Package io.github.sashirestela.openai.domain.embedding

Enum EmbeddingRequest.EncodingFormat

java.lang.Object

java.lang.Enum<EmbeddingRequest.EncodingFormat>

io.github.sashirestela.openai.domain.embedding.EmbeddingRequest.EncodingFormat

All Implemented Interfaces:

Serializable, Comparable<EmbeddingRequest.EncodingFormat>

Enclosing class:

EmbeddingRequest

public static enum EmbeddingRequest.EncodingFormat
extends Enum<EmbeddingRequest.EncodingFormat>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASE64
FLOAT

Method Summary

Modifier and Type	Method	Description
static EmbeddingRequest.EncodingFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EmbeddingRequest.EncodingFormat[]	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

FLOAT

public static final EmbeddingRequest.EncodingFormat FLOAT

BASE64

public static final EmbeddingRequest.EncodingFormat BASE64

Method Detail

values

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

Returns:

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

valueOf

public static EmbeddingRequest.EncodingFormat 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