FindChoicesOptions interface

  • Reference
Package:
botbuilder-dialogs

Options to control the recognition performed by findChoices().

Extends
FindValuesOptions

Properties

noAction

(Optional) If true, the the choices action.title field will NOT be searched over. Defaults to false.
noValue

(Optional) If true, the choices value field will NOT be search over. Defaults to false.
recognizeNumbers

(Optional) Default is true. If false, the Number Model will not be used to check the utterance for numbers.
recognizeOrdinals

(Optional) Default is true. If false, the Ordinal Model will not be used to check the utterance for ordinal numbers.

Inherited Properties

allowPartialMatches

(Optional) if true, then only some of the tokens in a value need to exist to be considered a match. The default value is "false".
locale

(Optional) locale/culture code of the utterance. The default is en-US.
maxTokenDistance

(Optional) maximum tokens allowed between two matched tokens in the utterance. So with a max distance of 2 the value "second last" would match the utterance "second from the last" but it wouldn't match "Wait a second. That's not the last one is it?". The default value is "2".
tokenizer

(Optional) tokenizer to use when parsing the utterance and values being recognized.

Property Details

noAction

(Optional) If true, the the choices action.title field will NOT be searched over. Defaults to false.

noAction?: boolean

Property Value

boolean

noValue

(Optional) If true, the choices value field will NOT be search over. Defaults to false.

noValue?: boolean

Property Value

boolean

recognizeNumbers

(Optional) Default is true. If false, the Number Model will not be used to check the utterance for numbers.

recognizeNumbers?: boolean

Property Value

boolean

recognizeOrdinals

(Optional) Default is true. If false, the Ordinal Model will not be used to check the utterance for ordinal numbers.

recognizeOrdinals?: boolean

Property Value

boolean

Inherited Property Details

allowPartialMatches

(Optional) if true, then only some of the tokens in a value need to exist to be considered a match. The default value is "false".

allowPartialMatches?: boolean

Property Value

boolean

Inherited From FindValuesOptions.allowPartialMatches

locale

(Optional) locale/culture code of the utterance. The default is en-US.

locale?: string

Property Value

string

Inherited From FindValuesOptions.locale

maxTokenDistance

(Optional) maximum tokens allowed between two matched tokens in the utterance. So with a max distance of 2 the value "second last" would match the utterance "second from the last" but it wouldn't match "Wait a second. That's not the last one is it?". The default value is "2".

maxTokenDistance?: number

Property Value

number

Inherited From FindValuesOptions.maxTokenDistance

tokenizer

(Optional) tokenizer to use when parsing the utterance and values being recognized.

tokenizer?: TokenizerFunction

Property Value

TokenizerFunction

Inherited From FindValuesOptions.tokenizer