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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AutomatedReasoningPolicyRuleReport.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`accuracyJustification()`	A textual explanation of the accuracy score, describing why the rule received this particular accuracy rating.
`Double`	`accuracyScore()`	A score from 0.0 to 1.0 indicating how accurately this rule represents the source material.
`static AutomatedReasoningPolicyRuleReport.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<String>`	`groundingJustifications()`	Explanations describing how the source statements support and justify this specific rule.
`List<AutomatedReasoningPolicyStatementReference>`	`groundingStatements()`	References to statements from the source documents that provide the basis or justification for this rule.
`boolean`	`hasGroundingJustifications()`	For responses, this returns true if the service returned a value for the GroundingJustifications property.
`boolean`	`hasGroundingStatements()`	For responses, this returns true if the service returned a value for the GroundingStatements property.
`int`	`hashCode()`
`String`	`rule()`	The identifier of the policy rule being analyzed in this report.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AutomatedReasoningPolicyRuleReport.Builder>`	`serializableBuilderClass()`
`AutomatedReasoningPolicyRuleReport.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AutomatedReasoningPolicyRuleReport.Builder,AutomatedReasoningPolicyRuleReport>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class AutomatedReasoningPolicyRuleReport

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

rule

hasGroundingStatements

groundingStatements

hasGroundingJustifications

groundingJustifications

accuracyScore

accuracyJustification

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField