java.lang.Object
- com.microsoft.semantickernel.data.VectorStoreTextSearch<Record>

Type Parameters:

Record - The record type.

All Implemented Interfaces:

TextSearch
```
public class VectorStoreTextSearch<Record>
extends Object
implements TextSearch
```
A text search implementation that uses a vector record collection to perform the search.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class VectorStoreTextSearch.Builder<Record>
A builder for the VectorStoreTextSearch class.

Constructor Summary

Constructors
Constructor	Description
`VectorStoreTextSearch(VectorizedSearch<Record> vectorizedSearch, TextEmbeddingGenerationService textEmbeddingGenerationService, TextSearchStringMapper stringMapper, TextSearchResultMapper resultMapper, VectorStoreTextSearchOptions options)`	Create a new instance of VectorStoreTextSearch with `VectorizedSearch` to perform vectorized search and `TextEmbeddingGenerationService` to generate text embeddings.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static <Record> VectorStoreTextSearch.Builder<Record>`	`builder()`	Create a new instance of `VectorStoreTextSearch.Builder`.
`reactor.core.publisher.Mono<KernelSearchResults<Object>>`	`getSearchResultsAsync(String query, TextSearchOptions options)`	Perform a search for content related to the specified query and return Object values representing the search results.
`reactor.core.publisher.Mono<KernelSearchResults<TextSearchResult>>`	`getTextSearchResultsAsync(String query, TextSearchOptions options)`	Perform a search for content related to the specified query and return TextSearchResult values representing the search results.
`reactor.core.publisher.Mono<KernelSearchResults<String>>`	`searchAsync(String query, TextSearchOptions options)`	Perform a search for content related to the specified query and return String values representing the search results.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VectorStoreTextSearch

public VectorStoreTextSearch(@Nonnull
                             VectorizedSearch<Record> vectorizedSearch,
                             @Nonnull
                             TextEmbeddingGenerationService textEmbeddingGenerationService,
                             @Nullable
                             TextSearchStringMapper stringMapper,
                             @Nullable
                             TextSearchResultMapper resultMapper,
                             @Nullable
                             VectorStoreTextSearchOptions options)

Create a new instance of VectorStoreTextSearch with VectorizedSearch to perform vectorized search and TextEmbeddingGenerationService to generate text embeddings.

Parameters:: vectorizedSearch - The vectorized search. Usually a vector record collection.; textEmbeddingGenerationService - The text embedding generation service.; stringMapper - The string mapper.; resultMapper - The result mapper.; options - The options.

Method Detail

searchAsync

public reactor.core.publisher.Mono<KernelSearchResults<String>> searchAsync(String query,
                                                                            TextSearchOptions options)

Perform a search for content related to the specified query and return String values representing the search results.

Specified by:: searchAsync in interface TextSearch
Parameters:: query - The text to search for.; options - The search options.
Returns:: The search results.

getTextSearchResultsAsync

public reactor.core.publisher.Mono<KernelSearchResults<TextSearchResult>> getTextSearchResultsAsync(String query,
                                                                                                    TextSearchOptions options)

Perform a search for content related to the specified query and return TextSearchResult values representing the search results.

Specified by:: getTextSearchResultsAsync in interface TextSearch
Parameters:: query - The text to search for.; options - The search options.
Returns:: The search results.

getSearchResultsAsync

public reactor.core.publisher.Mono<KernelSearchResults<Object>> getSearchResultsAsync(String query,
                                                                                      TextSearchOptions options)

Perform a search for content related to the specified query and return Object values representing the search results.

Specified by:: getSearchResultsAsync in interface TextSearch
Parameters:: query - The text to search for.; options - The search options.
Returns:: The search results.

builder
```
public static <Record> VectorStoreTextSearch.Builder<Record> builder()
```
Create a new instance of VectorStoreTextSearch.Builder.

Type Parameters:

Record - The record type.

Returns:

The builder.

Class VectorStoreTextSearch<Record>

Nested Class Summary