Kensho Scribe Transcription

{"$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/sp-global/main/json-schema/kensho-scribe-transcription-schema.json", "title": "Kensho Scribe Transcription", "description": "Top-level entity from the Kensho Scribe Batch v2 API (commonOptions).", "$ref": "#/$defs/commonOptions", "$defs": {"commonOptions": {"type": "object", "properties": {"callback_uri": {"type": "string", "format": "uri", "description": "A URI (currently restricted to http/https) which Scribe can send information to when the\ntranscription is complete.\n\nWhen the URI protocol is http or https we will make a PUT request to the callback_uri to\nindicate a change in the status of the transcription job.  The PUT request body will be\nJSON and contain the transcription id and if the transcription completed successfully or not:\n```json\n{ 'transcription_id': '<ID>', 'result': 'success' }\n```\n\nA separate call can then be made to retrieve the transcript (or any failures while generating it).\n"}, "transcriber": {"type": "string", "enum": ["human", "machine"], "default": "machine", "description": "The type of transcription to perform - either machine only (AI) or human assisted (human in the loop).\n"}, "media_language": {"type": "string", "enum": ["cmn", "da", "dan", "de", "deu", "en", "eng", "es", "fr", "fra", "it", "ita", "ja", "jpn", "ko", "kor", "nl", "nld", "no", "nor", "por", "pt", "ru", "rus", "spa", "yue", "zh", "zho"], "default": "en", "description": "The source language of the media.  If the media is not in english then the contents will have to be translated\nprior to transcription.  This is a single, ISO-639, language code which can be two characters for ISO-639-1 (ie en)\nor three characters for ISO-639-3 (ie zho).\n\n**NOTE - Only applicable when `human` is specified as the transcriber.**\n"}, "priority": {"type": "string", "enum": ["low", "medium", "high"], "default": "medium", "description": "This is the priority of the transcription and is dictated by contractual turn around times.\n\n**NOTE - Only applicable when `human` is specified as the transcriber.**\n"}, "context": {"oneOf": [{"type": "string", "description": "a single or multiline block of text with 'context' on this transcription.\n", "example": "Q1 Earnings Call"}, {"type": "object", "additionalProperties": true, "properties": {"id": {"type": "string", "description": "A short ID to pair with the transcription - typically something to cross reference the\ntranscription with.\n", "example": "abc_internal_id"}, "title": {"type": "string", "description": "A (typically) one line title / name to associate with the transcription.\n", "example": "Q1 earnings"}, "description": {"type": "string", "description": "A single or multiline block of text with more descriptive information about the transcription\n", "example": "Q1 earnings calls featuring Jane the CEO, with guest speaker John.\n"}}, "description": "TODO"}], "description": "Additional 'context' information that can be attached to the transcription.  This is typically never read\non the Kensho side, but it can be used to recall or cross-reference internal information about the\ntranscript.  A typical scenario could be one where transcriptions are submitted with titles, names and\ntracked with internal IDs which is needed when retrieving the transcript.\n"}}}}}