Class MistralAiChatRequestParameters

java.lang.Object

dev.langchain4j.model.chat.request.DefaultChatRequestParameters

dev.langchain4j.model.mistralai.MistralAiChatRequestParameters

All Implemented Interfaces:

ChatRequestParameters

public class MistralAiChatRequestParameters
extends DefaultChatRequestParameters

Mistral AI specific ChatRequestParameters.

In addition to the common ChatRequestParameters, this class exposes the Mistral AI specific options (safePrompt, randomSeed, sendThinking, returnThinking) so that they can be overridden per ChatRequest, not only at model build time.

See Also:

• MistralAiChatModel
• MistralAiStreamingChatModel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MistralAiChatRequestParameters.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final MistralAiChatRequestParameters	EMPTY

Method Summary

Modifier and Type	Method	Description
static MistralAiChatRequestParameters.Builder	builder()
MistralAiChatRequestParameters	defaultedBy(ChatRequestParameters that)	Creates a new ChatRequestParameters by combining the current parameters with the specified ones.
boolean	equals(Object o)
int	hashCode()
MistralAiChatRequestParameters	overrideWith(ChatRequestParameters that)	Creates a new ChatRequestParameters by combining the current parameters with the specified ones.
Integer	randomSeed()
Boolean	returnThinking()
Boolean	safePrompt()
Boolean	sendThinking()
MistralAiChatRequestParameters.Builder	toBuilder()
String	toString()

Methods inherited from class DefaultChatRequestParameters

frequencyPenalty, maxOutputTokens, modelName, presencePenalty, responseFormat, stopSequences, temperature, toolChoice, toolSpecifications, topK, topP

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EMPTY

public static final MistralAiChatRequestParameters EMPTY

Method Details

safePrompt

public Boolean safePrompt()

Returns:

whether to inject a safety prompt before all conversations (Mistral safe_prompt).

randomSeed

public Integer randomSeed()

Returns:

the seed to use for random sampling (Mistral random_seed).

sendThinking

public Boolean sendThinking()

Returns:

whether to send thinking/reasoning text to the LLM in follow-up requests.

returnThinking

public Boolean returnThinking()

Returns:

whether to parse and return the thinking/reasoning text from the API response inside AiMessage.thinking().

overrideWith

public MistralAiChatRequestParameters overrideWith(ChatRequestParameters that)

Description copied from interface: ChatRequestParameters

Creates a new ChatRequestParameters by combining the current parameters with the specified ones. Values from the specified parameters override values from the current parameters when there is overlap. Neither the current nor the specified ChatRequestParameters objects are modified.

Example:

Current parameters:
  temperature = 1.0
  maxOutputTokens = 100

Specified parameters:
  temperature = 0.5
  modelName = my-model

Result:
  temperature = 0.5        // Overridden from specified
  maxOutputTokens = 100    // Preserved from current
  modelName = my-model     // Added from specified

Specified by:

overrideWith in interface ChatRequestParameters

Overrides:

overrideWith in class DefaultChatRequestParameters

Parameters:

that - the parameters whose values will override the current ones

Returns:

a new ChatRequestParameters instance combining both sets of parameters

defaultedBy

public MistralAiChatRequestParameters defaultedBy(ChatRequestParameters that)

Description copied from interface: ChatRequestParameters

Creates a new ChatRequestParameters by combining the current parameters with the specified ones. Values from the current parameters take precedence over values from the specified parameters when there is overlap. Neither the current nor the specified ChatRequestParameters objects are modified.

Example:

Current parameters:
  temperature = 1.0
  maxOutputTokens = 100

Specified parameters:
  temperature = 0.5
  modelName = my-model

Result:
  temperature = 1.0        // Preserved from current
  maxOutputTokens = 100    // Preserved from current
  modelName = my-model     // Added from specified

Specified by:

defaultedBy in interface ChatRequestParameters

Overrides:

defaultedBy in class DefaultChatRequestParameters

Parameters:

that - the parameters whose values will be used as a default for the current ones

Returns:

a new ChatRequestParameters instance combining both sets of parameters

equals

public boolean equals(Object o)

Overrides:

equals in class DefaultChatRequestParameters

hashCode

public int hashCode()

Overrides:

hashCode in class DefaultChatRequestParameters

toString

public String toString()

Overrides:

toString in class DefaultChatRequestParameters

toBuilder

public MistralAiChatRequestParameters.Builder toBuilder()

builder

public static MistralAiChatRequestParameters.Builder builder()