VectorStore Class

Base class for vector stores.

Note: This class is marked as 'experimental' and may change in the future.

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.

Constructor

VectorStore(*, vector_record_collections: dict[str, VectorStoreRecordCollection] = None, managed_client: bool = True)

Keyword-Only Parameters

Name	Description
vector_record_collections Required
managed_client	Default value: True

Methods

get_collection	Get a vector record store.
list_collection_names	Get the names of all collections.

get_collection

Get a vector record store.

abstract get_collection(collection_name: str, data_model_type: type[object], data_model_definition: VectorStoreRecordDefinition | None = None, **kwargs: Any) -> VectorStoreRecordCollection

Parameters

Name	Description
collection_name Required
data_model_type Required
data_model_definition	Default value: None

list_collection_names

Get the names of all collections.

abstract async list_collection_names(**kwargs) -> Sequence[str]

Attributes

is_experimental

is_experimental = True

managed_client

managed_client: bool

stage_status

stage_status = 'experimental'

vector_record_collections

vector_record_collections: dict[str, VectorStoreRecordCollection]