chatpdf gpt

CHATPDF-GPT

Einführung

CHATPDF-GPT ist ein innovatives Projekt, das die Kraft des Langchain-Frameworks nutzt, ein transformatives Tool für die Entwicklung von Anwendungen, die von Sprachmodellen betrieben werden. Diese einzigartige Anwendung verwendet Langchain, um eine Chat -Schnittstelle anzubieten, die mit PDF -Dokumenten kommuniziert, die von den Funktionen der Sprachmodelle von OpenAI angetrieben werden.

In diesem Projekt ist das Sprachmodell mit anderen Datenquellen verbunden und ermöglicht die Interaktion mit seiner Umgebung, wodurch die Prinzipien des Langchain -Frameworks verkörpert werden. Benutzer können ein PDF -Dokument hochladen, das dann in PineCone, einer Vektor -Datenbank und Supabase -Speicher gespeichert und gespeichert wird. Benutzer können dann mit dem hochgeladenen PDF chatten, wobei die KI den Inhalt des Dokuments verwendet, um sich an ein sinnvolles Gespräch zu führen.

Das Projekt basiert auf dem nächsten.js-Framework, einer führenden Auswahl für robuste, vollständige Webanwendungen. Die UI -Komponenten werden mit der Radix UI -Bibliothek wunderschön gefertigt und mit Rückenwind -CSS gestaltet, basierend auf der eleganten Vorlage von Shadcn/UI.

Merkmale

1. Laden Sie ein PDF hoch : Benutzer können ein PDF -Dokument hochladen, das dann in der Pnecone -Vektor -Datenbank und in Supabasespeicher gespeichert wird.
2. Chat mit PDF : Die Anwendung verarbeitet den Inhalt des PDF und ermöglicht es Benutzern, mit dem Dokument mit OpenAI -API zu unterhalten.
3. PDF-Vorschau : Benutzer können das tatsächliche PDF-Dokument, mit dem sie interagieren, mit dem leistungsstarken React-Komponent-Paket @react-pdf-viewer eine Vorschau anbieten.
4. LISTE PDFS : Die Anwendung enthält eine Liste aller hochgeladenen PDF -Dokumente, die in der Supabase -Datenbank gespeichert sind.
5. PDF löschen : Benutzer können ein Dokument aus der Datenbank entfernen.
6. Quellen zitieren : Die AI -Chat -Schnittstelle bietet Quellen aus der PDF für jede Antwort, sodass Benutzer direkt zur Referenz im PDF navigieren können.

Nutzungsbeispiele

CHATPDF-GPT ist mit Beispielen ausgestattet, die verschiedene Operationen veranschaulichen, wie z. B.:

1. Interaktion mit Tinecone: Einbettung speichern, einen Datensatz löschen.
2. Hochladen einer Datei in Supabase Speicher und auch eine Datei löschen.
3. Auflistung verfügbarer Dokumente aus der Supabase -Datenbank.
4. Vorschau eines PDF mit dem @react-pdf-viewer.
5. Navigieren direkt zur Quelle einer KI -Antwort in der PDF.

Schnelle Tests mit der Demo

Um die Funktionalität dieses Projekts mithilfe der Demo zu testen, müssen Sie Ihre eigenen Anmeldeinformationen für OpenAI, Supabase und Tinecone bereitstellen. Für Supabase können Sie die nachstehend bereitgestellte Schritt-für-Schritt-Anleitung folgen, um die erforderlichen Anmeldeinformationen einzurichten und abzurufen. Um Anmeldeinformationen für OpenAI und Pinecone zu erwerben, konsultieren Sie bitte die entsprechende Dokumentation, da eine Schritt-für-Schritt-Anleitung möglicherweise nicht verfügbar ist. Stellen Sie immer sicher, dass Sie die neuesten Anweisungen der jeweiligen Dienste befolgen.

1. Openai

Openai

2. Supabase

1. Erstellen eines neuen Projekts in Supabase :

   • Öffnen Sie Ihren Webbrowser und navigieren Sie zu App.supabase.io.
   • Klicken Sie auf "neues Projekt".
   • Geben Sie Ihre Projektdetails ein und warten Sie, bis die neue PostgreSQL -Datenbank gestartet wird. Es kann einige Minuten dauern, bis der Vorgang abgeschlossen ist.

2. Abrufen der Datenbankverbindungs ​​-URL :

   • Sobald Ihre Datenbank erfolgreich erstellt wurde, navigieren Sie zur Seite Ihres Projekts.
   • Gehen Sie zum Abschnitt "Einstellungen".
   • Klicken Sie in der Seitenleiste auf die Registerkarte "Datenbank".
   • Scrollen Sie nach unten auf der Seite und suchen Sie nach dem Abschnitt "Verbindungszeichenfolge".
   • Wählen Sie "Nodejs" und kopieren Sie die URL.

Diese Verbindungszeichenfolge wird für die Umgebungsvariable DATABASE_URL in Ihrer Anwendung verwendet.

3. Abrufen der Verbindungs ​​-Pooling -Verbindungszeichenfolge :
   • Noch in der Registerkarte "Datenbank" des Abschnitts "Einstellungen" scrollen Sie, um den Abschnitt "Verbindungspooling" zu finden.
   • Wählen Sie "NodeJs" und kopieren Sie die Verbindungs ​​-Pooling -URL.

Diese URL wird für die DIRECT_URL -Umgebungsvariable in Ihrer Anwendung verwendet.

4. Abrufen von Speichertasten :
   • Gehen Sie auf der Seite Ihres Projekts in den Abschnitt "Einstellungen".
   • Klicken Sie in der Seitenleiste auf die Registerkarte "API".
   • Hier finden Sie Ihre SUPABASE_URL und SUPABASE_KEY . Kopieren Sie diese Werte.

Die SUPABASE_URL ist die URL für Ihr Projekt, während SUPABASE_KEY der öffentliche anonyme Schlüssel für Ihr Projekt ist.

5. Einrichten des Supabase -Eimers :

   • Gehen Sie auf der Seite Ihres Projekts zum Abschnitt "Speicher".
   • Erstellen Sie hier einen neuen Eimer oder verwenden Sie einen vorhandenen. Der Name des Eimers wird in Ihrer Anwendung als SUPABASE_BUCKET verwendet.

6. Einrichten von Umgebungsvariablen in Ihrer Anwendung :

   • Navigieren Sie nun zu Ihrem Projekt, wo Sie Supabase verwenden.
   • Fügen Sie die folgenden Umgebungsvariablen mit den Werten hinzu, die Sie aus der Supabase -Konsole kopiert haben:
     • DATABASE_URL
     • DIRECT_URL
     • SUPABASE_KEY
     • SUPABASE_URL
     • SUPABASE_BUCKET

Mit diesen Schlüssel kann Ihre Anwendung mit den Supabase -Diensten interagieren.

7. Verwalten von Speicher -Bucket -Richtlinien :
   • Navigieren Sie von der Seite Ihres Projekts zum Abschnitt "Speicher".
   • Klicken Sie auf den Eimer, für den Sie Richtlinien verwalten möchten.
   • Klicken Sie auf die Registerkarte "Richtlinien", um die vorhandenen Richtlinien für den Eimer anzuzeigen.
   • Um eine neue Richtlinie zu erstellen, klicken Sie auf die Schaltfläche "Richtlinien erstellen" und geben Sie die Richtliniendetails gemäß Ihren Anforderungen ein.
   • Um eine vorhandene Richtlinie zu bearbeiten, klicken Sie auf die Richtlinie in der Liste und nehmen Sie die erforderlichen Änderungen vor.

Bitte beachten Sie, dass es zwar möglich ist, eine Richtlinie festzulegen, die Ihren Speicherkorb öffentlich zugänglich macht, dies jedoch mit Vorsicht tun sollte. Wenn Sie Ihren Eimer öffentlich zugänglich machen, kann jeder mit der URL zu einem Objekt darauf zugreifen. Dies kann zum Testen nützlich sein, aber für Produktionsanwendungen sollten Sie restriktivere Richtlinien in Betracht ziehen, um die Sicherheit Ihrer Daten zu gewährleisten. Konsultieren Sie immer die Supabase -Dokumentation oder einen Sicherheitsexperten, um die Auswirkungen verschiedener Richtlinien zu verstehen.

Damit sollten Sie Supabase für Ihr Projekt einrichten und Speicherrichtlinien gemäß Ihren Anforderungen verwalten.

3. Pincone

Tannenzapfen

Einrichtung und Installation

Befolgen Sie die folgenden Schritte:

1. Klonen Sie das Projektrepository:

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

2. Navigieren Sie in das Projektverzeichnis und installieren Sie die Abhängigkeiten mit PNPM:

 cd chatpdf-gpt
pnpm install

3. Erstellen Sie eine .env -Datei im Stammverzeichnis und füllen Sie Ihre Anmeldeinformationen (OpenAI, Pinecone, Supabase) aus, wie in der Datei .env.example angegeben.

4. Erstellen Sie das Datenbankschema mit Prisma. Sie müssen Sie dazu bringen, das Prisma -Erzeugungs -Befehl prisma generate lassen

    npx prisma migrate dev --name init
   

5. Starten Sie den Server:

    npm run dev
   

Beitrag

CHATPDF-GPT ist ein Open-Source-Projekt, und wir begrüßen Beiträge von allen herzlich. Weitere Informationen zum Einstieg finden Sie in unserem Beitragsführer.

Credits

Dieses Projekt steht auf den Schultern der Riesen. Unsere Arbeit wäre ohne die große Auswahl an Bibliotheken, Frameworks und Tools, die die Open -Source -Community produziert hat, nicht möglich. Insbesondere möchten wir unsere Wertschätzung zum Ausdruck bringen:

1. Das Langchain -Team für ihren bahnbrechenden Rahmen für Anwendungen, die von Sprachmodellen betrieben werden.

2. Öffnen Sie für ihre hochmodernen Sprachmodelle, die die Chat-Funktionalität ermöglichen.

3. Supabase für ihre Open-Source Firebase-Alternative, mit der wir sichere und leistungsfähige Backends aufgebaut haben.

4. Pinecone für ihre Vektor -Datenbank, die eine einfache und effiziente Speicherung und das Abrufen von Vektoreinbettungen ermöglicht.

5. Weiter.js und Vercel für ihren umfassenden Framework, mit dem wir diese Vollstack-Webanwendung problemlos erstellen konnten.

6. Shadcn für ihre eleganten UI-Komponenten, auf denen wir eine schöne und benutzerfreundliche Schnittstelle erstellen.

7. Radix UI für ihre robuste, zugängliche und anpassbare Komponentenbibliothek, die das Rückgrat unserer Benutzeroberfläche bildet.

8. @React-PDF-Viewer für ihre leistungsstarke React-Komponente, mit der die Benutzer das tatsächliche PDF-Dokument, mit dem sie interagieren, eine Vorschau von PDF-Dokument ermöglicht.

Und alle anderen aufgelisteten und nicht aufgeführten Abhängigkeiten, die zur Verwirklichung dieses Projekts beigetragen haben. Unser Beitrag ist im Vergleich zu ihrer kollektiven Anstrengung bescheiden.

Lizenz

CHATPDF-GPT ist Open-Source-Software, die unter der MIT-Lizenz lizenziert wurde.