/

Common types

This page documents the common types shared across Lingo4G stages and components.

threads

Type
one of [string, integer]

Specifies the number of processing threads in the context of various components and stages. Value must be one of the following:

"auto"

Lingo4G picks the number of processing threads automatically, depending on system configuration and thread availability. This is the recommended setting.

min-max

Lingo4G uses any number of threads between min and max (inclusive). The minimum must be larger than zero. This option gives Lingo4G some flexibility in picking the right number of threads dynamically, although auto is still the recommended mode.

For example, 2-4 causes Lingo4G to use 2, 3 or 4 processing threads.

number

Lingo4G uses a fixed number of threads. The number must be larger than zero.

For example, 8 causes Lingo4G to use exactly 8 threads.

limit

Type
one of [
"unlimited"
, integer]

Defines the limit on the number of results, such as labels or documents, produced by a stage. If you set limit to "unlimited", Lingo4G returns all available items.

sort​Order

Type
string
Constraints
one of [ASCENDING, DESCENDING, UNSPECIFIED]

Determines the sorting order for a list of documents or labels. The exact context of what is compared depends on the stage or component that makes use of this property.

A​S​C​E​N​D​I​N​G

Specifies an ascending order (increasing).

D​E​S​C​E​N​D​I​N​G

Specifies a descending order (decreasing).

U​N​S​P​E​C​I​F​I​E​D

Does not specify any sort order. The order can be arbitrary or even random. Use this setting when you know that the order of elements does not influence the results, and sorting would just add additional overhead.

weight​Aggregation

Type
string
Constraints
one of [MIN, MAX, COUNT, SUM, PRODUCT, MEAN, GEOMETRIC_MEAN]

Determines how to aggregate a set of document or label weights into one weight.

M​I​N

A minimum of all values.

M​A​X

A maximum of all values.

C​O​U​N​T

A count of values.

S​U​M

A sum of all values.

P​R​O​D​U​C​T

A product of all values (multiplication of all values).

M​E​A​N

An arithmetic mean of all values.

G​E​O​M​E​T​R​I​C_​M​E​A​N

A geometric mean of all values.