Package org.springframework.ai.mistralai

Class MistralAiChatModel

java.lang.Object

org.springframework.ai.chat.model.AbstractToolCallSupport

org.springframework.ai.mistralai.MistralAiChatModel

All Implemented Interfaces:

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

public class MistralAiChatModel
extends AbstractToolCallSupport
implements ChatModel

Represents a Mistral AI Chat Model.

Since:

1.0.0

Author:

Ricken Bazolo, Christian Tzolov, Grogdunn, Thomas Vitale, luocongqiu

Field Summary

Fields inherited from class org.springframework.ai.chat.model.AbstractToolCallSupport

functionCallbackContext, functionCallbackRegister, IS_RUNTIME_CALL

Constructor Summary

Constructors

Constructor	Description
MistralAiChatModel(MistralAiApi mistralAiApi)
MistralAiChatModel(MistralAiApi mistralAiApi, MistralAiChatOptions options)
MistralAiChatModel(MistralAiApi mistralAiApi, MistralAiChatOptions options, FunctionCallbackContext functionCallbackContext, List<FunctionCallback> toolFunctionCallbacks, org.springframework.retry.support.RetryTemplate retryTemplate)
MistralAiChatModel(MistralAiApi mistralAiApi, MistralAiChatOptions options, FunctionCallbackContext functionCallbackContext, List<FunctionCallback> toolFunctionCallbacks, org.springframework.retry.support.RetryTemplate retryTemplate, io.micrometer.observation.ObservationRegistry observationRegistry)
MistralAiChatModel(MistralAiApi mistralAiApi, MistralAiChatOptions options, FunctionCallbackContext functionCallbackContext, org.springframework.retry.support.RetryTemplate retryTemplate)

Method Summary

Modifier and Type	Method	Description
ChatResponse	call(Prompt prompt)	Executes a method call to the AI model.
static ChatResponseMetadata	from(MistralAiApi.ChatCompletion result)
ChatOptions	getDefaultOptions()
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 org.springframework.ai.chat.model.AbstractToolCallSupport

buildToolCallConversation, executeFunctions, getFunctionCallbackRegister, handleToolCalls, isProxyToolCalls, isToolCall, isToolCall, resolveFunctionCallbacks, runtimeFunctionCallbackConfigurations

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

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

stream, stream

Constructor Details

MistralAiChatModel

public MistralAiChatModel(MistralAiApi mistralAiApi)

MistralAiChatModel

public MistralAiChatModel(MistralAiApi mistralAiApi,
 MistralAiChatOptions options)

MistralAiChatModel

public MistralAiChatModel(MistralAiApi mistralAiApi,
 MistralAiChatOptions options,
 FunctionCallbackContext functionCallbackContext,
 org.springframework.retry.support.RetryTemplate retryTemplate)

MistralAiChatModel

public MistralAiChatModel(MistralAiApi mistralAiApi,
 MistralAiChatOptions options,
 FunctionCallbackContext functionCallbackContext,
 List<FunctionCallback> toolFunctionCallbacks,
 org.springframework.retry.support.RetryTemplate retryTemplate)

MistralAiChatModel

public MistralAiChatModel(MistralAiApi mistralAiApi,
 MistralAiChatOptions options,
 FunctionCallbackContext functionCallbackContext,
 List<FunctionCallback> toolFunctionCallbacks,
 org.springframework.retry.support.RetryTemplate retryTemplate,
 io.micrometer.observation.ObservationRegistry observationRegistry)

Method Details

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

from

public static ChatResponseMetadata from(MistralAiApi.ChatCompletion result)

getDefaultOptions

public ChatOptions getDefaultOptions()

Specified by:

getDefaultOptions in interface ChatModel

setObservationConvention

public void setObservationConvention(ChatModelObservationConvention observationConvention)

Use the provided convention for reporting observation data

Parameters:

observationConvention - The provided convention