Package org.apache.lucene.classification
Class KNearestFuzzyClassifier
- java.lang.Object
-
- org.apache.lucene.classification.KNearestFuzzyClassifier
-
- All Implemented Interfaces:
Classifier<BytesRef>
public class KNearestFuzzyClassifier extends Object implements Classifier<BytesRef>
A k-Nearest Neighbor classifier based onNearestFuzzyQuery.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Constructor Description KNearestFuzzyClassifier(IndexReader indexReader, Similarity similarity, Analyzer analyzer, Query query, int k, String classFieldName, String... textFieldNames)Creates aKNearestFuzzyClassifier.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ClassificationResult<BytesRef>assignClass(String text)Assign a class (with score) to the given text StringList<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 firstmaxclasses (sorted by score, descending) assigned to the given text String.StringtoString()
-
-
-
Constructor Detail
-
KNearestFuzzyClassifier
public KNearestFuzzyClassifier(IndexReader indexReader, Similarity similarity, Analyzer analyzer, Query query, int k, String classFieldName, String... textFieldNames)
Creates aKNearestFuzzyClassifier.- Parameters:
indexReader- the reader on the index to be used for classificationanalyzer- anAnalyzerused to analyze unseen textsimilarity- 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 neighborclassFieldName- the name of the field used as the output for the classifiertextFieldNames- the name of the fields used as the inputs for the classifier, they can contain boosting indication e.g. title^10
-
-
Method Detail
-
assignClass
public ClassificationResult<BytesRef> assignClass(String text) throws IOException
Description copied from interface:ClassifierAssign a class (with score) to the given text String- Specified by:
assignClassin interfaceClassifier<BytesRef>- Parameters:
text- a String containing text to be classified- 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(String text) throws IOException
Description copied from interface:ClassifierGet all the classes (sorted by score, descending) assigned to the given text String.- Specified by:
getClassesin interfaceClassifier<BytesRef>- Parameters:
text- a String containing text to be classified- 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(String text, int max) throws IOException
Description copied from interface:ClassifierGet the firstmaxclasses (sorted by score, descending) assigned to the given text String.- Specified by:
getClassesin interfaceClassifier<BytesRef>- Parameters:
text- a String containing text to be classifiedmax- 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.
-
-