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

校验应用

功能介绍

该接口用于校验应用。

调用方法

请参见如何调用API

URI

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

表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参数

参数

是否必选

参数类型

描述

app_type

Integer

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

说明:

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

取值范围:

0-32

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

表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

表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

响应参数

状态码: 200

表9 响应Header参数

参数

参数类型

描述

X-Request-Id

String

请求ID。

状态码: 400

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

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

{
  "app_type" : 0,
  "iflytek_aiui_config" : {
    "app_id" : "e1xxxecf",
    "app_key" : "xxxxxxxxxx",
    "api_secret" : "xxxxxxxxxx",
    "is_production" : false
  }
}

响应示例

状态码: 400

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

状态码

状态码

描述

200

处理成功返回。

400

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

错误码

请参见错误码

相关文档