com.xatkit.core.recognition.processor

Class StanfordNLPPostProcessor

java.lang.Object

com.xatkit.core.recognition.processor.StanfordNLPPostProcessor

All Implemented Interfaces:

IntentPostProcessor

Direct Known Subclasses:

EnglishSentimentPostProcessor, IsEnglishYesNoQuestionPostProcessor

public abstract class StanfordNLPPostProcessor
extends Object
implements IntentPostProcessor

A IntentPostProcessor using Stanford NLP library to extract information from the user input.

This class should be extended by any IntentPostProcessor relying on the StanfordNLPService. It provides a default implementation of the init() methods that warms-up the NLP pipeline with a fake input, and provides the getAnnotation(String, XatkitSession) helpers that allows to retrieve an Annotation from a given input by looking in the XatkitSession.

See Also:

StanfordNLPService

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	NLP_ANNOTATION_SESSION_KEY The XatkitSession key used to store the last annotation.
protected static String	NLP_CONTEXT_KEY The context key used to store Stanford NLP information.
protected static String	NLP_INPUT_SESSION_KEY The XatkitSession key used to store the last annotated input.

Constructor Summary

Constructors

Constructor and Description
StanfordNLPPostProcessor()

Method Summary

Modifier and Type	Method and Description
protected edu.stanford.nlp.pipeline.Annotation	getAnnotation(String input, XatkitSession session) Computes the Annotation for the provided input.
void	init() Initialize the underlying StanfordNLPService and performs a warm-up annotation on it.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xatkit.core.recognition.processor.IntentPostProcessor

process

Field Detail

NLP_CONTEXT_KEY

protected static final String NLP_CONTEXT_KEY

The context key used to store Stanford NLP information.

See Also:

Constant Field Values

NLP_INPUT_SESSION_KEY

protected static final String NLP_INPUT_SESSION_KEY

The XatkitSession key used to store the last annotated input.

This value is stored in the XatkitSession to let multiple post-processors access it to compute specific metrics.

See Also:

Constant Field Values

NLP_ANNOTATION_SESSION_KEY

protected static final String NLP_ANNOTATION_SESSION_KEY

The XatkitSession key used to store the last annotation.

This value is stored in the XatkitSession to let multiple post-processors access it to compute specific metrics.

See Also:

Constant Field Values

Constructor Detail

StanfordNLPPostProcessor

public StanfordNLPPostProcessor()

Method Detail

init

public void init()

Initialize the underlying StanfordNLPService and performs a warm-up annotation on it.

This method is used to avoid delays on the first query performed on a deployed chatbot.

Specified by:

init in interface IntentPostProcessor

See Also:

StanfordNLPService.init()

getAnnotation

protected final edu.stanford.nlp.pipeline.Annotation getAnnotation(String input,
                                                                   XatkitSession session)

Computes the Annotation for the provided input.

This method looks in the provided session if an Annotation has been already computed for the provided input and returns it. If it is not the case a new Annotation is computed using StanfordNLPService.annotate(String) and stored in the session.

Parameters:

input - the textual input to annotate

session - the XatkitSession corresponding to the provided input

Returns:

the Annotation corresponding to the provided input