From 6dbb01db1c98c7195b03cd7dffbbdb067617147d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=93=D0=BB=D0=B5=D0=B1=20=D0=9D=D0=B8=D0=BA=D0=B8=D1=88?= =?UTF-8?q?=D0=B8=D0=BD?= Date: Thu, 4 Jun 2026 09:12:27 +0000 Subject: [PATCH] add README.md --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d815e8 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# RAG Agent with ChromaDB and Tavily + +This repository contains a simple RAG agent that uses **ChromaDB** as a local vector store and **Tavily** for web search. The agent automatically selects the appropriate source (local knowledge base or the web) based on the query. + +## Structure +- `vectorstore.py` – utilities for creating and loading the vector store. +- `tools.py` – LangChain tools for local and web search. +- `agent.py` – agent definition with routing logic. +- `main.py` – interactive CLI. +- `init_db.py` – helper script to load documents from `documents/` into the vector store. +- `requirements.txt` – dependencies. +- `documents/` – folder with sample `.txt`/`.md` files. + +## Usage +```bash +# Install dependencies +pip install -r requirements.txt + +# Load documents into the vector store +python init_db.py + +# Run the chat interface +python main.py +``` + +## Environment +- `TAVILY_API_KEY` – required for web search. +- `OLLAMA_BASE_URL` – optional, defaults to `http://localhost:11434`.