Package org.springframework.ai.openai.api

Record Class OpenAiApi.ChatCompletionMessage

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage

Record Components:

rawContent - The contents of the message. Can be either a OpenAiApi.ChatCompletionMessage.MediaContent or a String. The response message content is always a String.

role - The role of the messages author. Could be one of the OpenAiApi.ChatCompletionMessage.Role types.

name - An optional name for the participant. Provides the model information to differentiate between participants of the same role. In case of Function calling, the name is the function name that the message is responding to.

toolCallId - Tool call that this message is responding to. Only applicable for the OpenAiApi.ChatCompletionMessage.Role.TOOL role and null otherwise.

toolCalls - The tool calls generated by the model, such as function calls. Applicable only for OpenAiApi.ChatCompletionMessage.Role.ASSISTANT role and null otherwise.

refusal - The refusal message by the assistant. Applicable only for OpenAiApi.ChatCompletionMessage.Role.ASSISTANT role and null otherwise.

audioOutput - Audio response from the model.

annotations - Annotations for the message, when applicable, as when using the web search tool.

Enclosing class:

OpenAiApi

public static record OpenAiApi.ChatCompletionMessage(Object rawContent, OpenAiApi.ChatCompletionMessage.Role role, String name, String toolCallId, List<OpenAiApi.ChatCompletionMessage.ToolCall> toolCalls, String refusal, OpenAiApi.ChatCompletionMessage.AudioOutput audioOutput, List<OpenAiApi.ChatCompletionMessage.Annotation> annotations)
extends Record

Message comprising the conversation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OpenAiApi.ChatCompletionMessage.Annotation	Represents an annotation within a message, specifically for URL citations.
static final record	OpenAiApi.ChatCompletionMessage.AudioOutput	Audio response from the model.
static final record	OpenAiApi.ChatCompletionMessage.ChatCompletionFunction	The function definition.
static final record	OpenAiApi.ChatCompletionMessage.MediaContent	An array of content parts with a defined type.
static enum	OpenAiApi.ChatCompletionMessage.Role	The role of the author of this message.
static final record	OpenAiApi.ChatCompletionMessage.ToolCall	The relevant tool call.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionMessage(Object content, OpenAiApi.ChatCompletionMessage.Role role)	Create a chat completion message with the given content and role.
ChatCompletionMessage(Object rawContent, OpenAiApi.ChatCompletionMessage.Role role, String name, String toolCallId, List<OpenAiApi.ChatCompletionMessage.ToolCall> toolCalls, String refusal, OpenAiApi.ChatCompletionMessage.AudioOutput audioOutput, List<OpenAiApi.ChatCompletionMessage.Annotation> annotations)	Creates an instance of a ChatCompletionMessage record class.

Method Summary

Modifier and Type	Method	Description
List<OpenAiApi.ChatCompletionMessage.Annotation>	annotations()	Returns the value of the annotations record component.
OpenAiApi.ChatCompletionMessage.AudioOutput	audioOutput()	Returns the value of the audioOutput record component.
String	content()	Get message content as String.
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.
String	name()	Returns the value of the name record component.
Object	rawContent()	Returns the value of the rawContent record component.
String	refusal()	Returns the value of the refusal record component.
OpenAiApi.ChatCompletionMessage.Role	role()	Returns the value of the role record component.
String	toolCallId()	Returns the value of the toolCallId record component.
List<OpenAiApi.ChatCompletionMessage.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

ChatCompletionMessage

public ChatCompletionMessage(Object content,
 OpenAiApi.ChatCompletionMessage.Role role)

Create a chat completion message with the given content and role. All other fields are null.

Parameters:

content - The contents of the message.

role - The role of the author of this message.

ChatCompletionMessage

public ChatCompletionMessage(Object rawContent,
 OpenAiApi.ChatCompletionMessage.Role role,
 String name,
 String toolCallId,
 List<OpenAiApi.ChatCompletionMessage.ToolCall> toolCalls,
 String refusal,
 OpenAiApi.ChatCompletionMessage.AudioOutput audioOutput,
 List<OpenAiApi.ChatCompletionMessage.Annotation> annotations)

Creates an instance of a ChatCompletionMessage record class.

Parameters:

rawContent - the value for the rawContent record component

role - the value for the role record component

name - the value for the name record component

toolCallId - the value for the toolCallId record component

toolCalls - the value for the toolCalls record component

refusal - the value for the refusal record component

audioOutput - the value for the audioOutput record component

annotations - the value for the annotations record component

Method Details

content

public String content()

Get message content as String.

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.

rawContent

public Object rawContent()

Returns the value of the rawContent record component.

Returns:

the value of the rawContent record component

role

public OpenAiApi.ChatCompletionMessage.Role role()

Returns the value of the role record component.

Returns:

the value of the role record component

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

toolCallId

public String toolCallId()

Returns the value of the toolCallId record component.

Returns:

the value of the toolCallId record component

toolCalls

public List<OpenAiApi.ChatCompletionMessage.ToolCall> toolCalls()

Returns the value of the toolCalls record component.

Returns:

the value of the toolCalls record component

refusal

public String refusal()

Returns the value of the refusal record component.

Returns:

the value of the refusal record component

audioOutput

public OpenAiApi.ChatCompletionMessage.AudioOutput audioOutput()

Returns the value of the audioOutput record component.

Returns:

the value of the audioOutput record component

annotations

public List<OpenAiApi.ChatCompletionMessage.Annotation> annotations()

Returns the value of the annotations record component.

Returns:

the value of the annotations record component