Package org.springframework.ai.openai.api

Record Class OpenAiApi.ChatCompletionRequest.ToolChoice

java.lang.Object
java.lang.Record
org.springframework.ai.openai.api.OpenAiApi.ChatCompletionRequest.ToolChoice
Record Components:
type - The type of the tool. Currently, only 'function' is supported.
function - single field map for type 'name':'your function name'.
Enclosing class:
OpenAiApi.ChatCompletionRequest
public static record OpenAiApi.ChatCompletionRequest.ToolChoice(String type, Map<String,String> function) extends Record
Specifies a tool the model should use. Use to force the model to call a specific function.

  • Constructor Details

    • ToolChoice

      @ConstructorBinding public ToolChoice(String functionName)
      Create a tool choice of type 'function' and name 'functionName'.
      Parameters:
      functionName - Function name of the tool.

    • ToolChoice

      public ToolChoice(String type, Map<String,String> function)
      Creates an instance of a ToolChoice record class.
      Parameters:
      type - the value for the type record component
      function - the value for the function 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.
      Returns:
      the value of the type record component

    • function

      public Map<String,String> function()
      Returns the value of the function record component.
      Returns:
      the value of the function record component