aiq.retriever.nemo_retriever.register#

Classes#

NemoRetrieverConfig

Configuration for a Retriever which pulls data from a Nemo Retriever service.

Functions#

nemo_retriever(retriever_config, builder)

nemo_retriever_client(config, builder)

Module Contents#

class NemoRetrieverConfig(/, **data: Any)#

Bases: aiq.data_models.retriever.RetrieverBaseConfig

Configuration for a Retriever which pulls data from a Nemo Retriever service.

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.

uri: pydantic.HttpUrl = None#
collection_name: str | None = None#
top_k: int | None = None#
output_fields: list[str] | None = None#
timeout: int = None#
nvidia_api_key: str | None = None#
async nemo_retriever(
retriever_config: NemoRetrieverConfig,
builder: aiq.builder.builder.Builder,
)#
async nemo_retriever_client(
config: NemoRetrieverConfig,
builder: aiq.builder.builder.Builder,
)#