@gguf/claw 2026.2.1 → 2026.2.3

package/docs/zh-CN/automation/webhook.md

@@ -0,0 +1,163 @@
+---
+read_when:
+  - 添加或修改 webhook 端点
+  - 将外部系统接入 OpenClaw
+summary: 用于唤醒和隔离式智能体运行的 Webhook 入口
+title: Webhooks
+x-i18n:
+  generated_at: "2026-02-01T19:39:20Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: f26b88864567be82366b1f66a4772ef2813c7846110c62fce6caf7313568265e
+  source_path: automation/webhook.md
+  workflow: 14
+---
+
+# Webhooks
+
+Gateway网关可以暴露一个小型 HTTP webhook 端点用于外部触发。
+
+## 启用
+
+```json5
+{
+  hooks: {
+    enabled: true,
+    token: "shared-secret",
+    path: "/hooks",
+  },
+}
+```
+
+说明：
+
+- 当 `hooks.enabled=true` 时，`hooks.token` 为必填项。
+- `hooks.path` 默认为 `/hooks`。
+
+## 认证
+
+每个请求必须包含 hook 令牌。推荐使用请求头：
+
+- `Authorization: Bearer <token>`（推荐）
+- `x-openclaw-token: <token>`
+- `?token=<token>`（已弃用；会记录警告，将在未来的主要版本中移除）
+
+## 端点
+
+### `POST /hooks/wake`
+
+请求体：
+
+```json
+{ "text": "System line", "mode": "now" }
+```
+
+- `text` **必填**（字符串）：事件描述（例如 "New email received"）。
+- `mode` 可选（`now` | `next-heartbeat`）：是否触发立即心跳（默认 `now`）或等待下一次周期性检查。
+
+效果：
+
+- 为**主**会话入队一个系统事件
+- 如果 `mode=now`，触发立即心跳
+
+### `POST /hooks/agent`
+
+请求体：
+
+```json
+{
+  "message": "Run this",
+  "name": "Email",
+  "sessionKey": "hook:email:msg-123",
+  "wakeMode": "now",
+  "deliver": true,
+  "channel": "last",
+  "to": "+15551234567",
+  "model": "openai/gpt-5.2-mini",
+  "thinking": "low",
+  "timeoutSeconds": 120
+}
+```
+
+- `message` **必填**（字符串）：智能体处理的提示或消息。
+- `name` 可选（字符串）：hook 的人类可读名称（例如 "GitHub"），用作会话摘要的前缀。
+- `sessionKey` 可选（字符串）：用于标识智能体会话的键。默认为随机的 `hook:<uuid>`。使用一致的键可以在 hook 上下文中进行多轮对话。
+- `wakeMode` 可选（`now` | `next-heartbeat`）：是否触发立即心跳（默认 `now`）或等待下一次周期性检查。
+- `deliver` 可选（布尔值）：如果为 `true`，智能体的回复将发送到消息渠道。默认为 `true`。仅为心跳确认的回复会被自动跳过。
+- `channel` 可选（字符串）：投递的消息渠道。可选值：`last`、`whatsapp`、`telegram`、`discord`、`slack`、`mattermost`（插件）、`signal`、`imessage`、`msteams`。默认为 `last`。
+- `to` 可选（字符串）：渠道的接收方标识符（例如 WhatsApp/Signal 的电话号码、Telegram 的聊天 ID、Discord/Slack/Mattermost（插件）的频道 ID、Microsoft Teams 的会话 ID）。默认为主会话中的最后一个接收方。
+- `model` 可选（字符串）：模型覆盖（例如 `anthropic/claude-3-5-sonnet` 或别名）。如果有模型限制，必须在允许的模型列表中。
+- `thinking` 可选（字符串）：思维级别覆盖（例如 `low`、`medium`、`high`）。
+- `timeoutSeconds` 可选（数字）：智能体运行的最大持续时间（秒）。
+
+效果：
+
+- 运行一次**隔离式**智能体轮次（使用独立的会话键）
+- 始终将摘要发布到**主**会话
+- 如果 `wakeMode=now`，触发立即心跳
+
+### `POST /hooks/<name>`（映射）
+
+自定义 hook 名称通过 `hooks.mappings` 解析（参见配置）。映射可以将任意请求体转换为 `wake` 或 `agent` 操作，并支持可选的模板或代码转换。
+
+映射选项（概要）：
+
+- `hooks.presets: ["gmail"]` 启用内置的 Gmail 映射。
+- `hooks.mappings` 允许你在配置中定义 `match`、`action` 和模板。
+- `hooks.transformsDir` + `transform.module` 加载 JS/TS 模块以实现自定义逻辑。
+- 使用 `match.source` 保持通用的接收端点（基于请求体的路由）。
+- TS 转换需要 TS 加载器（例如 `bun` 或 `tsx`）或运行时预编译的 `.js`。
+- 在映射上设置 `deliver: true` + `channel`/`to` 可将回复路由到聊天界面（`channel` 默认为 `last`，回退到 WhatsApp）。
+- `allowUnsafeExternalContent: true` 为该 hook 禁用外部内容安全包装（危险；仅限受信任的内部来源）。
+- `openclaw webhooks gmail setup` 为 `openclaw webhooks gmail run` 写入 `hooks.gmail` 配置。完整的 Gmail watch 流程请参阅 [Gmail Pub/Sub](/automation/gmail-pubsub)。
+
+## 响应
+
+- `200` 用于 `/hooks/wake`
+- `202` 用于 `/hooks/agent`（异步运行已启动）
+- `401` 认证失败
+- `400` 无效请求体
+- `413` 请求体过大
+
+## 示例
+
+```bash
+curl -X POST http://127.0.0.1:18789/hooks/wake \
+  -H 'Authorization: Bearer SECRET' \
+  -H 'Content-Type: application/json' \
+  -d '{"text":"New email received","mode":"now"}'
+```
+
+```bash
+curl -X POST http://127.0.0.1:18789/hooks/agent \
+  -H 'x-openclaw-token: SECRET' \
+  -H 'Content-Type: application/json' \
+  -d '{"message":"Summarize inbox","name":"Email","wakeMode":"next-heartbeat"}'
+```
+
+### 使用不同的模型
+
+在 agent 请求体（或映射）中添加 `model` 以覆盖该次运行的模型：
+
+```bash
+curl -X POST http://127.0.0.1:18789/hooks/agent \
+  -H 'x-openclaw-token: SECRET' \
+  -H 'Content-Type: application/json' \
+  -d '{"message":"Summarize inbox","name":"Email","model":"openai/gpt-5.2-mini"}'
+```
+
+如果你设置了 `agents.defaults.models`，请确保覆盖的模型包含在其中。
+
+```bash
+curl -X POST http://127.0.0.1:18789/hooks/gmail \
+  -H 'Authorization: Bearer SECRET' \
+  -H 'Content-Type: application/json' \
+  -d '{"source":"gmail","messages":[{"from":"Ada","subject":"Hello","snippet":"Hi"}]}'
+```
+
+## 安全
+
+- 将 hook 端点限制在 local loopback、tailnet 或受信任的反向代理之后。
+- 使用专用的 hook 令牌；不要复用 Gateway网关认证令牌。
+- 避免在 webhook 日志中包含敏感的原始请求体。
+- Hook 请求体默认被视为不受信任的，并使用安全边界进行包装。如果你必须为特定 hook 禁用此功能，请在该 hook 的映射中设置 `allowUnsafeExternalContent: true`（危险）。

