Gestructureerde uitvoer · oefening
Valideer het antwoord van het model
Je hebt nu een pydantic-model dat de vorm van de quiz vastlegt, inclusief types. Deze les gebruikt het om het antwoord van het taalmodel te controleren: de JSON-tekst decoderen, elke sleutel en elk type controleren, en een QuizSet terugkrijgen of een precieze lijst van wat er mis is. Gegevens zo tegen een model controleren heet valideren (validation).
Decoderen en valideren in één stap
Elk pydantic-model heeft een methode die JSON-tekst aanneemt:
quiz = QuizSet.model_validate_json(text)
Die doet het werk van json.loads en van elke controle in read_quiz_json, en controleert ook de types. Als de tekst een geldige quiz is, krijg je een QuizSet. Als dat niet zo is, om welke reden ook, werpt hij één fout op: pydantic.ValidationError. Tekst die helemaal geen JSON is, geeft dezelfde fout, dus een aanroeper hoeft maar één exception af te handelen.
ValidationError wordt bovenaan structured.py geïmporteerd, uit pydantic.
Wat de fout zegt
Hier is het antwoord dat in les 2 door read_quiz_json glipte:
from pydantic import BaseModel, ValidationError
class QuizQuestion(BaseModel):
question: str
choices: list[str]
answer_index: int
class QuizSet(BaseModel):
questions: list[QuizQuestion]
text = '{"questions": [{"question": "Q?", "choices": ["a", "b"], "answer_index": "abc"}]}'
try:
QuizSet.model_validate_json(text)
except ValidationError as error:
print(error)
for item in error.errors():
print(item["loc"], item["msg"])
1 validation error for QuizSet
questions.0.answer_index
Input should be a valid integer, unable to parse string as an integer [type=int_parsing, input_value='abc', input_type=str]
For further information visit https://errors.pydantic.dev/2.14/v/int_parsing
('questions', 0, 'answer_index') Input should be a valid integer, unable to parse string as an integer
Als je de fout afdrukt, krijg je een volledig rapport, geschreven voor een programmeur, met een link naar de documentatie van pydantic. error.errors() geeft dezelfde feiten als gegevens: een lijst met één dictionary per probleem. Twee sleutels doen er hier toe. "loc" is waar het probleem zit, als tuple van stappen vanaf de bovenkant van het document: de sleutel questions, item 0 van die lijst, de sleutel answer_index daarvan. De posities in een lijst zijn gehele getallen; de sleutels zijn strings. "msg" is wat er mis is, in één zin.
Een antwoord met meerdere problemen geeft meerdere items, in de volgorde waarin pydantic ze vond. Tekst die geen JSON is, geeft één item waarvan de loc leeg is, (), omdat het probleem het hele antwoord is, en waarvan de melding begint met Invalid JSON.
Hier zie je de drie manieren om een antwoord te lezen die dit hoofdstuk heeft gebruikt naast elkaar. numbered_lines en read_quiz_json geven allebei zonder klagen een foute waarde terug. Het pydantic-model stopt, en de fout zegt waar het probleem zit.

Bouw parse_quiz en error_lines
parse_quiz(text) geeft QuizSet.model_validate_json(text) terug. Hij vangt niets af: beslissen wat er met een ongeldig antwoord moet gebeuren is de taak van de aanroeper, en les 8 geeft de aanroeper iets nuttigs te doen.
error_lines(error) maakt van een ValidationError korte regels, één per item van error.errors(), elk f"{location}: {item['msg']}". Bouw location uit de delen van item["loc"]: zet elk deel om met str(), omdat sommige gehele getallen zijn en ".".join alleen strings samenvoegt, en voeg ze dan samen met ".". Zo wordt ('questions', 0, 'answer_index') tot questions.0.answer_index. Als loc leeg is, gebruik dan (whole reply).
Voer het uit
Voer python structured.py uit. De demonstratie valideert het JSON-antwoord uit les 2 met jouw parse_quiz, geeft hem daarna drie ongeldige antwoorden, en drukt voor elk de uitvoer van jouw error_lines af:
The JSON reply, validated by parse_quiz:
3 questions. The first answer is '85'.
Replies that fail validation, explained by error_lines:
questions.0.answer_index: Input should be a valid integer, unable to parse string as an integer
questions.0.question: Field required
questions.0.answer_index: Field required
(whole reply): Invalid JSON: expected value at line 1 column 1
The system message from quiz_system_message:
Run stopped at the next function to build: quiz_system_message is built in Lesson 7.
Het eerste ongeldige antwoord heeft "abc" waar een geheel getal hoort. Het tweede heeft een vraag met alleen choices, dus ontbreken er twee velden en krijg je twee regels. Het derde is Here is your quiz!, en dat is geen JSON. Elke regel zegt waar en wat, en meer heeft een mens, of een taalmodel, niet nodig om het antwoord te verbeteren.
Wat validatie niet belooft
Drie dingen om te onthouden:
pydantic zet sommige waarden om. Voor een
int-veld accepteert het de string"3"als3, entrueals1. Dat wil je meestal bij tekst die over het netwerk binnenkwam, maar het is geen strikte typecontrole.Een geldige quiz kan nog steeds fout zijn. Een vraag met twee keuzes en
"answer_index": 5valideert, omdat 5 een geheel getal is. Validatie controleert de vorm die je hebt gedeclareerd. Als een regel daarbuiten belangrijk is, zoals dat de index bij de keuzes past, moet je programma dat zelf controleren.Dit is een andere fout dan die van
read_quiz_json.read_quiz_jsonwierp een gewoneValueErrorop die jij schreef.parse_quizwerpt deValidationErrorvan pydantic op. EenValidationErroris een soortValueError, dusexcept ValueError:zou ze allebei afvangen, maarexcept ValidationError:zegt precies wat je bedoelt, en dat is wat de rest van dit hoofdstuk afvangt.
parse_quiz krijgt de tekst Sure! Here is your quiz. Wat gebeurt er?
Waarom zet error_lines elk deel van loc om met str() voordat hij ze samenvoegt?
Opdracht
Vervang in structured.py de onafgemaakte bodies van parse_quiz(text) en error_lines(error).
parse_quiz(text)geeftQuizSet.model_validate_json(text)terug. Hij vangt niets af, dus eenValidationErrorbereikt de aanroeper.error_lines(error)krijgt eenValidationErroren geeft een lijst terug met één string per item vanerror.errors():f"{location}: {item['msg']}". De locatie bestaat uit de delen vanitem["loc"], elk omgezet metstr(), samengevoegd met".", zoals inquestions.0.answer_index. Alslocleeg is, is de locatie(whole reply).
Voer python structured.py uit om een antwoord gevalideerd te zien en drie ongeldige antwoorden uitgelegd, en controleer daarna je werk.