CV RAG Processing API - Production Documentation

📋 System Overview

The CV RAG Processing API is a sophisticated, production-ready system that combines multiple AI technologies to provide intelligent resume analysis and matching capabilities. Built for enterprise-scale applications, it processes CVs through advanced Natural Language Processing pipelines and provides semantic matching using vector databases.

🧠 Azure OpenAI Integration

Leverages GPT-4 for intelligent CV analysis, skill extraction, and experience assessment with detailed token usage tracking and cost optimization.

🔍 Vector Database (ChromaDB)

Stores high-dimensional embeddings for semantic similarity search using cosine distance with HNSW indexing for fast retrieval.

🗄️ MySQL Database

Structured storage for CV metadata, user information, skills taxonomy, and API usage analytics with optimized indexing strategies.

📊 Sentence Transformers

Generates contextual embeddings using 'all-MiniLM-L6-v2' model for multilingual semantic understanding and cross-document similarity.

Production Features: Multi-tenant architecture, comprehensive audit logging, webhook notifications, rate limiting, and enterprise-grade security with JWT-based authentication.

🚀 Quick Start

Get up and running with the CV RAG API in minutes. Choose your preferred version based on your requirements.

🎯 v1 - Basic Processing

Ready immediately. Uses sentence transformers for basic CV matching.

curl -X POST /v1/process-cvs \
  -H "Authorization: cvapi_your_token" \
  -H "Content-Type: application/json"
                    

⚡ v2 - Enhanced Analysis

Advanced TF-IDF with skills extraction and experience analysis.

curl -X POST /v2/process-cvs \
  -H "Authorization: cvapi_your_token" \
  -H "Content-Type: application/json"
                    

🧠 v3 - RAG Powered

AI-powered with Azure OpenAI and vector database storage.

curl -X POST /v3/process-cvs \
  -H "Authorization: cvapi_your_token" \
  -H "X-App-ID: your_app_id"
                    

First Time Setup: Generate an auth token using /api/auth/generate-token and set your X-App-ID header for multi-tenant support.

📚 Complete Documentation

Comprehensive guides and technical documentation for all aspects of the CV RAG Processing API.

🏗️ System Technologies

The architecture section provides comprehensive details about system design, components, and data flow.

View Complete Architecture: Click on the "Documentation" section above and select the "🏗️ Architecture" tab for detailed system architecture information.

📡 API Reference

POST /api/auth/generate-token

Purpose: Generate JWT authentication token for API access

curl -X POST /api/auth/generate-token \
  -H "Content-Type: application/json" \
  -d '{
    "user_id": "your_user_id", 
    "permissions": ["process_cvs", "rag_match", "admin"]
  }'
                    

POST /api/rag-match

Purpose: Intelligent CV matching using RAG system

curl -X POST /api/rag-match \
  -H "Authorization: cvapi_[your_token]" \
  -H "X-App-ID: your_app_id" \
  -H "Content-Type: application/json" \
  -d '{
    "job_description": "Senior Python Developer...",
    "expected_results": 10,
    "priority_skills": ["python", "machine learning", "aws"],
    "min_combined_score": 0.7,
    "exclude_cv_ids": [123, 456]
  }'
                    

POST /v3/process-cvs

Purpose: Process and analyze CVs using v3 RAG algorithm

curl -X POST /v3/process-cvs \ -H "Authorization: cvapi_[your_token]" \ -H "X-App-ID: your_app_id" \ -H "X-Webhook-URL: https://your-webhook-endpoint.com" \ -F 'job_description=Senior Software Engineer position...' \ -F 'priority_skills=python,react,aws,kubernetes' \ -F '[email protected]' \ -F 'user_ids=john_doe'

✔️ Status Endpoints

These endpoints provide real-time status information about the API and its components.

GET /heartbeat Simple heartbeat check - API alive status

GET /api/status/comprehensive Comprehensive status of all application components

GET /v1/status Detailed V1 algorithm status and performance metrics

GET /v3/health Check V3 RAG system health and readiness

🔒 Access Documentation

🤖 CV RAG Processing API