Package nl.dannyj.mistral.models.completion

Class ChatCompletionRequest.ChatCompletionRequestBuilder

java.lang.Object
nl.dannyj.mistral.models.completion.ChatCompletionRequest.ChatCompletionRequestBuilder
Enclosing class:
ChatCompletionRequest
public static class ChatCompletionRequest.ChatCompletionRequestBuilder extends Object

  • Method Details

    • responseFormat

      public ChatCompletionRequest.ChatCompletionRequestBuilder responseFormat(ResponseFormats responseFormat)

    • model

      public ChatCompletionRequest.ChatCompletionRequestBuilder model(String model)
      ID of the model to use. You can use the List Available Models API to see all of your available models.
      Parameters:
      model - The model's ID. Can't be null or empty.
      Returns:
      this.

    • messages

      public ChatCompletionRequest.ChatCompletionRequestBuilder messages(List<Message> messages)
      The prompt(s) to generate completions for, encoded as a list of dict with role and content. Must contain at least one message and the first prompt role should be user or system.
      Parameters:
      messages - The messages/conversation to generate completions for. Can't be null or empty.
      Returns:
      this.

    • temperature

      public ChatCompletionRequest.ChatCompletionRequestBuilder temperature(Double 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. Defaults to 0.7.
      Parameters:
      temperature - The sampling temperature to use. Has to be between 0.0 and 1.0.
      Returns:
      this.

    • topP

      public ChatCompletionRequest.ChatCompletionRequestBuilder topP(Double 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. Defaults to 1.0 (i.e., no nucleus sampling).
      Parameters:
      topP - the top p value to use. Has to be between 0.0 and 1.0.
      Returns:
      this.

    • maxTokens

      public ChatCompletionRequest.ChatCompletionRequestBuilder maxTokens(Integer 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. Defaults to 32000, which is the maximum value for all currently available models.
      Parameters:
      maxTokens - The maximum number of tokens to generate in the completion. Has to be positive or zero.
      Returns:
      this.

    • stream

      public ChatCompletionRequest.ChatCompletionRequestBuilder stream(Boolean stream)
      Whether to stream back partial progress. When set to true, the MistralClient.createChatCompletionStream(ChatCompletionRequest, ChatCompletionChunkCallback) method has to be used.
      Parameters:
      stream - Whether to stream back partial progress. Setting to null will default to false.
      Returns:
      this.

    • safePrompt

      public ChatCompletionRequest.ChatCompletionRequestBuilder safePrompt(boolean safePrompt)
      Whether to inject a safety prompt before all conversations. Toggling the safe prompt will prepend your messages with the following system prompt: Always assist with care, respect, and truth. Respond with utmost utility yet securely. Avoid harmful, unethical, prejudiced, or negative content. Ensure replies promote fairness and positivity.
      Parameters:
      safePrompt - Whether to inject a safety prompt before all conversations.
      Returns:
      this.

    • randomSeed

      public ChatCompletionRequest.ChatCompletionRequestBuilder randomSeed(Long randomSeed)
      The seed to use for random sampling. If set, different calls will generate deterministic results.
      Parameters:
      randomSeed - The seed to use for random sampling. Set to null for a random seed.
      Returns:
      this.

    • build

      public ChatCompletionRequest build()

    • toString

      public String toString()
      Overrides:
      toString in class Object