Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Recognize Class Reference

This is the action which customers can specify to indicate that the server call agent should perform speech or dtmf recognition. More...

Inheritance diagram for Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Recognize:

Public Member Functions

 Recognize ()
 
override void Validate ()
 

Properties

string Action [get, set]
 The type of action. Various concrete action classes specify their name. This is used to deserialize a list of actions from JSON to their respective concrete classes. More...
 
bool BargeInAllowed [get, set]
 Are customers allowed to enter choice before prompt finishes. Default : true. More...
 
IEnumerable< RecognitionOptionChoices [get, set]
 List of choices to recognize against. Choices can be speech or dtmf based. More...
 
CollectDigits CollectDigits [get, set]
 There is no choice based recognition. Rather collect all digits entered by user. More...
 
Culture Culture [get, set]
 Culture of Speech Recognizer to use. Default : en-US. More...
 
double InitialSilenceTimeoutInSeconds [get, set]
 Maximum initial silence allowed from the time we start the recognition operation before we timeout and fail the operation. More...
 
double InterdigitTimeoutInSeconds [get, set]
 Mamimum allowed time between digits if we are doing dtmf based choice recognition or CollectDigits recognition More...
 
bool IsStandaloneAction [get]
 Flag to indicate whether this action must not be specified along with any other actions. More...
 
string OperationId [get, set]
 An operation Id needs to be specified by customer so that they can correlate outcome to the action. This becomes necessary when multiple actions are specified in one response body More...
 
PlayPrompt PlayPrompt [get, set]
 Promt to played out (if any) before recognition starts. Customers can choose to specify "playPrompt" action separately or specify as part of "recognize" - mostly all recognitions are preceeded by a prompt More...
 

Detailed Description

This is the action which customers can specify to indicate that the server call agent should perform speech or dtmf recognition.

Definition at line 11 of file Calling/Models/Contracts/Recognize.cs.

Constructor & Destructor Documentation

Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Recognize.Recognize ( )
inline

Definition at line 66 of file Calling/Models/Contracts/Recognize.cs.

Member Function Documentation

override void Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Recognize.Validate ( )
inlinevirtual

Property Documentation

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ActionBase.Action
getsetinherited

The type of action. Various concrete action classes specify their name. This is used to deserialize a list of actions from JSON to their respective concrete classes.

Definition at line 40 of file ActionBase.cs.

bool Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Recognize.BargeInAllowed
getset

Are customers allowed to enter choice before prompt finishes. Default : true.

Definition at line 25 of file Calling/Models/Contracts/Recognize.cs.

IEnumerable<RecognitionOption> Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Recognize.Choices
getset

List of choices to recognize against. Choices can be speech or dtmf based.

Definition at line 56 of file Calling/Models/Contracts/Recognize.cs.

CollectDigits Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Recognize.CollectDigits
getset

There is no choice based recognition. Rather collect all digits entered by user.

Either CollectDigits or Choices must be specified. Both can not be specified.

Definition at line 64 of file Calling/Models/Contracts/Recognize.cs.

Culture Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Recognize.Culture
getset

Culture of Speech Recognizer to use. Default : en-US.

Definition at line 31 of file Calling/Models/Contracts/Recognize.cs.

double Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Recognize.InitialSilenceTimeoutInSeconds
getset

Maximum initial silence allowed from the time we start the recognition operation before we timeout and fail the operation.

if we are playing a prompt, then this timer starts after prompt finishes.

Default : 5 secs

Definition at line 42 of file Calling/Models/Contracts/Recognize.cs.

double Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Recognize.InterdigitTimeoutInSeconds
getset

Mamimum allowed time between digits if we are doing dtmf based choice recognition or CollectDigits recognition

Default : 1 sec

Definition at line 50 of file Calling/Models/Contracts/Recognize.cs.

bool Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ActionBase.IsStandaloneAction
getinherited

Flag to indicate whether this action must not be specified along with any other actions.

Definition at line 46 of file ActionBase.cs.

string Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.ActionBase.OperationId
getsetinherited

An operation Id needs to be specified by customer so that they can correlate outcome to the action. This becomes necessary when multiple actions are specified in one response body

Note: this is the first serialized field since it has the lowest order. By default Json.net starts ordering from -1.

Definition at line 33 of file ActionBase.cs.

PlayPrompt Microsoft.Bot.Builder.Calling.ObjectModel.Contracts.Recognize.PlayPrompt
getset

Promt to played out (if any) before recognition starts. Customers can choose to specify "playPrompt" action separately or specify as part of "recognize" - mostly all recognitions are preceeded by a prompt

Definition at line 19 of file Calling/Models/Contracts/Recognize.cs.


The documentation for this class was generated from the following file: