# Functions
Creates a new assistant message object.
Creates a new system message object.
Creates a new tool object.
Creates a new tool call object.
Creates a new tool message object.
Creates a new user message object.
# Constants
The output embeddings are encoded as a base64-encoded string, containing an binary representation of an array of floating-point numbers.
The output embeddings are encoded as an array of floating-point numbers.
The OpenAI system will utilize scale tier credits until they are exhausted.
The request will be processed using the default OpenAI service tier with a lower uptime SLA and no latency guarantee.
# Variables
Instructs the model to output the response as a JSON object.
Enables Structured Outputs which guarantees the model will match your supplied JSON schema.
Instructs the model to output the response as a plain text string.
Directs the model to pick between generating a message or calling one or more tools.
Forces the model to call a specific tool.
Directs the model to not call any tool and instead generates a message.
Directs that the model must call one or more tools.
# Structs
An assistant message object.
Provides input and output types that conform to the OpenAI Chat API, as described in the [API Reference] docs.
The input object for the OpenAI Chat API.
The output object for the OpenAI Chat API.
A completion choice object returned in the response.
A chat completion message generated by the model.
The output vector embeddings data.
Provides input and output types that conform to the OpenAI Embeddings API, as described in the [API Reference] docs.
The input object for the OpenAI Embeddings API.
The output object for the OpenAI Embeddings API.
A function call object that the model may generate.
The definition of a function that can be called by the model.
Log probability information for a choice.
Log probability information for a message content token.
Log probability information for the most likely tokens at a given position.
The base implementation for all MessageBase objects.
An object specifying the format that the model must output.
A system message object.
A tool object that the model may call.
A tool call object that the model may generate.
An object specifying which tool the model should call.
A tool message object.
The usage statistics returned by the OpenAI API.
A user message object.
# Interfaces
An interface to any message object.
# Type aliases
The encoding format for the output embeddings.
The OpenAI service tier used to process the request.