DKPro Core™ Component Reference

The character encoding used by the model.

Type: String  — Default value: UTF-8

Location from which the model is read. The model file is a simple word-list with one word per line.

Type: String

Determines the maximum edit distance (as an int value) that a suggestion for a spelling error may have. E.g. if set to one suggestions are limited to words within edit distance 1 to the original word.

Type: Integer  — Default value: 1

Use this language instead of the document language to resolve the model.

Optional — Type: String

Load the chunk tag to UIMA type mapping from this location instead of locating the mapping automatically.

Optional — Type: String

Use this language instead of the document language to resolve the model.

Optional — Type: String

Enable/disable type mapping.

Type: Boolean  — Default value: true

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Override the default variant used to locate the model.

Optional — Type: String

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false

Training algorithm.

Type: String  — Default value: MAXENT

Beam size.

Type: Integer  — Default value: 3

Frequency cut-off.

Type: Integer  — Default value: 5

Number of training iterations.

Type: Integer  — Default value: 100

Store this language to the model instead of the document language.

Type: String

Number of parallel threads.

Type: Integer  — Default value: 1

Location to which the output is written.

Type: String

Trainer type.

Type: String  — Default value: Event

Location of the mapping file for chunk tags to UIMA types.

Optional — Type: String

Use this TreeTagger executable instead of trying to locate the executable automatically.

Optional — Type: String

A sequence to flush the internal TreeTagger buffer and to force it to output the rest of the completed analysis. This is typically just a sequence of like 5-10 full stops (".") separated by new line characters. However, some models may require a different flush sequence, e.g. a short sentence in the respective language. For chunker models, mind that the sentence must also be POS tagged, e.g. Nous-PRO:PER\n....

Optional — Type: String

Use this language instead of the document language to resolve the model.

Optional — Type: String

Enable/disable type mapping.

Type: Boolean  — Default value: true

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

The character encoding used by the model.

Optional — Type: String

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Override the default variant used to locate the model.

Optional — Type: String

TT4J setting: Disable some sanity checks, e.g. whether tokens contain line breaks (which is not allowed). Turning this on will increase your performance, but the wrapper may throw exceptions if illegal data is provided.

Type: Boolean  — Default value: false

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false

DCoRef parameter: Maximum sentence distance between two mentions for resolution (-1: no constraint on the distance)

Type: Integer  — Default value: -1

DCoRef parameter: Do post-processing

Type: Boolean  — Default value: false

Enable all traditional PTB3 token transforms (like -LRB-, -RRB-).

Type: Boolean  — Default value: true

List of extra token texts (usually single character strings) that should be treated like opening quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

List of extra token texts (usually single character strings) that should be treated like closing quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

DCoRef parameter: Scoring the output of the system

Type: Boolean  — Default value: false

DCoRef parameter: Sieve passes - each class is defined in dcoref/sievepasses/.

Type: String  — Default value: MarkRole, DiscourseMatch, ExactStringMatch, RelaxedExactStringMatch, PreciseConstructs, StrictHeadMatch1, StrictHeadMatch2, StrictHeadMatch3, StrictHeadMatch4, RelaxedHeadMatch, PronounMatch

DCoRef parameter: setting singleton predictor

Type: Boolean  — Default value: true

DCoRef parameter: Maximum sentence distance between two mentions for resolution (-1: no constraint on the distance)

Type: Integer  — Default value: -1

DCoRef parameter: Do post processing

Type: Boolean  — Default value: false

DCoRef parameter: Scoring the output of the system

Type: Boolean  — Default value: false

DCoRef parameter: Sieve passes - each class is defined in dcoref/sievepasses/.

Type: String  — Default value: MarkRole, DiscourseMatch, ExactStringMatch, RelaxedExactStringMatch, PreciseConstructs, StrictHeadMatch1, StrictHeadMatch2, StrictHeadMatch3, StrictHeadMatch4, RelaxedHeadMatch, PronounMatch

DCoRef parameter: setting singleton predictor

Type: Boolean  — Default value: true

1. If this parameter is not specified, unknown tokens are not annotated.
2. If an empty float[] is passed, a random vector is generated that is used for each unknown token.
3. If a float[] is passed, each unknown token is annotated with that vector. The float must have the same length as the vectors in the model file.

