DKPro Core™ Format Reference

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Name of configuration parameter that contains the character encoding used by the input files. If not specified, the default system encoding will be used.

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String

Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

Type: Boolean  — Default value: false

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Write lemma annotations to the CAS.

Type: Boolean  — Default value: true

Write part-of-speech annotations to the CAS.

Type: Boolean  — Default value: true

Write sentence annotations to the CAS.

Type: Boolean  — Default value: true

Write token annotations to the CAS.

Type: Boolean  — Default value: true

Location from which the input is read.

Optional — Type: String

Type: Boolean  — Default value: true

Use the default excludes.

Type: Boolean  — Default value: true

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Types that are relations. It is mandatory to provide the type name followed by two feature names that represent Arg1 and Arg2 separated by colons, e.g. de.tudarmstadt.ukp.dkpro.core.api.syntax.type.dependency.Dependency:Governor:Dependent{A}. Additionally, a subcategorization feature may be specified.

Type: String[]  — Default value: [de.tudarmstadt.ukp.dkpro.core.api.syntax.type.dependency.Dependency:Governor:Dependent{A}]

Name of configuration parameter that contains the character encoding used by the input files.

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Types that are text annotations. It is mandatory to provide the type name which can optionally be followed by a subcategorization feature. Using this parameter is only necessary to specify a subcategorization feature. Otherwise, text annotation types are automatically detected.

Type: String[]  — Default value: []

Optional — Type: String[]  — Default value: []

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

Enable type mappings.

Type: Boolean  — Default value: false

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

Type: Boolean  — Default value: true

Types that will not be written to the exported file.

Type: String[]  — Default value: [de.tudarmstadt.ukp.dkpro.core.api.segmentation.type.Sentence]

Specify the suffix of output files. Default value .ann. If the suffix is not needed, provide an empty string as value.

Type: String  — Default value: .ann

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

Type: Boolean  — Default value: false

Colors to be used for the visual configuration that is generated for brat.

