Estructura del resultat
El resultat respon tres preguntes: quins valors s’han calculat, quins problemes s’han trobat i quina substitució o canvi es pot proposar per a cada aparició.
Una mètrica activa sempre s’avalua, però la sortida depèn del tipus: les mesures apareixen una vegada; les regles de suggeriment només apareixen quan troben coincidències.
result.measurements[]Mesures
Valors numèrics calculats. Cada entrada de result.measurements s'identifica per metric_id; value s'interpreta juntament amb unit i implementation_version.
Mètriques i regles →result.suggestions[]Regles de suggeriment
Problemes agrupats per regla. Cada element explica el problema i reuneix a occurrences totes les aparicions concretes al text.
Mètriques i regles →Estructura d’un suggeriment i els seus canvis
Una suggestion descriu el tipus de problema; cada occurrence indica on apareix i si arText disposa d’una substitució o edició concreta.
suggestions[].metric_idIdentificador estable de la regla. La seva definició es consulta a GET /v1/metrics.suggestions[].summaryExplicació del problema trobat en aquest informe.suggestions[].recommendations[]Orientació general per revisar el problema; no equival necessàriament a una substitució literal.suggestions[].examplesExemples redactats que il·lustren la recomanació, en text pla amb salts de línia significatius. Acompanyen la regla, no citen el text analitzat i no varien d'un informe a un altre. null quan la regla no té exemples.occurrences[].textFragment detectat per la mètrica.occurrences[].start / endRang sobre el text original mesurat en punts de codi Unicode; start és inclusiu i end exclusiu.occurrences[].replacementSubstitució textual preferida quan existeix. null significa que la regla no ofereix una substitució directa.occurrences[].alternatives[]Altres substitucions revisades, sense repetir replacement. Pot ser un array buit.occurrences[].edits[]Canvis segurs normalitzats com {start, end, text}. text buit elimina el rang i start igual a end insereix text.Una ocurrència continua sent un problema vàlid encara que replacement sigui null i edits estigui buit. En aquest cas cal mostrar l’explicació i deixar la revisió a la persona usuària; la integració no ha de fabricar cap canvi.
200 · Completat
{
"error": null,
"external_id": "document-123",
"position_in_queue": null,
"report_id": "rep_7f12a4c8",
"result": {
"genre": {
"domain": {
"name": "Llenguatge clar",
"slug": "llenguatge-clar"
},
"text_type": {
"name": "Text juridicoadministratiu dirigit a la ciutadania",
"slug": "text-juridic-administratiu-dirigit-a-la-ciutadania"
}
},
"language": "ca",
"measurements": [
{
"implementation_version": "1.0",
"metric_id": "word-count",
"unit": "words",
"value": 12
}
],
"offset_unit": "unicode_code_points",
"schema_version": "1.0",
"suggestions": [
{
"category": "lexical",
"explanation": null,
"id": "sug_1",
"implementation_version": "1.0",
"metric_id": "redundant-expressions",
"metric_title": "Eliminaci\u00f3 d\u2019expressions redundants",
"occurrences": [
{
"alternatives": [],
"edits": [
{
"end": 16,
"start": 0,
"text": ""
}
],
"end": 16,
"id": "occ_1",
"paragraph_index": 0,
"replacement": null,
"sentence_index": 0,
"start": 0,
"text": "En el dia d\u2019avui"
}
],
"recommendations": [
"Elimina l\u2019expressi\u00f3 si el context ho permet."
],
"severity": "warning",
"summary": "Conv\u00e9 formular el fragment d\u2019una manera m\u00e9s directa."
}
]
},
"status": "completed"
}