VectorTextSearchMixin Class

The mixin for text search, to be used in combination with VectorSearchBase.

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

Constructor

VectorTextSearchMixin()

Methods

text_search

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

text_search

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

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

Parameters

Name	Description
search_text Required	The query 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'