Share via


VectorSearchBase Class

Method for searching vectors.

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

VectorSearchBase(*, collection_name: str, data_model_type: type[TModel], data_model_definition: VectorStoreRecordDefinition, managed_client: bool = True)

Keyword-Only Parameters

Name Description
collection_name
Required
data_model_type
Required
data_model_definition
Required
managed_client
Default value: True

Attributes

options_class

The options class for the search.

collection_name

collection_name: str

data_model_definition

data_model_definition: VectorStoreRecordDefinition

data_model_type

data_model_type: type[TModel]

is_experimental

is_experimental = True

managed_client

managed_client: bool

stage_status

stage_status = 'experimental'