xAI Python SDK
Sellel lehel
Uuendatud 3. novembril 2026, lähtudes xAI parimatest tavadest ja API referentsist: temperatuur on piiratud väärtusega 1 ja soovitatav väärtus on 0,7. Allikas: Parimad tavad. Näide kõnest järgib SDK README-d (
chat.append(user(...)),chat.sample(),response.content) ja selle käivitamist kontrolliti.
xAI ametlik Python SDK
xAI enda Python SDK on kõige otsesem viis Grok API-ga töötamiseks. See võimaldab kasutada platvormi spetsiifilisi funktsioone ja saab värskendusi esimesena, kui lisanduvad uued mudelid või lõpp-punktid.
Paigaldamine
Paigalda SDK oma Pythoni keskkonda pip-i abil:
pip install xai-sdk
Soovitame kasutada virtuaalset keskkonda, et isoleerida iga projekti sõltuvused:
python -m venv venv
source venv/bin/activate # Linux/macOS
venv\Scripts\activate # Windows
pip install xai-sdk
Kliendi initsialiseerimine
Klass Client on SDK sisenemispunkt. See haldab autentimist, HTTP-ühendusi ja päringute seerialiseerimist:
from xai_sdk import Client
import os
client = Client(api_key=os.getenv("XAI_API_KEY"))
Kui keskkonnamuutuja XAI_API_KEY on määratud, saad luua kliendi ka ilma argumenti explicitsest määramiseta:
client = Client()
SDK tuvastab muutuja automaatselt ja kasutab seda autentimiseks.
Päringu saatmine
Kui klient on initsialiseeritud, mõtleb SDK vestluste kaupa: client.chat.create() loob vestluse (midagi saatmata), append lisab sõnumi, mis on ehitatud funktsioonidega user() või system(), ja sample() küsib mudelilt vastust:
import os
from xai_sdk import Client
from xai_sdk.chat import user
client = Client(api_key=os.getenv("XAI_API_KEY"))
chat = client.chat.create(model="grok-4.7")
chat.append(user("Selgita kolmes lauses, mis on REST API."))
response = chat.sample()
print(response.content)
Levinud parameetrid
model: kasutatava mudeli ID (kohustuslik); xAI soovitabgrok-4.7messages: vestluse algussõnumid, ehitatud funktsioonidegasystem(),user()jaassistant()moodulistxai_sdk.chat(lihtsõnastikud põhjustavad väljakutse nurjumise)temperature: vahemikus 0 kuni 2, üle selle piiratud väärtusega 1; xAI soovitab 0,7 koostop_pväärtusega 0,95max_tokens: genereeritavate tokenite maksimaalne arvreasoning_effort: arutluse sügavus (none,low,medium,high), mille xAI soovitab määrata igas päringus
Voogedastus ei käi parameetri kaudu: for response, chunk in chat.stream(): tagastab saabuvad fragmendid muutujas chunk.content. 10. õppetund näitab voogedastust REST API kaudu üle SSE.
Oma SDK eelised
Võrreldes OpenAI SDK-ga, mis on suunatud xAI API-le (järgmine õppetund), annab oma SDK otsese juurdepääsu xAI-spetsiifilistele funktsioonidele: X-i ja veebiotsing, serveripoolsed tööriistad, video genereerimine, dokumentide kogumid. Selle täielikud Pythoni tüübid toidavad sinu koodiredaktori automaatset täiendamist ja xAI haldab seda API arengutempoga kooskõlas. Sellel on ka oma struktuur, millega pead leppima: see töötab üle gRPC, selle sõnumid ehitatakse funktsioonidega user() ja system() ning selle veahanded on tüüpi grpc.RpcError.
Millal see SDK valida?
Valik tuleneb loomulikult sinu olukorrast. Uue projekti puhul, mis on ehitatud spetsiaalselt Grok API peale, on oma SDK ilmne lähtepunkt: saad kõik ülalmainitud eelised ilma ühilduvuspiiranguteta. See muutub hädavajalikuks niipea, kui plaanid kasutada xAI-spetsiifilisi funktsioone, nagu X-i otsing või sisseehitatud veebiotsing, mis toimivad täielikult ainult sel viisil. Kui aga sul on olemasolev kood, mis põhineb OpenAI SDK-l, ära kirjuta seda praegu ümber: järgmine õppetund näitab, kuidas seda kohandada, muutes vaid kaks rida.
Peamised punktid
- Paigalda käsu
pip install xai-sdkabil virtuaalses keskkonnas - Klass
Clienton sisenemispunkt, millel onXAI_API_KEYautomaatne tuvastamine client.chat.create()loob vestluse;chat.append(user(...))lisab sõnumi jachat.sample()tagastab vastuse, mida loed muutujastresponse.content- Eelista seda SDK-d uutele projektidele, mis on suunatud ainult Grok API-le