Expand description
AG-UI Protocol Types
This module defines core protocol types including:
- Message types (user, assistant, system, tool)
- Role definitions
- ID types (MessageId, RunId, ThreadId, ToolCallId)
- Context and input types
- Content types (text, binary) for multimodal messages
Structs§
- Activity
Message - An activity message for tracking agent activities.
- AgentId
- AgentId: A newtype used to prevent mixing it with other ID values.
- Assistant
Message - An assistant message (from the AI model).
- Base
Message - A basic message with optional string content.
- Binary
Input Content - Binary input content for multimodal messages.
- Content
Validation Error - Error type for content validation failures.
- Context
- Context information provided to an agent.
- Developer
Message - A developer message, typically for debugging purposes. Not to be confused with system messages.
- Function
Call - A generated function call from a model.
- Message
Id - MessageId: A newtype used to prevent mixing it with other ID values.
- RunAgent
Input - Input for running an agent.
- RunId
- RunId: A newtype used to prevent mixing it with other ID values.
- System
Message - A system message, usually containing the system prompt.
- Text
Input Content - Text input content for messages.
- Thread
Id - ThreadId: A newtype used to prevent mixing it with other ID values.
- Tool
- A tool definition describing a function the model can call.
- Tool
Call - A tool call made by an assistant.
- Tool
Call Id - A tool call ID.
- Tool
Message - A tool message containing the result of a tool/function call.
- User
Message - A user message from the human user.
Enums§
- Input
Content - Input content union type for multimodal messages.
- Message
- Represents the different types of messages in a conversation.
- Role
- Message role indicating the sender type.