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

使用说明

业务接口:CreateKeyword

您可以调用该接口指定文本库中添加关键词。关于如何构造HTTP请求,请参见请求结构;您也可以直接选用已构造好的HTTP请求,更多信息,请参见SDK概览

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

QPS限制

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

请求参数

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

请求body是一个结构体,结构说明如下:
名称 类型 是否必选 示例值 描述
KeywordLibId String 2147 文本库主键ID。
Keywords StringArray ["test"] 关键词列表。

返回数据

关于返回结果说明,请参见返回结果
名称 类型 示例值 描述
SuccessCount Integer 0 已成功添加的关键词数量。
InvalidKeywordList StringArray ["test"] 无效的关键词列表,即未添加成功的关键词。

示例

请求示例
{
  "KeywordLibId": "2147",
  "Keywords": [
      "test"
  ]
}
返回示例
{
  "code": 200,
  "data": {
    "InvalidKeywordList": [
      "test"
    ],
    "SuccessCount": 0
  }
}