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 aOpenAiApi.ChatCompletionMessage.MediaContent
or aString
. The response message content is always aString
.role
- The role of the messages author. Could be one of theOpenAiApi.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 theOpenAiApi.ChatCompletionMessage.Role.TOOL
role and null otherwise.toolCalls
- The tool calls generated by the model, such as function calls. Applicable only forOpenAiApi.ChatCompletionMessage.Role.ASSISTANT
role and null otherwise.refusal
- The refusal message by the assistant. Applicable only forOpenAiApi.ChatCompletionMessage.Role.ASSISTANT
role and null otherwise.audioOutput
- Audio response from the model. >>>>>>> bdb66e577 (OpenAI - Support audio input modality)
- 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)
extends Record
Message comprising the conversation.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final record
Audio response from the model.static final record
The function definition.static final record
An array of content parts with a defined type.static enum
The role of the author of this message.static final record
The relevant tool call. -
Constructor Summary
ConstructorDescriptionChatCompletionMessage
(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) Creates an instance of aChatCompletionMessage
record class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of theaudioOutput
record component.content()
Get message content as String.final boolean
Indicates whether some other object is "equal to" this one.final int
hashCode()
Returns a hash code value for this object.name()
Returns the value of thename
record component.Returns the value of therawContent
record component.refusal()
Returns the value of therefusal
record component.role()
Returns the value of therole
record component.Returns the value of thetoolCallId
record component.Returns the value of thetoolCalls
record component.final String
toString()
Returns a string representation of this record class.
-
Constructor Details
-
ChatCompletionMessage
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) Creates an instance of aChatCompletionMessage
record class.- Parameters:
rawContent
- the value for therawContent
record componentrole
- the value for therole
record componentname
- the value for thename
record componenttoolCallId
- the value for thetoolCallId
record componenttoolCalls
- the value for thetoolCalls
record componentrefusal
- the value for therefusal
record componentaudioOutput
- the value for theaudioOutput
record component
-
-
Method Details
-
content
Get message content as 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. -
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. -
equals
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 withObjects::equals(Object,Object)
. -
rawContent
Returns the value of therawContent
record component.- Returns:
- the value of the
rawContent
record component
-
role
Returns the value of therole
record component.- Returns:
- the value of the
role
record component
-
name
Returns the value of thename
record component.- Returns:
- the value of the
name
record component
-
toolCallId
Returns the value of thetoolCallId
record component.- Returns:
- the value of the
toolCallId
record component
-
toolCalls
Returns the value of thetoolCalls
record component.- Returns:
- the value of the
toolCalls
record component
-
refusal
Returns the value of therefusal
record component.- Returns:
- the value of the
refusal
record component
-
audioOutput
Returns the value of theaudioOutput
record component.- Returns:
- the value of the
audioOutput
record component
-