Skip to main content

Module types

dynamo_protocols

Module types 

Source

Modules§

anthropic
Anthropic Messages API types.
realtime
responses

Structs§

AudioUrl
AudioUrlArgs
Builder for AudioUrl.
AudioUrlResponse
Base64Embedding
Represents an base64-encoded embedding vector returned by embedding endpoint.
Base64EmbeddingVector
ChatChoice
Chat choice with extended response message.
ChatChoiceLogprobs
ChatChoiceStream
Streaming chat choice.
ChatCompletionAudio
ChatCompletionFunctions
ChatCompletionFunctionsArgs
Builder for ChatCompletionFunctions.
ChatCompletionMessageToolCall
Tool call kept locally to preserve type: "function" in unary request/response payloads.
ChatCompletionMessageToolCallChunk
Streaming tool-call chunk.
ChatCompletionNamedToolChoice
ChatCompletionRequestAssistantMessage
Assistant message with reasoning content support.
ChatCompletionRequestAssistantMessageArgs
Builder for ChatCompletionRequestAssistantMessage.
ChatCompletionRequestAssistantMessageAudio
ChatCompletionRequestDeveloperMessage
ChatCompletionRequestDeveloperMessageArgs
Builder for ChatCompletionRequestDeveloperMessage.
ChatCompletionRequestFunctionMessage
ChatCompletionRequestFunctionMessageArgs
Builder for ChatCompletionRequestFunctionMessage.
ChatCompletionRequestMessageContentPartAudio
Learn about audio inputs.
ChatCompletionRequestMessageContentPartAudioUrl
ChatCompletionRequestMessageContentPartAudioUrlArgs
Builder for ChatCompletionRequestMessageContentPartAudioUrl.
ChatCompletionRequestMessageContentPartImage
Image content part – uses our extended ImageUrl with url::Url and uuid.
ChatCompletionRequestMessageContentPartImageArgs
Builder for ChatCompletionRequestMessageContentPartImage.
ChatCompletionRequestMessageContentPartRefusal
ChatCompletionRequestMessageContentPartText
ChatCompletionRequestMessageContentPartVideo
ChatCompletionRequestMessageContentPartVideoArgs
Builder for ChatCompletionRequestMessageContentPartVideo.
ChatCompletionRequestSystemMessage
ChatCompletionRequestSystemMessageArgs
Builder for ChatCompletionRequestSystemMessage.
ChatCompletionRequestToolMessage
Tool message
ChatCompletionRequestToolMessageArgs
Builder for ChatCompletionRequestToolMessage.
ChatCompletionRequestUserMessage
ChatCompletionRequestUserMessageArgs
Builder for ChatCompletionRequestUserMessage.
ChatCompletionResponseContentPartAudioUrl
Response content part for audio URLs in assistant messages
ChatCompletionResponseContentPartImageUrl
Response content part for image URLs in assistant messages
ChatCompletionResponseContentPartText
Response content part for text in assistant messages
ChatCompletionResponseContentPartVideoUrl
Response content part for video URLs in assistant messages
ChatCompletionResponseMessage
Chat completion response message with multimodal content and reasoning.
ChatCompletionResponseMessageAudio
ChatCompletionStreamOptions
Stream options with per-chunk usage reporting.
ChatCompletionStreamResponseDelta
Streaming delta with reasoning content.
ChatCompletionStreamResponseDeltaFunctionCall
ChatCompletionTokenLogprob
ChatCompletionTool
ChatCompletionToolArgs
Builder for ChatCompletionTool.
Choice
CompletionTokensDetails
Breakdown of tokens used in a completion.
CompletionUsage
Usage statistics for the completion request.
CreateBase64EmbeddingResponse
CreateChatCompletionRequest
Chat completion request with multimodal processor support.
CreateChatCompletionRequestArgs
Builder for CreateChatCompletionRequest.
CreateChatCompletionResponse
Non-streaming chat completion response.
CreateChatCompletionStreamResponse
Streaming chat completion response with extended choices.
CreateCompletionRequest
Completion request with inference-serving extensions.
CreateCompletionRequestArgs
Builder for CreateCompletionRequest.
CreateCompletionResponse
CreateEmbeddingRequest
CreateEmbeddingRequestArgs
Builder for CreateEmbeddingRequest.
CreateEmbeddingResponse
Top-level /v1/embeddings response.
CreateImageEditRequest
CreateImageEditRequestArgs
Builder for CreateImageEditRequest.
CreateImageRequest
CreateImageRequestArgs
Builder for CreateImageRequest.
CreateImageVariationRequest
CreateImageVariationRequestArgs
Builder for CreateImageVariationRequest.
EditImageJsonRequest
JSON request body for image edits.
EditImageJsonRequestArgs
Builder for EditImageJsonRequest.
Embedding
A single embedding object inside an embeddings response.
EmbeddingUsage
FunctionCall
The name and arguments of a function that should be called.
FunctionCallStream
Streaming variant of FunctionCall where both fields are optional.
FunctionName
FunctionObject
FunctionObjectArgs
Builder for FunctionObject.
ImageEditCompletedEvent
Emitted when image editing has completed and the final image is available.
ImageEditPartialImageEvent
Emitted when a partial image is available during image editing streaming.
ImageGenCompletedEvent
Emitted when image generation has completed and the final image is available.
ImageGenInputUsageDetails
ImageGenOutputTokensDetails
ImageGenPartialImageEvent
Emitted when a partial image is available during image generation streaming.
ImageGenUsage
ImageInput
ImageRefParam
Reference an input image by either URL or uploaded file ID. Provide exactly one of image_url or file_id.
ImageUrl
Image URL with url::Url type and optional UUID.
ImageUrlArgs
Builder for ImageUrl.
ImageUrlResponse
ImagesResponse
InputAudio
Logprobs
PromptTokensDetails
Breakdown of tokens used in a completion.
ResponseFormatJsonSchema
TopLogprobs
VideoUrl
VideoUrlArgs
Builder for VideoUrl.
VideoUrlResponse
WebSearchLocation
Approximate location parameters for the search.
WebSearchOptions
Options for the web search tool.
WebSearchUserLocation

