Package com.gengoai.hermes.extraction.keyword

Class TermKeywordExtractor

java.lang.Object

com.gengoai.hermes.extraction.keyword.TermKeywordExtractor

All Implemented Interfaces:

Extractor, KeywordExtractor, Serializable

public class TermKeywordExtractor
extends Object
implements KeywordExtractor

Implementation of a KeywordExtractor that extracts and scores terms based on a given FeaturizingExtractor*.

Author:

David B. Bracewell

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
TermKeywordExtractor()	Instantiates a new TermSpec keyword extractor that uses a default TermSpec with lowercase words
TermKeywordExtractor(@NonNull FeaturizingExtractor termExtractor)	Instantiates a new TermSpec keyword extractor.

Method Summary

Modifier and Type	Method	Description
Extraction	extract(@NonNull HString hString)	Generate an Extraction from the given HString.
void	fit(DocumentCollection corpus)	In certain cases a keyword extractor needs to collect corpus level statistics or construct a model of what a good keyword looks like.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TermKeywordExtractor

public TermKeywordExtractor()

Instantiates a new TermSpec keyword extractor that uses a default TermSpec with lowercase words

TermKeywordExtractor

public TermKeywordExtractor(@NonNull
                            @NonNull FeaturizingExtractor termExtractor)

Instantiates a new TermSpec keyword extractor.

Parameters:

termExtractor - the specification on how to extract terms

Method Detail

extract

public Extraction extract(@NonNull
                          @NonNull HString hString)

Description copied from interface: Extractor

Generate an Extraction from the given HString.

Specified by:

extract in interface Extractor

Parameters:

hString - the source text from which we will generate an Extraction

Returns:

the Extraction

fit

public void fit(DocumentCollection corpus)

Description copied from interface: KeywordExtractor

In certain cases a keyword extractor needs to collect corpus level statistics or construct a model of what a good keyword looks like. The fit method allows implementations to perform this logic at a corpus level.

Specified by:

fit in interface KeywordExtractor

Parameters:

corpus - the corpus to fit the extractor to