Przejdź do głównej treści
Polski— Wybierz język
Menu

Schematy JSON i walidacja

Lekcja 2 z 20 Programista
Na tej stronie
  1. Schematy JSON i walidacja
  2. Struktura schematu funkcji
  3. Tryb ścisły (Strict Mode)
  4. Walidacja po stronie klienta
  5. Skuteczne opisy
  6. Zagnieżdżone schematy i referencje
  7. Kluczowe wnioski

Schematy JSON i walidacja

Schemat funkcji to nie tylko rura do walidacji: to jedyna umowa między modelem a Twoim kodem. Nie ma innego kanału komunikacji. Model nie czyta Twojej implementacji, nie zna Twoich wewnętrznych konwencji i nie domyśli się, że pole date oczekuje formatu ISO, a nie francuskiego.

Wszystko, czego nie zapiszesz w schemacie, zostanie ustalone przez losowe wnioski modelu. To wyjaśnia zalecaną w tej lekcji dysproporcję wysiłku: lepiej spędzić dziesięć minut na schemacie niż dwie godziny na debugowaniu niestabilnych argumentów.

Struktura schematu funkcji

Każda funkcja zadeklarowana w tools遵循 formatu JSON Schema. Oto pełna struktura:

tool_definition = {
    "type": "function",
    "name": "creer_facture",
    "description": "Create an invoice for an existing customer",
    "parameters": {
        "type": "object",
        "properties": {
            "client_id": {
                "type": "string",
                "description": "Unique customer identifier (format: CLI-XXXXX)"
            },
            "lignes": {
                "type": "array",
                "description": "List of billing line items",
                "items": {
                    "type": "object",
                    "properties": {
                        "description": {
                            "type": "string",
                            "description": "Product or service description"
                        },
                        "quantite": {
                            "type": "integer",
                            "minimum": 1,
                            "description": "Number of units"
                        },
                        "prix_unitaire": {
                            "type": "number",
                            "minimum": 0,
                            "description": "Unit price excluding tax in euros"
                        }
                    },
                    "required": ["description", "quantite", "prix_unitaire"]
                }
            },
            "devise": {
                "type": "string",
                "enum": ["EUR", "USD", "GBP"],
                "default": "EUR"
            },
            "echeance_jours": {
                "type": "integer",
                "enum": [30, 45, 60, 90],
                "description": "Payment deadline in days"
            }
        },
        "required": ["client_id", "lignes"],
        "additionalProperties": False
    },
    "strict": True
}

Tryb ścisły (Strict Mode)

Tryb ścisły zamienia prawdopodobieństwo w gwarancję. Bez niego model zazwyczaj generuje zgodne argumenty – ale wyjątki odkrywasz dopiero w produkcji, przy przypadkach brzegowych. Dzięki niemu zgodność jest zapewniona już na poziomie dekodowania. Włączaj go domyślnie: ograniczenia, które narzuca (szczegóły poniżej), to niewielka cena za wyeliminowanie całej klasy błędów.

tools = [{
    "type": "function",
    "name": "enregistrer_commande",
    "description": "Record a new order",
    "parameters": {
        "type": "object",
        "properties": {
            "produit": {"type": "string"},
            "quantite": {"type": "integer"},
            "urgent": {"type": "boolean"}
        },
        "required": ["produit", "quantite", "urgent"],
        "additionalProperties": False
    },
    "strict": True
}]

Ograniczenia trybu ścisłego

W trybie ścisłym obowiązują pewne zasady:

  • Wszystkie pola muszą znajdować się w required
  • additionalProperties musi mieć wartość false
  • Typy opcjonalne używają anyOf z null
  • Brak pattern, minLength, maxLength na najwyższym poziomie
# Pole opcjonalne w trybie ścisłym
"commentaire": {
    "anyOf": [
        {"type": "string"},
        {"type": "null"}
    ],
    "description": "Optional free-text comment"
}

Walidacja po stronie klienta

Tryb ścisły gwarantuje formę, nigdy znaczenie. Poprawnie sformatowana data może być w przeszłości, poprawny typ identyfikatora może nie odpowiadać żadnemu klientowi, a validna kwota może przekraczać dozwolony limit. Te reguły to logika biznesowa: żaden schemat JSON ich nie wyrazi, więc musisz je zweryfikować w swoim kodzie – a w przypadku odrzucenia wysłać modelowi komunikat błędu wyjaśniający, co poszło nie tak.

