mirror of
https://github.com/langbot-app/LangBot.git
synced 2026-11-05 07:12:02 +08:00
docs: update platform and usage documentation across multiple languagesDingTalk, Discord, and WeCom
This commit is contained in:
Junyan Qin
@@ -1,34 +1,3 @@
|
||||
# ナレッジベースの使用
|
||||
|
||||
LangBotはRAG(Retrieval-Augmented Generation)をネイティブサポートしています。組み込みナレッジベースを作成してパイプラインにバインドすることで、ナレッジベースの内容に基づいて質問に答えることができます。LangBotは外部のナレッジ検索サービス(例: Dify、RAGFlow)への接続もサポートしています。
|
||||
|
||||
## 組み込みナレッジベースの構築
|
||||
|
||||
:::info
|
||||
- 組み込みナレッジベースの作成と使用には、まず埋め込みモデルの設定が必要です。[モデルの設定](/en/deploy/models/readme)をお読みください。
|
||||
:::
|
||||
|
||||
ナレッジベースページで`ナレッジベースを作成`ボタンをクリックし、名前を入力し、既に設定済みの埋め込みモデルを選択してから`作成`をクリックします。
|
||||
作成後、ナレッジベースの「ドキュメント」タブに移動してドキュメントをアップロードします。LangBotはバックグラウンドで自動的に解析とインデックス化を行います。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/upload_docs.png" alt="create_kb" />
|
||||
|
||||
## 外部ナレッジベースの接続
|
||||
|
||||
ナレッジベースページで「外部ナレッジベース」タブに切り替え、外部リトリーバーを追加します。ダイアログで使用するナレッジリトリーバープラグインを選択します(関連プラグインをプラグイン管理で事前にインストールしてください)。サポートされているリトリーバーは[プラグインマーケットプレイス](https://space.langbot.app/market?category=KnowledgeRetriever)で確認できます。
|
||||
|
||||
## ナレッジベースの使用
|
||||
|
||||
パイプライン設定に移動し、「AI」タブで`Local Agent`をランナーとして選択してから、先ほど作成したナレッジベースを選択します。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/use_local_agent.png" alt="use_kb" />
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/use_kb.png" alt="use_kb" />
|
||||
|
||||
:::info
|
||||
LangBotの組み込みナレッジベースは、ランナーが`Local Agent`に設定されている場合にのみ使用できます。他のランナーについては、それぞれのドキュメントを参照してください。
|
||||
:::
|
||||
|
||||
これで`チャットデバッグ`でナレッジベースを使用したり、このパイプラインにリンクされたボットを通じて使用できます:
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/use_kb_in_chat.png" alt="use_kb_in_chat" />
|
||||
<script setup>
|
||||
window.location.href = '/ja/usage/knowledge/readme'
|
||||
</script>
|
||||
|
||||
@@ -1,47 +1,3 @@
|
||||
# モデルの設定(Models)
|
||||
|
||||
## 対話モデル (LLM Model)
|
||||
|
||||
モデルはパイプラインによってメッセージ処理に使用されます。最初に設定したモデルがデフォルトパイプラインのモデルとして設定されます。
|
||||
|
||||
|
||||
|
||||
複数のモデルを追加して、パイプラインでどのモデルを使用するかを選択できます。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/models/model_config.png" alt="model_config" />
|
||||
|
||||
これら4つのパラメータを入力します: `モデル名`、`モデルプロバイダー`、`リクエストURL`、`APIキー`、そして送信します。
|
||||
|
||||
モデルの機能については、特定のモデルの特性に応じて選択してください:
|
||||
|
||||
- ビジュアル機能: 画像を認識するために有効にする必要があります
|
||||
|
||||
- Function Calling: 会話でAgentツールを使用するために有効にする必要があります
|
||||
|
||||
:::info
|
||||
|
||||
*APIキーをお持ちでない場合は、[このリレーステーションから入手できます](https://api.qhaigc.net/)*
|
||||
|
||||
サードパーティのAPIリレーや他のモデルプロバイダーを使用する必要がある場合、
|
||||
|
||||
`OpenAI`を選択してください
|
||||
|
||||
リクエストURLにリレーのBase URLを入力します。例:
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/models/other_provider.png" alt="other_provider" />
|
||||
|
||||
:::
|
||||
|
||||
## 埋め込みモデル (Embedding Model)
|
||||
|
||||
埋め込みモデルはメッセージのベクトル表現を計算するために使用されます。ナレッジベースを使用する場合は、このモデルを設定してください。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/models/embedding_model.png" alt="embedding_model" />
|
||||
|
||||
これら4つのパラメータを入力します: `モデル名`、`モデルプロバイダー`、`リクエストURL`、`APIキー`、そして送信します。その後、ナレッジベースでこのモデルを使用するように設定してください。
|
||||
|
||||
### seekdb内蔵埋め込みモデルの使用（ゼロ設定）
|
||||
システムにはseekdbが提供する公式埋め込みモデルが統合されており、パラメータの入力は不要です。
|
||||
- 「埋め込みモデル」ページで「seekdb-内蔵」を選択します；
|
||||
- 「保存」をクリックするとすぐに使用できます；
|
||||
- その後、ナレッジベースでこのモデルを選択すると有効になります。
|
||||
<script setup>
|
||||
window.location.href = '/ja/usage/models/readme'
|
||||
</script>
|
||||
|
||||
@@ -1,53 +1,3 @@
|
||||
# 対話パイプライン設定の変更(Pipelines)
|
||||
|
||||
パイプラインは、メッセージを受信した後の処理フローと、大規模言語モデルとの情報交換を制御します。各ボットは1つのパイプラインにバインドでき、同じパイプラインは複数のボットにバインドできます。
|
||||
|
||||
LangBotは最初の起動時にデフォルトパイプラインを自動的に作成します。ボットを作成すると、自動的にデフォルトパイプラインにバインドされます。最初のモデルを作成すると、自動的にデフォルトパイプラインのモデルとして設定されます。
|
||||
|
||||
|
||||
|
||||
異なるシナリオに適応するために、異なるボット用に複数のパイプラインを作成できます。
|
||||
|
||||
|
||||
|
||||
現在、パイプラインでは以下の機能を設定できます:
|
||||
|
||||
## AI機能
|
||||
|
||||
以下を選択して使用できます: `組み込みエージェント`、[`Dify`](https://dify.ai/)、[`n8n`](https://n8n.io/)
|
||||
|
||||
AI機能は主に2つの部分に分かれています: ランナーの選択とランナーパラメータの設定。
|
||||
|
||||
ランナーは、メッセージを処理するために大規模モデルをスケジュールする方法を定義します。デフォルトは`組み込みエージェント`で、これはLangBotによって実装された複数ラウンドのエージェント戦略です。このランナーが選択されている場合のみ、LangBot内で設定されたモデルとツールが使用されます。
|
||||
|
||||
*<!--  -->*
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/pipelines/edit_pipeline_ai.png" alt="edit_pipeline" />
|
||||
|
||||
`Dify`、[`n8n`](https://n8n.io/)などの外部LLMOpsプラットフォームを使用することもできます。この場合、使用されるモデル、プロンプト、ツール、その他のリソースはLLMOpsプラットフォームによって提供されます。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/pipelines/more_runner.png" alt="more_runner" />
|
||||
|
||||
- Difyへの接続の詳細手順は、[チュートリアルを参照](/en/deploy/pipelines/dify.html)してください。
|
||||
- n8nへの接続の詳細手順は、[チュートリアルを参照](/en/deploy/pipelines/n8n.html)してください。
|
||||
|
||||
### 会話変数
|
||||
外部LLMOpsプラットフォームを使用する場合、LangBotは以下のパラメータを明示的に渡します。これらをLLMOpsプラットフォームワークフローの開始ノードに追加できます(以下の画像はDifyの例です):
|
||||
|
||||
- `launcher_type`: ランチャーオブジェクトタイプ、プライベートチャットの場合は`person`、グループチャットの場合は`group`
|
||||
- `launcher_id`: ランチャーオブジェクトID、プライベートチャットの場合はユーザーID、グループチャットの場合はグループID
|
||||
- `sender_id`: 送信者ID
|
||||
- `user_message_text`: ユーザーメッセージのプレーンテキスト
|
||||
- `session_id`: ユーザーセッションID、プライベートチャットの場合は`person_<id>`、グループチャットの場合は`group_<id>`
|
||||
- `conversation_id`: 文字列、ユーザーセッションID、LangBotによって生成されます。ユーザーがセッションをリセットした後に再生成されます
|
||||
- `msg_create_time`: 数値型、このメッセージが受信されたタイムスタンプ(秒)
|
||||
- `group_name`: グループ名、グループメッセージを受信した場合のみ設定されます
|
||||
- `sender_name`: 送信者名
|
||||
|
||||
[プラグインを通じて任意の変数をカスタマイズできます](/en/plugin/dev/apis/common.html#set-request-variables)。
|
||||
|
||||
|
||||
|
||||
## その他の設定
|
||||
|
||||
設定フォームの説明を参照してください。
|
||||
<script setup>
|
||||
window.location.href = '/ja/usage/pipelines/readme'
|
||||
</script>
|
||||
|
||||
@@ -1,22 +1,3 @@
|
||||
# ボットの設定（Bots）
|
||||
|
||||
ボットは、メッセージングプラットフォームからメッセージイベントを受信し、パイプラインを呼び出してメッセージを処理するために使用されます。
|
||||
|
||||
|
||||
|
||||
|
||||
| プラットフォーム | ステータス | 備考 | チュートリアル |
|
||||
| ------ | ---- | ---- | ---- |
|
||||
| Discord | ✅ | | [チュートリアル](/en/deploy/platforms/discord) |
|
||||
| Telegram | ✅ | | [チュートリアル](/en/deploy/platforms/telegram) |
|
||||
| Slack | ✅ | | [チュートリアル](/en/deploy/platforms/slack) |
|
||||
| LINE | ✅ | | [チュートリアル](/en/deploy/platforms/line) |
|
||||
| KOOK | ✅ | | [チュートリアル](/en/deploy/platforms/kook) |
|
||||
| Lark | ✅ | | [チュートリアル](/en/deploy/platforms/lark) |
|
||||
| DingTalk | ✅ | | [チュートリアル](/en/deploy/platforms/dingtalk) |
|
||||
| WeCom（Enterprise WeChat） | ✅ | 企業内部ボット | [チュートリアル](/en/deploy/platforms/wecom/wecom) |
|
||||
| WeCom Intelligent Bot | ✅ | wecom インテリジェントボット | [チュートリアル](/en/deploy/platforms/wecom/wecombot) |
|
||||
| WeCom Customer Service | ✅ | 企業外部ボット | [チュートリアル](/en/deploy/platforms/wecom/wecomcs) |
|
||||
| WeChat Official Account | ✅ | WeChat 公式プラットフォームボット | [チュートリアル](/en/deploy/platforms/wxoa) |
|
||||
| OneBot v11 | ✅ | 個人 QQ アカウントをボットとして使用し、独立したプロトコルクライアントが必要です。OneBot v11 をサポートします | [NapCat](/en/deploy/platforms/qq/aiocqhttp/napcat) <br> [Lagrange](/en/deploy/platforms/qq/aiocqhttp/lagrange) <br> [LiteLoaderQQNT](/en/deploy/platforms/qq/aiocqhttp/llonebot) |
|
||||
| QQ Official Bot | ✅ | QQ Open Platform ボット API に接続します | [チュートリアル](/en/deploy/platforms/qq/official_webhook) |
|
||||
<script setup>
|
||||
window.location.href = '/ja/usage/platforms/readme'
|
||||
</script>
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
# ナレッジベースの使用
|
||||
|
||||
LangBotはRAG(Retrieval-Augmented Generation)をネイティブサポートしています。組み込みナレッジベースを作成してパイプラインにバインドすることで、ナレッジベースの内容に基づいて質問に答えることができます。LangBotは外部のナレッジ検索サービス(例: Dify、RAGFlow)への接続もサポートしています。
|
||||
|
||||
## 組み込みナレッジベースの構築
|
||||
|
||||
:::info
|
||||
- 組み込みナレッジベースの作成と使用には、まず埋め込みモデルの設定が必要です。[モデルの設定](/en/deploy/models/readme)をお読みください。
|
||||
:::
|
||||
|
||||
ナレッジベースページで`ナレッジベースを作成`ボタンをクリックし、名前を入力し、既に設定済みの埋め込みモデルを選択してから`作成`をクリックします。
|
||||
作成後、ナレッジベースの「ドキュメント」タブに移動してドキュメントをアップロードします。LangBotはバックグラウンドで自動的に解析とインデックス化を行います。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/upload_docs.png" alt="create_kb" />
|
||||
|
||||
## 外部ナレッジベースの接続
|
||||
|
||||
ナレッジベースページで「外部ナレッジベース」タブに切り替え、外部リトリーバーを追加します。ダイアログで使用するナレッジリトリーバープラグインを選択します(関連プラグインをプラグイン管理で事前にインストールしてください)。サポートされているリトリーバーは[プラグインマーケットプレイス](https://space.langbot.app/market?category=KnowledgeRetriever)で確認できます。
|
||||
|
||||
## ナレッジベースの使用
|
||||
|
||||
パイプライン設定に移動し、「AI」タブで`Local Agent`をランナーとして選択してから、先ほど作成したナレッジベースを選択します。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/use_local_agent.png" alt="use_kb" />
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/use_kb.png" alt="use_kb" />
|
||||
|
||||
:::info
|
||||
LangBotの組み込みナレッジベースは、ランナーが`Local Agent`に設定されている場合にのみ使用できます。他のランナーについては、それぞれのドキュメントを参照してください。
|
||||
:::
|
||||
|
||||
これで`チャットデバッグ`でナレッジベースを使用したり、このパイプラインにリンクされたボットを通じて使用できます:
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/knowledge/use_kb_in_chat.png" alt="use_kb_in_chat" />
|
||||
@@ -0,0 +1,47 @@
|
||||
# モデルの設定(Models)
|
||||
|
||||
## 対話モデル (LLM Model)
|
||||
|
||||
モデルはパイプラインによってメッセージ処理に使用されます。最初に設定したモデルがデフォルトパイプラインのモデルとして設定されます。
|
||||
|
||||
|
||||
|
||||
複数のモデルを追加して、パイプラインでどのモデルを使用するかを選択できます。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/models/model_config.png" alt="model_config" />
|
||||
|
||||
これら4つのパラメータを入力します: `モデル名`、`モデルプロバイダー`、`リクエストURL`、`APIキー`、そして送信します。
|
||||
|
||||
モデルの機能については、特定のモデルの特性に応じて選択してください:
|
||||
|
||||
- ビジュアル機能: 画像を認識するために有効にする必要があります
|
||||
|
||||
- Function Calling: 会話でAgentツールを使用するために有効にする必要があります
|
||||
|
||||
:::info
|
||||
|
||||
*APIキーをお持ちでない場合は、[このリレーステーションから入手できます](https://api.qhaigc.net/)*
|
||||
|
||||
サードパーティのAPIリレーや他のモデルプロバイダーを使用する必要がある場合、
|
||||
|
||||
`OpenAI`を選択してください
|
||||
|
||||
リクエストURLにリレーのBase URLを入力します。例:
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/models/other_provider.png" alt="other_provider" />
|
||||
|
||||
:::
|
||||
|
||||
## 埋め込みモデル (Embedding Model)
|
||||
|
||||
埋め込みモデルはメッセージのベクトル表現を計算するために使用されます。ナレッジベースを使用する場合は、このモデルを設定してください。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/models/embedding_model.png" alt="embedding_model" />
|
||||
|
||||
これら4つのパラメータを入力します: `モデル名`、`モデルプロバイダー`、`リクエストURL`、`APIキー`、そして送信します。その後、ナレッジベースでこのモデルを使用するように設定してください。
|
||||
|
||||
### seekdb内蔵埋め込みモデルの使用（ゼロ設定）
|
||||
システムにはseekdbが提供する公式埋め込みモデルが統合されており、パラメータの入力は不要です。
|
||||
- 「埋め込みモデル」ページで「seekdb-内蔵」を選択します；
|
||||
- 「保存」をクリックするとすぐに使用できます；
|
||||
- その後、ナレッジベースでこのモデルを選択すると有効になります。
|
||||
@@ -0,0 +1,53 @@
|
||||
# 対話パイプライン設定の変更(Pipelines)
|
||||
|
||||
パイプラインは、メッセージを受信した後の処理フローと、大規模言語モデルとの情報交換を制御します。各ボットは1つのパイプラインにバインドでき、同じパイプラインは複数のボットにバインドできます。
|
||||
|
||||
LangBotは最初の起動時にデフォルトパイプラインを自動的に作成します。ボットを作成すると、自動的にデフォルトパイプラインにバインドされます。最初のモデルを作成すると、自動的にデフォルトパイプラインのモデルとして設定されます。
|
||||
|
||||
|
||||
|
||||
異なるシナリオに適応するために、異なるボット用に複数のパイプラインを作成できます。
|
||||
|
||||
|
||||
|
||||
現在、パイプラインでは以下の機能を設定できます:
|
||||
|
||||
## AI機能
|
||||
|
||||
以下を選択して使用できます: `組み込みエージェント`、[`Dify`](https://dify.ai/)、[`n8n`](https://n8n.io/)
|
||||
|
||||
AI機能は主に2つの部分に分かれています: ランナーの選択とランナーパラメータの設定。
|
||||
|
||||
ランナーは、メッセージを処理するために大規模モデルをスケジュールする方法を定義します。デフォルトは`組み込みエージェント`で、これはLangBotによって実装された複数ラウンドのエージェント戦略です。このランナーが選択されている場合のみ、LangBot内で設定されたモデルとツールが使用されます。
|
||||
|
||||
*<!--  -->*
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/pipelines/edit_pipeline_ai.png" alt="edit_pipeline" />
|
||||
|
||||
`Dify`、[`n8n`](https://n8n.io/)などの外部LLMOpsプラットフォームを使用することもできます。この場合、使用されるモデル、プロンプト、ツール、その他のリソースはLLMOpsプラットフォームによって提供されます。
|
||||
|
||||
<img width="400px" src="/assets/image/zh/deploy/pipelines/more_runner.png" alt="more_runner" />
|
||||
|
||||
- Difyへの接続の詳細手順は、[チュートリアルを参照](/en/deploy/pipelines/dify.html)してください。
|
||||
- n8nへの接続の詳細手順は、[チュートリアルを参照](/en/deploy/pipelines/n8n.html)してください。
|
||||
|
||||
### 会話変数
|
||||
外部LLMOpsプラットフォームを使用する場合、LangBotは以下のパラメータを明示的に渡します。これらをLLMOpsプラットフォームワークフローの開始ノードに追加できます(以下の画像はDifyの例です):
|
||||
|
||||
- `launcher_type`: ランチャーオブジェクトタイプ、プライベートチャットの場合は`person`、グループチャットの場合は`group`
|
||||
- `launcher_id`: ランチャーオブジェクトID、プライベートチャットの場合はユーザーID、グループチャットの場合はグループID
|
||||
- `sender_id`: 送信者ID
|
||||
- `user_message_text`: ユーザーメッセージのプレーンテキスト
|
||||
- `session_id`: ユーザーセッションID、プライベートチャットの場合は`person_<id>`、グループチャットの場合は`group_<id>`
|
||||
- `conversation_id`: 文字列、ユーザーセッションID、LangBotによって生成されます。ユーザーがセッションをリセットした後に再生成されます
|
||||
- `msg_create_time`: 数値型、このメッセージが受信されたタイムスタンプ(秒)
|
||||
- `group_name`: グループ名、グループメッセージを受信した場合のみ設定されます
|
||||
- `sender_name`: 送信者名
|
||||
|
||||
[プラグインを通じて任意の変数をカスタマイズできます](/en/plugin/dev/apis/common.html#set-request-variables)。
|
||||
|
||||
|
||||
|
||||
## その他の設定
|
||||
|
||||
設定フォームの説明を参照してください。
|
||||
@@ -0,0 +1,22 @@
|
||||
# ボットの設定（Bots）
|
||||
|
||||
ボットは、メッセージングプラットフォームからメッセージイベントを受信し、パイプラインを呼び出してメッセージを処理するために使用されます。
|
||||
|
||||
|
||||
|
||||
|
||||
| プラットフォーム | ステータス | 備考 | チュートリアル |
|
||||
| ------ | ---- | ---- | ---- |
|
||||
| Discord | ✅ | | [チュートリアル](/en/deploy/platforms/discord) |
|
||||
| Telegram | ✅ | | [チュートリアル](/en/deploy/platforms/telegram) |
|
||||
| Slack | ✅ | | [チュートリアル](/en/deploy/platforms/slack) |
|
||||
| LINE | ✅ | | [チュートリアル](/en/deploy/platforms/line) |
|
||||
| KOOK | ✅ | | [チュートリアル](/en/deploy/platforms/kook) |
|
||||
| Lark | ✅ | | [チュートリアル](/en/deploy/platforms/lark) |
|
||||
| DingTalk | ✅ | | [チュートリアル](/en/deploy/platforms/dingtalk) |
|
||||
| WeCom（Enterprise WeChat） | ✅ | 企業内部ボット | [チュートリアル](/en/deploy/platforms/wecom/wecom) |
|
||||
| WeCom Intelligent Bot | ✅ | wecom インテリジェントボット | [チュートリアル](/en/deploy/platforms/wecom/wecombot) |
|
||||
| WeCom Customer Service | ✅ | 企業外部ボット | [チュートリアル](/en/deploy/platforms/wecom/wecomcs) |
|
||||
| WeChat Official Account | ✅ | WeChat 公式プラットフォームボット | [チュートリアル](/en/deploy/platforms/wxoa) |
|
||||
| OneBot v11 | ✅ | 個人 QQ アカウントをボットとして使用し、独立したプロトコルクライアントが必要です。OneBot v11 をサポートします | [NapCat](/en/deploy/platforms/qq/aiocqhttp/napcat) <br> [Lagrange](/en/deploy/platforms/qq/aiocqhttp/lagrange) <br> [LiteLoaderQQNT](/en/deploy/platforms/qq/aiocqhttp/llonebot) |
|
||||
| QQ Official Bot | ✅ | QQ Open Platform ボット API に接続します | [チュートリアル](/en/deploy/platforms/qq/official_webhook) |
|
||||
Reference in New Issue
Block a user