Enum Class ToolChoice

java.lang.Object
java.lang.Enum<ToolChoice>
dev.langchain4j.model.chat.request.ToolChoice
All Implemented Interfaces:
Serializable, Comparable<ToolChoice>, Constable

public enum ToolChoice extends Enum<ToolChoice>
Specifies how ChatModel should use tools.
  • Enum Constant Details

    • AUTO

      public static final ToolChoice AUTO
      The chat model can choose whether to use tools, which ones to use, and how many.
    • REQUIRED

      public static final ToolChoice REQUIRED
      The chat model is required to use one or more tools.
  • Method Details

    • values

      public static ToolChoice[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ToolChoice valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null