chat-sync

Описание

Запускает или продолжает беседа Amazon Q Business без потоковой передачи.

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

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

Синтаксис

  chat-sync
--application-id <value>
[--user-id <value>]
[--user-groups <value>]
[--user-message <value>]
[--attachments <value>]
[--action-execution <value>]
[--auth-challenge-response <value>]
[--conversation-id <value>]
[--parent-message-id <value>]
[--attribute-filter <value>]
[--chat-mode <value>]
[--chat-mode-configuration <value>]
[--client-token <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]

Параметры

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

Идентификатор приложения Amazon Q Business, связанного с беседами Amazon Q Business.

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

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

--user-groups (список)

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

(строка)

Синтаксис:

"string" "string" ...

--user-message (строка)

Сообщение конечного пользователя в беседе.

--attachments (список)

Список файлов, загруженных непосредственно во время чата. Вы можете загрузить не более 5 файлов по 10 МБ каждый.

(структура)

Это либо файл, загруженный непосредственно в чат веб-приложения, либо ссылка на существующее вложение, которое является частью чата веб-приложения.

data -> (двоичные данные)

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

name -> (строка)

Имя файла вложения.

copyFrom -> (структура помеченных объединений)

Ссылка на существующее вложение.

Примечание

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

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

Ссылка на вложение в существующей беседе.

conversationId -> (строка)

Уникальный идентификатор беседы Amazon Q Business.

attachmentId -> (строка)

Уникальный идентификатор вложения Amazon Q Business.

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

data=blob,name=string,copyFrom={conversation={conversationId=string,attachmentId=string}} ...

Синтаксис JSON:

[
  {
    "data": blob,
    "name": "string",
    "copyFrom": {
      "conversation": {
        "conversationId": "string",
        "attachmentId": "string"
      }
    }
  }
  ...
]

--action-execution (структура)

Запрос от конечного пользователя на выполнение действия плагина Amazon Q Business.

pluginId -> (строка)

Идентификатор плагина, к которому прикреплено действие.

payload -> (словарь)

Сопоставление имен полей со значениями полей в вводе, который конечный пользователь предоставляет Amazon Q Business для выполнения действия плагина.

key -> (строка)

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

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

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

Содержание поля ввода пользователя в полезной нагрузке выполнения действия плагина.

payloadFieldNameSeparator -> (строка)

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

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

pluginId=string,payload={KeyName1={},KeyName2={}},payloadFieldNameSeparator=string

Синтаксис JSON:

{
  "pluginId": "string",
  "payload": {"string": {
        "value": {...}
      }
    ...},
  "payloadFieldNameSeparator": "string"
}

--auth-challenge-response (структура)

Ответ о проверке аутентификации, полученный от стороннего сервера аутентификации для Amazon Q Business.

responseMap -> (словарь)

Сопоставление пар ключ-значение в ответе на вызов аутентификации.

key -> (строка)

value -> (строка)

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

responseMap={KeyName1=string,KeyName2=string}

Синтаксис JSON:

{
  "responseMap": {"string": "string"
    ...}
}

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

Идентификатор беседы Amazon Q Business.

--parent-message-id (строка)

Идентификатор предыдущего системного сообщения в беседе.

--attribute-filter (структура)

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

andAllFilters -> (список)

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

(структура)

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

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 -> (структура)

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

name -> (строка)

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

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

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое)

Целое значение.

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

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

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

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

name -> (строка)

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

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

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое)

Целое значение.

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

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

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

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

name -> (строка)

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

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

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое)

Целое значение.

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

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

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

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

name -> (строка)

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

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

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое)

Целое значение.

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

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

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

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

name -> (строка)

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

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

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое)

Целое значение.

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

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

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

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

name -> (строка)

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

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

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое)

Целое значение.

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

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

orAllFilters -> (список)

Выполняет логическую операцию 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 -> (структура)

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

name -> (строка)

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

value -> (структура помеченных союзов)

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое число)

Целое число со знаком.

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

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

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

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

name -> (строка)

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

value -> (структура помеченных союзов)

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое число)

Целое число со знаком.

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

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

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

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

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)

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

name -> (string)

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

value -> (tagged union structure)

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

Примечание

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

stringValue -> (string)

Строка.

stringListValue -> (list)

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

(string)

longValue -> (long)

Значение long integer.

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)

Значение long integer.

dateValue -> (timestamp)

Дата, выраженная в виде строки ISO 8601.

containsAny -> (structure)

name -> (string)

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

