chatpdf gpt

Chatpdf-gpt

Perkenalan

ChatPDF-GPT adalah proyek inovatif yang memanfaatkan kekuatan kerangka kerja Langchain, alat transformatif untuk mengembangkan aplikasi yang didukung oleh model bahasa. Aplikasi unik ini menggunakan Langchain untuk menawarkan antarmuka obrolan yang berkomunikasi dengan dokumen PDF, didorong oleh kemampuan model bahasa Openai.

Dalam proyek ini, model bahasa terhubung ke sumber data lain dan memungkinkan interaksi dengan lingkungannya, sehingga mewujudkan prinsip -prinsip kerangka kerja Langchain. Pengguna dapat mengunggah dokumen PDF, yang kemudian diproses dan disimpan di Pinecone, database vektor, dan penyimpanan Supabase. Pengguna kemudian dapat mengobrol dengan PDF yang diunggah, dengan AI menggunakan konten dokumen untuk terlibat dalam percakapan yang bermakna.

Proyek ini bergantung pada Framework Next.js, pilihan utama untuk membuat aplikasi web full-stack yang kuat. Komponen UI dibuat dengan indah menggunakan perpustakaan Radix UI dan ditata dengan CSS tailwind, berdasarkan templat elegan yang disediakan oleh Shadcn/UI.

Fitur

1. Unggah PDF : Pengguna dapat mengunggah dokumen PDF, yang kemudian disimpan dalam database vektor Pinecone dan penyimpanan Supabase.
2. Obrolan dengan PDF : Aplikasi memproses konten PDF dan memungkinkan pengguna untuk terlibat dalam percakapan dengan dokumen menggunakan API OpenAI.
3. Pratinjau PDF : Pengguna dapat melihat pratinjau dokumen PDF aktual yang mereka berinteraksi dengan, menggunakan paket komponen React yang kuat, @react-pdf-viewer.
4. Daftar PDF : Aplikasi ini menyediakan daftar semua dokumen PDF yang diunggah yang disimpan dalam database Supabase.
5. Hapus PDF : Pengguna memiliki kemampuan untuk menghapus dokumen dari database.
6. CITE SUMBER : Antarmuka obrolan AI menyediakan sumber dari PDF untuk setiap balasan, yang memungkinkan pengguna untuk menavigasi langsung ke referensi di PDF.

Contoh penggunaan

ChatPDF-GPT dilengkapi dengan contoh-contoh yang menggambarkan berbagai operasi seperti:

1. Berinteraksi dengan Pinecone: Menyimpan Embeddings, Menghapus Catatan.
2. Mengunggah file ke penyimpanan Supabase dan juga menghapus file.
3. Daftar dokumen yang tersedia dari database Supabase.
4. Pratinjau PDF menggunakan @react-pdf-viewer.
5. Menavigasi langsung ke sumber balasan AI di PDF.

Pengujian Cepat Menggunakan Demo

Untuk menguji fungsionalitas proyek ini menggunakan demo, Anda perlu memberikan kredensial Anda sendiri untuk OpenAI, Supabase, dan Pinecone. Untuk Supabase, Anda dapat mengikuti panduan langkah demi langkah yang disediakan di bawah ini untuk mengatur dan mengambil kredensial yang diperlukan. Untuk memperoleh kredensial untuk Openai dan Pinecone, silakan berkonsultasi dengan dokumentasi yang sesuai sebagai panduan langkah demi langkah mungkin tidak tersedia. Selalu pastikan Anda mengikuti instruksi terbaru yang disediakan oleh Layanan masing -masing.

1. Openai

Openai

2. Supabase

1. Membuat proyek baru di Supabase :

   • Buka browser web Anda dan navigasikan ke app.upabase.io.
   • Klik "Proyek Baru".
   • Masukkan detail proyek Anda dan tunggu database PostgreSQL baru diluncurkan. Mungkin perlu beberapa menit untuk diselesaikan proses.

2. Mengambil URL Koneksi Basis Data :

   • Setelah basis data Anda berhasil dibuat, navigasikan ke halaman proyek Anda.
   • Buka bagian "Pengaturan".
   • Klik tab "Database" di bilah sisi.
   • Gulir ke bawah ke bagian bawah halaman dan cari bagian "Connection String".
   • Pilih "NodeJs" dan salin URL.

String koneksi ini akan digunakan untuk variabel lingkungan DATABASE_URL di aplikasi Anda.

3. Mengambil string koneksi koneksi koneksi :
   • Masih di tab "Database" pada bagian "Pengaturan", gulir untuk menemukan bagian "Koneksi Pooling".
   • Pilih "NodeJs" dan salin URL Pooling Koneksi.

URL ini akan digunakan untuk variabel lingkungan DIRECT_URL di aplikasi Anda.

4. Mengambil Kunci Penyimpanan :
   • Dari halaman proyek Anda, buka bagian "Pengaturan".
   • Klik tab "API" di bilah samping.
   • Di sini, Anda akan menemukan SUPABASE_URL dan SUPABASE_KEY Anda. Salin nilai -nilai ini.

