Package org.springframework.ai.mistralai

Class MistralAiChatModel

java.lang.Object

org.springframework.ai.mistralai.MistralAiChatModel

All Implemented Interfaces:

ChatModel, StreamingChatModel, Model<Prompt,ChatResponse>, StreamingModel<Prompt,ChatResponse>

public class MistralAiChatModel
extends Object
implements ChatModel

Represents a Mistral AI Chat Model.

The assistant message of each choice is built from ordered MessageParts that follow the content chunks Mistral returns: a text chunk, or a plain string content, becomes a TextPart, a thinking chunk a ReasoningPart, and any other chunk, such as the reference of a citation, an UnknownPart that holds it verbatim. Tool calls are a separate field of a Mistral message, so their ToolCallParts always follow the content.

An assistant message that carries Mistral reasoning or other Mistral chunks is replayed as content chunks in part order, so a reasoning model gets its earlier thinking back next to the answer it led to, as Mistral recommends. Any other assistant message is sent as its text, as before.

Since:

1.0.0

Author:

Ricken Bazolo, Christian Tzolov, Grogdunn, Thomas Vitale, luocongqiu, Ilayaperumal Gopinathan, Alexandros Pappas, Nicolas Krier, Jason Smith, Sebastien Deleuze, Dimitar Proynov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MistralAiChatModel.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	REFERENCE_CONTENT_METADATA
static final String	REFERENCE_THINKING_CONTENT_METADATA
static final String	SIGNATURE_PAYLOAD_KIND	The kind of the payload that holds the signature of a thinking chunk.
static final String	THINKING_CONTENT_METADATA	Deprecated, for removal: This API element is subject to removal in a future version. since 2.1.0 in favor of AssistantMessage.getReasoning()

Constructor Summary

Constructors

Constructor	Description
MistralAiChatModel(MistralAiApi mistralAiApi, MistralAiChatOptions options, ToolCallingManager toolCallingManager, org.springframework.core.retry.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)

Method Summary

Modifier and Type	Method	Description
static MistralAiChatModel.Builder	builder()
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
static ChatResponseMetadata	from(MistralAiApi.ChatCompletion result)
static ChatResponseMetadata	from(MistralAiApi.ChatCompletion result, Usage usage)
MistralAiChatOptions	getOptions()	Gets the chat options for this model.
void	setObservationConvention(ChatModelObservationConvention observationConvention)	Use the provided convention for reporting observation data
reactor.core.publisher.Flux<ChatResponse>	stream(Prompt prompt)	Executes a method call to the AI model.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.ai.chat.model.ChatModel

call, call, getDefaultOptions

Methods inherited from interface org.springframework.ai.chat.model.StreamingChatModel

stream, stream

Field Details

REFERENCE_CONTENT_METADATA

public static final String REFERENCE_CONTENT_METADATA

See Also:

• Constant Field Values

REFERENCE_THINKING_CONTENT_METADATA

public static final String REFERENCE_THINKING_CONTENT_METADATA

See Also:

• Constant Field Values

THINKING_CONTENT_METADATA

@Deprecated(since="2.1.0",
            forRemoval=true)
public static final String THINKING_CONTENT_METADATA

Deprecated, for removal: This API element is subject to removal in a future version.

since 2.1.0 in favor of AssistantMessage.getReasoning()

Key of the thinking text in the message metadata. Superseded by the ReasoningParts of the message, see AssistantMessage.getReasoning(). Still written for backward compatibility, and read on replay only from an assistant message without reasoning parts, such as one built by an earlier version. Unlike the text of a ReasoningPart, it joins the text chunks of the thinking with a line separator.

See Also:

• Constant Field Values

SIGNATURE_PAYLOAD_KIND

public static final String SIGNATURE_PAYLOAD_KIND

The kind of the payload that holds the signature of a thinking chunk.

Since:

2.1.0

See Also:

• Constant Field Values

Constructor Details

MistralAiChatModel

public MistralAiChatModel(MistralAiApi mistralAiApi,
 MistralAiChatOptions options,
 ToolCallingManager toolCallingManager,
 org.springframework.core.retry.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Method Details

from

public static ChatResponseMetadata from(MistralAiApi.ChatCompletion result)

from

public static ChatResponseMetadata from(MistralAiApi.ChatCompletion result,
 Usage usage)

call

public ChatResponse call(Prompt prompt)

Description copied from interface: Model

Executes a method call to the AI model.

Specified by:

call in interface ChatModel

Specified by:

call in interface Model<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the response from the AI model

stream

public reactor.core.publisher.Flux<ChatResponse> stream(Prompt prompt)

Description copied from interface: StreamingModel

Executes a method call to the AI model.

Specified by:

stream in interface ChatModel

Specified by:

stream in interface StreamingChatModel

Specified by:

stream in interface StreamingModel<Prompt,ChatResponse>

Parameters:

prompt - the request object to be sent to the AI model

Returns:

the streaming response from the AI model

getOptions

public MistralAiChatOptions getOptions()

Description copied from interface: ChatModel

Gets the chat options for this model.

Specified by:

getOptions in interface ChatModel

Returns:

the chat options

Since:

2.0.0

setObservationConvention

public void setObservationConvention(ChatModelObservationConvention observationConvention)

Use the provided convention for reporting observation data

Parameters:

observationConvention - The provided convention

builder

public static MistralAiChatModel.Builder builder()