Siirry pääsisältöön
Suomi— Valitse kieli
Valikko

xAI Python SDK

Oppitunti 5 / 14 Päivitetty 3. marraskuuta 2026 Kehittäjä
Tällä sivulla
  1. xAI:n virallinen Python-SDK
  2. Asennus
  3. Asiakkaan alustus
  4. Pyynnön lähettäminen
  5. Natiivin SDK:n edut
  6. Milloin valita tämä SDK
  7. Keskeiset asiat

Päivitetty 3. marraskuuta 2026 xAI:n parhaiden käytäntöjen ja API-viitteen perusteella: lämpötila rajoitettu arvoon 1 ja suositeltu arvo on 0,7. Lähde: Parhaat käytännöt. Esimerkkikutsu noudattaa SDK:n README-tiedostoa (chat.append(user(...)), chat.sample(), response.content) ja se on suoritettu varmennusta varten.

xAI:n virallinen Python-SDK

xAI:n natiivi Python-SDK on suoraviivaisin tapa työskennellä Grok API:n kanssa. Se tarjoaa pääsyn alustan erityisominaisuuksiin ja saa päivitykset ensimmäisenä, kun uusia malleja tai päätepisteitä lisätään.

pip
Vakioasennus
Client
Pääluokka
Auto
API-avaimen tunnistus
Native
Täysi xAI-tuki

Asennus

Asenna SDK pipillä Python-ympäristöösi:

pip install xai-sdk

Suosittelemme virtuaaliympäristön käyttöä eristääksesi kunkin projektin riippuvuudet:

python -m venv venv
source venv/bin/activate  # Linux/macOS
venv\Scripts\activate     # Windows
pip install xai-sdk

Asiakkaan alustus

Client-luokka on SDK:n sisäänmenopiste. Se hoitaa todennuksen, HTTP-yhteydet ja pyyntöjen sarjoittamisen:

from xai_sdk import Client
import os

client = Client(api_key=os.getenv("XAI_API_KEY"))

Jos XAI_API_KEY-ympäristömuuttuja on asetettu, voit luoda asiakkaan myös ilman eksplisiittistä argumenttia:

client = Client()

SDK tunnistaa muuttujan automaattisesti ja käyttää sitä todennukseen.

Pyynnön lähettäminen

Kun asiakas on alustettu, SDK ajattelee keskustelujen kautta: client.chat.create() luo keskustelun (lähettämättä mitään), append lisää viestin, joka on rakennettu funktiolla user() tai system(), ja sample() pyytää mallilta vastausta:

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("Selitä, mikä on REST API, kolmella lauseella."))
response = chat.sample()

print(response.content)

Yleiset parametrit

  • model: käytettävän mallin tunniste (vaadittu); xAI suosittelee arvoa grok-4.7
  • messages: keskustelun aloitusviestit, rakennettu funktioilla system(), user() ja assistant() moduulista xai_sdk.chat (pelkät sanakirjat aiheuttavat kutsun epäonnistumisen)
  • temperature: 0–2, rajoitettu arvoon 1 tämän yläpuolella; xAI suosittelee arvoa 0,7 ja top_p:tä arvolla 0,95
  • max_tokens: generoitavien tokenien enimmäismäärä
  • reasoning_effort: päättelyn syvyys (none, low, medium, high), jonka xAI suosittelee asettamaan jokaiseen pyyntöön

Suoratoisto ei kulje parametrin kautta: for response, chunk in chat.stream(): palauttaa osat saapumisjärjestyksessä kohteessa chunk.content. Oppitunti 10 esittelee suoratoiston REST API:n kautta SSE:n yli.

Natiivin SDK:n edut

Verrattuna xAI API:hun osoitettuun OpenAI SDK:hon (seuraava oppitunti), natiivi SDK tarjoaa suoran pääsyn xAI-kohtaisiin ominaisuuksiin: X- ja verkkohaku, palvelinpuolen työkalut, videon generointi ja asiakirjakokoelmat. Sen täydelliset Python-tyypit tehostavat editorisi automaattista täydennystä, ja xAI ylläpitää sitä API:n tahdissa. Sillä on myös oma rakenteensa, joka on hyväksyttävä: se toimii gRPC:n päällä, sen viestit rakennetaan funktioilla user() ja system(), ja sen virheet ovat tyyppiä grpc.RpcError.

Milloin valita tämä SDK

Valinta seuraa luontevasti tilannettasi. Uudessa projektissa, joka on rakennettu nimenomaan Grok API:n päälle, natiivi SDK on ilmeinen lähtökohta: saat kaikki edellä mainitut edut ilman yhteensopivuusrajoituksia. Siitä tulee välttämätön heti, kun aiot käyttää xAI-kohtaisia ominaisuuksia, kuten X-hakua tai sisäänrakennettua verkkohakua, jotka toimivat täysimääräisesti vain tällä tavalla. Jos sinulla taas on olemassa olevaa koodia, joka on rakennettu OpenAI SDK:n päälle, älä kirjoita sitä uudelleen toistaiseksi: seuraava oppitunti näyttää, kuinka muokkaat sen vaihtamalla kaksi riviä.

Keskeiset asiat

  • Asenna komennolla pip install xai-sdk virtuaaliympäristöön
  • Client-luokka on sisäänmenopiste, ja se tunnistaa XAI_API_KEY:n automaattisesti
  • client.chat.create() luo keskustelun; chat.append(user(...)) lisää viestin, ja chat.sample() palauttaa vastauksen, joka luetaan kohdasta response.content
  • Suosi tätä SDK:ta uusissa projekteissa, jotka kohdistuvat yksinomaan Grok API:hun