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 open-mistral-7b and open-mixtral-8x7b This model allows generating chat completion of a sync way based on a list of chat messages. You can find description of parameters here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MistralAiChatModel.MistralAiChatModelBuilder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static MistralAiChatModel.MistralAiChatModelBuilder	builder()
ChatResponse	chat(ChatRequest chatRequest)	This is the main API to interact with the chat model.
ModelProvider	provider()
Set<Capability>	supportedCapabilities()

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

chat, chat, chat, defaultRequestParameters, doChat, listeners

Constructor Details

MistralAiChatModel

public MistralAiChatModel(String baseUrl,
 String apiKey,
 String modelName,
 Double temperature,
 Double topP,
 Integer maxTokens,
 Boolean safePrompt,
 Integer randomSeed,
 ResponseFormat responseFormat,
 Duration timeout,
 Boolean logRequests,
 Boolean logResponses,
 Integer maxRetries,
 Set<Capability> supportedCapabilities)

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

responseFormat - the response format for generating chat responses.

Current values supported are "text" and "json_object".

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

supportedCapabilities

public Set<Capability> supportedCapabilities()

Specified by:

supportedCapabilities in interface ChatLanguageModel

chat

public ChatResponse chat(ChatRequest chatRequest)

Description copied from interface: ChatLanguageModel

This is the main API to interact with the chat model. A temporary default implementation of this method is necessary until all ChatLanguageModel implementations adopt it. It should be removed once that occurs.

Specified by:

chat in interface ChatLanguageModel

Parameters:

chatRequest - a ChatRequest, containing all the inputs to the LLM

Returns:

a ChatResponse, containing all the outputs from the LLM

provider

public ModelProvider provider()

Specified by:

provider in interface ChatLanguageModel

builder

public static MistralAiChatModel.MistralAiChatModelBuilder builder()