Saídas estruturadas

As saídas estruturadas restringem as respostas do Claude para seguir um esquema específico, garantindo uma saída válida e analisável para processamento posterior. As saídas estruturadas fornecem dois recursos complementares:

• Saídas JSON (output_config.format): Obtenha a resposta do Claude em um formato JSON específico
• Uso estrito de ferramentas (strict: true): Garanta a validação de esquema em nomes e entradas de ferramentas

Você pode usar esses recursos de forma independente ou em conjunto na mesma requisição.



Por que usar saídas estruturadas

Sem saídas estruturadas, o Claude pode gerar respostas JSON malformadas ou entradas de ferramentas inválidas que quebram suas aplicações. Mesmo com prompts cuidadosos, você pode encontrar:

• Erros de análise devido a sintaxe JSON inválida
• Campos obrigatórios ausentes
• Tipos de dados inconsistentes
• Violações de esquema que exigem tratamento de erros e novas tentativas

As saídas estruturadas garantem respostas em conformidade com o esquema por meio de decodificação restrita:

• Sempre válidas: Chega de erros de JSON.parse()
• Tipagem segura: Tipos de campos e campos obrigatórios garantidos
• Confiáveis: Não são necessárias novas tentativas por violações de esquema



Saídas JSON

As saídas JSON controlam o formato de resposta do Claude, garantindo que o Claude retorne JSON válido correspondente ao seu esquema. Use saídas JSON quando precisar:

• Controlar o formato de resposta do Claude
• Extrair dados de imagens ou texto
• Gerar relatórios estruturados
• Formatar respostas de API



Início rápido

Formato de resposta: JSON válido correspondente ao seu esquema em response.content[0].text

{
  "name": "John Smith",
  "email": "[email protected]",
  "plan_interest": "Enterprise",
  "demo_requested": true
}



Como funciona



Trabalhando com saídas JSON nos SDKs

Os SDKs fornecem auxiliares que facilitam o trabalho com saídas JSON, incluindo transformação de esquema, validação automática e integração com bibliotecas de esquema populares.



Usando definições de esquema nativas

Em vez de escrever esquemas JSON brutos, você pode usar ferramentas de definição de esquema familiares na sua linguagem:

• Python: Modelos Pydantic com client.messages.parse()
• TypeScript: Esquemas Zod com zodOutputFormat() ou literais de JSON Schema tipados com jsonSchemaOutputFormat()
• Java: Classes Java simples com derivação automática de esquema através de outputConfig(Class<T>)
• Ruby: Classes Anthropic::BaseModel com output_config: {format: Model}
• PHP: Classes implementando StructuredOutputModel com outputConfig: ['format' => MyClass::class]
• C#: Classes C# simples com a sobrecarga genérica , que deriva o esquema automaticamente



Métodos específicos do SDK

Cada SDK fornece auxiliares que facilitam o trabalho com saídas estruturadas. Consulte as páginas individuais de cada SDK para obter detalhes completos.



Como funciona a transformação do SDK

Os SDKs Python, TypeScript, Ruby e PHP transformam automaticamente esquemas com recursos não suportados. Os SDKs C# e Go aplicam as mesmas transformações quando o esquema é derivado de um tipo nativo (Create<T>() em C#; reflexão de struct ou BetaJSONSchemaOutputFormat() na API beta do Go). As etapas de transformação:

1. Remover restrições não suportadas (por exemplo, minimum, maximum, minLength, maxLength)
2. Atualizar descrições com informações de restrição (por exemplo, "Must be at least 100"), quando a restrição não é diretamente suportada com saídas estruturadas
3. Adicionar additionalProperties: false a todos os objetos
4. Filtrar formatos de string apenas para a lista suportada
5. Validar respostas contra seu esquema original (com todas as restrições)

Isso significa que o Claude recebe um esquema simplificado, mas seu código ainda aplica todas as restrições por meio de validação.

Exemplo: Um campo Pydantic com minimum: 100 torna-se um inteiro simples no esquema enviado, mas o SDK atualiza a descrição para "Must be at least 100" e valida a resposta contra a restrição original.



