API/AI Gateway/Natürliche Sprache zu SQL

Natürliche Sprache zu SQL

POST/v1/ai/{project_id}/nl2sql

Konvertiert natürliche Sprache in sichere, schreibgeschützte PostgreSQL-Abfragen, die von einem Abstract Syntax Tree (AST)-Parser überprüft werden.

Diese Seite wurde automatisch übersetzt. Maßgeblich ist die englische Version.

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

Anfrage

Parameter

Parameter	Typ	Erforderlich	Beschreibung
`question`	`string`	ja	Frage in natürlicher Sprache zu den Daten des Projekts.
`dialect`	`string`	Nein	Datenbankdialekt. Akzeptiert `'postgresql'` oder `'postgres'`.
`examples`	`object[]`	Nein	Optionale wenige Beispiele `[{ question, sql }]` als Leitfaden für die Abfragegenerierung.
`limit`	`number`	Nein	Maximales Zeilenlimit, das eingefügt wird, wenn es vom Modell weggelassen wird (Standard `100`, max. `1000`).

Sicherheit

AST Mutationswächter

Infos

Der Server analysiert das generierte SQL mit einer Abstract Syntax Tree (AST)-Engine, bevor es es zurückgibt:

Jede Nicht-SELECT-Mutationsanweisung (INSERT, UPDATE, DELETE, DROP, ALTER, TRUNCATE) wird sofort mit HTTP 400 abgelehnt.
Systemkatalogtabellen (pg_catalog, information_schema) sind strengstens verboten.
Wenn das Modell eine LIMIT-Klausel weglässt, injiziert der Server LIMIT 100 (begrenzt auf 1000) und markiert limit_injected: true.

v1.0 · überarbeitet 31.10.2026
↗ OpenAPI-Spezifikation↗ GitHub

← VORHERIGES

RAG query & ingest