Gerador de JSON Schema para saída estruturada
Cole um JSON de exemplo, obtenha um JSON Schema e copie um pedido de API que faz o modelo devolver exatamente essa estrutura. Tudo funciona no seu navegador.
Cada propriedade é required, additionalProperties é false e os campos em falta em alguns elementos tornam-se nullable. A saída estruturada estrita espera exatamente isto.
O seu JSON é processado neste navegador e nunca é carregado.
Definições do pedido (modelo, prompt)
Modelo de exemplo. O suporte de json_schema varia consoante o modelo, por isso verifique a página do modelo antes de confiar nele.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "response",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"age": {
"type": "integer"
},
"email": {
"type": "string",
"format": "email"
},
"joined": {
"type": "string",
"format": "date-time"
},
"skills": {
"type": "array",
"items": {
"type": "string"
}
},
"address": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"zip": {
"type": "string"
}
},
"required": [
"city",
"zip"
],
"additionalProperties": false
}
},
"required": [
"name",
"age",
"email",
"joined",
"skills",
"address"
],
"additionalProperties": false
}Execute-o na HiAPI em três passos
- 01Crie uma conta gratuita
Registe-se com e-mail, Google ou GitHub. Leva cerca de um minuto.
Registar - 02Crie uma chave de API
Gere uma chave no painel e use-a em vez de YOUR_API_KEY.
Obter chave de API - 03Faça a sua primeira chamada
Execute o código gerado. O seu pedido aparece nos registos de utilização.
Como gerar um esquema para saída estruturada
- 01 Cole um JSON de exemplo
Use um exemplo real da saída pretendida, com valores representativos. Inclua vários itens no array para que os campos opcionais sejam detetados.
- 02 Revise o esquema
Verifique tipos e formatos e ajuste nomes. O modo estrito torna cada campo obrigatório, que é o que a saída estruturada estrita espera.
- 03 Copie a chamada de API
Escolha cURL, Python ou Node.js, adicione a sua chave e execute. O resultado é uma cadeia JSON em choices[0].message.content.
Perguntas frequentes do gerador de JSON Schema
O meu JSON é carregado para algum lado?
Não. O esquema e o código são gerados inteiramente no seu navegador. Nada é enviado para a HiAPI ou qualquer outro servidor.
O que muda o modo estrito?
Marca cada propriedade como required, define additionalProperties como false e transforma em tipos nullable os campos em falta em alguns itens do array. A saída estruturada estrita exige tudo isto.
Todos os modelos suportam json_schema?
Não. O suporte depende do modelo. O exemplo usa kimi-k3 com response_format.type definido como json_schema. Consulte a página do modelo para saber o que cada modelo aceita.
Como é deduzido o esquema a partir de um exemplo?
Os tipos vêm dos seus valores, inteiros e decimais são distinguidos, os arrays são fundidos entre itens e os formatos de cadeia são adicionados quando cada amostra corresponde. Um único exemplo não mostra enums nem limites de valores, por isso edite-os manualmente.
Onde está o resultado estruturado na resposta?
Em choices[0].message.content como cadeia JSON. Analise-a e valide os campos de negócio na sua aplicação.