indexers.VectorStore.from_filespace

indexers.VectorStore.from_filespace(folder_path, vectoriser, hooks=None)

Creates a VectorStore instance from stored metadata and Parquet files. This method reads the metadata and vectors from the specified folder, validates the contents, and initializes a VectorStore object with the loaded data. It checks that the metadata contains the required keys, that the Parquet file exists and is not empty, and that the vectoriser class matches the one used to create the vectors. If any checks fail, it raises a ValueError with an appropriate message. This method is useful for loading previously created vector stores without needing to reprocess the original text data.

Parameters

Name Type Description Default
folder_path str The folder path containing the metadata and Parquet files. required
vectoriser object The vectoriser object used to transform text into vector embeddings. required
hooks dict [optional] A dictionary of user-defined hooks for preprocessing and postprocessing. Defaults to None. None

Returns

Name Type Description
VectorStore An instance of the VectorStore class.

Raises

Name Type Description
DataValidationError If input arguments are invalid or if there are issues with the metadata or Parquet files.
ConfigurationError If there are configuration issues, such as vectoriser mismatches.
IndexBuildError If there are failures during loading or parsing the files.