V‑Blaze REST API version 2.0.0-1
This section describes new features and capabilities that were introduced in the 2.0.0-1 release of the V‑Blaze REST API package.
Important
Please take special note of the output format changes, which will probably require minor modifications to any application that use the existing API.
Change in default JSON output format - WebAPI now returns a JSON dictionary by default (stream tag
output=json
). The outer list (square brackets) with which JSON was delivered has been eliminated. The structure of the inner JSON dictionary has not changed, and is now returned directly without the outer list. This change makes the output consistent with other APIs such as V-Cloud. To produce JSON output in the list format that was previously used by the API, users can manually specify theoutput=jsonlist
stream tag when calling the API.Change in default text output format - Text output (stream tag
output=text
) has changed from a JSON representation of the transcript, stored insource
andutterances
fields, to a simple plain text string. To produce text output in the format that was previously used by the API, users can specify theoutput=jsontextlist
stream tag when calling the API.Administrators can temporarily retain/lock the legacy
json
andtext
output formats for applications that use the existing API implementations by using the yum-plugin-versionlock to freeze their installation to use thevoci-webapi-2.0.0-compat
package. However, by doing this, no future updates/fixes to the WebAPI package will be applied by yum updates. recommends modifying any applications that depend on the old output formats, so that those applications can use the new output formats.The WebAPI can be configured by adding long-lived settings to the file
/opt/voci/state/webapi.cfg
.Detailed logging of each submitted API request can now be enabled by setting
accesslog=true
in the configuration file. The access log file location is/var/log/vociwebapi/access.log
.An identifier for each transcription request, known as a
requestid
, can be specified as a stream tag or in theX-Request-Id
HTTP header. If arequestid
is provided in one of these ways, the specifiedrequestid
is included in JSON output and in the WebAPI access log (if that log is enabled).The following output formats have been added, and can be specified by using the
output
stream tag:jsontop
- all utterance details are collapsed into a single text field, which is consistent with the same option in the V-Cloud APIjsonlist
,jsontextlist
- added to provide compatibility for applications that use the existing WebAPI 1.x output formats. The existing output formats ofjson
andtext
are retained, but behave as described at the beginning of this section of the release notes.
The
bindhost
configuration option is now provided to lock the WebAPI to listening only on a specific network interface (for example, localhost)Added support for responding to non-transcribe API requests (for example,
/status
) even when the ASR service is processing at capacityAdded new API methods to provide additional status information:
/maxstreamscheck
- describes current number of streams andmaxstreams
capacity, and returns success if not at capacity/statusfull
- returns more detailed/status
information
Eliminated support for handling multiple audio files as part of a single Multipart
/transcribe
requestImproved user-level error messages
Broadened communication protocols and increased robustness, including supporting
100-continue
and theConnection: close
header