Package dev.langchain4j.service.guardrail

Annotation Interface OutputGuardrails

@Documented @Retention(RUNTIME) @Target({TYPE,METHOD}) public @interface OutputGuardrails
An annotation to apply guardrails to the output of the model using the declarative AiServices approach.

Am output guardrail is a rule that is applied to the output of the model to ensure that the output is safe and meets certain expectations.

When a validation fails, the result can indicate whether the request should be retried as-is, or to provide a reprompt message to append to the prompt.

In the case of re-prompting, the reprompt message is added to the LLM context and the request is then retried.

If the annotation is present on a class, the guardrails will be applied to all the methods of the class.

When several guardrails are applied, the order of the guardrails is important, as the guardrails are applied in the order they are listed.

When several OutputGuardrails are applied, if any guardrail forces a retry or reprompt, then all of the guardrails will be re-applied to the new response.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Class<? extends OutputGuardrail>[]
    value
    The ordered list of guardrails to apply to the output of the model.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    int
    maxRetries
    The maximum number of retries to perform when an output guardrail forces a retry or reprompt.

  • Element Details

    • value

      Class<? extends OutputGuardrail>[] value
      The ordered list of guardrails to apply to the output of the model.

      The order of the classes is important as the guardrails are applied in the order they are listed. Guardrails can not be present twice in the list.

    • maxRetries

      int maxRetries
      The maximum number of retries to perform when an output guardrail forces a retry or reprompt.

      Set to 0 to disable retries

      See Also:
      Default:
      2