添加AI护栏模板规则

project_id

是

String

参数解释：

项目ID，用于标识请求所属的项目

约束限制：

字符串类型，32位UUID

取值范围：

只能由英文字母、数字组成，长度为1~64个字符

默认取值：

不涉及

policy_id

是

String

参数解释：

策略ID，用于标识AI护栏策略

约束限制：

字符串类型，32位UUID

取值范围：

只能由英文字母、数字组成，长度为1~64个字符

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

用户Token，用于验证请求的合法性。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

约束限制：

字符串类型，长度1~16384个字符

取值范围：

只能由英文字母、数字及"-"、"_"组成

默认取值：

不涉及

Content-Type

是

String

参数解释：

内容类型，用于指定请求体的媒体类型

约束限制：

固定值application/json

取值范围：

application/json

默认取值：

application/json

template_id

是

String

参数解释：

模板ID，用于指定应用的模板

取值范围：

字符串类型，8位字符

约束限制：

字符串类型，8位字符，必选

默认取值：

无

name

否

String

参数解释：

规则名称，用于标识规则，非必选，通过模板生成

取值范围：

字符串类型，长度1-255字符

约束限制：

字符串类型，长度1-255字符

默认取值：

无

action

否

AiGuardRuleAction object

参数解释：

防护动作，用于指定防护动作分类，非必选

取值范围：

对象类型，包含category字段

约束限制：

对象类型，必选

默认取值：

无

status

否

String

参数解释：

规则状态，用于标识规则的启用状态，非必选

取值范围：

enable(启用)、disable(禁用)

约束限制：

字符串类型，必选

默认取值：

无

project_id

否

String

参数解释：

项目ID，用于标识项目

取值范围：

字符串类型，32位UUID

约束限制：

字符串类型，32位UUID

默认取值：

无

tenant_id

否

String

参数解释：

租户ID，用于标识租户

取值范围：

字符串类型，长度1-64字符

约束限制：

字符串类型，长度1-64字符

默认取值：

无

not_supported_language_action

否

String

参数解释：

其他语言检测动作，用于指定不支持语言的检测动作

取值范围：

log(仅记录)、block(拦截)、pass(放行)

约束限制：

字符串类型，非必选

默认取值：

无

supported_language_labels

否

Array of strings

参数解释：

语言检测标签列表，用于指定支持的语言检测标签

取值范围：

zh/en(中英文)、extend-language(扩展语言/小语种)

约束限制：

数组类型，非必选

默认取值：

无

category

否

String

参数解释：

动作分类，用于标识防护动作的类型

取值范围：

log(仅记录)、block(拦截)

约束限制：

字符串类型，必选

默认取值：

无

id

String

参数解释：

规则ID，用于唯一标识规则

取值范围：

字符串类型，长度1-64字符

name

String

参数解释：

规则名称，用于标识规则的名称

取值范围：

字符串类型，长度1-255字符

policy_id

String

参数解释：

策略ID，用于标识规则所属的策略

取值范围：

字符串类型，32位UUID

status

String

参数解释：

规则状态，用于标识规则的启用状态

取值范围：

enable(启用)、disable(禁用)

detect_opts

Array of DetectOpt objects

参数解释：

检测选项配置列表，用于配置AI护栏规则的检测选项

取值范围：

数组类型，每个元素为DetectOpt对象

action

AiGuardRuleAction object

参数解释：

防护动作，用于指定AI护栏规则的防护动作

取值范围：

对象类型，包含category字段

detect_labels

DetectLabels object

参数解释：

检测标签配置，用于配置AI护栏规则的检测标签

取值范围：

对象类型，包含多个标签列表

create_time

Long

参数解释：

创建时间，用于标识规则的创建时间

取值范围：

毫秒时间戳，大于0的整数

update_time

Long

参数解释：

更新时间，用于标识规则的最后更新时间

取值范围：

毫秒时间戳，大于0的整数

detect_labels_info

DetectLabelsInfo object

参数解释：

检测标签详情，用于返回检测标签的详细信息

取值范围：

对象类型，DetectLabelsInfo对象

abuse_config

AbuseConfig object

参数解释：

算力滥用配置，仅当detect_opts包含type=abuse且enable=true时返回。

约束限制：

对象类型，当detect_opts包含type=abuse且enable=true时该字段不为空。

取值范围：

对象类型，包含scope和threshold字段。

默认取值：

不涉及。

type

String

参数解释：

检测类型，用于标识检测的类型

取值范围：

lexicon(词库检测)、compliance(合规检测)、inject(注入检测)、immunity_lexicon(豁免词库)、abuse（算力消耗）

约束限制：

