Dataherald项目中SQL生成API的正确使用方法

在使用Dataherald项目进行SQL生成时，开发者可能会遇到一些常见问题。本文将详细介绍如何正确使用SQL生成API，避免常见的错误配置。

问题背景

在Dataherald项目中，开发者通过API可以连接MSSQL数据库、同步表结构并创建查询提示。但在实际使用SQL生成功能时，可能会遇到类似"Could not find stored procedure"的错误提示。这通常是由于请求体配置不当导致的。

正确的API请求格式

要正确使用SQL生成API，请求体应该遵循以下格式：

{
  "low_latency_mode": false,
  "llm_config": {
    "llm_name": "gpt-3.5-turbo"
  },
  "evaluate": false,
  "metadata": {}
}

关键点在于：

1. 不需要包含"sql"字段，除非你确实想手动提供SQL查询
2. "llm_config"中的"api_base"字段不是必需的
3. 保持其他配置项的简洁性

常见错误分析

开发者常犯的错误是在请求体中包含了"sql": "string"这样的占位符值。Dataherald系统会尝试将这个"string"值作为实际的SQL语句执行，从而导致存储过程查找失败的错误。

最佳实践建议

1. 仅提供必要参数：除非有特殊需求，否则只需提供最基本的配置参数
2. 理解字段用途：
   • "low_latency_mode"：用于控制响应速度
   • "llm_config"：配置使用的语言模型
   • "evaluate"：是否评估生成的SQL
3. 错误处理：当API返回错误时，首先检查请求体是否符合规范

总结

Dataherald的SQL生成功能是一个强大的工具，但需要正确配置才能发挥其作用。通过遵循本文提供的建议和正确格式，开发者可以避免常见的配置错误，顺利生成所需的SQL查询。记住，简洁的配置往往是最有效的，不需要的字段应当省略。