> ## Documentation Index
> Fetch the complete documentation index at: https://docs.devin.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Saída Estruturada

> Aprenda a usar saída estruturada com eficiência e interagir com sessões do Devin via API

> [!NOTE]
>
> Saída estruturada é como o bloco de notas do Devin — ele atualiza suas anotações enquanto trabalha, e você pode consultá-las a qualquer momento. No momento, você não pode forçar o Devin a atualizar essas anotações, mas pode solicitar para ver o que ele escreveu até agora.

> **Atualizações de Progresso**
>
> Receba atualizações sobre o progresso do Devin durante tarefas de longa duração

> **Integração com Aplicações**
>
> Encaminhe a análise e as saídas do Devin para suas aplicações usando JSON consistente.

## Solicitando saída estruturada

Para usar saída estruturada, inclua o schema JSON desejado no prompt ao [criar uma sessão](https://docs.devin.ai/pt-BR/api-reference/v1/sessions/create-a-new-devin-session.md).
Certifique-se de instruir o Devin a atualizar a saída estruturada sempre que algo relevante acontecer.

**Revisão de PR**

```json theme={null}
{
  "prompt": "Review this PR and provide updates in this format. Please update the structured output immediately whenever you find new issues, have suggestions, or change your approval status:\n{
    "issues": [
      {
        "file": "src/App.tsx",
        "line": 42,
        "type": "bug",
        "description": "Memory leak in useEffect cleanup"
      }
    ],
    "suggestions": [
      "Add error handling for API calls",
      "Split component into smaller parts"
    ],
    "approved": false
  }"
}
```

Formato simples para revisões de PR e análise de código.

**Atualizações de progresso**

```json theme={null}
{
  "prompt": "As you work, provide updates in this format. Please update the structured output immediately whenever you start a new task, complete a task, or plan your next task:\n{
    "status": "in_progress",
    "current_task": "Adding authentication to login page",
    "completed_tasks": [
      "Set up project structure",
      "Added routing"
    ],
    "next_task": "Implement form validation"
  }"
}
```

Acompanhe no que o Devin está trabalhando no momento e o que vem em seguida.

**Resultados de testes**

```json theme={null}
{
  "prompt": "When running tests, report results in this format. Please update the structured output immediately after each test run and whenever coverage changes:\n{
    "tests_passed": 25,
    "tests_failed": 2,
    "failing_tests": [
      {
        "name": "login_validation",
        "error": "Expected error message to be shown"
      }
    ],
    "coverage": 85
  }"
}
```

Visão geral simples dos resultados da execução de testes.

**Implementação de funcionalidade**

```json theme={null}
{
  "prompt": "Build a user settings page and track progress in this format. Please update the structured output immediately whenever you complete a requirement, create new files, identify review items, or change testing status:\n{
    "requirements_met": {
      "can_change_password": true,
      "can_update_email": false,
      "dark_mode_toggle": true
    },
    "files_created": [
      "UserSettings.tsx",
      "useUpdateProfile.ts"
    ],
    "needs_review": [
      "Email update flow needs security review"
    ],
    "ready_for_testing": false
  }"
}
```

Acompanhe a implementação da funcionalidade em relação a requisitos específicos.

## Recuperando saída estruturada

Use [este endpoint](https://docs.devin.ai/pt-BR/api-reference/v1/sessions/retrieve-details-about-an-existing-session.md) para obter a saída estruturada de uma sessão.
A saída estruturada é retornada no campo `structured_output`.

> [!TIP]
>
> Ao usar o aplicativo web do Devin, você pode visualizar rapidamente a saída estruturada a qualquer momento pressionando `⌘ + I` (Command+I).

## Boas práticas

* Inclua a definição completa do schema no prompt inicial
* Defina a frequência de atualização esperada (por exemplo: "Atualize a saída estruturada sempre que adicionar um novo componente ao site")
* Documente claramente os tipos e formatos de valores
* Use nomes de campos claros e descritivos para que Devin saiba o que escrever
* Inclua valores de exemplo no seu schema
* Use intervalos de polling de 10 a 30 segundos para evitar sobrecarregar a Devin API
* Pare o polling quando a sessão for concluída ou apresentar erro

> [!NOTE]
>
> Lembre-se de que Devin atualiza a saída estruturada no seu próprio ritmo — você não pode forçar uma atualização, mas pode pedir para ver as notas mais recentes a qualquer momento.

Em caso de dúvidas sobre o uso de saída estruturada ou para relatar problemas, envie um email para [support@cognition.ai](mailto:support@cognition.ai).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.