0%

Strukturierte Ausgabe · Übung

JSON anfordern und prüfen

Lektion 1 endete mit einem Plan: Bitte das Modell um JSON, denn JSON kann ein Programm prüfen. In dieser Lektion sendest du diese Anfrage und prüfst, was zurückkommt, mit den Werkzeugen, die du in Python in der Praxis für JSON-Dokumente verwendet hast.

Fordere ein JSON-Objekt an

Der Chat-Endpunkt nimmt dafür ein weiteres Feld an, response_format:

"response_format": {"type": "json_object"}

Damit bittet der Dienst das Modell um eine Antwort, deren Inhalt ein einzelnes JSON-Objekt ist. Der Inhalt kommt weiterhin als String an, im selben Antwortdokument wie immer. Er ist JSON-Text, also dekodiert dein Code ihn mit json.loads, so wie in Python in der Praxis die Dokumente von Webdiensten. MODEL_SERVICE.md beschreibt das Feld.

Die API von OpenAI und viele Dienste, die sich an ihr orientieren, stellen eine Bedingung: Das Wort JSON muss irgendwo in den Nachrichten vorkommen, sonst lehnen sie die Anfrage ab. Die Systemnachricht des Quiz, QUIZ_SYSTEM in prompts.py, enthält es und sagt außerdem, was das Objekt enthalten soll:

QUIZ_SYSTEM = (
    "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)."
)
QUIZ_PROMPT = "Write three multiple-choice questions about the note below."

Die Anfrage bezieht sich auf eine Kursnotiz, die User-Nachricht ist also QUIZ_PROMPT, gefolgt von der Notiz. note_message(note_text, question) aus Kapitel 2 baut genau das: die Frage, eine Leerzeile und die Notiz zwischen <note>-Tags. Die Funktion wird oben in structured.py importiert.

Das geskriptete Modell erkennt nur genau diese Texte. Ein Live-Modell würde jede Formulierung akzeptieren, die um dasselbe bittet, aber das geskriptete Modell gleicht den Prompt ab. Verwende die Konstanten deshalb unverändert.

Baue quiz_request

quiz_request(note_text) gibt den gesamten Anfrage-Body zurück:

{
    "model": MODEL,
    "messages": [
        {"role": "system", "content": QUIZ_SYSTEM},
        note_message(note_text, QUIZ_PROMPT),
    ],
    "response_format": {"type": "json_object"},
}

Die Funktion baut nur den Body. Das Senden übernimmt send_body aus Kapitel 1.

Was json_object verspricht und was nicht

json_object verspricht, dass der Inhalt gültiges JSON ist. Es sagt nichts darüber, welche Schlüssel das Objekt hat oder was darin steht. Ein Modell, das {"quiz": "Sorry, no questions today"} antwortet, hat dieses Versprechen gehalten. Bevor ein Programm eine Antwort verwendet, prüft es deshalb die Form, so wie Python in der Praxis Dokumente von einem Webdienst vor der Verwendung geprüft hat: Ist es ein Dictionary, hat es den Schlüssel, ist der Wert eine Liste?

import json

data = json.loads('{"questions": [{"question": "Q?", "choices": ["a", "b"]}]}')
print(isinstance(data, dict), "questions" in data)
print(isinstance(data["questions"], list))
print("answer_index" in data["questions"][0])

Diese Antwort besteht die ersten drei Prüfungen und scheitert an der letzten: Ihrer Frage fehlt answer_index.

Baue read_quiz_json

read_quiz_json(text) dekodiert die Antwort und prüft sie von außen nach innen:

  1. data = json.loads(text). Bei Text, der kein JSON ist, löst json.loads einen json.JSONDecodeError aus. Dieser Fehler ist eine Art ValueError, lass ihn also unverändert durch.

  2. Wenn data kein Dictionary ist oder keinen Schlüssel questions hat, löse einen ValueError mit einer Meldung aus, die questions nennt.

  3. Wenn data["questions"] keine Liste ist, löse einen ValueError aus.

  4. Für jedes Element der Liste: Wenn es kein Dictionary ist, löse einen ValueError aus; wenn ihm question, choices oder answer_index fehlt, löse einen ValueError aus, der den fehlenden Schlüssel nennt.

  5. Gib die Liste zurück.

