Documentation: Updated README.md with information on the strucutre of a job

Signed-off-by: Orihara Izaya <xloki.stormbringery@gmail.com>
This commit is contained in:
Orihara Izaya
2024-11-27 17:12:20 +01:00
parent bff7ceb81c
commit 65fae1314e
+5 -1
View File
@@ -101,7 +101,11 @@ Jobs specify tasks for transcript creation. A job contains the following informa
- `source`: List[string]: The sources of the videos (paths, YouTube links)
- `language`: Optional[string]: The language of the video (If not specified employs auto-detection) as a language code
(e.g. 'en', 'de', 'fr')
- `output_format`:
- `output_format`: dict: The requested output formats
- `get_json_version`: bool: Whether to get the full data json version of the transcript (including word level time
stamps)
- `get_txt_version`: bool: Whether to get a plain text version of the transcript
- `get_sentence_level_json_version`: bool: Whether to get a sentence level json version of the transcript
## Contributing