create_retriever_tool#

langchain_core.tools.retriever.create_retriever_tool(retriever: BaseRetriever, name: str, description: str, *, document_prompt: BasePromptTemplate | None = None, document_separator: str = '\n\n', response_format: Literal['content', 'content_and_artifact'] = 'content') → Tool[来源]#

创建一个工具来检索文档。

Args:

retriever: 用于检索的retriever name: 工具的名称。这将传递给语言模型，

因此应该是唯一的并且具有一定的描述性。

description: The description for the tool. This will be passed to the language

模型，因此应该是描述性的。

document_prompt: 用于文档的提示。默认为 None。 document_separator: 用于文档之间的分隔符。默认为“

“.
response_format: The tool response format. If “content” then the output of

该工具被解释为ToolMessage的内容。如果选择“content_and_artifact”，则输出应为对应于ToolMessage的（内容，工件）的二元组（在这种情况下，工件是文档列表）。默认为“content”。

Returns:

传递给代理的工具类。

Parameters:

  • retriever (BaseRetriever)

  • name (str)

  • 描述 (str)

  • document_prompt (BasePromptTemplate | None)

  • document_separator (str)

  • response_format (Literal['content', 'content_and_artifact'])

Return type:

Tool

使用 create_retriever_tool 的示例