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

Branches

Tags

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

Clone

HTTPS

Download ZIP

api.md

861lines · modecode

RawDownload
Latest commit unavailable.
1# Shared Types
2
3```python
4from openai.types import (
5 AllModels,
6 ChatModel,
7 ComparisonFilter,
8 CompoundFilter,
9 ErrorObject,
10 FunctionDefinition,
11 FunctionParameters,
12 Metadata,
13 Reasoning,
14 ReasoningEffort,
15 ResponseFormatJSONObject,
16 ResponseFormatJSONSchema,
17 ResponseFormatText,
18 ResponsesModel,
19)
20```
21
22# Completions
23
24Types:
25
26```python
27from openai.types import Completion, CompletionChoice, CompletionUsage
28```
29
30Methods:
31
32- <code title="post /completions">client.completions.<a href="./src/openai/resources/completions.py">create</a>(\*\*<a href="src/openai/types/completion_create_params.py">params</a>) -> <a href="./src/openai/types/completion.py">Completion</a></code>
33
34# Chat
35
36Types:
37
38```python
39from openai.types import ChatModel
40```
41
42## Completions
43
44Types:
45
46```python
47from openai.types.chat import (
48 ChatCompletion,
49 ChatCompletionAssistantMessageParam,
50 ChatCompletionAudio,
51 ChatCompletionAudioParam,
52 ChatCompletionChunk,
53 ChatCompletionContentPart,
54 ChatCompletionContentPartImage,
55 ChatCompletionContentPartInputAudio,
56 ChatCompletionContentPartRefusal,
57 ChatCompletionContentPartText,
58 ChatCompletionDeleted,
59 ChatCompletionDeveloperMessageParam,
60 ChatCompletionFunctionCallOption,
61 ChatCompletionFunctionMessageParam,
62 ChatCompletionMessage,
63 ChatCompletionMessageParam,
64 ChatCompletionMessageToolCall,
65 ChatCompletionModality,
66 ChatCompletionNamedToolChoice,
67 ChatCompletionPredictionContent,
68 ChatCompletionRole,
69 ChatCompletionStoreMessage,
70 ChatCompletionStreamOptions,
71 ChatCompletionSystemMessageParam,
72 ChatCompletionTokenLogprob,
73 ChatCompletionTool,
74 ChatCompletionToolChoiceOption,
75 ChatCompletionToolMessageParam,
76 ChatCompletionUserMessageParam,
77 ChatCompletionReasoningEffort,
78)
79```
80
81Methods:
82
83- <code title="post /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">create</a>(\*\*<a href="src/openai/types/chat/completion_create_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
84- <code title="get /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">retrieve</a>(completion_id) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
85- <code title="post /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">update</a>(completion_id, \*\*<a href="src/openai/types/chat/completion_update_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
86- <code title="get /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">list</a>(\*\*<a href="src/openai/types/chat/completion_list_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">SyncCursorPage[ChatCompletion]</a></code>
87- <code title="delete /chat/completions/{completion_id}">client.chat.completions.<a href="./src/openai/resources/chat/completions/completions.py">delete</a>(completion_id) -> <a href="./src/openai/types/chat/chat_completion_deleted.py">ChatCompletionDeleted</a></code>
88
89### Messages
90
91Methods:
92
93- <code title="get /chat/completions/{completion_id}/messages">client.chat.completions.messages.<a href="./src/openai/resources/chat/completions/messages.py">list</a>(completion_id, \*\*<a href="src/openai/types/chat/completions/message_list_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion_store_message.py">SyncCursorPage[ChatCompletionStoreMessage]</a></code>
94
95# Embeddings
96
97Types:
98
99```python
100from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel
101```
102
103Methods:
104
105- <code title="post /embeddings">client.embeddings.<a href="./src/openai/resources/embeddings.py">create</a>(\*\*<a href="src/openai/types/embedding_create_params.py">params</a>) -> <a href="./src/openai/types/create_embedding_response.py">CreateEmbeddingResponse</a></code>
106
107# Files
108
109Types:
110
111```python
112from openai.types import FileContent, FileDeleted, FileObject, FilePurpose
113```
114
115Methods:
116
117- <code title="post /files">client.files.<a href="./src/openai/resources/files.py">create</a>(\*\*<a href="src/openai/types/file_create_params.py">params</a>) -> <a href="./src/openai/types/file_object.py">FileObject</a></code>
118- <code title="get /files/{file_id}">client.files.<a href="./src/openai/resources/files.py">retrieve</a>(file_id) -> <a href="./src/openai/types/file_object.py">FileObject</a></code>
119- <code title="get /files">client.files.<a href="./src/openai/resources/files.py">list</a>(\*\*<a href="src/openai/types/file_list_params.py">params</a>) -> <a href="./src/openai/types/file_object.py">SyncCursorPage[FileObject]</a></code>
120- <code title="delete /files/{file_id}">client.files.<a href="./src/openai/resources/files.py">delete</a>(file_id) -> <a href="./src/openai/types/file_deleted.py">FileDeleted</a></code>
121- <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">content</a>(file_id) -> HttpxBinaryResponseContent</code>
122- <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">retrieve_content</a>(file_id) -> <a href="./src/openai/types/file_content.py">str</a></code>
123- <code>client.files.<a href="./src/openai/resources/files.py">wait_for_processing</a>(\*args) -> FileObject</code>
124
125# Images
126
127Types:
128
129```python
130from openai.types import Image, ImageModel, ImagesResponse
131```
132
133Methods:
134
135- <code title="post /images/variations">client.images.<a href="./src/openai/resources/images.py">create_variation</a>(\*\*<a href="src/openai/types/image_create_variation_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
136- <code title="post /images/edits">client.images.<a href="./src/openai/resources/images.py">edit</a>(\*\*<a href="src/openai/types/image_edit_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
137- <code title="post /images/generations">client.images.<a href="./src/openai/resources/images.py">generate</a>(\*\*<a href="src/openai/types/image_generate_params.py">params</a>) -> <a href="./src/openai/types/images_response.py">ImagesResponse</a></code>
138
139# Audio
140
141Types:
142
143```python
144from openai.types import AudioModel, AudioResponseFormat
145```
146
147## Transcriptions
148
149Types:
150
151```python
152from openai.types.audio import (
153 Transcription,
154 TranscriptionInclude,
155 TranscriptionSegment,
156 TranscriptionStreamEvent,
157 TranscriptionTextDeltaEvent,
158 TranscriptionTextDoneEvent,
159 TranscriptionVerbose,
160 TranscriptionWord,
161 TranscriptionCreateResponse,
162)
163```
164
165Methods:
166
167- <code title="post /audio/transcriptions">client.audio.transcriptions.<a href="./src/openai/resources/audio/transcriptions.py">create</a>(\*\*<a href="src/openai/types/audio/transcription_create_params.py">params</a>) -> <a href="./src/openai/types/audio/transcription_create_response.py">TranscriptionCreateResponse</a></code>
168
169## Translations
170
171Types:
172
173```python
174from openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse
175```
176
177Methods:
178
179- <code title="post /audio/translations">client.audio.translations.<a href="./src/openai/resources/audio/translations.py">create</a>(\*\*<a href="src/openai/types/audio/translation_create_params.py">params</a>) -> <a href="./src/openai/types/audio/translation_create_response.py">TranslationCreateResponse</a></code>
180
181## Speech
182
183Types:
184
185```python
186from openai.types.audio import SpeechModel
187```
188
189Methods:
190
191- <code title="post /audio/speech">client.audio.speech.<a href="./src/openai/resources/audio/speech.py">create</a>(\*\*<a href="src/openai/types/audio/speech_create_params.py">params</a>) -> HttpxBinaryResponseContent</code>
192
193# Moderations
194
195Types:
196
197```python
198from openai.types import (
199 Moderation,
200 ModerationImageURLInput,
201 ModerationModel,
202 ModerationMultiModalInput,
203 ModerationTextInput,
204 ModerationCreateResponse,
205)
206```
207
208Methods:
209
210- <code title="post /moderations">client.moderations.<a href="./src/openai/resources/moderations.py">create</a>(\*\*<a href="src/openai/types/moderation_create_params.py">params</a>) -> <a href="./src/openai/types/moderation_create_response.py">ModerationCreateResponse</a></code>
211
212# Models
213
214Types:
215
216```python
217from openai.types import Model, ModelDeleted
218```
219
220Methods:
221
222- <code title="get /models/{model}">client.models.<a href="./src/openai/resources/models.py">retrieve</a>(model) -> <a href="./src/openai/types/model.py">Model</a></code>
223- <code title="get /models">client.models.<a href="./src/openai/resources/models.py">list</a>() -> <a href="./src/openai/types/model.py">SyncPage[Model]</a></code>
224- <code title="delete /models/{model}">client.models.<a href="./src/openai/resources/models.py">delete</a>(model) -> <a href="./src/openai/types/model_deleted.py">ModelDeleted</a></code>
225
226# FineTuning
227
228## Methods
229
230Types:
231
232```python
233from openai.types.fine_tuning import (
234 DpoHyperparameters,
235 DpoMethod,
236 ReinforcementHyperparameters,
237 ReinforcementMethod,
238 SupervisedHyperparameters,
239 SupervisedMethod,
240)
241```
242
243## Jobs
244
245Types:
246
247```python
248from openai.types.fine_tuning import (
249 FineTuningJob,
250 FineTuningJobEvent,
251 FineTuningJobWandbIntegration,
252 FineTuningJobWandbIntegrationObject,
253 FineTuningJobIntegration,
254)
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>
264- <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>
266
267### Checkpoints
268
269Types:
270
271```python
272from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint
273```
274
275Methods:
276
277- <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>
278
279## Checkpoints
280
281### Permissions
282
283Types:
284
285```python
286from openai.types.fine_tuning.checkpoints import (
287 PermissionCreateResponse,
288 PermissionRetrieveResponse,
289 PermissionDeleteResponse,
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>
297- <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>
298
299## 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 (
322 LabelModelGrader,
323 MultiGrader,
324 PythonGrader,
325 ScoreModelGrader,
326 StringCheckGrader,
327 TextSimilarityGrader,
328)
329```
330
331# VectorStores
332
333Types:
334
335```python
336from openai.types import (
337 AutoFileChunkingStrategyParam,
338 FileChunkingStrategy,
339 FileChunkingStrategyParam,
340 OtherFileChunkingStrategyObject,
341 StaticFileChunkingStrategy,
342 StaticFileChunkingStrategyObject,
343 StaticFileChunkingStrategyObjectParam,
344 VectorStore,
345 VectorStoreDeleted,
346 VectorStoreSearchResponse,
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
398# Beta
399
400## Realtime
401
402Types:
403
404```python
405from openai.types.beta.realtime import (
406 ConversationCreatedEvent,
407 ConversationItem,
408 ConversationItemContent,
409 ConversationItemCreateEvent,
410 ConversationItemCreatedEvent,
411 ConversationItemDeleteEvent,
412 ConversationItemDeletedEvent,
413 ConversationItemInputAudioTranscriptionCompletedEvent,
414 ConversationItemInputAudioTranscriptionDeltaEvent,
415 ConversationItemInputAudioTranscriptionFailedEvent,
416 ConversationItemRetrieveEvent,
417 ConversationItemTruncateEvent,
418 ConversationItemTruncatedEvent,
419 ConversationItemWithReference,
420 ErrorEvent,
421 InputAudioBufferAppendEvent,
422 InputAudioBufferClearEvent,
423 InputAudioBufferClearedEvent,
424 InputAudioBufferCommitEvent,
425 InputAudioBufferCommittedEvent,
426 InputAudioBufferSpeechStartedEvent,
427 InputAudioBufferSpeechStoppedEvent,
428 RateLimitsUpdatedEvent,
429 RealtimeClientEvent,
430 RealtimeResponse,
431 RealtimeResponseStatus,
432 RealtimeResponseUsage,
433 RealtimeServerEvent,
434 ResponseAudioDeltaEvent,
435 ResponseAudioDoneEvent,
436 ResponseAudioTranscriptDeltaEvent,
437 ResponseAudioTranscriptDoneEvent,
438 ResponseCancelEvent,
439 ResponseContentPartAddedEvent,
440 ResponseContentPartDoneEvent,
441 ResponseCreateEvent,
442 ResponseCreatedEvent,
443 ResponseDoneEvent,
444 ResponseFunctionCallArgumentsDeltaEvent,
445 ResponseFunctionCallArgumentsDoneEvent,
446 ResponseOutputItemAddedEvent,
447 ResponseOutputItemDoneEvent,
448 ResponseTextDeltaEvent,
449 ResponseTextDoneEvent,
450 SessionCreatedEvent,
451 SessionUpdateEvent,
452 SessionUpdatedEvent,
453 TranscriptionSessionUpdate,
454 TranscriptionSessionUpdatedEvent,
455)
456```
457
458### 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
470### 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
482## Assistants
483
484Types:
485
486```python
487from openai.types.beta import (
488 Assistant,
489 AssistantDeleted,
490 AssistantStreamEvent,
491 AssistantTool,
492 CodeInterpreterTool,
493 FileSearchTool,
494 FunctionTool,
495 MessageStreamEvent,
496 RunStepStreamEvent,
497 RunStreamEvent,
498 ThreadStreamEvent,
499)
500```
501
502Methods:
503
504- <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>
509
510## Threads
511
512Types:
513
514```python
515from openai.types.beta import (
516 AssistantResponseFormatOption,
517 AssistantToolChoice,
518 AssistantToolChoiceFunction,
519 AssistantToolChoiceOption,
520 Thread,
521 ThreadDeleted,
522)
523```
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>
532- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_poll</a>(\*args) -> Run</code>
533- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
534
535### Runs
536
537Types:
538
539```python
540from openai.types.beta.threads import RequiredActionFunctionToolCall, Run, RunStatus
541```
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>
551- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">create_and_poll</a>(\*args) -> Run</code>
552- <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>
553- <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>
556- <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>
557
558#### Steps
559
560Types:
561
562```python
563from openai.types.beta.threads.runs import (
564 CodeInterpreterLogs,
565 CodeInterpreterOutputImage,
566 CodeInterpreterToolCall,
567 CodeInterpreterToolCallDelta,
568 FileSearchToolCall,
569 FileSearchToolCallDelta,
570 FunctionToolCall,
571 FunctionToolCallDelta,
572 MessageCreationStepDetails,
573 RunStep,
574 RunStepDelta,
575 RunStepDeltaEvent,
576 RunStepDeltaMessageDelta,
577 RunStepInclude,
578 ToolCall,
579 ToolCallDelta,
580 ToolCallDeltaObject,
581 ToolCallsStepDetails,
582)
583```
584
585Methods:
586
587- <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>
588- <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 (
596 Annotation,
597 AnnotationDelta,
598 FileCitationAnnotation,
599 FileCitationDeltaAnnotation,
600 FilePathAnnotation,
601 FilePathDeltaAnnotation,
602 ImageFile,
603 ImageFileContentBlock,
604 ImageFileDelta,
605 ImageFileDeltaBlock,
606 ImageURL,
607 ImageURLContentBlock,
608 ImageURLDelta,
609 ImageURLDeltaBlock,
610 Message,
611 MessageContent,
612 MessageContentDelta,
613 MessageContentPartParam,
614 MessageDeleted,
615 MessageDelta,
616 MessageDeltaEvent,
617 RefusalContentBlock,
618 RefusalDeltaBlock,
619 Text,
620 TextContentBlock,
621 TextContentBlockParam,
622 TextDelta,
623 TextDeltaBlock,
624)
625```
626
627Methods:
628
629- <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>
633- <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>
634
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>
647- <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>
648- <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>
649
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>
675
676# Responses
677
678Types:
679
680```python
681from openai.types.responses import (
682 ComputerTool,
683 EasyInputMessage,
684 FileSearchTool,
685 FunctionTool,
686 Response,
687 ResponseAudioDeltaEvent,
688 ResponseAudioDoneEvent,
689 ResponseAudioTranscriptDeltaEvent,
690 ResponseAudioTranscriptDoneEvent,
691 ResponseCodeInterpreterCallCodeDeltaEvent,
692 ResponseCodeInterpreterCallCodeDoneEvent,
693 ResponseCodeInterpreterCallCompletedEvent,
694 ResponseCodeInterpreterCallInProgressEvent,
695 ResponseCodeInterpreterCallInterpretingEvent,
696 ResponseCodeInterpreterToolCall,
697 ResponseCompletedEvent,
698 ResponseComputerToolCall,
699 ResponseComputerToolCallOutputItem,
700 ResponseComputerToolCallOutputScreenshot,
701 ResponseContent,
702 ResponseContentPartAddedEvent,
703 ResponseContentPartDoneEvent,
704 ResponseCreatedEvent,
705 ResponseError,
706 ResponseErrorEvent,
707 ResponseFailedEvent,
708 ResponseFileSearchCallCompletedEvent,
709 ResponseFileSearchCallInProgressEvent,
710 ResponseFileSearchCallSearchingEvent,
711 ResponseFileSearchToolCall,
712 ResponseFormatTextConfig,
713 ResponseFormatTextJSONSchemaConfig,
714 ResponseFunctionCallArgumentsDeltaEvent,
715 ResponseFunctionCallArgumentsDoneEvent,
716 ResponseFunctionToolCall,
717 ResponseFunctionToolCallItem,
718 ResponseFunctionToolCallOutputItem,
719 ResponseFunctionWebSearch,
720 ResponseImageGenCallCompletedEvent,
721 ResponseImageGenCallGeneratingEvent,
722 ResponseImageGenCallInProgressEvent,
723 ResponseImageGenCallPartialImageEvent,
724 ResponseInProgressEvent,
725 ResponseIncludable,
726 ResponseIncompleteEvent,
727 ResponseInput,
728 ResponseInputAudio,
729 ResponseInputContent,
730 ResponseInputFile,
731 ResponseInputImage,
732 ResponseInputItem,
733 ResponseInputMessageContentList,
734 ResponseInputMessageItem,
735 ResponseInputText,
736 ResponseItem,
737 ResponseMcpCallArgumentsDeltaEvent,
738 ResponseMcpCallArgumentsDoneEvent,
739 ResponseMcpCallCompletedEvent,
740 ResponseMcpCallFailedEvent,
741 ResponseMcpCallInProgressEvent,
742 ResponseMcpListToolsCompletedEvent,
743 ResponseMcpListToolsFailedEvent,
744 ResponseMcpListToolsInProgressEvent,
745 ResponseOutputAudio,
746 ResponseOutputItem,
747 ResponseOutputItemAddedEvent,
748 ResponseOutputItemDoneEvent,
749 ResponseOutputMessage,
750 ResponseOutputRefusal,
751 ResponseOutputText,
752 ResponseOutputTextAnnotationAddedEvent,
753 ResponseQueuedEvent,
754 ResponseReasoningDeltaEvent,
755 ResponseReasoningDoneEvent,
756 ResponseReasoningItem,
757 ResponseReasoningSummaryDeltaEvent,
758 ResponseReasoningSummaryDoneEvent,
759 ResponseReasoningSummaryPartAddedEvent,
760 ResponseReasoningSummaryPartDoneEvent,
761 ResponseReasoningSummaryTextDeltaEvent,
762 ResponseReasoningSummaryTextDoneEvent,
763 ResponseRefusalDeltaEvent,
764 ResponseRefusalDoneEvent,
765 ResponseStatus,
766 ResponseStreamEvent,
767 ResponseTextAnnotationDeltaEvent,
768 ResponseTextConfig,
769 ResponseTextDeltaEvent,
770 ResponseTextDoneEvent,
771 ResponseUsage,
772 ResponseWebSearchCallCompletedEvent,
773 ResponseWebSearchCallInProgressEvent,
774 ResponseWebSearchCallSearchingEvent,
775 Tool,
776 ToolChoiceFunction,
777 ToolChoiceOptions,
778 ToolChoiceTypes,
779 WebSearchTool,
780)
781```
782
783Methods:
784
785- <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>
786- <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>
787- <code title="delete /responses/{response_id}">client.responses.<a href="./src/openai/resources/responses/responses.py">delete</a>(response_id) -> None</code>
788
789## InputItems
790
791Types:
792
793```python
794from openai.types.responses import ResponseItemList
795```
796
797Methods:
798
799- <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>
800
801# Evals
802
803Types:
804
805```python
806from openai.types import (
807 EvalCustomDataSourceConfig,
808 EvalStoredCompletionsDataSourceConfig,
809 EvalCreateResponse,
810 EvalRetrieveResponse,
811 EvalUpdateResponse,
812 EvalListResponse,
813 EvalDeleteResponse,
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 (
831 CreateEvalCompletionsRunDataSource,
832 CreateEvalJSONLRunDataSource,
833 EvalAPIError,
834 RunCreateResponse,
835 RunRetrieveResponse,
836 RunListResponse,
837 RunDeleteResponse,
838 RunCancelResponse,
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>
862