DialogServiceConnector Class

Definition

Namespace:

Microsoft.CognitiveServices.Speech.Dialog

Assembly:

Microsoft.CognitiveServices.Speech.csharp.dll

Package:

Microsoft.CognitiveServices.Speech v1.34.0

Connects to a speech enabled dialog. Added in 1.5.0

public sealed class DialogServiceConnector : IDisposable

type DialogServiceConnector = class
    interface IDisposable

Public NotInheritable Class DialogServiceConnector
Implements IDisposable

Inheritance

Object

DialogServiceConnector

Implements

IDisposable

Remarks

See also:

• Integrate with a client application using Speech SDK

• Voice assistants frequently asked questions

• What is Custom Commands?

Constructors

DialogServiceConnector(DialogServiceConfig)	Creates a dialog service connector using the default microphone input for a specified dialog service configuration.
DialogServiceConnector(DialogServiceConfig, AudioConfig)	Creates a dialog service connector using the specified dialog and audio configuration.

Properties

AuthorizationToken	Gets or sets authorization token used to communicate with the service.
Properties	The collection of properties and their values defined for this DialogServiceConnector instance.
SpeechActivityTemplate	Gets or sets the JSON template that will be provided to the speech service for the next conversation. The service will attempt to merge this template into all activities sent to the dialog backend, whether originated by the client with SendActivityAsync or generated by the service, as is the case with speech-to-text results.

Methods

ConnectAsync()	Connects with the Speech service as an asynchronous operation.
DisconnectAsync()	Disconnects from the Speech service as an asynchronous operation.
Dispose()	Dispose of associated resources.
Finalize()
ListenOnceAsync()	Starts a listening session as an asynchronous operation.
SendActivityAsync(String)	Sends an activity to the backing dialog as an asynchronous operation.
StartContinuousListeningAsync()	Begins a continuous listening session as an asynchronous operation.
StartKeywordRecognitionAsync(KeywordRecognitionModel)	Starts keyword recognition asynchronously.
StopKeywordRecognitionAsync()	Stops keyword recognition asynchronously.
StopListeningAsync()	Requests that an active listening operation stop immediately. This interrupts any ongoing speaking, and provides a result that only reflects the audio data captured so far.

Events

ActivityReceived	Signal that an activity was received from the backing dialog. See also ActivityReceivedEventArgs.
Canceled	Signal for events relating to the cancellation of an interaction. See also SpeechRecognitionCanceledEventArgs.
Recognized	Signal for events containing speech recognition results. See also SpeechRecognitionEventArgs.
Recognizing	Signal for events containing intermediate recognition results. See also SpeechRecognitionEventArgs.
SessionStarted	Signal that indicates the start of a listening session. See also SessionEventArgs.
SessionStopped	Signal that indicates the end of a listening session. See also SessionEventArgs.
SpeechEndDetected	Occurs when the end of speech data is detected for the current phrase.
SpeechStartDetected	Occurs when speech data is first detected in the input audio for current phrase.
TurnStatusReceived	Signal raised when a turn status update is received.