@symerian/symi 3.0.20 → 3.0.22

package/docs/zh-CN/plugins/voice-call.md

@@ -1,250 +0,0 @@
----
-read_when:
-  - 你想从 Symi 发起出站语音通话
-  - 你正在配置或开发 voice-call 插件
-summary: Voice Call 插件：通过 Twilio/Telnyx/Plivo 进行出站 + 入站通话（插件安装 + 配置 + CLI）
-title: Voice Call 插件
-x-i18n:
-  generated_at: "2026-02-03T07:53:40Z"
-  model: claude-opus-4-5
-  provider: pi
-  source_hash: d731c63bf52781cc49262db550d0507d7fc33e5e7ce5d87efaf5d44aedcafef7
-  source_path: plugins/voice-call.md
-  workflow: 15
----
-
-# Voice Call（插件）
-
-通过插件为 Symi 提供语音通话。支持出站通知和带有入站策略的多轮对话。
-
-当前提供商：
-
-- `twilio`（Programmable Voice + Media Streams）
-- `telnyx`（Call Control v2）
-- `plivo`（Voice API + XML transfer + GetInput speech）
-- `mock`（开发/无网络）
-
-快速心智模型：
-
-- 安装插件
-- 重启 Gateway 网关
-- 在 `plugins.entries.voice-call.config` 下配置
-- 使用 `symi voicecall ...` 或 `voice_call` 工具
-
-## 运行位置（本地 vs 远程）
-
-Voice Call 插件运行在 **Gateway 网关进程内部**。
-
-如果你使用远程 Gateway 网关，在**运行 Gateway 网关的机器**上安装/配置插件，然后重启 Gateway 网关以加载它。
-
-## 安装
-
-### 选项 A：从 npm 安装（推荐）
-
-```bash
-symi plugins install @symi/voice-call
-```
-
-之后重启 Gateway 网关。
-
-### 选项 B：从本地文件夹安装（开发，不复制）
-
-```bash
-symi plugins install ./extensions/voice-call
-cd ./extensions/voice-call && pnpm install
-```
-
-之后重启 Gateway 网关。
-
-## 配置
-
-在 `plugins.entries.voice-call.config` 下设置配置：
-
-```json5
-{
-  plugins: {
-    entries: {
-      "voice-call": {
-        enabled: true,
-        config: {
-          provider: "twilio", // 或 "telnyx" | "plivo" | "mock"
-          fromNumber: "+15550001234",
-          toNumber: "+15550005678",
-
-          twilio: {
-            accountSid: "ACxxxxxxxx",
-            authToken: "...",
-          },
-
-          plivo: {
-            authId: "MAxxxxxxxxxxxxxxxxxxxx",
-            authToken: "...",
-          },
-
-          // Webhook 服务器
-          serve: {
-            port: 3334,
-            path: "/voice/webhook",
-          },
-
-          // 公开暴露（选一个）
-          // publicUrl: "https://example.ngrok.app/voice/webhook",
-          // tunnel: { provider: "ngrok" },
-          // tailscale: { mode: "funnel", path: "/voice/webhook" }
-
-          outbound: {
-            defaultMode: "notify", // notify | conversation
-          },
-
-          streaming: {
-            enabled: true,
-            streamPath: "/voice/stream",
-          },
-        },
-      },
-    },
-  },
-}
-```
-
-注意事项：
-
-- Twilio/Telnyx 需要**可公开访问**的 webhook URL。
-- Plivo 需要**可公开访问**的 webhook URL。
-- `mock` 是本地开发提供商（无网络调用）。
-- `skipSignatureVerification` 仅用于本地测试。
-- 如果你使用 ngrok 免费版，将 `publicUrl` 设置为确切的 ngrok URL；签名验证始终强制执行。
-- `tunnel.allowNgrokFreeTierLoopbackBypass: true` 允许带有无效签名的 Twilio webhooks，**仅当** `tunnel.provider="ngrok"` 且 `serve.bind` 是 loopback（ngrok 本地代理）时。仅用于本地开发。
-- Ngrok 免费版 URL 可能会更改或添加中间页面行为；如果 `publicUrl` 漂移，Twilio 签名将失败。对于生产环境，优先使用稳定域名或 Tailscale funnel。
-
-## 通话的 TTS
-
-Voice Call 使用核心 `messages.tts` 配置（OpenAI 或 ElevenLabs）进行通话中的流式语音。你可以在插件配置下使用**相同的结构**覆盖它——它会与 `messages.tts` 深度合并。
-
-```json5
-{
-  tts: {
-    provider: "elevenlabs",
-    elevenlabs: {
-      voiceId: "pMsXgVXv3BLzUgSXRplE",
-      modelId: "eleven_multilingual_v2",
-    },
-  },
-}
-```
-
-注意事项：
-
-- **语音通话忽略 Edge TTS**（电话音频需要 PCM；Edge 输出不可靠）。
-- 当启用 Twilio 媒体流时使用核心 TTS；否则通话回退到提供商原生语音。
-
-### 更多示例
-
-仅使用核心 TTS（无覆盖）：
-
-```json5
-{
-  messages: {
-    tts: {
-      provider: "openai",
-      openai: { voice: "alloy" },
-    },
-  },
-}
-```
-
-仅为通话覆盖为 ElevenLabs（其他地方保持核心默认）：
-
-```json5
-{
-  plugins: {
-    entries: {
-      "voice-call": {
-        config: {
-          tts: {
-            provider: "elevenlabs",
-            elevenlabs: {
-              apiKey: "elevenlabs_key",
-              voiceId: "pMsXgVXv3BLzUgSXRplE",
-              modelId: "eleven_multilingual_v2",
-            },
-          },
-        },
-      },
-    },
-  },
-}
-```
-
-仅为通话覆盖 OpenAI 模型（深度合并示例）：
-
-```json5
-{
-  plugins: {
-    entries: {
-      "voice-call": {
-        config: {
-          tts: {
-            openai: {
-              model: "gpt-4o-mini-tts",
-              voice: "marin",
-            },
-          },
-        },
-      },
-    },
-  },
-}
-```
-
-## 入站通话
-
-入站策略默认为 `disabled`。要启用入站通话，设置：
-
-```json5
-{
-  inboundPolicy: "allowlist",
-  allowFrom: ["+15550001234"],
-  inboundGreeting: "Hello! How can I help?",
-}
-```
-
-自动响应使用智能体系统。通过以下方式调整：
-
-- `responseModel`
-- `responseSystemPrompt`
-- `responseTimeoutMs`
-
-## CLI
-
-```bash
-symi voicecall call --to "+15555550123" --message "Hello from Symi"
-symi voicecall continue --call-id <id> --message "Any questions?"
-symi voicecall speak --call-id <id> --message "One moment"
-symi voicecall end --call-id <id>
-symi voicecall status --call-id <id>
-symi voicecall tail
-symi voicecall expose --mode funnel
-```
-
-## 智能体工具
-
-工具名称：`voice_call`
-
-操作：
-
-- `initiate_call`（message、to?、mode?）
-- `continue_call`（callId、message）
-- `speak_to_user`（callId、message）
-- `end_call`（callId）
-- `get_status`（callId）
-
-此仓库在 `skills/voice-call/SKILL.md` 提供了配套的 skill 文档。
-
-## Gateway 网关 RPC
-
-- `voicecall.initiate`（`to?`、`message`、`mode?`）
-- `voicecall.continue`（`callId`、`message`）
-- `voicecall.speak`（`callId`、`message`）
-- `voicecall.end`（`callId`）
-- `voicecall.status`（`callId`）

