openai-python/api.md at main · solveforceapp/openai-python

Shared Types

from openai.types import (
    AllModels,
    ChatModel,
    ComparisonFilter,
    CompoundFilter,
    ErrorObject,
    FunctionDefinition,
    FunctionParameters,
    Metadata,
    Reasoning,
    ReasoningEffort,
    ResponseFormatJSONObject,
    ResponseFormatJSONSchema,
    ResponseFormatText,
    ResponsesModel,
)

Completions

Types:

from openai.types import Completion, CompletionChoice, CompletionUsage

Methods:

client.completions.create(**params) -> Completion

Chat

Types:

from openai.types import ChatModel

Completions

Types:

from openai.types.chat import (
    ChatCompletion,
    ChatCompletionAssistantMessageParam,
    ChatCompletionAudio,
    ChatCompletionAudioParam,
    ChatCompletionChunk,
    ChatCompletionContentPart,
    ChatCompletionContentPartImage,
    ChatCompletionContentPartInputAudio,
    ChatCompletionContentPartRefusal,
    ChatCompletionContentPartText,
    ChatCompletionDeleted,
    ChatCompletionDeveloperMessageParam,
    ChatCompletionFunctionCallOption,
    ChatCompletionFunctionMessageParam,
    ChatCompletionMessage,
    ChatCompletionMessageParam,
    ChatCompletionMessageToolCall,
    ChatCompletionModality,
    ChatCompletionNamedToolChoice,
    ChatCompletionPredictionContent,
    ChatCompletionRole,
    ChatCompletionStoreMessage,
    ChatCompletionStreamOptions,
    ChatCompletionSystemMessageParam,
    ChatCompletionTokenLogprob,
    ChatCompletionTool,
    ChatCompletionToolChoiceOption,
    ChatCompletionToolMessageParam,
    ChatCompletionUserMessageParam,
    ChatCompletionReasoningEffort,
)

Methods:

client.chat.completions.create(**params) -> ChatCompletion
client.chat.completions.retrieve(completion_id) -> ChatCompletion
client.chat.completions.update(completion_id, **params) -> ChatCompletion
client.chat.completions.list(**params) -> SyncCursorPage[ChatCompletion]
client.chat.completions.delete(completion_id) -> ChatCompletionDeleted

Messages

Methods:

client.chat.completions.messages.list(completion_id, **params) -> SyncCursorPage[ChatCompletionStoreMessage]

Embeddings

Types:

from openai.types import CreateEmbeddingResponse, Embedding, EmbeddingModel

Methods:

client.embeddings.create(**params) -> CreateEmbeddingResponse

Files

Types:

from openai.types import FileContent, FileDeleted, FileObject, FilePurpose

Methods:

client.files.create(**params) -> FileObject
client.files.retrieve(file_id) -> FileObject
client.files.list(**params) -> SyncCursorPage[FileObject]
client.files.delete(file_id) -> FileDeleted
client.files.content(file_id) -> HttpxBinaryResponseContent
client.files.retrieve_content(file_id) -> str
client.files.wait_for_processing(*args) -> FileObject

Images

Types:

from openai.types import Image, ImageModel, ImagesResponse

Methods:

client.images.create_variation(**params) -> ImagesResponse
client.images.edit(**params) -> ImagesResponse
client.images.generate(**params) -> ImagesResponse

Audio

Types:

from openai.types import AudioModel, AudioResponseFormat

Transcriptions

Types:

from openai.types.audio import (
    Transcription,
    TranscriptionInclude,
    TranscriptionSegment,
    TranscriptionStreamEvent,
    TranscriptionTextDeltaEvent,
    TranscriptionTextDoneEvent,
    TranscriptionVerbose,
    TranscriptionWord,
    TranscriptionCreateResponse,
)

Methods:

client.audio.transcriptions.create(**params) -> TranscriptionCreateResponse

Translations

Types:

from openai.types.audio import Translation, TranslationVerbose, TranslationCreateResponse

Methods:

