Microsoft Azure Cognitive Services Speech SDK for JavaScript
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode adding support to run tests in vscode (#13) Dec 20, 2018
ci Build fix: publish NPM package to artifacts (#28) Jan 16, 2019
src updating property docs, setters get getters doc as well and come last. ( Jan 14, 2019
tests Add tests for authtoken utilization. These tests run over the course … Jan 10, 2019
.editorconfig .editorconfig: added Dec 19, 2018
.gitattributes .editorconfig: added Dec 19, 2018
.gitignore Initial import of sources (#2) Dec 17, 2018
.npmignore Initial import of sources (#2) Dec 17, 2018
BuildTestConfig.cmd .editorconfig: added Dec 19, 2018
LICENSE Initial import of sources (#2) Dec 17, 2018
README.md Wolfma/readme (#27) Jan 16, 2019
REDIST.txt REDIST.txt: add microsoft.cognitiveservices.speech.sdk.bundle-min.js (#6 Dec 17, 2018
RunTests.cmd .editorconfig: added Dec 19, 2018
_config.yml Initial import of sources (#2) Dec 17, 2018
bundleApp.js Initial import of sources (#2) Dec 17, 2018
gulpfile.js Initial import of sources (#2) Dec 17, 2018
jest.config.js Initial import of sources (#2) Dec 17, 2018
jsdoc-conf.json .editorconfig: added Dec 19, 2018
microsoft.cognitiveservices.speech.sdk.ts Remove storage classes and consumers. These were being used to cache … Jan 10, 2019
package-lock.json Add tests for authtoken utilization. These tests run over the course … Jan 10, 2019
package.json Add tests for authtoken utilization. These tests run over the course … Jan 10, 2019
tsconfig.json .editorconfig: added Dec 19, 2018
tslint.json .editorconfig: added Dec 19, 2018

README.md

npm version Downloads

Microsoft Cognitive Services Speech SDK for JavaScript

The Microsoft Cognitive Services Speech SDK for JavaScript is the JavaScript version of the Microsoft Cognitive Services Speech SDK. An in-depth description of feature set, functionality, supported platforms, as well as installation options is available here.

The JavaScript versions of the Cognitive Services Speech SDK supports browser scenarios as well as the Node.js environment.

Installing

For the latest stable version:

npm install microsoft-cognitiveservices-speech-sdk

Documentation

Building

This source code for the Cognitive Services Speeck SDK (JavaScript) is available in a public GitHub repository. You are not required to go through the build process. We create prebuilt packages tuned for your use-cases. These are updated in regular intervals.

In order to build the Speech SDK, ensure that you have Git and Node.js installed.

Clone the repository:

git clone https://github.com/Microsoft/cognitive-services-speech-sdk-js

Change to the Speech SDK directory:

cd cognitive-services-speech-sdk-js

Install the required packages:

npm install

Run the build:

npm run build

Data / Telemetry

This project collects data and sends it to Microsoft to help monitor our service performance and improve our products and services. Read the Microsoft Privacy Statement to learn more.

To disable telemetry, you can call the following API:

// disable telemetry data
sdk.Recognizer.enableTelemetry(false);

This is a global setting and will disable telemetry for all recognizers (already created or new recognizers).

We strongly recommend you keep telemetry enabled. With telemetry enabled you transmit information about your platform (operating system and possibly, Speech Service relevant information like microphone characteristics, etc.), and information about the performance of the Speech Service (the time when you did send data and when you received data). It can be used to tune the service, monitor service performance and stability, and might help us to analyze reported problems. Without telemetry enabled, it is not possible for us to do any form of detailed analysis in case of a support request.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.