Gestructureerde uitvoer · oefening
Vraag om JSON en controleer het
Les 1 eindigde met een plan: vraag het model om JSON, want JSON kan een programma controleren. Deze les verstuurt dat request en controleert wat er terugkomt, met de middelen die je in Python in de praktijk op JSON-documenten gebruikte.
Vraag om een JSON-object
Het chat-endpoint accepteert hiervoor nog één veld, response_format:
"response_format": {"type": "json_object"}
Daarmee vraagt de dienst het model om een antwoord waarvan de content één JSON-object is. De content komt nog steeds binnen als string, in hetzelfde responsedocument als altijd. Het is JSON-tekst, dus je code decodeert het met json.loads, zoals je in Python in de praktijk deed met documenten van webdiensten. MODEL_SERVICE.md beschrijft het veld.
De API van OpenAI, en veel diensten die hem volgen, stellen één voorwaarde: het woord JSON moet ergens in de berichten staan, anders weigeren ze het request. Het systeembericht van de quiz, QUIZ_SYSTEM in prompts.py, noemt het, en zegt ook wat het object moet bevatten:
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."
Het request gaat over een cursusnotitie, dus het gebruikersbericht is QUIZ_PROMPT gevolgd door de notitie. note_message(note_text, question) uit hoofdstuk 2 bouwt precies dat: de vraag, een lege regel en de notitie tussen <note>-tags. Het wordt bovenaan structured.py geïmporteerd.
Het gescripte model herkent alleen deze exacte teksten. Een live model zou elke formulering accepteren die om hetzelfde vraagt, maar het gescripte model vergelijkt de prompt, dus gebruik de constanten zoals ze zijn.
Bouw quiz_request
quiz_request(note_text) geeft de hele requestbody terug:
{
"model": MODEL,
"messages": [
{"role": "system", "content": QUIZ_SYSTEM},
note_message(note_text, QUIZ_PROMPT),
],
"response_format": {"type": "json_object"},
}
Hij bouwt alleen de body. Versturen is de taak van send_body, uit hoofdstuk 1.
Wat json_object belooft, en wat niet
json_object belooft dat de content geldige JSON is. Het zegt niets over welke sleutels het object heeft, of wat erin zit. Een model dat {"quiz": "Sorry, no questions today"} antwoordt, heeft die belofte gehouden. Voordat een programma een antwoord gebruikt, controleert het daarom de vorm, net zoals Python in de praktijk documenten van een webdienst controleerde voordat ze gebruikt werden: is het een dictionary, heeft het de sleutel, is de waarde een lijst?
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])
Dit antwoord komt door de eerste drie controles en zakt voor de laatste: de vraag heeft geen answer_index.
Bouw read_quiz_json
read_quiz_json(text) decodeert het antwoord en controleert het, van buiten naar binnen:
data = json.loads(text). Tekst die geen JSON is, laatjson.loadsde foutjson.JSONDecodeErroropwerpen. Die fout is een soortValueError, dus laat hem ongewijzigd door.Als
datageen dictionary is, of geen sleutelquestionsheeft, werp danValueErrorop met een melding diequestionsnoemt.Als
data["questions"]geen lijst is, werp danValueErrorop.Voor elk item in de lijst: als het geen dictionary is, werp
ValueErrorop; alsquestion,choicesofanswer_indexontbreekt, werpValueErrorop met de naam van de ontbrekende sleutel.Geef de lijst terug.
Controleer de buitenkant voor de binnenkant. "questions" in data betekent iets anders voor een lijst of een string, en data["questions"] mislukt met een TypeError of KeyError die de aanroeper niets vertelt over het antwoord. Een ValueError waarvan de melding de ontbrekende sleutel noemt, zoals ValueError("A question has no answer_index key."), zegt wat er mis was met het antwoord.
Voer het uit
Voer python structured.py uit. Na de uitvoer van les 1 leest de demonstratie notes/03-lists.md, verstuurt er quiz_request voor met send_body, en drukt van elk item dat read_quiz_json teruggeeft de vraag af:
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.
Dit zijn dezelfde drie vragen als in de tekstquiz van les 1, nu gelezen uit benoemde sleutels in plaats van gevonden aan de hand van de regelopmaak. Het gescripte model geeft deze quiz voor elke notitie: het leest de notitie niet, en SCRIPTED_MODEL.md zegt dat ook. Een live model schrijft vragen over de notitie die het krijgt. De twee regels over een getal zijn voor les 3.
Wat de controles niet afdekken
Je controles zorgen dat elke sleutel er is. Naar de waarden kijken ze niet. Dit antwoord komt zonder klagen door read_quiz_json:
'{"questions": [{"question": "Q?", "choices": ["a", "b"], "answer_index": "abc"}]}'
Een quiz-app die later item["choices"][item["answer_index"]] uitvoert, mislukt daar met een TypeError, ver weg van het antwoord dat het veroorzaakte. Het type van elke waarde controleren met meer isinstance-aanroepen zou werken, maar de controles groeien met elk veld. De volgende lessen geven je een manier om de types één keer op te schrijven en ze voor je te laten controleren.
Een request vraagt om {"type": "json_object"}. Waar kan je code op rekenen in de content van het antwoord?
Waarom controleert read_quiz_json of de gedecodeerde waarde een dictionary is voordat het naar de sleutel questions kijkt?
Opdracht
Vervang in structured.py de onafgemaakte bodies van quiz_request(note_text) en read_quiz_json(text).
quiz_request geeft deze dictionary terug:
"model":MODEL"messages": een lijst van twee berichten:{"role": "system", "content": QUIZ_SYSTEM}, daarnanote_message(note_text, QUIZ_PROMPT)"response_format":{"type": "json_object"}
read_quiz_json decodeert text met json.loads en geeft de lijst questions ervan terug. Werp ValueError op met een melding die noemt wat er mis is wanneer:
de gedecodeerde waarde geen dictionary is, of geen sleutel
questionsheeft (noemquestionsin de melding);questionsgeen lijst is;een item van de lijst geen dictionary is, of een van de sleutels
question,choicesenanswer_indexmist (noem de ontbrekende sleutel).
Tekst die geen JSON is, laat json.loads de fout json.JSONDecodeError opwerpen. Dat is een soort ValueError, dus laat die door. Voer python structured.py uit om de vragen uit een JSON-antwoord te zien, en controleer daarna je werk.