Interface VectorQueryOptions (7.11.0)

Version latest

• 7.11.0 (latest)
• 7.9.0
• 7.7.0
• 7.6.0
• 7.5.0
• 7.4.0
• 7.3.1
• 7.2.0
• 7.1.0
• 6.4.1
• 6.3.0
• 6.0.0
• 5.0.2
• 4.15.1
• 4.14.2
• 4.9.8

Specifies the behavior of the VectorQuery generated by a call to .

Package

@google-cloud/firestore

Properties

distanceMeasure

distanceMeasure: 'EUCLIDEAN' | 'COSINE' | 'DOT_PRODUCT';

Specifies what type of distance is calculated when performing the query.

distanceResultField

distanceResultField?: string | firestore.FieldPath;

Optionally specifies the name of a field that will be set on each returned DocumentSnapshot, which will contain the computed distance for the document.

distanceThreshold

distanceThreshold?: number;

Specifies a threshold for which no less similar documents will be returned. The behavior of the specified distanceMeasure will affect the meaning of the distance threshold.

• For distanceMeasure: "EUCLIDEAN", the meaning of distanceThreshold is: SELECT docs WHERE euclidean_distance <= distanceThreshold - For distanceMeasure: "COSINE", the meaning of distanceThreshold is: SELECT docs WHERE cosine_distance <= distanceThreshold - For distanceMeasure: "DOT_PRODUCT", the meaning of distanceThreshold is: SELECT docs WHERE dot_product_distance >= distanceThreshold

limit

limit: number;

Specifies the upper bound of documents to return, must be a positive integer with a maximum value of 1000.

queryVector

queryVector: firestore.VectorValue | Array<number>;

The VectorValue used to measure the distance from vectorField values in the documents.

vectorField

vectorField: string | firestore.FieldPath;

A string or FieldPath specifying the vector field to search on.