VectorizableTextQuery Class

Definition

Namespace:

Azure.Search.Documents.Models

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.6.0-beta.4

Source:

VectorizableTextQuery.cs

The query parameters to use for vector search when a text value that needs to be vectorized is provided.

public class VectorizableTextQuery : Azure.Search.Documents.Models.VectorQuery

type VectorizableTextQuery = class
    inherit VectorQuery

Public Class VectorizableTextQuery
Inherits VectorQuery

Inheritance

Object

VectorQuery

VectorizableTextQuery

Constructors

VectorizableTextQuery(String)

Initializes a new instance of VectorizableTextQuery.

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. (Inherited from VectorQuery)
Fields	Vector Fields of type Collection(Edm.Single) to be included in the vector searched. (Inherited from VectorQuery)
KNearestNeighborsCount	Number of nearest neighbors to return as top hits. (Inherited from VectorQuery)
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. (Inherited from VectorQuery)
Text	The text to be vectorized to perform a vector search query.
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. (Inherited from VectorQuery)
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. (Inherited from VectorQuery)