本文提供了获取已添加的自定义文本库列表的具体接口及参数，帮助您通过API接口自主管理您的文本库。您通过API接口管理的文本库可用于文本反垃圾检测，该方式获取的文本库信息与内容安全控制台上的自定义文本库一致。

使用说明

业务接口：DescribeKeywordLib

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

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

QPS限制

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

请求参数

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

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

文本库所属的功能模块，取值：open_api，表示用于内容检测API功能的文本库。

返回数据

关于返回结果说明，请参见返回结果。

返回body中的KeywordLibList字段是JSON数组，每一个元素包含如下字段：
名称 类型 示例值 描述
Id Integer 2147 文本库ID。
ModifiedTime String 2018-09-04 14:17:56 +0800 文本库最近一次修改时间。
Name String test1sdkdk 文本库名称。
Code String 710001 文本库Code。
说明 在控制台中机器审核 > 风险库管理页面显示的文本库Code，而在API接口中以文本库ID标识文本库。
Count String 3 文本库中添加的文本的数量。
Category String BLACK 文本库类型，取值：
  • BLACK：表示匹配命中该文本库后，检测的目标文本结果为违规文本，您需要直接删除或限制公开该文本。
  • WHITE：表示匹配命中该文本库后，检测的目标文本结果为正常文本，可以直接放行。
  • REVIEW：表示匹配命中该文本库后，检测的目标文本需要执行人工审核。
Source String MANUAL 自定义的文本库的来源，取值：
  • MANUAL：手动创建的文本库。
  • FEEDBACK：内容安全自动创建的文本库。
BizTypes StringArray ["bizTypeA","bizTypeB"] 业务场景。更多信息，请参见创建业务场景。
ResourceType String TEXT 文本库类型，取值：
  • TEXT：文字文本库
  • IMAGE：图片文本库
  • VOICE：语音文本库
LibType String textKeyword 各应用场景中的文本库类型，取值：
  • 文本反垃圾场景
    • textKeyword：关键词文本库
    • similarText：相似文本库
  • 图片广告场景

    textKeyword：图片关键词文本库

  • 语音反垃圾场景

    voiceText：语音关键词文本库

MatchMode String fuzzy 待检测文本与文本库匹配的方式。取值：
  • fuzzy：模糊匹配
  • precise：精确匹配
Enable Boolean true 文本库的状态。
  • true：已启用
  • false：已停用。
    说明 如果您需要再次启用已停用的文本库，可以调用创建文本库接口来修改文本库的状态。相关文档，请参见修改文本库。

示例

请求示例
http(s)://green.cn-shanghai.aliyuncs.com/?
Action=DescribeKeywordLib&ServiceModule=open_api
&<公共请求参数>
返回示例
{
  "requestId": "795D8871-4889-4C0F-A8B1-C7D2B990FF61",
  "data": {
    "TotalCount": 11,
    "KeywordLibList": [
      {
        "Name": "test1sdkdk",
        "Source": "MANUAL",
        "BizTypes": [],
        "Category": "BLACK",
        "ServiceModule": "open_api",
        "Count": 3,
        "ResourceType": "TEXT",
        "Id": 2147,
        "ModifiedTime": "2018-09-04 14:17:56 +0800",
        "Code": "710001",
        "LibType": "textKeyword",
        "MatchMode":"fuzzy",
        "Enable":"true"
      },
      {
        "Name": "Test001",
        "Source": "MANUAL",
        "BizTypes": [],
        "Category": "BLACK",
        "ServiceModule": "open_api",
        "Count": 3,
        "ResourceType": "VOICE",
        "Id": 2693,
        "ModifiedTime": "2018-09-03 17:11:04 +0800",
        "Code": "932001",
        "LibType": "voiceText",
        "MatchMode":"fuzzy",
        "Enable":"true"
      }
    ]
  },
  "code": 200,
  "success": true
}