VectorizableTextQuery interface

Package:

@azure/search-documents

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

Extends

BaseVectorQuery<TModel>

Properties

kind	Polymorphic discriminator, which specifies the different types this object can be
text	The text to be vectorized to perform a vector search query.

Inherited 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.
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.

Property Details

kind

Polymorphic discriminator, which specifies the different types this object can be

kind: "text"

Property Value

"text"

text

The text to be vectorized to perform a vector search query.

text: string

Property Value

string

Inherited Property Details

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.

exhaustive?: boolean

Property Value

boolean

Inherited From BaseVectorQuery.exhaustive

fields

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

fields?: SearchFieldArray<TModel>

Property Value

SearchFieldArray<TModel>

Inherited From BaseVectorQuery.fields

kNearestNeighborsCount

Number of nearest neighbors to return as top hits.

kNearestNeighborsCount?: number

Property Value

number

Inherited From BaseVectorQuery.kNearestNeighborsCount

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.

oversampling?: number

Property Value

number

Inherited From BaseVectorQuery.oversampling

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.

weight?: number

Property Value

number

Inherited From BaseVectorQuery.weight