ag2 0.10.2__py3-none-any.whl

autogen/io/run_response.py

@@ -0,0 +1,294 @@
+# 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
+
+import queue
+from asyncio import Queue as AsyncQueue
+from collections.abc import AsyncIterable, Iterable, Sequence
+from typing import Any, Optional, Protocol
+from uuid import UUID, uuid4
+
+from pydantic import BaseModel, Field
+
+from autogen.tools.tool import Tool
+
+from ..agentchat.agent import Agent, LLMMessageType
+from ..agentchat.group.context_variables import ContextVariables
+from ..events.agent_events import ErrorEvent, InputRequestEvent, RunCompletionEvent
+from ..events.base_event import BaseEvent
+from .processors import (
+    AsyncConsoleEventProcessor,
+    AsyncEventProcessorProtocol,
+    ConsoleEventProcessor,
+    EventProcessorProtocol,
+)
+from .thread_io_stream import AsyncThreadIOStream, ThreadIOStream
+
+Message = dict[str, Any]
+
+
+class RunInfoProtocol(Protocol):
+    @property
+    def uuid(self) -> UUID: ...
+
+    @property
+    def above_run(self) -> Optional["RunResponseProtocol"]: ...
+
+
+class Usage(BaseModel):
+    cost: float
+    prompt_tokens: int
+    completion_tokens: int
+    total_tokens: int
+
+
+class CostBreakdown(BaseModel):
+    total_cost: float
+    models: dict[str, Usage] = Field(default_factory=dict)
+
+    @classmethod
+    def from_raw(cls, data: dict[str, Any]) -> "CostBreakdown":
+        # Extract total cost
+        total_cost = data.get("total_cost", 0.0)
+
+        # Remove total_cost key to extract models
+        model_usages = {k: Usage(**v) for k, v in data.items() if k != "total_cost"}
+
+        return cls(total_cost=total_cost, models=model_usages)
+
+
+class Cost(BaseModel):
+    usage_including_cached_inference: CostBreakdown
+    usage_excluding_cached_inference: CostBreakdown
+
+    @classmethod
+    def from_raw(cls, data: dict[str, Any]) -> "Cost":
+        return cls(
+            usage_including_cached_inference=CostBreakdown.from_raw(data.get("usage_including_cached_inference", {})),
+            usage_excluding_cached_inference=CostBreakdown.from_raw(data.get("usage_excluding_cached_inference", {})),
+        )
+
+
+class RunResponseProtocol(RunInfoProtocol, Protocol):
+    @property
+    def events(self) -> Iterable[BaseEvent]: ...
+
+    @property
+    def messages(self) -> Iterable[Message]: ...
+
+    @property
+    def summary(self) -> str | None: ...
+
+    @property
+    def context_variables(self) -> ContextVariables | None: ...
+
+    @property
+    def last_speaker(self) -> str | None: ...
+
+    @property
+    def cost(self) -> Cost | None: ...
+
+    def process(self, processor: EventProcessorProtocol | None = None) -> None: ...
+
+    def set_ui_tools(self, tools: list[Tool]) -> None: ...
+
+
+class AsyncRunResponseProtocol(RunInfoProtocol, Protocol):
+    @property
+    def events(self) -> AsyncIterable[BaseEvent]: ...
+
+    @property
+    async def messages(self) -> Iterable[Message]: ...
+
+    @property
+    async def summary(self) -> str | None: ...
+
+    @property
+    async def context_variables(self) -> ContextVariables | None: ...
+
+    @property
+    async def last_speaker(self) -> str | None: ...
+
+    @property
+    async def cost(self) -> Cost | None: ...
+
+    async def process(self, processor: AsyncEventProcessorProtocol | None = None) -> None: ...
+
+    def set_ui_tools(self, tools: list[Tool]) -> None: ...
+
+
+class RunResponse:
+    def __init__(self, iostream: ThreadIOStream, agents: list[Agent]):
+        self.iostream = iostream
+        self.agents = agents
+        self._summary: str | None = None
+        self._messages: Sequence[LLMMessageType] = []
+        self._uuid = uuid4()
+        self._context_variables: ContextVariables | None = None
+        self._last_speaker: str | None = None
+        self._cost: Cost | None = None
+
+    def _queue_generator(self, q: queue.Queue) -> Iterable[BaseEvent]:  # type: ignore[type-arg]
+        """A generator to yield items from the queue until the termination message is found."""
+        while True:
+            try:
+                # Get an item from the queue
+                event = q.get(timeout=0.1)  # Adjust timeout as needed
+
+                if isinstance(event, InputRequestEvent):
+                    event.content.respond = lambda response: self.iostream._output_stream.put(response)  # type: ignore[attr-defined]
+
+                yield event
+
+                if isinstance(event, RunCompletionEvent):
+                    self._messages = event.content.history  # type: ignore[attr-defined]
+                    self._last_speaker = event.content.last_speaker  # type: ignore[attr-defined]
+                    self._summary = event.content.summary  # type: ignore[attr-defined]
+                    self._context_variables = event.content.context_variables  # type: ignore[attr-defined]
+                    self.cost = event.content.cost  # type: ignore[attr-defined]
+                    break
+
+                if isinstance(event, ErrorEvent):
+                    raise event.content.error  # type: ignore[attr-defined]
+            except queue.Empty:
+                continue  # Wait for more items in the queue
+
+    @property
+    def events(self) -> Iterable[BaseEvent]:
+        return self._queue_generator(self.iostream.input_stream)
+
+    @property
+    def messages(self) -> Iterable[Message]:
+        return self._messages
+
+    @property
+    def summary(self) -> str | None:
+        return self._summary
+
+    @property
+    def above_run(self) -> Optional["RunResponseProtocol"]:
+        return None
+
+    @property
+    def uuid(self) -> UUID:
+        return self._uuid
+
+    @property
+    def context_variables(self) -> ContextVariables | None:
+        return self._context_variables
+
+    @property
+    def last_speaker(self) -> str | None:
+        return self._last_speaker
+
+    @property
+    def cost(self) -> Cost | None:
+        return self._cost
+
+    @cost.setter
+    def cost(self, value: Cost | dict[str, Any]) -> None:
+        if isinstance(value, dict):
+            self._cost = Cost.from_raw(value)
+        else:
+            self._cost = value
+
+    def process(self, processor: EventProcessorProtocol | None = None) -> None:
+        processor = processor or ConsoleEventProcessor()
+        processor.process(self)
+
+    def set_ui_tools(self, tools: list[Tool]) -> None:
+        """Set the UI tools for the agents."""
+        for agent in self.agents:
+            agent.set_ui_tools(tools)
+
+
+class AsyncRunResponse:
+    def __init__(self, iostream: AsyncThreadIOStream, agents: list[Agent]):
+        self.iostream = iostream
+        self.agents = agents
+        self._summary: str | None = None
+        self._messages: Sequence[LLMMessageType] = []
+        self._uuid = uuid4()
+        self._context_variables: ContextVariables | None = None
+        self._last_speaker: str | None = None
+        self._cost: Cost | None = None
+
+    async def _queue_generator(self, q: AsyncQueue[Any]) -> AsyncIterable[BaseEvent]:  # type: ignore[type-arg]
+        """A generator to yield items from the queue until the termination message is found."""
+        while True:
+            try:
+                # Get an item from the queue
+                event = await q.get()
+
+                if isinstance(event, InputRequestEvent):
+
+                    async def respond(response: str) -> None:
+                        await self.iostream._output_stream.put(response)
+
+                    event.content.respond = respond  # type: ignore[attr-defined]
+
+                yield event
+
+                if isinstance(event, RunCompletionEvent):
+                    self._messages = event.content.history  # type: ignore[attr-defined]
+                    self._last_speaker = event.content.last_speaker  # type: ignore[attr-defined]
+                    self._summary = event.content.summary  # type: ignore[attr-defined]
+                    self._context_variables = event.content.context_variables  # type: ignore[attr-defined]
+                    self.cost = event.content.cost  # type: ignore[attr-defined]
+                    break
+
+                if isinstance(event, ErrorEvent):
+                    raise event.content.error  # type: ignore[attr-defined]
+            except queue.Empty:
+                continue
+
+    @property
+    def events(self) -> AsyncIterable[BaseEvent]:
+        return self._queue_generator(self.iostream.input_stream)
+
+    @property
+    async def messages(self) -> Iterable[Message]:
+        return self._messages
+
+    @property
+    async def summary(self) -> str | None:
+        return self._summary
+
+    @property
+    def above_run(self) -> Optional["RunResponseProtocol"]:
+        return None
+
+    @property
+    def uuid(self) -> UUID:
+        return self._uuid
+
+    @property
+    async def context_variables(self) -> ContextVariables | None:
+        return self._context_variables
+
+    @property
+    async def last_speaker(self) -> str | None:
+        return self._last_speaker
+
+    @property
+    async def cost(self) -> Cost | None:
+        return self._cost
+
+    @cost.setter
+    def cost(self, value: Cost | dict[str, Any]) -> None:
+        if isinstance(value, dict):
+            self._cost = Cost.from_raw(value)
+        else:
+            self._cost = value
+
+    async def process(self, processor: AsyncEventProcessorProtocol | None = None) -> None:
+        processor = processor or AsyncConsoleEventProcessor()
+        await processor.process(self)
+
+    def set_ui_tools(self, tools: list[Tool]) -> None:
+        """Set the UI tools for the agents."""
+        for agent in self.agents:
+            agent.set_ui_tools(tools)

