Class ContentBlockDelta

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

A block of content in a streaming response.

See Also:

  • Method Details

    • text

      public final String text()

      The content text.

      Returns:
      The content text.

    • toolUse

      public final ToolUseBlockDelta toolUse()

      Information about a tool that the model is requesting to use.

      Returns:
      Information about a tool that the model is requesting to use.

    • hasToolResult

      public final boolean hasToolResult()
      For responses, this returns true if the service returned a value for the ToolResult property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • toolResult

      public final List<ToolResultBlockDelta> toolResult()

      An incremental update that contains the results from a tool call.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasToolResult() method.

      Returns:
      An incremental update that contains the results from a tool call.

    • reasoningContent

      public final ReasoningContentBlockDelta 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.

    • citation

      public final CitationsDelta citation()

      Incremental citation information that is streamed as part of the response generation process.

      Returns:
      Incremental citation information that is streamed as part of the response generation process.

    • toBuilder

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

    • builder

      public static ContentBlockDelta.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContentBlockDelta.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 ContentBlockDelta fromText(String text)
      Create an instance of this class with text() initialized to the given value.

      The content text.

      Parameters:
      text - The content text.

    • fromToolUse

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

      Information about a tool that the model is requesting to use.

      Parameters:
      toolUse - Information about a tool that the model is requesting to use.

    • fromToolUse

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

      Information about a tool that the model is requesting to use.

      Parameters:
      toolUse - Information about a tool that the model is requesting to use.

    • fromToolResult

      public static ContentBlockDelta fromToolResult(List<ToolResultBlockDelta> toolResult)
      Create an instance of this class with toolResult() initialized to the given value.

      An incremental update that contains the results from a tool call.

      Parameters:
      toolResult - An incremental update that contains the results from a tool call.

    • fromReasoningContent

      public static ContentBlockDelta fromReasoningContent(ReasoningContentBlockDelta 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 ContentBlockDelta fromReasoningContent(Consumer<ReasoningContentBlockDelta.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.

    • fromCitation

      public static ContentBlockDelta fromCitation(CitationsDelta citation)
      Create an instance of this class with citation() initialized to the given value.

      Incremental citation information that is streamed as part of the response generation process.

      Parameters:
      citation - Incremental citation information that is streamed as part of the response generation process.

    • fromCitation

      public static ContentBlockDelta fromCitation(Consumer<CitationsDelta.Builder> citation)
      Create an instance of this class with citation() initialized to the given value.

      Incremental citation information that is streamed as part of the response generation process.

      Parameters:
      citation - Incremental citation information that is streamed as part of the response generation process.

    • type

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