本文提供了创建自定义文本库的具体接口及参数,旨在帮助您通过API接口自主管理您的文本库。您通过API接口管理的文本库可用于文本反垃圾检测,该方式与云盾内容控制台上的自定义文本库功能完全一致。

描述

业务接口:CreateKeywordLib

创建文本库。文本库适用于以下检测场景:
  • 文本反垃圾:识别文本中包含的违规内容。
  • 图文违规检测:识别图片中包含的广告和文字违规内容。
  • 语音反垃圾:识别语音中包含的违规内容。

您还可以通过控制台操作创建文本库。更多信息,请参见创建和管理自定义文本库

请求参数

关于在请求中必须包含的公共请求参数,请参见公共参数

请求body是一个结构体,结构说明如下:
名称 类型 是否必须 描述
ServiceModule 字符串
服务模块名称,取值:
  • open_api:用于内容检测API功能的文本库。
  • website:用于站点检测功能的文本库。
Name 字符串 文本库名称。
ResourceType 字符串 文本库应用的检测场景类型,取值:
  • TEXT:文本反垃圾
  • IMAGE:图文违规检测
  • VOICE:语音反垃圾
BizTypes 列表 设置页面的内容检测API的自定义文本库位置显示的BizType。
Category 字符串 文本库类型,取值:
  • BLACK:黑名单
  • WHITE:白名单
  • REVIEW:灰名单
LibType 字符串 各应用场景中的文本库类型,取值:
  • 文本反垃圾
    • textKeyword:关键词文本库
    • similarText:相似文本库
  • 图文违规识别

    textKeyword:图片关键词文本库

  • 语音反垃圾

    voiceText:语音关键词文本库

MatchMode 字符串 匹配方式。取值:
  • fuzzy:模糊匹配
  • precise:精确匹配
Enable 布尔型 是否启用文本库,true表示启用,false表示停用。

返回参数

返回结果说明,参见返回结果
名称 类型 是否必须 描述
code 整型 错误码,和HTTP状态码一致(但有扩展)。
  • 2xx:表示调用成功
  • 4xx:表示请求有误
  • 5xx:表示后端有误
具体请参见公共错误码
msg 字符串 出现调用错误时,错误的描述信息。
requestId 字符串 唯一标识该请求的ID,可用于定位问题。
id 字符串 唯一标识一个文本库的id,可以用于后续对文本库中的内容进行操作。

示例

请求示例
{
  "Name": "test1sdkdk",
  "BizTypes": [],
  "Category": "BLACK",
  "ServiceModule": "open_api",
  "ResourceType": "TEXT",
  "LibType": "textKeyword"
}
返回示例
{
  "RequestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
  "code": 200,
  "Id":123
}