autogen/io/thread_io_stream.py

@@ -0,0 +1,63 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import queue
+from asyncio import Queue as AsyncQueue
+from typing import TYPE_CHECKING, Any
+
+from autogen.io.base import AsyncIOStreamProtocol, IOStreamProtocol
+
+from ..events.agent_events import InputRequestEvent
+from ..events.print_event import PrintEvent
+
+
+class ThreadIOStream:
+    def __init__(self) -> None:
+        self._input_stream: queue.Queue = queue.Queue()  # type: ignore[type-arg]
+        self._output_stream: queue.Queue = queue.Queue()  # type: ignore[type-arg]
+
+    def input(self, prompt: str = "", *, password: bool = False) -> str:
+        self.send(InputRequestEvent(prompt=prompt, password=password))  # type: ignore[call-arg]
+        return self._output_stream.get()  # type: ignore[no-any-return]
+
+    def print(self, *objects: Any, sep: str = " ", end: str = "\n", flush: bool = False) -> None:
+        print_message = PrintEvent(*objects, sep=sep, end=end)
+        self.send(print_message)
+
+    def send(self, message: Any) -> None:
+        self._input_stream.put(message)
+
+    @property
+    def input_stream(self) -> queue.Queue:  # type: ignore[type-arg]
+        return self._input_stream
+
+
+class AsyncThreadIOStream:
+    def __init__(self) -> None:
+        self._input_stream: AsyncQueue = AsyncQueue()  # type: ignore[type-arg]
+        self._output_stream: AsyncQueue = AsyncQueue()  # type: ignore[type-arg]
+
+    async def input(self, prompt: str = "", *, password: bool = False) -> str:
+        self.send(InputRequestEvent(prompt=prompt, password=password))  # type: ignore[call-arg]
+        return await self._output_stream.get()  # type: ignore[no-any-return]
+
+    def print(self, *objects: Any, sep: str = " ", end: str = "\n", flush: bool = False) -> None:
+        print_message = PrintEvent(*objects, sep=sep, end=end)
+        self.send(print_message)
+
+    def send(self, message: Any) -> None:
+        self._input_stream.put_nowait(message)
+
+    @property
+    def input_stream(self) -> AsyncQueue[Any]:
+        return self._input_stream
+
+
+if TYPE_CHECKING:
+
+    def check_type_1(x: ThreadIOStream) -> IOStreamProtocol:
+        return x
+
+    def check_type_2(x: AsyncThreadIOStream) -> AsyncIOStreamProtocol:
+        return x

