The agent engineering platform.
Python agentsaiai-agentsanthropicchatgptdeepagentsenterpriseframeworkgeminigenerative-ailangchainlanggraphllmmultiagentopen-sourceopenaipydanticpythonragtypescript
core: allow artifact in create_retriever_tool (#28903)
Adrián Panellaacddfc772e78
diff --git a/libs/core/langchain_core/tools/retriever.py b/libs/core/langchain_core/tools/retriever.pyindex b59b49a3d3..b1036058ca 100644--- a/libs/core/langchain_core/tools/retriever.py+++ b/libs/core/langchain_core/tools/retriever.py@@ -1,11 +1,12 @@from __future__ import annotationsfrom functools import partial-from typing import Optional+from typing import Literal, Optional, Unionfrom pydantic import BaseModel, Fieldfrom langchain_core.callbacks import Callbacks+from langchain_core.documents import Documentfrom langchain_core.prompts import (BasePromptTemplate,PromptTemplate,@@ -28,11 +29,16 @@ def _get_relevant_documents(document_prompt: BasePromptTemplate,document_separator: str,callbacks: Callbacks = None,-) -> str:+ response_format: Literal["content", "content_and_artifact"] = "content",+) -> Union[str, tuple[str, list[Document]]]:docs = retriever.invoke(query, config={"callbacks": callbacks})- return document_separator.join(+ content = document_separator.join(format_document(doc, document_prompt) for doc in docs)+ if response_format == "content_and_artifact":+ return (content, docs)++ return contentasync def _aget_relevant_documents(@@ -41,12 +47,18 @@ async def _aget_relevant_documents(document_prompt: BasePromptTemplate,document_separator: str,callbacks: Callbacks = None,-) -> str:+ response_format: Literal["content", "content_and_artifact"] = "content",+) -> Union[str, tuple[str, list[Document]]]:docs = await retriever.ainvoke(query, config={"callbacks": callbacks})- return document_separator.join(+ content = document_separator.join([await aformat_document(doc, document_prompt) for doc in docs])+ if response_format == "content_and_artifact":+ return (content, docs)++ return content+def create_retriever_tool(retriever: BaseRetriever,@@ -55,6 +67,7 @@ def create_retriever_tool(*,document_prompt: Optional[BasePromptTemplate] = None,document_separator: str = "\n\n",+ response_format: Literal["content", "content_and_artifact"] = "content",) -> Tool:"""Create a tool to do retrieval of documents.@@ -66,6 +79,11 @@ def create_retriever_tool(model, so should be descriptive.document_prompt: The prompt to use for the document. Defaults to None.document_separator: The separator to use between documents. Defaults to "\n\n".+ response_format: The tool response format. If "content" then the output of+ the tool is interpreted as the contents of a ToolMessage. If+ "content_and_artifact" then the output is expected to be a two-tuple+ corresponding to the (content, artifact) of a ToolMessage (artifact+ being a list of documents in this case). Defaults to "content".Returns:Tool class to pass to an agent.@@ -76,12 +94,14 @@ def create_retriever_tool(retriever=retriever,document_prompt=document_prompt,document_separator=document_separator,+ response_format=response_format,)afunc = partial(_aget_relevant_documents,retriever=retriever,document_prompt=document_prompt,document_separator=document_separator,+ response_format=response_format,)return Tool(name=name,@@ -89,4 +109,5 @@ def create_retriever_tool(func=func,coroutine=afunc,args_schema=RetrieverInput,+ response_format=response_format,)diff --git a/libs/core/tests/unit_tests/test_tools.py b/libs/core/tests/unit_tests/test_tools.pyindex c0d8c962dd..03e7fcc01e 100644--- a/libs/core/tests/unit_tests/test_tools.py+++ b/libs/core/tests/unit_tests/test_tools.py@@ -30,8 +30,13 @@ from langchain_core.callbacks import (AsyncCallbackManagerForToolRun,CallbackManagerForToolRun,)-from langchain_core.messages import ToolMessage+from langchain_core.callbacks.manager import (+ CallbackManagerForRetrieverRun,+)+from langchain_core.documents import Document+from langchain_core.messages import ToolCall, ToolMessagefrom langchain_core.messages.tool import ToolOutputMixin+from langchain_core.retrievers import BaseRetrieverfrom langchain_core.runnables import (Runnable,RunnableConfig,@@ -2118,6 +2123,57 @@ def test_tool_annotations_preserved() -> None:assert schema.__annotations__ == expected_type_hints+def test_create_retriever_tool() -> None:+ class MyRetriever(BaseRetriever):+ def _get_relevant_documents(+ self, query: str, *, run_manager: CallbackManagerForRetrieverRun+ ) -> list[Document]:+ return [Document(page_content=f"foo {query}"), Document(page_content="bar")]++ retriever = MyRetriever()+ retriever_tool = tools.create_retriever_tool(+ retriever, "retriever_tool_content", "Retriever Tool Content"+ )+ assert isinstance(retriever_tool, BaseTool)+ assert retriever_tool.name == "retriever_tool_content"+ assert retriever_tool.description == "Retriever Tool Content"+ assert retriever_tool.invoke("bar") == "foo bar\n\nbar"+ assert retriever_tool.invoke(+ ToolCall(+ name="retriever_tool_content",+ args={"query": "bar"},+ id="123",+ type="tool_call",+ )+ ) == ToolMessage(+ "foo bar\n\nbar", tool_call_id="123", name="retriever_tool_content"+ )++ retriever_tool_artifact = tools.create_retriever_tool(+ retriever,+ "retriever_tool_artifact",+ "Retriever Tool Artifact",+ response_format="content_and_artifact",+ )+ assert isinstance(retriever_tool_artifact, BaseTool)+ assert retriever_tool_artifact.name == "retriever_tool_artifact"+ assert retriever_tool_artifact.description == "Retriever Tool Artifact"+ assert retriever_tool_artifact.invoke("bar") == "foo bar\n\nbar"+ assert retriever_tool_artifact.invoke(+ ToolCall(+ name="retriever_tool_artifact",+ args={"query": "bar"},+ id="123",+ type="tool_call",+ )+ ) == ToolMessage(+ "foo bar\n\nbar",+ artifact=[Document(page_content="foo bar"), Document(page_content="bar")],+ tool_call_id="123",+ name="retriever_tool_artifact",+ )++@pytest.mark.skipif(PYDANTIC_MAJOR_VERSION != 2, reason="Testing pydantic v2.")def test_tool_args_schema_pydantic_v2_with_metadata() -> None:from pydantic import BaseModel as BaseModelV2