Class KNearestNeighborDocumentClassifier
- java.lang.Object
-
- org.apache.lucene.classification.KNearestNeighborClassifier
-
- org.apache.lucene.classification.document.KNearestNeighborDocumentClassifier
-
- All Implemented Interfaces:
Classifier<BytesRef>,DocumentClassifier<BytesRef>
public class KNearestNeighborDocumentClassifier extends KNearestNeighborClassifier implements DocumentClassifier<BytesRef>
A k-Nearest Neighbor Document classifier (seehttp://en.wikipedia.org/wiki/K-nearest_neighbors) based onMoreLikeThis.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Field Summary
Fields Modifier and Type Field Description protected Map<String,Analyzer>field2analyzermap of per field analyzers-
Fields inherited from class org.apache.lucene.classification.KNearestNeighborClassifier
classFieldName, indexSearcher, k, mlt, query, textFieldNames
-
-
Constructor Summary
Constructors Constructor Description KNearestNeighborDocumentClassifier(IndexReader indexReader, Similarity similarity, Query query, int k, int minDocsFreq, int minTermFreq, String classFieldName, Map<String,Analyzer> field2analyzer, String... textFieldNames)Creates aKNearestNeighborClassifier.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ClassificationResult<BytesRef>assignClass(Document document)Assign a class (with score) to the givenDocumentList<ClassificationResult<BytesRef>>getClasses(Document document)Get all the classes (sorted by score, descending) assigned to the givenDocument.List<ClassificationResult<BytesRef>>getClasses(Document document, int max)Get the firstmaxclasses (sorted by score, descending) assigned to the given text String.-
Methods inherited from class org.apache.lucene.classification.KNearestNeighborClassifier
assignClass, buildListFromTopDocs, classifyFromTopDocs, getClasses, getClasses, toString
-
-
-
-
Constructor Detail
-
KNearestNeighborDocumentClassifier
public KNearestNeighborDocumentClassifier(IndexReader indexReader, Similarity similarity, Query query, int k, int minDocsFreq, int minTermFreq, String classFieldName, Map<String,Analyzer> field2analyzer, String... textFieldNames) throws IOException
Creates aKNearestNeighborClassifier.- Parameters:
indexReader- the reader on the index to be used for classificationsimilarity- theSimilarityto be used by the underlyingIndexSearcherornull(defaults toBM25Similarity)query- aQueryto eventually filter the docs used for training the classifier, ornullif all the indexed docs should be usedk- the no. of docs to select in the MLT results to find the nearest neighborminDocsFreq-MoreLikeThis.minDocFreqparameterminTermFreq-MoreLikeThis.minTermFreqparameterclassFieldName- the name of the field used as the output for the classifierfield2analyzer- map with key a field name and the related {org.apache.lucene.analysis.Analyzer}textFieldNames- the name of the fields used as the inputs for the classifier, they can contain boosting indication e.g. title^10- Throws:
IOException
-
-
Method Detail
-
assignClass
public ClassificationResult<BytesRef> assignClass(Document document) throws IOException
Description copied from interface:DocumentClassifierAssign a class (with score) to the givenDocument- Specified by:
assignClassin interfaceDocumentClassifier<BytesRef>- Parameters:
document- aDocumentto be classified. Fields are considered features for the classification.- Returns:
- a
ClassificationResultholding assigned class of typeTand score - Throws:
IOException- If there is a low-level I/O error.
-
getClasses
public List<ClassificationResult<BytesRef>> getClasses(Document document) throws IOException
Description copied from interface:DocumentClassifierGet all the classes (sorted by score, descending) assigned to the givenDocument.- Specified by:
getClassesin interfaceDocumentClassifier<BytesRef>- Parameters:
document- aDocumentto be classified. Fields are considered features for the classification.- Returns:
- the whole list of
ClassificationResult, the classes and scores. Returnsnullif the classifier can't make lists. - Throws:
IOException- If there is a low-level I/O error.
-
getClasses
public List<ClassificationResult<BytesRef>> getClasses(Document document, int max) throws IOException
Description copied from interface:DocumentClassifierGet the firstmaxclasses (sorted by score, descending) assigned to the given text String.- Specified by:
getClassesin interfaceDocumentClassifier<BytesRef>- Parameters:
document- aDocumentto 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. Returnsnullif the classifier can't make lists. - Throws:
IOException- If there is a low-level I/O error.
-
-