com.xatkit.core.recognition

Class IntentRecognitionProviderFactory

java.lang.Object

com.xatkit.core.recognition.IntentRecognitionProviderFactory

public class IntentRecognitionProviderFactory
extends Object

Builds IntentRecognitionProviders from the provided configuration.

This factory inspects the provided configuration and finds the concrete IntentRecognitionProvider to construct. If the provided configuration does not define any IntentRecognitionProvider, a RegExIntentRecognitionProvider is returned, providing minimal support to XatkitSession management.

Note: RegExIntentRecognitionProvider does not handle IntentDefinition and RecognizedIntent computation. If the bot application requires such features a valid IntentRecognitionProvider must be specified in the provided configuration.

See Also:

IntentRecognitionProvider, RegExIntentRecognitionProvider

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENABLE_RECOGNITION_ANALYTICS The Configuration key used to specify whether to enable intent recognition monitoring.
static String	RECOGNITION_POSTPROCESSORS_KEY The Configuration key used to specify the IntentPostProcessors associated to the created IntentRecognitionProvider.
static String	RECOGNITION_PREPROCESSORS_KEY The Configuration key used to specify the InputPreProcessors associated to the created IntentRecognitionProvider.

Constructor Summary

Constructors

Constructor and Description
IntentRecognitionProviderFactory()

Method Summary

Modifier and Type	Method and Description
static IntentRecognitionProvider	getIntentRecognitionProvider(XatkitCore xatkitCore, Configuration configuration) Returns the IntentRecognitionProvider matching the provided configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ENABLE_RECOGNITION_ANALYTICS

public static String ENABLE_RECOGNITION_ANALYTICS

The Configuration key used to specify whether to enable intent recognition monitoring.

Intent recognition monitoring is enabled by default, and stores the results in the data/analytics folder. It can be disabled by explicitly setting this property to false in the Configuration file.

RECOGNITION_PREPROCESSORS_KEY

public static String RECOGNITION_PREPROCESSORS_KEY

The Configuration key used to specify the InputPreProcessors associated to the created IntentRecognitionProvider.

InputPreProcessors are specified as a comma-separated list of processor's names.

RECOGNITION_POSTPROCESSORS_KEY

public static String RECOGNITION_POSTPROCESSORS_KEY

The Configuration key used to specify the IntentPostProcessors associated to the created IntentRecognitionProvider.

IntentPostProcessors are specified as a comma-separated list of processor's names.

Constructor Detail

IntentRecognitionProviderFactory

public IntentRecognitionProviderFactory()

Method Detail

getIntentRecognitionProvider

public static IntentRecognitionProvider getIntentRecognitionProvider(XatkitCore xatkitCore,
                                                                     Configuration configuration)

Returns the IntentRecognitionProvider matching the provided configuration.

If the provided configuration does not define any IntentRecognitionProvider, a RegExIntentRecognitionProvider is returned, providing minimal support to XatkitSession management.

The created IntentRecognitionProvider embeds a RecognitionMonitor that logs monitoring information regarding the intent recognition. The RecognitionMonitor can be disabled by setting the ENABLE_RECOGNITION_ANALYTICS property to false in the configuration.

This method retrieves the list of InputPreProcessors and IntentPostProcessors from the provided configuration and bind them to the returned IntentRecognitionProvider. Pre/post -processors are specified with the configuration keys RECOGNITION_PREPROCESSORS_KEY and RECOGNITION_POSTPROCESSORS_KEY, respectively, and are specified as comma-separated list of processor's names.

Parameters:

xatkitCore - the XatkitCore instance to build the IntentRecognitionProvider from

configuration - the Configuration used to define the IntentRecognitionProvider to build

Returns:

the IntentRecognitionProvider matching the provided configuration

Throws:

XatkitException - if an error occurred when loading the pre/post processors.

See Also:

getRecognitionMonitor(XatkitCore, Configuration), getPreProcessors(Configuration), getPostProcessors(Configuration), RECOGNITION_PREPROCESSORS_KEY, RECOGNITION_POSTPROCESSORS_KEY