Record Class ChatOptions

java.lang.Object
java.lang.Record
smile.llm.ChatOptions
Record Components:
tools - available tools; null or empty means no tools.
toolChoice - tool selection policy; null defaults to ToolChoice.AUTO.
parallelToolCalls - whether multiple tool calls in one turn are allowed.
thinkingMode - THINKING_ENABLED, THINKING_DISABLED, THINKING_ADAPTIVE, or null for the model's default (templates that support it).
reasoningEffort - xhigh, medium or low for templates with a reasoning-effort setting (Qwen3.8); null for the template's default.
preserveThinking - whether earlier assistant turns keep their reasoning in the prompt (Qwen3.8's preserve_thinking); null for the template's default.
public record ChatOptions(ToolDefinition[] tools, ToolChoice toolChoice, boolean parallelToolCalls, String thinkingMode, String reasoningEffort, Boolean preserveThinking) extends Record
Per-request chat options for tool calling.

  • Field Details

    • THINKING_ENABLED

      public static final String THINKING_ENABLED
      Thinking is requested before every answer.
      See Also:

    • THINKING_DISABLED

      public static final String THINKING_DISABLED
      The model answers without thinking.
      See Also:

    • THINKING_ADAPTIVE

      public static final String THINKING_ADAPTIVE
      The model decides whether to think.
      See Also:

    • NONE

      public static final ChatOptions NONE
      Empty options (no tools).

  • Constructor Details

    • ChatOptions

      public ChatOptions(ToolDefinition[] tools, ToolChoice toolChoice, boolean parallelToolCalls, String thinkingMode)
      Options without reasoning-effort or preserve-thinking preferences.
      Parameters:
      tools - tool definitions; may be null.
      toolChoice - tool choice; null means auto.
      parallelToolCalls - whether parallel tool calls are allowed.
      thinkingMode - thinking mode or null.

    • ChatOptions

      public ChatOptions(ToolDefinition[] tools, ToolChoice toolChoice, boolean parallelToolCalls)
      Options without a thinking-mode preference.
      Parameters:
      tools - tool definitions; may be null.
      toolChoice - tool choice; null means auto.
      parallelToolCalls - whether parallel tool calls are allowed.

    • ChatOptions

      public ChatOptions(ToolDefinition[] tools, ToolChoice toolChoice, boolean parallelToolCalls, String thinkingMode, String reasoningEffort, Boolean preserveThinking)
      Compact canonical constructor.

  • Method Details

    • withThinkingMode

      public ChatOptions withThinkingMode(String mode)
      Returns a copy with another thinking mode.
      Parameters:
      mode - THINKING_ENABLED, THINKING_DISABLED, THINKING_ADAPTIVE or null.
      Returns:
      the new options.

    • withReasoningEffort

      public ChatOptions withReasoningEffort(String effort)
      Returns a copy with another reasoning effort.
      Parameters:
      effort - xhigh, medium, low or null for the template default.
      Returns:
      the new options.

    • withPreserveThinking

      public ChatOptions withPreserveThinking(Boolean preserve)
      Returns a copy with another preserve-thinking preference.
      Parameters:
      preserve - whether earlier turns keep their reasoning, or null for the template default.
      Returns:
      the new options.

    • hasTools

      public boolean hasTools()
      Returns whether tools should be injected into the chat template.
      Returns:
      true when tools should be injected into the chat template.

    • toolsForTemplate

      public List<ToolDefinition> toolsForTemplate()
      Tools filtered for template injection (named choice → single function).
      Returns:
      tools to expose, or empty list when none.

    • parseToolCalls

      public boolean parseToolCalls()
      Returns whether the tool-call output parser should run.
      Returns:
      true when the tool-call output parser should run.

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.

    • tools

      public ToolDefinition[] tools()
      Returns the value of the tools record component.
      Returns:
      the value of the tools record component

    • toolChoice

      public ToolChoice toolChoice()
      Returns the value of the toolChoice record component.
      Returns:
      the value of the toolChoice record component

    • parallelToolCalls

      public boolean parallelToolCalls()
      Returns the value of the parallelToolCalls record component.
      Returns:
      the value of the parallelToolCalls record component

    • thinkingMode

      public String thinkingMode()
      Returns the value of the thinkingMode record component.
      Returns:
      the value of the thinkingMode record component

    • reasoningEffort

      public String reasoningEffort()
      Returns the value of the reasoningEffort record component.
      Returns:
      the value of the reasoningEffort record component

    • preserveThinking

      public Boolean preserveThinking()
      Returns the value of the preserveThinking record component.
      Returns:
      the value of the preserveThinking record component