Automaatne parse() meetod
Sellel lehel
Uuendatud 3. novembril 2026. Põhineb xAI Structured Outputs dokumentatsioonil ja
openaiSDK versioonil 3.42.1: kui OpenAI SDK on suunatud xAI-le, on meetodiksclient.chat.completions.parse, mis tagastab täitmise, kus tüübitud objekt loetakse väljachoices[0].message.parsed;client.chat.parseei eksisteeri (xAI SDK pakub vestluse jaoks küllchat.parse(Schema), mis tagastab vastuse ja objekti paari). Allikas: Structured Outputs.
Kiirtee: parse()
Meetod parse() on lihtsaim viis kasutada struktureeritud väljundeid Grok API-ga. See võtab sisendiks Pydantic mudeli ja tagastab otseselt tüübitud objekti – ei mingit JSON-i parsimist ega käsitsi valideerimist.
Määratle Pydantic mudel
Lood Pythoni klassi, mis kirjeldab oodatavat struktuuri.
Kutsu client.chat.completions.parse()
Edastad Pydantic mudeli parameetrina response_format.
Saad tuple'i (Vastus, ParsitudMudel)
Tüübitud objekt on koode kasutamiseks valmis.
Täielik näide
Siin on näide, kuidas ekstraheerida struktureeritud filmiarvustus:
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
completion = client.chat.completions.parse(
model="grok-4.20-0309-reasoning",
messages=[{
"role": "user",
"content": "Write a review of the movie Inception"
}],
response_format=MovieReview
)
parsed = completion.choices[0].message.parsed
# parsed on tüübitud MovieReview objekt
print(parsed.title) # "Inception"
print(parsed.rating) # 9.2
print(parsed.recommend) # True
print(type(parsed)) # <class 'MovieReview'>
Mida parse() tagastab
Meetod parse() tagastab kahe elemendiga tuple’i:
response: Täielik API vastuse objekt (koos metaandmete, kasutatud tokenite jms).parsed: Sinu Pydantic mudel, mis on instantiateeritud ekstraheeritud andmetega.
Saad mõlemale vajadusel ligi pääseda:
completion = client.chat.completions.parse(...)
parsed = completion.choices[0].message.parsed
# Metaandmete lugemine
print(completion.usage.total_tokens)
print(completion.model)
# Struktureeritud andmete lugemine
print(parsed.title)
print(parsed.rating)
Pesastatud mudelid
parse() haldab keerukaid struktuure vaevata. Saad pesastada Pydantic mudeleid:
class Actor(BaseModel):
name: str
role: str
class Review(BaseModel):
title: str
director: str
year: int
rating: float
main_actors: list[Actor]
genres: list[str]
strengths: list[str]
weaknesses: list[str]
completion = client.chat.completions.parse(
model="grok-4.20-0309-reasoning",
messages=[{
"role": "user",
"content": "Complete analysis of the movie Interstellar"
}],
response_format=Review
)
parsed = completion.choices[0].message.parsed
for actor in parsed.main_actors:
print(f"{actor.name} plays {actor.role}")
Millal kasutada parse()?
parse() on lühim tee mudeli vastusest kasutatava Pythoni objektini: kui töötad Pydanticuga, on see vaikimisi valik. Meetod kapseldab kõik – skeemi saatmise, vastuse valideerimise ja objekti loomise – ning annab sulle otseselt tüübitud eksemplari, ilma json.loads või käsitsi kontrollideta. See on võimalikult lakooniline kood ja valdaval enamikul juhtudel ei too see lihtsus kaasa mingeid kaotusi: loobud peeneteralisest parsimiskontrollist vaid siis, kui seda tegelikult vajad, mis on haruldane. Järgmine tund käsitleb täpselt neid juhtumeid, kus käsitsi kontroll on põhjendatud.
Peamised punktid
parse()tagastab tuple’i(Response, ParsedModel)– automaatne parsimine- Tagastatud objekt on tüübitud ja valideeritud Pydantic eksemplar
- Pesastatud mudelid ja objektide loendid toimivad loomupäraselt
- See on soovitatud meetod enamiku Pythoni kasutusjuhtude jaoks
json.loads()või käsitsi valideerimine pole vajalik