speechmatics-python  

Python client library and CLI for Speechmatics Realtime and Batch ASR v2 APIs.

Getting started

To install from PyPI:

$ pip install speechmatics-python

To install from source:

$ git clone https://github.com/speechmatics/speechmatics-python
$ cd speechmatics-python && python setup.py install

Requirements

• Python 3.7+

Example command-line usage

Realtime ASR

• Starting a real-time session for SaaS customers using a .wav file as the input audio:

  # Point URL to the SaaS self-service runtime
  $ URL=wss://eu2.rt.speechmatics.com/v2/en
  
  $ speechmatics transcribe --url $URL --ssl-mode regular --auth-token $AUTH_TOKEN --generate-temp-token example_audio.wav

• Starting a real-time session for enterprise SaaS customers using a .wav file as the input audio:

  $ speechmatics transcribe --url $URL --ssl-mode regular --auth-token $AUTH_TOKEN example_audio.wav

• Starting a real-time session for on-prem customers using a .wav file as the input audio:

  # Point URL to the local instance of the realtime appliance
  $ URL=ws://realtimeappliance.yourcompany:9000/v2
  
  $ speechmatics transcribe --url $URL --lang en --ssl-mode none example_audio.wav

• Show the messages that are going over the websocket connection:

  $ speechmatics -v transcribe --url $URL --lang en --ssl-mode none example_audio.wav

• The CLI also accepts an audio stream on standard input. Transcribe the piped input audio:

  $ cat example_audio.wav | speechmatics transcribe --ssl-mode none --url $URL --lang en -

• Pipe audio directly from the microphone (example uses MacOS with ffmpeg)

  List available input devices:

  $ ffmpeg -f avfoundation -list_devices true -i ""

  There needs to be at least one available microphone attached to your computer. The command below gets the microphone input and pipes it to the transcriber. You may need to change the sample rate to match the sample rate that your machine records at. You may also need to replace :default with something like :0 or :1 if you want to use a specific microphone.

  $ ffmpeg -loglevel quiet -f avfoundation -i ":default" -f f32le -acodec pcm_f32le -ar 44100 - \
  >   | speechmatics transcribe --ssl-mode none --url $URL --raw pcm_f32le --sample-rate 44100 --lang en -

• Transcribe in real-time with partials (example uses Ubuntu with ALSA). In this mode, the transcription engine produces words instantly, which may get updated as additional context becomes available.

  List available input devices:

  $ cat /proc/asound/cards

  Record microphone audio and pipe to transcriber:

  $ ffmpeg -loglevel quiet -f alsa -i hw:0 -f f32le -acodec pcm_f32le -ar 44100 - \
      | speechmatics transcribe --ssl-mode none --url $URL --enable-partials --raw pcm_f32le --sample-rate 44100 --lang en -

  Add the --print-json argument to see the raw JSON transcript messages being sent rather than just the plaintext transcript.

  Batch ASR

• Submit a .wav file for batch ASR processing

  # Point URL to Speechmatics SaaS (Batch Virtual Appliance is also supported)
  $ URL=https://asr.api.speechmatics.com/v2/
  $ AUTH_TOKEN='abcd01234'
  
  $ speechmatics batch transcribe --url $URL --auth-token $AUTH_TOKEN --lang en example_audio.wav

• Files may be submitted for asynchronous processing

  $ speechmatics batch submit --url $URL --auth-token $AUTH_TOKEN --lang en example_audio.wav

• Check processing status of a job

  # $JOB_ID is from the submit command output
  $ speechmatics batch job-status --url $URL --auth-token $AUTH_TOKEN --job-id $JOB_ID

• Retrieve completed transcription

  # $JOB_ID is from the submit command output
  $ speechmatics batch get-results --url $URL --auth-token $AUTH_TOKEN --job-id $JOB_ID

  Custom Transcription Config File

• Instead of passing all the transcription options via the command line you can also pass a transcription config file. The config file is a JSON file that contains the transcription options. The config file can be passed to the CLI using the --config-file option.

  $ speechmatics transcribe --config-file transcription_config.json example_audio.wav

• The format of this JSON file is described in detail in the Batch API documentation and RT API documentation.

API documentation

Please see https://speechmatics.github.io/speechmatics-python/.

Testing

To install development dependencies and run tests

$ pip install -r requirements-dev.txt
$ make test

Support

If you have any issues with this library or encounter any bugs then please get in touch with us at [email protected].

License: MIT