Inicio>Relacionado con la programación>Otro código fuente
Descargar

Chatpdf-gpt

Introducción

ChatPDF-GPT es un proyecto innovador que aprovecha el poder del marco Langchain, una herramienta transformadora para desarrollar aplicaciones alimentadas por modelos de idiomas. Esta aplicación única utiliza Langchain para ofrecer una interfaz de chat que se comunique con los documentos PDF, impulsados ​​por las capacidades de los modelos de idiomas de OpenAI.

En este proyecto, el modelo de lenguaje está conectado a otras fuentes de datos y permite la interacción con su entorno, lo que incorpora los principios del marco Langchain. Los usuarios pueden cargar un documento PDF, que luego se procesa y guarda en Pinecone, una base de datos vectorial y almacenamiento de Supabase. Luego, los usuarios pueden chatear con el PDF cargado, con la IA utilizando el contenido del documento para participar en una conversación significativa.

El proyecto se basa en el marco Next.js, una opción líder para crear aplicaciones web robustas y completas. Los componentes de la interfaz de usuario están bellamente diseñados utilizando la biblioteca Radix UI y están diseñados con CSS de viento de cola, basada en la elegante plantilla proporcionada por Shadcn/UI.

Características

  1. Cargue un PDF : los usuarios pueden cargar un documento PDF, que luego se almacena en la base de datos Vector de Pinecone y el almacenamiento de Supabase.
  2. Chat con PDF : la aplicación procesa el contenido del PDF y permite a los usuarios entablar una conversación con el documento utilizando la API de OpenAI.
  3. Vista previa de PDF : los usuarios pueden obtener una vista previa del documento PDF real con el que están interactuando, utilizando el poderoso paquete de componentes React, @React-PDF-Viewer.
  4. Lista de PDF : la aplicación proporciona una lista de todos los documentos PDF cargados almacenados en la base de datos SUPABASE.
  5. Eliminar un PDF : los usuarios tienen la capacidad de eliminar un documento de la base de datos.
  6. Fuentes de cita : la interfaz de chat AI proporciona fuentes del PDF para cada respuesta, lo que permite a los usuarios navegar directamente a la referencia en el PDF.

Ejemplos de uso

ChatPDF-GPT está equipado con ejemplos que ilustran varias operaciones como:

  1. Interactuar con Pinecone: Guardar incrustaciones, eliminar un registro.
  2. Cargar un archivo para el almacenamiento de Supabase y también eliminar un archivo.
  3. Listado de documentos disponibles de Supabase Database.
  4. Vista previa de un PDF utilizando el Viewer @React-PDF.
  5. Navegando directamente a la fuente de una respuesta de IA en el PDF.

Pruebas rápidas usando la demostración

Para probar la funcionalidad de este proyecto utilizando la demostración, deberá proporcionar sus propias credenciales para OpenAI, Supabase y Pinecone. Para Supabase, puede seguir la guía paso a paso que se proporciona a continuación para configurar y recuperar las credenciales necesarias. Para adquirir credenciales para OpenAI y Pinecone, consulte la documentación correspondiente como una guía paso a paso puede no estar disponible. Siempre asegúrese de seguir las últimas instrucciones proporcionadas por los servicios respectivos.

1. OpenAi

Opadai

2. Supabase

  1. Creación de un nuevo proyecto en Supabase :

    • Abra su navegador web y navegue a App.supabase.io.
    • Haga clic en "Nuevo proyecto".
    • Ingrese los detalles de su proyecto y espere a que se inicie la nueva base de datos PostgreSQL. El proceso puede tardar unos minutos en completarse.

  2. Recuperación de la URL de conexión de la base de datos :

    • Una vez que su base de datos se cree con éxito, navegue a la página de su proyecto.
    • Vaya a la sección "Configuración".
    • Haga clic en la pestaña "Base de datos" en la barra lateral.
    • Desplácese hacia abajo hasta la parte inferior de la página y busque la sección "Cadena de conexión".
    • Elija "NodeJS" y copie la URL.

Esta cadena de conexión se utilizará para la variable de entorno DATABASE_URL en su aplicación.

  1. Recuperación de la cadena de conexión de agrupación de la conexión :
    • Todavía en la pestaña "Base de datos" de la sección "Configuración", desplácese para encontrar la sección "Agrupación de conexión".
    • Elija "NodeJS" y copie la URL de agrupación de conexión.

Esta URL se utilizará para la variable de entorno DIRECT_URL en su aplicación.

  1. Recuperando las llaves de almacenamiento :
    • Desde la página de su proyecto, vaya a la sección "Configuración".
    • Haga clic en la pestaña "API" en la barra lateral.
    • Aquí, encontrarás tu SUPABASE_URL y SUPABASE_KEY . Copiar estos valores.

