全部产品

词表管理API

更新时间:2017-08-22 16:11:20   分享:   

关键词管理接口文档

1、 创建关键词词表

1.1 地址

POST /asr/custom/keyword_lists

1.2 请求

body实例

  1. {
  2. "keywords": [
  3. {"keyword":"张三", "threshold":0.1},
  4. {"keyword":"李四", "threshold":0.0}
  5. ]
  6. }
参数 值类型 必须项 描述
keyword String yes 关键词
threshold float no 阈值,取值范围0~1,默认为0

注意:阈值设置越高,关键词准确率越高,但同时遗漏识别的概率增大。需要用户根据自身具体场景尝试不同取值的效果,不存在各场景通用的推荐值。

1.3 响应

  • HTTP状态说明见页末附表

body实例

  1. {
  2. "keyword_list_id": "be053bf9af0e406dafa8249631372d53",
  3. "request_id": "be053bf9af0e406dafa8249631372d53"
  4. }

JSON对象

属性 值类型 描述
keyword_list_id String 本次创建的关键词词表的id
request_id String 本次调用id

1.4 示例-请求

  1. curl -X POST --data "{\"keywords\": [{\"keyword\":\"张三\", \"threshold\":0.8},{\"keyword\":\"李四\", \"threshold\":0.7}]}" "http://localhost/asr/custom/keyword_lists"

正常示例-响应

  1. {
  2. "keyword_list_id": "be053bf9af0e406dafa8249631372d53",
  3. "request_id": "be053bf9af0e406dafa8249631372d53"
  4. }


2、 更新关键词词表

2.1 地址

PUT /asr/custom/keyword_lists/{keyword_list_id}

2.2 请求

body实例:

  1. {
  2. "keywords": [
  3. {"keyword":"张三", "threshold":0.8},
  4. {"keyword":"李四", "threshold":0.7}
  5. ]
  6. }
参数 值类型 必须项 描述
keyword String yes 关键词
threshold float yes 阈值

2.3 响应

  • HTTP状态说明见页末附表

body实例

  1. {
  2. "keyword_list_id": "be053bf9af0e406dafa8249631372d53",
  3. "request_id": "be053bf9af0e406dafa8249631372d53"
  4. }

JSON对象

属性 值类型 描述
keyword_list_id String 本次创建的关键词词表的id
request_id String 本次调用id

2.4 示例-请求

  1. curl -X PUT --data "{\"keywords\": [{\"keyword\":\"张三\", \"threshold\":0.8},{\"keyword\":\"李四\", \"threshold\":0.7}]}" "http://localhost/asr/custom/keyword_lists/be053bf9af0e406dafa8249631372d53"

正常示例-响应

  1. {
  2. "keyword_list_id": "be053bf9af0e406dafa8249631372d53",
  3. "request_id": "be053bf9af0e406dafa8249631372d53"
  4. }

3、 获取关键词词表

3.1 地址

GET /asr/custom/keyword_lists/{keyword_list_id}

3.2 请求

body:无

3.3 响应

  • HTTP状态说明见页末附表

body实例:

  1. {
  2. "request_id": "be053bf9af0e406dafa8249631372d53",
  3. "keywords": [
  4. {"keyword":"张三", "threshold":0.8},
  5. {"keyword":"李四", "threshold":0.7}
  6. ]
  7. }

JSON对象

参数 值类型 描述
request_id String 本地调用id
keyword String 关键词
threshold float 阈值

3.4 示例-请求

  1. curl -X GET "http://localhost/asr/custom/keyword_lists/be053bf9af0e406dafa8249631372d53"

正常示例-响应

  1. {
  2. "keywords": [
  3. {"keyword":"张三", "threshold":0.8},
  4. {"keyword":"李四", "threshold":0.7}
  5. ],
  6. "request_id": "be053bf9af0e406dafa8249631372d53"
  7. }


4、 删除关键词词表

4.1 地址

DELETE /asr/custom/keyword_lists/{keyword_list_id}

4.2 请求

body:无

4.3 响应

  • HTTP状态说明见页末附表

body实例:

  1. {
  2. "request_id": "be053bf9af0e406dafa8249631372d53"
  3. }

JSON对象

参数 值类型 描述
request_id String 本地调用id

4.4 示例-请求

  1. curl -X GET "http://localhost/asr/custom/keyword_lists/be053bf9af0e406dafa8249631372d53"

正常示例-响应

  1. {
  2. "request_id": "be053bf9af0e406dafa8249631372d53"
  3. }

HTTP状态说明

错误码 含义
200 成功
400 词表id或词表内容格式错误
404 词表不存在
409 (新增时)词表已存在
本文导读目录
本文导读目录
以上内容是否对您有帮助?