Python SDK for ZhiPu AI
The New Python SDK for Z.AI and ZhipuAI has released: z-ai-sdk-python! It is recommended to use this SDK for better, faster, and long-term support.
中文文档 | English
The official Python SDK for ZhipuAI's large model open interface, making it easier for developers to call ZhipuAI's open APIs.
pip install zhipuai| Package | Version | Purpose |
|---|---|---|
httpx |
>=0.23.0 |
HTTP client for API requests |
pydantic |
>=1.9.0,=4.0.0 |
Enhanced type hints support |
from zhipuai import ZhipuAI
# Initialize client
client = ZhipuAI(api_key="your-api-key")
# Create chat completion
response = client.chat.completions.create(
model="glm-4",
messages=[
{"role": "user", "content": "Hello, ZhipuAI!"}
]
)
print(response.choices[0].message.content)export ZHIPUAI_API_KEY="your-api-key"
export ZHIPUAI_BASE_URL="https://open.bigmodel.cn/api/paas/v4/" # Optionalfrom zhipuai import ZhipuAI
client = ZhipuAI(
api_key="your-api-key",
base_url="https://open.bigmodel.cn/api/paas/v4/" # Optional
)Customize client behavior with additional parameters:
from zhipuai import ZhipuAI
import httpx
client = ZhipuAI(
api_key="your-api-key",
timeout=httpx.Timeout(timeout=300.0, connect=8.0), # Request timeout
max_retries=3, # Retry attempts
base_url="https://open.bigmodel.cn/api/paas/v4/" # Custom API endpoint
)…from zhipuai import ZhipuAI
client = ZhipuAI(api_key="your-api-key")
response = client.chat.completions.create(
model="glm-4",
messages=[
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "Tell me a story about AI."}
],
stream=True
)
for chunk in response:
if chunk.choices[0].delta.content:
print(chunk.choices[0].delta)…from zhipuai import ZhipuAI
client = ZhipuAI(api_key="your-api-key")
response = client.chat.completions.create(
model="charglm-3",
messages=[
{
"role": "user",
"content": "Hello, how are you doing lately?"
}
],
meta={
"user_info": "I am a film director who specializes in music-themed movies.",
"bot_info": "You are a popular domestic female singer and actress with outstanding musical talent.",
"bot_name": "Xiaoya",
"user_name": "Director"
}
)
print(response)……The SDK provides comprehensive error handling:
from zhipuai import ZhipuAI
import zhipuai
client = ZhipuAI()
try:
response = client.chat.completions.create(
model="glm-4",
messages=[
{"role": "user", "content": "Hello, ZhipuAI!"}
]
)
print(response.choices[0].message.content)
except zhipuai.APIStatusError as err:
print(f"API Status Error: {err}")
except zhipuai.APITimeoutError as err:
print(f"Request Timeout: {err}")
except Exception as err:
print(f"Other Error: {err}")| Status Code | Error Type | Description |
|---|---|---|
| 400 | APIRequestFailedError |
Invalid request parameters |
| 401 | APIAuthenticationError |
Authentication failed |
| 429 | APIReachLimitError |
Rate limit exceeded |
| 500 | APIInternalError |
Internal server error |
| 503 | APIServerFlowExceedError |
Server overloaded |
| N/A | APIStatusError |
General API error |
For detailed version history and update information, please see Release-Note.md.
This project is licensed under the MIT License - see the LICENSE file for details.
Contributions are welcome! Please feel free to submit a Pull Request.
For questions and technical support, please visit ZhipuAI Open Platform or check our documentation.
No open issues yet, or sync has not completed.