AI Lakera Guard Configuration
Parameters
See plugin common configurations for configuration options available to all plugins.
This plugin supports referencing sensitive parameter values from environment variables using the env:// prefix, or from a secret manager, such as HashiCorp Vault’s KV secrets engine, using the secret:// prefix. For more information, see environment variables in plugin and secrets.
-
api_key—string· requiredValid values: non-empty
API key used to authenticate to the Lakera Guard API. It is sent as a Bearer token in the
Authorizationheader. The value is encrypted before being stored. -
lakera_endpoint—string· optional · default:https://api.lakera.ai/v2/guardURL of the Lakera Guard v2 endpoint. Set this to point at a self-hosted or regional Lakera Guard deployment.
-
project_id—string· optionalLakera project ID whose policy (detectors and thresholds) should be applied to the scan.
-
direction—string· optional · default:inputValid values:
input,output, orbothWhich traffic to scan. With
input, only the request prompt is scanned. Withoutput, only the LLM response is scanned, including streaming responses. Withboth, both are scanned. -
action—string· optional · default:blockValid values:
blockoralertHow to handle a flagged verdict. With
block, the request or response is denied. Withalert, the traffic is passed through and the verdict is only logged, which is useful for evaluating a policy before enforcing it. -
deny_code—integer· optional · default:200Valid values: between 200 and 599 inclusive
HTTP status code returned when blocking flagged traffic. The default
200returns a provider-compatible completion whose content is the failure message, so SDK clients handle it gracefully. Set a4xxvalue to surface the block as an HTTP error instead. -
request_failure_message—string· optional · default:Request blocked by Lakera GuardMessage returned in the deny response when the request prompt is flagged.
-
response_failure_message—string· optional · default:Response blocked by Lakera GuardMessage returned in the deny response when the LLM response is flagged.
-
reveal_failure_categories—boolean· optional · default:falseIf true, append the flagged detector categories (and their confidence levels) to the failure message.
-
fail_open—boolean· optional · default:falseBehavior when the call to the Lakera Guard API fails or times out. If false, the traffic is blocked (fail closed). If true, the traffic is allowed (fail open).
-
fail_mode—string· optional · default:skipValid values:
skip,warn, orerrorBehavior when the request format is not recognized as AI traffic, for example when the route does not also configure
ai-proxyorai-proxy-multi. Withskip, the request passes unchecked. Withwarn, it passes unchecked and a warning is logged. Witherror, the request is rejected with HTTP 500. None of these outcomes means a Lakera scan succeeded. -
timeout—integer· optional · default:5000Valid values: greater than or equal to 1
Timeout in milliseconds for the request to the Lakera Guard API.
-
ssl_verify—boolean· optional · default:trueIf true, verify the TLS certificate of the Lakera Guard endpoint.