Enums§

ChatCompletionAudioFormat
ChatCompletionAudioVoice
ChatCompletionFunctionCall
ChatCompletionMessageContent
Assistant message content – can be a simple string or multimodal content parts.
ChatCompletionRequestAssistantMessageContent
ChatCompletionRequestAssistantMessageContentPart
ChatCompletionRequestDeveloperMessageContent
ChatCompletionRequestMessage
Chat completion request message enum.
ChatCompletionRequestSystemMessageContent
ChatCompletionRequestSystemMessageContentPart
ChatCompletionRequestToolMessageContent
ChatCompletionRequestToolMessageContentPart
ChatCompletionRequestUserMessageContent
User message content – references our extended content part enum.
ChatCompletionRequestUserMessageContentPart
User message content part with video and audio URL support.
ChatCompletionResponseContentPart
Content parts for assistant responses supporting multiple modalities
ChatCompletionToolChoiceOption
Tool choice enum kept locally because upstream changed variant names.
ChatCompletionToolType
CompletionFinishReason
DallE2ImageSize
DallE3ImageSize
EmbeddingInput
EmbeddingVector
Per-input embedding payload.
EncodingFormat
FinishReason
FunctionType
GptImage1ImageSize
Image
ImageBackground
ImageDetail
Image detail level. Kept locally because upstream uses different field types in ImageUrl.
ImageEditInput
ImageEditStreamEvent
ImageGenStreamEvent
ImageModel
ImageModeration
ImageOutputFormat
ImageQuality
ImageResponseBackground
ImageResponseFormat
ImageSize
ImageStyle
InputAudioFormat
InputFidelity
PredictionContent
Static predicted output content, such as the content of a text file that is being regenerated.
PredictionContentContent
The content that should be matched when generating a model response. If generated tokens would match this content, the entire model response can be returned much more quickly.
Prompt
ReasoningContent
Reasoning content from a previous assistant turn.
ReasoningEffort
Reasoning effort values accepted by OpenAI-compatible clients.
ResponseFormat
Role
ServiceTier
ServiceTierResponse
Response tier enum for responses (distinct from request ServiceTier).
Stop
OpenAI stop configuration, with Dynamo’s token-id stop extension.
StopReason
Matched stop condition from the backend.
WebSearchContextSize
The amount of context window space to use for the search.
WebSearchUserLocationType

Type Aliases§

ChatCompletionResponseStream
CompletionResponseStream
Parsed server side events stream until an [DONE] is received from server.