rag from scratch

RAG from scratch

This repository contains code from the blog posts series on how to build RAG system from scratch.

OpenAI API key

In order to run this project, you need to create an API key in OpenAI:

• Run cp .env.sample .env
• Create an account or log in with you existing one
• Select API keys in the menu on the left
• Click Create new secret key
• Copy the key and paste it in the .env file

Setup

This project is meant to be run with Docker and Devcontainers. The settings are located inside .devcontainer/devcontainer.json.

To set up a devcontainer with your IDE, follow these instructions:

• For VSCode
• For IntelliJ

Once the devcontainer is created, run a terminal inside it and execute:

• poetry install

Setup without Devcontainer

Follow these steps:

• Install Python v3.10 or higher
• Install Poetry
• Run poetry install

Running the project

Explanation on what each script does and how to run it can be found in my blog post.