chatpdf gpt

chatpdf-gpt

導入

CHATPDF-GPTは、言語モデルを搭載したアプリケーションを開発するための変換ツールであるLangchain Frameworkの力を活用する革新的なプロジェクトです。このユニークなアプリケーションは、Langchainを使用して、Openaiの言語モデルの機能によって駆動されるPDFドキュメントと通信するチャットインターフェイスを提供します。

このプロジェクトでは、言語モデルは他のデータソースに接続されており、その環境との相互作用を可能にするため、Langchainフレームワークの原則を具体化します。ユーザーはPDFドキュメントをアップロードできます。これは、Pinecone、Vectorデータベース、およびSupabaseストレージで処理および保存されます。その後、ユーザーはアップロードされたPDFとチャットでき、AIはドキュメントのコンテンツを利用して意味のある会話を行うことができます。

このプロジェクトは、Next.JSフレームワークに依存しています。これは、堅牢でフルスタックのWebアプリケーションを作成するための主要な選択肢です。 UIコンポーネントは、RADIX UIライブラリを使用して美しく作られ、ShadCN/UIが提供するエレガントなテンプレートに基づいて、Tailwind CSSでスタイル化されています。

特徴

1. PDFのアップロード：ユーザーはPDFドキュメントをアップロードできます。これは、Pinecone Vector DatabaseとSupabaseストレージに保存されます。
2. PDFとのチャット：アプリケーションは、PDFのコンテンツを処理し、OpenAI APIを使用してユーザーがドキュメントと会話をすることができます。
3. PDFプレビュー：ユーザーは、強力なReactコンポーネントパッケージ @React-PDF-Viewerを使用して、対話している実際のPDFドキュメントをプレビューできます。
4. リストPDFS ：アプリケーションは、Supabaseデータベースに保存されているすべてのアップロードされたPDFドキュメントのリストを提供します。
5. PDFの削除：ユーザーは、データベースからドキュメントを削除する機能を持っています。
6. 引用ソース：AIチャットインターフェイスは、すべての返信ごとにPDFのソースを提供し、ユーザーがPDFの参照に直接ナビゲートできるようにします。

使用例

CHATPDF-GPTには、次のようなさまざまな操作を示す例が装備されています。

1. Pineconeとの対話：埋め込みの保存、レコードの削除。
2. ファイルをSupabaseストレージにアップロードし、ファイルも削除します。
3. Supabaseデータベースから利用可能なドキュメントをリストします。
4. @React-PDF-Viewerを使用してPDFをプレビューします。
5. PDFのAI応答のソースに直接ナビゲートします。

デモを使用したクイックテスト

デモを使用してこのプロジェクトの機能をテストするには、Openai、Supabase、およびPineconeに独自の資格情報を提供する必要があります。 Supabaseの場合、必要な資格情報をセットアップおよび取得するために、以下に示されているステップバイステップガイドに従うことができます。 OpenaiおよびPineconeの資格情報を取得するには、段階的なガイドが利用できない場合があるため、対応するドキュメントを参照してください。それぞれのサービスが提供する最新の指示に従っていることを常に確認してください。

1。Openai

Openai

2。Supabase

1. Supabaseで新しいプロジェクトの作成：

   • Webブラウザを開き、app.supabase.ioに移動します。
   • 「新しいプロジェクト」をクリックします。
   • プロジェクトの詳細を入力して、新しいPostgreSQLデータベースが起動するのを待ちます。プロセスが完了するまでに数分かかる場合があります。

2. データベース接続URLの取得：

   • データベースが正常に作成されたら、プロジェクトのページに移動します。
   • 「設定」セクションに移動します。
   • サイドバーの[データベース]タブをクリックします。
   • ページの下部までスクロールして、「接続文字列」セクションを探します。
   • 「nodejs」を選択し、URLをコピーします。

この接続文字列は、アプリケーションのDATABASE_URL環境変数に使用されます。

3. 接続プーリング接続文字列の取得：
   • 「設定」セクションの「データベース」タブにまだ、「接続プーリング」セクションを見つけてください。
   • 「nodejs」を選択し、接続プーリングURLをコピーします。

このURLは、アプリケーションのDIRECT_URL環境変数に使用されます。

4. ストレージキーの取得：
   • プロジェクトのページから、「設定」セクションに移動します。
   • サイドバーの[API]タブをクリックします。
   • ここには、 SUPABASE_URLとSUPABASE_KEYあります。これらの値をコピーします。

