com.xatkit.core.recognition.regex

Class RegExIntentRecognitionProvider

java.lang.Object

com.xatkit.core.recognition.IntentRecognitionProvider

com.xatkit.core.recognition.regex.RegExIntentRecognitionProvider

public class RegExIntentRecognitionProvider
extends IntentRecognitionProvider

A default IntentRecognitionProvider that relies on RegExp to match user inputs.

This intent provider is designed to handle bot prototyping with a minimal support to match user inputs using RegExp Patterns. This provider should not be used if advanced input extraction capabilities are required.

Note: this class uses strict patterns that perform exact matches of the input. This exact matching is case sensitive. You can check alternative IntentRecognitionProviders if you need to support advanced features such as partial matches.

Note: the RegExIntentRecognitionProvider translates EntityTypes into single-word patterns. This means that the any entity will match "test", but not "test test", you can check alternative IntentRecognitionProviders if you need to support such features.

The RegExIntentRecognitionProvider will be used by Xatkit if the application's Configuration file does not contain specific IntentRecognitionProvider properties (see IntentRecognitionProviderFactory.getIntentRecognitionProvider(XatkitCore, Configuration)).

See Also:

IntentRecognitionProviderFactory

Field Summary

Fields

Modifier and Type	Field and Description
static com.xatkit.intent.IntentDefinition	DEFAULT_FALLBACK_INTENT The Default Fallback Intent that is returned when the user input does not match any registered Intent.
protected EntityMapper	entityMapper The EntityMapper used to store system and dynamic entity mappings.
protected static String	FOLLOW_CONTEXT_NAME_SUFFIX The context name suffix used to identify follow-up contexts.
protected Map<com.xatkit.intent.IntentDefinition,List<Pattern>>	intentPatterns The Map used to store RegExp Patterns associated to the registered IntentDefinition.

Constructor Summary

Constructors

Constructor and Description
RegExIntentRecognitionProvider(Configuration configuration) Constructs a RegExIntentRecognitionProvider with the provided Configuration.
RegExIntentRecognitionProvider(Configuration configuration, RecognitionMonitor recognitionMonitor) Constructs a RegExIntentRecognitionProvider with the provided configuration.

Method Summary

Modifier and Type	Method and Description
XatkitSession	createSession(String sessionId) Creates a new XatkitSession from the provided sessionId.
void	deleteEntityDefinition(com.xatkit.intent.EntityDefinition entityDefinition) Deletes the provided entityDefinition.
void	deleteIntentDefinition(com.xatkit.intent.IntentDefinition intentDefinition) Deletes the provided intentDefinition.
com.xatkit.intent.RecognizedIntent	getIntentInternal(String input, XatkitSession session) Computes the RecognizedIntent associated to the provided input.
RecognitionMonitor	getRecognitionMonitor() Returns the RecognitionMonitor associated to this intent recognition provider.
boolean	isShutdown() Returns whether the intent recognition provider client is shutdown.
void	registerEntityDefinition(com.xatkit.intent.EntityDefinition entityDefinition) Registers the provided entityDefinition.
void	registerIntentDefinition(com.xatkit.intent.IntentDefinition intentDefinition) Registers the provided IntentDefinition.
void	shutdown() Shuts down the intent recognition provider client and invalidates the remaining sessions.
void	trainMLEngine() This method is not implemented and throws an UnsupportedOperationException.

Methods inherited from class com.xatkit.core.recognition.IntentRecognitionProvider

getIntent, setPostProcessors, setPreProcessors

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FALLBACK_INTENT

public static com.xatkit.intent.IntentDefinition DEFAULT_FALLBACK_INTENT

The Default Fallback Intent that is returned when the user input does not match any registered Intent.

FOLLOW_CONTEXT_NAME_SUFFIX

protected static String FOLLOW_CONTEXT_NAME_SUFFIX

The context name suffix used to identify follow-up contexts.

See Also:

setFollowUpContexts(IntentDefinition, RecognizedIntent)

entityMapper

protected EntityMapper entityMapper

The EntityMapper used to store system and dynamic entity mappings.

See Also:

registerEntityDefinition(EntityDefinition)

intentPatterns

protected Map<com.xatkit.intent.IntentDefinition,List<Pattern>> intentPatterns

The Map used to store RegExp Patterns associated to the registered IntentDefinition.

Patterns in this map are iterated when an input is received to retrieve the corresponding IntentDefinition. Note that the stored Patterns are strict and match exactly the training sentence used to create them.

Constructor Detail

RegExIntentRecognitionProvider

public RegExIntentRecognitionProvider(Configuration configuration)

Constructs a RegExIntentRecognitionProvider with the provided Configuration.

This constructor is a placeholder for RegExIntentRecognitionProvider(Configuration, RecognitionMonitor) with a null RecognitionMonitor.

Parameters:

configuration - the Configuration the Configuration used to customize the created XatkitSessions

Throws:

NullPointerException - if the provided configuration is null

See Also:

