create_retriever_tool(
retriever: BaseRetriever,
name: str,
description: str,
*,
document_prompt| Name | Type | Description |
|---|---|---|
retriever* | BaseRetriever | The retriever to use for the retrieval |
name* | str | The name for the tool. This will be passed to the language model, so should be unique and somewhat descriptive. |
description* | str | The description for the tool. This will be passed to the language model, so should be descriptive. |
document_prompt | BasePromptTemplate | None | Default: None |
document_separator | str | Default: '\n\n' |
response_format | Literal['content', 'content_and_artifact'] | Default: 'content' |
Create a tool to do retrieval of documents.
The prompt to use for the document.
The separator to use between documents.
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).