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_context": {
         "title": "Llm Context",
         "type": "object"
      }
   }
}

Fields:

• llm_context (Mapping[str, Any])

• type (str)

field llm_context: Mapping[str, Any] [Optional]#

field type: str = 'AssistantAgentState'#

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",
                  "MemoryQueryEvent": "#/$defs/MemoryQueryEvent",
                  "ModelClientStreamingChunkEvent": "#/$defs/ModelClientStreamingChunkEvent",
                  "MultiModalMessage": "#/$defs/MultiModalMessage",
                  "StopMessage": "#/$defs/StopMessage",
                  "TextMessage": "#/$defs/TextMessage",
                  "ThoughtEvent": "#/$defs/ThoughtEvent",
                  "ToolCallExecutionEvent": "#/$defs/ToolCallExecutionEvent",
                  "ToolCallRequestEvent": "#/$defs/ToolCallRequestEvent",
                  "ToolCallSummaryMessage": "#/$defs/ToolCallSummaryMessage",
                  "UserInputRequestedEvent": "#/$defs/UserInputRequestedEvent"
               },
               "propertyName": "type"
            },
            "oneOf": [
               {
                  "$ref": "#/$defs/ToolCallRequestEvent"
               },
               {
                  "$ref": "#/$defs/ToolCallExecutionEvent"
               },
               {
                  "$ref": "#/$defs/MemoryQueryEvent"
               },
               {
                  "$ref": "#/$defs/UserInputRequestedEvent"
               },
               {
                  "$ref": "#/$defs/ModelClientStreamingChunkEvent"
               },
               {
                  "$ref": "#/$defs/ThoughtEvent"
               },
               {
                  "$ref": "#/$defs/TextMessage"
               },
               {
                  "$ref": "#/$defs/MultiModalMessage"
               },
               {
                  "$ref": "#/$defs/StopMessage"
               },
               {
                  "$ref": "#/$defs/ToolCallSummaryMessage"
               },
               {
                  "$ref": "#/$defs/HandoffMessage"
               }
            ]
         },
         "title": "Message Thread",
         "type": "array"
      },
      "current_turn": {
         "default": 0,
         "title": "Current Turn",
         "type": "integer"
      }
   },
   "$defs": {
      "AssistantMessage": {
         "description": "Assistant message are sampled from the language model.",
         "properties": {
            "content": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionCall"
                     },
                     "type": "array"
                  }
               ],
               "title": "Content"
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Thought"
            },
            "source": {
               "title": "Source",
               "type": "string"
            },
            "type": {
               "const": "AssistantMessage",
               "default": "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": {
         "description": "Function execution result contains the output of a function call.",
         "properties": {
            "content": {
               "title": "Content",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "call_id": {
               "title": "Call Id",
               "type": "string"
            },
            "is_error": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Is Error"
            }
         },
         "required": [
            "content",
            "name",
            "call_id"
         ],
         "title": "FunctionExecutionResult",
         "type": "object"
      },
      "FunctionExecutionResultMessage": {
         "description": "Function execution result message contains the output of multiple function calls.",
         "properties": {
            "content": {
               "items": {
                  "$ref": "#/$defs/FunctionExecutionResult"
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "FunctionExecutionResultMessage",
               "default": "FunctionExecutionResultMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "content"
         ],
         "title": "FunctionExecutionResultMessage",
         "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
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "target": {
               "title": "Target",
               "type": "string"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "context": {
               "default": [],
               "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": "Context",
               "type": "array"
            },
            "type": {
               "const": "HandoffMessage",
               "default": "HandoffMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "target",
            "content"
         ],
         "title": "HandoffMessage",
         "type": "object"
      },
      "MemoryContent": {
         "description": "A memory content item.",
         "properties": {
            "content": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "binary",
                     "type": "string"
                  },
                  {
                     "type": "object"
                  },
                  {}
               ],
               "title": "Content"
            },
            "mime_type": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MemoryMimeType"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Mime Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "content",
            "mime_type"
         ],
         "title": "MemoryContent",
         "type": "object"
      },
      "MemoryMimeType": {
         "description": "Supported MIME types for memory content.",
         "enum": [
            "text/plain",
            "application/json",
            "text/markdown",
            "image/*",
            "application/octet-stream"
         ],
         "title": "MemoryMimeType",
         "type": "string"
      },
      "MemoryQueryEvent": {
         "description": "An event signaling the results of memory queries.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "items": {
                  "$ref": "#/$defs/MemoryContent"
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "MemoryQueryEvent",
               "default": "MemoryQueryEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "MemoryQueryEvent",
         "type": "object"
      },
      "ModelClientStreamingChunkEvent": {
         "description": "An event signaling a text output chunk from a model client in streaming mode.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "ModelClientStreamingChunkEvent",
               "default": "ModelClientStreamingChunkEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "ModelClientStreamingChunkEvent",
         "type": "object"
      },
      "MultiModalMessage": {
         "description": "A multimodal message.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "items": {
                  "anyOf": [
                     {
                        "type": "string"
                     },
                     {}
                  ]
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "MultiModalMessage",
               "default": "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
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "StopMessage",
               "default": "StopMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "StopMessage",
         "type": "object"
      },
      "SystemMessage": {
         "description": "System message contains instructions for the model coming from the developer.\n\n.. note::\n\n    Open AI is moving away from using 'system' role in favor of 'developer' role.\n    See `Model Spec <https://cdn.openai.com/spec/model-spec-2024-05-08.html#definitions>`_ for more details.\n    However, the 'system' role is still allowed in their API and will be automatically converted to 'developer' role\n    on the server side.\n    So, you can use `SystemMessage` for developer messages.",
         "properties": {
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "SystemMessage",
               "default": "SystemMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "content"
         ],
         "title": "SystemMessage",
         "type": "object"
      },
      "TextMessage": {
         "description": "A text message.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "TextMessage",
               "default": "TextMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "TextMessage",
         "type": "object"
      },
      "ThoughtEvent": {
         "description": "An event signaling the thought process of an agent.\nIt is used to communicate the reasoning tokens generated by a reasoning model,\nor the extra text content generated by a function call.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "ThoughtEvent",
               "default": "ThoughtEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "ThoughtEvent",
         "type": "object"
      },
      "ToolCallExecutionEvent": {
         "description": "An event signaling the execution of tool calls.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "items": {
                  "$ref": "#/$defs/FunctionExecutionResult"
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "ToolCallExecutionEvent",
               "default": "ToolCallExecutionEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "ToolCallExecutionEvent",
         "type": "object"
      },
      "ToolCallRequestEvent": {
         "description": "An event signaling a request to use tools.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "items": {
                  "$ref": "#/$defs/FunctionCall"
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "ToolCallRequestEvent",
               "default": "ToolCallRequestEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "ToolCallRequestEvent",
         "type": "object"
      },
      "ToolCallSummaryMessage": {
         "description": "A message signaling the summary of tool call results.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "ToolCallSummaryMessage",
               "default": "ToolCallSummaryMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "ToolCallSummaryMessage",
         "type": "object"
      },
      "UserInputRequestedEvent": {
         "description": "An event signaling a that the user proxy has requested user input. Published prior to invoking the input callback.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "request_id": {
               "title": "Request Id",
               "type": "string"
            },
            "content": {
               "const": "",
               "default": "",
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "UserInputRequestedEvent",
               "default": "UserInputRequestedEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "request_id"
         ],
         "title": "UserInputRequestedEvent",
         "type": "object"
      },
      "UserMessage": {
         "description": "User message contains input from end users, or a catch-all for data provided to the model.",
         "properties": {
            "content": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "anyOf": [
                           {
                              "type": "string"
                           },
                           {}
                        ]
                     },
                     "type": "array"
                  }
               ],
               "title": "Content"
            },
            "source": {
               "title": "Source",
               "type": "string"
            },
            "type": {
               "const": "UserMessage",
               "default": "UserMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "content",
            "source"
         ],
         "title": "UserMessage",
         "type": "object"
      }
   }
}

