org.openapitools.client.model

Enum IndexMetric

java.lang.Object

java.lang.Enum<IndexMetric>

org.openapitools.client.model.IndexMetric

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IndexMetric>

public enum IndexMetric
extends java.lang.Enum<IndexMetric>

The distance metric to be used for similarity search. You can use 'euclidean', 'cosine', or 'dotproduct'.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IndexMetric.Adapter

Enum Constant Summary

Enum Constants

Enum Constant and Description
COSINE
DOTPRODUCT
EUCLIDEAN

Method Summary

Modifier and Type	Method and Description
static IndexMetric	fromValue(java.lang.String value)
java.lang.String	getValue()
java.lang.String	toString()
static IndexMetric	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IndexMetric[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

COSINE

public static final IndexMetric COSINE

EUCLIDEAN

public static final IndexMetric EUCLIDEAN

DOTPRODUCT

public static final IndexMetric DOTPRODUCT

Method Detail

values

public static IndexMetric[] 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 (IndexMetric c : IndexMetric.values())
    System.out.println(c);

Returns:

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

valueOf

public static IndexMetric valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

getValue

public java.lang.String getValue()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<IndexMetric>

fromValue

public static IndexMetric fromValue(java.lang.String value)