跳到主要内容

指定名单添加词条

1. 请求​

1.1 请求地址​

区域请求地址
国内https://api.open.tuputech.com/v3/management/keyword/create/<secretId>
提示

<secretId> 需替换为您的应用 SID，请联系客户经理为您开通及配置。关于 SID 详见 常见问题（FAQ）。

1.2 请求方法​

POST

1.3 请求头​

Content-Type: application/json

1.4 请求参数​

参数名称类型是否必需说明
timestampNumber是当前服务器的 Unix 时间戳，可以是毫秒或秒级。
nonceNumber是随机数
signatureString是

RSA-SHA256 算法签名。签名步骤：

  1. 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString；
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例
thesaurusIdString是文本名单 ID
keywordsArray<Keyword>是词条数组（添加过程会忽略重复和空白的词条），单次请求添加数量应小于 10,000 ，详见 keyword 结果说明

Keyword 结果说明​

参数名称类型是否必需说明
contentString是词条文本

1.5 请求示例​

{
  "thesaurusId": "<thesaurusId>",
  "timestamp": "<timestamp>",
  "nonce": "<nonce>",
  "signature": "<signature>",
  "keywords": [
    {
      "content": "1 xxxx"
    },
    {
      "content": "2 xxxx"
    },
    {
      "content": "3 xxxx"
    }
  ]
}

2. 响应​

2.1 响应内容​

参数名称类型说明
jsonString响应内容 JSON 转义后的字符串
signatureString响应内容签名

2.2 响应参数​

参数名称类型是否可能为空说明
codeNumber否状态码
nonceNumber否随机数
messageString否相关信息
timestampNumber否时间戳
keywordsArray<Keyword>否词条信息（添加过程中会忽略重复和空白的词条），详见 keyword 结果说明

Keyword 结果说明​

参数名称类型是否可能为空说明
codeNumber否状态码，标识该文本是否成功入库，详见公共服务状态码
errorString否错误原因
contentString否词条文本

2.3 响应示例​

{
  "json": "{\"code\":0,\"keywords\":[{\"code\":0,\"error\":\"\",\"content\":\"1 xxxx\"},{\"code\":0,\"error\":\"\",\"content\":\"2 xxxx\"},{\"code\":0,\"error\":\"\",\"content\":\"3 xxxx\"}],\"message\":\"success\",\"nonce\":0.65333554465516,\"timestamp\":1669602627}",
  "signature": "iq72eJlFhYrbMJQxwPOG9my9kGSAVZnnW5GeH8kTOUaxj1sn0J2nDMSBi/5EnOU6nhUm2sgEWEoR4C/Oou4CD3++jV4BYfg/wAq5Vs953IaPJESGt+k9bgkxtijlYhKWyMtWecl41A9JkQAt+Vh2I7JxCy5n5/MRfRlqw49XSac="
}