El SUPABASE_URL es la URL para su proyecto, mientras que SUPABASE_KEY es la clave anónima pública para su proyecto.

  1. Configuración del cubo de Supabase :

    • Desde la página de su proyecto, vaya a la sección "Almacenamiento".
    • Aquí, cree un nuevo cubo o use uno existente. El nombre del cubo se utilizará como SUPABASE_BUCKET en su aplicación.

  2. Configuración de variables de entorno en su aplicación :

    • Ahora, navegue a su proyecto donde esté utilizando Supabase.
    • Agregue las siguientes variables de entorno con los valores que copió de la consola Supabase:
      • DATABASE_URL
      • DIRECT_URL
      • SUPABASE_KEY
      • SUPABASE_URL
      • SUPABASE_BUCKET

Estas claves permitirán que su aplicación interactúe con los servicios de Supabase.

  1. Gestión de políticas de cubo de almacenamiento :
    • Navegue a la sección "Almacenamiento" desde la página de su proyecto.
    • Haga clic en el cubo para el que desea administrar las políticas.
    • Haga clic en la pestaña "Políticas" para ver las políticas existentes para el cubo.
    • Para crear una nueva política, haga clic en el botón "Crear política" y complete los detalles de la política según sus requisitos.
    • Para editar una política existente, haga clic en la política de la lista y realice los cambios necesarios.

Tenga en cuenta que si bien es posible establecer una política que haga que su cubo de almacenamiento sea accesible públicamente, debe hacerlo con precaución. Hacer su cubo de acceso público significa que cualquier persona con URL a un objeto puede acceder a él. Esto puede ser útil para las pruebas, pero para las aplicaciones de producción, debe considerar políticas más restrictivas para garantizar la seguridad de sus datos. Siempre consulte la documentación de Supabase o un experto en seguridad para comprender las implicaciones de diferentes políticas.

Con esto, debería poder configurar Supabase para su proyecto y administrar las políticas de almacenamiento según sus requisitos.

3. Pincone

Piña

Configuración e instalación

Para configurar y ejecutar chatpdf-gpt en su máquina local, siga los pasos a continuación:

  1. Clon el repositorio del proyecto: 

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

  2. Navegue al directorio del proyecto e instale las dependencias utilizando PNPM: 

 cd chatpdf-gpt
pnpm install

  1. Cree un archivo .env en el directorio raíz y complete sus credenciales (OpenAI, Pinecone, Supabase) como se indica en el archivo .env.example .

  2. Cree el esquema de la base de datos usando prisma. Debes hacer que haya ejecutado el prisma generar comando prisma generate 

     npx prisma migrate dev --name init

  3. Inicie el servidor: 

     npm run dev

Contribución

ChatPDF-GPT es un proyecto de código abierto y damos la bienvenida a las contribuciones de todos. Lea nuestra guía de contribución para obtener más detalles sobre cómo comenzar.

Créditos

Este proyecto se encuentra en los hombros de los gigantes. Nuestro trabajo no sería posible sin la amplia gama de bibliotecas, marcos y herramientas que la comunidad de código abierto ha producido. Específicamente, nos gustaría expresar nuestro agradecimiento a:

  1. El equipo de Langchain por su marco innovador para aplicaciones alimentadas por modelos de idiomas.

  2. OpenAi para sus modelos de idiomas de última generación, que hacen posible la funcionalidad de chat.

  3. Supabase por su alternativa de base de fuego de código abierto que utilizamos para construir backends seguros y performadores.

  4. Pinecone para su base de datos vectorial que permite un almacenamiento y recuperación fácil y eficiente de las integridades vectoriales.

  5. Next.js y Vercel por su marco integral que nos permitió construir esta aplicación web de pila completa con facilidad.

  6. Shadcn para sus elegantes componentes de la interfaz de usuario en los que construimos para crear una interfaz hermosa y fácil de usar.

  7. Radix UI para su biblioteca de componentes robusta, accesible y personalizable que forma la columna vertebral de nuestra interfaz de usuario.

  8. @React-PDF-Viewer para su poderoso componente React, que permite a los usuarios obtener una vista previa del documento PDF real con el que están interactuando.

Y todas las otras dependencias, tanto enumeradas como en la lista, que contribuyeron a la realización de este proyecto. Nuestra contribución es modesta en comparación con su esfuerzo colectivo.

Licencia

ChatPDF-GPT es un software de código abierto con licencia bajo la licencia MIT.

Expandir
Información adicional
Aplicaciones relacionadas
Recomendado para ti
Información relacionada Todo