Validator

This module contains functionality related to the the validator module for embedding.vector_stores.core.

Validator

BaseVectorStoreValidator

Bases: ABC

Abstract base class for vector store validators.

This class defines the interface for vector store validators which are responsible for verifying that vector store configurations are valid before attempting operations.

All vector store validator implementations should inherit from this class and implement the validate method.

Source code in src/embedding/vector_stores/core/validator.py
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class BaseVectorStoreValidator(ABC):
    """
    Abstract base class for vector store validators.

    This class defines the interface for vector store validators which are
    responsible for verifying that vector store configurations are valid
    before attempting operations.

    All vector store validator implementations should inherit from this class
    and implement the validate method.
    """

    @abstractmethod
    def validate(self) -> None:
        """
        Validate the vector store settings.

        This method should check if all required settings are provided
        and have valid values. It should also verify any connections
        or permissions required for the vector store operation.

        Raises:
            Exception: If validation fails, implementations should raise
                       appropriate exceptions with descriptive messages.
        """
        pass

validate() abstractmethod

Validate the vector store settings.

This method should check if all required settings are provided and have valid values. It should also verify any connections or permissions required for the vector store operation.

Raises:
  • Exception

    If validation fails, implementations should raise appropriate exceptions with descriptive messages.

Source code in src/embedding/vector_stores/core/validator.py
16
17
18
19
20
21
22
23
24
25
26
27
28
29
@abstractmethod
def validate(self) -> None:
    """
    Validate the vector store settings.

    This method should check if all required settings are provided
    and have valid values. It should also verify any connections
    or permissions required for the vector store operation.

    Raises:
        Exception: If validation fails, implementations should raise
                   appropriate exceptions with descriptive messages.
    """
    pass