README.md

Speak-with-your-documents-and-books-app.

Speak with Your Documents and books project allows you to ask a question to an LLM (GPT, CoHere, .. ). It retrieves the most relevant sections from your documents and combines them with the model’s knowledge to provide accurate answers based on your specific content (RAG).

requirements

• python 3.8 or later

Install Python using Anaconda

1. Download and install Anaconda from here
2. Create a new environment using the following command:

$ conda create -n Speak-with-your-documents-and-books-app python=3.8

3. activate the environment:

$ conda activate Speak-with-your-documents-and-books-app 

(Optional) Setup you command line interface for better readability

export PS1="\[\033[01;32m\]\u@\h:\w\n\[\033[00m\]\$ "

Installation

Install the required packages

$ pip install -r requirements.txt

setup the environment

$ cd src
$ cp .env.example .env

Set your environment in the .env file. Like OPEN_API_KEY value.

Run Docker Compose Services

$ cd docker
$ cp .env.example .env

set .env with your credentials

Run the FastAPI server

uvicorn main:app --reload