Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

standard-tests: Fix ToolsIntegrationTests to correctly handle "content_and_artifact" tools #29391

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 8 additions & 18 deletions libs/standard-tests/langchain_tests/integration_tests/tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,10 @@ def test_invoke_matches_output_schema(self, tool: BaseTool) -> None:
)
result = tool.invoke(tool_call)

if tool.response_format == "content":
tool_message = result
elif tool.response_format == "content_and_artifact":
# should be (content, artifact)
assert isinstance(result, tuple)
assert len(result) == 2
tool_message, artifact = result

assert artifact # artifact can be anything, but shouldn't be none
tool_message = result
if tool.response_format == "content_and_artifact":
# artifact can be anything, except none
assert tool_message.artifact is not None

# check content is a valid ToolMessage content
assert isinstance(tool_message.content, (str, list))
Expand All @@ -59,15 +54,10 @@ async def test_async_invoke_matches_output_schema(self, tool: BaseTool) -> None:
)
result = await tool.ainvoke(tool_call)

if tool.response_format == "content":
tool_message = result
elif tool.response_format == "content_and_artifact":
# should be (content, artifact)
assert isinstance(result, tuple)
assert len(result) == 2
tool_message, artifact = result

assert artifact # artifact can be anything, but shouldn't be none
tool_message = result
if tool.response_format == "content_and_artifact":
# artifact can be anything, except none
assert tool_message.artifact is not None

# check content is a valid ToolMessage content
assert isinstance(tool_message.content, (str, list))
Expand Down
36 changes: 35 additions & 1 deletion libs/standard-tests/tests/unit_tests/test_basic_tool.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import Type
from typing import Literal, Type

from langchain_core.tools import BaseTool

Expand All @@ -16,6 +16,17 @@ 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]:
Expand Down Expand Up @@ -60,3 +71,26 @@ def tool_invoke_params_example(self) -> dict:
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}
Loading