Class AutomatedReasoningPolicyFidelityReport

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

A comprehensive analysis report that measures how accurately a generated policy represents the source documents. The report includes coverage and accuracy scores, detailed grounding information linking policy elements to source statements, and annotated document content.

See Also:

  • Method Details

    • coverageScore

      public final Double coverageScore()

      A score from 0.0 to 1.0 indicating how well the policy covers the statements in the source documents. A higher score means more of the source content is represented in the policy.

      Returns:
      A score from 0.0 to 1.0 indicating how well the policy covers the statements in the source documents. A higher score means more of the source content is represented in the policy.

    • accuracyScore

      public final Double accuracyScore()

      A score from 0.0 to 1.0 indicating how accurate the policy rules are relative to the source documents. A higher score means the policy rules more faithfully represent the source material.

      Returns:
      A score from 0.0 to 1.0 indicating how accurate the policy rules are relative to the source documents. A higher score means the policy rules more faithfully represent the source material.

    • hasRuleReports

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

    • ruleReports

      public final Map<String,AutomatedReasoningPolicyRuleReport> ruleReports()

      A mapping from rule identifiers to detailed fidelity reports for each rule, showing which source statements ground each rule and how accurate it is.

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

      Returns:
      A mapping from rule identifiers to detailed fidelity reports for each rule, showing which source statements ground each rule and how accurate it is.

    • hasVariableReports

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

    • variableReports

      public final Map<String,AutomatedReasoningPolicyVariableReport> variableReports()

      A mapping from variable names to detailed fidelity reports for each variable, showing which source statements ground each variable and how accurate it is.

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

      Returns:
      A mapping from variable names to detailed fidelity reports for each variable, showing which source statements ground each variable and how accurate it is.

    • hasDocumentSources

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

    • documentSources

      public final List<AutomatedReasoningPolicyReportSourceDocument> documentSources()

      A list of source documents with their content broken down into atomic statements and annotated with line numbers for precise referencing.

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

      Returns:
      A list of source documents with their content broken down into atomic statements and annotated with line numbers for precise referencing.

    • toBuilder

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

    • builder

      public static AutomatedReasoningPolicyFidelityReport.Builder builder()

    • serializableBuilderClass

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