Class AutomatedReasoningPolicyReportSourceDocument
- java.lang.Object
-
- software.amazon.awssdk.services.bedrock.model.AutomatedReasoningPolicyReportSourceDocument
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AutomatedReasoningPolicyReportSourceDocument.Builder,AutomatedReasoningPolicyReportSourceDocument>
@Generated("software.amazon.awssdk:codegen") public final class AutomatedReasoningPolicyReportSourceDocument extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AutomatedReasoningPolicyReportSourceDocument.Builder,AutomatedReasoningPolicyReportSourceDocument>
Represents a source document that was analyzed during fidelity report generation, including the document's metadata and its content broken down into atomic statements.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAutomatedReasoningPolicyReportSourceDocument.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AutomatedReasoningPolicyAtomicStatement>atomicStatements()The list of atomic statements extracted from this document, representing the fundamental units of meaning used for grounding.static AutomatedReasoningPolicyReportSourceDocument.Builderbuilder()List<AutomatedReasoningPolicyAnnotatedChunk>documentContent()The document's content organized into annotated chunks with line number information for precise referencing.StringdocumentHash()A SHA-256 hash of the document content, used for verification and ensuring the document hasn't changed since analysis.StringdocumentId()A unique identifier for this document within the fidelity report.StringdocumentName()The name of the source document that was analyzed.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAtomicStatements()For responses, this returns true if the service returned a value for the AtomicStatements property.booleanhasDocumentContent()For responses, this returns true if the service returned a value for the DocumentContent property.inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends AutomatedReasoningPolicyReportSourceDocument.Builder>serializableBuilderClass()AutomatedReasoningPolicyReportSourceDocument.BuildertoBuilder()StringtoString()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
-
documentName
public final String documentName()
The name of the source document that was analyzed.
- Returns:
- The name of the source document that was analyzed.
-
documentHash
public final String documentHash()
A SHA-256 hash of the document content, used for verification and ensuring the document hasn't changed since analysis.
- Returns:
- A SHA-256 hash of the document content, used for verification and ensuring the document hasn't changed since analysis.
-
documentId
public final String documentId()
A unique identifier for this document within the fidelity report.
- Returns:
- A unique identifier for this document within the fidelity report.
-
hasAtomicStatements
public final boolean hasAtomicStatements()
For responses, this returns true if the service returned a value for the AtomicStatements property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
atomicStatements
public final List<AutomatedReasoningPolicyAtomicStatement> atomicStatements()
The list of atomic statements extracted from this document, representing the fundamental units of meaning used for grounding.
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
hasAtomicStatements()method.- Returns:
- The list of atomic statements extracted from this document, representing the fundamental units of meaning used for grounding.
-
hasDocumentContent
public final boolean hasDocumentContent()
For responses, this returns true if the service returned a value for the DocumentContent property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
documentContent
public final List<AutomatedReasoningPolicyAnnotatedChunk> documentContent()
The document's content organized into annotated chunks with line number information 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
hasDocumentContent()method.- Returns:
- The document's content organized into annotated chunks with line number information for precise referencing.
-
toBuilder
public AutomatedReasoningPolicyReportSourceDocument.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AutomatedReasoningPolicyReportSourceDocument.Builder,AutomatedReasoningPolicyReportSourceDocument>
-
builder
public static AutomatedReasoningPolicyReportSourceDocument.Builder builder()
-
serializableBuilderClass
public static Class<? extends AutomatedReasoningPolicyReportSourceDocument.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-