> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-sdk/caf-sdk-pt-br/web-javascript/getting-started/document-detector/sdk-builder-options/messages.md).

# Mensagens

Aqui está uma lista de todos os parâmetros aceitos no **mensagens** objeto presente nas opções do Document Detector.

**Aprimorado na v6.8.3:** A configuração de mensagens agora usa um formato de objeto aninhado para melhor organização e legibilidade.

{% hint style="warning" %}
O `mensagens` o objeto é opcional. Se você não o passar, o SDK usará as mensagens padrão com base no `language` parâmetro (os valores padrão listados abaixo são para o idioma inglês).
{% endhint %}

<table data-header-hidden><thead><tr><th width="468"></th><th></th></tr></thead><tbody><tr><td><strong>Parâmetro</strong></td><td><strong>Tipo</strong></td></tr><tr><td><p><strong><code>geral</code></strong></p><p>Personalização das mensagens gerais exibidas.</p></td><td><a href="#3az3ijcss0mo">Geral</a></td></tr><tr><td><p><strong><code>captura</code></strong></p><p>Personalização das mensagens exibidas (modos de captura "manual" e "automático").</p></td><td><a href="#zcoihs13yycj">Captura</a></td></tr><tr><td><p><strong><code>envio</code></strong></p><p>Personalização das mensagens exibidas (modo de captura "upload").</p></td><td><a href="#guau2es7dwb3">Envio</a></td></tr></tbody></table>

## Formato de configuração <a href="#configuration_format" id="configuration_format"></a>

As opções de mensagens usam um **formato de objeto aninhado** para melhor organização:

```javascript
messages: {
  general: {
    wait: "Por favor, aguarde...",
    errors: {
      poorQuality: "A qualidade da imagem está muito baixa. Tente novamente.",
      documentNotFound: "Documento não encontrado. Tente novamente.",
      invalidDocument: "Este documento não é válido.",
      generic: "Algo deu errado. Tente novamente."
    }
  },
  capture: {
    title: "Capture seu documento",
    errors: {
      captureFailed: "Captura falhou. Tente novamente."
    }
  },
  upload: {
    title: "Envie seu documento", // Observação: Para os lados frente/verso, isso se torna "Envie seu documento - Frente" ou "Envie seu documento - Verso"
    details: "Selecione um documento para enviar",
    button: "Enviar",
    success: "Documento enviado com sucesso!",
    errors: {
      generic: {
        title: "Falha no upload",
        details: "Tente novamente.",
        button: "Tentar novamente"
      },
      invalidFileFormat: {
        title: "Formato inválido",
        details: "Use os formatos JPG, PNG ou PDF."
      },
      invalidDocument: {
        title: "Documento inválido",
        details: "Este documento não é válido."
      }
    }
  }
}
```

{% hint style="info" %}
Se você estiver atualizando de uma versão anterior, suas configurações existentes com notação pontuada (por exemplo, `"general.wait": "Por favor, aguarde..."`) continuarão funcionando, mas recomendamos migrar para o formato de objeto aninhado mostrado acima.
{% endhint %}

## Geral <a href="#id-3az3ijcss0mo" id="id-3az3ijcss0mo"></a>

