API/AI Gateway/Естественный язык в SQL

Естественный язык в SQL

POST/v1/ai/{project_id}/nl2sql

Преобразует естественный язык в безопасные запросы PostgreSQL только для чтения, проверяемые анализатором абстрактного синтаксического дерева (AST).

Эта страница была переведена автоматически. Английская версия является авторитетной.

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 · переработанный 31 окт. 2026 г.
↗ Спецификация OpenAPI↗ ГитХаб

← ПРЕДЫДУЩИЙ

RAG query & ingest