package/docs/zh-CN/bedrock.md

@@ -0,0 +1,170 @@
+---
+read_when:
+  - 你想在 OpenClaw 中使用 Amazon Bedrock 模型
+  - 你需要为模型调用设置 AWS 凭证/区域
+summary: 在 OpenClaw 中使用 Amazon Bedrock（Converse API）模型
+title: Amazon Bedrock
+x-i18n:
+  generated_at: "2026-02-01T19:39:40Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 318f1048451a1910b70522e2f7f9dfc87084de26d9e3938a29d372eed32244a8
+  source_path: bedrock.md
+  workflow: 14
+---
+
+# Amazon Bedrock
+
+OpenClaw 可以通过 pi‑ai 的 **Bedrock Converse** 流式提供商使用 **Amazon Bedrock** 模型。Bedrock 认证使用 **AWS SDK 默认凭证链**，而非 API 密钥。
+
+## pi‑ai 支持的内容
+
+- 提供商：`amazon-bedrock`
+- API：`bedrock-converse-stream`
+- 认证：AWS 凭证（环境变量、共享配置或实例角色）
+- 区域：`AWS_REGION` 或 `AWS_DEFAULT_REGION`（默认：`us-east-1`）
+
+## 自动模型发现
+
+如果检测到 AWS 凭证，OpenClaw 可以自动发现支持**流式传输**和**文本输出**的 Bedrock 模型。发现功能使用 `bedrock:ListFoundationModels`，并带有缓存（默认：1 小时）。
+
+配置选项位于 `models.bedrockDiscovery` 下：
+
+```json5
+{
+  models: {
+    bedrockDiscovery: {
+      enabled: true,
+      region: "us-east-1",
+      providerFilter: ["anthropic", "amazon"],
+      refreshInterval: 3600,
+      defaultContextWindow: 32000,
+      defaultMaxTokens: 4096,
+    },
+  },
+}
+```
+
+说明：
+
+- 当 AWS 凭证存在时，`enabled` 默认为 `true`。
+- `region` 默认为 `AWS_REGION` 或 `AWS_DEFAULT_REGION`，然后是 `us-east-1`。
+- `providerFilter` 匹配 Bedrock 提供商名称（例如 `anthropic`）。
+- `refreshInterval` 单位为秒；设置为 `0` 可禁用缓存。
+- `defaultContextWindow`（默认：`32000`）和 `defaultMaxTokens`（默认：`4096`）用于发现的模型（如果你了解模型限制可以覆盖）。
+
+## 设置（手动）
+
+1. 确保 AWS 凭证在 **Gateway网关主机**上可用：
+
+```bash
+export AWS_ACCESS_KEY_ID="AKIA..."
+export AWS_SECRET_ACCESS_KEY="..."
+export AWS_REGION="us-east-1"
+# 可选：
+export AWS_SESSION_TOKEN="..."
+export AWS_PROFILE="your-profile"
+# 可选（Bedrock API 密钥/Bearer 令牌）：
+export AWS_BEARER_TOKEN_BEDROCK="..."
+```
+
+2. 在配置中添加 Bedrock 提供商和模型（无需 `apiKey`）：
+
+```json5
+{
+  models: {
+    providers: {
+      "amazon-bedrock": {
+        baseUrl: "https://bedrock-runtime.us-east-1.amazonaws.com",
+        api: "bedrock-converse-stream",
+        auth: "aws-sdk",
+        models: [
+          {
+            id: "anthropic.claude-opus-4-5-20251101-v1:0",
+            name: "Claude Opus 4.5 (Bedrock)",
+            reasoning: true,
+            input: ["text", "image"],
+            cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
+            contextWindow: 200000,
+            maxTokens: 8192,
+          },
+        ],
+      },
+    },
+  },
+  agents: {
+    defaults: {
+      model: { primary: "amazon-bedrock/anthropic.claude-opus-4-5-20251101-v1:0" },
+    },
+  },
+}
+```
+
+## EC2 实例角色
+
+在附加了 IAM 角色的 EC2 实例上运行 OpenClaw 时，AWS SDK 会自动使用实例元数据服务（IMDS）进行认证。但是，OpenClaw 的凭证检测目前仅检查环境变量，不检查 IMDS 凭证。
+
+**解决方法：** 设置 `AWS_PROFILE=default` 以表明 AWS 凭证可用。实际认证仍通过 IMDS 使用实例角色。
+
+```bash
+# 添加到 ~/.bashrc 或你的 shell 配置文件
+export AWS_PROFILE=default
+export AWS_REGION=us-east-1
+```
+
+EC2 实例角色**所需的 IAM 权限**：
+
+- `bedrock:InvokeModel`
+- `bedrock:InvokeModelWithResponseStream`
+- `bedrock:ListFoundationModels`（用于自动发现）
+
+或附加托管策略 `AmazonBedrockFullAccess`。
+
+**快速设置：**
+
+```bash
+# 1. 创建 IAM 角色和实例配置文件
+aws iam create-role --role-name EC2-Bedrock-Access \
+  --assume-role-policy-document '{
+    "Version": "2012-10-17",
+    "Statement": [{
+      "Effect": "Allow",
+      "Principal": {"Service": "ec2.amazonaws.com"},
+      "Action": "sts:AssumeRole"
+    }]
+  }'
+
+aws iam attach-role-policy --role-name EC2-Bedrock-Access \
+  --policy-arn arn:aws:iam::aws:policy/AmazonBedrockFullAccess
+
+aws iam create-instance-profile --instance-profile-name EC2-Bedrock-Access
+aws iam add-role-to-instance-profile \
+  --instance-profile-name EC2-Bedrock-Access \
+  --role-name EC2-Bedrock-Access
+
+# 2. 附加到你的 EC2 实例
+aws ec2 associate-iam-instance-profile \
+  --instance-id i-xxxxx \
+  --iam-instance-profile Name=EC2-Bedrock-Access
+
+# 3. 在 EC2 实例上启用发现
+openclaw config set models.bedrockDiscovery.enabled true
+openclaw config set models.bedrockDiscovery.region us-east-1
+
+# 4. 设置解决方法的环境变量
+echo 'export AWS_PROFILE=default' >> ~/.bashrc
+echo 'export AWS_REGION=us-east-1' >> ~/.bashrc
+source ~/.bashrc
+
+# 5. 验证模型已被发现
+openclaw models list
+```
+
+## 说明
+
+- Bedrock 需要在你的 AWS 账户/区域中启用**模型访问**。
+- 自动发现需要 `bedrock:ListFoundationModels` 权限。
+- 如果你使用配置文件，请在 Gateway网关主机上设置 `AWS_PROFILE`。
+- OpenClaw 按以下顺序检测凭证来源：`AWS_BEARER_TOKEN_BEDROCK`，然后 `AWS_ACCESS_KEY_ID` + `AWS_SECRET_ACCESS_KEY`，然后 `AWS_PROFILE`，最后是默认的 AWS SDK 链。
+- 推理支持取决于模型；请查看 Bedrock 模型卡了解当前功能。
+- 如果你偏好托管密钥流程，也可以在 Bedrock 前面放置一个兼容 OpenAI 的代理，将其配置为 OpenAI 提供商。

