GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

openai/openai-python

Public

mirrored from https://github.com/openai/openai-pythonAvailable

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
v1.93.0

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

api.md

928lines · modecode

RawDownload
Latest commit unavailable.
1# Shared Types
2
3```python
4from openai.types import (
5 AllModels,
6 ChatModel,
7 ComparisonFilter,
8 CompoundFilter,
9 ErrorObject,
10 FunctionDefinition,
11 FunctionParameters,
12 Metadata,
13 Reasoning,
14 ReasoningEffort,
15 ResponseFormatJSONObject,
16 ResponseFormatJSONSchema,
17 ResponseFormatText,
18 ResponsesModel,
19)
20```
21
22# Completions
23
24Types:
25
26```python
27from openai.types import Completion, CompletionChoice, CompletionUsage
28```
29
30Methods:
31
32- <code title="post /completions">client.completions.<a href="./src/openai/resources/completions.py">create</a>(\*\*<a href="src/openai/types/completion_create_params.py">params</a>) -> <a href="./src/openai/types/completion.py">Completion</a></code>
33
34# Chat
35
36Types:
37
38```python
39from openai.types import ChatModel
40```
41
42## Completions
43
44Types:
45
46```python
47from openai.types.chat import (
48 ChatCompletion,
49 ChatCompletionAssistantMessageParam,
50 ChatCompletionAudio,
51 ChatCompletionAudioParam,
52 ChatCompletionChunk,
53 ChatCompletionContentPart,
54 ChatCompletionContentPartImage,
55 ChatCompletionContentPartInputAudio,
56 ChatCompletionContentPartRefusal,
57 ChatCompletionContentPartText,
58 ChatCompletionDeleted,
59 ChatCompletionDeveloperMessageParam,
60 ChatCompletionFunctionCallOption,
61 ChatCompletionFunctionMessageParam,
62 ChatCompletionMessage,
63 ChatCompletionMessageParam,
64 ChatCompletionMessageToolCall,
65 ChatCompletionModality,
66 ChatCompletionNamedToolChoice,
67 ChatCompletionPredictionContent,
68 ChatCompletionRole,
69 ChatCompletionStoreMessage,
70 ChatCompletionStreamOptions,
71 ChatCompletionSystemMessageParam,
72 ChatCompletionTokenLogprob,
73 ChatCompletionTool,
74 ChatCompletionToolChoiceOption,
75 ChatCompletionToolMessageParam,
76 ChatCompletionUserMessageParam,
77 ChatCompletionReasoningEffort,
78)
79```
80
81Methods:
82
83- <code title="post /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">create</a>(\*\*<a href="src/openai/types/chat/completion_create_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
84- <code title="get /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">retrieve</a>(completion_id) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
85- <code title="post /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">update</a>(completion_id, \*\*<a href="src/openai/types/chat/completion_update_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
86- <code title="get /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">list</a>(\*\*<a href="src/openai/types/chat/completion_list_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">SyncCursorPage[ChatCompletion]</a></code>
87- <code title="delete /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">delete</a>(completion_id) -> <a href="./src/openai/types/chat/chat_completion_deleted.py">ChatCompletionDeleted</a></code>
88
89### Messages
90
91Methods:
92
93- <code title="get /chat/completions/{completion_id}/messages">client.chat.completions.messages.<a href="./src/openai/resources/chat/completions/messages.py">list</a>(completion_id, \*\*<a href="src/openai/types/chat/completions/message_list_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion_store_message.py">SyncCursorPage[ChatCompletionStoreMessage]</a></code>
94
95# Embeddings
96
97Types:
98
99```python
100from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel
101```
102
103Methods:
104
105- <code title="post /embeddings">client.embeddings.<a href="./src/openai/resources/embeddings.py">create</a>(\*\*<a href="src/openai/types/embedding_create_params.py">params</a>) -> <a href="./src/openai/types/create_embedding_response.py">CreateEmbeddingResponse</a></code>
106
107# Files
108
109Types:
110
111```python
112from openai.types import FileContent, FileDeleted, FileObject, FilePurpose
113```
114
115Methods:
116
117- <code title="post /files">client.files.<a href="./src/openai/resources/files.py">create</a>(\*\*<a href="src/openai/types/file_create_params.py">params</a>) -> <a href="./src/openai/types/file_object.py">FileObject</a></code>
118- <code title="get /files/{file_id}">client.files.<a href="./src/openai/resources/files.py">retrieve</a>(file_id) -> <a href="./src/openai/types/file_object.py">FileObject</a></code>
119- <code title="get /files">client.files.<a href="./src/openai/resources/files.py">list</a>(\*\*<a href="src/openai/types/file_list_params.py">params</a>) -> <a href="./src/openai/types/file_object.py">SyncCursorPage[FileObject]</a></code>
120- <code title="delete /files/{file_id}">client.files.<a href="./src/openai/resources/files.py">delete</a>(file_id) -> <a href="./src/openai/types/file_deleted.py">FileDeleted</a></code>
121- <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">content</a>(file_id) -> HttpxBinaryResponseContent</code>
122- <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">retrieve_content</a>(file_id) -> <a href="./src/openai/types/file_content.py">str</a></code>
123- <code>client.files.<a href="./src/openai/resources/files.py">wait_for_processing</a>(\*args) -> FileObject</code>
124
125# Images
126
127Types:
128
129```python
130from openai.types import Image, ImageModel, ImagesResponse
131```
132
133Methods:
134
135- <code title="post /images/variations">client.images.<a href="./src/openai/resources/images.py">create_variation</a>(\*\*<a href="src/openai/types/image_create_variation_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
136- <code title="post /images/edits">client.images.<a href="./src/openai/resources/images.py">edit</a>(\*\*<a href="src/openai/types/image_edit_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
137- <code title="post /images/generations">client.images.<a href="./src/openai/resources/images.py">generate</a>(\*\*<a href="src/openai/types/image_generate_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
138
139# Audio
140
141Types:
142
143```python
144from openai.types import AudioModel, AudioResponseFormat
145```
146
147## Transcriptions
148
149Types:
150
151```python
152from openai.types.audio import (
153 Transcription,
154 TranscriptionInclude,
155 TranscriptionSegment,
156 TranscriptionStreamEvent,
157 TranscriptionTextDeltaEvent,
158 TranscriptionTextDoneEvent,
159 TranscriptionVerbose,
160 TranscriptionWord,
161 TranscriptionCreateResponse,
162)
163```
164
165Methods:
166
167- <code title="post /audio/transcriptions">client.audio.transcriptions.<a href="./src/openai/resources/audio/transcriptions.py">create</a>(\*\*<a href="src/openai/types/audio/transcription_create_params.py">params</a>) -> <a href="./src/openai/types/audio/transcription_create_response.py">TranscriptionCreateResponse</a></code>
168
169## Translations
170
171Types:
172
173```python
174from openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse
175```
176
177Methods:
178
179- <code title="post /audio/translations">client.audio.translations.<a href="./src/openai/resources/audio/translations.py">create</a>(\*\*<a href="src/openai/types/audio/translation_create_params.py">params</a>) -> <a href="./src/openai/types/audio/translation_create_response.py">TranslationCreateResponse</a></code>
180
181## Speech
182
183Types:
184
185```python
186from openai.types.audio import SpeechModel
187```
188
189Methods:
190
191- <code title="post /audio/speech">client.audio.speech.<a href="./src/openai/resources/audio/speech.py">create</a>(\*\*<a href="src/openai/types/audio/speech_create_params.py">params</a>) -> HttpxBinaryResponseContent</code>
192
193# Moderations
194
195Types:
196
197```python
198from openai.types import (
199 Moderation,
200 ModerationImageURLInput,
201 ModerationModel,
202 ModerationMultiModalInput,
203 ModerationTextInput,
204 ModerationCreateResponse,
205)
206```
207
208Methods:
209
210- <code title="post /moderations">client.moderations.<a href="./src/openai/resources/moderations.py">create</a>(\*\*<a href="src/openai/types/moderation_create_params.py">params</a>) -> <a href="./src/openai/types/moderation_create_response.py">ModerationCreateResponse</a></code>
211
212# Models
213
214Types:
215
216```python
217from openai.types import Model, ModelDeleted
218```
219
220Methods:
221
222- <code title="get /models/{model}">client.models.<a href="./src/openai/resources/models.py">retrieve</a>(model) -> <a href="./src/openai/types/model.py">Model</a></code>
223- <code title="get /models">client.models.<a href="./src/openai/resources/models.py">list</a>() -> <a href="./src/openai/types/model.py">SyncPage[Model]</a></code>
224- <code title="delete /models/{model}">client.models.<a href="./src/openai/resources/models.py">delete</a>(model) -> <a href="./src/openai/types/model_deleted.py">ModelDeleted</a></code>
225
226# FineTuning
227
228## Methods
229
230Types:
231
232```python
233from openai.types.fine_tuning import (
234 DpoHyperparameters,
235 DpoMethod,
236 ReinforcementHyperparameters,
237 ReinforcementMethod,
238 SupervisedHyperparameters,
239 SupervisedMethod,
240)
241```
242
243## Jobs
244
245Types:
246
247```python
248from openai.types.fine_tuning import (
249 FineTuningJob,
250 FineTuningJobEvent,
251 FineTuningJobWandbIntegration,
252 FineTuningJobWandbIntegrationObject,
253 FineTuningJobIntegration,
254)
255```
256
257Methods:
258
259- <code title="post /fine_tuning/jobs">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">create</a>(\*\*<a href="src/openai/types/fine_tuning/job_create_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
260- <code title="get /fine_tuning/jobs/{fine_tuning_job_id}">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">retrieve</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
261- <code title="get /fine_tuning/jobs">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">list</a>(\*\*<a href="src/openai/types/fine_tuning/job_list_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">SyncCursorPage[FineTuningJob]</a></code>
262- <code title="post /fine_tuning/jobs/{fine_tuning_job_id}/cancel">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">cancel</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
263- <code title="get /fine_tuning/jobs/{fine_tuning_job_id}/events">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">list_events</a>(fine_tuning_job_id, \*\*<a href="src/openai/types/fine_tuning/job_list_events_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job_event.py">SyncCursorPage[FineTuningJobEvent]</a></code>
264- <code title="post /fine_tuning/jobs/{fine_tuning_job_id}/pause">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">pause</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
265- <code title="post /fine_tuning/jobs/{fine_tuning_job_id}/resume">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">resume</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
266
267### Checkpoints
268
269Types:
270
271```python
272from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint
273```
274
275Methods:
276
277- <code title="get /fine_tuning/jobs/{fine_tuning_job_id}/checkpoints">client.fine_tuning.jobs.checkpoints.<a href="./src/openai/resources/fine_tuning/jobs/checkpoints.py">list</a>(fine_tuning_job_id, \*\*<a href="src/openai/types/fine_tuning/jobs/checkpoint_list_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/jobs/fine_tuning_job_checkpoint.py">SyncCursorPage[FineTuningJobCheckpoint]</a></code>
278
279## Checkpoints
280
281### Permissions
282
283Types:
284
285```python
286from openai.types.fine_tuning.checkpoints import (
287 PermissionCreateResponse,
288 PermissionRetrieveResponse,
289 PermissionDeleteResponse,
290)
291```
292
293Methods:
294
295- <code title="post /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fine_tuning.checkpoints.permissions.<a href="./src/openai/resources/fine_tuning/checkpoints/permissions.py">create</a>(fine_tuned_model_checkpoint, \*\*<a href="src/openai/types/fine_tuning/checkpoints/permission_create_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/checkpoints/permission_create_response.py">SyncPage[PermissionCreateResponse]</a></code>
296- <code title="get /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fine_tuning.checkpoints.permissions.<a href="./src/openai/resources/fine_tuning/checkpoints/permissions.py">retrieve</a>(fine_tuned_model_checkpoint, \*\*<a href="src/openai/types/fine_tuning/checkpoints/permission_retrieve_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/checkpoints/permission_retrieve_response.py">PermissionRetrieveResponse</a></code>
297- <code title="delete /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions/{permission_id}">client.fine_tuning.checkpoints.permissions.<a href="./src/openai/resources/fine_tuning/checkpoints/permissions.py">delete</a>(permission_id, \*, fine_tuned_model_checkpoint) -> <a href="./src/openai/types/fine_tuning/checkpoints/permission_delete_response.py">PermissionDeleteResponse</a></code>
298
299## Alpha
300
301### Graders
302
303Types:
304
305```python
306from openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse
307```
308
309Methods:
310
311- <code title="post /fine_tuning/alpha/graders/run">client.fine_tuning.alpha.graders.<a href="./src/openai/resources/fine_tuning/alpha/graders.py">run</a>(\*\*<a href="src/openai/types/fine_tuning/alpha/grader_run_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/alpha/grader_run_response.py">GraderRunResponse</a></code>
312- <code title="post /fine_tuning/alpha/graders/validate">client.fine_tuning.alpha.graders.<a href="./src/openai/resources/fine_tuning/alpha/graders.py">validate</a>(\*\*<a href="src/openai/types/fine_tuning/alpha/grader_validate_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/alpha/grader_validate_response.py">GraderValidateResponse</a></code>
313
314# Graders
315
316## GraderModels
317
318Types:
319
320```python
321from openai.types.graders import (
322 LabelModelGrader,
323 MultiGrader,
324 PythonGrader,
325 ScoreModelGrader,
326 StringCheckGrader,
327 TextSimilarityGrader,
328)
329```
330
331# VectorStores
332
333Types:
334
335```python
336from openai.types import (
337 AutoFileChunkingStrategyParam,
338 FileChunkingStrategy,
339 FileChunkingStrategyParam,
340 OtherFileChunkingStrategyObject,
341 StaticFileChunkingStrategy,
342 StaticFileChunkingStrategyObject,
343 StaticFileChunkingStrategyObjectParam,
344 VectorStore,
345 VectorStoreDeleted,
346 VectorStoreSearchResponse,
347)
348```
349
350Methods:
351
352- <code title="post /vector_stores">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">create</a>(\*\*<a href="src/openai/types/vector_store_create_params.py">params</a>) -> <a href="./src/openai/types/vector_store.py">VectorStore</a></code>
353- <code title="get /vector_stores/{vector_store_id}">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">retrieve</a>(vector_store_id) -> <a href="./src/openai/types/vector_store.py">VectorStore</a></code>
354- <code title="post /vector_stores/{vector_store_id}">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">update</a>(vector_store_id, \*\*<a href="src/openai/types/vector_store_update_params.py">params</a>) -> <a href="./src/openai/types/vector_store.py">VectorStore</a></code>
355- <code title="get /vector_stores">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">list</a>(\*\*<a href="src/openai/types/vector_store_list_params.py">params</a>) -> <a href="./src/openai/types/vector_store.py">SyncCursorPage[VectorStore]</a></code>
356- <code title="delete /vector_stores/{vector_store_id}">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">delete</a>(vector_store_id) -> <a href="./src/openai/types/vector_store_deleted.py">VectorStoreDeleted</a></code>
357- <code title="post /vector_stores/{vector_store_id}/search">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">search</a>(vector_store_id, \*\*<a href="src/openai/types/vector_store_search_params.py">params</a>) -> <a href="./src/openai/types/vector_store_search_response.py">SyncPage[VectorStoreSearchResponse]</a></code>
358
359## Files
360
361Types:
362
363```python
364from openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse
365```
366
367Methods:
368
369- <code title="post /vector_stores/{vector_store_id}/files">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">create</a>(vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_create_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
370- <code title="get /vector_stores/{vector_store_id}/files/{file_id}">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">retrieve</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
371- <code title="post /vector_stores/{vector_store_id}/files/{file_id}">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">update</a>(file_id, \*, vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_update_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
372- <code title="get /vector_stores/{vector_store_id}/files">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">list</a>(vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_list_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">SyncCursorPage[VectorStoreFile]</a></code>
373- <code title="delete /vector_stores/{vector_store_id}/files/{file_id}">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">delete</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file_deleted.py">VectorStoreFileDeleted</a></code>
374- <code title="get /vector_stores/{vector_store_id}/files/{file_id}/content">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">content</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/file_content_response.py">SyncPage[FileContentResponse]</a></code>
375- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">create_and_poll</a>(\*args) -> VectorStoreFile</code>
376- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">poll</a>(\*args) -> VectorStoreFile</code>
377- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload</a>(\*args) -> VectorStoreFile</code>
378- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload_and_poll</a>(\*args) -> VectorStoreFile</code>
379
380## FileBatches
381
382Types:
383
384```python
385from openai.types.vector_stores import VectorStoreFileBatch
386```
387
388Methods:
389
390- <code title="post /vector_stores/{vector_store_id}/file_batches">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">create</a>(vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_batch_create_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
391- <code title="get /vector_stores/{vector_store_id}/file_batches/{batch_id}">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">retrieve</a>(batch_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
392- <code title="post /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">cancel</a>(batch_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
393- <code title="get /vector_stores/{vector_store_id}/file_batches/{batch_id}/files">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">list_files</a>(batch_id, \*, vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_batch_list_files_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">SyncCursorPage[VectorStoreFile]</a></code>
394- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">create_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
395- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">poll</a>(\*args) -> VectorStoreFileBatch</code>
396- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">upload_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
397
398# Webhooks
399
400Types:
401
402```python
403from openai.types.webhooks import (
404 BatchCancelledWebhookEvent,
405 BatchCompletedWebhookEvent,
406 BatchExpiredWebhookEvent,
407 BatchFailedWebhookEvent,
408 EvalRunCanceledWebhookEvent,
409 EvalRunFailedWebhookEvent,
410 EvalRunSucceededWebhookEvent,
411 FineTuningJobCancelledWebhookEvent,
412 FineTuningJobFailedWebhookEvent,
413 FineTuningJobSucceededWebhookEvent,
414 ResponseCancelledWebhookEvent,
415 ResponseCompletedWebhookEvent,
416 ResponseFailedWebhookEvent,
417 ResponseIncompleteWebhookEvent,
418 UnwrapWebhookEvent,
419)
420```
421
422Methods:
423
424- <code>client.webhooks.<a href="./src/openai/resources/webhooks.py">unwrap</a>(payload, headers, \*, secret) -> UnwrapWebhookEvent</code>
425- <code>client.webhooks.<a href="./src/openai/resources/webhooks.py">verify_signature</a>(payload, headers, \*, secret, tolerance) -> None</code>
426
427# Beta
428
429## Realtime
430
431Types:
432
433```python
434from openai.types.beta.realtime import (
435 ConversationCreatedEvent,
436 ConversationItem,
437 ConversationItemContent,
438 ConversationItemCreateEvent,
439 ConversationItemCreatedEvent,
440 ConversationItemDeleteEvent,
441 ConversationItemDeletedEvent,
442 ConversationItemInputAudioTranscriptionCompletedEvent,
443 ConversationItemInputAudioTranscriptionDeltaEvent,
444 ConversationItemInputAudioTranscriptionFailedEvent,
445 ConversationItemRetrieveEvent,
446 ConversationItemTruncateEvent,
447 ConversationItemTruncatedEvent,
448 ConversationItemWithReference,
449 ErrorEvent,
450 InputAudioBufferAppendEvent,
451 InputAudioBufferClearEvent,
452 InputAudioBufferClearedEvent,
453 InputAudioBufferCommitEvent,
454 InputAudioBufferCommittedEvent,
455 InputAudioBufferSpeechStartedEvent,
456 InputAudioBufferSpeechStoppedEvent,
457 RateLimitsUpdatedEvent,
458 RealtimeClientEvent,
459 RealtimeResponse,
460 RealtimeResponseStatus,
461 RealtimeResponseUsage,
462 RealtimeServerEvent,
463 ResponseAudioDeltaEvent,
464 ResponseAudioDoneEvent,
465 ResponseAudioTranscriptDeltaEvent,
466 ResponseAudioTranscriptDoneEvent,
467 ResponseCancelEvent,
468 ResponseContentPartAddedEvent,
469 ResponseContentPartDoneEvent,
470 ResponseCreateEvent,
471 ResponseCreatedEvent,
472 ResponseDoneEvent,
473 ResponseFunctionCallArgumentsDeltaEvent,
474 ResponseFunctionCallArgumentsDoneEvent,
475 ResponseOutputItemAddedEvent,
476 ResponseOutputItemDoneEvent,
477 ResponseTextDeltaEvent,
478 ResponseTextDoneEvent,
479 SessionCreatedEvent,
480 SessionUpdateEvent,
481 SessionUpdatedEvent,
482 TranscriptionSessionUpdate,
483 TranscriptionSessionUpdatedEvent,
484)
485```
486
487### Sessions
488
489Types:
490
491```python
492from openai.types.beta.realtime import Session, SessionCreateResponse
493```
494
495Methods:
496
497- <code title="post /realtime/sessions">client.beta.realtime.sessions.<a href="./src/openai/resources/beta/realtime/sessions.py">create</a>(\*\*<a href="src/openai/types/beta/realtime/session_create_params.py">params</a>) -> <a href="./src/openai/types/beta/realtime/session_create_response.py">SessionCreateResponse</a></code>
498
499### TranscriptionSessions
500
501Types:
502
503```python
504from openai.types.beta.realtime import TranscriptionSession
505```
506
507Methods:
508
509- <code title="post /realtime/transcription_sessions">client.beta.realtime.transcription_sessions.<a href="./src/openai/resources/beta/realtime/transcription_sessions.py">create</a>(\*\*<a href="src/openai/types/beta/realtime/transcription_session_create_params.py">params</a>) -> <a href="./src/openai/types/beta/realtime/transcription_session.py">TranscriptionSession</a></code>
510
511## Assistants
512
513Types:
514
515```python
516from openai.types.beta import (
517 Assistant,
518 AssistantDeleted,
519 AssistantStreamEvent,
520 AssistantTool,
521 CodeInterpreterTool,
522 FileSearchTool,
523 FunctionTool,
524 MessageStreamEvent,
525 RunStepStreamEvent,
526 RunStreamEvent,
527 ThreadStreamEvent,
528)
529```
530
531Methods:
532
533- <code title="post /assistants">client.beta.assistants.<a href="./src/openai/resources/beta/assistants.py">create</a>(\*\*<a href="src/openai/types/beta/assistant_create_params.py">params</a>) -> <a href="./src/openai/types/beta/assistant.py">Assistant</a></code>
534- <code title="get /assistants/{assistant_id}">client.beta.assistants.<a href="./src/openai/resources/beta/assistants.py">retrieve</a>(assistant_id) -> <a href="./src/openai/types/beta/assistant.py">Assistant</a></code>
535- <code title="post /assistants/{assistant_id}">client.beta.assistants.<a href="./src/openai/resources/beta/assistants.py">update</a>(assistant_id, \*\*<a href="src/openai/types/beta/assistant_update_params.py">params</a>) -> <a href="./src/openai/types/beta/assistant.py">Assistant</a></code>
536- <code title="get /assistants">client.beta.assistants.<a href="./src/openai/resources/beta/assistants.py">list</a>(\*\*<a href="src/openai/types/beta/assistant_list_params.py">params</a>) -> <a href="./src/openai/types/beta/assistant.py">SyncCursorPage[Assistant]</a></code>
537- <code title="delete /assistants/{assistant_id}">client.beta.assistants.<a href="./src/openai/resources/beta/assistants.py">delete</a>(assistant_id) -> <a href="./src/openai/types/beta/assistant_deleted.py">AssistantDeleted</a></code>
538
539## Threads
540
541Types:
542
543```python
544from openai.types.beta import (
545 AssistantResponseFormatOption,
546 AssistantToolChoice,
547 AssistantToolChoiceFunction,
548 AssistantToolChoiceOption,
549 Thread,
550 ThreadDeleted,
551)
552```
553
554Methods:
555
556- <code title="post /threads">client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create</a>(\*\*<a href="src/openai/types/beta/thread_create_params.py">params</a>) -> <a href="./src/openai/types/beta/thread.py">Thread</a></code>
557- <code title="get /threads/{thread_id}">client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">retrieve</a>(thread_id) -> <a href="./src/openai/types/beta/thread.py">Thread</a></code>
558- <code title="post /threads/{thread_id}">client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">update</a>(thread_id, \*\*<a href="src/openai/types/beta/thread_update_params.py">params</a>) -> <a href="./src/openai/types/beta/thread.py">Thread</a></code>
559- <code title="delete /threads/{thread_id}">client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">delete</a>(thread_id) -> <a href="./src/openai/types/beta/thread_deleted.py">ThreadDeleted</a></code>
560- <code title="post /threads/runs">client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run</a>(\*\*<a href="src/openai/types/beta/thread_create_and_run_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
561- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_poll</a>(\*args) -> Run</code>
562- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
563
564### Runs
565
566Types:
567
568```python
569from openai.types.beta.threads import RequiredActionFunctionToolCall, Run, RunStatus
570```
571
572Methods:
573
574- <code title="post /threads/{thread_id}/runs">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">create</a>(thread_id, \*\*<a href="src/openai/types/beta/threads/run_create_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
575- <code title="get /threads/{thread_id}/runs/{run_id}">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">retrieve</a>(run_id, \*, thread_id) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
576- <code title="post /threads/{thread_id}/runs/{run_id}">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">update</a>(run_id, \*, thread_id, \*\*<a href="src/openai/types/beta/threads/run_update_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
577- <code title="get /threads/{thread_id}/runs">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">list</a>(thread_id, \*\*<a href="src/openai/types/beta/threads/run_list_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/run.py">SyncCursorPage[Run]</a></code>
578- <code title="post /threads/{thread_id}/runs/{run_id}/cancel">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">cancel</a>(run_id, \*, thread_id) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
579- <code title="post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">submit_tool_outputs</a>(run_id, \*, thread_id, \*\*<a href="src/openai/types/beta/threads/run_submit_tool_outputs_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
580- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">create_and_poll</a>(\*args) -> Run</code>
581- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">create_and_stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
582- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">poll</a>(\*args) -> Run</code>
583- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
584- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">submit_tool_outputs_and_poll</a>(\*args) -> Run</code>
585- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">submit_tool_outputs_stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
586
587#### Steps
588
589Types:
590
591```python
592from openai.types.beta.threads.runs import (
593 CodeInterpreterLogs,
594 CodeInterpreterOutputImage,
595 CodeInterpreterToolCall,
596 CodeInterpreterToolCallDelta,
597 FileSearchToolCall,
598 FileSearchToolCallDelta,
599 FunctionToolCall,
600 FunctionToolCallDelta,
601 MessageCreationStepDetails,
602 RunStep,
603 RunStepDelta,
604 RunStepDeltaEvent,
605 RunStepDeltaMessageDelta,
606 RunStepInclude,
607 ToolCall,
608 ToolCallDelta,
609 ToolCallDeltaObject,
610 ToolCallsStepDetails,
611)
612```
613
614Methods:
615
616- <code title="get /threads/{thread_id}/runs/{run_id}/steps/{step_id}">client.beta.threads.runs.steps.<a href="./src/openai/resources/beta/threads/runs/steps.py">retrieve</a>(step_id, \*, thread_id, run_id, \*\*<a href="src/openai/types/beta/threads/runs/step_retrieve_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/runs/run_step.py">RunStep</a></code>
617- <code title="get /threads/{thread_id}/runs/{run_id}/steps">client.beta.threads.runs.steps.<a href="./src/openai/resources/beta/threads/runs/steps.py">list</a>(run_id, \*, thread_id, \*\*<a href="src/openai/types/beta/threads/runs/step_list_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/runs/run_step.py">SyncCursorPage[RunStep]</a></code>
618
619### Messages
620
621Types:
622
623```python
624from openai.types.beta.threads import (
625 Annotation,
626 AnnotationDelta,
627 FileCitationAnnotation,
628 FileCitationDeltaAnnotation,
629 FilePathAnnotation,
630 FilePathDeltaAnnotation,
631 ImageFile,
632 ImageFileContentBlock,
633 ImageFileDelta,
634 ImageFileDeltaBlock,
635 ImageURL,
636 ImageURLContentBlock,
637 ImageURLDelta,
638 ImageURLDeltaBlock,
639 Message,
640 MessageContent,
641 MessageContentDelta,
642 MessageContentPartParam,
643 MessageDeleted,
644 MessageDelta,
645 MessageDeltaEvent,
646 RefusalContentBlock,
647 RefusalDeltaBlock,
648 Text,
649 TextContentBlock,
650 TextContentBlockParam,
651 TextDelta,
652 TextDeltaBlock,
653)
654```
655
656Methods:
657
658- <code title="post /threads/{thread_id}/messages">client.beta.threads.messages.<a href="./src/openai/resources/beta/threads/messages.py">create</a>(thread_id, \*\*<a href="src/openai/types/beta/threads/message_create_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/message.py">Message</a></code>
659- <code title="get /threads/{thread_id}/messages/{message_id}">client.beta.threads.messages.<a href="./src/openai/resources/beta/threads/messages.py">retrieve</a>(message_id, \*, thread_id) -> <a href="./src/openai/types/beta/threads/message.py">Message</a></code>
660- <code title="post /threads/{thread_id}/messages/{message_id}">client.beta.threads.messages.<a href="./src/openai/resources/beta/threads/messages.py">update</a>(message_id, \*, thread_id, \*\*<a href="src/openai/types/beta/threads/message_update_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/message.py">Message</a></code>
661- <code title="get /threads/{thread_id}/messages">client.beta.threads.messages.<a href="./src/openai/resources/beta/threads/messages.py">list</a>(thread_id, \*\*<a href="src/openai/types/beta/threads/message_list_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/message.py">SyncCursorPage[Message]</a></code>
662- <code title="delete /threads/{thread_id}/messages/{message_id}">client.beta.threads.messages.<a href="./src/openai/resources/beta/threads/messages.py">delete</a>(message_id, \*, thread_id) -> <a href="./src/openai/types/beta/threads/message_deleted.py">MessageDeleted</a></code>
663
664# Batches
665
666Types:
667
668```python
669from openai.types import Batch, BatchError, BatchRequestCounts
670```
671
672Methods:
673
674- <code title="post /batches">client.batches.<a href="./src/openai/resources/batches.py">create</a>(\*\*<a href="src/openai/types/batch_create_params.py">params</a>) -> <a href="./src/openai/types/batch.py">Batch</a></code>
675- <code title="get /batches/{batch_id}">client.batches.<a href="./src/openai/resources/batches.py">retrieve</a>(batch_id) -> <a href="./src/openai/types/batch.py">Batch</a></code>
676- <code title="get /batches">client.batches.<a href="./src/openai/resources/batches.py">list</a>(\*\*<a href="src/openai/types/batch_list_params.py">params</a>) -> <a href="./src/openai/types/batch.py">SyncCursorPage[Batch]</a></code>
677- <code title="post /batches/{batch_id}/cancel">client.batches.<a href="./src/openai/resources/batches.py">cancel</a>(batch_id) -> <a href="./src/openai/types/batch.py">Batch</a></code>
678
679# Uploads
680
681Types:
682
683```python
684from openai.types import Upload
685```
686
687Methods:
688
689- <code title="post /uploads">client.uploads.<a href="./src/openai/resources/uploads/uploads.py">create</a>(\*\*<a href="src/openai/types/upload_create_params.py">params</a>) -> <a href="./src/openai/types/upload.py">Upload</a></code>
690- <code title="post /uploads/{upload_id}/cancel">client.uploads.<a href="./src/openai/resources/uploads/uploads.py">cancel</a>(upload_id) -> <a href="./src/openai/types/upload.py">Upload</a></code>
691- <code title="post /uploads/{upload_id}/complete">client.uploads.<a href="./src/openai/resources/uploads/uploads.py">complete</a>(upload_id, \*\*<a href="src/openai/types/upload_complete_params.py">params</a>) -> <a href="./src/openai/types/upload.py">Upload</a></code>
692
693## Parts
694
695Types:
696
697```python
698from openai.types.uploads import UploadPart
699```
700
701Methods:
702
703- <code title="post /uploads/{upload_id}/parts">client.uploads.parts.<a href="./src/openai/resources/uploads/parts.py">create</a>(upload_id, \*\*<a href="src/openai/types/uploads/part_create_params.py">params</a>) -> <a href="./src/openai/types/uploads/upload_part.py">UploadPart</a></code>
704
705# Responses
706
707Types:
708
709```python
710from openai.types.responses import (
711 ComputerTool,
712 EasyInputMessage,
713 FileSearchTool,
714 FunctionTool,
715 Response,
716 ResponseAudioDeltaEvent,
717 ResponseAudioDoneEvent,
718 ResponseAudioTranscriptDeltaEvent,
719 ResponseAudioTranscriptDoneEvent,
720 ResponseCodeInterpreterCallCodeDeltaEvent,
721 ResponseCodeInterpreterCallCodeDoneEvent,
722 ResponseCodeInterpreterCallCompletedEvent,
723 ResponseCodeInterpreterCallInProgressEvent,
724 ResponseCodeInterpreterCallInterpretingEvent,
725 ResponseCodeInterpreterToolCall,
726 ResponseCompletedEvent,
727 ResponseComputerToolCall,
728 ResponseComputerToolCallOutputItem,
729 ResponseComputerToolCallOutputScreenshot,
730 ResponseContent,
731 ResponseContentPartAddedEvent,
732 ResponseContentPartDoneEvent,
733 ResponseCreatedEvent,
734 ResponseError,
735 ResponseErrorEvent,
736 ResponseFailedEvent,
737 ResponseFileSearchCallCompletedEvent,
738 ResponseFileSearchCallInProgressEvent,
739 ResponseFileSearchCallSearchingEvent,
740 ResponseFileSearchToolCall,
741 ResponseFormatTextConfig,
742 ResponseFormatTextJSONSchemaConfig,
743 ResponseFunctionCallArgumentsDeltaEvent,
744 ResponseFunctionCallArgumentsDoneEvent,
745 ResponseFunctionToolCall,
746 ResponseFunctionToolCallItem,
747 ResponseFunctionToolCallOutputItem,
748 ResponseFunctionWebSearch,
749 ResponseImageGenCallCompletedEvent,
750 ResponseImageGenCallGeneratingEvent,
751 ResponseImageGenCallInProgressEvent,
752 ResponseImageGenCallPartialImageEvent,
753 ResponseInProgressEvent,
754 ResponseIncludable,
755 ResponseIncompleteEvent,
756 ResponseInput,
757 ResponseInputAudio,
758 ResponseInputContent,
759 ResponseInputFile,
760 ResponseInputImage,
761 ResponseInputItem,
762 ResponseInputMessageContentList,
763 ResponseInputMessageItem,
764 ResponseInputText,
765 ResponseItem,
766 ResponseMcpCallArgumentsDeltaEvent,
767 ResponseMcpCallArgumentsDoneEvent,
768 ResponseMcpCallCompletedEvent,
769 ResponseMcpCallFailedEvent,
770 ResponseMcpCallInProgressEvent,
771 ResponseMcpListToolsCompletedEvent,
772 ResponseMcpListToolsFailedEvent,
773 ResponseMcpListToolsInProgressEvent,
774 ResponseOutputAudio,
775 ResponseOutputItem,
776 ResponseOutputItemAddedEvent,
777 ResponseOutputItemDoneEvent,
778 ResponseOutputMessage,
779 ResponseOutputRefusal,
780 ResponseOutputText,
781 ResponseOutputTextAnnotationAddedEvent,
782 ResponsePrompt,
783 ResponseQueuedEvent,
784 ResponseReasoningDeltaEvent,
785 ResponseReasoningDoneEvent,
786 ResponseReasoningItem,
787 ResponseReasoningSummaryDeltaEvent,
788 ResponseReasoningSummaryDoneEvent,
789 ResponseReasoningSummaryPartAddedEvent,
790 ResponseReasoningSummaryPartDoneEvent,
791 ResponseReasoningSummaryTextDeltaEvent,
792 ResponseReasoningSummaryTextDoneEvent,
793 ResponseRefusalDeltaEvent,
794 ResponseRefusalDoneEvent,
795 ResponseStatus,
796 ResponseStreamEvent,
797 ResponseTextConfig,
798 ResponseTextDeltaEvent,
799 ResponseTextDoneEvent,
800 ResponseUsage,
801 ResponseWebSearchCallCompletedEvent,
802 ResponseWebSearchCallInProgressEvent,
803 ResponseWebSearchCallSearchingEvent,
804 Tool,
805 ToolChoiceFunction,
806 ToolChoiceMcp,
807 ToolChoiceOptions,
808 ToolChoiceTypes,
809 WebSearchTool,
810)
811```
812
813Methods:
814
815- <code title="post /responses">client.responses.<a href="./src/openai/resources/responses/responses.py">create</a>(\*\*<a href="src/openai/types/responses/response_create_params.py">params</a>) -> <a href="./src/openai/types/responses/response.py">Response</a></code>
816- <code title="get /responses/{response_id}">client.responses.<a href="./src/openai/resources/responses/responses.py">retrieve</a>(response_id, \*\*<a href="src/openai/types/responses/response_retrieve_params.py">params</a>) -> <a href="./src/openai/types/responses/response.py">Response</a></code>
817- <code title="delete /responses/{response_id}">client.responses.<a href="./src/openai/resources/responses/responses.py">delete</a>(response_id) -> None</code>
818- <code title="post /responses/{response_id}/cancel">client.responses.<a href="./src/openai/resources/responses/responses.py">cancel</a>(response_id) -> <a href="./src/openai/types/responses/response.py">Response</a></code>
819
820## InputItems
821
822Types:
823
824```python
825from openai.types.responses import ResponseItemList
826```
827
828Methods:
829
830- <code title="get /responses/{response_id}/input_items">client.responses.input_items.<a href="./src/openai/resources/responses/input_items.py">list</a>(response_id, \*\*<a href="src/openai/types/responses/input_item_list_params.py">params</a>) -> <a href="./src/openai/types/responses/response_item.py">SyncCursorPage[ResponseItem]</a></code>
831
832# Evals
833
834Types:
835
836```python
837from openai.types import (
838 EvalCustomDataSourceConfig,
839 EvalStoredCompletionsDataSourceConfig,
840 EvalCreateResponse,
841 EvalRetrieveResponse,
842 EvalUpdateResponse,
843 EvalListResponse,
844 EvalDeleteResponse,
845)
846```
847
848Methods:
849
850- <code title="post /evals">client.evals.<a href="./src/openai/resources/evals/evals.py">create</a>(\*\*<a href="src/openai/types/eval_create_params.py">params</a>) -> <a href="./src/openai/types/eval_create_response.py">EvalCreateResponse</a></code>
851- <code title="get /evals/{eval_id}">client.evals.<a href="./src/openai/resources/evals/evals.py">retrieve</a>(eval_id) -> <a href="./src/openai/types/eval_retrieve_response.py">EvalRetrieveResponse</a></code>
852- <code title="post /evals/{eval_id}">client.evals.<a href="./src/openai/resources/evals/evals.py">update</a>(eval_id, \*\*<a href="src/openai/types/eval_update_params.py">params</a>) -> <a href="./src/openai/types/eval_update_response.py">EvalUpdateResponse</a></code>
853- <code title="get /evals">client.evals.<a href="./src/openai/resources/evals/evals.py">list</a>(\*\*<a href="src/openai/types/eval_list_params.py">params</a>) -> <a href="./src/openai/types/eval_list_response.py">SyncCursorPage[EvalListResponse]</a></code>
854- <code title="delete /evals/{eval_id}">client.evals.<a href="./src/openai/resources/evals/evals.py">delete</a>(eval_id) -> <a href="./src/openai/types/eval_delete_response.py">EvalDeleteResponse</a></code>
855
856## Runs
857
858Types:
859
860```python
861from openai.types.evals import (
862 CreateEvalCompletionsRunDataSource,
863 CreateEvalJSONLRunDataSource,
864 EvalAPIError,
865 RunCreateResponse,
866 RunRetrieveResponse,
867 RunListResponse,
868 RunDeleteResponse,
869 RunCancelResponse,
870)
871```
872
873Methods:
874
875- <code title="post /evals/{eval_id}/runs">client.evals.runs.<a href="./src/openai/resources/evals/runs/runs.py">create</a>(eval_id, \*\*<a href="src/openai/types/evals/run_create_params.py">params</a>) -> <a href="./src/openai/types/evals/run_create_response.py">RunCreateResponse</a></code>
876- <code title="get /evals/{eval_id}/runs/{run_id}">client.evals.runs.<a href="./src/openai/resources/evals/runs/runs.py">retrieve</a>(run_id, \*, eval_id) -> <a href="./src/openai/types/evals/run_retrieve_response.py">RunRetrieveResponse</a></code>
877- <code title="get /evals/{eval_id}/runs">client.evals.runs.<a href="./src/openai/resources/evals/runs/runs.py">list</a>(eval_id, \*\*<a href="src/openai/types/evals/run_list_params.py">params</a>) -> <a href="./src/openai/types/evals/run_list_response.py">SyncCursorPage[RunListResponse]</a></code>
878- <code title="delete /evals/{eval_id}/runs/{run_id}">client.evals.runs.<a href="./src/openai/resources/evals/runs/runs.py">delete</a>(run_id, \*, eval_id) -> <a href="./src/openai/types/evals/run_delete_response.py">RunDeleteResponse</a></code>
879- <code title="post /evals/{eval_id}/runs/{run_id}">client.evals.runs.<a href="./src/openai/resources/evals/runs/runs.py">cancel</a>(run_id, \*, eval_id) -> <a href="./src/openai/types/evals/run_cancel_response.py">RunCancelResponse</a></code>
880
881### OutputItems
882
883Types:
884
885```python
886from openai.types.evals.runs import OutputItemRetrieveResponse, OutputItemListResponse
887```
888
889Methods:
890
891- <code title="get /evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}">client.evals.runs.output_items.<a href="./src/openai/resources/evals/runs/output_items.py">retrieve</a>(output_item_id, \*, eval_id, run_id) -> <a href="./src/openai/types/evals/runs/output_item_retrieve_response.py">OutputItemRetrieveResponse</a></code>
892- <code title="get /evals/{eval_id}/runs/{run_id}/output_items">client.evals.runs.output_items.<a href="./src/openai/resources/evals/runs/output_items.py">list</a>(run_id, \*, eval_id, \*\*<a href="src/openai/types/evals/runs/output_item_list_params.py">params</a>) -> <a href="./src/openai/types/evals/runs/output_item_list_response.py">SyncCursorPage[OutputItemListResponse]</a></code>
893
894# Containers
895
896Types:
897
898```python
899from openai.types import ContainerCreateResponse, ContainerRetrieveResponse, ContainerListResponse
900```
901
902Methods:
903
904- <code title="post /containers">client.containers.<a href="./src/openai/resources/containers/containers.py">create</a>(\*\*<a href="src/openai/types/container_create_params.py">params</a>) -> <a href="./src/openai/types/container_create_response.py">ContainerCreateResponse</a></code>
905- <code title="get /containers/{container_id}">client.containers.<a href="./src/openai/resources/containers/containers.py">retrieve</a>(container_id) -> <a href="./src/openai/types/container_retrieve_response.py">ContainerRetrieveResponse</a></code>
906- <code title="get /containers">client.containers.<a href="./src/openai/resources/containers/containers.py">list</a>(\*\*<a href="src/openai/types/container_list_params.py">params</a>) -> <a href="./src/openai/types/container_list_response.py">SyncCursorPage[ContainerListResponse]</a></code>
907- <code title="delete /containers/{container_id}">client.containers.<a href="./src/openai/resources/containers/containers.py">delete</a>(container_id) -> None</code>
908
909## Files
910
911Types:
912
913```python
914from openai.types.containers import FileCreateResponse, FileRetrieveResponse, FileListResponse
915```
916
917Methods:
918
919- <code title="post /containers/{container_id}/files">client.containers.files.<a href="./src/openai/resources/containers/files/files.py">create</a>(container_id, \*\*<a href="src/openai/types/containers/file_create_params.py">params</a>) -> <a href="./src/openai/types/containers/file_create_response.py">FileCreateResponse</a></code>
920- <code title="get /containers/{container_id}/files/{file_id}">client.containers.files.<a href="./src/openai/resources/containers/files/files.py">retrieve</a>(file_id, \*, container_id) -> <a href="./src/openai/types/containers/file_retrieve_response.py">FileRetrieveResponse</a></code>
921- <code title="get /containers/{container_id}/files">client.containers.files.<a href="./src/openai/resources/containers/files/files.py">list</a>(container_id, \*\*<a href="src/openai/types/containers/file_list_params.py">params</a>) -> <a href="./src/openai/types/containers/file_list_response.py">SyncCursorPage[FileListResponse]</a></code>
922- <code title="delete /containers/{container_id}/files/{file_id}">client.containers.files.<a href="./src/openai/resources/containers/files/files.py">delete</a>(file_id, \*, container_id) -> None</code>
923
924### Content
925
926Methods:
927
928- <code title="get /containers/{container_id}/files/{file_id}/content">client.containers.files.content.<a href="./src/openai/resources/containers/files/content.py">retrieve</a>(file_id, \*, container_id) -> HttpxBinaryResponseContent</code>
929