切换主题
文档怎么读
第一次接入只需沿着 准备 → 应用 → 后台 → 前端 → 验证 这条路线读。跑通之后,再根据业务需求选择能力专题。
我该从哪里开始
| 你现在的情况 | 从这里进入 | 读到哪里可以停 |
|---|---|---|
| 想知道 SparkTide 能解决什么 | 初识 SparkTide | 理解两套 SDK 与底座的分工 |
| 第一次接入,尚未跑通聊天 | 从零接入教程 | 第 5 步回答成功、追问与刷新历史 |
| 后台同事已准备好 /api/ai | 接入聊天页面 | ChatPanel 或 JS/TS 方法可调用 |
| 聊天已经可用,想查询业务数据 | 添加工具与知识 | 工具回调 / 检索与引用验证完成 |
| 已经在业务项目接入,需要更多功能 | 能力指南 | 当前需求对应的专题 |
| 查一个字段或 SDK 方法 | SDK 参考 / HTTP API | 找到准确参数、约束和返回值 |
| 运维部署或排查故障 | 部署与运维 | 当前环境完成部署或定位问题 |
| 查看资源、运行和审计 | 控制台操作 | 完成查看、调试或显式治理 |
文档分为三层
教程按步骤给出完整文件、命令、预期结果和失败排查。不要把语言或框架标签理解为都要执行;每组选择一个。
能力指南按业务需求解释概念、接入方式和限制,例如模型、工具、知识、UI、权限与发布。每页说明适用阶段,再链接到更深的协议和 SDK 用法。
参考与运维用于按需查询参数和部署治理,不是接入的前置阅读清单。底层 HTTP、旧直连客户端、手工 Registry 注册放在参考中,常规业务优先使用双 SDK。
接入过程中不需要先做什么
默认 ChatPanel 已能发送消息、展示历史和处理确认。第一轮聊天只需要应用、模型图、业务身份适配和前端客户端;自定义卡片、子智能体、向量检索、多实例与审计导出均可在接入后按需学习。
管理平台用于查看、调试、停用和治理。业务模型、工具、知识与智能体的常规声明尽量由后台 SDK 管理,不要求从控制台逐个录入。