Type: Boolean  — Default value: false

If set to true (default: false), all tokens are lowercased.

Type: Boolean  — Default value: false

If set to true (default: false), the first line is interpreted as header line containing the number of entries and the dimensionality. This should be set to true for models generated with Word2Vec.

Type: Boolean  — Default value: false

Whether the model is in binary format instead of text format.

Type: Boolean  — Default value: false

The file containing the word embeddings.

Currently only supports text file format.

Type: String

The annotation type to use for the model. For lemmas, use de.tudarmstadt.ukp.dkpro.core.api.segmentation.type.Token/lemma/value

Type: String  — Default value: de.tudarmstadt.ukp.dkpro.core.api.segmentation.type.Token

Choose a compression method. (default: CompressionMethod#NONE)

Optional — Type: String  — Default value: NONE

If specified, the text contained in the given segmentation type annotations are fed as separate units ("documents") to the topic model estimator e.g. de.tudarmstadt.ukp.dkpro.core.api.segmentation.type.sentence. Text that is not within such annotations is ignored.

By default, the full text is used as a document.

Type: String  — Default value: ``

The dimensionality of the output word embeddings (default: 50).

Type: Integer  — Default value: 50

URL-encode the file name to avoid illegal characters (e.g. \, :, etc.)

Type: Boolean  — Default value: false

An example word that is output with its nearest neighbours once in a while (default: null, i.e. none).

Optional — Type: String

Regular expression of tokens to be filtered.

Type: String  — Default value: ``

Value with which tokens matching the regular expression are replaced.

Type: String  — Default value: ``

If set to true (default: false), all tokens are lowercased.

Type: Boolean  — Default value: false

Ignore documents with fewer tokens than this value (default: 10).

Type: Integer  — Default value: 10

Ignore tokens (or any other annotation type, as specified by #PARAM_TOKEN_FEATURE_PATH) that are shorter than the given value.

Type: Integer  — Default value: 3

The number of negative samples to be generated for each token (default: 5).

Type: Integer  — Default value: 5

The number of threads to use during model estimation. If not set, the number of threads is automatically set by ComponentParameters#computeNumThreads(int).

Warning: do not set this to more than 1 when using very small (test) data sets on MalletEmbeddingsTrainer! This might prevent the process from terminating.

Type: Integer  — Default value: 0

Allow overwriting target files (ignored when writing to ZIP archives).

Type: Boolean  — Default value: false

The location of the stopwords file.

Type: String  — Default value: ``

If set, stopwords found in the #PARAM_STOPWORDS_FILE location are not removed, but replaced by the given string (e.g. STOP).

Type: String  — Default value: ``

Treat target location as a single file name. This is particularly useful if only a single input file is processed and the result should be written to a pre-defined output file instead of deriving the file name from the document URI or document ID. It can also be useful if the user wishes to force multiple input files to be written to a single target file. The latter case does not work for all formats (e.g. binary, XMI, etc.), but can be useful, e.g. for Conll-based formats. This option has no effect if the target location points to an archive location (ZIP/JAR). The #PARAM_COMPRESSION is respected, but does not automatically add an extension. The #PARAM_STRIP_EXTENSION has no effect as the original extension is not preserved.

Type: Boolean  — Default value: false

Remove the original extension.

Type: Boolean  — Default value: false

Target location. If this parameter is not set, data is written to stdout.

Optional — Type: String

The annotation type to use as input tokens for the model estimation. For lemmas, use de.tudarmstadt.ukp.dkpro.core.api.segmentation.type.Token/lemma/value

Type: String  — Default value: de.tudarmstadt.ukp.dkpro.core.api.segmentation.type.Token

If true (default: false), estimate character embeddings. #PARAM_TOKEN_FEATURE_PATH is ignored.

Type: Boolean  — Default value: false

Use the document ID as file name even if a relative path information is present.

Type: Boolean  — Default value: false

The context size when generating embeddings (default: 5).

Type: Integer  — Default value: 5

The annotation to create on matching phases. If nothing is specified, this defaults to NGram.

Optional — Type: String

The character encoding used by the model.

Type: String  — Default value: UTF-8

The file must contain one phrase per line - phrases will be split at " "

Type: String

The value to set the feature configured in #PARAM_VALUE_FEATURE to.

Optional — Type: String

Set this feature on the created annotations.

Optional — Type: String  — Default value: value

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Location from which the model is read.

Optional — Type: String

Variant of a model the model. Used to address a specific model if here are multiple models for one language.

Optional — Type: String

The random seed.

Optional — Type: String

The maximum n-gram size that should be considered. Default is 3.

Type: Integer  — Default value: 3

The minimum n-gram size that should be considered. Default is 1.

Type: Integer  — Default value: 1

Use this language instead of the document language to resolve the model.

Optional — Type: String  — Default value: en

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Override the default variant used to locate the model.

Optional — Type: String

Enable all traditional PTB3 token transforms (like -LRB-, -RRB-).

Type: Boolean  — Default value: true

List of extra token texts (usually single character strings) that should be treated like opening quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

List of extra token texts (usually single character strings) that should be treated like closing quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

Enable all traditional PTB3 token transforms (like -LRB-, -RRB-).

Type: Boolean  — Default value: true

List of extra token texts (usually single character strings) that should be treated like opening quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

List of extra token texts (usually single character strings) that should be treated like closing quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

Use this language instead of the document language to resolve the model.

Optional — Type: String

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Override the default variant used to locate the model.

Optional — Type: String

Use this language instead of the document language to resolve the model.

Optional — Type: String

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Override the default variant used to locate the model.

Optional — Type: String

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false

Remove characters specified in #PARAM_SANTIZE_CHARS from lemmas.

Type: Boolean  — Default value: true

Characters to remove from lemmas if #PARAM_SANITIZE is enabled.

Type: String[]  — Default value: [(, ), [, ]]

Use this language instead of the document language to resolve the model.

Optional — Type: String

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Try reconstructing proper casing for lemmata. This is useful for German, but e.g. for English creates odd results.

Type: Boolean  — Default value: false

Override the default variant used to locate the model.

Optional — Type: String

Pass part-of-speech information on to Morpha. Since we currently do not know in which format the part-of-speech tags are expected by Morpha, we just pass on the actual pos tag value we get from the token. This may produce worse results than not passing on pos tags at all, so this is disabled by default.

Type: Boolean  — Default value: false

Use this language instead of the document language to resolve the model.

Optional — Type: String

Use this language instead of the document language to resolve the model.

Optional — Type: String

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

The character encoding used by the model.

Optional — Type: String

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Override the default variant used to locate the model.

Optional — Type: String

Training algorithm.

Type: String  — Default value: MAXENT

Beam size.

Type: Integer  — Default value: 3

Frequency cut-off.

Type: Integer  — Default value: 5

Number of training iterations.

Type: Integer  — Default value: 100

Store this language to the model instead of the document language.

Type: String

Number of parallel threads.

Type: Integer  — Default value: 1

Location to which the output is written.

Type: String

Trainer type.

Type: String  — Default value: Event

Use this language instead of the document language to resolve the model.

Optional — Type: String

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Override the default variant used to locate the model.

Optional — Type: String

Load the morphological features mapping from this location instead of locating the mapping automatically.

Optional — Type: String

Load the part-of-speech tag to UIMA type mapping from this location instead of locating the mapping automatically.

Optional — Type: String

Use this language instead of the document language to resolve the model.

Optional — Type: String

Enable/disable type mapping.

Type: Boolean  — Default value: true

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

The character encoding used by the model.

Optional — Type: String

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Override the default variant used to locate the model.

Optional — Type: String

Write the tag set(s) to the log when a model is loaded.

Type: Boolean  — Default value: false

Load the morphological features mapping from this location instead of locating the mapping automatically.

Optional — Type: String

Use this language instead of the document language to resolve the model.

Optional — Type: String

Whether to lookup the first word of a sentence in lowercase, useful if the employed model does not handle lowercasing.

Optional — Type: Boolean  — Default value: false

Whether to record only the first (FIRST) or all possible analyses (ALL).

Type: String  — Default value: FIRST

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Specifies the model encoding.

Type: String  — Default value: UTF-8

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Override the default variant used to locate the model.

Optional — Type: String

Write the tag set(s) to the log when a model is loaded.

Type: Boolean  — Default value: false

Write lemma information.

Type: Boolean  — Default value: true

Write part-of-speech information.

Type: Boolean  — Default value: true

Location of the mapping file for named entity tags to UIMA types.

Optional — Type: String

Use this language instead of the document language to resolve the model.

Optional — Type: String

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Location from which the model is read.

Optional — Type: String

Variant of a model the model. Used to address a specific model if here are multiple models for one language.

Optional — Type: String

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false

Enable all traditional PTB3 token transforms (like -LRB-, -RRB-).

Type: Boolean  — Default value: true

List of extra token texts (usually single character strings) that should be treated like opening quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

List of extra token texts (usually single character strings) that should be treated like closing quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

Location of the mapping file for named entity tags to UIMA types.

Optional — Type: String

Type: Boolean  — Default value: true

Use this language instead of the document language to resolve the model and tag set mapping.

Optional — Type: String

Maximum sentence length. Longer sentences are skipped.

Type: Integer  — Default value: 2147483647

Maximum time to spend on a single sentence.

Type: Integer  — Default value: -1

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

The character encoding used by the model.

Optional — Type: String

Location from which the model is read.

Optional — Type: String

Variant of a model the model. Used to address a specific model if here are multiple models for one language.

Optional — Type: String

Number of parallel threads to use.

Type: Integer  — Default value: 0

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false

Enable all traditional PTB3 token transforms (like -LRB-, -RRB-).

Type: Boolean  — Default value: true

List of extra token texts (usually single character strings) that should be treated like opening quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

List of extra token texts (usually single character strings) that should be treated like closing quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

Regex to filter the de.tudarmstadt.ukp.dkpro.core.api.ner.type.NamedEntity#getValue() named entity by type.

Optional — Type: String

Label set to use for training.

Options: IOB1, IOB2, IOE1, IOE2, SBIEO, IO, BIO, BILOU, noprefix

Optional — Type: String  — Default value: noprefix

Training file containing the parameters. The trainFile or trainFileList and serializeTo parameters in this file are ignored/overridden.

Optional — Type: String

Flag to keep the label set specified by PARAM_LABEL_SET. If set to false, representation is mapped to IOB1 on output.

Optional — Type: Boolean  — Default value: true

Location of the target model file.

Type: String

Location of the mapping file for named entity tags to UIMA types.

Optional — Type: String

Use this language instead of the document language to resolve the model.

Optional — Type: String

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Location from which the model is read.

Optional — Type: String

Variant of a model the model. Used to address a specific model if here are multiple models for one language.

Optional — Type: String

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false

Regex to filter the de.tudarmstadt.ukp.dkpro.core.api.ner.type.NamedEntity#getValue() named entity by type.

Optional — Type: String

Location to which the output is written.

Type: String

Location of the mapping file for named entity tags to UIMA types.

Optional — Type: String

Process anyway, even if the model relies on features that are not supported by this component.

Type: Boolean  — Default value: false

Use this language instead of the document language to resolve the model.

Optional — Type: String

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Location from which the model is read.

Optional — Type: String

Variant of a model the model. Used to address a specific model if here are multiple models for one language.

Optional — Type: String

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false

Location of the mapping file for named entity tags to UIMA types.

Optional — Type: String

Use this language instead of the document language to resolve the model.

Optional — Type: String

Enable/disable type mapping.

Type: Boolean  — Default value: true

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Location from which the model is read.

Optional — Type: String

Variant of a model the model. Used to address a specific model if here are multiple models for one language.

Type: String  — Default value: person

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false

Regex to filter the de.tudarmstadt.ukp.dkpro.core.api.ner.type.NamedEntity#getValue() named entity by type.

Optional — Type: String

Type: String  — Default value: PERCEPTRON

Type: Integer  — Default value: 3

Frequency cut-off.

Type: Integer  — Default value: 0

File containing the feature generation specification.

Optional — Type: String

Number of training iterations.

Type: Integer  — Default value: 300

Store this language to the model instead of the document language.

Type: String

Number of parallel threads.

Type: Integer  — Default value: 1

Type of sequence encoding to use.

Type: String  — Default value: BILOU

Location to which the output is written.

Type: String

Training algorithm.

Type: String  — Default value: Event

Annotation types which should be annotated with semantic fields

Type: String

A constraint on the annotations that should be considered in form of a JXPath statement. Example: set #PARAM_ANNOTATION_TYPE to a NamedEntity type and set the #PARAM_CONSTRAINT to ".[value = 'LOCATION']" to annotate only tokens with semantic fields that are part of a location named entity.

Optional — Type: String

Location of the mapping file for constituent tags to UIMA types.

Optional — Type: String

Location of the mapping file for part-of-speech tags to UIMA types.

Optional — Type: String

Set thresholds for accuracy instead of efficiency.

Type: Boolean  — Default value: false

Output binarized trees.

Type: Boolean  — Default value: false

Retain predicted function labels. Model must have been trained with function labels.

Type: Boolean  — Default value: false

Use this language instead of the language set in the CAS to locate the model.

Optional — Type: String

Enable/disable type mapping.

Type: Boolean  — Default value: true

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Override the default variant used to locate the model.

Optional — Type: String

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false

Sets whether to use or not to use already existing POS tags from another annotator for the parsing process.

Type: Boolean  — Default value: true

Output inside scores (only for binarized viterbi trees).

Type: Boolean  — Default value: false

Output sub-categories (only for binarized Viterbi trees).

Type: Boolean  — Default value: false

Use variational rule score approximation instead of max-rule

Type: Boolean  — Default value: false

Compute Viterbi derivation instead of max-rule tree.

Type: Boolean  — Default value: false

Sets whether to create or not to create POS tags. The creation of constituent tags must be turned on for this to work.

Type: Boolean  — Default value: false

If this parameter is set to true, each sentence is annotated with a PennTree-Annotation, containing the whole parse tree in Penn Treebank style format.

Type: Boolean  — Default value: false

Use this language instead of the document language to resolve the model.

Optional — Type: String

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Location from which the model is read.

Optional — Type: String

Variant of a model the model. Used to address a specific model if here are multiple models for one language.

Optional — Type: String

Write the tag set(s) to the log when a model is loaded.

Type: Boolean  — Default value: false

Use this language instead of the document language to resolve the model and tag set mapping.

Optional — Type: String

Sets the kind of dependencies being created.

Optional — Type: String  — Default value: TREE

Create original dependencies. If this is disabled, universal dependencies are created. The default is to create the original dependencies.

Type: Boolean  — Default value: true

Location of the mapping file for part-of-speech tags to UIMA types.

Optional — Type: String

Types of extra edges to add to the dependency tree.

Type: String  — Default value: NONE

Use this language instead of the document language to resolve the model and tag set mapping.

Optional — Type: String

Enable/disable type mapping.

Type: Boolean  — Default value: true

Maximum sentence length. Longer sentences are skipped.

Type: Integer  — Default value: 2147483647

Maximum time to spend on a single sentence.

Type: Integer  — Default value: -1

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

The character encoding used by the model.

Optional — Type: String

Location from which the model is read.

Optional — Type: String

Variant of a model the model. Used to address a specific model if here are multiple models for one language.

Optional — Type: String

Number of parallel threads to use.

Type: Integer  — Default value: 0

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false

Enable all traditional PTB3 token transforms (like -LRB-, -RRB-).

Type: Boolean  — Default value: true

List of extra token texts (usually single character strings) that should be treated like opening quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

List of extra token texts (usually single character strings) that should be treated like closing quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

Location of the mapping file for dependency tags to UIMA types.

Optional — Type: String

Location of the mapping file for dependency tags to UIMA types.

Optional — Type: String

Location of the mapping file for part-of-speech tags to UIMA types.

Optional — Type: String

Types of extra edges to add to the dependency tree.

Type: String  — Default value: NONE

Whether to keep punctuation dependencies in the dependency parse output of the parser.

Type: Boolean  — Default value: false

Use this language instead of the document language to resolve the model and tag set mapping.

Optional — Type: String

Enable/disable type mapping.

Type: Boolean  — Default value: true

Maximum sentence length. Longer sentences are skipped.

Type: Integer  — Default value: 2147483647

Maximum time to spend on a single sentence.

Type: Integer  — Default value: -1

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

The character encoding used by the model.

Optional — Type: String

Location from which the model is read.

Optional — Type: String

Variant of a model the model. Used to address a specific model if here are multiple models for one language.

Optional — Type: String

Number of parallel threads to use.

Type: Integer  — Default value: 0

Generate original Stanford Dependencies grammatical relations instead of Universal Dependencies.

Type: Boolean  — Default value: true

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false

Enable all traditional PTB3 token transforms (like -LRB-, -RRB-).

Type: Boolean  — Default value: true

List of extra token texts (usually single character strings) that should be treated like opening quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

List of extra token texts (usually single character strings) that should be treated like closing quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

Sets whether to use or not to use existing POS tags.

Type: Boolean  — Default value: true

Sets whether to create or not to create constituent tags. This is required for POS-tagging and lemmatization.

Type: Boolean  — Default value: true

Sets whether to create or not to create dependency annotations.

Type: Boolean  — Default value: true

Sets whether to create or not to create POS tags. The creation of constituent tags must be turned on for this to work.

Type: Boolean  — Default value: false

If this parameter is set to true, each sentence is annotated with a PennTree-Annotation, containing the whole parse tree in Penn Treebank style format.

Type: Boolean  — Default value: false

Location of the mapping file for constituent tags to UIMA types.

Optional — Type: String

Location of the mapping file for part-of-speech tags to UIMA types.

Optional — Type: String

This parameter can be used to override the standard behavior which uses the Sentence annotation as the basic unit for parsing.

If the parameter is set with the name of an annotation type x, the parser will no longer parse Sentence-annotations, but x-Annotations.

Optional — Type: String

Whether to keep the punctuation as part of the parse tree.

Type: Boolean  — Default value: false

Use this language instead of the document language to resolve the model and tag set mapping.

Optional — Type: String

Enable/disable type mapping.

Type: Boolean  — Default value: true

Controls when the factored parser considers a sentence to be too complex and falls back to the PCFG parser.

Type: Integer  — Default value: 200000

Maximum number of tokens in a sentence. Longer sentences are not parsed. This is to avoid out of memory exceptions.

Type: Integer  — Default value: 130

Sets the kind of dependencies being created.

Optional — Type: String  — Default value: TREE

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Location from which the model is read.

Optional — Type: String

Variant of a model the model. Used to address a specific model if here are multiple models for one language.

Optional — Type: String

Write the tag set(s) to the log when a model is loaded.

Type: Boolean  — Default value: false

Enable all traditional PTB3 token transforms (like -LRB-, -RRB-).

Type: Boolean  — Default value: true

List of extra token texts (usually single character strings) that should be treated like opening quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

List of extra token texts (usually single character strings) that should be treated like closing quotes and escaped accordingly before being sent to the parser.

Optional — Type: String[]

Sets whether to use or not to use already existing POS tags from another annotator for the parsing process.

Type: Boolean  — Default value: true

Sets whether to create or not to create constituent tags. This is required for POS-tagging and lemmatization.

Type: Boolean  — Default value: true

Sets whether to create or not to create dependency annotations.

Type: Boolean  — Default value: true

Sets whether to create or not to create POS tags. The creation of constituent tags must be turned on for this to work.

Type: Boolean  — Default value: false

If this parameter is set to true, each sentence is annotated with a PennTree-Annotation, containing the whole parse tree in Penn Treebank style format.

Type: Boolean  — Default value: false

Load the dependency to UIMA type mapping from this location instead of locating the mapping automatically.

Optional — Type: String

Use this language instead of the document language to resolve the model.

Optional — Type: String

Enable/disable type mapping.

Type: Boolean  — Default value: true

URI of the model artifact. This can be used to override the default model resolving mechanism and directly address a particular model.

The URI format is mvn:${groupId:${artifactId}:${version}}. Remember to set the variant parameter to match the artifact. If the artifact contains the model in a non-default location, you also have to specify the model location parameter, e.g. classpath:/model/path/in/artifact/model.bin.

Optional — Type: String

Load the model from this location instead of locating the model automatically.

Optional — Type: String

Override the default variant used to locate the model.

Optional — Type: String

Specifies the order/scope of features. 1 only has features over single edges and 2 has features over pairs of adjacent edges in the tree. The model must have been trained with the respective order set here.

Optional — Type: Integer

Log the tag set(s) when a model is loaded.

Type: Boolean  — Default value: false