Package dev.langchain4j.model.mistralai

Class MistralAiChatModel

java.lang.Object

dev.langchain4j.model.mistralai.MistralAiChatModel

All Implemented Interfaces:

ChatModel

public class MistralAiChatModel
extends Object
implements ChatModel

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(HttpClientBuilder httpClientBuilder, 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)	Deprecated, for removal: This API element is subject to removal in a future version. Please use builder() instead.
MistralAiChatModel(MistralAiChatModel.MistralAiChatModelBuilder builder)
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)	Deprecated, for removal: This API element is subject to removal in a future version. Please use builder() instead.

Method Summary

Modifier and Type	Method	Description
static MistralAiChatModel.MistralAiChatModelBuilder	builder()
ChatRequestParameters	defaultRequestParameters()
ChatResponse	doChat(ChatRequest chatRequest)
List<ChatModelListener>	listeners()
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.ChatModel

chat, chat, chat, chat

Constructor Details

MistralAiChatModel

public MistralAiChatModel(MistralAiChatModel.MistralAiChatModelBuilder builder)

MistralAiChatModel

@Deprecated(forRemoval=true)
public MistralAiChatModel(HttpClientBuilder httpClientBuilder,
 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)

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

Please use builder() instead.

Constructs a MistralAiChatModel with the specified parameters.

Parameters:

httpClientBuilder - the HTTP client builder to use for creating the HTTP client

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

supportedCapabilities - the set of capabilities supported by this model

MistralAiChatModel

@Deprecated(forRemoval=true)
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)

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

Please use builder() instead.

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

supportedCapabilities - the set of capabilities supported by this model

Method Details

doChat

public ChatResponse doChat(ChatRequest chatRequest)

Specified by:

doChat in interface ChatModel

defaultRequestParameters

public ChatRequestParameters defaultRequestParameters()

Specified by:

defaultRequestParameters in interface ChatModel

listeners

public List<ChatModelListener> listeners()

Specified by:

listeners in interface ChatModel

provider

public ModelProvider provider()

Specified by:

provider in interface ChatModel

supportedCapabilities

public Set<Capability> supportedCapabilities()

Specified by:

supportedCapabilities in interface ChatModel

builder

public static MistralAiChatModel.MistralAiChatModelBuilder builder()