client.audio.translations.create(**params) -> TranslationCreateResponse

Speech

Types:

from openai.types.audio import SpeechModel

Methods:

client.audio.speech.create(**params) -> HttpxBinaryResponseContent

Moderations

Types:

from openai.types import (
    Moderation,
    ModerationImageURLInput,
    ModerationModel,
    ModerationMultiModalInput,
    ModerationTextInput,
    ModerationCreateResponse,
)

Methods:

client.moderations.create(**params) -> ModerationCreateResponse

Models

Types:

from openai.types import Model, ModelDeleted

Methods:

client.models.retrieve(model) -> Model
client.models.list() -> SyncPage[Model]
client.models.delete(model) -> ModelDeleted

FineTuning

Methods

Types:

from openai.types.fine_tuning import (
    DpoHyperparameters,
    DpoMethod,
    ReinforcementHyperparameters,
    ReinforcementMethod,
    SupervisedHyperparameters,
    SupervisedMethod,
)

Jobs

Types:

from openai.types.fine_tuning import (
    FineTuningJob,
    FineTuningJobEvent,
    FineTuningJobWandbIntegration,
    FineTuningJobWandbIntegrationObject,
    FineTuningJobIntegration,
)

Methods:

client.fine_tuning.jobs.create(**params) -> FineTuningJob
client.fine_tuning.jobs.retrieve(fine_tuning_job_id) -> FineTuningJob
client.fine_tuning.jobs.list(**params) -> SyncCursorPage[FineTuningJob]
client.fine_tuning.jobs.cancel(fine_tuning_job_id) -> FineTuningJob
client.fine_tuning.jobs.list_events(fine_tuning_job_id, **params) -> SyncCursorPage[FineTuningJobEvent]
client.fine_tuning.jobs.pause(fine_tuning_job_id) -> FineTuningJob
client.fine_tuning.jobs.resume(fine_tuning_job_id) -> FineTuningJob

Checkpoints

Types:

from openai.types.fine_tuning.jobs import FineTuningJobCheckpoint

Methods:

client.fine_tuning.jobs.checkpoints.list(fine_tuning_job_id, **params) -> SyncCursorPage[FineTuningJobCheckpoint]

Checkpoints

Permissions

Types:

from openai.types.fine_tuning.checkpoints import (
    PermissionCreateResponse,
    PermissionRetrieveResponse,
    PermissionDeleteResponse,
)

Methods:

client.fine_tuning.checkpoints.permissions.create(fine_tuned_model_checkpoint, **params) -> SyncPage[PermissionCreateResponse]
client.fine_tuning.checkpoints.permissions.retrieve(fine_tuned_model_checkpoint, **params) -> PermissionRetrieveResponse
client.fine_tuning.checkpoints.permissions.delete(permission_id, *, fine_tuned_model_checkpoint) -> PermissionDeleteResponse

Alpha

Graders

Types:

from openai.types.fine_tuning.alpha import GraderRunResponse, GraderValidateResponse

Methods:

client.fine_tuning.alpha.graders.run(**params) -> GraderRunResponse
client.fine_tuning.alpha.graders.validate(**params) -> GraderValidateResponse

Graders

GraderModels

Types:

from openai.types.graders import (
    LabelModelGrader,
    MultiGrader,
    PythonGrader,
    ScoreModelGrader,
    StringCheckGrader,
    TextSimilarityGrader,
)

VectorStores

Types:

from openai.types import (
    AutoFileChunkingStrategyParam,
    FileChunkingStrategy,
    FileChunkingStrategyParam,
    OtherFileChunkingStrategyObject,
    StaticFileChunkingStrategy,
    StaticFileChunkingStrategyObject,
    StaticFileChunkingStrategyObjectParam,
    VectorStore,
    VectorStoreDeleted,
    VectorStoreSearchResponse,
)

Methods:

