文档中心

数据库工作台

SQL 任务

GenerateSQLFromNL

GenerateSQLFromNL

调用 GenerateSQLFromNL 接口将自然语言生成 SQL 语句。

请求类型

同步请求。

请求参数

名称	类型	是否必填	示例值	描述
InstanceID	String	是	mysql-bf120f******	数据库实例 ID。说明您可以按需选择以下接口查询实例 ID：您可以调用 DescribeDBInstances 接口查询 MySQL 的实例 ID。调用 DescribeDBInstances 接口查询 veDB MySQL 的实例 ID。
InstanceType	String	是	MySQL	数据库类型，当前支持的数据库如下所示。 MySQL：云数据库 MySQL 版。 VeDBMySQL：云数据库 veDB MySQL 版。 Postgre：云数据库 PostgreSQL 版。 Mongo：文档数据库 MongoDB 版。
Database	String	是	company	数据库名称，即指定在哪个数据库中查询。
Query	String	是	查询所有在北京工区工作的员工信息	待生成 SQL 语句的自然语言。
Tables	List\<String\>	否	["employee"]	数据表，即指定在哪些数据表中查询。说明当 InstanceType 取值为 Mongo 时，则必须为 Tables 指定一个值；当 InstanceType 取值非 Mongo 时，建议不要指定具体某张表，如果没有指定数据表，则自动联想待查询的数据表。
IsStream	Bool	否	false	服务端是否使用 SSE 流式返回。 false：服务端不使用 SSE 流式返回。 true：服务端使用 SSE 流式返回。

返回参数

名称	类型	示例值	描述
SQL	String	select * from employee where base_city = '北京';	LLM 根据自然语言生成的 SQL 语句。

请求示例

返回示例

错误码

更多详情，请参见错误码。

最近更新时间：2025.11.28 16:36:58

这个页面对您有帮助吗？

有用

有用

无用

无用