ag2 0.10.2__py3-none-any.whl

autogen/a2a/utils.py

@@ -0,0 +1,207 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Any, cast
+from uuid import uuid4
+
+from a2a.types import Artifact, DataPart, Message, Part, Role, Task, TaskState, TextPart
+from a2a.utils import get_message_text, new_agent_parts_message, new_artifact
+from a2a.utils.message import new_agent_text_message
+
+from autogen.remote.protocol import RequestMessage, ResponseMessage
+
+AG2_METADATA_KEY_PREFIX = "ag2_"
+CLIENT_TOOLS_KEY = f"{AG2_METADATA_KEY_PREFIX}client_tools"
+CONTEXT_KEY = f"{AG2_METADATA_KEY_PREFIX}context_update"
+
+
+def request_message_to_a2a(
+    request_message: RequestMessage,
+    context_id: str,
+) -> Message:
+    metadata: dict[str, Any] = {}
+    if request_message.client_tools:
+        metadata[CLIENT_TOOLS_KEY] = request_message.client_tools
+    if request_message.context:
+        metadata[CONTEXT_KEY] = request_message.context
+
+    return Message(
+        role=Role.user,
+        parts=[message_to_part(message) for message in request_message.messages],
+        message_id=uuid4().hex,
+        context_id=context_id,
+        metadata=metadata,
+    )
+
+
+def request_message_from_a2a(message: Message) -> RequestMessage:
+    metadata = message.metadata or {}
+    return RequestMessage(
+        messages=[message_from_part(part) for part in message.parts],
+        context=metadata.get(CONTEXT_KEY),
+        client_tools=metadata.get(CLIENT_TOOLS_KEY, []),
+    )
+
+
+def response_message_from_a2a_task(task: Task) -> ResponseMessage | None:
+    history = [message_from_part(p) for m in (task.history or []) for p in m.parts]
+
+    if task.status.state is TaskState.input_required:
+        message: str | None = None
+        context: dict[str, Any] | None = None
+
+        if task.history:
+            input_message = task.history[-1]
+            message = get_message_text(input_message)
+
+            if input_message.metadata:
+                context = input_message.metadata.get(CONTEXT_KEY)
+
+            if "role" not in history[-1]:
+                history[-1]["role"] = "assistant"
+
+        return ResponseMessage(
+            messages=history,
+            input_required=message or "Please provide input:",
+            context=context,
+        )
+
+    response = response_message_from_a2a_artifacts(task.artifacts)
+    if response:
+        response.messages = history + response.messages
+    return response
+
+
+def response_message_from_a2a_artifacts(artifacts: list[Artifact] | None) -> ResponseMessage | None:
+    if not artifacts:
+        return None
+
+    if len(artifacts) > 1:
+        raise NotImplementedError("Multiple artifacts are not supported")
+
+    artifact = artifacts[-1]
+
+    if not artifact.parts:
+        return None
+
+    if len(artifact.parts) > 1:
+        raise NotImplementedError("Multiple parts are not supported")
+
+    return ResponseMessage(
+        messages=[message_from_part(artifact.parts[-1])],
+        context=(artifact.metadata or {}).get(CONTEXT_KEY),
+    )
+
+
+def response_message_from_a2a_message(message: Message) -> ResponseMessage | None:
+    text_parts: list[Part] = []
+    data_parts: list[Part] = []
+    for part in message.parts:
+        if isinstance(part.root, TextPart):
+            text_parts.append(part)
+        elif isinstance(part.root, DataPart):
+            data_parts.append(part)
+        else:
+            raise NotImplementedError(f"Unsupported part type: {type(part.root)}")
+
+    tpn = len(text_parts)
+    if dpn := len(data_parts):
+        if dpn > 1:
+            raise NotImplementedError("Multiple data parts are not supported")
+
+        if tpn:
+            raise NotImplementedError("Data parts and text parts are not supported together")
+
+        messages = [message_from_part(data_parts[0])]
+    elif tpn == 1:
+        messages = [message_from_part(text_parts[0])]
+    else:
+        messages = [{"content": "\n".join(cast(TextPart, t.root).text for t in text_parts)}]
+
+    return ResponseMessage(
+        messages=messages,
+        context=(message.metadata or {}).get(CONTEXT_KEY),
+    )
+
+
+def response_message_to_a2a(
+    result: ResponseMessage | None,
+    context_id: str | None,
+    task_id: str | None,
+) -> tuple[Artifact | None, list[Message], Message | None]:
+    if not result:
+        return (
+            new_artifact(
+                name="result",
+                parts=[],
+                description=None,
+            ),
+            [],
+            None,
+        )
+
+    message_history = [
+        new_agent_parts_message(
+            parts=[message_to_part(m) for m in result.messages],
+            context_id=context_id,
+            task_id=task_id,
+        ),
+    ]
+
+    if result.input_required is not None:
+        input_message = new_agent_text_message(
+            text=result.input_required,
+            context_id=context_id,
+            task_id=task_id,
+        )
+        if result.context:
+            input_message.metadata = {CONTEXT_KEY: result.context}
+
+        return None, message_history, input_message
+
+    artifact = new_artifact(
+        name="result",
+        parts=[message_to_part(result.messages[-1])],
+        description=None,
+    )
+
+    if result.context:
+        artifact.metadata = {CONTEXT_KEY: result.context}
+
+    return artifact, message_history, None
+
+
+def message_to_part(message: dict[str, Any]) -> Part:
+    message = message.copy()
+    text = message.pop("content", "") or ""
+    return Part(
+        root=TextPart(
+            text=text,
+            metadata=message or None,
+        )
+    )
+
+
+def message_from_part(part: Part) -> dict[str, Any]:
+    root = part.root
+
+    if isinstance(root, TextPart):
+        return {
+            **(root.metadata or {}),
+            "content": root.text,
+        }
+
+    elif isinstance(root, DataPart):
+        if (  # pydantic-ai specific
+            set(root.data.keys()) == {"result"}
+            and root.metadata
+            and "json_schema" in root.metadata
+            and isinstance(data := root.data["result"], dict)
+        ):
+            return data
+
+        return root.data
+
+    else:
+        raise NotImplementedError(f"Unsupported part type: {type(part.root)}")

