Palaikomi tipai ir JSON schemos
Šiame puslapyje
Tavo schemų statybiniai blokai
Norėdamas apibrėžti atsakymų struktūrą, turi septynis JSON tipus. Kiekvienas jų tenkina specifinį duomenų modeliavimo poreikį. Šių tipų supratimas yra būtinas kuriant efektyvias schemas.
Septyni palaikomi tipai
string (tekstas)
Dažniausiai naudojamas tipas. Skirtas vardams, aprašymams, identifikatoriams ir bet kokiam tekstiniam turiniui.
{
"type": "object",
"properties": {
"name": { "type": "string" },
"description": { "type": "string" }
}
}
number (skaičius)
Apima sveikuosius ir slankiojo kablelio skaičius. Nėra atskiro integer ir float skirtumo – vienetas number tipas tvarko abu.
{
"properties": {
"price": { "type": "number" },
"quantity": { "type": "number" }
}
}
boolean (loginė reikšmė)
„Tiesa“ arba „klaidinga“. Puikiai tinka žymoms, validavimui ir dvinariams sprendimams.
{
"properties": {
"in_stock": { "type": "boolean" },
"express_delivery": { "type": "boolean" }
}
}
object (objektas)
Leidžia kurti įdėtines struktūras. Objektas gali turėti kitų objektų, masyvų arba skaliarinių reikšmių – be gylio apribojimų.
{
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"street": { "type": "string" },
"city": { "type": "string" },
"postal_code": { "type": "string" }
}
}
}
}
array (masyvas)
To paties tipo elementų sąrašai. Gali turėti tekstų, skaičių, objektų ar net masyvų masyvus.
{
"properties": {
"skills": {
"type": "array",
"items": { "type": "string" }
}
}
}
enum (išvardijimas)
Baigtinis leistinų reikšmių rinkinys. Būtinas kategorizavimui ir klasifikavimui.
{
"properties": {
"priority": {
"type": "string",
"enum": ["low", "medium", "high", "critical"]
}
}
}
anyOf (bet kuris iš)
Leidžia apibrėžti tipų sąjungas. Laukas gali priimti kelias skirtingas struktūras. Naudinga, kai vienas laukas gali įgyti įvairias formas.
{
"properties": {
"contact": {
"anyOf": [
{
"type": "object",
"properties": {
"email": { "type": "string" }
}
},
{
"type": "object",
"properties": {
"phone": { "type": "string" }
}
}
]
}
}
}
Tipų derinimas
Schemų galia slypi šių tipų derinime. Štai reali schema produkto analizei:
{
"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" }
}
}
}
}
Ši schema maišo skaliarines reikšmes, išvardijimą, masyvą ir įdėtą objektą. Modelis laikysis kiekvieno apribojimo kiekvienu kvietimu.
Nebūtini laukai
Norėdamas padaryti lauką nebūtinu, naudok anyOf kartu su null:
{
"properties": {
"phone": {
"anyOf": [
{ "type": "string" },
{ "type": "null" }
]
}
}
}
Pydantic tai atitinka kaip phone: str | None.
Svarbiausi punktai
- Septyni galimi tipai:
string,number,object,array,boolean,enum,anyOf - Tipai laisvai derinami sudėtingoms struktūroms modeliuoti
- Nebūtini laukai naudoja
anyOfsunull - Nėra skirtumo tarp sveikųjų ir slankiojo kablelio skaičių – vienetas
numbertipas enumpriverčia naudoti iš anksto apibrėžtas reikšmes klasifikavimui