xAI Python SDK
Šajā lapā
Atjaunināts 2026. gada 3. novembrī, pamatojoties uz xAI labākās prakses vadlīnijām un API atsauces dokumentāciju: temperatūra ierobežota līdz 1, ieteicamā vērtība ir 0,7. Avots: Labākā prakse. Izsauces piemērs atbilst SDK README (
chat.append(user(...)),chat.sample(),response.content) un tika izpildīts pārbaudes nolūkā.
xAI oficiālais Python SDK
xAI natīvais Python SDK ir tiešākais veids, kā strādāt ar Grok API. Tas nodrošina piekļuvi platformas specifiskajām funkcijām un saņem atjauninājumus vispirms, kad tiek pievienoti jauni modeļi vai galapunkti.
Instalācija
Instalē SDK, izmantojot pip savā Python vidē:
pip install xai-sdk
Mēs iesakām izmantot virtuālo vidi, lai izolētu katra projekta atkarības:
python -m venv venv
source venv/bin/activate # Linux/macOS
venv\Scripts\activate # Windows
pip install xai-sdk
Klienta inicializēšana
Klase Client ir SDK ieejas punkts. Tā pārvalda autentifikāciju, HTTP savienojumus un pieprasījumu serializāciju:
from xai_sdk import Client
import os
client = Client(api_key=os.getenv("XAI_API_KEY"))
Ja vides mainīgais XAI_API_KEY ir iestatīts, klientu vari izveidot arī bez eksplicīta argumenta:
client = Client()
SDK automātiski noteiks šo mainīgo un izmantos to autentifikācijai.
Pieprasījuma nosūtīšana
Kad klients ir inicializēts, SDK domā sarunu kategorijās: client.chat.create() izveido sarunu (neko nesūtot), append pievieno ziņojumu, kas veidots ar user() vai system(), bet sample() pieprasa modelim atbildi:
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("Paskaidro, kas ir REST API, 3 teikumos."))
response = chat.sample()
print(response.content)
Biežāk lietotie parametri
model: izmantojamā modeļa ID (obligāts); xAI iesakagrok-4.7messages: sarunas sākuma ziņojumi, veidoti arsystem(),user()unassistant()noxai_sdk.chat(parasti vārdnīcas izraisīs kļūdu)temperature: no 0 līdz 2, vērtības virs 1 tiek ierobežotas; xAI iesaka 0,7, bettop_p– 0,95max_tokens: ģenerējamo tokenu maksimālais skaitsreasoning_effort: spriešanas dziļums (none,low,medium,high), ko xAI iesaka iestatīt katrā pieprasījumā
Straumēšana nenotiek caur parametru: for response, chunk in chat.stream(): atgriež fragmentus, tiklīdz tie pienāk, mainīgajā chunk.content. 10. nodarbībā apskatīta straumēšana, izmantojot REST API pār SSE.
Natīvā SDK priekšrocības
Salīdzinot ar OpenAI SDK, kas vērsts uz xAI API (nākamajā nodarbībā), natīvais SDK nodrošina tiešu piekļuvi xAI specifiskajām funkcijām: X un tīmekļa meklēšana, servera puses rīki, video ģenerēšana, dokumentu kolekcijas. Tā pilnīgie Python tipi uzlabo tava redaktora automātisko papildināšanu, un xAI to uztur sinhroni ar API attīstību. Tam ir arī sava struktūra, kas jāpieņem: tas darbojas pār gRPC, ziņojumi tiek veidoti ar user() un system(), bet kļūdas ir grpc.RpcError tipa.
Kad izvēlēties šo SDK
Izvēle izriet no tavas situācijas. Jaunam projektam, kas veidots specifiski Grok API, natīvais SDK ir acīmredzamais sākumpunkts: tu iegūsti visu iepriekš minēto bez saderības ierobežojumiem. Tas kļūst neaizstājams, tiklīdz plāno izmantot xAI specifiskas funkcijas, piemēram, X meklēšanu vai iebūvēto tīmekļa meklēšanu, kas pilnvērtīgi darbojas tikai šādā veidā. Ja, no otras puses, tev ir esošs kods, kas balstīts uz OpenAI SDK, neko pārrakstīt pagaidām nevajag: nākamajā nodarbībā parādīts, kā to pielāgot, mainot tikai divas koda rindiņas.
Galvenās atziņas
- Instalē ar
pip install xai-sdkvirtuālajā vidē - Klase
Clientir ieejas punkts ar automātiskuXAI_API_KEYnoteikšanu client.chat.create()izveido sarunu;chat.append(user(...))pievieno ziņojumu, betchat.sample()atgriež atbildi, ko nolasām noresponse.content- Dod priekšroku šim SDK jauniem projektiem, kas mērķē tikai uz Grok API