autogen/agentchat/__init__.py

@@ -0,0 +1,47 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# Portions derived from  https://github.com/microsoft/autogen are under the MIT License.
+# SPDX-License-Identifier: MIT
+from .agent import Agent, LLMAgent
+from .assistant_agent import AssistantAgent
+from .chat import ChatResult, a_initiate_chats, initiate_chats
+
+# Imported last to avoid circular imports
+from .contrib.swarm_agent import (
+    a_initiate_swarm_chat,
+    a_run_swarm,
+    run_swarm,
+)
+from .conversable_agent import ConversableAgent, UpdateSystemMessage, register_function
+from .group import ContextVariables, ReplyResult
+from .group.multi_agent_chat import a_initiate_group_chat, a_run_group_chat, initiate_group_chat, run_group_chat
+from .groupchat import GroupChat, GroupChatManager
+from .user_proxy_agent import UserProxyAgent
+from .utils import gather_usage_summary
+
+__all__ = [
+    "Agent",
+    "AssistantAgent",
+    "ChatResult",
+    "ContextVariables",
+    "ConversableAgent",
+    "GroupChat",
+    "GroupChatManager",
+    "LLMAgent",
+    "ReplyResult",
+    "UpdateSystemMessage",
+    "UserProxyAgent",
+    "a_initiate_chats",
+    "a_initiate_group_chat",
+    "a_initiate_swarm_chat",
+    "a_run_group_chat",
+    "a_run_swarm",
+    "gather_usage_summary",
+    "initiate_chats",
+    "initiate_group_chat",
+    "register_function",
+    "run_group_chat",
+    "run_swarm",
+]

autogen/agentchat/agent.py

