Package dev.langchain4j.model.mistralai

Class MistralAiChatModel

java.lang.Object

dev.langchain4j.model.mistralai.MistralAiChatModel

All Implemented Interfaces:

ChatLanguageModel

public class MistralAiChatModel
extends Object
implements ChatLanguageModel

Represents a Mistral AI Chat Model with a chat completion interface, such as mistral-tiny and mistral-small. This model allows generating chat completion of a sync way based on a list of chat messages. You can find description of parameters here.

Constructor Summary

Constructors

Constructor	Description
MistralAiChatModel(String baseUrl, String apiKey, String modelName, Double temperature, Double topP, Integer maxTokens, Boolean safePrompt, Integer randomSeed, Duration timeout, Boolean logRequests, Boolean logResponses, Integer maxRetries)	Constructs a MistralAiChatModel with the specified parameters.

Method Summary

Modifier and Type	Method	Description
Response<AiMessage>	generate(List<ChatMessage> messages)	Generates chat response based on the given list of messages.
static MistralAiChatModel	withApiKey(String apiKey)	Creates a MistralAiChatModel with the specified API key.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.model.chat.ChatLanguageModel

generate, generate, generate, generate

Constructor Details

MistralAiChatModel

public MistralAiChatModel(String baseUrl,
 String apiKey,
 String modelName,
 Double temperature,
 Double topP,
 Integer maxTokens,
 Boolean safePrompt,
 Integer randomSeed,
 Duration timeout,
 Boolean logRequests,
 Boolean logResponses,
 Integer maxRetries)

Constructs a MistralAiChatModel with the specified parameters.

Parameters:

baseUrl - the base URL of the Mistral AI API. It uses the default value if not specified

apiKey - the API key for authentication

modelName - the name of the Mistral AI model to use

temperature - the temperature parameter for generating chat responses

topP - the top-p parameter for generating chat responses

maxTokens - the maximum number of new tokens to generate in a chat response

safePrompt - a flag indicating whether to use a safe prompt for generating chat responses

randomSeed - the random seed for generating chat responses

timeout - the timeout duration for API requests

The default value is 60 seconds

logRequests - a flag indicating whether to log API requests

logResponses - a flag indicating whether to log API responses

maxRetries - the maximum number of retries for API requests. It uses the default value 3 if not specified

Method Details

withApiKey

public static MistralAiChatModel withApiKey(String apiKey)

Creates a MistralAiChatModel with the specified API key.

Parameters:

apiKey - the API key for authentication

Returns:

a MistralAiChatModel instance

generate

public Response<AiMessage> generate(List<ChatMessage> messages)

Generates chat response based on the given list of messages.

Specified by:

generate in interface ChatLanguageModel

Parameters:

messages - the list of chat messages