client.vector_stores.create(**params) -> VectorStore
client.vector_stores.retrieve(vector_store_id) -> VectorStore
client.vector_stores.update(vector_store_id, **params) -> VectorStore
client.vector_stores.list(**params) -> SyncCursorPage[VectorStore]
client.vector_stores.delete(vector_store_id) -> VectorStoreDeleted
client.vector_stores.search(vector_store_id, **params) -> SyncPage[VectorStoreSearchResponse]

Files

Types:

from openai.types.vector_stores import VectorStoreFile, VectorStoreFileDeleted, FileContentResponse

Methods:

client.vector_stores.files.create(vector_store_id, **params) -> VectorStoreFile
client.vector_stores.files.retrieve(file_id, *, vector_store_id) -> VectorStoreFile
client.vector_stores.files.update(file_id, *, vector_store_id, **params) -> VectorStoreFile
client.vector_stores.files.list(vector_store_id, **params) -> SyncCursorPage[VectorStoreFile]
client.vector_stores.files.delete(file_id, *, vector_store_id) -> VectorStoreFileDeleted
client.vector_stores.files.content(file_id, *, vector_store_id) -> SyncPage[FileContentResponse]
client.vector_stores.files.create_and_poll(*args) -> VectorStoreFile
client.vector_stores.files.poll(*args) -> VectorStoreFile
client.vector_stores.files.upload(*args) -> VectorStoreFile
client.vector_stores.files.upload_and_poll(*args) -> VectorStoreFile

FileBatches

Types:

from openai.types.vector_stores import VectorStoreFileBatch

Methods:

client.vector_stores.file_batches.create(vector_store_id, **params) -> VectorStoreFileBatch
client.vector_stores.file_batches.retrieve(batch_id, *, vector_store_id) -> VectorStoreFileBatch
client.vector_stores.file_batches.cancel(batch_id, *, vector_store_id) -> VectorStoreFileBatch
client.vector_stores.file_batches.list_files(batch_id, *, vector_store_id, **params) -> SyncCursorPage[VectorStoreFile]
client.vector_stores.file_batches.create_and_poll(*args) -> VectorStoreFileBatch
client.vector_stores.file_batches.poll(*args) -> VectorStoreFileBatch
client.vector_stores.file_batches.upload_and_poll(*args) -> VectorStoreFileBatch

Beta

Realtime

Types:

from openai.types.beta.realtime import (
    ConversationCreatedEvent,
    ConversationItem,
    ConversationItemContent,
    ConversationItemCreateEvent,
    ConversationItemCreatedEvent,
    ConversationItemDeleteEvent,
    ConversationItemDeletedEvent,
    ConversationItemInputAudioTranscriptionCompletedEvent,
    ConversationItemInputAudioTranscriptionDeltaEvent,
    ConversationItemInputAudioTranscriptionFailedEvent,
    ConversationItemRetrieveEvent,
    ConversationItemTruncateEvent,
    ConversationItemTruncatedEvent,
    ConversationItemWithReference,
    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,
    TranscriptionSessionUpdate,
    TranscriptionSessionUpdatedEvent,
)

Sessions

Types:

from openai.types.beta.realtime import Session, SessionCreateResponse

Methods:

client.beta.realtime.sessions.create(**params) -> SessionCreateResponse

TranscriptionSessions

Types:

from openai.types.beta.realtime import TranscriptionSession

Methods:

client.beta.realtime.transcription_sessions.create(**params) -> TranscriptionSession

Assistants

Types:

from openai.types.beta import (
    Assistant,
    AssistantDeleted,
    AssistantStreamEvent,
    AssistantTool,
    CodeInterpreterTool,
    FileSearchTool,
    FunctionTool,
    MessageStreamEvent,
    RunStepStreamEvent,
    RunStreamEvent,
    ThreadStreamEvent,
)

Methods:

client.beta.assistants.create(**params) -> Assistant
client.beta.assistants.retrieve(assistant_id) -> Assistant
client.beta.assistants.update(assistant_id, **params) -> Assistant
client.beta.assistants.list(**params) -> SyncCursorPage[Assistant]
client.beta.assistants.delete(assistant_id) -> AssistantDeleted

