Class GuardrailAutomatedReasoningTranslation
- java.lang.Object
-
- software.amazon.awssdk.services.bedrockruntime.model.GuardrailAutomatedReasoningTranslation
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<GuardrailAutomatedReasoningTranslation.Builder,GuardrailAutomatedReasoningTranslation>
@Generated("software.amazon.awssdk:codegen") public final class GuardrailAutomatedReasoningTranslation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GuardrailAutomatedReasoningTranslation.Builder,GuardrailAutomatedReasoningTranslation>
Contains the logical translation of natural language input into formal logical statements, including premises, claims, and confidence scores.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGuardrailAutomatedReasoningTranslation.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GuardrailAutomatedReasoningTranslation.Builderbuilder()List<GuardrailAutomatedReasoningStatement>claims()The logical statements that are being validated against the premises and policy rules.Doubleconfidence()A confidence score between 0 and 1 indicating how certain the system is about the logical translation.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasClaims()For responses, this returns true if the service returned a value for the Claims property.inthashCode()booleanhasPremises()For responses, this returns true if the service returned a value for the Premises property.booleanhasUntranslatedClaims()For responses, this returns true if the service returned a value for the UntranslatedClaims property.booleanhasUntranslatedPremises()For responses, this returns true if the service returned a value for the UntranslatedPremises property.List<GuardrailAutomatedReasoningStatement>premises()The logical statements that serve as the foundation or assumptions for the claims.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GuardrailAutomatedReasoningTranslation.Builder>serializableBuilderClass()GuardrailAutomatedReasoningTranslation.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<GuardrailAutomatedReasoningInputTextReference>untranslatedClaims()References to portions of the original input text that correspond to the claims but could not be fully translated.List<GuardrailAutomatedReasoningInputTextReference>untranslatedPremises()References to portions of the original input text that correspond to the premises but could not be fully translated.-
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
-
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 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.
-
premises
public final List<GuardrailAutomatedReasoningStatement> 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 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.
-
claims
public final List<GuardrailAutomatedReasoningStatement> 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 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.
-
untranslatedPremises
public final List<GuardrailAutomatedReasoningInputTextReference> 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 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.
-
untranslatedClaims
public final List<GuardrailAutomatedReasoningInputTextReference> 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 GuardrailAutomatedReasoningTranslation.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GuardrailAutomatedReasoningTranslation.Builder,GuardrailAutomatedReasoningTranslation>
-
builder
public static GuardrailAutomatedReasoningTranslation.Builder builder()
-
serializableBuilderClass
public static Class<? extends GuardrailAutomatedReasoningTranslation.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
-
-