检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建API Key API Key是每个用户单独的身份认证,是个人调用应用接口的依据,必须妥善保管。用户开发的Agent在调用平台接口时需要进行平台鉴权认证,可以使用“平台API Key”进行平台的鉴权认证。 操作须知 每个用户最多可添加两个平台API Key。 前提条件 需要具备
API概览 AppStage接口的分类与说明如表1所示。 表1 API概览 类型 说明 模型调用 包含文本对话类、文本向量化类模型服务调用接口。 应用中心 包含Agent调用、用户配置(工作流、技能)调用、文件盒子等接口。 知识中心 包含知识库和知识数据集的创建、删除、执行及查询等接口
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。
如何通过调用Agent API将变量传递到工作流? 创建Agent时配置变量,如图1所示,具体操作请参见创建并发布Agent。 图1 配置变量 在配置工作流时,选择引入变量,根据Agent中定义的变量类型(一般变量或敏感变量)来设置工作流的入参,如图2所示,具体操作请参见创建工作流
如何获取Agent发布时所需的API Key? 填写AI原生应用引擎平台的API Key,生成方式请参见新增平台API Key。 父主题: AI原生应用引擎
如何调用API 构造请求 认证鉴权 返回结果
模型API接入接口规范 当前模型网关支持文本对话(Chat)、文本向量化(Embeddings)、文本排序(Rerank)三种类型的API接入。模型API接入之前,请确保符合相对应的接口规范,其中Chat接口和Embeddings接口需要符合OpenAI接口规范,Rerank接口需要符合
AI原生应用引擎SDK API 版本变更记录 SDK概述 快速开始 应用示例 modules模块 错误处理 日志处理
API 模型调用 应用中心 知识中心
模型调测时,无法选择模型服务商API是什么原因? 对模型服务商API调测前,需要先设置鉴权,具体操作请参见如何对模型供应商提供的模型服务设置鉴权。 父主题: AI原生应用引擎
type: WiseCloud::Agent::APIGateway version: x.x.x.x flavor: 1C2G param: $ref: 'config/sidecar_apigw_param.json
CCE/EVS/ECS/ELB/IAM/IMS/NAT/EIP/OBS/SFS/SMN/SWR/DCS/VPC/VPCEP/WAF/HSS/Anti-DDoS/DWS/CES/DRS/DEW/DDS/APIG/MRS/CSS/DMS/TaurusDB/GeminiDB Cassandra
华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。
应用中心 调用知识检索流 调用流 调用工具的执行动作 上传文件用于测试流 上传文件用于调用Agent 查询我的工具页面的工具连接器列表 删除工具 查询工具详情 查询执行动作列表 创建工具 创建执行动作 删除执行动作 查询执行动作详情 上传文件至文件盒子 删除文件盒子中的文件 调用Agent
模型调用 调用文本对话模型服务 调用文本向量化模型服务 父主题: API
构造请求 本节介绍REST API请求的组成,并以调用AppStage服务的文本对话接口说明如何调用API。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987 。 请求URI 请求URI由如下部分组成
调用Agent 功能介绍 调用本接口,向已发布的Agent发起一次对话请求。若无已发布的Agent,请先在AI原生应用引擎中创建Agent并进行发布。 调用方法 请参见如何调用API。 URI POST https://aiae.appstage.myhuaweicloud.com
知识中心 检索知识库数据 创建知识库 删除知识库 执行知识库 查询知识库最新执行记录 修改知识库召回状态 创建知识数据集 查询知识数据集详情 删除知识数据集 执行知识数据集 查询知识数据集最新执行记录 父主题: API
App-code:APP认证方式,通过请求header的X-Apig-Appcode字段携带App-code进行认证,需要提供App-code。 API key 鉴权方式为“Api-key”时,配置此参数。 API密钥所需的字段,以及该验证所必须的字段值。
返回结果 状态码 请求发送以后,您会收到响应,包含状态码、响应消息头和消息体。 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于文本对话接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头