Threads

Types:

from openai.types.beta import (
    AssistantResponseFormatOption,
    AssistantToolChoice,
    AssistantToolChoiceFunction,
    AssistantToolChoiceOption,
    Thread,
    ThreadDeleted,
)

Methods:

client.beta.threads.create(**params) -> Thread
client.beta.threads.retrieve(thread_id) -> Thread
client.beta.threads.update(thread_id, **params) -> Thread
client.beta.threads.delete(thread_id) -> ThreadDeleted
client.beta.threads.create_and_run(**params) -> Run
client.beta.threads.create_and_run_poll(*args) -> Run
client.beta.threads.create_and_run_stream(*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]

Runs

Types:

from openai.types.beta.threads import RequiredActionFunctionToolCall, Run, RunStatus

Methods:

client.beta.threads.runs.create(thread_id, **params) -> Run
client.beta.threads.runs.retrieve(run_id, *, thread_id) -> Run
client.beta.threads.runs.update(run_id, *, thread_id, **params) -> Run
client.beta.threads.runs.list(thread_id, **params) -> SyncCursorPage[Run]
client.beta.threads.runs.cancel(run_id, *, thread_id) -> Run
client.beta.threads.runs.submit_tool_outputs(run_id, *, thread_id, **params) -> Run
client.beta.threads.runs.create_and_poll(*args) -> Run
client.beta.threads.runs.create_and_stream(*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]
client.beta.threads.runs.poll(*args) -> Run
client.beta.threads.runs.stream(*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]
client.beta.threads.runs.submit_tool_outputs_and_poll(*args) -> Run
client.beta.threads.runs.submit_tool_outputs_stream(*args) -> AssistantStreamManager[AssistantEventHandler] | AssistantStreamManager[AssistantEventHandlerT]

Steps

Types:

from openai.types.beta.threads.runs import (
    CodeInterpreterLogs,
    CodeInterpreterOutputImage,
    CodeInterpreterToolCall,
    CodeInterpreterToolCallDelta,
    FileSearchToolCall,
    FileSearchToolCallDelta,
    FunctionToolCall,
    FunctionToolCallDelta,
    MessageCreationStepDetails,
    RunStep,
    RunStepDelta,
    RunStepDeltaEvent,
    RunStepDeltaMessageDelta,
    RunStepInclude,
    ToolCall,
    ToolCallDelta,
    ToolCallDeltaObject,
    ToolCallsStepDetails,
)

Methods:

client.beta.threads.runs.steps.retrieve(step_id, *, thread_id, run_id, **params) -> RunStep
client.beta.threads.runs.steps.list(run_id, *, thread_id, **params) -> SyncCursorPage[RunStep]

Messages

Types:

from openai.types.beta.threads import (
    Annotation,
    AnnotationDelta,
    FileCitationAnnotation,
    FileCitationDeltaAnnotation,
    FilePathAnnotation,
    FilePathDeltaAnnotation,
    ImageFile,
    ImageFileContentBlock,
    ImageFileDelta,
    ImageFileDeltaBlock,
    ImageURL,
    ImageURLContentBlock,
    ImageURLDelta,
    ImageURLDeltaBlock,
    Message,
    MessageContent,
    MessageContentDelta,
    MessageContentPartParam,
    MessageDeleted,
    MessageDelta,
    MessageDeltaEvent,
    RefusalContentBlock,
    RefusalDeltaBlock,
    Text,
    TextContentBlock,
    TextContentBlockParam,
    TextDelta,
    TextDeltaBlock,
)

Methods:

client.beta.threads.messages.create(thread_id, **params) -> Message
client.beta.threads.messages.retrieve(message_id, *, thread_id) -> Message
client.beta.threads.messages.update(message_id, *, thread_id, **params) -> Message
client.beta.threads.messages.list(thread_id, **params) -> SyncCursorPage[Message]
client.beta.threads.messages.delete(message_id, *, thread_id) -> MessageDeleted

