opc-agent 1.2.1 → 1.3.0

package/docs/index.md

@@ -1,27 +1,27 @@
----
-layout: home
-hero:
-  name: OPC Agent
-  text: Open Agent Framework
-  tagline: Build, test, and run AI Agents for business workstations
-  actions:
-    - theme: brand
-      text: Get Started
-      link: /guide/getting-started
-    - theme: alt
-      text: View on GitHub
-      link: https://github.com/Deepleaper/opc-agent
-features:
-  - title: 🚀 Quick Start
-    details: Create an agent in under 2 minutes with 13 built-in templates
-  - title: 📝 OAD Schema
-    details: Declarative YAML-based agent definition with full validation
-  - title: 🔌 Multi-Channel
-    details: Web, Telegram, Slack, WeChat, Email, Voice, WebSocket
-  - title: 🧪 Testing Framework
-    details: Define test cases in OAD, run with `opc test`, get pass/fail reports
-  - title: 📊 Analytics
-    details: Track messages, LLM calls, tool usage, and errors with built-in analytics
-  - title: 🌍 i18n
-    details: English, Chinese, and Japanese out of the box
----
+---
+layout: home
+hero:
+  name: OPC Agent
+  text: Open Agent Framework
+  tagline: Build, test, and run AI Agents for business workstations
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /guide/getting-started
+    - theme: alt
+      text: View on GitHub
+      link: https://github.com/Deepleaper/opc-agent
+features:
+  - title: 🚀 Quick Start
+    details: Create an agent in under 2 minutes with 13 built-in templates
+  - title: 📝 OAD Schema
+    details: Declarative YAML-based agent definition with full validation
+  - title: 🔌 Multi-Channel
+    details: Web, Telegram, Slack, WeChat, Email, Voice, WebSocket
+  - title: 🧪 Testing Framework
+    details: Define test cases in OAD, run with `opc test`, get pass/fail reports
+  - title: 📊 Analytics
+    details: Track messages, LLM calls, tool usage, and errors with built-in analytics
+  - title: 🌍 i18n
+    details: English, Chinese, and Japanese out of the box
+---

package/docs/zh/api/cli.md

@@ -1,54 +1,54 @@
-# CLI 命令参考
-
-## 完整命令列表
-
-| 命令 | 说明 |
-|------|------|
-| `opc init [name]` | 创建新智能体项目（交互式） |
-| `opc create <name>` | 从模板快速创建 |
-| `opc run` | 启动智能体（Web 服务） |
-| `opc chat` | 命令行交互对话 |
-| `opc test` | 运行测试用例 |
-| `opc analytics` | 查看使用分析 |
-| `opc info` | 查看智能体信息 |
-| `opc build` | 校验 OAD 配置 |
-| `opc dev` | 热重载开发模式 |
-| `opc deploy` | 部署智能体 |
-| `opc publish` | 发布到市场 |
-| `opc install <source>` | 从包安装智能体 |
-| `opc search <query>` | 搜索 OPC 市场 |
-| `opc stats` | 查看运行时统计 |
-| `opc kb add <file>` | 添加知识库文件 |
-| `opc kb search <query>` | 搜索知识库 |
-| `opc tool list` | 列出 MCP 工具 |
-| `opc workflow run <name>` | 运行工作流 |
-| `opc version-mgmt list` | 列出保存的版本 |
-
-## 通用选项
-
-- `-f, --file <file>` — OAD 文件路径（默认：`oad.yaml`）
-- `-t, --template <name>` — 模板名称
-- `-p, --port <port>` — 端口覆盖
-- `--json` — JSON 格式输出（用于 test/analytics）
-
-## 常用示例
-
-```bash
-# 用模板创建项目
-opc init my-bot -t teacher
-
-# 运行测试，输出 JSON
-opc test --json
-
-# 查看分析数据
-opc analytics
-
-# 部署到 OpenClaw
-opc deploy --target openclaw --install
-
-# 添加文件到知识库
-opc kb add ./docs/product-manual.pdf
-
-# 搜索知识库
-opc kb search "退货政策"
-```
+# CLI 命令参考
+
+## 完整命令列表
+
+| 命令 | 说明 |
+|------|------|
+| `opc init [name]` | 创建新智能体项目（交互式） |
+| `opc create <name>` | 从模板快速创建 |
+| `opc run` | 启动智能体（Web 服务） |
+| `opc chat` | 命令行交互对话 |
+| `opc test` | 运行测试用例 |
+| `opc analytics` | 查看使用分析 |
+| `opc info` | 查看智能体信息 |
+| `opc build` | 校验 OAD 配置 |
+| `opc dev` | 热重载开发模式 |
+| `opc deploy` | 部署智能体 |
+| `opc publish` | 发布到市场 |
+| `opc install <source>` | 从包安装智能体 |
+| `opc search <query>` | 搜索 OPC 市场 |
+| `opc stats` | 查看运行时统计 |
+| `opc kb add <file>` | 添加知识库文件 |
+| `opc kb search <query>` | 搜索知识库 |
+| `opc tool list` | 列出 MCP 工具 |
+| `opc workflow run <name>` | 运行工作流 |
+| `opc version-mgmt list` | 列出保存的版本 |
+
+## 通用选项
+
+- `-f, --file <file>` — OAD 文件路径（默认：`oad.yaml`）
+- `-t, --template <name>` — 模板名称
+- `-p, --port <port>` — 端口覆盖
+- `--json` — JSON 格式输出（用于 test/analytics）
+
+## 常用示例
+
+```bash
+# 用模板创建项目
+opc init my-bot -t teacher
+
+# 运行测试，输出 JSON
+opc test --json
+
+# 查看分析数据
+opc analytics
+
+# 部署到 OpenClaw
+opc deploy --target openclaw --install
+
+# 添加文件到知识库
+opc kb add ./docs/product-manual.pdf
+
+# 搜索知识库
+opc kb search "退货政策"
+```

package/docs/zh/api/oad-schema.md

@@ -1,87 +1,87 @@
-# OAD Schema v1 规范
-
-**OAD**（Open Agent Definition）是智能体的声明式定义格式，支持 YAML 和 JSON。
-
-## 完整 Schema
-
-```yaml
-apiVersion: opc/v1          # 必填。API 版本，目前固定为 "opc/v1"
-kind: Agent                  # 必填。资源类型，目前固定为 "Agent"
-
-metadata:
-  name: string               # 必填。智能体标识名
-  version: string            # 语义版本号，默认 "1.0.0"
-  description: string        # 可选。人类可读的描述
-  author: string             # 可选。作者
-  license: string            # 默认 "Apache-2.0"
-  marketplace:               # 可选。市场配置
-    certified: boolean       # 默认 false
-    category: string         # 如 "customer-service"
-
-spec:
-  provider:                  # 大语言模型供应商
-    default: string          # 默认供应商，默认 "deepseek"
-    allowed: string[]        # 允许的供应商列表，默认 ["openai", "deepseek", "qwen"]
-  model: string              # 模型名称，默认 "deepseek-chat"
-  systemPrompt: string       # 系统提示词
-
-  skills:                    # 技能列表
-    - name: string           # 技能标识
-      description: string    # 技能说明
-      config: object         # 可选。技能配置
-
-  channels:                  # 通信渠道
-    - type: web|websocket|telegram|slack|wechat|feishu|email|voice|webhook
-      port: number           # Web 渠道的端口
-      config: object         # 可选。渠道配置
-
-  memory:
-    shortTerm: boolean       # 开启对话记忆，默认 true
-    longTerm: boolean        # 开启持久化记忆，默认 false
-    provider: string         # 记忆后端（可选）
-
-  testing:
-    cases:                   # 测试用例
-      - name: string
-        input: string
-        expect:
-          contains: string[]
-          notContains: string[]
-          toolCalled: string[]
-          maxLatencyMs: number
-
-  rateLimits:
-    perUser:
-      maxRequests: number
-      windowMs: number
-    perProvider:
-      maxRequests: number
-      windowMs: number
-
-  cache:
-    enabled: boolean
-    ttlMs: number
-    maxEntries: number
-
-  dtv:
-    trust:
-      level: sandbox|verified|certified|listed  # 默认 "sandbox"
-    value:
-      metrics: string[]      # 要追踪的指标，默认 []
-```
-
-## 校验
-
-OAD 文件使用 Zod schema 校验。用 CLI 校验：
-
-```bash
-opc build -f oad.yaml
-```
-
-或在代码中校验：
-
-```typescript
-import { validateOAD } from 'opc-agent';
-
-const config = validateOAD(yamlData);
-```
+# OAD Schema v1 规范
+
+**OAD**（Open Agent Definition）是智能体的声明式定义格式，支持 YAML 和 JSON。
+
+## 完整 Schema
+
+```yaml
+apiVersion: opc/v1          # 必填。API 版本，目前固定为 "opc/v1"
+kind: Agent                  # 必填。资源类型，目前固定为 "Agent"
+
+metadata:
+  name: string               # 必填。智能体标识名
+  version: string            # 语义版本号，默认 "1.0.0"
+  description: string        # 可选。人类可读的描述
+  author: string             # 可选。作者
+  license: string            # 默认 "Apache-2.0"
+  marketplace:               # 可选。市场配置
+    certified: boolean       # 默认 false
+    category: string         # 如 "customer-service"
+
+spec:
+  provider:                  # 大语言模型供应商
+    default: string          # 默认供应商，默认 "deepseek"
+    allowed: string[]        # 允许的供应商列表，默认 ["openai", "deepseek", "qwen"]
+  model: string              # 模型名称，默认 "deepseek-chat"
+  systemPrompt: string       # 系统提示词
+
+  skills:                    # 技能列表
+    - name: string           # 技能标识
+      description: string    # 技能说明
+      config: object         # 可选。技能配置
+
+  channels:                  # 通信渠道
+    - type: web|websocket|telegram|slack|wechat|feishu|email|voice|webhook
+      port: number           # Web 渠道的端口
+      config: object         # 可选。渠道配置
+
+  memory:
+    shortTerm: boolean       # 开启对话记忆，默认 true
+    longTerm: boolean        # 开启持久化记忆，默认 false
+    provider: string         # 记忆后端（可选）
+
+  testing:
+    cases:                   # 测试用例
+      - name: string
+        input: string
+        expect:
+          contains: string[]
+          notContains: string[]
+          toolCalled: string[]
+          maxLatencyMs: number
+
+  rateLimits:
+    perUser:
+      maxRequests: number
+      windowMs: number
+    perProvider:
+      maxRequests: number
+      windowMs: number
+
+  cache:
+    enabled: boolean
+    ttlMs: number
+    maxEntries: number
+
+  dtv:
+    trust:
+      level: sandbox|verified|certified|listed  # 默认 "sandbox"
+    value:
+      metrics: string[]      # 要追踪的指标，默认 []
+```
+
+## 校验
+
+OAD 文件使用 Zod schema 校验。用 CLI 校验：
+
+```bash
+opc build -f oad.yaml
+```
+
+或在代码中校验：
+
+```typescript
+import { validateOAD } from 'opc-agent';
+
+const config = validateOAD(yamlData);
+```

