Update README to reflect current behavior
Mirror and run GitLab CI / build (push) Has been cancelled
Mirror and run GitLab CI / build (push) Has been cancelled
- Remove PDF-related references - Clarify DOCX format: no cover pages, transcript line-numbered - Align output files and env vars with current implementation
This commit is contained in:
@@ -3,7 +3,7 @@
|
||||
ScrAIbe is a transcription and summarization service that:
|
||||
|
||||
- Sends audio to a LocalAI server running vibevoice.cpp for transcription and speaker diarization.
|
||||
- Optionally uses a second LLM to generate a detailed, structured summary.
|
||||
- Optionally uses a second LLM to generate a structured summary.
|
||||
- Provides:
|
||||
- A web GUI for uploading audio and receiving transcripts via email.
|
||||
- A CLI and Python API for direct integration.
|
||||
@@ -29,12 +29,12 @@ For more information: https://apstrom.ca
|
||||
- Jobs are queued and processed in the background (Celery + Redis).
|
||||
- Emails:
|
||||
- Immediate confirmation with queue position.
|
||||
- Final transcript (MD + JSON) when ready.
|
||||
- Summary as MD file (if requested).
|
||||
- Final transcript (MD + DOCX + JSON) when ready.
|
||||
- Summary as MD + DOCX (if requested).
|
||||
- Error notification if processing fails.
|
||||
- File formats:
|
||||
- Transcript: .md and .docx
|
||||
- Summary (if requested): .md and .docx
|
||||
- Transcript: .md and .docx (line-numbered, no cover page)
|
||||
- Summary (if requested): .md and .docx (no line numbering, no cover page)
|
||||
- Full structured output: .json
|
||||
- Customizable branding:
|
||||
- Web GUI title, logo, and accent color via environment variables.
|
||||
@@ -256,12 +256,13 @@ Email subject lines (customizable):
|
||||
Output files (async web GUI):
|
||||
|
||||
When a job completes, the user receives:
|
||||
|
||||
- Transcript:
|
||||
- .md file
|
||||
- .docx file
|
||||
- .docx file (line-numbered, no cover page)
|
||||
- Summary (if requested):
|
||||
- .md file
|
||||
- .docx file
|
||||
- .docx file (no line numbering, no cover page)
|
||||
- JSON:
|
||||
- Structured transcript with diarization and metadata
|
||||
|
||||
|
||||
Reference in New Issue
Block a user