检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 模型调用 应用中心 知识中心
如何调用API 构造请求 认证鉴权 返回结果
API概览 AppStage接口的分类与说明如表1所示。 表1 API概览 类型 说明 文本对话 文本对话类模型服务调用。 文本向量化 文本向量化类模型服务调用。 调用知识检索流 调用用户配置的知识检索流。 调用流 调用用户配置的工作流。 调用Agent 调用用户发布的Agent。
新增平台API Key API Key是每个用户单独的身份认证,是个人调用应用接口的依据,必须妥善保管。租户开发的Agent在调用平台接口时需要进行平台鉴权认证,可以使用“平台API Key”进行平台的鉴权认证。 背景信息 对于华为或者第三方运营的商业化模型服务,支持通过API接入到
应用中心 调用知识检索流 调用流 调用技能 文件盒子 调用Agent 父主题: API
模型调用 文本对话 文本向量化 父主题: API
知识中心 检索知识库数据 父主题: API
附录 状态码 错误码
则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于文本对话接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。
{ } } API Key认证 API Key全称为应用程序接口密钥,是一种用于验证和授权API请求的代码。它通常是一串字符,用于识别调用API的应用程序和开发者。 获取API Key 以管理员身份登录AI原生应用引擎工作台,参考创建API Key获取。 使用API Key鉴权
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台,在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面,选择“平台API Key”页签,单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称,用以区分API
请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于文本对话接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头。例如,Content-Type=application/json
AI原生应用引擎鉴权API Key。 1.以管理员身份登录AI原生应用引擎工作台,在左侧导航栏选择“系统管理 > 平台租户鉴权”。 2.在“平台租户鉴权”页面,选择“平台API Key”页签,单击“新增平台API Key”。 3.在“新增平台API Key”对话框中的输入框设置API Key名称,用以区分API
请求Header参数 参数 是否必选 参数类型 描述 authorization 是 String 鉴权信息,填写WiseAgent注册的api key,本接口只需要此鉴权信息,不需要使用公共请求头中的鉴权方式。 表3 请求Body参数 参数 是否必选 参数类型 描述 body 否 Object
请求Header参数 参数 是否必选 参数类型 描述 authorization 是 String 鉴权信息,填写WiseAgent注册的api key,本接口只需要此鉴权信息,不需要使用公共请求头中的鉴权方式。 header_example 否 String 按照用户配置的工作流请求头参
请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 鉴权信息,填写WiseAgent注册的api key,本接口只需要此鉴权信息,不需要使用公共请求头中的鉴权方式。 h-user-id 是 String 用户ID。 h-dept-code 是
表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 是 String 鉴权信息,填写租户管理员已创建的API Key,前缀加Bearer与空格。 h-user-id 否 String 用户ID,引用文件时候为必填。 表3 请求Body参数 参数 是否必选
管理华为云已释放的主机 在华为云上已经释放的主机,VMS不会同步释放,会作为冗余资源展示在VMS中。 查看冗余主机 进入AppStage运维中心。 在顶部导航栏选择服务。 单击,选择“运维 > 主机管理服务(VMS)”。 选择左侧导航栏的“云服务器管理 > 冗余主机”。 在“冗余主机”页面查看冗余主机。
请求Header参数 参数 是否必选 参数类型 描述 authorization 是 String 鉴权信息,填写WiseAgent注册的api key,本接口只需要此鉴权信息,不需要使用公共请求头中的鉴权方式。 header_example 否 String 按照用户配置的知识检索流请求
运维中心对接华为云WeLink 监控服务告警、事件可以通过华为云WeLink(简称WeLink)进行通知,如果您的企业已使用WeLink,可以通过配置对接WeLink,完成运维中心与WeLink对接,通过WeLink公众号收取监控服务的告警及事件通知。 前提条件 已使用华为云WeLink。