VectorQuery Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.5.1
Package:
Azure.Search.Documents v11.6.0-beta.4
Source:
VectorQuery.cs
Source:
VectorQuery.cs

The query parameters for vector and hybrid search queries. Please note VectorQuery is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include VectorizableImageBinaryQuery, VectorizableImageUrlQuery, VectorizableTextQuery and VectorizedQuery.

public abstract class VectorQuery
type VectorQuery = class
Public MustInherit Class VectorQuery
Inheritance
Object
VectorQuery
Derived

Constructors

VectorQuery()

Initializes a new instance of VectorQuery.

Properties

Exhaustive

When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values.
Fields

Vector Fields of type Collection(Edm.Single) to be included in the vector searched.
KNearestNeighborsCount

Number of nearest neighbors to return as top hits.
Oversampling

Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field.
Threshold

The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. Please note VectorThreshold is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include SearchScoreThreshold and VectorSimilarityThreshold.
Weight

Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero.

Applies to