Enum StructuredQuery.FindNearest.DistanceMeasure (3.28.0)

public enum StructuredQuery.FindNearest.DistanceMeasure extends Enum<StructuredQuery.FindNearest.DistanceMeasure> implements ProtocolMessageEnum

The distance measure to use when comparing vectors.

Protobuf enum google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasure

Implements

ProtocolMessageEnum

Static Fields

Name Description
COSINE

COSINE distance 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 about COSINE similarity and COSINE distance. The resulting COSINE distance decreases the more similar two vectors are.

COSINE = 2;

COSINE_VALUE

COSINE distance 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 about COSINE similarity and COSINE distance. The resulting COSINE distance decreases the more similar two vectors are.

COSINE = 2;

DISTANCE_MEASURE_UNSPECIFIED

Should not be set.

DISTANCE_MEASURE_UNSPECIFIED = 0;

DISTANCE_MEASURE_UNSPECIFIED_VALUE

Should not be set.

DISTANCE_MEASURE_UNSPECIFIED = 0;

DOT_PRODUCT

Similar to cosine but is affected by the magnitude of the vectors. See Dot Product to learn more. The resulting distance increases the more similar two vectors are.

DOT_PRODUCT = 3;

DOT_PRODUCT_VALUE

Similar to cosine but is affected by the magnitude of the vectors. See Dot Product to learn more. The resulting distance increases the more similar two vectors are.

DOT_PRODUCT = 3;

EUCLIDEAN

Measures the EUCLIDEAN distance between the vectors. See Euclidean to learn more. The resulting distance decreases the more similar two vectors are.

EUCLIDEAN = 1;

EUCLIDEAN_VALUE

Measures the EUCLIDEAN distance between the vectors. See Euclidean to learn more. The resulting distance decreases the more similar two vectors are.

EUCLIDEAN = 1;

UNRECOGNIZED

Static Methods

Name Description
forNumber(int value)
getDescriptor()
internalGetValueMap()
valueOf(Descriptors.EnumValueDescriptor desc)
valueOf(int value)

Deprecated. Use #forNumber(int) instead.

valueOf(String name)
values()

Methods

Name Description
getDescriptorForType()
getNumber()
getValueDescriptor()