mirror of
https://github.com/zhayujie/chatgpt-on-wechat.git
synced 2026-07-20 05:27:59 +08:00
docs: add Japanese documents
This commit is contained in:
Ikko Ashimine
58
docs/ja/channels/dingtalk.mdx
Normal file
58
docs/ja/channels/dingtalk.mdx
Normal file
@@ -0,0 +1,58 @@
|
||||
---
|
||||
title: DingTalk
|
||||
description: CowAgent を DingTalk アプリケーションに統合する
|
||||
---
|
||||
|
||||
DingTalk オープンプラットフォームでインテリジェントロボットアプリを作成して、CowAgent を DingTalk に統合します。
|
||||
|
||||
## 1. アプリの作成
|
||||
|
||||
1. [DingTalk 開発者コンソール](https://open-dev.dingtalk.com/fe/app#/corp/app)にアクセスし、ログインして**アプリを作成**をクリックし、アプリ情報を入力します：
|
||||
|
||||
<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-create-app.png" width="800"/>
|
||||
|
||||
2. **アプリ機能の追加**をクリックし、**ロボット**機能を選択して**追加**をクリックします：
|
||||
|
||||
<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-add-bot.png" width="800"/>
|
||||
|
||||
3. ロボット情報を設定し、**公開**をクリックします。公開後、「**デバッグ**」をクリックすると自動的にテストグループチャットが作成され、クライアントで確認できます：
|
||||
|
||||
<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-config-bot.png" width="600"/>
|
||||
|
||||
4. **バージョン管理とリリース**をクリックし、新しいバージョンを作成して公開します：
|
||||
|
||||
<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-publish-bot.png" width="700"/>
|
||||
|
||||
## 2. プロジェクト設定
|
||||
|
||||
1. **認証情報と基本情報**をクリックし、`Client ID` と `Client Secret` を取得します：
|
||||
|
||||
<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-get-secret.png" width="700"/>
|
||||
|
||||
2. プロジェクトルートの `config.json` に以下の設定を追加します：
|
||||
|
||||
```json
|
||||
{
|
||||
"channel_type": "dingtalk",
|
||||
"dingtalk_client_id": "YOUR_CLIENT_ID",
|
||||
"dingtalk_client_secret": "YOUR_CLIENT_SECRET"
|
||||
}
|
||||
```
|
||||
|
||||
3. 依存パッケージをインストールします：
|
||||
|
||||
```bash
|
||||
pip3 install dingtalk_stream
|
||||
```
|
||||
|
||||
<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-app-config.png" width="700"/>
|
||||
|
||||
4. プロジェクト起動後、DingTalk 開発者コンソールに移動し、**イベントサブスクリプション**をクリックし、**接続確認済み、チャネルを確認**をクリックします。「**接続成功**」と表示されれば設定完了です：
|
||||
|
||||
<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-event-sub.png" width="700"/>
|
||||
|
||||
## 3. 使い方
|
||||
|
||||
ロボットと個別チャットするか、企業グループに追加して会話を開始します：
|
||||
|
||||
<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/dingtalk-hosting-demo.png" width="650"/>
|
||||
69
docs/ja/channels/feishu.mdx
Normal file
69
docs/ja/channels/feishu.mdx
Normal file
@@ -0,0 +1,69 @@
|
||||
---
|
||||
title: Feishu (Lark)
|
||||
description: CowAgent を Feishu アプリケーションに統合する
|
||||
---
|
||||
|
||||
企業向けカスタムアプリを作成して、CowAgent を Feishu に統合します。管理者権限を持つ Feishu 企業ユーザーである必要があります。
|
||||
|
||||
## 1. 企業カスタムアプリの作成
|
||||
|
||||
### 1.1 アプリの作成
|
||||
|
||||
[Feishu 開発者プラットフォーム](https://open.feishu.cn/app/)にアクセスし、**企業カスタムアプリを作成**をクリックして、必要な情報を入力し**作成**をクリックします：
|
||||
|
||||
<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/feishu-hosting-create-app.jpg" width="500"/>
|
||||
|
||||
### 1.2 Bot 機能の追加
|
||||
|
||||
**アプリ機能の追加**で、アプリに **Bot** 機能を追加します：
|
||||
|
||||
<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/feishu-hosting-add-bot.jpg" width="800"/>
|
||||
|
||||
### 1.3 アプリ権限の設定
|
||||
|
||||
**権限管理**をクリックし、**権限設定**の下の入力欄に以下の権限文字列を貼り付け、フィルタされたすべての権限を選択し、**一括有効化**をクリックして確認します：
|
||||
|
||||
```
|
||||
im:message,im:message.group_at_msg,im:message.group_at_msg:readonly,im:message.p2p_msg,im:message.p2p_msg:readonly,im:message:send_as_bot,im:resource
|
||||
```
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/feishu-hosting-add-auth2.png" width="800"/>
|
||||
|
||||
## 2. プロジェクト設定
|
||||
|
||||
1. **認証情報と基本情報**から `App ID` と `App Secret` を取得します：
|
||||
|
||||
<img src="https://img-1317903499.cos.ap-guangzhou.myqcloud.com/docs/feishu-hosting-appid-secret.jpg" width="800"/>
|
||||
|
||||
2. プロジェクトルートの `config.json` に以下の設定を追加します：
|
||||
|
||||
```json
|
||||
{
|
||||
"channel_type": "feishu",
|
||||
"feishu_app_id": "YOUR_APP_ID",
|
||||
"feishu_app_secret": "YOUR_APP_SECRET",
|
||||
"feishu_bot_name": "YOUR_BOT_NAME"
|
||||
}
|
||||
```
|
||||
|
||||
| パラメータ | 説明 |
|
||||
| --- | --- |
|
||||
| `feishu_app_id` | Feishu Bot の App ID |
|
||||
| `feishu_app_secret` | Feishu Bot の App Secret |
|
||||
| `feishu_bot_name` | Bot 名（アプリ作成時に設定）、グループチャットで使用する際に必要 |
|
||||
|
||||
設定完了後、プロジェクトを起動します。
|
||||
|
||||
## 3. イベントサブスクリプションの設定
|
||||
|
||||
1. プロジェクトが正常に動作した後、Feishu 開発者プラットフォームに移動し、**イベントとコールバック**をクリックし、**ロングコネクション**モードを選択して保存をクリックします：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/202601311731183.png" width="600"/>
|
||||
|
||||
2. 下の**イベントを追加**をクリックし、「メッセージ受信」を検索して「**メッセージ受信 v2.0**」を選択し、確認します。
|
||||
|
||||
3. **バージョン管理とリリース**をクリックし、新しいバージョンを作成して**本番リリース**を申請します。Feishu クライアントで承認メッセージを確認し、承認します：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/202601311807356.png" width="600"/>
|
||||
|
||||
完了後、Feishu で Bot 名を検索してチャットを開始できます。
|
||||
88
docs/ja/channels/qq.mdx
Normal file
88
docs/ja/channels/qq.mdx
Normal file
@@ -0,0 +1,88 @@
|
||||
---
|
||||
title: QQ Bot
|
||||
description: CowAgent を QQ Bot に接続する（WebSocket ロングコネクション）
|
||||
---
|
||||
|
||||
> QQ オープンプラットフォームの Bot API を介して CowAgent を接続し、QQ のダイレクトメッセージ、グループチャット（@bot）、ギルドチャネルメッセージ、ギルド DM に対応します。パブリック IP は不要で、WebSocket ロングコネクションを使用します。
|
||||
|
||||
<Note>
|
||||
QQ Bot は QQ オープンプラットフォームを通じて作成します。WebSocket ロングコネクションでメッセージを受信し、OpenAPI でメッセージを送信します。パブリック IP やドメインは不要です。
|
||||
</Note>
|
||||
|
||||
## 1. QQ Bot の作成
|
||||
|
||||
> [QQ オープンプラットフォーム](https://q.qq.com)にアクセスし、QQ でサインインします。未登録の場合は、先に[アカウント登録](https://q.qq.com/#/register)を完了してください。
|
||||
|
||||
1.[QQ オープンプラットフォーム - Bot 一覧](https://q.qq.com/#/apps)に移動し、**Bot を作成**をクリックします：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260317162900.png" width="800"/>
|
||||
|
||||
2.Bot 名、アバター、その他の基本情報を入力して作成を完了します：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260317163005.png" width="800"/>
|
||||
|
||||
3.Bot 設定ページに入り、**開発管理**に移動して以下の手順を完了します：
|
||||
|
||||
- **AppID**（Bot ID）をコピーして保存します
|
||||
- **AppSecret**（Bot Secret）を生成して保存します
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260317164955.png" width="800"/>
|
||||
|
||||
## 2. 設定と起動
|
||||
|
||||
### 方法 A: Web コンソール
|
||||
|
||||
プログラムを起動し、Web コンソール（ローカルアクセス: http://127.0.0.1:9899/）を開きます。**チャネル**タブに移動し、**チャネルを接続**をクリックして **QQ Bot** を選択し、前のステップで取得した AppID と AppSecret を入力して接続をクリックします。
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260317165425.png" width="800"/>
|
||||
|
||||
### 方法 B: 設定ファイル
|
||||
|
||||
`config.json` に以下を追加します：
|
||||
|
||||
```json
|
||||
{
|
||||
"channel_type": "qq",
|
||||
"qq_app_id": "YOUR_APP_ID",
|
||||
"qq_app_secret": "YOUR_APP_SECRET"
|
||||
}
|
||||
```
|
||||
|
||||
| パラメータ | 説明 |
|
||||
| --- | --- |
|
||||
| `qq_app_id` | QQ Bot の AppID。オープンプラットフォームの開発管理で確認できます |
|
||||
| `qq_app_secret` | QQ Bot の AppSecret。オープンプラットフォームの開発管理で確認できます |
|
||||
|
||||
設定後、プログラムを起動します。ログに `[QQ] ✅ Connected successfully` と表示されれば接続成功です。
|
||||
|
||||
|
||||
## 3. 使い方
|
||||
|
||||
QQ オープンプラットフォームで、**管理 → 利用範囲とメンバー**に移動し、「グループとメッセージリストに追加」の QR コードを QQ クライアントでスキャンして Bot とのチャットを開始します：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260317165947.png" width="800"/>
|
||||
|
||||
チャット例:
|
||||
<img src="https://cdn.link-ai.tech/doc/20260317171508.png" width="800"/>
|
||||
|
||||
## 4. 対応機能
|
||||
|
||||
> 注意: グループチャットやギルドチャネルで QQ Bot を使用するには、公開審査を完了し、利用範囲の権限を設定する必要があります。
|
||||
|
||||
| 機能 | 状態 |
|
||||
| --- | --- |
|
||||
| QQ ダイレクトメッセージ | ✅ |
|
||||
| QQ グループチャット（@bot） | ✅ |
|
||||
| ギルドチャネル（@bot） | ✅ |
|
||||
| ギルド DM | ✅ |
|
||||
| テキストメッセージ | ✅ 送受信 |
|
||||
| 画像メッセージ | ✅ 送受信（グループ・ダイレクト） |
|
||||
| ファイルメッセージ | ✅ 送信（グループ・ダイレクト） |
|
||||
| スケジュールタスク | ✅ 能動的プッシュ（ユーザーあたり月4回） |
|
||||
|
||||
|
||||
## 5. 注意事項
|
||||
|
||||
- **受動メッセージの制限**: QQ ダイレクトメッセージの返信は60分間有効です（1メッセージあたり最大5回返信可能）。グループチャットの返信は5分間有効です。
|
||||
- **能動メッセージの制限**: ダイレクトメッセージとグループチャットの両方で、月あたりの能動メッセージは4件までです。スケジュールタスク機能を使用する際はこの点にご注意ください。
|
||||
- **イベント権限**: デフォルトでは `GROUP_AND_C2C_EVENT`（QQ グループ/ダイレクト）と `PUBLIC_GUILD_MESSAGES`（ギルド公開メッセージ）がサブスクライブされています。追加の権限が必要な場合は、オープンプラットフォームで申請してください。
|
||||
75
docs/ja/channels/web.mdx
Normal file
75
docs/ja/channels/web.mdx
Normal file
@@ -0,0 +1,75 @@
|
||||
---
|
||||
title: Web コンソール
|
||||
description: Web コンソールで CowAgent を使用する
|
||||
---
|
||||
|
||||
Web コンソールは CowAgent のデフォルトチャネルです。起動後に自動的に開始され、ブラウザを通じて Agent とチャットしたり、モデル、Skill、メモリ、チャネルなどの設定をオンラインで管理できます。
|
||||
|
||||
## 設定
|
||||
|
||||
```json
|
||||
{
|
||||
"channel_type": "web",
|
||||
"web_port": 9899
|
||||
}
|
||||
```
|
||||
|
||||
| パラメータ | 説明 | デフォルト値 |
|
||||
| --- | --- | --- |
|
||||
| `channel_type` | `web` に設定 | `web` |
|
||||
| `web_port` | Web サービスのリスンポート | `9899` |
|
||||
|
||||
## アクセス URL
|
||||
|
||||
プロジェクト起動後、以下にアクセスしてください：
|
||||
|
||||
- ローカル: `http://localhost:9899`
|
||||
- サーバー: `http://<server-ip>:9899`
|
||||
|
||||
<Note>
|
||||
サーバーのファイアウォールとセキュリティグループで該当ポートが許可されていることを確認してください。
|
||||
</Note>
|
||||
|
||||
## 機能
|
||||
|
||||
### チャット画面
|
||||
|
||||
ストリーミング出力に対応しており、Agent の推論プロセスやツール呼び出しをリアルタイムで表示し、Agent の意思決定を直感的に観察できます：
|
||||
|
||||
<img width="850" src="https://cdn.link-ai.tech/doc/20260227180120.png" />
|
||||
|
||||
### モデル管理
|
||||
|
||||
設定ファイルを手動で編集せずに、オンラインでモデル設定を管理できます：
|
||||
|
||||
<img width="850" src="https://cdn.link-ai.tech/doc/20260227173811.png" />
|
||||
|
||||
### Skill 管理
|
||||
|
||||
Agent の Skill をオンラインで閲覧・管理できます：
|
||||
|
||||
<img width="850" src="https://cdn.link-ai.tech/doc/20260227173403.png" />
|
||||
|
||||
### メモリ管理
|
||||
|
||||
Agent のメモリをオンラインで閲覧・管理できます：
|
||||
|
||||
<img width="850" src="https://cdn.link-ai.tech/doc/20260227173349.png" />
|
||||
|
||||
### チャネル管理
|
||||
|
||||
接続中のチャネルをオンラインで管理し、リアルタイムで接続・切断操作を行えます：
|
||||
|
||||
<img width="850" src="https://cdn.link-ai.tech/doc/20260227173331.png" />
|
||||
|
||||
### スケジュールタスク
|
||||
|
||||
スケジュールタスクをオンラインで閲覧・管理できます。一回限りのタスク、固定間隔、Cron 式に対応しています：
|
||||
|
||||
<img width="850" src="https://cdn.link-ai.tech/doc/20260227173704.png" />
|
||||
|
||||
### ログ
|
||||
|
||||
Agent のランタイムログをリアルタイムで確認でき、監視やトラブルシューティングに活用できます：
|
||||
|
||||
<img width="850" src="https://cdn.link-ai.tech/doc/20260227173514.png" />
|
||||
72
docs/ja/channels/wechatmp.mdx
Normal file
72
docs/ja/channels/wechatmp.mdx
Normal file
@@ -0,0 +1,72 @@
|
||||
---
|
||||
title: WeChat 公式アカウント
|
||||
description: CowAgent を WeChat 公式アカウントに統合する
|
||||
---
|
||||
|
||||
CowAgent は個人サブスクリプションアカウントと企業サービスアカウントの両方に対応しています。
|
||||
|
||||
| 種類 | 要件 | 特徴 |
|
||||
| --- | --- | --- |
|
||||
| **個人サブスクリプション** | 個人で利用可能 | まずプレースホルダーの返信を送信し、ユーザーが完全な応答を取得するにはメッセージを送信する必要があります |
|
||||
| **企業サービス** | カスタマーサービス API が認証済みの企業 | ユーザーに能動的に返信をプッシュできます |
|
||||
|
||||
<Note>
|
||||
公式アカウントはサーバーおよび Docker デプロイのみサポートしており、ローカル実行モードには対応していません。拡張依存パッケージをインストールしてください: `pip3 install -r requirements-optional.txt`
|
||||
</Note>
|
||||
|
||||
## 1. 個人サブスクリプションアカウント
|
||||
|
||||
`config.json` に以下の設定を追加します：
|
||||
|
||||
```json
|
||||
{
|
||||
"channel_type": "wechatmp",
|
||||
"single_chat_prefix": [""],
|
||||
"wechatmp_app_id": "wx73f9******d1e48",
|
||||
"wechatmp_app_secret": "YOUR_APP_SECRET",
|
||||
"wechatmp_aes_key": "",
|
||||
"wechatmp_token": "YOUR_TOKEN",
|
||||
"wechatmp_port": 80
|
||||
}
|
||||
```
|
||||
|
||||
### セットアップ手順
|
||||
|
||||
これらの設定は [WeChat 公式アカウントプラットフォーム](https://mp.weixin.qq.com/advanced/advanced?action=dev&t=advanced/dev)と一致している必要があります。**設定と開発 → 基本設定 → サーバー設定**に移動し、以下のように設定します：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260228103506.png" width="480"/>
|
||||
|
||||
1. プラットフォームで開発者シークレットを有効化し（`wechatmp_app_secret` に対応）、サーバー IP をホワイトリストに追加します
|
||||
2. プラットフォームの設定と一致するように公式アカウントのパラメータを `config.json` に入力します
|
||||
3. プログラムを起動します。ポート 80 でリスンします（権限がない場合は `sudo` を使用してください。ポート 80 を占有しているプロセスがあれば停止してください）
|
||||
4. 公式アカウントプラットフォームで**サーバー設定を有効化**して送信します。正常に保存できれば設定完了です。**「サーバー URL」**は `http://{HOST}/wx` の形式で入力する必要があり、`{HOST}` にはサーバー IP またはドメインを指定できます
|
||||
|
||||
アカウントをフォローしてメッセージを送信すると、以下のような結果が表示されるはずです：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260228103522.png" width="720"/>
|
||||
|
||||
サブスクリプションアカウントの制限により、短い返信（15秒以内）は即座に返されますが、長い返信の場合はまず「考え中...」というプレースホルダーが送信され、ユーザーは任意のテキストを送信して回答を取得する必要があります。企業サービスアカウントではカスタマーサービス API を使用してこの問題を解決できます。
|
||||
|
||||
<Tip>
|
||||
**音声認識**: WeChat 内蔵の音声認識を使用できます。公式アカウント管理ページの「設定と開発 → API 権限」で「音声認識結果の受信」を有効にしてください。
|
||||
</Tip>
|
||||
|
||||
## 2. 企業サービスアカウント
|
||||
|
||||
企業サービスアカウントのセットアップ手順は個人サブスクリプションアカウントとほぼ同じですが、以下の点が異なります：
|
||||
|
||||
1. プラットフォームで企業サービスアカウントを登録し、WeChat 認証を完了します。**カスタマーサービス API** の権限が付与されていることを確認してください
|
||||
2. `config.json` で `"channel_type": "wechatmp_service"` に設定します。その他の設定は同じです
|
||||
3. 長い返信であっても、ユーザーに能動的にプッシュでき、手動での取得が不要です
|
||||
|
||||
```json
|
||||
{
|
||||
"channel_type": "wechatmp_service",
|
||||
"single_chat_prefix": [""],
|
||||
"wechatmp_app_id": "YOUR_APP_ID",
|
||||
"wechatmp_app_secret": "YOUR_APP_SECRET",
|
||||
"wechatmp_aes_key": "",
|
||||
"wechatmp_token": "YOUR_TOKEN",
|
||||
"wechatmp_port": 80
|
||||
}
|
||||
```
|
||||
73
docs/ja/channels/wecom-bot.mdx
Normal file
73
docs/ja/channels/wecom-bot.mdx
Normal file
@@ -0,0 +1,73 @@
|
||||
---
|
||||
title: WeCom Bot
|
||||
description: CowAgent を WeCom AI Bot に接続する（WebSocket ロングコネクション）
|
||||
---
|
||||
|
||||
WeCom AI Bot を介して CowAgent を接続し、ダイレクトメッセージとグループチャットの両方に対応します。パブリック IP は不要で、WebSocket ロングコネクションを使用し、Markdown レンダリングとストリーミング出力をサポートします。
|
||||
|
||||
<Note>
|
||||
WeCom Bot と WeCom App は異なる統合方式です。WeCom Bot は WebSocket ロングコネクションを使用するため、パブリック IP やドメインが不要で、セットアップが簡単です。
|
||||
</Note>
|
||||
|
||||
## 1. AI Bot の作成
|
||||
|
||||
1. WeCom クライアントを開き、**ワークベンチ**に移動し、**AI Bot** をクリックします：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260316180959.png" width="800"/>
|
||||
|
||||
2. **Bot を作成** → **手動作成**をクリックします：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260316181118.png" width="600"/>
|
||||
|
||||
3. 右パネルの一番下までスクロールし、**API モード**を選択します：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260316181215.png" width="600"/>
|
||||
|
||||
4. Bot 名、アバター、公開範囲を設定します。**ロングコネクション**モードを選択し、**Bot ID** と **Secret** をメモしてから保存をクリックします。
|
||||
|
||||
## 2. 設定
|
||||
|
||||
### 方法 A: Web コンソール
|
||||
|
||||
プログラムを起動し、Web コンソール（ローカルアクセス: http://127.0.0.1:9899）を開きます。**チャネル**タブに移動し、**チャネルを接続**をクリックして **WeCom Bot** を選択し、前のステップで取得した Bot ID と Secret を入力して接続をクリックします。
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260316181711.png" width="600"/>
|
||||
|
||||
### 方法 B: 設定ファイル
|
||||
|
||||
`config.json` に以下を追加します：
|
||||
|
||||
```json
|
||||
{
|
||||
"channel_type": "wecom_bot",
|
||||
"wecom_bot_id": "YOUR_BOT_ID",
|
||||
"wecom_bot_secret": "YOUR_SECRET"
|
||||
}
|
||||
```
|
||||
|
||||
| パラメータ | 説明 |
|
||||
| --- | --- |
|
||||
| `wecom_bot_id` | AI Bot の Bot ID |
|
||||
| `wecom_bot_secret` | AI Bot の Secret |
|
||||
|
||||
設定後、プログラムを起動します。ログに `[WecomBot] Subscribe success` と表示されれば接続成功です。
|
||||
|
||||
## 3. 対応機能
|
||||
|
||||
| 機能 | 状態 |
|
||||
| --- | --- |
|
||||
| ダイレクトメッセージ | ✅ |
|
||||
| グループチャット（@bot） | ✅ |
|
||||
| テキストメッセージ | ✅ 送受信 |
|
||||
| 画像メッセージ | ✅ 送受信 |
|
||||
| ファイルメッセージ | ✅ 送受信 |
|
||||
| ストリーミング返信 | ✅ |
|
||||
| スケジュール配信 | ✅ |
|
||||
|
||||
## 4. 使い方
|
||||
|
||||
WeCom で Bot 名を検索してダイレクトメッセージを開始できます。
|
||||
|
||||
グループチャットで使用するには、Bot をグループに追加し、@メンションしてメッセージを送信します。
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260316182902.png" width="800"/>
|
||||
98
docs/ja/channels/wecom.mdx
Normal file
98
docs/ja/channels/wecom.mdx
Normal file
@@ -0,0 +1,98 @@
|
||||
---
|
||||
title: WeCom
|
||||
description: CowAgent を WeCom 企業アプリに統合する
|
||||
---
|
||||
|
||||
カスタム企業アプリを通じて CowAgent を WeCom に統合し、社内従業員との1対1チャットに対応します。
|
||||
|
||||
<Note>
|
||||
WeCom は Docker デプロイまたはサーバー上の Python デプロイのみサポートしています。ローカル実行モードには対応していません。
|
||||
</Note>
|
||||
|
||||
## 1. 前提条件
|
||||
|
||||
必要なリソース：
|
||||
|
||||
1. パブリック IP を持つサーバー（海外サーバー、または国際 API アクセス用のプロキシを持つ国内サーバー）
|
||||
2. 登録済みの WeCom アカウント（個人登録は可能ですが認証はできません）
|
||||
3. 認証済みの WeCom アカウントには、対応する法人名義で届け出済みのドメインが別途必要です
|
||||
|
||||
## 2. WeCom アプリの作成
|
||||
|
||||
1. [WeCom 管理コンソール](https://work.weixin.qq.com/wework_admin/frame#profile)で、**自社情報**をクリックし、ページ下部の **Corp ID** を確認します。この ID を `wechatcom_corp_id` 設定フィールド用に保存します。
|
||||
|
||||
2. **アプリ管理**に切り替え、アプリを作成をクリックします：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260228103156.png" width="480"/>
|
||||
|
||||
3. アプリ作成ページで、`AgentId` と `Secret` を記録します：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260228103218.png" width="580"/>
|
||||
|
||||
4. **API 受信設定**をクリックしてアプリケーションインターフェースを設定します：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260228103211.png" width="520"/>
|
||||
|
||||
- URL の形式: `http://ip:port/wxcomapp`（認証済み企業は届け出済みドメインを使用する必要があります）
|
||||
- ランダムな `Token` と `EncodingAESKey` を生成し、設定ファイル用に保存します
|
||||
|
||||
<Note>
|
||||
プログラムがまだ起動していないため、この時点では API 受信設定を保存できません。プロジェクトが動作した後に戻って保存してください。
|
||||
</Note>
|
||||
|
||||
## 3. 設定と起動
|
||||
|
||||
`config.json` に以下の設定を追加します（各パラメータと WeCom コンソールの対応関係は上のスクリーンショットを参照してください）：
|
||||
|
||||
```json
|
||||
{
|
||||
"channel_type": "wechatcom_app",
|
||||
"single_chat_prefix": [""],
|
||||
"wechatcom_corp_id": "YOUR_CORP_ID",
|
||||
"wechatcomapp_token": "YOUR_TOKEN",
|
||||
"wechatcomapp_secret": "YOUR_SECRET",
|
||||
"wechatcomapp_agent_id": "YOUR_AGENT_ID",
|
||||
"wechatcomapp_aes_key": "YOUR_AES_KEY",
|
||||
"wechatcomapp_port": 9898
|
||||
}
|
||||
```
|
||||
|
||||
| パラメータ | 説明 |
|
||||
| --- | --- |
|
||||
| `wechatcom_corp_id` | Corp ID |
|
||||
| `wechatcomapp_token` | API 受信設定の Token |
|
||||
| `wechatcomapp_secret` | アプリの Secret |
|
||||
| `wechatcomapp_agent_id` | アプリの AgentId |
|
||||
| `wechatcomapp_aes_key` | API 受信設定の EncodingAESKey |
|
||||
| `wechatcomapp_port` | リスンポート、デフォルトは 9898 |
|
||||
|
||||
設定後、プログラムを起動します。ログに `http://0.0.0.0:9898/` と表示されれば、プログラムは正常に動作しています。このポートを外部に公開する必要があります（例：クラウドサーバーのセキュリティグループで許可します）。
|
||||
|
||||
プログラム起動後、WeCom 管理コンソールに戻って**メッセージサーバー設定**を保存します。保存が成功したら、サーバー IP を**企業の信頼済み IP** に追加する必要もあります。追加しないとメッセージの送受信ができません：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260228103224.png" width="520"/>
|
||||
|
||||
<Warning>
|
||||
URL 設定のコールバックが失敗する場合や、設定がうまくいかない場合：
|
||||
1. サーバーのファイアウォールが無効になっており、セキュリティグループでリスンポートが許可されていることを確認してください
|
||||
2. Token、Secret Key などのパラメータ設定が一致しているか、URL の形式が正しいか慎重に確認してください
|
||||
3. 認証済みの WeCom アカウントは、法人に対応する届け出済みドメインを設定する必要があります
|
||||
</Warning>
|
||||
|
||||
## 4. 使い方
|
||||
|
||||
WeCom で作成したアプリ名を検索して、直接チャットを開始できます。異なるポートでリスンする複数のインスタンスを実行して、複数の WeCom アプリを作成できます：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260228103228.png" width="720"/>
|
||||
|
||||
外部の個人 WeChat ユーザーにアプリを利用してもらうには、**自社情報 → WeChat プラグイン**に移動し、招待 QR コードを共有します。スキャンしてフォローした後、個人 WeChat ユーザーがアプリとチャットできるようになります：
|
||||
|
||||
<img src="https://cdn.link-ai.tech/doc/20260228103232.png" width="520"/>
|
||||
|
||||
## FAQ
|
||||
|
||||
以下の依存パッケージがインストールされていることを確認してください：
|
||||
|
||||
```bash
|
||||
pip install websocket-client pycryptodome
|
||||
```
|
||||
Reference in New Issue
Block a user