Package com.sap.ai.sdk.foundationmodels.openai.generated.model

Enum Class ChatCompletionRequestFunctionMessage.RoleEnum

java.lang.Object

java.lang.Enum<ChatCompletionRequestFunctionMessage.RoleEnum>

com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionRequestFunctionMessage.RoleEnum

All Implemented Interfaces:

Serializable, Comparable<ChatCompletionRequestFunctionMessage.RoleEnum>, Constable

Enclosing class:

ChatCompletionRequestFunctionMessage

public static enum ChatCompletionRequestFunctionMessage.RoleEnum
extends Enum<ChatCompletionRequestFunctionMessage.RoleEnum>

The role of the messages author, in this case `function`.

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
FUNCTION	The FUNCTION option of this ChatCompletionRequestFunctionMessage
UNKNOWN_DEFAULT_OPEN_API	The UNKNOWN_DEFAULT_OPEN_API option of this ChatCompletionRequestFunctionMessage

Method Summary

Modifier and Type	Method	Description
static ChatCompletionRequestFunctionMessage.RoleEnum	fromValue(String value)	Get the enum value from a String value
String	getValue()	Get the value of the enum
String	toString()	Get the String value of the enum value.
static ChatCompletionRequestFunctionMessage.RoleEnum	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChatCompletionRequestFunctionMessage.RoleEnum[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FUNCTION

public static final ChatCompletionRequestFunctionMessage.RoleEnum FUNCTION

The FUNCTION option of this ChatCompletionRequestFunctionMessage

UNKNOWN_DEFAULT_OPEN_API

public static final ChatCompletionRequestFunctionMessage.RoleEnum UNKNOWN_DEFAULT_OPEN_API

The UNKNOWN_DEFAULT_OPEN_API option of this ChatCompletionRequestFunctionMessage

Method Details

values

public static ChatCompletionRequestFunctionMessage.RoleEnum[] 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 ChatCompletionRequestFunctionMessage.RoleEnum 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

getValue

@Nonnull
public String getValue()

Get the value of the enum

Returns:

The enum value

toString

@Nonnull
public String toString()

Get the String value of the enum value.

Overrides:

toString in class Enum<ChatCompletionRequestFunctionMessage.RoleEnum>

Returns:

The enum value as String

fromValue

@Nonnull
public static ChatCompletionRequestFunctionMessage.RoleEnum fromValue(@Nonnull
 String value)

Get the enum value from a String value

Parameters:

value - The String value

Returns:

The enum value of type ChatCompletionRequestFunctionMessage