opc-agent 1.3.1 → 1.3.2

package/docs/zh/guide/configuration.md

@@ -1,135 +1,135 @@
-# 配置详解
-
-## OAD 文件结构
-
-`oad.yaml` 是智能体的核心配置文件，所有配置都在这里：
-
-```yaml
-apiVersion: opc/v1
-kind: Agent
-metadata:
-  name: my-agent
-  version: 1.0.0
-  description: 我的智能体
-spec:
-  provider:
-    default: deepseek
-    allowed: [openai, deepseek, qwen]
-  model: deepseek-chat
-  systemPrompt: "你是一个专业的助手。"
-  skills: []
-  channels:
-    - type: web
-      port: 3000
-  memory:
-    shortTerm: true
-    longTerm: false
-  testing:
-    cases:
-      - name: 问候测试
-        input: "你好"
-        expect:
-          contains: ["你好", "帮"]
-          maxLatencyMs: 5000
-  rateLimits:
-    perUser:
-      maxRequests: 60
-      windowMs: 60000
-    perProvider:
-      maxRequests: 100
-      windowMs: 60000
-  cache:
-    enabled: true
-    ttlMs: 3600000
-```
-
-## 环境变量
-
-| 变量 | 说明 | 默认值 |
-|------|------|--------|
-| `OPC_LLM_API_KEY` | 大语言模型 API Key | — |
-| `OPC_LLM_BASE_URL` | API 地址 | `https://api.openai.com/v1` |
-| `OPC_LLM_MODEL` | 模型名称 | `gpt-4o-mini` |
-
-## 模型供应商配置
-
-```yaml
-spec:
-  provider:
-    default: deepseek               # 默认供应商
-    allowed: [deepseek, qwen, openai]  # 允许的供应商列表
-  model: deepseek-chat              # 具体模型
-```
-
-运行时通过环境变量 `OPC_LLM_API_KEY` 和 `OPC_LLM_BASE_URL` 传入凭证。
-
-## 限流配置
-
-保护你的 API 配额和后端服务：
-
-```yaml
-spec:
-  rateLimits:
-    perUser:
-      maxRequests: 60       # 每个用户每分钟最多 60 次请求
-      windowMs: 60000
-    perProvider:
-      maxRequests: 100      # 每个供应商每分钟最多 100 次请求
-      windowMs: 60000
-```
-
-## 缓存配置
-
-开启 LLM 响应缓存，降低 API 调用成本：
-
-```yaml
-spec:
-  cache:
-    enabled: true
-    ttlMs: 3600000    # 缓存有效期 1 小时
-    maxEntries: 1000  # 最大缓存条数
-```
-
-## 渠道配置
-
-```yaml
-spec:
-  channels:
-    - type: web
-      port: 3000
-      config:
-        cors: true
-        sse: true           # 启用 SSE 流式响应
-
-    - type: telegram
-      config:
-        token: ${TELEGRAM_BOT_TOKEN}
-
-    - type: wechat
-      config:
-        appId: ${WECHAT_APP_ID}
-        appSecret: ${WECHAT_APP_SECRET}
-```
-
-## 记忆配置
-
-```yaml
-spec:
-  memory:
-    shortTerm: true          # 对话上下文记忆
-    longTerm: true           # 跨会话长期记忆
-    provider: deepbrain      # 长期记忆后端
-    config:
-      collection: my-kb      # 知识库集合名称
-```
-
-## DTV 信任配置
-
-```yaml
-spec:
-  dtv:
-    trust:
-      level: sandbox         # sandbox | verified | certified | listed
-    value:
-      metrics: [response_time, satisfaction_score]
-```
+# 配置详解
+
+## OAD 文件结构
+
+`oad.yaml` 是智能体的核心配置文件，所有配置都在这里：
+
+```yaml
+apiVersion: opc/v1
+kind: Agent
+metadata:
+  name: my-agent
+  version: 1.0.0
+  description: 我的智能体
+spec:
+  provider:
+    default: deepseek
+    allowed: [openai, deepseek, qwen]
+  model: deepseek-chat
+  systemPrompt: "你是一个专业的助手。"
+  skills: []
+  channels:
+    - type: web
+      port: 3000
+  memory:
+    shortTerm: true
+    longTerm: false
+  testing:
+    cases:
+      - name: 问候测试
+        input: "你好"
+        expect:
+          contains: ["你好", "帮"]
+          maxLatencyMs: 5000
+  rateLimits:
+    perUser:
+      maxRequests: 60
+      windowMs: 60000
+    perProvider:
+      maxRequests: 100
+      windowMs: 60000
+  cache:
+    enabled: true
+    ttlMs: 3600000
+```
+
+## 环境变量
+
+| 变量 | 说明 | 默认值 |
+|------|------|--------|
+| `OPC_LLM_API_KEY` | 大语言模型 API Key | — |
+| `OPC_LLM_BASE_URL` | API 地址 | `https://api.openai.com/v1` |
+| `OPC_LLM_MODEL` | 模型名称 | `gpt-4o-mini` |
+
+## 模型供应商配置
+
+```yaml
+spec:
+  provider:
+    default: deepseek               # 默认供应商
+    allowed: [deepseek, qwen, openai]  # 允许的供应商列表
+  model: deepseek-chat              # 具体模型
+```
+
+运行时通过环境变量 `OPC_LLM_API_KEY` 和 `OPC_LLM_BASE_URL` 传入凭证。
+
+## 限流配置
+
+保护你的 API 配额和后端服务：
+
+```yaml
+spec:
+  rateLimits:
+    perUser:
+      maxRequests: 60       # 每个用户每分钟最多 60 次请求
+      windowMs: 60000
+    perProvider:
+      maxRequests: 100      # 每个供应商每分钟最多 100 次请求
+      windowMs: 60000
+```
+
+## 缓存配置
+
+开启 LLM 响应缓存，降低 API 调用成本：
+
+```yaml
+spec:
+  cache:
+    enabled: true
+    ttlMs: 3600000    # 缓存有效期 1 小时
+    maxEntries: 1000  # 最大缓存条数
+```
+
+## 渠道配置
+
+```yaml
+spec:
+  channels:
+    - type: web
+      port: 3000
+      config:
+        cors: true
+        sse: true           # 启用 SSE 流式响应
+
+    - type: telegram
+      config:
+        token: ${TELEGRAM_BOT_TOKEN}
+
+    - type: wechat
+      config:
+        appId: ${WECHAT_APP_ID}
+        appSecret: ${WECHAT_APP_SECRET}
+```
+
+## 记忆配置
+
+```yaml
+spec:
+  memory:
+    shortTerm: true          # 对话上下文记忆
+    longTerm: true           # 跨会话长期记忆
+    provider: deepbrain      # 长期记忆后端
+    config:
+      collection: my-kb      # 知识库集合名称
+```
+
+## DTV 信任配置
+
+```yaml
+spec:
+  dtv:
+    trust:
+      level: sandbox         # sandbox | verified | certified | listed
+    value:
+      metrics: [response_time, satisfaction_score]
+```