@@ -0,0 +1,180 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# Portions derived from  https://github.com/microsoft/autogen are under the MIT License.
+# SPDX-License-Identifier: MIT
+from typing import TYPE_CHECKING, Any, Optional, Protocol, TypeVar, runtime_checkable
+
+from ..doc_utils import export_module
+
+__all__ = ["Agent", "LLMAgent", "LLMMessageType"]
+
+Tool = TypeVar("Tool")
+
+LLMMessageType = dict[str, Any]
+
+DEFAULT_SUMMARY_METHOD = "last_msg"
+
+
+@runtime_checkable
+@export_module("autogen")
+class Agent(Protocol):
+    """(In preview) A protocol for Agent.
+
+    An agent can communicate with other agents and perform actions.
+    Different agents can differ in what actions they perform in the `receive` method.
+    """
+
+    @property
+    def name(self) -> str:
+        """The name of the agent."""
+        ...
+
+    @property
+    def description(self) -> str:
+        """The description of the agent. Used for the agent's introduction in
+        a group chat setting.
+        """
+        ...
+
+    def send(
+        self,
+        message: dict[str, Any] | str,
+        recipient: "Agent",
+        request_reply: bool | None = None,
+    ) -> None:
+        """Send a message to another agent.
+
+        Args:
+            message (dict or str): the message to send. If a dict, it should be
+                a JSON-serializable and follows the OpenAI's ChatCompletion schema.
+            recipient (Agent): the recipient of the message.
+            request_reply (bool): whether to request a reply from the recipient.
+        """
+        ...
+
+    async def a_send(
+        self,
+        message: dict[str, Any] | str,
+        recipient: "Agent",
+        request_reply: bool | None = None,
+    ) -> None:
+        """(Async) Send a message to another agent.
+
+        Args:
+            message (dict or str): the message to send. If a dict, it should be
+                a JSON-serializable and follows the OpenAI's ChatCompletion schema.
+            recipient (Agent): the recipient of the message.
+            request_reply (bool): whether to request a reply from the recipient.
+        """
+        ...
+
+    def receive(
+        self,
+        message: dict[str, Any] | str,
+        sender: "Agent",
+        request_reply: bool | None = None,
+    ) -> None:
+        """Receive a message from another agent.
+
+        Args:
+            message (dict or str): the message received. If a dict, it should be
+                a JSON-serializable and follows the OpenAI's ChatCompletion schema.
+            sender (Agent): the sender of the message.
+            request_reply (bool): whether the sender requests a reply.
+        """
+
+    async def a_receive(
+        self,
+        message: dict[str, Any] | str,
+        sender: "Agent",
+        request_reply: bool | None = None,
+    ) -> None:
+        """(Async) Receive a message from another agent.
+
+        Args:
+            message (dict or str): the message received. If a dict, it should be
+                a JSON-serializable and follows the OpenAI's ChatCompletion schema.
+            sender (Agent): the sender of the message.
+            request_reply (bool): whether the sender requests a reply.
+        """
+        ...
+
+    def generate_reply(
+        self,
+        messages: list[dict[str, Any]] | None = None,
+        sender: Optional["Agent"] = None,
+    ) -> str | dict[str, Any] | None:
+        """Generate a reply based on the received messages.
+
+        Args:
+            messages (list[dict[str, Any]]): a list of messages received from other agents.
+                The messages are dictionaries that are JSON-serializable and
+                follows the OpenAI's ChatCompletion schema.
+            sender: sender of an Agent instance.
+            **kwargs: Additional keyword arguments.
+
+        Returns:
+            str or dict or None: the generated reply. If None, no reply is generated.
+        """
+
+    async def a_generate_reply(
+        self,
+        messages: list[dict[str, Any]] | None = None,
+        sender: Optional["Agent"] = None,
+    ) -> str | dict[str, Any] | None:
+        """(Async) Generate a reply based on the received messages.
+
+        Args:
+            messages (list[dict[str, Any]]): a list of messages received from other agents.
+                The messages are dictionaries that are JSON-serializable and
+                follows the OpenAI's ChatCompletion schema.
+            sender: sender of an Agent instance.
+            **kwargs: Additional keyword arguments.
+
+        Returns:
+            str or dict or None: the generated reply. If None, no reply is generated.
+        """
+        ...
+
+    def set_ui_tools(self, tools: list[Tool]) -> None:
+        """Set the UI tools for the agent.
+
+        Args:
+            tools: a list of UI tools to set.
+        """
+        ...
+
+    def unset_ui_tools(self, tools: list[Tool]) -> None:
+        """Unset the UI tools for the agent.
+
+        Args:
+            tools: a list of UI tools to set.
+        """
+        ...
+
+
+@runtime_checkable
+@export_module("autogen")
+class LLMAgent(Agent, Protocol):
+    """(In preview) A protocol for an LLM agent."""
+
+    @property
+    def system_message(self) -> str:
+        """The system message of this agent."""
+
+    def update_system_message(self, system_message: str) -> None:
+        """Update this agent's system message.
+
+        Args:
+            system_message (str): system message for inference.
+        """
+
+
+if TYPE_CHECKING:
+    # mypy will fail if Conversable agent does not implement Agent protocol
+    from .conversable_agent import ConversableAgent
+
+    def _check_protocol_implementation(agent: ConversableAgent) -> Agent:
+        return agent

autogen/agentchat/assistant_agent.py

