Record Class MistralAiApi.ChatCompletionMessage
java.lang.Object
java.lang.Record
org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionMessage
- Record Components:
content- The content of the message. Can be either a list ofMistralAiApi.ChatCompletionMessage.ContentChunkor aString.role- The role of the messages author. Could be one of theMistralAiApi.ChatCompletionMessage.Roletypes.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.ASSISTANTrole and null otherwise.toolCallId- Tool call that this message is responding to. Only applicable for theMistralAiApi.ChatCompletionMessage.Role.TOOLrole and null otherwise.
- Enclosing class:
- MistralAiApi
public static record MistralAiApi.ChatCompletionMessage(@Nullable Object content, @Nullable MistralAiApi.ChatCompletionMessage.Role role, @Nullable String name, @Nullable List<MistralAiApi.ChatCompletionMessage.ToolCall> toolCalls, @Nullable String toolCallId)
extends Record
Message comprising the conversation.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final recordThe function definition.static interfaceMarker interface representing the different content chunks supported.static classstatic classstatic final recordstatic final recordstatic enumThe role of the author of this message.static final recordstatic final recordstatic interfaceMarker interface representing the different thinking content chunks supported.static final recordThe relevant tool call. -
Constructor Summary
ConstructorsConstructorDescriptionChatCompletionMessage(@Nullable Object content, @Nullable MistralAiApi.ChatCompletionMessage.Role role, @Nullable String name, @Nullable List<MistralAiApi.ChatCompletionMessage.ToolCall> toolCalls, @Nullable String toolCallId) Creates an instance of aChatCompletionMessagerecord class.ChatCompletionMessage(@Nullable Object content, MistralAiApi.ChatCompletionMessage.Role role) Create a chat completion message with the given content and role.ChatCompletionMessage(@Nullable Object content, MistralAiApi.ChatCompletionMessage.Role role, @Nullable String name, List<MistralAiApi.ChatCompletionMessage.ToolCall> toolCalls) Message comprising the conversation. -
Method Summary
Modifier and TypeMethodDescription@Nullable Objectcontent()Returns the value of thecontentrecord component.final booleanIndicates whether some other object is "equal to" this one.Extract text content as integers.@Nullable StringExtract text content as string.Extract thinking reference content as integers.@Nullable StringExtract thinking text content as string.final inthashCode()Returns a hash code value for this object.@Nullable Stringname()Returns the value of thenamerecord component.@Nullable MistralAiApi.ChatCompletionMessage.Rolerole()Returns the value of therolerecord component.@Nullable StringReturns the value of thetoolCallIdrecord component.@Nullable List<MistralAiApi.ChatCompletionMessage.ToolCall>Returns the value of thetoolCallsrecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
ChatCompletionMessage
public ChatCompletionMessage(@Nullable Object content, MistralAiApi.ChatCompletionMessage.Role role, @Nullable String name, List<MistralAiApi.ChatCompletionMessage.ToolCall> toolCalls) Message comprising the conversation.- Parameters:
content- The content of the message.role- The role of the messages author. Could be one of theMistralAiApi.ChatCompletionMessage.Roletypes.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.ASSISTANTrole and null otherwise.
-
ChatCompletionMessage
public ChatCompletionMessage(@Nullable Object content, MistralAiApi.ChatCompletionMessage.Role role) Create a chat completion message with the given content and role. All other fields are null.- Parameters:
content- The content of the message.role- The role of the author of this message.
-
ChatCompletionMessage
public ChatCompletionMessage(@Nullable Object content, @Nullable MistralAiApi.ChatCompletionMessage.Role role, @Nullable String name, @Nullable List<MistralAiApi.ChatCompletionMessage.ToolCall> toolCalls, @Nullable String toolCallId) Creates an instance of aChatCompletionMessagerecord class.- Parameters:
content- the value for thecontentrecord componentrole- the value for therolerecord componentname- the value for thenamerecord componenttoolCalls- the value for thetoolCallsrecord componenttoolCallId- the value for thetoolCallIdrecord component
-
-
Method Details
-
extractThinkingReferenceContent
Extract thinking reference content as integers.Note: This method handles only content as a list of
MistralAiApi.ChatCompletionMessage.ThinkChunkcontainingMistralAiApi.ChatCompletionMessage.ReferenceChunk. -
extractThinkingTextContent
Extract thinking text content as string.Note: This method handles only content as a list of
MistralAiApi.ChatCompletionMessage.ThinkChunkcontainingMistralAiApi.ChatCompletionMessage.TextChunk. -
extractTextContent
Extract text content as string.Note: This method handles only content as a list of
MistralAiApi.ChatCompletionMessage.TextChunkor aString. -
extractReferenceContent
Extract text content as integers.Note: This method handles only content as a list of
MistralAiApi.ChatCompletionMessage.ReferenceChunk. -
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 thecontentrecord component.- Returns:
- the value of the
contentrecord component
-
role
Returns the value of therolerecord component.- Returns:
- the value of the
rolerecord component
-
name
Returns the value of thenamerecord component.- Returns:
- the value of the
namerecord component
-
toolCalls
Returns the value of thetoolCallsrecord component.- Returns:
- the value of the
toolCallsrecord component
-
toolCallId
Returns the value of thetoolCallIdrecord component.- Returns:
- the value of the
toolCallIdrecord component
-