Casos de uso comuns



Uso estrito de ferramentas

Para aplicar conformidade com JSON Schema em entradas de ferramentas com amostragem restrita por gramática, consulte Uso estrito de ferramentas.



Usando ambos os recursos juntos

As saídas JSON e o uso estrito de ferramentas resolvem problemas diferentes e funcionam juntos:

• Saídas JSON controlam o formato de resposta do Claude (o que o Claude diz)
• Uso estrito de ferramentas valida parâmetros de ferramentas (como o Claude chama suas funções)

Quando combinados, o Claude pode chamar ferramentas com parâmetros garantidamente válidos E retornar respostas JSON estruturadas. Isso é útil para fluxos de trabalho agênticos onde você precisa tanto de chamadas de ferramentas confiáveis quanto de saídas finais estruturadas.



Considerações importantes



Compilação e cache de gramática

As saídas estruturadas usam amostragem restrita com artefatos de gramática compilados. Isso introduz algumas características de desempenho a serem observadas:

• Latência da primeira requisição: Na primeira vez que você usa um esquema específico, há latência adicional enquanto a gramática é compilada
• Cache automático: Gramáticas compiladas são armazenadas em cache por 24 horas a partir do último uso, tornando as requisições subsequentes muito mais rápidas
• Invalidação de cache: O cache é invalidado se você alterar:
  • A estrutura do esquema JSON
  • O conjunto de ferramentas na sua requisição (ao usar saídas estruturadas e uso de ferramentas juntos)
  • Alterar apenas os campos name ou description não invalida o cache



Modificação de prompt e custos de token

Ao usar saídas estruturadas, o Claude recebe automaticamente um prompt do sistema adicional explicando o formato de saída esperado. Isso significa que:

• Sua contagem de tokens de entrada é ligeiramente maior
• O prompt injetado custa tokens como qualquer outro prompt do sistema
• Alterar o parâmetro output_config.format invalidará qualquer cache de prompt para aquele thread de conversa



Limitações do JSON Schema

As saídas estruturadas suportam JSON Schema padrão com algumas limitações. Tanto as saídas JSON quanto o uso estrito de ferramentas compartilham essas limitações.



Ordenação de propriedades

Ao usar saídas estruturadas, as propriedades em objetos mantêm sua ordenação definida no seu esquema, com uma ressalva importante: propriedades obrigatórias aparecem primeiro, seguidas por propriedades opcionais.

Por exemplo, dado este esquema:

{
  "type": "object",
  "properties": {
    "notes": { "type": "string" },
    "name": { "type": "string" },
    "email": { "type": "string" },
    "age": { "type": "integer" }
  },
  "required": ["name", "email"],
  "additionalProperties": false
}

A saída ordenará as propriedades como:

1. name (obrigatória, na ordem do esquema)
2. email (obrigatória, na ordem do esquema)
3. notes (opcional, na ordem do esquema)
4. age (opcional, na ordem do esquema)

Isso significa que a saída pode ser assim:

{
  "name": "John Smith",
  "email": "[email protected]",
  "notes": "Interested in enterprise plan",
  "age": 35
}

Se a ordem das propriedades na saída for importante para sua aplicação, marque todas as propriedades como obrigatórias ou leve em conta essa reordenação na sua lógica de análise.



Saídas inválidas

Embora as saídas estruturadas garantam conformidade com o esquema na maioria dos casos, há cenários em que a saída pode não corresponder ao seu esquema:

Recusas (stop_reason: "refusal")

O Claude mantém suas propriedades de segurança e utilidade mesmo ao usar saídas estruturadas. Se o Claude recusar uma requisição por motivos de segurança:

• A resposta tem stop_reason: "refusal"
• Você receberá um código de status 200
• Você será cobrado pelos tokens gerados
• A saída pode não corresponder ao seu esquema porque a mensagem de recusa tem precedência sobre as restrições do esquema

Limite de tokens atingido (stop_reason: "max_tokens")

Se a resposta for cortada devido ao atingimento do limite de max_tokens:

• A resposta tem stop_reason: "max_tokens"
• A saída pode estar incompleta e não corresponder ao seu esquema
• Tente novamente com um valor de max_tokens mais alto para obter a saída estruturada completa



Limites de complexidade de esquema

As saídas estruturadas funcionam compilando seus esquemas JSON em uma gramática que restringe a saída do Claude. Esquemas mais complexos produzem gramáticas maiores que levam mais tempo para compilar. Para proteger contra tempos de compilação excessivos, a API impõe vários limites de complexidade.



Limites explícitos

Os seguintes limites se aplicam a todas as requisições com output_config.format ou strict: true:



Limites internos adicionais

Além dos limites explícitos na tabela anterior, há limites internos adicionais no tamanho da gramática compilada. Esses limites existem porque a complexidade do esquema não se reduz a uma única dimensão: recursos como parâmetros opcionais, tipos de união, objetos aninhados e número de ferramentas interagem entre si de maneiras que podem tornar a gramática compilada desproporcionalmente grande.

Quando esses limites são excedidos, você receberá um erro 400 com a mensagem "Schema is too complex for compilation." Esses erros significam que a complexidade combinada dos seus esquemas excede o que pode ser compilado de forma eficiente, mesmo que cada limite individual na tabela anterior seja satisfeito. Como última salvaguarda, a API também impõe um tempo limite de compilação de 180 segundos. Esquemas que passam em todas as verificações explícitas, mas produzem gramáticas compiladas muito grandes, podem atingir esse tempo limite.



Dicas para reduzir a complexidade do esquema

Se você estiver atingindo limites de complexidade, tente estas estratégias em ordem:

1. Marque apenas ferramentas críticas como estritas. Se você tiver muitas ferramentas, reserve isso para ferramentas onde violações de esquema causam problemas reais e confie na aderência natural do Claude para ferramentas mais simples.

2. Reduza parâmetros opcionais. Torne os parâmetros required sempre que possível. Cada parâmetro opcional aproximadamente dobra uma parte do espaço de estados da gramática. Se um parâmetro sempre tem um padrão razoável, considere torná-lo obrigatório e fazer com que o Claude forneça esse padrão explicitamente.

3. Simplifique estruturas aninhadas. Objetos profundamente aninhados com campos opcionais aumentam a complexidade. Achate as estruturas sempre que possível.

4. Divida em múltiplas requisições. Se você tiver muitas ferramentas estritas, considere dividi-las em requisições separadas ou subagentes.

Para problemas persistentes com esquemas válidos, entre em contato com o suporte com sua definição de esquema.



Retenção de dados

Prompts e respostas são processados com ZDR ao usar saídas estruturadas. No entanto, o próprio esquema JSON é temporariamente armazenado em cache por até 24 horas desde o último uso para fins de otimização. Nenhum dado de prompt ou resposta é retido além da resposta da API.

As saídas estruturadas são elegíveis para HIPAA, mas PHI não deve ser incluído em definições de esquema JSON. A API compila esquemas JSON em gramáticas que são armazenadas em cache separadamente do conteúdo da mensagem, e esses esquemas em cache não recebem as mesmas proteções de PHI que prompts e respostas. Não inclua PHI em nomes de propriedades de esquema, valores enum, valores const ou expressões regulares pattern. PHI deve aparecer apenas no conteúdo da mensagem (prompts e respostas), onde é protegido sob as salvaguardas da HIPAA.

Para elegibilidade de ZDR e HIPAA em todos os recursos, consulte API e retenção de dados.



Compatibilidade de recursos

Funciona com:

• Processamento em lote: Processe saídas estruturadas em escala com 50% de desconto
• Contagem de tokens: Conte tokens sem compilação
• Streaming: Faça streaming de saídas estruturadas como respostas normais
• Uso combinado: Use saídas JSON (output_config.format) e uso estrito de ferramentas (strict: true) juntos na mesma requisição

Incompatível com:

• Citações: Citações exigem intercalar blocos de citação com texto, o que conflita com restrições estritas de esquema JSON. Retorna erro 400 se citações estiverem habilitadas com output_config.format.
• Pré-preenchimento de mensagem: Incompatível com saídas JSON