public class BM25NBClassifier extends Object implements Classifier<BytesRef>
Constructor and Description |
---|
BM25NBClassifier(IndexReader indexReader,
Analyzer analyzer,
Query query,
String classFieldName,
String... textFieldNames)
Creates a new NaiveBayes classifier.
|
Modifier and Type | Method and Description |
---|---|
ClassificationResult<BytesRef> |
assignClass(String inputDocument)
Assign a class (with score) to the given text String
|
List<ClassificationResult<BytesRef>> |
getClasses(String text)
Get all the classes (sorted by score, descending) assigned to the given text String.
|
List<ClassificationResult<BytesRef>> |
getClasses(String text,
int max)
Get the first
max classes (sorted by score, descending) assigned to the given text String. |
public BM25NBClassifier(IndexReader indexReader, Analyzer analyzer, Query query, String classFieldName, 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 heavely 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(String inputDocument) throws IOException
Classifier
assignClass
in interface Classifier<BytesRef>
inputDocument
- a String containing text to be classifiedClassificationResult
holding assigned class of type T
and scoreIOException
- If there is a low-level I/O error.public List<ClassificationResult<BytesRef>> getClasses(String text) throws 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.IOException
- If there is a low-level I/O error.public List<ClassificationResult<BytesRef>> getClasses(String text, int max) throws 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.IOException
- If there is a low-level I/O error.Copyright © 2000-2021 Apache Software Foundation. All Rights Reserved.