RegExIntentRecognitionProvider(Configuration, RecognitionMonitor)

RegExIntentRecognitionProvider

public RegExIntentRecognitionProvider(Configuration configuration,
                                      @Nullable
                                      RecognitionMonitor recognitionMonitor)

Constructs a RegExIntentRecognitionProvider with the provided configuration.

Parameters:

configuration - the Configuration used to customize the created XatkitSessions * @param recognitionMonitor the RecognitionMonitor instance storing intent matching information

Throws:

NullPointerException - if the provided configuration is null

Method Detail

registerEntityDefinition

public void registerEntityDefinition(com.xatkit.intent.EntityDefinition entityDefinition)

Registers the provided entityDefinition.

Registered EntityDefinition are reused when registering intents to produce RegExp Patterns that are matched against user inputs.

Specified by:

registerEntityDefinition in class IntentRecognitionProvider

Parameters:

entityDefinition - the EntityDefinition to register to the underlying intent recognition provider

See Also:

registerIntentDefinition(IntentDefinition)

registerIntentDefinition

public void registerIntentDefinition(com.xatkit.intent.IntentDefinition intentDefinition)

Registers the provided IntentDefinition.

This method creates a set of RegExp patterns that can be matched against user inputs. Note that CustomEntityDefinition used in the provided intentDefinition must have been registered using registerEntityDefinition(EntityDefinition).

Specified by:

registerIntentDefinition in class IntentRecognitionProvider

Parameters:

intentDefinition - the IntentDefinition to register to the underlying intent recognition provider

See Also:

registerEntityDefinition(EntityDefinition)

deleteEntityDefinition

public void deleteEntityDefinition(com.xatkit.intent.EntityDefinition entityDefinition)

Deletes the provided entityDefinition.

Specified by:

deleteEntityDefinition in class IntentRecognitionProvider

Parameters:

entityDefinition - the EntityDefinition to delete from the underlying intent recognition provider

See Also:

IntentRecognitionProvider.trainMLEngine()

deleteIntentDefinition

public void deleteIntentDefinition(com.xatkit.intent.IntentDefinition intentDefinition)

Deletes the provided intentDefinition.

This method deletes the RegExp Patterns associated to the provided intentDefinition, meaning that the intent won't be matched by the provider anymore.

Specified by:

deleteIntentDefinition in class IntentRecognitionProvider

Parameters:

intentDefinition - the IntentDefinition to delete from the underlying intent recognition provider

See Also:

IntentRecognitionProvider.trainMLEngine()

trainMLEngine

public void trainMLEngine()

This method is not implemented and throws an UnsupportedOperationException.

Use valid IntentRecognitionProviders to enable ML training.

Specified by:

trainMLEngine in class IntentRecognitionProvider

Throws:

UnsupportedOperationException - when called

createSession

public XatkitSession createSession(String sessionId)

Creates a new XatkitSession from the provided sessionId.

Specified by:

createSession in class IntentRecognitionProvider

Parameters:

sessionId - the identifier to create a session from

Returns:

a new XatkitSession for the provided sessionId

getRecognitionMonitor

@Nullable
public RecognitionMonitor getRecognitionMonitor()

Returns the RecognitionMonitor associated to this intent recognition provider.

Specified by:

getRecognitionMonitor in class IntentRecognitionProvider

Returns:

the RecognitionMonitor, or null if analytics monitoring is disabled.

shutdown

public void shutdown()

Shuts down the intent recognition provider client and invalidates the remaining sessions.

Note: calling this method invalidates the intent recognition provider client connection, and thus this class cannot be used to access the intent recognition provider anymore.

Specified by:

shutdown in class IntentRecognitionProvider

isShutdown

public boolean isShutdown()

Returns whether the intent recognition provider client is shutdown.

Specified by:

isShutdown in class IntentRecognitionProvider

Returns:

true if the intent recognition provider client is shutdown, false otherwise

getIntentInternal

public com.xatkit.intent.RecognizedIntent getIntentInternal(String input,
                                                            XatkitSession session)

Computes the RecognizedIntent associated to the provided input.

This method relies on the RegExp patterns created when calling registerIntentDefinition(IntentDefinition) to match the provided input. The provided session is used to retrieve the intents that can be matched according to the current contexts.

If the RegExIntentRecognitionProvider cannot find a valid IntentDefinition for the provided input the returned RecognizedIntent's definition will be the DEFAULT_FALLBACK_INTENT.

Note: this class uses strict patterns that perform exact matches of the input. This exact matching is case sensitive. You can check alternative IntentRecognitionProviders if you need to support advanced features such as partial matches.

Note: the RegExIntentRecognitionProvider translates EntityTypes into single-word patterns. This means that the any entity will match "test", but not "test test", you can check alternative IntentRecognitionProviders if you need to support such features.

Specified by:

getIntentInternal in class IntentRecognitionProvider

Parameters:

input - the String representing the textual input to process and extract the intent from

session - the XatkitSession used to access context information

Returns:

the RecognizedIntent matched from the provided input