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 | - | Implementation |
| - max_num_results | No | integer | No | - | Max Num Results |
| - question_transformer | No | Reference[QuestionTransformer] | No | - | - |
| - document_retriever | No | Reference[DocumentRetriever] | No | - | - |
| - document_reranker | No | Reference[DocumentReranker] | No | - | - |
| - result_summarizer | No | Reference[ResultSummarizer] | No | - | - |
| + 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 | - | - |
| - apu | No | Reference[APU] | No | - | The APU to use for question transformation. |
1. Property implementation
Title: Implementation
| Type | const |
| Required | Yes |
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"} |
4. Property document_retriever
| Type | Reference[DocumentRetriever] |
| Required | No |
| Default | {"implementation": "DocumentRetriever"} |
5. Property document_reranker
| Type | Reference[DocumentReranker] |
| Required | No |
| Default | {"implementation": "DocumentReranker"} |
6. Property result_summarizer
| Type | Reference[ResultSummarizer] |
| Required | No |
| Default | {"implementation": "ResultSummarizer"} |
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 |
12. Property apu
| Type | Reference[APU] |
| Required | No |
| Default | {"implementation": "APU"} |
Description: The APU to use for question transformation.