Record Class AnthropicApi.ToolChoiceTool

java.lang.Object
java.lang.Record
org.springframework.ai.anthropic.api.AnthropicApi.ToolChoiceTool
Record Components:
type - The type of tool choice, always "tool".
name - The name of the tool to use.
disableParallelToolUse - Whether to disable parallel tool use. Defaults to false. If set to true, the model will output exactly one tool use.
All Implemented Interfaces:
AnthropicApi.ToolChoice
Enclosing class:
AnthropicApi
public static record AnthropicApi.ToolChoiceTool(String type, String name, Boolean disableParallelToolUse) extends Record implements AnthropicApi.ToolChoice
Tool choice - the model will use the specified tool.
Since:
1.0.0
Author:
Christian Tzolov, Mariusz Bernacki, Thomas Vitale, Jihoon Kim, Alexandros Pappas, Jonghoon Park, Claudio Silva Junior, Filip Hrisafov, Soby Chacko, Austin Dase

  • Constructor Details

    • ToolChoiceTool

      public ToolChoiceTool(String name)
      Create a tool choice for a specific tool.
      Parameters:
      name - The name of the tool to use.

    • ToolChoiceTool

      public ToolChoiceTool(String name, Boolean disableParallelToolUse)
      Create a tool choice for a specific tool with parallel tool use setting.
      Parameters:
      name - The name of the tool to use.
      disableParallelToolUse - Whether to disable parallel tool use.

    • ToolChoiceTool

      public ToolChoiceTool(String type, String name, Boolean disableParallelToolUse)
      Creates an instance of a ToolChoiceTool record class.
      Parameters:
      type - the value for the type record component
      name - the value for the name record component
      disableParallelToolUse - the value for the disableParallelToolUse record component

  • Method Details

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • type

      public String type()
      Returns the value of the type record component.
      Specified by:
      type in interface AnthropicApi.ToolChoice
      Returns:
      the value of the type record component

    • name

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

    • disableParallelToolUse

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