RetrieverAgent
Description: A RetrieverAgent is an agent that will take a query, rewrite it for better similarity vector search, and then perform the vector search on the document store. The agent will dynamically load and embed files, so it is not performant for loading large bodies of files, but performs very well for small to medium-sized document stores (hundreds to thousands of documents) which are updating frequently.
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - implementation | No | const | No | - | RetrieverAgent |
| - max_num_results | No | integer | No | - | Max Num Results |
| - question_transformer | No | Reference[QuestionTransformer] | No | In QuestionTransformer | Overview of QuestionTransformer components |
| - document_retriever | No | Reference[DocumentRetriever] | No | In DocumentRetriever | Overview of DocumentRetriever components |
| - document_reranker | No | Reference[DocumentReranker] | No | In DocumentReranker | Overview of DocumentReranker components |
| - result_summarizer | No | Reference[ResultSummarizer] | No | In ResultSummarizer | Overview of ResultSummarizer components |
| + name | No | string | No | - | Name |
| + description | No | string | No | - | Description |
| - loader_root_location | No | string | No | - | Loader Root Location |
| - loader_pattern | No | Combination | No | - | Loader Pattern |
| - document_manager | No | Reference[DocumentManager] | No | In DocumentManager | Overview of DocumentManager components |
| - apu | No | Reference[APU] | No | In APU | The APU is the main interface for the Agent to interact with the LLM. The APU provides a set of capabilities that encapsulate LLM functionality and creates a clear separation between business logic and the underlying LLM implementation. To learn more, check out our blog article APU: What is it and how does it work?. |
1. Property implementation
| Type | const |
| Required | No |
Description: RetrieverAgent
Specific value: "RetrieverAgent"
2. Property max_num_results
Title: Max Num Results
| Type | integer |
| Required | No |
| Default | 10 |
Description: The maximum number of results to consider.
3. Property question_transformer
| Type | Reference[QuestionTransformer] |
| Required | No |
| Default | {"implementation": "QuestionTransformer"} |
| Defined in | QuestionTransformer |
Description: Overview of QuestionTransformer components
4. Property document_retriever
| Type | Reference[DocumentRetriever] |
| Required | No |
| Default | {"implementation": "DocumentRetriever"} |
| Defined in | DocumentRetriever |
Description: Overview of DocumentRetriever components
5. Property document_reranker
| Type | Reference[DocumentReranker] |
| Required | No |
| Default | {"implementation": "DocumentReranker"} |
| Defined in | DocumentReranker |
Description: Overview of DocumentReranker components
6. Property result_summarizer
| Type | Reference[ResultSummarizer] |
| Required | No |
| Default | {"implementation": "ResultSummarizer"} |
| Defined in | ResultSummarizer |
Description: Overview of ResultSummarizer components
7. Property name
Title: Name
| Type | string |
| Required | Yes |
Description: The name of the document store to use.
8. Property description
Title: Description
| Type | string |
| Required | Yes |
Description: A detailed description of the the retriever including all necessary information for the calling agent to decide to call this agent, i.e. file type or location or etc…
9. Property loader_root_location
Title: Loader Root Location
| Type | string |
| Required | No |
| Default | null |
Description: A URL specifying the root location of the loader.
10. Property loader_pattern
Title: Loader Pattern
| Type | combining |
| Required | No |
| Additional properties | [Any type: allowed] |
| Default | "**/*" |
Description: The search pattern to use when loading files.
10.1. Property item 0
| Type | string |
| Required | No |
10.2. Property item 1
| Type | null |
| Required | No |
11. Property document_manager
| Type | Reference[DocumentManager] |
| Required | No |
| Default | null |
| Defined in | DocumentManager |
Description: Overview of DocumentManager components
12. Property apu
| Type | Reference[APU] |
| Required | No |
| Default | {"implementation": "APU"} |
| Defined in | APU |
Description: The APU is the main interface for the Agent to interact with the LLM. The APU provides a set of capabilities that encapsulate LLM functionality and creates a clear separation between business logic and the underlying LLM implementation.
To learn more, check out our blog article APU: What is it and how does it work?.