package/docs/zh-CN/plugins/zalouser.md

@@ -1,88 +0,0 @@
----
-read_when:
-  - 你想在 Symi 中支持 Zalo Personal（非官方）
-  - 你正在配置或开发 zalouser 插件
-summary: Zalo Personal 插件：通过 zca-cli 进行 QR 登录 + 消息（插件安装 + 渠道配置 + CLI + 工具）
-title: Zalo Personal 插件
-x-i18n:
-  generated_at: "2026-02-03T07:53:33Z"
-  model: claude-opus-4-5
-  provider: pi
-  source_hash: b29b788b023cd50720e24fe6719f02e9f86c8bca9c73b3638fb53c2316718672
-  source_path: plugins/zalouser.md
-  workflow: 15
----
-
-# Zalo Personal（插件）
-
-通过插件为 Symi 提供 Zalo Personal 支持，使用 `zca-cli` 自动化普通 Zalo 用户账户。
-
-> **警告：** 非官方自动化可能导致账户被暂停/封禁。使用风险自负。
-
-## 命名
-
-渠道 id 是 `zalouser`，以明确表示这是自动化**个人 Zalo 用户账户**（非官方）。我们保留 `zalo` 用于潜在的未来官方 Zalo API 集成。
-
-## 运行位置
-
-此插件**在 Gateway 网关进程内**运行。
-
-如果你使用远程 Gateway 网关，请在**运行 Gateway 网关的机器**上安装/配置它，然后重启 Gateway 网关。
-
-## 安装
-
-### 选项 A：从 npm 安装
-
-```bash
-symi plugins install @symi/zalouser
-```
-
-之后重启 Gateway 网关。
-
-### 选项 B：从本地文件夹安装（开发）
-
-```bash
-symi plugins install ./extensions/zalouser
-cd ./extensions/zalouser && pnpm install
-```
-
-之后重启 Gateway 网关。
-
-## 前置条件：zca-cli
-
-Gateway 网关机器必须在 `PATH` 中有 `zca`：
-
-```bash
-zca --version
-```
-
-## 配置
-
-渠道配置位于 `channels.zalouser` 下（不是 `plugins.entries.*`）：
-
-```json5
-{
-  channels: {
-    zalouser: {
-      enabled: true,
-      dmPolicy: "pairing",
-    },
-  },
-}
-```
-
-## CLI
-
-```bash
-symi channels login --channel zalouser
-symi channels logout --channel zalouser
-symi channels status --probe
-symi message send --channel zalouser --target <threadId> --message "Hello from Symi"
-symi directory peers list --channel zalouser --query "name"
-```
-
-## 智能体工具
-
-工具名称：`zalouser`
-
-操作：`send`、`image`、`link`、`friends`、`groups`、`me`、`status`

