Suggestion rulesActive

Use of definitions

definition-usage

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

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 = "definition-usage"

Calculation method

Counts the text's definition markers and compares them with the genre's reference value; a mode parameter decides whether the notice is raised for too many or too few. 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": "definition-usage",
  "metric_title": "Use of definitions",
  "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/definition-usage

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

Open the JSON record