KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

speech-to-text-code-pattern

★ 46 Open GitHub ↗

WARNING: This repository is no longer maintained

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# WARNING: This repository is no longer maintained :warning:

> This repository will not be updated. The repository will be kept available in read-only mode.

[![Build Status](https://github.com/IBM/speech-to-text-code-pattern/actions/workflows/nodejs.yml/badge.svg?branch=master)](https://github.com/IBM/speech-to-text-code-pattern/actions/workflows/nodejs.yml)

# 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/ ✨

![architecture](https://raw.githubusercontent.com/IBM/speech-to-text-code-pattern/master/doc/source/images/architecture.png)

## 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/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.

## Steps

1. [Provision Watson Speech to Text](#1-Provision-Watson-Speech-to-Text)
2. [Deploy the server](#2-Deploy-the-server)
3. [Use the web app](#3-Use-the-web-app)

## 1. Provision Watson Speech to Text

The instructions will depend on whether you are provisioning services using IBM Cloud Pak for Data or on IBM Cloud.

**Click to expand one:**

<details><summary>IBM Cloud Pak for Data</summary>


<h4>Install and provision</h4>

The service is not available by default. An administrator must install it on the IBM Cloud Pak for Data platform, and you must be given access to the service. To determine whether the service is installed, click the Services icon (<img class="lazycontent" src="doc/source/images/services_icon.png" alt="services_icon"/>) and check whether the service is enabled.

<h4>Gather credentials</h4>

<ol>
 <li>For production use, create a user to use for authentication. From the main navigation menu (☰), select Administer > Manage users and then + New user.</li>
 <li>From the main navigation menu (☰), select My instances.</li>
 <li>On the Provisioned instances tab, find your service instance, and then hover over the last column to find and click the ellipses icon. Choose View details.</li>
 <li>Copy the URL to use as the SPEECH_TO_TEXT_URL when you configure credentials.</li>
 <li>Optionally, copy the Bearer token to use in development testing only. It is not recommended to use the bearer token except during testing and development because that token does not expire.</li>
 <li>Use the Menu and select Users and + Add user to grant your user access to this service instance. This is the SPEECH_TO_TEXT_USERNAME (and SPEECH_TO_TEXT_PASSWORD) you will use when you configure credentials to allow the Node.js server to authenticate.</li>
</ol>

</details>

<details><summary>IBM Cloud</summary>

<h4>Create the service instance</h4>

* If you do not have an IBM Cloud account, register for a free trial account [here](https://cloud.ibm.com/registration).
* Click [here](https://cloud.ibm.com/catalog/services/speech-to-text) to create a **Speech to Text** instance.
 * `Select a region`.
 * `Select a pricing plan` (**Lite** is *free*).
 * Set your `Service name` or use the generated one.
 * Click `Create`.
* Gather credentials
 * Copy the API Key and URL to use when you configure and [deploy the server](#2-Deploy-the-server).

> If you need to find the service later, use the main navigation menu (☰) and select **Resource list** to find the service under **Services**.
Click on the service name to get back to the **Manage** view (where you can collect the **API Key** and **URL**).

</details>

## 2. Deploy the server

Click on one of the options below for instructions on deploying the Node.js server.

|   |   |
| - | - |
| [![local](https://raw.githubusercontent.com/IBM/pattern-utils/master/deploy-buttons/local.png)](https://raw.githubusercontent.com/IBM/speech-to-text-code-pattern/master/doc/source/local.md) | [![openshift](https://raw.githubusercontent.com/IBM/pattern-utils/master/deploy-buttons/openshift.png)](https://raw.githubusercontent.com/IBM/speech-to-text-code-pattern/master/doc/source/openshift.md) |

## 3. Use the web app

* Select an input `Language model` (defaults to English).

* Press the `Play audio sample` button to hear our example audio and watch as it is transcribed.

* Press the `Record your own` button to transcribe audio from your microphone. Press the button again to stop (the button label becomes `Stop recording`).

* Use the `Upload file` button to transcribe audio from a file.

![architecture](https://raw.githubusercontent.com/IBM/speech-to-text-code-pattern/master/doc/source/images/stt.png)

## Developing and testing

See [DEVELOPING.md](DEVELOPING.md) and [TESTING.md](TESTING.md) for more details about developing and testing this app.

## License

This code pattern is licensed under the Apache License, Version 2. Separate third-party code objects invoked within this code pattern are licensed by their respective providers pursuant to their own separate licenses. Contributions are subject to the [Developer Certificate of Origin, Version 1.1](https://developercertificate.org/) and the [Apache License, Version 2](https://www.apache.org/licenses/LICENSE-2.0.txt).

[Apache License FAQ](https://www.apache.org/foundation/license-faq.html#WhatDoesItMEAN)

speech-to-text-code-pattern

Was this content helpful?

Recent Feedback

Download README