autogen_agentchat.state#
State management for agents, teams and termination conditions.
- pydantic model AssistantAgentState[source]#
Bases:
BaseState
State for an assistant agent.
Show JSON schema
{ "title": "AssistantAgentState", "description": "State for an assistant agent.", "type": "object", "properties": { "type": { "default": "AssistantAgentState", "title": "Type", "type": "string" }, "version": { "default": "1.0.0", "title": "Version", "type": "string" }, "llm_messages": { "items": { "discriminator": { "mapping": { "AssistantMessage": "#/$defs/AssistantMessage", "FunctionExecutionResultMessage": "#/$defs/FunctionExecutionResultMessage", "SystemMessage": "#/$defs/SystemMessage", "UserMessage": "#/$defs/UserMessage" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/SystemMessage" }, { "$ref": "#/$defs/UserMessage" }, { "$ref": "#/$defs/AssistantMessage" }, { "$ref": "#/$defs/FunctionExecutionResultMessage" } ] }, "title": "Llm Messages", "type": "array" } }, "$defs": { "AssistantMessage": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "$ref": "#/$defs/FunctionCall" }, "type": "array" } ], "title": "Content" }, "source": { "title": "Source", "type": "string" }, "type": { "const": "AssistantMessage", "default": "AssistantMessage", "enum": [ "AssistantMessage" ], "title": "Type", "type": "string" } }, "required": [ "content", "source" ], "title": "AssistantMessage", "type": "object" }, "FunctionCall": { "properties": { "id": { "title": "Id", "type": "string" }, "arguments": { "title": "Arguments", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "arguments", "name" ], "title": "FunctionCall", "type": "object" }, "FunctionExecutionResult": { "properties": { "content": { "title": "Content", "type": "string" }, "call_id": { "title": "Call Id", "type": "string" } }, "required": [ "content", "call_id" ], "title": "FunctionExecutionResult", "type": "object" }, "FunctionExecutionResultMessage": { "properties": { "content": { "items": { "$ref": "#/$defs/FunctionExecutionResult" }, "title": "Content", "type": "array" }, "type": { "const": "FunctionExecutionResultMessage", "default": "FunctionExecutionResultMessage", "enum": [ "FunctionExecutionResultMessage" ], "title": "Type", "type": "string" } }, "required": [ "content" ], "title": "FunctionExecutionResultMessage", "type": "object" }, "SystemMessage": { "properties": { "content": { "title": "Content", "type": "string" }, "type": { "const": "SystemMessage", "default": "SystemMessage", "enum": [ "SystemMessage" ], "title": "Type", "type": "string" } }, "required": [ "content" ], "title": "SystemMessage", "type": "object" }, "UserMessage": { "properties": { "content": { "anyOf": [ { "type": "string" }, { "items": { "anyOf": [ { "type": "string" }, {} ] }, "type": "array" } ], "title": "Content" }, "source": { "title": "Source", "type": "string" }, "type": { "const": "UserMessage", "default": "UserMessage", "enum": [ "UserMessage" ], "title": "Type", "type": "string" } }, "required": [ "content", "source" ], "title": "UserMessage", "type": "object" } } }
- Fields:
llm_messages (List[autogen_core.models._types.SystemMessage | autogen_core.models._types.UserMessage | autogen_core.models._types.AssistantMessage | autogen_core.models._types.FunctionExecutionResultMessage])
type (str)
- field llm_messages: List[Annotated[SystemMessage | UserMessage | AssistantMessage | FunctionExecutionResultMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]] [Optional]#
- pydantic model BaseGroupChatManagerState[source]#
Bases:
BaseState
Base state for all group chat managers.
Show JSON schema
{ "title": "BaseGroupChatManagerState", "description": "Base state for all group chat managers.", "type": "object", "properties": { "type": { "default": "BaseGroupChatManagerState", "title": "Type", "type": "string" }, "version": { "default": "1.0.0", "title": "Version", "type": "string" }, "message_thread": { "items": { "discriminator": { "mapping": { "HandoffMessage": "#/$defs/HandoffMessage", "MultiModalMessage": "#/$defs/MultiModalMessage", "StopMessage": "#/$defs/StopMessage", "TextMessage": "#/$defs/TextMessage", "ToolCallMessage": "#/$defs/ToolCallMessage", "ToolCallResultMessage": "#/$defs/ToolCallResultMessage" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/TextMessage" }, { "$ref": "#/$defs/MultiModalMessage" }, { "$ref": "#/$defs/StopMessage" }, { "$ref": "#/$defs/HandoffMessage" }, { "$ref": "#/$defs/ToolCallMessage" }, { "$ref": "#/$defs/ToolCallResultMessage" } ] }, "title": "Message Thread", "type": "array" }, "current_turn": { "default": 0, "title": "Current Turn", "type": "integer" } }, "$defs": { "FunctionCall": { "properties": { "id": { "title": "Id", "type": "string" }, "arguments": { "title": "Arguments", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "arguments", "name" ], "title": "FunctionCall", "type": "object" }, "FunctionExecutionResult": { "properties": { "content": { "title": "Content", "type": "string" }, "call_id": { "title": "Call Id", "type": "string" } }, "required": [ "content", "call_id" ], "title": "FunctionExecutionResult", "type": "object" }, "HandoffMessage": { "description": "A message requesting handoff of a conversation to another agent.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "target": { "title": "Target", "type": "string" }, "content": { "title": "Content", "type": "string" }, "type": { "const": "HandoffMessage", "default": "HandoffMessage", "enum": [ "HandoffMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "target", "content" ], "title": "HandoffMessage", "type": "object" }, "MultiModalMessage": { "description": "A multimodal message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "anyOf": [ { "type": "string" }, {} ] }, "title": "Content", "type": "array" }, "type": { "const": "MultiModalMessage", "default": "MultiModalMessage", "enum": [ "MultiModalMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "MultiModalMessage", "type": "object" }, "RequestUsage": { "properties": { "prompt_tokens": { "title": "Prompt Tokens", "type": "integer" }, "completion_tokens": { "title": "Completion Tokens", "type": "integer" } }, "required": [ "prompt_tokens", "completion_tokens" ], "title": "RequestUsage", "type": "object" }, "StopMessage": { "description": "A message requesting stop of a conversation.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "StopMessage", "default": "StopMessage", "enum": [ "StopMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "StopMessage", "type": "object" }, "TextMessage": { "description": "A text message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "TextMessage", "default": "TextMessage", "enum": [ "TextMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "TextMessage", "type": "object" }, "ToolCallMessage": { "description": "A message signaling the use of tools.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "$ref": "#/$defs/FunctionCall" }, "title": "Content", "type": "array" }, "type": { "const": "ToolCallMessage", "default": "ToolCallMessage", "enum": [ "ToolCallMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "ToolCallMessage", "type": "object" }, "ToolCallResultMessage": { "description": "A message signaling the results of tool calls.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "$ref": "#/$defs/FunctionExecutionResult" }, "title": "Content", "type": "array" }, "type": { "const": "ToolCallResultMessage", "default": "ToolCallResultMessage", "enum": [ "ToolCallResultMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "ToolCallResultMessage", "type": "object" } } }
- Fields:
current_turn (int)
message_thread (List[autogen_agentchat.messages.TextMessage | autogen_agentchat.messages.MultiModalMessage | autogen_agentchat.messages.StopMessage | autogen_agentchat.messages.HandoffMessage | autogen_agentchat.messages.ToolCallMessage | autogen_agentchat.messages.ToolCallResultMessage])
type (str)
- field message_thread: List[Annotated[TextMessage | MultiModalMessage | StopMessage | HandoffMessage | ToolCallMessage | ToolCallResultMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]] [Optional]#
- pydantic model BaseState[source]#
Bases:
BaseModel
Base class for all saveable state
Show JSON schema
{ "title": "BaseState", "description": "Base class for all saveable state", "type": "object", "properties": { "type": { "default": "BaseState", "title": "Type", "type": "string" }, "version": { "default": "1.0.0", "title": "Version", "type": "string" } } }
- Fields:
type (str)
version (str)
- pydantic model ChatAgentContainerState[source]#
Bases:
BaseState
State for a container of chat agents.
Show JSON schema
{ "title": "ChatAgentContainerState", "description": "State for a container of chat agents.", "type": "object", "properties": { "type": { "default": "ChatAgentContainerState", "title": "Type", "type": "string" }, "version": { "default": "1.0.0", "title": "Version", "type": "string" }, "agent_state": { "title": "Agent State", "type": "object" }, "message_buffer": { "items": { "discriminator": { "mapping": { "HandoffMessage": "#/$defs/HandoffMessage", "MultiModalMessage": "#/$defs/MultiModalMessage", "StopMessage": "#/$defs/StopMessage", "TextMessage": "#/$defs/TextMessage" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/TextMessage" }, { "$ref": "#/$defs/MultiModalMessage" }, { "$ref": "#/$defs/StopMessage" }, { "$ref": "#/$defs/HandoffMessage" } ] }, "title": "Message Buffer", "type": "array" } }, "$defs": { "HandoffMessage": { "description": "A message requesting handoff of a conversation to another agent.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "target": { "title": "Target", "type": "string" }, "content": { "title": "Content", "type": "string" }, "type": { "const": "HandoffMessage", "default": "HandoffMessage", "enum": [ "HandoffMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "target", "content" ], "title": "HandoffMessage", "type": "object" }, "MultiModalMessage": { "description": "A multimodal message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "anyOf": [ { "type": "string" }, {} ] }, "title": "Content", "type": "array" }, "type": { "const": "MultiModalMessage", "default": "MultiModalMessage", "enum": [ "MultiModalMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "MultiModalMessage", "type": "object" }, "RequestUsage": { "properties": { "prompt_tokens": { "title": "Prompt Tokens", "type": "integer" }, "completion_tokens": { "title": "Completion Tokens", "type": "integer" } }, "required": [ "prompt_tokens", "completion_tokens" ], "title": "RequestUsage", "type": "object" }, "StopMessage": { "description": "A message requesting stop of a conversation.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "StopMessage", "default": "StopMessage", "enum": [ "StopMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "StopMessage", "type": "object" }, "TextMessage": { "description": "A text message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "TextMessage", "default": "TextMessage", "enum": [ "TextMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "TextMessage", "type": "object" } } }
- Fields:
agent_state (Mapping[str, Any])
message_buffer (List[Annotated[autogen_agentchat.messages.TextMessage | autogen_agentchat.messages.MultiModalMessage | autogen_agentchat.messages.StopMessage | autogen_agentchat.messages.HandoffMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]])
type (str)
- field message_buffer: List[Annotated[TextMessage | MultiModalMessage | StopMessage | HandoffMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]] [Optional]#
- pydantic model MagenticOneOrchestratorState[source]#
Bases:
BaseGroupChatManagerState
State for
MagneticOneGroupChat
orchestrator.Show JSON schema
{ "title": "MagenticOneOrchestratorState", "description": "State for :class:`~autogen_agentchat.teams.MagneticOneGroupChat` orchestrator.", "type": "object", "properties": { "type": { "default": "MagenticOneOrchestratorState", "title": "Type", "type": "string" }, "version": { "default": "1.0.0", "title": "Version", "type": "string" }, "message_thread": { "items": { "discriminator": { "mapping": { "HandoffMessage": "#/$defs/HandoffMessage", "MultiModalMessage": "#/$defs/MultiModalMessage", "StopMessage": "#/$defs/StopMessage", "TextMessage": "#/$defs/TextMessage", "ToolCallMessage": "#/$defs/ToolCallMessage", "ToolCallResultMessage": "#/$defs/ToolCallResultMessage" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/TextMessage" }, { "$ref": "#/$defs/MultiModalMessage" }, { "$ref": "#/$defs/StopMessage" }, { "$ref": "#/$defs/HandoffMessage" }, { "$ref": "#/$defs/ToolCallMessage" }, { "$ref": "#/$defs/ToolCallResultMessage" } ] }, "title": "Message Thread", "type": "array" }, "current_turn": { "default": 0, "title": "Current Turn", "type": "integer" }, "task": { "default": "", "title": "Task", "type": "string" }, "facts": { "default": "", "title": "Facts", "type": "string" }, "plan": { "default": "", "title": "Plan", "type": "string" }, "n_rounds": { "default": 0, "title": "N Rounds", "type": "integer" }, "n_stalls": { "default": 0, "title": "N Stalls", "type": "integer" } }, "$defs": { "FunctionCall": { "properties": { "id": { "title": "Id", "type": "string" }, "arguments": { "title": "Arguments", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "arguments", "name" ], "title": "FunctionCall", "type": "object" }, "FunctionExecutionResult": { "properties": { "content": { "title": "Content", "type": "string" }, "call_id": { "title": "Call Id", "type": "string" } }, "required": [ "content", "call_id" ], "title": "FunctionExecutionResult", "type": "object" }, "HandoffMessage": { "description": "A message requesting handoff of a conversation to another agent.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "target": { "title": "Target", "type": "string" }, "content": { "title": "Content", "type": "string" }, "type": { "const": "HandoffMessage", "default": "HandoffMessage", "enum": [ "HandoffMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "target", "content" ], "title": "HandoffMessage", "type": "object" }, "MultiModalMessage": { "description": "A multimodal message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "anyOf": [ { "type": "string" }, {} ] }, "title": "Content", "type": "array" }, "type": { "const": "MultiModalMessage", "default": "MultiModalMessage", "enum": [ "MultiModalMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "MultiModalMessage", "type": "object" }, "RequestUsage": { "properties": { "prompt_tokens": { "title": "Prompt Tokens", "type": "integer" }, "completion_tokens": { "title": "Completion Tokens", "type": "integer" } }, "required": [ "prompt_tokens", "completion_tokens" ], "title": "RequestUsage", "type": "object" }, "StopMessage": { "description": "A message requesting stop of a conversation.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "StopMessage", "default": "StopMessage", "enum": [ "StopMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "StopMessage", "type": "object" }, "TextMessage": { "description": "A text message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "TextMessage", "default": "TextMessage", "enum": [ "TextMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "TextMessage", "type": "object" }, "ToolCallMessage": { "description": "A message signaling the use of tools.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "$ref": "#/$defs/FunctionCall" }, "title": "Content", "type": "array" }, "type": { "const": "ToolCallMessage", "default": "ToolCallMessage", "enum": [ "ToolCallMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "ToolCallMessage", "type": "object" }, "ToolCallResultMessage": { "description": "A message signaling the results of tool calls.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "$ref": "#/$defs/FunctionExecutionResult" }, "title": "Content", "type": "array" }, "type": { "const": "ToolCallResultMessage", "default": "ToolCallResultMessage", "enum": [ "ToolCallResultMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "ToolCallResultMessage", "type": "object" } } }
- Fields:
facts (str)
n_rounds (int)
n_stalls (int)
plan (str)
task (str)
type (str)
- pydantic model RoundRobinManagerState[source]#
Bases:
BaseGroupChatManagerState
State for
RoundRobinGroupChat
manager.Show JSON schema
{ "title": "RoundRobinManagerState", "description": "State for :class:`~autogen_agentchat.teams.RoundRobinGroupChat` manager.", "type": "object", "properties": { "type": { "default": "RoundRobinManagerState", "title": "Type", "type": "string" }, "version": { "default": "1.0.0", "title": "Version", "type": "string" }, "message_thread": { "items": { "discriminator": { "mapping": { "HandoffMessage": "#/$defs/HandoffMessage", "MultiModalMessage": "#/$defs/MultiModalMessage", "StopMessage": "#/$defs/StopMessage", "TextMessage": "#/$defs/TextMessage", "ToolCallMessage": "#/$defs/ToolCallMessage", "ToolCallResultMessage": "#/$defs/ToolCallResultMessage" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/TextMessage" }, { "$ref": "#/$defs/MultiModalMessage" }, { "$ref": "#/$defs/StopMessage" }, { "$ref": "#/$defs/HandoffMessage" }, { "$ref": "#/$defs/ToolCallMessage" }, { "$ref": "#/$defs/ToolCallResultMessage" } ] }, "title": "Message Thread", "type": "array" }, "current_turn": { "default": 0, "title": "Current Turn", "type": "integer" }, "next_speaker_index": { "default": 0, "title": "Next Speaker Index", "type": "integer" } }, "$defs": { "FunctionCall": { "properties": { "id": { "title": "Id", "type": "string" }, "arguments": { "title": "Arguments", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "arguments", "name" ], "title": "FunctionCall", "type": "object" }, "FunctionExecutionResult": { "properties": { "content": { "title": "Content", "type": "string" }, "call_id": { "title": "Call Id", "type": "string" } }, "required": [ "content", "call_id" ], "title": "FunctionExecutionResult", "type": "object" }, "HandoffMessage": { "description": "A message requesting handoff of a conversation to another agent.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "target": { "title": "Target", "type": "string" }, "content": { "title": "Content", "type": "string" }, "type": { "const": "HandoffMessage", "default": "HandoffMessage", "enum": [ "HandoffMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "target", "content" ], "title": "HandoffMessage", "type": "object" }, "MultiModalMessage": { "description": "A multimodal message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "anyOf": [ { "type": "string" }, {} ] }, "title": "Content", "type": "array" }, "type": { "const": "MultiModalMessage", "default": "MultiModalMessage", "enum": [ "MultiModalMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "MultiModalMessage", "type": "object" }, "RequestUsage": { "properties": { "prompt_tokens": { "title": "Prompt Tokens", "type": "integer" }, "completion_tokens": { "title": "Completion Tokens", "type": "integer" } }, "required": [ "prompt_tokens", "completion_tokens" ], "title": "RequestUsage", "type": "object" }, "StopMessage": { "description": "A message requesting stop of a conversation.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "StopMessage", "default": "StopMessage", "enum": [ "StopMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "StopMessage", "type": "object" }, "TextMessage": { "description": "A text message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "TextMessage", "default": "TextMessage", "enum": [ "TextMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "TextMessage", "type": "object" }, "ToolCallMessage": { "description": "A message signaling the use of tools.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "$ref": "#/$defs/FunctionCall" }, "title": "Content", "type": "array" }, "type": { "const": "ToolCallMessage", "default": "ToolCallMessage", "enum": [ "ToolCallMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "ToolCallMessage", "type": "object" }, "ToolCallResultMessage": { "description": "A message signaling the results of tool calls.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "$ref": "#/$defs/FunctionExecutionResult" }, "title": "Content", "type": "array" }, "type": { "const": "ToolCallResultMessage", "default": "ToolCallResultMessage", "enum": [ "ToolCallResultMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "ToolCallResultMessage", "type": "object" } } }
- Fields:
next_speaker_index (int)
type (str)
- pydantic model SelectorManagerState[source]#
Bases:
BaseGroupChatManagerState
State for
SelectorGroupChat
manager.Show JSON schema
{ "title": "SelectorManagerState", "description": "State for :class:`~autogen_agentchat.teams.SelectorGroupChat` manager.", "type": "object", "properties": { "type": { "default": "SelectorManagerState", "title": "Type", "type": "string" }, "version": { "default": "1.0.0", "title": "Version", "type": "string" }, "message_thread": { "items": { "discriminator": { "mapping": { "HandoffMessage": "#/$defs/HandoffMessage", "MultiModalMessage": "#/$defs/MultiModalMessage", "StopMessage": "#/$defs/StopMessage", "TextMessage": "#/$defs/TextMessage", "ToolCallMessage": "#/$defs/ToolCallMessage", "ToolCallResultMessage": "#/$defs/ToolCallResultMessage" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/TextMessage" }, { "$ref": "#/$defs/MultiModalMessage" }, { "$ref": "#/$defs/StopMessage" }, { "$ref": "#/$defs/HandoffMessage" }, { "$ref": "#/$defs/ToolCallMessage" }, { "$ref": "#/$defs/ToolCallResultMessage" } ] }, "title": "Message Thread", "type": "array" }, "current_turn": { "default": 0, "title": "Current Turn", "type": "integer" }, "previous_speaker": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "title": "Previous Speaker" } }, "$defs": { "FunctionCall": { "properties": { "id": { "title": "Id", "type": "string" }, "arguments": { "title": "Arguments", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "arguments", "name" ], "title": "FunctionCall", "type": "object" }, "FunctionExecutionResult": { "properties": { "content": { "title": "Content", "type": "string" }, "call_id": { "title": "Call Id", "type": "string" } }, "required": [ "content", "call_id" ], "title": "FunctionExecutionResult", "type": "object" }, "HandoffMessage": { "description": "A message requesting handoff of a conversation to another agent.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "target": { "title": "Target", "type": "string" }, "content": { "title": "Content", "type": "string" }, "type": { "const": "HandoffMessage", "default": "HandoffMessage", "enum": [ "HandoffMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "target", "content" ], "title": "HandoffMessage", "type": "object" }, "MultiModalMessage": { "description": "A multimodal message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "anyOf": [ { "type": "string" }, {} ] }, "title": "Content", "type": "array" }, "type": { "const": "MultiModalMessage", "default": "MultiModalMessage", "enum": [ "MultiModalMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "MultiModalMessage", "type": "object" }, "RequestUsage": { "properties": { "prompt_tokens": { "title": "Prompt Tokens", "type": "integer" }, "completion_tokens": { "title": "Completion Tokens", "type": "integer" } }, "required": [ "prompt_tokens", "completion_tokens" ], "title": "RequestUsage", "type": "object" }, "StopMessage": { "description": "A message requesting stop of a conversation.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "StopMessage", "default": "StopMessage", "enum": [ "StopMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "StopMessage", "type": "object" }, "TextMessage": { "description": "A text message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "TextMessage", "default": "TextMessage", "enum": [ "TextMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "TextMessage", "type": "object" }, "ToolCallMessage": { "description": "A message signaling the use of tools.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "$ref": "#/$defs/FunctionCall" }, "title": "Content", "type": "array" }, "type": { "const": "ToolCallMessage", "default": "ToolCallMessage", "enum": [ "ToolCallMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "ToolCallMessage", "type": "object" }, "ToolCallResultMessage": { "description": "A message signaling the results of tool calls.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "$ref": "#/$defs/FunctionExecutionResult" }, "title": "Content", "type": "array" }, "type": { "const": "ToolCallResultMessage", "default": "ToolCallResultMessage", "enum": [ "ToolCallResultMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "ToolCallResultMessage", "type": "object" } } }
- Fields:
previous_speaker (str | None)
type (str)
- pydantic model SwarmManagerState[source]#
Bases:
BaseGroupChatManagerState
State for
Swarm
manager.Show JSON schema
{ "title": "SwarmManagerState", "description": "State for :class:`~autogen_agentchat.teams.Swarm` manager.", "type": "object", "properties": { "type": { "default": "SwarmManagerState", "title": "Type", "type": "string" }, "version": { "default": "1.0.0", "title": "Version", "type": "string" }, "message_thread": { "items": { "discriminator": { "mapping": { "HandoffMessage": "#/$defs/HandoffMessage", "MultiModalMessage": "#/$defs/MultiModalMessage", "StopMessage": "#/$defs/StopMessage", "TextMessage": "#/$defs/TextMessage", "ToolCallMessage": "#/$defs/ToolCallMessage", "ToolCallResultMessage": "#/$defs/ToolCallResultMessage" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/$defs/TextMessage" }, { "$ref": "#/$defs/MultiModalMessage" }, { "$ref": "#/$defs/StopMessage" }, { "$ref": "#/$defs/HandoffMessage" }, { "$ref": "#/$defs/ToolCallMessage" }, { "$ref": "#/$defs/ToolCallResultMessage" } ] }, "title": "Message Thread", "type": "array" }, "current_turn": { "default": 0, "title": "Current Turn", "type": "integer" }, "current_speaker": { "default": "", "title": "Current Speaker", "type": "string" } }, "$defs": { "FunctionCall": { "properties": { "id": { "title": "Id", "type": "string" }, "arguments": { "title": "Arguments", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "arguments", "name" ], "title": "FunctionCall", "type": "object" }, "FunctionExecutionResult": { "properties": { "content": { "title": "Content", "type": "string" }, "call_id": { "title": "Call Id", "type": "string" } }, "required": [ "content", "call_id" ], "title": "FunctionExecutionResult", "type": "object" }, "HandoffMessage": { "description": "A message requesting handoff of a conversation to another agent.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "target": { "title": "Target", "type": "string" }, "content": { "title": "Content", "type": "string" }, "type": { "const": "HandoffMessage", "default": "HandoffMessage", "enum": [ "HandoffMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "target", "content" ], "title": "HandoffMessage", "type": "object" }, "MultiModalMessage": { "description": "A multimodal message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "anyOf": [ { "type": "string" }, {} ] }, "title": "Content", "type": "array" }, "type": { "const": "MultiModalMessage", "default": "MultiModalMessage", "enum": [ "MultiModalMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "MultiModalMessage", "type": "object" }, "RequestUsage": { "properties": { "prompt_tokens": { "title": "Prompt Tokens", "type": "integer" }, "completion_tokens": { "title": "Completion Tokens", "type": "integer" } }, "required": [ "prompt_tokens", "completion_tokens" ], "title": "RequestUsage", "type": "object" }, "StopMessage": { "description": "A message requesting stop of a conversation.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "StopMessage", "default": "StopMessage", "enum": [ "StopMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "StopMessage", "type": "object" }, "TextMessage": { "description": "A text message.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "title": "Content", "type": "string" }, "type": { "const": "TextMessage", "default": "TextMessage", "enum": [ "TextMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "TextMessage", "type": "object" }, "ToolCallMessage": { "description": "A message signaling the use of tools.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "$ref": "#/$defs/FunctionCall" }, "title": "Content", "type": "array" }, "type": { "const": "ToolCallMessage", "default": "ToolCallMessage", "enum": [ "ToolCallMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "ToolCallMessage", "type": "object" }, "ToolCallResultMessage": { "description": "A message signaling the results of tool calls.", "properties": { "source": { "title": "Source", "type": "string" }, "models_usage": { "anyOf": [ { "$ref": "#/$defs/RequestUsage" }, { "type": "null" } ], "default": null }, "content": { "items": { "$ref": "#/$defs/FunctionExecutionResult" }, "title": "Content", "type": "array" }, "type": { "const": "ToolCallResultMessage", "default": "ToolCallResultMessage", "enum": [ "ToolCallResultMessage" ], "title": "Type", "type": "string" } }, "required": [ "source", "content" ], "title": "ToolCallResultMessage", "type": "object" } } }
- Fields:
current_speaker (str)
type (str)
- pydantic model TeamState[source]#
Bases:
BaseState
State for a team of agents.
Show JSON schema
{ "title": "TeamState", "description": "State for a team of agents.", "type": "object", "properties": { "type": { "default": "TeamState", "title": "Type", "type": "string" }, "version": { "default": "1.0.0", "title": "Version", "type": "string" }, "agent_states": { "title": "Agent States", "type": "object" }, "team_id": { "default": "", "title": "Team Id", "type": "string" } } }
- Fields:
agent_states (Mapping[str, Any])
team_id (str)
type (str)