检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
模型API接入接口规范 当前模型网关支持文本对话(Chat)、文本向量化(Embeddings)、文本排序(Rerank)三种类型的API接入。模型API接入之前,请确保符合相对应的接口规范,其中Chat接口和Embeddings接口需要符合OpenAI接口规范,Rerank接口需要符合AI引擎标准协议。
应用示例 创建知识库并进行检索 更新知识库
ENT_API_KEY填写AI原生应用引擎的平台API KEY,该值用于鉴权,为必填。接口会返回检索到的切片信息。如果接口报错请参考错误处理。 代码示例 import os os.environ["WISEAGENT_API_KEY"] = "wiseagent-api-key"
重定向到OrgID的退出页完成OrgID侧的退出逻辑。 /callback/logout接口 该接口为OrgID的回调接口,当用户从OrgID侧发起退出登录时,会通知到应用侧。此时会回调该接口,不同于/app/logout退出接口,该接口只需清理demo应用自身会话,完成自身退出登录。 父主题: 集成OrgID登录功能
API概览 AppStage接口的分类与说明如表1所示。 表1 API概览 类型 说明 模型调用 包含文本对话类、文本向量化类模型服务调用接口。 应用中心 包含Agent调用、用户配置(工作流、技能)调用、文件盒子等接口。 知识中心 包含知识库和知识数据集的创建、删除、执行及查询等接口。
创建API Key API Key是每个用户单独的身份认证,是个人调用应用接口的依据,必须妥善保管。用户开发的Agent在调用平台接口时需要进行平台鉴权认证,可以使用“平台API Key”进行平台的鉴权认证。 前提条件 需要具备AI原生应用引擎管理员或开发者权限,权限申请操作请参见AppStage组织成员申请权限。
API 模型调用 应用中心 知识中心
如何调用API 构造请求 认证鉴权 返回结果
AI原生应用引擎SDK API 版本变更记录 SDK概述 快速开始 应用示例 modules模块 错误处理 日志处理
工具链同步信息接口规格说明 本章节介绍开发中心工具链相关接口规格说明,可以参考对应的接口规格来实现具体的接口,并将接口配置在开发中心工具链集成页面,实现数据同步集成。 同步集成接口规格 参考如下接口规格实现接口并配置工具链同步集成,可以将开发中心中的数据(租户、产品、服务、微服务
查看及导出微服务接口契约 微服务场景中的契约是指服务契约,它是基于OpenAPI规范的微服务接口约束规范,是服务端和消费端对于接口的定义。本文介绍如何查看以及导出微服务的接口契约。 查看接口契约 进入AppStage运维中心。 在顶部导航栏选择服务。 单击,选择“微服务开发 > 服务发现”。
查看及导出微服务接口契约 微服务场景中的契约是指服务契约,它是基于OpenAPI规范的微服务接口约束规范,是服务端和消费端对于接口的定义。本文介绍如何查看以及导出微服务的接口契约。 查看接口契约 进入AppStage运维中心。 在顶部导航栏选择服务。 单击,选择“微服务开发 > 服务发现”。
Authorization 是 String 参数解释: 鉴权信息。获取平台API Key,并为API Key添加前缀Bearer,得到标准鉴权信息,例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值:
模型调用 调用文本对话模型服务 调用文本向量化模型服务 父主题: API
则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于文本对话接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示。
创建知识库并进行检索 操作场景 本文通过调用一系列知识中心的API,介绍从零开始创建知识库并进行检索的基本流程。API调用方法请参见如何调用API。 前提条件 准备一篇名为“问题.txt”的文档,文档内容为: “什么是量子计算?它是一种利用量子力学原理进行信息处理的计算方式。====
更新知识库 操作场景 本文通过调用一系列知识中心的API介绍知识库的更新流程,适用于当数据源为OBS接入时,在OBS上进行文件增删改后,将改动同步到知识库的场景。API调用方法请参见如何调用API。 前提条件 用户接入的OBS目录下,存在文件的增删改其中一种情况。 需获取待更新数据集的id,支持通过如下两种方式获取:
Authorization 是 String 参数解释: 鉴权信息。获取平台API Key,并为API Key添加前缀Bearer,得到标准鉴权信息,例如Bearer sk-74e4157***。API Key获取方法请参见创建API Key。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值:
调用工具的执行动作 上传文件用于测试流 上传文件用于调用Agent 上传文件至文件盒子 删除文件盒子中的文件 调用Agent 父主题: API
查询知识库最新执行记录 修改知识库召回状态 创建知识数据集 查询知识数据集详情 删除知识数据集 执行知识数据集 查询知识数据集最新执行记录 父主题: API