IntentRecognitionProvider (Xatkit Runtime 4.0.1-SNAPSHOT API)

java.lang.Object
- com.xatkit.core.recognition.IntentRecognitionProvider

Direct Known Subclasses:

DialogFlowApi, RegExIntentRecognitionProvider
```
public abstract class IntentRecognitionProvider
extends Object
```
A unified wrapper for concrete intent recognition providers.
This interface provides utility methods to connect to a given intent recognition provider, register and delete IntentDefinitions, create XatkitSessions, and compute the RecognizedIntent from a given input text.

Constructor Summary

Constructors
Constructor and Description

IntentRecognitionProvider()

Constructors
Constructor and Description
`IntentRecognitionProvider()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract XatkitSession`	`createSession(String sessionId)` Creates a new `XatkitSession` from the provided `sessionId`.
`abstract void`	`deleteEntityDefinition(com.xatkit.intent.EntityDefinition entityDefinition)` Deletes the provided `entityDefinition` from the underlying intent recognition provider.
`abstract void`	`deleteIntentDefinition(com.xatkit.intent.IntentDefinition intentDefinition)` Deletes the provided `intentDefinition` from the underlying intent recognition provider.
`com.xatkit.intent.RecognizedIntent`	`getIntent(String input, XatkitSession session)` Returns the `RecognizedIntent` extracted from te provided `input`.
`protected abstract com.xatkit.intent.RecognizedIntent`	`getIntentInternal(String input, XatkitSession session)` Returns the raw `RecognizedIntent` extracted from the provided `input`.
`abstract RecognitionMonitor`	`getRecognitionMonitor()` Returns the `RecognitionMonitor` associated to this intent recognition provider.
`abstract boolean`	`isShutdown()` Returns whether the intent recognition provider client is shutdown.
`abstract void`	`registerEntityDefinition(com.xatkit.intent.EntityDefinition entityDefinition)` Registers the provided `entityDefinition` in the underlying intent recognition provider.
`abstract void`	`registerIntentDefinition(com.xatkit.intent.IntentDefinition intentDefinition)` Registers the provided `intentDefinition` in the underlying intent recognition provider.
`void`	`setPostProcessors(List<? extends IntentPostProcessor> postProcessors)` Set the `IntentPostProcessor`s.
`void`	`setPreProcessors(List<? extends InputPreProcessor> preProcessors)` Sets the `InputPreProcessor`s.
`abstract void`	`shutdown()` Shuts down the intent recognition provider client and invalidates the remaining sessions.
`abstract void`	`trainMLEngine()` Trains the underlying intent recognition provider.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IntentRecognitionProvider
```
public IntentRecognitionProvider()
```
- Method Detail
  - setPreProcessors
```
public final void setPreProcessors(List<? extends InputPreProcessor> preProcessors)
```
    Sets the InputPreProcessors.
    
    Parameters:
    
    preProcessors - the InputPreProcessor to set
  - setPostProcessors
```
public final void setPostProcessors(List<? extends IntentPostProcessor> postProcessors)
```
    Set the IntentPostProcessors.
    
    Parameters:
    
    postProcessors - the IntentPostProcessor to set
  - registerEntityDefinition
```
public abstract void registerEntityDefinition(com.xatkit.intent.EntityDefinition entityDefinition)
```
    Registers the provided entityDefinition in the underlying intent recognition provider.
    Note: unless explicitly stated in subclasses, this method does not train the underlying machine learning engine, so multiple entity registrations does not generate multiple training calls. Once all the EntityDefinitions have been registered in the underlying intent recognition provider use trainMLEngine() to train the ML engine.
    
    Parameters:
    
    entityDefinition - the EntityDefinition to delete from the underlying intent recognition provider
    
    See Also:
    
    trainMLEngine()
  - registerIntentDefinition
```
public abstract void registerIntentDefinition(com.xatkit.intent.IntentDefinition intentDefinition)
```
    Registers the provided intentDefinition in the underlying intent recognition provider.
    Note: unless explicitly stated in subclasses, this method does not train the underlying machine learning engine, so multiple intent registrations does not generate multiple training calls. Once all the IntentDefinitions have been registered in the underlying intent recognition provider use trainMLEngine() to train the ML engine.
    
    Parameters:
    
    intentDefinition - the IntentDefinition to register to the underlying intent recognition provider
    
    See Also:
    
    trainMLEngine()
  - deleteEntityDefinition
