Package software.amazon.awssdk.services.bedrockruntime.model

Class ToolResultContentBlock

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

The tool result content block. For more information, see Call a tool with the Converse API in the Amazon Bedrock User Guide.

See Also:

  • Method Details

    • json

      public final Document json()

      A tool result that is JSON format data.

      Returns:
      A tool result that is JSON format data.

    • text

      public final String text()

      A tool result that is text.

      Returns:
      A tool result that is text.

    • image

      public final ImageBlock image()

      A tool result that is an image.

      This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.

      Returns:
      A tool result that is an image.

      This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.

    • document

      public final DocumentBlock document()

      A tool result that is a document.

      Returns:
      A tool result that is a document.

    • video

      public final VideoBlock video()

      A tool result that is video.

      Returns:
      A tool result that is video.

    • searchResult

      public final SearchResultBlock searchResult()

      A tool result that is a search result.

      Returns:
      A tool result that is a search result.

    • toBuilder

      public ToolResultContentBlock.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<ToolResultContentBlock.Builder,ToolResultContentBlock>

    • builder

      public static ToolResultContentBlock.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ToolResultContentBlock.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

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

    • fromJson

      public static ToolResultContentBlock fromJson(Document json)
      Create an instance of this class with json() initialized to the given value.

      A tool result that is JSON format data.

      Parameters:
      json - A tool result that is JSON format data.

    • fromText

      public static ToolResultContentBlock fromText(String text)
      Create an instance of this class with text() initialized to the given value.

      A tool result that is text.

      Parameters:
      text - A tool result that is text.

    • fromImage

      public static ToolResultContentBlock fromImage(ImageBlock image)
      Create an instance of this class with image() initialized to the given value.

      A tool result that is an image.

      This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.

      Parameters:
      image - A tool result that is an image.

      This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.

    • fromImage

      public static ToolResultContentBlock fromImage(Consumer<ImageBlock.Builder> image)
      Create an instance of this class with image() initialized to the given value.

      A tool result that is an image.

      This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.

      Parameters:
      image - A tool result that is an image.

      This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models.

    • fromDocument

      public static ToolResultContentBlock fromDocument(DocumentBlock document)
      Create an instance of this class with document() initialized to the given value.

      A tool result that is a document.

      Parameters:
      document - A tool result that is a document.

    • fromDocument

      public static ToolResultContentBlock fromDocument(Consumer<DocumentBlock.Builder> document)
      Create an instance of this class with document() initialized to the given value.

      A tool result that is a document.

      Parameters:
      document - A tool result that is a document.

    • fromVideo

      public static ToolResultContentBlock fromVideo(VideoBlock video)
      Create an instance of this class with video() initialized to the given value.

      A tool result that is video.

      Parameters:
      video - A tool result that is video.

    • fromVideo

      public static ToolResultContentBlock fromVideo(Consumer<VideoBlock.Builder> video)
      Create an instance of this class with video() initialized to the given value.

      A tool result that is video.

      Parameters:
      video - A tool result that is video.

    • fromSearchResult

      public static ToolResultContentBlock fromSearchResult(SearchResultBlock searchResult)
      Create an instance of this class with searchResult() initialized to the given value.

      A tool result that is a search result.

      Parameters:
      searchResult - A tool result that is a search result.

    • fromSearchResult

      public static ToolResultContentBlock fromSearchResult(Consumer<SearchResultBlock.Builder> searchResult)
      Create an instance of this class with searchResult() initialized to the given value.

      A tool result that is a search result.

      Parameters:
      searchResult - A tool result that is a search result.

    • type

      public ToolResultContentBlock.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 ToolResultContentBlock.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 ToolResultContentBlock.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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo