跳到主要内容

参数

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

  • access_key_id

    string

    必填


    阿里云 Access Key ID。

  • access_key_secret

    string

    必填


    阿里云 Access Key Secret。该值会在存储前加密。

  • region_id

    string

    必填


    阿里云 Region ID。

  • endpoint

    string

    必填


    阿里云 Endpoint。

  • check_request

    boolean

    默认值:true


    如果为 true,则审核请求内容。

  • check_response

    boolean

    默认值:false


    如果为 true,则审核响应内容。

  • request_check_service

    string

    默认值:llm_query_moderation


    阿里云审核请求的服务位置。

  • request_check_length_limit

    number

    默认值:2000


    请求内容长度限制,以字符数计。超过该限制时,内容将分块发送。

    例如,请求内容有 250 个字符且 request_check_length_limit 设置为 100 时,内容将通过 3 个请求发送到阿里云。

  • response_check_service

    string

    默认值:llm_response_moderation


    阿里云审核响应的服务位置。

  • response_check_length_limit

    number

    默认值:5000


    响应内容长度限制,以字符数计。超过该限制时,内容将分块发送。

    例如,响应内容有 250 个字符且 response_check_length_limit 设置为 100 时,内容将通过 3 个请求发送到阿里云。

  • risk_level_bar

    string

    默认值:high

    有效值:

    nonelowmediumhighmax


    如果评估的风险等级低于 risk_level_bar,则请求/响应将分别传递给上游 LLM / 客户端。

  • deny_code

    integer

    默认值:200

    有效值:

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


    拒绝 HTTP 状态码。

  • deny_message

    string


    拒绝消息。

  • timeout

    integer

    默认值:10000

    有效值:

    大于或等于 1


    超时时间(毫秒)。

  • stream_check_mode

    string

    默认值:final_packet

    有效值:

    realtimefinal_packet


    流式检查模式,用于指定如何审核流式(SSE)响应的内容。

    realtime 在响应流式传输期间以增量批次方式执行审核检查。检测到违规时,将立即中断流并返回拒绝消息。

    final_packet 在 LLM 完成响应后评估完整响应,并将计算出的风险等级追加到 SSE 消息的数据字段中。

  • stream_check_cache_size

    integer

    默认值:128

    有效值:

    大于或等于 1


    realtime 模式下每个审核批次的最大字符数。

  • stream_check_interval

    number

    默认值:3

    有效值:

    大于或等于 0.1


    realtime 模式下两次批量检查之间的间隔秒数。

  • keepalive

    boolean

    默认值:true


    如果为 true,则启用到阿里云的 HTTP keepalive。

  • keepalive_pool

    integer

    默认值:30

    有效值:

    大于或等于 1


    keepalive 连接池中的最大连接数。

  • keepalive_timeout

    integer

    默认值:60000

    有效值:

    大于或等于 1000


    keepalive 超时时间(毫秒)。

  • ssl_verify

    boolean

    默认值:true


    如果为 true,启用 SSL 验证。

  • fail_mode

    string

    默认值:skip

    有效值:

    skipwarnerror


    插件绑定到 Consumer 后收到无法识别格式的请求(例如非 AI 请求)时的处理方式。设置为 skip 时,未识别的请求不经检查直接放行;设置为 warn 时,请求将被放行并记录警告;设置为 error 时,请求将以 HTTP 400 被拒绝。

    自 API7 企业版 3.9.14 起可用。

  • request_check_mode

    string

    默认值:last

    有效值:

    lastall


    对请求中由 request_check_roles 选定角色的哪些轮次消息进行审核。设置为 last 时,仅审核最近连续的一组已选 usertool 消息;设置为 all 时,审核所有已选 usertool 消息。选择 system 角色后,每个请求都会审核该角色。

    在 3.9 系列中自 API7 企业版 3.9.16 起可用,在 3.10 系列中自 3.10.2 起可用。

  • request_check_roles

    array[string]

    默认值:["user"]

    有效值:

    usertoolsystem


    请求侧要审核的消息角色。usertool 遵循 request_check_mode;由于系统内容可能受到恶意工具调用参数的影响,system 会在每个请求中接受检查。

    工具结果审核适用于以单独 tool 角色或条目表示工具输出的 OpenAI 兼容格式。

    在 3.9 系列中自 API7 企业版 3.9.16 起可用,在 3.10 系列中自 3.10.2 起可用。