```
public abstract void deleteEntityDefinition(com.xatkit.intent.EntityDefinition entityDefinition)
```
    Deletes the provided entityDefinition from the underlying intent recognition provider.
    Note: unless explicitly stated in subclasses, this method does not train the underlying machine learning engine, so multiple entity deletion does not generate multiple training calls. Once all the EntityDefinitions have been deleted from the underlying intent recognition provider use trainMLEngine() to train the ML engine.
    
    Parameters:
    
    entityDefinition - the EntityDefinition to delete from the underlying intent recognition provider
    
    See Also:
    
    trainMLEngine()
  - deleteIntentDefinition
```
public abstract void deleteIntentDefinition(com.xatkit.intent.IntentDefinition intentDefinition)
```
    Deletes the provided intentDefinition from the underlying intent recognition provider.
    Note: unless explicitly stated in subclasses, this method does not train the underlying machine learning engine, so multiple intent deletion does not generate multiple training calls. Once all the IntentDefinitions have been deleted from the underlying intent recognition provider use trainMLEngine() to train the ML engine.
    
    Parameters:
    
    intentDefinition - the IntentDefinition to delete from the underlying intent recognition provider
    
    See Also:
    
    trainMLEngine()
  - trainMLEngine
```
public abstract void trainMLEngine()
```
    Trains the underlying intent recognition provider.
    Note: this method returns once the intent recognition provider's training is complete. However, the propagation of the training information may not be complete when this method returns.
  - createSession
```
public abstract XatkitSession createSession(String sessionId)
```
    Creates a new XatkitSession from the provided sessionId.
    
    Parameters:
    
    sessionId - the identifier to create a session from
    
    Returns:
    
    a new XatkitSession for the provided sessionId
  - shutdown
```
public abstract 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.
  - isShutdown
```
public abstract boolean isShutdown()
```
    Returns whether the intent recognition provider client is shutdown.
    
    Returns:
    
    true if the intent recognition provider client is shutdown, false otherwise
  - getIntent
```
public final com.xatkit.intent.RecognizedIntent getIntent(String input,
                                                          XatkitSession session)
```
    Returns the RecognizedIntent extracted from te provided input.
    This method uses the provided session to extract contextual intents, such as follow-up or context-based intents.
    This method applies the pre-processing functions associated to this IntentRecognitionProvider on the given input, and the post-processing functions on the returned RecognizedIntent.
    
    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 post-processed RecognizedIntent extracted from the provided input and session
    
    See Also:
    
    IntentRecognitionProviderFactory.getIntentRecognitionProvider(XatkitCore, Configuration)
  - getIntentInternal
```
protected abstract com.xatkit.intent.RecognizedIntent getIntentInternal(String input,
                                                                        XatkitSession session)
```
    Returns the raw RecognizedIntent extracted from the provided input.
    This method is called after pre-processing of the input (i.e. the given input is already pre-processed), and does not apply any post-processing function (this is done by getIntent(String, XatkitSession)). Subclasses implementing this method should not take care of pre/post processing.
    
    Parameters:
    
    input - the textual input to process and extract the intent from
    
    session - the XatkitSession used to access context information
    
    Returns:
    
    the RecognizedIntent extracted from the provided input and session
  - getRecognitionMonitor
```
@Nullable
public abstract RecognitionMonitor getRecognitionMonitor()
```
    Returns the RecognitionMonitor associated to this intent recognition provider.
    
    Returns:
    
    the RecognitionMonitor, or null if analytics monitoring is disabled.

Class IntentRecognitionProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IntentRecognitionProvider

Method Detail

setPreProcessors

setPostProcessors

registerEntityDefinition

registerIntentDefinition

deleteEntityDefinition

deleteIntentDefinition

trainMLEngine

createSession

shutdown

isShutdown

getIntent

getIntentInternal

getRecognitionMonitor