Typer som stöds och JSON-scheman
På denna sida
Byggstenarna i dina scheman
För att definiera strukturen på dina svar har du sju JSON-typer tillgängliga. Varje typ fyller ett specifikt behov när du modellerar din data. Att förstå dessa typer är avgörande för att designa effektiva scheman.
De sju typer som stöds
string
Den vanligaste typen. Används för namn, beskrivningar, identifierare och allt textinnehåll.
{
"type": "object",
"properties": {
"name": { "type": "string" },
"description": { "type": "string" }
}
}
number
Täcker både heltal och flyttal. Det görs ingen åtskillnad mellan integer och float – en enda typ, number, hanterar båda.
{
"properties": {
"price": { "type": "number" },
"quantity": { "type": "number" }
}
}
boolean
Sant eller falskt. Perfekt för flaggor, valideringar och binära beslut.
{
"properties": {
"in_stock": { "type": "boolean" },
"express_delivery": { "type": "boolean" }
}
}
object
Låter dig nästla strukturer. Ett objekt kan innehålla andra objekt, arrayer eller skalärer – utan någon begränsning för djupet.
{
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"street": { "type": "string" },
"city": { "type": "string" },
"postal_code": { "type": "string" }
}
}
}
}
array
Listor med element av samma typ. Du kan ha arrayer av strängar, tal, objekt eller till och med andra arrayer.
{
"properties": {
"skills": {
"type": "array",
"items": { "type": "string" }
}
}
}
enum
En ändlig mängd tillåtna värden. Avgörande för kategoriseringar och klassificeringar.
{
"properties": {
"priority": {
"type": "string",
"enum": ["low", "medium", "high", "critical"]
}
}
}
anyOf
Låter dig definiera typunioner. Ett fält kan acceptera flera olika strukturer. Användbart när ett enskilt fält kan anta varierande former.
{
"properties": {
"contact": {
"anyOf": [
{
"type": "object",
"properties": {
"email": { "type": "string" }
}
},
{
"type": "object",
"properties": {
"phone": { "type": "string" }
}
}
]
}
}
}
Kombinera typer
Styrkan hos scheman kommer från att kombinera dessa typer. Här är ett realistiskt schema för att analysera en produkt:
{
"type": "object",
"properties": {
"name": { "type": "string" },
"price": { "type": "number" },
"in_stock": { "type": "boolean" },
"category": {
"type": "string",
"enum": ["electronics", "clothing", "grocery", "other"]
},
"tags": {
"type": "array",
"items": { "type": "string" }
},
"manufacturer": {
"type": "object",
"properties": {
"name": { "type": "string" },
"country": { "type": "string" }
}
}
}
}
Detta schema blandar skalärer, en enum, en array och ett nästlat objekt. Modellen kommer att respektera varje begränsning vid varje anrop.
Valfria fält
För att göra ett fält valfritt använder du anyOf tillsammans med null:
{
"properties": {
"phone": {
"anyOf": [
{ "type": "string" },
{ "type": "null" }
]
}
}
}
I Pydantic motsvarar detta phone: str | None.
Viktiga punkter
- Sju tillgängliga typer:
string,number,object,array,boolean,enum,anyOf - Typer kan kombineras fritt för att modellera komplexa strukturer
- Valfria fält använder
anyOfmednull - Ingen åtskillnad mellan heltal och flyttal – en enda typ
numberhanterar båda enumtvingar fram fördefinierade värden för klassificeringar