查询智能交互对话列表
功能介绍
该接口用于智能交互对话列表。
调用方法
请参见如何调用API。
URI
GET /v1/{project_id}/smart-chat-rooms
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID,获取方法请参考获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
offset |
否 |
Integer |
偏移量,表示从此偏移量开始查询。 取值范围: 0-2147483647 默认取值: 0 |
limit |
否 |
Integer |
每页显示的条目数量。 取值范围: 1-100 默认取值: 10 |
room_name |
否 |
String |
按智能交互对话名称模糊查询。 |
model_name |
否 |
String |
按形象名称模糊查询。 |
start_time |
否 |
String |
最近智能交互对话任务起始时间。格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。 |
end_time |
否 |
String |
结束时间。格式遵循:RFC 3339 如"2021-01-10T10:43:17Z"。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
Authorization |
否 |
String |
使用AK/SK方式认证时必选,携带的鉴权信息。 |
X-Sdk-Date |
否 |
String |
使用AK/SK方式认证时必选,请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 |
X-Project-Id |
否 |
String |
使用AK/SK方式认证时必选,携带项目ID信息。 |
X-App-UserId |
否 |
String |
第三方用户ID。不允许输入中文。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
X-Request-Id |
String |
请求ID。 |
参数 |
参数类型 |
描述 |
---|---|---|
count |
Integer |
参数解释: 智能交互对话总数。 取值范围: 0-2147483647 |
count_concurrency |
Integer |
参数解释: 智能交互对话总并发路数。 取值范围: 0-1024000 |
smart_chat_rooms |
Array of SmartChatRoomBaseInfo objects |
智能交互对话列表。 |
参数 |
参数类型 |
描述 |
---|---|---|
room_id |
String |
智能交互对话ID |
room_name |
String |
智能交互对话名称 |
room_description |
String |
智能交互对话描述。 |
robot_id |
String |
机器人ID。 |
cover_url |
String |
对话封面图URL |
model_infos |
ModelInfo object |
数字人模型信息 |
voice_config |
VoiceConfig object |
语音配置参数。 |
concurrency |
Integer |
参数解释: 并发路数。 取值范围: 0-1024 |
create_time |
String |
创建时间,格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。 |
update_time |
String |
更新时间,格式遵循:RFC 3339 如“2021-01-10T08:43:17Z”。 |
参数 |
参数类型 |
描述 |
---|---|---|
model_asset_id |
String |
模型资产ID,可以从资产库中查询。 |
asset_name |
String |
资产名称 |
backup_model_asset_ids |
Array of strings |
主播轮换时备选主播数字人资产ID(仅形象资产,不包含音色),可以从资产库中查询。 |
参数 |
参数类型 |
描述 |
---|---|---|
voice_asset_id |
String |
参数解释: 音色资产ID,可以从资产库中查询。 约束限制: 不涉及。 取值范围: 字符长度1-256位。 默认取值: 不涉及。 |
speed |
Integer |
参数解释: 语速。50表示0.5倍语速,100表示正常语速,200表示2倍语速。 当取值为“100”时,表示一个成年人的正常语速,约为250字/分钟。 约束限制: 不涉及。 取值范围: 50-200 默认取值: 100 |
pitch |
Integer |
参数解释: 音高。 约束限制: 不涉及。 取值范围: 50-200 默认取值: 100 |
volume |
Integer |
参数解释: 音量。 约束限制: 不涉及。 取值范围: 90-240 默认取值: 140 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
BadRequest |
AnyType |
请求传参异常,包含错误码及对应描述。 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
Unauthorized |
AnyType |
未鉴权或鉴权失败。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
InternalServiceError |
AnyType |
内部服务错误。 |
请求示例
GET https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/smart-chat-rooms
响应示例
状态码: 200
成功。
{ "count" : 1, "smart_chat_rooms" : [ { "room_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66", "room_name" : "云笙展厅", "room_description" : "云笙", "create_time" : "2022-11-30T06:59:55Z", "update_time" : "2022-12-05T12:30:37Z" } ] }
状态码: 400
请求传参异常,包含错误码及对应描述。
{ "error_code" : "MSS.00000003", "error_msg" : "Invalid parameter" }
状态码: 401
未鉴权或鉴权失败。
{ "error_code" : "MSS.00000001", "error_msg" : "Unauthorized" }
状态码: 500
内部服务错误。
{ "error_code" : "MSS.00000004", "error_msg" : "Internal Error" }
SDK代码示例
SDK代码示例如下。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.metastudio.v1.region.MetaStudioRegion; import com.huaweicloud.sdk.metastudio.v1.*; import com.huaweicloud.sdk.metastudio.v1.model.*; public class ListSmartChatRoomsSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); MetaStudioClient client = MetaStudioClient.newBuilder() .withCredential(auth) .withRegion(MetaStudioRegion.valueOf("<YOUR REGION>")) .build(); ListSmartChatRoomsRequest request = new ListSmartChatRoomsRequest(); try { ListSmartChatRoomsResponse response = client.listSmartChatRooms(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkmetastudio.v1.region.metastudio_region import MetaStudioRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkmetastudio.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = MetaStudioClient.new_builder() \ .with_credentials(credentials) \ .with_region(MetaStudioRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListSmartChatRoomsRequest() response = client.list_smart_chat_rooms(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" metastudio "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/metastudio/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := metastudio.NewMetaStudioClient( metastudio.MetaStudioClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListSmartChatRoomsRequest{} response, err := client.ListSmartChatRooms(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
成功。 |
400 |
请求传参异常,包含错误码及对应描述。 |
401 |
未鉴权或鉴权失败。 |
500 |
内部服务错误。 |
错误码
请参见错误码。