Fields:

• current_turn (int)

• message_thread (List[autogen_agentchat.messages.ToolCallRequestEvent | autogen_agentchat.messages.ToolCallExecutionEvent | autogen_agentchat.messages.MemoryQueryEvent | autogen_agentchat.messages.UserInputRequestedEvent | autogen_agentchat.messages.ModelClientStreamingChunkEvent | autogen_agentchat.messages.ThoughtEvent | autogen_agentchat.messages.TextMessage | autogen_agentchat.messages.MultiModalMessage | autogen_agentchat.messages.StopMessage | autogen_agentchat.messages.ToolCallSummaryMessage | autogen_agentchat.messages.HandoffMessage])

• type (str)

field current_turn: int = 0#

field message_thread: List[Annotated[Annotated[ToolCallRequestEvent | ToolCallExecutionEvent | MemoryQueryEvent | UserInputRequestedEvent | ModelClientStreamingChunkEvent | ThoughtEvent, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | Annotated[TextMessage | MultiModalMessage | StopMessage | ToolCallSummaryMessage | HandoffMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')], FieldInfo(annotation=NoneType, required=True, discriminator='type')]] [Optional]#

field type: str = 'BaseGroupChatManagerState'#

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)

field type: str = 'BaseState'#

field version: str = '1.0.0'#

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",
                  "ToolCallSummaryMessage": "#/$defs/ToolCallSummaryMessage"
               },
               "propertyName": "type"
            },
            "oneOf": [
               {
                  "$ref": "#/$defs/TextMessage"
               },
               {
                  "$ref": "#/$defs/MultiModalMessage"
               },
               {
                  "$ref": "#/$defs/StopMessage"
               },
               {
                  "$ref": "#/$defs/ToolCallSummaryMessage"
               },
               {
                  "$ref": "#/$defs/HandoffMessage"
               }
            ]
         },
         "title": "Message Buffer",
         "type": "array"
      }
   },
   "$defs": {
      "AssistantMessage": {
         "description": "Assistant message are sampled from the language model.",
         "properties": {
            "content": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionCall"
                     },
                     "type": "array"
                  }
               ],
               "title": "Content"
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Thought"
            },
            "source": {
               "title": "Source",
               "type": "string"
            },
            "type": {
               "const": "AssistantMessage",
               "default": "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": {
         "description": "Function execution result contains the output of a function call.",
         "properties": {
            "content": {
               "title": "Content",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "call_id": {
               "title": "Call Id",
               "type": "string"
            },
            "is_error": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Is Error"
            }
         },
         "required": [
            "content",
            "name",
            "call_id"
         ],
         "title": "FunctionExecutionResult",
         "type": "object"
      },
      "FunctionExecutionResultMessage": {
         "description": "Function execution result message contains the output of multiple function calls.",
         "properties": {
            "content": {
               "items": {
                  "$ref": "#/$defs/FunctionExecutionResult"
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "FunctionExecutionResultMessage",
               "default": "FunctionExecutionResultMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "content"
         ],
         "title": "FunctionExecutionResultMessage",
         "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
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "target": {
               "title": "Target",
               "type": "string"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "context": {
               "default": [],
               "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": "Context",
               "type": "array"
            },
            "type": {
               "const": "HandoffMessage",
               "default": "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
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "items": {
                  "anyOf": [
                     {
                        "type": "string"
                     },
                     {}
                  ]
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "MultiModalMessage",
               "default": "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
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "StopMessage",
               "default": "StopMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "StopMessage",
         "type": "object"
      },
      "SystemMessage": {
         "description": "System message contains instructions for the model coming from the developer.\n\n.. note::\n\n    Open AI is moving away from using 'system' role in favor of 'developer' role.\n    See `Model Spec <https://cdn.openai.com/spec/model-spec-2024-05-08.html#definitions>`_ for more details.\n    However, the 'system' role is still allowed in their API and will be automatically converted to 'developer' role\n    on the server side.\n    So, you can use `SystemMessage` for developer messages.",
         "properties": {
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "SystemMessage",
               "default": "SystemMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "content"
         ],
         "title": "SystemMessage",
         "type": "object"
      },
      "TextMessage": {
         "description": "A text message.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "TextMessage",
               "default": "TextMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "TextMessage",
         "type": "object"
      },
      "ToolCallSummaryMessage": {
         "description": "A message signaling the summary of tool call results.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "ToolCallSummaryMessage",
               "default": "ToolCallSummaryMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "ToolCallSummaryMessage",
         "type": "object"
      },
      "UserMessage": {
         "description": "User message contains input from end users, or a catch-all for data provided to the model.",
         "properties": {
            "content": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "anyOf": [
                           {
                              "type": "string"
                           },
                           {}
                        ]
                     },
                     "type": "array"
                  }
               ],
               "title": "Content"
            },
            "source": {
               "title": "Source",
               "type": "string"
            },
            "type": {
               "const": "UserMessage",
               "default": "UserMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "content",
            "source"
         ],
         "title": "UserMessage",
         "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.ToolCallSummaryMessage | autogen_agentchat.messages.HandoffMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]])

• type (str)

field agent_state: Mapping[str, Any] [Optional]#

field message_buffer: List[Annotated[TextMessage | MultiModalMessage | StopMessage | ToolCallSummaryMessage | HandoffMessage, FieldInfo(annotation=NoneType, required=True, discriminator='type')]] [Optional]#

field type: str = 'ChatAgentContainerState'#

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",
                  "MemoryQueryEvent": "#/$defs/MemoryQueryEvent",
                  "ModelClientStreamingChunkEvent": "#/$defs/ModelClientStreamingChunkEvent",
                  "MultiModalMessage": "#/$defs/MultiModalMessage",
                  "StopMessage": "#/$defs/StopMessage",
                  "TextMessage": "#/$defs/TextMessage",
                  "ThoughtEvent": "#/$defs/ThoughtEvent",
                  "ToolCallExecutionEvent": "#/$defs/ToolCallExecutionEvent",
                  "ToolCallRequestEvent": "#/$defs/ToolCallRequestEvent",
                  "ToolCallSummaryMessage": "#/$defs/ToolCallSummaryMessage",
                  "UserInputRequestedEvent": "#/$defs/UserInputRequestedEvent"
               },
               "propertyName": "type"
            },
            "oneOf": [
               {
                  "$ref": "#/$defs/ToolCallRequestEvent"
               },
               {
                  "$ref": "#/$defs/ToolCallExecutionEvent"
               },
               {
                  "$ref": "#/$defs/MemoryQueryEvent"
               },
               {
                  "$ref": "#/$defs/UserInputRequestedEvent"
               },
               {
                  "$ref": "#/$defs/ModelClientStreamingChunkEvent"
               },
               {
                  "$ref": "#/$defs/ThoughtEvent"
               },
               {
                  "$ref": "#/$defs/TextMessage"
               },
               {
                  "$ref": "#/$defs/MultiModalMessage"
               },
               {
                  "$ref": "#/$defs/StopMessage"
               },
               {
                  "$ref": "#/$defs/ToolCallSummaryMessage"
               },
               {
                  "$ref": "#/$defs/HandoffMessage"
               }
            ]
         },
         "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": {
      "AssistantMessage": {
         "description": "Assistant message are sampled from the language model.",
         "properties": {
            "content": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "$ref": "#/$defs/FunctionCall"
                     },
                     "type": "array"
                  }
               ],
               "title": "Content"
            },
            "thought": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Thought"
            },
            "source": {
               "title": "Source",
               "type": "string"
            },
            "type": {
               "const": "AssistantMessage",
               "default": "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": {
         "description": "Function execution result contains the output of a function call.",
         "properties": {
            "content": {
               "title": "Content",
               "type": "string"
            },
            "name": {
               "title": "Name",
               "type": "string"
            },
            "call_id": {
               "title": "Call Id",
               "type": "string"
            },
            "is_error": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Is Error"
            }
         },
         "required": [
            "content",
            "name",
            "call_id"
         ],
         "title": "FunctionExecutionResult",
         "type": "object"
      },
      "FunctionExecutionResultMessage": {
         "description": "Function execution result message contains the output of multiple function calls.",
         "properties": {
            "content": {
               "items": {
                  "$ref": "#/$defs/FunctionExecutionResult"
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "FunctionExecutionResultMessage",
               "default": "FunctionExecutionResultMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "content"
         ],
         "title": "FunctionExecutionResultMessage",
         "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
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "target": {
               "title": "Target",
               "type": "string"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "context": {
               "default": [],
               "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": "Context",
               "type": "array"
            },
            "type": {
               "const": "HandoffMessage",
               "default": "HandoffMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "target",
            "content"
         ],
         "title": "HandoffMessage",
         "type": "object"
      },
      "MemoryContent": {
         "description": "A memory content item.",
         "properties": {
            "content": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "format": "binary",
                     "type": "string"
                  },
                  {
                     "type": "object"
                  },
                  {}
               ],
               "title": "Content"
            },
            "mime_type": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/MemoryMimeType"
                  },
                  {
                     "type": "string"
                  }
               ],
               "title": "Mime Type"
            },
            "metadata": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Metadata"
            }
         },
         "required": [
            "content",
            "mime_type"
         ],
         "title": "MemoryContent",
         "type": "object"
      },
      "MemoryMimeType": {
         "description": "Supported MIME types for memory content.",
         "enum": [
            "text/plain",
            "application/json",
            "text/markdown",
            "image/*",
            "application/octet-stream"
         ],
         "title": "MemoryMimeType",
         "type": "string"
      },
      "MemoryQueryEvent": {
         "description": "An event signaling the results of memory queries.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "items": {
                  "$ref": "#/$defs/MemoryContent"
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "MemoryQueryEvent",
               "default": "MemoryQueryEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "MemoryQueryEvent",
         "type": "object"
      },
      "ModelClientStreamingChunkEvent": {
         "description": "An event signaling a text output chunk from a model client in streaming mode.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "ModelClientStreamingChunkEvent",
               "default": "ModelClientStreamingChunkEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "ModelClientStreamingChunkEvent",
         "type": "object"
      },
      "MultiModalMessage": {
         "description": "A multimodal message.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "items": {
                  "anyOf": [
                     {
                        "type": "string"
                     },
                     {}
                  ]
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "MultiModalMessage",
               "default": "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
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "StopMessage",
               "default": "StopMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "StopMessage",
         "type": "object"
      },
      "SystemMessage": {
         "description": "System message contains instructions for the model coming from the developer.\n\n.. note::\n\n    Open AI is moving away from using 'system' role in favor of 'developer' role.\n    See `Model Spec <https://cdn.openai.com/spec/model-spec-2024-05-08.html#definitions>`_ for more details.\n    However, the 'system' role is still allowed in their API and will be automatically converted to 'developer' role\n    on the server side.\n    So, you can use `SystemMessage` for developer messages.",
         "properties": {
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "SystemMessage",
               "default": "SystemMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "content"
         ],
         "title": "SystemMessage",
         "type": "object"
      },
      "TextMessage": {
         "description": "A text message.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "TextMessage",
               "default": "TextMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "TextMessage",
         "type": "object"
      },
      "ThoughtEvent": {
         "description": "An event signaling the thought process of an agent.\nIt is used to communicate the reasoning tokens generated by a reasoning model,\nor the extra text content generated by a function call.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "ThoughtEvent",
               "default": "ThoughtEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "ThoughtEvent",
         "type": "object"
      },
      "ToolCallExecutionEvent": {
         "description": "An event signaling the execution of tool calls.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "items": {
                  "$ref": "#/$defs/FunctionExecutionResult"
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "ToolCallExecutionEvent",
               "default": "ToolCallExecutionEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "ToolCallExecutionEvent",
         "type": "object"
      },
      "ToolCallRequestEvent": {
         "description": "An event signaling a request to use tools.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "items": {
                  "$ref": "#/$defs/FunctionCall"
               },
               "title": "Content",
               "type": "array"
            },
            "type": {
               "const": "ToolCallRequestEvent",
               "default": "ToolCallRequestEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "ToolCallRequestEvent",
         "type": "object"
      },
      "ToolCallSummaryMessage": {
         "description": "A message signaling the summary of tool call results.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "content": {
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "ToolCallSummaryMessage",
               "default": "ToolCallSummaryMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "content"
         ],
         "title": "ToolCallSummaryMessage",
         "type": "object"
      },
      "UserInputRequestedEvent": {
         "description": "An event signaling a that the user proxy has requested user input. Published prior to invoking the input callback.",
         "properties": {
            "source": {
               "title": "Source",
               "type": "string"
            },
            "models_usage": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/RequestUsage"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "metadata": {
               "additionalProperties": {
                  "type": "string"
               },
               "default": {},
               "title": "Metadata",
               "type": "object"
            },
            "request_id": {
               "title": "Request Id",
               "type": "string"
            },
            "content": {
               "const": "",
               "default": "",
               "title": "Content",
               "type": "string"
            },
            "type": {
               "const": "UserInputRequestedEvent",
               "default": "UserInputRequestedEvent",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "source",
            "request_id"
         ],
         "title": "UserInputRequestedEvent",
         "type": "object"
      },
      "UserMessage": {
         "description": "User message contains input from end users, or a catch-all for data provided to the model.",
         "properties": {
            "content": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "items": {
                        "anyOf": [
                           {
                              "type": "string"
                           },
                           {}
                        ]
                     },
                     "type": "array"
                  }
               ],
               "title": "Content"
            },
            "source": {
               "title": "Source",
               "type": "string"
            },
            "type": {
               "const": "UserMessage",
               "default": "UserMessage",
               "title": "Type",
               "type": "string"
            }
         },
         "required": [
            "content",
            "source"
         ],
         "title": "UserMessage",
         "type": "object"
      }
   }
}

Fields:

• facts (str)

• n_rounds (int)

• n_stalls (int)

• plan (str)

• task (str)

• type (str)

field facts: str = ''#

field n_rounds: int = 0#

field n_stalls: int = 0#

field plan: str = ''#

field task: str = ''#

field type: str = 'MagenticOneOrchestratorState'#