Expand description
This module contains the request body and POST method for the chat completion API.
Structs§
- Assistant
Audio - Data about a previous audio response from the model, referenced in an assistant message for multi-turn audio conversations.
- Chat
Completion Audio Param - Parameters for audio output of a chat completion.
- Chat
Completion Prediction Content Param - JSON
Schema - Request
Body - Creates a model response for the given chat conversation.
- Stream
Options - Tool
Call Custom - Tool
Call Function - Tool
Choice Allowed Tools - Tool
Choice Custom - Tool
Choice Function - Tool
Custom - Tool
Custom Format Grammar Grammar - Tool
Function - WebSearch
Options - WebSearch
Options User Location Approximate
Enums§
- Assistant
Tool Call - Audio
Format - The output audio format of a chat completion.
- Chat
Completion Content Part Text Param Type - Chat
Completion Prediction Content Param Content - Chat
Completion Prediction Content Param Type - LowMedium
High Enum - Message
- Modality
- Reasoning
Effort - Constrains the effort on reasoning for reasoning models. This is an official OpenAI parameter; reasoning providers such as DeepSeek and Qwen accept a subset of these values and map the rest to their nearest effort level.
- Request
Tool - Response
Format - Stop
Keywords - Tool
Choice - Tool
Choice Allowed Tools Mode - The mode for allowed tools in tool choice.
- Tool
Choice Specific - Tool
Custom Format - Tool
Custom Format Grammar Grammar Syntax - Voice
- The voice the model uses to respond with audio output.
- WebSearch
Options User Location