openai-client-base 0.12.0

Auto-generated Rust client for the OpenAI API
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344

# \UsageApi

All URIs are relative to *https://api.openai.com/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**usage_audio_speeches**](UsageApi.md#usage_audio_speeches) | **GET** /organization/usage/audio_speeches | Get audio speeches usage details for the organization.
[**usage_audio_transcriptions**](UsageApi.md#usage_audio_transcriptions) | **GET** /organization/usage/audio_transcriptions | Get audio transcriptions usage details for the organization.
[**usage_code_interpreter_sessions**](UsageApi.md#usage_code_interpreter_sessions) | **GET** /organization/usage/code_interpreter_sessions | Get code interpreter sessions usage details for the organization.
[**usage_completions**](UsageApi.md#usage_completions) | **GET** /organization/usage/completions | Get completions usage details for the organization.
[**usage_costs**](UsageApi.md#usage_costs) | **GET** /organization/costs | Get costs details for the organization.
[**usage_embeddings**](UsageApi.md#usage_embeddings) | **GET** /organization/usage/embeddings | Get embeddings usage details for the organization.
[**usage_images**](UsageApi.md#usage_images) | **GET** /organization/usage/images | Get images usage details for the organization.
[**usage_moderations**](UsageApi.md#usage_moderations) | **GET** /organization/usage/moderations | Get moderations usage details for the organization.
[**usage_vector_stores**](UsageApi.md#usage_vector_stores) | **GET** /organization/usage/vector_stores | Get vector stores usage details for the organization.



## usage_audio_speeches

> models::UsageResponse usage_audio_speeches(start_time, end_time, bucket_width, project_ids, user_ids, api_key_ids, models, group_by, limit, page)
Get audio speeches usage details for the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**start_time** | **i32** | Start time (Unix seconds) of the query time range, inclusive. | [required] |
**end_time** | Option<**i32**> | End time (Unix seconds) of the query time range, exclusive. |  |
**bucket_width** | Option<**String**> | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |  |[default to 1d]
**project_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these projects. |  |
**user_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these users. |  |
**api_key_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these API keys. |  |
**models** | Option<[**Vec<String>**](String.md)> | Return only usage for these models. |  |
**group_by** | Option<[**Vec<String>**](String.md)> | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them. |  |
**limit** | Option<**i32**> | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440  |  |
**page** | Option<**String**> | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |  |

### Return type

[**models::UsageResponse**](UsageResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## usage_audio_transcriptions

> models::UsageResponse usage_audio_transcriptions(start_time, end_time, bucket_width, project_ids, user_ids, api_key_ids, models, group_by, limit, page)
Get audio transcriptions usage details for the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**start_time** | **i32** | Start time (Unix seconds) of the query time range, inclusive. | [required] |
**end_time** | Option<**i32**> | End time (Unix seconds) of the query time range, exclusive. |  |
**bucket_width** | Option<**String**> | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |  |[default to 1d]
**project_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these projects. |  |
**user_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these users. |  |
**api_key_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these API keys. |  |
**models** | Option<[**Vec<String>**](String.md)> | Return only usage for these models. |  |
**group_by** | Option<[**Vec<String>**](String.md)> | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them. |  |
**limit** | Option<**i32**> | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440  |  |
**page** | Option<**String**> | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |  |

### Return type

[**models::UsageResponse**](UsageResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## usage_code_interpreter_sessions

> models::UsageResponse usage_code_interpreter_sessions(start_time, end_time, bucket_width, project_ids, group_by, limit, page)
Get code interpreter sessions usage details for the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**start_time** | **i32** | Start time (Unix seconds) of the query time range, inclusive. | [required] |
**end_time** | Option<**i32**> | End time (Unix seconds) of the query time range, exclusive. |  |
**bucket_width** | Option<**String**> | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |  |[default to 1d]
**project_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these projects. |  |
**group_by** | Option<[**Vec<String>**](String.md)> | Group the usage data by the specified fields. Support fields include `project_id`. |  |
**limit** | Option<**i32**> | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440  |  |
**page** | Option<**String**> | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |  |

### Return type

[**models::UsageResponse**](UsageResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## usage_completions

> models::UsageResponse usage_completions(start_time, end_time, bucket_width, project_ids, user_ids, api_key_ids, models, batch, group_by, limit, page)
Get completions usage details for the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**start_time** | **i32** | Start time (Unix seconds) of the query time range, inclusive. | [required] |
**end_time** | Option<**i32**> | End time (Unix seconds) of the query time range, exclusive. |  |
**bucket_width** | Option<**String**> | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |  |[default to 1d]
**project_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these projects. |  |
**user_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these users. |  |
**api_key_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these API keys. |  |
**models** | Option<[**Vec<String>**](String.md)> | Return only usage for these models. |  |
**batch** | Option<**bool**> | If `true`, return batch jobs only. If `false`, return non-batch jobs only. By default, return both.  |  |
**group_by** | Option<[**Vec<String>**](String.md)> | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model`, `batch`, `service_tier` or any combination of them. |  |
**limit** | Option<**i32**> | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440  |  |
**page** | Option<**String**> | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |  |

### Return type

[**models::UsageResponse**](UsageResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## usage_costs

> models::UsageResponse usage_costs(start_time, end_time, bucket_width, project_ids, group_by, limit, page)
Get costs details for the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**start_time** | **i32** | Start time (Unix seconds) of the query time range, inclusive. | [required] |
**end_time** | Option<**i32**> | End time (Unix seconds) of the query time range, exclusive. |  |
**bucket_width** | Option<**String**> | Width of each time bucket in response. Currently only `1d` is supported, default to `1d`. |  |[default to 1d]
**project_ids** | Option<[**Vec<String>**](String.md)> | Return only costs for these projects. |  |
**group_by** | Option<[**Vec<String>**](String.md)> | Group the costs by the specified fields. Support fields include `project_id`, `line_item` and any combination of them. |  |
**limit** | Option<**i32**> | A limit on the number of buckets to be returned. Limit can range between 1 and 180, and the default is 7.  |  |[default to 7]
**page** | Option<**String**> | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |  |

### Return type

[**models::UsageResponse**](UsageResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## usage_embeddings

> models::UsageResponse usage_embeddings(start_time, end_time, bucket_width, project_ids, user_ids, api_key_ids, models, group_by, limit, page)
Get embeddings usage details for the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**start_time** | **i32** | Start time (Unix seconds) of the query time range, inclusive. | [required] |
**end_time** | Option<**i32**> | End time (Unix seconds) of the query time range, exclusive. |  |
**bucket_width** | Option<**String**> | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |  |[default to 1d]
**project_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these projects. |  |
**user_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these users. |  |
**api_key_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these API keys. |  |
**models** | Option<[**Vec<String>**](String.md)> | Return only usage for these models. |  |
**group_by** | Option<[**Vec<String>**](String.md)> | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them. |  |
**limit** | Option<**i32**> | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440  |  |
**page** | Option<**String**> | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |  |

### Return type

[**models::UsageResponse**](UsageResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## usage_images

> models::UsageResponse usage_images(start_time, end_time, bucket_width, sources, sizes, project_ids, user_ids, api_key_ids, models, group_by, limit, page)
Get images usage details for the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**start_time** | **i32** | Start time (Unix seconds) of the query time range, inclusive. | [required] |
**end_time** | Option<**i32**> | End time (Unix seconds) of the query time range, exclusive. |  |
**bucket_width** | Option<**String**> | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |  |[default to 1d]
**sources** | Option<[**Vec<String>**](String.md)> | Return only usages for these sources. Possible values are `image.generation`, `image.edit`, `image.variation` or any combination of them. |  |
**sizes** | Option<[**Vec<String>**](String.md)> | Return only usages for these image sizes. Possible values are `256x256`, `512x512`, `1024x1024`, `1792x1792`, `1024x1792` or any combination of them. |  |
**project_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these projects. |  |
**user_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these users. |  |
**api_key_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these API keys. |  |
**models** | Option<[**Vec<String>**](String.md)> | Return only usage for these models. |  |
**group_by** | Option<[**Vec<String>**](String.md)> | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model`, `size`, `source` or any combination of them. |  |
**limit** | Option<**i32**> | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440  |  |
**page** | Option<**String**> | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |  |

### Return type

[**models::UsageResponse**](UsageResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## usage_moderations

> models::UsageResponse usage_moderations(start_time, end_time, bucket_width, project_ids, user_ids, api_key_ids, models, group_by, limit, page)
Get moderations usage details for the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**start_time** | **i32** | Start time (Unix seconds) of the query time range, inclusive. | [required] |
**end_time** | Option<**i32**> | End time (Unix seconds) of the query time range, exclusive. |  |
**bucket_width** | Option<**String**> | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |  |[default to 1d]
**project_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these projects. |  |
**user_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these users. |  |
**api_key_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these API keys. |  |
**models** | Option<[**Vec<String>**](String.md)> | Return only usage for these models. |  |
**group_by** | Option<[**Vec<String>**](String.md)> | Group the usage data by the specified fields. Support fields include `project_id`, `user_id`, `api_key_id`, `model` or any combination of them. |  |
**limit** | Option<**i32**> | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440  |  |
**page** | Option<**String**> | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |  |

### Return type

[**models::UsageResponse**](UsageResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## usage_vector_stores

> models::UsageResponse usage_vector_stores(start_time, end_time, bucket_width, project_ids, group_by, limit, page)
Get vector stores usage details for the organization.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**start_time** | **i32** | Start time (Unix seconds) of the query time range, inclusive. | [required] |
**end_time** | Option<**i32**> | End time (Unix seconds) of the query time range, exclusive. |  |
**bucket_width** | Option<**String**> | Width of each time bucket in response. Currently `1m`, `1h` and `1d` are supported, default to `1d`. |  |[default to 1d]
**project_ids** | Option<[**Vec<String>**](String.md)> | Return only usage for these projects. |  |
**group_by** | Option<[**Vec<String>**](String.md)> | Group the usage data by the specified fields. Support fields include `project_id`. |  |
**limit** | Option<**i32**> | Specifies the number of buckets to return. - `bucket_width=1d`: default: 7, max: 31 - `bucket_width=1h`: default: 24, max: 168 - `bucket_width=1m`: default: 60, max: 1440  |  |
**page** | Option<**String**> | A cursor for use in pagination. Corresponding to the `next_page` field from the previous response. |  |

### Return type

[**models::UsageResponse**](UsageResponse.md)

### Authorization

[ApiKeyAuth](../README.md#ApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)