From 65fae1314ed86a671bd344958d27978d00a3ccc8 Mon Sep 17 00:00:00 2001 From: Orihara Izaya Date: Wed, 27 Nov 2024 17:12:20 +0100 Subject: [PATCH] Documentation: Updated README.md with information on the strucutre of a job Signed-off-by: Orihara Izaya --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1c1826f..d3796eb 100644 --- a/README.md +++ b/README.md @@ -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