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

Updates to docs. Added new transcription_methodology, revised approach to revisions: 1 revision per document (that can be updated)

Browse Source
This commit is contained in:
Jim Lancaster
2026-07-29 13:29:44 -05:00
parent ec61013b47
commit eaf9805121
6 changed files with 77 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/schema.md
+5 -5
View File
@@ -48,18 +48,18 @@ erDiagram
document ||--o{ source : "has 0 or more"
document ||--o{ job : "has 0 or more"
job ||--o{ source : "processes 0 or more"
source ||--o{ revision : "has 0 or more"
source ||--o{ revision : "has 0 or 1"
```
---
## Table Relationships & Constraints
* A document can consist of 0 or more content sources. A document can have 0 or more jobs.
* 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 source can belong to only one job (which contains the original transcription). A source can only belong to one document. A source may have one optional transcription revision.
* A job can process one or more sources. A job can belong to only one document.
* A revision can belong to only one source. A source can have 0 or more revisions.
* A revision can belong to only one source. A source may have one optional revision.
* `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.
* Revision rows are optional user-authored edits and are derived from the original transcription. Unlike jobs, revision rows can be updated.
---
@@ -70,4 +70,4 @@ erDiagram
* **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 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.
* **Revision** - A revision is a user-created modification of an existing transcription. It is optional. Some original transcriptions will have no revisions.