Χειροκίνητο response_format
Σε αυτήν τη σελίδα
Περισσότερος έλεγχος με το response_format
Η χειροκίνητη μέθοδος μέσω του response_format σας προσφέρει πλήρη έλεγχο κατά την ανάλυση (parsing). Σε αντίθεση με το parse(), το οποίο επιστρέφει ένα αντικείμενο με τύπο, αυτή η προσέγγιση επιστρέφει μια συμβολοσειρά JSON την οποία αναλύετε εσείς· το μοντέλο Pydantic παρέχει απλώς το σχήμα (model_json_schema()) και επικυρώνει εκ των υστέρων. Επιλέξτε αυτή τη μέθοδο όταν χρειάζεστε ευελιξία ή όταν εργάζεστε σε περιβάλλον χωρίς το Pydantic.
Ροή εργασίας
Με το response_format, η διαδικασία ολοκληρώνεται σε δύο βήματα:
- Το API επιστρέφει το JSON ως συμβολοσειρά στο
response.choices[0].message.content - Εσείς αναλύετε αυτή τη συμβολοσειρά χρησιμοποιώντας τη μέθοδο της επιλογής σας
Πλήρες παράδειγμα
from openai import OpenAI
from pydantic import BaseModel
client = OpenAI(
api_key="your-xai-key",
base_url="https://api.x.ai/v1"
)
class MovieReview(BaseModel):
title: str
rating: float
summary: str
recommend: bool
response = client.chat.completions.create(
model="grok-4.20-0309-reasoning",
messages=[{
"role": "user",
"content": "Review the movie Inception"
}],
response_format={
"type": "json_schema",
"json_schema": {
"name": "movie_review",
"schema": MovieReview.model_json_schema()
}
}
)
# Το περιεχόμενο είναι μια συμβολοσειρά JSON
json_string = response.choices[0].message.content
print(type(json_string)) # <class 'str'>
print(json_string)
# {"title": "Inception", "rating": 9.2, "summary": "...", "recommend": true}
# Χειροκίνητη ανάλυση με Pydantic
parsed = MovieReview.model_validate_json(json_string)
print(parsed.title) # "Inception"
Διαφορές από το parse()
| Πτυχή | parse() | response_format |
|---|---|---|
| Επιστροφή | (Response, ParsedModel) | Μόνο Response |
| Ανάλυση | Αυτόματη | Χειροκίνητη |
| Πρόσβαση στα δεδομένα | parsed.field | json.loads() ή model_validate_json() |
| Ευελιξία | Τυπική | Μέγιστη |
| Διαχείριση σφαλμάτων | Ενσωματωμένη | Δική σας ευθύνη |
Ανάλυση χωρίς Pydantic
Δεν είστε υποχρεωμένοι να χρησιμοποιήσετε το Pydantic για την ανάλυση του αποτελέσματος. Λειτουργεί εξίσου καλά και η τυπική βιβλιοθήκη json:
import json
response = client.chat.completions.create(
model="grok-4.20-0309-reasoning",
messages=[{
"role": "user",
"content": "Analyze this text and extract entities"
}],
response_format={
"type": "json_schema",
"json_schema": {
"name": "entities",
"schema": {
"type": "object",
"properties": {
"people": {
"type": "array",
"items": { "type": "string" }
},
"places": {
"type": "array",
"items": { "type": "string" }
}
}
}
}
}
)
data = json.loads(response.choices[0].message.content)
print(data["people"]) # ["Marie Curie", "Pierre Curie"]
print(data["places"]) # ["Paris", "Warsaw"]
Πότε να επιλέξετε το response_format
Το response_format διακρίνεται όποτε χρειάζεται να δείτε ή να επιθεωρήσετε το JSON πριν μετατραπεί σε αντικείμενο. Η πιο συνηθισμένη περίπτωση είναι η καταγραφή (logging): στην παραγωγή, η διατήρηση του αρχικού JSON πριν τον μετασχηματισμό αποτελεί συχνά απαίτηση ελέγχου ή αποσφαλμάτωσης, και το parse() δεν σας παρέχει αυτό το σημείο παρέμβασης. Ακολουθεί το ζήτημα του σχήματος: εάν η σύμβαση διεπαφής σας είναι ένα αρχικό σχήμα JSON—κοινόχρηστο με άλλες ομάδες, παραγόμενο από εργαλείο, με εκδόσεις ανεξάρτητες από τον κώδικα Python—η άμεση επιβολή του είναι πιο πιστή από την ανακατασκευή του ως μοντέλο Pydantic. Τέλος, δεν λειτουργούν όλα τα έργα εντός του οικοσυστήματος Pydantic: εάν η επικύρωσή σας περνά μέσα από ένα άλλο πλαίσιο εργασίας ή μέσω ενός ενδιάμεσου βήματος επεξεργασίας ειδικού για τη ροή σας, το response_format σας παραδίδει το JSON ως έχει και σας αφήνει τον έλεγχο για το επόμενο βήμα.
Διαχείριση σφαλμάτων
Με τη χειροκίνητη μέθοδο, πρέπει να διαχειριστείτε εσείς τα σφάλματα ανάλυσης:
import json
try:
data = json.loads(response.choices[0].message.content)
except json.JSONDecodeError as e:
print(f"Parsing error: {e}")
Στην πράξη, αυτό το σφάλμα δεν θα έπρεπε ποτέ να συμβαίνει, καθώς το API εγγυάται έγκυρο JSON. Ωστόσο, η αμυντική διαχείριση παραμένει βέλτιστη πρακτική στην παραγωγή.
Βασικά σημεία
- Το
response_formatεπιστρέφει μια συμβολοσειρά JSON στοresponse.choices[0].message.content - Η ανάλυση είναι δική σας ευθύνη:
json.loads(),model_validate_json()ή άλλη μέθοδος - Μπορείτε να χρησιμοποιήσετε ένα αρχικό σχήμα JSON αντί για μοντέλο Pydantic
- Περισσότερη ευελιξία από το
parse(), αλλά απαιτείται περισσότερος κώδικας - Το επιστρεφόμενο JSON είναι εγγυημένα έγκυρο· τα σφάλματα ανάλυσης δεν θα πρέπει να εμφανίζονται