API Docs
EN
Concepts

Available metrics and rules

This catalog documents what arText calculates, how each result is interpreted and the limitations the integration must respect.

The catalog originates from the 21 plain-language recommendations of the arText claro system and currently comprises 25 suggestion rules, 22 of which form the plain-language set and 3 of which are used only by specialized genres. They are organized into the discourse, morphosyntactic and lexical levels, and each genre applies its own. Every report records the rules evaluated and their implementation version.

Metrics are not selected per request: POST /v1/reports snapshots the ones the requested genre (domain_slug + text_type_slug) enables for that language. GET /v1/metrics is the discovery and documentation catalog, and accepts the same pair to show what applies to each genre.

  1. 1

    The report is created with language, domain_slug and text_type_slug.

  2. 2

    The metric_id appears in measurements or suggestions.

  3. 3

    The metric page documents unit, output and limitations.

Categories

Document

5 metrics and rules

Readability

3 metrics and rules

Lexical

11 metrics and rules
Suggestion rules

Use acronyms consistently

acronym-consistency

Detects repeated use of an expanded term after its acronym has already been introduced.

Active
Suggestion rules

Introduce acronyms

acronym-introduction

Detects the first occurrence of uppercase acronyms that do not appear with an expanded form.

Active
Suggestion rules

Use of definitions

definition-usage

Compares the number of definition markers in the text with the genre's reference value.

Active
Suggestion rules

Replace difficult expressions

difficult-expressions

Finds difficult-to-understand expressions in the catalog and returns alternatives when available.

Active
Suggestion rules

Replace ambiguous words

imprecise-words

Finds imprecise words or sequences listed in the editable catalog and returns their alternatives.

Active
Suggestion rules

Review long words

long-words

Finds long words in the editorial catalog and proposes shorter alternatives when available.

Active
Suggestion rules

Lack of definitions

missing-definitions

Warns when the text contains no definition marker although the genre usually includes definitions.

Active
Suggestion rules

Remove redundant expressions

redundant-expressions

Finds catalogued redundant expressions so they can be removed or rephrased.

Active
Suggestion rules

Use of subjectivity markers

subjectivity-markers

Combines lexical items, sequences, morphological categories and exclamations to find possible subjectivity markers.

Active
Suggestion rules

Use more transparent terms

transparent-terms

Detects catalogued difficult terms and proposes more transparent wording.

Active
Suggestion rules

Review repeated words

word-repetition

Flags content words repeated in the text above the threshold configured for the genre.

Active

Syntax

7 metrics and rules

Discourse

8 metrics and rules