package/docs/zh/guide/deployment.md

@@ -1,81 +1,81 @@
-# 部署指南
-
-## 本地开发
-
-```bash
-# 热重载开发模式
-opc dev
-
-# 普通启动
-opc run
-```
-
-## Docker 部署
-
-每个 `opc init` 创建的项目都自带 `Dockerfile` 和 `docker-compose.yml`：
-
-```bash
-docker compose up -d
-```
-
-### 自定义 Docker 配置
-
-```yaml
-# docker-compose.yml
-services:
-  agent:
-    build: .
-    ports:
-      - "3000:3000"
-    env_file: .env
-    restart: unless-stopped
-```
-
-## 部署到 OpenClaw
-
-```bash
-# 部署
-opc deploy --target openclaw
-
-# 部署并注册到配置
-opc deploy --target openclaw --install
-```
-
-## 部署到 Hermes 云
-
-```bash
-# 直接部署
-opc deploy --target hermes
-
-# 生成部署文件到指定目录
-opc deploy --target hermes --output ./my-deploy
-```
-
-## 环境变量
-
-在 `.env` 文件中配置：
-
-```bash
-# 大语言模型配置
-OPC_LLM_API_KEY=sk-xxx
-OPC_LLM_BASE_URL=https://api.deepseek.com/v1
-OPC_LLM_MODEL=deepseek-chat
-
-# Telegram 机器人（可选）
-TELEGRAM_BOT_TOKEN=xxx
-
-# 微信公众号（可选）
-WECHAT_APP_ID=xxx
-WECHAT_APP_SECRET=xxx
-```
-
-## 上线检查清单
-
-- [ ] 在 `.env` 中配置正确的 API Key
-- [ ] 在 `oad.yaml` 中配置限流策略
-- [ ] 开启缓存以降低 API 成本
-- [ ] 配置监控和告警
-- [ ] 运行 `opc test` 确保测试通过
-- [ ] 检查 DTV 信任等级设置
-- [ ] 配置 CORS 和安全头
-- [ ] 准备回滚方案
+# 部署指南
+
+## 本地开发
+
+```bash
+# 热重载开发模式
+opc dev
+
+# 普通启动
+opc run
+```
+
+## Docker 部署
+
+每个 `opc init` 创建的项目都自带 `Dockerfile` 和 `docker-compose.yml`：
+
+```bash
+docker compose up -d
+```
+
+### 自定义 Docker 配置
+
+```yaml
+# docker-compose.yml
+services:
+  agent:
+    build: .
+    ports:
+      - "3000:3000"
+    env_file: .env
+    restart: unless-stopped
+```
+
+## 部署到 OpenClaw
+
+```bash
+# 部署
+opc deploy --target openclaw
+
+# 部署并注册到配置
+opc deploy --target openclaw --install
+```
+
+## 部署到 Hermes 云
+
+```bash
+# 直接部署
+opc deploy --target hermes
+
+# 生成部署文件到指定目录
+opc deploy --target hermes --output ./my-deploy
+```
+
+## 环境变量
+
+在 `.env` 文件中配置：
+
+```bash
+# 大语言模型配置
+OPC_LLM_API_KEY=sk-xxx
+OPC_LLM_BASE_URL=https://api.deepseek.com/v1
+OPC_LLM_MODEL=deepseek-chat
+
+# Telegram 机器人（可选）
+TELEGRAM_BOT_TOKEN=xxx
+
+# 微信公众号（可选）
+WECHAT_APP_ID=xxx
+WECHAT_APP_SECRET=xxx
+```
+
+## 上线检查清单
+
+- [ ] 在 `.env` 中配置正确的 API Key
+- [ ] 在 `oad.yaml` 中配置限流策略
+- [ ] 开启缓存以降低 API 成本
+- [ ] 配置监控和告警
+- [ ] 运行 `opc test` 确保测试通过
+- [ ] 检查 DTV 信任等级设置
+- [ ] 配置 CORS 和安全头
+- [ ] 准备回滚方案