autogen/io/websockets.py

@@ -0,0 +1,214 @@
+# 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
+import logging
+import ssl
+import threading
+from collections.abc import Callable, Iterable, Iterator
+from contextlib import contextmanager
+from functools import partial
+from time import sleep
+from typing import Any, Protocol
+
+from ..doc_utils import export_module
+from ..events.base_event import BaseEvent
+from ..events.print_event import PrintEvent
+from ..import_utils import optional_import_block, require_optional_import
+from .base import IOStream
+
+# Check if the websockets module is available
+with optional_import_block():
+    from websockets.sync.server import serve as ws_serve
+
+__all__ = ("IOWebsockets",)
+
+
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.INFO)
+
+# The following type and protocols are used to define the ServerConnection and WebSocketServer classes
+# if websockets is not installed, they would be untyped
+Data = str | bytes
+
+
+class ServerConnection(Protocol):
+    def send(self, message: Data | Iterable[Data]) -> None:
+        """Send a message to the client.
+
+        Args:
+            message (Union[Data, Iterable[Data]]): The message to send.
+
+        """
+        ...  # pragma: no cover
+
+    def recv(self, timeout: float | None = None) -> Data:
+        """Receive a message from the client.
+
+        Args:
+            timeout (Optional[float], optional): The timeout for the receive operation. Defaults to None.
+
+        Returns:
+            Data: The message received from the client.
+
+        """
+        ...  # pragma: no cover
+
+    def close(self) -> None:
+        """Close the connection."""
+        ...
+
+
+class WebSocketServer(Protocol):
+    def serve_forever(self) -> None:
+        """Run the server forever."""
+        ...  # pragma: no cover
+
+    def shutdown(self) -> None:
+        """Shutdown the server."""
+        ...  # pragma: no cover
+
+    def __enter__(self) -> "WebSocketServer":
+        """Enter the server context."""
+        ...  # pragma: no cover
+
+    def __exit__(self, exc_type: Any, exc_value: Any, traceback: Any) -> None:
+        """Exit the server context."""
+        ...  # pragma: no cover
+
+
+@require_optional_import("websockets", "websockets")
+@export_module("autogen.io")
+class IOWebsockets(IOStream):
+    """A websocket input/output stream."""
+
+    def __init__(self, websocket: ServerConnection) -> None:
+        """Initialize the websocket input/output stream.
+
+        Args:
+            websocket (ServerConnection): The websocket server.
+        """
+        self._websocket = websocket
+
+    @staticmethod
+    def _handler(websocket: ServerConnection, on_connect: Callable[["IOWebsockets"], None]) -> None:
+        """The handler function for the websocket server."""
+        logger.info(f" - IOWebsockets._handler(): Client connected on {websocket}")
+        # create a new IOWebsockets instance using the websocket that is create when a client connects
+        try:
+            iowebsocket = IOWebsockets(websocket)
+            with IOStream.set_default(iowebsocket):
+                # call the on_connect function
+                try:
+                    on_connect(iowebsocket)
+                except Exception as e:
+                    logger.warning(f" - IOWebsockets._handler(): Error in on_connect: {e}")
+        except Exception as e:
+            logger.error(f" - IOWebsockets._handler(): Unexpected error in IOWebsockets: {e}")
+
+    @staticmethod
+    @contextmanager
+    def run_server_in_thread(
+        *,
+        host: str = "127.0.0.1",
+        port: int = 8765,
+        on_connect: Callable[["IOWebsockets"], None],
+        ssl_context: ssl.SSLContext | None = None,
+        **kwargs: Any,
+    ) -> Iterator[str]:
+        """Factory function to create a websocket input/output stream.
+
+        Args:
+            host (str, optional): The host to bind the server to. Defaults to "127.0.0.1".
+            port (int, optional): The port to bind the server to. Defaults to 8765.
+            on_connect (Callable[[IOWebsockets], None]): The function to be executed on client connection. Typically creates agents and initiate chat.
+            ssl_context (Optional[ssl.SSLContext], optional): The SSL context to use for secure connections. Defaults to None.
+            kwargs (Any): Additional keyword arguments to pass to the websocket server.
+
+        Yields:
+            str: The URI of the websocket server.
+        """
+        server_dict: dict[str, WebSocketServer] = {}
+
+        def _run_server() -> None:
+            # print(f" - _run_server(): starting server on ws://{host}:{port}", flush=True)
+            with ws_serve(
+                handler=partial(IOWebsockets._handler, on_connect=on_connect),
+                host=host,
+                port=port,
+                ssl_context=ssl_context,
+                **kwargs,
+            ) as server:
+                # print(f" - _run_server(): server {server} started on ws://{host}:{port}", flush=True)
+
+                server_dict["server"] = server
+
+                # runs until the server is shutdown
+                server.serve_forever()
+
+                return
+
+        # start server in a separate thread
+        thread = threading.Thread(target=_run_server)
+        thread.start()
+        try:
+            while "server" not in server_dict:
+                sleep(0.1)
+
+            yield f"ws://{host}:{port}"
+
+        finally:
+            # print(f" - run_server_in_thread(): shutting down server on ws://{host}:{port}", flush=True)
+            # gracefully stop server
+            if "server" in server_dict:
+                # print(f" - run_server_in_thread(): shutting down server {server_dict['server']}", flush=True)
+                server_dict["server"].shutdown()
+
+            # wait for the thread to stop
+            if thread:
+                thread.join()
+
+    @property
+    def websocket(self) -> "ServerConnection":
+        """The URI of the websocket server."""
+        return self._websocket
+
+    def print(self, *objects: Any, sep: str = " ", end: str = "\n", flush: bool = False) -> None:
+        """Print data to the output stream.
+
+        Args:
+            objects (any): The data to print.
+            sep (str, optional): The separator between objects. Defaults to " ".
+            end (str, optional): The end of the output. Defaults to "\n".
+            flush (bool, optional): Whether to flush the output. Defaults to False.
+        """
+        print_message = PrintEvent(*objects, sep=sep, end=end)
+        self.send(print_message)
+
+    def send(self, message: BaseEvent) -> None:
+        """Send a message to the output stream.
+
+        Args:
+            message (Any): The message to send.
+        """
+        self._websocket.send(message.model_dump_json())
+
+    def input(self, prompt: str = "", *, password: bool = False) -> str:
+        """Read a line from the input stream.
+
+        Args:
+            prompt (str, optional): The prompt to display. Defaults to "".
+            password (bool, optional): Whether to read a password. Defaults to False.
+
+        Returns:
+            str: The line read from the input stream.
+
+        """
+        if prompt != "":
+            self._websocket.send(prompt)
+
+        msg = self._websocket.recv()
+
+        return msg.decode("utf-8") if isinstance(msg, bytes) else msg

