• Stars
    star
    235
  • Rank 163,613 (Top 4 %)
  • Language
    TypeScript
  • License
    Other
  • Created over 5 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Microsoft Azure Cognitive Services Speech SDK for JavaScript

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

Samples

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. Version requirement for Node: 12.44.0 or higher (or 14.17.0 or higher for Node 14).

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

Run setup to pull updated dependency versions:

npm run setup

Install the required packages:

npm install

Run the build:

npm run build

Testing

Run all tests

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

Run a subset of tests

  • Edit the file jest.config.js. Replace the regex expressions in testRegex: "tests/.*Tests\\.ts$" with one that defines the test file (or files) you want to run. For example, to only run tests defined in AutoSourceLangDetectionTests.ts, replace it with testRegex: "tests/AutoSourceLangDetectionTests.ts". Do this is for the two project jsdom and node.

  • Option 1: Use a secrets file. Create the file secrets\TestConfiguration.ts. It should import the default configuration settings and define the values of the mandatory ones for this test, as well as and any additional optional settings. For example, to run the AutoSourceLangDetectionTests.ts tests, the required mandatory values are the speech key and region (using a fake key here as an example):

    import { Settings } from "../tests/Settings";
    Settings.SpeechSubscriptionKey = "0123456789abcdef0123456789abcdef";
    Settings.SpeechRegion = "westcentralus"; 

    Then to run the tests type RunTests.cmd in the root of the repo.

  • Option 2: Use command line arguments. Instead of creating secrets\TestConfiguration.ts, pass the values directly to RunTests.cmd. For the above example, this would be:

    RunTests.cmd SpeechSubscriptionKey:0123456789abcdef0123456789abcdef SpeechRegion:westcentralus
    
  • Option 3: Edit the file tests\Settings.ts directly and enter values needed to run the test.

  • See summary of the test results in test-javascript-junit.xml.

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 [email protected] with any additional questions or comments.

More Repositories

1

vscode

Visual Studio Code
TypeScript
157,226
star
2

PowerToys

Windows system utilities to maximize productivity
C#
103,126
star
3

TypeScript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TypeScript
96,979
star
4

terminal

The new Windows Terminal and the original Windows console host, all in the same place!
C++
93,068
star
5

Web-Dev-For-Beginners

24 Lessons, 12 Weeks, Get Started as a Web Developer
JavaScript
81,067
star
6

ML-For-Beginners

12 weeks, 26 lessons, 52 quizzes, classic Machine Learning for all
HTML
65,262
star
7

playwright

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript
60,055
star
8

monaco-editor

A browser based code editor
JavaScript
35,437
star
9

generative-ai-for-beginners

18 Lessons, Get Started Building with Generative AI 🔗 https://microsoft.github.io/generative-ai-for-beginners/
Jupyter Notebook
31,194
star
10

AI-For-Beginners

12 Weeks, 24 Lessons, AI for All!
Jupyter Notebook
30,214
star
11

calculator

Windows Calculator: A simple yet powerful calculator that ships with Windows
C++
27,371
star
12

DeepSpeed

DeepSpeed is a deep learning optimization library that makes distributed training and inference easy, efficient, and effective.
Python
26,923
star
13

Data-Science-For-Beginners

10 Weeks, 20 Lessons, Data Science for All!
Jupyter Notebook
26,023
star
14

cascadia-code

This is a fun, new monospaced font that includes programming ligatures and is designed to enhance the modern look and feel of the Windows Terminal.
Python
23,884
star
15

autogen

A programming framework for agentic AI. Join our Discord: https://discord.gg/pAbnFJrkgZ
Jupyter Notebook
23,491
star
16

JARVIS

JARVIS, a system to connect LLMs with ML community. Paper: https://arxiv.org/pdf/2303.17580.pdf
Python
22,801
star
17

api-guidelines

Microsoft REST API Guidelines
22,149
star
18

winget-cli

WinGet is the Windows Package Manager. This project includes a CLI (Command Line Interface), PowerShell modules, and a COM (Component Object Model) API (Application Programming Interface).
C++
20,495
star
19

vcpkg

C++ Library Manager for Windows, Linux, and MacOS
CMake
19,600
star
20

fluentui

Fluent UI web represents a collection of utilities, React components, and web components for building web applications.
TypeScript
17,524
star
21

CNTK

Microsoft Cognitive Toolkit (CNTK), an open source deep-learning toolkit
C++
17,412
star
22

MS-DOS

The original sources of MS-DOS 1.25 and 2.0, for reference purposes
Assembly
17,220
star
23

unilm

Large-scale Self-supervised Pre-training Across Tasks, Languages, and Modalities
Python
17,032
star
24

WSL

Issues found on WSL
PowerShell
16,488
star
25

recommenders

Best Practices on Recommendation Systems
Python
16,075
star
26

