feat: add type validation to params when tool is invoked (#129)

* feat: add authenticated parameters support

* chore: add asyncio dep

* chore: run itest

* chore: add type hint

* fix: call tool instead of client

* chore: correct arg name

* feat: add support for bound parameters

* chore: add tests for bound parameters

* docs: update syntax error on readme (#121)

* ci: added release please config (#112)

* ci: add release please config

* chore: add initial version

* chore: specify initial version as string

* chore: Update .release-please-manifest.json

* chore: add empty json

* chore: small change

* chore: try fixing config

* chore: try fixing config again

* chore: remove release-as

* chore: add changelog sections

* chore: better release notes

* chore: better release notes

* chore: change toolbox-langchain version

* chore: separate PRs for packages

* chore: change PR style

* added basic e2e tests

* change license year

* add test deps

* fix tests

* fix tests

* fix tests

* add new test case

* fix docstring

* added todo

* cleanup

* add bind param test case

* make bind params dynamic

* try fix test errors

* lint

* remove redundant test

* test fix

* fix docstring

* feat: add authenticated parameters support

* chore: add asyncio dep

* chore: run itest

* chore: add type hint

* fix: call tool instead of client

* chore: correct arg name

* chore: address feedback

* chore: address more feedback

* feat: add support for bound parameters

* chore: add tests for bound parameters

* chore: address feedback

* revert package file changes

* fix error message

* revert package files

* lint

* fix error message

* Update packages/toolbox-core/tests/test_e2e.py

Co-authored-by: Anubhav Dhawan <anubhav756@gmail.com>

* try changing docstring to include args and their descriptions

* fix docstring

* lint

* fix test

* lint

* added return type annotation

* Add docstrings

* use and update schema

# Conflicts:
#	packages/toolbox-core/src/toolbox_core/tool.py

* lint

* lint

* try out pydantic validation

# Conflicts:
#	packages/toolbox-core/src/toolbox_core/client.py
#	packages/toolbox-core/src/toolbox_core/tool.py

* revert changes to e2e test file

* add basic pydantic type checking

* lint

* fix pydantic validation error

* fix error string

* fix error string

* lint

* added to_pydantic_model as a method under the toolschema class

* lint

* revert changes to e2e test file

# Conflicts:
#	packages/toolbox-core/tests/test_e2e.py

* change string to str and in arg type

* small change

* fix imports

* remove toolschema usage

* lint

* create pydantic model at init

* lint

* move create_docstring method outside the class.

* lint

* lint

* Update packages/toolbox-core/src/toolbox_core/tool.py

Co-authored-by: Anubhav Dhawan <anubhav756@gmail.com>

* move to_pydantic_model outside the class

* lint

* rename function

* added name to pydantic model

* lint

---------

Co-authored-by: Kurtis Van Gent <31518063+kurtisvg@users.noreply.github.com>
Co-authored-by: Yuan <45984206+Yuan325@users.noreply.github.com>
Co-authored-by: Anubhav Dhawan <anubhav756@gmail.com>

Author: 4 people

packages/toolbox-core/src/toolbox_core/tool.py

@@ -23,10 +23,13 @@
     Mapping,
     Optional,
     Sequence,
+    Type,
     Union,
+    cast,
 )
 
 from aiohttp import ClientSession
+from pydantic import BaseModel, Field, create_model
 
 from toolbox_core.protocol import ParameterSchema
 
@@ -78,6 +81,8 @@ def __init__(
         self.__url = f"{base_url}/api/tool/{name}/invoke"
         self.__description = description
         self.__params = params
+        self.__pydantic_model = params_to_pydantic_model(name, self.__params)
+
         inspect_type_params = [param.to_param() for param in self.__params]
 
         # the following properties are set to help anyone that might inspect it determine usage
@@ -86,6 +91,7 @@ def __init__(
         self.__signature__ = Signature(
             parameters=inspect_type_params, return_annotation=str
         )
+
         self.__annotations__ = {p.name: p.annotation for p in inspect_type_params}
         # TODO: self.__qualname__ ??
 
@@ -170,6 +176,9 @@ async def __call__(self, *args: Any, **kwargs: Any) -> str:
         all_args.apply_defaults()  # Include default values if not provided
         payload = all_args.arguments
 
+        # Perform argument type validations using pydantic
+        self.__pydantic_model.model_validate(payload)
+
         # apply bounded parameters
         for param, value in self.__bound_parameters.items():
             if asyncio.iscoroutinefunction(value):
@@ -305,3 +314,19 @@ def identify_required_authn_params(
         if required:
             required_params[param] = services
     return required_params
+
+
+def params_to_pydantic_model(
+    tool_name: str, params: Sequence[ParameterSchema]
+) -> Type[BaseModel]:
+    """Converts the given parameters to a Pydantic BaseModel class."""
+    field_definitions = {}
+    for field in params:
+        field_definitions[field.name] = cast(
+            Any,
+            (
+                field.to_param().annotation,
+                Field(description=field.description),
+            ),
+        )
+    return create_model(tool_name, **field_definitions)

packages/toolbox-core/tests/test_e2e.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 import pytest
 import pytest_asyncio
+from pydantic import ValidationError
 
 from toolbox_core.client import ToolboxClient
 from toolbox_core.tool import ToolboxTool
@@ -77,8 +78,8 @@ async def test_run_tool_missing_params(self, get_n_rows_tool: ToolboxTool):
     async def test_run_tool_wrong_param_type(self, get_n_rows_tool: ToolboxTool):
         """Invoke a tool with wrong param type."""
         with pytest.raises(
-            Exception,
-            match='provided parameters were invalid: unable to parse value for "num_rows": .* not type "string"',
+            ValidationError,
+            match=r"num_rows\s+Input should be a valid string\s+\[type=string_type,\s+input_value=2,\s+input_type=int\]",
         ):
             await get_n_rows_tool(num_rows=2)