Remediierungstool
Das remediate-Tool nimmt eines oder mehrere Barrierefreiheit-Probleme, die vom analyze- oder igt-Tool identifiziert wurden, und generiert kontextbezogene, KI-gestützte Leitlinien zur Behebung, die von Coding-Agenten in tatsächliche Codekorrekturen übersetzt werden können. Probleme werden als Batch übermittelt, sodass ein einzelner Aufruf Lösungen für jede auf einer Seite gefundene Verletzung liefern kann.
Funktionalität
- Authentifizierung - Validiert die Anmeldeinformationen des Benutzers — entweder einen API-Schlüssel oder ein OAuth 2.0-Zugriffstoken — um den autorisierten Zugriff sicherzustellen
- KI-Guthaben Nutzung - Jedes Problem im Batch verbraucht KI-Guthaben aus dem Kontingent Ihrer Organisation und ermöglicht die Nutzung fortgeschrittener KI-Modelle, die auf der umfangreichen Barrierefreiheitsexpertise von Deque basieren
- KI-generierte Remediation - Erstellt hochwertige, umsetzbare Barrierefreiheit-Korrekturen, die von Coding-Agenten interpretiert und im Quellcode implementiert werden können
Wenn die KI-Guthaben aufgebraucht sind, funktioniert das remediate-Tool nicht mehr, bis Ihre Guthaben wiederhergestellt sind (entweder durch Kauf weiterer Guthaben oder durch Zurücksetzen Ihres monatlichen Zyklus). Das analyze-Tool wird jedoch weiterhin funktionieren.
Batch-Remediation
Das Tool akzeptiert ein issues-Array. Übermitteln Sie alle die Probleme aus einem einzigen analyze- oder igt-Durchlauf gemeinsam in einem Aufruf, anstatt das Tool für jedes Problem einmal aufzurufen — ein Batch unterstützt zwischen 1 und 25 Problemen.
Jedes Problem hat die folgenden Felder:
| Feld | Erforderlich | Beschreibung |
|---|---|---|
id |
Ja | Eine vom Anrufer gewählte Kennung, die innerhalb des Batches eindeutig ist (z. B. die Regel-ID plus ein Zähler: color-contrast-0). Wird nur verwendet, um jedes Ergebnis mit seinem Eingabewert zu korrelieren. |
rule |
Ja | Die Axe-Regel-ID aus dem analyze/igt-Output (z. B. color-contrast, image-alt). |
elementHtml |
Ja | Das HTML-Snippet des verletzenden Elements. |
remediation |
Ja | Eine Beschreibung des Problems und was behoben werden muss, basierend auf der Zusammenfassung des Problems (optional ergänzt durch die Beschreibung, Hilfetext oder KI-Argumentation). |
pageUrl |
Nein | Die URL der Seite, die behoben wird, aus der analyze-Antwort. |
Fordern Sie Ihren KI-Agenten in natürlicher Sprache auf — er erstellt den Batch aus den Analyseergebnissen:
Analyze http://localhost:3000 and remediate every issue foundDer Agent löst die Aufforderung und ruft das remediate-Tool mit einer Nutzlast auf, die folgendermaßen aussieht:
{
"issues": [
{
"id": "color-contrast-0",
"rule": "color-contrast",
"elementHtml": "<span style=\"color: #aaa\">Sign up</span>",
"remediation": "Increase the contrast ratio to at least 4.5:1",
"pageUrl": "http://localhost:3000"
},
{
"id": "image-alt-1",
"rule": "image-alt",
"elementHtml": "<img src=\"logo.png\">",
"remediation": "Add alt text describing the image"
}
]
}Ausgabe
Das Tool gibt ein Array mit Ergebnissen pro Problem zurück, das durch id mit dem Eingabewert verknüpft ist. Ein Ergebnis hat eine von zwei Formen:
- Erfolg —
status: "ok"mit einemremediation-Objekt, das eine allgemeine Beschreibung, die Remediationsschritte und eine konkrete Codekorrektur enthält - Fehler —
status: "error"mit einemerror-Objekt (codeundmessage) für ein Problem, das nicht behoben werden konnte
{
"data": [
{
"id": "color-contrast-0",
"status": "ok",
"remediation": {
"general_description": "...",
"remediation": "...",
"code_fix": "<span style=\"color: #595959\">Sign up</span>"
}
},
{
"id": "image-alt-1",
"status": "error",
"error": { "code": "LLM_ERROR", "message": "..." }
}
]
}Ergebnisse sind unabhängig: Ein Fehler bei einem Problem blockiert nicht die Anleitung für die anderen.
Guthabenverwendung
Das remediate-Tool ist Teil des KI-Guthaben-Verwaltungssystem. Jedes Problem in einem Batch verbraucht Guthaben aus dem monatlichen Kontingent Ihrer Organisation. Administratoren können den Guthabenverbrauch im Axe-Kontoportal überwachen.