VectorizableTextSearchMixin Class

The mixin for searching with text that get's vectorized downstream.

To be used in combination with VectorSearchBase.

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

Constructor

VectorizableTextSearchMixin()

Methods

vectorizable_text_search

Search the vector store for records that match the given text and filter. The text string will be vectorized downstream and used for the vector search.

vectorizable_text_search

Search the vector store for records that match the given text and filter.

The text string will be vectorized downstream and used for the vector search.

async vectorizable_text_search(vectorizable_text: str, options: SearchOptions | None = None, **kwargs: Any) -> KernelSearchResults[VectorSearchResult[TModel]]

Parameters

Name	Description
vectorizable_text Required	The text to search for, will be vectorized downstream.
options	options for the search 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'