package/docs/zh-CN/brave-search.md

@@ -0,0 +1,48 @@
+---
+read_when:
+  - 你想使用 Brave Search 进行 web_search
+  - 你需要 BRAVE_API_KEY 或套餐详情
+summary: 为 web_search 设置 Brave Search API
+title: Brave Search
+x-i18n:
+  generated_at: "2026-02-01T19:39:45Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: cdcb037b092b8a10609f02acf062b4164cb826ac22bdb3fb2909c842a1405341
+  source_path: brave-search.md
+  workflow: 14
+---
+
+# Brave Search API
+
+OpenClaw 使用 Brave Search 作为 `web_search` 的默认提供商。
+
+## 获取 API 密钥
+
+1. 在 https://brave.com/search/api/ 创建 Brave Search API 账户。
+2. 在控制面板中，选择 **Data for Search** 套餐并生成 API 密钥。
+3. 将密钥存储在配置中（推荐）或在 Gateway网关环境中设置 `BRAVE_API_KEY`。
+
+## 配置示例
+
+```json5
+{
+  tools: {
+    web: {
+      search: {
+        provider: "brave",
+        apiKey: "BRAVE_API_KEY_HERE",
+        maxResults: 5,
+        timeoutSeconds: 30,
+      },
+    },
+  },
+}
+```
+
+## 说明
+
+- Data for AI 套餐与 `web_search` **不**兼容。
+- Brave 提供免费套餐和付费套餐；请查看 Brave API 门户了解当前限制。
+
+完整的 web_search 配置请参阅 [Web 工具](/tools/web)。