Update documentation to reflect simplified API-based architecture

SETUP_GUIDE.md

@@ -1,238 +1,176 @@
 # vBot Setup Guide
 
+This guide provides detailed instructions for setting up and deploying the vBot system.
+
 ## Step 1: Deploy to Hugging Face Spaces
 
-1. **Create Hugging Face Account**
-   - Go to https://huggingface.co/
+1. **Create a Hugging Face Account**
+   - Go to [Hugging Face](https://huggingface.co)
    - Sign up for a free account
-   - Verify your email
+   - Create a new Space
 
 2. **Deploy the Space**
-   - Visit https://huggingface.co/spaces/iajitpanday/vBot
    - Click "Use this Space"
-   - Choose your deployment settings
-   - Wait for deployment to complete
+   - Choose "Docker" as the SDK
+   - Select "FastAPI" as the framework
+   - Deploy the space
 
 3. **Configure Environment Variables**
    ```bash
    # Generate a secure JWT secret
    python3 -c "import secrets; print(secrets.token_urlsafe(32))"
    
-   # Set these in your Space settings
+   # Set these environment variables in your Space settings
    JWT_SECRET=<generated-secret>
    ADMIN_USERNAME=your-admin-username
    ADMIN_PASSWORD=your-secure-password
-   DATABASE_URL=mysql+pymysql://username:password@host:port/vbot_main
+   DATABASE_URL=mysql+pymysql://username:password@host:port/database
    ```
 
 ## Step 2: Set Up Main Database
 
-1. **Create MySQL Database**
-   - Sign up for a free MySQL hosting service:
-     - [PlanetScale](https://planetscale.com/) (Recommended)
-     - [Railway](https://railway.app/)
-     - [Clever Cloud](https://www.clever-cloud.com/)
-   - Create a new database named `vbot_main`
+1. **Choose a Database Provider**
+   - [PlanetScale](https://planetscale.com/) (Recommended)
+   - [Railway](https://railway.app/)
+   - [Clever Cloud](https://www.clever-cloud.com/)
+
+2. **Create Database**
+   - Sign up for an account
+   - Create a new MySQL database
    - Get your database connection URL
+   - Update the `DATABASE_URL` environment variable
 
-2. **Verify Database Connection**
-   ```bash
-   # Test connection using the DATABASE_URL
-   mysql -h your-host -u your-user -p your-password
-   ```
+3. **Verify Database Connection**
+   - The application will automatically create necessary tables
+   - Check the logs for any connection issues
 
 ## Step 3: Admin Setup
 
 1. **Access Admin Dashboard**
    - Go to your Space URL
-   - Navigate to `/api/v1/token`
-   - Login with your admin credentials
-   - Save the JWT token
+   - Click "Admin Login"
+   - Use your admin credentials
 
 2. **Create First Customer**
-   ```bash
-   # POST /api/v1/customers/
-   {
-       "name": "John Doe",
-       "company_name": "ACME Corp",
-       "email": "john@acme.com",
-       "db_host": "customer-db-host",
-       "db_port": 3306,
-       "db_name": "acme_calls",
-       "db_user": "acme_user",
-       "db_password": "acme_password"
-   }
-   ```
-
-3. **Save Customer API Key**
-   - Note down the API key from the response
-   - Share it securely with the customer
+   - Click "Add New Customer"
+   - Fill in customer details:
+     - Name
+     - Company Name
+     - Email
+   - Save the customer
+   - Copy the generated API key
 
 ## Step 4: Customer Setup
 
-1. **Create Customer Database**
-   - Customer creates their own MySQL database
-   - Provides database credentials to admin
-   - Admin configures customer in the system
-
-2. **Configure Asterisk**
-   ```ini
-   # /etc/asterisk/dialplan/vbot.conf
-   [from-internal]
-   exten => _X.,1,Answer()
-   same => n,Set(CALLERID=${CALLERID(num)})
-   same => n,Set(CALLED=${EXTEN})
-   same => n,Record(/tmp/call-${UNIQUEID}.wav,0,30)
-   same => n,System(curl -X POST "https://your-huggingface-space-url/api/v1/process-call" \
-       -H "api-key: YOUR_API_KEY" \
-       -H "caller-number: ${CALLERID}" \
-       -H "called-number: ${CALLED}" \
-       -F "file=@/tmp/call-${UNIQUEID}.wav")
-   same => n,System(rm /tmp/call-${UNIQUEID}.wav)
-   same => n,Dial(SIP/${EXTEN})
-   same => n,Hangup()
-   ```
+1. **Configure Asterisk**
+   - Install Asterisk if not already installed
+   - Configure your dialplan
+   - Set up call recording
 
-3. **Update Asterisk Configuration**
-   ```bash
-   # Edit /etc/asterisk/extensions.conf
-   [general]
-   # Add this line
-   #include vbot.conf
-   
-   # Reload Asterisk
-   asterisk -rx "dialplan reload"
-   ```
+2. **Update Asterisk Configuration**
+   - Add the vBot dialplan configuration
+   - Configure the API endpoint
+   - Set up the API key
 
-4. **API Endpoints for Data Access**
-   ```bash
-   # Get call records
-   curl -X GET "https://your-huggingface-space-url/api/v1/calls" \
-       -H "api-key: YOUR_API_KEY" \
-       -H "Content-Type: application/json"
-
-   # Get specific call details
-   curl -X GET "https://your-huggingface-space-url/api/v1/calls/{call_id}" \
-       -H "api-key: YOUR_API_KEY" \
-       -H "Content-Type: application/json"
-
-   # Search calls
-   curl -X GET "https://your-huggingface-space-url/api/v1/calls/search" \
-       -H "api-key: YOUR_API_KEY" \
-       -H "Content-Type: application/json" \
-       -d '{
-           "start_date": "2024-01-01",
-           "end_date": "2024-01-31",
-           "caller_number": "+1234567890"
-       }'
-   ```
+3. **Test Integration**
+   - Make a test call
+   - Verify call recording
+   - Check API responses
 
 ## Step 5: Testing
 
 1. **Test API Connection**
    ```bash
-   # Test customer API key
-   curl -X POST "https://your-huggingface-space-url/api/v1/process-call" \
-       -H "api-key: YOUR_API_KEY" \
-       -H "caller-number: +1234567890" \
-       -H "called-number: +0987654321" \
-       -F "file=@test.wav"
+   curl -X POST "https://your-space.huggingface.space/api/v1/token" \
+        -H "Content-Type: application/x-www-form-urlencoded" \
+        -d "username=admin&password=your-password"
    ```
 
 2. **Test Call Processing**
-   - Make a test call through Asterisk
-   - Check customer's database for results
-   - Verify transcription, summary, and sentiment
+   - Make a test call
+   - Check the logs for processing status
+   - Verify transcription and analysis
 
 3. **Monitor Logs**
-   ```bash
-   # Check Asterisk logs
-   tail -f /var/log/asterisk/messages
-   
-   # Check Hugging Face Space logs
-   # View logs in Space settings
-   ```
+   - Check Space logs for errors
+   - Monitor database connections
+   - Verify API responses
 
 ## Step 6: Production Deployment
 
 1. **Security Checklist**
-   - [ ] Use HTTPS only
-   - [ ] Set strong passwords
-   - [ ] Configure firewall rules
-   - [ ] Enable database encryption
-   - [ ] Regular backups
+   - [ ] Secure JWT secret
+   - [ ] Strong admin password
+   - [ ] HTTPS enabled
+   - [ ] API keys properly configured
+   - [ ] Database credentials secured
 
 2. **Performance Optimization**
-   - [ ] Configure database indexes
-   - [ ] Set up connection pooling
-   - [ ] Monitor resource usage
-   - [ ] Configure caching
+   - Configure database connection pooling
+   - Set up caching if needed
+   - Monitor resource usage
 
 3. **Monitoring Setup**
-   - [ ] Set up error alerts
-   - [ ] Monitor API usage
-   - [ ] Track database performance
-   - [ ] Monitor disk space
+   - Enable Space monitoring
+   - Set up database monitoring
+   - Configure alerting
 
 ## Step 7: Maintenance
 
 1. **Regular Tasks**
-   - Monitor system resources
-   - Check error logs
+   - Monitor system logs
+   - Check database performance
    - Update dependencies
-   - Backup databases
+   - Backup data
 
 2. **Customer Management**
-   - Review API usage
-   - Monitor database sizes
+   - Monitor customer usage
    - Handle customer requests
    - Update customer configurations
 
 3. **System Updates**
-   - Test updates in staging
-   - Plan maintenance windows
-   - Keep dependencies current
-   - Monitor security patches
+   - Keep dependencies updated
+   - Monitor for security patches
+   - Plan for feature updates
 
 ## Troubleshooting
 
 1. **Common Issues**
-   - API key invalid
-   - Database connection failed
-   - File processing errors
-   - Resource limits reached
+   - Database connection errors
+   - API authentication issues
+   - Call processing failures
+   - Performance problems
 
 2. **Solutions**
-   - Check API key validity
+   - Check environment variables
    - Verify database credentials
-   - Monitor file permissions
-   - Review resource quotas
+   - Monitor system logs
+   - Test API endpoints
 
 3. **Support**
-   - Check Space logs
-   - Review error messages
-   - Contact system administrator
-   - Consult documentation
+   - Check documentation
+   - Review logs
+   - Contact support if needed
 
 ## Best Practices
 
 1. **Security**
-   - Rotate API keys regularly
    - Use strong passwords
-   - Enable database encryption
+   - Rotate API keys regularly
    - Monitor access logs
+   - Keep systems updated
 
 2. **Performance**
-   - Optimize database queries
    - Monitor resource usage
-   - Set up caching
-   - Configure connection pooling
+   - Optimize database queries
+   - Cache frequently accessed data
+   - Scale resources as needed
 
 3. **Reliability**
    - Regular backups
    - Monitor system health
-   - Set up alerts
-   - Plan for failures
+   - Test failover procedures
+   - Document procedures
 
 ## Database Schema Setup
 

USER_MANUAL.md

@@ -1,224 +1,236 @@
 # vBot User Manual
 
+This manual provides comprehensive documentation for using the vBot system.
+
 ## Table of Contents
-1. [Overview](#overview)
-2. [System Requirements](#system-requirements)
-3. [Installation](#installation)
-4. [Configuration](#configuration)
-5. [Usage](#usage)
-6. [API Reference](#api-reference)
-7. [Troubleshooting](#troubleshooting)
+1. [Introduction](#introduction)
+2. [Getting Started](#getting-started)
+3. [Admin Interface](#admin-interface)
+4. [Customer Management](#customer-management)
+5. [API Usage](#api-usage)
+6. [Troubleshooting](#troubleshooting)
+
+## Introduction
 
-## Overview
-vBot is a multi-tenant system that provides AI-powered call analysis for Asterisk PBX systems. It processes phone conversations to provide transcription, summarization, and sentiment analysis using Hugging Face models.
+vBot is an intelligent call analysis system that provides real-time transcription, sentiment analysis, and call summaries. The system is designed to be easy to use while providing powerful features for call center management and analysis.
 
 ### Key Features
-- Multi-tenant support with secure API keys
-- Real-time call processing
-- Speech-to-text transcription
-- Call summarization
+- Real-time call transcription
 - Sentiment analysis
-- Secure admin dashboard
-- RESTful API
-
-## System Requirements
-
-### Server Requirements
-- Python 3.8 or higher
-- MySQL 5.7 or higher
-- 4GB RAM minimum
-- 20GB storage minimum
-- CUDA-capable GPU (recommended for faster processing)
+- Call summaries
+- Modern admin interface
+- Secure API access
+- Customer management
+
+## Getting Started
+
+### Prerequisites
+- A Hugging Face account
+- Access to the vBot system
+- Admin credentials
+
+### Initial Setup
+1. Log in to the admin interface
+2. Create your first customer
+3. Configure your Asterisk system
+4. Test the integration
+
+## Admin Interface
+
+### Login
+1. Navigate to the admin interface
+2. Enter your admin credentials
+3. Click "Login"
+
+### Dashboard
+The dashboard provides an overview of:
+- Total customers
+- Active customers
+- Recent activity
+- System status
+
+### Navigation
+- **Customers**: Manage customer accounts
+- **Settings**: Configure system settings
+- **Logs**: View system logs
+- **Help**: Access documentation
+
+## Customer Management
+
+### Adding Customers
+1. Click "Add New Customer"
+2. Fill in customer details:
+   - Name
+   - Company Name
+   - Email
+3. Click "Save"
+4. Copy the generated API key
+
+### Managing Customers
+- View customer list
+- Edit customer details
+- Enable/disable customers
+- View customer usage
+
+### Customer Settings
+- API key management
+- Usage limits
+- Feature access
+
+## API Usage
 
-### Client Requirements
-- Asterisk PBX system
-- Internet connectivity
-- curl command-line tool
+### Authentication
+```bash
+# Get JWT token
+curl -X POST "https://your-space.huggingface.space/api/v1/token" \
+     -H "Content-Type: application/x-www-form-urlencoded" \
+     -d "username=admin&password=your-password"
+```
 
-## Installation
+### Customer API Endpoints
 
-### 1. Deploy to Hugging Face Spaces
-1. Visit https://huggingface.co/spaces/iajitpanday/vBot
-2. Click "Use this Space"
-3. Choose your deployment settings
-4. Wait for the deployment to complete
+#### Process Call
+```bash
+curl -X POST "https://your-space.huggingface.space/api/v1/process-call" \
+     -H "api-key: YOUR_API_KEY" \
+     -H "caller-number: +1234567890" \
+     -H "called-number: +0987654321" \
+     -F "file=@call.wav"
+```
 
-### 2. Configure Environment Variables
-In your Hugging Face Space settings, add the following environment variables:
+#### Get Call Records
 ```bash
-JWT_SECRET=your-secure-secret-key
-ADMIN_USERNAME=your-admin-username
-ADMIN_PASSWORD=your-secure-password
-DATABASE_URL=mysql+pymysql://username:password@host:port/database
+curl -X GET "https://your-space.huggingface.space/api/v1/calls" \
+     -H "api-key: YOUR_API_KEY"
 ```
 
-### 3. Database Setup
-1. Create a MySQL database
-2. The application will automatically create required tables on first run
-
-## Configuration
-
-### 1. Admin Setup
-1. Log in to the admin dashboard using your credentials
-2. Navigate to the Customers section
-3. Create new customers by providing:
-   - Company name
-   - Contact person name
-   - Email address
-4. Save the generated API key for each customer
-
-### 2. Asterisk Integration
-1. Copy the sample dialplan configuration:
-```ini
-[from-internal]
-exten => _X.,1,Answer()
-same => n,Set(CALLERID=${CALLERID(num)})
-same => n,Set(CALLED=${EXTEN})
-same => n,Record(/tmp/call-${UNIQUEID}.wav,0,30)
-same => n,System(curl -X POST "https://your-huggingface-space-url/api/v1/process-call" \
-    -H "api-key: YOUR_API_KEY" \
-    -H "caller-number: ${CALLERID}" \
-    -H "called-number: ${CALLED}" \
-    -F "file=@/tmp/call-${UNIQUEID}.wav")
-same => n,System(rm /tmp/call-${UNIQUEID}.wav)
-same => n,Dial(SIP/${EXTEN})
-same => n,Hangup()
+#### Get Call Details
+```bash
+curl -X GET "https://your-space.huggingface.space/api/v1/calls/{call_id}" \
+     -H "api-key: YOUR_API_KEY"
 ```
 
-2. Replace placeholders:
-   - `YOUR_API_KEY` with the customer's API key
-   - `your-huggingface-space-url` with your actual Space URL
+#### Search Calls
+```bash
+curl -X GET "https://your-space.huggingface.space/api/v1/calls/search" \
+     -H "api-key: YOUR_API_KEY" \
+     -H "Content-Type: application/json" \
+     -d '{
+         "start_date": "2024-01-01",
+         "end_date": "2024-01-31",
+         "caller_number": "+1234567890"
+     }'
+```
 
-3. Add the dialplan to your Asterisk configuration:
-   - Copy to `/etc/asterisk/dialplan/`
-   - Include in `extensions.conf`
-   - Reload Asterisk dialplan
+### Response Formats
+
+#### Call Processing Response
+```json
+{
+    "status": "success",
+    "call_id": "123",
+    "transcription": "Call transcript...",
+    "summary": "Call summary...",
+    "sentiment": "positive",
+    "timestamp": "2024-01-01T12:00:00Z"
+}
+```
 
-## Usage
+#### Call Records Response
+```json
+{
+    "calls": [
+        {
+            "call_id": "123",
+            "caller_number": "+1234567890",
+            "called_number": "+0987654321",
+            "timestamp": "2024-01-01T12:00:00Z",
+            "duration": 300,
+            "status": "completed"
+        }
+    ],
+    "total": 1,
+    "page": 1,
+    "per_page": 10
+}
+```
 
-### 1. Admin Dashboard
-1. Access the admin dashboard at `https://your-space-url/admin`
-2. Log in with admin credentials
-3. Manage customers and view call records
+## Troubleshooting
 
-### 2. Customer Integration
-1. Provide customers with their API key
-2. Share the Asterisk dialplan configuration
-3. Guide them through Asterisk integration
+### Common Issues
 
-### 3. Call Processing
-The system automatically:
-1. Records incoming calls
-2. Sends audio to the processing server
-3. Performs AI analysis
-4. Stores results in the database
-5. Cleans up temporary files
+#### API Authentication
+- Verify API key is correct
+- Check API key permissions
+- Ensure HTTPS is used
 
-## API Reference
+#### Call Processing
+- Verify audio file format
+- Check file size limits
+- Monitor processing status
 
-### Authentication
-- Admin: JWT token authentication
-- Customers: API key in header
+#### System Status
+- Check system logs
+- Monitor resource usage
+- Verify database connection
 
-### Endpoints
+### Error Messages
 
-#### Admin Endpoints
+#### Authentication Errors
 ```
-POST /api/v1/token
-- Login to get admin token
-
-POST /api/v1/customers/
-- Create new customer
-- Requires admin token
-
-GET /api/v1/customers/
-- List all customers
-- Requires admin token
-
-GET /api/v1/customers/{customer_id}
-- Get customer details
-- Requires admin token
-
-DELETE /api/v1/customers/{customer_id}
-- Delete customer
-- Requires admin token
+401 Unauthorized: Invalid API key
+403 Forbidden: Insufficient permissions
 ```
 
-#### Customer Endpoints
+#### Processing Errors
 ```
-POST /api/v1/process-call
-- Process call recording
-- Requires customer API key
-- Headers:
-  - api-key: Customer's API key
-  - caller-number: Caller's phone number
-  - called-number: Called number
-
-GET /api/v1/calls/{customer_id}
-- List customer's calls
-- Requires admin token
+400 Bad Request: Invalid file format
+413 Payload Too Large: File size exceeds limit
+500 Internal Server Error: Processing failed
 ```
 
-## Troubleshooting
-
-### Common Issues
-
-1. **API Key Invalid**
-   - Verify API key is correct
-   - Check if customer is active
-   - Ensure proper header format
-
-2. **Call Processing Failed**
-   - Check audio file format (WAV)
-   - Verify file size limits
-   - Check server logs
-
-3. **Database Connection Issues**
-   - Verify DATABASE_URL
-   - Check database credentials
-   - Ensure database is running
-
-4. **Asterisk Integration Problems**
-   - Verify dialplan syntax
-   - Check file permissions
-   - Test curl command manually
-
 ### Support
+- Check documentation
+- Review error logs
+- Contact system administrator
+
+## Best Practices
+
+### Security
+- Keep API keys secure
+- Use HTTPS for all requests
+- Rotate API keys regularly
+- Monitor access logs
+
+### Performance
+- Optimize audio file size
+- Use appropriate sampling rates
+- Monitor API usage limits
+- Cache frequently accessed data
+
+### Reliability
+- Implement retry logic
+- Handle API errors gracefully
+- Monitor system health
+- Regular backups
+
+## Updates and Maintenance
+
+### System Updates
+- Monitor for new features
+- Review changelog
+- Test updates in staging
+- Plan maintenance windows
+
+### Backup and Recovery
+- Regular data backups
+- Document recovery procedures
+- Test backup restoration
+- Monitor backup status
+
+## Contact Support
+
 For additional support:
-1. Check the logs in your Hugging Face Space
-2. Contact system administrator
-3. Review error messages in Asterisk logs
-
-## Security Considerations
-
-1. **API Keys**
-   - Keep API keys secure
-   - Rotate keys periodically
-   - Use HTTPS only
-
-2. **Admin Access**
-   - Use strong passwords
-   - Enable 2FA if available
-   - Monitor access logs
-
-3. **Data Protection**
-   - Regular backups
-   - Encryption at rest
-   - Secure file handling
-
-## Maintenance
-
-1. **Regular Tasks**
-   - Monitor system resources
-   - Check error logs
-   - Update dependencies
-
-2. **Backup Procedures**
-   - Database backups
-   - Configuration backups
-   - Recovery testing
-
-3. **Updates**
-   - Monitor for security updates
-   - Test updates in staging
-   - Plan maintenance windows 
+- Email: support@vbot.com
+- Documentation: https://vbot.com/docs
+- Community: https://vbot.com/community