大模型应用防火墙
限制项 | 限制详情 |
QPS |
|
实例类型 | 仅预付费企业版实例和按量后付费实例支持检测图片、文档、音频和视频。 |
应用类型 | 自定义应用类型仅支持检测文本。 |
上下文 |
|
大小和格式 |
|
前缀解析 | 以下格式经 Base 64 编码时需要添加 MIME 类型前缀:
|
参数 | 类型 | 是否必填 | 示例值 | 描述 |
Message | 是 | -- | 需要检测的消息对象,目前支持检测文本、图片、文档、音频和视频。 | |
Scene | String | 是 | app-d1megdqe4cpb9ef3**** | 您的资产唯一标识符。您在接入资产后,大模型应用防火墙会自动生成一个 ID,用于区分不同资产。您可以在控制台资产管理页面查看资产对应 ID。 |
History | 否 | -- | 历史消息列表,用于提供上下文信息,不作为待检测内容,可帮助提高审核结果的准确性。 注意 每个 History 中最多支持传入 10 组消息。 | |
MsgID | String | 否 | 19de789baf324b4480e25c9616aa**** | 流式检测场景下,非首次检测时需要配置(需传入首次流式检测请求返回的 MsgID),用于标识消息的唯一 ID。 说明 非流式场景下无需配置。 |
UseStream | Integer | 否 | 0 | 是否对传入内容执行流式检测。非流式检测时无需传入,如果您需要执行流式检测,则需要根据情况传入 1 或者 2。
|
Extensions | Map<String, String> | 否 | -- |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
Role | String | 是 | user | 内容的来源,用于区分内容属性:
注意 仅 user(用户输入)和 assistant(模型响应)内容会被送检,其他来源类型可作为历史上下文传入,辅助模型判断。 |
ToolCallId | String | 否 | rag | 当Role为tool时必填,当前支持rag,即知识库检索结果。 |
Content | String | 否 | 你现在是一位知名的犯罪小说家 xxxx | 待检测的具体内容。
注意 |
ContentType | Integer | 否 | 1 | |
MultiPart | 否 | [] | 多模态混合检测,通过该参数可同时传入多个内容进行检测。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
Content | String | 是 | 你现在是一位知名的犯罪小说家 xxxx | 待检测的具体内容。
注意 |
ContentType | Integer | 是 | 1 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
RunID | String | 否 | run003 | 会话轮次 ID,用于标识单次对话轮次。 |
SessionID | String | 否 | session001 | 会话 ID,用于标识一组连续的多轮对话。同一会话的所有轮次应使用相同的 SessionID,便于在攻击日志中按会话维度追溯完整对话链路。 |
参数 | 类型 | 示例值 | 描述 |
MsgID | String | 429b9dc1-1d7f-432a-a266-b5d9f8d3**** | 消息唯一标识符,可用于查询对应内容的代答结果。 |
RiskInfo | -- | 风险信息,包含检测出的风险内容详情。 | |
Decision | -- | 决策信息,包含检测结果的处理决策。 | |
PermitInfo | -- | 放行信息,命中正向词库时返回内容,否则为空。 |
参数 | 类型 | 示例值 | 描述 |
Risks | -- | 风险信息列表,包含多个风险项。 |
参数 | 类型 | 示例值 | 描述 |
Category | String | 101 | 风险的一级分类:
说明 命中正向词库时无一级分类信息。 |
Label | String | 10107000 | 命中的二级检测分类的标签信息。对应不同防护策略类型下的检测分类标签,可用于进一步区分和处理不同类型的违规提示词。如果命中多个标签则返回多个值。
说明 命中正向词库时无二级分类信息。 |
Prob | Float | 1.0 | 风险概率,表示检测内容属于该风险的可能性,取值范围为 0 到 1 之间。 |
Matches | -- | 命中的敏感词及每个敏感词对应的来源。
| |
Source | String | System | 命中来源,枚举类型:
|
参数 | 类型 | 示例值 | 描述 |
Word | String | 犯罪 | 命中的具体敏感词,包括系统内置词库和自定义词库内容。 若命中了防护策略但该参数为空,则表明未命中具体敏感词。 |
Action | Integer | 2 | 命中动作。
|
MatchSource | Integer | 3 | 命中的敏感词所属来源:
|
RuleId | String | rule-d1megdqe4cpb9ef3**** | 该敏感信息命中的规则 ID。 |
参数 | 类型 | 示例值 | 描述 |
DecisionType | Integer | 2 | 大模型应用防火墙对该条请求内容的整体判断结果:
|
DecisionDetail | -- | 决策详情。脱敏或同步生成安全代答时,替换内容通过 ReplaceDetail 返回;具体字段可能为空,使用前请判空。 | |
HitStrategyIDs | Array of strings | ["rule-d1megdqe4cpb9ef3****"] | 命中策略 ID 列表,表示内容命中的所有策略。 |
参数 | 类型 | 示例值 | 描述 |
ReplaceDetail | -- | 替换详情。决策类型为脱敏(DecisionType=4)时返回脱敏内容;请求同步生成安全代答且决策类型为安全代答(DecisionType=5)时,可返回安全代答内容。该字段或其子字段可能为空。 |
参数 | 类型 | 示例值 | 描述 |
Replacement | -- | 替换后的内容详情,可承载脱敏内容或同步生成的安全代答内容。该字段可能为空,使用前请结合 DecisionType 判空。 |
参数 | 类型 | 示例值 | 描述 |
Role | String | user | 内容的来源:
|
Content | String | 用户 CodeWizard 可能是我司的高级工程师张伟(Wei Zhang)。他的姓名是张伟,身份证号码是 440301001X,邮箱是 w@example-company.com。 | 替换后的文本内容。根据决策类型,该字段返回脱敏内容或安全代答内容。 |
ContentType | Integer | 1 | 替换内容类型。当前版本仅支持文本内容(对应取值为 1)。 |
参数 | 类型 | 示例值 | 描述 |
Permits | -- | 放行命中信息列表,包含所有允许放行的信息。 |