更新时间:2024-12-12 GMT+08:00

查询应用列表

功能介绍

该接口用于查询应用列表。

调用方法

请参见如何调用API

URI

GET /v1/{project_id}/digital-human-chat/robot

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

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

取值范围:

0-2147483647

默认取值:

0

limit

Integer

每页显示的条目数量。

取值范围:

1-100

默认取值:

10

room_id

String

智能交互对话房间ID。

robot_type

String

交互对接类型

  • LIVE:直播交互

  • CHAT:智能交互

请求参数

表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 RobotInfo objects

应用信息

表6 RobotInfo

参数

参数类型

描述

robot_id

String

应用ID。

name

String

应用名称。

room_id

String

智能交互对话房间ID。

app_id

String

第三方应用ID。

app_type

Integer

对接第三方应用厂商类型。

说明:

0:科大讯飞AIUI;1:华为云CBS;2:科大讯飞星火交互认知大模型;5:第三方驱动;6:第三方语言模型;8:奇妙问

取值范围:

0-32

app_key

String

应用的AccessKey或帐号。

robot_type

String

交互对接类型

  • LIVE:直播交互

  • CHAT:智能交互

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"。

region

Integer

CBS所在区域

取值范围:

0-32

cbs_project_id

String

CBS所在区域的projectId

llm_url

String

第三方语言模型地址。

is_stream

Boolean

是否采用流式响应。

默认取值:

false

chat_rounds

Integer

支持的多轮对话数量,取值大于1时,请求第三方语言模型时将携带历史对话信息。

取值范围:

1-10

默认取值:

1

is_ifly_production

Boolean

是否为正式环境

默认取值:

false

tail_silence_time

Integer

语音识别后端点静音时长默认500ms

取值范围:

0-3000

role_id

String

奇妙问角色ID。

sis_region

Integer

SIS所在区域

取值范围:

0-32

sis_project_id

String

SIS所在区域的projectId

enable_hot_words

Boolean

是否开启热词

enable_question_audit

Boolean

是否开启提问文本审核开关

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET https://metastudio.cn-north-4.myhuaweicloud.com/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-chat/robot

响应示例

状态码: 200

处理成功返回。

{
  "offset" : 0,
  "limit" : 10,
  "count" : 1,
  "data" : [ {
    "robot_id" : "b3e2b1db10b34f45bff241b133142627",
    "name" : "展厅机器人",
    "app_id" : "e1xxxecf",
    "app_type" : 0,
    "create_time" : "2023-09-01T06:34:21Z",
    "update_time" : "2023-09-01T06:34:21Z",
    "language" : "CN",
    "enable_hot_words" : false,
    "enable_question_audit" : true
  } ]
}

状态码: 400

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

状态码

状态码

描述

200

处理成功返回。

400

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

错误码

请参见错误码