Product Plugins: Transcription - Speechmatics

Transcription

Transcription is a feature of the ShareDo platform that allows quick and easy speech-to-text conversion across several ShareDo functions. The Transcription article provides more information about using this functionality

Provider

Speechmatics is one of the providers available for transcription functionality on the ShareDo platform. This functions on a BYOL (Bring Your Own License) basis. We recommend you check out their website and trial their service before committing. Once you're happy and have an agreement, tier, contract or package in place, you will be able to use your credentials to set up Speechmatics as a provider in ShareDo.

You can find more about Speechmatics and register for an account on their website.

Installation

To have Speechmatics installed on your ShareDo environment, there is an initial requirement that you must be on ShareDo version 7.9.0 or later.

Reach out to your CSM, and they will install the latest version of the plugin for you, initially on a non-production environment for you to test and then in production.

Configuration

The configuration of a transcription plugin involves two steps: the Global Feature and a Linked Service for authentication.

Global Feature Config

Navigate to: Modeller > Global Features

Then search for the transcription Feature.

  1. Firstly, ensure the checkbox is enabled, then click the green cog. This opens the configurtion blade.
  2. On this screen, you have a drop-down to choose the provider (if you have more than one provider installed), choose Speechmatics.
  3. Next, the Global Feature will check to see if there is a matching Linked Service and whether it is configured correctly. This message will be red, amber, or green.
    1. Red - No Linked Service found.
    2. Amber - Linked Service exists, but some fields are missing or incorrect.
    3. Green - Everything looks good, and is working as expected.
  4. You can configure the Linked service directly from the button on the Global Feature blade, but we'll come back to that shortly.
  5. For now, you need to make sure you enter the:
    1. Socket API URL: In our case, this was wss://eu2.rt.speechmatics.com/
      For now, it looks like all Speechmatics Customers use the same URL, but this could change in future. Please consult the Speechmatics Documentation.
  6. Don't forget to Save & Close the Global Feature.

Linked Service Config

Next, we need to configure the Linked Service. If you are still on the Transcription Global Feature Blade, you can click Configure it. Otherwise, you can navigate to Admin > Integrations > Manage Linked Services.

  1. Look for a service called Speechmatics.
  2. If it doesn't exist, you can create it by clicking the green Add New icon in the top right-hand corner.
  3. Then choose Shared secret from the list of available service providers.
  4. You will need to populate the following fields:
Field Value
System-name speechmatics
Name [No Specific Value] Speechmatics Service
Icon [No Specific Value] We use ‘fa-microphone’
Description [Optional]
Secret {Your own API key}
Allow fallback to system secret Yes
API Base URL https://mp.speechmatics.com
HTTP Header to send token in Authorization
HTTP Header Prefix Bearer
  • Fields in Bold are mandatory
  • Fields with [No Specific Value] can be set as you please
  • Secret must be populated with your own API Key

Once you're done, hit Save & Close. Then, navigate back to the User side of ShareDo, and you can test it out in any Rich Text Field.