Package-level declarations
Types
Approximate location details.
Assistant message builder.
A function or custom tool reference.
Allowed subset of tools.
Audio output configuration.
A completion generated by OpenAI.
A completion generated by OpenAI.
An object containing a response from the chat completion api.
Builder of ChatCompletionFunction instances.
Advanced fields whose types differ from the original Chat request contract.
Creates a completion for the chat message.
Creates a completion for the chat message.
Completion result supporting custom calls without extending legacy sealed types.
Metadata update for an existing stored completion.
Name and free-form input of a custom call.
Generated chat message.
Rich function definition for advanced Chat requests.
Function declaration supporting strict schema enforcement without changing FunctionTool.
Encoded audio input.
Typed content for advanced Chat inputs.
Uploaded file or inline file data.
Advanced input message supporting multimodal content and custom tool calls.
Independent multimodal input part hierarchy.
Multimodal content parts.
Plain text input.
The messages to generate chat completions for.
Builder of ChatMessageBuilder instances.
Creates a list of ChatMessage.
Moderation configuration for chat inputs and outputs.
Moderation behavior: score content or block policy violations.
Separate moderation policies for input and output.
Predicted output content used to accelerate responses with a known prefix.
Prompt caching mode and minimum lifetime; supported values depend on the model.
An object specifying the format that the model must output.
Output citation used by rich Chat result messages.
Generated choice, or a streamed choice delta.
Complete or incremental assistant message with custom tool calls.
Function/custom call; optional fields support incremental streaming updates.
Streaming controls for advanced Chat requests.
Tool accepted by Chat Completions, either a function or custom text tool.
Select a custom tool or an allowed tool subset.
Usage details returned by advanced Chat operations.
Represents a chat message part.
A tool accepting free-form or grammar-constrained text.
Custom tool declaration.
Custom tool input format: text, or grammar with a definition and syntax.
Grammar accepted by a custom tool.
Represents a function invocation with its name and serialized arguments as generated by the model.
This interface determines how the model handles function calls.
Creates a list of ChatCompletionFunction.
A description of what the function does, used by the model to choose when and how to call the function.
Tool call builder.
Represents the function to call by the model.
Image content part.
Specification for JSON schema response format
The chat message content as a list of content parts.
An object containing log probability information for the choice.
An object containing logprobs for a single token
Represents parameters that a function accepts, described as a JSON Schema object.
Explicit cache boundary on an input content part.
Search context size setting for web search.
Options for streaming response.
Builder for StreamOptions.
System message builder.
The chat message content as text.
Text content part.
A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for.
Creates a list of Tool.
Details of the tool call chunk.
List of tool calls builder.
Controls which (if any) function is called by the model.
Tool message builder.
An object containing a token and their log probability.
Nested Chat URL citation.
Location hint used by web search.
User message builder.
Configuration for web search in chat completions.
Functions
Assistant chat message.
The function to generate chat completion function instances.
The messages to generate chat completions for.
The messages to generate chat completions for.
Tool: function call.
Create a new StreamOptions instance.
System chat message.
Tool chat message.
User chat message.