predict-q-app

Описание

Генерирует определение Amazon Q App на основе предоставленного ввода: диалога или описания проблемы. Полученное определение приложения можно использовать для вызова CreateQApp. Этот API напрямую не создает Amazon Q Apps.

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

predict-q-app использует значения типов документов. Типы документов следуют модели данных JSON, где допустимыми значениями являются: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить данные в формате JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  predict-q-app
--instance-id <value>
[--options <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]

Параметры

--instance-id (строка)

Уникальный идентификатор экземпляра среды приложения Amazon Q Business.

--options (структура помеченного объединения)

Входные данные для генерации определения Q App: либо диалог, либо описание проблемы.

Примечание

Это структура помеченного объединения. Можно задать только один из следующих ключевых элементов верхнего уровня: conversation, problemStatement.

conversation -> (список)

Диалог, используемый в качестве входных данных для генерации определения Q App.

(структура)

Сообщение в диалоге, используемое в качестве входных данных для генерации определения Amazon Q App.

body -> (строка)

Текстовое содержимое сообщения в диалоге.

type -> (строка)

Тип сообщения в диалоге.

problemStatement -> (строка)

Описание проблемы, используемое в качестве входных данных для генерации определения Q App.

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

conversation=[{body=string,type=string},{body=string,type=string}],problemStatement=string

Синтаксис JSON:

{
  "conversation": [
    {
      "body": "string",
      "type": "USER"|"SYSTEM"
    }
    ...
  ],
  "problemStatement": "string"
}

--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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, 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.

Вывод

приложение -> (структура)

Сгенерированное определение Q приложения.

заголовок -> (строка)

Заголовок сгенерированного определения Q приложения.

описание -> (строка)

Описание сгенерированного определения Q приложения.

определение_приложения -> (структура)

Определение, указывающее карты и поток сгенерированного Q приложения.

карты -> (список)

Карты, составляющие определение Q приложения.

(структура помеченного объединения)

Свойства, определяющие карту ввода в Amazon Q приложении.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих ключевых слов верхнего уровня: textInput, qQuery, qPlugin, fileUpload, formInput.

текстовое_поле -> (структура)

Контейнер для свойств карты текстового поля.

заголовок -> (строка)

Заголовок или метка карты текстового поля.

id -> (строка)

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

тип -> (строка)

Тип карты.

подсказка -> (строка)

Текст подсказки для отображения в поле ввода текста.

значение_по_умолчанию -> (строка)

Значение по умолчанию для предварительной заполнения в поле ввода текста.

запрос -> (структура)

Контейнер для свойств карты ввода запроса.

заголовок -> (строка)

Заголовок или метка карты запроса.

id -> (строка)

Уникальный идентификатор карты запроса.

тип -> (строка)

Тип карты.

подсказка -> (строка)

Подсказка или инструкции, отображаемые для карты запроса.

источник_вывода -> (строка)

Источник или тип вывода для генерации на карте запроса.

фильтр_атрибутов -> (структура)

Включает фильтрацию ответов на основе атрибутов документа или полей метаданных.

и_все_фильтры -> (список)

Выполняет логическую операцию AND на всех предоставленных фильтрах.

(структура)

Критерии фильтрации, используемые для ответов на основе атрибутов документа или полей метаданных.

и_все_фильтры -> (список)

Выполняет логическую операцию AND на всех предоставленных фильтрах.

(… рекурсивно …)

или_все_фильтры -> (список)

Выполняет логическую операцию OR на всех предоставленных фильтрах.

(… рекурсивно …)

(… рекурсивно …)равно -> (структура)

Выполняет операцию равно над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue , longValue , stringListValue и stringValue.

имя -> (строка)

Идентификатор атрибута.

значение -> (структура помеченного объединения)

Значение атрибута.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих ключевых слов верхнего уровня: stringValue, stringListValue, longValue, dateValue.

строковое_значение -> (строка)

