Welcome to the official repository of the EAK-Copilot challenge, developed as part of the Innovation Fellowship 2024. This project is designed to enhance workplace efficiency and foster innovation by providing AI-supported tools that assist employees in their daily tasks.
This repository serves as a proof of concept (PoC), which is slated to conclude in February 2025. However, we are optimistic that the momentum generated by this innovative challenge will attract continued support and development beyond this timeframe.
Check the website for more information.
COMING SOON: a detailed overview of our project's vision and strategic alignment.
Please check the CONTRIBUTORS.md
file to contribute to the EAK-Copilot project.
The EAK-Copilot currently features:
Here you will find instructions for installing and setting up EAK-Copilot:
Before starting, ensure you have the following software installed on your computer:
Linux users may need to prepend sudo
to Docker commands depending on their Docker configuration.
Clone the Repository
Begin by cloning the EAK-Copilot repository to your local machine to get the necessary project files.
git clone https://github.com/CdC-SI/eak-copilot.git
cd eak-copilot
Setting Up Environment Variables
To use EAK-Copilot, you need to set up some environment variables. Copy the .env.example
file to a new file named .env
and fill in the appropriate values:
cp .env.example .env
Build Docker Images
Build the Docker images using the Docker Compose configuration. This step compiles and launches your Docker environment.
docker-compose up --build -d
Verifying the Installation
Check the status of the containers to confirm everything is running as expected:
docker-compose ps
After the containers are successfully started, verify that the application is running correctly by accessing it through your web browser at http://localhost:4200.
Notes
Sample FAQ and RAG data is automatically indexed when config/config.yaml indexing.faq.auto_index
and indexing.rag.auto_index
are set to true.
To index more extensive FAQ data from https://faq.bsv.admin.ch, navigate to localhost:8000/indexing/docs
and make a request to the /indexing/index_faq_data/
endpoint.