校验应用
功能介绍
该接口用于校验应用。
调用方法
请参见如何调用API。
URI
POST /v1/{project_id}/digital-human-chat/robot/validate
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID，获取方法请参考获取项目ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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。不允许输入中文。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
奇妙问应用配置 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
是否开启热词 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
app_id |
否 |
String |
AIUI应用ID。 |
|
app_key |
否 |
String |
AIUI应用密钥。 |
|
api_secret |
否 |
String |
AIUI API密钥。 |
|
is_production |
否 |
Boolean |
是否为正式环境 默认取值： false |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
app_id |
否 |
String |
星火大模型应用ID。 |
|
app_key |
否 |
String |
星火大模型应用密钥。 |
|
api_secret |
否 |
String |
星火大模型API密钥。 |
|
is_production |
否 |
Boolean |
是否为正式环境 默认取值： false |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
是否开启热词 |
响应参数
状态码： 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-Request-Id |
String |
请求ID。 |
状态码： 400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
请求传参异常，包含错误码及对应描述。 |
错误码
请参见错误码。
