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

Branches

Tags

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

Clone

HTTPS

Download ZIP

api.md

897lines · 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,
bf1ca86cRobert Craigie1 years ago9ErrorObject,
10FunctionDefinition,
11FunctionParameters,
fdd52476stainless-app[bot]1 years ago12Metadata,
2954945eRobert Craigie1 years ago13Reasoning,
14ReasoningEffort,
bf1ca86cRobert Craigie1 years ago15ResponseFormatJSONObject,
16ResponseFormatJSONSchema,
17ResponseFormatText,
653dfec4stainless-app[bot]1 years ago18ResponsesModel,
bf1ca86cRobert Craigie1 years ago19)
a228a539Stainless Bot2 years ago20```
21
08b8179aDavid Schnurr2 years ago22# Completions
23
24Types:
25
26```python
27from openai.types import Completion, CompletionChoice, CompletionUsage
28```
29
30Methods:
31
32- <code title="post /completions">client.completions.<a href="./src/openai/resources/completions.py">create</a>(\*\*<a href="src/openai/types/completion_create_params.py">params</a>) -> <a href="./src/openai/types/completion.py">Completion</a></code>
33
34# Chat
35
1dc93403Stainless Bot2 years ago36Types:
37
38```python
39from openai.types import ChatModel
40```
41
08b8179aDavid Schnurr2 years ago42## Completions
43
44Types:
45
46```python
47from openai.types.chat import (
48ChatCompletion,
baa9f07fRobert Craigie2 years ago49ChatCompletionAssistantMessageParam,
550b855fstainless-app[bot]1 years ago50ChatCompletionAudio,
51ChatCompletionAudioParam,
08b8179aDavid Schnurr2 years ago52ChatCompletionChunk,
baa9f07fRobert Craigie2 years ago53ChatCompletionContentPart,
54ChatCompletionContentPartImage,
550b855fstainless-app[bot]1 years ago55ChatCompletionContentPartInputAudio,
bf1ca86cRobert Craigie1 years ago56ChatCompletionContentPartRefusal,
baa9f07fRobert Craigie2 years ago57ChatCompletionContentPartText,
300f58bbstainless-app[bot]1 years ago58ChatCompletionDeleted,
575ff607stainless-app[bot]1 years ago59ChatCompletionDeveloperMessageParam,
baa9f07fRobert Craigie2 years ago60ChatCompletionFunctionCallOption,
61ChatCompletionFunctionMessageParam,
08b8179aDavid Schnurr2 years ago62ChatCompletionMessage,
63ChatCompletionMessageParam,
baa9f07fRobert Craigie2 years ago64ChatCompletionMessageToolCall,
550b855fstainless-app[bot]1 years ago65ChatCompletionModality,
baa9f07fRobert Craigie2 years ago66ChatCompletionNamedToolChoice,
dfdcf571Stainless Bot1 years ago67ChatCompletionPredictionContent,
08b8179aDavid Schnurr2 years ago68ChatCompletionRole,
300f58bbstainless-app[bot]1 years ago69ChatCompletionStoreMessage,
6cc51587Stainless Bot2 years ago70ChatCompletionStreamOptions,
baa9f07fRobert Craigie2 years ago71ChatCompletionSystemMessageParam,
ccae821bStainless Bot2 years ago72ChatCompletionTokenLogprob,
baa9f07fRobert Craigie2 years ago73ChatCompletionTool,
74ChatCompletionToolChoiceOption,
75ChatCompletionToolMessageParam,
76ChatCompletionUserMessageParam,
2954945eRobert Craigie1 years ago77ChatCompletionReasoningEffort,
08b8179aDavid Schnurr2 years ago78)
79```
80
81Methods:
82
300f58bbstainless-app[bot]1 years ago83- <code title="post /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">create</a>(\*\*<a href="src/openai/types/chat/completion_create_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
84- <code title="get /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">retrieve</a>(completion_id) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
85- <code title="post /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">update</a>(completion_id, \*\*<a href="src/openai/types/chat/completion_update_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
86- <code title="get /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">list</a>(\*\*<a href="src/openai/types/chat/completion_list_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">SyncCursorPage[ChatCompletion]</a></code>
87- <code title="delete /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">delete</a>(completion_id) -> <a href="./src/openai/types/chat/chat_completion_deleted.py">ChatCompletionDeleted</a></code>
88
89### Messages
90
91Methods:
92
93- <code title="get /chat/completions/{completion_id}/messages">client.chat.completions.messages.<a href="./src/openai/resources/chat/completions/messages.py">list</a>(completion_id, \*\*<a href="src/openai/types/chat/completions/message_list_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion_store_message.py">SyncCursorPage[ChatCompletionStoreMessage]</a></code>
08b8179aDavid Schnurr2 years ago94
95# Embeddings
96
97Types:
98
99```python
eab2e5a3Stainless Bot1 years ago100from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel
08b8179aDavid Schnurr2 years ago101```
102
103Methods:
104
105- <code title="post /embeddings">client.embeddings.<a href="./src/openai/resources/embeddings.py">create</a>(\*\*<a href="src/openai/types/embedding_create_params.py">params</a>) -> <a href="./src/openai/types/create_embedding_response.py">CreateEmbeddingResponse</a></code>
106
107# Files
108
109Types:
110
111```python
05f0132fstainless-app[bot]1 years ago112from openai.types import FileContent, FileDeleted, FileObject, FilePurpose
08b8179aDavid Schnurr2 years ago113```
114
115Methods:
116
117- <code title="post /files">client.files.<a href="./src/openai/resources/files.py">create</a>(\*\*<a href="src/openai/types/file_create_params.py">params</a>) -> <a href="./src/openai/types/file_object.py">FileObject</a></code>
118- <code title="get /files/{file_id}">client.files.<a href="./src/openai/resources/files.py">retrieve</a>(file_id) -> <a href="./src/openai/types/file_object.py">FileObject</a></code>
dfdcf571Stainless Bot1 years ago119- <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 ago120- <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 ago121- <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 ago122- <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 ago123- <code>client.files.<a href="./src/openai/resources/files.py">wait_for_processing</a>(\*args) -> FileObject</code>
124
125# Images
126
127Types:
128
129```python
ece795f0Stainless Bot1 years ago130from openai.types import Image, ImageModel, ImagesResponse
08b8179aDavid Schnurr2 years ago131```
132
133Methods:
134
135- <code title="post /images/variations">client.images.<a href="./src/openai/resources/images.py">create_variation</a>(\*\*<a href="src/openai/types/image_create_variation_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
136- <code title="post /images/edits">client.images.<a href="./src/openai/resources/images.py">edit</a>(\*\*<a href="src/openai/types/image_edit_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
137- <code title="post /images/generations">client.images.<a href="./src/openai/resources/images.py">generate</a>(\*\*<a href="src/openai/types/image_generate_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
138
139# Audio
140
ece795f0Stainless Bot1 years ago141Types:
142
143```python
102fce4fStainless Bot1 years ago144from openai.types import AudioModel, AudioResponseFormat
ece795f0Stainless Bot1 years ago145```
146
08b8179aDavid Schnurr2 years ago147## Transcriptions
148
149Types:
150
151```python
adb6da3aRobert Craigie1 years ago152from openai.types.audio import (
153Transcription,
2b4bc759stainless-app[bot]1 years ago154TranscriptionInclude,
adb6da3aRobert Craigie1 years ago155TranscriptionSegment,
2b4bc759stainless-app[bot]1 years ago156TranscriptionStreamEvent,
157TranscriptionTextDeltaEvent,
158TranscriptionTextDoneEvent,
adb6da3aRobert Craigie1 years ago159TranscriptionVerbose,
160TranscriptionWord,
161TranscriptionCreateResponse,
162)
08b8179aDavid Schnurr2 years ago163```
164
165Methods:
166
adb6da3aRobert Craigie1 years ago167- <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 ago168
169## Translations
170
171Types:
172
173```python
adb6da3aRobert Craigie1 years ago174from openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse
08b8179aDavid Schnurr2 years ago175```
176
177Methods:
178
adb6da3aRobert Craigie1 years ago179- <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 ago180
baa9f07fRobert Craigie2 years ago181## Speech
182
ece795f0Stainless Bot1 years ago183Types:
184
185```python
186from openai.types.audio import SpeechModel
187```
188
baa9f07fRobert Craigie2 years ago189Methods:
190
191- <code title="post /audio/speech">client.audio.speech.<a href="./src/openai/resources/audio/speech.py">create</a>(\*\*<a href="src/openai/types/audio/speech_create_params.py">params</a>) -> HttpxBinaryResponseContent</code>
192
08b8179aDavid Schnurr2 years ago193# Moderations
194
195Types:
196
197```python
56e64d9astainless-app[bot]1 years ago198from openai.types import (
199Moderation,
200ModerationImageURLInput,
201ModerationModel,
202ModerationMultiModalInput,
203ModerationTextInput,
204ModerationCreateResponse,
205)
08b8179aDavid Schnurr2 years ago206```
207
208Methods:
209
210- <code title="post /moderations">client.moderations.<a href="./src/openai/resources/moderations.py">create</a>(\*\*<a href="src/openai/types/moderation_create_params.py">params</a>) -> <a href="./src/openai/types/moderation_create_response.py">ModerationCreateResponse</a></code>
211
212# Models
213
214Types:
215
216```python
217from openai.types import Model, ModelDeleted
218```
219
220Methods:
221
222- <code title="get /models/{model}">client.models.<a href="./src/openai/resources/models.py">retrieve</a>(model) -> <a href="./src/openai/types/model.py">Model</a></code>
223- <code title="get /models">client.models.<a href="./src/openai/resources/models.py">list</a>() -> <a href="./src/openai/types/model.py">SyncPage[Model]</a></code>
224- <code title="delete /models/{model}">client.models.<a href="./src/openai/resources/models.py">delete</a>(model) -> <a href="./src/openai/types/model_deleted.py">ModelDeleted</a></code>
225
226# FineTuning
227
a3b8e772stainless-app[bot]1 years ago228## Methods
229
230Types:
231
232```python
233from openai.types.fine_tuning import (
234DpoHyperparameters,
235DpoMethod,
236ReinforcementHyperparameters,
237ReinforcementMethod,
238SupervisedHyperparameters,
239SupervisedMethod,
240)
241```
242
08b8179aDavid Schnurr2 years ago243## Jobs
244
245Types:
246
247```python
f5247e30Stainless Bot2 years ago248from openai.types.fine_tuning import (
249FineTuningJob,
250FineTuningJobEvent,
251FineTuningJobWandbIntegration,
252FineTuningJobWandbIntegrationObject,
530f9b80stainless-app[bot]1 years ago253FineTuningJobIntegration,
f5247e30Stainless Bot2 years ago254)
255```
256
257Methods:
258
259- <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>
260- <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>
261- <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>
262- <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>
263- <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 ago264- <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>
265- <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 ago266
267### Checkpoints
268
269Types:
270
271```python
272from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint
08b8179aDavid Schnurr2 years ago273```
274
275Methods:
276
f5247e30Stainless Bot2 years ago277- <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 ago278
8da9f46bstainless-app[bot]1 years ago279## Checkpoints
280
281### Permissions
282
283Types:
284
285```python
286from openai.types.fine_tuning.checkpoints import (
287PermissionCreateResponse,
288PermissionRetrieveResponse,
289PermissionDeleteResponse,
290)
291```
292
293Methods:
294
295- <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>
296- <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 ago297- <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 ago298
a3b8e772stainless-app[bot]1 years ago299## Alpha
300
301### Graders
302
303Types:
304
305```python
306from openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse
307```
308
309Methods:
310
311- <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>
312- <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>
313
314# Graders
315
316## GraderModels
317
318Types:
319
320```python
321from openai.types.graders import (
322LabelModelGrader,
323MultiGrader,
324PythonGrader,
325ScoreModelGrader,
326StringCheckGrader,
327TextSimilarityGrader,
328)
329```
330
2954945eRobert Craigie1 years ago331# VectorStores
332
333Types:
334
335```python
336from openai.types import (
337AutoFileChunkingStrategyParam,
338FileChunkingStrategy,
339FileChunkingStrategyParam,
340OtherFileChunkingStrategyObject,
341StaticFileChunkingStrategy,
342StaticFileChunkingStrategyObject,
343StaticFileChunkingStrategyObjectParam,
344VectorStore,
345VectorStoreDeleted,
346VectorStoreSearchResponse,
347)
348```
349
350Methods:
351
352- <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>
353- <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>
354- <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>
355- <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>
356- <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>
357- <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>
358
359## Files
360
361Types:
362
363```python
364from openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse
365```
366
367Methods:
368
369- <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>
370- <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>
371- <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>
372- <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>
373- <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>
374- <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>
375- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">create_and_poll</a>(\*args) -> VectorStoreFile</code>
376- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">poll</a>(\*args) -> VectorStoreFile</code>
377- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload</a>(\*args) -> VectorStoreFile</code>
378- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload_and_poll</a>(\*args) -> VectorStoreFile</code>
379
380## FileBatches
381
382Types:
383
384```python
385from openai.types.vector_stores import VectorStoreFileBatch
386```
387
388Methods:
389
390- <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>
391- <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>
392- <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>
393- <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>
394- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">create_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
395- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">poll</a>(\*args) -> VectorStoreFileBatch</code>
396- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">upload_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
397
baa9f07fRobert Craigie2 years ago398# Beta
399
575ff607stainless-app[bot]1 years ago400## Realtime
401
5fdba486stainless-app[bot]1 years ago402Types:
403
404```python
405from openai.types.beta.realtime import (
406ConversationCreatedEvent,
407ConversationItem,
408ConversationItemContent,
409ConversationItemCreateEvent,
410ConversationItemCreatedEvent,
411ConversationItemDeleteEvent,
412ConversationItemDeletedEvent,
413ConversationItemInputAudioTranscriptionCompletedEvent,
2b4bc759stainless-app[bot]1 years ago414ConversationItemInputAudioTranscriptionDeltaEvent,
5fdba486stainless-app[bot]1 years ago415ConversationItemInputAudioTranscriptionFailedEvent,
2b4bc759stainless-app[bot]1 years ago416ConversationItemRetrieveEvent,
5fdba486stainless-app[bot]1 years ago417ConversationItemTruncateEvent,
418ConversationItemTruncatedEvent,
f344db25stainless-app[bot]1 years ago419ConversationItemWithReference,
5fdba486stainless-app[bot]1 years ago420ErrorEvent,
421InputAudioBufferAppendEvent,
422InputAudioBufferClearEvent,
423InputAudioBufferClearedEvent,
424InputAudioBufferCommitEvent,
425InputAudioBufferCommittedEvent,
426InputAudioBufferSpeechStartedEvent,
427InputAudioBufferSpeechStoppedEvent,
428RateLimitsUpdatedEvent,
429RealtimeClientEvent,
430RealtimeResponse,
431RealtimeResponseStatus,
432RealtimeResponseUsage,
433RealtimeServerEvent,
434ResponseAudioDeltaEvent,
435ResponseAudioDoneEvent,
436ResponseAudioTranscriptDeltaEvent,
437ResponseAudioTranscriptDoneEvent,
438ResponseCancelEvent,
439ResponseContentPartAddedEvent,
440ResponseContentPartDoneEvent,
441ResponseCreateEvent,
442ResponseCreatedEvent,
443ResponseDoneEvent,
444ResponseFunctionCallArgumentsDeltaEvent,
445ResponseFunctionCallArgumentsDoneEvent,
446ResponseOutputItemAddedEvent,
447ResponseOutputItemDoneEvent,
448ResponseTextDeltaEvent,
449ResponseTextDoneEvent,
450SessionCreatedEvent,
451SessionUpdateEvent,
452SessionUpdatedEvent,
2b4bc759stainless-app[bot]1 years ago453TranscriptionSessionUpdate,
454TranscriptionSessionUpdatedEvent,
5fdba486stainless-app[bot]1 years ago455)
456```
457
575ff607stainless-app[bot]1 years ago458### Sessions
459
460Types:
461
462```python
463from openai.types.beta.realtime import Session, SessionCreateResponse
464```
465
466Methods:
467
468- <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>
469
2b4bc759stainless-app[bot]1 years ago470### TranscriptionSessions
471
472Types:
473
474```python
475from openai.types.beta.realtime import TranscriptionSession
476```
477
478Methods:
479
480- <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>
481
baa9f07fRobert Craigie2 years ago482## Assistants
483
484Types:
485
486```python
5429f696Stainless Bot2 years ago487from openai.types.beta import (
488Assistant,
489AssistantDeleted,
490AssistantStreamEvent,
491AssistantTool,
492CodeInterpreterTool,
5b20698dStainless Bot2 years ago493FileSearchTool,
5429f696Stainless Bot2 years ago494FunctionTool,
495MessageStreamEvent,
496RunStepStreamEvent,
497RunStreamEvent,
498ThreadStreamEvent,
499)
baa9f07fRobert Craigie2 years ago500```
501
502Methods:
503
5b20698dStainless Bot2 years ago504- <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>
505- <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>
506- <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>
507- <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>
508- <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 ago509
510## Threads
511
512Types:
513
514```python
f5247e30Stainless Bot2 years ago515from openai.types.beta import (
516AssistantResponseFormatOption,
517AssistantToolChoice,
518AssistantToolChoiceFunction,
519AssistantToolChoiceOption,
520Thread,
521ThreadDeleted,
522)
baa9f07fRobert Craigie2 years ago523```
524
525Methods:
526
527- <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>
528- <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>
529- <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>
530- <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>
531- <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 ago532- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_poll</a>(\*args) -> Run</code>
5429f696Stainless Bot2 years ago533- <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 ago534
535### Runs
536
537Types:
538
539```python
f0b18239Stainless Bot2 years ago540from openai.types.beta.threads import RequiredActionFunctionToolCall, Run, RunStatus
baa9f07fRobert Craigie2 years ago541```
542
543Methods:
544
545- <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>
546- <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>
547- <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>
548- <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>
549- <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>
550- <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 ago551- <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 ago552- <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 ago553- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">poll</a>(\*args) -> Run</code>
554- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
555- <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 ago556- <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 ago557
558#### Steps
559
560Types:
561
562```python
563from openai.types.beta.threads.runs import (
5429f696Stainless Bot2 years ago564CodeInterpreterLogs,
565CodeInterpreterOutputImage,
566CodeInterpreterToolCall,
567CodeInterpreterToolCallDelta,
5b20698dStainless Bot2 years ago568FileSearchToolCall,
569FileSearchToolCallDelta,
baa9f07fRobert Craigie2 years ago570FunctionToolCall,
5429f696Stainless Bot2 years ago571FunctionToolCallDelta,
baa9f07fRobert Craigie2 years ago572MessageCreationStepDetails,
573RunStep,
5429f696Stainless Bot2 years ago574RunStepDelta,
575RunStepDeltaEvent,
576RunStepDeltaMessageDelta,
5d3111a8Stainless Bot1 years ago577RunStepInclude,
5429f696Stainless Bot2 years ago578ToolCall,
579ToolCallDelta,
580ToolCallDeltaObject,
baa9f07fRobert Craigie2 years ago581ToolCallsStepDetails,
582)
583```
584
585Methods:
586
5d3111a8Stainless Bot1 years ago587- <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 ago588- <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>
589
590### Messages
591
592Types:
593
594```python
595from openai.types.beta.threads import (
5429f696Stainless Bot2 years ago596Annotation,
597AnnotationDelta,
598FileCitationAnnotation,
599FileCitationDeltaAnnotation,
600FilePathAnnotation,
601FilePathDeltaAnnotation,
602ImageFile,
603ImageFileContentBlock,
604ImageFileDelta,
605ImageFileDeltaBlock,
79a0b401Stainless Bot2 years ago606ImageURL,
607ImageURLContentBlock,
608ImageURLDelta,
609ImageURLDeltaBlock,
5429f696Stainless Bot2 years ago610Message,
611MessageContent,
612MessageContentDelta,
79a0b401Stainless Bot2 years ago613MessageContentPartParam,
5429f696Stainless Bot2 years ago614MessageDeleted,
615MessageDelta,
616MessageDeltaEvent,
bf1ca86cRobert Craigie1 years ago617RefusalContentBlock,
618RefusalDeltaBlock,
5429f696Stainless Bot2 years ago619Text,
620TextContentBlock,
79a0b401Stainless Bot2 years ago621TextContentBlockParam,
5429f696Stainless Bot2 years ago622TextDelta,
623TextDeltaBlock,
baa9f07fRobert Craigie2 years ago624)
625```
626
627Methods:
628
5b20698dStainless Bot2 years ago629- <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>
630- <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>
631- <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>
632- <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 ago633- <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 ago634
635# Batches
636
637Types:
638
639```python
640from openai.types import Batch, BatchError, BatchRequestCounts
641```
642
643Methods:
644
645- <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>
646- <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 ago647- <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 ago648- <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 ago649
650# Uploads
651
652Types:
653
654```python
655from openai.types import Upload
656```
657
658Methods:
659
660- <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>
661- <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>
662- <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>
663
664## Parts
665
666Types:
667
668```python
669from openai.types.uploads import UploadPart
670```
671
672Methods:
673
674- <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 ago675
676# Responses
677
678Types:
679
680```python
681from openai.types.responses import (
682ComputerTool,
683EasyInputMessage,
684FileSearchTool,
685FunctionTool,
686Response,
687ResponseAudioDeltaEvent,
688ResponseAudioDoneEvent,
689ResponseAudioTranscriptDeltaEvent,
690ResponseAudioTranscriptDoneEvent,
691ResponseCodeInterpreterCallCodeDeltaEvent,
692ResponseCodeInterpreterCallCodeDoneEvent,
693ResponseCodeInterpreterCallCompletedEvent,
694ResponseCodeInterpreterCallInProgressEvent,
695ResponseCodeInterpreterCallInterpretingEvent,
696ResponseCodeInterpreterToolCall,
697ResponseCompletedEvent,
698ResponseComputerToolCall,
bff8da95stainless-app[bot]1 years ago699ResponseComputerToolCallOutputItem,
700ResponseComputerToolCallOutputScreenshot,
2954945eRobert Craigie1 years ago701ResponseContent,
702ResponseContentPartAddedEvent,
703ResponseContentPartDoneEvent,
704ResponseCreatedEvent,
705ResponseError,
706ResponseErrorEvent,
707ResponseFailedEvent,
708ResponseFileSearchCallCompletedEvent,
709ResponseFileSearchCallInProgressEvent,
710ResponseFileSearchCallSearchingEvent,
711ResponseFileSearchToolCall,
712ResponseFormatTextConfig,
713ResponseFormatTextJSONSchemaConfig,
714ResponseFunctionCallArgumentsDeltaEvent,
715ResponseFunctionCallArgumentsDoneEvent,
716ResponseFunctionToolCall,
bff8da95stainless-app[bot]1 years ago717ResponseFunctionToolCallItem,
718ResponseFunctionToolCallOutputItem,
2954945eRobert Craigie1 years ago719ResponseFunctionWebSearch,
4a81b4edstainless-app[bot]1 years ago720ResponseImageGenCallCompletedEvent,
721ResponseImageGenCallGeneratingEvent,
722ResponseImageGenCallInProgressEvent,
723ResponseImageGenCallPartialImageEvent,
2954945eRobert Craigie1 years ago724ResponseInProgressEvent,
725ResponseIncludable,
726ResponseIncompleteEvent,
727ResponseInput,
728ResponseInputAudio,
729ResponseInputContent,
730ResponseInputFile,
731ResponseInputImage,
732ResponseInputItem,
733ResponseInputMessageContentList,
bff8da95stainless-app[bot]1 years ago734ResponseInputMessageItem,
2954945eRobert Craigie1 years ago735ResponseInputText,
bff8da95stainless-app[bot]1 years ago736ResponseItem,
4a81b4edstainless-app[bot]1 years ago737ResponseMcpCallArgumentsDeltaEvent,
738ResponseMcpCallArgumentsDoneEvent,
739ResponseMcpCallCompletedEvent,
740ResponseMcpCallFailedEvent,
741ResponseMcpCallInProgressEvent,
742ResponseMcpListToolsCompletedEvent,
743ResponseMcpListToolsFailedEvent,
744ResponseMcpListToolsInProgressEvent,
2954945eRobert Craigie1 years ago745ResponseOutputAudio,
746ResponseOutputItem,
747ResponseOutputItemAddedEvent,
748ResponseOutputItemDoneEvent,
749ResponseOutputMessage,
750ResponseOutputRefusal,
751ResponseOutputText,
4a81b4edstainless-app[bot]1 years ago752ResponseOutputTextAnnotationAddedEvent,
753ResponseQueuedEvent,
754ResponseReasoningDeltaEvent,
755ResponseReasoningDoneEvent,
27ef73fdstainless-app[bot]1 years ago756ResponseReasoningItem,
4a81b4edstainless-app[bot]1 years ago757ResponseReasoningSummaryDeltaEvent,
758ResponseReasoningSummaryDoneEvent,
6321004astainless-app[bot]1 years ago759ResponseReasoningSummaryPartAddedEvent,
760ResponseReasoningSummaryPartDoneEvent,
761ResponseReasoningSummaryTextDeltaEvent,
762ResponseReasoningSummaryTextDoneEvent,
2954945eRobert Craigie1 years ago763ResponseRefusalDeltaEvent,
764ResponseRefusalDoneEvent,
765ResponseStatus,
766ResponseStreamEvent,
767ResponseTextConfig,
768ResponseTextDeltaEvent,
769ResponseTextDoneEvent,
770ResponseUsage,
771ResponseWebSearchCallCompletedEvent,
772ResponseWebSearchCallInProgressEvent,
773ResponseWebSearchCallSearchingEvent,
774Tool,
775ToolChoiceFunction,
776ToolChoiceOptions,
777ToolChoiceTypes,
778WebSearchTool,
779)
780```
781
782Methods:
783
784- <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>
785- <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>
786- <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 ago787- <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 ago788
789## InputItems
790
791Types:
792
793```python
794from openai.types.responses import ResponseItemList
795```
796
797Methods:
798
bff8da95stainless-app[bot]1 years ago799- <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 ago800
801# Evals
802
803Types:
804
805```python
806from openai.types import (
807EvalCustomDataSourceConfig,
808EvalStoredCompletionsDataSourceConfig,
809EvalCreateResponse,
810EvalRetrieveResponse,
811EvalUpdateResponse,
812EvalListResponse,
813EvalDeleteResponse,
814)
815```
816
817Methods:
818
819- <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>
820- <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>
821- <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>
822- <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>
823- <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>
824
825## Runs
826
827Types:
828
829```python
830from openai.types.evals import (
831CreateEvalCompletionsRunDataSource,
832CreateEvalJSONLRunDataSource,
833EvalAPIError,
834RunCreateResponse,
835RunRetrieveResponse,
836RunListResponse,
837RunDeleteResponse,
838RunCancelResponse,
839)
840```
841
842Methods:
843
844- <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>
845- <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>
846- <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>
847- <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>
848- <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>
849
850### OutputItems
851
852Types:
853
854```python
855from openai.types.evals.runs import OutputItemRetrieveResponse, OutputItemListResponse
856```
857
858Methods:
859
860- <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>
861- <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 ago862
863# Containers
864
865Types:
866
867```python
868from openai.types import ContainerCreateResponse, ContainerRetrieveResponse, ContainerListResponse
869```
870
871Methods:
872
873- <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>
874- <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>
875- <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>
876- <code title="delete /containers/{container_id}">client.containers.<a href="./src/openai/resources/containers/containers.py">delete</a>(container_id) -> None</code>
877
878## Files
879
880Types:
881
882```python
883from openai.types.containers import FileCreateResponse, FileRetrieveResponse, FileListResponse
884```
885
886Methods:
887
888- <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>
889- <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>
890- <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>
891- <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>
892
893### Content
894
895Methods:
896
cca09707stainless-app[bot]1 years ago897- <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>