chatpdf gpt

Chatpdf-gpt

Введение

CHATPDF-GPT-это инновационный проект, который использует силу Langchain Framework, преобразующего инструмента для разработки приложений, работающих на языковых моделях. Это уникальное приложение использует Langchain, чтобы предложить интерфейс чата, который связывается с PDF -документами, обусловленными возможностями языковых моделей OpenAI.

В этом проекте языковая модель подключена к другим источникам данных и позволяет взаимодействовать с его средой, тем самым воплощая принципы структуры Langchain. Пользователи могут загружать документ PDF, который затем обрабатывается и сохраняется в Pinecone, векторной базе данных и хранении Supabase. Затем пользователи могут общаться с загруженным PDF, и ИИ использует содержание документа для участия в значимом разговоре.

Проект опирается на Framework Next.js, ведущий выбор для создания надежных, полных веб-приложений. Компоненты пользовательского интерфейса красиво изготовлены с использованием библиотеки пользовательского интерфейса Radix и стилизованы с Tailwind CSS, на основе элегантного шаблона, предоставленного Shadcn/UI.

Функции

1. Загрузите PDF : пользователи могут загружать PDF -документ, который затем хранится в базе данных Vector Vector Pinecone и хранении Supabase.
2. Общайтесь с PDF : приложение обрабатывает содержание PDF и позволяет пользователям вести разговор с документом с помощью API OpenAI.
3. Предварительный просмотр PDF : пользователи могут предварительно просмотреть фактический документ PDF, с которым они взаимодействуют, используя мощный пакет компонентов React, @React-PDF-Viewer.
4. Список PDFS : в приложении содержится список всех загруженных документов PDF, хранящихся в базе данных Supabase.
5. Удалить PDF : пользователи могут удалить документ из базы данных.
6. Источники цитирования : интерфейс чата AI предоставляет источники из PDF для каждого ответа, что позволяет пользователям перейти непосредственно к ссылке в PDF.

Примеры использования

CHATPDF-GPT оснащен примерами, которые иллюстрируют различные операции, такие как:

1. Взаимодействие с Pinecone: сохранение встраиваний, удаление записи.
2. Загрузка файла в хранилище Supabase, а также удаление файла.
3. Перечисление доступных документов из базы данных Supabase.
4. Предварительное просмотр PDF с использованием @React-PDF-Viewer.
5. Навигация непосредственно к источнику ответа ИИ в PDF.

Быстрое тестирование с использованием демонстрации

Чтобы проверить функциональность этого проекта, используя демонстрацию, вам необходимо предоставить свои собственные учетные данные для OpenAI, Supabase и Pinecone. Для Supabase вы можете следовать пошаговому руководству, представленному ниже для настройки и получения необходимых учетных данных. Для получения учетных данных для Openai и Pinecone, пожалуйста, обратитесь к соответствующей документации в качестве пошагового руководства, возможно, недоступны. Всегда убедитесь, что вы следите за последними инструкциями, предоставленными соответствующими службами.

1. Openai

Openai

2. Supabase

1. Создание нового проекта в Supabase :

   • Откройте свой веб -браузер и перейдите к 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_BUCKET в вашем приложении.

6. Настройка переменных среды в вашем приложении :

   • Теперь перейдите к своему проекту, где вы используете Supabase.
   • Добавьте следующие переменные среды со значениями, которые вы скопировали из консоли Supabase:
     • DATABASE_URL
     • DIRECT_URL
     • SUPABASE_KEY
     • SUPABASE_URL
     • SUPABASE_BUCKET

Эти ключи позволят вашему приложению взаимодействовать со службами Supabase.

7. Управление политиками ведра хранения :
   • Перейдите в раздел «Хранение» со страницы вашего проекта.
   • Нажмите на ведро, для которого вы хотите управлять политиками.
   • Нажмите на вкладку «Политики», чтобы просмотреть существующие политики для ведра.
   • Чтобы создать новую политику, нажмите кнопку «Создать политику» и заполните подробности политики в соответствии с вашими требованиями.
   • Чтобы редактировать существующую политику, нажмите на политику в списке и внесите необходимые изменения.

Обратите внимание, что, хотя можно установить политику, которая делает ваше ведро для хранения общедоступным, вы должны сделать это с осторожностью. Сделать ваше ведро общедоступным означает, что любой, у кого есть URL -адрес объект, может получить к нему доступ. Это может быть полезно для тестирования, но для производственных приложений вы должны рассмотреть более ограничительную политику для обеспечения безопасности ваших данных. Всегда консультируйтесь с документацией Supabase или экспертом по безопасности, чтобы понять последствия различных политик.

При этом вы сможете настроить Supabase для вашего проекта и управлять политиками хранения в соответствии с вашими требованиями.

3. Пинкон

Pinecone

Настройка и установка

Чтобы настроить и запустить Chatpdf-GPT на вашей локальной машине, выполните следующие шаги:

1. Клонировать репозиторий проекта:

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

2. Перейдите в каталог проекта и установите зависимости, используя PNPM:

 cd chatpdf-gpt
pnpm install

3. Создайте файл .env в корневом каталоге и заполните свои учетные данные (Openai, Pinecone, Supabase), как указано в файле .env.example .

4. Создайте схему базы данных, используя Prisma. Вы должны заставить вас запустить Prisma Generate Command prisma generate

    npx prisma migrate dev --name init
   

5. Запустить сервер:

    npm run dev
   

Вклад

CHATPDF-GPT-это проект с открытым исходным кодом, и мы тепло приветствуем взносы всех. Пожалуйста, прочитайте наше руководство для получения более подробной информации о том, как начать.

Кредиты

Этот проект стоит на плечах гигантов. Наша работа была бы невозможна без огромного количества библиотек, рамок и инструментов, которые создало сообщество с открытым исходным кодом. В частности, мы хотели бы выразить нашу признательность:

1. Команда Langchain за их новаторскую структуру для приложений, основанных на языковых моделях.

2. Openai для их современных языковых моделей, которые делают возможным функциональность чата.

3. Supabase для их альтернативы Firebase с открытым исходным кодом, которую мы использовали для создания безопасных и эффективных бэкэндов.

4. Pinecone для их векторной базы данных, которая позволяет легко и эффективно хранить и извлекать векторные встраивания.

5. Next.js и Vercel для их комплексной структуры, которая позволила нам с легкостью создать это веб-приложение с полным стеком.

6. Shadcn для их элегантных компонентов пользовательского интерфейса, которые мы создали, чтобы создать красивый и удобный интерфейс.

7. Radix UI для их надежной, доступной и настраиваемой библиотеки компонентов, которая формирует основу нашего пользовательского интерфейса.

8. @React-PDF-Viewer для их мощного компонента React, который позволяет пользователям предварительно просмотреть фактический документ PDF, с которым они взаимодействуют.

И все остальные зависимости, как перечисленные, так и не перечисленные, которые способствовали реализации этого проекта. Наш вклад скромный по сравнению с их коллективными усилиями.

Лицензия

CHATPDF-GPT-это программное обеспечение с открытым исходным кодом, лицензированное по лицензии MIT.