Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/watson-developer-cloud/speech-to-text-code-pattern
React app using the Watson Speech to Text service to transform voice audio into written text.
https://github.com/watson-developer-cloud/speech-to-text-code-pattern
Last synced: 3 days ago
JSON representation
React app using the Watson Speech to Text service to transform voice audio into written text.
- Host: GitHub
- URL: https://github.com/watson-developer-cloud/speech-to-text-code-pattern
- Owner: watson-developer-cloud
- Created: 2020-01-17T18:29:44.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-07T19:04:38.000Z (over 1 year ago)
- Last Synced: 2024-05-09T16:21:36.835Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 17.1 MB
- Stars: 2
- Watchers: 6
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DEPRECATED
This code pattern and repo is no longer supported. You can find the newly supported Speech to Text Code Pattern
here.
Speech to Text Code Pattern 🗣
Sample React app for playing around with the Watson Speech to Text service.
✨ **Demo:** https://speech-to-text-code-pattern.ng.bluemix.net/ ✨
## Flow
1. User supplies an audio input to the application (running locally, in the IBM Cloud or in IBM Cloud Pak for Data).
1. The application sends the audio data to the Watson Speech to Text service through a [WebSocket connection](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-websockets).
1. As the data is processed, the Speech to Text service returns information about extracted text and other metadata to the application to display.
## Prerequisites
1. Sign up for an [IBM Cloud account](https://console.bluemix.net/registration/).
1. Download the [IBM Cloud CLI](https://console.bluemix.net/docs/cli/index.html#overview).
1. Create an instance of the Speech to Text service and get your credentials:
- Go to the [Speech to Text](https://console.bluemix.net/catalog/services/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.
- Copy the `url` value.
### Cloud Pak for Data
To use this code pattern with a Speech to Text instance provisioned on Cloud Pak for Data, you can use your CPD `username` and `password` credentials or an `access_token` to authenticate your requests. You also need the service `url` as described [here](https://cloud.ibm.com/apidocs/speech-to-text/speech-to-text-data#authentication).
Another important thing to note is that this code pattern assumes that you're using a **valid SSL certificate** for your CPD cluster. If not, you'll receive transcription errors. If you'd still like to use the app with an invalid certificate, you'll need to look up your browser-specific way to ignore these certificate errors. Do note that this is very insecure though!
## Configuring the application
Depending on where your service instance is you may have different ways to download the credentials file.
> Need more information? See the [authentication wiki](https://github.com/IBM/node-sdk-core/blob/master/Authentication.md).
### Automatically
Copy the credential file to the application folder.
**Cloud Pak for Data**
**Public Cloud**
### Manually
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 depending on your environment.
Example `.env` file that configures the `apikey` and `url` for a Speech to Text service instance hosted in the US South region:
```
SPEECH_TO_TEXT_APIKEY=12345abcde
SPEECH_TO_TEXT_URL=https://stream.watsonplatform.net/speech-to-text/api
```
- **CPD using username and password:** If your service instance is running in Cloud Pak for Data and you want to use `username` and `password` credentials, add the following variables to the `.env` file.
```
SPEECH_TO_TEXT_USERNAME=admin
SPEECH_TO_TEXT_PASSWORD=password
SPEECH_TO_TEXT_URL=https://{cpd-url}:{cpd-port}/speech-to-text/api
```
- **CPD using access token:** If your service instance is running in Cloud Pak for Data and you want to use the `access_token` from the service instance detail page, add the following:
```
SPEECH_TO_TEXT_BEARER_TOKEN=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey...
SPEECH_TO_TEXT_URL=https://{cpd-url}:{cpd-port}/speech-to-text/api
```
## Running locally
1. Install the dependencies
```
npm install
```
1. Build the application
```
npm run build
```
1. Run the application
```
npm run dev
```
1. View the application in a browser at `localhost:3000`
## Deploying to IBM Cloud as a Cloud Foundry Application
Click on the button below to deploy this demo to the IBM Cloud.
[](https://cloud.ibm.com/devops/setup/deploy?repository=https://github.com/watson-developer-cloud/speech-to-text-code-pattern)
1. Build the application
```
npm run build
```
1. Login to IBM Cloud with the [IBM Cloud CLI](https://console.bluemix.net/docs/cli/index.html#overview)
```
ibmcloud login
```
1. Target a Cloud Foundry organization and space.
```
ibmcloud target --cf
```
1. Edit the `manifest.yml` file. Change the **name** field to something unique. For example: `- name: my-app-name`.
1. Deploy the application
```
ibmcloud app push
```
1. View the application online at the app URL, for example: https://my-app-name.mybluemix.net
## Tests
#### Unit tests
Run unit tests with:
```
npm run test:components
```
See the output for more info.
#### Integration tests
First you have to make sure your code is built:
```
npm run build
```
Then run integration tests with:
```
npm run test:integration
```
## Directory structure
```none
.
├── app.js // Express routes
├── config // Express configuration
│ ├── error-handler.js
│ ├── express.js
│ └── security.js
├── package.json
├── public // Static resources
├── server.js // Entry point
├── test // Tests
└── src // React client
└── index.js // App entry point
```
## License
This sample code is licensed under the [MIT License](https://opensource.org/licenses/MIT).
## Open Source @ IBM
Find more open source projects on the [IBM Github Page](http://ibm.github.io/)