This is the documentation for a previous version of our product. Click here to see the latest version.

Batch Virtual Appliance

High-Level Summary

This release updates the language packs for German and Dutch. It also adds metadata tags for profanities in English in the JSON output

It is recommended that customers on previous releases upgrade to this version.

Important Notices

The legacy V1 API that the Batch Virtual Appliance currently supports will be discontinued in the near future. We will align the product with the same V2 API used by the Speechmatics SaaS: We recommend that customers familiarise themselves with the configuration object used to specify job configurations, and also prepare to integrate to the V2 API. The configuration object in V2 is a superset of the configuration object in V1, so you can start to adopt it now to minimise required integration changes.

What's New

  • New German and Dutch language packs
  • Profanity tagging in English

Issues Fixed

The following issues are addressed since the previous release:

Issue IDSummaryResolution Description
REQ-15418Custom dictionary with splitting characters gets incorrect pronunciationWhen using words with splitting characters in a Custom Dictionary (for example covid-19) where a number follows a word we now have the correct pronunciations created. Splitting characters include ["-", "_", "/", "<", ">", ":", " "]. This is for all languages
REQ-11426When there are two speakers in German, the second speaker is sometimes not transcribedThis is now resolved in the latest German release
REQ-11960Transcripts are blank for some German audio filesThis is now resolved in the latest German release
REQ-12791Some German numbers are not transcribed accurately or are missingThis is now resolved in the latest German release
REQ-12792Some German transcripts are missing wordsThis has now been resolved in the latest German release
REQ-15870In the global english language pack the word "check" with British output locale is always transcribed as "cheque"This is now fixed in the English language pack

Known Limitations

The following are known issues in this release:

Issue IDSummaryDetailed Description and Possible Workarounds
REQ-1409Proteus HCL with <unk> causes out of memory errorA custom dictionary list that contains the word '' causes the worker to crash.
REQ-7549Memory leak affecting gRPCThere is a small memory leak in the gRPC Python server (
REQ-10160Advanced punctuation for Spanish (es) does not contain inverted marks.Inverted marks [ ¿ ¡ ] are not currently available for Spanish advanced punctuation.
REQ-10627Double full stops when acronym is at the end of the sentenceIf there is an acronym at the end of the sentence, then a double full stop will be output, for example: "team G.B.."
REQ-111353.2.0 introduced unwanted hesitations in transcripts for English (en).Due to changes in the way that training data is now ingested to improve the accuracy of spontaneous speech for English (en) there is a greater likelihood that hesitations will be included in the output transcrtips. We plan to support a hesitation filtering capability in a future release for customers that do not want to see hesitations on transcripts.
REQ-14402When running very large numbers of small jobs (<10 seconds) offline, this may cause some of the jobs to be rejectedIf you encounter this issue, please ensure licensing is in offline mode when running the appliance offline

Supported Platforms

Virtual Appliance image (OVA) for installation on:

  • VMware ESXi 6.5+ or VMware Workstation Player.
  • VirtualBox 5.2+
  • Amazon EC2

See the Installation and Admin Guide for details on the minimum specifications for the VM. The maximum number of concurrent jobs (maxworkers) that you can run on a single appliance is 30.

Form Factors

VariantImage SizeMax. Disk SpaceLanguages
mini19GB40GBen, de, es
midi37GB60GBen, de, es, fr, ko, ja, nl, pt
maxi64GB80GBen, de, es, fr, ko, ja, nl, pt, it, da, pl, ca, hi, ru, sv
plus65GB80GBen, cmn, no, ar, bg, cs, el, fi, hu, hr, lt, lv, ro, sk, sl, tr, ms

Upgrade Path

Remove the license from your old appliance (see the Admin Guide), then re-import the new OVA and configure networking as per the Installation and Admin guide. You will need to re-apply the license code you have once the OVA has imported.


Upload the OVA to VMWare ESX, VMWare Workstation Player, or VirtualBox. See the Installation and Admin Guide for more information.