HEYQUANT / DOCUMENTATION

快速开始

从公开仓库安装 SDK，发起第一次数据集发现请求。

安装客户端

当前客户端处于早期预览阶段。从公开仓库以开发模式安装；需要 Python 3.11 或更新版本。

git clone https://github.com/heyroute-ai/heyquant.git
cd heyquant
python -m pip install -e .

配置访问

运行请求前，需要从服务提供方获得有效的服务地址与 API Key。官网不发放密钥。将 HEYQUANT_BASE_URL 和 HEYQUANT_API_KEY 设置为环境变量；不要将实际密钥提交到代码仓库或粘贴进公开示例。

发起第一次请求

使用上下文管理器自动关闭连接。list_datasets() 返回服务端的 JSON；文档不假定其完整结构。

import os
from heyquant import HeyQuantClient

with HeyQuantClient(
    base_url=os.environ["HEYQUANT_BASE_URL"],
    api_key=os.environ["HEYQUANT_API_KEY"],
) as client:
    print(client.list_datasets())

下一步

查看查询示例，或了解导出流程。如果尚未取得服务访问权限，可以先体验首页的合成数据演示。