value -> (tagged union structure)

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

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

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

(string)

longValue -> (long)

Значение long integer.

dateValue -> (timestamp)

Дата, выраженная в виде строки ISO 8601.

greaterThan -> (structure)

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

name -> (string)

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

value -> (tagged union structure)

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

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

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

(string)

longValue -> (long)

Значение long integer.

dateValue -> (timestamp)

Дата, выраженная в виде строки ISO 8601.

greaterThanOrEquals -> (structure)

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

name -> (string)

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

value -> (tagged union structure)

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

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

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

(string)

longValue -> (long)

Значение long integer.

dateValue -> (timestamp)

Дата, выраженная в виде строки ISO 8601.

lessThan -> (structure)

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

name -> (string)

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

value -> (tagged union structure)

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

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

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

(string)

longValue -> (long)

Значение long integer.

dateValue -> (timestamp)

Дата, выраженная в виде строки ISO 8601.

lessThanOrEquals -> (structure)

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

name -> (string)

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

value -> (tagged union structure)

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

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

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

(string)

longValue -> (long)

Значение long integer.

dateValue -> (timestamp)

Дата, выраженная в виде строки ISO 8601.

equalsTo -> (structure)

name -> (string)

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

value -> (tagged union structure)

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

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

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

(string)

longValue -> (long)

Значение long integer.

dateValue -> (timestamp)

Дата, выраженная в виде строки ISO 8601.

containsAll -> (structure)

name -> (string)

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

value -> (tagged union structure)

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

Примечание

stringValue -> (string)

Строка.

stringListValue -> (list)

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

(string)

longValue -> (long)

Значение long integer.

dateValue -> (timestamp)

Дата, выраженная в виде строки ISO 8601.

containsAny -> (structure)

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

name -> (строка)

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

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

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое)

Целое значение.

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

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

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

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

name -> (строка)

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

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

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое)

Целое значение.

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

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

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

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

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

name -> (строка)

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

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

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое)

Целое значение.

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

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

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

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

name -> (строка)

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

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

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое)

Целое значение.

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

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

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

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

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

name -> (строка)

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

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

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

Примечание

stringValue -> (строка)

Строка.

stringListValue -> (список)

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

(строка)

longValue -> (целое)

Целое значение.

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

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

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

Синтаксис JSON:

{
  "andAllFilters": [
    {
      "andAllFilters": [
        { ... recursive ... }
        ...
      ],
      "orAllFilters": [
        { ... recursive ... }
        ...
      ],
      "notFilter": { ... recursive ... },
      "equalsTo": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "containsAll": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "containsAny": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "greaterThan": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "greaterThanOrEquals": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "lessThan": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "lessThanOrEquals": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      }
    }
    ...
  ],
  "orAllFilters": [
    {
      "andAllFilters": [
        { ... recursive ... }
        ...
      ],
      "orAllFilters": [
        { ... recursive ... }
        ...
      ],
      "notFilter": { ... recursive ... },
      "equalsTo": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "containsAll": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "containsAny": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "greaterThan": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "greaterThanOrEquals": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "lessThan": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      },
      "lessThanOrEquals": {
        "name": "string",
        "value": {
          "stringValue": "string",
          "stringListValue": ["string", ...],
          "longValue": long,
          "dateValue": timestamp
        }
      }
    }
    ...
  ],
  "notFilter": {
    "andAllFilters": [
      { ... recursive ... }
      ...
    ],
    "orAllFilters": [
      { ... recursive ... }
      ...
    ],
    "notFilter": { ... recursive ... },
    "equalsTo": {
      "name": "string",
      "value": {
        "stringValue": "string",
        "stringListValue": ["string", ...],
        "longValue": long,
        "dateValue": timestamp
      }
    },
    "containsAll": {
      "name": "string",
      "value": {
        "stringValue": "string",
        "stringListValue": ["string", ...],
        "longValue": long,
        "dateValue": timestamp
      }
    },
    "containsAny": {
      "name": "string",
      "value": {
        "stringValue": "string",
        "stringListValue": ["string", ...],
        "longValue": long,
        "dateValue": timestamp
      }
    },
    "greaterThan": {
      "name": "string",
      "value": {
        "stringValue": "string",
        "stringListValue": ["string", ...],
        "longValue": long,
        "dateValue": timestamp
      }
    },
    "greaterThanOrEquals": {
      "name": "string",
      "value": {
        "stringValue": "string",
        "stringListValue": ["string", ...],
        "longValue": long,
        "dateValue": timestamp
      }
    },
    "lessThan": {
      "name": "string",
      "value": {
        "stringValue": "string",
        "stringListValue": ["string", ...],
        "longValue": long,
        "dateValue": timestamp
      }
    },
    "lessThanOrEquals": {
      "name": "string",
      "value": {
        "stringValue": "string",
        "stringListValue": ["string", ...],
        "longValue": long,
        "dateValue": timestamp
      }
    }
  },
  "equalsTo": {
    "name": "string",
    "value": {
      "stringValue": "string",
      "stringListValue": ["string", ...],
      "longValue": long,
      "dateValue": timestamp
    }
  },
  "containsAll": {
    "name": "string",
    "value": {
      "stringValue": "string",
      "stringListValue": ["string", ...],
      "longValue": long,
      "dateValue": timestamp
    }
  },
  "containsAny": {
    "name": "string",
    "value": {
      "stringValue": "string",
      "stringListValue": ["string", ...],
      "longValue": long,
      "dateValue": timestamp
    }
  },
  "greaterThan": {
    "name": "string",
    "value": {
      "stringValue": "string",
      "stringListValue": ["string", ...],
      "longValue": long,
      "dateValue": timestamp
    }
  },
  "greaterThanOrEquals": {
    "name": "string",
    "value": {
      "stringValue": "string",
      "stringListValue": ["string", ...],
      "longValue": long,
      "dateValue": timestamp
    }
  },
  "lessThan": {
    "name": "string",
    "value": {
      "stringValue": "string",
      "stringListValue": ["string", ...],
      "longValue": long,
      "dateValue": timestamp
    }
  },
  "lessThanOrEquals": {
    "name": "string",
    "value": {
      "stringValue": "string",
      "stringListValue": ["string", ...],
      "longValue": long,
      "dateValue": timestamp
    }
  }
}

