API/AI Gateway/自然言語から SQL へ

自然言語から SQL へ

POST/v1/ai/{project_id}/nl2sql

自然言語を、抽象構文ツリー (AST) パーサーによってチェックされる安全な読み取り専用の PostgreSQL クエリに変換します。

このページは自動翻訳されました。英語版が正式です。

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

リクエスト

パラメータ

パラメータ	種類	必須	説明
`question`	`string`	はい	プロジェクトのデータに関する自然言語の質問。
`dialect`	`string`	いいえ	データベースの方言。 `'postgresql'` または `'postgres'`を受け入れます。
`examples`	`object[]`	いいえ	クエリ生成をガイドするオプションの少数ショットの例 `[{ question, sql }]`。
`limit`	`number`	いいえ	モデルによって省略された場合に挿入される最大行制限 (デフォルトは `100`、最大 `1000`)。

セキュリティ

AST 突然変異ガード

情報

サーバーは、生成された SQL を返す前に、抽象構文ツリー (AST) エンジンを使用して解析します。

非 SELECT 変更ステートメント (INSERT、 UPDATE、 DELETE、 DROP、 ALTER、 TRUNCATE) は、 HTTP 400で即座に拒否されます。
システムカタログテーブル (pg_catalog、 information_schema) は厳密に許可されません。
モデルが LIMIT 句を省略した場合、サーバーは LIMIT 100 (上限は 1000) を挿入し、 limit_injected: trueをマークします。

v1.0 · 改訂 2026/10/31
↗ OpenAPI仕様↗ GitHub

← 前へ

RAG query & ingest