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

Branches

Tags

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

Clone

HTTPS

Download ZIP

api.md

680lines · modeblame

RawDownload
Latest commit unavailable.
a228a539Stainless Bot2 years ago1# Shared Types
2
3```python
bf1ca86cRobert Craigie1 years ago4from openai.types import (
530f9b80stainless-app[bot]1 years ago5ChatModel,
2954945eRobert Craigie1 years ago6ComparisonFilter,
7CompoundFilter,
bf1ca86cRobert Craigie1 years ago8ErrorObject,
9FunctionDefinition,
10FunctionParameters,
fdd52476stainless-app[bot]1 years ago11Metadata,
2954945eRobert Craigie1 years ago12Reasoning,
13ReasoningEffort,
bf1ca86cRobert Craigie1 years ago14ResponseFormatJSONObject,
15ResponseFormatJSONSchema,
16ResponseFormatText,
17)
a228a539Stainless Bot2 years ago18```
19
08b8179aDavid Schnurr2 years ago20# Completions
21
22Types:
23
24```python
25from openai.types import Completion, CompletionChoice, CompletionUsage
26```
27
28Methods:
29
30- <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>
31
32# Chat
33
1dc93403Stainless Bot2 years ago34Types:
35
36```python
37from openai.types import ChatModel
38```
39
08b8179aDavid Schnurr2 years ago40## Completions
41
42Types:
43
44```python
45from openai.types.chat import (
46ChatCompletion,
baa9f07fRobert Craigie2 years ago47ChatCompletionAssistantMessageParam,
550b855fstainless-app[bot]1 years ago48ChatCompletionAudio,
49ChatCompletionAudioParam,
08b8179aDavid Schnurr2 years ago50ChatCompletionChunk,
baa9f07fRobert Craigie2 years ago51ChatCompletionContentPart,
52ChatCompletionContentPartImage,
550b855fstainless-app[bot]1 years ago53ChatCompletionContentPartInputAudio,
bf1ca86cRobert Craigie1 years ago54ChatCompletionContentPartRefusal,
baa9f07fRobert Craigie2 years ago55ChatCompletionContentPartText,
300f58bbstainless-app[bot]1 years ago56ChatCompletionDeleted,
575ff607stainless-app[bot]1 years ago57ChatCompletionDeveloperMessageParam,
baa9f07fRobert Craigie2 years ago58ChatCompletionFunctionCallOption,
59ChatCompletionFunctionMessageParam,
08b8179aDavid Schnurr2 years ago60ChatCompletionMessage,
61ChatCompletionMessageParam,
baa9f07fRobert Craigie2 years ago62ChatCompletionMessageToolCall,
550b855fstainless-app[bot]1 years ago63ChatCompletionModality,
baa9f07fRobert Craigie2 years ago64ChatCompletionNamedToolChoice,
dfdcf571Stainless Bot1 years ago65ChatCompletionPredictionContent,
08b8179aDavid Schnurr2 years ago66ChatCompletionRole,
300f58bbstainless-app[bot]1 years ago67ChatCompletionStoreMessage,
6cc51587Stainless Bot2 years ago68ChatCompletionStreamOptions,
baa9f07fRobert Craigie2 years ago69ChatCompletionSystemMessageParam,
ccae821bStainless Bot2 years ago70ChatCompletionTokenLogprob,
baa9f07fRobert Craigie2 years ago71ChatCompletionTool,
72ChatCompletionToolChoiceOption,
73ChatCompletionToolMessageParam,
74ChatCompletionUserMessageParam,
2954945eRobert Craigie1 years ago75ChatCompletionReasoningEffort,
08b8179aDavid Schnurr2 years ago76)
77```
78
79Methods:
80
300f58bbstainless-app[bot]1 years ago81- <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>
82- <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>
83- <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>
84- <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>
85- <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>
86
87### Messages
88
89Methods:
90
91- <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>
08b8179aDavid Schnurr2 years ago92
93# Embeddings
94
95Types:
96
97```python
eab2e5a3Stainless Bot1 years ago98from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel
08b8179aDavid Schnurr2 years ago99```
100
101Methods:
102
103- <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>
104
105# Files
106
107Types:
108
109```python
05f0132fstainless-app[bot]1 years ago110from openai.types import FileContent, FileDeleted, FileObject, FilePurpose
08b8179aDavid Schnurr2 years ago111```
112
113Methods:
114
115- <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>
116- <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>
dfdcf571Stainless Bot1 years ago117- <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>
08b8179aDavid Schnurr2 years ago118- <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>
aa681899Stainless Bot2 years ago119- <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">content</a>(file_id) -> HttpxBinaryResponseContent</code>
d779e40bstainless-app[bot]1 years ago120- <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>
08b8179aDavid Schnurr2 years ago121- <code>client.files.<a href="./src/openai/resources/files.py">wait_for_processing</a>(\*args) -> FileObject</code>
122
123# Images
124
125Types:
126
127```python
ece795f0Stainless Bot1 years ago128from openai.types import Image, ImageModel, ImagesResponse
08b8179aDavid Schnurr2 years ago129```
130
131Methods:
132
133- <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>
134- <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>
135- <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>
136
137# Audio
138
ece795f0Stainless Bot1 years ago139Types:
140
141```python
102fce4fStainless Bot1 years ago142from openai.types import AudioModel, AudioResponseFormat
ece795f0Stainless Bot1 years ago143```
144
08b8179aDavid Schnurr2 years ago145## Transcriptions
146
147Types:
148
149```python
adb6da3aRobert Craigie1 years ago150from openai.types.audio import (
151Transcription,
152TranscriptionSegment,
153TranscriptionVerbose,
154TranscriptionWord,
155TranscriptionCreateResponse,
156)
08b8179aDavid Schnurr2 years ago157```
158
159Methods:
160
adb6da3aRobert Craigie1 years ago161- <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>
08b8179aDavid Schnurr2 years ago162
163## Translations
164
165Types:
166
167```python
adb6da3aRobert Craigie1 years ago168from openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse
08b8179aDavid Schnurr2 years ago169```
170
171Methods:
172
adb6da3aRobert Craigie1 years ago173- <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>
08b8179aDavid Schnurr2 years ago174
baa9f07fRobert Craigie2 years ago175## Speech
176
ece795f0Stainless Bot1 years ago177Types:
178
179```python
180from openai.types.audio import SpeechModel
181```
182
baa9f07fRobert Craigie2 years ago183Methods:
184
185- <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>
186
08b8179aDavid Schnurr2 years ago187# Moderations
188
189Types:
190
191```python
56e64d9astainless-app[bot]1 years ago192from openai.types import (
193Moderation,
194ModerationImageURLInput,
195ModerationModel,
196ModerationMultiModalInput,
197ModerationTextInput,
198ModerationCreateResponse,
199)
08b8179aDavid Schnurr2 years ago200```
201
202Methods:
203
204- <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>
205
206# Models
207
208Types:
209
210```python
211from openai.types import Model, ModelDeleted
212```
213
214Methods:
215
216- <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>
217- <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>
218- <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>
219
220# FineTuning
221
222## Jobs
223
224Types:
225
226```python
f5247e30Stainless Bot2 years ago227from openai.types.fine_tuning import (
228FineTuningJob,
229FineTuningJobEvent,
230FineTuningJobWandbIntegration,
231FineTuningJobWandbIntegrationObject,
530f9b80stainless-app[bot]1 years ago232FineTuningJobIntegration,
f5247e30Stainless Bot2 years ago233)
234```
235
236Methods:
237
238- <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>
239- <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>
240- <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>
241- <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>
242- <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>
243
244### Checkpoints
245
246Types:
247
248```python
249from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint
08b8179aDavid Schnurr2 years ago250```
251
252Methods:
253
f5247e30Stainless Bot2 years ago254- <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>
08b8179aDavid Schnurr2 years ago255
2954945eRobert Craigie1 years ago256# VectorStores
257
258Types:
259
260```python
261from openai.types import (
262AutoFileChunkingStrategyParam,
263FileChunkingStrategy,
264FileChunkingStrategyParam,
265OtherFileChunkingStrategyObject,
266StaticFileChunkingStrategy,
267StaticFileChunkingStrategyObject,
268StaticFileChunkingStrategyObjectParam,
269VectorStore,
270VectorStoreDeleted,
271VectorStoreSearchResponse,
272)
273```
274
275Methods:
276
277- <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>
278- <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>
279- <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>
280- <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>
281- <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>
282- <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>
283
284## Files
285
286Types:
287
288```python
289from openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse
290```
291
292Methods:
293
294- <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>
295- <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>
296- <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>
297- <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>
298- <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>
299- <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>
300- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">create_and_poll</a>(\*args) -> VectorStoreFile</code>
301- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">poll</a>(\*args) -> VectorStoreFile</code>
302- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload</a>(\*args) -> VectorStoreFile</code>
303- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload_and_poll</a>(\*args) -> VectorStoreFile</code>
304
305## FileBatches
306
307Types:
308
309```python
310from openai.types.vector_stores import VectorStoreFileBatch
311```
312
313Methods:
314
315- <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>
316- <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>
317- <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>
318- <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>
319- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">create_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
320- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">poll</a>(\*args) -> VectorStoreFileBatch</code>
321- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">upload_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
322
baa9f07fRobert Craigie2 years ago323# Beta
324
575ff607stainless-app[bot]1 years ago325## Realtime
326
5fdba486stainless-app[bot]1 years ago327Types:
328
329```python
330from openai.types.beta.realtime import (
331ConversationCreatedEvent,
332ConversationItem,
333ConversationItemContent,
334ConversationItemCreateEvent,
335ConversationItemCreatedEvent,
336ConversationItemDeleteEvent,
337ConversationItemDeletedEvent,
338ConversationItemInputAudioTranscriptionCompletedEvent,
339ConversationItemInputAudioTranscriptionFailedEvent,
340ConversationItemTruncateEvent,
341ConversationItemTruncatedEvent,
f344db25stainless-app[bot]1 years ago342ConversationItemWithReference,
5fdba486stainless-app[bot]1 years ago343ErrorEvent,
344InputAudioBufferAppendEvent,
345InputAudioBufferClearEvent,
346InputAudioBufferClearedEvent,
347InputAudioBufferCommitEvent,
348InputAudioBufferCommittedEvent,
349InputAudioBufferSpeechStartedEvent,
350InputAudioBufferSpeechStoppedEvent,
351RateLimitsUpdatedEvent,
352RealtimeClientEvent,
353RealtimeResponse,
354RealtimeResponseStatus,
355RealtimeResponseUsage,
356RealtimeServerEvent,
357ResponseAudioDeltaEvent,
358ResponseAudioDoneEvent,
359ResponseAudioTranscriptDeltaEvent,
360ResponseAudioTranscriptDoneEvent,
361ResponseCancelEvent,
362ResponseContentPartAddedEvent,
363ResponseContentPartDoneEvent,
364ResponseCreateEvent,
365ResponseCreatedEvent,
366ResponseDoneEvent,
367ResponseFunctionCallArgumentsDeltaEvent,
368ResponseFunctionCallArgumentsDoneEvent,
369ResponseOutputItemAddedEvent,
370ResponseOutputItemDoneEvent,
371ResponseTextDeltaEvent,
372ResponseTextDoneEvent,
373SessionCreatedEvent,
374SessionUpdateEvent,
375SessionUpdatedEvent,
376)
377```
378
575ff607stainless-app[bot]1 years ago379### Sessions
380
381Types:
382
383```python
384from openai.types.beta.realtime import Session, SessionCreateResponse
385```
386
387Methods:
388
389- <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>
390
baa9f07fRobert Craigie2 years ago391## Assistants
392
393Types:
394
395```python
5429f696Stainless Bot2 years ago396from openai.types.beta import (
397Assistant,
398AssistantDeleted,
399AssistantStreamEvent,
400AssistantTool,
401CodeInterpreterTool,
5b20698dStainless Bot2 years ago402FileSearchTool,
5429f696Stainless Bot2 years ago403FunctionTool,
404MessageStreamEvent,
405RunStepStreamEvent,
406RunStreamEvent,
407ThreadStreamEvent,
408)
baa9f07fRobert Craigie2 years ago409```
410
411Methods:
412
5b20698dStainless Bot2 years ago413- <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>
414- <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>
415- <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>
416- <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>
417- <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>
baa9f07fRobert Craigie2 years ago418
419## Threads
420
421Types:
422
423```python
f5247e30Stainless Bot2 years ago424from openai.types.beta import (
425AssistantResponseFormatOption,
426AssistantToolChoice,
427AssistantToolChoiceFunction,
428AssistantToolChoiceOption,
429Thread,
430ThreadDeleted,
431)
baa9f07fRobert Craigie2 years ago432```
433
434Methods:
435
436- <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>
437- <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>
438- <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>
439- <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>
440- <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>
595f3b36Stainless Bot2 years ago441- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_poll</a>(\*args) -> Run</code>
5429f696Stainless Bot2 years ago442- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
baa9f07fRobert Craigie2 years ago443
444### Runs
445
446Types:
447
448```python
f0b18239Stainless Bot2 years ago449from openai.types.beta.threads import RequiredActionFunctionToolCall, Run, RunStatus
baa9f07fRobert Craigie2 years ago450```
451
452Methods:
453
454- <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>
455- <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>
456- <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>
457- <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>
458- <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>
459- <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>
595f3b36Stainless Bot2 years ago460- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">create_and_poll</a>(\*args) -> Run</code>
5429f696Stainless Bot2 years ago461- <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>
595f3b36Stainless Bot2 years ago462- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">poll</a>(\*args) -> Run</code>
463- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
464- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">submit_tool_outputs_and_poll</a>(\*args) -> Run</code>
5429f696Stainless Bot2 years ago465- <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>
baa9f07fRobert Craigie2 years ago466
467#### Steps
468
469Types:
470
471```python
472from openai.types.beta.threads.runs import (
5429f696Stainless Bot2 years ago473CodeInterpreterLogs,
474CodeInterpreterOutputImage,
475CodeInterpreterToolCall,
476CodeInterpreterToolCallDelta,
5b20698dStainless Bot2 years ago477FileSearchToolCall,
478FileSearchToolCallDelta,
baa9f07fRobert Craigie2 years ago479FunctionToolCall,
5429f696Stainless Bot2 years ago480FunctionToolCallDelta,
baa9f07fRobert Craigie2 years ago481MessageCreationStepDetails,
482RunStep,
5429f696Stainless Bot2 years ago483RunStepDelta,
484RunStepDeltaEvent,
485RunStepDeltaMessageDelta,
5d3111a8Stainless Bot1 years ago486RunStepInclude,
5429f696Stainless Bot2 years ago487ToolCall,
488ToolCallDelta,
489ToolCallDeltaObject,
baa9f07fRobert Craigie2 years ago490ToolCallsStepDetails,
491)
492```
493
494Methods:
495
5d3111a8Stainless Bot1 years ago496- <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>
baa9f07fRobert Craigie2 years ago497- <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>
498
499### Messages
500
501Types:
502
503```python
504from openai.types.beta.threads import (
5429f696Stainless Bot2 years ago505Annotation,
506AnnotationDelta,
507FileCitationAnnotation,
508FileCitationDeltaAnnotation,
509FilePathAnnotation,
510FilePathDeltaAnnotation,
511ImageFile,
512ImageFileContentBlock,
513ImageFileDelta,
514ImageFileDeltaBlock,
79a0b401Stainless Bot2 years ago515ImageURL,
516ImageURLContentBlock,
517ImageURLDelta,
518ImageURLDeltaBlock,
5429f696Stainless Bot2 years ago519Message,
520MessageContent,
521MessageContentDelta,
79a0b401Stainless Bot2 years ago522MessageContentPartParam,
5429f696Stainless Bot2 years ago523MessageDeleted,
524MessageDelta,
525MessageDeltaEvent,
bf1ca86cRobert Craigie1 years ago526RefusalContentBlock,
527RefusalDeltaBlock,
5429f696Stainless Bot2 years ago528Text,
529TextContentBlock,
79a0b401Stainless Bot2 years ago530TextContentBlockParam,
5429f696Stainless Bot2 years ago531TextDelta,
532TextDeltaBlock,
baa9f07fRobert Craigie2 years ago533)
534```
535
536Methods:
537
5b20698dStainless Bot2 years ago538- <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>
539- <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>
540- <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>
541- <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>
d2738d42Stainless Bot2 years ago542- <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>
db069cdaStainless Bot2 years ago543
544# Batches
545
546Types:
547
548```python
549from openai.types import Batch, BatchError, BatchRequestCounts
550```
551
552Methods:
553
554- <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>
555- <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>
2edeeb1fStainless Bot2 years ago556- <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>
db069cdaStainless Bot2 years ago557- <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>
24ab406bstainless-app[bot]1 years ago558
559# Uploads
560
561Types:
562
563```python
564from openai.types import Upload
565```
566
567Methods:
568
569- <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>
570- <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>
571- <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>
572
573## Parts
574
575Types:
576
577```python
578from openai.types.uploads import UploadPart
579```
580
581Methods:
582
583- <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>
2954945eRobert Craigie1 years ago584
585# Responses
586
587Types:
588
589```python
590from openai.types.responses import (
591ComputerTool,
592EasyInputMessage,
593FileSearchTool,
594FunctionTool,
595Response,
596ResponseAudioDeltaEvent,
597ResponseAudioDoneEvent,
598ResponseAudioTranscriptDeltaEvent,
599ResponseAudioTranscriptDoneEvent,
600ResponseCodeInterpreterCallCodeDeltaEvent,
601ResponseCodeInterpreterCallCodeDoneEvent,
602ResponseCodeInterpreterCallCompletedEvent,
603ResponseCodeInterpreterCallInProgressEvent,
604ResponseCodeInterpreterCallInterpretingEvent,
605ResponseCodeInterpreterToolCall,
606ResponseCompletedEvent,
607ResponseComputerToolCall,
608ResponseContent,
609ResponseContentPartAddedEvent,
610ResponseContentPartDoneEvent,
611ResponseCreatedEvent,
612ResponseError,
613ResponseErrorEvent,
614ResponseFailedEvent,
615ResponseFileSearchCallCompletedEvent,
616ResponseFileSearchCallInProgressEvent,
617ResponseFileSearchCallSearchingEvent,
618ResponseFileSearchToolCall,
619ResponseFormatTextConfig,
620ResponseFormatTextJSONSchemaConfig,
621ResponseFunctionCallArgumentsDeltaEvent,
622ResponseFunctionCallArgumentsDoneEvent,
623ResponseFunctionToolCall,
624ResponseFunctionWebSearch,
625ResponseInProgressEvent,
626ResponseIncludable,
627ResponseIncompleteEvent,
628ResponseInput,
629ResponseInputAudio,
630ResponseInputContent,
631ResponseInputFile,
632ResponseInputImage,
633ResponseInputItem,
634ResponseInputMessageContentList,
635ResponseInputText,
636ResponseOutputAudio,
637ResponseOutputItem,
638ResponseOutputItemAddedEvent,
639ResponseOutputItemDoneEvent,
640ResponseOutputMessage,
641ResponseOutputRefusal,
642ResponseOutputText,
27ef73fdstainless-app[bot]1 years ago643ResponseReasoningItem,
2954945eRobert Craigie1 years ago644ResponseRefusalDeltaEvent,
645ResponseRefusalDoneEvent,
646ResponseStatus,
647ResponseStreamEvent,
648ResponseTextAnnotationDeltaEvent,
649ResponseTextConfig,
650ResponseTextDeltaEvent,
651ResponseTextDoneEvent,
652ResponseUsage,
653ResponseWebSearchCallCompletedEvent,
654ResponseWebSearchCallInProgressEvent,
655ResponseWebSearchCallSearchingEvent,
656Tool,
657ToolChoiceFunction,
658ToolChoiceOptions,
659ToolChoiceTypes,
660WebSearchTool,
661)
662```
663
664Methods:
665
666- <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>
667- <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>
668- <code title="delete /responses/{response_id}">client.responses.<a href="./src/openai/resources/responses/responses.py">delete</a>(response_id) -> None</code>
669
670## InputItems
671
672Types:
673
674```python
675from openai.types.responses import ResponseItemList
676```
677
678Methods:
679
680- <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>) -> SyncCursorPage[Data]</code>