VectorizedQuery interface

  • Reference
Package:
@azure/search-documents

The query parameters to use for vector search when a raw vector value is provided.

Extends

BaseVectorQuery<TModel>

Properties

kind

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

The vector representation of a 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.

Property Details

kind

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

kind: "vector"

Property Value

"vector"

vector

The vector representation of a search query.

vector: number[]

Property Value

number[]

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