Package opennlp.tools.sentdetect

Class SentenceDetectorME

java.lang.Object

opennlp.tools.sentdetect.SentenceDetectorME

All Implemented Interfaces:

Probabilistic, SentenceDetector

public class SentenceDetectorME
extends Object
implements SentenceDetector, Probabilistic

A sentence detector for splitting up raw text into sentences.

A maximum entropy model is used to evaluate end-of-sentence characters in a string to determine if they signify the end of a sentence.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NO_SPLIT	Constant indicates no sentence split.
static final String	SPLIT	Constant indicates a sentence split.

Constructor Summary

Constructors

Constructor	Description
SentenceDetectorME(String language)	Initializes the sentence detector by downloading a default model.
SentenceDetectorME(SentenceModel model)	Initializes the current instance.
SentenceDetectorME(SentenceModel model, Dictionary abbDict)	Instantiates a SentenceDetectorME with an existing SentenceModel.
SentenceDetectorME(SentenceModel model, Factory factory)	Deprecated. Use a SentenceDetectorFactory to extend SentenceDetector functionality.

Method Summary

Modifier and Type	Method	Description
double[]	getSentenceProbabilities()	Deprecated, for removal: This API element is subject to removal in a future version. Use probs() instead.
double[]	probs()	Retrieves the probabilities of the last decoded sequence.
String[]	sentDetect(CharSequence s)	Detects sentences in given input CharSequence..
Span[]	sentPosDetect(CharSequence s)	Detects the position of the first words of sentences in a CharSequence.
static SentenceModel	train(String languageCode, ObjectStream<SentenceSample> samples, SentenceDetectorFactory sdFactory, TrainingParameters mlParams)	Starts a training of a SentenceModel with the given parameters.

Methods inherited from class java.lang.Object

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

Field Details

SPLIT

public static final String SPLIT

Constant indicates a sentence split.

See Also:

• Constant Field Values

NO_SPLIT

public static final String NO_SPLIT

Constant indicates no sentence split.

See Also:

• Constant Field Values

Constructor Details

SentenceDetectorME

public SentenceDetectorME(String language)
                   throws IOException

Initializes the sentence detector by downloading a default model.

Parameters:

language - The language of the sentence detector.

Throws:

IOException - Thrown if the model cannot be downloaded or saved.

SentenceDetectorME

public SentenceDetectorME(SentenceModel model)

Initializes the current instance.

Parameters:

model - the SentenceModel

SentenceDetectorME

public SentenceDetectorME(SentenceModel model,
 Dictionary abbDict)

Instantiates a SentenceDetectorME with an existing SentenceModel.

Parameters:

model - The SentenceModel to be used.

abbDict - The Dictionary to be used. It must fit the language of the model.

SentenceDetectorME

@Deprecated
public SentenceDetectorME(SentenceModel model,
 Factory factory)

Deprecated.

Use a SentenceDetectorFactory to extend SentenceDetector functionality.

Method Details

sentDetect

public String[] sentDetect(CharSequence s)

Detects sentences in given input CharSequence..

Specified by:

sentDetect in interface SentenceDetector

Parameters:

s - The CharSequence. to be processed.

Returns:

A string array containing individual sentences as elements.

sentPosDetect

public Span[] sentPosDetect(CharSequence s)

Detects the position of the first words of sentences in a CharSequence.

Specified by:

sentPosDetect in interface SentenceDetector

Parameters:

s - The CharSequence to be processed.

Returns:

An span array containing the positions of the end index of every sentence.

probs

public double[] probs()

Retrieves the probabilities of the last decoded sequence. The sequence was determined based on the previous call to sentDetect(CharSequence).

Specified by:

probs in interface Probabilistic

Returns:

An array with the same number of probabilities as tokens were sent to sentDetect(CharSequence) when it was last called. If not applicable, an empty array is returned.

getSentenceProbabilities

@Deprecated(forRemoval=true,
            since="2.5.5")
public double[] getSentenceProbabilities()

Deprecated, for removal: This API element is subject to removal in a future version.

Use probs() instead.

Returns:

The probability for each sentence returned for the most recent call to sentDetect(CharSequence). If not applicable, an empty array is returned.

train

public static SentenceModel train(String languageCode,
 ObjectStream<SentenceSample> samples,
 SentenceDetectorFactory sdFactory,
 TrainingParameters mlParams)
                           throws IOException

Starts a training of a SentenceModel with the given parameters.

Parameters:

languageCode - The ISO language code to train the model. Must not be null.

samples - The ObjectStream of SentenceSample used as input for training.

sdFactory - The SentenceDetectorFactory for creating related objects as defined via mlParams.

mlParams - The TrainingParameters for the context of the training process.

Returns:

A valid, trained SentenceModel instance.

Throws:

IOException - Thrown if IO errors occurred.