Class AutomatedReasoningCheckTranslation

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

Contains the logical translation of natural language input into formal logical statements, including premises, claims, and confidence scores.

See Also:

  • Method Details

    • hasPremises

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

    • premises

      public final List<AutomatedReasoningLogicStatement> premises()

      The logical statements that serve as the foundation or assumptions for the claims.

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

      Returns:
      The logical statements that serve as the foundation or assumptions for the claims.

    • hasClaims

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

    • claims

      public final List<AutomatedReasoningLogicStatement> claims()

      The logical statements that are being validated against the premises and policy rules.

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

      Returns:
      The logical statements that are being validated against the premises and policy rules.

    • hasUntranslatedPremises

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

    • untranslatedPremises

      public final List<AutomatedReasoningCheckInputTextReference> untranslatedPremises()

      References to portions of the original input text that correspond to the premises but could not be fully translated.

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

      Returns:
      References to portions of the original input text that correspond to the premises but could not be fully translated.

    • hasUntranslatedClaims

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

    • untranslatedClaims

      public final List<AutomatedReasoningCheckInputTextReference> untranslatedClaims()

      References to portions of the original input text that correspond to the claims but could not be fully translated.

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

      Returns:
      References to portions of the original input text that correspond to the claims but could not be fully translated.

    • confidence

      public final Double confidence()

      A confidence score between 0 and 1 indicating how certain the system is about the logical translation.

      Returns:
      A confidence score between 0 and 1 indicating how certain the system is about the logical translation.

    • toBuilder

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

    • builder

      public static AutomatedReasoningCheckTranslation.Builder builder()

    • serializableBuilderClass

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