文档首页/ 语音交互服务 SIS/ API参考/ 热词管理接口/ 查询热词表信息 - ShowVocabulary
更新时间：2025-12-04 GMT+08:00
查看PDF
分享

查询热词表信息 - ShowVocabulary

功能介绍

通过热词表id查询热词表的信息和内容。

URI

GET /v1/{project_id}/asr/vocabularies/{vocabulary_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目编号。获取方法，请参见获取项目ID。

vocabulary_id

是

String

被查询的热词表id。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表3 响应Body参数

参数

是否必选

参数类型

描述

vocabulary_id

是

String

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

name

是

String

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

language

是

String

调用成功返回热词表语言类型，调用失败时无此字段。

description

是

String

调用成功返回热词表描述，调用失败时无此字段。

contents

是

Array of strings

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

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

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

error_msg

String

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

请求示例

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

  • 查询热词表信息 
    GET https://{endpoint}/v1/{project_id}/asr/vocabularies/{vocabulary_id}

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

响应示例

状态码： 200

成功响应示例

{ 
  "vocabulary_id": "CFD08A32-6176-4ad7-92F9-11ED015C8109",
  "name": "telepower",
  "description": "telepower description",
  "language": "chinese_mandarin", 
  "contents": ["example"]
}

状态码：400

失败响应示例

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

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。

父主题： 热词管理接口