Add README.md
This commit is contained in:
@@ -1 +1,33 @@
|
|||||||
<LOCAL_CONTENT>
|
# RAG Agent Project
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
```bash
|
||||||
|
python -m venv .venv
|
||||||
|
source .venv/bin/activate
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
## Environment Variables
|
||||||
|
- `OPENAI_API_KEY` – API key for OpenAI or Ollama. If using local Ollama set `OPENAI_API_BASE_URL=http://localhost:11434/v1`.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
### Load documents into vector store
|
||||||
|
```bash
|
||||||
|
python init_loader.py /path/to/text/files
|
||||||
|
```
|
||||||
|
|
||||||
|
### Start interactive CLI
|
||||||
|
```bash
|
||||||
|
python cli_client.py /add --text "Your document content"
|
||||||
|
python cli_client.py /search --text "What is LangChain?"
|
||||||
|
python cli_client.py /quit
|
||||||
|
```
|
||||||
|
|
||||||
|
### Run agent directly
|
||||||
|
```bash
|
||||||
|
python agent.py
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development
|
||||||
|
- Tests are not included but can be added in `tests/`.
|
||||||
|
- Lint with `ruff .` and format with `black .`.
|
||||||
Reference in New Issue
Block a user