Package org.springframework.ai.mistralai.api

Enum Class MistralAiApi.ChatCompletionMessage.Role

java.lang.Object

java.lang.Enum<MistralAiApi.ChatCompletionMessage.Role>

org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage.Role

All Implemented Interfaces:

Serializable, Comparable<MistralAiApi.ChatCompletionMessage.Role>, Constable

Enclosing class:

MistralAiApi.ChatCompletionMessage

public static enum MistralAiApi.ChatCompletionMessage.Role
extends Enum<MistralAiApi.ChatCompletionMessage.Role>

The role of the author of this message.

NOTE: Mistral expects the system message to be before the user message or will fail with 400 error.

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

Method Summary

Modifier and Type	Method	Description
static MistralAiApi.ChatCompletionMessage.Role	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MistralAiApi.ChatCompletionMessage.Role[]	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 MistralAiApi.ChatCompletionMessage.Role SYSTEM

USER

public static final MistralAiApi.ChatCompletionMessage.Role USER

ASSISTANT

public static final MistralAiApi.ChatCompletionMessage.Role ASSISTANT

TOOL

public static final MistralAiApi.ChatCompletionMessage.Role TOOL

Method Details

values

public static MistralAiApi.ChatCompletionMessage.Role[] 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 MistralAiApi.ChatCompletionMessage.Role 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