From 1883bf7bcd8764add4a4e04e4babf9fda4dc19db Mon Sep 17 00:00:00 2001 From: YSTYLE Date: Fri, 27 Feb 2026 10:55:14 +0800 Subject: [PATCH] docs(channels): add xiaoyi channel documentation - Add docs/channels/xiaoyi/README.zh.md and README.md - Update README.zh.md and README.md with xiaoyi channel info - Include link to Huawei official setup guide --- README.md | 3 +- README.zh.md | 1 + docs/channels/xiaoyi/README.md | 49 +++++++++++++++++++++++++++++++ docs/channels/xiaoyi/README.zh.md | 49 +++++++++++++++++++++++++++++++ 4 files changed, 101 insertions(+), 1 deletion(-) create mode 100644 docs/channels/xiaoyi/README.md create mode 100644 docs/channels/xiaoyi/README.zh.md diff --git a/README.md b/README.md index 6f5cce4d0..78b613dc5 100644 --- a/README.md +++ b/README.md @@ -288,7 +288,7 @@ That's it! You have a working AI assistant in 2 minutes. ## 💬 Chat Apps -Talk to your picoclaw through Telegram, Discord, DingTalk, LINE, or WeCom +Talk to your picoclaw through Telegram, Discord, DingTalk, LINE, WeCom, or XiaoYi | Channel | Setup | | ------------ | ---------------------------------- | @@ -298,6 +298,7 @@ Talk to your picoclaw through Telegram, Discord, DingTalk, LINE, or WeCom | **DingTalk** | Medium (app credentials) | | **LINE** | Medium (credentials + webhook URL) | | **WeCom** | Medium (CorpID + webhook setup) | +| **XiaoYi** | Medium (AK/SK + AgentID) |
Telegram (Recommended) diff --git a/README.zh.md b/README.zh.md index 7c9351cb4..40fb848cc 100644 --- a/README.zh.md +++ b/README.zh.md @@ -304,6 +304,7 @@ PicoClaw 支持多种聊天平台，使您的 Agent 能够连接到任何地方 | **Line** | ⭐⭐⭐ 较难 | 需要 HTTPS Webhook | [查看文档](docs/channels/line/README.zh.md) | | **OneBot** | ⭐⭐ 中等 | 兼容 NapCat/Go-CQHTTP，社区生态丰富 | [查看文档](docs/channels/onebot/README.zh.md) | | **MaixCam** | ⭐ 简单 | 专为 AI 摄像头设计的硬件集成通道 | [查看文档](docs/channels/maixcam/README.zh.md) | +| **小艺 (XiaoYi)** | ⭐⭐ 中等 | 华为小艺 A2A 协议，支持语音助手生态 | [查看文档](docs/channels/xiaoyi/README.zh.md) | ## ClawdChat 加入 Agent 社交网络 diff --git a/docs/channels/xiaoyi/README.md b/docs/channels/xiaoyi/README.md new file mode 100644 index 000000000..55a2a0312 --- /dev/null +++ b/docs/channels/xiaoyi/README.md @@ -0,0 +1,49 @@ +# XiaoYi (小艺) + +XiaoYi Channel enables AI agent communication via Huawei's A2A (Agent-to-Agent) protocol, supporting text messages, file attachments, streaming responses, and status updates. + +## Configuration + +```json +{ + "channels": { + "xiaoyi": { + "enabled": true, + "ak": "your-access-key", + "sk": "your-secret-key", + "agent_id": "your-agent-id", + "ws_url1": "", + "ws_url2": "", + "allow_from": [] + } + } +} +``` + +| Field | Type | Required | Description | +| ---------- | ------ | -------- | ---------------------------------------------- | +| enabled | bool | Yes | Enable XiaoYi channel | +| ak | string | Yes | Access Key | +| sk | string | Yes | Secret Key | +| agent_id | string | Yes | Agent identifier | +| ws_url1 | string | No | Server 1 URL, defaults to official server | +| ws_url2 | string | No | Server 2 URL, defaults to backup server | +| allow_from | array | No | User ID whitelist, empty allows all users | + +## Setup + +For detailed setup instructions, please refer to the official Huawei documentation: [OpenClaw Integration Guide](https://developer.huawei.com/consumer/cn/doc/service/openclaw-0000002518410344) + +1. Register and create an OpenClaw type agent on Huawei Developer Platform +2. Obtain AK (Access Key) and SK (Secret Key) +3. Get Agent ID +4. Add configuration to config file +5. Start PicoClaw, XiaoYi Channel will automatically connect to XiaoYi servers + +## Features + +- **WebSocket long connection**: Dual server hot-standby support +- **Auto-reconnect**: Exponential backoff strategy, max 50 retries +- **Heartbeat**: Protocol-level + application-level dual heartbeat +- **Streaming response**: Support progressive result return +- **Status update**: Send "processing" status immediately upon receiving message diff --git a/docs/channels/xiaoyi/README.zh.md b/docs/channels/xiaoyi/README.zh.md new file mode 100644 index 000000000..8fdf653f7 --- /dev/null +++ b/docs/channels/xiaoyi/README.zh.md @@ -0,0 +1,49 @@ +# 小艺 (XiaoYi) + +小艺 Channel 通过华为小艺 A2A (Agent-to-Agent) 协议实现智能体通信，支持文本消息、文件附件、流式响应和状态更新。 + +## 配置 + +```json +{ + "channels": { + "xiaoyi": { + "enabled": true, + "ak": "your-access-key", + "sk": "your-secret-key", + "agent_id": "your-agent-id", + "ws_url1": "", + "ws_url2": "", + "allow_from": [] + } + } +} +``` + +| 字段 | 类型 | 必填 | 描述 | +| ---------- | ------ | ---- | -------------------------------------------- | +| enabled | bool | 是 | 是否启用小艺频道 | +| ak | string | 是 | Access Key | +| sk | string | 是 | Secret Key | +| agent_id | string | 是 | Agent 标识 | +| ws_url1 | string | 否 | 服务器1 URL，默认为小艺官方服务器 | +| ws_url2 | string | 否 | 服务器2 URL，默认为小艺备用服务器 | +| allow_from | array | 否 | 用户ID白名单，空表示允许所有用户 | + +## 设置流程 + +详细教程请参考华为官方文档：[OpenClaw 接入指南](https://developer.huawei.com/consumer/cn/doc/service/openclaw-0000002518410344) + +1. 在华为开发者平台注册并创建 OpenClaw 类型的智能体 +2. 获取 AK (Access Key) 和 SK (Secret Key) +3. 获取 Agent ID +4. 将配置填入配置文件中 +5. 启动 PicoClaw，小艺 Channel 将自动连接到小艺服务器 + +## 特性 + +- **WebSocket 长连接**：支持双服务器热备 +- **自动重连**：指数退避策略，最大重试 50 次 +- **心跳机制**：协议层 + 应用层双重心跳 +- **流式响应**：支持逐步返回结果 +- **状态更新**：收到消息后立即发送"处理中"状态