检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 AppStage接口的分类与说明如表1所示。 表1 API概览 类型 说明 模型调用 包含文本对话类、文本向量化类模型服务调用接口。 应用中心 包含Agent调用、用户配置(工作流、技能)调用、文件盒子等接口。 知识中心 包含知识库和知识数据集的创建、删除、执行及查询等接口。
API 模型调用 应用中心 知识中心
如何调用API 构造请求 认证鉴权 返回结果
对接华为云WeLink 监控服务告警、事件可以通过华为云WeLink(简称WeLink)进行通知,如果您的企业已使用WeLink,可以通过配置对接WeLink,完成运维中心与WeLink对接,通过WeLink公众号收取监控服务的告警及事件通知。 前提条件 已使用华为云WeLink。
创建API Key API Key是每个用户单独的身份认证,是个人调用应用接口的依据,必须妥善保管。用户开发的Agent在调用平台接口时需要进行平台鉴权认证,可以使用“平台API Key”进行平台的鉴权认证。 前提条件 需要具备AI原生应用引擎管理员或开发者权限,权限申请操作请参见AppStage组织成员申请权限。
AI原生应用引擎SDK API 版本变更记录 SDK概述 快速开始 应用示例 modules模块 错误处理 日志处理
查询知识库最新执行记录 修改知识库召回状态 创建知识数据集 查询知识数据集详情 删除知识数据集 执行知识数据集 查询知识数据集最新执行记录 父主题: API
模型API接入接口规范 当前模型网关支持文本对话(Chat)、文本向量化(Embeddings)、文本排序(Rerank)三种类型的API接入。模型API接入之前,请确保符合相对应的接口规范,其中Chat接口和Embeddings接口需要符合OpenAI接口规范,Rerank接口需要符合AI引擎标准协议。
调用工具的执行动作 上传文件用于测试流 上传文件用于调用Agent 上传文件至文件盒子 删除文件盒子中的文件 调用Agent 父主题: API
如何获取Agent发布时要所需的API Key? 填写AI原生应用引擎平台的API Key,生成方式请参见新增平台API Key。 父主题: AI原生应用引擎
华为账号与华为云账号的区别是什么? 华为云账号只能登录华为云,无法登录其他华为服务。 华为账号是用户访问华为各网站的统一“身份标识”,您只需注册一个华为账号,即可访问所有华为服务,如:华为云、终端云、华为手机等终端、华为开发者联盟等。 华为账号与华为云账号的相同点 均可以购买AppStage。
应用示例 创建知识库并进行检索 更新知识库
Authorization 是 String 参数解释: 鉴权信息。获取平台API Key,并为API Key添加前缀Bearer,得到标准鉴权信息,例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值:
附录 状态码 错误码 知识数据集请求参数说明
模型调用 调用文本对话模型服务 调用文本向量化模型服务 父主题: API
http_client httpx.client False 自定义的httpx client。 kwargs - False 其他可选参数,如api_key、timeout等。 父主题: modules模块
版本变更记录 表1 版本变更记录 版本 变更类型 说明 0.0.1 - 第一次发布。 父主题: AI原生应用引擎SDK API
则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于文本对话接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。
{ } } API Key认证 API Key全称为应用程序接口密钥,是一种用于验证和授权API请求的代码。它通常是一串字符,用于识别调用API的应用程序和开发者。 获取API Key 以管理员身份登录AI原生应用引擎工作台,参考创建API Key获取。 使用API Key鉴权
PromptTemplate KnowledgeRetriever ApplicationCenter 父主题: AI原生应用引擎SDK API