LightGBM

A fast, distributed, high performance gradient boosting (GBT, GBDT, GBRT, GBM or MART) framework based on decision tree algorithms, used for ranking, classification and many other machine learning tasks.
C++
15,890
star
27

react-native-windows

A framework for building native Windows apps with React.
C++
15,855
star
28

AirSim

Open source simulator for autonomous vehicles built on Unreal Engine / Unity, from Microsoft AI & Research
C++
15,545
star
29

IoT-For-Beginners

12 Weeks, 24 Lessons, IoT for All!
C++
14,552
star
30

semantic-kernel

Integrate cutting-edge LLM technology quickly and easily into your apps
C#
14,400
star
31

Bringing-Old-Photos-Back-to-Life

Bringing Old Photo Back to Life (CVPR 2020 oral)
Python
14,132
star
32

dotnet

This repo is the official home of .NET on GitHub. It's a great starting point to find many .NET OSS projects from Microsoft and the community, including many that are part of the .NET Foundation.
HTML
14,026
star
33

qlib

Qlib is an AI-oriented quantitative investment platform that aims to realize the potential, empower research, and create value using AI technologies in quantitative investment, from exploring ideas to implementing productions. Qlib supports diverse machine learning modeling paradigms. including supervised learning, market dynamics modeling, and RL.
Python
13,919
star
34

nni

An open source AutoML toolkit for automate machine learning lifecycle, including feature engineering, neural architecture search, model compression and hyper-parameter tuning.
Python
13,084
star
35

ai-edu

AI education materials for Chinese students, teachers and IT professionals.
HTML
12,952
star
36

pyright

Static Type Checker for Python
Python
11,792
star
37

guidance

A guidance language for controlling large language models.
Jupyter Notebook
11,777
star
38

TypeScript-Node-Starter

A reference example for TypeScript and Node with a detailed README describing how to use the two together.
SCSS
11,224
star
39

Swin-Transformer

This is an official implementation for "Swin Transformer: Hierarchical Vision Transformer using Shifted Windows".
Python
11,187
star
40

TypeScript-React-Starter

A starter template for TypeScript and React with a detailed README describing how to use the two together.
TypeScript
11,081
star
41

frontend-bootcamp

Frontend Workshop from HTML/CSS/JS to TypeScript/React/Redux
TypeScript
10,797
star
42

language-server-protocol

Defines a common protocol for language servers.
HTML
10,093
star
43

onnxruntime

ONNX Runtime: cross-platform, high performance ML inferencing and training accelerator
C++
9,837
star
44

windows-rs

Rust for Windows
Rust
9,654
star
45

wslg

Enabling the Windows Subsystem for Linux to include support for Wayland and X server related scenarios
C++
9,626
star
46

sql-server-samples

Azure Data SQL Samples - Official Microsoft GitHub Repository containing code samples for SQL Server, Azure SQL, Azure Synapse, and Azure SQL Edge
9,367
star
47

computervision-recipes

Best Practices, code samples, and documentation for Computer Vision.
Jupyter Notebook
9,264
star
48

napajs

Napa.js: a multi-threaded JavaScript runtime
C++
9,256
star
49

Windows-universal-samples

API samples for the Universal Windows Platform.
JavaScript
9,253
star
50

mimalloc

mimalloc is a compact general purpose allocator with excellent performance.
C
9,165
star
51

vscode-tips-and-tricks

Collection of helpful tips and tricks for VS Code.
9,038
star
52

playwright-python

Python version of the Playwright testing and automation library.
Python
8,990
star
53

STL

MSVC's implementation of the C++ Standard Library.
C++
8,978
star
54

fast

The adaptive interface system for modern web experiences.
TypeScript
8,958
star
55

react-native-code-push

React Native module for CodePush
C
8,643
star
56

fluentui-emoji

A collection of familiar, friendly, and modern emoji from Microsoft
Python
8,487
star
57

reactxp

Library for cross-platform app development.
TypeScript
8,308
star
58

LoRA

Code for loralib, an implementation of "LoRA: Low-Rank Adaptation of Large Language Models"
Python
8,153
star
59

vscode-extension-samples

Sample code illustrating the VS Code extension API.
TypeScript
7,779
star
60

reverse-proxy

A toolkit for developing high-performance HTTP reverse proxy applications.
C#
7,702
star
61

inshellisense

IDE style command line auto complete
TypeScript
7,675
star
62

c9-python-getting-started

Sample code for Channel 9 Python for Beginners course
Jupyter Notebook
7,642
star
63

ailab

Experience, Learn and Code the latest breakthrough innovations with Microsoft AI
C#
7,604
star
64

cpprestsdk

The C++ REST SDK is a Microsoft project for cloud-based client-server communication in native code using a modern asynchronous C++ API design. This project aims to help C++ developers connect to and interact with services.
C++
7,573
star
65

