Skip to main content

Module types

Module types

Expand description

Data types for the MiMo API.

Modules§

schema: Schema helpers for creating tool parameter schemas.

Structs§

Annotation: Web search annotation.
Audio: Audio output configuration for text-to-speech.
ChatRequest: Chat completion request.
ChatResponse: Chat completion response.
Choice: A completion choice.
CompletionTokensDetails: Completion tokens details.
ContentPart: Content part for multi-modal messages.
DeltaAudio: Delta audio in a streaming response.
DeltaFunctionCall: Delta function call in a streaming response.
DeltaMessage: Delta message in a streaming response.
DeltaToolCall: Delta tool call in a streaming response.
FunctionCall: A function call.
Message: A message in the conversation.
ParameterBuilder: Builder for creating JSON Schema parameters.
PromptTokensDetails: Prompt tokens details.
ResponseAudio: Response audio data from text-to-speech.
ResponseFormat: Response format configuration.
ResponseMessage: Response message.
StreamChoice: A streaming choice.
StreamChunk: Streaming response chunk.
Thinking: Thinking configuration.
Tool: A tool that can be called by the model.
TtsStyle: Text-to-speech style control.
Usage: Token usage information.
UserLocation: User location for localized web search.
WebSearchUsage: Web search usage.

Enums§

AudioFormat: Audio output format.
ContentType: Content type.
FinishReason: Reason for finishing generation.
MessageContent: Message content - can be text or multi-part content.
Model: Available MiMo models.
ResponseFormatType: Response format type.
Role: Message role.
Stop: Stop sequence configuration.
ThinkingType: Thinking mode configuration.
ToolChoice: Tool choice configuration.
ToolType: Tool type.
Voice: Available voice options for text-to-speech.

Functions§

styled_text: Create styled text for TTS with the given style.