Skip to content

WORKFLOW_TEST.md

Latest commit

 

History

History
90 lines (69 loc) · 3.63 KB

WORKFLOW_TEST.md

File metadata and controls

90 lines (69 loc) · 3.63 KB

✅ Project-Based Subtitle Workflow Implementation Complete

🚀 New API Endpoints

1. Generate Subtitles (POST /generate-subtitles)

Purpose: Generate and save subtitles for a project Parameters:

  • project_id (required) - Unique project identifier
  • url (required) - Video URL
  • language (optional) - Default: "en"
  • timing_offset (optional) - Default: 0.0

Response: Job ID for tracking generation progress

2. Add Subtitles (POST /add-subtitles)

Purpose: Add subtitles to video using project_id (generates if not exist) Parameters:

  • project_id (required) - Project identifier to find existing subtitles
  • url (required) - Video URL
  • All styling parameters (font-size, colors, etc.)

Behavior:

  • ✅ If subtitles exist for project_id → Use existing subtitles
  • ⚡ If no subtitles exist → Generate first, then add to video

📋 Workflow Examples

Scenario 1: Generate First, Add Later

# Step 1: Generate subtitles only
curl -X POST /generate-subtitles \
  -d '{"project_id": "my-video-001", "url": "https://video.mp4"}'
# Returns: job_id for generation

# Step 2: Add subtitles to video (uses existing)  
curl -X POST /add-subtitles \
  -d '{"project_id": "my-video-001", "url": "https://video.mp4"}'
# Returns: job_id for video processing with existing subtitles

Scenario 2: Direct Add (Auto-Generate)

# Single step: Generate + Add in one call
curl -X POST /add-subtitles \
  -d '{"project_id": "my-video-002", "url": "https://video.mp4"}'  
# Returns: job_id for generation + video processing

🔧 Technical Implementation

Job Manager Enhancements:

  • save_project_subtitles(project_id, data) - Store subtitles by project
  • get_project_subtitles(project_id) - Retrieve existing subtitles
  • Project subtitle files: {project_id}_subtitles.json

Processing Functions:

  1. process_generate_subtitles_job() - Generate only, save by project_id
  2. process_add_subtitles_job() - Check for existing, generate if needed, then process video

Smart Duplicate Detection:

  • Generate endpoint returns "already_exists" if subtitles exist for project
  • Add endpoint automatically uses existing subtitles if available

✅ Benefits

  1. Efficiency: Generate subtitles once, reuse for multiple video versions
  2. Cost Savings: Avoid redundant Whisper processing for same content
  3. Workflow Flexibility: Separate generation from video processing
  4. Project Management: Organize subtitles by project for easy tracking
  5. Automatic Fallback: Add-subtitles works regardless of existing subtitle state

🎯 Usage Patterns

Content Creators: Generate subtitles once, apply to multiple video formats/versions Batch Processing: Generate all subtitles first, then process videos in parallel Iterative Design: Tweak video styling without re-generating expensive subtitles Team Workflows: One person generates subtitles, others handle video processing

🧪 Test Results

  • ✅ Endpoints Created: Both generate-subtitles and add-subtitles operational
  • ✅ Project Storage: Job manager saves/retrieves subtitles by project_id
  • ✅ Duplicate Detection: Generate endpoint detects existing subtitles
  • ✅ Workflow Logic: Add endpoint uses existing or generates new subtitles
  • ✅ Progress Tracking: Both workflows provide detailed job status updates
  • ✅ Container Deploy: Performance mode with tiny model + project workflow active

Note: Full end-to-end testing requires valid video URLs. Framework and logic confirmed working via container deployment and endpoint validation.