Поддържани типове и JSON схеми
На тази страница
Основните градивни елементи на Вашите схеми
За да дефинирате структурата на Вашите отговори, разполагате със седем JSON типа. Всеки от тях служи за конкретна нужда при моделирането на данните. Разбирането на тези типове е от съществено значение за проектирането на ефективни схеми.
Седемте поддържани типа
string
Най-често използваният тип. Използва се за имена, описания, идентификатори и всякакво текстово съдържание.
{
"type": "object",
"properties": {
"name": { "type": "string" },
"description": { "type": "string" }
}
}
number
Обхваща цели числа и числа с плаваща запетая. Няма разлика между integer и float — единният тип number обработва и двете.
{
"properties": {
"price": { "type": "number" },
"quantity": { "type": "number" }
}
}
boolean
Истина или лъжа. Идеален за флагове, валидации и бинарни решения.
{
"properties": {
"in_stock": { "type": "boolean" },
"express_delivery": { "type": "boolean" }
}
}
object
Позволява ви да влагате структури. Един обект може да съдържа други обекти, масиви или скаларни стойности — без ограничение за дълбочина.
{
"type": "object",
"properties": {
"address": {
"type": "object",
"properties": {
"street": { "type": "string" },
"city": { "type": "string" },
"postal_code": { "type": "string" }
}
}
}
}
array
Списъци от елементи от един и същи тип. Можете да имате масиви от низове, числа, обекти или дори масиви.
{
"properties": {
"skills": {
"type": "array",
"items": { "type": "string" }
}
}
}
enum
Краен набор от позволени стойности. Съществен за категоризации и класификации.
{
"properties": {
"priority": {
"type": "string",
"enum": ["low", "medium", "high", "critical"]
}
}
}
anyOf
Позволява ви да дефинирате обединения от типове. Дадено поле може да приема няколко различни структури. Полезно е, когато едно поле може да приема различни форми.
{
"properties": {
"contact": {
"anyOf": [
{
"type": "object",
"properties": {
"email": { "type": "string" }
}
},
{
"type": "object",
"properties": {
"phone": { "type": "string" }
}
}
]
}
}
}
Комбиниране на типове
Силата на схемите идва от комбинирането на тези типове. Ето една реалистична схема за анализ на продукт:
{
"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" }
}
}
}
}
Тази схема смесва скаларни стойности, enum, масив и влаган обект. Моделът ще спазва всяко ограничение при всяко извикване.
Незадължителни полета
За да направите едно поле незадължително, използвайте anyOf с null:
{
"properties": {
"phone": {
"anyOf": [
{ "type": "string" },
{ "type": "null" }
]
}
}
}
В Pydantic това съответства на phone: str | None.
Ключови изводи
- Седем налични типа:
string,number,object,array,boolean,enum,anyOf - Типовете се комбинират свободно за моделиране на сложни структури
- Незадължителните полета използват
anyOfсnull - Няма разлика между цяло число и число с плаваща запетая — единният тип
number enumналага предварително дефинирани стойности за класификации