API Proofreader

Publicado em: 4 de setembro de 2025

Explicação Web Extensões Status do Chrome Intenção
GitHub Teste de origem Teste de origem Teste de origem Teste de origem Ver Intenção de prototipar

A revisão é o processo de procurar e corrigir erros de gramática, ortografia e pontuação. Os navegadores e sistemas operacionais têm oferecido cada vez mais revisão de texto às ferramentas de escrita, como nos Documentos Google.

Com a API Proofreader, é possível oferecer revisão interativa ao seu aplicativo ou extensão da Web com IA integrada. Essa API oferece as seguintes funções:

  • Correção: corrija as entradas do usuário em relação a gramática, ortografia e pontuação.
  • Marcadores: marque cada correção pelo tipo de erro.
  • Explicação: defina o que é o erro ou por que a correção foi necessária em linguagem simples.

Casos de uso

Há muitos motivos para usar a API Proofreader. Por exemplo:

  • Sugerir correções para mensagens de fórum, comentários em artigos e e-mails antes do envio.
  • Ofereça correções durante a anotação ativa.

Seu caso de uso não está listado? Participe do programa de acesso antecipado para compartilhar seu feedback.

Primeiros passos

Participe do teste de origem da API Proofreader, que será executado no Chrome 141 a 145.

Revisar os requisitos de hardware

Os desenvolvedores e usuários que operam recursos usando essas APIs no Chrome precisam atender aos seguintes requisitos. Outros navegadores podem ter requisitos operacionais diferentes.

As APIs Language Detector e Translator funcionam no Chrome em computadores. Essas APIs não funcionam em dispositivos móveis. As APIs Prompt, Summarizer, Writer, Rewriter e Proofreader funcionam no Chrome quando as seguintes condições são atendidas:

  • Sistema operacional: Windows 10 ou 11; macOS 13 ou mais recente (Ventura e versões posteriores); Linux; ou ChromeOS (da plataforma 16389.0.0 em diante) em dispositivos Chromebook Plus. O Chrome para Android, iOS e ChromeOS em dispositivos que não são Chromebook Plus ainda não é compatível com as APIs que usam o Gemini Nano.
  • Armazenamento: pelo menos 22 GB de espaço livre no volume que contém seu perfil do Chrome.
  • GPU: mais de 4 GB de VRAM.
  • Rede: dados ilimitados ou uma conexão ilimitada.

O tamanho exato do Gemini Nano pode variar conforme o navegador atualiza o modelo. Para determinar o tamanho atual, acesse chrome://on-device-internals.

Adicionar suporte ao localhost

Para acessar a API Proofreader no localhost durante o teste de origem, atualize o Chrome para a versão mais recente. Em seguida, siga estas etapas:

  1. Acesse chrome://flags/#proofreader-api-for-gemini-nano.
  2. Selecione Ativado.
  3. Clique em Reiniciar ou reinicie o Chrome.

Inscrever-se no teste de origem

Para começar a usar a API Proofreader, siga estas etapas:

  1. Confirme a Política de uso proibido da IA generativa do Google.
  2. Acesse o teste de origem da API Proofreader.
  3. Clique em Registrar e preencha o formulário. No campo "Origem da Web", informe sua origem ou ID da extensão, chrome-extension://YOUR_EXTENSION_ID.
  4. Para enviar, clique em Registrar.
  5. Copie o token fornecido e adicione-o a todas as páginas da Web participantes na sua origem ou inclua-o no manifesto da extensão.
  6. Comece a usar a API Proofreader.

Saiba como começar a usar os testes de origem.

Usar a API Proofreader

Para determinar se o modelo está pronto para uso, chame Proofreader.availability(). Se a resposta a availability() for "downloadable", aguarde o progresso do download e informe o usuário, já que o download pode levar tempo.

const options = {
  expectedInputLanguages: ['en'],
};
const available = if (Proofreader.availability("downloadable") === true);

Para acionar o download e instanciar o revisor, verifique a ativação do usuário. Em seguida, chame a função assíncrona Proofreader.create().

const session = await Proofreader.create({
  monitor(m) {
    m.addEventListener('downloadprogress', (e) => {
      console.log(`Downloaded ${e.loaded * 100}%`);
    });
  },
  ...options,
});

Criar um objeto Proofreader

Para criar um revisor, use a função Proofreader.create().

const proofreader = await Proofreader.create({
  expectedInputLanguages: ["en"],
  monitor(m) {
    m.addEventListener("downloadprogress", e => {
      console.log(Downloaded ${e.loaded * 100}%);
    });
  }
};

O método create() inclui as seguintes opções:

  • expectedInputLanguages: uma matriz de idiomas de entrada esperados.

As opções includeCorrectionTypes e includeCorrectionExplanation do explicador não são compatíveis.

Começar a revisar o texto do usuário

Chame proofread() para receber correções de um texto de entrada:

const proofreadResult = await proofreader.proofread(
  'I seen him yesterday at the store, and he bought two loafs of bread.',
);

As correções são um tipo de ProofreadResult. Encontre a entrada totalmente corrigida no atributo corrected e a lista de correções na matriz corrections:

let inputRenderIndex = 0;

console.log(proofreadResult.correction);

for (const correction of proofreadResult.corrections) {
  // Render part of input that has no error.
  if (correction.startIndex > inputRenderIndex) {
    const unchangedInput = document.createElement('span');
    unchangedInput.textContent = input.substring(inputRenderIndex, correction.startIndex);
    editBox.append(unchangedInput);
  }
  // Render part of input that has an error and highlight as such.
  const errorInput = document.createElement('span');
  errorInput.textContent = input.substring(correction.startIndex, correction.endIndex);
  errorInput.classList.add('error');
  editBox.append(errorInput);
  inputRenderIndex = correction.endIndex;
}

// Render the rest of the input that has no error.
if (inputRenderIndex !== input.length){
  const unchangedInput = document.createElement('span');
  unchangedInput.textContent = input.substring(inputRenderIndex, input.length);
  editBox.append(unchangedInput);
}

Política de permissões, iframes e Web Workers

Por padrão, a API Proofreader está disponível apenas para janelas de nível superior e iframes de mesma origem. O acesso à API pode ser delegado a iframes de origem cruzada usando o atributo allow="" da política de permissões:

<!--
  The hosting site at https://main.example.com can grant a cross-origin iframe
  at https://cross-origin.example.com/ access to the Proofreader API by
  setting the `allow="proofreader"` attribute.
-->
<iframe src="https://cross-origin.example.com/" allow="proofreader"></iframe>

A API Proofreader não está disponível em Web Workers. Isso ocorre devido à complexidade de estabelecer um documento responsável para cada worker, a fim de verificar o status da política de permissões.

Demonstração

Teste o playground da API Proofreader.

Engajamento e como compartilhar feedback

A API Proofreader está em discussão e sujeita a mudanças no futuro. Se você testar essa API e tiver feedback, envie sua opinião.

Descubra todas as APIs de IA integradas que usam modelos, incluindo modelos de linguagem grandes, no navegador.