Class ToolUseBlock

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

A tool use content block. Contains information about a tool that the model is requesting be run., The model uses the result from the tool to generate a response. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

See Also:

  • Method Details

    • toolUseId

      public final String toolUseId()

      The ID for the tool request.

      Returns:
      The ID for the tool request.

    • name

      public final String name()

      The name of the tool that the model wants to use.

      Returns:
      The name of the tool that the model wants to use.

    • input

      public final Document input()

      The input to pass to the tool.

      Returns:
      The input to pass to the tool.

    • type

      public final ToolUseType type()

      The type for the tool request.

      If the service returns an enum value that is not available in the current SDK version, type will return ToolUseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type for the tool request.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type for the tool request.

      If the service returns an enum value that is not available in the current SDK version, type will return ToolUseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type for the tool request.
      See Also:

    • toBuilder

      public ToolUseBlock.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<ToolUseBlock.Builder,ToolUseBlock>
      Returns:
      a builder for type T

    • builder

      public static ToolUseBlock.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ToolUseBlock.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)

    • 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.