VectorStoreTextSearch<TRecord> Class

Definition

Namespace:: Microsoft.SemanticKernel.Data

Assembly:: Microsoft.SemanticKernel.Core.dll

Package:: Microsoft.SemanticKernel.Core v1.45.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A Vector Store Text Search implementation that can be used to perform searches using a Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.

public sealed class VectorStoreTextSearch<TRecord> : Microsoft.SemanticKernel.Data.ITextSearch

type VectorStoreTextSearch<'Record> = class
    interface ITextSearch

Public NotInheritable Class VectorStoreTextSearch(Of TRecord)
Implements ITextSearch

Type Parameters

TRecord

Inheritance: Object
VectorStoreTextSearch<TRecord>

Implements: ITextSearch

Constructors

VectorStoreTextSearch<TRecord>(IVectorizableTextSearch<TRecord>, ITextSearchStringMapper, ITextSearchResultMapper, VectorStoreTextSearchOptions)	Create an instance of the VectorStoreTextSearch<TRecord> with the provided Microsoft.Extensions.VectorData.IVectorizableTextSearch`1 for performing searches and ITextEmbeddingGenerationService for generating vectors from the text search query.
VectorStoreTextSearch<TRecord>(IVectorizableTextSearch<TRecord>, MapFromResultToString, MapFromResultToTextSearchResult, VectorStoreTextSearchOptions)	Create an instance of the VectorStoreTextSearch<TRecord> with the provided Microsoft.Extensions.VectorData.IVectorizableTextSearch`1 for performing searches and ITextEmbeddingGenerationService for generating vectors from the text search query.
VectorStoreTextSearch<TRecord>(IVectorizedSearch<TRecord>, ITextEmbeddingGenerationService, ITextSearchStringMapper, ITextSearchResultMapper, VectorStoreTextSearchOptions)	Create an instance of the VectorStoreTextSearch<TRecord> with the provided Microsoft.Extensions.VectorData.IVectorizedSearch`1 for performing searches and ITextEmbeddingGenerationService for generating vectors from the text search query.
VectorStoreTextSearch<TRecord>(IVectorizedSearch<TRecord>, ITextEmbeddingGenerationService, MapFromResultToString, MapFromResultToTextSearchResult, VectorStoreTextSearchOptions)	Create an instance of the VectorStoreTextSearch<TRecord> with the provided Microsoft.Extensions.VectorData.IVectorizedSearch`1 for performing searches and ITextEmbeddingGenerationService for generating vectors from the text search query.

Methods

GetSearchResultsAsync(String, TextSearchOptions, CancellationToken)	Perform a search for content related to the specified query and return Object values representing the search results.
GetTextSearchResultsAsync(String, TextSearchOptions, CancellationToken)	Perform a search for content related to the specified query and return TextSearchResult values representing the search results.
SearchAsync(String, TextSearchOptions, CancellationToken)	Perform a search for content related to the specified query and return String values representing the search results.

Extension Methods

CreateGetSearchResults(ITextSearch, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes GetSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateGetSearchResults(ITextSearch, JsonSerializerOptions, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes GetSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateGetTextSearchResults(ITextSearch, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes GetTextSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateGetTextSearchResults(ITextSearch, JsonSerializerOptions, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes GetTextSearchResultsAsync(String, TextSearchOptions, CancellationToken).
CreateSearch(ITextSearch, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes SearchAsync(String, TextSearchOptions, CancellationToken).
CreateSearch(ITextSearch, JsonSerializerOptions, KernelFunctionFromMethodOptions, TextSearchOptions)	Create a KernelFunction which invokes SearchAsync(String, TextSearchOptions, CancellationToken).
CreateWithGetSearchResults(ITextSearch, String, String)	Creates a plugin from an ITextSearch implementation.
CreateWithGetSearchResults(ITextSearch, String, JsonSerializerOptions, String)	Creates a plugin from an ITextSearch implementation.
CreateWithGetTextSearchResults(ITextSearch, String, String)	Creates a plugin from an ITextSearch implementation.
CreateWithGetTextSearchResults(ITextSearch, String, JsonSerializerOptions, String)	Creates a plugin from an ITextSearch implementation.
CreateWithSearch(ITextSearch, String, String)	Creates a plugin from an ITextSearch implementation.
CreateWithSearch(ITextSearch, String, JsonSerializerOptions, String)	Creates a plugin from an ITextSearch implementation.

Applies to

Share via