Container Usage Reporting
Speechmatics offers two ways for you to report your transcription usage.
- Automatic Usage Reporting is the most convenient way to report on usage. This works by automatically sending periodic HTTPS requests to Speechmatics over the course of a transcription session.
- The Usage Container can be used if you have specific restrictions preventing connection to the Internet. This produces an output which needs to be sent to Speechmatics via email.
For further information, please also refer to What Data Do We Record?
Automatic Usage Reporting
Transcription:BatchReal-TimeDeployments:ContainerStatus:BetaGetting Started
The most convenient way of reporting usage to Speechmatics is by allowing Automatic Usage Reporting. The transcriber will automatically connect to Speechmatics servers to send required usage analytics.
This feature works by sending periodic HTTPS requests to Speechmatics over the course of a transcription session. Information recorded includes the job configuration, the duration of transcription, and the amount of audio being transcribed. We aim to be completely transparent about exactly What Data We Record.
Compatibility
To enable automatic usage reporting, you must be running one of the following ASR Container versions:
- Batch Container 10.1.0 onwards
- Real-Time Container 10.1.0 onwards
Introduction
The most convenient way of reporting usage to Speechmatics is by allowing Automatic Usage Reporting. The transcriber will automatically connect to Speechmatics servers to send required usage analytics.
This feature works by sending periodic HTTPS requests to Speechmatics over the course of a transcription session. Information recorded includes the job configuration, the duration of transcription, and the amount of audio being transcribed. We aim to be completely transparent about exactly What Data We Record.
This feature is turned ON by default and is currently opt out. It is turned off by setting the environment variable SM_ENABLE_USAGE_REPORTING=false
(false
, no
or 0
are equally valid) when running the transcriber. For example:
docker run -i -v ~/$AUDIO_FILE:/input.audio \
-e LICENSE_TOKEN=eyJhbGciOiJ... \
-e SM_ENABLE_USAGE_REPORTING=false \
batch-asr-transcriber-en:11.0.1
Automatic Usage Reporting will be ON by default, starting from version 10.6.0.
For further information see automatic usage Technical Details
We will never send customer audio data over the network. See What Data Do We Record for a full description of what information will be recorded.
Offline Usage Reporting
Transcription:BatchReal-TimeDeployments:ContainerTerminology
Throughout this document there are references to different types of containers:
- ASR Containers - Speechmatics containers that transcribe media or audio files into a transcript. Two types are available - those can process media in batch, and those that can process media in real-time. When these are specifically referred to they are called the Batch or Real-Time Containers
- Usage Containers - a new container that stores event-specific data from ASR Containers
Getting Started
The ASR Usage Container can be retrieved from Speechmatics Docker Registry as a Docker Image. To access the Usage Container, you should use the same credentials that you use to access Speechmatics' ASR Containers from its Docker Registry. This information should already be provided to you by Support when you are onboarded.
You will also need to know the following information:
- Docker Registry URL, e.g.
https://speechmatics-docker-public.jfrog.io
- Image name, e.g.
asr-usage
- Image tag, e.g.
0.2.0
The image can be downloaded by using the standard Docker workflow: