Page d'accueil>Lié à la programmation>Autre code source
Télécharger

Chatpdf-gpt

Introduction

ChatPDF-GPT est un projet innovant qui exploite la puissance du cadre de Langchain, un outil transformateur pour développer des applications alimentées par des modèles de langue. Cette application unique utilise Langchain pour offrir une interface de chat qui communique avec les documents PDF, motivé par les capacités des modèles de langue d'Openai.

Dans ce projet, le modèle de langue est connecté à d'autres sources de données et permet l'interaction avec son environnement, incarnant ainsi les principes du cadre de Langchain. Les utilisateurs peuvent télécharger un document PDF, qui est ensuite traité et enregistré dans PineCone, une base de données vectorielle et le stockage de supabase. Les utilisateurs peuvent ensuite discuter avec le PDF téléchargé, l'IA utilisant le contenu du document pour engager une conversation significative.

Le projet s'appuie sur le framework suivant.js, un choix de premier plan pour créer des applications Web robustes et complètes. Les composants de l'interface utilisateur sont magnifiquement conçus à l'aide de la bibliothèque d'interface utilisateur Radix et stylisés avec CSS du vent arrière, basé sur le modèle élégant fourni par Shadcn / UI.

Caractéristiques

  1. Téléchargez un PDF : les utilisateurs peuvent télécharger un document PDF, qui est ensuite stocké dans la base de données vectorielle de Pinecone et le stockage de supabase.
  2. Discutez avec PDF : l'application traite le contenu du PDF et permet aux utilisateurs de s'engager dans une conversation avec le document à l'aide de l'API OpenAI.
  3. Aperçu PDF : Les utilisateurs peuvent prévisualiser le document PDF réel avec lequel ils interagissent, en utilisant le puissant package React Component, @ React-PDF-Viewer.
  4. Liste des PDF : l'application fournit une liste de tous les documents PDF téléchargés stockés dans la base de données Supabase.
  5. Supprimer un PDF : les utilisateurs ont la possibilité de supprimer un document de la base de données.
  6. CITE SOURCES : L'interface de chat AI fournit des sources du PDF pour chaque réponse, permettant aux utilisateurs de naviguer directement vers la référence dans le PDF.

Exemples d'utilisation

ChatPDF-GPT est équipé d'exemples qui illustrent diverses opérations telles que:

  1. Interagir avec Pinecone: Sauver les intégres, supprimer un enregistrement.
  2. Télécharger un fichier sur Supabase Storage et supprimer également un fichier.
  3. Listing Documents disponibles dans la base de données Supabase.
  4. Aperçu d'un PDF à l'aide du @ react-pdf-Viewer.
  5. Naviguer directement vers la source d'une réponse AI dans le PDF.

Test rapide à l'aide de la démo

Pour tester les fonctionnalités de ce projet à l'aide de la démo, vous devrez fournir vos propres informations d'identification pour OpenAI, Supabase et PineCone. Pour Supabase, vous pouvez suivre le guide étape par étape fourni ci-dessous pour configurer et récupérer les informations d'identification nécessaires. Pour acquérir des informations d'identification pour OpenAI et Pinecone, veuillez consulter la documentation correspondante en tant que guide étape par étape peut ne pas être disponible. Assurez-vous toujours que vous suivez les dernières instructions fournies par les services respectifs.

1. Openai

Openai

2. Supabase

  1. Création d'un nouveau projet à Supabase :

    • Ouvrez votre navigateur Web et accédez à App.supabase.io.
    • Cliquez sur "Nouveau projet".
    • Entrez les détails de votre projet et attendez que la nouvelle base de données PostgreSQL se lance. Cela peut prendre quelques minutes pour que le processus se termine.

  2. Récupération de l'URL de connexion de la base de données :

    • Une fois votre base de données créée avec succès, accédez à la page de votre projet.
    • Accédez à la section "Paramètres".
    • Cliquez sur l'onglet "Base de données" dans la barre latérale.
    • Faites défiler vers le bas de la page et recherchez la section "String de connexion".
    • Choisissez "Nodejs" et copiez l'URL.

Cette chaîne de connexion sera utilisée pour la variable d'environnement DATABASE_URL dans votre application.

  1. Récupération de la chaîne de connexion de raccordement de connexion :
    • Toujours dans l'onglet "base de données" de la section "Paramètres", faites défiler pour trouver la section "Poorage de connexion".
    • Choisissez "NodeJS" et copiez l'URL de mise en commun des connexions.

Cette URL sera utilisée pour la variable d'environnement DIRECT_URL dans votre application.

  1. Récupération des clés de stockage :
    • À partir de la page de votre projet, accédez à la section "Paramètres".
    • Cliquez sur l'onglet "API" dans la barre latérale.
    • Ici, vous trouverez votre SUPABASE_URL et SUPABASE_KEY . Copiez ces valeurs.

Le SUPABASE_URL est l'URL de votre projet, tandis que SUPABASE_KEY est la clé anonyme publique de votre projet.

  1. Configuration du seau Supabase :

    • À partir de la page de votre projet, accédez à la section "stockage".
    • Ici, créez un nouveau seau ou utilisez un existant. Le nom du seau sera utilisé comme SUPABASE_BUCKET dans votre application.

  2. Configuration des variables d'environnement dans votre application :

    • Maintenant, accédez à votre projet où vous utilisez Supabase.
    • Ajoutez les variables d'environnement suivantes avec les valeurs que vous avez copiées à partir de la console Supabase:
      • DATABASE_URL
      • DIRECT_URL
      • SUPABASE_KEY
      • SUPABASE_URL
      • SUPABASE_BUCKET

Ces clés permettront à votre application d'interagir avec les services Supabase.

  1. Gestion des politiques de seau de stockage :
    • Accédez à la section "Stockage" à partir de la page de votre projet.
    • Cliquez sur le seau pour lequel vous souhaitez gérer les politiques.
    • Cliquez sur l'onglet "Politiques" pour afficher les politiques existantes pour le seau.
    • Pour créer une nouvelle stratégie, cliquez sur le bouton "Créer la stratégie" et remplissez les détails de la politique conformément à vos besoins.
    • Pour modifier une politique existante, cliquez sur la politique dans la liste et apportez les modifications nécessaires.

Veuillez noter que s'il est possible de définir une politique qui rend votre seau de stockage accessible au public, vous devez le faire avec prudence. Rendre votre seau accessible publiquement signifie que toute personne ayant l'URL vers un objet peut y accéder. Cela peut être utile pour les tests, mais pour les applications de production, vous devriez considérer des politiques plus restrictives pour assurer la sécurité de vos données. Consultez toujours la documentation Supabase ou un expert en sécurité pour comprendre les implications des différentes politiques.

Avec cela, vous devriez être en mesure de configurer Supabase pour votre projet et de gérer les politiques de stockage conformément à vos exigences.

3. Pincone

Pignon

Configuration et installation

Pour configurer et exécuter le chatpdf-gpt sur votre machine locale, suivez les étapes ci-dessous:

  1. Clone le référentiel du projet: 

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

  2. Naviguez dans le répertoire du projet et installez les dépendances à l'aide de PNPM: 

 cd chatpdf-gpt
pnpm install

  1. Créez un fichier .env dans le répertoire racine et remplissez vos informations d'identification (Openai, Pinecone, Supabase) comme indiqué dans le fichier .env.example .

  2. Créez le schéma de base de données à l'aide de prisma. Vous devez vous faire exécuter le prisma prisma generate le commande 

     npx prisma migrate dev --name init

  3. Démarrez le serveur: 

     npm run dev

Contribution

ChatPDF-GPT est un projet open-source et nous accueillons chaleureusement les contributions de tout le monde. Veuillez lire notre guide de contribution pour plus de détails sur la façon de commencer.

Crédits

Ce projet est sur les épaules des géants. Notre travail ne serait pas possible sans la vaste gamme de bibliothèques, de cadres et d'outils que la communauté open source a produite. Plus précisément, nous aimerions exprimer notre appréciation:

  1. L'équipe de Langchain pour son cadre révolutionnaire pour les applications propulsées par des modèles de langue.

  2. Openai pour leurs modèles de langue de pointe, ce qui rend la fonctionnalité de chat possible.

  3. Supabase pour leur alternative de base de feu open source que nous avons utilisée pour construire des backends sécurisés et performants.

  4. Pinecone pour leur base de données vectorielle qui permet un stockage et une récupération faciles et efficaces des incorporations vectorielles.

  5. Next.js et Vercel pour leur cadre complet qui nous a permis de créer cette application Web complète avec facilité.

  6. Shadcn pour leurs composants d'interface utilisateur élégants sur lesquels nous avons construit pour créer une interface belle et conviviale.

  7. Radix UI pour leur bibliothèque de composants robuste, accessible et personnalisable qui forme l'épine dorsale de notre interface utilisateur.

  8. @ React-PDF-Viewer pour leur puissant composant React, qui permet aux utilisateurs de prévisualiser le document PDF réel avec lequel ils interagissent.

Et toutes les autres dépendances, énumérées et non répertoriées, qui ont contribué à la réalisation de ce projet. Notre contribution est modeste par rapport à leur effort collectif.

Licence

ChatPDF-GPT est un logiciel open-source sous licence MIT.

Développer
Informations supplémentaires
Applications connexes
Recommandé pour vous
Actualités connexes Tout