Spec-Zone.ru › AWS CLI v2

[ aws . bedrock-agent-runtime ]

generate-query

Описание

Генерирует SQL-запрос на основе естественного языка запроса. Дополнительную информацию см. в руководстве пользователя Amazon Bedrock в разделе «Генерация запроса для структурированных данных».

См. также: Документацию API AWS

Синтаксис

  generate-query
--query-generation-input <value>
--transformation-configuration <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--query-generation-input (структура)

Указывает информацию о запросе на естественном языке для преобразования в SQL.

text -> (строка)

Текст запроса.

type -> (строка)

Тип запроса.

Краткая синтаксическая запись:

text=string,type=string

Синтаксис JSON:

{
  "text": "string",
  "type": "TEXT"
}

--transformation-configuration (структура)

Указывает конфигурации для преобразования запроса на естественном языке в SQL.

mode -> (строка)

Режим преобразования.

textToSqlConfiguration -> (структура)

Указывает конфигурации для преобразования текста в SQL.

knowledgeBaseConfiguration -> (структура)

Указывает конфигурации для использования базы знаний в преобразовании.

knowledgeBaseArn -> (строка)

ARN базы знаний

type -> (строка)

Тип ресурса для использования в преобразовании.

Краткая синтаксическая запись:

mode=string,textToSqlConfiguration={knowledgeBaseConfiguration={knowledgeBaseArn=string},type=string}

Синтаксис JSON:

{
  "mode": "TEXT_TO_SQL",
  "textToSqlConfiguration": {
    "knowledgeBaseConfiguration": {
      "knowledgeBaseArn": "string"
    },
    "type": "KNOWLEDGE_BASE"
  }
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному в --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с использованием значения, предоставленного в JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит JSON-скелет в стандартный вывод без отправки запроса API. Если указано без значения или со значением input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если указано yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если указано значение output, он проверит входные данные команд и вернёт пример выходного JSON для этой команды. Сгенерированный JSON-скелет не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-скелете.

Глобальные параметры

--debug (логическое)

Включить отладочную запись журнала.

--endpoint-url (строка)

Переопределить стандартный URL команды заданным URL.

--no-verify-ssl (логическое)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого подключения SSL AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет стандартное поведение проверки сертификатов SSL.

--no-paginate (логическое)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования для вывода команд.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла аутентификации.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию данного инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • on
  • off
  • auto

--no-sign-request (логическое)

Не подписывать запросы. Кредиты не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл с набором сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования, который будет использоваться для бинарных блоков. Формат по умолчанию — base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная в base64 строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое отображается как двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настроек cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое)

Отключить пейджер CLI для вывода.

--cli-auto-prompt (логическое)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (логическое)

Отключить автоматическое запросы параметров ввода CLI.

Вывод

queries -> (список)

Список объектов, каждый из которых определяет сгенерированный запрос, который может соответствовать запросам на естественном языке.

(структура)

Содержит информацию о запросе, сгенерированном для запроса на естественном языке.

sql -> (строка)

SQL-запрос, соответствующий запросу на естественном языке.

type -> (строка)

Тип преобразованного запроса.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API