Skip to content

Configuration Base Class#

QuivrBaseConfig #

Bases: BaseModel

Base configuration class for Quivr.

This class extends Pydantic's BaseModel and provides a foundation for configuration management in quivr-core.

Attributes:

Name Type Description
model_config ConfigDict

Configuration for the Pydantic model. It's set to forbid extra attributes, ensuring strict adherence to the defined schema.

Class Methods

from_yaml: Create an instance of the class from a YAML file.

from_yaml classmethod #

from_yaml(file_path)

Create an instance of the class from a YAML file.

Parameters:

Name Type Description Default
file_path str | Path

The path to the YAML file.

required

Returns:

Name Type Description
QuivrBaseConfig Self

An instance of the class initialized with the data from the YAML file.