SUPABASE_URLはプロジェクトのURLですが、 SUPABASE_KEYはプロジェクトの公開匿名キーです。

5. Supabaseバケツのセットアップ：

   • プロジェクトのページから、「ストレージ」セクションに移動します。
   • ここで、新しいバケットを作成するか、既存のバケットを使用します。バケットの名前は、アプリケーションでSUPABASE_BUCKETとして使用されます。

6. アプリケーションで環境変数を設定します：

   • 次に、Supabaseを使用しているプロジェクトに移動します。
   • Supabaseコンソールからコピーした値で次の環境変数を追加します。
     • DATABASE_URL
     • DIRECT_URL
     • SUPABASE_KEY
     • SUPABASE_URL
     • SUPABASE_BUCKET

これらのキーを使用すると、アプリケーションがSupabaseサービスと対話できます。

7. ストレージバケットポリシーの管理：
   • プロジェクトのページから「ストレージ」セクションに移動します。
   • ポリシーを管理するバケットをクリックします。
   • [ポリシー]タブをクリックして、バケットの既存のポリシーを表示します。
   • 新しいポリシーを作成するには、[ポリシーの作成]ボタンをクリックし、要件に応じてポリシーの詳細を入力します。
   • 既存のポリシーを編集するには、リスト内のポリシーをクリックして、必要な変更を行います。

ストレージバケットを公開できるようにするポリシーを設定することは可能ですが、これを慎重に行う必要があります。バケツを公開しやすくすることは、オブジェクトにURLを持っている人なら誰でもアクセスできることを意味します。これはテストに役立つかもしれませんが、生産アプリケーションでは、データのセキュリティを確保するために、より制限的なポリシーを検討する必要があります。さまざまなポリシーの意味を理解するために、常にSupabaseのドキュメントまたはセキュリティの専門家に相談してください。

これにより、要件に従ってプロジェクトのためにSupabaseを設定し、ストレージポリシーを管理できるはずです。

3。ピンコーン

松ぼっくり

セットアップとインストール

ローカルマシンでCHATPDF-GPTをセットアップして実行するには、以下の手順に従ってください。

1. プロジェクトリポジトリをクローンします：

    git clone https://github.com/anis-marrouchi/chatpdf-gpt.git
   

2. プロジェクトディレクトリに移動し、PNPMを使用して依存関係をインストールします。

 cd chatpdf-gpt
pnpm install

3. ルートディレクトリに.envファイルを作成し、 .env.exampleファイルに示されているように、資格情報（Openai、Pinecone、Supabase）に入力します。

4. Prismaを使用してデータベーススキーマを作成します。あなたはあなたがプリスマ生成コマンドprisma generateを実行させる必要があります

    npx prisma migrate dev --name init
   

5. サーバーを開始します：

    npm run dev
   

貢献

chatpdf-gptはオープンソースプロジェクトであり、すべての人からの貢献を温かく歓迎します。開始方法の詳細については、寄稿ガイドをご覧ください。

クレジット

このプロジェクトは、巨人の肩に立っています。オープンソースコミュニティが生み出したライブラリ、フレームワーク、ツールの膨大な配列がなければ、私たちの仕事は不可能です。具体的には、次のように感謝したいと思います。

1. Langchainチームは、言語モデルを搭載したアプリケーションの画期的なフレームワークのためのチームです。

2. 最先端の言語モデルについては、チャット機能を可能にします。

3. Supabaseセキュアとパフォーマンスのバックエンドを構築するために使用したオープンソースファイアベースの代替品。

4. ベクトル埋め込みの簡単で効率的な保存と取得を可能にするベクトルデータベースのPinecone。

5. next.jsとvercelは、このフルスタックのWebアプリケーションを簡単に構築できるようにしました。

6. 美しくユーザーフレンドリーなインターフェイスを作成するために構築したエレガントなUIコンポーネント用のShadCN。

7. UIのバックボーンを形成する、堅牢でアクセス可能なカスタマイズ可能なコンポーネントライブラリ用のRADIX UI。

8. @React-PDF-Viewerの強力なReactコンポーネントについては、ユーザーが相互作用している実際のPDFドキュメントをプレビューできます。

そして、このプロジェクトの実現に貢献した他のすべての依存関係は、リストされているものとリストされていません。私たちの貢献は、彼らの集合的な努力と比較して控えめです。

ライセンス

CHATPDF-GPTは、MITライセンスに基づいてライセンスされているオープンソースソフトウェアです。