SUPABASE_URL adalah URL untuk proyek Anda, sedangkan SUPABASE_KEY adalah kunci anonim publik untuk proyek Anda.

5. Menyiapkan Supabase Bucket :

   • Dari halaman proyek Anda, buka bagian "Penyimpanan".
   • Di sini, buat ember baru atau gunakan yang sudah ada. Nama ember akan digunakan sebagai SUPABASE_BUCKET di aplikasi Anda.

6. Menyiapkan variabel lingkungan dalam aplikasi Anda :

   • Sekarang, arahkan ke proyek Anda di mana Anda menggunakan Supabase.
   • Tambahkan variabel lingkungan berikut dengan nilai yang Anda salin dari konsol Supabase:
     • DATABASE_URL
     • DIRECT_URL
     • SUPABASE_KEY
     • SUPABASE_URL
     • SUPABASE_BUCKET

Kunci -kunci ini akan memungkinkan aplikasi Anda untuk berinteraksi dengan layanan Supabase.

7. Mengelola Kebijakan Bucket Penyimpanan :
   • Arahkan ke bagian "penyimpanan" dari halaman proyek Anda.
   • Klik pada ember tempat Anda ingin mengelola kebijakan.
   • Klik pada tab "Kebijakan" untuk melihat kebijakan yang ada untuk ember.
   • Untuk membuat kebijakan baru, klik tombol "Buat Kebijakan" dan isi detail kebijakan sesuai kebutuhan Anda.
   • Untuk mengedit kebijakan yang ada, klik pada kebijakan dalam daftar dan buat perubahan yang diperlukan.

Harap dicatat bahwa walaupun mungkin untuk menetapkan kebijakan yang membuat ember penyimpanan Anda dapat diakses secara publik, Anda harus melakukan ini dengan hati -hati. Membuat ember Anda dapat diakses secara publik berarti bahwa siapa pun yang memiliki URL ke suatu objek dapat mengaksesnya. Ini mungkin berguna untuk pengujian, tetapi untuk aplikasi produksi, Anda harus mempertimbangkan kebijakan yang lebih ketat untuk memastikan keamanan data Anda. Selalu berkonsultasi dengan dokumentasi Supabase atau pakar keamanan untuk memahami implikasi dari berbagai kebijakan.

Dengan ini, Anda harus dapat mengatur Supabase untuk proyek Anda dan mengelola kebijakan penyimpanan sesuai kebutuhan Anda.

3. Pincone

Pinecone

Pengaturan dan Instalasi

Untuk mengatur dan menjalankan ChatPDF-GPT di mesin lokal Anda, ikuti langkah-langkah di bawah ini:

1. Klon Repositori Proyek:

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

2. Navigasi ke direktori proyek dan instal dependensi menggunakan PNPM:

 cd chatpdf-gpt
pnpm install

3. Buat file .env di direktori root dan isi kredensial Anda (OpenAi, Pinecone, Supabase) seperti yang ditunjukkan dalam file .env.example .

4. Buat skema basis data menggunakan prisma. Anda harus membuat Anda telah menjalankan prisma menghasilkan komando prisma generate

    npx prisma migrate dev --name init
   

5. Mulai server:

    npm run dev
   

Kontribusi

ChatPDF-GPT adalah proyek open-source dan kami sangat menyambut kontribusi dari semua orang. Harap baca panduan berkontribusi kami untuk detail lebih lanjut tentang cara memulai.

Kredit

Proyek ini berdiri di pundak raksasa. Pekerjaan kami tidak akan mungkin terjadi tanpa sejumlah besar perpustakaan, kerangka kerja, dan alat yang telah diproduksi oleh komunitas open source. Secara khusus, kami ingin menyampaikan penghargaan kami kepada:

1. Tim Langchain untuk kerangka kerja inovatif mereka untuk aplikasi yang ditenagai oleh model bahasa.

2. Openai untuk model bahasa canggih mereka, yang memungkinkan fungsi obrolan.

3. Supabase untuk alternatif firebase sumber terbuka mereka yang kami gunakan untuk membangun backend yang aman dan berkinerja.

4. Pinecone untuk basis data vektor mereka yang memungkinkan penyimpanan dan pengambilan embeddings vektor yang mudah dan efisien.

5. Next.js dan Vercel untuk kerangka kerja komprehensif mereka yang memungkinkan kami membangun aplikasi web full-stack ini dengan mudah.

6. Shadcn untuk komponen UI elegan yang kami bangun untuk menciptakan antarmuka yang indah dan ramah pengguna.

7. Radix UI untuk pustaka komponen yang kuat, dapat diakses, dan dapat disesuaikan yang membentuk tulang punggung UI kami.

8. @react-pdf-viewer untuk komponen reaksi kuat mereka, yang memungkinkan pengguna melihat pratinjau dokumen PDF aktual yang mereka berinteraksi dengan.

Dan semua dependensi lainnya, baik terdaftar maupun tidak terdaftar, yang berkontribusi pada realisasi proyek ini. Kontribusi kami sederhana dibandingkan dengan upaya kolektif mereka.

Lisensi

ChatPDF-GPT adalah perangkat lunak open-source yang dilisensikan di bawah lisensi MIT.