Class GuardrailAutomatedReasoningTranslation

    • 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 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<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 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<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 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<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 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<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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)