Prüfe das Äußere vor dem Inneren. "questions" in data bedeutet bei einer Liste oder einem String etwas anderes, und data["questions"] scheitert mit einem TypeError oder KeyError, der dem Aufrufer nichts über die Antwort verrät. Ein ValueError, dessen Meldung den fehlenden Schlüssel nennt, etwa ValueError("A question has no answer_index key."), sagt, was an der Antwort falsch war.

Ausführen

Führe python structured.py aus. Nach der Ausgabe von Lektion 1 liest die Demonstration notes/03-lists.md, sendet dafür quiz_request mit send_body und gibt die Frage jedes Elements aus, das read_quiz_json zurückgibt:

body = quiz_request(note)
for item in read_quiz_json(answer_text(send_body(body))):
    print(f"  {item['question']}")
The questions in a JSON reply, checked by read_quiz_json:
  For scores = [90, 72, 85], what is scores[-1]?
  What does scores.append(60) return?
  Which line makes an independent copy of scores?
read_quiz_json given a number instead of text:
  TypeError: the JSON object must be str, bytes or bytearray, not int
A QuizQuestion from sample_question:
Run stopped at the next function to build: sample_question is built in Lesson 4.

Das sind dieselben drei Fragen wie im Text-Quiz aus Lektion 1, jetzt aus benannten Schlüsseln gelesen statt anhand des Zeilenlayouts gefunden. Das geskriptete Modell liefert dieses Quiz für jede Notiz: Es liest die Notiz nicht, und SCRIPTED_MODEL.md sagt das auch. Ein Live-Modell schreibt Fragen zu der Notiz, die es bekommt. Die beiden Zeilen über eine Zahl sind für Lektion 3.

Was die Prüfungen nicht abdecken

Deine Prüfungen stellen sicher, dass jeder Schlüssel vorhanden ist. Die Werte sehen sie sich nicht an. Diese Antwort besteht read_quiz_json ohne Beschwerde:

'{"questions": [{"question": "Q?", "choices": ["a", "b"], "answer_index": "abc"}]}'

Eine Quiz-App, die später item["choices"][item["answer_index"]] ausführt, scheitert dort mit einem TypeError, weit entfernt von der Antwort, die ihn verursacht hat. Den Typ jedes Werts mit weiteren isinstance-Aufrufen zu prüfen, würde funktionieren, aber die Prüfungen wachsen mit jedem Feld. Die nächsten Lektionen zeigen dir, wie du die Typen einmal angibst und sie für dich prüfen lässt.

Eine Anfrage verlangt {"type": "json_object"}. Worauf kann sich dein Code beim Inhalt der Antwort verlassen?

Warum prüft read_quiz_json, ob der dekodierte Wert ein Dictionary ist, bevor es nach dem Schlüssel questions sucht?

Aufgabe

Ersetze in structured.py die unfertigen Rümpfe von quiz_request(note_text) und read_quiz_json(text).

quiz_request gibt dieses Dictionary zurück:

  • "model": MODEL

  • "messages": eine Liste mit zwei Nachrichten: {"role": "system", "content": QUIZ_SYSTEM}, danach note_message(note_text, QUIZ_PROMPT)

  • "response_format": {"type": "json_object"}

read_quiz_json dekodiert text mit json.loads und gibt dessen Liste questions zurück. Löse einen ValueError mit einer Meldung aus, die nennt, was falsch ist, wenn:

  • der dekodierte Wert kein Dictionary ist oder keinen Schlüssel questions hat (nenne questions in der Meldung);

  • questions keine Liste ist;

  • ein Element der Liste kein Dictionary ist oder ihm einer der Schlüssel question, choices und answer_index fehlt (nenne den fehlenden Schlüssel).

Bei Text, der kein JSON ist, löst json.loads einen json.JSONDecodeError aus, eine Art ValueError, also lass ihn durch. Führe python structured.py aus, um die Fragen aus einer JSON-Antwort zu sehen, und prüfe dann deine Arbeit.