Package org.springframework.ai.chat.prompt

Interface ChatOptions.Builder

All Known Subinterfaces:
FunctionCallingOptions.Builder
All Known Implementing Classes:
DefaultChatOptionsBuilder, DefaultFunctionCallingOptionsBuilder
Enclosing interface:
ChatOptions
public static interface ChatOptions.Builder
Builder for creating ChatOptions instance.

  • Method Details

    • model

      ChatOptions.Builder model(String model)
      Builds with the model to use for the chat.
      Parameters:
      model -
      Returns:
      the builder

    • frequencyPenalty

      ChatOptions.Builder frequencyPenalty(Double frequencyPenalty)
      Builds with the frequency penalty to use for the chat.
      Parameters:
      frequencyPenalty -
      Returns:
      the builder.

    • maxTokens

      ChatOptions.Builder maxTokens(Integer maxTokens)
      Builds with the maximum number of tokens to use for the chat.
      Parameters:
      maxTokens -
      Returns:
      the builder.

    • presencePenalty

      ChatOptions.Builder presencePenalty(Double presencePenalty)
      Builds with the presence penalty to use for the chat.
      Parameters:
      presencePenalty -
      Returns:
      the builder.

    • stopSequences

      ChatOptions.Builder stopSequences(List<String> stopSequences)
      Builds with the stop sequences to use for the chat.
      Parameters:
      stopSequences -
      Returns:
      the builder.

    • temperature

      ChatOptions.Builder temperature(Double temperature)
      Builds with the temperature to use for the chat.
      Parameters:
      temperature -
      Returns:
      the builder.

    • topK

      ChatOptions.Builder topK(Integer topK)
      Builds with the top K to use for the chat.
      Parameters:
      topK -
      Returns:
      the builder.

    • topP

      ChatOptions.Builder topP(Double topP)
      Builds with the top P to use for the chat.
      Parameters:
      topP -
      Returns:
      the builder.

    • build

      ChatOptions build()
      Build the ChatOptions.
      Returns:
      the Chat options.