mirror of
https://github.com/hwchase17/langchain.git
synced 2025-06-24 07:35:18 +00:00
**Description:**
The response from `tool.invoke()` is always a ToolMessage, with content
and artifact fields, not a tuple.
The tuple is converted to a ToolMessage here
b6ae7ca91d/libs/core/langchain_core/tools/base.py (L726)
**Issue:**
Currently `ToolsIntegrationTests` requires `invoke()` to return a tuple
and so standard tests fail for "content_and_artifact" tools. This fixes
that to check the returned ToolMessage.
This PR also adds a test that now passes.
97 lines
3.2 KiB
Python
97 lines
3.2 KiB
Python
from typing import Literal, Type
|
|
|
|
from langchain_core.tools import BaseTool
|
|
|
|
from langchain_tests.integration_tests import ToolsIntegrationTests
|
|
from langchain_tests.unit_tests import ToolsUnitTests
|
|
|
|
|
|
class ParrotMultiplyTool(BaseTool): # type: ignore
|
|
name: str = "ParrotMultiplyTool"
|
|
description: str = (
|
|
"Multiply two numbers like a parrot. Parrots always add eighty for their matey."
|
|
)
|
|
|
|
def _run(self, a: int, b: int) -> int:
|
|
return a * b + 80
|
|
|
|
|
|
class ParrotMultiplyArtifactTool(BaseTool): # type: ignore
|
|
name: str = "ParrotMultiplyArtifactTool"
|
|
description: str = (
|
|
"Multiply two numbers like a parrot. Parrots always add eighty for their matey."
|
|
)
|
|
response_format: Literal["content_and_artifact"] = "content_and_artifact"
|
|
|
|
def _run(self, a: int, b: int) -> tuple[int, str]:
|
|
return a * b + 80, "parrot artifact"
|
|
|
|
|
|
class TestParrotMultiplyToolUnit(ToolsUnitTests):
|
|
@property
|
|
def tool_constructor(self) -> Type[ParrotMultiplyTool]:
|
|
return ParrotMultiplyTool
|
|
|
|
@property
|
|
def tool_constructor_params(self) -> dict:
|
|
# if your tool constructor instead required initialization arguments like
|
|
# `def __init__(self, some_arg: int):`, you would return those here
|
|
# as a dictionary, e.g.: `return {'some_arg': 42}`
|
|
return {}
|
|
|
|
@property
|
|
def tool_invoke_params_example(self) -> dict:
|
|
"""
|
|
Returns a dictionary representing the "args" of an example tool call.
|
|
|
|
This should NOT be a ToolCall dict - i.e. it should not
|
|
have {"name", "id", "args"} keys.
|
|
"""
|
|
return {"a": 2, "b": 3}
|
|
|
|
|
|
class TestParrotMultiplyToolIntegration(ToolsIntegrationTests):
|
|
@property
|
|
def tool_constructor(self) -> Type[ParrotMultiplyTool]:
|
|
return ParrotMultiplyTool
|
|
|
|
@property
|
|
def tool_constructor_params(self) -> dict:
|
|
# if your tool constructor instead required initialization arguments like
|
|
# `def __init__(self, some_arg: int):`, you would return those here
|
|
# as a dictionary, e.g.: `return {'some_arg': 42}`
|
|
return {}
|
|
|
|
@property
|
|
def tool_invoke_params_example(self) -> dict:
|
|
"""
|
|
Returns a dictionary representing the "args" of an example tool call.
|
|
|
|
This should NOT be a ToolCall dict - i.e. it should not
|
|
have {"name", "id", "args"} keys.
|
|
"""
|
|
return {"a": 2, "b": 3}
|
|
|
|
|
|
class TestParrotMultiplyArtifactToolIntegration(ToolsIntegrationTests):
|
|
@property
|
|
def tool_constructor(self) -> Type[ParrotMultiplyArtifactTool]:
|
|
return ParrotMultiplyArtifactTool
|
|
|
|
@property
|
|
def tool_constructor_params(self) -> dict:
|
|
# if your tool constructor instead required initialization arguments like
|
|
# `def __init__(self, some_arg: int):`, you would return those here
|
|
# as a dictionary, e.g.: `return {'some_arg': 42}`
|
|
return {}
|
|
|
|
@property
|
|
def tool_invoke_params_example(self) -> dict:
|
|
"""
|
|
Returns a dictionary representing the "args" of an example tool call.
|
|
|
|
This should NOT be a ToolCall dict - i.e. it should not
|
|
have {"name", "id", "args"} keys.
|
|
"""
|
|
return {"a": 2, "b": 3}
|