Automatinis parse() metodas
Šiame puslapyje
Atnaujinta 2026 m. lapkričio 3 d. Remiantis Structured Outputs dokumentacija iš xAI ir
openaiSDK 3.42.1 versijos: kai OpenAI SDK nukreiptas į xAI, naudojamas metodas yraclient.chat.completions.parse, kuris grąžina užbaigimą, kur tipizuotas objektas nuskaitymas išchoices[0].message.parsed;client.chat.parseneegzistuoja (xAI SDK siūlochat.parse(Schema)pokalbiui, kuris grąžina atsakymo ir objekto porą). Šaltinis: Structured Outputs.
Greitasis būdas: parse()
Metodas parse() yra paprasčiausias būdas naudoti struktūrizuotą išvestį su Grok API. Jis priima Pydantic modelį kaip įvestį ir tiesiogiai grąžina tipizuotą objektą – nereikia analizuoti JSON ar atlikti rankinio validavimo.
Apibrėžkite Pydantic modelį
Sukuriate Python klasę, aprašančią tikėtiną struktūrą.
Iškvieskite client.chat.completions.parse()
Perduodate Pydantic modelį kaip `response_format`.
Gaukite porą (Response, ParsedModel)
Tipizuotas objektas paruoštas naudojimui jūsų kode.
Pilnas pavyzdys
Štai kaip išgauti struktūrizuotą filmo apžvalgą:
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 yra tipizuotas MovieReview objektas
print(parsed.title) # "Inception"
print(parsed.rating) # 9.2
print(parsed.recommend) # True
print(type(parsed)) # <class 'MovieReview'>
Ką grąžina parse()?
Metodas parse() grąžina dviejų elementų porą (tuple):
response: Pilnas API atsakymo objektas (su metaduomenimis, panaudotais tokenais ir kt.)parsed: Jūsų Pydantic modelis, sukurtas su išgautais duomenimis
Abu galite pasiekti pagal poreikį:
completion = client.chat.completions.parse(...)
parsed = completion.choices[0].message.parsed
# Pasiekti metaduomenis
print(completion.usage.total_tokens)
print(completion.model)
# Pasiekti struktūrizuotus duomenis
print(parsed.title)
print(parsed.rating)
Įdėtieji modeliai
parse() be vargo tvarko sudėtingas struktūras. Galite įdėti Pydantic modelius vieną į kitą:
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}")
Kada naudoti parse()?
parse() yra trumpiausias kelias nuo modelio atsakymo iki naudojamo Python objekto: jei dirbate su Pydantic, tai yra numatytasis pasirinkimas. Šis metodas apima viską – schemos siuntimą, atsakymo validavimą, objekto sukūrimą – ir tiesiogiai pateikia jums tipizuotą egzempliorių be json.loads ar rankinių patikrų. Tai pats glaustiausias kodas, ir daugeliu atvejų šis paprastumas nieko nekainuoja: atsisakote tik smulkmeniškos analizės kontrolės, jei jos iš tikrųjų reikia, o tai pasitaiko retai. Kitoje pamokoje nagrinėsime būtent tuos atvejus, kai rankinė kontrolė yra pateisinama.
Svarbiausi punktai
parse()grąžina porą(Response, ParsedModel)– automatinė analizė- Grąžintas objektas yra tipizuotas ir validuotas Pydantic egzempliorius
- Įdėtieji modeliai ir objektų sąrašai veikia natūraliai
- Tai rekomenduojamas metodas daugumai naudojimo atvejų Python kalboje
- Nereikia naudoti
json.loads()ar atlikti rankinio validavimo