Interface DocumentClassifier<T>
- All Known Implementing Classes:
KNearestNeighborDocumentClassifier
,SimpleNaiveBayesDocumentClassifier
public interface DocumentClassifier<T>
A classifier, see
http://en.wikipedia.org/wiki/Classifier_(mathematics)
, which
assign classes of type T
to a Document
s- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Method Summary
Modifier and TypeMethodDescriptionassignClass
(Document document) Assign a class (with score) to the givenDocument
getClasses
(Document document) Get all the classes (sorted by score, descending) assigned to the givenDocument
.getClasses
(Document document, int max) Get the firstmax
classes (sorted by score, descending) assigned to the given text String.
-
Method Details
-
assignClass
Assign a class (with score) to the givenDocument
- Parameters:
document
- aDocument
to be classified. Fields are considered features for the classification.- Returns:
- a
ClassificationResult
holding assigned class of typeT
and score - Throws:
IOException
- If there is a low-level I/O error.
-
getClasses
Get all the classes (sorted by score, descending) assigned to the givenDocument
.- Parameters:
document
- aDocument
to be classified. Fields are considered features for the classification.- Returns:
- the whole list of
ClassificationResult
, the classes and scores. Returnsnull
if the classifier can't make lists. - Throws:
IOException
- If there is a low-level I/O error.
-
getClasses
Get the firstmax
classes (sorted by score, descending) assigned to the given text String.- Parameters:
document
- aDocument
to be classified. Fields are considered features for the classification.max
- the number of return list elements- Returns:
- the whole list of
ClassificationResult
, the classes and scores. Cut for "max" number of elements. Returnsnull
if the classifier can't make lists. - Throws:
IOException
- If there is a low-level I/O error.
-