chat with your doc

obrolan-dengan-doc-mu

chat-with-your-doc adalah aplikasi demonstrasi yang memanfaatkan kemampuan ChatGPT/GPT-4 dan Langchain untuk memungkinkan pengguna mengobrol dengan dokumen mereka. Repositori ini meng -host basis kode, instruksi, dan sumber daya yang diperlukan untuk mengatur dan menjalankan aplikasi.

Perkenalan

Tujuan utama dari proyek ini adalah untuk menyederhanakan interaksi dengan dokumen dan mengekstrak informasi berharga dengan menggunakan bahasa alami. Proyek ini dibangun menggunakan Langchain dan GPT-4/ChatGPT untuk memberikan pengalaman percakapan yang mulus dan alami kepada pengguna, dengan dukungan untuk Azure OpenAI Services dan OpenAI

Pembaruan

• 20230709: Tambahkan dukungan untuk API Openai
• 20230703: Web UI diubah menjadi streamlit, dengan dukungan untuk streaming

Fitur

• Unggah dokumen sebagai basis pengetahuan eksternal untuk GPT-4/ChatGPT, mendukung Azure OpenAI Services dan OpenAI
• Dukung berbagai format termasuk PDF, DOCX, PPTX, TXT dan dll.
• Obrolan dengan konten dokumen, ajukan pertanyaan, dan dapatkan jawaban yang relevan berdasarkan konteksnya.
• Antarmuka ramah pengguna untuk memastikan interaksi yang mulus.

Todo

• [x] Tampilkan dokumen sumber untuk jawaban di Web GUI
• [x] mendukung streaming jawaban
• Dukungan SWITH Jenis Rantai dan Output Langchain Streaming di Web GUI

Arsitektur

Instalasi

Sarankan untuk menginstal di Ubuntu, bukan Centos/Debian. Lihat masalah #12

Untuk memulai dengan Chat-with-your-doc , ikuti langkah-langkah ini:

1. Klon Repositori:

git clone https://github.com/linjungz/chat-with-your-doc.git

2. Ubah ke Direktori chat-with-your-doc :

 cd chat-with-your-doc

3. Pasang paket Python yang diperlukan:

Buat lingkungan virtual:

python3 -m venv .venv
source .venv/bin/activate

Instal depenansi:

pip install -r requirements.txt

Konfigurasi

Dalam proyek ini kami mendukung API dari Openai dan Azure Openai Service. Ada beberapa variabel lingkungan yang umum untuk dua API sementara beberapa unik. Tabel berikut mencantumkan semua var vars yang didukung:

Variabel Lingkungan	Layanan Openai Azure	Openai
Openai_api_base	✅
Openai_api_key	✅	✅
Openai_gpt_deployment_name	✅
Openai_embedding_deployment_name	✅	✅
Chat_model_name		✅
Request_timeout	✅	✅
Vectorbb_path	✅	✅
SUHU	✅	✅
Chunk_size	✅	✅
Chunk_overlap	✅	✅

Azure Openai Services

1. Dapatkan Kunci API Openai Azure Anda, titik akhir dan nama penyebaran dari portal Azure.
2. Buat .env di root dir dan atur variabel lingkungan dalam file:

 OPENAI_API_BASE=https://your-endpoint.openai.azure.com
OPENAI_API_KEY=your-key-here
OPENAI_GPT_DEPLOYMENT_NAME=your-gpt-deployment-name
OPENAI_EMBEDDING_DEPLOYMENT_NAME=your-embedding-deployment-name

Di sinilah Anda dapat menemukan nama penempatan untuk GPT dan embedding:

Openai

1. Dapatkan kunci API OpenAI Anda dari platform.openai.com.
2. Buat .env di root dir dan atur variabel lingkungan dalam file:

 OPENAI_API_KEY=your-key-here
CHAT_MODEL_NAME="gpt-4-0314"

Penggunaan: Web

Ini akan menginisialisasi aplikasi berdasarkan Streamlit dan membuka antarmuka pengguna di browser web default Anda. Anda sekarang dapat mengunggah dokumen untuk membuat basis pengetahuan dan memulai percakapan dengannya.

$ streamlit run chat_web_st.py --server.address ' 0.0.0.0 '

Collecting usage statistics. To deactivate, set browser.gatherUsageStats to False.


  You can now view your Streamlit app in your browser.

  URL: http://0.0.0.0:8501 ` ` `

Perhatikan bahwa UI Web sebelumnya yang dibangun menggunakan gradio sudah usang dan tidak lagi dipertahankan. Anda dapat menemukan kode di file chat_web.py.

Penggunaan: Cli

Aplikasi CLI dibangun untuk mendukung perintah ingest dan chat . Perpustakaan Python typer digunakan untuk membangun antarmuka baris perintah.

Menelan

Perintah ini akan mengambil dokumen sebagai input, membagi teks, menghasilkan embeddings dan menyimpan di toko vektor FAISS . Toko vektor akan disimpan secara lokal untuk kemudian digunakan untuk mengobrol.

Misalnya jika Anda ingin memasukkan semua PDF di direktori ke dalam satu toko vektor tunggal bernama surface , Anda dapat menjalankan:

$ python chat_cli.py ingest --path " ./data/source_documents/*.pdf " --name surface

Perhatikan bahwa jalur harus dilampirkan dengan kutipan ganda untuk menghindari ekspansi shell.

Mengobrol

Perintah ini akan memulai obrolan interaktif, dengan dokumen sebagai basis pengetahuan eksternal di toko vektor. Anda dapat memilih basis pengetahuan mana yang akan dimuat untuk mengobrol.

Dua dokumen sampel tentang permukaan telah disediakan di Data/Source_Document Directory dan sudah dicerna ke dalam index toko vektor default, disimpan dalam data/vektor_store. Anda dapat menjalankan perintah berikut untuk memulai obrolan dengan dokumen:

$ python chat_cli.py chat

Atau Anda bisa menentukan toko vektor untuk dimuat untuk obrolan:

$ python chat_cli.py chat --name surface

Referensi

Langchain dimanfaatkan untuk dengan cepat membangun alur kerja yang berinteraksi dengan Azure GPT-4. ConversationalRetrievalChain digunakan dalam kasus penggunaan khusus ini untuk mendukung riwayat obrolan. Anda dapat merujuk ke tautan ini untuk lebih detail.

Untuk chaintype , secara default stuff . Untuk detail lebih lanjut, silakan merujuk ke tautan ini

Kredit

• Penggunaan Langchain terinspirasi oleh GPT4-PDF-CHATBOT-LANGCHAIN
• Integrasi streaming langchain dan stremlit terinspirasi oleh contoh -contoh dari streamlit
• Pemrosesan dokumen terinspirasi oleh OpenAienterPriseChatBotandqa

Lisensi

chat-with-your-doc dirilis di bawah lisensi MIT. Lihat file LICENSE untuk lebih jelasnya.