Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

send-message

Описание

Отправляет сообщение в сеанс Amazon Q в Connect.

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

Синтаксис

  send-message
--assistant-id <value>
--session-id <value>
--type <value>
--message <value>
[--conversation-context <value>]
[--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]

Параметры

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

Идентификатор помощника Amazon Q в Connect.

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

Идентификатор сеанса Amazon Q в Connect.

--type (строка)

Тип сообщения.

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

  • TEXT

--message (структура)

Данные сообщения для отправки в сеанс Amazon Q в Connect.

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

Значение входного сообщения.

Примечание

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

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

Данные сообщения в текстовом формате.

value -> (строка)

Значение данных сообщения в текстовом формате.

Краткая форма:

value={text={value=string}}

Синтаксис JSON:

{
  "value": {
    "text": {
      "value": "string"
    }
  }
}

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

Контекст разговора перед сеансом Amazon Q в Connect.

selfServiceConversationHistory -> (список)

История разговора самообслуживания перед сеансом Amazon Q в Connect.

(структура)

Данные истории разговора, которые нужно включить в данные контекста разговора перед сеансом Amazon Q в Connect.

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

Номер хода данных истории разговора.

inputTranscript -> (строка)

Транскрипт входного сообщения данных истории разговора.

botResponse -> (строка)

Ответ бота данных истории разговора.

Краткая форма:

selfServiceConversationHistory=[{turnNumber=integer,inputTranscript=string,botResponse=string},{turnNumber=integer,inputTranscript=string,botResponse=string}]

Синтаксис JSON:

{
  "selfServiceConversationHistory": [
    {
      "turnNumber": integer,
      "inputTranscript": "string",
      "botResponse": "string"
    }
    ...
  ]
}

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

Настройка запроса SendMessage.

generateFillerMessage -> (булево)

Создает заполняющий ответ, когда выбор инструмента равен QUESTION.

Краткая форма:

generateFillerMessage=boolean

Синтаксис JSON:

{
  "generateFillerMessage": true|false
}

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

Уникальный, регистрозависимый идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если не указано, AWS SDK заполняет это поле. Для получения дополнительной информации об идемпотентности см. Making retries safe with idempotent APIs.

--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
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

Показать версию этого инструмента.

--color (строка)

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

  • вкл
  • выкл
  • авто

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

Вывод

requestMessageId -> (строка)

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

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

Настройка запроса SendMessage.

generateFillerMessage -> (булево)

Создает заполняющий ответ, когда выбор инструмента равен QUESTION.

nextMessageToken -> (строка)

Токен для следующего сообщения, используемый GetNextMessage.

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

Spec-Zone.ru

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