V-Blaze Online Help

output

Values: json (default), jsontop, text

Compatibility Values (V‑Blaze only): jsonlist, jsontext, jsontextlist

Description:

Specifies transcript delivery format. The following outputs are supported:

output=json

Returns a JSON dictionary that includes utterance and event details in a hierarchical structure by default.

output=jsontop

Returns a JSON output in which all utterance details are collapsed into a single, top-level text field.

output=text

Returns a plain text version of the transcript.

Note

Earlier releases included outer list (square brackets) that have since been removed. The structure of the inner JSON dictionary has not changed, and is now returned directly without the outer list. To produce JSON output in the list format that was previously used by the API, refer to the output parameters below.

The following output parameters are legacy and can be used by manually setting output to the desired format when making a transcription request.

output=jsonlist

Returns a JSON dictionary that includes an outer list. Use to produce the same type of JSON used by previous releases. Voci recommends modifying any applications that depend on the old output formats to be compatible with the new output formats.

output=jsontext

Returns text output in the text or list formats that were previously used. A JSON representation of the transcription is provided and stored in source and utterances fields. jsontext and jsontextlist output formats are provided to enable any pre-existing applications that depend on the old output format to to be used. Voci recommends modifying any applications that depend on the old output formats to be compatible with the new output formats.

Note

Text output was formerly a JSON representation of the transcription, stored in source and utterances fields. To produce text output in the format that was previously used by Voci APIs, you can specify the output as output=jsontextlist.

Note

Applications that continue to depend on previous output formats can still be used if an administrator of your V‑Cloud site has used the yum-plugin-revisionlock command to freeze the installation to use the voci-webapi-2.0.0-compat package. By doing this, no future updates/fixes to the V‑Cloud product will be applied by yum updates. Updating your applications is recommended in order to enable the installation to continue to receive updates.

json is the recommended output format because it contains a significant amount of information in addition to the text of the transcript. json includes the following:

  • Confidence scores for each word and utterance

  • Start and stop time of each word and utterance

  • Gender, emotion, sentiment, and other related data

In most use-cases, a transcript complete with all forms of metadata is preferable, however, text and jsontop outputs can be useful during integration testing because they are easier to read.