创建词库(CSV上传) - CreateUpload
功能介绍
功能介绍:通过上传CSV文件创建内容审核词库。需提供词库名称、类型(黑名单/白名单)和CSV文件,CSV文件需符合词库模板格式(包含关键字、规则编码、类别等列)。返回词库ID和词条数量。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v1/{project_id}/content-check/lexicons/upload
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识资源所属的华为云项目,用于隔离不同的租户资源。可通过用户控制台的“我的凭证”页面或调用IAM服务接口获取对应的项目ID 约束限制: 满足正则匹配"^[a-z0-9]{32}$" 取值范围: 由IAM服务接口返回,为固定长度的32个字符,由数字和字母组成 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于鉴权和标识调用方身份。通过调用IAM服务“查询用户Token”接口获取,Token值为响应消息头中X-Subject-Token对应的值 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| lexicon_name | 是 | String | 参数解释: 词库名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| lexicon_type | 是 | String | 参数解释: 词库类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| lexicon_desc | 否 | String | 参数解释: 词库描述 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| file | 是 | File | 参数解释: 上传的词库CSV文件,用于以CSV文件形式批量上传词条内容以创建词库。文件需符合词库CSV模板格式(包含关键字、规则编码、类别等列) 约束限制: 不涉及 取值范围: CSV格式文件,字符编码建议UTF-8 默认取值: 不涉及 |
响应参数
状态码:201
| 参数 | 参数类型 | 描述 |
|---|---|---|
| lexicon_id | String | 参数解释: 词库ID 取值范围: 不涉及 |
| entry_count | Integer | 参数解释: 词条数量 取值范围: 不涉及 |
| updated_at | Long | 参数解释: 更新时间,Unix时间戳,单位毫秒 取值范围: 0 ~ 9999999999999(Unix时间戳,单位毫秒) |
请求示例
通过CSV文件上传创建词库
{
"lexicon_name" : "blacklist-sensitive-words",
"lexicon_type" : "BLACK",
"lexicon_desc" : "敏感词黑名单词库,用于内容审核敏感词过滤",
"file" : "sensitive-words.csv"
} 响应示例
状态码:201
lexicon_id: 1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a entry_count:111 updated_at:177777565
状态码
| 状态码 | 描述 |
|---|---|
| 201 | 请求已成功 |
错误码
请参见错误码。