> For the complete documentation index, see [llms.txt](https://docs.digitalhumans.jp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digitalhumans.jp/dify-guide/knowledge-base/dify-docs-integrate-external-knowledge-base.md).

# 外部ナレッジベースと連携

外部ナレッジベース連携（External Knowledge Base）は、Difyの外部で管理されているナレッジベースを、Difyから利用するための機能です。Dify側で**外部API接続（Endpoint + API Key）** を定義し、外部システム側の**ナレッジベースID**を指定して検索を実行します。 本機能は、Dify内部にデータをインポートするのではなく、「外部システムを検索して結果を取得する」用途に使用されます。

## アクセス方法

1. Difyのコンソールを開きます。
2. **ナレッジ（Knowledge）** タブへ移動します。
3. **外部ナレッジベース連携API（External Knowledge API）** ボタンを選択します。 ※ 画面右上の「外部ナレッジAPI」等のリンクから設定画面へ遷移します（バージョンにより配置が異なる場合があります）。

## 設定の流れ

![](/files/09kbqUs5P0vKFvOQeoiJ)

連携は以下の2段階で設定します。

1. **外部ナレッジベース連携API**の作成
   * APIのエンドポイントや認証情報を登録します。
2. \*\*外部ナレッジベース（KB）\*\*の追加
   * 作成したAPI定義を選択し、具体的なナレッジベースIDや検索設定を紐付けます。

## 1. 外部ナレッジAPIの設定

![](/files/xbrBVfmPvXq1GAPeRcpW)

「外部ナレッジベース連携APIを作成」から、以下の項目を設定します。

* **名前 (Name)**：管理用の識別名
* **API エンドポイント (API Endpoint)**：外部ナレッジベースの検索API URL
* **API キー (API Key)**：認証用のAPIキー
  * Difyから外部APIへのリクエスト時に認証情報として使用されます。機密情報として適切に管理し、定期的なローテーションや最小権限の付与を推奨します。

## 2. ナレッジベースの連携と検索設定

API定義作成後、実際にアプリで使用するナレッジベースを登録します。

### 基本設定

* **外部ナレッジベース連携API**：作成したAPI定義を選択
* **外部ナレッジベースID**：外部システム側で管理されているナレッジベースのID

### 検索設定

検索時の挙動を制御するパラメータです。

* **TopK**
  * 検索結果として取得する上位件数（デフォルト: 4）
* **Score Threshold（スコア閾値）**
  * 検索結果の類似度スコアの下限値（デフォルト: 0.5）
  * 値を上げると関連度の高い結果のみに厳選され、下げるとより多くの結果が含まれるようになります。

## 利用手順

1. **外部ナレッジベース連携API** を作成（エンドポイント設定）
2. ナレッジ一覧画面から「ナレッジを作成」→「外部ナレッジベース」を選択、または専用メニューから連携を追加
3. 使用する **API接続** を選択し、**外部ナレッジID** を入力
4. **検索設定（TopK、スコア閾値）** を調整
5. **「保存/連携」** をクリック
   * 連携が成功すると、接続テストやプレビューが可能になります。

## 制約・注意点

* **検索（Retrieval）のみサポート**
  * 本機能は外部データの検索・取得に特化しています。Dify側から外部ナレッジベースへのドキュメント追加・編集・削除（書き込み操作）は行えません。
* **API仕様**
  * 接続先の外部APIは、Difyが規定するインターフェース（リクエスト/レスポンス形式）に準拠している必要があります。詳細は公式APIドキュメントを参照してください。

## 参考情報

* **Dify 公式ドキュメント: External Knowledge API** <https://docs.dify.ai/en/use-dify/knowledge/external-knowledge-api>

  外部ナレッジベースと連携機能は、Dify外部で管理されているナレッジベース（RAGシステム）をDifyのアプリケーションから利用するための機能です。APIとナレッジベースIDを使って外部システムと連携し、検索機能を活用できます。
