词表管理API是什么?

关键词管理接口文档



1、 创建关键词词表



1.1 地址

协议	URL	方法
HTTPS	https://nlsapi.aliyun.com/asr/custom/keyword_lists	POST

1.2 请求



body实例

<divre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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实例

<divre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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

JSON对象

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

1.4 示例-请求

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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

正常示例-响应

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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

2、 更新关键词词表



2.1 地址

协议	URL	方法
HTTPS	https://nlsapi.aliyun.com/asr/custom/keyword_lists/{keyword_list_id}	PUT

2.2 请求



body实例：

<divre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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实例

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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

JSON对象

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

2.4 示例-请求

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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

正常示例-响应

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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

3、 获取关键词词表



3.1 地址

协议	URL	方法
HTTPS	https://nlsapi.aliyun.com/asr/custom/keyword_lists/{keyword_list_id}	GET

3.2 请求



body：无



3.3 响应

• HTTP状态说明见页末附表

body实例：

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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 示例-请求

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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

正常示例-响应

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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

4、 删除关键词词表



4.1 地址

协议	URL	方法
HTTPS	https://nlsapi.aliyun.com/asr/custom/keyword_lists/{keyword_list_id}	DELETE

4.2 请求



body：无



4.3 响应

• HTTP状态说明见页末附表

body实例：

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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

JSON对象

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

4.4 示例-请求

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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

正常示例-响应

<pre style='background: rgb(246, 246, 246); font: 12px/1.6 "YaHei Consolas Hybrid", Consolas, "Meiryo UI", "Malgun Gothic", "Segoe UI", "Trebuchet MS", Helvetica, monospace, monospace; margin: 0px 0px 16px; padding: 10px; outline: 0px; border-radius: 3px; border: 1px solid rgb(221, 221, 221); color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; word-spacing: 0px; white-space: pre-wrap; word-wrap: break-word; box-sizing: border-box; orphans: 2; widows: 2; font-size-adjust: none; font-stretch: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' prettyprinted?="" linenums="">

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

HTTP状态说明

<table style='background: rgb(255, 255, 255); padding: 0px; outline: 0px; border: 0px currentColor; width: 768px; color: rgb(51, 51, 51); text-transform: none; text-indent: 0px; letter-spacing: normal; overflow: auto; font-family: PingFangSC, "helvetica neue", "hiragino sans gb", arial, "microsoft yahei ui", "microsoft yahei", simsun, sans-serif; font-size: 14px; font-style: normal; font-weight: normal; margin-top: 0px; margin-right: 0px; margin-bottom: 0px !important; margin-left: 0px; word-spacing: 0px; display: table; white-space: normal; border-collapse: collapse; table-layout: fixed; box-sizing: border-box; border-spacing: 0px; orphans: 2; widows: 2; font-variant-ligatures: normal; font-variant-caps: normal; -webkit-text-stroke-width: 0px; text-decoration-style: initial; text-decoration-color: initial;' table-condensed?="" table-striped="">[tr][td]错误码[/td][td]含义[/td][/tr][tr][td]200[/td][td]成功[/td][/tr][tr][td]400[/td][td]词表id或词表内容格式错误[/td][/tr][tr][td]404[/td][td]词表不存在[/td][/tr][tr][td]409[/td][td](新增时)词表已存在[/td][/tr]