sambaker/speech-to-text-nodejs

:microphone: Sample Node.js Application for the IBM Watson Speech to Text Service

🎤 Speech to Text Demo

Node.js sample applications that shows some of the the IBM Watson Speech to Text service features.

The Speech to Text service uses IBM's speech recognition capabilities to convert speech in multiple languages into text. The transcription of incoming audio is continuously sent back to the client with minimal delay, and it is corrected as more speech is heard. The service is accessed via a WebSocket interface; a REST HTTP interface is also available;

You can view a demo of this app.

Prerequisites

1. Sign up for an IBM Cloud account.
2. Download the IBM Cloud CLI.
3. Create an instance of the Speech to Text service and get your credentials:
   • Go to the Speech to Text page in the IBM Cloud Catalog.
   • Log in to your IBM Cloud account.
   • Click Create.
   • Click Show to view the service credentials.
   • Copy the apikey value, or copy the username and password values if your service instance doesn't provide an apikey.
   • Copy the url value.

Configuring the application

1. In the application folder, copy the .env.example file and create a file called .env

   cp .env.example .env
   

2. Open the .env file and add the service credentials that you obtained in the previous step.

   Example .env file that configures the apikey and url for a Speech to Text service instance hosted in the US East region:

   SPEECH_TO_TEXT_IAM_APIKEY=X4rbi8vwZmKpXfowaS3GAsA7vdy17Qh7km5D6EzKLHL2
   SPEECH_TO_TEXT_URL=https://gateway-wdc.watsonplatform.net/speech-to-text/api
   

   • If your service instance uses username and password credentials, add the SPEECH_TO_TEXT_USERNAME and SPEECH_TO_TEXT_PASSWORD variables to the .env file.

   Example .env file that configures the username, password, and url for a Speech to Text service instance hosted in the Sydney region:

   SPEECH_TO_TEXT_USERNAME=522be-7b41-ab44-dec3-g1eab2ha73c6
   SPEECH_TO_TEXT_PASSWORD=A4Z5BdGENrwu8
   SPEECH_TO_TEXT_URL=https://gateway-syd.watsonplatform.net/speech-to-text/api
   

Running locally

1. Install the dependencies

   npm install
   

2. Run the application

   npm start
   

3. View the application in a browser at localhost:3000

Deploying to IBM Cloud as a Cloud Foundry Application

1. Login to IBM Cloud with the IBM Cloud CLI

   ibmcloud login
   

2. Target a Cloud Foundry organization and space.

   ibmcloud target --cf
   

3. Edit the manifest.yml file. Change the name field to something unique. For example, - name: my-app-name.

4. Deploy the application

   ibmcloud app push
   

5. View the application online at the app URL, for example: https://my-app-name.mybluemix.net

License

This sample code is licensed under Apache 2.0.

Contributing

See CONTRIBUTING.

Open Source @ IBM

Find more open source projects on the IBM Github Page