Regles de suggerimentActiva

Inclusió de llistes

list-usage

Avisa, amb una única ocurrència de document, quan no s'ha reconegut cap llista estructurada al text.

Ús d’aquesta mètrica

Si està activa i troba coincidències, l’informe conté una entrada amb aquest metric_id a result.suggestions. L’absència significa que no hi ha coincidències, no que la mètrica no s’hagi avaluat.

Ubicació al resultatresult.suggestions[]metric_id = "list-usage"

Mètode de càlcul

Retorna un únic suggeriment de document, sense posicions de text, quan has_list és fals; has_list s'obté del text i de l'HTML estructurat.

Interpretació del resultat

Cada element d'`occurrences` identifica un fragment afectat. `start` és inclusiu i `end` exclusiu, tots dos mesurats en punts de codi Unicode sobre el text enviat. `replacement`, `alternatives` i `edits` només contenen valors quan hi ha un canvi segur; l'absència del suggeriment significa que no hi ha coincidències, no que el text sigui necessàriament correcte.

Limitacions

Depèn de la segmentació del text pla i que els marcadors estructurals siguin recognoscibles; no implica per si sola un error de redacció.

Dependències

language: ca
implementation_version: 1.2

Exemple vàlid

{
  "category": "discourse",
  "examples": null,
  "explanation": null,
  "id": "sug_1",
  "implementation_version": "1.2",
  "metric_id": "list-usage",
  "metric_title": "Inclusi\u00f3 de llistes",
  "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/list-usage

Contracte complet de peticions, respostes i errors, generat automàticament des del codi.

Consultar la fitxa JSON