This project is to develop a chat AI based user interface for the description and configuration of RTDIP data pipelines. Users are to interact with the chat AI to create an RTDIP configuration, consisting of a block configuration (the steps in the pipeline) and PySpark code for individual blocks to perform the data processing. Chat history and generated output should be visible to the user in parallel, e.g. chat history to the left, generated code to the right.
Scrum Master: @SaraElBrak
Product Owners: @AviKatziuk, @ceciliabetb
Software Developers: @lyndanajjar, @bergzain, @Obismadi99, @Nahrain1
The planning document of the team is found here
Ensure that you have installed:
- Python version 3.11 or higher
- Docker Desktop
- OpenAI API Key
To get started with this project, follow these steps:
- Clone the github repository
git clone https://github.com/amosproj/amos2023ws05-pipeline-config-chat-ai.git
- Install Dependencies To set up the required dependencies, create a virtual environment and run the following command:
pip install -r requirements.txt
- Run the Application with Docker
Navigate to thesrc
folder by using:
cd src
Ensure that the Docker daemon is running before proceeding. Follow these steps to run the application:
Step 1: Build the Docker Image
Execute the following command to build the Docker image. Replace <your-image-name>
with your chosen image name:
docker build -t <your-image-name> .
Step 2: Run the Docker Container Launch the container using the following command, specifying port 8501 for Streamlit:
docker run -dp 8501:8501 <your-image-name>
Once the container is successfully running, access the application by clicking the link displayed in the Ports
column within the Docker Desktop interface. This link corresponds to the port mapping configured during the container's launch and serves as the entry point to interact with the application.
Note: Remember to replace with the actual name you assigned to your Docker image.
- Accessing the Chatbot Application
Open your web browser and navigate to the presented link. The Chatbot application will be displayed, prompting you to input your OpenAI API Key. Engage in conversations by posing RTDIP-oriented questions and explore the capabilities of the application.