Batches

Types:

from openai.types import Batch, BatchError, BatchRequestCounts

Methods:

client.batches.create(**params) -> Batch
client.batches.retrieve(batch_id) -> Batch
client.batches.list(**params) -> SyncCursorPage[Batch]
client.batches.cancel(batch_id) -> Batch

Uploads

Types:

from openai.types import Upload

Methods:

client.uploads.create(**params) -> Upload
client.uploads.cancel(upload_id) -> Upload
client.uploads.complete(upload_id, **params) -> Upload

Parts

Types:

from openai.types.uploads import UploadPart

Methods:

client.uploads.parts.create(upload_id, **params) -> UploadPart

Responses

Types:

from openai.types.responses import (
    ComputerTool,
    EasyInputMessage,
    FileSearchTool,
    FunctionTool,
    Response,
    ResponseAudioDeltaEvent,
    ResponseAudioDoneEvent,
    ResponseAudioTranscriptDeltaEvent,
    ResponseAudioTranscriptDoneEvent,
    ResponseCodeInterpreterCallCodeDeltaEvent,
    ResponseCodeInterpreterCallCodeDoneEvent,
    ResponseCodeInterpreterCallCompletedEvent,
    ResponseCodeInterpreterCallInProgressEvent,
    ResponseCodeInterpreterCallInterpretingEvent,
    ResponseCodeInterpreterToolCall,
    ResponseCompletedEvent,
    ResponseComputerToolCall,
    ResponseComputerToolCallOutputItem,
    ResponseComputerToolCallOutputScreenshot,
    ResponseContent,
    ResponseContentPartAddedEvent,
    ResponseContentPartDoneEvent,
    ResponseCreatedEvent,
    ResponseError,
    ResponseErrorEvent,
    ResponseFailedEvent,
    ResponseFileSearchCallCompletedEvent,
    ResponseFileSearchCallInProgressEvent,
    ResponseFileSearchCallSearchingEvent,
    ResponseFileSearchToolCall,
    ResponseFormatTextConfig,
    ResponseFormatTextJSONSchemaConfig,
    ResponseFunctionCallArgumentsDeltaEvent,
    ResponseFunctionCallArgumentsDoneEvent,
    ResponseFunctionToolCall,
    ResponseFunctionToolCallItem,
    ResponseFunctionToolCallOutputItem,
    ResponseFunctionWebSearch,
    ResponseImageGenCallCompletedEvent,
    ResponseImageGenCallGeneratingEvent,
    ResponseImageGenCallInProgressEvent,
    ResponseImageGenCallPartialImageEvent,
    ResponseInProgressEvent,
    ResponseIncludable,
    ResponseIncompleteEvent,
    ResponseInput,
    ResponseInputAudio,
    ResponseInputContent,
    ResponseInputFile,
    ResponseInputImage,
    ResponseInputItem,
    ResponseInputMessageContentList,
    ResponseInputMessageItem,
    ResponseInputText,
    ResponseItem,
    ResponseMcpCallArgumentsDeltaEvent,
    ResponseMcpCallArgumentsDoneEvent,
    ResponseMcpCallCompletedEvent,
    ResponseMcpCallFailedEvent,
    ResponseMcpCallInProgressEvent,
    ResponseMcpListToolsCompletedEvent,
    ResponseMcpListToolsFailedEvent,
    ResponseMcpListToolsInProgressEvent,
    ResponseOutputAudio,
    ResponseOutputItem,
    ResponseOutputItemAddedEvent,
    ResponseOutputItemDoneEvent,
    ResponseOutputMessage,
    ResponseOutputRefusal,
    ResponseOutputText,
    ResponseOutputTextAnnotationAddedEvent,
    ResponsePrompt,
    ResponseQueuedEvent,
    ResponseReasoningDeltaEvent,
    ResponseReasoningDoneEvent,
    ResponseReasoningItem,
    ResponseReasoningSummaryDeltaEvent,
    ResponseReasoningSummaryDoneEvent,
    ResponseReasoningSummaryPartAddedEvent,
    ResponseReasoningSummaryPartDoneEvent,
    ResponseReasoningSummaryTextDeltaEvent,
    ResponseReasoningSummaryTextDoneEvent,
    ResponseRefusalDeltaEvent,
    ResponseRefusalDoneEvent,
    ResponseStatus,
    ResponseStreamEvent,
    ResponseTextConfig,
    ResponseTextDeltaEvent,
    ResponseTextDoneEvent,
    ResponseUsage,
    ResponseWebSearchCallCompletedEvent,
    ResponseWebSearchCallInProgressEvent,
    ResponseWebSearchCallSearchingEvent,
    Tool,
    ToolChoiceFunction,
    ToolChoiceOptions,
    ToolChoiceTypes,
    WebSearchTool,
)