<table data-header-hidden><thead><tr><th width="468"></th><th></th><th></th></tr></thead><tbody><tr><td><strong>Parâmetro</strong></td><td><strong>Tipo</strong></td><td><strong>Valor Padrão</strong></td></tr><tr><td><p><strong><code>aguarde</code></strong></p><p>Mensagem de carregamento.</p><p><strong>Exemplo:</strong> <code>general: { wait: "Por favor, aguarde..." }</code></p></td><td>string</td><td><code>"Aguarde..."</code></td></tr><tr><td><p><strong><code>errors.poorQuality</code></strong></p><p>Mensagem exibida quando a imagem capturada tem baixa qualidade.</p><p><strong>Exemplo:</strong> <code>general: { errors: { poorQuality: "Qualidade muito baixa..." } }</code></p></td><td>string</td><td><code>"A qualidade da captura não foi boa. Certifique-se de estar em um ambiente bem iluminado e tente novamente."</code></td></tr><tr><td><p><strong><code>errors.documentNotFound</code></strong></p><p>Mensagem exibida quando o documento não é encontrado.</p><p><strong>Exemplo:</strong> <code>general: { errors: { documentNotFound: "Documento não encontrado..." } }</code></p></td><td>string</td><td><code>"Ops, parece que este documento não é compatível."</code></td></tr><tr><td><p><strong><code>errors.invalidDocument</code></strong></p><p>Mensagem exibida quando o documento não é compatível.</p><p>Exemplo: <code>"Ops, este documento não é "Frente do RG""</code></p><p><strong>Exemplo:</strong> <code>general: { errors: { invalidDocument: "Documento inválido..." } }</code></p></td><td>string</td><td><code>"Ops, este documento não é "${expectedDocumentLabel}""</code></td></tr><tr><td><p><strong><code>errors.generic</code></strong></p><p>Mensagem de erro genérica.</p><p><strong>Exemplo:</strong> <code>general: { errors: { generic: "Algo deu errado..." } }</code></p></td><td>string</td><td><code>"Ops, algo deu errado, tente novamente"</code></td></tr></tbody></table>

## Captura <a href="#zcoihs13yycj" id="zcoihs13yycj"></a>

<table data-header-hidden><thead><tr><th width="468"></th><th></th><th></th></tr></thead><tbody><tr><td><strong>Parâmetro</strong></td><td><strong>Tipo</strong></td><td><strong>Valor Padrão</strong></td></tr><tr><td><p><strong><code>título</code></strong></p><p>Título da captura.</p><p><strong>Exemplo:</strong> <code>capture: { title: "Capture seu documento" }</code></p></td><td>string</td><td>O rótulo do documento esperado (por exemplo, "Frente do RG")</td></tr><tr><td><p><strong><code>errors.captureFailed</code></strong></p><p>Mensagem exibida quando a captura falha.</p><p><strong>Exemplo:</strong> <code>capture: { errors: { captureFailed: "Captura falhou..." } }</code></p></td><td>string</td><td><code>"Ops! Tivemos um problema ao processar sua imagem."</code></td></tr></tbody></table>

## Envio <a href="#guau2es7dwb3" id="guau2es7dwb3"></a>

{% hint style="info" %}
**Comportamento importante para títulos de upload**: Quando o SDK é configurado para capturar lados específicos do documento (frente ou verso), ele adiciona automaticamente um sufixo de lado ao título do upload. Por exemplo, se você definir `upload.title` como "Envie seu documento", os títulos exibidos de fato serão:

* **Lado da frente**: "Envie seu documento - Frente"
* **Lado de trás**: "Envie seu documento - Verso"
* **Ambos os lados**: Usa seu título personalizado como está

Isso garante que os usuários sempre saibam qual lado do documento precisam enviar, mesmo com títulos personalizados.
{% endhint %}

