Docs
文档目录

SDK 开发指南

使用 SDK 接入 Agentbase:先选择客户端、服务端或管理面,再按业务功能查找调用示例。

当前状态:2.12.0 迭代分支交付。 源 appbase v2.12.0@1b75b0e57db3b46dce1a04d48f75aa695c4eb6a6,docs 基线 caddb6c90d76246e760238f4150701315a359b14;工作分支 docs/v2.12.0-sync → 保护迭代分支 v2.12.0,此前交付 PR #34。首次交付 PR #32 已合并,旧 PR #33 已关闭;该 PR 请求派蒙评审,开启 Squash、合并后删源分支和评审/检查通过后自动合并。SDK Release 2.12.0 保留原构建来源;中文/英文同步,日文未产出。本期记录列出源码增量、截图缺口及验证边界;文档/Skill 制品以同名 tag 和 Release 为准。

文档语言:中文 · English,各 52 篇;日文尚未产出。编程语言与文档语言独立。

开始接入

  1. 阅读接入安装,按所用语言安装 SDK。

  2. 确认运行环境与 endpoint,选择所需身份:Web 用户 Session、服务端 API Key或Console 管理面。

  3. 从函数、知识库、数据库等功能页查看参数和完整调用示例;遇到异常时查阅常见错误。

语言面与获取方式

语言面分发形态获取方式文档
JavaScript — web(浏览器)/ node(服务端)/ console(管理面)npm 包,双面发布(public agentbase-*-sdk / 内部 @alipay/agentbase-*-sdk)从远程 registry 下载安装(写精确版本号,不写 latest/范围)接入安装
Java — server / consoleRelease ZIP 附件(内层为 Java 生态制品,双层 SHA-256 校验)未发布到 registry,需在源码仓库中引用(放 JAR / 本地安装,按实际附件内容选用)接入安装
Python — server / consoleRelease ZIP 附件(内层为 Python 生态制品)未发布到 registry,需在源码仓库中引用(本地 wheel 路径 / 离线安装)接入安装
Go — server / consoleRelease ZIP 附件(内层为 Go 模块源码)未发布到 registry,需在源码仓库中引用(本地模块路径 / vendored 源码)接入安装

各语言的安装方式、精确版本和校验步骤见接入安装。

索引(功能分组)

组位置内容状态
通用接入安装、environment.md、troubleshooting.md接入两条路径;endpoint / region;错误速查已产出(zh-CN,基于 2.9.0 并含 2.10.0 增量)
账号级account/authentication.md、account/profile.md登录认证与账号自身已产出(zh-CN,基于 2.9.0 并含 2.10.0 增量)
组织级organization/organization.md、organization/project-governance.md组织管理、组织项目治理已产出(zh-CN,基于 2.9.0 并含 2.10.0 增量)
项目级overview/、databases/、auth/、storage.md、functions.md、agent-runtime.md 等项目及其库表、存储、函数、用户/团队、网关、知识库、观测与 Runtime已产出(zh-CN,基于 2.9.0 并含 2.10.0 增量)
SDK 轴client-sdk/、console-sdk/、server-sdk/各类 SDK 的初始化、认证与功能面映射已产出(zh-CN:client 1 + console 4 + server 4)
语言示例<lang>/examples/<language>.md每种 SDK 编程语言一份调用示例已产出 JavaScript / Java / Python / Go(zh-CN,示例坐标为 2.10.0;内容含 2.9.0 基线与 2.10.0 增量,历史交付缺口见 changelog)
迭代增量changelogs/<X.Y.Z>.md每迭代一个,入口 changelogs/README.md已登记 2.6.0 / 2.7.0 / 2.8.0 / 2.9.0 / 2.10.0 / 2.11.0 / 2.12.0

场景库使用与契约 · English