Suggestion rulesActive

Review long words

long-words

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

Usage of this metric

When enabled and matches are found, the report contains one item with this metric_id in result.suggestions. Absence means no match was found, not that the metric was not evaluated.

Location in the resultresult.suggestions[]metric_id = "long-words"

Calculation method

Normalizes token lemmas and matches complete sequences from the active catalog; returns the term, alternative and text offsets when available. Detection uses the active editorial catalog for the language.

Result interpretation

Each `occurrences` item identifies an affected span. `start` is inclusive and `end` exclusive, both measured in Unicode code points over the submitted text. `replacement`, `alternatives` and `edits` contain values only when a safe change is available. Absence means no match was found, not necessarily that the text is correct.

Limitations

Coverage depends on the active language catalog; every match still requires contextual review.

Dependencies

language: en
implementation_version: 1.2

Valid example

{
  "category": "lexical",
  "examples": null,
  "explanation": null,
  "id": "sug_1",
  "implementation_version": "1.2",
  "metric_id": "long-words",
  "metric_title": "Review long words",
  "occurrences": [
    {
      "alternatives": [],
      "edits": [],
      "end": 25,
      "id": "occ_1",
      "paragraph_index": 0,
      "replacement": null,
      "sentence_index": 0,
      "start": 18,
      "text": "example"
    }
  ],
  "recommendations": [
    "Review the detected fragment in context."
  ],
  "severity": "warning",
  "summary": "Example detection returned by this metric."
}

GET /v1/metrics/long-words

Complete request, response and error contracts, generated automatically from the code.

Open the JSON record