xAI SDK: client.chat.create
F'din il-paġna
Aġġornat fit-3 ta’ Novembru, 2026. Il-verżjoni preċedenti kienet tassumi li l-
xai-sdkkien juża l-interfaċċa tal-OpenAI SDK: messaġġi bħala dizzjunarji,response.choices[0].message.content, il-parametrustream=True, u moduluxai_sdk.errorsli ma jeżistix. Bis-SDK attwali (verżjoni 1.21.0), dak il-kodici jfalli fl-ewwel sejħa:ValueError: unknown enum label "user". Din il-lezzjoni issa ssegwi r-README uffiċjali tal-SDK, u kull eżempju ġie eżegwit kontra l-API ta’ xAI (b’ċavetta fittizja, biex jiġu vverifikati l-mogħdija tas-sejħa u l-iżbalji). Sorsi: xAI Python SDK · Best practices (xAI) · Debugging Errors (xAI).
L-SDK nativ ta’ xAI
L-SDK uffiċjali ta’ xAI għal Python, xai-sdk, ma jużax il-punt tat-tmiem REST Chat Completions: din hija librerija gRPC, b’klijent sinkronu (Client) u klijent asinkronu (AsyncClient), għal Python 3.10 ‘il fuq. Ma jipprovax jimita l-OpenAI SDK, u dik hija l-ewwel ħaġa li għandek iżżomm f’moħħok: l-oġġetti, il-metodi u l-iżbalji tiegħu għandhom l-istruttura tagħhom stess. Biex tuża mill-ġdid kodiċi miktub għal OpenAI, il-lezzjoni li jmiss turi t-triq l-oħra, l-OpenAI SDK ikkonfigurat għall-API ta’ xAI.
Installazzjoni u awtentikazzjoni
pip install xai-sdk
L-awtentikazzjoni tuża ċavetta API maħluqa fil-konsoll ta’ xAI. Poġġiha fil-varjabbli tal-ambjent XAI_API_KEY, li l-klijent jaqra awtomatikament:
export XAI_API_KEY="your-api-key"
Konversazzjoni, mhux talba
Ma’ dan l-SDK, client.chat.create() ma tibgħat xejn: toħloq oġġett konversazzjoni (chat), li miegħu żżid il-messaġġi b’append, imbagħad titlob tweġiba b’sample(). Il-messaġġi jinbnew bil-funzjonijiet system, user, u assistant mill-modulu xai_sdk.chat, mhux b’dizzjunarji.
from xai_sdk import Client
from xai_sdk.chat import system, user
client = Client() # jaqra XAI_API_KEY
chat = client.chat.create(
model="grok-4.7",
messages=[system("You are a helpful assistant. Respond in French.")],
)
chat.append(user("Explain deep learning in 3 sentences."))
response = chat.sample()
print(response.content)
It-tweġiba tesponi t-test tagħha direttament f’response.content, flimkien ma’ finish_reason, usage (tokens konsumati), reasoning_content għal mudelli li jesponuha, u citations meta tkun saret tfittxija.
L-API tibqa’ mingħajr stat: l-oġġett chat iżomm l-istorja għalik. Għal konversazzjoni b’diversi dawriet, żid it-tweġiba mal-fil qabel il-mistoqsija li jmiss:
chat.append(response)
chat.append(user("Give a concrete example of an application."))
print(chat.sample().content)
Parametri tal-ġenerazzjoni
Il-parametri jgħaddu lil client.chat.create() u japplikaw għall-konversazzjoni kollha:
chat = client.chat.create(
model="grok-4.7",
messages=[system("Respond only in JSON.")],
temperature=0.7,
top_p=0.95,
reasoning_effort="medium",
)
model: l-identifikatur tal-mudell. xAI jirrakkomandagrok-4.7għall-użi kollha.messages: il-messaġġi inizjali, mibnija b’system,user, uassistant.temperature: l-API taċċetta minn 0 sa 2, iżda xAI tillimitaha għal 1 lil hinn minn hekk u tirrakkomanda 0.7, b’top_pfuq 0.95.max_tokens: in-numru massimu ta’ tokens iġġenerati. L-aħjar prattiki ta’ xAI jirrakkomandaw li tistabbilixxih ogħla mill-itwal tweġiba mistennija, jew tħalli l-valur predefinit.reasoning_effort: il-fond tar-raġunament, minnnonesahigh(uxhighfuq xi mudelli). Il-valur predefinit jiddependi fuq il-mudell: xAI jirrakkomanda li tistabbilixxih espliċitament fuq kull talba, u tinnotah ma’ kull riżultat.response_format,tools,tool_choice: outputs strutturati u sejħiet ta’ għodod, koperti aktar tard fil-kors.
Jeżisti wkoll stop (sa erba’ sekwenzi), iżda l-aħjar prattiki ta’ xAI jispeċifikaw li l-mudelli tar-raġunament ma jaċċettawx dan, u lanqas presence_penalty u frequency_penalty.
Tweġibiet b’fluss (Streaming)
xAI jirrakkomanda l-fluss (streaming), speċjalment ma’ mudelli tar-raġunament, li t-tweġibiet tagħhom jistgħu jieħdu ħafna ħin biex jaslu. Ma jużax parametru: il-konversazzjoni toffri metodu ieħor, stream(), li jirritorna par (response, chunk) f’kull pass. chunk.content fih il-framment tat-test li għadu kif wasal, u response jakkumula t-tweġiba sħiħa matul il-fluss.
chat = client.chat.create(model="grok-4.7")
chat.append(user("Write a short article on generative AI."))
for response, chunk in chat.stream():
print(chunk.content, end="", flush=True)
print()
chat.append(response) # it-tweġiba sħiħa tingħaqad mal-istorja
Ġestjoni tal-iżbalji
Peress li l-SDK jitkellem gRPC, l-iżbalji tiegħu huma grpc.RpcError (asinkronikament, grpc.aio.AioRpcError, li jwirtu minnhom). Taqra l-kodiċi tagħhom b’.code() u l-messaġġ b’.details():
import grpc
from xai_sdk import Client
from xai_sdk.chat import user
client = Client()
chat = client.chat.create(model="grok-4.7")
chat.append(user("Hello"))
try:
response = chat.sample()
print(response.content)
except grpc.RpcError as error:
if error.code() == grpc.StatusCode.DEADLINE_EXCEEDED:
print("Timeout exceeded: the request took too long.")
else:
print(f"Error {error.code().name}: {error.details()}")
Hemm tliet imġibiet li jiswa li tkun taf. L-SDK jipprova mill-ġdid waħdu it-talbiet li jfallu b’UNAVAILABLE, sa ħames tentattivi b’dewmien dejjem jiżdied; ir-README tiegħu juri kif iżżid kodiċijiet oħra ma’ din il-lista, pereżempju RESOURCE_EXHAUSTED, il-kodiċi gRPC għal kwoti eżawriti. Il-ħin ta’ stennija massimu (timeout) huwa predefinit għal 27 minuta għal kwalunkwe talba u jiġi stabbilit fil-ħolqien tal-klijent (Client(timeout=…), f’sekondi). Tnaqqsux wisq: xAI jħeġġeġ li tippjana għal mill-inqas 900 sekonda għal kull talba mal-mudelli tar-raġunament tiegħu. Fl-aħħar nett, ċavetta API invalida tinmanifesta ruħha bħala l-kodiċi INVALID_ARGUMENT u l-messaġġ “Incorrect API key provided”: dan huwa dak li tirritorna l-API llum, ivverifikat fit-3 ta’ Novembru, 2026.
Sejħiet asinkroni
Għal applikazzjoni asyncio, ibdel Client b’AsyncClient. Il-ħolqien tal-konversazzjoni jibqa’ sinkronu; sample() u stream() huma dawk li jistennew (await):
import asyncio
from xai_sdk import AsyncClient
from xai_sdk.chat import user
async def main():
client = AsyncClient()
chat = client.chat.create(model="grok-4.7")
chat.append(user("Hello"))
response = await chat.sample()
print(response.content)
chat.append(response)
chat.append(user("Summarize your response in one sentence."))
async for response, chunk in chat.stream():
print(chunk.content, end="", flush=True)
asyncio.run(main())
Punti Ewlenin
xai-sdkhuwa SDK gRPC, bl-interfaċċa tiegħu stess: ma jerġax juża l-forma jew l-oġġetti tal-OpenAI SDKclient.chat.create()toħloq konversazzjoni;chat.append(user(...))iżid messaġġ,chat.sample()tirritorna t-tweġiba, li taqra f’response.content- Il-messaġġi jinbnew b’
system,user, uassistantminnxai_sdk.chat; id-dizzjunarji jikkawżaw li s-sejħa tfalli - Il-fluss (streaming) juża
chat.stream(), li jirritorna pari(response, chunk) - L-iżbalji huma
grpc.RpcError;UNAVAILABLEjiġi ppruvat mill-ġdid awtomatikament, il-ħin massimu predefinit huwa 27 minuta