For the latest stable version:
npm install microsoft-cognitiveservices-speech-sdk
Clone the repository:
git clone https://github.com/Microsoft/cognitive-services-speech-sdk-js
Change to the Speech SDK directory:
Install the required packages:
Run the build:
npm run build
Run tests (see ci/build.yml) -- complete results require several specifically-configured subscriptions, but incomplete results can be obtained with a subset (expect and ignore failures involving missing assignments).
At a minimum, invoking
npm run test will compile/lint the test files to catch early problems in test code changes.
RunTests.cmd ^ SpeechSubscriptionKey:SPEECH_KEY ^ SpeechRegion:SPEECH_REGION ^ LuisSubscriptionKey:LUIS_KEY ^ LuisRegion:LUIS_REGION ^ SpeechTestEndpointId:CUSTOM_ENDPOINT ^ BotSubscription:BOT_KEY ^ BotRegion:BOT_REGION ^ SpeakerIDSubscriptionKey:SPEAKER_ID_KEY ^ SpeakerIDRegion:SPEAKER_ID_SUBSCRIPTION_REGION ^ CustomVoiceSubscriptionKey:CUSTOM_VOICE_KEY ^ CustomVoiceRegion:CUSTOM_VOICE_REGION
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.
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.