package/docs/zh/guide/getting-started.md

@@ -1,82 +1,82 @@
-# 快速开始
-
-## 安装
-
-```bash
-npm install -g opc-agent
-```
-
-## 创建第一个智能体
-
-```bash
-# 交互式创建（会让你选模板和配置）
-opc init my-agent
-cd my-agent
-```
-
-或者直接用模板：
-
-```bash
-opc init my-bot --template customer-service
-opc init my-bot --template sales-assistant
-opc init my-bot --template knowledge-base
-```
-
-## 配置
-
-编辑 `.env` 文件，填入你的大语言模型 API Key：
-
-```bash
-OPC_LLM_API_KEY=your-api-key
-OPC_LLM_BASE_URL=https://api.deepseek.com/v1    # DeepSeek
-OPC_LLM_MODEL=deepseek-chat
-```
-
-支持的供应商和对应的 Base URL：
-
-| 供应商 | Base URL | 推荐模型 |
-|--------|----------|---------|
-| DeepSeek | `https://api.deepseek.com/v1` | `deepseek-chat` |
-| 通义千问 | `https://dashscope.aliyuncs.com/compatible-mode/v1` | `qwen-plus` |
-| OpenAI | `https://api.openai.com/v1` | `gpt-4o-mini` |
-| Ollama (本地) | `http://localhost:11434/v1` | `llama3` |
-
-## 启动
-
-```bash
-# 启动 Web 对话服务
-opc run
-
-# 或者用命令行对话
-opc chat
-
-# 开发模式（改代码自动重启）
-opc dev
-```
-
-访问 `http://localhost:3000` 即可看到对话界面。
-
-## 校验配置
-
-```bash
-opc build
-```
-
-## 运行测试
-
-```bash
-opc test
-```
-
-## 查看数据分析
-
-```bash
-opc analytics
-```
-
-## 下一步
-
-- [核心概念](/zh/guide/concepts) — 理解 OAD、技能、渠道等概念
-- [模板列表](/zh/guide/templates) — 查看全部 12 个场景模板
-- [配置详解](/zh/guide/configuration) — OAD 文件的完整配置项
-- [部署指南](/zh/guide/deployment) — Docker、OpenClaw、Hermes 部署
+# 快速开始
+
+## 安装
+
+```bash
+npm install -g opc-agent
+```
+
+## 创建第一个智能体
+
+```bash
+# 交互式创建（会让你选模板和配置）
+opc init my-agent
+cd my-agent
+```
+
+或者直接用模板：
+
+```bash
+opc init my-bot --template customer-service
+opc init my-bot --template sales-assistant
+opc init my-bot --template knowledge-base
+```
+
+## 配置
+
+编辑 `.env` 文件，填入你的大语言模型 API Key：
+
+```bash
+OPC_LLM_API_KEY=your-api-key
+OPC_LLM_BASE_URL=https://api.deepseek.com/v1    # DeepSeek
+OPC_LLM_MODEL=deepseek-chat
+```
+
+支持的供应商和对应的 Base URL：
+
+| 供应商 | Base URL | 推荐模型 |
+|--------|----------|---------|
+| DeepSeek | `https://api.deepseek.com/v1` | `deepseek-chat` |
+| 通义千问 | `https://dashscope.aliyuncs.com/compatible-mode/v1` | `qwen-plus` |
+| OpenAI | `https://api.openai.com/v1` | `gpt-4o-mini` |
+| Ollama (本地) | `http://localhost:11434/v1` | `llama3` |
+
+## 启动
+
+```bash
+# 启动 Web 对话服务
+opc run
+
+# 或者用命令行对话
+opc chat
+
+# 开发模式（改代码自动重启）
+opc dev
+```
+
+访问 `http://localhost:3000` 即可看到对话界面。
+
+## 校验配置
+
+```bash
+opc build
+```
+
+## 运行测试
+
+```bash
+opc test
+```
+
+## 查看数据分析
+
+```bash
+opc analytics
+```
+
+## 下一步
+
+- [核心概念](/zh/guide/concepts) — 理解 OAD、技能、渠道等概念
+- [模板列表](/zh/guide/templates) — 查看全部 12 个场景模板
+- [配置详解](/zh/guide/configuration) — OAD 文件的完整配置项
+- [部署指南](/zh/guide/deployment) — Docker、OpenClaw、Hermes 部署