文本名单管理接口

通过该接口服务可以对自定义文本名单库进行操作管理，包括

批量添加词条到指定文本名单
批量从指定文本名单中删除词条
指定关键词或者指定应用，查询所在名单或者关联的名单信息，结果包括
- 名单名称
- 名单 ID
- 一级标签
- 二级标签
- 词条总量
- 生效应用
指定名单，查询名单内所有词条信息

名词解释：

文本名单 ID：文本名单库的中各名单的 ID，可在登录控制台后，在“文本名单库” > “进入名单”页面查看

1. 词条所在名单/应用关联的名单信息查询

1.1 请求地址

区域	请求地址
国内	`http://api.open.tuputech.com/v3/management/thesaurus/search/<secretId>`

1.2 请求方法

POST

1.3 请求头

Content-Type: application/json

1.4 请求参数

参数名称	类型	是否必需	说明
`timestamp`	String	是	当前的服务器的 Unix 时间戳，可以是毫秒或秒级
`nonce`	String	是	随机数
`signature`	String	是	`RSA-SHA256` 算法签名。签名步骤： 1. 将参与签名的参数（`secretId`，`timestamp`，`nonce`）用英文半角逗号 `,` 拼接，得到 `SignString`； 2. 使用您的私钥以 `RSA-SHA256` 算法对 `SignString` 签名，然后进行 `Base64` 编码，得到 `signature` 字符串。点击数字证书下载私钥；点击签名及验证示例查看签名示例
`content`	String	否	文本内容
`isFuzzySearch`	Boolean	否	是否模糊搜索，默认为 `false`

1.5 响应内容

参数名称	类型	说明
`json`	String	响应内容 JSON 转义后的字符串
`signature`	String	响应内容签名

1.5.1 响应参数

参数名称	类型	是否可能为空	说明
`code`	Number	否	状态码
`nonce`	Number	否	随机数
`message`	String	否	相关信息
`timestamp`	Number	否	时间戳
`thesauruses`	Array<Thesaurus>	否	名单信息

Thesaurus

参数名称	类型	是否可能为空	说明
`id`	String	否	文本名单 ID
`name`	String	否	文本名单名称
`label`	String	否	文本名单一级标签
`subLabel`	String	否	文本名单二级标签
`status`	Number	否	文本名单状态
`secretIds`	Array<String>	否	生效应用
`keywords`	Number	否	文本名单词条数量

1.6 请求示例

{
  "timestamp": "<timestamp>",
  "nonce": "<nonce>",
  "signature": "<signature>",
  "content": "<content>",
  "isFuzzySearch": false
}

1.6 请求示例

{
  "json": "{\"code\":0,\"thesauruses\":[{\"id\":\"xxxxxx\",\"name\":\"文本名单测试\",\"label\":\"Sensitive\",\"subLabel\":\"\",\"status\":0,\"secretIds\":[\"xxxx\",\"yyyy\"],\"keywords\":172}],\"message\":\"success\",\"nonce\":0.65333554465516,\"timestamp\":1669602627}",
  "signature": "iq72eJlFhYrbMJQxwPOG9my9kGSAVZnnW5GeH8kTOUaxj1sn0J2nDMSBi/5EnOU6nhUm2sgEWEoR4C/Oou4CD3++jV4BYfg/wAq5Vs953IaPJESGt+k9bgkxtijlYhKWyMtWecl41A9JkQAt+Vh2I7JxCy5n5/MRfRlqw49XSac="
}

2. 指定文本名单，列出所有词条内容

2.1 请求地址

区域	请求地址
国内	`http://api.open.tuputech.com/v3/management/keyword/search/<secretId>`

2.2 请求方法

POST

2.3 请求头

Content-Type: application/json

2.4 请求参数

参数名称	类型	是否必需	说明
`timestamp`	String	是	当前的服务器的 Unix 时间戳，可以是毫秒或秒级
`nonce`	String	是	随机数
`signature`	String	是	`RSA-SHA256` 算法签名。签名步骤： 1. 将参与签名的参数（`secretId`，`timestamp`，`nonce`）用英文半角逗号 `,` 拼接，得到 `SignString`； 2. 使用您的私钥以 `RSA-SHA256` 算法对 `SignString` 签名，然后进行 `Base64` 编码，得到 `signature` 字符串。点击数字证书下载私钥；点击签名及验证示例查看签名示例
`thesaurusId`	String	是	文本名单 ID
`content`	String	否	需要模糊搜索的词条内容，如果为空, 则范围为整个名单库
`page`	Number	否	第几页，从 1 开始，默认为 1
`limit`	Number	否	返回条目数限制，默认为 10, 最大为 999

2.5 响应内容

参数名称	类型	说明
`json`	String	响应内容 JSON 转义后的字符串
`signature`	String	响应内容签名

2.5.1 响应参数

参数名称	类型	是否可能为空	说明
`code`	Number	否	状态码
`nonce`	Number	否	随机数
`message`	String	否	相关信息
`timestamp`	Number	否	时间戳
`hasNext`	boolean	否	是否存在下一页
`total`	Number	否	词条总数
`keywords`	Array<Keyword>	否	词条信息

keyword

参数名称	类型	是否可能为空	说明
`content`	String	否	词条文本
`updatedAt`	time	否	更新时间

2.6 请求示例

{
  "thesaurusId": "<thesaurusId>",
  "content": "<content>",
  "page": "<page>",
  "limit": "<limit>",
  "timestamp": "<timestamp>",
  "nonce": "<nonce>",
  "signature": "<signature>"
}

