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

# \EvalsApi

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

Method | HTTP request | Description
------------- | ------------- | -------------
[**cancel_eval_run**](EvalsApi.md#cancel_eval_run) | **POST** /evals/{eval_id}/runs/{run_id} | Cancel an ongoing evaluation run. 
[**create_eval**](EvalsApi.md#create_eval) | **POST** /evals | Create the structure of an evaluation that can be used to test a model's performance. An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources. For more information, see the [Evals guide](/docs/guides/evals). 
[**create_eval_run**](EvalsApi.md#create_eval_run) | **POST** /evals/{eval_id}/runs | Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation. 
[**delete_eval**](EvalsApi.md#delete_eval) | **DELETE** /evals/{eval_id} | Delete an evaluation. 
[**delete_eval_run**](EvalsApi.md#delete_eval_run) | **DELETE** /evals/{eval_id}/runs/{run_id} | Delete an eval run. 
[**get_eval**](EvalsApi.md#get_eval) | **GET** /evals/{eval_id} | Get an evaluation by ID. 
[**get_eval_run**](EvalsApi.md#get_eval_run) | **GET** /evals/{eval_id}/runs/{run_id} | Get an evaluation run by ID. 
[**get_eval_run_output_item**](EvalsApi.md#get_eval_run_output_item) | **GET** /evals/{eval_id}/runs/{run_id}/output_items/{output_item_id} | Get an evaluation run output item by ID. 
[**get_eval_run_output_items**](EvalsApi.md#get_eval_run_output_items) | **GET** /evals/{eval_id}/runs/{run_id}/output_items | Get a list of output items for an evaluation run. 
[**get_eval_runs**](EvalsApi.md#get_eval_runs) | **GET** /evals/{eval_id}/runs | Get a list of runs for an evaluation. 
[**list_evals**](EvalsApi.md#list_evals) | **GET** /evals | List evaluations for a project. 
[**update_eval**](EvalsApi.md#update_eval) | **POST** /evals/{eval_id} | Update certain properties of an evaluation. 



## cancel_eval_run

> models::EvalRun cancel_eval_run(eval_id, run_id)
Cancel an ongoing evaluation run. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**eval_id** | **String** | The ID of the evaluation whose run you want to cancel. | [required] |
**run_id** | **String** | The ID of the run to cancel. | [required] |

### Return type

[**models::EvalRun**](EvalRun.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_eval

> models::Eval create_eval(create_eval_request)
Create the structure of an evaluation that can be used to test a model's performance. An evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources. For more information, see the [Evals guide](/docs/guides/evals). 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_eval_request** | [**CreateEvalRequest**](CreateEvalRequest.md) |  | [required] |

### Return type

[**models::Eval**](Eval.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_eval_run

> models::EvalRun create_eval_run(eval_id, create_eval_run_request)
Kicks off a new run for a given evaluation, specifying the data source, and what model configuration to use to test. The datasource will be validated against the schema specified in the config of the evaluation. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**eval_id** | **String** | The ID of the evaluation to create a run for. | [required] |
**create_eval_run_request** | [**CreateEvalRunRequest**](CreateEvalRunRequest.md) |  | [required] |

### Return type

[**models::EvalRun**](EvalRun.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_eval

> models::DeleteEval200Response delete_eval(eval_id)
Delete an evaluation. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**eval_id** | **String** | The ID of the evaluation to delete. | [required] |

### Return type

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


## delete_eval_run

> models::DeleteEvalRun200Response delete_eval_run(eval_id, run_id)
Delete an eval run. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**eval_id** | **String** | The ID of the evaluation to delete the run from. | [required] |
**run_id** | **String** | The ID of the run to delete. | [required] |

### Return type

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


## get_eval

> models::Eval get_eval(eval_id)
Get an evaluation by ID. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**eval_id** | **String** | The ID of the evaluation to retrieve. | [required] |

### Return type

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


## get_eval_run

> models::EvalRun get_eval_run(eval_id, run_id)
Get an evaluation run by ID. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**eval_id** | **String** | The ID of the evaluation to retrieve runs for. | [required] |
**run_id** | **String** | The ID of the run to retrieve. | [required] |

### Return type

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


## get_eval_run_output_item

> models::EvalRunOutputItem get_eval_run_output_item(eval_id, run_id, output_item_id)
Get an evaluation run output item by ID. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**eval_id** | **String** | The ID of the evaluation to retrieve runs for. | [required] |
**run_id** | **String** | The ID of the run to retrieve. | [required] |
**output_item_id** | **String** | The ID of the output item to retrieve. | [required] |

### Return type

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


## get_eval_run_output_items

> models::EvalRunOutputItemList get_eval_run_output_items(eval_id, run_id, after, limit, status, order)
Get a list of output items for an evaluation run. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**eval_id** | **String** | The ID of the evaluation to retrieve runs for. | [required] |
**run_id** | **String** | The ID of the run to retrieve output items for. | [required] |
**after** | Option<**String**> | Identifier for the last output item from the previous pagination request. |  |
**limit** | Option<**i32**> | Number of output items to retrieve. |  |[default to 20]
**status** | Option<**String**> | Filter output items by status. Use `failed` to filter by failed output items or `pass` to filter by passed output items.  |  |
**order** | Option<**String**> | Sort order for output items by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`. |  |[default to asc]

### Return type

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


## get_eval_runs

> models::EvalRunList get_eval_runs(eval_id, after, limit, order, status)
Get a list of runs for an evaluation. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**eval_id** | **String** | The ID of the evaluation to retrieve runs for. | [required] |
**after** | Option<**String**> | Identifier for the last run from the previous pagination request. |  |
**limit** | Option<**i32**> | Number of runs to retrieve. |  |[default to 20]
**order** | Option<**String**> | Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`. |  |[default to asc]
**status** | Option<**String**> | Filter runs by status. One of `queued` | `in_progress` | `failed` | `completed` | `canceled`. |  |

### Return type

[**models::EvalRunList**](EvalRunList.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_evals

> models::EvalList list_evals(after, limit, order, order_by)
List evaluations for a project. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**after** | Option<**String**> | Identifier for the last eval from the previous pagination request. |  |
**limit** | Option<**i32**> | Number of evals to retrieve. |  |[default to 20]
**order** | Option<**String**> | Sort order for evals by timestamp. Use `asc` for ascending order or `desc` for descending order. |  |[default to asc]
**order_by** | Option<**String**> | Evals can be ordered by creation time or last updated time. Use `created_at` for creation time or `updated_at` for last updated time.  |  |[default to created_at]

### Return type

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


## update_eval

> models::Eval update_eval(eval_id, update_eval_request)
Update certain properties of an evaluation. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**eval_id** | **String** | The ID of the evaluation to update. | [required] |
**update_eval_request** | [**UpdateEvalRequest**](UpdateEvalRequest.md) | Request to update an evaluation | [required] |

### Return type

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