快速上手

跟着这篇文档走 5 分钟,你会:

1. 拿到一个 API Key
2. 用命令行问出第一个数据问题
3. 把同样的查询写进 Python 脚本

1. 申请 API Key

打开 控制台,登录后在左侧菜单找到 API Keys → 新建。给 Key 起个名字(比如 dev-laptop),点确定后会显示一串以 bd_live_ 开头的字符串。

:::danger 这串 Key 只显示一次 关闭弹窗后无法再看到。请立刻复制保存到密码管理器或环境变量里。 :::

把它写入环境变量:

export BEYONDATA_API_KEY="bd_live_xxxxxxxxxxxxxxxx"

2. 第一个查询(命令行)

beyondata ask "上周销售额最高的三个产品是什么?"

输出大致是这样:

正在分析问题... ✓
生成 SQL... ✓
执行查询... ✓

| 产品名   | 销售额(元) |
|----------|-------------|
| 商品 A   | 128,400     |
| 商品 B   |  97,200     |
| 商品 C   |  84,500     |

耗时 1.2 秒

3. 同样的查询,写进 Python

from beyondata import Client

client = Client()  # 自动读取 BEYONDATA_API_KEY 环境变量

result = client.ask("上周销售额最高的三个产品是什么?")

for row in result.rows:
    print(row["产品名"], row["销售额"])

接下来

• 想接入你自己的数据库?看 连接数据源
• 想了解所有 CLI 子命令?看 命令行参考
• 觉得效果不准确?看 优化查询效果

:::tip 一键打开 LLM 助手 所有文档页都支持「复制为 Markdown」和「在 ChatGPT 中打开」,方便你边读边问。 :::