Methods:

client.responses.create(**params) -> Response
client.responses.retrieve(response_id, **params) -> Response
client.responses.delete(response_id) -> None
client.responses.cancel(response_id) -> Response

InputItems

Types:

from openai.types.responses import ResponseItemList

Methods:

client.responses.input_items.list(response_id, **params) -> SyncCursorPage[ResponseItem]

Evals

Types:

from openai.types import (
    EvalCustomDataSourceConfig,
    EvalStoredCompletionsDataSourceConfig,
    EvalCreateResponse,
    EvalRetrieveResponse,
    EvalUpdateResponse,
    EvalListResponse,
    EvalDeleteResponse,
)

Methods:

client.evals.create(**params) -> EvalCreateResponse
client.evals.retrieve(eval_id) -> EvalRetrieveResponse
client.evals.update(eval_id, **params) -> EvalUpdateResponse
client.evals.list(**params) -> SyncCursorPage[EvalListResponse]
client.evals.delete(eval_id) -> EvalDeleteResponse

Runs

Types:

from openai.types.evals import (
    CreateEvalCompletionsRunDataSource,
    CreateEvalJSONLRunDataSource,
    EvalAPIError,
    RunCreateResponse,
    RunRetrieveResponse,
    RunListResponse,
    RunDeleteResponse,
    RunCancelResponse,
)

Methods:

client.evals.runs.create(eval_id, **params) -> RunCreateResponse
client.evals.runs.retrieve(run_id, *, eval_id) -> RunRetrieveResponse
client.evals.runs.list(eval_id, **params) -> SyncCursorPage[RunListResponse]
client.evals.runs.delete(run_id, *, eval_id) -> RunDeleteResponse
client.evals.runs.cancel(run_id, *, eval_id) -> RunCancelResponse

OutputItems

Types:

from openai.types.evals.runs import OutputItemRetrieveResponse, OutputItemListResponse

Methods:

client.evals.runs.output_items.retrieve(output_item_id, *, eval_id, run_id) -> OutputItemRetrieveResponse
client.evals.runs.output_items.list(run_id, *, eval_id, **params) -> SyncCursorPage[OutputItemListResponse]

Containers

Types:

from openai.types import ContainerCreateResponse, ContainerRetrieveResponse, ContainerListResponse

Methods:

client.containers.create(**params) -> ContainerCreateResponse
client.containers.retrieve(container_id) -> ContainerRetrieveResponse
client.containers.list(**params) -> SyncCursorPage[ContainerListResponse]
client.containers.delete(container_id) -> None

Files

Types:

from openai.types.containers import FileCreateResponse, FileRetrieveResponse, FileListResponse

Methods:

client.containers.files.create(container_id, **params) -> FileCreateResponse
client.containers.files.retrieve(file_id, *, container_id) -> FileRetrieveResponse
client.containers.files.list(container_id, **params) -> SyncCursorPage[FileListResponse]
client.containers.files.delete(file_id, *, container_id) -> None

Content

Methods:

client.containers.files.content.retrieve(file_id, *, container_id) -> HttpxBinaryResponseContent