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.99.7

Branches

Tags

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

Clone

HTTPS

Download ZIP

api.md

953lines · modecode

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