Class MistralAiChatOptions

java.lang.Object
org.springframework.ai.mistralai.MistralAiChatOptions
All Implemented Interfaces:
org.springframework.ai.chat.prompt.ChatOptions, org.springframework.ai.model.ModelOptions, org.springframework.ai.model.tool.StructuredOutputChatOptions, org.springframework.ai.model.tool.ToolCallingChatOptions

public class MistralAiChatOptions extends Object implements org.springframework.ai.model.tool.ToolCallingChatOptions, org.springframework.ai.model.tool.StructuredOutputChatOptions
Options for the Mistral AI Chat API.
Since:
0.8.1
Author:
Ricken Bazolo, Christian Tzolov, Thomas Vitale, Alexandros Pappas, Jason Smith, Sebastien Deleuze, Nicolas Krier
  • Constructor Details

  • Method Details

    • builder

      public static MistralAiChatOptions.Builder builder()
    • getModel

      public String getModel()
      Specified by:
      getModel in interface org.springframework.ai.chat.prompt.ChatOptions
    • getMaxTokens

      public @Nullable Integer getMaxTokens()
      Specified by:
      getMaxTokens in interface org.springframework.ai.chat.prompt.ChatOptions
    • getSafePrompt

      public Boolean getSafePrompt()
    • getRandomSeed

      public @Nullable Integer getRandomSeed()
    • getResponseFormat

      public @Nullable MistralAiApi.ChatCompletionRequest.ResponseFormat getResponseFormat()
    • getStopSequences

      public @Nullable List<String> getStopSequences()
      Specified by:
      getStopSequences in interface org.springframework.ai.chat.prompt.ChatOptions
    • getStop

      public @Nullable List<String> getStop()
    • getReasoningEffort

      public @Nullable MistralAiApi.ChatCompletionRequest.ReasoningEffort getReasoningEffort()
    • getTools

      public @Nullable List<MistralAiApi.FunctionTool> getTools()
    • getToolChoice

      public @Nullable MistralAiApi.ChatCompletionRequest.ToolChoice getToolChoice()
    • getTemperature

      public Double getTemperature()
      Specified by:
      getTemperature in interface org.springframework.ai.chat.prompt.ChatOptions
    • getTopP

      public Double getTopP()
      Specified by:
      getTopP in interface org.springframework.ai.chat.prompt.ChatOptions
    • getFrequencyPenalty

      public Double getFrequencyPenalty()
      Specified by:
      getFrequencyPenalty in interface org.springframework.ai.chat.prompt.ChatOptions
    • getPresencePenalty

      public Double getPresencePenalty()
      Specified by:
      getPresencePenalty in interface org.springframework.ai.chat.prompt.ChatOptions
    • getN

      public @Nullable Integer getN()
    • getToolCallbacks

      public @Nullable List<org.springframework.ai.tool.ToolCallback> getToolCallbacks()
      Specified by:
      getToolCallbacks in interface org.springframework.ai.model.tool.ToolCallingChatOptions
    • getTopK

      public @Nullable Integer getTopK()
      Specified by:
      getTopK in interface org.springframework.ai.chat.prompt.ChatOptions
    • getToolContext

      public @Nullable Map<String,Object> getToolContext()
      Specified by:
      getToolContext in interface org.springframework.ai.model.tool.ToolCallingChatOptions
    • getOutputSchema

      public @Nullable String getOutputSchema()
      Specified by:
      getOutputSchema in interface org.springframework.ai.model.tool.StructuredOutputChatOptions
    • mutate

      Specified by:
      mutate in interface org.springframework.ai.chat.prompt.ChatOptions
      Specified by:
      mutate in interface org.springframework.ai.model.tool.StructuredOutputChatOptions
      Specified by:
      mutate in interface org.springframework.ai.model.tool.ToolCallingChatOptions
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public boolean equals(@Nullable Object obj)
      Overrides:
      equals in class Object