xAI Python SDK
Šiame puslapyje
Atnaujinta 2026 m. lapkričio 3 d., remiantis xAI geriausiomis praktikomis ir API nuoroda: temperatūra ribojama iki 1, rekomenduojama nustatyti 0,7. Šaltinis: Geriausios praktikos. Pavyzdinis kvietimas atitinka SDK README (
chat.append(user(...)),chat.sample(),response.content) ir buvo paleistas patikrinimui.
Oficialus xAI Python SDK
Natūralus xAI Python SDK yra tiesiausias būdas dirbti su Grok API. Jis suteikia prieigą prie specifinių platformos funkcijų ir pirmasis gauna atnaujinimus, kai pridedami nauji modeliai arba galiniai taškai.
Diegimas
Įdiekite SDK naudodami pip savo Python aplinkoje:
pip install xai-sdk
Rekomenduojame naudoti virtualią aplinką, kad kiekvieno projekto priklausomybės būtų izoliuotos:
python -m venv venv
source venv/bin/activate # Linux/macOS
venv\Scripts\activate # Windows
pip install xai-sdk
Kliento inicializavimas
Klasė Client yra SDK įvesties taškas. Ji tvarko autentifikavimą, HTTP ryšius ir užklausų serializavimą:
from xai_sdk import Client
import os
client = Client(api_key=os.getenv("XAI_API_KEY"))
Jei nustatytas aplinkos kintamasis XAI_API_KEY, klientą galite sukurti ir be aiškaus argumento:
client = Client()
SDK automatiškai aptinka šį kintamąjį ir naudoja jį autentifikavimui.
Užklausos siuntimas
Inicializavus klientą, SDK mąsto pokalbių kategorijomis: client.chat.create() sukuria pokalbį (nieko nesiųsdamas), append prideda žinutę, sukurtą naudojant user() arba system(), o sample() prašo modelio pateikti atsakymą:
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("Paaiškink, kas yra REST API, trimis sakiniais."))
response = chat.sample()
print(response.content)
Dažniausiai naudojami parametrai
model: naudojamo modelio ID (privaloma); xAI rekomenduojagrok-4.7messages: pradinės pokalbio žinutės, sukurtos naudojantsystem(),user()irassistant()išxai_sdk.chat(paprasti žodynai sukels klaidą)temperature: nuo 0 iki 2, viršijus ribojama iki 1; xAI rekomenduoja 0,7, otop_p– 0,95max_tokens: maksimalus sugeneruojamų tokenų skaičiusreasoning_effort: samprotavimo gylis (none,low,medium,high), kurį xAI rekomenduoja nustatyti kiekvienoje užklausoje
Srautinis perdavimas (streaming) neatliekamas per parametrą: for response, chunk in chat.stream(): grąžina fragmentus jiems atvykstant kintamajame chunk.content. 10 pamokoje parodomas srautinis perdavimas naudojant REST API per SSE.
Natūralaus SDK privalumai
Palyginti su OpenAI SDK, nukreiptu į xAI API (kitoje pamokoje), natūralus SDK suteikia tiesioginę prieigą prie xAI specifinių funkcijų: paieškos X ir internete, serverio pusės įrankių, vaizdo generavimo, dokumentų kolekcijų. Išsamūs Python tipai pagerina jūsų redaktoriaus automatinį užbaigimą, o xAI jį prižiūri tuo pačiu tempu kaip ir API. Jis taip pat turi savo struktūrą, kurią tenka priimti: jis veikia per gRPC, žinutės kuriamos naudojant user() ir system(), o klaidos yra grpc.RpcError.
Kada rinktis šį SDK
Pasirinkimas natūraliai išplaukia iš jūsų situacijos. Naujam projektui, sukurtam specialiai Grok API, natūralus SDK yra akivaizdus starto taškas: gaunate viską, kas išdėstyta aukščiau, be jokių suderinamumo apribojimų. Jis tampa būtinas, kai planuojate naudoti xAI specifines funkcijas, pavyzdžiui, paiešką X arba integruotą interneto paiešką, kurios visiškai veikia tik taip. Kita vertus, jei turite esamą kodą, sukurtą naudojant OpenAI SDK, nieko neperrašinėkite: kitoje pamokoje parodysime, kaip jį pritaikyti pakeitus dvi eilutes.
Svarbiausi punktai
- Įdiekite naudodami
pip install xai-sdkvirtualioje aplinkoje - Klasė
Clientyra įvesties taškas, automatiškai aptinkantisXAI_API_KEY client.chat.create()sukuria pokalbį;chat.append(user(...))prideda žinutę, ochat.sample()grąžina atsakymą, skaitomą išresponse.content- Šį SDK rinkitės naujiems projektams, skirtiems tik Grok API