V‑Blaze REST API version 3.0.0 (May 2021)
V‑Blaze REST API version 3.0.0 is a major release with numerous new features and improvements.
Added new V‑Blaze REST API Flows
Tag specification enabled via header or url parameters. Refer to Submitting transcription requests for more information.
Simple, single part POSTs. Refer to Submitting transcription requests for more information.
WebSockets to enable bidirectional streaming of data via upgraded connections. Refer to WebSocket API interface for more information.
Simple results streaming back through the primary HTTP (POST) connection. Either JSON utterance data or scrubbed audio can be streamed back, but not both in the same connection. Refer to /db/organizations/medallia/repositories/voci-production/content/documents/Voci/V-Blaze/API/http_results_streaming.dita#http_results_streaming for more information.
The
vociwebapiservice script now attempts to allow a clean exit. Astoporrestartoperation will block new/transcribePOSTS, but will allow existing/transcriberequests and any newGETrequests to complete before exiting. Refer to V‑Blaze service commands for more information.Added new stats endpoint, and made updates to the status, statusfull, and sysinfo endpoints.
The
/statusandstatusfullendpoints have changed to better reflect the current state of the ASR system. They are now lightweight calls that show summary information about current state of ASR processing.The following fields were added to
/statusandstatusfull: efficiency, stream.audiosecs, stream.count, stream.errors, stream.speed, stream.warnings, utt.audiosecs, utt.count, utt.speed, utt.tat, utt.tat.max, utilization.idle, and shutdownin. The shutdownin field only shows up if a query is made during the shutdown waiting period, and indicates the number of seconds remaining before shutdown.The following fields were removed from
/statusandstatusfull: lastactive, totalerrors, totalidle, totalstreamsThe
sysinfoendpoint shows the same product and server information with additional information included such as system sizing, licensing, and capacity.The following fields were added: aminfo, expires, gpudriver, gpumem, licenses, maxdecoders, maxstreams
The new
/statsendpoint includes detailed performance-related metrics. Time-window averages allow users to determine how the system performed within the last 1, 5 and 15 minute windows. This allows clients to analyze the consistency of their machine by comparing measurements across different windows. The comprehensiveness of the/statsresponse provides users with a view of the system internals. Expert users may use this to fine tune their system and API implementation for optimal performance.
The
datahdrparameter now defaults toWAVEwhen not specified. Customers who require legacy behavior or a customized default can configure using thedatahdrsetting in webapi.cfg.For more information on
datahdr, refer to Adjusting for audio.Minor bug fixes and general improvements.
