Class AutomatedReasoningPolicyRuleReport

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

Provides detailed fidelity analysis for a specific policy rule, including which source document statements support it and how accurate the rule is.

See Also:

  • Method Details

    • rule

      public final String rule()

      The identifier of the policy rule being analyzed in this report.

      Returns:
      The identifier of the policy rule being analyzed in this report.

    • hasGroundingStatements

      public final boolean hasGroundingStatements()
      For responses, this returns true if the service returned a value for the GroundingStatements 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.

    • groundingStatements

      public final List<AutomatedReasoningPolicyStatementReference> groundingStatements()

      References to statements from the source documents that provide the basis or justification for this rule.

      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 hasGroundingStatements() method.

      Returns:
      References to statements from the source documents that provide the basis or justification for this rule.

    • hasGroundingJustifications

      public final boolean hasGroundingJustifications()
      For responses, this returns true if the service returned a value for the GroundingJustifications 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.

    • groundingJustifications

      public final List<String> groundingJustifications()

      Explanations describing how the source statements support and justify this specific rule.

      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 hasGroundingJustifications() method.

      Returns:
      Explanations describing how the source statements support and justify this specific rule.

    • accuracyScore

      public final Double accuracyScore()

      A score from 0.0 to 1.0 indicating how accurately this rule represents the source material.

      Returns:
      A score from 0.0 to 1.0 indicating how accurately this rule represents the source material.

    • accuracyJustification

      public final String accuracyJustification()

      A textual explanation of the accuracy score, describing why the rule received this particular accuracy rating.

      Returns:
      A textual explanation of the accuracy score, describing why the rule received this particular accuracy rating.

    • toBuilder

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

    • builder

      public static AutomatedReasoningPolicyRuleReport.Builder builder()

    • serializableBuilderClass

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