文档首页/ 语音交互服务 SIS/ API参考/ 热词管理接口/ 查询热词表列表
更新时间：2023-06-20 GMT+08:00
查看PDF
分享

查询热词表列表

功能介绍

查询用户所有热词表列表。详细使用指导请参见SIS服务使用简介章节。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/{project_id}/asr/vocabularies

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目编号。获取方法，请参见获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

limit

否

Integer

每页查询显示的条目数量。

缺省值：10

offset

否

Integer

页码偏移量，表示从此页码偏移量开始查询，offset大于等于0。

缺省值：0

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

用于获取操作API的权限。获取方法请参见认证鉴权。响应消息头中X-Subject-Token的值即为Token。
表4 请求Body参数

参数

是否必选

参数类型

描述

name

否

String

热词表的表名，用于筛选热词表表名。

响应参数

状态码： 200

表5 响应Body参数

参数

是否必选

参数类型

描述

count

是

Integer

热词表数。

result

是

Array of VocabInfo objects

调用成功返回热词表列表，调用失败时无此字段。
表6 VocabInfo

参数

是否必选

参数类型

描述

vocabulary_id

是

String

热词ID。

name

是

String

热词表名。

language

是

String

热词表语言类型。

description

是

String

热词表描述。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码。 调用成功时无此字段。

error_msg

String

调用失败时的错误信息。 调用成功时无此字段。

请求示例

“endpoint”即调用API的请求地址，不同服务不同区域的“endpoint”不同，具体请参见终端节点。

  • 获取热词表列表信息 
    GET https://{endpoint}/v1/{project_id}/asr/vocabularies

Request Header:
Content-Type: application/json
X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...

响应示例

状态码：200

成功响应示例

{ 
  "result": [
    {
        "vocabulary_id": "5F85A74C-BED9-4a15-B66E-039251D877D6",
        "language": "chinese_mandarin", 
        "name": "weather",
        "description": "no desc"
    },
    {
        "vocabulary_id": "50875954-7328-42ab-B236-B3EC6E22207A",
        "language": "chinese_mandarin", 
        "name": "war",
        "description": "no desc"
    }
  ]
}

状态码：400

失败响应示例

{ 
    "error_code":"SIS.0201", 
    "error_msg":"***" 
}

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。

父主题： 热词管理接口

相关文档