Optional — Type: String[]  — Default value: [#8dd3c7, #ffffb3, #bebada, #fb8072, #80b1d3, #fdb462, #b3de69, #fccde5, #d9d9d9, #bc80bd, #ccebc5, #ffed6f]

Types that are relations. It is mandatory to provide the type name followed by two feature names that represent Arg1 and Arg2 separated by colons, e.g. de.tudarmstadt.ukp.dkpro.core.api.syntax.type.dependency.Dependency:Governor:Dependent.

Type: String[]  — Default value: [de.tudarmstadt.ukp.dkpro.core.api.syntax.type.dependency.Dependency:Governor:Dependent]

Whether to render attributes by their short name or by their qualified name.

Type: Boolean  — Default value: false

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

Types that are text annotations (aka entities or spans).

Type: String[]  — Default value: []

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

Specify the suffix of text output files. Default value .txt. If the suffix is not needed, provide an empty string as value.

Type: String  — Default value: .txt

FIXME

Optional — Type: String[]  — Default value: [de.tudarmstadt.ukp.dkpro.core.api.lexmorph.type.(\\w+) → $1, de.tudarmstadt.ukp.dkpro.core.api.lexmorph.type.pos.(\\w+) → $1, de.tudarmstadt.ukp.dkpro.core.api.segmentation.type.(\\w+) → $1, de.tudarmstadt.ukp.dkpro.core.api.ner.type.(\\w+) → $1]

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

Type: Boolean  — Default value: false

Enable writing of features with null values.

Type: Boolean  — Default value: false

The brat web application can currently not handle attributes on relations, thus they are disabled by default. Here they can be enabled again.

Type: Boolean  — Default value: false

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

Optional — Type: String

Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data.

Optional — Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

Type: String[]

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

Optional — Type: String

Use this chunk tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

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 part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Use the String#intern() method on tags. This is usually a good idea to avoid spamming the heap with thousands of strings representing only a few different tags. Default: true

Optional — Type: Boolean  — Default value: true

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Write chunk information. Default: true

Type: Boolean  — Default value: true

Write part-of-speech information. Default: true

Type: Boolean  — Default value: true

Character encoding of the input data.

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

Type: String  — Default value: .conll

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

Type: Boolean  — Default value: false

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

Character encoding of the output data.

Type: String  — Default value: UTF-8

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

Optional — Type: String

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

Type: Boolean  — Default value: false

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

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

Optional — Type: String

Column separator parameter. Acceptable input values come from ColumnSeparators.
Example usage: if you want to define 'tab' as the column separator the following value should be input for this parameter Conll2002Reader.ColumnSeparators.TAB.getName()

Optional — Type: String  — Default value: space

Has embedded named entity extra column. Default: false

Optional — Type: Boolean  — Default value: false

Indicates that there is a header line before the sentence

Optional — Type: Boolean  — Default value: false

Token number flag. When true, the first column contains the token number inside the sentence (as in GermEval 2014 format)

Optional — Type: Boolean  — Default value: false

Include hidden files and directories.

Type: Boolean  — Default value: false

Use the String#intern() method on tags. This is usually a good idea to avoid spamming the heap with thousands of strings representing only a few different tags. Default: true

Optional — Type: Boolean  — Default value: true

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Read named entity information. Default: true

Type: Boolean  — Default value: true

Character encoding of the input data.

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

Type: String  — Default value: .conll

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

Type: Boolean  — Default value: false

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

Character encoding of the output data.

Type: String  — Default value: UTF-8

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

Optional — Type: String

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

Type: Boolean  — Default value: false

Type: Boolean  — Default value: true

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

Optional — Type: String

Use this chunk tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

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

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 part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Use the String#intern() method on tags. This is usually a good idea to avoid spamming the heap with thousands of strings representing only a few different tags. Default: true

Optional — Type: Boolean  — Default value: true

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Write chunk information. Default: true

Type: Boolean  — Default value: true

Read named entity information. Default: true

Type: Boolean  — Default value: true

Write part-of-speech information. Default: true

Type: Boolean  — Default value: true

Character encoding of the input data.

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

Type: String  — Default value: .conll

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

Type: Boolean  — Default value: false

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

Character encoding of the output data.

Type: String  — Default value: UTF-8

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

Optional — Type: String

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

Type: Boolean  — Default value: false

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

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

Optional — Type: String

Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Enable to use CPOS (column 4) as the part-of-speech tag. Otherwise the POS (column 3) is used.

Type: Boolean  — Default value: false

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

Type: String  — Default value: .conll

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

Type: Boolean  — Default value: false

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

Character encoding of the output data.

Type: String  — Default value: UTF-8

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

Optional — Type: String

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

Type: Boolean  — Default value: false

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

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

Optional — Type: String

Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

Type: String  — Default value: .conll

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

Type: Boolean  — Default value: false

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

Character encoding of the output data.

Type: String  — Default value: UTF-8

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

Optional — Type: String

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

Type: Boolean  — Default value: false

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

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

Optional — Type: String

Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

Type: String  — Default value: .conll

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

Type: Boolean  — Default value: false

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

Character encoding of the output data.

Type: String  — Default value: UTF-8

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

Optional — Type: String

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

Type: Boolean  — Default value: false

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

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

Optional — Type: String

Use this constituent tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

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 part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Use the String#intern() method on tags. This is usually a good idea to avoid spaming the heap with thousands of strings representing only a few different tags. Default: true

Optional — Type: Boolean  — Default value: true

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Disabled by default because CoNLL 2012 format does not include lemmata for all words, only for predicates.

Type: Boolean  — Default value: false

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

Use the document ID declared in the file header instead of using the filename.

Type: Boolean  — Default value: true

Optional — Type: Boolean  — Default value: false

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

Type: String  — Default value: .conll

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

Type: Boolean  — Default value: false

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

Character encoding of the output data.

Type: String  — Default value: UTF-8

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

Optional — Type: String

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

Type: Boolean  — Default value: false

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

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

Optional — Type: String

Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Type: Boolean  — Default value: false

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

Type: String  — Default value: .conll

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

Type: Boolean  — Default value: false

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

Character encoding of the output data.

Type: String  — Default value: UTF-8

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

Optional — Type: String

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

Type: Boolean  — Default value: false

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

Type: Boolean  — Default value: true

If set to true, the new corpus will be appended to an existing config file. If false, the existing file is overwritten. Default: true.

Type: Boolean  — Default value: true

If set, only documents with one of the listed collection IDs are written, all others are ignored. If this is empty (null), all documents are written.

Optional — Type: String[]

If true (default), only write documents with collection ids matching one of the collection values exactly. If false, write documents with collection ids containing any of the collection value string in collection while ignoring cases.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

The corpus name is used to name the corresponding sub-directory and will be set in the configuration file.

Type: String

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

Type: Boolean  — Default value: true

The maximum number of topic words to extract. Default: 15

Type: Integer  — Default value: 15

A Mallet file storing a serialized ParallelTopicModel.

Type: String

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

Type: Boolean  — Default value: false

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

Directory in which to store output files.

Type: String

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

Type: Boolean  — Default value: false

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Name of configuration parameter that contains the character encoding used by the input files.

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String

Specify which tag set should be used to locate the mapping file.

Optional — Type: String

If true, the unit IDs are used only to detect if a new document (CAS) needs to be created, but for the purpose of setting the document ID, a new ID is generated. (Default: false)

Type: Boolean  — Default value: false

If true, the unit text ID encoded in the corpus file is stored as the URI in the document meta data. This setting has is not affected by #PARAM_GENERATE_NEW_IDS (Default: false)

Type: Boolean  — Default value: false

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Read lemmas. Default: true

Type: Boolean  — Default value: true

Read part-of-speech tags and generate POS annotations or subclasses if a #PARAM_POS_TAG_SET tag set or #PARAM_POS_MAPPING_LOCATION mapping file is used. Default: true

Type: Boolean  — Default value: true

Read sentences. Default: true

Type: Boolean  — Default value: true

Read tokens and generate Token annotations. Default: true

Type: Boolean  — Default value: true

Replace non-XML characters with spaces. (Default: true)

Type: Boolean  — Default value: true

Character encoding of the output.

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

Write additional token-level annotation features. These have to be given as an array of fully qualified feature paths (fully.qualified.classname/featureName). The names for these annotations in CQP are their lowercase shortnames.

Optional — Type: String[]

The name of the generated corpus.

Type: String  — Default value: corpus

Set this parameter to compress the token streams and the indexes using cwb-huffcode and cwb-compress-rdx. With modern hardware, this may actually slow down queries, so we turn it off by default. If you have large data sets, you best try yourself what works best for you. (default: false)

Type: Boolean  — Default value: false

Set this parameter to the directory containing the cwb-encode and cwb-makeall commands if you want the write to directly encode into the CQP binary format.

Optional — Type: String

Make document IDs compatible with CQPweb. CQPweb demands an id consisting of only letters, numbers and underscore.

Type: Boolean  — Default value: false

Type: String  — Default value: s

Character encoding of the output data.

Type: String  — Default value: UTF-8

Location to which the output is written.

Type: String

Write coarse-grained part-of-speech tags. These are the simple names of the UIMA types used to represent the part-of-speech tag.

Type: Boolean  — Default value: false

Write the document ID for each token. It is usually a better idea to generate a #PARAM_WRITE_DOCUMENT_TAG document tag or a #PARAM_WRITE_TEXT_TAG text tag which also contain the document ID that can be queried in CQP.

Type: Boolean  — Default value: false

Write a pseudo-XML tag with the name document to mark the start and end of a document.

Type: Boolean  — Default value: false

Write lemmata.

Type: Boolean  — Default value: true

Write the start and end position of each token.

Type: Boolean  — Default value: false

Write part-of-speech tags.

Type: Boolean  — Default value: true

Write a pseudo-XML tag with the name text to mark the start and end of a document. This is used by CQPweb.

Type: Boolean  — Default value: true

Specifies the URL to the database.

If used with uimaFIT and the value is not given, jdbc:mysql://127.0.0.1/ will be taken.

Do not use this parameter to add additional parameters, but use #PARAM_CONNECTION_PARAMS instead.

Type: String  — Default value: jdbc:mysql://127.0.0.1/

Add additional parameters for the connection URL here in a single string: [&propertyName1=propertyValue1[&propertyName2=propertyValue2]...].

Type: String  — Default value: ``

Specifies name of the database to be accessed.

Type: String

Specify the class name of the JDBC driver.

If used with uimaFIT and the value is not given, com.mysql.cj.jdbc.Driver will be taken.

Type: String  — Default value: com.mysql.cj.jdbc.Driver

Specifies the language.

Optional — Type: String

Specifies the password for database access.

Type: String

Specifies the query.

Type: String

Specifies the user name for database access.

Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Name of configuration parameter that contains the character encoding used by the input files.

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

Specify the suffix of output files. Default value .json. If the suffix is not needed, provide an empty string as value.

Type: String  — Default value: .json

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

Type: Boolean  — Default value: false

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

Character encoding of the output data.

Type: String  — Default value: UTF-8

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

Optional — Type: String

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

Type: Boolean  — Default value: false

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

Type: Boolean  — Default value: false

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

Type: Boolean  — Default value: true

Specify the suffix of output files. Default value .lxf. If the suffix is not needed, provide an empty string as value.

Type: String  — Default value: .lxf

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

Type: Boolean  — Default value: false

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

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

Type: Boolean  — Default value: false

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

If #PARAM_SINGULAR_TARGET is set to false (default), this extension will be appended to the output files. Default: .topics.

Type: String  — Default value: .topics

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

Type: Boolean  — Default value: false

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

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

Type: Boolean  — Default value: false

If set to true (default), each output line is preceded by the document id.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

Type: Integer  — Default value: 3

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

Type: Boolean  — Default value: false

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

Type: String

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

Type: Boolean  — Default value: false

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

Optional — Type: String

Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

The collection ID to the written to the document meta data. (Default: none)

Optional — Type: String

What indicates if a new CAS should be started. E.g., if set to DocumentUnit#ORIGIN_NAME ORIGIN_NAME, a new CAS is generated whenever the origin name of the current sentence differs from the origin name of the last sentence. (Default: ORIGIN_NAME)

Type: String  — Default value: ORIGIN_NAME

If true, the unit IDs are used only to detect if a new document (CAS) needs to be created, but for the purpose of setting the document ID, a new ID is generated. (Default: false)

Type: Boolean  — Default value: false

The language.

Optional — Type: String

Write lemma information. Default: true

Type: Boolean  — Default value: true

Write part-of-speech information. Default: true

Type: Boolean  — Default value: true

Write Penn Treebank bracketed structure information. Mind this may not work with all tagsets, in particular not with such that contain "(" or ")" in their tags. The tree is generated using the original tag set in the corpus, not using the mapped tagset! Default: false

Type: Boolean  — Default value: false

Character encoding of the input data.

Type: String  — Default value: UTF-8

Location from which the input is read.

Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A number of documents which will be skipped at the beginning.

Optional — Type: Integer

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String

Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String  — Default value: NONE

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

Type: Boolean  — Default value: true

Specify the suffix of output files. Default value .ttl. The file format will be chosen depending on the file suffice.

Type: String  — Default value: .ttl

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

Type: Boolean  — Default value: false

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

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

Type: Boolean  — Default value: false

The last page to be extracted from the PDF.

Optional — Type: Integer  — Default value: -1

The type used to annotate headings.

Optional — Type: String  — Default value: <built-in>

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

The type used to annotate paragraphs.

Optional — Type: String  — Default value: <built-in>

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Location from which the input is read.

Optional — Type: String

The first page to be extracted from the PDF.

Optional — Type: Integer  — Default value: -1

The location of the substitution table use to post-process the text extracted form the PDF, e.g. to convert ligatures to separate characters.

Optional — Type: String  — Default value: <built-in>

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String

Use this part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

Write chunk annotations to the CAS.

Type: Boolean  — Default value: true

Write part-of-speech annotations to the CAS.

Type: Boolean  — Default value: true

Write sentence annotations to the CAS.

Type: Boolean  — Default value: true

Write token annotations to the CAS.

Type: Boolean  — Default value: true

Character encoding of the input data.

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

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

Optional — Type: String

Use this constituent tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

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 part-of-speech tag set to use to resolve the tag set mapping instead of using the tag set defined as part of the model meta data. This can be useful if a custom model is specified which does not have such meta data, or it can be used in readers.

Optional — Type: String

Include hidden files and directories.

Type: Boolean  — Default value: false

Use the String#intern() method on tags. This is usually a good idea to avoid spaming the heap with thousands of strings representing only a few different tags.

Default: true

Optional — Type: Boolean  — Default value: true

Name of optional configuration parameter that contains the language of the documents in the input directory. If specified, this information will be added to the CAS.

Optional — Type: String

The frequency with which read documents are logged. Default: 1 (log every document).

Set to 0 or negative values to deactivate logging.

Type: Integer  — Default value: 1

A set of Ant-like include/exclude patterns. A pattern starts with #INCLUDE_PREFIX [+] if it is an include pattern and with #EXCLUDE_PREFIX [-] if it is an exclude pattern. The wildcard /**/ can be used to address any number of sub-directories. The wildcard * can be used to a address a part of a name.

Optional — Type: String[]

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

Default: true

Type: Boolean  — Default value: true

Optional — Type: Boolean  — Default value: true

Name of configuration parameter that contains the character encoding used by the input files.

Type: String  — Default value: UTF-8

Location from which the input is read.

Optional — Type: String

Use the default excludes.

Type: Boolean  — Default value: true

Optional — Type: Boolean  — Default value: false

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

Optional — Type: String  — Default value: NONE

Type: Boolean  — Default value: false

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

Type: Boolean  — Default value: true

Specify the suffix of output files. Default value .mrg. If the suffix is not needed, provide an empty string as value.

Type: String  — Default value: .mrg

Type: Boolean  — Default value: false

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

Type: Boolean  — Default value: false

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

Character encoding of the output data.

Type: String  — Default value: UTF-8

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

Optional — Type: String

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

Type: Boolean  — Default value: false

Include hidden files and directories.

Type: Boolean  — Default value: false