Interface GuardrailResult<GR extends GuardrailResult>

All Known Implementing Classes:
InputGuardrailResult, OutputGuardrailResult
@Deprecated(forRemoval=true) public interface GuardrailResult<GR extends GuardrailResult>
Deprecated, for removal: This API element is subject to removal in a future version.
Use GuardrailResult instead
The result of the validation of an interaction between a user and the LLM.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    GuardrailResult.Failure
    Deprecated, for removal: This API element is subject to removal in a future version.
    The message and the cause of the failure of a single validation.
    static enum 
    GuardrailResult.Result
    Deprecated, for removal: This API element is subject to removal in a future version.
    The possible results of a guardrails validation.

  • Method Summary

    Modifier and Type
    Method
    Description
    default GuardrailResult<GR>
    blockRetry()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    List<? extends GuardrailResult.Failure>
    failures()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    default Throwable
    getFirstFailureException()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    GuardrailResult.Result
    getResult()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    default boolean
    hasRewrittenResult()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isFatal()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    default boolean
    isSuccess()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    default Object
    successfulResult()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    default String
    successfulText()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    GR
    validatedBy(Class<? extends Guardrail> guardrailClass)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Details

    • getResult

      GuardrailResult.Result getResult()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isSuccess

      default boolean isSuccess()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • hasRewrittenResult

      default boolean hasRewrittenResult()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • blockRetry

      default GuardrailResult<GR> blockRetry()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • successfulText

      default String successfulText()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • successfulResult

      default Object successfulResult()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • isFatal

      boolean isFatal()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • failures

      List<? extends GuardrailResult.Failure> failures()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns:
      The list of failures eventually resulting from a set of validations.

    • getFirstFailureException

      default Throwable getFirstFailureException()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • validatedBy

      GR validatedBy(Class<? extends Guardrail> guardrailClass)
      Deprecated, for removal: This API element is subject to removal in a future version.