Sure, here's a professional README file for your GitHub repository where you created a Generative AI app using the mentioned technologies:
This repository contains a Generative AI Chatbot application built using Streamlit, Google Generative AI, and several other supporting libraries. The application allows users to ask questions and receive responses generated by the Google Generative AI model.
- Introduction
- Features
- Technologies Used
- Requirements
- Installation
- Usage
- Project Structure
- Acknowledgements
- License
This Generative AI Chatbot application leverages Google Generative AI to provide intelligent and context-aware responses to user queries. The app is built using Streamlit for the web interface and integrates various libraries for enhanced functionality, including text processing, PDF handling, and more.
- Interactive web interface built with Streamlit.
- Integration with Google Generative AI for generating responses.
- Supports PDF processing and content extraction.
- Uses LangChain for managing and processing text inputs.
- Utilizes FAISS for efficient similarity search.
- Environment variable management with python-dotenv.
- Streamlit: For building the web interface.
- Google Generative AI: For generating responses.
- python-dotenv: For loading environment variables.
- LangChain: For handling and processing text data.
- PyPDF2: For extracting text from PDF files.
- ChromaDB: For storing and managing embeddings.
- pdf2image: For converting PDF pages to images.
- faiss-cpu: For efficient similarity search.
- langchain_google_genai: For integrating LangChain with Google Generative AI.
- Python 3.7+
- Streamlit
- google-generativeai
- python-dotenv
- langchain
- PyPDF2
- chromadb
- pdf2image
- faiss-cpu
- langchain_google_genai
-
Clone the repository:
git clone https://github.com/yourusername/generative-ai-chatbot.git cd generative-ai-chatbot -
Install the required libraries:
pip install streamlit google-generativeai python-dotenv langchain PyPDF2 chromadb pdf2image faiss-cpu langchain_google_genai
-
Set up environment variables:
Create a
.envfile in the project directory and add your Google Generative AI API key:GOOGLE_GENERATIVE_AI_API_KEY=your_api_key_here
-
Run the Streamlit app:
streamlit run app.py
-
Open your web browser and navigate to the provided local URL (usually
http://localhost:8501). -
Enter your question in the input field and click the "Ask the question" button to receive a response.
generative-ai-chatbot/
├── app.py # Main application file
├── .env # Environment variables file
├── requirements.txt # Python dependencies
└── README.md # Project README file
- Streamlit for providing an easy-to-use framework for building web apps.
- Google Generative AI for offering powerful AI capabilities.
- LangChain for efficient text processing.
- The authors of PyPDF2, ChromaDB, pdf2image, and faiss-cpu for their excellent libraries.
This project is licensed under the MIT License - see the LICENSE file for details.
Feel free to customize this README file to better suit your project and its specifics.