Package org.springframework.ai.chat.prompt

Interface ChatOptions

All Superinterfaces:
ModelOptions
All Known Subinterfaces:
StructuredOutputChatOptions, ToolCallingChatOptions
All Known Implementing Classes:
AnthropicChatOptions, AzureOpenAiChatOptions, BedrockChatOptions, DeepSeekChatOptions, DefaultChatOptions, DefaultToolCallingChatOptions, GoogleGenAiChatOptions, MiniMaxChatOptions, MistralAiChatOptions, OCICohereChatOptions, OllamaChatOptions, OpenAiChatOptions, OpenAiSdkChatOptions, VertexAiGeminiChatOptions, ZhiPuAiChatOptions
public interface ChatOptions extends ModelOptions
ModelOptions representing the common options that are portable across different chat models.

  • Method Details

    • getModel

      @Nullable String getModel()
      Returns the model to use for the chat.
      Returns:
      the model to use for the chat

    • getFrequencyPenalty

      @Nullable Double getFrequencyPenalty()
      Returns the frequency penalty to use for the chat.
      Returns:
      the frequency penalty to use for the chat

    • getMaxTokens

      @Nullable Integer getMaxTokens()
      Returns the maximum number of tokens to use for the chat.
      Returns:
      the maximum number of tokens to use for the chat

    • getPresencePenalty

      @Nullable Double getPresencePenalty()
      Returns the presence penalty to use for the chat.
      Returns:
      the presence penalty to use for the chat

    • getStopSequences

      @Nullable List<String> getStopSequences()
      Returns the stop sequences to use for the chat.
      Returns:
      the stop sequences to use for the chat

    • getTemperature

      @Nullable Double getTemperature()
      Returns the temperature to use for the chat.
      Returns:
      the temperature to use for the chat

    • getTopK

      @Nullable Integer getTopK()
      Returns the top K to use for the chat.
      Returns:
      the top K to use for the chat

    • getTopP

      @Nullable Double getTopP()
      Returns the top P to use for the chat.
      Returns:
      the top P to use for the chat

    • copy

      <T extends ChatOptions> T copy()
      Returns a copy of this ChatOptions.
      Returns:
      a copy of this ChatOptions

    • mutate

      default ChatOptions.Builder<?> mutate()
      Returns a new ChatOptions.Builder initialized with the values of this ChatOptions. Concrete ChatOptions classes must override this to return the most concrete builder implementation.

    • builder

      static ChatOptions.Builder<?> builder()
      Creates a new ChatOptions.Builder to create the default ChatOptions.
      Returns:
      Returns a new ChatOptions.Builder.