# Shared Types: - ErrorObject - FunctionDefinition - FunctionParameters - Metadata - ResponseFormatJSONObject - ResponseFormatJSONSchema - ResponseFormatText # Completions Types: - Completion - CompletionChoice - CompletionUsage Methods: - client.completions.create({ ...params }) -> Completion # Chat Types: - ChatModel ## Completions Types: - ChatCompletion - ChatCompletionAssistantMessageParam - ChatCompletionAudio - ChatCompletionAudioParam - ChatCompletionChunk - ChatCompletionContentPart - ChatCompletionContentPartImage - ChatCompletionContentPartInputAudio - ChatCompletionContentPartRefusal - ChatCompletionContentPartText - ChatCompletionDeleted - ChatCompletionDeveloperMessageParam - ChatCompletionFunctionCallOption - ChatCompletionFunctionMessageParam - ChatCompletionMessage - ChatCompletionMessageParam - ChatCompletionMessageToolCall - ChatCompletionModality - ChatCompletionNamedToolChoice - ChatCompletionPredictionContent - ChatCompletionReasoningEffort - ChatCompletionRole - ChatCompletionStoreMessage - ChatCompletionStreamOptions - ChatCompletionSystemMessageParam - ChatCompletionTokenLogprob - ChatCompletionTool - ChatCompletionToolChoiceOption - ChatCompletionToolMessageParam - ChatCompletionUserMessageParam Methods: - client.chat.completions.create({ ...params }) -> ChatCompletion - client.chat.completions.retrieve(completionID) -> ChatCompletion - client.chat.completions.update(completionID, { ...params }) -> ChatCompletion - client.chat.completions.list({ ...params }) -> ChatCompletionsPage - client.chat.completions.delete(completionID) -> ChatCompletionDeleted ### Messages Methods: - client.chat.completions.messages.list(completionID, { ...params }) -> ChatCompletionStoreMessagesPage # Embeddings Types: - CreateEmbeddingResponse - Embedding - EmbeddingModel Methods: - client.embeddings.create({ ...params }) -> CreateEmbeddingResponse # Files Types: - FileContent - FileDeleted - FileObject - FilePurpose Methods: - client.files.create({ ...params }) -> FileObject - client.files.retrieve(fileID) -> FileObject - client.files.list({ ...params }) -> FileObjectsPage - client.files.delete(fileID) -> FileDeleted - client.files.content(fileID) -> Response - client.files.waitForProcessing(id, { pollInterval = 5000, maxWait = 30 _ 60 _ 1000 }) -> Promise<FileObject> # Images Types: - Image - ImageModel - ImagesResponse Methods: - client.images.createVariation({ ...params }) -> ImagesResponse - client.images.edit({ ...params }) -> ImagesResponse - client.images.generate({ ...params }) -> ImagesResponse # Audio Types: - AudioModel - AudioResponseFormat ## Transcriptions Types: - Transcription - TranscriptionSegment - TranscriptionVerbose - TranscriptionWord - TranscriptionCreateResponse Methods: - client.audio.transcriptions.create({ ...params }) -> TranscriptionCreateResponse ## Translations Types: - Translation - TranslationVerbose - TranslationCreateResponse Methods: - client.audio.translations.create({ ...params }) -> TranslationCreateResponse ## Speech Types: - SpeechModel Methods: - client.audio.speech.create({ ...params }) -> Response # Moderations Types: - Moderation - ModerationImageURLInput - ModerationModel - ModerationMultiModalInput - ModerationTextInput - ModerationCreateResponse Methods: - client.moderations.create({ ...params }) -> ModerationCreateResponse # Models Types: - Model - ModelDeleted Methods: - client.models.retrieve(model) -> Model - client.models.list() -> ModelsPage - client.models.delete(model) -> ModelDeleted # FineTuning ## Jobs Types: - FineTuningJob - FineTuningJobEvent - FineTuningJobIntegration - FineTuningJobWandbIntegration - FineTuningJobWandbIntegrationObject Methods: - client.fineTuning.jobs.create({ ...params }) -> FineTuningJob - client.fineTuning.jobs.retrieve(fineTuningJobID) -> FineTuningJob - client.fineTuning.jobs.list({ ...params }) -> FineTuningJobsPage - client.fineTuning.jobs.cancel(fineTuningJobID) -> FineTuningJob - client.fineTuning.jobs.listEvents(fineTuningJobID, { ...params }) -> FineTuningJobEventsPage ### Checkpoints Types: - FineTuningJobCheckpoint Methods: - client.fineTuning.jobs.checkpoints.list(fineTuningJobID, { ...params }) -> FineTuningJobCheckpointsPage # Beta ## Realtime Types: - ConversationCreatedEvent - ConversationItem - ConversationItemContent - ConversationItemCreateEvent - ConversationItemCreatedEvent - ConversationItemDeleteEvent - ConversationItemDeletedEvent - ConversationItemInputAudioTranscriptionCompletedEvent - ConversationItemInputAudioTranscriptionFailedEvent - 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 ### Sessions Types: - Session - SessionCreateResponse Methods: - client.beta.realtime.sessions.create({ ...params }) -> SessionCreateResponse ## VectorStores Types: - AutoFileChunkingStrategyParam - FileChunkingStrategy - FileChunkingStrategyParam - OtherFileChunkingStrategyObject - StaticFileChunkingStrategy - StaticFileChunkingStrategyObject - StaticFileChunkingStrategyObjectParam - VectorStore - VectorStoreDeleted Methods: - client.beta.vectorStores.create({ ...params }) -> VectorStore - client.beta.vectorStores.retrieve(vectorStoreID) -> VectorStore - client.beta.vectorStores.update(vectorStoreID, { ...params }) -> VectorStore - client.beta.vectorStores.list({ ...params }) -> VectorStoresPage - client.beta.vectorStores.delete(vectorStoreID) -> VectorStoreDeleted ### Files Types: - VectorStoreFile - VectorStoreFileDeleted Methods: - client.beta.vectorStores.files.create(vectorStoreID, { ...params }) -> VectorStoreFile - client.beta.vectorStores.files.retrieve(fileID, { ...params }) -> VectorStoreFile - client.beta.vectorStores.files.list(vectorStoreID, { ...params }) -> VectorStoreFilesPage - client.beta.vectorStores.files.delete(fileID, { ...params }) -> VectorStoreFileDeleted - client.beta.vectorStores.files.createAndPoll(vectorStoreId, body, options?) -> Promise<VectorStoreFile> - client.beta.vectorStores.files.poll(vectorStoreId, fileId, options?) -> Promise<VectorStoreFile> - client.beta.vectorStores.files.upload(vectorStoreId, file, options?) -> Promise<VectorStoreFile> - client.beta.vectorStores.files.uploadAndPoll(vectorStoreId, file, options?) -> Promise<VectorStoreFile> ### FileBatches Types: - VectorStoreFileBatch Methods: - client.beta.vectorStores.fileBatches.create(vectorStoreID, { ...params }) -> VectorStoreFileBatch - client.beta.vectorStores.fileBatches.retrieve(batchID, { ...params }) -> VectorStoreFileBatch - client.beta.vectorStores.fileBatches.cancel(batchID, { ...params }) -> VectorStoreFileBatch - client.beta.vectorStores.fileBatches.listFiles(batchID, { ...params }) -> VectorStoreFilesPage - client.beta.vectorStores.fileBatches.createAndPoll(vectorStoreId, body, options?) -> Promise<VectorStoreFileBatch> - client.beta.vectorStores.fileBatches.poll(vectorStoreId, batchId, options?) -> Promise<VectorStoreFileBatch> -

