LuisRecognizerOptionsV3 Class

Package:
com.microsoft.bot.ai.luis
Maven Artifact:
com.microsoft.bot:bot-ai-luis-v3:4.14.3

public class LuisRecognizerOptionsV3
extends LuisRecognizerOptions

Luis Recognizer Options for V3 LUIS Runtime.

Field Summary

Modifier and Type Field and Description
static final java.lang.String LUIS_TRACE_LABEL

The context label for a LUIS trace activity.
static final java.lang.String LUIS_TRACE_TYPE

The value type for a LUIS trace activity.

Constructor Summary

Constructor Description
LuisRecognizerOptionsV3(LuisApplication application)

Initializes a new instance of the LuisRecognizerOptionsV3.

Method Summary

Modifier and Type Method and Description
java.lang.String getDateTimeReference()

Gets datetimeV2 offset.
java.util.List<DynamicList> getDynamicLists()

Returns Dynamic lists used to recognize entities for a particular query.
java.util.List<ExternalEntity> getExternalEntities()

Gets External entities to be recognized in query.
Recognizer getExternalEntityRecognizer()

Gets External entity recognizer to recognize external entities to pass to LUIS.
okhttp3.OkHttpClient getHttpClient()

Gets whether the http client.
java.lang.String getSlot()

Gets the LUIS slot to use for the application.
java.lang.String getVersion()

Gets the specific version of the application to access.
boolean isIncludeAllIntents()

Gets indicating whether all intents come back or only the top one.
boolean isIncludeInstanceData()

Gets value indicating whether or not instance data should be included in response.
boolean isLog()

Value indicating whether queries should be logged in LUIS.
boolean isPreferExternalEntities()

Gets value indicating whether external entities should override other means of recognizing entities.
void setDateTimeReference(String dateTimeReference)

Sets datetimeV2 offset.
void setDynamicLists(List<DynamicList> dynamicLists)

Sets Dynamic lists used to recognize entities for a particular query.
void setExternalEntities(List<ExternalEntity> externalEntities)

Sets External entities to be recognized in query.
void setExternalEntityRecognizer(Recognizer externalEntityRecognizer)

Sets External entity recognizer to recognize external entities to pass to LUIS.
void setHttpClient(OkHttpClient httpClient)

Sets the http client.
void setIncludeAllIntents(boolean includeAllIntents)

Sets indicating whether all intents come back or only the top one.
void setIncludeInstanceData(boolean includeInstanceData)

Sets value indicating whether or not instance data should be included in response.
void setLog(boolean log)

Value indicating whether queries should be logged in LUIS.
void setPreferExternalEntities(boolean preferExternalEntities)

Sets value indicating whether external entities should override other means of recognizing entities.
void setSlot(String slot)

Sets the LUIS slot to use for the application.
void setVersion(String version)

Sets the specific version of the application to access.

Methods inherited from LuisRecognizerOptions

getApplication getTelemetryClient isIncludeAPIResults isLogPersonalInformation setIncludeAPIResults setLogPersonalInformation setTelemetryClient

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

Field Details

LUIS_TRACE_LABEL

public static final String LUIS_TRACE_LABEL

The context label for a LUIS trace activity.

LUIS_TRACE_TYPE

public static final String LUIS_TRACE_TYPE

The value type for a LUIS trace activity.

Constructor Details

LuisRecognizerOptionsV3

public LuisRecognizerOptionsV3(LuisApplication application)

Initializes a new instance of the LuisRecognizerOptionsV3.

Parameters:

application - Luis Application instance to query.

Method Details

getDateTimeReference

public String getDateTimeReference()

Gets datetimeV2 offset. The format for the datetimeReference is ISO 8601.

Returns:

The format for the datetimeReference in ISO 8601.

getDynamicLists

public List getDynamicLists()

Returns Dynamic lists used to recognize entities for a particular query.

Returns:

Dynamic lists used to recognize entities for a particular query