Строка.

список_строковых_значений -> (список)

Список строк.

(строка)

целое_значение -> (целое)

Целое число.

дата -> (метка_времени)

Дата, выраженная в формате ISO 8601.

Важно, чтобы часовой пояс был включен в формате ISO 8601 дата-время. Например, 2012-03-25T12:30:10+01:00 — это формат ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

содержит_все -> (структура)

Возвращает true, когда документ содержит все указанные атрибуты документа или поля метаданных. Поддерживается для следующих типов значений атрибутов документа: stringListValue.

имя -> (строка)

Идентификатор атрибута.

значение -> (структура помеченного объединения)

Значение атрибута.

Примечание

строковое_значение -> (строка)

Строка.

список_строковых_значений -> (список)

Список строк.

(строка)

целое_значение -> (целое)

Целое число.

дата -> (метка_времени)

Дата, выраженная в формате ISO 8601.

содержит_любой -> (структура)

Возвращает true, когда документ содержит любой из указанных атрибутов документа или полей метаданных. Поддерживается для следующих типов значений атрибутов документа: stringListValue.

имя -> (строка)

Идентификатор атрибута.

значение -> (структура помеченного объединения)

Значение атрибута.

Примечание

строковое_значение -> (строка)

Строка.

список_строковых_значений -> (список)

Список строк.

(строка)

целое_значение -> (целое)

Целое число.

дата -> (метка_времени)

Дата, выраженная в формате ISO 8601.

больше_чем -> (структура)

Выполняет операцию больше чем над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue.

имя -> (строка)

Идентификатор атрибута.

значение -> (структура помеченного объединения)

Значение атрибута.

Примечание

строковое_значение -> (строка)

Строка.

список_строковых_значений -> (список)

Список строк.

(строка)

целое_значение -> (целое)

Целое число.

дата -> (метка_времени)

Дата, выраженная в формате ISO 8601.

больше_или_равно -> (структура)

Выполняет операцию больше или равно над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue.

имя -> (строка)

Идентификатор атрибута.

значение -> (структура помеченного объединения)

Значение атрибута.

Примечание

строковое_значение -> (строка)

Строка.

список_строковых_значений -> (список)

Список строк.

(строка)

целое_значение -> (целое)

Целое число.

дата -> (метка_времени)

Дата, выраженная в формате ISO 8601.

меньше_чем -> (структура)

Выполняет операцию меньше чем над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue.

имя -> (строка)

Идентификатор атрибута.

значение -> (структура помеченного объединения)

Значение атрибута.

Примечание

строковое_значение -> (строка)

Строка.

список_строковых_значений -> (список)

Список строк.

(строка)

целое_значение -> (целое)

Целое число.

дата -> (метка_времени)

Дата, выраженная в формате ISO 8601.

меньше_или_равно -> (структура)

Выполняет операцию меньше или равно над двумя атрибутами документа или полями метаданных. Поддерживается для следующего типа значений атрибутов документа: dateValue и longValue.

имя -> (строка)

Идентификатор атрибута.

значение -> (структура помеченного объединения)

Значение атрибута.

Примечание

строковое_значение -> (строка)

Строка.

список_строковых_значений -> (список)

Список строк.

(строка)

целое_значение -> (целое)

Целое число.

дата -> (метка_времени)

Дата, выраженная в формате ISO 8601.

или_все_фильтры -> (список)

Выполняет логическую OR операцию над всеми предоставленными фильтрами.

(структура)

Критерии фильтрации, используемые для ответов на основе атрибутов документа или полей метаданных.

andAllFilters -> (список)

Выполняет логическую AND операцию над всеми предоставленными фильтрами.

(… рекурсивно …)

orAllFilters -> (список)

Выполняет логическую OR операцию над всеми предоставленными фильтрами.

(… рекурсивно …)

(… рекурсивно …)equalsTo -> (структура)

Выполняет операцию равенства над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue , longValue , stringListValue и stringValue .

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

