ecoCompanion: Your Environmental Management Assistant

Welcome to the ecoCompanion repository! This project is dedicated to developing an assistant capable of addressing queries related to ISO 14001 and EMS (Environmental Management System) using the RAG method and the Gemini model.

Project Overview

Our aim is to empower our model to efficiently respond to inquiries regarding ISO 14001 and EMS. We've curated a specialized corpus from an EMS course within our school semester and a relevant book. By doing so, our model focuses solely on this specific topic and politely declines to answer any questions outside its scope.

To facilitate interactions with the model, we've leveraged Chainlit, an excellent tool that simplifies building a visually appealing interface without requiring UI coding.

Installation

Follow these steps to get the project up and running:

Clone this repository:

git clone https://github.com/ImadSaddik/ecoCompanion.git

Navigate to the project directory:
```
cd ecoCompanion
```
Install the dependencies (assuming you have Python and pip installed):
```
pip install -r requirements.txt
```
Create a new file called .env and place your API key to be able to use the Gemini model
```
GEMINI_API_KEY=""
```
Start the app:
```
 chainlit run app.py -w
```
Enjoy using ecoCompanion!

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

Fork the repository.
Create a new branch for your feature or bug fix: git checkout -b feature-name.
Make your changes and commit them.
Push your changes to your fork: git push origin feature-name.
Open a pull request describing your changes.