langchain_core.tools.create_retriever_tool

langchain_core.tools.create_retriever_tool(retriever: BaseRetriever, name: str, description: str, *, document_prompt: Optional[BasePromptTemplate] = None, document_separator: str = '\n\n') → Tool

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

参数：

retriever: 用于检索的检索器 name: 工具的名称。这将传递给语言模型，因此应该是唯一且有些描述性的。 description: 工具的描述。这将传递给语言模型，因此应该是描述性的。

返回：

传递给代理的工具类

Parameters

• retriever (BaseRetriever) –

• name (str) –

• description (str) –

• document_prompt (Optional[BasePromptTemplate]) –

• document_separator (str) –

Return type

Tool

Examples using create_retriever_tool

• Load in document to retrieve over

• Quickstart

• Quickstart {#quickstart}

• Uncomment the below to use LangSmith. Not required.

• conversational_retrieval_agents.md

• xata_chat_message_history.md