API/AI Gateway/Lenguaje natural a SQL

Lenguaje natural a SQL

POST/v1/ai/{project_id}/nl2sql

Convierte el lenguaje natural en consultas PostgreSQL seguras y de solo lectura verificadas por un analizador de árbol de sintaxis abstracta (AST).

Esta página fue traducida automáticamente. La versión en inglés es autorizada.

nl2sql.tstypescript

const { data, error } = await aura.ai.nl2sql(
  'What are the 10 most recent user registrations?',
  { dialect: 'postgresql', limit: 10 }
)
console.log('Safe SQL Query:', data?.sql)
console.log('Injected Limit:', data?.limit, 'Confidence:', data?.confidence)

200.jsonjson

{
  "data": {
    "sql": "SELECT id, email, created_at FROM users ORDER BY created_at DESC LIMIT 10;",
    "explanation": "Retrieves the latest 10 users ordered by creation timestamp.",
    "confidence": 0.96,
    "limit_injected": false,
    "limit": 10
  }
}

Solicitar

Parámetros

Parámetro	Tipo	Requerido	Descripción
`question`	`string`	si	Pregunta en lenguaje natural sobre los datos del proyecto.
`dialect`	`string`	no	Dialecto de base de datos. Acepta `'postgresql'` o `'postgres'`.
`examples`	`object[]`	no	Ejemplos opcionales de pocas tomas `[{ question, sql }]` que guían la generación de consultas.
`limit`	`number`	no	Límite máximo de fila inyectado si el modelo lo omite (predeterminado `100`, máximo `1000`).

Seguridad

AST Guardias de mutación

Información

El servidor analiza el SQL generado con un motor de árbol de sintaxis abstracta (AST) antes de devolverlo:

Cualquier declaración de mutación que no sea SELECT (INSERT, UPDATE, DELETE, DROP, ALTER, TRUNCATE) se rechaza inmediatamente con HTTP 400.
Las tablas de catálogo del sistema (pg_catalog, information_schema) están estrictamente prohibidas.
Si el modelo omite una cláusula LIMIT, el servidor inyecta LIMIT 100 (con un límite de 1000) y marca limit_injected: true.

v1.0 · revisado 31 oct 2026
↗ Especificaciones de OpenAPI↗ GitHub

← ANTERIOR

RAG query & ingest