kesuskim / speech-to-text-nodejs

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

Speech to Text Nodejs Starter Application

The Speech to Text service uses IBM's speech recognition capabilities to convert English speech 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 can be accessed via a REST interface.

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
  name: <application-name>
  command: node app.js
  path: .
  memory: 128M

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

4. Connect to Bluemix in the command line tool.

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

5. Create the Speech to Text service in Bluemix.

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

6. 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][http://nodejs.org/] and [npm][https://www.npmjs.com/] 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 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",
       "plan": "free"
    }]
   }
   }

   You need to copy username, password and url.

2. Install Node.js

3. Go to the project folder in a terminal and run: npm install

4. Start the application

5. node app.js

6. 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

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