2023-11-08 19:51:57 +00:00
|
|
|
# Shared Types
|
|
|
|
|
|
|
|
|
|
```python
|
2024-08-06 18:11:32 +01:00
|
|
|
from openai.types import (
|
|
|
|
|
ErrorObject,
|
|
|
|
|
FunctionDefinition,
|
|
|
|
|
FunctionParameters,
|
|
|
|
|
ResponseFormatJSONObject,
|
|
|
|
|
ResponseFormatJSONSchema,
|
|
|
|
|
ResponseFormatText,
|
|
|
|
|
)
|
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,
|
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,
|
|
|
|
|
ChatCompletionFunctionCallOption,
|
|
|
|
|
ChatCompletionFunctionMessageParam,
|
2023-11-06 08:19:00 -08:00
|
|
|
ChatCompletionMessage,
|
|
|
|
|
ChatCompletionMessageParam,
|
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
|
|
|
ChatCompletionMessageToolCall,
|
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,
|
2023-11-06 08:19:00 -08:00
|
|
|
ChatCompletionRole,
|
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,
|
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
|
|
|
ChatCompletionTool,
|
|
|
|
|
ChatCompletionToolChoiceOption,
|
|
|
|
|
ChatCompletionToolMessageParam,
|
|
|
|
|
ChatCompletionUserMessageParam,
|
2023-11-06 08:19:00 -08:00
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /chat/completions">client.chat.completions.<a href="./src/openai/resources/chat/completions.py">create</a>(\*\*<a href="src/openai/types/chat/completion_create_params.py">params</a>) -> <a href="./src/openai/types/chat/chat_completion.py">ChatCompletion</a></code>
|
|
|
|
|
|
|
|
|
|
# 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>
|
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 /files">client.files.<a href="./src/openai/resources/files.py">list</a>(\*\*<a href="src/openai/types/file_list_params.py">params</a>) -> <a href="./src/openai/types/file_object.py">SyncPage[FileObject]</a></code>
|
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>
|
2023-11-06 08:19:00 -08:00
|
|
|
- <code title="get /files/{file_id}/content">client.files.<a href="./src/openai/resources/files.py">retrieve_content</a>(file_id) -> str</code>
|
|
|
|
|
- <code>client.files.<a href="./src/openai/resources/files.py">wait_for_processing</a>(\*args) -> FileObject</code>
|
|
|
|
|
|
|
|
|
|
# Images
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-08-02 09:32:24 +00:00
|
|
|
from openai.types import Image, 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,
|
|
|
|
|
TranscriptionSegment,
|
|
|
|
|
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
|
|
|
|
|
|
|
|
|
|
## Jobs
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-04-15 15:05:04 -04:00
|
|
|
from openai.types.fine_tuning import (
|
|
|
|
|
FineTuningJob,
|
|
|
|
|
FineTuningJobEvent,
|
|
|
|
|
FineTuningJobIntegration,
|
|
|
|
|
FineTuningJobWandbIntegration,
|
|
|
|
|
FineTuningJobWandbIntegrationObject,
|
|
|
|
|
)
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
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>
|
|
|
|
|
|
|
|
|
|
### 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
|
|
|
|
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-04-17 12:35:22 -04:00
|
|
|
## VectorStores
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
2024-09-06 09:27:05 +00:00
|
|
|
from openai.types.beta import (
|
|
|
|
|
AutoFileChunkingStrategyParam,
|
|
|
|
|
FileChunkingStrategy,
|
|
|
|
|
FileChunkingStrategyParam,
|
|
|
|
|
OtherFileChunkingStrategyObject,
|
|
|
|
|
StaticFileChunkingStrategy,
|
|
|
|
|
StaticFileChunkingStrategyObject,
|
|
|
|
|
StaticFileChunkingStrategyParam,
|
|
|
|
|
VectorStore,
|
|
|
|
|
VectorStoreDeleted,
|
|
|
|
|
)
|
2024-04-17 12:35:22 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /vector_stores">client.beta.vector_stores.<a href="./src/openai/resources/beta/vector_stores/vector_stores.py">create</a>(\*\*<a href="src/openai/types/beta/vector_store_create_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_store.py">VectorStore</a></code>
|
|
|
|
|
- <code title="get /vector_stores/{vector_store_id}">client.beta.vector_stores.<a href="./src/openai/resources/beta/vector_stores/vector_stores.py">retrieve</a>(vector_store_id) -> <a href="./src/openai/types/beta/vector_store.py">VectorStore</a></code>
|
|
|
|
|
- <code title="post /vector_stores/{vector_store_id}">client.beta.vector_stores.<a href="./src/openai/resources/beta/vector_stores/vector_stores.py">update</a>(vector_store_id, \*\*<a href="src/openai/types/beta/vector_store_update_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_store.py">VectorStore</a></code>
|
|
|
|
|
- <code title="get /vector_stores">client.beta.vector_stores.<a href="./src/openai/resources/beta/vector_stores/vector_stores.py">list</a>(\*\*<a href="src/openai/types/beta/vector_store_list_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_store.py">SyncCursorPage[VectorStore]</a></code>
|
|
|
|
|
- <code title="delete /vector_stores/{vector_store_id}">client.beta.vector_stores.<a href="./src/openai/resources/beta/vector_stores/vector_stores.py">delete</a>(vector_store_id) -> <a href="./src/openai/types/beta/vector_store_deleted.py">VectorStoreDeleted</a></code>
|
|
|
|
|
|
|
|
|
|
### Files
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.beta.vector_stores import VectorStoreFile, VectorStoreFileDeleted
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /vector_stores/{vector_store_id}/files">client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">create</a>(vector_store_id, \*\*<a href="src/openai/types/beta/vector_stores/file_create_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
|
|
|
|
|
- <code title="get /vector_stores/{vector_store_id}/files/{file_id}">client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">retrieve</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file.py">VectorStoreFile</a></code>
|
|
|
|
|
- <code title="get /vector_stores/{vector_store_id}/files">client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">list</a>(vector_store_id, \*\*<a href="src/openai/types/beta/vector_stores/file_list_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file.py">SyncCursorPage[VectorStoreFile]</a></code>
|
|
|
|
|
- <code title="delete /vector_stores/{vector_store_id}/files/{file_id}">client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">delete</a>(file_id, \*, vector_store_id) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file_deleted.py">VectorStoreFileDeleted</a></code>
|
|
|
|
|
- <code>client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">create_and_poll</a>(\*args) -> VectorStoreFile</code>
|
|
|
|
|
- <code>client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">poll</a>(\*args) -> VectorStoreFile</code>
|
|
|
|
|
- <code>client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">upload</a>(\*args) -> VectorStoreFile</code>
|
|
|
|
|
- <code>client.beta.vector_stores.files.<a href="./src/openai/resources/beta/vector_stores/files.py">upload_and_poll</a>(\*args) -> VectorStoreFile</code>
|
|
|
|
|
|
|
|
|
|
### FileBatches
|
|
|
|
|
|
|
|
|
|
Types:
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
from openai.types.beta.vector_stores import VectorStoreFileBatch
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Methods:
|
|
|
|
|
|
|
|
|
|
- <code title="post /vector_stores/{vector_store_id}/file_batches">client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">create</a>(vector_store_id, \*\*<a href="src/openai/types/beta/vector_stores/file_batch_create_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
|
|
|
|
|
- <code title="get /vector_stores/{vector_store_id}/file_batches/{batch_id}">client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">retrieve</a>(batch_id, \*, vector_store_id) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
|
|
|
|
|
- <code title="post /vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel">client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">cancel</a>(batch_id, \*, vector_store_id) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file_batch.py">VectorStoreFileBatch</a></code>
|
|
|
|
|
- <code title="get /vector_stores/{vector_store_id}/file_batches/{batch_id}/files">client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">list_files</a>(batch_id, \*, vector_store_id, \*\*<a href="src/openai/types/beta/vector_stores/file_batch_list_files_params.py">params</a>) -> <a href="./src/openai/types/beta/vector_stores/vector_store_file.py">SyncCursorPage[VectorStoreFile]</a></code>
|
|
|
|
|
- <code>client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">create_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
|
|
|
|
|
- <code>client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">poll</a>(\*args) -> VectorStoreFileBatch</code>
|
|
|
|
|
- <code>client.beta.vector_stores.file_batches.<a href="./src/openai/resources/beta/vector_stores/file_batches.py">upload_and_poll</a>(\*args) -> VectorStoreFileBatch</code>
|
|
|
|
|
|
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
|
|
|
|
|
from openai.types import Batch, BatchError, BatchRequestCounts
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
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>
|
