VectorSearchOptions<TRecord> Class

Definition

Namespace:: Microsoft.Extensions.VectorData

Assembly:: Microsoft.Extensions.VectorData.Abstractions.dll

Package:: Microsoft.Extensions.VectorData.Abstractions v9.6.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.

Defines options for vector search via SearchAsync<TInput>(TInput, Int32, VectorSearchOptions<TRecord>, CancellationToken).

generic <typename TRecord>
public ref class VectorSearchOptions

public class VectorSearchOptions<TRecord>

type VectorSearchOptions<'Record> = class

Public Class VectorSearchOptions(Of TRecord)

Type Parameters

TRecord

Inheritance: Object
VectorSearchOptions<TRecord>

Constructors

VectorSearchOptions<TRecord>()

Properties

Filter	Gets or sets a search filter to use before doing the vector search.
IncludeVectors	Gets or sets a value indicating whether to include vectors in the retrieval result.
OldFilter	Obsolete. Gets or sets a search filter to use before doing the vector search.
Skip	Gets or sets the number of results to skip before returning results, that is, the index of the first result to return.
VectorProperty	Gets or sets the vector property to search on. Only needs to be set when the collection has multiple vector properties.

Applies to