字符串类型，必选

默认取值：

无

enable

Boolean

参数解释：

是否启用该检测类型，用于标识检测类型的启用状态

取值范围：

true(启用)、false(禁用)

约束限制：

布尔类型，必选

默认取值：

无

category

String

参数解释：

动作分类，用于标识防护动作的类型

取值范围：

log(仅记录)、block(拦截)

约束限制：

字符串类型，必选

默认取值：

无

compliance_labels

Array of strings

参数解释：

合规检测标签列表，用于配置合规检测标签

取值范围：

字符串数组，最多10个元素

约束限制：

数组类型，非必选

默认取值：

无

inject_labels

Array of strings

参数解释：

注入检测标签列表，用于配置注入检测标签

取值范围：

字符串数组，最多10个元素

约束限制：

数组类型，非必选

默认取值：

无

immunity_lexicon_labels

Array of strings

参数解释：

豁免词库标签列表，用于配置豁免词库标签

取值范围：

字符串数组，最多10个元素

约束限制：

数组类型，非必选

默认取值：

无

lexicon_labels

Array of strings

参数解释：

自定义词库检测标签列表，用于配置自定义词库检测标签

取值范围：

字符串数组，最多10个元素

约束限制：

数组类型，非必选

默认取值：

无

lexicon_internal_labels

Array of strings

参数解释：

内置词库检测标签列表，用于配置内置词库检测标签

取值范围：

字符串数组，最多10个元素

约束限制：

数组类型，非必选

默认取值：

无

label

String

参数解释：

检测标签，用于标识检测的标签

取值范围：

字符串类型，长度1-64字符

name

String

参数解释：

检测名称，用于标识检测的名称

取值范围：

字符串类型，长度1-255字符

scope

AbuseScope object

参数解释：

请求统计范围，用于指定算力滥用的统计范围。

约束限制：

对象类型，必填。

取值范围：

对象类型，包含type和user_identifier字段。

默认取值：

不涉及。

threshold

AbuseThreshold object

参数解释：

触发阈值配置，用于指定算力滥用的触发阈值。

约束限制：

对象类型，必填。

取值范围：

对象类型，包含time_window_seconds和conditions字段。

默认取值：

不涉及。

type

String

参数解释：

统计范围类型，用于指定算力滥用的统计方式。

约束限制：

字符串类型，必填。

取值范围：

all_users：统计所有用户的合并用量；single_user：按单个用户统计用量。

默认取值：

不涉及。

user_identifier

String

参数解释：

用户标识字段名，当type=single_user时必填，指定用户标识字段名。

约束限制：

字符串类型，当type=single_user时必填。

取值范围：

字符串类型，如user_id、app_id、ip等，长度1~64字符。

默认取值：

不涉及。

time_window_seconds

Integer

参数解释：

统计时间窗口（秒），用于指定阈值统计的时间范围。

约束限制：

整数类型，必填。

取值范围：

1~86400的整数，如60/300/3600。

默认取值：

不涉及。

conditions

Array of AbuseCondition objects

参数解释：

阈值条件列表，用于指定触发阈值的条件。

约束限制：

数组类型，当前版本必须恰好1个条件。

取值范围：

数组类型，每个元素为AbuseCondition对象。

默认取值：

不涉及。

dimension

String

参数解释：

算力消耗统计维度，用于指定统计的维度。

约束限制：

字符串类型，必填。

取值范围：

input：仅统计模型输入；output：仅统计模型输出；input_output：统计输入+输出的合并。

默认取值：

不涉及。

metric

String

参数解释：

阈值指标类型，用于指定阈值的衡量方式。

约束限制：

字符串类型，必填。

取值范围：

call_count：调用次数；char_count：字符数。

默认取值：

不涉及。

value

Long

参数解释：

阈值数值，用于指定触发阈值的具体数值。

约束限制：

整数类型，必填，必须大于0。当metric=call_count时上限为1,000,000，当metric=char_count时上限为1,000,000,000,000。

取值范围：

metric=call_count时：1~1,000,000；metric=char_count时：1~1,000,000,000,000。

默认取值：

不涉及。

error_code

String

参数解释：

错误码，用于标识错误类型

取值范围：

字符串类型，长度1~64字符

error_msg

String

参数解释：

错误信息，用于描述错误详情

取值范围：

字符串类型，长度1~2048字符

error_code

String

参数解释：

错误码，用于标识错误类型

取值范围：

字符串类型，长度1~64字符

error_msg

String

参数解释：

错误信息，用于描述错误详情

取值范围：

字符串类型，长度1~2048字符

200

操作成功

400

参数错误

500

服务端内部错误