A programming framework for agentic AI
Notebook checks (#333)
Jack Gerrits33649c3e08fe
diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.ymlindex 9101fe646..0ec8ed4fa 100644--- a/.github/workflows/checks.yml+++ b/.github/workflows/checks.yml@@ -87,6 +87,15 @@ jobs:hatch run +python=${{ matrix.python-version }} teamone-test-matrix:pytest -n autoworking-directory: ./python/teams/team-one+ mypy-notebooks:+ runs-on: ubuntu-latest+ steps:+ - uses: actions/checkout@v4+ - name: Install Hatch+ uses: pypa/hatch@install+ - run: hatch run nbqa mypy docs/src+ working-directory: ./python+docs:runs-on: ubuntu-lateststeps:diff --git a/python/docs/src/cookbook/langgraph-agent.ipynb b/python/docs/src/cookbook/langgraph-agent.ipynbindex aef3b09cb..f3f90cff4 100644--- a/python/docs/src/cookbook/langgraph-agent.ipynb+++ b/python/docs/src/cookbook/langgraph-agent.ipynb@@ -201,10 +201,10 @@" \"Tool use agent\",\n"," ChatOpenAI(\n"," model=\"gpt-4o\",\n",- " api_key=os.getenv(\"OPENAI_API_KEY\"),\n",+ " # api_key=os.getenv(\"OPENAI_API_KEY\"),\n"," ),\n"," # AzureChatOpenAI(\n",- " # azure_deployment=os.getenv(\"AZURE_OPENAI_DEPLOYMENT\"), \n",+ " # azure_deployment=os.getenv(\"AZURE_OPENAI_DEPLOYMENT\"),\n"," # azure_endpoint=os.getenv(\"AZURE_OPENAI_ENDPOINT\"),\n"," # api_version=os.getenv(\"AZURE_OPENAI_API_VERSION\"),\n"," # # Using Azure Active Directory authentication.\n",diff --git a/python/docs/src/getting-started/agent-and-agent-runtime.ipynb b/python/docs/src/getting-started/agent-and-agent-runtime.ipynbindex 2edfdf642..f5c7819cc 100644--- a/python/docs/src/getting-started/agent-and-agent-runtime.ipynb+++ b/python/docs/src/getting-started/agent-and-agent-runtime.ipynb@@ -58,13 +58,15 @@"from dataclasses import dataclass\n","from agnext.core import BaseAgent, CancellationToken\n","\n",+ "\n","@dataclass\n","class MyMessage:\n"," content: str\n","\n",+ "\n","class MyAgent(BaseAgent):\n",- " def __init__(self):\n",- " super().__init__(\"MyAgent\", subscriptions=[MyMessage])\n",+ " def __init__(self) -> None:\n",+ " super().__init__(\"MyAgent\", subscriptions=[\"MyMessage\"])\n","\n"," async def on_message(self, message: MyMessage, cancellation_token: CancellationToken) -> None:\n"," print(f\"Received message: {message.content}\")"@@ -131,9 +133,9 @@],"source": ["agent_id = await runtime.get(\"my_agent\")\n",- "run_context = runtime.start() # Start processing messages in the background.\n",+ "run_context = runtime.start() # Start processing messages in the background.\n","await runtime.send_message(MyMessage(content=\"Hello, World!\"), agent_id)\n",- "await run_context.stop() # Stop processing messages in the background."+ "await run_context.stop() # Stop processing messages in the background."]},{@@ -173,7 +175,7 @@"source": ["run_context = runtime.start()\n","# ... Send messages, publish messages, etc.\n",- "await run_context.stop() # This will return immediately but will not cancel\n",+ "await run_context.stop() # This will return immediately but will not cancel\n","# any in-progress message handling."]},@@ -198,7 +200,7 @@"source": ["run_context = runtime.start()\n","# ... Send messages, publish messages, etc.\n",- "await run_context.stop_when_idle() # This will block until the runtime is idle."+ "await run_context.stop_when_idle() # This will block until the runtime is idle."]},{diff --git a/python/docs/src/getting-started/message-and-communication.ipynb b/python/docs/src/getting-started/message-and-communication.ipynbindex 84f7e84f0..d1339dc70 100644--- a/python/docs/src/getting-started/message-and-communication.ipynb+++ b/python/docs/src/getting-started/message-and-communication.ipynb@@ -33,11 +33,13 @@"source": ["from dataclasses import dataclass\n","\n",+ "\n","@dataclass\n","class TextMessage:\n"," content: str\n"," source: str\n","\n",+ "\n","@dataclass\n","class ImageMessage:\n"," url: str\n",@@ -83,6 +85,7 @@"from agnext.components import TypeRoutedAgent, message_handler\n","from agnext.core import CancellationToken\n","\n",+ "\n","class MyAgent(TypeRoutedAgent):\n"," @message_handler\n"," async def on_text_message(self, message: TextMessage, cancellation_token: CancellationToken) -> None:\n",@@ -183,15 +186,18 @@"from agnext.components import TypeRoutedAgent, message_handler\n","from agnext.core import CancellationToken, AgentId\n","\n",+ "\n","@dataclass\n","class Message:\n"," content: str\n","\n",+ "\n","class InnerAgent(TypeRoutedAgent):\n"," @message_handler\n"," async def on_my_message(self, message: Message, cancellation_token: CancellationToken) -> Message:\n"," return Message(content=f\"Hello from inner, {message.content}\")\n","\n",+ "\n","class OuterAgent(TypeRoutedAgent):\n"," def __init__(self, description: str, inner_agent_id: AgentId):\n"," super().__init__(description)\n",@@ -289,12 +295,14 @@"from agnext.components import TypeRoutedAgent, message_handler\n","from agnext.core import CancellationToken\n","\n",+ "\n","class BroadcastingAgent(TypeRoutedAgent):\n"," @message_handler\n"," async def on_my_message(self, message: Message, cancellation_token: CancellationToken) -> None:\n"," # Publish a message to all agents in the same namespace.\n"," await self.publish_message(Message(f\"Publishing a message: {message.content}!\"))\n","\n",+ "\n","class ReceivingAgent(TypeRoutedAgent):\n"," @message_handler\n"," async def on_my_message(self, message: Message, cancellation_token: CancellationToken) -> None:\n",diff --git a/python/docs/src/getting-started/model-clients.ipynb b/python/docs/src/getting-started/model-clients.ipynbindex 13ab4e090..54b388e4b 100644--- a/python/docs/src/getting-started/model-clients.ipynb+++ b/python/docs/src/getting-started/model-clients.ipynb@@ -120,7 +120,7 @@"\n","# Iterate over the stream and print the responses.\n","print(\"Streamed responses:\")\n",- "async for response in stream:\n",+ "async for response in stream: # type: ignore\n"," if isinstance(response, str):\n"," # A partial response is a string.\n"," print(response, flush=True, end=\"\")\n",@@ -184,21 +184,19 @@"from azure.identity import DefaultAzureCredential, get_bearer_token_provider\n","\n","# Create the token provider\n",- "token_provider = get_bearer_token_provider(\n",- " DefaultAzureCredential(), \"https://cognitiveservices.azure.com/.default\"\n",- ")\n",+ "token_provider = get_bearer_token_provider(DefaultAzureCredential(), \"https://cognitiveservices.azure.com/.default\")\n","\n",- "model_client = AzureOpenAIChatCompletionClient(\n",+ "az_model_client = AzureOpenAIChatCompletionClient(\n"," model=\"{your-azure-deployment}\",\n"," api_version=\"2024-06-01\",\n"," azure_endpoint=\"https://{your-custom-endpoint}.openai.azure.com/\",\n",- " azure_ad_token_provider=token_provider, # Optional if you choose key-based authentication.\n",+ " azure_ad_token_provider=token_provider, # Optional if you choose key-based authentication.\n"," # api_key=\"sk-...\", # For key-based authentication.\n"," model_capabilities={\n",- " \"vision\":True,\n",- " \"function_calling\":True,\n",- " \"json_output\":True,\n",- " }\n",+ " \"vision\": True,\n",+ " \"function_calling\": True,\n",+ " \"json_output\": True,\n",+ " },\n",")"]},@@ -232,23 +230,27 @@"from agnext.components.models import ChatCompletionClient, SystemMessage, UserMessage, OpenAIChatCompletionClient\n","from agnext.core import CancellationToken\n","\n",+ "\n","@dataclass\n","class Message:\n"," content: str\n","\n",- "class SimpleAgent(TypeRoutedAgent):\n","\n",+ "class SimpleAgent(TypeRoutedAgent):\n"," def __init__(self, model_client: ChatCompletionClient) -> None:\n"," super().__init__(\"A simple agent\")\n"," self._system_messages = [SystemMessage(\"You are a helpful AI assistant.\")]\n"," self._model_client = model_client\n",- " \n",+ "\n"," @message_handler\n"," async def handle_user_message(self, message: Message, cancellation_token: CancellationToken) -> Message:\n"," # Prepare input to the chat completion model.\n"," user_message = UserMessage(content=message.content, source=\"user\")\n",- " response = await self._model_client.create(self._system_messages + [user_message], cancellation_token=cancellation_token)\n",+ " response = await self._model_client.create(\n",+ " self._system_messages + [user_message], cancellation_token=cancellation_token\n",+ " )\n"," # Return with the model's response.\n",+ " assert isinstance(response.content, str)\n"," return Message(content=response.content)"]},@@ -308,14 +310,16 @@}],"source": [- " # Create the runtime and register the agent.\n",+ "# Create the runtime and register the agent.\n","runtime = SingleThreadedAgentRuntime()\n","agent = await runtime.register_and_get(\n"," \"simple-agent\",\n",- " lambda: SimpleAgent(OpenAIChatCompletionClient(\n",- " model=\"gpt-4o-mini\",\n",- " # api_key=\"sk-...\", # Optional if you have an OPENAI_API_KEY set in the environment.\n",- " )), \n",+ " lambda: SimpleAgent(\n",+ " OpenAIChatCompletionClient(\n",+ " model=\"gpt-4o-mini\",\n",+ " # api_key=\"sk-...\", # Optional if you have an OPENAI_API_KEY set in the environment.\n",+ " )\n",+ " ),\n",")\n","# Start the runtime processing messages.\n","run_context = runtime.start()\n",diff --git a/python/docs/src/getting-started/multi-agent-design-patterns.ipynb b/python/docs/src/getting-started/multi-agent-design-patterns.ipynbindex ec503c05a..44cd54c2c 100644--- a/python/docs/src/getting-started/multi-agent-design-patterns.ipynb+++ b/python/docs/src/getting-started/multi-agent-design-patterns.ipynb@@ -63,6 +63,7 @@"source": ["from dataclasses import dataclass\n","\n",+ "\n","@dataclass\n","class CodeWritingTask:\n"," task: str\n",@@ -154,7 +155,7 @@"\n"," def __init__(self, model_client: ChatCompletionClient) -> None:\n"," super().__init__(\"A code writing agent.\")\n",- " self._system_messages = [\n",+ " self._system_messages: List[LLMMessage] = [\n"," SystemMessage(\n"," content=\"\"\"You are a proficient coder. You write code to solve problems.\n","Work with the reviewer to improve your code.\n",@@ -182,7 +183,7 @@" self._session_memory.setdefault(session_id, []).append(message)\n"," # Generate a response using the chat completion API.\n"," response = await self._model_client.create(\n",- " self._system_messages + [UserMessage(content=message.task, source=self.metadata[\"name\"])],\n",+ " self._system_messages + [UserMessage(content=message.task, source=self.metadata[\"type\"])],\n"," cancellation_token=cancellation_token,\n"," )\n"," assert isinstance(response.content, str)\n",@@ -296,7 +297,7 @@"\n"," def __init__(self, model_client: ChatCompletionClient) -> None:\n"," super().__init__(\"A code reviewer agent.\")\n",- " self._system_messages = [\n",+ " self._system_messages: List[LLMMessage] = [\n"," SystemMessage(\n"," content=\"\"\"You are a code reviewer. You focus on correctness, efficiency and safety of the code.\n","Respond using the following JSON format:\n",@@ -316,9 +317,15 @@" @message_handler\n"," async def handle_code_review_task(self, message: CodeReviewTask, cancellation_token: CancellationToken) -> None:\n"," # Format the prompt for the code review.\n",+ " # Gather the previous feedback if available.\n"," previous_feedback = \"\"\n"," if message.session_id in self._session_memory:\n",- " previous_feedback = self._session_memory[message.session_id][-1].review\n",+ " previous_review = next(\n",+ " (m for m in reversed(self._session_memory[message.session_id]) if isinstance(m, CodeReviewResult)),\n",+ " None,\n",+ " )\n",+ " if previous_review is not None:\n",+ " previous_feedback = previous_review.review\n"," # Store the messages in a temporary memory for this request only.\n"," self._session_memory.setdefault(message.session_id, []).append(message)\n"," prompt = f\"\"\"The problem statement is: {message.code_writing_task}\n",@@ -334,7 +341,7 @@"\"\"\"\n"," # Generate a response using the chat completion API.\n"," response = await self._model_client.create(\n",- " self._system_messages + [UserMessage(content=prompt, source=self.metadata[\"name\"])],\n",+ " self._system_messages + [UserMessage(content=prompt, source=self.metadata[\"type\"])],\n"," cancellation_token=cancellation_token,\n"," json_output=True,\n"," )\n",@@ -500,9 +507,7 @@")\n","run_context = runtime.start()\n","await runtime.publish_message(\n",- " message=CodeWritingTask(\n",- " task=\"Write a function to find the sum of all even numbers in a list.\"\n",- " ),\n",+ " message=CodeWritingTask(task=\"Write a function to find the sum of all even numbers in a list.\"),\n"," namespace=\"default\",\n",")\n","\n",diff --git a/python/docs/src/getting-started/tools.ipynb b/python/docs/src/getting-started/tools.ipynbindex b3f82d489..4ad4df813 100644--- a/python/docs/src/getting-started/tools.ipynb+++ b/python/docs/src/getting-started/tools.ipynb@@ -94,10 +94,12 @@"from agnext.components.tools import FunctionTool\n","from agnext.core import CancellationToken\n","\n",+ "\n","async def get_stock_price(ticker: str, date: Annotated[str, \"Date in YYYY/MM/DD\"]) -> float:\n"," # Returns a random stock price for demonstration purposes.\n"," return random.uniform(10, 200)\n","\n",+ "\n","# Create a function tool.\n","stock_price_tool = FunctionTool(get_stock_price, description=\"Get the stock price.\")\n","\n",@@ -141,6 +143,7 @@" OpenAIChatCompletionClient,\n"," SystemMessage,\n"," UserMessage,\n",+ " LLMMessage,\n",")\n","from agnext.components.tool_agent import ToolAgent, ToolException\n","from agnext.components.tools import FunctionTool, Tool, ToolSchema\n",@@ -155,7 +158,7 @@"class ToolUseAgent(TypeRoutedAgent):\n"," def __init__(self, model_client: ChatCompletionClient, tool_schema: List[ToolSchema], tool_agent: AgentId) -> None:\n"," super().__init__(\"An agent with tools\")\n",- " self._system_messages = [SystemMessage(\"You are a helpful AI assistant.\")]\n",+ " self._system_messages: List[LLMMessage] = [SystemMessage(\"You are a helpful AI assistant.\")]\n"," self._model_client = model_client\n"," self._tool_schema = tool_schema\n"," self._tool_agent = tool_agent\n",@@ -163,7 +166,7 @@" @message_handler\n"," async def handle_user_message(self, message: Message, cancellation_token: CancellationToken) -> Message:\n"," # Create a session of messages.\n",- " session = [UserMessage(content=message.content, source=\"user\")]\n",+ " session: List[LLMMessage] = [UserMessage(content=message.content, source=\"user\")]\n"," # Get a response from the model.\n"," response = await self._model_client.create(\n"," self._system_messages + session, tools=self._tool_schema, cancellation_token=cancellation_token\n",@@ -192,9 +195,10 @@" response = await self._model_client.create(\n"," self._system_messages + session, tools=self._tool_schema, cancellation_token=cancellation_token\n"," )\n",- " session.append(AssistantMessage(content=response.content, source=self.metadata[\"name\"]))\n",+ " session.append(AssistantMessage(content=response.content, source=self.metadata[\"type\"]))\n","\n"," # Return the final response.\n",+ " assert isinstance(response.content, str)\n"," return Message(content=response.content)"]},diff --git a/python/pyproject.toml b/python/pyproject.tomlindex f489ff53f..958016d48 100644--- a/python/pyproject.toml+++ b/python/pyproject.toml@@ -60,7 +60,8 @@ dependencies = ["types-aiofiles","types-pillow","types-protobuf",- "wikipedia"+ "wikipedia",+ "nbqa"][tool.hatch.envs.default.extra-scripts]@@ -76,6 +77,8 @@ check = ["pyright","mypy --non-interactive --install-types","pytest -n auto",+ # Only checking notebooks with mypy for now due to the fact pyright doesn't seem to be able to ignore the top level await+ "nbqa mypy docs/src",][tool.hatch.envs.test-matrix]@@ -85,6 +88,7 @@ template = "default"python = ["3.10", "3.11", "3.12"][tool.hatch.envs.docs]+template = "default"dependencies = ["sphinx","furo",@@ -96,7 +100,9 @@ dependencies = [[tool.hatch.envs.docs.scripts]build = "sphinx-build docs/src docs/build"serve = "sphinx-autobuild --watch src docs/src docs/build"-check = "sphinx-build --fail-on-warning docs/src docs/build"+check = [+ "sphinx-build --fail-on-warning docs/src docs/build"+]# Benchmark environments[tool.hatch.envs.bench-humaneval-teamone]@@ -121,7 +127,7 @@ line-length = 120fix = trueexclude = ["build", "dist", "src/agnext/worker/protos"]target-version = "py310"-include = ["src/**", "samples/*.py"]+include = ["src/**", "samples/*.py", "docs/**/*.ipynb"][tool.ruff.format]docstring-code-format = true@@ -179,3 +185,8 @@ outputs = ["{proto_path}/{proto_name}_pb2.pyi"][[tool.hatch.build.hooks.protobuf.generators]]name = "mypy_grpc"outputs = ["{proto_path}/{proto_name}_pb2_grpc.pyi"]++[tool.nbqa.addopts]+mypy = [+ "--disable-error-code=top-level-await"+]