getting-started.md

Getting Started

Follow these steps to get started with the workshop.

Prerequisites

To successfully complete this workshop, ensure you have the following:

• A Box account, you can use the free developer account.
• A Box CCG application created in your Box account (see this guide).
• Python 3.12 or higher installed on your machine.

Clone the Repository:

git clone [email protected]:box-community/Box-RAG-Workshop.git
cd Box-RAG-Workshop

Create a python virtual environment:

On MacOS and Linux (Python 3.12)

python3.12 -m venv .venv
source .venv/bin/activate
pip install --upgrade pip
pip install -r requirements.txt

On Windows CMD (Python 3.12)

python3 -m venv .venv
.venv\Scripts\activate.bat
pip install --upgrade pip
pip install -r requirements.txt

On Windows PowerShell (Python 3.12)

python3 -m venv .venv
.venv\Scripts\Activate.ps1
pip install --upgrade pip
pip install -r requirements.txt

Setup your environment:

Create a .env file in the root directory of the project and add your Box API credentials:

# CCG settings
BOX_CLIENT_ID = YOUR_CLIENT_ID
BOX_CLIENT_SECRET = YOUR_CLIENT_SECRET

BOX_ENTERPRISE_ID = YOUR_ENTERPRISE_ID
BOX_USER_ID = YOUR_USER_ID

BOX_ROOT_DEMO_FOLDER = YOUR_ROOT_FOLDER_ID_TO_STORE_SAMPLES

# Open AI Chroma Settings
OPENAI_API_KEY = YOUR_OPENAI_API_KEY
TOKENIZERS_PARALLELISM = False

Initialize the Box workshop:

Run the gen_sample_data.py script to generate sample data in your Box account:

python src/gen_sample_data.py

You should see a summary of your configurations and the sample data being generated in your Box account.