JSON garanteeritud skeemiga
Sellel lehel
Miks struktureeritud väljundid kõike muudavad
Kui kasutad keelemudelit tootmiskeskkonnas, vajad vastuseid, mida kood suudab kasutada. Mitte vaba teksti, mitte ligikaudset JSON-i, vaid JSON-i, mis on garanteeritult kooskõlas sinu määratletud skeemiga. Just seda pakubki Grok API struktureeritud väljundite funktsioon.
Põhimõte on lihtne: esitad mudelile JSON-skeemi ja API garanteerib, et vastus järgib seda struktuuri täpselt. Puudub juhuslik parsimine, habras regex või try/catch-plokkide vajadus olukordadeks, kus mudel leiutab oma vormingu.
Kuidas see toimib
Struktureeritud väljundid tuginevad piirangumehhanismile, mida rakendatakse teksti genereerimise ajal. Iga toodetava tokeni puhul on mudel sunnitud genereerima ainult tokeneid, mis ühilduvad esitatud skeemiga. Tulemuseks on JSON, mis on alati kehtiv ja alati kooskõlas nõuetega.
Vaatan konkreetset näidet. Soovid meilist eraldada kontaktandmeid:
from pydantic import BaseModel
class Contact(BaseModel):
nom: str
email: str
entreprise: str
telephone: str | None
# Vastus on ALATI kehtiv Contact-objekt
Ilma struktureeritud väljunditeta võib mudel tagastada telefoninumbri võtmena "tel", "phone" või "numéro". Skeemi kasutamisel on väli alati nimega telephone ja selle väärtus on alati string või null.
Kättesaadavus
Struktureeritud väljundeid toetavad kõik xAI keelemudelid: Grok 4.5, Grok 4.3, grok-4.20 variandid ja hilisemad versioonid. Sõltumata sellest, millist mudelit kasutad, on see funktsioon saadaval ilma lisakulude või täiendava seadistamiseta.
Ilma struktureeritud väljunditeta vs nendega
Siin on ülevaade, mida saad ilma selle funktsioonita ja sellega:
Ilma struktureeritud väljunditeta:
- Mudel võib tagastada vaba teksti, osalise JSON-i või ootamatu vormingu
- Pead parsima käsitsi ja käsitlema vigu
- Väljade nimed võivad päringust päringusse muutuda
- Sinu töövoog katkeb kohe, kui mudel vormingut muudab
Struktureeritud väljunditega:
- JSON on alati süntaktiliselt kehtiv
- Struktuur vastab täpselt esitatud skeemile
- Andmetüüpe austatakse (string, number, boolean jne)
- Sinu kood saab vastust otse tarbida
Kaks saadaolevat lähenemisviisi
Grok API pakub struktureeritud väljundite kasutamiseks kahte meetodit:
parse(): Automaatne meetod, mis tagastab otseselt tüübitud objekti. Ideaalne enamiku juhtude jaoks.response_format: Manuaalne meetod, mis tagastab JSON-stringi. Pakub rohkem kontrolli, kuid parsimine jääb sinu hooleks.
Avastad neid kahte meetodit üksikasjalikult järgnevates tundides.
Peamised punktid
- Struktureeritud väljundid garanteerivad iga väljakutse puhul JSON-i, mis on kooskõlas sinu skeemiga
- Piirangut rakendatakse genereerimise ajal, mitte pärast seda
- Kõik xAI keelemudelid toetavad seda funktsiooni
- Saadaval on kaks meetodit:
parse()(automaatne) jaresponse_format(manuaalne) - See on iga usaldusväärse tootmistöövoogu alus Grok API kasutamisel