Microsoft.SemanticKernel.Data Namespace

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.

Classes

KernelSearchResults<T>	Represents the search results returned from a ITextSearch service.
TextSearchExtensions	Provides extension methods for interacting with ITextSearch.
TextSearchFilter	Used to provide filtering when using ITextSearch.
TextSearchOptions	Options which can be applied when using ITextSearch.
TextSearchResult	Represents a search result retrieved from a ITextSearch instance.
TextSearchResultLinkAttribute	Attribute to mark a property on a record class as the link to the source data.
TextSearchResultMapper	Default implementation of ITextSearchResultMapper that use the MapFromResultToTextSearchResult(Object) delegate.
TextSearchResultNameAttribute	Attribute to mark a property on a record class as the name of the source data.
TextSearchResultValueAttribute	Attribute to mark a property on a record class as the value of the source data.
TextSearchStringMapper	Default implementation of ITextSearchStringMapper that use the MapFromResultToString(Object) delegate.
VectorStoreTextSearch<TRecord>	A Vector Store Text Search implementation that can be used to perform searches using a Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.
VectorStoreTextSearchOptions	Options used to construct an instance of VectorStoreTextSearch<TRecord>. At the moment this is empty but it is being included for future use.

Interfaces

ITextSearch	Interface for text based search queries for use with Semantic Kernel prompts and automatic function calling.
ITextSearchResultMapper	Interface for mapping between a ITextSearch implementation result value, and a TextSearchResult instance.
ITextSearchStringMapper	Interface for mapping between a ITextSearch implementation result value, and a String instance.

Delegates

MapFromResultToString	Delegate to map from an Object which represents a result value associated with a ITextSearch implementation to a a String instance.
MapFromResultToTextSearchResult	Delegate to map from an Object which represents a result value associated with a ITextSearch implementation to a a TextSearchResult instance.