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
a6e9db84c1952c856c8449536714b7a7daa22d2e

Branches

Tags

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

Clone

HTTPS

Download ZIP

api.md

475lines · modeblame

RawDownload
Latest commit unavailable.
a228a539Stainless Bot2 years ago1# Shared Types
2
3```python
bf1ca86cRobert Craigie1 years ago4from openai.types import (
5ErrorObject,
6FunctionDefinition,
7FunctionParameters,
8ResponseFormatJSONObject,
9ResponseFormatJSONSchema,
10ResponseFormatText,
11)
a228a539Stainless Bot2 years ago12```
13
08b8179aDavid Schnurr2 years ago14# Completions
15
16Types:
17
18```python
19from openai.types import Completion, CompletionChoice, CompletionUsage
20```
21
22Methods:
23
24- <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>
25
26# Chat
27
1dc93403Stainless Bot2 years ago28Types:
29
30```python
31from openai.types import ChatModel
32```
33
08b8179aDavid Schnurr2 years ago34## Completions
35
36Types:
37
38```python
39from openai.types.chat import (
40ChatCompletion,
baa9f07fRobert Craigie2 years ago41ChatCompletionAssistantMessageParam,
08b8179aDavid Schnurr2 years ago42ChatCompletionChunk,
baa9f07fRobert Craigie2 years ago43ChatCompletionContentPart,
44ChatCompletionContentPartImage,
bf1ca86cRobert Craigie1 years ago45ChatCompletionContentPartRefusal,
baa9f07fRobert Craigie2 years ago46ChatCompletionContentPartText,
47ChatCompletionFunctionCallOption,
48ChatCompletionFunctionMessageParam,
08b8179aDavid Schnurr2 years ago49ChatCompletionMessage,
50ChatCompletionMessageParam,
baa9f07fRobert Craigie2 years ago51ChatCompletionMessageToolCall,
52ChatCompletionNamedToolChoice,
08b8179aDavid Schnurr2 years ago53ChatCompletionRole,
6cc51587Stainless Bot2 years ago54ChatCompletionStreamOptions,
baa9f07fRobert Craigie2 years ago55ChatCompletionSystemMessageParam,
ccae821bStainless Bot2 years ago56ChatCompletionTokenLogprob,
baa9f07fRobert Craigie2 years ago57ChatCompletionTool,
58ChatCompletionToolChoiceOption,
59ChatCompletionToolMessageParam,
60ChatCompletionUserMessageParam,
08b8179aDavid Schnurr2 years ago61)
62```
63
64Methods:
65
66- <code title="post /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/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>
67
68# Embeddings
69
70Types:
71
72```python
73from openai.types import CreateEmbeddingResponse, Embedding
74```
75
76Methods:
77
78- <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>
79
80# Files
81
82Types:
83
84```python
05f0132fstainless-app[bot]1 years ago85from openai.types import FileContent, FileDeleted, FileObject, FilePurpose
08b8179aDavid Schnurr2 years ago86```
87
88Methods:
89
90- <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>
91- <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>
baa9f07fRobert Craigie2 years ago92- <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">SyncPage[FileObject]</a></code>
08b8179aDavid Schnurr2 years ago93- <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 ago94- <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">content</a>(file_id) -> HttpxBinaryResponseContent</code>
08b8179aDavid Schnurr2 years ago95- <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">retrieve_content</a>(file_id) -> str</code>
96- <code>client.files.<a href="./src/openai/resources/files.py">wait_for_processing</a>(\*args) -> FileObject</code>
97
98# Images
99
100Types:
101
102```python
ece795f0Stainless Bot1 years ago103from openai.types import Image, ImageModel, ImagesResponse
08b8179aDavid Schnurr2 years ago104```
105
106Methods:
107
108- <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>
109- <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>
110- <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>
111
112# Audio
113
ece795f0Stainless Bot1 years ago114Types:
115
116```python
117from openai.types import AudioModel
118```
119
08b8179aDavid Schnurr2 years ago120## Transcriptions
121
122Types:
123
124```python
125from openai.types.audio import Transcription
126```
127
128Methods:
129
130- <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.py">Transcription</a></code>
131
132## Translations
133
134Types:
135
136```python
137from openai.types.audio import Translation
138```
139
140Methods:
141
142- <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.py">Translation</a></code>
143
baa9f07fRobert Craigie2 years ago144## Speech
145
ece795f0Stainless Bot1 years ago146Types:
147
148```python
149from openai.types.audio import SpeechModel
150```
151
baa9f07fRobert Craigie2 years ago152Methods:
153
154- <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>
155
08b8179aDavid Schnurr2 years ago156# Moderations
157
158Types:
159
160```python
ece795f0Stainless Bot1 years ago161from openai.types import Moderation, ModerationModel, ModerationCreateResponse
08b8179aDavid Schnurr2 years ago162```
163
164Methods:
165
166- <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>
167
168# Models
169
170Types:
171
172```python
173from openai.types import Model, ModelDeleted
174```
175
176Methods:
177
178- <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>
179- <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>
180- <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>
181
182# FineTuning
183
184## Jobs
185
186Types:
187
188```python
f5247e30Stainless Bot2 years ago189from openai.types.fine_tuning import (
190FineTuningJob,
191FineTuningJobEvent,
192FineTuningJobIntegration,
193FineTuningJobWandbIntegration,
194FineTuningJobWandbIntegrationObject,
195)
196```
197
198Methods:
199
200- <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>
201- <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>
202- <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>
203- <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>
204- <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>
205
206### Checkpoints
207
208Types:
209
210```python
211from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint
08b8179aDavid Schnurr2 years ago212```
213
214Methods:
215
f5247e30Stainless Bot2 years ago216- <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 ago217
baa9f07fRobert Craigie2 years ago218# Beta
219
5b20698dStainless Bot2 years ago220## VectorStores
221
222Types:
223
224```python
f161000fStainless Bot1 years ago225from openai.types.beta import (
226AutoFileChunkingStrategyParam,
227FileChunkingStrategy,
228FileChunkingStrategyParam,
229OtherFileChunkingStrategyObject,
230StaticFileChunkingStrategy,
231StaticFileChunkingStrategyObject,
232StaticFileChunkingStrategyParam,
233VectorStore,
234VectorStoreDeleted,
235)
5b20698dStainless Bot2 years ago236```
237
238Methods:
239
240- <code title="post /vector_stores">client.beta.vector_stores.<a href="./src/openai/resources/beta/vector_stores/vector_stores.py">create</a>(\*\*<a href="src/openai/types/beta/vector_store_create_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_store.py">VectorStore</a></code>
241- <code title="get /vector_stores/{vector_store_id}">client.beta.vector_stores.<a href="./src/openai/resources/beta/vector_stores/vector_stores.py">retrieve</a>(vector_store_id) -> <a href="./src/openai/types/beta/vector_store.py">VectorStore</a></code>
242- <code title="post /vector_stores/{vector_store_id}">client.beta.vector_stores.<a href="./src/openai/resources/beta/vector_stores/vector_stores.py">update</a>(vector_store_id, \*\*<a href="src/openai/types/beta/vector_store_update_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_store.py">VectorStore</a></code>
243- <code title="get /vector_stores">client.beta.vector_stores.<a href="./src/openai/resources/beta/vector_stores/vector_stores.py">list</a>(\*\*<a href="src/openai/types/beta/vector_store_list_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_store.py">SyncCursorPage[VectorStore]</a></code>
244- <code title="delete /vector_stores/{vector_store_id}">client.beta.vector_stores.<a href="./src/openai/resources/beta/vector_stores/vector_stores.py">delete</a>(vector_store_id) -> <a href="./src/openai/types/beta/vector_store_deleted.py">VectorStoreDeleted</a></code>
245
246### Files
247
248Types:
249
250```python
251from openai.types.beta.vector_stores import VectorStoreFile, VectorStoreFileDeleted
252```
253
254Methods:
255
256- <code title="post /vector_stores/{vector_store_id}/files">client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">create</a>(vector_store_id, \*\*<a href="src/openai/types/beta/vector_stores/file_create_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
257- <code title="get /vector_stores/{vector_store_id}/files/{file_id}">client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">retrieve</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
258- <code title="get /vector_stores/{vector_store_id}/files">client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">list</a>(vector_store_id, \*\*<a href="src/openai/types/beta/vector_stores/file_list_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file.py">SyncCursorPage[VectorStoreFile]</a></code>
259- <code title="delete /vector_stores/{vector_store_id}/files/{file_id}">client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">delete</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file_deleted.py">VectorStoreFileDeleted</a></code>
260- <code>client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">create_and_poll</a>(\*args) -> VectorStoreFile</code>
261- <code>client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">poll</a>(\*args) -> VectorStoreFile</code>
262- <code>client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">upload</a>(\*args) -> VectorStoreFile</code>
263- <code>client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">upload_and_poll</a>(\*args) -> VectorStoreFile</code>
264
265### FileBatches
266
267Types:
268
269```python
270from openai.types.beta.vector_stores import VectorStoreFileBatch
271```
272
273Methods:
274
275- <code title="post /vector_stores/{vector_store_id}/file_batches">client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">create</a>(vector_store_id, \*\*<a href="src/openai/types/beta/vector_stores/file_batch_create_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
276- <code title="get /vector_stores/{vector_store_id}/file_batches/{batch_id}">client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">retrieve</a>(batch_id, \*, vector_store_id) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
277- <code title="post /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel">client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">cancel</a>(batch_id, \*, vector_store_id) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
278- <code title="get /vector_stores/{vector_store_id}/file_batches/{batch_id}/files">client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">list_files</a>(batch_id, \*, vector_store_id, \*\*<a href="src/openai/types/beta/vector_stores/file_batch_list_files_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file.py">SyncCursorPage[VectorStoreFile]</a></code>
279- <code>client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">create_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
280- <code>client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">poll</a>(\*args) -> VectorStoreFileBatch</code>
281- <code>client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">upload_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
282
baa9f07fRobert Craigie2 years ago283## Assistants
284
285Types:
286
287```python
5429f696Stainless Bot2 years ago288from openai.types.beta import (
289Assistant,
290AssistantDeleted,
291AssistantStreamEvent,
292AssistantTool,
293CodeInterpreterTool,
5b20698dStainless Bot2 years ago294FileSearchTool,
5429f696Stainless Bot2 years ago295FunctionTool,
296MessageStreamEvent,
297RunStepStreamEvent,
298RunStreamEvent,
299ThreadStreamEvent,
300)
baa9f07fRobert Craigie2 years ago301```
302
303Methods:
304
5b20698dStainless Bot2 years ago305- <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>
306- <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>
307- <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>
308- <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>
309- <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 ago310
311## Threads
312
313Types:
314
315```python
f5247e30Stainless Bot2 years ago316from openai.types.beta import (
317AssistantResponseFormatOption,
318AssistantToolChoice,
319AssistantToolChoiceFunction,
320AssistantToolChoiceOption,
321Thread,
322ThreadDeleted,
323)
baa9f07fRobert Craigie2 years ago324```
325
326Methods:
327
328- <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>
329- <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>
330- <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>
331- <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>
332- <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 ago333- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_poll</a>(\*args) -> Run</code>
5429f696Stainless Bot2 years ago334- <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 ago335
336### Runs
337
338Types:
339
340```python
f0b18239Stainless Bot2 years ago341from openai.types.beta.threads import RequiredActionFunctionToolCall, Run, RunStatus
baa9f07fRobert Craigie2 years ago342```
343
344Methods:
345
346- <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>
347- <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>
348- <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>
349- <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>
350- <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>
351- <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 ago352- <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 ago353- <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 ago354- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">poll</a>(\*args) -> Run</code>
355- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
356- <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 ago357- <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 ago358
359#### Steps
360
361Types:
362
363```python
364from openai.types.beta.threads.runs import (
5429f696Stainless Bot2 years ago365CodeInterpreterLogs,
366CodeInterpreterOutputImage,
367CodeInterpreterToolCall,
368CodeInterpreterToolCallDelta,
5b20698dStainless Bot2 years ago369FileSearchToolCall,
370FileSearchToolCallDelta,
baa9f07fRobert Craigie2 years ago371FunctionToolCall,
5429f696Stainless Bot2 years ago372FunctionToolCallDelta,
baa9f07fRobert Craigie2 years ago373MessageCreationStepDetails,
374RunStep,
5429f696Stainless Bot2 years ago375RunStepDelta,
376RunStepDeltaEvent,
377RunStepDeltaMessageDelta,
5d3111a8Stainless Bot1 years ago378RunStepInclude,
5429f696Stainless Bot2 years ago379ToolCall,
380ToolCallDelta,
381ToolCallDeltaObject,
baa9f07fRobert Craigie2 years ago382ToolCallsStepDetails,
383)
384```
385
386Methods:
387
5d3111a8Stainless Bot1 years ago388- <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 ago389- <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>
390
391### Messages
392
393Types:
394
395```python
396from openai.types.beta.threads import (
5429f696Stainless Bot2 years ago397Annotation,
398AnnotationDelta,
399FileCitationAnnotation,
400FileCitationDeltaAnnotation,
401FilePathAnnotation,
402FilePathDeltaAnnotation,
403ImageFile,
404ImageFileContentBlock,
405ImageFileDelta,
406ImageFileDeltaBlock,
79a0b401Stainless Bot2 years ago407ImageURL,
408ImageURLContentBlock,
409ImageURLDelta,
410ImageURLDeltaBlock,
5429f696Stainless Bot2 years ago411Message,
412MessageContent,
413MessageContentDelta,
79a0b401Stainless Bot2 years ago414MessageContentPartParam,
5429f696Stainless Bot2 years ago415MessageDeleted,
416MessageDelta,
417MessageDeltaEvent,
bf1ca86cRobert Craigie1 years ago418RefusalContentBlock,
419RefusalDeltaBlock,
5429f696Stainless Bot2 years ago420Text,
421TextContentBlock,
79a0b401Stainless Bot2 years ago422TextContentBlockParam,
5429f696Stainless Bot2 years ago423TextDelta,
424TextDeltaBlock,
baa9f07fRobert Craigie2 years ago425)
426```
427
428Methods:
429
5b20698dStainless Bot2 years ago430- <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>
431- <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>
432- <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>
433- <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 ago434- <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 ago435
436# Batches
437
438Types:
439
440```python
441from openai.types import Batch, BatchError, BatchRequestCounts
442```
443
444Methods:
445
446- <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>
447- <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 ago448- <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 ago449- <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 ago450
451# Uploads
452
453Types:
454
455```python
456from openai.types import Upload
457```
458
459Methods:
460
461- <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>
462- <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>
463- <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>
464
465## Parts
466
467Types:
468
469```python
470from openai.types.uploads import UploadPart
471```
472
473Methods:
474
475- <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>