IRecognizeAction interface

Package:

botbuilder-calling

Recognize action allows to either capture the speech recognition output or collect digits from Skype user dial pad.

Extends

IAction

Properties

action	Type of action.
bargeInAllowed	Indicates if Skype user is allowed to enter choice before the prompt finishes. The default value is true.
choices	List of RecognitionOption objects dictating the recognizable choices. Choices can be speech or dial pad digit based. Either collectDigits or choices must be specified, but not both.
collectDigits	CollectDigits will result in collecting digits from Skype user dial pad as part of recognize. Either collectDigits or choices must be specified, but not both.
culture	Culture is an enum indicating what culture the speech recognizer should use. The default value is “en-US”. Currently the only culture supported is en-US.
initialSilenceTimeoutInSeconds	Maximum initial silence allowed before failing the operation from the time we start the recording. The default value is 5 seconds.
interdigitTimeoutInSeconds	Maximum allowed time between dial pad digits. The default value is 1 second.
operationId	Used to correlate outcomes to actions in ConversationResult.
playPrompt	A prompt to be played before the recognition starts.

Property Details

action

Type of action.

action: string

Property Value

string

bargeInAllowed

Indicates if Skype user is allowed to enter choice before the prompt finishes. The default value is true.

bargeInAllowed?: boolean

Property Value

boolean

choices

List of RecognitionOption objects dictating the recognizable choices. Choices can be speech or dial pad digit based. Either collectDigits or choices must be specified, but not both.

choices?: IRecognitionChoice[]

Property Value

IRecognitionChoice[]

collectDigits

CollectDigits will result in collecting digits from Skype user dial pad as part of recognize. Either collectDigits or choices must be specified, but not both.

collectDigits?: ICollectDigits

Property Value

ICollectDigits

culture

Culture is an enum indicating what culture the speech recognizer should use. The default value is “en-US”. Currently the only culture supported is en-US.

culture?: string

Property Value

string

initialSilenceTimeoutInSeconds

Maximum initial silence allowed before failing the operation from the time we start the recording. The default value is 5 seconds.

initialSilenceTimeoutInSeconds?: number

Property Value

number

interdigitTimeoutInSeconds

Maximum allowed time between dial pad digits. The default value is 1 second.

interdigitTimeoutInSeconds?: number

Property Value

number

operationId

Used to correlate outcomes to actions in ConversationResult.

operationId: string

Property Value

string

playPrompt

A prompt to be played before the recognition starts.

playPrompt?: IPlayPromptAction

Property Value

IPlayPromptAction