Python SDK | Alephant Documentation

官方 Alephant Analytics Python SDK 让 Python 脚本或数据科学 notebook 能够访问 Alephant Analytics API。它同时支持同步和异步执行。

安装

通过 pip 安装 SDK：

$ pip install alephantai-analytics-api

初始化

您可以根据架构初始化同步或异步客户端。

同步客户端

1 import os
2 from alephant_logs_collector import (
3     LogsCollectorAnalyticsClient,
4     LogsCollectorAnalyticsClientEnvironment,
5 )
6 
7 client = LogsCollectorAnalyticsClient(
8     environment=LogsCollectorAnalyticsClientEnvironment.DEVELOPMENT,
9 )

异步客户端

适用于 FastAPI、异步 Web 框架或高并发应用程序：

1 import os
2 from alephant_logs_collector import (
3     AsyncLogsCollectorAnalyticsClient,
4     LogsCollectorAnalyticsClientEnvironment,
5 )
6 
7 async_client = AsyncLogsCollectorAnalyticsClient(
8     environment=LogsCollectorAnalyticsClientEnvironment.DEVELOPMENT,
9 )

使用示例

冒烟测试

使用公开 health 端点验证 SDK 能否连接到 Analytics 开发服务。

1 response = client.analytics_atomic.get_health()
2 print(response.data.status)

实时 24 小时面板概览

获取展示热门模型和密钥的滚动实时 24 小时仪表板式面板。

1 def fetch_live_summary():
2     try:
3         response = client.analytics_saas.get_saas_live24h(
4             limit=5,
5             authorization=f"Bearer {os.environ['ALEPHANT_API_TOKEN']}",
6             x_workspace_id=os.environ["ALEPHANT_WORKSPACE_ID"],
7         )
8         print(response.data)
9     except Exception as e:
10         print(f"Failed to fetch live summary: {e}")

获取用量序列

获取指定日期范围内的每日用量指标。

1 async def get_usage_series():
2     response = await async_client.analytics_saas.get_saas_usage(
3         date_from="2026-03-01",
4         date_to="2026-03-31",
5         authorization=f"Bearer {os.environ['ALEPHANT_API_TOKEN']}",
6         x_workspace_id=os.environ["ALEPHANT_WORKSPACE_ID"],
7     )
8 
9     print(response.data)

错误处理

任何产生 4xx 或 5xx 状态码的请求都会抛出与错误类型相对应的异常（ApiError、RateLimitError 等）。在 Python 中原生捕获它们以执行回退逻辑或指数退避。