批量新增或修改词条 - CreateUpsert
功能介绍
功能介绍:批量新增或修改词条。传入的词条列表中,携带entry_id的为修改操作,不携带的为新增操作。返回新增数量、更新数量和当前词条总数。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/content-check/lexicons/{lexicon_id}/words/upsert
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识资源所属的华为云项目,用于隔离不同的租户资源。可通过用户控制台的“我的凭证”页面或调用IAM服务接口获取对应的项目ID 约束限制: 满足正则匹配"^[a-z0-9]{32}$" 取值范围: 由IAM服务接口返回,为固定长度的32个字符,由数字和字母组成 默认取值: 不涉及 |
| lexicon_id | 是 | String | 参数解释: 词库的ID,唯一的资源标识,用于定位要操作的具体词库。可通过调用创建词库接口的返回值获取,或通过查询词库列表接口获取 约束限制: 满足正则匹配"^[a-z0-9]{32}$" 取值范围: 字符类型,长度不超过64个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权和标识调用方身份。通过调用IAM服务“查询用户Token”接口获取,Token值为响应消息头中X-Subject-Token对应的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| words | 是 | Array of WordItem objects | 参数解释: 词语条目列表,数组元素为WordItem对象,每个元素包含条目ID(entry_id)、关键字(keyword)、规则编码(rule_code)、类别(category)等属性,用于批量新增或修改词条。详情参见WordItem结构 约束限制: 不涉及 取值范围: 数组元素为WordItem对象,最大元素数量为100个 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| entry_id | 否 | String | 参数解释: 条目ID,词语条目的唯一标识。新增词条时该ID由系统自动生成(可留空),修改已有词条时需传入已有条目ID,可通过查询指定词库的词条列表接口获取 约束限制: 不涉及 取值范围: 字符类型,长度不超过64个字符 默认取值: 不涉及 |
| keyword | 是 | String | 参数解释: 关键字 约束限制: 最大长度64字符 取值范围: 不涉及 默认取值: 不涉及 |
| rule_code | 是 | String | 参数解释: 规则编码,用于指定词条所采用的匹配检测规则类型,黑词库不支持REGEX 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| category | 否 | String | 参数解释: 词条所属检测类别,用于指定该词条在内容审核中参与哪类违规检测,黑词库必须有违禁类型,白词库无违禁词类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| added | Integer | 参数解释: 添加数量 取值范围: 不涉及 |
| updated | Integer | 参数解释: 更新数量 取值范围: 不涉及 |
| total_word_count | Integer | 参数解释: 当前词条数量 取值范围: 不涉及 |
| updated_at | Long | 参数解释: 更新时间,Unix时间戳,单位毫秒 取值范围: 0 ~ 9999999999999(Unix时间戳,单位毫秒) |
请求示例
批量新增或修改词条
{
"words" : [ {
"entry_id" : "5b6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e",
"keyword" : "未授权转载内容",
"rule_code" : "REGEX",
"category" : "COPYRIGHT"
}, {
"entry_id" : "6c7d8e9f0a1b2c3d4e5f6a7b8c9d0e1f",
"keyword" : "侵权盗版素材",
"rule_code" : "SINGLE",
"category" : "COPYRIGHT"
} ]
} 响应示例
状态码:200
{
"added" : 10,
"updated" : 5,
"total_word_count" : 128,
"updated_at" : 1787392800000
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。