package/docs/zh-CN/prose.md

@@ -1,141 +0,0 @@
----
-read_when:
-  - 你想运行或编写 .prose 工作流
-  - 你想启用 OpenProse 插件
-  - 你需要了解状态存储
-summary: OpenProse：Symi 中的 .prose 工作流、斜杠命令和状态
-title: OpenProse
-x-i18n:
-  generated_at: "2026-02-03T07:53:38Z"
-  model: claude-opus-4-5
-  provider: pi
-  source_hash: cf7301e927b9a46347b498e264aeaa10dd76e85ff2de04775be57435718339f5
-  source_path: prose.md
-  workflow: 15
----
-
-# OpenProse
-
-OpenProse 是一种可移植的、以 Markdown 为中心的工作流格式，用于编排 AI 会话。在 Symi 中，它作为插件发布，安装一个 OpenProse Skills 包以及一个 `/prose` 斜杠命令。程序存放在 `.prose` 文件中，可以生成多个具有显式控制流的子智能体。
-
-官方网站：https://www.prose.md
-
-## 它能做什么
-
-- 具有显式并行性的多智能体研究 + 综合。
-- 可重复的批准安全工作流（代码审查、事件分类、内容管道）。
-- 可在支持的智能体运行时之间运行的可重用 `.prose` 程序。
-
-## 安装 + 启用
-
-捆绑的插件默认是禁用的。启用 OpenProse：
-
-```bash
-symi plugins enable open-prose
-```
-
-启用插件后重启 Gateway 网关。
-
-开发/本地检出：`symi plugins install ./extensions/open-prose`
-
-相关文档：[插件](/tools/plugin)、[插件清单](/plugins/manifest)、[Skills](/tools/skills)。
-
-## 斜杠命令
-
-OpenProse 将 `/prose` 注册为用户可调用的 Skills 命令。它路由到 OpenProse VM 指令，并在底层使用 Symi 工具。
-
-常用命令：
-
-```
-/prose help
-/prose run <file.prose>
-/prose run <handle/slug>
-/prose run <https://example.com/file.prose>
-/prose compile <file.prose>
-/prose examples
-/prose update
-```
-
-## 示例：一个简单的 `.prose` 文件
-
-```prose
-# Research + synthesis with two agents running in parallel.
-
-input topic: "What should we research?"
-
-agent researcher:
-  model: sonnet
-  prompt: "You research thoroughly and cite sources."
-
-agent writer:
-  model: opus
-  prompt: "You write a concise summary."
-
-parallel:
-  findings = session: researcher
-    prompt: "Research {topic}."
-  draft = session: writer
-    prompt: "Summarize {topic}."
-
-session "Merge the findings + draft into a final answer."
-context: { findings, draft }
-```
-
-## 文件位置
-
-OpenProse 将状态保存在工作空间的 `.prose/` 下：
-
-```
-.prose/
-├── .env
-├── runs/
-│   └── {YYYYMMDD}-{HHMMSS}-{random}/
-│       ├── program.prose
-│       ├── state.md
-│       ├── bindings/
-│       └── agents/
-└── agents/
-```
-
-用户级持久智能体位于：
-
-```
-~/.prose/agents/
-```
-
-## 状态模式
-
-OpenProse 支持多种状态后端：
-
-- **filesystem**（默认）：`.prose/runs/...`
-- **in-context**：瞬态，用于小程序
-- **sqlite**（实验性）：需要 `sqlite3` 二进制文件
-- **postgres**（实验性）：需要 `psql` 和连接字符串
-
-说明：
-
-- sqlite/postgres 是选择加入的，且处于实验阶段。
-- postgres 凭证会流入子智能体日志；请使用专用的、最小权限的数据库。
-
-## 远程程序
-
-`/prose run <handle/slug>` 解析为 `https://p.prose.md/<handle>/<slug>`。
-直接 URL 按原样获取。这使用 `web_fetch` 工具（或用于 POST 的 `exec`）。
-
-## Symi 运行时映射
-
-OpenProse 程序映射到 Symi 原语：
-
-| OpenProse 概念       | Symi 工具        |
-| -------------------- | ---------------- |
-| 生成会话 / Task 工具 | `sessions_spawn` |
-| 文件读/写            | `read` / `write` |
-| Web 获取             | `web_fetch`      |
-
-如果你的工具白名单阻止这些工具，OpenProse 程序将失败。参见 [Skills 配置](/tools/skills-config)。
-
-## 安全 + 批准
-
-将 `.prose` 文件视为代码。运行前请审查。使用 Symi 工具白名单和批准门控来控制副作用。
-
-对于确定性的、批准门控的工作流，可与 [Pipeline](/tools/pipeline) 比较。

