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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397

# \FineTuningApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel_fine_tuning_job**](FineTuningApi.md#cancel_fine_tuning_job) | **POST** /fine_tuning/jobs/{fine_tuning_job_id}/cancel | Immediately cancel a fine-tune job. 
[**create_fine_tuning_checkpoint_permission**](FineTuningApi.md#create_fine_tuning_checkpoint_permission) | **POST** /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions | **NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).  This enables organization owners to share fine-tuned models with other projects in their organization. 
[**create_fine_tuning_job**](FineTuningApi.md#create_fine_tuning_job) | **POST** /fine_tuning/jobs | Creates a fine-tuning job which begins the process of creating a new model from a given dataset.  Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.  [Learn more about fine-tuning](/docs/guides/model-optimization) 
[**delete_fine_tuning_checkpoint_permission**](FineTuningApi.md#delete_fine_tuning_checkpoint_permission) | **DELETE** /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id} | **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).  Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint. 
[**list_fine_tuning_checkpoint_permissions**](FineTuningApi.md#list_fine_tuning_checkpoint_permissions) | **GET** /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions | **NOTE:** This endpoint requires an [admin API key](../admin-api-keys).  Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint. 
[**list_fine_tuning_events**](FineTuningApi.md#list_fine_tuning_events) | **GET** /fine_tuning/jobs/{fine_tuning_job_id}/events | Get status updates for a fine-tuning job. 
[**list_fine_tuning_job_checkpoints**](FineTuningApi.md#list_fine_tuning_job_checkpoints) | **GET** /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints | List checkpoints for a fine-tuning job. 
[**list_paginated_fine_tuning_jobs**](FineTuningApi.md#list_paginated_fine_tuning_jobs) | **GET** /fine_tuning/jobs | List your organization's fine-tuning jobs 
[**pause_fine_tuning_job**](FineTuningApi.md#pause_fine_tuning_job) | **POST** /fine_tuning/jobs/{fine_tuning_job_id}/pause | Pause a fine-tune job. 
[**resume_fine_tuning_job**](FineTuningApi.md#resume_fine_tuning_job) | **POST** /fine_tuning/jobs/{fine_tuning_job_id}/resume | Resume a fine-tune job. 
[**retrieve_fine_tuning_job**](FineTuningApi.md#retrieve_fine_tuning_job) | **GET** /fine_tuning/jobs/{fine_tuning_job_id} | Get info about a fine-tuning job.  [Learn more about fine-tuning](/docs/guides/model-optimization) 
[**run_grader**](FineTuningApi.md#run_grader) | **POST** /fine_tuning/alpha/graders/run | Run a grader. 
[**validate_grader**](FineTuningApi.md#validate_grader) | **POST** /fine_tuning/alpha/graders/validate | Validate a grader. 



## cancel_fine_tuning_job

> models::FineTuningJob cancel_fine_tuning_job(fine_tuning_job_id)
Immediately cancel a fine-tune job. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fine_tuning_job_id** | **String** | The ID of the fine-tuning job to cancel.  | [required] |

### Return type

[**models::FineTuningJob**](FineTuningJob.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)


## create_fine_tuning_checkpoint_permission

> models::ListFineTuningCheckpointPermissionResponse create_fine_tuning_checkpoint_permission(fine_tuned_model_checkpoint, create_fine_tuning_checkpoint_permission_request)
**NOTE:** Calling this endpoint requires an [admin API key](../admin-api-keys).  This enables organization owners to share fine-tuned models with other projects in their organization. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fine_tuned_model_checkpoint** | **String** | The ID of the fine-tuned model checkpoint to create a permission for.  | [required] |
**create_fine_tuning_checkpoint_permission_request** | [**CreateFineTuningCheckpointPermissionRequest**](CreateFineTuningCheckpointPermissionRequest.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)


## create_fine_tuning_job

> models::FineTuningJob create_fine_tuning_job(create_fine_tuning_job_request)
Creates a fine-tuning job which begins the process of creating a new model from a given dataset.  Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.  [Learn more about fine-tuning](/docs/guides/model-optimization) 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_fine_tuning_job_request** | [**CreateFineTuningJobRequest**](CreateFineTuningJobRequest.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)


## delete_fine_tuning_checkpoint_permission

> models::DeleteFineTuningCheckpointPermissionResponse delete_fine_tuning_checkpoint_permission(fine_tuned_model_checkpoint, permission_id)
**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).  Organization owners can use this endpoint to delete a permission for a fine-tuned model checkpoint. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fine_tuned_model_checkpoint** | **String** | The ID of the fine-tuned model checkpoint to delete a permission for.  | [required] |
**permission_id** | **String** | The ID of the fine-tuned model checkpoint permission to delete.  | [required] |

### Return type

[**models::DeleteFineTuningCheckpointPermissionResponse**](DeleteFineTuningCheckpointPermissionResponse.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)


## list_fine_tuning_checkpoint_permissions

> models::ListFineTuningCheckpointPermissionResponse list_fine_tuning_checkpoint_permissions(fine_tuned_model_checkpoint, project_id, after, limit, order)
**NOTE:** This endpoint requires an [admin API key](../admin-api-keys).  Organization owners can use this endpoint to view all permissions for a fine-tuned model checkpoint. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fine_tuned_model_checkpoint** | **String** | The ID of the fine-tuned model checkpoint to get permissions for.  | [required] |
**project_id** | Option<**String**> | The ID of the project to get permissions for. |  |
**after** | Option<**String**> | Identifier for the last permission ID from the previous pagination request. |  |
**limit** | Option<**i32**> | Number of permissions to retrieve. |  |[default to 10]
**order** | Option<**String**> | The order in which to retrieve permissions. |  |[default to descending]

### Return type

[**models::ListFineTuningCheckpointPermissionResponse**](ListFineTuningCheckpointPermissionResponse.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)


## list_fine_tuning_events

> models::ListFineTuningJobEventsResponse list_fine_tuning_events(fine_tuning_job_id, after, limit)
Get status updates for a fine-tuning job. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fine_tuning_job_id** | **String** | The ID of the fine-tuning job to get events for.  | [required] |
**after** | Option<**String**> | Identifier for the last event from the previous pagination request. |  |
**limit** | Option<**i32**> | Number of events to retrieve. |  |[default to 20]

### Return type

[**models::ListFineTuningJobEventsResponse**](ListFineTuningJobEventsResponse.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)


## list_fine_tuning_job_checkpoints

> models::ListFineTuningJobCheckpointsResponse list_fine_tuning_job_checkpoints(fine_tuning_job_id, after, limit)
List checkpoints for a fine-tuning job. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fine_tuning_job_id** | **String** | The ID of the fine-tuning job to get checkpoints for.  | [required] |
**after** | Option<**String**> | Identifier for the last checkpoint ID from the previous pagination request. |  |
**limit** | Option<**i32**> | Number of checkpoints to retrieve. |  |[default to 10]

### Return type

[**models::ListFineTuningJobCheckpointsResponse**](ListFineTuningJobCheckpointsResponse.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)


## list_paginated_fine_tuning_jobs

> models::ListPaginatedFineTuningJobsResponse list_paginated_fine_tuning_jobs(after, limit, metadata)
List your organization's fine-tuning jobs 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**after** | Option<**String**> | Identifier for the last job from the previous pagination request. |  |
**limit** | Option<**i32**> | Number of fine-tuning jobs to retrieve. |  |[default to 20]
**metadata** | Option<[**std::collections::HashMap<String, String>**](String.md)> | Optional metadata filter. To filter, use the syntax `metadata[k]=v`. Alternatively, set `metadata=null` to indicate no metadata.  |  |

### Return type

[**models::ListPaginatedFineTuningJobsResponse**](ListPaginatedFineTuningJobsResponse.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)


## pause_fine_tuning_job

> models::FineTuningJob pause_fine_tuning_job(fine_tuning_job_id)
Pause a fine-tune job. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fine_tuning_job_id** | **String** | The ID of the fine-tuning job to pause.  | [required] |

### Return type

[**models::FineTuningJob**](FineTuningJob.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)


## resume_fine_tuning_job

> models::FineTuningJob resume_fine_tuning_job(fine_tuning_job_id)
Resume a fine-tune job. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fine_tuning_job_id** | **String** | The ID of the fine-tuning job to resume.  | [required] |

### Return type

[**models::FineTuningJob**](FineTuningJob.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)


## retrieve_fine_tuning_job

> models::FineTuningJob retrieve_fine_tuning_job(fine_tuning_job_id)
Get info about a fine-tuning job.  [Learn more about fine-tuning](/docs/guides/model-optimization) 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**fine_tuning_job_id** | **String** | The ID of the fine-tuning job.  | [required] |

### Return type

[**models::FineTuningJob**](FineTuningJob.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)


## run_grader

> models::RunGraderResponse run_grader(run_grader_request)
Run a grader. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**run_grader_request** | [**RunGraderRequest**](RunGraderRequest.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)


## validate_grader

> models::ValidateGraderResponse validate_grader(validate_grader_request)
Validate a grader. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**validate_grader_request** | [**ValidateGraderRequest**](ValidateGraderRequest.md) |  | [required] |

### Return type

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

### Authorization

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

### HTTP request headers

- **Content-Type**: application/json
- **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)