Strukturierte Ausgabe · Übung
Dem Modell die Form zeigen
Dein Programm weiß jetzt genau, wie ein gültiges Quiz aussieht: QuizSet legt es fest. Das Sprachmodell weiß es nicht. Es bekommt nur QUIZ_SYSTEM, einen Satz, der das Objekt in Worten beschreibt. In dieser Lektion schickst du dem Modell dieselbe Beschreibung, gegen die dein Programm prüft, damit die beiden nicht auseinanderlaufen können.
Ein Modell kann sich selbst beschreiben
Jedes Pydantic-Modell kann seine Form als JSON Schema ausgeben, ein Standardformat zur Beschreibung von JSON-Dokumenten:
import json
from pydantic import BaseModel
class QuizQuestion(BaseModel):
question: str
choices: list[str]
answer_index: int
class QuizSet(BaseModel):
questions: list[QuizQuestion]
schema = QuizSet.model_json_schema()
print(type(schema).__name__)
print(schema["required"])
print(schema["$defs"]["QuizQuestion"]["properties"]["answer_index"])
dict
['questions']
{'title': 'Answer Index', 'type': 'integer'}
model_json_schema() gibt ein Dictionary zurück. Seine properties listen die Felder mit ihren JSON-Typen auf (string, integer, array für eine Liste), required nennt die Felder, die vorhanden sein müssen, und $defs enthält die Beschreibung von QuizQuestion, auf die questions verweist. Du musst JSON Schema nicht selbst schreiben; du musst nur wissen, dass es die eigene Beschreibung des Modells ist, in einer Form, die andere Programme und auch Sprachmodelle verstehen.
Baue quiz_system_message
quiz_system_message() gibt die Systemnachricht zurück, bei der das Schema hinter QUIZ_SYSTEM angehängt ist:
{"role": "system", "content": QUIZ_SYSTEM + "\n\nJSON schema:\n" + json.dumps(QuizSet.model_json_schema(), indent=2)}
json.dumps(..., indent=2) macht aus dem Dictionary JSON-Text, verteilt auf eingerückte Zeilen, wie in Python in der Praxis. Ein Sprachmodell liest den Text so oder so; die eingerückte Form kann ein Mensch mit bloßem Auge prüfen. Baue das Schema in der Funktion aus QuizSet. Würdest du stattdessen den Schematext einfügen, würde die Nachricht nach einer späteren Änderung an QuizSet noch die alte Form beschreiben.
Ändere dann quiz_request: Seine erste Nachricht wird quiz_system_message() statt {"role": "system", "content": QUIZ_SYSTEM}. Die Notiz-Nachricht, model und response_format bleiben, wie sie sind.
Wer das Schema liest
Ein Live-Modell liest das Schema als Teil seines Prompts und richtet seine Antwort danach aus. Das Schema gibt ihm die genauen Feldnamen und Typen, es muss also weniger raten als bei einer Beschreibung in Worten. Es bleibt trotzdem eine Bitte, keine Garantie: Das Modell kann es falsch machen, und deshalb validiert dein Programm ohnehin jede Antwort.
Das geskriptete Modell liest das Schema nicht. Es antwortet wie bisher aus seiner Tabelle vorbereiteter Antworten, und die Systemnachricht spielt keine Rolle dabei, welche Antwort es auswählt. Die Ausgabe unten ist also dasselbe Quiz wie in Lektion 6.
Es gibt eine strengere Art, ein Schema zu senden, das Antwortformat json_schema, bei dem der Dienst selbst dafür sorgen soll, dass das Modell sich an das Schema hält. Du verwendest es in Kapitel 5 über den openai-Client, der diese Anfrage für dich aus QuizSet baut.
Ausführen
Führe python structured.py aus. Die Demonstration gibt den Inhalt deiner Systemnachricht aus. Wenn quiz_request sie noch nicht sendet, sagt sie das in der nächsten Zeile. Danach sendet sie einen Prompt, dessen erste Antwort absichtlich ungültig ist; darum kümmert sich die nächste Lektion:
The system message from quiz_system_message:
You write multiple-choice quiz questions for a Python course. Reply with JSON only: an object with a questions list. Each question has question, choices (three or four strings) and answer_index (the position of the correct choice, counting from 0).
JSON schema:
{
"$defs": {
"QuizQuestion": {
"properties": {
"question": {
"title": "Question",
"type": "string"
},
"choices": {
"items": {
"type": "string"
},
"title": "Choices",
"type": "array"
},
"answer_index": {
"title": "Answer Index",
"type": "integer"
}
},
"required": [
"question",
"choices",
"answer_index"
],
"title": "QuizQuestion",
"type": "object"
}
},
"properties": {
"questions": {
"items": {
"$ref": "#/$defs/QuizQuestion"
},
"title": "Questions",
"type": "array"
}
},
"required": [
"questions"
],
"title": "QuizSet",
"type": "object"
}
A reply that fails validation, and one retry:
First reply: {"questions": [{"question": "What does len() return?", "choices": ["The number of items", "The last item", "The first item"], "answer_index": "abc"}]}
Run stopped at the next function to build: retry_request is built in Lesson 8.
Das ist die vollständige Systemnachricht, die das Modell mit jeder Quiz-Anfrage bekommt: zuerst die Anweisungen in Worten, dann die genaue Form als JSON Schema.
Warum baut quiz_system_message das Schema jedes Mal aus QuizSet, statt das Schema als eingefügten Text zu enthalten?
Die Quiz-Anfrage enthält jetzt das JSON Schema in ihrer Systemnachricht. Was garantiert das für die Antwort eines Live-Modells?
Aufgabe
Ersetze in structured.py den unfertigen Rumpf von quiz_system_message() und ändere dann quiz_request so, dass es diese Funktion verwendet.
quiz_system_message()gibt{"role": "system", "content": ...}zurück, wobei der Inhalt ausQUIZ_SYSTEM, dann"\n\nJSON schema:\n"und dannjson.dumps(QuizSet.model_json_schema(), indent=2)besteht. Baue das Schema in der Funktion ausQuizSet, statt seinen Text einzufügen.Ersetze in
quiz_requestdie erste Nachricht,{"role": "system", "content": QUIZ_SYSTEM}, durchquiz_system_message(). Lass den Rest des Rumpfs unverändert.
Führe python structured.py aus, um die Systemnachricht mit dem Schema zu sehen, und prüfe dann deine Arbeit.