package/docs/zh-CN/providers/anthropic.md

@@ -1,159 +0,0 @@
----
-read_when:
-  - 你想在 Symi 中使用 Anthropic 模型
-  - 你想使用 setup-token 而不是 API 密钥
-summary: 在 Symi 中通过 API 密钥或 setup-token 使用 Anthropic Claude
-title: Anthropic
-x-i18n:
-  generated_at: "2026-02-03T10:08:33Z"
-  model: claude-opus-4-5
-  provider: pi
-  source_hash: a78ccd855810a93e71d7138af4d3fc7d66e877349815c4a3207cf2214b0150b3
-  source_path: providers/anthropic.md
-  workflow: 15
----
-
-# Anthropic（Claude）
-
-Anthropic 构建了 **Claude** 模型系列，并通过 API 提供访问。
-在 Symi 中，你可以使用 API 密钥或 **setup-token** 进行认证。
-
-## 选项 A：Anthropic API 密钥
-
-**适用于：** 标准 API 访问和按用量计费。
-在 Anthropic Console 中创建你的 API 密钥。
-
-### CLI 设置
-
-```bash
-symi onboard
-# 选择：Anthropic API key
-
-# 或非交互式
-symi onboard --anthropic-api-key "$ANTHROPIC_API_KEY"
-```
-
-### 配置片段
-
-```json5
-{
-  env: { ANTHROPIC_API_KEY: "sk-ant-..." },
-  agents: { defaults: { model: { primary: "anthropic/claude-opus-4-5" } } },
-}
-```
-
-## 提示缓存（Anthropic API）
-
-Symi 支持 Anthropic 的提示缓存功能。这是**仅限 API**；订阅认证不支持缓存设置。
-
-### 配置
-
-在模型配置中使用 `cacheRetention` 参数：
-
-| 值      | 缓存时长 | 描述                       |
-| ------- | -------- | -------------------------- |
-| `none`  | 无缓存   | 禁用提示缓存               |
-| `short` | 5 分钟   | API 密钥认证的默认值       |
-| `long`  | 1 小时   | 扩展缓存（需要 beta 标志） |
-
-```json5
-{
-  agents: {
-    defaults: {
-      models: {
-        "anthropic/claude-opus-4-5": {
-          params: { cacheRetention: "long" },
-        },
-      },
-    },
-  },
-}
-```
-
-### 默认值
-
-使用 Anthropic API 密钥认证时，Symi 会自动为所有 Anthropic 模型应用 `cacheRetention: "short"`（5 分钟缓存）。你可以通过在配置中显式设置 `cacheRetention` 来覆盖此设置。
-
-### 旧版参数
-
-为了向后兼容，仍支持旧版 `cacheControlTtl` 参数：
-
-- `"5m"` 映射到 `short`
-- `"1h"` 映射到 `long`
-
-我们建议迁移到新的 `cacheRetention` 参数。
-
-Symi 在 Anthropic API 请求中包含 `extended-cache-ttl-2025-04-11` beta 标志；
-如果你覆盖提供商头信息，请保留它（参见 [/gateway/configuration](/gateway/configuration)）。
-
-## 选项 B：Claude setup-token
-
-**适用于：** 使用你的 Claude 订阅。
-
-### 在哪里获取 setup-token
-
-setup-token 由 **Claude Code CLI** 创建，而不是 Anthropic Console。你可以在**任何机器**上运行：
-
-```bash
-claude setup-token
-```
-
-将令牌粘贴到 Symi（向导：**Anthropic token (paste setup-token)**），或在 Gateway 网关主机上运行：
-
-```bash
-symi models auth setup-token --provider anthropic
-```
-
-如果你在不同的机器上生成了令牌，请粘贴它：
-
-```bash
-symi models auth paste-token --provider anthropic
-```
-
-### CLI 设置
-
-```bash
-# 在新手引导期间粘贴 setup-token
-symi onboard --auth-choice setup-token
-```
-
-### 配置片段
-
-```json5
-{
-  agents: { defaults: { model: { primary: "anthropic/claude-opus-4-5" } } },
-}
-```
-
-## 注意事项
-
-- 使用 `claude setup-token` 生成 setup-token 并粘贴，或在 Gateway 网关主机上运行 `symi models auth setup-token`。
-- 如果你在 Claude 订阅上看到"OAuth token refresh failed …"，请使用 setup-token 重新认证。参见 [/gateway/troubleshooting#oauth-token-refresh-failed-anthropic-claude-subscription](/gateway/troubleshooting#oauth-token-refresh-failed-anthropic-claude-subscription)。
-- 认证详情 + 重用规则在 [/concepts/oauth](/concepts/oauth)。
-
-## 故障排除
-
-**401 错误/令牌突然失效**
-
-- Claude 订阅认证可能过期或被撤销。重新运行 `claude setup-token`
-  并将其粘贴到 **Gateway 网关主机**。
-- 如果 Claude CLI 登录在不同的机器上，在 Gateway 网关主机上使用
-  `symi models auth paste-token --provider anthropic`。
-
-**No API key found for provider "anthropic"**
-
-- 认证是**按智能体**的。新智能体不会继承主智能体的密钥。
-- 为该智能体重新运行新手引导，或在 Gateway 网关主机上粘贴 setup-token / API 密钥，
-  然后使用 `symi models status` 验证。
-
-**No credentials found for profile `anthropic:default`**
-
-- 运行 `symi models status` 查看哪个认证配置文件处于活动状态。
-- 重新运行新手引导，或为该配置文件粘贴 setup-token / API 密钥。
-
-**No available auth profile (all in cooldown/unavailable)**
-
-- 检查 `symi models status --json` 中的 `auth.unusableProfiles`。
-- 添加另一个 Anthropic 配置文件或等待冷却期结束。
-
-更多信息：[/gateway/troubleshooting](/gateway/troubleshooting) 和 [/help/faq](/help/faq)。