com.xatkit.core.recognition

Class RecognitionMonitor

java.lang.Object

com.xatkit.core.recognition.RecognitionMonitor

public class RecognitionMonitor
extends Object

Provides monitoring capabilities for IntentRecognitionProviders.

This class stores analytics information related to intent recognition, and registers a set of REST endpoints allowing to query them from external applications.

The following endpoints can be used to access the stored information:

• /analytics/monitoring: returns a JSON array containing all the persisted monitoring information (note that this method doesn't support pagination yet, so the returned JSON may be big for long-running applications).
• /analytics/monitoring/session?sessionId=id: returns a JSON object containing the monitoring information for the provided sessionId
• /analytics/monitoring/unmatched: returns a JSON array containing all the monitoring entries corresponding to unmatched inputs (i.e. inputs that haven't been successfully translated into intents)
• /analytics/monitoring/matched: returns a JSON array containing all the monitoring entries corresponding to matched inputs (i.e. inputs that have been successfully translated into intents)
• /analytics/monitoring/sessions/stats: returns a JSON object containing computed statistics over stored sessions (e.g. average time/session, average number of matched inputs/sessions, etc)

Constructor Summary

Constructors

Constructor and Description
RecognitionMonitor(XatkitServer xatkitServer, Configuration configuration) Constructs a RecognitionMonitor with the provided xatkitServer and configuration.

Method Summary

Modifier and Type	Method and Description
void	logRecognizedIntent(XatkitSession session, com.xatkit.intent.RecognizedIntent recognizedIntent) Logs the recognition information from the provided recognizedIntent and session.
void	shutdown() Commit the pending operations on the database and closes the connection.

Methods inherited from class java.lang.Object

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

Constructor Detail

RecognitionMonitor

public RecognitionMonitor(XatkitServer xatkitServer,
                          Configuration configuration)

Constructs a RecognitionMonitor with the provided xatkitServer and configuration.

This constructor loads the stored information from the analytics database and create the in-memory data structures used to monitor intent recognition providers.

This constructor also registers the REST endpoints allowing to query the stored information from external applications.

This method also registers a shutdown hook which ensures that the database is closed properly when the JVM is stopped.

If the provided Configuration specifies a value for the xatkit.data.directory key it will be used as the base location to create the analytics database (in <xatkit.data.directory>/analytics /analytics.db.

Parameters:

xatkitServer - the XatkitServer instance used to register the REST endpoints

configuration - the Xatkit Configuration

Method Detail

logRecognizedIntent

public void logRecognizedIntent(XatkitSession session,
                                com.xatkit.intent.RecognizedIntent recognizedIntent)

Logs the recognition information from the provided recognizedIntent and session.

Parameters:

session - the XatkitSession from which the RecognizedIntent has been created

recognizedIntent - the RecognizedIntent to log

shutdown

public void shutdown()

Commit the pending operations on the database and closes the connection.