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

Branches

Tags

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

Clone

HTTPS

Download ZIP

api.md

797lines · 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## Jobs
229
230Types:
231
232```python
233from openai.types.fine_tuning import (
234 FineTuningJob,
235 FineTuningJobEvent,
236 FineTuningJobWandbIntegration,
237 FineTuningJobWandbIntegrationObject,
238 FineTuningJobIntegration,
239)
240```
241
242Methods:
243
244- <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>
245- <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>
246- <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>
247- <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>
248- <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>
249
250### Checkpoints
251
252Types:
253
254```python
255from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint
256```
257
258Methods:
259
260- <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>
261
262## Checkpoints
263
264### Permissions
265
266Types:
267
268```python
269from openai.types.fine_tuning.checkpoints import (
270 PermissionCreateResponse,
271 PermissionRetrieveResponse,
272 PermissionDeleteResponse,
273)
274```
275
276Methods:
277
278- <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>
279- <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>
280- <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>
281
282# VectorStores
283
284Types:
285
286```python
287from openai.types import (
288 AutoFileChunkingStrategyParam,
289 FileChunkingStrategy,
290 FileChunkingStrategyParam,
291 OtherFileChunkingStrategyObject,
292 StaticFileChunkingStrategy,
293 StaticFileChunkingStrategyObject,
294 StaticFileChunkingStrategyObjectParam,
295 VectorStore,
296 VectorStoreDeleted,
297 VectorStoreSearchResponse,
298)
299```
300
301Methods:
302
303- <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>
304- <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>
305- <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>
306- <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>
307- <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>
308- <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>
309
310## Files
311
312Types:
313
314```python
315from openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse
316```
317
318Methods:
319
320- <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>
321- <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>
322- <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>
323- <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>
324- <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>
325- <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>
326- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">create_and_poll</a>(\*args) -> VectorStoreFile</code>
327- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">poll</a>(\*args) -> VectorStoreFile</code>
328- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload</a>(\*args) -> VectorStoreFile</code>
329- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload_and_poll</a>(\*args) -> VectorStoreFile</code>
330
331## FileBatches
332
333Types:
334
335```python
336from openai.types.vector_stores import VectorStoreFileBatch
337```
338
339Methods:
340
341- <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>
342- <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>
343- <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>
344- <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>
345- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">create_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
346- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">poll</a>(\*args) -> VectorStoreFileBatch</code>
347- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">upload_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
348
349# Beta
350
351## Realtime
352
353Types:
354
355```python
356from openai.types.beta.realtime import (
357 ConversationCreatedEvent,
358 ConversationItem,
359 ConversationItemContent,
360 ConversationItemCreateEvent,
361 ConversationItemCreatedEvent,
362 ConversationItemDeleteEvent,
363 ConversationItemDeletedEvent,
364 ConversationItemInputAudioTranscriptionCompletedEvent,
365 ConversationItemInputAudioTranscriptionDeltaEvent,
366 ConversationItemInputAudioTranscriptionFailedEvent,
367 ConversationItemRetrieveEvent,
368 ConversationItemTruncateEvent,
369 ConversationItemTruncatedEvent,
370 ConversationItemWithReference,
371 ErrorEvent,
372 InputAudioBufferAppendEvent,
373 InputAudioBufferClearEvent,
374 InputAudioBufferClearedEvent,
375 InputAudioBufferCommitEvent,
376 InputAudioBufferCommittedEvent,
377 InputAudioBufferSpeechStartedEvent,
378 InputAudioBufferSpeechStoppedEvent,
379 RateLimitsUpdatedEvent,
380 RealtimeClientEvent,
381 RealtimeResponse,
382 RealtimeResponseStatus,
383 RealtimeResponseUsage,
384 RealtimeServerEvent,
385 ResponseAudioDeltaEvent,
386 ResponseAudioDoneEvent,
387 ResponseAudioTranscriptDeltaEvent,
388 ResponseAudioTranscriptDoneEvent,
389 ResponseCancelEvent,
390 ResponseContentPartAddedEvent,
391 ResponseContentPartDoneEvent,
392 ResponseCreateEvent,
393 ResponseCreatedEvent,
394 ResponseDoneEvent,
395 ResponseFunctionCallArgumentsDeltaEvent,
396 ResponseFunctionCallArgumentsDoneEvent,
397 ResponseOutputItemAddedEvent,
398 ResponseOutputItemDoneEvent,
399 ResponseTextDeltaEvent,
400 ResponseTextDoneEvent,
401 SessionCreatedEvent,
402 SessionUpdateEvent,
403 SessionUpdatedEvent,
404 TranscriptionSessionUpdate,
405 TranscriptionSessionUpdatedEvent,
406)
407```
408
409### Sessions
410
411Types:
412
413```python
414from openai.types.beta.realtime import Session, SessionCreateResponse
415```
416
417Methods:
418
419- <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>
420
421### TranscriptionSessions
422
423Types:
424
425```python
426from openai.types.beta.realtime import TranscriptionSession
427```
428
429Methods:
430
431- <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>
432
433## Assistants
434
435Types:
436
437```python
438from openai.types.beta import (
439 Assistant,
440 AssistantDeleted,
441 AssistantStreamEvent,
442 AssistantTool,
443 CodeInterpreterTool,
444 FileSearchTool,
445 FunctionTool,
446 MessageStreamEvent,
447 RunStepStreamEvent,
448 RunStreamEvent,
449 ThreadStreamEvent,
450)
451```
452
453Methods:
454
455- <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>
456- <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>
457- <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>
458- <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>
459- <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>
460
461## Threads
462
463Types:
464
465```python
466from openai.types.beta import (
467 AssistantResponseFormatOption,
468 AssistantToolChoice,
469 AssistantToolChoiceFunction,
470 AssistantToolChoiceOption,
471 Thread,
472 ThreadDeleted,
473)
474```
475
476Methods:
477
478- <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>
479- <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>
480- <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>
481- <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>
482- <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>
483- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_poll</a>(\*args) -> Run</code>
484- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
485
486### Runs
487
488Types:
489
490```python
491from openai.types.beta.threads import RequiredActionFunctionToolCall, Run, RunStatus
492```
493
494Methods:
495
496- <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>
497- <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>
498- <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>
499- <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>
500- <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>
501- <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>
502- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">create_and_poll</a>(\*args) -> Run</code>
503- <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>
504- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">poll</a>(\*args) -> Run</code>
505- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
506- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">submit_tool_outputs_and_poll</a>(\*args) -> Run</code>
507- <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>
508
509#### Steps
510
511Types:
512
513```python
514from openai.types.beta.threads.runs import (
515 CodeInterpreterLogs,
516 CodeInterpreterOutputImage,
517 CodeInterpreterToolCall,
518 CodeInterpreterToolCallDelta,
519 FileSearchToolCall,
520 FileSearchToolCallDelta,
521 FunctionToolCall,
522 FunctionToolCallDelta,
523 MessageCreationStepDetails,
524 RunStep,
525 RunStepDelta,
526 RunStepDeltaEvent,
527 RunStepDeltaMessageDelta,
528 RunStepInclude,
529 ToolCall,
530 ToolCallDelta,
531 ToolCallDeltaObject,
532 ToolCallsStepDetails,
533)
534```
535
536Methods:
537
538- <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>
539- <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>
540
541### Messages
542
543Types:
544
545```python
546from openai.types.beta.threads import (
547 Annotation,
548 AnnotationDelta,
549 FileCitationAnnotation,
550 FileCitationDeltaAnnotation,
551 FilePathAnnotation,
552 FilePathDeltaAnnotation,
553 ImageFile,
554 ImageFileContentBlock,
555 ImageFileDelta,
556 ImageFileDeltaBlock,
557 ImageURL,
558 ImageURLContentBlock,
559 ImageURLDelta,
560 ImageURLDeltaBlock,
561 Message,
562 MessageContent,
563 MessageContentDelta,
564 MessageContentPartParam,
565 MessageDeleted,
566 MessageDelta,
567 MessageDeltaEvent,
568 RefusalContentBlock,
569 RefusalDeltaBlock,
570 Text,
571 TextContentBlock,
572 TextContentBlockParam,
573 TextDelta,
574 TextDeltaBlock,
575)
576```
577
578Methods:
579
580- <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>
581- <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>
582- <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>
583- <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>
584- <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>
585
586# Batches
587
588Types:
589
590```python
591from openai.types import Batch, BatchError, BatchRequestCounts
592```
593
594Methods:
595
596- <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>
597- <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>
598- <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>
599- <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>
600
601# Uploads
602
603Types:
604
605```python
606from openai.types import Upload
607```
608
609Methods:
610
611- <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>
612- <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>
613- <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>
614
615## Parts
616
617Types:
618
619```python
620from openai.types.uploads import UploadPart
621```
622
623Methods:
624
625- <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>
626
627# Responses
628
629Types:
630
631```python
632from openai.types.responses import (
633 ComputerTool,
634 EasyInputMessage,
635 FileSearchTool,
636 FunctionTool,
637 Response,
638 ResponseAudioDeltaEvent,
639 ResponseAudioDoneEvent,
640 ResponseAudioTranscriptDeltaEvent,
641 ResponseAudioTranscriptDoneEvent,
642 ResponseCodeInterpreterCallCodeDeltaEvent,
643 ResponseCodeInterpreterCallCodeDoneEvent,
644 ResponseCodeInterpreterCallCompletedEvent,
645 ResponseCodeInterpreterCallInProgressEvent,
646 ResponseCodeInterpreterCallInterpretingEvent,
647 ResponseCodeInterpreterToolCall,
648 ResponseCompletedEvent,
649 ResponseComputerToolCall,
650 ResponseComputerToolCallOutputItem,
651 ResponseComputerToolCallOutputScreenshot,
652 ResponseContent,
653 ResponseContentPartAddedEvent,
654 ResponseContentPartDoneEvent,
655 ResponseCreatedEvent,
656 ResponseError,
657 ResponseErrorEvent,
658 ResponseFailedEvent,
659 ResponseFileSearchCallCompletedEvent,
660 ResponseFileSearchCallInProgressEvent,
661 ResponseFileSearchCallSearchingEvent,
662 ResponseFileSearchToolCall,
663 ResponseFormatTextConfig,
664 ResponseFormatTextJSONSchemaConfig,
665 ResponseFunctionCallArgumentsDeltaEvent,
666 ResponseFunctionCallArgumentsDoneEvent,
667 ResponseFunctionToolCall,
668 ResponseFunctionToolCallItem,
669 ResponseFunctionToolCallOutputItem,
670 ResponseFunctionWebSearch,
671 ResponseInProgressEvent,
672 ResponseIncludable,
673 ResponseIncompleteEvent,
674 ResponseInput,
675 ResponseInputAudio,
676 ResponseInputContent,
677 ResponseInputFile,
678 ResponseInputImage,
679 ResponseInputItem,
680 ResponseInputMessageContentList,
681 ResponseInputMessageItem,
682 ResponseInputText,
683 ResponseItem,
684 ResponseOutputAudio,
685 ResponseOutputItem,
686 ResponseOutputItemAddedEvent,
687 ResponseOutputItemDoneEvent,
688 ResponseOutputMessage,
689 ResponseOutputRefusal,
690 ResponseOutputText,
691 ResponseReasoningItem,
692 ResponseReasoningSummaryPartAddedEvent,
693 ResponseReasoningSummaryPartDoneEvent,
694 ResponseReasoningSummaryTextDeltaEvent,
695 ResponseReasoningSummaryTextDoneEvent,
696 ResponseRefusalDeltaEvent,
697 ResponseRefusalDoneEvent,
698 ResponseStatus,
699 ResponseStreamEvent,
700 ResponseTextAnnotationDeltaEvent,
701 ResponseTextConfig,
702 ResponseTextDeltaEvent,
703 ResponseTextDoneEvent,
704 ResponseUsage,
705 ResponseWebSearchCallCompletedEvent,
706 ResponseWebSearchCallInProgressEvent,
707 ResponseWebSearchCallSearchingEvent,
708 Tool,
709 ToolChoiceFunction,
710 ToolChoiceOptions,
711 ToolChoiceTypes,
712 WebSearchTool,
713)
714```
715
716Methods:
717
718- <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>
719- <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>
720- <code title="delete /responses/{response_id}">client.responses.<a href="./src/openai/resources/responses/responses.py">delete</a>(response_id) -> None</code>
721
722## InputItems
723
724Types:
725
726```python
727from openai.types.responses import ResponseItemList
728```
729
730Methods:
731
732- <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>
733
734# Evals
735
736Types:
737
738```python
739from openai.types import (
740 EvalCustomDataSourceConfig,
741 EvalLabelModelGrader,
742 EvalStoredCompletionsDataSourceConfig,
743 EvalStringCheckGrader,
744 EvalTextSimilarityGrader,
745 EvalCreateResponse,
746 EvalRetrieveResponse,
747 EvalUpdateResponse,
748 EvalListResponse,
749 EvalDeleteResponse,
750)
751```
752
753Methods:
754
755- <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>
756- <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>
757- <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>
758- <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>
759- <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>
760
761## Runs
762
763Types:
764
765```python
766from openai.types.evals import (
767 CreateEvalCompletionsRunDataSource,
768 CreateEvalJSONLRunDataSource,
769 EvalAPIError,
770 RunCreateResponse,
771 RunRetrieveResponse,
772 RunListResponse,
773 RunDeleteResponse,
774 RunCancelResponse,
775)
776```
777
778Methods:
779
780- <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>
781- <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>
782- <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>
783- <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>
784- <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>
785
786### OutputItems
787
788Types:
789
790```python
791from openai.types.evals.runs import OutputItemRetrieveResponse, OutputItemListResponse
792```
793
794Methods:
795
796- <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>
797- <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>
798