Skip to content

Quick Start

Anjana Tiha edited this page Mar 28, 2026 · 1 revision

Quick Start

Get RAG Agent running with your first document in under 5 minutes.

Prerequisites

  • Ollama installed and running (ollama serve in a separate terminal)
  • Models pulled (see Installation)
  • Virtual environment activated (source rag_env_311/bin/activate)

Option A — Web UI

streamlit run app.py

Open http://localhost:8501 in your browser.

Add a Document

From a file:

  1. Use the Upload a file panel in the sidebar
  2. Select any supported file (PDF, DOCX, XLSX, CSV, TXT, etc.)
  3. Wait for the indexing progress bar to complete

From a URL:

  1. Paste any public URL into the Add a URL field
  2. Click Add — the page is fetched, parsed, and indexed automatically

From a topic search:

  1. Type a topic into the Search a topic field (e.g. "climate change")
  2. Click Search — DuckDuckGo results are crawled and indexed automatically

Ask a Question

Type your question in the chat box at the bottom and press Enter.

Example questions:

What is the candidate's most recent job title?       ← on a resume PDF
What was the revenue in Q3?                          ← on a spreadsheet
Summarise the main findings of this report           ← any document
What is 15% of the salary mentioned in the resume?  ← agent mode

Option B — Terminal

python main.py

Place documents in ./docs/ first (see folder structure below), then start the chatbot. Type your question at the You: prompt.

python main.py --agent    # agent mode with tool calling

Document Folder Structure

Place files in the matching subfolder under ./docs/, or drop any folder anywhere under ./docs/ — the scanner walks recursively:

docs/
  pdfs/       ← PDF files
  txts/       ← plain text files
  docx/       ← Word documents
  xlsx/       ← Excel spreadsheets
  pptx/       ← PowerPoint presentations
  csv/        ← CSV files
  md/         ← Markdown files
  html/       ← HTML files

Files placed in the wrong subfolder are still processed — the system detects the correct type by file extension.


Next Steps

Clone this wiki locally