Package org.springframework.ai.ollama.api

Record Class OllamaApi.Message

java.lang.Object

java.lang.Record

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

Record Components:

role - The role of the message of type OllamaApi.Message.Role.

content - The content of the message.

images - The list of base64-encoded images to send with the message. Requires multimodal models such as llava or bakllava.

toolCalls - The relevant tool call.

Enclosing class:

OllamaApi

public static record OllamaApi.Message(OllamaApi.Message.Role role, String content, List<String> images, List<OllamaApi.Message.ToolCall> toolCalls)
extends Record

Chat message object.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OllamaApi.Message.Builder
static enum	OllamaApi.Message.Role	The role of the message in the conversation.
static final record	OllamaApi.Message.ToolCall	The relevant tool call.
static final record	OllamaApi.Message.ToolCallFunction	The function definition.

Constructor Summary

Constructors

Constructor	Description
Message(OllamaApi.Message.Role role, String content, List<String> images, List<OllamaApi.Message.ToolCall> toolCalls)	Creates an instance of a Message record class.

Method Summary

Modifier and Type	Method	Description
static OllamaApi.Message.Builder	builder(OllamaApi.Message.Role role)
String	content()	Returns the value of the content record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<String>	images()	Returns the value of the images record component.
OllamaApi.Message.Role	role()	Returns the value of the role record component.
List<OllamaApi.Message.ToolCall>	toolCalls()	Returns the value of the toolCalls record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Message

public Message(OllamaApi.Message.Role role,
 String content,
 List<String> images,
 List<OllamaApi.Message.ToolCall> toolCalls)

Creates an instance of a Message record class.

Parameters:

role - the value for the role record component

content - the value for the content record component

images - the value for the images record component

toolCalls - the value for the toolCalls record component

Method Details

builder

public static OllamaApi.Message.Builder builder(OllamaApi.Message.Role role)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

role

public OllamaApi.Message.Role role()

Returns the value of the role record component.

Returns:

the value of the role record component

content

public String content()

Returns the value of the content record component.

Returns:

the value of the content record component

images

public List<String> images()

Returns the value of the images record component.

Returns:

the value of the images record component

toolCalls

public List<OllamaApi.Message.ToolCall> toolCalls()

Returns the value of the toolCalls record component.

Returns:

the value of the toolCalls record component