Types:

• HealthInfo
• InterleavedContent
• InterleavedContentItem
• ListProvidersResponse
• ListRoutesResponse
• ParamType
• ProviderInfo
• RouteInfo
• SamplingParams
• SystemMessage
• VersionInfo

Responses

Types:

• CompactedResponse
• ResponseInput
• ResponseMessage
• ResponseObject
• ResponseObjectStream
• ResponseOutput
• ResponseListResponse
• ResponseDeleteResponse

Methods:

• client.responses.create({ ...params }) -> ResponseObject
• client.responses.retrieve(responseId) -> ResponseObject
• client.responses.list({ ...params }) -> ResponseListResponsesOpenAICursorPage
• client.responses.delete(responseId) -> ResponseDeleteResponse
• client.responses.compact({ ...params }) -> CompactedResponse

InputItems

Types:

• InputItemListResponse

Methods:

• client.responses.inputItems.list(responseId, { ...params }) -> InputItemListResponse

Prompts

Types:

• ListPromptsResponse
• Prompt
• PromptListResponse

Methods:

• client.prompts.create({ ...params }) -> Prompt
• client.prompts.retrieve(promptId, { ...params }) -> Prompt
• client.prompts.update(promptId, { ...params }) -> Prompt
• client.prompts.list() -> PromptListResponse
• client.prompts.delete(promptId) -> void
• client.prompts.setDefaultVersion(promptId, { ...params }) -> Prompt

Versions

Methods:

• client.prompts.versions.list(promptId) -> PromptListResponse

Conversations

Types:

• ConversationObject
• ConversationDeleteResponse

Methods:

• client.conversations.create({ ...params }) -> ConversationObject
• client.conversations.retrieve(conversationId) -> ConversationObject
• client.conversations.update(conversationId, { ...params }) -> ConversationObject
• client.conversations.delete(conversationId) -> ConversationDeleteResponse

Items

Types:

• ItemCreateResponse
• ItemListResponse
• ItemGetResponse

Methods:

• client.conversations.items.create(conversationId, { ...params }) -> ItemCreateResponse
• client.conversations.items.list(conversationId, { ...params }) -> ItemListResponsesOpenAICursorPage
• client.conversations.items.delete(conversationId, itemId) -> ConversationObject
• client.conversations.items.get(conversationId, itemId, { ...params }) -> ItemGetResponse

Inspect

Methods:

• client.inspect.health() -> HealthInfo
• client.inspect.version() -> VersionInfo

Embeddings

Types:

• CreateEmbeddingsResponse

Methods:

• client.embeddings.create({ ...params }) -> CreateEmbeddingsResponse

Chat

Types:

• ChatCompletionChunk

Completions

Types:

• CompletionCreateResponse
• CompletionRetrieveResponse
• CompletionListResponse

Methods:

• client.chat.completions.create({ ...params }) -> CompletionCreateResponse
• client.chat.completions.retrieve(completionId) -> CompletionRetrieveResponse
• client.chat.completions.list({ ...params }) -> CompletionListResponse

Messages

Types:

• MessageListResponse

Methods:

• client.chat.completions.messages.list(completionId, { ...params }) -> MessageListResponsesOpenAICursorPage

Completions

Types:

• CompletionCreateResponse

Methods:

• client.completions.create({ ...params }) -> CompletionCreateResponse

VectorIo

Types:

• QueryChunksResponse

Methods:

• client.vectorIo.insert({ ...params }) -> void
• client.vectorIo.query({ ...params }) -> QueryChunksResponse

VectorStores

Types:

• ListVectorStoresResponse
• VectorStore
• VectorStoreDeleteResponse
• VectorStoreSearchResponse

Methods:

• client.vectorStores.create({ ...params }) -> VectorStore
• client.vectorStores.retrieve(vectorStoreId) -> VectorStore
• client.vectorStores.update(vectorStoreId, { ...params }) -> VectorStore
• client.vectorStores.list({ ...params }) -> VectorStoresOpenAICursorPage
• client.vectorStores.delete(vectorStoreId) -> VectorStoreDeleteResponse
• client.vectorStores.search(vectorStoreId, { ...params }) -> VectorStoreSearchResponse

Files

Types:

• VectorStoreFile
• FileDeleteResponse
• FileContentResponse

Methods:

• client.vectorStores.files.create(vectorStoreId, { ...params }) -> VectorStoreFile
• client.vectorStores.files.retrieve(vectorStoreId, fileId) -> VectorStoreFile
• client.vectorStores.files.update(vectorStoreId, fileId, { ...params }) -> VectorStoreFile
• client.vectorStores.files.list(vectorStoreId, { ...params }) -> VectorStoreFilesOpenAICursorPage
• client.vectorStores.files.delete(vectorStoreId, fileId) -> FileDeleteResponse
• client.vectorStores.files.content(vectorStoreId, fileId, { ...params }) -> FileContentResponse

FileBatches

Types:

• ListVectorStoreFilesInBatchResponse
• VectorStoreFileBatches

Methods:

• client.vectorStores.fileBatches.create(vectorStoreId, { ...params }) -> VectorStoreFileBatches
• client.vectorStores.fileBatches.retrieve(vectorStoreId, batchId) -> VectorStoreFileBatches
• client.vectorStores.fileBatches.cancel(vectorStoreId, batchId) -> VectorStoreFileBatches
• client.vectorStores.fileBatches.listFiles(vectorStoreId, batchId, { ...params }) -> VectorStoreFilesOpenAICursorPage

Models

Types:

• ListModelsResponse
• Model
• ModelRetrieveResponse
• ModelListResponse

Methods:

• client.models.retrieve(modelId, { ...params }) -> ModelRetrieveResponse
• client.models.list({ ...params }) -> ModelListResponse

OpenAI

Types:

• OpenAIListResponse

Methods:

• client.models.openai.list({ ...params }) -> OpenAIListResponse

Providers

Types:

• ProviderListResponse

Methods:

• client.providers.retrieve(providerId) -> ProviderInfo
• client.providers.list() -> ProviderListResponse

Routes

Types:

• RouteListResponse

Methods:

• client.routes.list({ ...params }) -> RouteListResponse

Files

Types:

• DeleteFileResponse
• File
• ListFilesResponse
• FileContentResponse

Methods:

• client.files.create({ ...params }) -> File
• client.files.retrieve(fileId) -> File
• client.files.list({ ...params }) -> FilesOpenAICursorPage
• client.files.delete(fileId) -> DeleteFileResponse
• client.files.content(fileId) -> string

Batches

Types:

• BatchCreateResponse
• BatchRetrieveResponse
• BatchListResponse
• BatchCancelResponse

Methods:

• client.batches.create({ ...params }) -> BatchCreateResponse
• client.batches.retrieve(batchId) -> BatchRetrieveResponse
• client.batches.list({ ...params }) -> BatchListResponsesOpenAICursorPage
• client.batches.cancel(batchId) -> BatchCancelResponse

Alpha

Admin

Methods:

• client.alpha.admin.health() -> HealthInfo
• client.alpha.admin.inspectProvider(providerId) -> ProviderInfo
• client.alpha.admin.listProviders() -> ProviderListResponse
• client.alpha.admin.listRoutes({ ...params }) -> RouteListResponse
• client.alpha.admin.version() -> VersionInfo

Inference

Types:

• InferenceRerankResponse

Methods:

• client.alpha.inference.rerank({ ...params }) -> InferenceRerankResponse