client.beta.vectorStores.fileBatches.uploadAndPoll(vectorStoreId, { files, fileIds = [] }, options?) -> Promise<VectorStoreFileBatch>

## Chat ### Completions Methods: - client.beta.chat.completions.runTools(body, options?) -> ChatCompletionRunner | ChatCompletionStreamingRunner - client.beta.chat.completions.stream(body, options?) -> ChatCompletionStream ## Assistants Types: - Assistant - AssistantDeleted - AssistantStreamEvent - AssistantTool - CodeInterpreterTool - FileSearchTool - FunctionTool - MessageStreamEvent - RunStepStreamEvent - RunStreamEvent - ThreadStreamEvent Methods: - client.beta.assistants.create({ ...params }) -> Assistant - client.beta.assistants.retrieve(assistantID) -> Assistant - client.beta.assistants.update(assistantID, { ...params }) -> Assistant - client.beta.assistants.list({ ...params }) -> AssistantsPage - client.beta.assistants.delete(assistantID) -> AssistantDeleted ## Threads Types: - AssistantResponseFormatOption - AssistantToolChoice - AssistantToolChoiceFunction - AssistantToolChoiceOption - Thread - ThreadDeleted Methods: - client.beta.threads.create({ ...params }) -> Thread - client.beta.threads.retrieve(threadID) -> Thread - client.beta.threads.update(threadID, { ...params }) -> Thread - client.beta.threads.delete(threadID) -> ThreadDeleted - client.beta.threads.createAndRun({ ...params }) -> Run - client.beta.threads.createAndRunPoll(body, options?) -> Promise<Threads.Run> - client.beta.threads.createAndRunStream(body, options?) -> AssistantStream ### Runs Types: - RequiredActionFunctionToolCall - Run - RunStatus Methods: - client.beta.threads.runs.create(threadID, { ...params }) -> Run - client.beta.threads.runs.retrieve(runID, { ...params }) -> Run - client.beta.threads.runs.update(runID, { ...params }) -> Run - client.beta.threads.runs.list(threadID, { ...params }) -> RunsPage - client.beta.threads.runs.cancel(runID, { ...params }) -> Run - client.beta.threads.runs.submitToolOutputs(runID, { ...params }) -> Run - client.beta.threads.runs.createAndPoll(threadId, body, options?) -> Promise<Run> - client.beta.threads.runs.createAndStream(threadId, body, options?) -> AssistantStream - client.beta.threads.runs.poll(threadId, runId, options?) -> Promise<Run> - client.beta.threads.runs.stream(threadId, body, options?) -> AssistantStream - client.beta.threads.runs.submitToolOutputsAndPoll(threadId, runId, body, options?) -> Promise<Run> - client.beta.threads.runs.submitToolOutputsStream(threadId, runId, body, options?) -> AssistantStream #### Steps Types: - 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(stepID, { ...params }) -> RunStep - client.beta.threads.runs.steps.list(runID, { ...params }) -> RunStepsPage ### Messages Types: - 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(threadID, { ...params }) -> Message - client.beta.threads.messages.retrieve(messageID, { ...params }) -> Message - client.beta.threads.messages.update(messageID, { ...params }) -> Message - client.beta.threads.messages.list(threadID, { ...params }) -> MessagesPage - client.beta.threads.messages.delete(messageID, { ...params }) -> MessageDeleted # Batches Types: - Batch - BatchError - BatchRequestCounts Methods: - client.batches.create({ ...params }) -> Batch - client.batches.retrieve(batchID) -> Batch - client.batches.list({ ...params }) -> BatchesPage - client.batches.cancel(batchID) -> Batch # Uploads Types: - Upload Methods: - client.uploads.create({ ...params }) -> Upload - client.uploads.cancel(uploadID) -> Upload - client.uploads.complete(uploadID, { ...params }) -> Upload ## Parts Types: - UploadPart Methods: - client.uploads.parts.create(uploadID, { ...params }) -> UploadPart