@@ -0,0 +1,86 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+# Portions derived from  https://github.com/microsoft/autogen are under the MIT License.
+# SPDX-License-Identifier: MIT
+from collections.abc import Callable
+from typing import Any, Literal
+
+from ..doc_utils import export_module
+from ..llm_config import LLMConfig
+from ..runtime_logging import log_new_agent, logging_enabled
+from .conversable_agent import ConversableAgent
+
+
+@export_module("autogen")
+class AssistantAgent(ConversableAgent):
+    """(In preview) Assistant agent, designed to solve a task with LLM.
+
+    AssistantAgent is a subclass of ConversableAgent configured with a default system message.
+    The default system message is designed to solve a task with LLM,
+    including suggesting python code blocks and debugging. \n
+    `human_input_mode` is default to "NEVER" \n
+    and `code_execution_config` is default to False. \n
+    This agent doesn't execute code by default, and expects the user to execute the code. \n
+    """
+
+    DEFAULT_SYSTEM_MESSAGE = """You are a helpful AI assistant.
+Solve tasks using your coding and language skills.
+In the following cases, suggest python code (in a python coding block) or shell script (in a sh coding block) for the user to execute.
+    1. When you need to collect info, use the code to output the info you need, for example, browse or search the web, download/read a file, print the content of a webpage or a file, get the current date/time, check the operating system. After sufficient info is printed and the task is ready to be solved based on your language skill, you can solve the task by yourself.
+    2. When you need to perform some task with code, use the code to perform the task and output the result. Finish the task smartly.
+Solve the task step by step if you need to. If a plan is not provided, explain your plan first. Be clear which step uses code, and which step uses your language skill.
+When using code, you must indicate the script type in the code block. The user cannot provide any other feedback or perform any other action beyond executing the code you suggest. The user can't modify your code. So do not suggest incomplete code which requires users to modify. Don't use a code block if it's not intended to be executed by the user.
+If you want the user to save the code in a file before executing it, put # filename: <filename> inside the code block as the first line. Don't include multiple code blocks in one response. Do not ask users to copy and paste the result. Instead, use 'print' function for the output when relevant. Check the execution result returned by the user.
+If the result indicates there is an error, fix the error and output the code again. Suggest the full code instead of partial code or code changes. If the error can't be fixed or if the task is not solved even after the code is executed successfully, analyze the problem, revisit your assumption, collect additional info you need, and think of a different approach to try.
+When you find an answer, verify the answer carefully. Include verifiable evidence in your response if possible.
+Reply "TERMINATE" in the end when everything is done.
+    """
+
+    DEFAULT_DESCRIPTION = "A helpful and general-purpose AI assistant that has strong language skills, Python skills, and Linux command line skills."
+
+    def __init__(
+        self,
+        name: str,
+        system_message: str | None = DEFAULT_SYSTEM_MESSAGE,
+        llm_config: LLMConfig | dict[str, Any] | Literal[False] | None = None,
+        is_termination_msg: Callable[[dict[str, Any]], bool] | None = None,
+        max_consecutive_auto_reply: int | None = None,
+        human_input_mode: Literal["ALWAYS", "NEVER", "TERMINATE"] = "NEVER",
+        description: str | None = None,
+        **kwargs: Any,
+    ):
+        """Args:
+        - name (str): agent name. \n
+        - system_message (str): system message for the ChatCompletion inference. \n
+            Please override this attribute if you want to reprogram the agent.
+        - llm_config (dict or False or None): llm inference configuration. \n
+            Please refer to [OpenAIWrapper.create](https://docs.ag2.ai/latest/docs/api-reference/autogen/OpenAIWrapper/#autogen.OpenAIWrapper.create) \n
+            for available options. \n
+        - is_termination_msg (function): a function that takes a message in the form of a dictionary
+            and returns a boolean value indicating if this received message is a termination message.
+            The dict can contain the following keys: "content", "role", "name", "function_call". \n
+        - max_consecutive_auto_reply (int): the maximum number of consecutive auto replies.
+            default to None (no limit provided, class attribute MAX_CONSECUTIVE_AUTO_REPLY will be used as the limit in this case).
+            The limit only plays a role when human_input_mode is not "ALWAYS". \n
+        - **kwargs (dict): Please refer to other kwargs in
+            [ConversableAgent](https://docs.ag2.ai/latest/docs/api-reference/autogen/ConversableAgent). \n
+        """
+        super().__init__(
+            name,
+            system_message,
+            is_termination_msg,
+            max_consecutive_auto_reply,
+            human_input_mode,
+            llm_config=llm_config,
+            description=description,
+            **kwargs,
+        )
+        if logging_enabled():
+            log_new_agent(self, locals())
+
+        # Update the provided description if None, and we are using the default system_message,
+        # then use the default description.
+        if description is None and system_message == self.DEFAULT_SYSTEM_MESSAGE:
+            self.description = self.DEFAULT_DESCRIPTION