Interface DocumentClassifier<T>
-
- All Known Implementing Classes:
KNearestNeighborDocumentClassifier
,SimpleNaiveBayesDocumentClassifier
public interface DocumentClassifier<T>
A classifier, seehttp://en.wikipedia.org/wiki/Classifier_(mathematics)
, which assign classes of typeT
to aDocument
s- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ClassificationResult<T>
assignClass(Document document)
Assign a class (with score) to the givenDocument
List<ClassificationResult<T>>
getClasses(Document document)
Get all the classes (sorted by score, descending) assigned to the givenDocument
.List<ClassificationResult<T>>
getClasses(Document document, int max)
Get the firstmax
classes (sorted by score, descending) assigned to the given text String.
-
-
-
Method Detail
-
assignClass
ClassificationResult<T> assignClass(Document document) throws IOException
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
List<ClassificationResult<T>> getClasses(Document document) throws IOException
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
List<ClassificationResult<T>> getClasses(Document document, int max) throws IOException
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.
-
-