autogen/json_utils.py

@@ -0,0 +1,42 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+from typing import Any
+
+from .import_utils import optional_import_block, require_optional_import
+
+with optional_import_block():
+    from jsonschema import Draft7Validator, RefResolver
+
+__all__ = ["resolve_json_references"]
+
+
+@require_optional_import("jsonschema", "gemini")
+def resolve_json_references(schema: dict[str, Any]) -> dict[str, Any]:
+    """Resolve JSON references in the given schema.
+
+    Args:
+        schema (dict): The JSON schema with references.
+
+    Returns:
+        dict: The JSON schema with resolved references.
+    """
+    resolver = RefResolver.from_schema(schema)
+    validator = Draft7Validator(schema, resolver=resolver)
+    resolved_schema = validator.schema
+
+    def resolve_refs(node: Any) -> Any:
+        if isinstance(node, dict):
+            if "$ref" in node:
+                ref = node["$ref"]
+                with resolver.resolving(ref) as resolved:
+                    return resolve_refs(resolved)
+            else:
+                return {k: resolve_refs(v) for k, v in node.items()}
+        elif isinstance(node, list):
+            return [resolve_refs(item) for item in node]
+        else:
+            return node
+
+    return resolve_refs(resolved_schema)  # type: ignore[no-any-return]