AOSSIE-Org/EduAid

Feat: Add Audio Input Support

Open

#34 opened on Mar 28, 2024

View on GitHub
 (25 comments) (0 reactions) (0 assignees)JavaScript (427 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (172 stars)
PR merge metrics
 (PR metrics pending)

Description

Issue Title:

Enhancement: Add Audio Input Support for Generating Q&A

Issue Description:

Problem:

Currently, the software supports only text and PDF input for generating Q&A. However, there is a growing need to include audio input capabilities, allowing users to provide recorded lectures as input data.

Proposed Solution:

Integrate audio input functionality into the software to enable users to upload recorded lectures. The system should then process these audio files, extract relevant information, and generate Q&A accordingly.

Expected Behavior:

  1. Users should be able to upload audio files in commonly used formats (e.g., MP3, WAV).
  2. The software should process audio input, transcribe the content, and extract key points.
  3. Generated Q&A should reflect the information presented in the audio lecture accurately.
  4. Ensure compatibility and efficiency of audio processing across different platforms and environments.

Labels:

  • enhancement
  • feature-request

Contributor guide

Research direction
Study the existing text and PDF input modules to understand the architecture. Research audio processing libraries (e.g., ffmpeg) and speech to text APIs. Plan an endpoint for audio upload and a pipeline for transcription and Q&A generation.
Tech stack
javascript
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60