modal_app/README.md

# KnowledgeBridge Modal App

This Modal app provides distributed computing capabilities for KnowledgeBridge, including:

## Features

- **Text Extraction**: OCR from images and PDF parsing
- **Vector Indexing**: FAISS-based vector index building
- **Vector Search**: High-performance semantic search
- **Batch Processing**: Process multiple documents in parallel
- **Task Management**: Async task status tracking

## Deployment

1. Install Modal CLI:
```bash
pip install modal
```

2. Authenticate:
```bash
modal token set
```

3. Deploy the app:
```bash
modal deploy main.py
```

4. Check deployment:
```bash
modal app list
```

## Endpoints

Once deployed, your app will be available at:
- `https://fazeelusmani18--knowledgebridge-main.modal.run/vector-search`
- `https://fazeelusmani18--knowledgebridge-main.modal.run/extract-text`
- `https://fazeelusmani18--knowledgebridge-main.modal.run/build-index`
- `https://fazeelusmani18--knowledgebridge-main.modal.run/batch-process`
- `https://fazeelusmani18--knowledgebridge-main.modal.run/task-status`
- `https://fazeelusmani18--knowledgebridge-main.modal.run/health`

## Configuration

Update your `.env` file with the new endpoint:
```bash
MODAL_BASE_URL=https://fazeelusmani18--knowledgebridge-main.modal.run
```

## Usage

The app automatically integrates with your KnowledgeBridge backend through the Modal client.