microsoft-cognitiveservices-speech-sdk package

Classes

Agent
ConsoleLoggingListener
FileAudioSource
MicAudioSource
PcmRecorder
ProxyInfo
ReplayableAudioNode
WebsocketConnection
WebsocketMessageAdapter
AddedLmIntent
AgentConfig

Represents the JSON used in the agent.config message sent to the speech service.

CognitiveSubscriptionKeyAuthentication
CognitiveTokenAuthentication
ConnectionFactoryBase
DialogConnectionFactory
DialogServiceAdapter
DialogServiceTurnState
DialogServiceTurnStateManager
DynamicGrammarBuilder

Responsible for building the object to be sent to the speech service to support dynamic grammars.

EnumTranslation
AuthInfo
IntentConnectionFactory
IntentServiceRecognizer
QueryParameterNames
ConnectingToServiceEvent
ListeningStartedEvent
RecognitionEndedEvent
RecognitionStartedEvent
RecognitionTriggeredEvent
SpeechRecognitionEvent
Context
Device
OS
RecognizerConfig
SpeechServiceConfig
System
RequestSession
ActivityPayloadResponse
DetailedSpeechPhrase
IntentResponse
SimpleSpeechPhrase
SpeechDetected
SpeechHypothesis
TranslationHypothesis
TranslationPhrase
TranslationSynthesisEnd
ServiceRecognizerBase
ServiceTelemetryListener
SpeechConnectionFactory
SpeechConnectionMessage
SpeechContext

Represents the JSON used in the speech.context message sent to the speech service. The dynamic grammar is always refreshed from the encapsulated dynamic grammar object.

SpeechServiceRecognizer
TranslationConnectionFactory
TranslationServiceRecognizer
WebsocketMessageFormatter
AudioSourceErrorEvent
AudioSourceEvent
AudioSourceInitializingEvent
AudioSourceOffEvent
AudioSourceReadyEvent
AudioStreamNodeAttachedEvent
AudioStreamNodeAttachingEvent
AudioStreamNodeDetachedEvent
AudioStreamNodeErrorEvent
AudioStreamNodeEvent
ChunkedArrayBufferStream
ConnectionClosedEvent
ConnectionEstablishErrorEvent
ConnectionEstablishedEvent
ConnectionEvent
ConnectionMessageReceivedEvent
ConnectionMessageSentEvent
ConnectionStartEvent
ConnectionMessage
ConnectionOpenResponse
ArgumentNullError

The error that is thrown when an argument passed in is null.

InvalidOperationError

The error that is thrown when an invalid operation is performed in the code.

ObjectDisposedError

The error that is thrown when an object is disposed.

EventSource
Events
List
PlatformEvent
Deferred
Promise
PromiseHelper
PromiseResult
PromiseResultEventSource
Sink
Queue
RawWebsocketMessage
RiffPcmEncoder
Stream
StreamReader
ActivityReceivedEventArgs

Defines contents of received message/events.

AudioConfig

Represents audio input configuration used for specifying what type of input to use (microphone, file, stream).

AudioInputStream

Represents audio input stream used for custom audio input configurations.

PullAudioInputStream
PushAudioInputStream

Represents memory backed push audio input stream used for custom audio input configurations.

AudioOutputStream

Represents audio input stream used for custom audio input configurations.

PullAudioOutputStream

Represents memory backed push audio input stream used for custom audio input configurations.

AudioStreamFormat

Represents audio stream format used for custom audio input configurations.

BaseAudioPlayer

Base audio player class TODO: Plays only PCM for now.

PullAudioInputStreamCallback

An abstract base class that defines callback methods (read() and close()) for custom audio input streams).

BotFrameworkConfig

Class that defines configurations for the dialog service connector object for using a Bot Framework backend.

CancellationDetails

Contains detailed information about why a result was canceled.

Connection

Connection is a proxy class for managing connection to the speech service of the specified Recognizer. By default, a Recognizer autonomously manages connection to service when needed. The Connection class provides additional methods for users to explicitly open or close a connection and to subscribe to connection status changes. The use of Connection is optional, and mainly for scenarios where fine tuning of application behavior based on connection status is needed. Users can optionally call Open() to manually set up a connection in advance before starting recognition on the Recognizer associated with this Connection. If the Recognizer needs to connect or disconnect to service, it will setup or shutdown the connection independently. In this case the Connection will be notified by change of connection status via Connected/Disconnected events. Added in version 1.2.0.

ConnectionEventArgs

Defines payload for connection events like Connected/Disconnected. Added in version 1.2.0

