RAG連携

概要¶

RAG（検索拡張生成）は、大規模言語モデル（LLM）が回答を生成する前に、外部のデータベースや社内文書から関連する情報を探し出して組み合わせるAI技術です。

プリザンターのRAG連携機能は、テーブル内のレコードをRAGサービスのベクトルDBへ自動で受け渡す機能です。RAG連携機能を使うと、プリザンターに格納した業務データに基づくナレッジベースを手軽に構築できます。

対応するRAGサービス¶

プリザンターのRAG連携機能は、DifyとOpenAIとの自動連携に対応しています。

DifyとOpenAI以外のRAGサービスについては、マークダウンファイルを介して手動で登録することができます。

注意事項¶

1. 本機能で出力されたファイルの取り扱いに十分注意してください。プリザンターのレコードをマークダウンファイルへ書き出し、RAGサービスへ直接連携します。レコードが社外秘のデータを含む場合、ローカル環境にRAGサービスを立てるなどの工夫が必要になります。
2. 多数のレコードを含むテーブルで同期を実行すると、完了までに長い時間を要する可能性があります。また、RAGサービスの利用方法によっては料金が発生する可能性があります。

操作手順¶

➊ 機能の有効化¶

AiConnect.jsonのパラメータEnabledをtrueに設定してください。

➋ 出力先フォルダの設定¶

AiConnect.jsonのパラメータOutputFilePathにマークダウンファイルを格納するフォルダへのパスを設定してください。詳細はAiConnect.jsonを参照してください。このフォルダは、出力ファイルがなくなっても削除されません。

➌ AI連携設定の作成¶

AI連携設定（連携先の設定）は、テーブルの管理：AI連携タブで管理します。設定方法は連携先により異なります。以下を参考に設定してください。

1. RAG連携：Difyに連携する
2. RAG連携：OpenAIに連携する
3. RAG連携：マークダウンファイルを出力する

➍ テーブルの更新時にオンデマンドで連携する¶

1. 連携処理は、レコードの作成、レコードの更新、レコードの削除をトリガーとして実行されます。
2. レコードの一括更新とレコードのインポートによる更新は連携の対象外です。これらの操作で更新したレコードを連携先へ反映するには、下記手順❻の同期操作を実行してください。

更新連携時の注意事項¶

1. 連携先への登録が通信エラーで失敗した場合は、既定では2回まで再試行します。この回数は、AiConnect.jsonのパラメータ「SyncRetryCount」で変更できます。

➎ レコードの削除を連携する¶

プリザンターでレコードを削除したときに、連携先の文書とWebサーバ上のマークダウンファイルを削除できます。削除連携が正しく実行されたか確認するには、ジョブの管理画面で「ジョブ種別」が「AI連携」のジョブの状況を確認し、連携先の文書とサーバ上のマークダウンファイルが削除されていることを確認してください。

1. 本機能を利用するにはAiConnect.jsonのパラメータDeleteEnabledをtrueに設定してください。

2. 一括削除やゴミ箱からの完全削除などの操作では連携されません。詳細は以下の表を参照してください。

   削除操作	RAG連携
   レコードの編集画面の削除	連携する
   APIによる削除	連携する
   サーバスクリプトによる削除	連携する
   一覧からの一括削除	連携しない （RAGサービス側で削除が必要）
   ゴミ箱からの完全削除	連携しない
   履歴の削除、サイトの削除、テナントの削除	連携しない

削除時の注意事項¶

1. 連携先の文書の削除に失敗した場合、既定では2回まで再試行します。再試行後も削除できない場合、その文書は連携先に残ります。この試行回数の上限値はAiConnect.jsonのDeleteRetryCountで変更できます。
2. サーバ上に削除対象のマークダウンファイルが存在しない場合（出力先フォルダがない場合を含む）は、削除を成功として扱います。ファイルのロックなど一時的な失敗は、既定では2回まで再試行し、成功しない場合は削除連携のジョブが失敗します。権限不足、出力先フォルダの外を指すパス、パスが長すぎる、ドライブが見つからないなど恒久的な失敗は、再試行せず削除連携のジョブが失敗します。

❻ 既存のレコードを一括連携する¶

既存のレコードをRAGサービスへ一括連携する手順は以下の通りです。

1. 任意のテーブルを開いてください。
2. テーブルの管理：AI連携タブでAI連携設定を1件選択し、「同期」ボタンをクリックしてください。
3. キューイングを有効にしている場合は、ジョブへの登録を知らせるメッセージとジョブIDのリンクが表示されます。リンクをクリックしてジョブの管理画面へ移動してください。キューイングを無効にしている、処理の完了後に削除件数・成功件数・失敗件数を含むメッセージが表示されます。
4. ジョブの管理画面で、ジョブ種別が「AI連携（同期）」のジョブの状態と結果を確認してください。

なお、同期は既存のレコードをRAGに一括連携する機能です。「対象のAI連携設定がプリザンターから登録したマークダウンファイルを削除してから、全レコードから出力されたマークダウンファイルを登録し直す」処理であることに注意してください。同じデータセット（ストレージ）を他のサイト・他のAI連携設定と共有していても、それらの文書は削除されません。

❼ RAG連携とキューイング¶

1. キューイングを利用できる環境では、連携処理はバックグラウンドジョブとして実行されます。
2. キューイングを利用できない環境では、テーブルの更新と並行して即時実行されます。

3. キューへ登録されたジョブの状況はジョブの管理画面で確認できます。「ジョブ種別」は下記の名称で表示されます。

   ジョブ種別	内容
   AI連携	レコードの作成・更新によるAI連携、連携方式が「OpenAI」の場合の登録状態の確認・削除・連携状態。3つの処理を同じ状況で表示。
   AI連携（同期）	AIへの同期を行っている状態。

❽ 出力されるマークダウンファイルのパス¶

上記➋で設定した出力先フォルダ配下に、以下のパスでマークダウンファイルが出力されます。

📁{OutputFilePath}
└📁テナントID
　└📁サイトID
　　└📄pleasanter-{テナントID}-{サイトID}-{連携先ID}-{issueまたはresult}-{レコードID}.md

対応バージョン¶