Class ReasoningContentBlock

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

Contains content regarding the reasoning that the foundation model made with respect to the content in the content block. Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance the accuracy of its final response.

See Also:

  • Method Details

    • reasoningText

      public final ReasoningTextBlock reasoningText()

      Contains information about the reasoning that the model used to return the content in the content block.

      Returns:
      Contains information about the reasoning that the model used to return the content in the content block.

    • redactedContent

      public final SdkBytes redactedContent()

      The content in the reasoning that was encrypted by the model provider for trust and safety reasons.

      Returns:
      The content in the reasoning that was encrypted by the model provider for trust and safety reasons.

    • toBuilder

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

    • builder

      public static ReasoningContentBlock.Builder builder()

    • serializableBuilderClass

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

    • fromReasoningText

      public static ReasoningContentBlock fromReasoningText(ReasoningTextBlock reasoningText)
      Create an instance of this class with reasoningText() initialized to the given value.

      Contains information about the reasoning that the model used to return the content in the content block.

      Parameters:
      reasoningText - Contains information about the reasoning that the model used to return the content in the content block.

    • fromReasoningText

      public static ReasoningContentBlock fromReasoningText(Consumer<ReasoningTextBlock.Builder> reasoningText)
      Create an instance of this class with reasoningText() initialized to the given value.

      Contains information about the reasoning that the model used to return the content in the content block.

      Parameters:
      reasoningText - Contains information about the reasoning that the model used to return the content in the content block.

    • fromRedactedContent

      public static ReasoningContentBlock fromRedactedContent(SdkBytes redactedContent)
      Create an instance of this class with redactedContent() initialized to the given value.

      The content in the reasoning that was encrypted by the model provider for trust and safety reasons.

      Parameters:
      redactedContent - The content in the reasoning that was encrypted by the model provider for trust and safety reasons.

    • type

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