Class VectorQuery

Represents a vector query.

Uncommitted: This API is subject to change in the future.

Hierarchy

VectorQuery

Index

Constructors

Methods

boost numCandidates create

Constructors

constructor

new VectorQuery(fieldName, vector): VectorQuery
Parameters
- fieldName: string
- vector: number[]
Returns VectorQuery
- Defined in lib/vectorsearch.ts:47

Methods

boost

boost(boost): VectorQuery
Adds boost option to vector query.

Uncommitted: This API is subject to change in the future.
Parameters
- boost: number
  A floating point value.
Returns VectorQuery
- Defined in lib/vectorsearch.ts:79

numCandidates

numCandidates(numCandidates): VectorQuery
Adds numCandidates option to vector query. Value must be >= 1.

Uncommitted: This API is subject to change in the future.
Parameters
- numCandidates: number
  An integer value.
Returns VectorQuery
- Defined in lib/vectorsearch.ts:91

`Static` create

create(fieldName, vector): VectorQuery
Creates a vector query.

Uncommitted: This API is subject to change in the future.
Parameters
- fieldName: string
  The name of the field in the JSON document that holds the vector.
- vector: number[]
  List of floating point values that represent the vector.
Returns VectorQuery
- Defined in lib/vectorsearch.ts:109

Generated using TypeDoc