public class SimpleNaiveBayesClassifier extends java.lang.Object implements Classifier<BytesRef>
http://en.wikipedia.org/wiki/Naive_Bayes_classifier
Modifier and Type | Field and Description |
---|---|
protected Analyzer |
analyzer
Analyzer to be used for tokenizing unseen input text |
protected java.lang.String |
classFieldName
name of the field to be used as a class / category output
|
protected IndexReader |
indexReader
IndexReader used to access the Classifier 's
index |
protected IndexSearcher |
indexSearcher
IndexSearcher to run searches on the index for retrieving frequencies |
protected Query |
query
Query used to eventually filter the document set to be used to classify |
protected java.lang.String[] |
textFieldNames
names of the fields to be used as input text
|
Constructor and Description |
---|
SimpleNaiveBayesClassifier(IndexReader indexReader,
Analyzer analyzer,
Query query,
java.lang.String classFieldName,
java.lang.String... textFieldNames)
Creates a new NaiveBayes classifier.
|
Modifier and Type | Method and Description |
---|---|
ClassificationResult<BytesRef> |
assignClass(java.lang.String inputDocument)
Assign a class (with score) to the given text String
|
protected java.util.List<ClassificationResult<BytesRef>> |
assignClassNormalizedList(java.lang.String inputDocument)
Calculate probabilities for all classes for a given input text
|
protected int |
countDocsWithClass()
count the number of documents in the index having at least a value for the 'class' field
|
java.util.List<ClassificationResult<BytesRef>> |
getClasses(java.lang.String text)
Get all the classes (sorted by score, descending) assigned to the given text String.
|
java.util.List<ClassificationResult<BytesRef>> |
getClasses(java.lang.String text,
int max)
Get the first
max classes (sorted by score, descending) assigned to the given text String. |
protected java.util.ArrayList<ClassificationResult<BytesRef>> |
normClassificationResults(java.util.List<ClassificationResult<BytesRef>> assignedClasses)
Normalize the classification results based on the max score available
|
protected java.lang.String[] |
tokenize(java.lang.String text)
tokenize a
String on this classifier's text fields and analyzer |
protected final IndexReader indexReader
IndexReader
used to access the Classifier
's
indexprotected final java.lang.String[] textFieldNames
protected final java.lang.String classFieldName
protected final IndexSearcher indexSearcher
IndexSearcher
to run searches on the index for retrieving frequenciespublic SimpleNaiveBayesClassifier(IndexReader indexReader, Analyzer analyzer, Query query, java.lang.String classFieldName, java.lang.String... textFieldNames)
indexReader
- the reader on the index to be used for classificationanalyzer
- an Analyzer
used to analyze unseen textquery
- a Query
to eventually filter the docs used for training the classifier, or null
if all the indexed docs should be usedclassFieldName
- the name of the field used as the output for the classifier NOTE: must not be havely analyzed
as the returned class will be a token indexed for this fieldtextFieldNames
- the name of the fields used as the inputs for the classifier, NO boosting supported per fieldpublic ClassificationResult<BytesRef> assignClass(java.lang.String inputDocument) throws java.io.IOException
Classifier
assignClass
in interface Classifier<BytesRef>
inputDocument
- a String containing text to be classifiedClassificationResult
holding assigned class of type T
and scorejava.io.IOException
- If there is a low-level I/O error.public java.util.List<ClassificationResult<BytesRef>> getClasses(java.lang.String text) throws java.io.IOException
Classifier
getClasses
in interface Classifier<BytesRef>
text
- a String containing text to be classifiedClassificationResult
, the classes and scores. Returns null
if the classifier can't make lists.java.io.IOException
- If there is a low-level I/O error.public java.util.List<ClassificationResult<BytesRef>> getClasses(java.lang.String text, int max) throws java.io.IOException
Classifier
max
classes (sorted by score, descending) assigned to the given text String.getClasses
in interface Classifier<BytesRef>
text
- a String containing text to be classifiedmax
- the number of return list elementsClassificationResult
, the classes and scores. Cut for "max" number of elements. Returns null
if the classifier can't make lists.java.io.IOException
- If there is a low-level I/O error.protected java.util.List<ClassificationResult<BytesRef>> assignClassNormalizedList(java.lang.String inputDocument) throws java.io.IOException
inputDocument
- the input text as a String
List
of ClassificationResult
, one for each existing classjava.io.IOException
- if assigning probabilities failsprotected int countDocsWithClass() throws java.io.IOException
java.io.IOException
- if accessing to term vectors or search failsprotected java.lang.String[] tokenize(java.lang.String text) throws java.io.IOException
String
on this classifier's text fields and analyzertext
- the String
representing an input text (to be classified)String
array of the resulting tokensjava.io.IOException
- if tokenization failsprotected java.util.ArrayList<ClassificationResult<BytesRef>> normClassificationResults(java.util.List<ClassificationResult<BytesRef>> assignedClasses)
assignedClasses
- the list of assigned classesCopyright © 2000–2019 The Apache Software Foundation. All rights reserved.