dialog Module

Classes related to dialog service connector.

Classes

ActivityReceivedEventArgs

An object that encapsulates the response data that originates from the dialog implementation used by a DialogServiceConnector. Activities may be sent by a dialog implementation at any time during a connection and there may be a many-to-one relationship between activities received and input utterances.

Constructor for internal use.

BotFrameworkConfig

Class that is used to initialize a DialogServiceConnector that will connect to a Bot Framework bot using the Direct Line Speech channel.

See also the direct line speech page /azure/cognitive-services/speech-service/direct-line-speech.

The configuration can be initialized in following ways:

  • from subscription: pass a subscription key, a region and a bot_id (optional)

  • from authorization token: pass an authorization token, a region and a bot_id (optional)

CustomCommandsConfig

Class used to initialize a DialogServiceConnector that will connect to a Custom Commands application as published from Speech Studio for a speech service resource.

See also the custom commands page /azure/cognitive-services/speech-service/custom-commands.

The configuration can be initialized in following ways:

  • from subscription: pass an application id, a subscription key and a region

  • from authorization token: pass an application id, an authorization token and a region

DialogServiceConfig

Class that defines base configurations for the dialog service connector object that can communicate with a voice assistant.

This class is base class for BotFrameworkConfig and CustomCommandsConfig classes. Create dialog config instances from specific BotFrameworkConfig or CustomCommandsConfig objects.

DialogServiceConnector

An object that communicates with a speech-enabled dialog system using either the Bot Framework or Custom Commands. This type receives speech-to-text results and also facilitates the asynchronous sending and receiving of non-speech dialog activity data.

TurnStatusReceivedEventArgs

An object that encapsulates turn status information as received from the dialog implementation that a DialogServiceConnector communicates with. A turn is a single execution session within the dialog implementation that may generate any number of activities over its course. The information in this payload represents success or failure conditions encountered by the dialog implementation over the course of this execution. This data facilitates the indication of completion or error conditions within the dialog implementation even when no explicit activity data is produced as part of a turn.

Constructor for internal use.