文档首页/ 数字内容生产线 MetaStudio/ API参考/ 智能交互/ 智能交互管理/ 智能交互数字人热词记录管理/ 查询热词记录列表
更新时间：2024-12-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询热词记录列表

功能介绍

该接口用于查询热词记录列表。

调用方法

请参见如何调用API。

URI

GET /v1/{project_id}/digital-human-chat/hot-words

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，获取方法请参考获取项目ID。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

偏移量，表示从此偏移量开始查询。

取值范围：

0-2147483647

默认取值：

0

limit

否

Integer

每页显示的条目数量。

取值范围：

1-100

默认取值：

10

robot_id

是

String

应用ID。

region

否

Integer

sis服务所在区域

取值范围：

0-32

language

否

String

智能交互语言

  • zh_CN：简体中文（已下线，请使用CN）

  • en_US：英语（已下线，请使用EN）

  • CN: 中文

  • EN: 英文

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

用户Token。使用Token鉴权方式时必选。

通过调用IAM服务获取用户Token接口获取。

响应消息头中X-Subject-Token的值。

Authorization

否

String

使用AK/SK方式认证时必选，携带的鉴权信息。

X-Sdk-Date

否

String

使用AK/SK方式认证时必选，请求的发生时间。

X-Project-Id

否

String

使用AK/SK方式认证时必选，携带项目ID信息。

X-App-UserId

否

String

第三方用户ID。不允许输入中文。

响应参数

状态码： 200

表4 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。
表5 响应Body参数

参数

参数类型

描述

offset

Integer

与第一条数据的偏移量

取值范围：

0-2147483647

默认取值：

0

limit

Integer

页面大小

取值范围：

1-1000

默认取值：

10

count

Integer

总数量

取值范围：

0-2147483647

data

Array of HotWordsInfo objects

热词记录信息
表6 HotWordsInfo

参数

参数类型

描述

hot_words_id

String

热词记录ID。

robot_id

String

应用ID。

hot_words_type

String

热词类型。

说明：

SIS:使用的语音识别服务为SIS时选此类型

vocabulary_id

String

热词ID(sis中配置)。

sis_project_id

String

SIS服务所在区域projectId

region

Integer

对接SIS服务的区域。

说明：

0：北京四；3：上海一；

取值范围：

0-32

language

String

智能交互语言

  • zh_CN：简体中文（已下线，请使用CN）

  • en_US：英语（已下线，请使用EN）

  • CN：中文

  • EN：英文

create_time

String

创建时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。

update_time

String

更新时间，格式遵循：RFC 3339 如"2021-01-10T08:43:17Z"。

状态码： 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/hot-words?robot_id=b3e2b1db10b34f45bff241b133142627

响应示例

状态码： 200

处理成功返回。

{
  "offset" : 0,
  "limit" : 10,
  "count" : 1,
  "data" : [ {
    "hot_words_id" : "39b9cedccec1f19b33d8f7ce1a6d35b9",
    "robot_id" : "b3e2b1db10b34f45bff241b133142627",
    "hot_words_type" : "SIS",
    "vocabulary_id" : "036bd500-27cd-4e2d-bba9-0e6baf9c1bd8",
    "sis_project_id" : "3c4a6bad10334e64823520d734d8f678",
    "region" : 0,
    "language" : "CN",
    "create_time" : "2021-01-10T08:43:17Z",
    "update_time" : "2021-01-10T08:43:17Z"
  } ]
}

状态码： 400

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

状态码

状态码

描述

200

处理成功返回。

400

请求传参异常，包含错误码及对应描述。

错误码

请参见错误码。

父主题： 智能交互数字人热词记录管理