import json
from jsonschema import validate, ValidationError

SCHEMA_FACTURE = {
    "type": "object",
    "properties": {
        "client_id": {"type": "string", "pattern": "^CLI-[0-9]{5}$"},
        "lignes": {
            "type": "array",
            "minItems": 1,
            "items": {
                "type": "object",
                "properties": {
                    "description": {"type": "string", "minLength": 1},
                    "quantite": {"type": "integer", "minimum": 1},
                    "prix_unitaire": {"type": "number", "minimum": 0}
                },
                "required": ["description", "quantite", "prix_unitaire"]
            }
        }
    },
    "required": ["client_id", "lignes"]
}

def executer_fonction(name: str, arguments: str) -> str:
    args = json.loads(arguments)

    try:
        validate(instance=args, schema=SCHEMA_FACTURE)
    except ValidationError as e:
        return json.dumps({"error": f"Invalid arguments: {e.message}"})

    # Logika biznesowa po walidacji
    return creer_facture(**args)

Skuteczne opisy

Pisz opis funkcji jak instrukcję dla nowego współpracownika: kiedy ją wywołać, a zwłaszcza kiedy jej nie wywoływać. To właśnie tę drugą część systematycznie pomijamy, a rozwiązuje ona większość błędnych wywołań – „nie używaj do zamówień zarchiwizowanych“ zapobiega niepotrzebnemu okrążeniu, którego nie zatrzymałyby trzy zdania opisu pozytywnego.

# Źle: zbyt ogólnie
{
    "name": "get_data",
    "description": "Retrieve data"
}

# Dobrze: konkretnie i z kontekstem
{
    "name": "rechercher_produits_catalogue",
    "description": "Search for products in the e-commerce catalog. "
                   "Returns name, price, stock, and category. "
                   "Use for questions about availability or pricing."
}

Opisy parametrów

Na poziomie parametrów wrogiem jest domysł. Jednostka (euro czy centy?), format (ISO czy lokalny?), konwencja (ID wewnętrzne czy referencja klienta?), których nie zapiszesz, zostaną odgadnięte – czasem poprawnie, czasem nie, bez żadnego sygnału w jedną czy drugą stronę. enum to Twoje najlepsze narzędzie: nie opisuje oczekiwanej wartości, lecz ją ogranicza.

"properties": {
    "date_debut": {
        "type": "string",
        "description": "Start date in ISO 8601 format (YYYY-MM-DD). "
                       "Defaults to today's date if not specified."
    },
    "statut": {
        "type": "string",
        "enum": ["actif", "inactif", "suspendu"],
        "description": "Filter by account status. "
                       "'actif' = accounts in service, "
                       "'suspendu' = temporarily frozen accounts."
    }
}

Zagnieżdżone schematy i referencje

Głęboko zagnieżdżony schemat jest trudny do ponownego przeczytania dla Ciebie i do poprawnego wypełnienia dla modelu. Jeśli dochodzisz do trzech poziomów, pytanie nie brzmi „jak to lepiej zapisać“, ale „czy ta funkcja nie robi za dużo“: dwie funkcje o jasnym zakresie są prawie zawsze lepsze niż jedna konfigurowalna funkcja obsługująca oba przypadki.

adresse_schema = {
    "type": "object",
    "properties": {
        "rue": {"type": "string"},
        "code_postal": {"type": "string"},
        "ville": {"type": "string"},
        "pays": {"type": "string", "enum": ["FR", "BE", "CH", "LU"]}
    },
    "required": ["rue", "code_postal", "ville", "pays"]
}

tools = [{
    "type": "function",
    "name": "creer_livraison",
    "description": "Create a delivery with shipping and destination addresses",
    "parameters": {
        "type": "object",
        "properties": {
            "expedition": adresse_schema,
            "destination": adresse_schema,
            "poids_kg": {"type": "number", "minimum": 0.1}
        },
        "required": ["expedition", "destination", "poids_kg"],
        "additionalProperties": False
    },
    "strict": True
}]

Kluczowe wnioski

  • Włącz strict: true, aby zagwarantować zgodność argumentów
  • Nadal waliduj po stronie klienta za pomocą jsonschema pod kątem reguł biznesowych
  • Pisz precyzyjne opisy: to główny dźwignia jakości
  • Używaj enum, aby ograniczyć akceptowane wartości
  • Rozbijaj złożone schematy na wielokrotnego użytku podstruktury