快速上手

先用一组小数据走完“提问、查看 SQL、确认执行”的流程，再接入自己的业务数据。

准备示例数据#

完成安装后，打开中文工作区并填写数据库令牌。仓库中的 examples/nl2sql/cases.json 提供了送货记录和考试成绩示例；可以通过工作区的数据管理功能或 POST /datasets 导入。

数据集名称、字段说明和关联关系会参与查询规划。字段说明应解释业务含义，例如数量的单位、日期代表的事件，以及缺失值如何理解。

用一句话提问#

选择 deliveries 数据集，输入：

按供应商汇总送货数量，按总量从高到低排序。

查看系统识别出的分组字段、求和字段和排序方式，再检查 SQL。参考查询如下：

SELECT supplier, SUM(quantity) AS total_quantity
FROM deliveries
GROUP BY supplier
ORDER BY total_quantity DESC NULLS LAST;

算术与分组由 PostgreSQL 执行。JEV 用于理解请求，以及判断需要语义解释的条件。

检查并确认#

如果页面要求复核，请先检查候选解释。修改解释会重新生成预览；只有确认后才会执行符合要求的查询。写入操作还需要检查变更预览并单独提交。

结果为空与评估尚未完成是两种不同情况。看到 UNKNOWN 或 NOT_EVALUATED 时，不要将其理解为“不匹配”。

验证教程文件#

在仓库目录运行以下命令，可检查教程数据与预期结构，不调用模型：

python examples/nl2sql/compare.py --validate-only

实际的规划或模型对比会产生模型调用。接下来可以阅读SQL 示例或查询工作区指南。

本页介绍用法与注意事项。完整参数及详细约定请参阅对应英文文档。