Package org.springframework.ai.ollama.api

Enum Class OllamaApi.Message.Role

java.lang.Object

java.lang.Enum<OllamaApi.Message.Role>

org.springframework.ai.ollama.api.OllamaApi.Message.Role

All Implemented Interfaces:

Serializable, Comparable<OllamaApi.Message.Role>, Constable

Enclosing class:

OllamaApi.Message

public static enum OllamaApi.Message.Role
extends Enum<OllamaApi.Message.Role>

The role of the message in the conversation.

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	Assistant message type.
SYSTEM	System message type used as instructions to the model.
USER	User message type.

Method Summary

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

System message type used as instructions to the model.

USER

public static final OllamaApi.Message.Role USER

User message type.

ASSISTANT

public static final OllamaApi.Message.Role ASSISTANT

Assistant message type. Usually the response from the model.

Method Details

values

public static OllamaApi.Message.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 OllamaApi.Message.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