Package com.azure.ai.openai.responses.models

Enum ResponsesMessageRole

java.lang.Object

java.lang.Enum<ResponsesMessageRole>

com.azure.ai.openai.responses.models.ResponsesMessageRole

All Implemented Interfaces:

Serializable, Comparable<ResponsesMessageRole>, java.lang.constant.Constable

public enum ResponsesMessageRole
extends Enum<ResponsesMessageRole>

The collection of valid roles for responses message items.

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
ASSISTANT	Enum value assistant.
DEVELOPER	Enum value developer.
SYSTEM	Enum value system.
USER	Enum value user.

Method Summary

Modifier and Type	Method	Description
static ResponsesMessageRole	fromString(String value)	Parses a serialized value to a ResponsesMessageRole instance.
String	toString()
static ResponsesMessageRole	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ResponsesMessageRole[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SYSTEM

public static final ResponsesMessageRole SYSTEM

Enum value system.

DEVELOPER

public static final ResponsesMessageRole DEVELOPER

Enum value developer.

USER

public static final ResponsesMessageRole USER

Enum value user.

ASSISTANT

public static final ResponsesMessageRole ASSISTANT

Enum value assistant.

Method Details

values

public static ResponsesMessageRole[] values()

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

Returns:

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

valueOf

public static ResponsesMessageRole 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

fromString

public static ResponsesMessageRole fromString(String value)

Parses a serialized value to a ResponsesMessageRole instance.

Parameters:

value - the serialized value to parse.

Returns:

the parsed ResponsesMessageRole object, or null if unable to parse.

toString

public String toString()

Overrides:

toString in class Enum<ResponsesMessageRole>