--chat-mode (строка)

Параметр chatMode определяет доступные режимы чата для пользователей Amazon Q Business:

RETRIEVAL_MODE - Если вы выберете этот режим, Amazon Q будет генерировать ответы только из подключенных и индексированных приложением источников данных. Если ответ не найден в источниках данных или доступных источниках данных нет, Amazon Q вернет сообщение «Ответ не найден », если не включено знание LLM. В этом случае Amazon Q сгенерирует ответ из знания LLM.
CREATOR_MODE - Выбрав этот режим, вы можете генерировать ответы только из знания LLM. Вы также можете прикреплять файлы и запрашивать у Amazon Q сгенерировать ответ на основе данных в этих файлах. Если прикрепленные файлы не содержат ответа на запрос, Amazon Q автоматически переключится на генерацию ответа из знания LLM.
PLUGIN_MODE - Выбрав этот режим, пользователи могут использовать плагины в чате для получения ответов.

Примечание

Если ни один из режимов не выбран, Amazon Q будет отвечать только с помощью информации из прикрепленных файлов.

Дополнительную информацию см. в разделах «Административные параметры и ограничения», «Плагины» и «Источники ответов».

Возможные значения:

RETRIEVAL_MODE
CREATOR_MODE
PLUGIN_MODE

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

Настройка режима чата для приложения Amazon Q Business.

Примечание

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

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

Необходимая информация для вызова чата в PLUGIN_MODE.

pluginId -> (строка)

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

Сокращенный синтаксис:

pluginConfiguration={pluginId=string}

Синтаксис JSON:

{
  "pluginConfiguration": {
    "pluginId": "string"
  }
}

--client-token (строка)

Токен, который вы предоставляете для идентификации запроса в чат.

--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 (boolean)

Включить отладку.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

json
text
table
yaml
yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования, используемый для бинарных блоков. По умолчанию формат 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 (boolean)

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

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

conversationId -> (строка)

Идентификатор беседы Amazon Q Business.

systemMessage -> (строка)

Сообщение, сгенерированное ИИ в беседе.

systemMessageId -> (строка)

Идентификатор сообщения, сгенерированного ИИ Amazon Q Business в беседе.

userMessageId -> (строка)

Идентификатор сообщения ввода текста конечного пользователя Amazon Q Business в беседе.

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

Запрос от Amazon Q Business к конечному пользователю для получения информации, необходимой Amazon Q Business для успешного выполнения запрошенного действия плагина.

pluginId -> (строка)

Идентификатор плагина, связанного с обзором действия.

pluginType -> (строка)

Тип плагина.

payload -> (словарь)

Значения полей, которые должен предоставить конечный пользователь Amazon Q Business для выполнения запрошенного действия плагина.