DialogServiceConfig

Class that defines base configurations for dialog service connector

DialogServiceConfigImpl

Dialog Service configuration.

DialogServiceConnector

Dialog Service Connector

IntentRecognitionCanceledEventArgs

Define payload of intent recognition canceled result events.

IntentRecognitionEventArgs

Intent recognition result event arguments.

IntentRecognitionResult

Intent recognition result.

IntentRecognizer

Intent recognizer.

KeywordRecognitionModel

Represents a keyword recognition model for recognizing when the user says a keyword to initiate further speech recognition.

LanguageUnderstandingModel

Language understanding model

NoMatchDetails

Contains detailed information for NoMatch recognition results.

PhraseListGrammar

Allows additions of new phrases to improve speech recognition. Phrases added to the recognizer are effective at the start of the next recognition, or the next time the SpeechSDK must reconnect to the speech service.

PropertyCollection

Represents collection of properties and their values.

RecognitionEventArgs

Defines payload for session events like Speech Start/End Detected

RecognitionResult

Defines result of speech recognition.

Recognizer

Defines the base class Recognizer which mainly contains common event handlers.

SessionEventArgs

Defines content for session events like SessionStarted/Stopped, SoundStarted/Stopped.

SpeechCommandsConfig

Class that defines configurations for the dialog service connector object for using a SpeechCommands backend.

SpeechConfig

Speech configuration.

SpeechConfigImpl
SpeechRecognitionCanceledEventArgs

Defines content of a RecognitionErrorEvent.

SpeechRecognitionEventArgs

Defines contents of speech recognizing/recognized event.

SpeechRecognitionResult

Defines result of speech recognition.

SpeechRecognizer

Performs speech recognition from microphone, file, or other audio input streams, and gets transcribed text as result.

SpeechTranslationConfig

Speech translation configuration.

TranslationRecognitionCanceledEventArgs

Define payload of speech recognition canceled result events.

TranslationRecognitionEventArgs

Translation text result event arguments.

TranslationRecognitionResult

Translation text result.

TranslationRecognizer

Translation recognizer

TranslationSynthesisEventArgs

Translation Synthesis event arguments

TranslationSynthesisResult

Defines translation synthesis result, i.e. the voice output of the translated text in the target language.

Translations

Represents collection of parameters and their values.

Interfaces

IRecorder
IAgentConfig
IDynamicGrammar

Top level grammar node

IDynamicGrammarGeneric

Generic phrase based dynamic grammars

IDynamicGrammarGroup

Group of Dynamic Grammar items of a common type.

IDynamicGrammarPeople
IAuthentication
IConnectionFactory
ISpeechConfigAudio
ISpeechConfigAudioDevice
IActivityPayloadResponse
IDetailedSpeechPhrase
IPhrase
IIntentEntity
IIntentResponse
ISingleIntent
ISimpleSpeechPhrase
ISpeechDetected
ISpeechHypothesis
ITranslationHypothesis
ITranslationPhrase
ITranslationSynthesisEnd
IMetric
ITelemetry
IResultErrorDetails
ISpeechEndDetectedResult
ITranslation
ITranslations
ITurnStart
ITurnStartContext
IAudioSource
IAudioStreamNode
IConnection
IDetachable
INumberDictionary
IStringDictionary
IDisposable
IEventListener
IEventSource
ITimer
IWebsocketMessageFormatter
IList
IDeferred
IPromise
IQueue
IStreamChunk

Enums

RecognitionCompletionStatus
RecognitionMode
SpeechResultFormat
connectivity
type
MessageDataStreamType
RecognitionStatus
TranslationStatus

Defines translation status.

MessageType
ConnectionState
EventType
PromiseState
CancellationErrorCode

Defines error code in case that CancellationReason is Error. Added in version 1.1.0.

CancellationReason

Defines the possible reasons a recognition result might be canceled.

NoMatchReason

Defines the possible reasons a recognition result might not be recognized.

OutputFormat

Define Speech Recognizer output formats.

ProfanityOption

Profanity option. Added in version 1.7.0.

PropertyId

Defines speech property ids.

ResultReason

Defines the possible reasons a recognition result might be generated.

ServicePropertyChannel

Defines channels used to pass property settings to service. Added in version 1.7.0.

Functions

check(any, (error: Error, res: any) => void)

Function Details

check(any, (error: Error, res: any) => void)

function check(options: any, cb: (error: Error, res: any) => void)

Parameters

options
any
cb
(error: Error, res: any) => void

Returns

any