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

使用说明

业务接口：CreateKeywordLib

您可以调用该接口创建文本库。关于如何构造HTTP请求，请参见请求结构；您也可以直接选用已构造好的HTTP请求，更多信息，请参见SDK概览。

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

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

计费信息：该接口为免费接口。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。

请求参数

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

请求body是一个结构体，结构说明如下：
名称 类型 是否必须 示例值 描述
ServiceModule String 是 open_api

服务模块名称，取值：open_api。

Name String 是 test1sdkdk 文本库名称。
ResourceType String 是 TEXT 文本库应用的检测场景类型，取值：
  • TEXT：文本反垃圾
  • IMAGE：图文违规检测
  • VOICE：语音反垃圾
BizTypes StringArray 否 ["bizTypeA","bizTypeB"] 业务场景。更多信息，请参见创建业务场景。
Category String 是 BLACK 文本库类型，取值：
  • BLACK：风险名单
  • WHITE：可信名单
  • REVIEW：疑似名单
LibType String 是 textKeyword 各应用场景中的文本库类型，取值：
  • 文本反垃圾
    • textKeyword：关键词文本库
    • similarText：相似文本库
  • 图文违规识别

    textKeyword：图片关键词文本库

  • 语音反垃圾

    voiceText：语音关键词文本库

MatchMode String 否 fuzzy 匹配方式。取值：
  • fuzzy：模糊匹配
  • precise：精确匹配
Enable Boolean 否 true 是否启用文本库。
  • true（默认）：启用
  • false：停用

返回数据

返回结果说明，参见返回结果。
名称 类型 示例值 描述
code Integer 200 错误码，和HTTP状态码一致。

更多信息，请参见公共错误码。

msg String OK 请求信息的响应消息。
requestId String 795D8871-4889-4C0F-A8B1-C7D2B990FF61 唯一标识该请求的ID，可用于定位问题。
id String 123 唯一标识一个文本库的ID，可以用于后续对文本库中的内容进行操作。

示例

请求示例
http(s)://green.cn-shanghai.aliyuncs.com/?
Action=CreateKeywordLib&ServiceModule=open_api
&<公共请求参数>
{
  "Name": "test1sdkdk",
  "BizTypes": [],
  "Category": "BLACK",
  "ServiceModule": "open_api",
  "ResourceType": "TEXT",
  "LibType": "textKeyword"
}
返回示例
{
  "RequestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
  "code": 200,
  "Id": "123"
}