Files
heicode/docs/glossary.md
T
gongzhiyong 1f21309597 refactor: rename manager codebase dir new-api → heicode, module github.com/heicode/manager
Remove user-facing new-api naming; Docker/network/container names use heicode.
Go imports updated; Dockerfiles and workflows ldflags fixed.

Made-with: Cursor
2026-05-01 01:47:23 +08:00

98 lines
4.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 术语表
本术语表是 Heicode 仓库内 **跨文档共享的命名标准**。任意文档涉及以下名称时,请相对链接回本文件锚点,避免规则漂移。
> 与代号相关的方向性来源:[`vision-heicode-full-stack-agentic-dev.md`](./vision-heicode-full-stack-agentic-dev.md)。
> 与 API 字段相关的来源:[`integration/agnet-platform-api-design.md`](./integration/agnet-platform-api-design.md)。
## 产品级代号
### Heicode
仓库与产品族的总称。在区分产品形态时,亦称 **Heicode 客户端**。
### Heicode Manager
账户、模型策略、渠道、计费与平台管控的服务端,源码目录 `heicode/`。在文档中亦称 **Manager**。
### Heicode 客户端
面向开发者的 CLI(Ink)+ 桌面应用(Tauri + React)+ 本地 HTTP/WS 服务,源码目录 `cc-haha/`。
### Orchard
**子智能体编排与团队模板** 所在平台的概念名。它是一个抽象代号,用以保持愿景叙事不绑死在某个厂商。落地形态可对应 Agnet。
### Agnet
当前实际接入的编排平台名称。规范上 Heicode 与 Agnet 通过 [`integration/agnet-platform-api-design.md`](./integration/agnet-platform-api-design.md) 中定义的契约通信。
## 编排相关
### 执行单元 (`agent_instance`)
按角色模板在编排侧实例化的智能体实例。生命周期字段详见 API 设计 §6.1。
### 子 agent
本仓库语境下,特指 **Agnet 平台内部** 的子智能体 / 子执行单元,由 Agnet 编排实例化,**不是** Heicode 自研运行时。
### 部署 (`deployment`)
一次「按团队模板把多个执行单元拉起」的整体行为,由 `deployment_id` 唯一标识。
### 团队 / 编队
一组在同一 `deployment` 中协同工作的执行单元。瀑布与敏捷下的最小/最大编队详见愿景附录 A。
## 资产与边界
### SK(Skill 资产)
为子 agent 提供运行时只读上下文的说明类正文,多为 Markdown。详见 [`sk-lifecycle.md`](./sk-lifecycle.md)。
### `sk_sources`
SK 的来源数组。每个元素声明其来源类型:
- `git`:以 commit SHA 为快照锚点
- `upload`:以 `artifact_id` + 版本为快照锚点
### `sk_file_refs`
简化字段(路径数组),可视为 `sk_sources` 的简写;展开规则需在联合 RFC 中声明。
### Provider Preset
Heicode 客户端预先配置的供应商描述(baseUrl、默认模型、API 格式等),目前仅保留 `taijiaicloud` 与 `clawdrouter`,定义于 `cc-haha/src/server/config/providerPresets.json`。
## 标识符
| 名称 | 含义 | 出处 |
|------|------|------|
| `tenant_id` | 顶层租户隔离边界,所有持久化资源必带 | API 设计 §4.1 |
| `org_id` | 租户内组织划分(可选) | API 设计 §4.1 |
| `project_id` | 编排资源挂载点 | API 设计 §4.1 |
| `deployment_id` | 一次部署的全局标识 | API 设计 §5.1 |
| `instance_id` / `agent_instance_id` | 执行单元实例 | API 设计 §5.1 / §6.1 |
| `sub_agent_id` | Agnet 内子 agent 实例 | API 设计 §5.0 / §6.4 |
| `correlation_id` / `X-Heicode-Correlation-Id` | Heicode → Agnet 全链路关联键 | API 设计 §2.3 |
| `request_id` / `X-Request-Id` | 单次请求追踪 | API 设计 §2.3 |
| `state` | OAuth 流程会话标识 | [`integration/heicode-oauth-flow.md`](./integration/heicode-oauth-flow.md) |
## 状态字段
### `phase`
执行单元的生命周期阶段:`pending` / `running` / `succeeded` / `failed` / `stopped` 等。
### `health`
执行单元健康度:`ok` / `degraded` / `unknown`。
### `schema_version`
事件载荷与某些资源体的版本号。客户端遇到未知字段必须忽略,破坏性变更须升级版本号。
## 认证相关
### M2M JWT
`Authorization: Bearer <m2m_jwt>` 形式的服务间令牌,由 Manager 或 Agnet 签发;至少包含 `sub` / `tenant_id` / `scope` / `exp`。
### 用户委派令牌
终端用户经 Heicode OAuth 后,由 Manager 代发用于访问 Agnet 受限接口的令牌;Claims 含 `user_id` / `org_id` / `roles`。
### loopback redirect_uri
Heicode 客户端浏览器登录时使用的回跳地址,必须使用 `127.0.0.1` / `localhost` / `::1`。详见 [`integration/heicode-oauth-flow.md`](./integration/heicode-oauth-flow.md)。
## 范式与角色(参考)
### 瀑布隐喻 / 敏捷隐喻
两种协作叙事,分别强调「阶段闸门可审计」与「短迭代闭环」。详见愿景正文第六节。
### 编队角色代号
`WF-*` 表示瀑布编队角色(如 `WF-DEV`、`WF-QA`、`WF-REL`),`AG-*` 表示敏捷编队角色(如 `AG-PO`、`AG-DEV`、`AG-QA`)。完整对照见愿景附录 A。