Это структура помеченного объединения. Может быть установлено только одно из следующих значений верхнего уровня: stringValue, stringListValue, longValue, dateValue.

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (длинное целое)

Значение целого числа большого размера.

dateValue -> (метка времени)

Дата, представленная в формате ISO 8601.

Важно, чтобы часовой пояс был включен в формате ISO 8601 дата-время. Например, 2012-03-25T12:30:10+01:00 — это формат ISO 8601 дата-время для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (длинное целое)

Значение целого числа большого размера.

dateValue -> (метка времени)

Дата, представленная в формате ISO 8601.

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

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (длинное целое)

Значение целого числа большого размера.

dateValue -> (метка времени)

Дата, представленная в формате ISO 8601.

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

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (длинное целое)

Значение целого числа большого размера.

dateValue -> (метка времени)

Дата, представленная в формате ISO 8601.

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

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (длинное целое)

Значение целого числа большого размера.

dateValue -> (метка времени)

Дата, представленная в формате ISO 8601.

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

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (длинное целое)

Значение целого числа большого размера.

dateValue -> (метка времени)

Дата, представленная в формате ISO 8601.

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

Выполняет операцию меньше или равно над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue .

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (длинное целое)

Значение целого числа большого размера.

dateValue -> (метка времени)

Дата, представленная в формате ISO 8601.

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

Выполняет логическую операцию NOT над всеми предоставленными фильтрами.

andAllFilters -> (list)

Выполняет логическую операцию AND над всеми предоставленными фильтрами.

( … recursive … )

orAllFilters -> (list)

Выполняет логическую операцию OR над всеми предоставленными фильтрами.

( … recursive … )

( … recursive … )equalsTo -> (structure)

name -> (string)

Идентификатор атрибута.

value -> (tagged union structure)

Значение атрибута.

Примечание

Это структура Tagged Union. Может быть установлен только один из следующих ключей верхнего уровня: stringValue, stringListValue, longValue, dateValue.

stringValue -> (string)

Строка.

stringListValue -> (list)

Список строк.

(string)

longValue -> (long)

Длинное целое значение.

dateValue -> (timestamp)

Дата, выраженная в формате ISO 8601.

Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.

containsAll -> (structure)

name -> (string)

Идентификатор атрибута.

value -> (tagged union structure)

Значение атрибута.

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

Список строк.

(string)

longValue -> (long)

Длинное целое значение.

dateValue -> (timestamp)

Дата, выраженная в формате ISO 8601.

containsAny -> (structure)

name -> (string)

Идентификатор атрибута.

value -> (tagged union structure)

Значение атрибута.

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

Список строк.

(string)

longValue -> (long)

Длинное целое значение.

dateValue -> (timestamp)

Дата, выраженная в формате ISO 8601.

greaterThan -> (structure)

name -> (string)

Идентификатор атрибута.

value -> (tagged union structure)

Значение атрибута.

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

Список строк.

(string)

longValue -> (long)

Длинное целое значение.

dateValue -> (timestamp)

Дата, выраженная в формате ISO 8601.

greaterThanOrEquals -> (structure)

name -> (string)

Идентификатор атрибута.

value -> (tagged union structure)

Значение атрибута.

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

Список строк.

(string)

longValue -> (long)

Длинное целое значение.

dateValue -> (timestamp)

Дата, выраженная в формате ISO 8601.

lessThan -> (structure)

name -> (string)

Идентификатор атрибута.

value -> (tagged union structure)

Значение атрибута.

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

Список строк.

(string)

longValue -> (long)

Длинное целое значение.

dateValue -> (timestamp)

Дата, выраженная в формате ISO 8601.

lessThanOrEquals -> (structure)

name -> (string)

Идентификатор атрибута.

value -> (tagged union structure)

Значение атрибута.

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

Список строк.

(string)

longValue -> (long)

Длинное целое значение.

