Class ContentBlock

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

A block of content for a message that you pass to, or receive from, a model with the Converse or ConverseStream API operations.

See Also:

  • Method Details

    • text

      public final String text()

      Text to include in the message.

      Returns:
      Text to include in the message.

    • image

      public final ImageBlock image()

      Image to include in the message.

      This field is only supported by Anthropic Claude 3 models.

      Returns:
      Image to include in the message.

      This field is only supported by Anthropic Claude 3 models.

    • document

      public final DocumentBlock document()

      A document to include in the message.

      Returns:
      A document to include in the message.

    • video

      public final VideoBlock video()

      Video to include in the message.

      Returns:
      Video to include in the message.

    • toolUse

      public final ToolUseBlock toolUse()

      Information about a tool use request from a model.

      Returns:
      Information about a tool use request from a model.

    • toolResult

      public final ToolResultBlock toolResult()

      The result for a tool request that a model makes.

      Returns:
      The result for a tool request that a model makes.

    • guardContent

      public final GuardrailConverseContentBlock guardContent()

      Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

      For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

      Returns:
      Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

      For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

    • cachePoint

      public final CachePointBlock cachePoint()

      CachePoint to include in the message.

      Returns:
      CachePoint to include in the message.

    • reasoningContent

      public final ReasoningContentBlock reasoningContent()

      Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

      Returns:
      Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

    • citationsContent

      public final CitationsContentBlock citationsContent()

      A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

      Returns:
      A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

    • toBuilder

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

    • builder

      public static ContentBlock.Builder builder()

    • serializableBuilderClass

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

    • fromText

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

      Text to include in the message.

      Parameters:
      text - Text to include in the message.

    • fromImage

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

      Image to include in the message.

      This field is only supported by Anthropic Claude 3 models.

      Parameters:
      image - Image to include in the message.

      This field is only supported by Anthropic Claude 3 models.

    • fromImage

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

      Image to include in the message.

      This field is only supported by Anthropic Claude 3 models.

      Parameters:
      image - Image to include in the message.

      This field is only supported by Anthropic Claude 3 models.

    • fromDocument

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

      A document to include in the message.

      Parameters:
      document - A document to include in the message.

    • fromDocument

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

      A document to include in the message.

      Parameters:
      document - A document to include in the message.

    • fromVideo

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

      Video to include in the message.

      Parameters:
      video - Video to include in the message.

    • fromVideo

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

      Video to include in the message.

      Parameters:
      video - Video to include in the message.

    • fromToolUse

      public static ContentBlock fromToolUse(ToolUseBlock toolUse)
      Create an instance of this class with toolUse() initialized to the given value.

      Information about a tool use request from a model.

      Parameters:
      toolUse - Information about a tool use request from a model.

    • fromToolUse

      public static ContentBlock fromToolUse(Consumer<ToolUseBlock.Builder> toolUse)
      Create an instance of this class with toolUse() initialized to the given value.

      Information about a tool use request from a model.

      Parameters:
      toolUse - Information about a tool use request from a model.

    • fromToolResult

      public static ContentBlock fromToolResult(ToolResultBlock toolResult)
      Create an instance of this class with toolResult() initialized to the given value.

      The result for a tool request that a model makes.

      Parameters:
      toolResult - The result for a tool request that a model makes.

    • fromToolResult

      public static ContentBlock fromToolResult(Consumer<ToolResultBlock.Builder> toolResult)
      Create an instance of this class with toolResult() initialized to the given value.

      The result for a tool request that a model makes.

      Parameters:
      toolResult - The result for a tool request that a model makes.

    • fromGuardContent

      public static ContentBlock fromGuardContent(GuardrailConverseContentBlock guardContent)
      Create an instance of this class with guardContent() initialized to the given value.

      Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

      For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

      Parameters:
      guardContent - Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

      For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

    • fromGuardContent

      public static ContentBlock fromGuardContent(Consumer<GuardrailConverseContentBlock.Builder> guardContent)
      Create an instance of this class with guardContent() initialized to the given value.

      Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

      For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

      Parameters:
      guardContent - Contains the content to assess with the guardrail. If you don't specify guardContent in a call to the Converse API, the guardrail (if passed in the Converse API) assesses the entire message.

      For more information, see Use a guardrail with the Converse API in the Amazon Bedrock User Guide.

    • fromCachePoint

      public static ContentBlock fromCachePoint(CachePointBlock cachePoint)
      Create an instance of this class with cachePoint() initialized to the given value.

      CachePoint to include in the message.

      Parameters:
      cachePoint - CachePoint to include in the message.

    • fromCachePoint

      public static ContentBlock fromCachePoint(Consumer<CachePointBlock.Builder> cachePoint)
      Create an instance of this class with cachePoint() initialized to the given value.

      CachePoint to include in the message.

      Parameters:
      cachePoint - CachePoint to include in the message.

    • fromReasoningContent

      public static ContentBlock fromReasoningContent(ReasoningContentBlock reasoningContent)
      Create an instance of this class with reasoningContent() initialized to the given value.

      Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

      Parameters:
      reasoningContent - Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

    • fromReasoningContent

      public static ContentBlock fromReasoningContent(Consumer<ReasoningContentBlock.Builder> reasoningContent)
      Create an instance of this class with reasoningContent() initialized to the given value.

      Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

      Parameters:
      reasoningContent - Contains content regarding the reasoning that is carried out by the model. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

    • fromCitationsContent

      public static ContentBlock fromCitationsContent(CitationsContentBlock citationsContent)
      Create an instance of this class with citationsContent() initialized to the given value.

      A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

      Parameters:
      citationsContent - A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

    • fromCitationsContent

      public static ContentBlock fromCitationsContent(Consumer<CitationsContentBlock.Builder> citationsContent)
      Create an instance of this class with citationsContent() initialized to the given value.

      A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

      Parameters:
      citationsContent - A content block that contains both generated text and associated citation information, providing traceability between the response and source documents.

    • type

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