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/schema.md
+8 -6
View File
@@ -55,17 +55,19 @@ erDiagram
## Table Relationships & Constraints
* A document can consist of 0 or more content sources. A document can have 0 or more jobs.
* An source can belong to only one job (which contains the original transcription). A source can only belong to one document. A source can have 0 or more transcription revisions.
* A source can belong to only one job (which contains the original transcription). A source can only belong to one document. A source can have 0 or more transcription revisions.
* A job can process one or more sources. A job can belong to only one document.
* A revision can belong to only one source. An source can have 0 or more revisions.
* A revision can belong to only one source. A source can have 0 or more revisions.
* `Job.text` stores the original immutable provider transcription.
* Revision rows are optional user-authored edits and may be derived from either the original transcription or a prior revision.
---
## Glossary
* **Document** - Documents consist of one or more content sources and their related transcriptions.
* **Source** - A content source that is transcribed to text. It can either be an image (.jpg, .tiff, .png) or a pdf (.pdf)
* **Source** - A content source that is transcribed to text. It can either be an image (.jpg, .tiff, .png) or a PDF (.pdf).
* **Image** - The scanned image of one page of a document.
* **PDF** - A pdf containing the image of one or more pages of a document.
* **PDF** - A PDF containing the image of one or more pages of a document.
* **Job** - A processing job ingests one or more sources, sends them to an AI model along with a prompt for transcription, then stores the results. The results are immutable, *including the original transcription*. The user can create a revision of the original transcription, but the user cannot modify the original.
* Transcription - The text contained in a content source. A job creates the original transcription.
* Revision - A modification of a transcription. A job creates the original transcription. A user can create one or more transcription revisions.
* **Transcription** - The text contained in a content source. A job creates the original immutable transcription. A user can optionally create a revised transcription, or "revision".
* **Revision** - A revision is a user-created modification of an existing transcription. A user can create a revision from either the original transcription or a previous revision, but it is entirely optional. Some original transcriptions will have no revisions.