VectorStoreTextSearch<TRecord> Constructors
Definition
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.
Overloads
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.
public VectorStoreTextSearch(Microsoft.Extensions.VectorData.IVectorizableTextSearch<TRecord> vectorizableTextSearch, Microsoft.SemanticKernel.Data.ITextSearchStringMapper? stringMapper = default, Microsoft.SemanticKernel.Data.ITextSearchResultMapper? resultMapper = default, Microsoft.SemanticKernel.Data.VectorStoreTextSearchOptions? options = default);
new Microsoft.SemanticKernel.Data.VectorStoreTextSearch<'Record> : Microsoft.Extensions.VectorData.IVectorizableTextSearch<'Record> * Microsoft.SemanticKernel.Data.ITextSearchStringMapper * Microsoft.SemanticKernel.Data.ITextSearchResultMapper * Microsoft.SemanticKernel.Data.VectorStoreTextSearchOptions -> Microsoft.SemanticKernel.Data.VectorStoreTextSearch<'Record>
Public Sub New (vectorizableTextSearch As IVectorizableTextSearch(Of TRecord), Optional stringMapper As ITextSearchStringMapper = Nothing, Optional resultMapper As ITextSearchResultMapper = Nothing, Optional options As VectorStoreTextSearchOptions = Nothing)
Parameters
- vectorizableTextSearch
- Microsoft.Extensions.VectorData.IVectorizableTextSearch<TRecord>
Microsoft.Extensions.VectorData.IVectorizableTextSearch`1 instance used to perform the text search.
- stringMapper
- ITextSearchStringMapper
ITextSearchStringMapper instance that can map a TRecord to a String
- resultMapper
- ITextSearchResultMapper
ITextSearchResultMapper instance that can map a TRecord to a TextSearchResult
- options
- VectorStoreTextSearchOptions
Options used to construct an instance of VectorStoreTextSearch<TRecord>
Applies to
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.
public VectorStoreTextSearch(Microsoft.Extensions.VectorData.IVectorizableTextSearch<TRecord> vectorizableTextSearch, Microsoft.SemanticKernel.Data.MapFromResultToString stringMapper, Microsoft.SemanticKernel.Data.MapFromResultToTextSearchResult resultMapper, Microsoft.SemanticKernel.Data.VectorStoreTextSearchOptions? options = default);
new Microsoft.SemanticKernel.Data.VectorStoreTextSearch<'Record> : Microsoft.Extensions.VectorData.IVectorizableTextSearch<'Record> * Microsoft.SemanticKernel.Data.MapFromResultToString * Microsoft.SemanticKernel.Data.MapFromResultToTextSearchResult * Microsoft.SemanticKernel.Data.VectorStoreTextSearchOptions -> Microsoft.SemanticKernel.Data.VectorStoreTextSearch<'Record>
Public Sub New (vectorizableTextSearch As IVectorizableTextSearch(Of TRecord), stringMapper As MapFromResultToString, resultMapper As MapFromResultToTextSearchResult, Optional options As VectorStoreTextSearchOptions = Nothing)
Parameters
- vectorizableTextSearch
- Microsoft.Extensions.VectorData.IVectorizableTextSearch<TRecord>
Microsoft.Extensions.VectorData.IVectorizableTextSearch`1 instance used to perform the text search.
- stringMapper
- MapFromResultToString
MapFromResultToString instance that can map a TRecord to a String
- resultMapper
- MapFromResultToTextSearchResult
MapFromResultToTextSearchResult instance that can map a TRecord to a TextSearchResult
- options
- VectorStoreTextSearchOptions
Options used to construct an instance of VectorStoreTextSearch<TRecord>
Applies to
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.
public VectorStoreTextSearch(Microsoft.Extensions.VectorData.IVectorizedSearch<TRecord> vectorizedSearch, Microsoft.SemanticKernel.Embeddings.ITextEmbeddingGenerationService textEmbeddingGeneration, Microsoft.SemanticKernel.Data.ITextSearchStringMapper? stringMapper = default, Microsoft.SemanticKernel.Data.ITextSearchResultMapper? resultMapper = default, Microsoft.SemanticKernel.Data.VectorStoreTextSearchOptions? options = default);
new Microsoft.SemanticKernel.Data.VectorStoreTextSearch<'Record> : Microsoft.Extensions.VectorData.IVectorizedSearch<'Record> * Microsoft.SemanticKernel.Embeddings.ITextEmbeddingGenerationService * Microsoft.SemanticKernel.Data.ITextSearchStringMapper * Microsoft.SemanticKernel.Data.ITextSearchResultMapper * Microsoft.SemanticKernel.Data.VectorStoreTextSearchOptions -> Microsoft.SemanticKernel.Data.VectorStoreTextSearch<'Record>
Public Sub New (vectorizedSearch As IVectorizedSearch(Of TRecord), textEmbeddingGeneration As ITextEmbeddingGenerationService, Optional stringMapper As ITextSearchStringMapper = Nothing, Optional resultMapper As ITextSearchResultMapper = Nothing, Optional options As VectorStoreTextSearchOptions = Nothing)
Parameters
- vectorizedSearch
- Microsoft.Extensions.VectorData.IVectorizedSearch<TRecord>
Microsoft.Extensions.VectorData.IVectorizedSearch`1 instance used to perform the search.
- textEmbeddingGeneration
- ITextEmbeddingGenerationService
ITextEmbeddingGenerationService instance used to create a vector from the text query.
- stringMapper
- ITextSearchStringMapper
ITextSearchStringMapper instance that can map a TRecord to a String
- resultMapper
- ITextSearchResultMapper
ITextSearchResultMapper instance that can map a TRecord to a TextSearchResult
- options
- VectorStoreTextSearchOptions
Options used to construct an instance of VectorStoreTextSearch<TRecord>
Applies to
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.
public VectorStoreTextSearch(Microsoft.Extensions.VectorData.IVectorizedSearch<TRecord> vectorizedSearch, Microsoft.SemanticKernel.Embeddings.ITextEmbeddingGenerationService textEmbeddingGeneration, Microsoft.SemanticKernel.Data.MapFromResultToString stringMapper, Microsoft.SemanticKernel.Data.MapFromResultToTextSearchResult resultMapper, Microsoft.SemanticKernel.Data.VectorStoreTextSearchOptions? options = default);
new Microsoft.SemanticKernel.Data.VectorStoreTextSearch<'Record> : Microsoft.Extensions.VectorData.IVectorizedSearch<'Record> * Microsoft.SemanticKernel.Embeddings.ITextEmbeddingGenerationService * Microsoft.SemanticKernel.Data.MapFromResultToString * Microsoft.SemanticKernel.Data.MapFromResultToTextSearchResult * Microsoft.SemanticKernel.Data.VectorStoreTextSearchOptions -> Microsoft.SemanticKernel.Data.VectorStoreTextSearch<'Record>
Public Sub New (vectorizedSearch As IVectorizedSearch(Of TRecord), textEmbeddingGeneration As ITextEmbeddingGenerationService, stringMapper As MapFromResultToString, resultMapper As MapFromResultToTextSearchResult, Optional options As VectorStoreTextSearchOptions = Nothing)
Parameters
- vectorizedSearch
- Microsoft.Extensions.VectorData.IVectorizedSearch<TRecord>
Microsoft.Extensions.VectorData.IVectorizedSearch`1 instance used to perform the search.
- textEmbeddingGeneration
- ITextEmbeddingGenerationService
ITextEmbeddingGenerationService instance used to create a vector from the text query.
- stringMapper
- MapFromResultToString
MapFromResultToString instance that can map a TRecord to a String
- resultMapper
- MapFromResultToTextSearchResult
MapFromResultToTextSearchResult instance that can map a TRecord to a TextSearchResult
- options
- VectorStoreTextSearchOptions
Options used to construct an instance of VectorStoreTextSearch<TRecord>