跳到主要内容

参数

有关所有插件均可使用的配置项,请参阅插件通用配置

该插件支持使用 env:// 前缀从环境变量引用敏感参数值,也支持使用 secret:// 前缀从密钥管理器(例如 HashiCorp Vault 的 KV 密钥引擎)引用敏感参数值。有关更多信息,请参阅插件中的环境变量密钥

  • api_key

    string


    必填


    有效值:

    非空


    用于向 Lakera Guard API 进行认证的 API Key。它会作为 Bearer Token 通过 Authorization 请求头发送。该值会在存储前加密。

  • lakera_endpoint

    string


    默认值:https://api.lakera.ai/v2/guard


    Lakera Guard v2 端点的 URL。可将其设置为指向自托管或区域化的 Lakera Guard 部署。

  • project_id

    string


    Lakera 项目 ID,其策略(检测器和阈值)将应用于本次扫描。

  • direction

    string


    默认值:input


    有效值:

    inputoutputboth


    要扫描的流量。取值为 input 时,仅扫描请求提示词。取值为 output 时,仅扫描 LLM 响应(包括流式响应)。取值为 both 时,两者都扫描。

  • action

    string


    默认值:block


    有效值:

    blockalert


    如何处理被标记的判定结果。取值为 block 时,请求或响应将被拒绝。取值为 alert 时,流量将被放行且仅记录判定结果,这在正式实施某个策略之前评估该策略时很有用。

  • deny_code

    integer


    默认值:200


    有效值:

    介于 200 和 599 之间(含边界值)


    拦截被标记流量时返回的 HTTP 状态码。默认值 200 会返回一个与提供商兼容的补全,其内容为失败消息,因此 SDK 客户端可以优雅地处理它。设置为 4xx 值可改为将拦截以 HTTP 错误的形式呈现。

  • request_failure_message

    string


    默认值:Request blocked by Lakera Guard


    当请求提示词被标记时,在拒绝响应中返回的消息。

  • response_failure_message

    string


    默认值:Response blocked by Lakera Guard


    当 LLM 响应被标记时,在拒绝响应中返回的消息。

  • reveal_failure_categories

    boolean


    默认值:false


    如果为 true,将被标记的检测器类别(及其置信度)追加到失败消息中。

  • fail_open

    boolean


    默认值:false


    当对 Lakera Guard API 的调用失败或超时时的行为。如果为 false,流量将被拦截(失败时关闭,fail closed)。如果为 true,流量将被放行(失败时打开,fail open)。

  • fail_mode

    string


    默认值:skip


    有效值:

    skipwarnerror


    当请求格式未被识别为 AI 流量时(例如路由未同时配置 ai-proxyai-proxy-multi)的行为。取值为 skip 时,请求将不经检查直接放行。取值为 warn 时,请求将放行并记录一条警告日志。取值为 error 时,请求将以 HTTP 500 被拒绝。

  • timeout

    integer


    默认值:5000


    有效值:

    大于或等于 1


    对 Lakera Guard API 发起请求的超时时间,单位为毫秒。

  • ssl_verify

    boolean


    默认值:true


    如果为 true,验证 Lakera Guard 端点的 TLS 证书。