README.md

Readme

TLDR;

This project shows how to use LLMs for different tasks. It uses Streamlit as the frontend and LangChain and OpenAi as the backend.

How to run

Requirements

You need to have docker and docker-compose (if you are using an old version of docker) installed in your machine. To use the system, you need to have an OpenAi API key. You can get one here. The key needs to be loaded in the app using the Start Here section in the sidebar.

Running

To run the project, you need to run the following command in the repo root:

docker compose up --build

After that, you can access the project in your browser at http://localhost:8501.

Testing

To run the tests, you need to run the following command:

cd frontend
poetry run python -m pytest

Sample files references

The sample files are taken from the following sources:

• AI-for-Education-RAG: AI for Education
• alice.txt: Project Gutenberg
• ArtOfWar-SunTzu.docx: Exported to Docs from Project Gutenberg