A programming framework for agentic AI
Allow model client to accept the tool schema directly (#196)
Jack Gerrits05e72084e8e2
diff --git a/python/src/agnext/components/models/_model_client.py b/python/src/agnext/components/models/_model_client.pyindex 1dcfe351a..b87e50b91 100644--- a/python/src/agnext/components/models/_model_client.py+++ b/python/src/agnext/components/models/_model_client.py@@ -11,7 +11,7 @@ from typing_extensions import (Union,)-from ..tools import Tool+from ..tools import Tool, ToolSchemafrom ._types import CreateResult, LLMMessage, RequestUsage@@ -27,7 +27,7 @@ class ChatCompletionClient(Protocol):async def create(self,messages: Sequence[LLMMessage],- tools: Sequence[Tool] = [],+ tools: Sequence[Tool | ToolSchema] = [],# None means do not override the default# A value means to override the client default - often specified in the constructorjson_output: Optional[bool] = None,@@ -37,7 +37,7 @@ class ChatCompletionClient(Protocol):def create_stream(self,messages: Sequence[LLMMessage],- tools: Sequence[Tool] = [],+ tools: Sequence[Tool | ToolSchema] = [],# None means do not override the default# A value means to override the client default - often specified in the constructorjson_output: Optional[bool] = None,diff --git a/python/src/agnext/components/models/_openai_client.py b/python/src/agnext/components/models/_openai_client.pyindex 6fbd417cd..68ef9acb9 100644--- a/python/src/agnext/components/models/_openai_client.py+++ b/python/src/agnext/components/models/_openai_client.py@@ -38,7 +38,7 @@ from .. import (FunctionCall,Image,)-from ..tools import Tool+from ..tools import Tool, ToolSchemafrom . import _model_infofrom ._model_client import ChatCompletionClient, ModelCapabilitiesfrom ._types import (@@ -205,11 +205,16 @@ def _add_usage(usage1: RequestUsage, usage2: RequestUsage) -> RequestUsage:def convert_tools(- tools: Sequence[Tool],+ tools: Sequence[Tool | ToolSchema],) -> List[ChatCompletionToolParam]:result: List[ChatCompletionToolParam] = []for tool in tools:- tool_schema = tool.schema+ if isinstance(tool, Tool):+ tool_schema = tool.schema+ else:+ assert isinstance(tool, dict)+ tool_schema = tool+result.append(ChatCompletionToolParam(type="function",@@ -287,7 +292,7 @@ class BaseOpenAIChatCompletionClient(ChatCompletionClient):async def create(self,messages: Sequence[LLMMessage],- tools: Sequence[Tool] = [],+ tools: Sequence[Tool | ToolSchema] = [],json_output: Optional[bool] = None,extra_create_args: Mapping[str, Any] = {},) -> CreateResult:@@ -393,7 +398,7 @@ class BaseOpenAIChatCompletionClient(ChatCompletionClient):async def create_stream(self,messages: Sequence[LLMMessage],- tools: Sequence[Tool] = [],+ tools: Sequence[Tool | ToolSchema] = [],json_output: Optional[bool] = None,extra_create_args: Mapping[str, Any] = {},) -> AsyncGenerator[Union[str, CreateResult], None]:diff --git a/python/src/agnext/components/tools/__init__.py b/python/src/agnext/components/tools/__init__.pyindex 7054e173f..1f0e6f1f6 100644--- a/python/src/agnext/components/tools/__init__.py+++ b/python/src/agnext/components/tools/__init__.py@@ -1,9 +1,10 @@-from ._base import BaseTool, BaseToolWithState, Tool+from ._base import BaseTool, BaseToolWithState, Tool, ToolSchemafrom ._code_execution import CodeExecutionInput, CodeExecutionResult, PythonCodeExecutionToolfrom ._function_tool import FunctionTool__all__ = ["Tool",+ "ToolSchema","BaseTool","BaseToolWithState","PythonCodeExecutionTool",diff --git a/python/src/agnext/components/tools/_base.py b/python/src/agnext/components/tools/_base.pyindex 36d7c83c4..2dfaefff7 100644--- a/python/src/agnext/components/tools/_base.py+++ b/python/src/agnext/components/tools/_base.py@@ -1,7 +1,7 @@import jsonfrom abc import ABC, abstractmethodfrom collections.abc import Sequence-from typing import Any, Dict, Generic, Mapping, Protocol, Type, TypedDict, TypeVar+from typing import Any, Dict, Generic, Mapping, Protocol, Type, TypedDict, TypeVar, runtime_checkablefrom pydantic import BaseModelfrom typing_extensions import NotRequired@@ -24,6 +24,7 @@ class ToolSchema(TypedDict):description: NotRequired[str]+@runtime_checkableclass Tool(Protocol):@propertydef name(self) -> str: ...diff --git a/python/tests/test_tools.py b/python/tests/test_tools.pyindex c5e52f19a..18f554c7f 100644--- a/python/tests/test_tools.py+++ b/python/tests/test_tools.py@@ -5,6 +5,7 @@ from typing import Annotatedimport pytestfrom agnext.components._function_utils import get_typed_signaturefrom agnext.components.tools import BaseTool, FunctionTool+from agnext.components.models._openai_client import convert_toolsfrom agnext.core import CancellationTokenfrom pydantic import BaseModel, Field, model_serializerfrom pydantic_core import PydanticUndefined@@ -286,3 +287,25 @@ async def test_func_int_res()-> None:tool = FunctionTool(my_function, description="Function tool.")result = await tool.run_json({"arg": 5}, CancellationToken())assert tool.return_value_as_string(result) == "5"+++def test_convert_tools_accepts_both_func_tool_and_schema() -> None:+ def my_function(arg: str, other: Annotated[int, "int arg"], nonrequired: int = 5) -> MyResult:+ return MyResult(result="test")+ tool = FunctionTool(my_function, description="Function tool.")+ schema = tool.schema++ converted_tool_schema = convert_tools([tool, schema])++ assert len(converted_tool_schema) == 2+ assert converted_tool_schema[0] == converted_tool_schema[1]+++def test_convert_tools_accepts_both_tool_and_schema() -> None:+ tool = MyTool()+ schema = tool.schema++ converted_tool_schema = convert_tools([tool, schema])++ assert len(converted_tool_schema) == 2+ assert converted_tool_schema[0] == converted_tool_schema[1]