开发流程
本文将介绍使用开放平台实现智能体相关能力集成的大致流程,各开放能力间可能有些许差异,请以具体的接口文档为准。
流程概览
编辑
操作步骤
步骤一:创建及发布应用
在开放平台,智能体应用是除模型效果盲测能力外,各项能力的必要载体,在使用 API 或 SDK 进行能力集成前,请先完成智能体应用的创建以及发布,并获取对应应用 ID。
创建应用
操作步骤
-
开发者登录我的应用,点击页面上方的新建应用。
编辑
-
在新建应用面板,选择应用类型以及构建方式,并根据自身需求完善包含应用名称、应用图标以及应用功能介绍在内的基本信息,最后点击新建。
编辑
发布应用
1.发布应用并开启 SDK 授权:完成应用发布,并在发布过程中,开启 SDK 服务下,目标能力的授权。
编辑
其中:
-
- WebSDK:开启后才可使用百宝箱的 WebSDK 服务将智能体集成至网页端。
- 智能体 SDK:除 WebSDK 外,其他开放能力(包括 API 及 SDK)均需开启该授权。
- IOT 设备:开启后,可通过 IOT 设备实现智能体与硬件设备的集成,从而为硬件添加对话能力。
2.获取应用 ID:在发布应用页面的应用状态栏可快速获取当前应用的 AppID。
编辑
步骤二:获取授权令牌
在开放平台,授权令牌(token)是用于验证开放身份的凭证,需要您在调用开放能力时,在请求参数中进行配置。为保证您的数据安全,请妥善保管您的令牌信息。
步骤三:调用开放能力
开放平台通过 API 接口与 SDK 的开放,支持智能体调用、模型效果盲测以及 WebSDK 等场景,简单几步即可完成服务的集成。在进行接口调用前,请点击下方附录中的链接,快速阅读对应的说明文档,以保证调用流程的顺畅与准确。
附录:开放能力速览
API 列表
| 功能模块 | 能力名称 | 说明 |
| 智能体调用 | 使用对话型智能体POST``https://api.tbox.cn/api/chat | 通过调用本接口,可以向指定智能体发起对话,支持在对话时添加上下文消息,便于智能体做出合理的回复。 |
使用生成型智能体POST``https://api.tbox.cn/api/completion | 通过调用本接口,可以在自有系统中使用生成型智能体,例如生成古诗、文章以及图片等内容。 | |
文件上传POST``https://api.tbox.cn/api/file/upload | 通过调用本接口,可以实现文件上传功能,上传后的文件可以用于创建知识库或作为多模态数据输入给应用。 | |
文件查询GET``https://api.tbox.cn/api/file/retrieve?fileId={fileId} | 调用本接口,开发者可以查询通过文件上传接口上传的文件详情信息。 | |
发起会话POST``https://api.tbox.cn/api/conversation/create | 通过调用本接口,开发者可以发起一个新的会话行为。 | |
查询会话列表GET``https://api.tbox.cn/api/conversation/conversations | 通过调用本接口,开发者可以查询由开放平台 API 或 SDK 发起的智能体会话列表。 | |
查询消息列表GET``https://api.tbox.cn/api/conversation/messages | 通过调用本接口,开发者可以查询由开放平台 API 或 SDK 发起的,指定会话过程中的消息列表。 | |
| 模型效果测评 | 获取模型测评结果- POST``https://api.tbox.cn/api/model/responses |
POST``https://api.tbox.cn/api/model/completions| 通过调用模型效果盲测接口,开发者可以实现一次调用过程中,使用多种不同的模型进行内容生成。适用于在实际业务场景下,做用户对不同模型底座的智能体的喜好对比。 | | 盲测效果反馈POST``https://api.tbox.cn/model/api/feedback| 通过调用本接口,可以将模型效果盲测的结果反馈给百宝箱。百宝箱会将收集到的反馈数据进行计分排行,用于展示在不同业务场景下,底层模型适配排行。 | |
SDK 能力