Dify ドキュメント作成 活用方法と徹底ガイド

こんにちは、スクーティー代表のかけやと申します。
​
弊社は生成AIを強みとするベトナムオフショア開発・ラボ型開発や、生成AIコンサルティングなどのサービスを提供しており、最近はありがたいことに生成AIと連携したシステム開発のご依頼を数多く頂いています。

Difyは、オープンソースのLLMアプリケーション開発プラットフォームとして、生成AIアプリケーションの迅速な構築を支援します。Backend-as-a-ServiceとLLMOpsの概念を組み合わせることで、開発者だけでなく技術者以外のユーザーもAIアプリケーションの定義やデータ操作に参加できる環境を提供しています。

Difyは、数百ものモデルをサポートし、直感的なプロンプトオーケストレーションインターフェース、高品質なRAGエンジン、柔軟なエージェントフレームワークなど、LLMアプリケーション構築に必要な主要な技術スタックを一元管理しています。これにより、開発者は車輪の再発明に時間を費やすことなく、イノベーションとビジネスニーズに集中できるようになります。

Difyという名称は「Define」と「Modify」の組み合わせであり、AIアプリケーションを定義しつつ継続的に改善するという意味を持ちます。以下の記事では、リライト元の記事内容に沿いながら、Difyにおけるドキュメント作成の基本と活用方法について詳しく解説します。

Difyドキュメント作成の基本

まず、Difyについて知りたいという方は、ぜひこちらの記事を先にご覧ください。
関連記事：DifyでSEO記事作成を試してみる

関連記事：DifyでRAGを爆速で構築する

関連記事：Difyのワークフローを使って今度こそSEO記事を作成する【2024年6月更新】

テンプレートから作成

Difyを初めて使用するユーザーでも、わかりやすいアプリケーションの作成プロセスを体験できるよう、Difyチームのプロンプトエンジニアが複数のシナリオに対応する高品質なアプリケーションテンプレートを多数用意しています。利用手順は以下の通りです。

• ナビゲーションメニューから「Studio」を選択する。
• アプリケーションリスト内の「Create from Template」をクリックする。
• 表示されたテンプレート一覧から任意のテンプレートを選び、「Use this template」をクリックする。

この手順により、ユーザーは直感的にどのような種類のアプリケーションが構築可能かを理解でき、視覚的なガイド（画像）も参照できるため、初めてのユーザーでも操作に戸惑うことなく、スムーズにアプリケーション作成に移行できます。

新規アプリケーションの作成とDSLファイルから作成

Difyで空白（ブランク）のアプリケーションを作成する場合、ナビゲーションから「Studio」を選択し、アプリケーションリストの「Create from Blank」をクリックします。初回利用者は、以下の基本概念を把握してください。

• チャットボット、テキストジェネレーター、エージェント、チャットフロー、ワークフローなど、4種類以上のアプリケーションタイプが存在。
• 各プロジェクトには、名前の設定、アイコンの選択または画像アップロード、目的の明確な説明が必要。

また、DifyではDSL（Domain Specific Language）ファイルを活用した定義が可能です。DSLファイル作成の手順は以下のように整理できます。

1. ローカルファイルまたはURL経由でDSLファイル（YML形式）を入手する。
2. 「Import DSL File」またはURLからインポートするオプションを選択し、設定情報を自動でロードする。
3. DSLバージョンチェック機能により、互換性の問題が発生しにくい設計となっている（例：しきい値「0.6」など具体的な数値情報を参照）。

このプロセスにより、手動入力の手間を省き、ユーザーは直感的かつ詳細な設定を容易に適用できます。

Difyドキュメント作成の活用方法

ナレッジベースの作成

Difyでは、ナレッジベースを作成することで、エージェントが大量のテキストコンテンツから正確な情報を抽出できる体制を整えます。以下の手順に従って情報資産を一元管理してください.

• ローカルのドキュメントファイルまたはオンラインデータをインポートする。
• インポート後、チャンクモードにより長文のテキストが複数の小さなパーツ（チャンク）に自動分割される。例として、分割後のチャンク数やインデックス登録件数など、具体的な目安をシステム上で確認可能。
• インデックス作成および取得設定をカスタマイズし、類似性スコアのしきい値（例：0.6）を設定する。
• 完成したナレッジベースは、アプリケーションにリンクしてQ&Aシステム、内部ヘルプデスク、FAQページなどの基盤として活用可能。

また、以下の表により、ドキュメントの状態変更に関するオプションが視覚的に管理できます.

オプション	内容	備考
有効化	通常の状態で編集および取得が可能	必要に応じて変更・再編集可能
無効化	インデックス登録を一時停止	スイッチ操作により設定
アーカイブ	旧ドキュメントを保存し、編集は不可	削除せずに保管
削除	ドキュメントを完全に削除	復元不可、慎重に操作する必要あり

記事リーダーの作成とファイルアップロードの活用

Difyでは、ファイルアップロード機能を活用してローカルのドキュメントを直接LLMが読み取ることができます。記事リーダー構築の手順は以下の通りです.

• 開始ノードでファイル変数（例：sys.filesまたはユーザー定義のファイル変数）を設定する。
• ドキュメント抽出ノードを用いて、アップロードされたファイルからテキストを抽出する。※LLMは直接ファイルを扱えないため、必ずテキスト変換が必要。
• 複数ファイルの場合、反復処理またはリスト操作ノードを利用し、特定の条件（例：ファイル名順、特定形式のみ）でファイルをフィルタリングする。
• 抽出されたテキスト内容をLLMノードに渡し、最終的な回答生成を行う。

この仕組みにより、記事リーダーはアップロードされた各ファイルに基づくコンテンツ解析やQ&A支援機能としての役割を果たすことができます。

RAGを活用したチャットボットの構築

RAGチャットボットの導入とアカウント登録

Difyは、検索AI技術と生成AIモデルを統合した「RAGエンジン」を活用することで、効率的なチャットボットの構築を実現しています。アカウント登録の手順は以下の通りです。

1. Difyのウェブサイト（https://dify.ai/）にアクセスする。
2. 「Get Started」をクリックして、GoogleまたはGitHubのソーシャルログインを利用し認証する。
3. ログイン後、上部の「Knowledge」タブからナレッジの登録を行い、テキストファイルなどをインポートする。
4. ナレッジ登録後、各ファイルのベクトル変換や類似性計算が自動で実行され、問い合わせに対して高精度な情報提供が可能になる。

この一連の流れにより、ユーザーは安心してRAGチャットボットの導入を進められます。

チャットボットのワークフロー構築とテスト

RAGを活用したチャットボット構築のプロセスは、以下の主要ステップで構成されます。

• Startノード: ユーザーが入力するテキスト用の変数（例：background、instruction）を定義し、sys.queryやsys.filesなどの既定変数と連動させる。
• Knowledge Retrievalノード: 登録済みナレッジベースからユーザーのクエリに応じた情報を抽出する。取得結果には具体的な数値（例：しきい値0.6）が適用される。
• LLMノード: 取得されたナレッジ内容とユーザー情報をプロンプトに組み込み、最終的な回答を生成する。
• テストフェーズ: 画面右上の「Preview」機能を用い、具体例（例：「OAuth 2.0の特徴を教えてください」）を入力し、各ノードの入出力を確認する。
• 最終的に「Publish」ボタンを押し、チャットボットの公開を完了する。

このプロセス全体が視覚的なガイドおよび画像付き説明と連動しており、ユーザーは各工程の詳細な動作を確認しながら進めることができます。