Record Class MistralAiApi.ChatCompletionMessage
java.lang.Object
java.lang.Record
org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage
- Record Components:
content
- The contents of the message.role
- The role of the messages author. Could be one of theMistralAiApi.ChatCompletionMessage.Role
types.name
- The name of the author of the message.toolCalls
- The tool calls generated by the model, such as function calls. Applicable only forMistralAiApi.ChatCompletionMessage.Role.ASSISTANT
role and null otherwise.toolCallId
- Tool call that this message is responding to. Only applicable for theMistralAiApi.ChatCompletionMessage.Role.TOOL
role and null otherwise.
- Enclosing class:
- MistralAiApi
public static record MistralAiApi.ChatCompletionMessage(String content, MistralAiApi.ChatCompletionMessage.Role role, String name, List<MistralAiApi.ChatCompletionMessage.ToolCall> toolCalls, String toolCallId)
extends Record
Message comprising the conversation.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final record
The function definition.static enum
The role of the author of this message.static final record
The relevant tool call. -
Constructor Summary
ConstructorDescriptionChatCompletionMessage
(String content, MistralAiApi.ChatCompletionMessage.Role role) Create a chat completion message with the given content and role.ChatCompletionMessage
(String content, MistralAiApi.ChatCompletionMessage.Role role, String name, List<MistralAiApi.ChatCompletionMessage.ToolCall> toolCalls) Message comprising the conversation.ChatCompletionMessage
(String content, MistralAiApi.ChatCompletionMessage.Role role, String name, List<MistralAiApi.ChatCompletionMessage.ToolCall> toolCalls, String toolCallId) Creates an instance of aChatCompletionMessage
record class. -
Method Summary
Modifier and TypeMethodDescriptioncontent()
Returns the value of thecontent
record component.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.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
public ChatCompletionMessage(String content, MistralAiApi.ChatCompletionMessage.Role role, String name, List<MistralAiApi.ChatCompletionMessage.ToolCall> toolCalls) Message comprising the conversation.- Parameters:
content
- The contents of the message.role
- The role of the messages author. Could be one of theMistralAiApi.ChatCompletionMessage.Role
types.toolCalls
- The tool calls generated by the model, such as function calls. Applicable only forMistralAiApi.ChatCompletionMessage.Role.ASSISTANT
role and null otherwise.
-
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(String content, MistralAiApi.ChatCompletionMessage.Role role, String name, List<MistralAiApi.ChatCompletionMessage.ToolCall> toolCalls, String toolCallId) Creates an instance of aChatCompletionMessage
record class.- Parameters:
content
- the value for thecontent
record componentrole
- the value for therole
record componentname
- the value for thename
record componenttoolCalls
- the value for thetoolCalls
record componenttoolCallId
- the value for thetoolCallId
record component
-
-
Method Details
-
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)
. -
content
Returns the value of thecontent
record component.- Returns:
- the value of the
content
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
-
toolCalls
Returns the value of thetoolCalls
record component.- Returns:
- the value of the
toolCalls
record component
-
toolCallId
Returns the value of thetoolCallId
record component.- Returns:
- the value of the
toolCallId
record component
-