com.google.cloud.aiplatform.v1beta1

Enum FeatureView.VectorSearchConfig.DistanceMeasureType

java.lang.Object

java.lang.Enum<FeatureView.VectorSearchConfig.DistanceMeasureType>

com.google.cloud.aiplatform.v1beta1.FeatureView.VectorSearchConfig.DistanceMeasureType

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<FeatureView.VectorSearchConfig.DistanceMeasureType>

Enclosing class:

FeatureView.VectorSearchConfig

public static enum FeatureView.VectorSearchConfig.DistanceMeasureType
extends Enum<FeatureView.VectorSearchConfig.DistanceMeasureType>
implements com.google.protobuf.ProtocolMessageEnum

Protobuf enum google.cloud.aiplatform.v1beta1.FeatureView.VectorSearchConfig.DistanceMeasureType

Enum Constant Summary

Enum Constants

Enum Constant and Description
COSINE_DISTANCE Cosine Distance.
DISTANCE_MEASURE_TYPE_UNSPECIFIED Should not be set.
DOT_PRODUCT_DISTANCE Dot Product Distance.
SQUARED_L2_DISTANCE Euclidean (L_2) Distance.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	COSINE_DISTANCE_VALUE Cosine Distance.
static int	DISTANCE_MEASURE_TYPE_UNSPECIFIED_VALUE Should not be set.
static int	DOT_PRODUCT_DISTANCE_VALUE Dot Product Distance.
static int	SQUARED_L2_DISTANCE_VALUE Euclidean (L_2) Distance.

Method Summary

Modifier and Type	Method and Description
static FeatureView.VectorSearchConfig.DistanceMeasureType	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<FeatureView.VectorSearchConfig.DistanceMeasureType>	internalGetValueMap()
static FeatureView.VectorSearchConfig.DistanceMeasureType	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static FeatureView.VectorSearchConfig.DistanceMeasureType	valueOf(int value) Deprecated. Use forNumber(int) instead.
static FeatureView.VectorSearchConfig.DistanceMeasureType	valueOf(String name) Returns the enum constant of this type with the specified name.
static FeatureView.VectorSearchConfig.DistanceMeasureType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISTANCE_MEASURE_TYPE_UNSPECIFIED

public static final FeatureView.VectorSearchConfig.DistanceMeasureType DISTANCE_MEASURE_TYPE_UNSPECIFIED

 Should not be set.
 

DISTANCE_MEASURE_TYPE_UNSPECIFIED = 0;

SQUARED_L2_DISTANCE

public static final FeatureView.VectorSearchConfig.DistanceMeasureType SQUARED_L2_DISTANCE

 Euclidean (L_2) Distance.
 

SQUARED_L2_DISTANCE = 1;

COSINE_DISTANCE

public static final FeatureView.VectorSearchConfig.DistanceMeasureType COSINE_DISTANCE

 Cosine Distance. Defined as 1 - cosine similarity.

 We strongly suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead
 of COSINE distance. Our algorithms have been more optimized for
 DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is
 mathematically equivalent to COSINE distance and results in the same
 ranking.
 

COSINE_DISTANCE = 2;

DOT_PRODUCT_DISTANCE

public static final FeatureView.VectorSearchConfig.DistanceMeasureType DOT_PRODUCT_DISTANCE

 Dot Product Distance. Defined as a negative of the dot product.
 

DOT_PRODUCT_DISTANCE = 3;

UNRECOGNIZED

public static final FeatureView.VectorSearchConfig.DistanceMeasureType UNRECOGNIZED

Field Detail

DISTANCE_MEASURE_TYPE_UNSPECIFIED_VALUE

public static final int DISTANCE_MEASURE_TYPE_UNSPECIFIED_VALUE

 Should not be set.
 

DISTANCE_MEASURE_TYPE_UNSPECIFIED = 0;

See Also:

Constant Field Values

SQUARED_L2_DISTANCE_VALUE

public static final int SQUARED_L2_DISTANCE_VALUE

 Euclidean (L_2) Distance.
 

SQUARED_L2_DISTANCE = 1;

See Also:

Constant Field Values

COSINE_DISTANCE_VALUE

public static final int COSINE_DISTANCE_VALUE

 Cosine Distance. Defined as 1 - cosine similarity.

 We strongly suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead
 of COSINE distance. Our algorithms have been more optimized for
 DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is
 mathematically equivalent to COSINE distance and results in the same
 ranking.
 

COSINE_DISTANCE = 2;

See Also:

Constant Field Values

DOT_PRODUCT_DISTANCE_VALUE

public static final int DOT_PRODUCT_DISTANCE_VALUE

 Dot Product Distance. Defined as a negative of the dot product.
 

DOT_PRODUCT_DISTANCE = 3;

See Also:

Constant Field Values

Method Detail

values

public static FeatureView.VectorSearchConfig.DistanceMeasureType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FeatureView.VectorSearchConfig.DistanceMeasureType c : FeatureView.VectorSearchConfig.DistanceMeasureType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FeatureView.VectorSearchConfig.DistanceMeasureType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static FeatureView.VectorSearchConfig.DistanceMeasureType valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static FeatureView.VectorSearchConfig.DistanceMeasureType forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<FeatureView.VectorSearchConfig.DistanceMeasureType> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static FeatureView.VectorSearchConfig.DistanceMeasureType valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)