FindChoicesOptions Class

Package:
com.microsoft.bot.dialogs.choices
Maven Artifact:
com.microsoft.bot:bot-dialogs:4.14.3

public class FindChoicesOptions
extends FindValuesOptions

Contains options to control how input is matched against a list of choices.

Constructor Summary

Constructor Description
FindChoicesOptions()

Method Summary

Modifier and Type Method and Description
boolean isNoAction()

Indicates whether the title of the choices action will NOT be searched over.
boolean isNoValue()

Indicates whether the choices value will NOT be search over.
boolean isRecognizeNumbers()

Indicates whether the recognizer should check for Numbers using the NumberRecognizer's NumberModel.
boolean isRecognizeOrdinals()

Indicates whether the recognizer should check for Ordinal Numbers using the NumberRecognizer's OrdinalModel.
void setNoAction(boolean withNoAction)

Sets whether the title of the choices action will NOT be searched over.
void setNoValue(boolean withNoValue)

Sets whether the choices value will NOT be search over.
void setRecognizeNumbers(boolean withRecognizeNumbers)

Set whether the recognizer should check for Numbers using the NumberRecognizer's NumberModel.
void setRecognizeOrdinals(boolean withRecognizeOrdinals)

Sets whether the recognizer should check for Ordinal Numbers using the NumberRecognizer's OrdinalModel.

Methods inherited from FindValuesOptions

getAllowPartialMatches getLocale getMaxTokenDistance getTokenizer setAllowPartialMatches setLocale setMaxTokenDistance setTokenizer

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

FindChoicesOptions

public FindChoicesOptions()

Method Details

isNoAction

public boolean isNoAction()

Indicates whether the title of the choices action will NOT be searched over. The default is false.

Returns:

true if the title of the choices action will NOT be searched over.

isNoValue

public boolean isNoValue()

Indicates whether the choices value will NOT be search over. The default is false.

Returns:

true if the choices value will NOT be search over.

isRecognizeNumbers

public boolean isRecognizeNumbers()

Indicates whether the recognizer should check for Numbers using the NumberRecognizer's NumberModel.

Returns:

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

isRecognizeOrdinals

public boolean isRecognizeOrdinals()

Indicates whether the recognizer should check for Ordinal Numbers using the NumberRecognizer's OrdinalModel.

Returns:

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

setNoAction

public void setNoAction(boolean withNoAction)

Sets whether the title of the choices action will NOT be searched over.

Parameters:

withNoAction - true if the title of the choices action will NOT be searched over.

setNoValue

public void setNoValue(boolean withNoValue)

Sets whether the choices value will NOT be search over.

Parameters:

withNoValue - true if the choices value will NOT be search over.

setRecognizeNumbers

public void setRecognizeNumbers(boolean withRecognizeNumbers)

Set whether the recognizer should check for Numbers using the NumberRecognizer's NumberModel.

Parameters:

withRecognizeNumbers - Default is true. If false, the Number Model will not be used to check the utterance for numbers.

setRecognizeOrdinals

public void setRecognizeOrdinals(boolean withRecognizeOrdinals)

Sets whether the recognizer should check for Ordinal Numbers using the NumberRecognizer's OrdinalModel.

Parameters:

withRecognizeOrdinals - If false, the Ordinal Model will not be used to check the utterance for ordinal numbers.

Applies to