Skip to main content

Module chat

Module chat 

Source

Structs§

AudioContent
Audio content part for multimodal messages.
AudioUrl
Audio URL content for multimodal messages.
ChatCompletionChunk
A streaming chunk for chat completions.
ChatCompletionRequest
Chat completion request matching the OpenRouter API schema.
ChatCompletionResponse
Chat completion response.
Choice
A choice returned by the chat API.
ChoiceStream
A choice returned by the streaming chat API. Different from regular Choice as it contains deltas instead of complete messages.
CompletionTokensDetails
Details about completion token usage.
DebugConfig
Debug configuration for request inspection.
FileContent
File content part for multimodal messages.
FileUrl
File URL content for multimodal messages (e.g. PDFs).
ImageContent
Image content part for multimodal messages.
ImageUrl
Image URL content for multimodal messages.
LogProbs
Log probabilities information.
Message
Represents a chat message with a role and content.
Plugin
Plugin configuration for enabling OpenRouter server-side features.
PredictionConfig
Prediction configuration for latency optimization.
PromptTokensDetails
Details about prompt token usage.
ReasoningConfig
Reasoning configuration for models that support extended thinking.
ServerToolUse
Server-side tool usage counts (e.g., web search requests).
StreamDelta
Delta content for streaming responses.
TextContent
Text content part for multimodal messages.
TokenLogProb
Token log probability information.
TopLogProb
Top log probability information.
Usage
Usage data returned from the API.

Enums§

ChatRole
Defines the role of a chat message (user, assistant, or system).
ContentPart
Content parts for multimodal messages (user role only).
ContentType
Content type for multimodal message parts.
ImageDetail
Image detail level for vision models.
MessageContent
Enhanced message content supporting both string and multimodal content.
ReasoningDetail
Structured reasoning detail item returned by some reasoning-capable models.
ReasoningEffort
Effort level for reasoning models (o1, o3, Claude extended thinking, DeepSeek R1).
ReasoningSummary
Summary verbosity for reasoning models that expose summarized thinking output.
RouteStrategy
Route strategy for model routing.
StopSequence
Stop sequence for chat completion - can be a string or array of strings.
VerbosityLevel
Verbosity level for model responses.