key -> (строка)

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

Поле ввода пользователя в рецензии действия плагина.

displayName -> (строка)

Название поля.

displayOrder -> (целое число)

Порядок отображения полей в наборе данных.

displayDescription -> (строка)

Описание поля каждого поля ввода в обзоре действия. Это может быть объяснение поля. В веб-приложении Amazon Q Business эти описания можно использовать для отображения подсказок, чтобы помочь пользователям понять поле.

type -> (строка)

Тип поля.

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

Значение поля.

allowedValues -> (список)

Информация о значениях поля, которые конечный пользователь может использовать для предоставления Amazon Q Business для выполнения запрошенного действия плагина.

(структура)

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

Значение поля.

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

Имя поля.

allowedFormat -> (строка)

Ожидаемый формат данных для значения поля ввода обзора действия. Например, в запросе PTO from и to будут иметь формат datetime.

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

Используется для создания пользовательской формы с полями массива (поля с вложенными объектами внутри массива).

required -> (булево)

Информация о том, является ли поле обязательным.

payloadFieldNameSeparator -> (строка)

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

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

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

authorizationUrl -> (строка)

URL, отправленный Amazon Q Business на сервер аутентификации третьей стороны для аутентификации пользователя пользовательского плагина через протокол OAuth.

sourceAttributions -> (список)

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

(структура)

Документы, используемые для генерации ответа веб-приложения Amazon Q Business.

title -> (строка)

Название документа, являющегося источником сгенерированного ответа Amazon Q Business.

snippet -> (строка)

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

url -> (строка)

URL документа, являющегося источником сгенерированного ответа Amazon Q Business.

citationNumber -> (целое число)

Номер, прикреплённый к цитате в сгенерированном ответе Amazon Q Business.

updatedAt -> (временная метка)

Временная метка Unix, когда приложение Amazon Q Business было в последний раз обновлено.

textMessageSegments -> (список)

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

(структура)

Предоставляет информацию об извлечённом фрагменте текста в ответе чата, который можно отнести к исходному документу.

beginOffset -> (целое число)

Ноль-базовое расположение в строке ответа, где начинается атрибуция источника.

endOffset -> (целое число)

Ноль-базовое расположение в строке ответа, где заканчивается атрибуция источника.

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

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

text -> (строка)

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

mediaId -> (строка)

Идентификатор объекта мультимедиа, связанного с фрагментом текста в атрибуции источника.

mediaMimeType -> (строка)

MIME-тип (image/png) объекта мультимедиа, связанного с фрагментом текста в атрибуции источника.

sourceDetails -> (структура с тэгами)

Информация о источнике для фрагмента извлечённого текста, включая его тип мультимедиа.

Примечание

Это структура с тэгами. Может быть установлено только одно из следующих верхнеуровневых ключей: imageSourceDetails, audioSourceDetails, videoSourceDetails.

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

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

mediaId -> (строка)

Уникальный идентификатор файла изображения.

mediaMimeType -> (строка)

MIME-тип файла изображения.

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

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

mediaId -> (строка)

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

mediaMimeType -> (строка)

MIME-тип аудиофайла (например, audio/mp3, audio/wav).

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

Начальная временная метка в миллисекундах для соответствующего аудиофрагмента.

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

Конечная временная метка в миллисекундах для соответствующего аудиофрагмента.

audioExtractionType -> (строка)

Тип аудиоизвлечения, выполненного над содержимым.

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

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

mediaId -> (строка)

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

mediaMimeType -> (строка)

MIME-тип видеофайла (например, video/mp4, video/avi).

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

Начальная временная метка в миллисекундах для соответствующего видеофрагмента.

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

Конечная временная метка в миллисекундах для соответствующего видеофрагмента.

videoExtractionType -> (строка)

Тип видеоизвлечения, выполненного над содержимым.

failedAttachments -> (список)

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

(структура)

Подробности о файле, загруженном во время чата.

name -> (строка)

Название загруженного файла во время чата.

status -> (строка)

Статус загруженного файла во время чата.

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

Ошибка, связанная с файлом, загруженным во время чата.

errorMessage -> (строка)

Сообщение, объясняющее ошибку запроса Amazon Q Business.

errorCode -> (строка)

Код, связанный с ошибкой запроса Amazon Q Business.

attachmentId -> (строка)

Уникальный идентификатор вложения Amazon Q Business.

conversationId -> (строка)

Уникальный идентификатор беседы Amazon Q Business.

END_OF_DOCUMENT_MARKER