aiq.tool.retriever

Attributes

logger

Classes

AIQRetrieverConfig

AIQRetriever tool which provides a common interface for different vectorstores. Its

Functions

_get_description_from_config(→ str)	Generate a description of what the tool will do based on how it is configured.
aiq_retriever_tool(config, builder)	Configure an AgentIQ Retriever Tool which supports different clients such as Milvus and Nemo Retriever.

Module Contents

logger

class AIQRetrieverConfig(/, **data: Any)

Bases: aiq.data_models.function.FunctionBaseConfig

AIQRetriever tool which provides a common interface for different vectorstores. Its configuration uses clients, which are the vectorstore-specific implementaiton of the retriever interface.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

retriever: aiq.data_models.component_ref.RetrieverRef = None

raise_errors: bool = None

topic: str = None

description: str = None

_get_description_from_config(config: AIQRetrieverConfig) → str

Generate a description of what the tool will do based on how it is configured.

async aiq_retriever_tool(

config: AIQRetrieverConfig,

builder: aiq.builder.builder.Builder,

)

Configure an AgentIQ Retriever Tool which supports different clients such as Milvus and Nemo Retriever.

Args:

config: A config object with required parameters ‘client’ and ‘client_config’ builder: A workflow builder object