8/10/2021 Apache OpenNLP Developer Documentation

Apache OpenNLP Developer Documentation

Written and maintained by the Apache OpenNLP Development
Community

Version 1.9.3

Copyright © 2011, 2021 The Apache Software Foundation

License and Disclaimer. 

The ASF licenses this documentation
to
you under the Apache License,
Version 2.0 (the
"License"); you may
not use this documentation
except in compliance
with the License.
You may obtain a copy of the
License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,

this
documentation and its contents are distributed under the License
on
an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the
License.

Table of Contents

1. Introduction

Description
General Library Structure
Application Program Interface (API). Generic Example
Command line interface (CLI)

Description
List of tools
Setting up
Generic Example

2. Language Detector

Classifying
Language Detector Tool
Language Detector API
Training

Training Tool
Training with Leipzig
Training API

3. Sentence Detector

Sentence Detection

Sentence Detection Tool

Sentence Detection API

Sentence Detector Training

Training Tool
Training API

Evaluation

Evaluation Tool

4. Tokenizer

Tokenization

Tokenizer Tools
Tokenizer API

Tokenizer Training

Training Tool
Training API

Detokenizing

Detokenizing API
Detokenizer Dictionary

5. Name Finder

Named Entity Recognition

Name Finder Tool

Name Finder API

https://opennlp.apache.org/docs/1.9.3/manual/opennlp.html 1/64
8/10/2021 Apache OpenNLP Developer Documentation
Name Finder Training

Training Tool
Training API
Custom Feature Generation

Evaluation

Evaluation Tool
Evaluation API

Named Entity Annotation Guidelines

6. Document Categorizer

Classifying

Document Categorizer Tool

Document Categorizer API

Training

Training Tool
Training API

7. Part-of-Speech Tagger

Tagging

POS Tagger Tool

POS Tagger API

Training

Training Tool
Training API
Tag Dictionary

Evaluation

Evaluation Tool

8. Lemmatizer

Lemmatizer Tool
Lemmatizer API
Lemmatizer Training

Training Tool
Training API

Lemmatizer Evaluation

9. Chunker

Chunking

Chunker Tool
Chunking API

Chunker Training

Training Tool
Training API

Chunker Evaluation

Chunker Evaluation Tool

10. Parser

Parsing

Parser Tool
Parsing API

Parser Training

Training Tool
Training API

Parser Evaluation

Parser Evaluation Tool

Evaluation API

11. Coreference Resolution

12. Extending OpenNLP

Writing an extension
Running in an OSGi container
https://opennlp.apache.org/docs/1.9.3/manual/opennlp.html 2/64