2023-11-08 19:51:57 +00:00
|
|
|
# Shared Types
|
|
|
|
|
|
|
|
|
|
```python
|
2024-08-06 18:11:32 +01:00
|
|
|
from openai.types import (
|
2025-03-19 20:39:23 +00:00
|
|
|
AllModels,
|
2025-03-06 20:10:48 +00:00
|
|
|
ChatModel,
|
2025-03-11 12:22:03 -04:00
|
|
|
ComparisonFilter,
|
|
|
|
|
CompoundFilter,
|
2025-08-07 17:02:31 +00:00
|
|
|
CustomToolInputFormat,
|
2024-08-06 18:11:32 +01:00
|
|
|
ErrorObject,
|
|
|
|
|
FunctionDefinition,
|
|
|
|
|
FunctionParameters,
|
2025-01-31 19:09:53 +00:00
|
|
|
Metadata,
|
2025-03-11 12:22:03 -04:00
|
|
|
Reasoning,
|
|
|
|
|
ReasoningEffort,
|
2024-08-06 18:11:32 +01:00
|
|
|
ResponseFormatJSONObject,
|
|
|
|
|
ResponseFormatJSONSchema,
|
|
|
|
|
ResponseFormatText,
|
2025-08-07 17:02:31 +00:00
|
|
|
ResponseFormatTextGrammar,
|
|
|
|
|
ResponseFormatTextPython,
|
2025-03-19 20:39:23 +00:00
|
|
|
ResponsesModel,
|
2024-08-06 18:11:32 +01:00
|
|
|
)
|
2023-11-08 19:51:57 +00:00
|
|
|
```
|
|
|
|
|
|
2023-11-06 08:19:00 -08:00
|
|
|
# Completions
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types import Completion, CompletionChoice, CompletionUsage
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
# Chat
|
|
|
|
|
|
2024-04-16 12:54:34 -04:00
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types import ChatModel
|
|
|
|
|
```
|
|
|
|
|
|
2023-11-06 08:19:00 -08:00
|
|
|
## Completions
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.chat import (
|
|
|
|
|
ChatCompletion,
|
2025-08-07 17:02:31 +00:00
|
|
|
ChatCompletionAllowedToolChoice,
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
ChatCompletionAssistantMessageParam,
|
2024-10-17 16:49:46 +00:00
|
|
|
ChatCompletionAudio,
|
|
|
|
|
ChatCompletionAudioParam,
|
2023-11-06 08:19:00 -08:00
|
|
|
ChatCompletionChunk,
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
ChatCompletionContentPart,
|
|
|
|
|
ChatCompletionContentPartImage,
|
2024-10-17 16:49:46 +00:00
|
|
|
ChatCompletionContentPartInputAudio,
|
2024-08-06 18:11:32 +01:00
|
|
|
ChatCompletionContentPartRefusal,
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
ChatCompletionContentPartText,
|
2025-08-07 17:02:31 +00:00
|
|
|
ChatCompletionCustomTool,
|
2025-02-13 19:45:16 +00:00
|
|
|
ChatCompletionDeleted,
|
2024-12-17 17:59:13 +00:00
|
|
|
ChatCompletionDeveloperMessageParam,
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
ChatCompletionFunctionCallOption,
|
|
|
|
|
ChatCompletionFunctionMessageParam,
|
2025-08-07 17:02:31 +00:00
|
|
|
ChatCompletionFunctionTool,
|
2023-11-06 08:19:00 -08:00
|
|
|
ChatCompletionMessage,
|
2025-08-07 17:02:31 +00:00
|
|
|
ChatCompletionMessageCustomToolCall,
|
|
|
|
|
ChatCompletionMessageFunctionToolCall,
|
2023-11-06 08:19:00 -08:00
|
|
|
ChatCompletionMessageParam,
|
2025-08-11 12:56:29 +00:00
|
|
|
ChatCompletionMessageToolCallUnion,
|
2024-10-17 16:49:46 +00:00
|
|
|
ChatCompletionModality,
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
ChatCompletionNamedToolChoice,
|
2025-08-07 17:02:31 +00:00
|
|
|
ChatCompletionNamedToolChoiceCustom,
|
2024-11-04 22:47:52 +00:00
|
|
|
ChatCompletionPredictionContent,
|
2023-11-06 08:19:00 -08:00
|
|
|
ChatCompletionRole,
|
2025-02-13 19:45:16 +00:00
|
|
|
ChatCompletionStoreMessage,
|
2024-05-06 15:07:30 -04:00
|
|
|
ChatCompletionStreamOptions,
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
ChatCompletionSystemMessageParam,
|
2023-12-16 19:47:42 -05:00
|
|
|
ChatCompletionTokenLogprob,
|
2025-08-08 11:24:58 +00:00
|
|
|
ChatCompletionToolUnion,
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
ChatCompletionToolChoiceOption,
|
|
|
|
|
ChatCompletionToolMessageParam,
|
|
|
|
|
ChatCompletionUserMessageParam,
|
2025-08-07 17:02:31 +00:00
|
|
|
ChatCompletionAllowedTools,
|
2025-03-11 12:22:03 -04:00
|
|
|
ChatCompletionReasoningEffort,
|
2023-11-06 08:19:00 -08:00
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
2025-02-13 19:45:16 +00:00
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
### Messages
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
2023-11-06 08:19:00 -08:00
|
|
|
|
|
|
|
|
# Embeddings
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-09-19 16:26:25 +00:00
|
|
|
from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel
|
2023-11-06 08:19:00 -08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
# Files
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-08-15 21:59:01 +00:00
|
|
|
from openai.types import FileContent, FileDeleted, FileObject, FilePurpose
|
2023-11-06 08:19:00 -08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
2024-11-04 22:47:52 +00:00
|
|
|
- <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>
|
2023-11-06 08:19:00 -08:00
|
|
|
- <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>
|
2023-11-09 18:46:43 +00:00
|
|
|
- <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">content</a>(file_id) -> HttpxBinaryResponseContent</code>
|
2025-01-31 10:09:46 +00:00
|
|
|
- <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>
|
2023-11-06 08:19:00 -08:00
|
|
|
- <code>client.files.<a href="./src/openai/resources/files.py">wait_for_processing</a>(\*args) -> FileObject</code>
|
|
|
|
|
|
|
|
|
|
# Images
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2025-07-16 16:24:53 +00:00
|
|
|
from openai.types import (
|
|
|
|
|
Image,
|
|
|
|
|
ImageEditCompletedEvent,
|
|
|
|
|
ImageEditPartialImageEvent,
|
|
|
|
|
ImageEditStreamEvent,
|
|
|
|
|
ImageGenCompletedEvent,
|
|
|
|
|
ImageGenPartialImageEvent,
|
|
|
|
|
ImageGenStreamEvent,
|
|
|
|
|
ImageModel,
|
|
|
|
|
ImagesResponse,
|
|
|
|
|
)
|
2023-11-06 08:19:00 -08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
# Audio
|
|
|
|
|
|
2024-08-02 09:32:24 +00:00
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-09-25 12:43:48 +00:00
|
|
|
from openai.types import AudioModel, AudioResponseFormat
|
2024-08-02 09:32:24 +00:00
|
|
|
```
|
|
|
|
|
|
2023-11-06 08:19:00 -08:00
|
|
|
## Transcriptions
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-09-27 23:51:00 +01:00
|
|
|
from openai.types.audio import (
|
|
|
|
|
Transcription,
|
2025-10-16 14:55:31 +00:00
|
|
|
TranscriptionDiarized,
|
|
|
|
|
TranscriptionDiarizedSegment,
|
2025-03-20 16:25:10 +00:00
|
|
|
TranscriptionInclude,
|
2024-09-27 23:51:00 +01:00
|
|
|
TranscriptionSegment,
|
2025-03-20 16:25:10 +00:00
|
|
|
TranscriptionStreamEvent,
|
|
|
|
|
TranscriptionTextDeltaEvent,
|
|
|
|
|
TranscriptionTextDoneEvent,
|
2025-10-16 14:55:31 +00:00
|
|
|
TranscriptionTextSegmentEvent,
|
2024-09-27 23:51:00 +01:00
|
|
|
TranscriptionVerbose,
|
|
|
|
|
TranscriptionWord,
|
|
|
|
|
TranscriptionCreateResponse,
|
|
|
|
|
)
|
2023-11-06 08:19:00 -08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
2024-09-27 23:51:00 +01:00
|
|
|
- <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>
|
2023-11-06 08:19:00 -08:00
|
|
|
|
|
|
|
|
## Translations
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-09-27 23:51:00 +01:00
|
|
|
from openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse
|
2023-11-06 08:19:00 -08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
2024-09-27 23:51:00 +01:00
|
|
|
- <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>
|
2023-11-06 08:19:00 -08:00
|
|
|
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
## Speech
|
|
|
|
|
|
2024-08-02 09:32:24 +00:00
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.audio import SpeechModel
|
|
|
|
|
```
|
|
|
|
|
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
|
2023-11-06 08:19:00 -08:00
|
|
|
# Moderations
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-09-26 17:25:28 +00:00
|
|
|
from openai.types import (
|
|
|
|
|
Moderation,
|
|
|
|
|
ModerationImageURLInput,
|
|
|
|
|
ModerationModel,
|
|
|
|
|
ModerationMultiModalInput,
|
|
|
|
|
ModerationTextInput,
|
|
|
|
|
ModerationCreateResponse,
|
|
|
|
|
)
|
2023-11-06 08:19:00 -08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
# Models
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types import Model, ModelDeleted
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
# FineTuning
|
|
|
|
|
|
2025-05-08 17:23:49 +00:00
|
|
|
## Methods
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.fine_tuning import (
|
|
|
|
|
DpoHyperparameters,
|
|
|
|
|
DpoMethod,
|
|
|
|
|
ReinforcementHyperparameters,
|
|
|
|
|
ReinforcementMethod,
|
|
|
|
|
SupervisedHyperparameters,
|
|
|
|
|
SupervisedMethod,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
2023-11-06 08:19:00 -08:00
|
|
|
## Jobs
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-04-15 15:05:04 -04:00
|
|
|
from openai.types.fine_tuning import (
|
|
|
|
|
FineTuningJob,
|
|
|
|
|
FineTuningJobEvent,
|
|
|
|
|
FineTuningJobWandbIntegration,
|
|
|
|
|
FineTuningJobWandbIntegrationObject,
|
2025-03-06 20:10:48 +00:00
|
|
|
FineTuningJobIntegration,
|
2024-04-15 15:05:04 -04:00
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
2025-05-08 17:23:49 +00:00
|
|
|
- <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>
|
|
|
|
|
- <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>
|
2024-04-15 15:05:04 -04:00
|
|
|
|
|
|
|
|
### Checkpoints
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint
|
2023-11-06 08:19:00 -08:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
2024-04-15 15:05:04 -04:00
|
|
|
- <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>
|
2023-11-06 08:19:00 -08:00
|
|
|
|
2025-04-08 18:50:02 +00:00
|
|
|
## Checkpoints
|
|
|
|
|
|
|
|
|
|
### Permissions
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.fine_tuning.checkpoints import (
|
|
|
|
|
PermissionCreateResponse,
|
|
|
|
|
PermissionRetrieveResponse,
|
|
|
|
|
PermissionDeleteResponse,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
2025-06-23 11:26:16 -07:00
|
|
|
- <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>
|
2025-04-23 16:29:55 +00:00
|
|
|
- <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>
|
2025-04-08 18:50:02 +00:00
|
|
|
|
2025-05-08 17:23:49 +00:00
|
|
|
## Alpha
|
|
|
|
|
|
|
|
|
|
### Graders
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
# Graders
|
|
|
|
|
|
|
|
|
|
## GraderModels
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.graders import (
|
2025-12-13 03:23:48 +00:00
|
|
|
GraderInputs,
|
2025-05-08 17:23:49 +00:00
|
|
|
LabelModelGrader,
|
|
|
|
|
MultiGrader,
|
|
|
|
|
PythonGrader,
|
|
|
|
|
ScoreModelGrader,
|
|
|
|
|
StringCheckGrader,
|
|
|
|
|
TextSimilarityGrader,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
2025-03-11 12:22:03 -04:00
|
|
|
# VectorStores
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types import (
|
|
|
|
|
AutoFileChunkingStrategyParam,
|
|
|
|
|
FileChunkingStrategy,
|
|
|
|
|
FileChunkingStrategyParam,
|
|
|
|
|
OtherFileChunkingStrategyObject,
|
|
|
|
|
StaticFileChunkingStrategy,
|
|
|
|
|
StaticFileChunkingStrategyObject,
|
|
|
|
|
StaticFileChunkingStrategyObjectParam,
|
|
|
|
|
VectorStore,
|
|
|
|
|
VectorStoreDeleted,
|
|
|
|
|
VectorStoreSearchResponse,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
## Files
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">create_and_poll</a>(\*args) -> VectorStoreFile</code>
|
|
|
|
|
- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">poll</a>(\*args) -> VectorStoreFile</code>
|
|
|
|
|
- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload</a>(\*args) -> VectorStoreFile</code>
|
|
|
|
|
- <code>client.vector_stores.files.<a href="./src/openai/resources/vector_stores/files.py">upload_and_poll</a>(\*args) -> VectorStoreFile</code>
|
|
|
|
|
|
|
|
|
|
## FileBatches
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.vector_stores import VectorStoreFileBatch
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">create_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
|
|
|
|
|
- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">poll</a>(\*args) -> VectorStoreFileBatch</code>
|
|
|
|
|
- <code>client.vector_stores.file_batches.<a href="./src/openai/resources/vector_stores/file_batches.py">upload_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
|
|
|
|
|
|
2025-06-26 09:56:28 -07:00
|
|
|
# Webhooks
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.webhooks import (
|
|
|
|
|
BatchCancelledWebhookEvent,
|
|
|
|
|
BatchCompletedWebhookEvent,
|
|
|
|
|
BatchExpiredWebhookEvent,
|
|
|
|
|
BatchFailedWebhookEvent,
|
|
|
|
|
EvalRunCanceledWebhookEvent,
|
|
|
|
|
EvalRunFailedWebhookEvent,
|
|
|
|
|
EvalRunSucceededWebhookEvent,
|
|
|
|
|
FineTuningJobCancelledWebhookEvent,
|
|
|
|
|
FineTuningJobFailedWebhookEvent,
|
|
|
|
|
FineTuningJobSucceededWebhookEvent,
|
2025-09-02 13:46:20 +00:00
|
|
|
RealtimeCallIncomingWebhookEvent,
|
2025-06-26 09:56:28 -07:00
|
|
|
ResponseCancelledWebhookEvent,
|
|
|
|
|
ResponseCompletedWebhookEvent,
|
|
|
|
|
ResponseFailedWebhookEvent,
|
|
|
|
|
ResponseIncompleteWebhookEvent,
|
|
|
|
|
UnwrapWebhookEvent,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code>client.webhooks.<a href="./src/openai/resources/webhooks.py">unwrap</a>(payload, headers, \*, secret) -> UnwrapWebhookEvent</code>
|
|
|
|
|
- <code>client.webhooks.<a href="./src/openai/resources/webhooks.py">verify_signature</a>(payload, headers, \*, secret, tolerance) -> None</code>
|
|
|
|
|
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
# Beta
|
|
|
|
|
|
2024-12-17 17:59:13 +00:00
|
|
|
## Realtime
|
|
|
|
|
|
2024-12-17 18:09:06 +00:00
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.beta.realtime import (
|
|
|
|
|
ConversationCreatedEvent,
|
|
|
|
|
ConversationItem,
|
|
|
|
|
ConversationItemContent,
|
|
|
|
|
ConversationItemCreateEvent,
|
|
|
|
|
ConversationItemCreatedEvent,
|
|
|
|
|
ConversationItemDeleteEvent,
|
|
|
|
|
ConversationItemDeletedEvent,
|
|
|
|
|
ConversationItemInputAudioTranscriptionCompletedEvent,
|
2025-03-20 16:25:10 +00:00
|
|
|
ConversationItemInputAudioTranscriptionDeltaEvent,
|
2024-12-17 18:09:06 +00:00
|
|
|
ConversationItemInputAudioTranscriptionFailedEvent,
|
2025-03-20 16:25:10 +00:00
|
|
|
ConversationItemRetrieveEvent,
|
2024-12-17 18:09:06 +00:00
|
|
|
ConversationItemTruncateEvent,
|
|
|
|
|
ConversationItemTruncatedEvent,
|
2025-02-05 11:26:48 +00:00
|
|
|
ConversationItemWithReference,
|
2024-12-17 18:09:06 +00:00
|
|
|
ErrorEvent,
|
|
|
|
|
InputAudioBufferAppendEvent,
|
|
|
|
|
InputAudioBufferClearEvent,
|
|
|
|
|
InputAudioBufferClearedEvent,
|
|
|
|
|
InputAudioBufferCommitEvent,
|
|
|
|
|
InputAudioBufferCommittedEvent,
|
|
|
|
|
InputAudioBufferSpeechStartedEvent,
|
|
|
|
|
InputAudioBufferSpeechStoppedEvent,
|
|
|
|
|
RateLimitsUpdatedEvent,
|
|
|
|
|
RealtimeClientEvent,
|
|
|
|
|
RealtimeResponse,
|
|
|
|
|
RealtimeResponseStatus,
|
|
|
|
|
RealtimeResponseUsage,
|
|
|
|
|
RealtimeServerEvent,
|
|
|
|
|
ResponseAudioDeltaEvent,
|
|
|
|
|
ResponseAudioDoneEvent,
|
|
|
|
|
ResponseAudioTranscriptDeltaEvent,
|
|
|
|
|
ResponseAudioTranscriptDoneEvent,
|
|
|
|
|
ResponseCancelEvent,
|
|
|
|
|
ResponseContentPartAddedEvent,
|
|
|
|
|
ResponseContentPartDoneEvent,
|
|
|
|
|
ResponseCreateEvent,
|
|
|
|
|
ResponseCreatedEvent,
|
|
|
|
|
ResponseDoneEvent,
|
|
|
|
|
ResponseFunctionCallArgumentsDeltaEvent,
|
|
|
|
|
ResponseFunctionCallArgumentsDoneEvent,
|
|
|
|
|
ResponseOutputItemAddedEvent,
|
|
|
|
|
ResponseOutputItemDoneEvent,
|
|
|
|
|
ResponseTextDeltaEvent,
|
|
|
|
|
ResponseTextDoneEvent,
|
|
|
|
|
SessionCreatedEvent,
|
|
|
|
|
SessionUpdateEvent,
|
|
|
|
|
SessionUpdatedEvent,
|
2025-03-20 16:25:10 +00:00
|
|
|
TranscriptionSessionUpdate,
|
|
|
|
|
TranscriptionSessionUpdatedEvent,
|
2024-12-17 18:09:06 +00:00
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
2024-12-17 17:59:13 +00:00
|
|
|
### Sessions
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.beta.realtime import Session, SessionCreateResponse
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
|
2025-03-20 16:25:10 +00:00
|
|
|
### TranscriptionSessions
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.beta.realtime import TranscriptionSession
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
## Assistants
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-03-13 16:35:35 -04:00
|
|
|
from openai.types.beta import (
|
|
|
|
|
Assistant,
|
|
|
|
|
AssistantDeleted,
|
|
|
|
|
AssistantStreamEvent,
|
|
|
|
|
AssistantTool,
|
|
|
|
|
CodeInterpreterTool,
|
2024-04-17 12:35:22 -04:00
|
|
|
FileSearchTool,
|
2024-03-13 16:35:35 -04:00
|
|
|
FunctionTool,
|
|
|
|
|
MessageStreamEvent,
|
|
|
|
|
RunStepStreamEvent,
|
|
|
|
|
RunStreamEvent,
|
|
|
|
|
ThreadStreamEvent,
|
|
|
|
|
)
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
2024-04-17 12:35:22 -04:00
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
|
|
|
|
|
## Threads
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-04-15 15:05:04 -04:00
|
|
|
from openai.types.beta import (
|
|
|
|
|
AssistantResponseFormatOption,
|
|
|
|
|
AssistantToolChoice,
|
|
|
|
|
AssistantToolChoiceFunction,
|
|
|
|
|
AssistantToolChoiceOption,
|
|
|
|
|
Thread,
|
|
|
|
|
ThreadDeleted,
|
|
|
|
|
)
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
2024-04-02 00:39:26 +02:00
|
|
|
- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_poll</a>(\*args) -> Run</code>
|
2024-03-13 16:35:35 -04:00
|
|
|
- <code>client.beta.threads.<a href="./src/openai/resources/beta/threads/threads.py">create_and_run_stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
|
|
|
|
|
### Runs
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-02-22 15:17:19 -05:00
|
|
|
from openai.types.beta.threads import RequiredActionFunctionToolCall, Run, RunStatus
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
2024-04-02 00:39:26 +02:00
|
|
|
- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">create_and_poll</a>(\*args) -> Run</code>
|
2024-03-13 16:35:35 -04:00
|
|
|
- <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>
|
2024-04-02 00:39:26 +02:00
|
|
|
- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">poll</a>(\*args) -> Run</code>
|
|
|
|
|
- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">stream</a>(\*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]</code>
|
|
|
|
|
- <code>client.beta.threads.runs.<a href="./src/openai/resources/beta/threads/runs/runs.py">submit_tool_outputs_and_poll</a>(\*args) -> Run</code>
|
2024-03-13 16:35:35 -04:00
|
|
|
- <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>
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
|
|
|
|
|
#### Steps
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.beta.threads.runs import (
|
2024-03-13 16:35:35 -04:00
|
|
|
CodeInterpreterLogs,
|
|
|
|
|
CodeInterpreterOutputImage,
|
|
|
|
|
CodeInterpreterToolCall,
|
|
|
|
|
CodeInterpreterToolCallDelta,
|
2024-04-17 12:35:22 -04:00
|
|
|
FileSearchToolCall,
|
|
|
|
|
FileSearchToolCallDelta,
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
FunctionToolCall,
|
2024-03-13 16:35:35 -04:00
|
|
|
FunctionToolCallDelta,
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
MessageCreationStepDetails,
|
|
|
|
|
RunStep,
|
2024-03-13 16:35:35 -04:00
|
|
|
RunStepDelta,
|
|
|
|
|
RunStepDeltaEvent,
|
|
|
|
|
RunStepDeltaMessageDelta,
|
2024-08-29 16:27:45 +00:00
|
|
|
RunStepInclude,
|
2024-03-13 16:35:35 -04:00
|
|
|
ToolCall,
|
|
|
|
|
ToolCallDelta,
|
|
|
|
|
ToolCallDeltaObject,
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
ToolCallsStepDetails,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
2024-08-29 16:27:45 +00:00
|
|
|
- <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>
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
### Messages
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.beta.threads import (
|
2024-03-13 16:35:35 -04:00
|
|
|
Annotation,
|
|
|
|
|
AnnotationDelta,
|
|
|
|
|
FileCitationAnnotation,
|
|
|
|
|
FileCitationDeltaAnnotation,
|
|
|
|
|
FilePathAnnotation,
|
|
|
|
|
FilePathDeltaAnnotation,
|
|
|
|
|
ImageFile,
|
|
|
|
|
ImageFileContentBlock,
|
|
|
|
|
ImageFileDelta,
|
|
|
|
|
ImageFileDeltaBlock,
|
2024-05-09 16:19:42 -04:00
|
|
|
ImageURL,
|
|
|
|
|
ImageURLContentBlock,
|
|
|
|
|
ImageURLDelta,
|
|
|
|
|
ImageURLDeltaBlock,
|
2024-03-13 16:35:35 -04:00
|
|
|
Message,
|
|
|
|
|
MessageContent,
|
|
|
|
|
MessageContentDelta,
|
2024-05-09 16:19:42 -04:00
|
|
|
MessageContentPartParam,
|
2024-03-13 16:35:35 -04:00
|
|
|
MessageDeleted,
|
|
|
|
|
MessageDelta,
|
|
|
|
|
MessageDeltaEvent,
|
2024-08-06 18:11:32 +01:00
|
|
|
RefusalContentBlock,
|
|
|
|
|
RefusalDeltaBlock,
|
2024-03-13 16:35:35 -04:00
|
|
|
Text,
|
|
|
|
|
TextContentBlock,
|
2024-05-09 16:19:42 -04:00
|
|
|
TextContentBlockParam,
|
2024-03-13 16:35:35 -04:00
|
|
|
TextDelta,
|
|
|
|
|
TextDeltaBlock,
|
feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more (#682)
* feat(api): releases from DevDay; assistants, multimodality, tools, dall-e-3, tts, and more
* docs(api): improve docstrings
* v1.1.0
2023-11-06 20:35:10 +00:00
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
2024-04-17 12:35:22 -04:00
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
2024-05-01 00:00:17 -04:00
|
|
|
- <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>
|
2024-04-15 16:10:17 -04:00
|
|
|
|
|
|
|
|
# Batches
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2025-09-30 07:36:50 +00:00
|
|
|
from openai.types import Batch, BatchError, BatchRequestCounts, BatchUsage
|
2024-04-15 16:10:17 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
2024-04-18 10:49:14 -04:00
|
|
|
- <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>
|
2024-04-15 16:10:17 -04:00
|
|
|
- <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>
|
2024-07-22 11:10:52 +00:00
|
|
|
|
|
|
|
|
# Uploads
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types import Upload
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
## Parts
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.uploads import UploadPart
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
2025-03-11 12:22:03 -04:00
|
|
|
|
|
|
|
|
# Responses
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.responses import (
|
2025-11-13 18:10:43 +00:00
|
|
|
ApplyPatchTool,
|
2025-12-04 17:50:57 +00:00
|
|
|
CompactedResponse,
|
2025-03-11 12:22:03 -04:00
|
|
|
ComputerTool,
|
2026-02-10 18:05:29 +00:00
|
|
|
ContainerAuto,
|
|
|
|
|
ContainerNetworkPolicyAllowlist,
|
|
|
|
|
ContainerNetworkPolicyDisabled,
|
|
|
|
|
ContainerNetworkPolicyDomainSecret,
|
|
|
|
|
ContainerReference,
|
2025-08-07 17:02:31 +00:00
|
|
|
CustomTool,
|
2025-03-11 12:22:03 -04:00
|
|
|
EasyInputMessage,
|
|
|
|
|
FileSearchTool,
|
2025-11-13 18:10:43 +00:00
|
|
|
FunctionShellTool,
|
2025-03-11 12:22:03 -04:00
|
|
|
FunctionTool,
|
2026-02-10 18:05:29 +00:00
|
|
|
InlineSkill,
|
|
|
|
|
InlineSkillSource,
|
|
|
|
|
LocalEnvironment,
|
|
|
|
|
LocalSkill,
|
2025-03-11 12:22:03 -04:00
|
|
|
Response,
|
2025-11-13 18:10:43 +00:00
|
|
|
ResponseApplyPatchToolCall,
|
|
|
|
|
ResponseApplyPatchToolCallOutput,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseAudioDeltaEvent,
|
|
|
|
|
ResponseAudioDoneEvent,
|
|
|
|
|
ResponseAudioTranscriptDeltaEvent,
|
|
|
|
|
ResponseAudioTranscriptDoneEvent,
|
|
|
|
|
ResponseCodeInterpreterCallCodeDeltaEvent,
|
|
|
|
|
ResponseCodeInterpreterCallCodeDoneEvent,
|
|
|
|
|
ResponseCodeInterpreterCallCompletedEvent,
|
|
|
|
|
ResponseCodeInterpreterCallInProgressEvent,
|
|
|
|
|
ResponseCodeInterpreterCallInterpretingEvent,
|
|
|
|
|
ResponseCodeInterpreterToolCall,
|
2025-12-04 17:50:57 +00:00
|
|
|
ResponseCompactionItem,
|
|
|
|
|
ResponseCompactionItemParam,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseCompletedEvent,
|
|
|
|
|
ResponseComputerToolCall,
|
2025-03-18 21:50:14 +00:00
|
|
|
ResponseComputerToolCallOutputItem,
|
|
|
|
|
ResponseComputerToolCallOutputScreenshot,
|
2026-02-10 18:05:29 +00:00
|
|
|
ResponseContainerReference,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseContent,
|
|
|
|
|
ResponseContentPartAddedEvent,
|
|
|
|
|
ResponseContentPartDoneEvent,
|
2025-08-21 16:10:05 -05:00
|
|
|
ResponseConversationParam,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseCreatedEvent,
|
2025-08-07 17:02:31 +00:00
|
|
|
ResponseCustomToolCall,
|
|
|
|
|
ResponseCustomToolCallInputDeltaEvent,
|
|
|
|
|
ResponseCustomToolCallInputDoneEvent,
|
|
|
|
|
ResponseCustomToolCallOutput,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseError,
|
|
|
|
|
ResponseErrorEvent,
|
|
|
|
|
ResponseFailedEvent,
|
|
|
|
|
ResponseFileSearchCallCompletedEvent,
|
|
|
|
|
ResponseFileSearchCallInProgressEvent,
|
|
|
|
|
ResponseFileSearchCallSearchingEvent,
|
|
|
|
|
ResponseFileSearchToolCall,
|
|
|
|
|
ResponseFormatTextConfig,
|
|
|
|
|
ResponseFormatTextJSONSchemaConfig,
|
|
|
|
|
ResponseFunctionCallArgumentsDeltaEvent,
|
|
|
|
|
ResponseFunctionCallArgumentsDoneEvent,
|
2025-09-30 07:36:50 +00:00
|
|
|
ResponseFunctionCallOutputItem,
|
|
|
|
|
ResponseFunctionCallOutputItemList,
|
2025-11-13 18:10:43 +00:00
|
|
|
ResponseFunctionShellCallOutputContent,
|
|
|
|
|
ResponseFunctionShellToolCall,
|
|
|
|
|
ResponseFunctionShellToolCallOutput,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseFunctionToolCall,
|
2025-03-18 21:50:14 +00:00
|
|
|
ResponseFunctionToolCallItem,
|
|
|
|
|
ResponseFunctionToolCallOutputItem,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseFunctionWebSearch,
|
2025-05-21 11:39:41 -05:00
|
|
|
ResponseImageGenCallCompletedEvent,
|
|
|
|
|
ResponseImageGenCallGeneratingEvent,
|
|
|
|
|
ResponseImageGenCallInProgressEvent,
|
|
|
|
|
ResponseImageGenCallPartialImageEvent,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseInProgressEvent,
|
|
|
|
|
ResponseIncludable,
|
|
|
|
|
ResponseIncompleteEvent,
|
|
|
|
|
ResponseInput,
|
|
|
|
|
ResponseInputAudio,
|
|
|
|
|
ResponseInputContent,
|
|
|
|
|
ResponseInputFile,
|
2025-09-30 07:36:50 +00:00
|
|
|
ResponseInputFileContent,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseInputImage,
|
2025-09-30 07:36:50 +00:00
|
|
|
ResponseInputImageContent,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseInputItem,
|
|
|
|
|
ResponseInputMessageContentList,
|
2025-03-18 21:50:14 +00:00
|
|
|
ResponseInputMessageItem,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseInputText,
|
2025-09-30 07:36:50 +00:00
|
|
|
ResponseInputTextContent,
|
2025-03-18 21:50:14 +00:00
|
|
|
ResponseItem,
|
2026-02-10 18:05:29 +00:00
|
|
|
ResponseLocalEnvironment,
|
2025-05-21 11:39:41 -05:00
|
|
|
ResponseMcpCallArgumentsDeltaEvent,
|
|
|
|
|
ResponseMcpCallArgumentsDoneEvent,
|
|
|
|
|
ResponseMcpCallCompletedEvent,
|
|
|
|
|
ResponseMcpCallFailedEvent,
|
|
|
|
|
ResponseMcpCallInProgressEvent,
|
|
|
|
|
ResponseMcpListToolsCompletedEvent,
|
|
|
|
|
ResponseMcpListToolsFailedEvent,
|
|
|
|
|
ResponseMcpListToolsInProgressEvent,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseOutputAudio,
|
|
|
|
|
ResponseOutputItem,
|
|
|
|
|
ResponseOutputItemAddedEvent,
|
|
|
|
|
ResponseOutputItemDoneEvent,
|
|
|
|
|
ResponseOutputMessage,
|
|
|
|
|
ResponseOutputRefusal,
|
|
|
|
|
ResponseOutputText,
|
2025-05-21 11:39:41 -05:00
|
|
|
ResponseOutputTextAnnotationAddedEvent,
|
2025-06-16 14:03:28 -05:00
|
|
|
ResponsePrompt,
|
2025-05-21 11:39:41 -05:00
|
|
|
ResponseQueuedEvent,
|
2025-03-11 21:44:13 +00:00
|
|
|
ResponseReasoningItem,
|
2025-04-23 16:29:55 +00:00
|
|
|
ResponseReasoningSummaryPartAddedEvent,
|
|
|
|
|
ResponseReasoningSummaryPartDoneEvent,
|
|
|
|
|
ResponseReasoningSummaryTextDeltaEvent,
|
|
|
|
|
ResponseReasoningSummaryTextDoneEvent,
|
2025-08-05 16:50:43 +00:00
|
|
|
ResponseReasoningTextDeltaEvent,
|
|
|
|
|
ResponseReasoningTextDoneEvent,
|
2025-03-11 12:22:03 -04:00
|
|
|
ResponseRefusalDeltaEvent,
|
|
|
|
|
ResponseRefusalDoneEvent,
|
|
|
|
|
ResponseStatus,
|
|
|
|
|
ResponseStreamEvent,
|
|
|
|
|
ResponseTextConfig,
|
|
|
|
|
ResponseTextDeltaEvent,
|
|
|
|
|
ResponseTextDoneEvent,
|
|
|
|
|
ResponseUsage,
|
|
|
|
|
ResponseWebSearchCallCompletedEvent,
|
|
|
|
|
ResponseWebSearchCallInProgressEvent,
|
|
|
|
|
ResponseWebSearchCallSearchingEvent,
|
2026-02-10 18:05:29 +00:00
|
|
|
SkillReference,
|
2025-03-11 12:22:03 -04:00
|
|
|
Tool,
|
2025-08-07 17:02:31 +00:00
|
|
|
ToolChoiceAllowed,
|
2025-11-13 18:10:43 +00:00
|
|
|
ToolChoiceApplyPatch,
|
2025-08-07 17:02:31 +00:00
|
|
|
ToolChoiceCustom,
|
2025-03-11 12:22:03 -04:00
|
|
|
ToolChoiceFunction,
|
2025-06-26 09:56:28 -07:00
|
|
|
ToolChoiceMcp,
|
2025-03-11 12:22:03 -04:00
|
|
|
ToolChoiceOptions,
|
2025-11-13 18:10:43 +00:00
|
|
|
ToolChoiceShell,
|
2025-03-11 12:22:03 -04:00
|
|
|
ToolChoiceTypes,
|
2025-09-02 13:46:20 +00:00
|
|
|
WebSearchPreviewTool,
|
2025-03-11 12:22:03 -04:00
|
|
|
WebSearchTool,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <code title="delete /responses/{response_id}">client.responses.<a href="./src/openai/resources/responses/responses.py">delete</a>(response_id) -> None</code>
|
2025-06-02 14:39:03 -05:00
|
|
|
- <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>
|
2025-12-04 17:50:57 +00:00
|
|
|
- <code title="post /responses/compact">client.responses.<a href="./src/openai/resources/responses/responses.py">compact</a>(\*\*<a href="src/openai/types/responses/response_compact_params.py">params</a>) -> <a href="./src/openai/types/responses/compacted_response.py">CompactedResponse</a></code>
|
2025-03-11 12:22:03 -04:00
|
|
|
|
|
|
|
|
## InputItems
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.responses import ResponseItemList
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
2025-03-18 21:50:14 +00:00
|
|
|
- <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>
|
2025-04-08 18:50:02 +00:00
|
|
|
|
2025-10-20 16:44:45 +00:00
|
|
|
## InputTokens
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.responses import InputTokenCountResponse
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /responses/input_tokens">client.responses.input_tokens.<a href="./src/openai/resources/responses/input_tokens.py">count</a>(\*\*<a href="src/openai/types/responses/input_token_count_params.py">params</a>) -> <a href="./src/openai/types/responses/input_token_count_response.py">InputTokenCountResponse</a></code>
|
|
|
|
|
|
2025-09-02 13:46:20 +00:00
|
|
|
# Realtime
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.realtime import (
|
2025-09-08 15:24:53 -04:00
|
|
|
AudioTranscription,
|
2025-09-02 13:46:20 +00:00
|
|
|
ConversationCreatedEvent,
|
|
|
|
|
ConversationItem,
|
|
|
|
|
ConversationItemAdded,
|
|
|
|
|
ConversationItemCreateEvent,
|
|
|
|
|
ConversationItemCreatedEvent,
|
|
|
|
|
ConversationItemDeleteEvent,
|
|
|
|
|
ConversationItemDeletedEvent,
|
|
|
|
|
ConversationItemDone,
|
|
|
|
|
ConversationItemInputAudioTranscriptionCompletedEvent,
|
|
|
|
|
ConversationItemInputAudioTranscriptionDeltaEvent,
|
|
|
|
|
ConversationItemInputAudioTranscriptionFailedEvent,
|
|
|
|
|
ConversationItemInputAudioTranscriptionSegment,
|
|
|
|
|
ConversationItemRetrieveEvent,
|
|
|
|
|
ConversationItemTruncateEvent,
|
|
|
|
|
ConversationItemTruncatedEvent,
|
|
|
|
|
ConversationItemWithReference,
|
|
|
|
|
InputAudioBufferAppendEvent,
|
|
|
|
|
InputAudioBufferClearEvent,
|
|
|
|
|
InputAudioBufferClearedEvent,
|
|
|
|
|
InputAudioBufferCommitEvent,
|
|
|
|
|
InputAudioBufferCommittedEvent,
|
2025-12-04 17:50:57 +00:00
|
|
|
InputAudioBufferDtmfEventReceivedEvent,
|
2025-09-02 13:46:20 +00:00
|
|
|
InputAudioBufferSpeechStartedEvent,
|
|
|
|
|
InputAudioBufferSpeechStoppedEvent,
|
|
|
|
|
InputAudioBufferTimeoutTriggered,
|
|
|
|
|
LogProbProperties,
|
|
|
|
|
McpListToolsCompleted,
|
|
|
|
|
McpListToolsFailed,
|
|
|
|
|
McpListToolsInProgress,
|
2025-09-08 15:24:53 -04:00
|
|
|
NoiseReductionType,
|
2025-09-02 13:46:20 +00:00
|
|
|
OutputAudioBufferClearEvent,
|
|
|
|
|
RateLimitsUpdatedEvent,
|
|
|
|
|
RealtimeAudioConfig,
|
2025-09-08 15:24:53 -04:00
|
|
|
RealtimeAudioConfigInput,
|
|
|
|
|
RealtimeAudioConfigOutput,
|
|
|
|
|
RealtimeAudioFormats,
|
|
|
|
|
RealtimeAudioInputTurnDetection,
|
2025-09-02 13:46:20 +00:00
|
|
|
RealtimeClientEvent,
|
|
|
|
|
RealtimeConversationItemAssistantMessage,
|
|
|
|
|
RealtimeConversationItemFunctionCall,
|
|
|
|
|
RealtimeConversationItemFunctionCallOutput,
|
|
|
|
|
RealtimeConversationItemSystemMessage,
|
|
|
|
|
RealtimeConversationItemUserMessage,
|
|
|
|
|
RealtimeError,
|
|
|
|
|
RealtimeErrorEvent,
|
2025-09-10 11:03:41 -04:00
|
|
|
RealtimeFunctionTool,
|
2025-09-02 13:46:20 +00:00
|
|
|
RealtimeMcpApprovalRequest,
|
|
|
|
|
RealtimeMcpApprovalResponse,
|
|
|
|
|
RealtimeMcpListTools,
|
|
|
|
|
RealtimeMcpProtocolError,
|
|
|
|
|
RealtimeMcpToolCall,
|
|
|
|
|
RealtimeMcpToolExecutionError,
|
|
|
|
|
RealtimeMcphttpError,
|
|
|
|
|
RealtimeResponse,
|
2025-09-08 15:24:53 -04:00
|
|
|
RealtimeResponseCreateAudioOutput,
|
|
|
|
|
RealtimeResponseCreateMcpTool,
|
|
|
|
|
RealtimeResponseCreateParams,
|
2025-09-02 13:46:20 +00:00
|
|
|
RealtimeResponseStatus,
|
|
|
|
|
RealtimeResponseUsage,
|
|
|
|
|
RealtimeResponseUsageInputTokenDetails,
|
|
|
|
|
RealtimeResponseUsageOutputTokenDetails,
|
|
|
|
|
RealtimeServerEvent,
|
|
|
|
|
RealtimeSession,
|
|
|
|
|
RealtimeSessionCreateRequest,
|
|
|
|
|
RealtimeToolChoiceConfig,
|
|
|
|
|
RealtimeToolsConfig,
|
|
|
|
|
RealtimeToolsConfigUnion,
|
|
|
|
|
RealtimeTracingConfig,
|
2025-09-08 15:24:53 -04:00
|
|
|
RealtimeTranscriptionSessionAudio,
|
|
|
|
|
RealtimeTranscriptionSessionAudioInput,
|
|
|
|
|
RealtimeTranscriptionSessionAudioInputTurnDetection,
|
2025-09-02 13:46:20 +00:00
|
|
|
RealtimeTranscriptionSessionCreateRequest,
|
|
|
|
|
RealtimeTruncation,
|
2025-09-08 15:24:53 -04:00
|
|
|
RealtimeTruncationRetentionRatio,
|
2025-09-02 13:46:20 +00:00
|
|
|
ResponseAudioDeltaEvent,
|
|
|
|
|
ResponseAudioDoneEvent,
|
|
|
|
|
ResponseAudioTranscriptDeltaEvent,
|
|
|
|
|
ResponseAudioTranscriptDoneEvent,
|
|
|
|
|
ResponseCancelEvent,
|
|
|
|
|
ResponseContentPartAddedEvent,
|
|
|
|
|
ResponseContentPartDoneEvent,
|
|
|
|
|
ResponseCreateEvent,
|
|
|
|
|
ResponseCreatedEvent,
|
|
|
|
|
ResponseDoneEvent,
|
|
|
|
|
ResponseFunctionCallArgumentsDeltaEvent,
|
|
|
|
|
ResponseFunctionCallArgumentsDoneEvent,
|
|
|
|
|
ResponseMcpCallArgumentsDelta,
|
|
|
|
|
ResponseMcpCallArgumentsDone,
|
|
|
|
|
ResponseMcpCallCompleted,
|
|
|
|
|
ResponseMcpCallFailed,
|
|
|
|
|
ResponseMcpCallInProgress,
|
|
|
|
|
ResponseOutputItemAddedEvent,
|
|
|
|
|
ResponseOutputItemDoneEvent,
|
|
|
|
|
ResponseTextDeltaEvent,
|
|
|
|
|
ResponseTextDoneEvent,
|
|
|
|
|
SessionCreatedEvent,
|
|
|
|
|
SessionUpdateEvent,
|
|
|
|
|
SessionUpdatedEvent,
|
|
|
|
|
TranscriptionSessionUpdate,
|
|
|
|
|
TranscriptionSessionUpdatedEvent,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## ClientSecrets
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2025-09-08 15:24:53 -04:00
|
|
|
from openai.types.realtime import (
|
|
|
|
|
RealtimeSessionClientSecret,
|
|
|
|
|
RealtimeSessionCreateResponse,
|
|
|
|
|
RealtimeTranscriptionSessionCreateResponse,
|
|
|
|
|
RealtimeTranscriptionSessionTurnDetection,
|
|
|
|
|
ClientSecretCreateResponse,
|
|
|
|
|
)
|
2025-09-02 13:46:20 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /realtime/client_secrets">client.realtime.client_secrets.<a href="./src/openai/resources/realtime/client_secrets.py">create</a>(\*\*<a href="src/openai/types/realtime/client_secret_create_params.py">params</a>) -> <a href="./src/openai/types/realtime/client_secret_create_response.py">ClientSecretCreateResponse</a></code>
|
|
|
|
|
|
2025-10-02 20:13:26 +00:00
|
|
|
## Calls
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /realtime/calls">client.realtime.calls.<a href="./src/openai/resources/realtime/calls.py">create</a>(\*\*<a href="src/openai/types/realtime/call_create_params.py">params</a>) -> HttpxBinaryResponseContent</code>
|
|
|
|
|
- <code title="post /realtime/calls/{call_id}/accept">client.realtime.calls.<a href="./src/openai/resources/realtime/calls.py">accept</a>(call_id, \*\*<a href="src/openai/types/realtime/call_accept_params.py">params</a>) -> None</code>
|
|
|
|
|
- <code title="post /realtime/calls/{call_id}/hangup">client.realtime.calls.<a href="./src/openai/resources/realtime/calls.py">hangup</a>(call_id) -> None</code>
|
|
|
|
|
- <code title="post /realtime/calls/{call_id}/refer">client.realtime.calls.<a href="./src/openai/resources/realtime/calls.py">refer</a>(call_id, \*\*<a href="src/openai/types/realtime/call_refer_params.py">params</a>) -> None</code>
|
|
|
|
|
- <code title="post /realtime/calls/{call_id}/reject">client.realtime.calls.<a href="./src/openai/resources/realtime/calls.py">reject</a>(call_id, \*\*<a href="src/openai/types/realtime/call_reject_params.py">params</a>) -> None</code>
|
|
|
|
|
|
2025-08-21 16:10:05 -05:00
|
|
|
# Conversations
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.conversations import (
|
|
|
|
|
ComputerScreenshotContent,
|
|
|
|
|
Conversation,
|
|
|
|
|
ConversationDeleted,
|
|
|
|
|
ConversationDeletedResource,
|
|
|
|
|
Message,
|
|
|
|
|
SummaryTextContent,
|
|
|
|
|
TextContent,
|
2025-09-17 18:02:28 -04:00
|
|
|
InputTextContent,
|
|
|
|
|
OutputTextContent,
|
|
|
|
|
RefusalContent,
|
|
|
|
|
InputImageContent,
|
|
|
|
|
InputFileContent,
|
2025-08-21 16:10:05 -05:00
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /conversations">client.conversations.<a href="./src/openai/resources/conversations/conversations.py">create</a>(\*\*<a href="src/openai/types/conversations/conversation_create_params.py">params</a>) -> <a href="./src/openai/types/conversations/conversation.py">Conversation</a></code>
|
|
|
|
|
- <code title="get /conversations/{conversation_id}">client.conversations.<a href="./src/openai/resources/conversations/conversations.py">retrieve</a>(conversation_id) -> <a href="./src/openai/types/conversations/conversation.py">Conversation</a></code>
|
|
|
|
|
- <code title="post /conversations/{conversation_id}">client.conversations.<a href="./src/openai/resources/conversations/conversations.py">update</a>(conversation_id, \*\*<a href="src/openai/types/conversations/conversation_update_params.py">params</a>) -> <a href="./src/openai/types/conversations/conversation.py">Conversation</a></code>
|
|
|
|
|
- <code title="delete /conversations/{conversation_id}">client.conversations.<a href="./src/openai/resources/conversations/conversations.py">delete</a>(conversation_id) -> <a href="./src/openai/types/conversations/conversation_deleted_resource.py">ConversationDeletedResource</a></code>
|
|
|
|
|
|
|
|
|
|
## Items
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.conversations import ConversationItem, ConversationItemList
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /conversations/{conversation_id}/items">client.conversations.items.<a href="./src/openai/resources/conversations/items.py">create</a>(conversation_id, \*\*<a href="src/openai/types/conversations/item_create_params.py">params</a>) -> <a href="./src/openai/types/conversations/conversation_item_list.py">ConversationItemList</a></code>
|
|
|
|
|
- <code title="get /conversations/{conversation_id}/items/{item_id}">client.conversations.items.<a href="./src/openai/resources/conversations/items.py">retrieve</a>(item_id, \*, conversation_id, \*\*<a href="src/openai/types/conversations/item_retrieve_params.py">params</a>) -> <a href="./src/openai/types/conversations/conversation_item.py">ConversationItem</a></code>
|
|
|
|
|
- <code title="get /conversations/{conversation_id}/items">client.conversations.items.<a href="./src/openai/resources/conversations/items.py">list</a>(conversation_id, \*\*<a href="src/openai/types/conversations/item_list_params.py">params</a>) -> <a href="./src/openai/types/conversations/conversation_item.py">SyncConversationCursorPage[ConversationItem]</a></code>
|
|
|
|
|
- <code title="delete /conversations/{conversation_id}/items/{item_id}">client.conversations.items.<a href="./src/openai/resources/conversations/items.py">delete</a>(item_id, \*, conversation_id) -> <a href="./src/openai/types/conversations/conversation.py">Conversation</a></code>
|
|
|
|
|
|
2025-04-08 18:50:02 +00:00
|
|
|
# Evals
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types import (
|
|
|
|
|
EvalCustomDataSourceConfig,
|
|
|
|
|
EvalStoredCompletionsDataSourceConfig,
|
|
|
|
|
EvalCreateResponse,
|
|
|
|
|
EvalRetrieveResponse,
|
|
|
|
|
EvalUpdateResponse,
|
|
|
|
|
EvalListResponse,
|
|
|
|
|
EvalDeleteResponse,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
## Runs
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.evals import (
|
|
|
|
|
CreateEvalCompletionsRunDataSource,
|
|
|
|
|
CreateEvalJSONLRunDataSource,
|
|
|
|
|
EvalAPIError,
|
|
|
|
|
RunCreateResponse,
|
|
|
|
|
RunRetrieveResponse,
|
|
|
|
|
RunListResponse,
|
|
|
|
|
RunDeleteResponse,
|
|
|
|
|
RunCancelResponse,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
### OutputItems
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.evals.runs import OutputItemRetrieveResponse, OutputItemListResponse
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
2025-05-21 13:39:24 -05:00
|
|
|
|
|
|
|
|
# Containers
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types import ContainerCreateResponse, ContainerRetrieveResponse, ContainerListResponse
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <code title="delete /containers/{container_id}">client.containers.<a href="./src/openai/resources/containers/containers.py">delete</a>(container_id) -> None</code>
|
|
|
|
|
|
|
|
|
|
## Files
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.containers import FileCreateResponse, FileRetrieveResponse, FileListResponse
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
- <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>
|
|
|
|
|
|
|
|
|
|
### Content
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
2025-06-02 14:39:03 -05:00
|
|
|
- <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>
|
2025-10-06 17:49:02 +00:00
|
|
|
|
2026-02-10 18:05:29 +00:00
|
|
|
# Skills
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types import DeletedSkill, Skill, SkillList
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /skills">client.skills.<a href="./src/openai/resources/skills/skills.py">create</a>(\*\*<a href="src/openai/types/skill_create_params.py">params</a>) -> <a href="./src/openai/types/skill.py">Skill</a></code>
|
|
|
|
|
- <code title="get /skills/{skill_id}">client.skills.<a href="./src/openai/resources/skills/skills.py">retrieve</a>(skill_id) -> <a href="./src/openai/types/skill.py">Skill</a></code>
|
|
|
|
|
- <code title="post /skills/{skill_id}">client.skills.<a href="./src/openai/resources/skills/skills.py">update</a>(skill_id, \*\*<a href="src/openai/types/skill_update_params.py">params</a>) -> <a href="./src/openai/types/skill.py">Skill</a></code>
|
|
|
|
|
- <code title="get /skills">client.skills.<a href="./src/openai/resources/skills/skills.py">list</a>(\*\*<a href="src/openai/types/skill_list_params.py">params</a>) -> <a href="./src/openai/types/skill.py">SyncCursorPage[Skill]</a></code>
|
|
|
|
|
- <code title="delete /skills/{skill_id}">client.skills.<a href="./src/openai/resources/skills/skills.py">delete</a>(skill_id) -> <a href="./src/openai/types/deleted_skill.py">DeletedSkill</a></code>
|
|
|
|
|
|
|
|
|
|
## Content
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="get /skills/{skill_id}/content">client.skills.content.<a href="./src/openai/resources/skills/content.py">retrieve</a>(skill_id) -> HttpxBinaryResponseContent</code>
|
|
|
|
|
|
|
|
|
|
## Versions
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.skills import DeletedSkillVersion, SkillVersion, SkillVersionList
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /skills/{skill_id}/versions">client.skills.versions.<a href="./src/openai/resources/skills/versions/versions.py">create</a>(skill_id, \*\*<a href="src/openai/types/skills/version_create_params.py">params</a>) -> <a href="./src/openai/types/skills/skill_version.py">SkillVersion</a></code>
|
|
|
|
|
- <code title="get /skills/{skill_id}/versions/{version}">client.skills.versions.<a href="./src/openai/resources/skills/versions/versions.py">retrieve</a>(version, \*, skill_id) -> <a href="./src/openai/types/skills/skill_version.py">SkillVersion</a></code>
|
|
|
|
|
- <code title="get /skills/{skill_id}/versions">client.skills.versions.<a href="./src/openai/resources/skills/versions/versions.py">list</a>(skill_id, \*\*<a href="src/openai/types/skills/version_list_params.py">params</a>) -> <a href="./src/openai/types/skills/skill_version.py">SyncCursorPage[SkillVersion]</a></code>
|
|
|
|
|
- <code title="delete /skills/{skill_id}/versions/{version}">client.skills.versions.<a href="./src/openai/resources/skills/versions/versions.py">delete</a>(version, \*, skill_id) -> <a href="./src/openai/types/skills/deleted_skill_version.py">DeletedSkillVersion</a></code>
|
|
|
|
|
|
|
|
|
|
### Content
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="get /skills/{skill_id}/versions/{version}/content">client.skills.versions.content.<a href="./src/openai/resources/skills/versions/content.py">retrieve</a>(version, \*, skill_id) -> HttpxBinaryResponseContent</code>
|
|
|
|
|
|
2025-10-06 17:49:02 +00:00
|
|
|
# Videos
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types import (
|
|
|
|
|
Video,
|
|
|
|
|
VideoCreateError,
|
|
|
|
|
VideoModel,
|
|
|
|
|
VideoSeconds,
|
|
|
|
|
VideoSize,
|
|
|
|
|
VideoDeleteResponse,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /videos">client.videos.<a href="./src/openai/resources/videos.py">create</a>(\*\*<a href="src/openai/types/video_create_params.py">params</a>) -> <a href="./src/openai/types/video.py">Video</a></code>
|
|
|
|
|
- <code title="get /videos/{video_id}">client.videos.<a href="./src/openai/resources/videos.py">retrieve</a>(video_id) -> <a href="./src/openai/types/video.py">Video</a></code>
|
|
|
|
|
- <code title="get /videos">client.videos.<a href="./src/openai/resources/videos.py">list</a>(\*\*<a href="src/openai/types/video_list_params.py">params</a>) -> <a href="./src/openai/types/video.py">SyncConversationCursorPage[Video]</a></code>
|
|
|
|
|
- <code title="delete /videos/{video_id}">client.videos.<a href="./src/openai/resources/videos.py">delete</a>(video_id) -> <a href="./src/openai/types/video_delete_response.py">VideoDeleteResponse</a></code>
|
|
|
|
|
- <code title="get /videos/{video_id}/content">client.videos.<a href="./src/openai/resources/videos.py">download_content</a>(video_id, \*\*<a href="src/openai/types/video_download_content_params.py">params</a>) -> HttpxBinaryResponseContent</code>
|
|
|
|
|
- <code title="post /videos/{video_id}/remix">client.videos.<a href="./src/openai/resources/videos.py">remix</a>(video_id, \*\*<a href="src/openai/types/video_remix_params.py">params</a>) -> <a href="./src/openai/types/video.py">Video</a></code>
|
|
|
|
|
- <code>client.videos.<a href="./src/openai/resources/videos.py">create_and_poll</a>(\*args) -> Video</code>
|
|
|
|
|
|
