Package nl.dannyj.mistral.models.completion

Enum Class MessageRole

java.lang.Object

java.lang.Enum<MessageRole>

nl.dannyj.mistral.models.completion.MessageRole

All Implemented Interfaces:

Serializable, Comparable<MessageRole>, Constable

public enum MessageRole
extends Enum<MessageRole>

The role of the message.

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
SYSTEM
USER

Method Summary

Modifier and Type	Method	Description
String	getRole()	Returns a lowercase string representation of the role.
static MessageRole	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MessageRole[]	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

SYSTEM

public static final MessageRole SYSTEM

ASSISTANT

public static final MessageRole ASSISTANT

USER

public static final MessageRole USER

Method Details

values

public static MessageRole[] 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 MessageRole 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

getRole

public String getRole()

Returns a lowercase string representation of the role. To be used when interacting with the API.

Returns:

A lowercase string representation of the role.