GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

openai/openai-python

Public

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

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
v1.99.7

Branches

Tags

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

Clone

HTTPS

Download ZIP

api.md

953lines · modeblame

RawDownload
Latest commit unavailable.
a228a539Stainless Bot2 years ago1# Shared Types
2
3```python
bf1ca86cRobert Craigie1 years ago4from openai.types import (
653dfec4stainless-app[bot]1 years ago5AllModels,
530f9b80stainless-app[bot]1 years ago6ChatModel,
2954945eRobert Craigie1 years ago7ComparisonFilter,
8CompoundFilter,
caf837bbstainless-app[bot]10 months ago9CustomToolInputFormat,
bf1ca86cRobert Craigie1 years ago10ErrorObject,
11FunctionDefinition,
12FunctionParameters,
fdd52476stainless-app[bot]1 years ago13Metadata,
2954945eRobert Craigie1 years ago14Reasoning,
15ReasoningEffort,
bf1ca86cRobert Craigie1 years ago16ResponseFormatJSONObject,
17ResponseFormatJSONSchema,
18ResponseFormatText,
caf837bbstainless-app[bot]10 months ago19ResponseFormatTextGrammar,
20ResponseFormatTextPython,
653dfec4stainless-app[bot]1 years ago21ResponsesModel,
bf1ca86cRobert Craigie1 years ago22)
a228a539Stainless Bot2 years ago23```
24
08b8179aDavid Schnurr2 years ago25# Completions
26
27Types:
28
29```python
30from openai.types import Completion, CompletionChoice, CompletionUsage
31```
32
33Methods:
34
35- <code title="post /completions">client.completions.<a href="./src/openai/resources/completions.py">create</a>(\*\*<a href="src/openai/types/completion_create_params.py">params</a>) -> <a href="./src/openai/types/completion.py">Completion</a></code>
36
37# Chat
38
1dc93403Stainless Bot2 years ago39Types:
40
41```python
42from openai.types import ChatModel
43```
44
08b8179aDavid Schnurr2 years ago45## Completions
46
47Types:
48
49```python
50from openai.types.chat import (
51ChatCompletion,
caf837bbstainless-app[bot]10 months ago52ChatCompletionAllowedToolChoice,
baa9f07fRobert Craigie2 years ago53ChatCompletionAssistantMessageParam,
550b855fstainless-app[bot]1 years ago54ChatCompletionAudio,
55ChatCompletionAudioParam,
08b8179aDavid Schnurr2 years ago56ChatCompletionChunk,
baa9f07fRobert Craigie2 years ago57ChatCompletionContentPart,
58ChatCompletionContentPartImage,
550b855fstainless-app[bot]1 years ago59ChatCompletionContentPartInputAudio,
bf1ca86cRobert Craigie1 years ago60ChatCompletionContentPartRefusal,
baa9f07fRobert Craigie2 years ago61ChatCompletionContentPartText,
caf837bbstainless-app[bot]10 months ago62ChatCompletionCustomTool,
300f58bbstainless-app[bot]1 years ago63ChatCompletionDeleted,
575ff607stainless-app[bot]1 years ago64ChatCompletionDeveloperMessageParam,
baa9f07fRobert Craigie2 years ago65ChatCompletionFunctionCallOption,
66ChatCompletionFunctionMessageParam,
caf837bbstainless-app[bot]10 months ago67ChatCompletionFunctionTool,
08b8179aDavid Schnurr2 years ago68ChatCompletionMessage,
caf837bbstainless-app[bot]10 months ago69ChatCompletionMessageCustomToolCall,
70ChatCompletionMessageFunctionToolCall,
08b8179aDavid Schnurr2 years ago71ChatCompletionMessageParam,
bff85cddstainless-app[bot]10 months ago72ChatCompletionMessageToolCallUnion,
550b855fstainless-app[bot]1 years ago73ChatCompletionModality,
baa9f07fRobert Craigie2 years ago74ChatCompletionNamedToolChoice,
caf837bbstainless-app[bot]10 months ago75ChatCompletionNamedToolChoiceCustom,
dfdcf571Stainless Bot1 years ago76ChatCompletionPredictionContent,
08b8179aDavid Schnurr2 years ago77ChatCompletionRole,
300f58bbstainless-app[bot]1 years ago78ChatCompletionStoreMessage,
6cc51587Stainless Bot2 years ago79ChatCompletionStreamOptions,
baa9f07fRobert Craigie2 years ago80ChatCompletionSystemMessageParam,
ccae821bStainless Bot2 years ago81ChatCompletionTokenLogprob,
458a542astainless-app[bot]10 months ago82ChatCompletionToolUnion,
baa9f07fRobert Craigie2 years ago83ChatCompletionToolChoiceOption,
84ChatCompletionToolMessageParam,
85ChatCompletionUserMessageParam,
caf837bbstainless-app[bot]10 months ago86ChatCompletionAllowedTools,
2954945eRobert Craigie1 years ago87ChatCompletionReasoningEffort,
08b8179aDavid Schnurr2 years ago88)
89```
90
91Methods:
92
300f58bbstainless-app[bot]1 years ago93- <code title="post /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">create</a>(\*\*<a href="src/openai/types/chat/completion_create_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
94- <code title="get /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">retrieve</a>(completion_id) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
95- <code title="post /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">update</a>(completion_id, \*\*<a href="src/openai/types/chat/completion_update_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
96- <code title="get /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">list</a>(\*\*<a href="src/openai/types/chat/completion_list_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">SyncCursorPage[ChatCompletion]</a></code>
97- <code title="delete /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">delete</a>(completion_id) -> <a href="./src/openai/types/chat/chat_completion_deleted.py">ChatCompletionDeleted</a></code>
98
99### Messages
100
101Methods:
102
103- <code title="get /chat/completions/{completion_id}/messages">client.chat.completions.messages.<a href="./src/openai/resources/chat/completions/messages.py">list</a>(completion_id, \*\*<a href="src/openai/types/chat/completions/message_list_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion_store_message.py">SyncCursorPage[ChatCompletionStoreMessage]</a></code>
08b8179aDavid Schnurr2 years ago104
105# Embeddings
106
107Types:
108
109```python
eab2e5a3Stainless Bot1 years ago110from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel
08b8179aDavid Schnurr2 years ago111```
112
113Methods:
114
115- <code title="post /embeddings">client.embeddings.<a href="./src/openai/resources/embeddings.py">create</a>(\*\*<a href="src/openai/types/embedding_create_params.py">params</a>) -> <a href="./src/openai/types/create_embedding_response.py">CreateEmbeddingResponse</a></code>
116
117# Files
118
119Types:
120
121```python
05f0132fstainless-app[bot]1 years ago122from openai.types import FileContent, FileDeleted, FileObject, FilePurpose
08b8179aDavid Schnurr2 years ago123```
124
125Methods:
126
127- <code title="post /files">client.files.<a href="./src/openai/resources/files.py">create</a>(\*\*<a href="src/openai/types/file_create_params.py">params</a>) -> <a href="./src/openai/types/file_object.py">FileObject</a></code>
128- <code title="get /files/{file_id}">client.files.<a href="./src/openai/resources/files.py">retrieve</a>(file_id) -> <a href="./src/openai/types/file_object.py">FileObject</a></code>
dfdcf571Stainless Bot1 years ago129- <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 ago130- <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 ago131- <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 ago132- <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 ago133- <code>client.files.<a href="./src/openai/resources/files.py">wait_for_processing</a>(\*args) -> FileObject</code>
134
135# Images
136
137Types:
138
139```python
a85ad051stainless-app[bot]11 months ago140from openai.types import (
141Image,
142ImageEditCompletedEvent,
143ImageEditPartialImageEvent,
144ImageEditStreamEvent,
145ImageGenCompletedEvent,
146ImageGenPartialImageEvent,
147ImageGenStreamEvent,
148ImageModel,
149ImagesResponse,
150)
08b8179aDavid Schnurr2 years ago151```
152
153Methods:
154
155- <code title="post /images/variations">client.images.<a href="./src/openai/resources/images.py">create_variation</a>(\*\*<a href="src/openai/types/image_create_variation_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
156- <code title="post /images/edits">client.images.<a href="./src/openai/resources/images.py">edit</a>(\*\*<a href="src/openai/types/image_edit_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
157- <code title="post /images/generations">client.images.<a href="./src/openai/resources/images.py">generate</a>(\*\*<a href="src/openai/types/image_generate_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
158
159# Audio
160
ece795f0Stainless Bot1 years ago161Types:
162
163```python
102fce4fStainless Bot1 years ago164from openai.types import AudioModel, AudioResponseFormat
ece795f0Stainless Bot1 years ago165```
166
08b8179aDavid Schnurr2 years ago167## Transcriptions
168
169Types:
170
171```python
adb6da3aRobert Craigie1 years ago172from openai.types.audio import (
173Transcription,
2b4bc759stainless-app[bot]1 years ago174TranscriptionInclude,
adb6da3aRobert Craigie1 years ago175TranscriptionSegment,
2b4bc759stainless-app[bot]1 years ago176TranscriptionStreamEvent,
177TranscriptionTextDeltaEvent,
178TranscriptionTextDoneEvent,
adb6da3aRobert Craigie1 years ago179TranscriptionVerbose,
180TranscriptionWord,
181TranscriptionCreateResponse,
182)
08b8179aDavid Schnurr2 years ago183```
184
185Methods:
186
adb6da3aRobert Craigie1 years ago187- <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 ago188
189## Translations
190
191Types:
192
193```python
adb6da3aRobert Craigie1 years ago194from openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse
08b8179aDavid Schnurr2 years ago195```
196
197Methods:
198
adb6da3aRobert Craigie1 years ago199- <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 ago200
baa9f07fRobert Craigie2 years ago201## Speech
202
ece795f0Stainless Bot1 years ago203Types:
204
205```python
206from openai.types.audio import SpeechModel
207```
208
baa9f07fRobert Craigie2 years ago209Methods:
210
211- <code title="post /audio/speech">client.audio.speech.<a href="./src/openai/resources/audio/speech.py">create</a>(\*\*<a href="src/openai/types/audio/speech_create_params.py">params</a>) -> HttpxBinaryResponseContent</code>
212
08b8179aDavid Schnurr2 years ago213# Moderations
214
215Types:
216
217```python
56e64d9astainless-app[bot]1 years ago218from openai.types import (
219Moderation,
220ModerationImageURLInput,
221ModerationModel,
222ModerationMultiModalInput,
223ModerationTextInput,
224ModerationCreateResponse,
225)
08b8179aDavid Schnurr2 years ago226```
227
228Methods:
229
230- <code title="post /moderations">client.moderations.<a href="./src/openai/resources/moderations.py">create</a>(\*\*<a href="src/openai/types/moderation_create_params.py">params</a>) -> <a href="./src/openai/types/moderation_create_response.py">ModerationCreateResponse</a></code>
231
232# Models
233
234Types:
235
236```python
237from openai.types import Model, ModelDeleted
238```
239
240Methods:
241
242- <code title="get /models/{model}">client.models.<a href="./src/openai/resources/models.py">retrieve</a>(model) -> <a href="./src/openai/types/model.py">Model</a></code>
243- <code title="get /models">client.models.<a href="./src/openai/resources/models.py">list</a>() -> <a href="./src/openai/types/model.py">SyncPage[Model]</a></code>
244- <code title="delete /models/{model}">client.models.<a href="./src/openai/resources/models.py">delete</a>(model) -> <a href="./src/openai/types/model_deleted.py">ModelDeleted</a></code>
245
246# FineTuning
247
a3b8e772stainless-app[bot]1 years ago248## Methods
249
250Types:
251
252```python
253from openai.types.fine_tuning import (
254DpoHyperparameters,
255DpoMethod,
256ReinforcementHyperparameters,
257ReinforcementMethod,
258SupervisedHyperparameters,
259SupervisedMethod,
260)
261```
262
08b8179aDavid Schnurr2 years ago263## Jobs
264
265Types:
266
267```python
f5247e30Stainless Bot2 years ago268from openai.types.fine_tuning import (
269FineTuningJob,
270FineTuningJobEvent,
271FineTuningJobWandbIntegration,
272FineTuningJobWandbIntegrationObject,
530f9b80stainless-app[bot]1 years ago273FineTuningJobIntegration,
f5247e30Stainless Bot2 years ago274)
275```
276
277Methods:
278
279- <code title="post /fine_tuning/jobs">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">create</a>(\*\*<a href="src/openai/types/fine_tuning/job_create_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
280- <code title="get /fine_tuning/jobs/{fine_tuning_job_id}">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">retrieve</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
281- <code title="get /fine_tuning/jobs">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">list</a>(\*\*<a href="src/openai/types/fine_tuning/job_list_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">SyncCursorPage[FineTuningJob]</a></code>
282- <code title="post /fine_tuning/jobs/{fine_tuning_job_id}/cancel">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">cancel</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
283- <code title="get /fine_tuning/jobs/{fine_tuning_job_id}/events">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">list_events</a>(fine_tuning_job_id, \*\*<a href="src/openai/types/fine_tuning/job_list_events_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job_event.py">SyncCursorPage[FineTuningJobEvent]</a></code>
a3b8e772stainless-app[bot]1 years ago284- <code title="post /fine_tuning/jobs/{fine_tuning_job_id}/pause">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">pause</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
285- <code title="post /fine_tuning/jobs/{fine_tuning_job_id}/resume">client.fine_tuning.jobs.<a href="./src/openai/resources/fine_tuning/jobs/jobs.py">resume</a>(fine_tuning_job_id) -> <a href="./src/openai/types/fine_tuning/fine_tuning_job.py">FineTuningJob</a></code>
f5247e30Stainless Bot2 years ago286
287### Checkpoints
288
289Types:
290
291```python
292from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint
08b8179aDavid Schnurr2 years ago293```
294
295Methods:
296
f5247e30Stainless Bot2 years ago297- <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 ago298
8da9f46bstainless-app[bot]1 years ago299## Checkpoints
300
301### Permissions
302
303Types:
304
305```python
306from openai.types.fine_tuning.checkpoints import (
307PermissionCreateResponse,
308PermissionRetrieveResponse,
309PermissionDeleteResponse,
310)
311```
312
313Methods:
314
315- <code title="post /fine_tuning/checkpoints/{fine_tuned_model_checkpoint}/permissions">client.fine_tuning.checkpoints.permissions.<a href="./src/openai/resources/fine_tuning/checkpoints/permissions.py">create</a>(fine_tuned_model_checkpoint, \*\*<a href="src/openai/types/fine_tuning/checkpoints/permission_create_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/checkpoints/permission_create_response.py">SyncPage[PermissionCreateResponse]</a></code>
0673da62stainless-app[bot]1 years ago316- <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>
6321004astainless-app[bot]1 years ago317- <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>
8da9f46bstainless-app[bot]1 years ago318
a3b8e772stainless-app[bot]1 years ago319## Alpha
320
321### Graders
322
323Types:
324
325```python
326from openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse
327```
328
329Methods:
330
331- <code title="post /fine_tuning/alpha/graders/run">client.fine_tuning.alpha.graders.<a href="./src/openai/resources/fine_tuning/alpha/graders.py">run</a>(\*\*<a href="src/openai/types/fine_tuning/alpha/grader_run_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/alpha/grader_run_response.py">GraderRunResponse</a></code>
332- <code title="post /fine_tuning/alpha/graders/validate">client.fine_tuning.alpha.graders.<a href="./src/openai/resources/fine_tuning/alpha/graders.py">validate</a>(\*\*<a href="src/openai/types/fine_tuning/alpha/grader_validate_params.py">params</a>) -> <a href="./src/openai/types/fine_tuning/alpha/grader_validate_response.py">GraderValidateResponse</a></code>
333
334# Graders
335
336## GraderModels
337
338Types:
339
340```python
341from openai.types.graders import (
342LabelModelGrader,
343MultiGrader,
344PythonGrader,
345ScoreModelGrader,
346StringCheckGrader,
347TextSimilarityGrader,
348)
349```
350
2954945eRobert Craigie1 years ago351# VectorStores
352
353Types:
354
355```python
356from openai.types import (
357AutoFileChunkingStrategyParam,
358FileChunkingStrategy,
359FileChunkingStrategyParam,
360OtherFileChunkingStrategyObject,
361StaticFileChunkingStrategy,
362StaticFileChunkingStrategyObject,
363StaticFileChunkingStrategyObjectParam,
364VectorStore,
365VectorStoreDeleted,
366VectorStoreSearchResponse,
367)
368```
369
370Methods:
371
372- <code title="post /vector_stores">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">create</a>(\*\*<a href="src/openai/types/vector_store_create_params.py">params</a>) -> <a href="./src/openai/types/vector_store.py">VectorStore</a></code>
373- <code title="get /vector_stores/{vector_store_id}">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">retrieve</a>(vector_store_id) -> <a href="./src/openai/types/vector_store.py">VectorStore</a></code>
374- <code title="post /vector_stores/{vector_store_id}">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">update</a>(vector_store_id, \*\*<a href="src/openai/types/vector_store_update_params.py">params</a>) -> <a href="./src/openai/types/vector_store.py">VectorStore</a></code>
375- <code title="get /vector_stores">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">list</a>(\*\*<a href="src/openai/types/vector_store_list_params.py">params</a>) -> <a href="./src/openai/types/vector_store.py">SyncCursorPage[VectorStore]</a></code>
376- <code title="delete /vector_stores/{vector_store_id}">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">delete</a>(vector_store_id) -> <a href="./src/openai/types/vector_store_deleted.py">VectorStoreDeleted</a></code>
377- <code title="post /vector_stores/{vector_store_id}/search">client.vector_stores.<a href="./src/openai/resources/vector_stores/vector_stores.py">search</a>(vector_store_id, \*\*<a href="src/openai/types/vector_store_search_params.py">params</a>) -> <a href="./src/openai/types/vector_store_search_response.py">SyncPage[VectorStoreSearchResponse]</a></code>
378
379## Files
380
381Types:
382
383```python
384from openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse
385```
386
387Methods:
388
389- <code title="post /vector_stores/{vector_store_id}/files">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">create</a>(vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_create_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
390- <code title="get /vector_stores/{vector_store_id}/files/{file_id}">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">retrieve</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
391- <code title="post /vector_stores/{vector_store_id}/files/{file_id}">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">update</a>(file_id, \*, vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_update_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
392- <code title="get /vector_stores/{vector_store_id}/files">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">list</a>(vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_list_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">SyncCursorPage[VectorStoreFile]</a></code>
393- <code title="delete /vector_stores/{vector_store_id}/files/{file_id}">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">delete</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file_deleted.py">VectorStoreFileDeleted</a></code>
394- <code title="get /vector_stores/{vector_store_id}/files/{file_id}/content">client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">content</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/file_content_response.py">SyncPage[FileContentResponse]</a></code>
395- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">create_and_poll</a>(\*args) -> VectorStoreFile</code>
396- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">poll</a>(\*args) -> VectorStoreFile</code>
397- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload</a>(\*args) -> VectorStoreFile</code>
398- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload_and_poll</a>(\*args) -> VectorStoreFile</code>
399
400## FileBatches
401
402Types:
403
404```python
405from openai.types.vector_stores import VectorStoreFileBatch
406```
407
408Methods:
409
410- <code title="post /vector_stores/{vector_store_id}/file_batches">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">create</a>(vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_batch_create_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
411- <code title="get /vector_stores/{vector_store_id}/file_batches/{batch_id}">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">retrieve</a>(batch_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
412- <code title="post /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">cancel</a>(batch_id, \*, vector_store_id) -> <a href="./src/openai/types/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
413- <code title="get /vector_stores/{vector_store_id}/file_batches/{batch_id}/files">client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">list_files</a>(batch_id, \*, vector_store_id, \*\*<a href="src/openai/types/vector_stores/file_batch_list_files_params.py">params</a>) -> <a href="./src/openai/types/vector_stores/vector_store_file.py">SyncCursorPage[VectorStoreFile]</a></code>
414- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">create_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
415- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">poll</a>(\*args) -> VectorStoreFileBatch</code>
416- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">upload_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
417
18e0b36astainless-app[bot]1 years ago418# Webhooks
419
420Types:
421
422```python
423from openai.types.webhooks import (
424BatchCancelledWebhookEvent,
425BatchCompletedWebhookEvent,
426BatchExpiredWebhookEvent,
427BatchFailedWebhookEvent,
428EvalRunCanceledWebhookEvent,
429EvalRunFailedWebhookEvent,
430EvalRunSucceededWebhookEvent,
431FineTuningJobCancelledWebhookEvent,
432FineTuningJobFailedWebhookEvent,
433FineTuningJobSucceededWebhookEvent,
434ResponseCancelledWebhookEvent,
435ResponseCompletedWebhookEvent,
436ResponseFailedWebhookEvent,
437ResponseIncompleteWebhookEvent,
438UnwrapWebhookEvent,
439)
440```
441
442Methods:
443
444- <code>client.webhooks.<a href="./src/openai/resources/webhooks.py">unwrap</a>(payload, headers, \*, secret) -> UnwrapWebhookEvent</code>
445- <code>client.webhooks.<a href="./src/openai/resources/webhooks.py">verify_signature</a>(payload, headers, \*, secret, tolerance) -> None</code>
446
baa9f07fRobert Craigie2 years ago447# Beta
448
575ff607stainless-app[bot]1 years ago449## Realtime
450
5fdba486stainless-app[bot]1 years ago451Types:
452
453```python
454from openai.types.beta.realtime import (
455ConversationCreatedEvent,
456ConversationItem,
457ConversationItemContent,
458ConversationItemCreateEvent,
459ConversationItemCreatedEvent,
460ConversationItemDeleteEvent,
461ConversationItemDeletedEvent,
462ConversationItemInputAudioTranscriptionCompletedEvent,
2b4bc759stainless-app[bot]1 years ago463ConversationItemInputAudioTranscriptionDeltaEvent,
5fdba486stainless-app[bot]1 years ago464ConversationItemInputAudioTranscriptionFailedEvent,
2b4bc759stainless-app[bot]1 years ago465ConversationItemRetrieveEvent,
5fdba486stainless-app[bot]1 years ago466ConversationItemTruncateEvent,
467ConversationItemTruncatedEvent,
f344db25stainless-app[bot]1 years ago468ConversationItemWithReference,
5fdba486stainless-app[bot]1 years ago469ErrorEvent,
470InputAudioBufferAppendEvent,
471InputAudioBufferClearEvent,
472InputAudioBufferClearedEvent,
473InputAudioBufferCommitEvent,
474InputAudioBufferCommittedEvent,
475InputAudioBufferSpeechStartedEvent,
476InputAudioBufferSpeechStoppedEvent,
477RateLimitsUpdatedEvent,
478RealtimeClientEvent,
479RealtimeResponse,
480RealtimeResponseStatus,
481RealtimeResponseUsage,
482RealtimeServerEvent,
483ResponseAudioDeltaEvent,
484ResponseAudioDoneEvent,
485ResponseAudioTranscriptDeltaEvent,
486ResponseAudioTranscriptDoneEvent,
487ResponseCancelEvent,
488ResponseContentPartAddedEvent,
489ResponseContentPartDoneEvent,
490ResponseCreateEvent,
491ResponseCreatedEvent,
492ResponseDoneEvent,
493ResponseFunctionCallArgumentsDeltaEvent,
494ResponseFunctionCallArgumentsDoneEvent,
495ResponseOutputItemAddedEvent,
496ResponseOutputItemDoneEvent,
497ResponseTextDeltaEvent,
498ResponseTextDoneEvent,
499SessionCreatedEvent,
500SessionUpdateEvent,
501SessionUpdatedEvent,
2b4bc759stainless-app[bot]1 years ago502TranscriptionSessionUpdate,
503TranscriptionSessionUpdatedEvent,
5fdba486stainless-app[bot]1 years ago504)
505```
506
575ff607stainless-app[bot]1 years ago507### Sessions
508
509Types:
510
511```python
512from openai.types.beta.realtime import Session, SessionCreateResponse
513```
514
515Methods:
516
517- <code title="post /realtime/sessions">client.beta.realtime.sessions.<a href="./src/openai/resources/beta/realtime/sessions.py">create</a>(\*\*<a href="src/openai/types/beta/realtime/session_create_params.py">params</a>) -> <a href="./src/openai/types/beta/realtime/session_create_response.py">SessionCreateResponse</a></code>
518
2b4bc759stainless-app[bot]1 years ago519### TranscriptionSessions
520
521Types:
522
523```python
524from openai.types.beta.realtime import TranscriptionSession
525```
526
527Methods:
528
529- <code title="post /realtime/transcription_sessions">client.beta.realtime.transcription_sessions.<a href="./src/openai/resources/beta/realtime/transcription_sessions.py">create</a>(\*\*<a href="src/openai/types/beta/realtime/transcription_session_create_params.py">params</a>) -> <a href="./src/openai/types/beta/realtime/transcription_session.py">TranscriptionSession</a></code>
530
baa9f07fRobert Craigie2 years ago531## Assistants
532
533Types:
534
535```python
5429f696Stainless Bot2 years ago536from openai.types.beta import (
537Assistant,
538AssistantDeleted,
539AssistantStreamEvent,
540AssistantTool,
541CodeInterpreterTool,
5b20698dStainless Bot2 years ago542FileSearchTool,
5429f696Stainless Bot2 years ago543FunctionTool,
544MessageStreamEvent,
545RunStepStreamEvent,
546RunStreamEvent,
547ThreadStreamEvent,
548)
baa9f07fRobert Craigie2 years ago549```
550
551Methods:
552
5b20698dStainless Bot2 years ago553- <code title="post /assistants">client.beta.assistants.<a href="./src/openai/resources/beta/assistants.py">create</a>(\*\*<a href="src/openai/types/beta/assistant_create_params.py">params</a>) -> <a href="./src/openai/types/beta/assistant.py">Assistant</a></code>
554- <code title="get /assistants/{assistant_id}">client.beta.assistants.<a href="./src/openai/resources/beta/assistants.py">retrieve</a>(assistant_id) -> <a href="./src/openai/types/beta/assistant.py">Assistant</a></code>
555- <code title="post /assistants/{assistant_id}">client.beta.assistants.<a href="./src/openai/resources/beta/assistants.py">update</a>(assistant_id, \*\*<a href="src/openai/types/beta/assistant_update_params.py">params</a>) -> <a href="./src/openai/types/beta/assistant.py">Assistant</a></code>
556- <code title="get /assistants">client.beta.assistants.<a href="./src/openai/resources/beta/assistants.py">list</a>(\*\*<a href="src/openai/types/beta/assistant_list_params.py">params</a>) -> <a href="./src/openai/types/beta/assistant.py">SyncCursorPage[Assistant]</a></code>
557- <code title="delete /assistants/{assistant_id}">client.beta.assistants.<a href="./src/openai/resources/beta/assistants.py">delete</a>(assistant_id) -> <a href="./src/openai/types/beta/assistant_deleted.py">AssistantDeleted</a></code>
baa9f07fRobert Craigie2 years ago558
559## Threads
560
561Types:
562
563```python
f5247e30Stainless Bot2 years ago564from openai.types.beta import (
565AssistantResponseFormatOption,
566AssistantToolChoice,
567AssistantToolChoiceFunction,
568AssistantToolChoiceOption,
569Thread,
570ThreadDeleted,
571)
baa9f07fRobert Craigie2 years ago572```
573
574Methods:
575
576- <code title="post /threads">client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create</a>(\*\*<a href="src/openai/types/beta/thread_create_params.py">params</a>) -> <a href="./src/openai/types/beta/thread.py">Thread</a></code>
577- <code title="get /threads/{thread_id}">client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">retrieve</a>(thread_id) -> <a href="./src/openai/types/beta/thread.py">Thread</a></code>
578- <code title="post /threads/{thread_id}">client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">update</a>(thread_id, \*\*<a href="src/openai/types/beta/thread_update_params.py">params</a>) -> <a href="./src/openai/types/beta/thread.py">Thread</a></code>
579- <code title="delete /threads/{thread_id}">client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">delete</a>(thread_id) -> <a href="./src/openai/types/beta/thread_deleted.py">ThreadDeleted</a></code>
580- <code title="post /threads/runs">client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run</a>(\*\*<a href="src/openai/types/beta/thread_create_and_run_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
595f3b36Stainless Bot2 years ago581- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_poll</a>(\*args) -> Run</code>
5429f696Stainless Bot2 years ago582- <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 ago583
584### Runs
585
586Types:
587
588```python
f0b18239Stainless Bot2 years ago589from openai.types.beta.threads import RequiredActionFunctionToolCall, Run, RunStatus
baa9f07fRobert Craigie2 years ago590```
591
592Methods:
593
594- <code title="post /threads/{thread_id}/runs">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">create</a>(thread_id, \*\*<a href="src/openai/types/beta/threads/run_create_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
595- <code title="get /threads/{thread_id}/runs/{run_id}">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">retrieve</a>(run_id, \*, thread_id) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
596- <code title="post /threads/{thread_id}/runs/{run_id}">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">update</a>(run_id, \*, thread_id, \*\*<a href="src/openai/types/beta/threads/run_update_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
597- <code title="get /threads/{thread_id}/runs">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">list</a>(thread_id, \*\*<a href="src/openai/types/beta/threads/run_list_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/run.py">SyncCursorPage[Run]</a></code>
598- <code title="post /threads/{thread_id}/runs/{run_id}/cancel">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">cancel</a>(run_id, \*, thread_id) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
599- <code title="post /threads/{thread_id}/runs/{run_id}/submit_tool_outputs">client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">submit_tool_outputs</a>(run_id, \*, thread_id, \*\*<a href="src/openai/types/beta/threads/run_submit_tool_outputs_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/run.py">Run</a></code>
595f3b36Stainless Bot2 years ago600- <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 ago601- <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 ago602- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">poll</a>(\*args) -> Run</code>
603- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
604- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">submit_tool_outputs_and_poll</a>(\*args) -> Run</code>
5429f696Stainless Bot2 years ago605- <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 ago606
607#### Steps
608
609Types:
610
611```python
612from openai.types.beta.threads.runs import (
5429f696Stainless Bot2 years ago613CodeInterpreterLogs,
614CodeInterpreterOutputImage,
615CodeInterpreterToolCall,
616CodeInterpreterToolCallDelta,
5b20698dStainless Bot2 years ago617FileSearchToolCall,
618FileSearchToolCallDelta,
baa9f07fRobert Craigie2 years ago619FunctionToolCall,
5429f696Stainless Bot2 years ago620FunctionToolCallDelta,
baa9f07fRobert Craigie2 years ago621MessageCreationStepDetails,
622RunStep,
5429f696Stainless Bot2 years ago623RunStepDelta,
624RunStepDeltaEvent,
625RunStepDeltaMessageDelta,
5d3111a8Stainless Bot1 years ago626RunStepInclude,
5429f696Stainless Bot2 years ago627ToolCall,
628ToolCallDelta,
629ToolCallDeltaObject,
baa9f07fRobert Craigie2 years ago630ToolCallsStepDetails,
631)
632```
633
634Methods:
635
5d3111a8Stainless Bot1 years ago636- <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 ago637- <code title="get /threads/{thread_id}/runs/{run_id}/steps">client.beta.threads.runs.steps.<a href="./src/openai/resources/beta/threads/runs/steps.py">list</a>(run_id, \*, thread_id, \*\*<a href="src/openai/types/beta/threads/runs/step_list_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/runs/run_step.py">SyncCursorPage[RunStep]</a></code>
638
639### Messages
640
641Types:
642
643```python
644from openai.types.beta.threads import (
5429f696Stainless Bot2 years ago645Annotation,
646AnnotationDelta,
647FileCitationAnnotation,
648FileCitationDeltaAnnotation,
649FilePathAnnotation,
650FilePathDeltaAnnotation,
651ImageFile,
652ImageFileContentBlock,
653ImageFileDelta,
654ImageFileDeltaBlock,
79a0b401Stainless Bot2 years ago655ImageURL,
656ImageURLContentBlock,
657ImageURLDelta,
658ImageURLDeltaBlock,
5429f696Stainless Bot2 years ago659Message,
660MessageContent,
661MessageContentDelta,
79a0b401Stainless Bot2 years ago662MessageContentPartParam,
5429f696Stainless Bot2 years ago663MessageDeleted,
664MessageDelta,
665MessageDeltaEvent,
bf1ca86cRobert Craigie1 years ago666RefusalContentBlock,
667RefusalDeltaBlock,
5429f696Stainless Bot2 years ago668Text,
669TextContentBlock,
79a0b401Stainless Bot2 years ago670TextContentBlockParam,
5429f696Stainless Bot2 years ago671TextDelta,
672TextDeltaBlock,
baa9f07fRobert Craigie2 years ago673)
674```
675
676Methods:
677
5b20698dStainless Bot2 years ago678- <code title="post /threads/{thread_id}/messages">client.beta.threads.messages.<a href="./src/openai/resources/beta/threads/messages.py">create</a>(thread_id, \*\*<a href="src/openai/types/beta/threads/message_create_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/message.py">Message</a></code>
679- <code title="get /threads/{thread_id}/messages/{message_id}">client.beta.threads.messages.<a href="./src/openai/resources/beta/threads/messages.py">retrieve</a>(message_id, \*, thread_id) -> <a href="./src/openai/types/beta/threads/message.py">Message</a></code>
680- <code title="post /threads/{thread_id}/messages/{message_id}">client.beta.threads.messages.<a href="./src/openai/resources/beta/threads/messages.py">update</a>(message_id, \*, thread_id, \*\*<a href="src/openai/types/beta/threads/message_update_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/message.py">Message</a></code>
681- <code title="get /threads/{thread_id}/messages">client.beta.threads.messages.<a href="./src/openai/resources/beta/threads/messages.py">list</a>(thread_id, \*\*<a href="src/openai/types/beta/threads/message_list_params.py">params</a>) -> <a href="./src/openai/types/beta/threads/message.py">SyncCursorPage[Message]</a></code>
d2738d42Stainless Bot2 years ago682- <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 ago683
684# Batches
685
686Types:
687
688```python
689from openai.types import Batch, BatchError, BatchRequestCounts
690```
691
692Methods:
693
694- <code title="post /batches">client.batches.<a href="./src/openai/resources/batches.py">create</a>(\*\*<a href="src/openai/types/batch_create_params.py">params</a>) -> <a href="./src/openai/types/batch.py">Batch</a></code>
695- <code title="get /batches/{batch_id}">client.batches.<a href="./src/openai/resources/batches.py">retrieve</a>(batch_id) -> <a href="./src/openai/types/batch.py">Batch</a></code>
2edeeb1fStainless Bot2 years ago696- <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 ago697- <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 ago698
699# Uploads
700
701Types:
702
703```python
704from openai.types import Upload
705```
706
707Methods:
708
709- <code title="post /uploads">client.uploads.<a href="./src/openai/resources/uploads/uploads.py">create</a>(\*\*<a href="src/openai/types/upload_create_params.py">params</a>) -> <a href="./src/openai/types/upload.py">Upload</a></code>
710- <code title="post /uploads/{upload_id}/cancel">client.uploads.<a href="./src/openai/resources/uploads/uploads.py">cancel</a>(upload_id) -> <a href="./src/openai/types/upload.py">Upload</a></code>
711- <code title="post /uploads/{upload_id}/complete">client.uploads.<a href="./src/openai/resources/uploads/uploads.py">complete</a>(upload_id, \*\*<a href="src/openai/types/upload_complete_params.py">params</a>) -> <a href="./src/openai/types/upload.py">Upload</a></code>
712
713## Parts
714
715Types:
716
717```python
718from openai.types.uploads import UploadPart
719```
720
721Methods:
722
723- <code title="post /uploads/{upload_id}/parts">client.uploads.parts.<a href="./src/openai/resources/uploads/parts.py">create</a>(upload_id, \*\*<a href="src/openai/types/uploads/part_create_params.py">params</a>) -> <a href="./src/openai/types/uploads/upload_part.py">UploadPart</a></code>
2954945eRobert Craigie1 years ago724
725# Responses
726
727Types:
728
729```python
730from openai.types.responses import (
731ComputerTool,
caf837bbstainless-app[bot]10 months ago732CustomTool,
2954945eRobert Craigie1 years ago733EasyInputMessage,
734FileSearchTool,
735FunctionTool,
736Response,
737ResponseAudioDeltaEvent,
738ResponseAudioDoneEvent,
739ResponseAudioTranscriptDeltaEvent,
740ResponseAudioTranscriptDoneEvent,
741ResponseCodeInterpreterCallCodeDeltaEvent,
742ResponseCodeInterpreterCallCodeDoneEvent,
743ResponseCodeInterpreterCallCompletedEvent,
744ResponseCodeInterpreterCallInProgressEvent,
745ResponseCodeInterpreterCallInterpretingEvent,
746ResponseCodeInterpreterToolCall,
747ResponseCompletedEvent,
748ResponseComputerToolCall,
bff8da95stainless-app[bot]1 years ago749ResponseComputerToolCallOutputItem,
750ResponseComputerToolCallOutputScreenshot,
2954945eRobert Craigie1 years ago751ResponseContent,
752ResponseContentPartAddedEvent,
753ResponseContentPartDoneEvent,
754ResponseCreatedEvent,
caf837bbstainless-app[bot]10 months ago755ResponseCustomToolCall,
756ResponseCustomToolCallInputDeltaEvent,
757ResponseCustomToolCallInputDoneEvent,
758ResponseCustomToolCallOutput,
2954945eRobert Craigie1 years ago759ResponseError,
760ResponseErrorEvent,
761ResponseFailedEvent,
762ResponseFileSearchCallCompletedEvent,
763ResponseFileSearchCallInProgressEvent,
764ResponseFileSearchCallSearchingEvent,
765ResponseFileSearchToolCall,
766ResponseFormatTextConfig,
767ResponseFormatTextJSONSchemaConfig,
768ResponseFunctionCallArgumentsDeltaEvent,
769ResponseFunctionCallArgumentsDoneEvent,
770ResponseFunctionToolCall,
bff8da95stainless-app[bot]1 years ago771ResponseFunctionToolCallItem,
772ResponseFunctionToolCallOutputItem,
2954945eRobert Craigie1 years ago773ResponseFunctionWebSearch,
4a81b4edstainless-app[bot]1 years ago774ResponseImageGenCallCompletedEvent,
775ResponseImageGenCallGeneratingEvent,
776ResponseImageGenCallInProgressEvent,
777ResponseImageGenCallPartialImageEvent,
2954945eRobert Craigie1 years ago778ResponseInProgressEvent,
779ResponseIncludable,
780ResponseIncompleteEvent,
781ResponseInput,
782ResponseInputAudio,
783ResponseInputContent,
784ResponseInputFile,
785ResponseInputImage,
786ResponseInputItem,
787ResponseInputMessageContentList,
bff8da95stainless-app[bot]1 years ago788ResponseInputMessageItem,
2954945eRobert Craigie1 years ago789ResponseInputText,
bff8da95stainless-app[bot]1 years ago790ResponseItem,
4a81b4edstainless-app[bot]1 years ago791ResponseMcpCallArgumentsDeltaEvent,
792ResponseMcpCallArgumentsDoneEvent,
793ResponseMcpCallCompletedEvent,
794ResponseMcpCallFailedEvent,
795ResponseMcpCallInProgressEvent,
796ResponseMcpListToolsCompletedEvent,
797ResponseMcpListToolsFailedEvent,
798ResponseMcpListToolsInProgressEvent,
2954945eRobert Craigie1 years ago799ResponseOutputAudio,
800ResponseOutputItem,
801ResponseOutputItemAddedEvent,
802ResponseOutputItemDoneEvent,
803ResponseOutputMessage,
804ResponseOutputRefusal,
805ResponseOutputText,
4a81b4edstainless-app[bot]1 years ago806ResponseOutputTextAnnotationAddedEvent,
cc2c1fc1stainless-app[bot]1 years ago807ResponsePrompt,
4a81b4edstainless-app[bot]1 years ago808ResponseQueuedEvent,
27ef73fdstainless-app[bot]1 years ago809ResponseReasoningItem,
6321004astainless-app[bot]1 years ago810ResponseReasoningSummaryPartAddedEvent,
811ResponseReasoningSummaryPartDoneEvent,
812ResponseReasoningSummaryTextDeltaEvent,
813ResponseReasoningSummaryTextDoneEvent,
2026d533stainless-app[bot]10 months ago814ResponseReasoningTextDeltaEvent,
815ResponseReasoningTextDoneEvent,
2954945eRobert Craigie1 years ago816ResponseRefusalDeltaEvent,
817ResponseRefusalDoneEvent,
818ResponseStatus,
819ResponseStreamEvent,
820ResponseTextConfig,
821ResponseTextDeltaEvent,
822ResponseTextDoneEvent,
823ResponseUsage,
824ResponseWebSearchCallCompletedEvent,
825ResponseWebSearchCallInProgressEvent,
826ResponseWebSearchCallSearchingEvent,
827Tool,
caf837bbstainless-app[bot]10 months ago828ToolChoiceAllowed,
829ToolChoiceCustom,
2954945eRobert Craigie1 years ago830ToolChoiceFunction,
18e0b36astainless-app[bot]1 years ago831ToolChoiceMcp,
2954945eRobert Craigie1 years ago832ToolChoiceOptions,
833ToolChoiceTypes,
834WebSearchTool,
835)
836```
837
838Methods:
839
840- <code title="post /responses">client.responses.<a href="./src/openai/resources/responses/responses.py">create</a>(\*\*<a href="src/openai/types/responses/response_create_params.py">params</a>) -> <a href="./src/openai/types/responses/response.py">Response</a></code>
841- <code title="get /responses/{response_id}">client.responses.<a href="./src/openai/resources/responses/responses.py">retrieve</a>(response_id, \*\*<a href="src/openai/types/responses/response_retrieve_params.py">params</a>) -> <a href="./src/openai/types/responses/response.py">Response</a></code>
842- <code title="delete /responses/{response_id}">client.responses.<a href="./src/openai/resources/responses/responses.py">delete</a>(response_id) -> None</code>
cca09707stainless-app[bot]1 years ago843- <code title="post /responses/{response_id}/cancel">client.responses.<a href="./src/openai/resources/responses/responses.py">cancel</a>(response_id) -> <a href="./src/openai/types/responses/response.py">Response</a></code>
2954945eRobert Craigie1 years ago844
845## InputItems
846
847Types:
848
849```python
850from openai.types.responses import ResponseItemList
851```
852
853Methods:
854
bff8da95stainless-app[bot]1 years ago855- <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>
8da9f46bstainless-app[bot]1 years ago856
857# Evals
858
859Types:
860
861```python
862from openai.types import (
863EvalCustomDataSourceConfig,
864EvalStoredCompletionsDataSourceConfig,
865EvalCreateResponse,
866EvalRetrieveResponse,
867EvalUpdateResponse,
868EvalListResponse,
869EvalDeleteResponse,
870)
871```
872
873Methods:
874
875- <code title="post /evals">client.evals.<a href="./src/openai/resources/evals/evals.py">create</a>(\*\*<a href="src/openai/types/eval_create_params.py">params</a>) -> <a href="./src/openai/types/eval_create_response.py">EvalCreateResponse</a></code>
876- <code title="get /evals/{eval_id}">client.evals.<a href="./src/openai/resources/evals/evals.py">retrieve</a>(eval_id) -> <a href="./src/openai/types/eval_retrieve_response.py">EvalRetrieveResponse</a></code>
877- <code title="post /evals/{eval_id}">client.evals.<a href="./src/openai/resources/evals/evals.py">update</a>(eval_id, \*\*<a href="src/openai/types/eval_update_params.py">params</a>) -> <a href="./src/openai/types/eval_update_response.py">EvalUpdateResponse</a></code>
878- <code title="get /evals">client.evals.<a href="./src/openai/resources/evals/evals.py">list</a>(\*\*<a href="src/openai/types/eval_list_params.py">params</a>) -> <a href="./src/openai/types/eval_list_response.py">SyncCursorPage[EvalListResponse]</a></code>
879- <code title="delete /evals/{eval_id}">client.evals.<a href="./src/openai/resources/evals/evals.py">delete</a>(eval_id) -> <a href="./src/openai/types/eval_delete_response.py">EvalDeleteResponse</a></code>
880
881## Runs
882
883Types:
884
885```python
886from openai.types.evals import (
887CreateEvalCompletionsRunDataSource,
888CreateEvalJSONLRunDataSource,
889EvalAPIError,
890RunCreateResponse,
891RunRetrieveResponse,
892RunListResponse,
893RunDeleteResponse,
894RunCancelResponse,
895)
896```
897
898Methods:
899
900- <code title="post /evals/{eval_id}/runs">client.evals.runs.<a href="./src/openai/resources/evals/runs/runs.py">create</a>(eval_id, \*\*<a href="src/openai/types/evals/run_create_params.py">params</a>) -> <a href="./src/openai/types/evals/run_create_response.py">RunCreateResponse</a></code>
901- <code title="get /evals/{eval_id}/runs/{run_id}">client.evals.runs.<a href="./src/openai/resources/evals/runs/runs.py">retrieve</a>(run_id, \*, eval_id) -> <a href="./src/openai/types/evals/run_retrieve_response.py">RunRetrieveResponse</a></code>
902- <code title="get /evals/{eval_id}/runs">client.evals.runs.<a href="./src/openai/resources/evals/runs/runs.py">list</a>(eval_id, \*\*<a href="src/openai/types/evals/run_list_params.py">params</a>) -> <a href="./src/openai/types/evals/run_list_response.py">SyncCursorPage[RunListResponse]</a></code>
903- <code title="delete /evals/{eval_id}/runs/{run_id}">client.evals.runs.<a href="./src/openai/resources/evals/runs/runs.py">delete</a>(run_id, \*, eval_id) -> <a href="./src/openai/types/evals/run_delete_response.py">RunDeleteResponse</a></code>
904- <code title="post /evals/{eval_id}/runs/{run_id}">client.evals.runs.<a href="./src/openai/resources/evals/runs/runs.py">cancel</a>(run_id, \*, eval_id) -> <a href="./src/openai/types/evals/run_cancel_response.py">RunCancelResponse</a></code>
905
906### OutputItems
907
908Types:
909
910```python
911from openai.types.evals.runs import OutputItemRetrieveResponse, OutputItemListResponse
912```
913
914Methods:
915
916- <code title="get /evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}">client.evals.runs.output_items.<a href="./src/openai/resources/evals/runs/output_items.py">retrieve</a>(output_item_id, \*, eval_id, run_id) -> <a href="./src/openai/types/evals/runs/output_item_retrieve_response.py">OutputItemRetrieveResponse</a></code>
917- <code title="get /evals/{eval_id}/runs/{run_id}/output_items">client.evals.runs.output_items.<a href="./src/openai/resources/evals/runs/output_items.py">list</a>(run_id, \*, eval_id, \*\*<a href="src/openai/types/evals/runs/output_item_list_params.py">params</a>) -> <a href="./src/openai/types/evals/runs/output_item_list_response.py">SyncCursorPage[OutputItemListResponse]</a></code>
71058dd6stainless-app[bot]1 years ago918
919# Containers
920
921Types:
922
923```python
924from openai.types import ContainerCreateResponse, ContainerRetrieveResponse, ContainerListResponse
925```
926
927Methods:
928
929- <code title="post /containers">client.containers.<a href="./src/openai/resources/containers/containers.py">create</a>(\*\*<a href="src/openai/types/container_create_params.py">params</a>) -> <a href="./src/openai/types/container_create_response.py">ContainerCreateResponse</a></code>
930- <code title="get /containers/{container_id}">client.containers.<a href="./src/openai/resources/containers/containers.py">retrieve</a>(container_id) -> <a href="./src/openai/types/container_retrieve_response.py">ContainerRetrieveResponse</a></code>
931- <code title="get /containers">client.containers.<a href="./src/openai/resources/containers/containers.py">list</a>(\*\*<a href="src/openai/types/container_list_params.py">params</a>) -> <a href="./src/openai/types/container_list_response.py">SyncCursorPage[ContainerListResponse]</a></code>
932- <code title="delete /containers/{container_id}">client.containers.<a href="./src/openai/resources/containers/containers.py">delete</a>(container_id) -> None</code>
933
934## Files
935
936Types:
937
938```python
939from openai.types.containers import FileCreateResponse, FileRetrieveResponse, FileListResponse
940```
941
942Methods:
943
944- <code title="post /containers/{container_id}/files">client.containers.files.<a href="./src/openai/resources/containers/files/files.py">create</a>(container_id, \*\*<a href="src/openai/types/containers/file_create_params.py">params</a>) -> <a href="./src/openai/types/containers/file_create_response.py">FileCreateResponse</a></code>
945- <code title="get /containers/{container_id}/files/{file_id}">client.containers.files.<a href="./src/openai/resources/containers/files/files.py">retrieve</a>(file_id, \*, container_id) -> <a href="./src/openai/types/containers/file_retrieve_response.py">FileRetrieveResponse</a></code>
946- <code title="get /containers/{container_id}/files">client.containers.files.<a href="./src/openai/resources/containers/files/files.py">list</a>(container_id, \*\*<a href="src/openai/types/containers/file_list_params.py">params</a>) -> <a href="./src/openai/types/containers/file_list_response.py">SyncCursorPage[FileListResponse]</a></code>
947- <code title="delete /containers/{container_id}/files/{file_id}">client.containers.files.<a href="./src/openai/resources/containers/files/files.py">delete</a>(file_id, \*, container_id) -> None</code>
948
949### Content
950
951Methods:
952
cca09707stainless-app[bot]1 years ago953- <code title="get /containers/{container_id}/files/{file_id}/content">client.containers.files.content.<a href="./src/openai/resources/containers/files/content.py">retrieve</a>(file_id, \*, container_id) -> HttpxBinaryResponseContent</code>