Retriever_configuration

This module contains functionality related to the the retriever_configuration module for augmentation.bootstrap.configuration.components.

Retriever_configuration

RetrieverConfiguration

Bases: BaseConfiguration

Configuration class for retrievers.

This class defines the parameters needed to configure a retriever component in the RAG pipeline.

Source code in src/augmentation/bootstrap/configuration/components/retriever_configuration.py
17
18
19
20
21
22
23
24
25
26
27
28
class RetrieverConfiguration(BaseConfiguration):
    """
    Configuration class for retrievers.

    This class defines the parameters needed to configure a retriever component
    in the RAG pipeline.
    """

    name: RetrieverName = Field(..., description="The name of the retriever.")
    similarity_top_k: int = Field(
        ..., description="The number of top similar items to retrieve."
    )

RetrieverConfigurationRegistry

Bases: ConfigurationRegistry

Registry for retriever configurations.

Maps RetrieverName enum values to their corresponding configuration classes. Used for dynamic instantiation of retriever components based on configuration.

Attributes:
  • _key_class (Type) –

    The enumeration class for retriever names.

Source code in src/augmentation/bootstrap/configuration/components/retriever_configuration.py
31
32
33
34
35
36
37
38
39
40
41
42
class RetrieverConfigurationRegistry(ConfigurationRegistry):
    """
    Registry for retriever configurations.

    Maps RetrieverName enum values to their corresponding configuration classes.
    Used for dynamic instantiation of retriever components based on configuration.

    Attributes:
        _key_class: The enumeration class for retriever names.
    """

    _key_class: Type = RetrieverName

RetrieverName

Bases: str, Enum

Enumeration of supported retriever types.

Source code in src/augmentation/bootstrap/configuration/components/retriever_configuration.py
10
11
12
13
14
class RetrieverName(str, Enum):
    """Enumeration of supported retriever types."""

    BASIC = "basic"
    AUTO = "auto"