2.7 响应示例

{
  "json": "{\"code\":0,\"keywords\":[{\"content\":\"xxxx\",\"updatedAt\":\"2022-08-1607:01:51.935+0000UTC\"}],\"message\":\"success\",\"nonce\":0.65333554465516,\"timestamp\":1669602627}",
  "signature": "iq72eJlFhYrbMJQxwPOG9my9kGSAVZnnW5GeH8kTOUaxj1sn0J2nDMSBi/5EnOU6nhUm2sgEWEoR4C/Oou4CD3++jV4BYfg/wAq5Vs953IaPJESGt+k9bgkxtijlYhKWyMtWecl41A9JkQAt+Vh2I7JxCy5n5/MRfRlqw49XSac="
}

3. 指定名单添加词条

3.1 请求地址

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

3.2 请求方法

POST

3.3 请求头

Content-Type: application/json

3.4 请求参数

参数名称	类型	是否必需	说明
`timestamp`	String	是	当前的服务器的 Unix 时间戳，可以是毫秒或秒级
`nonce`	String	是	随机数
`signature`	String	是	`RSA-SHA256` 算法签名。签名步骤： 1. 将参与签名的参数（`secretId`，`timestamp`，`nonce`）用英文半角逗号 `,` 拼接，得到 `SignString`； 2. 使用您的私钥以 `RSA-SHA256` 算法对 `SignString` 签名，然后进行 `Base64` 编码，得到 `signature` 字符串。点击数字证书下载私钥；点击签名及验证示例查看签名示例
`thesaurusId`	String	是	文本名单 ID
`keywords`	Array<Keyword>	是	词条数组，单次请求添加数量应小于 10000

Keyword

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

3.5 响应内容

参数名称	类型	说明
`json`	String	响应内容 JSON 转义后的字符串
`signature`	String	响应内容签名

3.5.1 响应参数

参数名称	类型	是否可能为空	说明
`code`	Number	否	状态码
`nonce`	Number	否	随机数
`message`	String	否	相关信息
`timestamp`	Number	否	时间戳
`keywords`	Array<Keyword>	否	词条信息

Keyword

参数名称	类型	是否可能为空	说明
`code`	Number	否	状态码，标识该文本是否成功入库，详见服务公共状态码解析
`error`	String	否	错误原因
`content`	String	否	词条文本，支持组合规则，值为通过 + 拼接，且被括号包裹的字符串，例如：(加+微信)；(A+B) 表示关键词 A 与 B 之间无顺序要求，{A+B} 表示关键词 A 与 B 之间按照出现顺序匹配, 详见details数据结构

3.6 请求示例

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

3.7 响应示例

{
  "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="
}

4. 指定名单删除词条

4.1 请求地址

区域	请求地址
国内	`http://api.open.tuputech.com/v3/management/keyword/delete/<secretId>`

4.2 请求方法

POST

4.3 请求头

Content-Type: application/json

4.4 请求参数

参数名称	类型	是否必需	说明
`timestamp`	String	是	当前的服务器的 Unix 时间戳，可以是毫秒或秒级
`nonce`	String	是	随机数
`signature`	String	是	`RSA-SHA256` 算法签名。签名步骤： 1. 将参与签名的参数（`secretId`，`timestamp`，`nonce`）用英文半角逗号 `,` 拼接，得到 `SignString`； 2. 使用您的私钥以 `RSA-SHA256` 算法对 `SignString` 签名，然后进行 `Base64` 编码，得到 `signature` 字符串。点击数字证书下载私钥；点击签名及验证示例查看签名示例
`thesaurusId`	String	是	文本名单 ID
`keywords`	Array<Keyword>	是	词条数组，单次请求删除数量应小于 10000

Keyword

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

4.5 响应内容

参数名称	类型	说明
`json`	String	响应内容 JSON 转义后的字符串
`signature`	String	响应内容签名

4.5.1 响应参数

参数名称	类型	是否可能为空	说明
`code`	Number	否	状态码
`nonce`	Number	否	随机数
`message`	String	否	相关信息
`timestamp`	Number	否	时间戳
`keywords`	Array<Keyword>	否	词条信息

Keyword

参数名称	类型	是否可能为空	说明
`code`	Number	否	状态码，标识该文本是否成功删除，详见服务公共状态码解析
`error`	String	否	错误原因
`content`	String	否	词条文本

4.6 请求示例

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

4.7 响应示例

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

文本名单管理接口

文本名单管理接口

1. 词条所在名单/应用关联的名单信息查询

1.1 请求地址

1.2 请求方法

1.3 请求头

1.4 请求参数

1.5 响应内容

1.5.1 响应参数

1.6 请求示例

1.6 请求示例

2. 指定文本名单，列出所有词条内容

2.1 请求地址

2.2 请求方法

2.3 请求头

2.4 请求参数

2.5 响应内容

2.5.1 响应参数

2.6 请求示例

2.7 响应示例

3. 指定名单添加词条

3.1 请求地址

3.2 请求方法

3.3 请求头

3.4 请求参数

3.5 响应内容

3.5.1 响应参数

3.6 请求示例

3.7 响应示例

4. 指定名单删除词条

4.1 请求地址

4.2 请求方法

4.3 请求头

4.4 请求参数

4.5 响应内容

4.5.1 响应参数

4.6 请求示例

4.7 响应示例

results matching ""

No results matching ""