package/docs/zh/api/sdk.md

@@ -1,102 +1,102 @@
-# SDK 参考
-
-## 核心类
-
-### AgentRuntime — 智能体运行时
-
-```typescript
-import { AgentRuntime } from 'opc-agent';
-
-const runtime = new AgentRuntime();
-await runtime.loadConfig('oad.yaml');   // 加载 OAD 配置
-const agent = await runtime.initialize(); // 初始化智能体
-await runtime.start();                    // 启动服务
-```
-
-### AnalyticsEngine — 分析引擎
-
-```typescript
-import { AnalyticsEngine } from 'opc-agent';
-
-const engine = new AnalyticsEngine('.');
-engine.trackMessage('user-1', 250, 100, 50);  // 追踪消息
-engine.trackToolUse('search', true, 120);       // 追踪工具调用
-const stats = engine.getStats();                // 获取统计数据
-```
-
-### RateLimiter — 限流器
-
-```typescript
-import { RateLimiter } from 'opc-agent';
-
-const limiter = new RateLimiter({
-  userLimit: { maxRequests: 60, windowMs: 60000 },
-  providerLimit: { maxRequests: 100, windowMs: 60000 },
-});
-
-await limiter.acquire('user-1', 'openai'); // 获取令牌，超限时抛出异常
-```
-
-### LLMCache — LLM 响应缓存
-
-```typescript
-import { LLMCache } from 'opc-agent';
-
-const cache = new LLMCache({ ttlMs: 3600000 }); // 1 小时过期
-const key = LLMCache.makeKey(messages, systemPrompt);
-const cached = cache.get(key);
-if (!cached) {
-  const response = await callLLM(messages);
-  cache.set(key, response);
-}
-```
-
-### KnowledgeBase — 知识库
-
-```typescript
-import { KnowledgeBase } from 'opc-agent';
-
-const kb = new KnowledgeBase('./docs');
-await kb.addFile('产品手册.pdf');    // 添加文件
-await kb.addFile('FAQ.md');
-const results = await kb.search('退货政策'); // 语义搜索
-```
-
-### Orchestrator — 多智能体编排
-
-```typescript
-import { Orchestrator } from 'opc-agent';
-
-const orchestrator = new Orchestrator({
-  agents: [triageAgent, salesAgent, supportAgent],
-  strategy: 'route-by-intent', // 按意图路由
-});
-
-const response = await orchestrator.handle(message);
-```
-
-### Testing — 测试工具
-
-```typescript
-import { runTests, formatReport } from 'opc-agent';
-
-const report = await runTests('oad.yaml');
-console.log(formatReport(report));
-```
-
-## 模板列表
-
-| 模板 | 说明 |
-|------|------|
-| `customer-service` | 客服：FAQ + 人工转接 |
-| `sales-assistant` | 销售：产品问答 + 线索捕获 |
-| `knowledge-base` | 知识库：RAG 语义检索 |
-| `code-reviewer` | 代码审查：Bug 检测 + 风格检查 |
-| `hr-recruiter` | HR：简历筛选 + 面试 |
-| `project-manager` | 项目管理：任务 + 会议纪要 |
-| `content-writer` | 内容创作：博客 + 社媒 + SEO |
-| `legal-assistant` | 法务：合同审查 + 合规 |
-| `financial-advisor` | 财务：预算 + 支出 |
-| `executive-assistant` | 行政：日程 + 邮件 + 会议 |
-| `data-analyst` | 数据分析：查询 + 可视化 |
-| `teacher` | 教学：课程 + 出题 |
+# SDK 参考
+
+## 核心类
+
+### AgentRuntime — 智能体运行时
+
+```typescript
+import { AgentRuntime } from 'opc-agent';
+
+const runtime = new AgentRuntime();
+await runtime.loadConfig('oad.yaml');   // 加载 OAD 配置
+const agent = await runtime.initialize(); // 初始化智能体
+await runtime.start();                    // 启动服务
+```
+
+### AnalyticsEngine — 分析引擎
+
+```typescript
+import { AnalyticsEngine } from 'opc-agent';
+
+const engine = new AnalyticsEngine('.');
+engine.trackMessage('user-1', 250, 100, 50);  // 追踪消息
+engine.trackToolUse('search', true, 120);       // 追踪工具调用
+const stats = engine.getStats();                // 获取统计数据
+```
+
+### RateLimiter — 限流器
+
+```typescript
+import { RateLimiter } from 'opc-agent';
+
+const limiter = new RateLimiter({
+  userLimit: { maxRequests: 60, windowMs: 60000 },
+  providerLimit: { maxRequests: 100, windowMs: 60000 },
+});
+
+await limiter.acquire('user-1', 'openai'); // 获取令牌，超限时抛出异常
+```
+
+### LLMCache — LLM 响应缓存
+
+```typescript
+import { LLMCache } from 'opc-agent';
+
+const cache = new LLMCache({ ttlMs: 3600000 }); // 1 小时过期
+const key = LLMCache.makeKey(messages, systemPrompt);
+const cached = cache.get(key);
+if (!cached) {
+  const response = await callLLM(messages);
+  cache.set(key, response);
+}
+```
+
+### KnowledgeBase — 知识库
+
+```typescript
+import { KnowledgeBase } from 'opc-agent';
+
+const kb = new KnowledgeBase('./docs');
+await kb.addFile('产品手册.pdf');    // 添加文件
+await kb.addFile('FAQ.md');
+const results = await kb.search('退货政策'); // 语义搜索
+```
+
+### Orchestrator — 多智能体编排
+
+```typescript
+import { Orchestrator } from 'opc-agent';
+
+const orchestrator = new Orchestrator({
+  agents: [triageAgent, salesAgent, supportAgent],
+  strategy: 'route-by-intent', // 按意图路由
+});
+
+const response = await orchestrator.handle(message);
+```
+
+### Testing — 测试工具
+
+```typescript
+import { runTests, formatReport } from 'opc-agent';
+
+const report = await runTests('oad.yaml');
+console.log(formatReport(report));
+```
+
+## 模板列表
+
+| 模板 | 说明 |
+|------|------|
+| `customer-service` | 客服：FAQ + 人工转接 |
+| `sales-assistant` | 销售：产品问答 + 线索捕获 |
+| `knowledge-base` | 知识库：RAG 语义检索 |
+| `code-reviewer` | 代码审查：Bug 检测 + 风格检查 |
+| `hr-recruiter` | HR：简历筛选 + 面试 |
+| `project-manager` | 项目管理：任务 + 会议纪要 |
+| `content-writer` | 内容创作：博客 + 社媒 + SEO |
+| `legal-assistant` | 法务：合同审查 + 合规 |
+| `financial-advisor` | 财务：预算 + 支出 |
+| `executive-assistant` | 行政：日程 + 邮件 + 会议 |
+| `data-analyst` | 数据分析：查询 + 可视化 |
+| `teacher` | 教学：课程 + 出题 |