跳到主要内容

Documentation Map

这页定义 AI4J 文档站的正式阅读路径。它的作用不是替代功能页,而是告诉读者:

  • 哪些目录是当前 canonical 主线。
  • 哪些目录属于历史沉淀或迁移来源。
  • 同一个能力应该从哪条路径进入,避免在旧页和新页之间来回跳。

Canonical 主线

主题正式入口适合谁
项目定位、模块选择、第一步运行Start Here第一次接触 AI4J 的用户
Core SDK、模型、Tool、Skill、RAG、基础能力Core SDK普通 Java 或 SDK 接入者
MCP client、gateway、server、tool 暴露MCP要接外部工具或发布 Java 能力的团队
Spring Boot 自动配置和 Bean 扩展Spring BootSpring 应用开发者
通用 Agent runtime、workflow、trace、teamAgent要在业务系统中嵌入 Agent 的团队
本地代码仓任务、CLI、TUI、ACPCoding Agent要做 coding agent 或本地开发宿主的团队
FlowGram.ai 画布后端执行层FlowGram要做可视化工作流平台的团队
场景 cookbookSolutions已经有明确业务场景的读者
版本、发布、安全、迁移、生产检查Operations选型、上线和维护人员

Legacy 来源目录

这些目录暂时保留,因为里面有不少长文和迁移内容仍然有价值。它们不再作为新用户的第一入口。

目录当前定位处理原则
getting-started/旧入门页、历史 quickstart 和版本页精华迁移到 start-here/reference/spring-boot/ 后保留跳转
ai-basics/Core SDK 低层细节和旧能力树迁移强内容到 core-sdk/mcp/solutions/ 后降级为 legacy reference
guides/历史博客、方案和迁移指南迁移到 solutions/migration/,保留博客迁移索引
core-sdk/chat/core-sdk/responses/旧模型访问拆分页内容逐步并入 core-sdk/model-access/
core-sdk/mcp/Core SDK 视角下的 MCP 深层参考顶层 mcp/ 是正式主线;独有技术细节再迁入或作为 advanced reference
agent/orchestration/agent/runtimes/agent/observability/迁移期别名目录优先阅读 agent/ 下的平铺 canonical 页面

能力到页面的唯一入口

你要找的能力从这里开始不建议从这里开始
Chat / Responses / Streaming / MultimodalModel Accessai-basics/chat/*core-sdk/chat/*
Function Tool / Tool whitelistToolsai-basics/chat/tool-calling
SkillSkillsai-basics/skills
MCPMCP Overviewcore-sdk/mcp/overview
MemoryMemoryai-basics/chat/chat-memory*
RAG / Vector / IngestionSearch & RAGai-basics/rag/*
Provider 扩展Extensionai-basics/provider-and-model-extension
Spring BootSpring Boot Overviewgetting-started/quickstart-springboot
Coding Agent MCP / ACPMCP and ACPagent/coding-agent-*
FlowGram 节点和任务 APIFlowGram Overviewflowgram/builtin-nodes

迁移期间的阅读规则

  1. 新用户只从 sidebar 里的 canonical 主线进入。
  2. 搜索到旧页时,先看页面顶部是否给出正式入口。
  3. 旧页里的长代码和实现细节可以参考,但不要把旧页当成模块边界的来源。
  4. 新增文档必须落在 canonical 主线;不能继续向 getting-started/ai-basics/guides/ 增加新主线内容。

如果你还不知道应该读哪条线,回到 Choose Your Path