Speechly
Client libraries, examples and demos of Speechly API for the Web.
Install / Use
/learn @speechly/SpeechlyREADME
Website · Docs · Support · Blog · Login
<br/> </div>Speechly
Speechly offers Automatic Speech Recognition (ASR) and Natural Language Understanding (NLU) tools, SDKs and APIs. Easily integrate Speechly into your product and deploy on-device, on-premise or in the cloud.
This monorepository contains Speechly's web related libraries, demos and examples.
Libraries
Speechly client libraries provide the natural Spoken Language Understanding API for web applications. They handle audio capturing and streaming, authentication, and network connection to Speechly cloud API.
| Folder | Version | npm package | Description |
| ------------------------------------------------------ | ------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------- |
| /libraries/browser-client | 
Related repositories
- Speechly Android Client
- Speechly iOS Client
- Speechly Unity Client
- Speechly API gRPC protos and pre-compiled stubs
Demos
This monorepository contains the source code of Speechly demos available at https://demos.speechly.com. They are built using React and Speechly's react-client and react-ui. Each of the demo subfolder is a stand-alone project. See the demos' README for further instructions.
| Folder | Description | | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | /demos/moderation | The moderation demo highlights profanities from various audio clips and labels the utterances into offensive and non offensive ones in real time. | | /demos/transcription | The transcription demo accurately transcribes both live and pre-recorded audio using our off-the-shelf speech recognition model in real time. |
Examples
Example applications to get you started developing with Speechly.
| Folder | Description | | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | /examples/browser-client-example | An example JavaScript app built with Speechly Browser Client. | | /examples/react-client-example | An example React app built with Speechly React Client. | | /examples/ios-decoder-example | An example iOS app for using the Speechly Decoder library for on-device transcription. | | /examples/ios-client-example | An example iOS app for filtering GitHub repositories built with Speechly iOS Client. | | /examples/android-decoder-example | An example Android app for using the Speechly Decoder library for on-device transcription. | | /examples/android-client-example | An example Android app for filtering GitHub repositories built with Speechly Android Client. |
How to get help?
For general discussion or questions, please use our GitHub Discussion forum.
For feature requests or bug reports, please file a GitHub Issue.
Contributing
We are happy to receive community contributions! For small fixes, feel free to file a pull request. For bigger changes or new features start by filing an issue.
How to use this Rush monorepository
This monorepository is set up using rushjs. Rush can be used to build all projects and libraries in one go. It also helps with develop and test features that span multiple libraries and/or projects.
Each project and library is a stand-alone node project that can be built and devoped with npm or pnpm. To run a single examples or demos, just follow the instructions in the project's README.
To build all projects using Rush, run
npm install -g @microsoft/rush
npm install -g pnpm
rush update
rush build
This will build everything in the repository – This may take a while! After this step, you can run any example or demo by navigating to the corresponding folder (e.g. examples/browser-client-example) and running
rushx start
Before doing a PR, remember to create a changelog entry with
rush change -b origin/main
Learn more
- Quick Start Guide – Learn how to create a Speechly application and transcribe both live and pre-recorded audio.
- Developer Documentation – Browse the latest developer documentation, including sample code and reference docs.
- Speechly Demos – Get inspired and see what you can build with Speechly.
- Speechly Dashboard – Create, edit and manage your Speechly applications & projects.
- Speechly CLI – Interact with Speechly from the comfort of your CLI.
