Sign in

v3

latestOpenAPI 3.0.02026-07-318685204.9 KB
Enhancements

Create a new speech dictionary

A speech dictionary is a flat list of terms (names, proper nouns, acronyms, specialized terminology) that helps the speech recognition correctly caption the source audio of a speech enhancement. It does not translate terms: the source audio is first captioned in the source language (aided by the dictionary) and then translated into the target languages. Connect a dictionary to an ingest via the dictionary field of the speech enhancement entry; the dictionary language must match that enhancement's sourceLanguage. Terms are cleaned up automatically (whitespace normalized, empty and duplicate entries dropped); terms that cannot be fixed automatically (forbidden characters ";" or "/", more than 6 words) are rejected with invalid_value.

post/enhancements/speech/dictionaries

Request body

namestring required

Name of the speech dictionary

languagestring required

IETF BCP 47 language tag of the terms (e.g. "en", "en-US"). Must match the sourceLanguage of the speech enhancement the dictionary is used with

termsstring[] required

List of terms (names, proper nouns, acronyms, specialized terminology) the speech recognition checks against while captioning the source audio. One term per entry, at most 6 words per term; a term must exactly match what is said in the stream. Optionally append "sounds like" phonetic spellings to a term with a pipe, separating multiple pronunciations with a comma: "D&I|dee-and-eye,dee-n-eye". Entries are cleaned up automatically: whitespace is normalized, spaces around "|" and "," are removed, and empty or duplicate entries are dropped. Entries containing ";" or "/" (not accepted by the speech recognition) or more than 6 words are rejected.

Example request

{
  "terms": [
    "THEOlive",
    "A. Väyrynen",
    "D&I|dee-and-eye,dee-n-eye"
  ]
}

Response

Speech dictionary created successfully

Example response

{
  "data": {
    "terms": [
      "THEOlive",
      "A. Väyrynen",
      "D&I|dee-and-eye,dee-n-eye"
    ]
  }
}