Ferramenta de Remediação
A ferramenta remediate toma um ou mais problemas de acessibilidade identificados pela ferramenta analyze ou igt e gera orientações de remediação com consciência de contexto e impulsionadas por IA, que agentes de codificação podem traduzir em correções reais de código. Os problemas são submetidos em lote, de modo que uma única chamada pode retornar correções para todas as violações encontradas em uma página.
O Que Ela Faz
- Autenticação - Valida as credenciais do usuário — seja uma chave de API ou um token de acesso OAuth 2.0 — para garantir o acesso autorizado
- Uso de Crédito de IA - Cada problema no lote consome créditos de IA da alocação de sua organização, permitindo o uso de modelos avançados de IA treinados na extensa expertise em acessibilidade da Deque
- Remediação Gerada por IA - Cria correções de acessibilidade de alta qualidade e acionáveis que agentes de codificação podem interpretar e implementar no código fonte
Se os créditos de IA se esgotarem, a ferramenta remediate deixará de funcionar até que seus créditos sejam restaurados (seja comprando mais ou quando seu ciclo mensal for reiniciado). No entanto, a ferramenta analyze continuará a funcionar.
Remediação em Lote
A ferramenta aceita um array issues. Submeta todos os problemas de uma única execução analyze ou igt juntos em uma única chamada, em vez de chamar a ferramenta uma vez por problema — um lote suporta entre 1 e 25 problemas.
Cada problema tem os seguintes campos:
| Campo | Obrigatório | Descrição |
|---|---|---|
id |
Sim | Um identificador escolhido pelo chamador, único dentro do lote (por exemplo, o ID da regra mais um contador: color-contrast-0). Usado apenas para correlacionar cada resultado com sua entrada. |
rule |
Sim | O ID da regra Axe a partir da saída analyze/igt (por exemplo, color-contrast, image-alt). |
elementHtml |
Sim | O fragmento HTML do elemento infrator. |
remediation |
Sim | Uma descrição do que está errado e o que precisa ser corrigido, tirada do resumo do problema (opcionalmente enriquecida com descrição, texto de ajuda ou raciocínio de IA). |
pageUrl |
Não | A URL da página que está sendo remediada, a partir da resposta analyze. |
Instrua seu agente de IA em linguagem natural — ele monta o lote a partir dos resultados da análise:
Analyze http://localhost:3000 and remediate every issue foundO agente resolve a instrução e chama a ferramenta remediate com um payload similar a:
{
"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"
}
]
}Saída
A ferramenta retorna um array de resultados por problema, cada um ligado de volta à sua entrada por id. Um resultado tem um de dois formatos:
- Sucesso —
status: "ok", com um objetoremediationcontendo uma descrição geral, os passos de remediação e uma correção de código concreta - Erro —
status: "error", com um objetoerror(codeemessage) para um problema que não pôde ser remediado
{
"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": "..." }
}
]
}Os resultados são independentes: uma falha em um problema não bloqueia orientações para os outros.
Uso de Créditos
A ferramenta remediate faz parte do Sistema de Gerenciamento de Créditos de IA. Cada problema em um lote consome créditos da alocação mensal da sua organização. Os administradores podem monitorar o uso de créditos através do Portal da Conta Axe.