BaseVectorQuery interface

  • Reference
Package:
@azure/search-documents

The query parameters for vector and hybrid search queries.

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

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

Number of nearest neighbors to return as top hits.

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

fields

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

fields?: SearchFieldArray<TModel>

Property Value

SearchFieldArray<TModel>

kind

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

kind: "vector"

Property Value

"vector"

kNearestNeighborsCount

Number of nearest neighbors to return as top hits.

kNearestNeighborsCount?: number

Property Value

number