mdabbagh88 / speech-to-text-nodejs

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

Speech to Text Browser Application

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;

Node.js is also used to provide the browser client's authentication token.

Give it a try! Click the button below to fork into IBM DevOps Services and deploy your own copy of this application on Bluemix.

Getting Started

1. Create a Bluemix Account

   Sign up in Bluemix, or use an existing account. Watson Services in Beta are free to use.

2. Download and install the Cloud-foundry CLI tool

3. Edit the manifest.yml file and change the <application-name> to something unique.

applications:
- services:
  - speech-to-text-service-standard
  name: <application-name>
  command: node app.js
  path: .
  memory: 512M

The name you use will determinate your application url initially, e.g. <application-name>.mybluemix.net.

4. Install Node.js

5. Connect to Bluemix in the command line tool.

$ cf api https://api.ng.bluemix.net
$ cf login -u <your user ID>

7. Create the Speech to Text service in Bluemix.

$ cf create-service speech_to_text standard speech-to-text-service-standard

8. Push it live!

$ cf push

See the full Getting Started documentation for more details, including code snippets and references.

Running locally

The application uses Node.js and npm so you will have to download and install them as part of the steps below.

1. Copy the credentials from your speech-to-text-service-standard service in Bluemix to app.js, you can see the credentials using:

   $ cf env <application-name>

   Example output:

   System-Provided:
   {
   "VCAP_SERVICES": {
     "speech_to_text": [{
         "credentials": {
           "url": "<url>",
           "password": "<password>",
           "username": "<username>"
         },
       "label": "speech-to-text",
       "name": "speech-to-text-service-standard",
       "plan": "standard"
    }]
   }
   }

   You need to copy username, password and url. Then you need to pass those values in app.js

   var config = {
     version: 'v1',
     url: 'https://stream.watsonplatform.net/speech-to-text/api',
     username: '<username>',
     password: '<password>'  
   };
   

2. Install Node.js

3. To install project dependencies, go to the project folder in a terminal and run:

   $ npm install

4. Start the application:

   $ npm start

5. Go to: http://localhost:3000

Troubleshooting

To troubleshoot your Bluemix app the main useful source of information are the logs, to see them, run:

$ cf logs <application-name> --recent

For problems with recording audio, you can play back the audio you just recorded for debugging purposes. To do that, add '?debug=true' (without the quotations) in the URL.

License

This sample code is licensed under Apache 2.0. Full license text is available in LICENSE.

Contributing

See CONTRIBUTING.

Open Source @ IBM

Find more open source projects on the IBM Github Page

Privacy Notice

This node sample web application includes code to track deployments to Bluemix and other Cloud Foundry platforms. The following information is sent to a Deployment Tracker service on each deployment:

• Application Name (application_name)
• Space ID (space_id)
• Application Version (application_version)
• Application URIs (application_uris)

This data is collected from the VCAP_APPLICATION environment variable in IBM Bluemix and other Cloud Foundry platforms. This data is used by IBM to track metrics around deployments of sample applications to IBM Bluemix. Only deployments of sample applications that include code to ping the Deployment Tracker service will be tracked.

Disabling Deployment Tracking

Deployment tracking can be disabled by removing require('cf-deployment-tracker-client').track(); from the beginning of the server.js file at the root of this repo.