Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

list-realtime-contact-analysis-segments-v2

Описание

Предоставляет список сегментов анализа для сеанса анализа чата в реальном времени. Этот API поддерживает только каналы CHAT.

Предупреждение

Этот API не поддерживает VOICE. Если вы попытаетесь использовать его для VOICE, произойдет ошибка InvalidRequestException.

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

Синтаксис

  list-realtime-contact-analysis-segments-v2
--instance-id <value>
--contact-id <value>
[--max-results <value>]
[--next-token <value>]
--output-type <value>
--segment-types <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 Connect. Идентификатор экземпляра можно найти в Amazon Resource Name (ARN) экземпляра.

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

Идентификатор контакта в этом экземпляре Amazon Connect.

--max-results (целое число)

Максимальное количество результатов на страницу.

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

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

--output-type (строка)

Тип выходных данных Contact Lens, которые будут возвращены.

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

  • Raw
  • Redacted

--segment-types (список)

Перечисление типов сегментов. Каждое значение соответствует типу сегмента, возвращенному в списке segments API. Каждый тип сегмента имеет свою собственную структуру. Разные каналы могут иметь разные наборы поддерживаемых типов сегментов.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  Transcript
  Categories
  Issues
  Event
  Attachments
  PostContactSummary

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

Вывод

Канал -> (строка)

Канал контакта.

Предупреждение

Поддерживается только CHAT. Этот API не поддерживает VOICE. Если вы попытаетесь использовать его для канала VOICE, произойдёт ошибка InvalidRequestException.

Статус -> (строка)

Статус анализа контакта в реальном времени.

Сегменты -> (список)

Проаналированный фрагмент транскрипта или категория.

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

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

Примечание

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

Транскрипт -> (структура)

Проаналированный сегмент транскрипта.

Id -> (строка)

Идентификатор транскрипта.

ParticipantId -> (строка)

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

ParticipantRole -> (строка)

Роль участника. Например, клиент, агент или система.

DisplayName -> (строка)

Имя участника для отображения.

Содержание -> (строка)

Содержание транскрипта. Может быть отредактировано.

ContentType -> (строка)

Тип содержимого элемента. Например, text/plain.

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

Поле, описывающее время события. Может иметь различные представления времени.

Примечание

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

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

Время в формате ISO 8601: yyyy-MM-ddThh:mm:ss.SSSZ. Например, 2019-11-08T02:41:28.172Z.

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

Объект, описывающий редактирование, примененное к транскрипту. Если поле транскрипта содержит данные, это означает, что часть транскрипта была отредактирована.

CharacterOffsets -> (список)

Список интервалов символов, каждый из которых описывает часть текста, которая была отредактирована. Для OutputType.Raw, это часть исходного текста, содержащая данные, которые могут быть отредактированы. Для OutputType.Redacted, часть строки с меткой редактирования.

(структура)

Начальный и конечный смещения для части текста.

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

Начало интервала символов.

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

Конец интервала символов.

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

Обнаруженное настроение для этого фрагмента транскрипта.

Категории -> (структура)

Соответствующие правила категории.

MatchedDetails -> (карта)

Карта между именем соответствующего правила и RealTimeContactAnalysisCategoryDetails.

ключ -> (строка)

значение -> (структура)

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

PointsOfInterest -> (список)

Список объектов PointOfInterest, описывающих одно соответствие правила.

(структура)

Часть сегмента транскрипта контакта, в которой было обнаружено правило категории.

TranscriptItems -> (список)

Список элементов транскрипта (сегментов), связанных с данным пунктом интереса.

(структура)

Представление транскрипта, содержащее Id и список интервалов символов, связанных с данными анализа. Например, этот объект в RealTimeContactAnalysisPointOfInterest в Category.MatchedDetails будет содержать интервал символов, описывающий часть текста, соответствующую категории.

Id -> (строка)

Идентификатор транскрипта. Соответствует идентификатору из одного из TranscriptSegments.

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

Список интервалов символов в содержании/тексте транскрипта.

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

Начало интервала символов.

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

Конец интервала символов.

Проблемы -> (структура)

Тип сегмента, содержащий список обнаруженных проблем.

IssuesDetected -> (список)

Список обнаруженных проблем.

(структура)

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

TranscriptItems -> (список)

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

(структура)

Представление транскрипта, содержащее Id, Содержание и список интервалов символов, связанных с данными анализа. Например, этот объект в обнаруженной проблеме будет описывать как содержимое, содержащее идентифицированную проблему, так и интервалы, откуда это содержимое взято.

Содержание -> (строка)

Часть содержимого транскрипта, содержащая идентифицированную проблему. Может быть отредактировано.

Id -> (строка)

Идентификатор транскрипта. Соответствует идентификатору из одного из TranscriptSegments.

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

Начальные и конечные смещения для части текста.

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

Начало интервала символов.

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

Конец интервала символов.

Событие -> (структура)

Тип сегмента, описывающий событие контакта.

Id -> (строка)

Идентификатор события контакта.

ParticipantId -> (строка)

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

ParticipantRole -> (строка)

Роль участника. Например, клиент, агент или система.

DisplayName -> (строка)

Имя участника для отображения. Может быть отредактировано.

EventType -> (строка)

Тип события. Например, application/vnd.amazonaws.connect.event.participant.left.

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

Поле, описывающее время события. Может иметь различные представления времени.

Примечание

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

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

Время в формате ISO 8601: yyyy-MM-ddThh:mm:ss.SSSZ. Например, 2019-11-08T02:41:28.172Z.

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

Проаналированные вложения.

Id -> (строка)

Идентификатор сегмента.

ParticipantId -> (строка)

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

ParticipantRole -> (строка)

Роль участника. Например, клиент, агент или система.

DisplayName -> (строка)

Имя участника для отображения. Может быть отредактировано.

Вложения -> (список)

Список объектов, описывающих индивидуальное вложение.

(структура)

Объект, описывающий прикрепленный файл.

AttachmentName -> (строка)

Имя вложения (регистрозависимое), загружаемого. Может быть отредактировано.

ContentType -> (строка)

Описание MIME-типа файла вложения. Список поддерживаемых типов файлов см. в спецификациях функций в руководстве администратора Amazon Connect.

AttachmentId -> (строка)

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

Статус -> (строка)

Статус вложения.

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

Поле, описывающее время события. Может иметь различные представления времени.

Примечание

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

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

Время в формате ISO 8601: yyyy-MM-ddThh:mm:ss.SSSZ. Например, 2019-11-08T02:41:28.172Z.

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

Информация о сводке после контакта.

Содержание -> (строка)

Содержание сводки.

Статус -> (строка)

Успешно завершен (COMPLETED) или не удалось сгенерировать (FAILED) сводку.

Код ошибки -> (строка)

Если сводка не была сгенерирована, может произойти одна из следующих ошибок:

  • QUOTA_EXCEEDED: Количество одновременных задач анализа достигло лимита вашей службы.
  • INSUFFICIENT_CONVERSATION_CONTENT: Разговор должен содержать как минимум один обмен от обоих участников, чтобы сгенерировать сводку.
  • FAILED_SAFETY_GUIDELINES: Сгенерированная сводка не может быть предоставлена, так как она не соответствует системным правилам безопасности.
  • INVALID_ANALYSIS_CONFIGURATION: Этот код возникает, например, при использовании языка, который не поддерживается генеративными AI-моделями для сводок после контакта.
  • INTERNAL_ERROR: Внутренняя ошибка системы.

NextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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