Package net.thexcoders.aladin_bot_backend.nlp_models.categorizer

Interface Categorizer

All Known Implementing Classes:

CategorizerImpl

public interface Categorizer

Categorizer class aims to recognize the category of the sentence based on the training Model used. The data used to train the model is based on the categories_[lang].txt The file is dynamic and the admin can download the file, edit and save it back to the ressources folder.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Categorizer.Language	enumeration class with two values Categorizer.Language.EN and Categorizer.Language.FR.

Method Summary

Modifier and Type	Method	Description
CategorizerImpl.CategoryResult	getCategory(String[] tokens, Categorizer.Language lang, String sentence)	this method is used to get the category of the tokenized sentence using the Tokenizer class.
static CategorizerImpl	getInstance()	gets the instance of the class, if the instance is null it calls the constructor to create a new instance
opennlp.tools.doccat.DoccatModel	train(String lang)	This method takes a lot of time to execute since it prepares the training Model for the categorizer based on the training Data provided in the CategorizerImpl() constructor} For optimization purposes, we Have used a singleton

Method Detail

getInstance

static CategorizerImpl getInstance()

gets the instance of the class, if the instance is null it calls the constructor to create a new instance

Returns:

Categorizer the instance of the class.

train

opennlp.tools.doccat.DoccatModel train(String lang)

This method takes a lot of time to execute since it prepares the training Model for the categorizer based on the training Data provided in the CategorizerImpl() constructor} For optimization purposes, we Have used a singleton

Parameters:

lang - a string value representing the language in which the model will be trained. It also references the file to be used to train the Model

Returns:

instance of DoccatModel which is the trained model.

See Also:

ObjectStream, DoccatModel, TrainingParameters, DoccatFactory, DocumentSampleStream, DocumentSample, DocumentCategorizerME, MarkableFileInputStreamFactory, PlainTextByLineStream

getCategory

CategorizerImpl.CategoryResult getCategory(String[] tokens,
                                           Categorizer.Language lang,
                                           String sentence)

this method is used to get the category of the tokenized sentence using the Tokenizer class.

Parameters:

tokens - an array of tokens retrieved from the tokenizer

lang - the Categorizer.Language in which the tokens are in

sentence - the sentenced (a single sentence from the user's input) from which the tokens are retrieved.

Returns:

an instance of CategorizerImpl.CategoryResult representing the result to be displayed to the user.