API/AI Gateway/Natuurlijke taal naar SQL

Natuurlijke taal naar SQL

POST/v1/ai/{project_id}/nl2sql

Converteert natuurlijke taal naar veilige, alleen-lezen PostgreSQL-query's die worden gecontroleerd door een abstracte syntaxisboom (AST)-parser.

Deze pagina is automatisch vertaald. De Engelse versie is gezaghebbend.

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
  }
}

Verzoek

Parameters

Parameter	Typ	Vereist	Beschrijving
`question`	`string`	ja	Vraag in natuurlijke taal over de gegevens van het project.
`dialect`	`string`	nee	Database-dialect. Accepteert `'postgresql'` of `'postgres'`.
`examples`	`object[]`	nee	Optionele voorbeelden van enkele shots `[{ question, sql }]` die het genereren van query's begeleiden.
`limit`	`number`	nee	Maximale geïnjecteerde rijlimiet indien weggelaten door het model (standaard `100`, max `1000`).

Beveiliging

AST Mutatiewachters

Info

De server parseert de gegenereerde SQL met een Abstract Syntax Tree (AST)-engine voordat deze wordt geretourneerd:

Elke niet-SELECT-mutatie-instructie (INSERT, UPDATE, DELETE, DROP, ALTER, TRUNCATE) wordt onmiddellijk afgewezen met HTTP 400.
Systeemcatalogustabellen (pg_catalog, information_schema) zijn ten strengste niet toegestaan.
Als het model een LIMIT-clausule weglaat, injecteert de server LIMIT 100 (met een maximum van 1000) en markeert limit_injected: true.

v1.0 · herzien 31 okt 2026
↗ OpenAPI-specificatie↗ GitHub

← VORIGE

RAG query & ingest