<table data-header-hidden><thead><tr><th width="468"></th><th></th><th></th></tr></thead><tbody><tr><td><strong>Parâmetro</strong></td><td><strong>Tipo</strong></td><td><strong>Valor Padrão</strong></td></tr><tr><td><p><strong><code>título</code></strong></p><p>Personalização do título da tela de upload.</p><p><strong>Importante:</strong> Ao capturar lados específicos do documento (frente/verso), o SDK adiciona automaticamente o sufixo do lado ao seu título personalizado (por exemplo, "Seu título personalizado - Frente" ou "Seu título personalizado - Verso").</p><p><strong>Exemplo:</strong> <code>upload: { title: "Enviar documento" }</code></p></td><td>string</td><td><code>"Anexar documento"</code> (ou com sufixo de lado: <code>"Anexar documento - Frente"</code>, <code>"Anexar documento - Verso"</code>)</td></tr><tr><td><p><strong><code>detalhes</code></strong></p><p>Personalização da mensagem abaixo do título da tela de upload.</p><p><strong>Exemplo:</strong> <code>upload: { details: "Selecione um documento..." }</code></p></td><td>string</td><td><code>"Permita o acesso às suas fotos e anexe seu documento"</code></td></tr><tr><td><p><strong><code>botão</code></strong></p><p>Personalização do texto do botão de upload.</p><p><strong>Exemplo:</strong> <code>upload: { button: "Enviar" }</code></p></td><td>string</td><td><code>"Selecionar arquivo"</code></td></tr><tr><td><p><strong><code>sucesso</code></strong></p><p>Personalização do título exibido na tela quando o arquivo foi enviado com sucesso.</p><p><strong>Exemplo:</strong> <code>upload: { success: "Sucesso!" }</code></p></td><td>string</td><td><code>"Foto enviada com sucesso!"</code></td></tr><tr><td><p><strong><code>errors.generic.title</code></strong></p><p>Personalização do título exibido na tela quando ocorreu um erro genérico no processo de upload.</p><p><strong>Exemplo:</strong> <code>upload: { errors: { generic: { title: "Erro" } } }</code></p></td><td>string</td><td><code>"Erro ao enviar o arquivo"</code></td></tr><tr><td><p><strong><code>errors.generic.details</code></strong></p><p>Personalização da mensagem abaixo do título exibido na tela quando ocorreu um erro genérico no processo de upload.</p><p><strong>Exemplo:</strong> <code>upload: { errors: { generic: { details: "Tente novamente..." } } }</code></p></td><td>string</td><td><code>"Ops, algo deu errado ao enviar seu arquivo. Tente novamente."</code></td></tr><tr><td><p><strong><code>errors.generic.button</code></strong></p><p>Personalização do texto do botão para fazer o upload novamente.</p><p><strong>Exemplo:</strong> <code>upload: { errors: { generic: { button: "Tentar novamente" } } }</code></p></td><td>string</td><td><code>"Tente novamente"</code></td></tr><tr><td><p><strong><code>errors.invalidFileFormat.title</code></strong></p><p>Personalização do título exibido na tela quando ocorreu um erro no formato do arquivo enviado.</p><p><strong>Exemplo:</strong> <code>upload: { errors: { invalidFileFormat: { title: "Formato inválido" } } }</code></p></td><td>string</td><td><code>"Formato inválido"</code></td></tr><tr><td><p><strong><code>errors.invalidFileFormat.details</code></strong></p><p>Personalização da mensagem abaixo do título exibido na tela quando ocorreu um erro no formato do arquivo enviado.</p><p><strong>Exemplo:</strong> <code>upload: { errors: { invalidFileFormat: { details: "Use JPG, PNG ou PDF" } } }</code></p></td><td>string</td><td><code>"Parece que o formato da sua foto não é compatível. Tente enviar novamente nos formatos JPG, PNG ou PDF."</code></td></tr><tr><td><p><strong><code>errors.invalidDocument.title</code></strong></p><p>Personalização do título exibido na tela quando um documento inválido é enviado.</p><p><strong>Exemplo:</strong> <code>upload: { errors: { invalidDocument: { title: "Documento inválido" } } }</code></p></td><td>string</td><td><code>"Documento inválido"</code></td></tr><tr><td><p><strong><code>errors.invalidDocument.details</code></strong></p><p>Personalização da mensagem abaixo do título exibido na tela quando um documento inválido é enviado.</p><p><strong>Exemplo:</strong> <code>upload: { errors: { invalidDocument: { details: "Documento não válido..." } } }</code></p></td><td>string</td><td><code>"Ops, este documento não é ..."</code></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.caf.io/caf-sdk/caf-sdk-pt-br/web-javascript/getting-started/document-detector/sdk-builder-options/messages.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.