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

使用说明

业务接口:DescribeKeywordLib

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

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

QPS限制

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

请求参数

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

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

服务模块名称,取值:open_api

返回数据

关于返回结果说明,请参见返回结果

返回body中的Data字段是JSON数组,每一个元素包含如下字段:
名称 类型 示例值 描述
Id Integer 2147 主键ID。
ModifiedTime String 2018-09-04 14:17:56 +0800 最近一次修改时间。
Name String test1sdkdk 文本库名称。
Code String 710001 文本库编码。
说明 在控制台中显示的文本库编码,而在API接口中以主键ID标识文本库。
Count String 3 文本库中的样本数量。
Category String BLACK 文本库类型,取值:
  • BLACK:黑名单
  • WHITE:白名单
  • REVIEW:灰名单
Source String MANUAL 文本库来源。
说明 目前取值均为MANUAL,即手动方式添加。
BizTypes StringArray ["bizTypeA","bizTypeB"] 设置页面的内容检测API的自定义文本库位置显示的BizType。
ResourceType String TEXT 文本库类型,取值:
  • TEXT:文字文本库
  • IMAGE:图片文本库
  • VOICE:语言文本库
LibType String textKeyword 各应用场景中的文本库类型,取值:
  • 文本反垃圾场景
    • textKeyword:关键词文本库
    • similarText:相似文本库
  • 图片广告场景

    textKeyword:图片关键词文本库

  • 语音反垃圾场景

    voiceText:语音关键词文本库

MatchMode String fuzzy 匹配类型。取值:
  • fuzzy:模糊匹配
  • precise:精确匹配
Enable Boolean true 是否启用文本库。
  • true:启用
  • false:停用

示例

请求示例
{
  "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": "语音测试",
        "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
}