dateValue -> (timestamp)

Дата, выраженная в формате ISO 8601.

equalsTo -> (structure)

name -> (string)

Идентификатор атрибута.

value -> (tagged union structure)

Значение атрибута.

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

Список строк.

(string)

longValue -> (long)

Длинное целое значение.

dateValue -> (timestamp)

Дата, выраженная в формате ISO 8601.

containsAll -> (structure)

name -> (string)

Идентификатор атрибута.

value -> (tagged union structure)

Значение атрибута.

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

Список строк.

(string)

longValue -> (long)

Длинное целое значение.

dateValue -> (timestamp)

Дата, выраженная в формате ISO 8601.

containsAny -> (structure)

Возвращает true, когда документ содержит любой из указанных атрибутов документа или метаданных. Поддерживается для следующих типов значений атрибутов документа: stringListValue.

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

Это структура помеченного объединения. Может быть задан только один из следующих ключей верхнего уровня: stringValue, stringListValue, longValue, dateValue.

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (целое число типа long)

Целое значение типа long.

dateValue -> (метка времени)

Дата, выраженная в формате ISO 8601.

Важно включить часовой пояс в формате ISO 8601 date-time. Например, 2012-03-25T12:30:10+01:00 — это формат ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (целое число типа long)

Целое значение типа long.

dateValue -> (метка времени)

Дата, выраженная в формате ISO 8601.

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

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (целое число типа long)

Целое значение типа long.

dateValue -> (метка времени)

Дата, выраженная в формате ISO 8601.

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

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (целое число типа long)

Целое значение типа long.

dateValue -> (метка времени)

Дата, выраженная в формате ISO 8601.

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

name -> (строка)

Идентификатор атрибута.

value -> (структура помеченного объединения)

Значение атрибута.

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

Список строк.

(строка)

longValue -> (целое число типа long)

Целое значение типа long.

dateValue -> (метка времени)

Дата, выраженная в формате ISO 8601.

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

Контейнер для свойств карточки ввода плагина.

title -> (строка)

Заголовок или метка карточки плагина.

id -> (строка)

Уникальный идентификатор карточки плагина.

type -> (строка)

Тип карточки.

prompt -> (строка)

Подсказка или инструкции, отображаемые для карточки плагина.

pluginId -> (строка)

Уникальный идентификатор плагина, используемого карточкой.

actionIdentifier -> (строка)

Идентификатор действия, которое должна выполнить карточка плагина.

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

Контейнер для свойств карточки загрузки файла.

title -> (строка)

Заголовок или метка карточки загрузки файла.

id -> (строка)

Уникальный идентификатор карточки загрузки файла.

type -> (строка)

Тип карточки.

filename -> (строка)

Значение по умолчанию для имени загружаемого файла.

fileId -> (строка)

Идентификатор предварительно загруженного файла, связанного с карточкой.

allowOverride -> (булево значение)

Флаг, указывающий, может ли пользователь заменить файл по умолчанию.

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

Контейнер для свойств карточки ввода формы.

title -> (строка)

Заголовок или метка карточки ввода формы.

id -> (строка)

Уникальный идентификатор карточки ввода формы.

type -> (строка)

Тип карточки.

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

Метаданные, определяющие данные карточки ввода формы.

schema -> (документ)

JSON-схема, определяющая структуру данных ответа.

computeMode -> (строка)

Режим вычисления карточки ввода формы. Этот параметр определяет, могут ли отдельные участники сеанса сбора данных отправлять несколько ответов или один ответ. Режим вычисления append позволит участникам отправлять одну и ту же форму несколько раз с разными значениями. Режим вычисления replace перепишет текущее значение для каждого участника.

initialPrompt -> (строка)

Первоначальная подсказка, отображаемая при запуске Q-приложения.

problemStatement -> (строка)

Заявление о проблеме, извлеченное из входящего разговора, если предоставлено.

END_OF_DOCUMENT_MARKER