Suggestion rulesActive

Introduce acronyms

acronym-introduction

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

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 = "acronym-introduction"

Calculation method

Extracts uppercase candidates, ignores stopwords, keeps the first occurrence and searches immediately before or after it for an expanded form.

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

This is a review signal, not an automatic correction or a complete assessment of text quality.

Dependencies

language: en
implementation_version: 1.2

Valid example

{
  "category": "lexical",
  "examples": null,
  "explanation": null,
  "id": "sug_1",
  "implementation_version": "1.2",
  "metric_id": "acronym-introduction",
  "metric_title": "Introduce acronyms",
  "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/acronym-introduction

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

Open the JSON record