Package org.opensearch.ml.common.model

Enum Class TextEmbeddingModelConfig.PoolingMode

java.lang.Object

java.lang.Enum<TextEmbeddingModelConfig.PoolingMode>

org.opensearch.ml.common.model.TextEmbeddingModelConfig.PoolingMode

All Implemented Interfaces:

Serializable, Comparable<TextEmbeddingModelConfig.PoolingMode>, Constable

Enclosing class:

TextEmbeddingModelConfig

public static enum TextEmbeddingModelConfig.PoolingMode
extends Enum<TextEmbeddingModelConfig.PoolingMode>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLS
LAST_TOKEN
MAX
MEAN
MEAN_SQRT_LEN
WEIGHTED_MEAN

Method Summary

Modifier and Type	Method	Description
static TextEmbeddingModelConfig.PoolingMode	from(String value)
String	getName()
static TextEmbeddingModelConfig.PoolingMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TextEmbeddingModelConfig.PoolingMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MEAN

public static final TextEmbeddingModelConfig.PoolingMode MEAN

MEAN_SQRT_LEN

public static final TextEmbeddingModelConfig.PoolingMode MEAN_SQRT_LEN

MAX

public static final TextEmbeddingModelConfig.PoolingMode MAX

WEIGHTED_MEAN

public static final TextEmbeddingModelConfig.PoolingMode WEIGHTED_MEAN

CLS

public static final TextEmbeddingModelConfig.PoolingMode CLS

LAST_TOKEN

public static final TextEmbeddingModelConfig.PoolingMode LAST_TOKEN

Method Details

values

public static TextEmbeddingModelConfig.PoolingMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static TextEmbeddingModelConfig.PoolingMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getName

public String getName()

from

public static TextEmbeddingModelConfig.PoolingMode from(String value)