Appearance
AI 智能体接口清单
以下是当前源码中最稳定的接口分组,完整参数和响应以 Controller 注解及 DTO 为准。
| 领域 | 前缀 | 控制器 |
|---|---|---|
| 聊天、会话、SSE | /v1/chatbot | AiChatbotAgentController |
| Agent 管理 | /v1/agent | AiAgentManagementController |
| Agent 直接执行 | /v1/agent/execute | AiAgentExecutionController |
| LLM 模型 | /v1/llm-model | AiLlmModelController |
| 会话日志 | /v1/logs | ConversationLogController |
| Skill | /v1/skill | SkillController |
| 官方 Skill 仓库 | /v1/skill-repository | OfficialSkillRepositoryController |
| 文件房间 | /v1/files/rooms | FileRoomController |
| 微信渠道 | /v1/channel/wechat | WechatChannelController |
| 企业微信渠道 | /v1/channel/wecom | WeComChannelController |
| 钉钉渠道 | /v1/channel/dingtalk | DingTalkChannelController |
| QQ 渠道 | /v1/channel/qq | QqChannelController |
| RAG 阶段 | /ai/rag/stage | RagStageController |
| 向量化 | /ai/vectorization | VectorizationController |
聊天接口的使用顺序
- 创建或复用 session。
- 建立 SSE 或注册回调通道。
- 提交消息。
- 读取运行状态、消息流和 Artifact。
- 任务结束后主动关闭连接或结束 session。
接口返回的业务包装通常为 R<T>,HTTP 200 不代表 Agent 任务成功;需要同时检查响应体状态和后续运行事件。
当前聊天路径
以 AiChatbotAgentController 为准,聊天相关路径都挂在 /v1/chatbot 下:
| 操作 | 路径 |
|---|---|
| 快速同步 SSE | POST /{agentId}/sessions/{sessionId}/quick-chat |
| 提交聊天消息 | POST /{agentId}/sessions/{sessionId}/chat |
| 请求安全暂停 | POST /{agentId}/sessions/{sessionId}/pause |
| 恢复运行 | POST /{agentId}/sessions/{sessionId}/resume |
| 取消运行 | POST /{agentId}/sessions/{sessionId}/cancel |
| 建立 SSE | GET /{agentId}/sessions/{sessionId}/sse/connect |
| 查询运行状态 | GET /{agentId}/sessions/{sessionId}/run-status |
| 创建/切换分支 | POST /{agentId}/sessions/{sessionId}/branches、POST /{agentId}/sessions/{sessionId}/branches/{branchId}/activate |
暂停、恢复和取消由服务端按 session 当前运行版本绑定;请求体可带 clientMessageId 用于去重,恢复请求的 message 用于补充暂停期间的输入。当前 Controller 没有独立的 approved 字段,普通工具 HITL 在 human_review 节点恢复时由服务端生成批准响应并带回原 toolCallId;checkpoint 暂停恢复则不会生成工具批准。dispatcher 内部使用 (sessionId, runVersion) 防止旧运行的迟到消息覆盖新状态。客户端收到 hitlPending、agent_state 或 error 后,应先查询运行状态和事件序号,再决定是否重连或展示操作入口。请求进入主图和 Agentic Loop 的具体过程见智能体执行引擎。