Reference documentation and code samples for the Cloud Firestore V1 Client class DistanceMeasure.
The distance measure to use when comparing vectors.
Protobuf type google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasure
Namespace
Google \ Cloud \ Firestore \ V1 \ StructuredQuery \ FindNearestMethods
static::name
Parameter | |
---|---|
Name | Description |
value |
mixed
|
static::value
Parameter | |
---|---|
Name | Description |
name |
mixed
|
Constants
DISTANCE_MEASURE_UNSPECIFIED
Value: 0
Should not be set.
Generated from protobuf enum DISTANCE_MEASURE_UNSPECIFIED = 0;
EUCLIDEAN
Value: 1
Measures the EUCLIDEAN distance between the vectors. See Euclidean to learn more
Generated from protobuf enum EUCLIDEAN = 1;
COSINE
Value: 2
Compares vectors based on the angle between them, which allows you to measure similarity that isn't based on the vectors magnitude.
We recommend using DOT_PRODUCT with unit normalized vectors instead of COSINE distance, which is mathematically equivalent with better performance. See Cosine Similarity to learn more.
Generated from protobuf enum COSINE = 2;
DOT_PRODUCT
Value: 3
Similar to cosine but is affected by the magnitude of the vectors. See Dot Product to learn more.
Generated from protobuf enum DOT_PRODUCT = 3;