> ## Documentation Index
> Fetch the complete documentation index at: https://developer.qaip.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# n8n

> n8nのワークフローからQAIPのデータソースを活用して回答生成・情報抽出・検索を行うことができます。

## n8n連携

[n8n](https://n8n.io/) は、コードを書かずに複雑なワークフローを構築できるオープンソースのワークフロー自動化プラットフォームです。
QAIP のコミュニティノードを使用すると、n8n のワークフローから QAIP のデータソースを活用した AI 回答生成、情報抽出、セマンティック検索が簡単に実現できます。

## インストール

<Warning>
  現在、QAIP ノードは n8n の **セルフホスト版** でのみ利用可能です。n8n クラウド版では [verified node](https://docs.n8n.io/integrations/community-nodes/) のみインストールできるため、現時点ではご利用いただけません。
</Warning>

<Steps>
  <Step title="n8n のコミュニティノード設定を開く">
    n8n の左サイドバーから <Icon icon="gear" /> **Settings** を選択し、<Icon icon="cube" /> **Community nodes** を開きます。

    <Info>
      セルフホストの n8n を使用している場合は、環境変数 `N8N_COMMUNITY_PACKAGES_ENABLED=true` を設定する必要があります。
      詳しくは [n8n のドキュメント](https://docs.n8n.io/integrations/community-nodes/installation/) を参照してください。
    </Info>
  </Step>

  <Step title="QAIP ノードをインストール">
    **Install a community node** をクリックし、パッケージ名に `@qlonolink/n8n-nodes-qaip` と入力して **Install** をクリックします。
  </Step>

  <Step title="インストールを確認">
    インストールが完了すると、ノードパネルから **QAIP** ノードが利用可能になります。
  </Step>
</Steps>

## 認証情報の設定

QAIP ノードを使用するには、API キーの設定が必要です。

<Steps>
  <Step title="API キーを発行する">
    [API キーの作成方法](/docs/features/apikey)を参照して、QAIP ダッシュボードから API キーを発行します。
  </Step>

  <Step title="n8n で認証情報を作成する">
    n8n のキャンバスで QAIP ノードを配置し、**Credential to connect with** の横にある **Create New Credential** をクリックします。
  </Step>

  <Step title="API キーを入力する">
    **API Key** フィールドに、発行した API キーを入力して保存します。
  </Step>
</Steps>

## 利用可能なオペレーション

QAIP ノードは以下の 3 つのオペレーションをサポートしています。

### Completion

データソースをコンテクストとして活用し、自然な会話形式で AI 回答を生成します。

| 主なパラメータ      | 説明                                              |
| ------------ | ----------------------------------------------- |
| Messages     | 会話履歴（role: user/assistant/system と content のペア） |
| Citation     | 引用元を回答に含めるかどうか（デフォルト: true）                     |
| Tags         | 検索対象のタグ名                                        |
| Source Types | 検索対象のソースタイプ（Crawl, GitHub, Google Drive など）     |
| File Types   | 検索対象のファイルタイプ（PDF, HTML, MD など）                  |

### Search

セマンティック検索を使用して、クエリに関連する情報をデータソースから取得します。

| 主なパラメータ      | 説明                    |
| ------------ | --------------------- |
| Query        | 検索クエリ                 |
| Limit        | 取得する結果の最大数（デフォルト: 10） |
| Tags         | 検索対象のタグ名              |
| Source Types | 検索対象のソースタイプ           |
| File Types   | 検索対象のファイルタイプ          |

### Extract

非構造化データから情報を抽出し、指定した JSON スキーマに従って構造化データに変換します。

| 主なパラメータ      | 説明                     |
| ------------ | ---------------------- |
| Prompt       | 抽出する情報を指示するプロンプト       |
| JSON Schema  | 抽出結果の形式を定義する JSON スキーマ |
| Tags         | 検索対象のタグ名               |
| Source Types | 検索対象のソースタイプ            |

## 使用例

[n8n-nodes-qaip リポジトリの examples フォルダ](https://github.com/qlonolink/n8n-nodes-qaip/tree/main/examples)にサンプルワークフローが用意されています。

### ワークフローのインポート方法

<Steps>
  <Step title="ワークフロー JSON をダウンロード">
    GitHub から使用したいワークフローの JSON ファイルをダウンロードします。
  </Step>

  <Step title="n8n にインポート">
    JSON ファイルの内容をコピーし、n8n のキャンバス画面で `Cmd + V`（Mac）または `Ctrl + V`（Windows）でペーストします。
  </Step>

  <Step title="認証情報を設定">
    インポートしたワークフロー内の QAIP ノードに、[API キー](/docs/features/apikey)を設定した認証情報を割り当てます。
  </Step>
</Steps>

<Tip>
  ワークフローのインポートについて詳しくは、[n8n のドキュメント](https://docs.n8n.io/workflows/export-import/)を参照してください。
</Tip>

### シンプルな Completion

* **ファイル**: [`qaip_simple_completions.json`](https://github.com/qlonolink/n8n-nodes-qaip/blob/main/examples/qaip_simple_completions.json)
* **概要**: QAIP ノードを使用してシンプルな Completion を実行する基本的なワークフローです。
* **必要な設定**: [QAIP API キー](/docs/features/apikey)、メッセージ内容の変更

### Slack チャットボット

* **ファイル**: [`qaip_slack_completions.json`](https://github.com/qlonolink/n8n-nodes-qaip/blob/main/examples/qaip_slack_completions.json)
* **概要**: Slack のメンションに対して QAIP で回答を生成し、同じスレッドに返信するチャットボットです。
* **必要な設定**: QAIP と Slack の認証情報。Slack アプリは `app_mention` イベントの受信と `chat:write` スコープが必要です。

<Info>
  Slack アプリの設定については、[n8n の Slack Trigger ノードのドキュメント](https://docs.n8n.io/integrations/builtin/trigger-nodes/n8n-nodes-base.slacktrigger/)を参照してください。
</Info>

## 関連リンク

* [n8n コミュニティノードのインストールガイド](https://docs.n8n.io/integrations/community-nodes/installation/)
* [QAIP API ドキュメント](/docs/sdks/index)
* [API キーの作成方法](/docs/features/apikey)