更新时间:2024-11-18 GMT+08:00
分享

创建应用

功能介绍

该接口用于创建应用。

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

请求参数

表2 请求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。不允许输入中文。

表3 请求Body参数

参数

是否必选

参数类型

描述

name

String

应用名称。

app_type

Integer

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

说明:

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

取值范围:

0-32

room_id

String

智能交互对话房间ID。

robot_type

String

交互对接类型

  • LIVE:直播交互

  • CHAT:智能交互

language

String

智能交互语言

  • zh_CN:简体中文(已下线,请使用CN)

  • en_US:英语(已下线,请使用EN)

  • CN:中文

  • EN:英文

tail_silence_time

Integer

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

取值范围:

0-3000

enable_question_audit

Boolean

提问文本审核开关

huawei_ei_cbs

HuaweiEiCbs object

华为云CBS应用配置

iflytek_aiui_config

IflytekAiuiConfig object

科大讯飞AIUI应用配置

iflytek_spark

IflytekSpark object

科大讯飞星火大模型应用配置

third_party_model_config

ThirdPartyModelConfig object

第三方语言模型配置

mobvoi_config

MobvoiConfig object

奇妙问应用配置

表4 HuaweiEiCbs

参数

是否必选

参数类型

描述

app_id

String

CBS应用ID。

region

Integer

CBS所在区域

取值范围:

0-32

cbs_project_id

String

CBS所在区域的projectId

sis_region

Integer

SIS所在区域

取值范围:

0-32

sis_project_id

String

SIS所在区域的projectId

enable_hot_words

Boolean

是否开启热词

表5 IflytekAiuiConfig

参数

是否必选

参数类型

描述

app_id

String

AIUI应用ID。

app_key

String

AIUI应用密钥。

api_secret

String

AIUI API密钥。

is_production

Boolean

是否为正式环境

默认取值:

false

表6 IflytekSpark

参数

是否必选

参数类型

描述

app_id

String

星火大模型应用ID。

app_key

String

星火大模型应用密钥。

api_secret

String

星火大模型API密钥。

is_production

Boolean

是否为正式环境

默认取值:

false

表7 ThirdPartyModelConfig

参数

是否必选

参数类型

描述

app_id

String

第三方语言模型应用ID。

app_key

String

第三方语言模型应用密钥。

llm_url

String

第三方语言模型地址。

is_stream

Boolean

是否采用流式响应。

默认取值:

false

chat_rounds

Integer

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

取值范围:

1-10

默认取值:

1

sis_region

Integer

SIS所在区域

取值范围:

0-32

sis_project_id

String

SIS所在区域的projectId

enable_hot_words

Boolean

是否开启热词

表8 MobvoiConfig

参数

是否必选

参数类型

描述

app_key

String

奇妙问应用帐号。

app_secret

String

奇妙问应用Secret。

role_id

String

奇妙问角色ID。

sis_region

Integer

SIS所在区域

取值范围:

0-32

sis_project_id

String

SIS所在区域的projectId

enable_hot_words

Boolean

是否开启热词

响应参数

状态码: 200

表9 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

表10 响应Body参数

参数

参数类型

描述

robot_id

String

应用ID。

状态码: 400

表11 响应Body参数

参数

参数类型

描述

BadRequest

AnyType

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

请求示例

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

{
  "name" : "展厅机器人",
  "app_type" : 0,
  "enable_question_audit" : true,
  "iflytek_aiui_config" : {
    "app_id" : "e1xxxecf",
    "app_key" : "xxxxxxxxxx",
    "api_secret" : "xxxxxxxxxx"
  }
}

响应示例

状态码: 200

处理成功返回。

{
  "robot_id" : "b3e2b1db10b34f45bff241b133142627"
}

状态码: 400

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

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

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
48
49
50
51
52
53
54
55
56
57
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 CreateRobotSolution {

    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();
        CreateRobotRequest request = new CreateRobotRequest();
        CreateRobotReq body = new CreateRobotReq();
        IflytekAiuiConfig iflytekAiuiConfigbody = new IflytekAiuiConfig();
        iflytekAiuiConfigbody.withAppId("e1xxxecf")
            .withAppKey("xxxxxxxxxx")
            .withApiSecret("xxxxxxxxxx");
        body.withIflytekAiuiConfig(iflytekAiuiConfigbody);
        body.withEnableQuestionAudit(true);
        body.withAppType(0);
        body.withName("展厅机器人");
        request.withBody(body);
        try {
            CreateRobotResponse response = client.createRobot(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
32
33
34
35
36
37
38
39
40
41
42
# 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 = CreateRobotRequest()
        iflytekAiuiConfigbody = IflytekAiuiConfig(
            app_id="e1xxxecf",
            app_key="xxxxxxxxxx",
            api_secret="xxxxxxxxxx"
        )
        request.body = CreateRobotReq(
            iflytek_aiui_config=iflytekAiuiConfigbody,
            enable_question_audit=True,
            app_type=0,
            name="展厅机器人"
        )
        response = client.create_robot(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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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.CreateRobotRequest{}
	appIdIflytekAiuiConfig:= "e1xxxecf"
	appKeyIflytekAiuiConfig:= "xxxxxxxxxx"
	apiSecretIflytekAiuiConfig:= "xxxxxxxxxx"
	iflytekAiuiConfigbody := &model.IflytekAiuiConfig{
		AppId: &appIdIflytekAiuiConfig,
		AppKey: &appKeyIflytekAiuiConfig,
		ApiSecret: &apiSecretIflytekAiuiConfig,
	}
	enableQuestionAuditCreateRobotReq:= true
	request.Body = &model.CreateRobotReq{
		IflytekAiuiConfig: iflytekAiuiConfigbody,
		EnableQuestionAudit: &enableQuestionAuditCreateRobotReq,
		AppType: int32(0),
		Name: "展厅机器人",
	}
	response, err := client.CreateRobot(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

处理成功返回。

400

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

错误码

请参见错误码

相关文档