Class ToolChoice

java.lang.Object
software.amazon.awssdk.services.bedrockruntime.model.ToolChoice
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ToolChoice.Builder,ToolChoice>
@Generated("software.amazon.awssdk:codegen") public final class ToolChoice extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ToolChoice.Builder,ToolChoice>

Determines which tools the model should request in a call to Converse or ConverseStream. ToolChoice is only supported by Anthropic Claude 3 models and by Mistral AI Mistral Large.

See Also:

  • Method Details

    • auto

      public final AutoToolChoice auto()

      (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

      Returns:
      (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

    • any

      public final AnyToolChoice any()

      The model must request at least one tool (no text is generated).

      Returns:
      The model must request at least one tool (no text is generated).

    • tool

      public final SpecificToolChoice tool()

      The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

      Returns:
      The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

    • toBuilder

      public ToolChoice.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ToolChoice.Builder,ToolChoice>
      Returns:
      a builder for type T

    • builder

      public static ToolChoice.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ToolChoice.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • fromAuto

      public static ToolChoice fromAuto(AutoToolChoice auto)
      Create an instance of this class with auto() initialized to the given value.

      (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

      Parameters:
      auto - (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

    • fromAuto

      public static ToolChoice fromAuto(Consumer<AutoToolChoice.Builder> auto)
      Create an instance of this class with auto() initialized to the given value.

      (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

      Parameters:
      auto - (Default). The Model automatically decides if a tool should be called or whether to generate text instead.

    • fromAny

      public static ToolChoice fromAny(AnyToolChoice any)
      Create an instance of this class with any() initialized to the given value.

      The model must request at least one tool (no text is generated).

      Parameters:
      any - The model must request at least one tool (no text is generated).

    • fromAny

      public static ToolChoice fromAny(Consumer<AnyToolChoice.Builder> any)
      Create an instance of this class with any() initialized to the given value.

      The model must request at least one tool (no text is generated).

      Parameters:
      any - The model must request at least one tool (no text is generated).

    • fromTool

      public static ToolChoice fromTool(SpecificToolChoice tool)
      Create an instance of this class with tool() initialized to the given value.

      The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

      Parameters:
      tool - The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

    • fromTool

      public static ToolChoice fromTool(Consumer<SpecificToolChoice.Builder> tool)
      Create an instance of this class with tool() initialized to the given value.

      The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

      Parameters:
      tool - The Model must request the specified tool. Only supported by Anthropic Claude 3 models.

    • type

      public ToolChoice.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be ToolChoice.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be ToolChoice.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.