public class KNearestNeighborDocumentClassifier extends KNearestNeighborClassifier implements DocumentClassifier<BytesRef>
http://en.wikipedia.org/wiki/K-nearest_neighbors
) based
on MoreLikeThis
.Modifier and Type | Field and Description |
---|---|
protected Map<String,Analyzer> |
field2analyzer
map of per field analyzers
|
classFieldName, indexSearcher, k, mlt, query, textFieldNames
Constructor and Description |
---|
KNearestNeighborDocumentClassifier(IndexReader indexReader,
Similarity similarity,
Query query,
int k,
int minDocsFreq,
int minTermFreq,
String classFieldName,
Map<String,Analyzer> field2analyzer,
String... textFieldNames)
Creates a
KNearestNeighborClassifier . |
Modifier and Type | Method and Description |
---|---|
ClassificationResult<BytesRef> |
assignClass(Document document)
Assign a class (with score) to the given
Document |
List<ClassificationResult<BytesRef>> |
getClasses(Document document)
Get all the classes (sorted by score, descending) assigned to the given
Document . |
List<ClassificationResult<BytesRef>> |
getClasses(Document document,
int max)
Get the first
max classes (sorted by score, descending) assigned to the given text String. |
assignClass, buildListFromTopDocs, getClasses, getClasses, toString
public KNearestNeighborDocumentClassifier(IndexReader indexReader, Similarity similarity, Query query, int k, int minDocsFreq, int minTermFreq, String classFieldName, Map<String,Analyzer> field2analyzer, String... textFieldNames)
KNearestNeighborClassifier
.indexReader
- the reader on the index to be used for classificationsimilarity
- the Similarity
to be used by the underlying IndexSearcher
or null
(defaults to ClassicSimilarity
)query
- a Query
to eventually filter the docs used for training the classifier, or null
if all the indexed docs should be usedk
- the no. of docs to select in the MLT results to find the nearest neighborminDocsFreq
- MoreLikeThis.minDocFreq
parameterminTermFreq
- MoreLikeThis.minTermFreq
parameterclassFieldName
- 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^10public ClassificationResult<BytesRef> assignClass(Document document) throws IOException
Document
assignClass
in interface DocumentClassifier<BytesRef>
document
- a Document
to be classified. Fields are considered features for the classification.ClassificationResult
holding assigned class of type T
and scoreIOException
- If there is a low-level I/O error.public List<ClassificationResult<BytesRef>> getClasses(Document document) throws IOException
Document
.getClasses
in interface DocumentClassifier<BytesRef>
document
- a Document
to be classified. Fields are considered features for the classification.ClassificationResult
, 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(Document document, int max) throws IOException
max
classes (sorted by score, descending) assigned to the given text String.getClasses
in interface DocumentClassifier<BytesRef>
document
- a Document
to be classified. Fields are considered features for the classification.max
- 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-2017 Apache Software Foundation. All Rights Reserved.