IPromptChoiceFeatures interface
Optional features for PromptChoice class.
- Extends
Properties
default |
(Optional) style to use as the default when the caller specifies ListStyle.auto and it's determined that keyboards aren't supported. The default value is "ListStyle.list". |
default |
The library namespace to use for the defaultRetryPrompt. If not specified then the bots default namespace of "*" will be used. |
default |
The default retryPrompt to send should the caller not provide one. |
disable |
If true, then the prompt should not execute it's own recognition logic. The default is "false". |
inline |
(Optional) number of items to show in an inline list when a defaultListStyle of ListStyle.list is being applied. The default value is "3". Set this value to "0" to disable inline mode. |
min |
(Optional) minimum score from 0.0 - 1.0 needed for a recognized choice to be considered a match. The default value is "0.4". |
recognize |
(Optional) if true, the prompt will attempt to recognize the selected value using the choices themselves. The default value is "true". |
recognize |
(Optional) if true, the prompt will attempt to recognize numbers in the users utterance as the index of the choice to return. The default value is "true". |
recognize |
(Optional) if true, the prompt will attempt to recognize ordinals like "the first one" or "the second one" as the index of the choice to return. The default value is "true". |
Property Details
defaultListStyle
(Optional) style to use as the default when the caller specifies ListStyle.auto and it's determined that keyboards aren't supported. The default value is "ListStyle.list".
defaultListStyle?: ListStyle
Property Value
defaultRetryNamespace
The library namespace to use for the defaultRetryPrompt. If not specified then the bots default namespace of "*" will be used.
defaultRetryNamespace?: string
Property Value
string
defaultRetryPrompt
The default retryPrompt to send should the caller not provide one.
defaultRetryPrompt?: TextOrMessageType
Property Value
disableRecognizer
If true, then the prompt should not execute it's own recognition logic. The default is "false".
disableRecognizer?: boolean
Property Value
boolean
inlineListCount
(Optional) number of items to show in an inline list when a defaultListStyle of ListStyle.list is being applied. The default value is "3". Set this value to "0" to disable inline mode.
inlineListCount?: number
Property Value
number
minScore
(Optional) minimum score from 0.0 - 1.0 needed for a recognized choice to be considered a match. The default value is "0.4".
minScore?: number
Property Value
number
recognizeChoices
(Optional) if true, the prompt will attempt to recognize the selected value using the choices themselves. The default value is "true".
recognizeChoices?: boolean
Property Value
boolean
recognizeNumbers
(Optional) if true, the prompt will attempt to recognize numbers in the users utterance as the index of the choice to return. The default value is "true".
recognizeNumbers?: boolean
Property Value
boolean
recognizeOrdinals
(Optional) if true, the prompt will attempt to recognize ordinals like "the first one" or "the second one" as the index of the choice to return. The default value is "true".
recognizeOrdinals?: boolean
Property Value
boolean