VectorSearchOptions Class

Definition

Namespace:

Microsoft.Extensions.VectorData

Assembly:

Microsoft.Extensions.VectorData.Abstractions.dll

Package:

Microsoft.Extensions.VectorData.Abstractions v9.0.0-preview.1.25078.1

Options for vector search.

public ref class VectorSearchOptions

public class VectorSearchOptions

type VectorSearchOptions = class

Public Class VectorSearchOptions

Inheritance

Object

VectorSearchOptions

Constructors

VectorSearchOptions()

Properties

Filter	Gets or sets a search filter to use before doing the vector search.
IncludeTotalCount	Gets or sets a value indicating whether the total count should be included in the results.
IncludeVectors	Gets or sets a value indicating whether to include vectors in the retrieval result.
Skip	Gets or sets the number of results to skip before returning results, i.e. the index of the first result to return.
Top	Gets or sets the maximum number of results to return.
VectorPropertyName	Gets or sets the name of the vector property to search on. Use the name of the vector property from your data model or as provided in the record definition. If not provided will default to the first vector property in the schema.