getExternalEntities

public List getExternalEntities()

Gets External entities to be recognized in query.

Returns:

External entities to be recognized in query.

getExternalEntityRecognizer

public Recognizer getExternalEntityRecognizer()

Gets External entity recognizer to recognize external entities to pass to LUIS.

Returns:

externalEntityRecognizer

getHttpClient

public OkHttpClient getHttpClient()

Gets whether the http client.

Returns:

OkHttpClient used to query the Luis Service.

getSlot

public String getSlot()

Gets the LUIS slot to use for the application. By default this uses the production slot. You can find other standard slots in LuisSlot. If you specify a Version, then a private version of the application is used instead of a slot.

Returns:

LuisSlot constant.

getVersion

public String getVersion()

Gets the specific version of the application to access. LUIS supports versions and this is the version to use instead of a slot. If this is specified, then the Slot is ignored.

Returns:

Luis application version to Query.

isIncludeAllIntents

public boolean isIncludeAllIntents()

Gets indicating whether all intents come back or only the top one. True for returning all intents.

Returns:

True for returning all intents.

isIncludeInstanceData

public boolean isIncludeInstanceData()

Gets value indicating whether or not instance data should be included in response.

Returns:

True if instance data should be included in response.

isLog

public boolean isLog()

Value indicating whether queries should be logged in LUIS. If queries should be logged in LUIS in order to help build better models through active learning

Returns:

True if queries should be logged in LUIS.

isPreferExternalEntities

public boolean isPreferExternalEntities()

Gets value indicating whether external entities should override other means of recognizing entities.

Returns:

True if external entities should be preferred to the results from LUIS models.

setDateTimeReference

public void setDateTimeReference(String dateTimeReference)

Sets datetimeV2 offset.

Parameters:

dateTimeReference - The format for the datetimeReference is ISO 8601.

setDynamicLists

public void setDynamicLists(List dynamicLists)

Sets Dynamic lists used to recognize entities for a particular query.

Parameters:

dynamicLists - to recognize entities for a particular query.

setExternalEntities

public void setExternalEntities(List externalEntities)

Sets External entities to be recognized in query.

Parameters:

externalEntities - External entities to be recognized in query.

setExternalEntityRecognizer

public void setExternalEntityRecognizer(Recognizer externalEntityRecognizer)

Sets External entity recognizer to recognize external entities to pass to LUIS.

Parameters:

externalEntityRecognizer - External Recognizer instance.

setHttpClient

public void setHttpClient(OkHttpClient httpClient)

Sets the http client.

Parameters:

httpClient - to use for Luis Service http calls.

setIncludeAllIntents

public void setIncludeAllIntents(boolean includeAllIntents)

Sets indicating whether all intents come back or only the top one.

Parameters:

includeAllIntents - True for returning all intents.

setIncludeInstanceData

public void setIncludeInstanceData(boolean includeInstanceData)

Sets value indicating whether or not instance data should be included in response.

Parameters:

includeInstanceData - True if instance data should be included in response.

setLog

public void setLog(boolean log)

Value indicating whether queries should be logged in LUIS. If queries should be logged in LUIS in order to help build better models through active learning.

Parameters:

log - True if queries should be logged in LUIS.

setPreferExternalEntities

public void setPreferExternalEntities(boolean preferExternalEntities)

Sets value indicating whether external entities should override other means of recognizing entities.

Parameters:

preferExternalEntities - True if external entities should be preferred to the results from LUIS models.

setSlot

public void setSlot(String slot)

Sets the LUIS slot to use for the application. By default this uses the production slot. You can find other standard slots in LuisSlot. If you specify a Version, then a private version of the application is used instead of a slot.

Parameters:

slot - LuisSlot value to use.

setVersion

public void setVersion(String version)

Sets the specific version of the application to access. LUIS supports versions and this is the version to use instead of a slot.

Parameters:

version - Luis Application version. If this is specified, then the Slot is ignored.

Applies to