bbchops/transcription
1
0
Fork 0
generated from john/python-template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Used co-pilot for complete review of all documentation, including extensive revision of v1.md

Browse Source
This commit is contained in:
Jim Lancaster
2026-07-02 12:37:32 -05:00
parent 97cb7055d4
commit ec61013b47
17 changed files with 155 additions and 2894 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/architecture.md
+13 -4
View File
@@ -20,7 +20,7 @@ Current scope includes:
- content source upload and metadata capture
- asynchronous transcription jobs
- prompt-library driven transcription behavior, with one Markdown file per prompt
- transcript review and revision history
- original transcription review and optional revision history
- full-text search over accepted transcripts
- export of transcript data
@@ -134,9 +134,9 @@ Production transcription flow:
1. A user uploads one or more content sources through the UI or API.
2. The application validates payloads and creates document, source, and job records.
3. The in-process worker de-queues the job and calls the transcription provider.
4. The application persists transcript output, confidence metadata, and provenance events.
4. The application persists original transcription output on the job, plus confidence metadata and provenance events.
5. Job status transitions from queued to processing to transcribed or failed.
6. The UI and API expose status, revision history, and searchable transcript text.
6. The UI and API expose status, optional revision history, and searchable transcription text.
## Data Model Ownership
@@ -147,6 +147,15 @@ System-of-record entities:
- transcript revisions
- provenance metadata
### Original Transcription And Revision Ownership
- each processing job stores the original immutable provider output (`text`)
- provider metadata (`provider`, `model`, `prompt_name`) and failure detail (`error_detail`) are job-owned processing artifacts
- revisions are optional user-authored edits linked to a content source
- a revision can be created from either original `job.text` or a previous revision
- many jobs will have zero revisions; revision history is additive and never overwrites original provider output
- a document groups one or more content sources (images, PDFs, and future source types)
Storage strategy:
- PostgreSQL for relational system-of-record entities
@@ -285,6 +294,6 @@ Control:
- Port/Interface: A stable contract used by application/domain code to call infrastructure implementations.
- Prompt artifact: A single Markdown file that defines one transcription prompt and can be revised independently.
- Provenance: Metadata that records where generated data came from and how it was produced.
- Revision history: Versioned record of transcript edits over time.
- Revision history: Optional versioned record of user-authored transcription edits over time.
- System of record: The authoritative persistent store for canonical data.
- Vertical slice: A minimal end-to-end feature path spanning UI/API, application logic, and persistence.