WSL2-Linux-Kernel

The source for the Linux kernel used in Windows Subsystem for Linux 2 (WSL2)
C
7,430
star
66

botframework-sdk

Bot Framework provides the most comprehensive experience for building conversation applications.
JavaScript
7,272
star
67

azuredatastudio

Azure Data Studio is a data management and development tool with connectivity to popular cloud and on-premises databases. Azure Data Studio supports Windows, macOS, and Linux, with immediate capability to connect to Azure SQL and SQL Server. Browse the extension library for more database support options including MySQL, PostreSQL, and MongoDB.
TypeScript
7,182
star
68

winget-pkgs

The Microsoft community Windows Package Manager manifest repository
6,981
star
69

Windows-driver-samples

This repo contains driver samples prepared for use with Microsoft Visual Studio and the Windows Driver Kit (WDK). It contains both Universal Windows Driver and desktop-only driver samples.
C
6,568
star
70

winfile

Original Windows File Manager (winfile) with enhancements
C
6,437
star
71

nlp-recipes

Natural Language Processing Best Practices & Examples
Python
6,320
star
72

WinObjC

Objective-C for Windows
C
6,229
star
73

SandDance

Visually explore, understand, and present your data.
TypeScript
6,091
star
74

MixedRealityToolkit-Unity

This repository is for the legacy Mixed Reality Toolkit (MRTK) v2. For the latest version of the MRTK please visit https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity
C#
5,943
star
75

vscode-go

An extension for VS Code which provides support for the Go language. We have moved to https://github.com/golang/vscode-go
TypeScript
5,937
star
76

VFSForGit

Virtual File System for Git: Enable Git at Enterprise Scale
C#
5,918
star
77

microsoft-ui-xaml

Windows UI Library: the latest Windows 10 native controls and Fluent styles for your applications
5,861
star
78

GSL

Guidelines Support Library
C++
5,850
star
79

vscode-recipes

JavaScript
5,802
star
80

MMdnn

MMdnn is a set of tools to help users inter-operate among different deep learning frameworks. E.g. model conversion and visualization. Convert models between Caffe, Keras, MXNet, Tensorflow, CNTK, PyTorch Onnx and CoreML.
Python
5,772
star
81

ethr

Ethr is a Comprehensive Network Measurement Tool for TCP, UDP & ICMP.
Go
5,642
star
82

FASTER

Fast persistent recoverable log and key-value store + cache, in C# and C++.
C#
5,630
star
83

rushstack

Monorepo for tools developed by the Rush Stack community
TypeScript
5,502
star
84

DirectX-Graphics-Samples

This repo contains the DirectX Graphics samples that demonstrate how to build graphics intensive applications on Windows.
C++
5,440
star
85

vscode-docs

Public documentation for Visual Studio Code
Markdown
5,423
star
86

fluentui-system-icons

Fluent System Icons are a collection of familiar, friendly and modern icons from Microsoft.
HTML
5,377
star
87

vscode-cpptools

Official repository for the Microsoft C/C++ extension for VS Code.
TypeScript
5,315
star
88

BosqueLanguage

The Bosque programming language is an experiment in regularized design for a machine assisted rapid and reliable software development lifecycle.
TypeScript
5,282
star
89

DeepSpeedExamples

Example models using DeepSpeed
Python
5,092
star
90

promptbase

All things prompt engineering
Python
4,927
star
91

TypeScript-Handbook

Deprecated, please use the TypeScript-Website repo instead
JavaScript
4,881
star
92

Detours

Detours is a software package for monitoring and instrumenting API calls on Windows. It is distributed in source code form.
C++
4,811
star
93

tsyringe

Lightweight dependency injection container for JavaScript/TypeScript
TypeScript
4,700
star
94

Windows-classic-samples

This repo contains samples that demonstrate the API used in Windows classic desktop applications.
4,684
star
95

vscode-dev-containers

NOTE: Most of the contents of this repository have been migrated to the new devcontainers GitHub org (https://github.com/devcontainers). See https://github.com/devcontainers/template-starter and https://github.com/devcontainers/feature-starter for information on creating your own!
Shell
4,659
star
96

tsdoc

A doc comment standard for TypeScript
TypeScript
4,617
star
97

SPTAG

A distributed approximate nearest neighborhood search (ANN) library which provides a high quality vector index build, search and distributed online serving toolkits for large scale vector search scenario.
C++
4,603
star
98

WPF-Samples

Repository for WPF related samples
C#
4,545
star
99

TypeScript-Vue-Starter

A starter template for TypeScript and Vue with a detailed README describing how to use the two together.
JavaScript
4,458
star
100

FluidFramework

Library for building distributed, real-time collaborative web applications
TypeScript
4,366
star