Package org.springframework.ai.mistralai.api

Record Class MistralAiApi.ChatCompletionRequest

java.lang.Object
java.lang.Record
org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest
Record Components:
model - ID of the model to use.
messages - The prompt(s) to generate completions for, encoded as a list of dict with role and content. The first prompt role should be user or system.
tools - A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for.
toolChoice - Controls which (if any) function is called by the model. none means the model will not call a function and instead generates a message. auto means the model can pick between generating a message or calling a function. Any means the model must call a function.
temperature - What sampling temperature to use, between 0.0 and 1.0. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.
topP - Nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.
maxTokens - The maximum number of tokens to generate in the completion. The token count of your prompt plus max_tokens cannot exceed the model's context length.
n - Number of completions to return for each request, input tokens are only billed once. Minimum is 1.
presencePenalty - The presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative. Supported range is between -2.0 and 2.0.
frequencyPenalty - The frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition. Supported range is between -2.0 and 2.0.
stream - Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Otherwise, the server will hold the request open until the timeout or until completion, with the response containing the full result as JSON.
safePrompt - Whether to inject a safety prompt before all conversations.
stop - A list of tokens that the model should stop generating after.
reasoningEffort - Controls the reasoning effort level for reasoning models.
randomSeed - The seed to use for random sampling. If set, different calls will generate deterministic results.
responseFormat - An object specifying the format or schema that the model must output. Setting to { "type": "json_object" } enables JSON mode, which guarantees the message the model generates is valid JSON. Setting to { "type": "json_object" , "json_schema": schema} allows you to ensure the model provides an answer in a very specific JSON format by supplying a clear JSON schema.
Enclosing class:
MistralAiApi
public static record MistralAiApi.ChatCompletionRequest(@Nullable String model, List<MistralAiApi.ChatCompletionMessage> messages, @Nullable List<MistralAiApi.FunctionTool> tools, @Nullable MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice, @Nullable Double temperature, @Nullable Double topP, @Nullable Integer maxTokens, @Nullable Integer n, @Nullable Double presencePenalty, @Nullable Double frequencyPenalty, @Nullable Boolean stream, @Nullable Boolean safePrompt, @Nullable List<String> stop, @Nullable MistralAiApi.ChatCompletionRequest.ReasoningEffort reasoningEffort, @Nullable Integer randomSeed, @Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat) extends Record
Creates a model request for chat conversation.

  • Constructor Details

    • ChatCompletionRequest

      public ChatCompletionRequest(List<MistralAiApi.ChatCompletionMessage> messages, String model)
      Shortcut constructor for a chat completion request with the given messages and model.
      Parameters:
      messages - The prompt(s) to generate completions for, encoded as a list of dict with role and content. The first prompt role should be user or system.
      model - ID of the model to use.

    • ChatCompletionRequest

      public ChatCompletionRequest(List<MistralAiApi.ChatCompletionMessage> messages, String model, Double temperature, boolean stream)
      Shortcut constructor for a chat completion request with the given messages, model and temperature.
      Parameters:
      messages - The prompt(s) to generate completions for, encoded as a list of dict with role and content. The first prompt role should be user or system.
      model - ID of the model to use.
      temperature - What sampling temperature to use, between 0.0 and 1.0.
      stream - Whether to stream back partial progress. If set, tokens will be sent

    • ChatCompletionRequest

      public ChatCompletionRequest(List<MistralAiApi.ChatCompletionMessage> messages, String model, Double temperature)
      Shortcut constructor for a chat completion request with the given messages, model and temperature.
      Parameters:
      messages - The prompt(s) to generate completions for, encoded as a list of dict with role and content. The first prompt role should be user or system.
      model - ID of the model to use.
      temperature - What sampling temperature to use, between 0.0 and 1.0.

    • ChatCompletionRequest

      public ChatCompletionRequest(List<MistralAiApi.ChatCompletionMessage> messages, String model, List<MistralAiApi.FunctionTool> tools, MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice)
      Shortcut constructor for a chat completion request with the given messages, model, tools and tool choice. Streaming is set to false, temperature to 0.8 and all other parameters are null.
      Parameters:
      messages - A list of messages comprising the conversation so far.
      model - ID of the model to use.
      tools - A list of tools the model may call. Currently, only functions are supported as a tool.
      toolChoice - Controls which (if any) function is called by the model.

    • ChatCompletionRequest

      public ChatCompletionRequest(List<MistralAiApi.ChatCompletionMessage> messages, Boolean stream)
      Shortcut constructor for a chat completion request with the given messages and stream.

    • ChatCompletionRequest

      public ChatCompletionRequest(@Nullable String model, List<MistralAiApi.ChatCompletionMessage> messages, @Nullable List<MistralAiApi.FunctionTool> tools, @Nullable MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice, @Nullable Double temperature, @Nullable Double topP, @Nullable Integer maxTokens, @Nullable Integer n, @Nullable Double presencePenalty, @Nullable Double frequencyPenalty, @Nullable Boolean stream, @Nullable Boolean safePrompt, @Nullable List<String> stop, @Nullable MistralAiApi.ChatCompletionRequest.ReasoningEffort reasoningEffort, @Nullable Integer randomSeed, @Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat)
      Creates an instance of a ChatCompletionRequest record class.
      Parameters:
      model - the value for the model record component
      messages - the value for the messages record component
      tools - the value for the tools record component
      toolChoice - the value for the toolChoice record component
      temperature - the value for the temperature record component
      topP - the value for the topP record component
      maxTokens - the value for the maxTokens record component
      n - the value for the n record component
      presencePenalty - the value for the presencePenalty record component
      frequencyPenalty - the value for the frequencyPenalty record component
      stream - the value for the stream record component
      safePrompt - the value for the safePrompt record component
      stop - the value for the stop record component
      reasoningEffort - the value for the reasoningEffort record component
      randomSeed - the value for the randomSeed record component
      responseFormat - the value for the responseFormat record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • model

      public @Nullable String model()
      Returns the value of the model record component.
      Returns:
      the value of the model record component

    • messages

      public List<MistralAiApi.ChatCompletionMessage> messages()
      Returns the value of the messages record component.
      Returns:
      the value of the messages record component

    • tools

      public @Nullable List<MistralAiApi.FunctionTool> tools()
      Returns the value of the tools record component.
      Returns:
      the value of the tools record component

    • toolChoice

      public @Nullable MistralAiApi.ChatCompletionRequest.ToolChoice toolChoice()
      Returns the value of the toolChoice record component.
      Returns:
      the value of the toolChoice record component

    • temperature

      public @Nullable Double temperature()
      Returns the value of the temperature record component.
      Returns:
      the value of the temperature record component

    • topP

      public @Nullable Double topP()
      Returns the value of the topP record component.
      Returns:
      the value of the topP record component

    • maxTokens

      public @Nullable Integer maxTokens()
      Returns the value of the maxTokens record component.
      Returns:
      the value of the maxTokens record component

    • n

      public @Nullable Integer n()
      Returns the value of the n record component.
      Returns:
      the value of the n record component

    • presencePenalty

      public @Nullable Double presencePenalty()
      Returns the value of the presencePenalty record component.
      Returns:
      the value of the presencePenalty record component

    • frequencyPenalty

      public @Nullable Double frequencyPenalty()
      Returns the value of the frequencyPenalty record component.
      Returns:
      the value of the frequencyPenalty record component

    • stream

      public @Nullable Boolean stream()
      Returns the value of the stream record component.
      Returns:
      the value of the stream record component

    • safePrompt

      public @Nullable Boolean safePrompt()
      Returns the value of the safePrompt record component.
      Returns:
      the value of the safePrompt record component

    • stop

      public @Nullable List<String> stop()
      Returns the value of the stop record component.
      Returns:
      the value of the stop record component

    • reasoningEffort

      public @Nullable MistralAiApi.ChatCompletionRequest.ReasoningEffort reasoningEffort()
      Returns the value of the reasoningEffort record component.
      Returns:
      the value of the reasoningEffort record component

    • randomSeed

      public @Nullable Integer randomSeed()
      Returns the value of the randomSeed record component.
      Returns:
      the value of the randomSeed record component

    • responseFormat

      public @Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat responseFormat()
      Returns the value of the responseFormat record component.
      Returns:
      the value of the responseFormat record component