Share via

VectorizedSearchMixin Class

The mixin for searching with vectors. To be used in combination with VectorSearchBase.

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

Constructor

VectorizedSearchMixin()

Methods

vectorized_search

Search the vector store for records that match the given vector (embedding) and filter.

Search the vector store for records that match the given vector (embedding) and filter.

async vectorized_search(vector: list[float | int], options: SearchOptions | None = None, **kwargs: Any) -> KernelSearchResults[VectorSearchResult[TModel]]

Parameters

Name Description
vector
Required

The vector to search for.
options

options, should include query_text

Default value: None
**kwargs
Required

if options are not set, this is used to create them.

Exceptions

Type Description
VectorSearchExecutionException

If an error occurs during the search.
VectorStoreModelDeserializationException

If an error occurs during deserialization.
VectorSearchOptionsException

If the search options are invalid.
VectorStoreMixinException

raised when the method is not used in combination with the VectorSearchBase.

Attributes

is_experimental 

is_experimental = True

stage_status 

stage_status = 'experimental'