Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

create-evaluation-form

Описание

Создаёт форму оценки в указанном экземпляре Amazon Connect. Форма может использоваться для определения вопросов, связанных с производительностью агента, и создания разделов для организации таких вопросов. Идентификаторы вопросов и разделов не могут дублироваться в рамках одной формы оценки.

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

Синтаксис

  create-evaluation-form
--instance-id <value>
--title <value>
[--description <value>]
--items <value>
[--scoring-strategy <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]

Параметры

--instance-id (string)

Идентификатор экземпляра Amazon Connect. Вы можете найти идентификатор экземпляра в Amazon Resource Name (ARN) экземпляра.

--title (string)

Название формы оценки.

--description (string)

Описание формы оценки.

--items (list)

Элементы, которые являются частью формы оценки. Общее количество разделов и вопросов не должно превышать 100 для каждого. Вопросы должны содержаться в разделе.

(структура с тегами)

Информация об элементе из формы оценки. Элементом должен быть раздел или вопрос.

Примечание

Это структура Tagged Union. Можно установить только один из следующих ключей верхнего уровня: Section, Question.

Section -> (structure)

Информация о разделе.

Title -> (string)

Заголовок раздела.

RefId -> (string)

Идентификатор раздела. Идентификатор должен быть уникальным в рамках формы оценки.

Instructions -> (string)

Инструкции раздела.

Items -> (list)

Элементы раздела.

(структура с тегами)

Информация об элементе из формы оценки. Элементом должен быть раздел или вопрос.

Примечание

Это структура Tagged Union. Можно установить только один из следующих ключей верхнего уровня: Section, Question.

Section -> (structure)

Информация о разделе.

Title -> (string)

Заголовок раздела.

RefId -> (string)

Идентификатор раздела. Идентификатор должен быть уникальным в рамках формы оценки.

Instructions -> (string)

Инструкции раздела.

Weight -> (double)

Вес оценки раздела.

Question -> (structure)

Информация о вопросе.

Title -> (string)

Заголовок вопроса.

Instructions -> (string)

Инструкции раздела.

RefId -> (string)

Идентификатор вопроса. Идентификатор должен быть уникальным в рамках формы оценки.

NotApplicableEnabled -> (boolean)

Флаг для включения неприменимых ответов на вопрос.

QuestionType -> (string)

Тип вопроса.

QuestionTypeProperties -> (структура с тегами)

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

Примечание

Это структура Tagged Union. Можно установить только один из следующих ключей верхнего уровня: Numeric, SingleSelect.

Numeric -> (structure)

Свойства числового вопроса.

MinValue -> (integer)

Минимальное значение ответа.

MaxValue -> (integer)

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

Options -> (list)

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

(structure)

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

MinValue -> (integer)

Минимальное значение ответа для варианта диапазона.

MaxValue -> (integer)

Максимальное значение ответа для варианта диапазона.

Score -> (integer)

Оценка, присвоенная значениям ответов в варианте диапазона.

AutomaticFail -> (boolean)

Флаг для пометки варианта как автоматический сбой. Если предоставлен ответ с автоматическим сбоем, общая оценка получает оценку 0.

Automation -> (структура с тегами)

Свойства автоматизации числового вопроса.

Примечание

Это структура Tagged Union. Можно установить только один из следующих ключей верхнего уровня: PropertyValue.

PropertyValue -> (structure)

Значение свойства автоматизации.

Label -> (string)

Метка свойства автоматизации.

SingleSelect -> (structure)

Свойства числового вопроса.

Options -> (list)

Варианты ответа на вопрос с одним вариантом выбора.

(structure)

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

RefId -> (string)

Идентификатор варианта ответа. Идентификатор должен быть уникальным в рамках вопроса.

Text -> (string)

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

Score -> (integer)

Оценка, присвоенная варианту ответа.

AutomaticFail -> (boolean)

Флаг для пометки варианта как автоматический сбой. Если предоставлен ответ с автоматическим сбоем, общая оценка получает оценку 0.

DisplayAs -> (string)

Режим отображения вопроса с одним вариантом выбора.

Automation -> (structure)

Режим отображения вопроса с одним вариантом выбора.

Options -> (list)

Параметры автоматизации вопроса с одним вариантом выбора.

(структура с тегами)

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

Примечание

Это структура Tagged Union. Можно установить только один из следующих ключей верхнего уровня: RuleCategory.

RuleCategory -> (structure)

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

Category -> (string)

Имя категории, как определено в правилах.

Condition -> (string)

Условие, применяемое для параметра автоматизации. Если условие PRESENT , то параметр применяется, когда данные контакта включают категорию. Аналогично, если условие NOT_PRESENT , то параметр применяется, когда данные контакта не включают категорию.

OptionRefId -> (string)

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

DefaultOptionRefId -> (string)

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

Weight -> (double)

Вес оценки раздела.

Weight -> (double)

Вес оценки раздела.

Question -> (structure)

Информация о вопросе.

Title -> (string)

Заголовок вопроса.

Instructions -> (string)

Инструкции раздела.

RefId -> (string)

Идентификатор вопроса. Идентификатор должен быть уникальным в рамках формы оценки.

NotApplicableEnabled -> (boolean)

Флаг для включения неприменимых ответов на вопрос.

QuestionType -> (string)

Тип вопроса.

QuestionTypeProperties -> (структура с тегами)

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

Примечание

Это структура Tagged Union. Можно установить только один из следующих ключей верхнего уровня: Numeric, SingleSelect.

Numeric -> (structure)

Свойства числового вопроса.

MinValue -> (integer)

Минимальное значение ответа.

MaxValue -> (integer)

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

Options -> (list)

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

(structure)

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

MinValue -> (integer)

Минимальное значение ответа для варианта диапазона.

MaxValue -> (integer)

Максимальное значение ответа для варианта диапазона.

Score -> (integer)

Оценка, присвоенная значениям ответов в варианте диапазона.

AutomaticFail -> (boolean)

Флаг для пометки варианта как автоматический сбой. Если предоставлен ответ с автоматическим сбоем, общая оценка получает оценку 0.

Automation -> (структура с тегами)

Свойства автоматизации числового вопроса.

Примечание

Это структура Tagged Union. Можно установить только один из следующих ключей верхнего уровня: PropertyValue.

PropertyValue -> (structure)

Значение свойства автоматизации.

Label -> (string)

Метка свойства автоматизации.

SingleSelect -> (structure)

Свойства числового вопроса.

Options -> (list)

Варианты ответа на вопрос с одним вариантом выбора.

(structure)

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

RefId -> (string)

Идентификатор варианта ответа. Идентификатор должен быть уникальным в рамках вопроса.

Text -> (string)

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

Score -> (integer)

Оценка, присвоенная варианту ответа.

AutomaticFail -> (boolean)

Флаг для пометки варианта как автоматический сбой. Если предоставлен ответ с автоматическим сбоем, общая оценка получает оценку 0.

DisplayAs -> (string)

Режим отображения вопроса с одним вариантом выбора.

Automation -> (structure)

Режим отображения вопроса с одним вариантом выбора.

Options -> (list)

Параметры автоматизации вопроса с одним вариантом выбора.

(структура с тегами)

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

Примечание

Это структура Tagged Union. Можно установить только один из следующих ключей верхнего уровня: RuleCategory.

RuleCategory -> (structure)

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

Category -> (string)

Имя категории, как определено в правилах.

Condition -> (string)

Условие, применяемое для параметра автоматизации. Если условие PRESENT , то параметр применяется, когда данные контакта включают категорию. Аналогично, если условие NOT_PRESENT , то параметр применяется, когда данные контакта не включают категорию.

OptionRefId -> (string)

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

DefaultOptionRefId -> (string)

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

Weight -> (double)

Вес оценки раздела.

JSON синтаксис:

[
  {
    "Section": {
      "Title": "string",
      "RefId": "string",
      "Instructions": "string",
      "Items": [
        {
          "Section": {
            "Title": "string",
            "RefId": "string",
            "Instructions": "string",
            "Items": ,
            "Weight": double
          },
          "Question": {
            "Title": "string",
            "Instructions": "string",
            "RefId": "string",
            "NotApplicableEnabled": true|false,
            "QuestionType": "TEXT"|"SINGLESELECT"|"NUMERIC",
            "QuestionTypeProperties": {
              "Numeric": {
                "MinValue": integer,
                "MaxValue": integer,
                "Options": [
                  {
                    "MinValue": integer,
                    "MaxValue": integer,
                    "Score": integer,
                    "AutomaticFail": true|false
                  }
                  ...
                ],
                "Automation": {
                  "PropertyValue": {
                    "Label": "OVERALL_CUSTOMER_SENTIMENT_SCORE"|"OVERALL_AGENT_SENTIMENT_SCORE"|"NON_TALK_TIME"|"NON_TALK_TIME_PERCENTAGE"|"NUMBER_OF_INTERRUPTIONS"|"CONTACT_DURATION"|"AGENT_INTERACTION_DURATION"|"CUSTOMER_HOLD_TIME"
                  }
                }
              },
              "SingleSelect": {
                "Options": [
                  {
                    "RefId": "string",
                    "Text": "string",
                    "Score": integer,
                    "AutomaticFail": true|false
                  }
                  ...
                ],
                "DisplayAs": "DROPDOWN"|"RADIO",
                "Automation": {
                  "Options": [
                    {
                      "RuleCategory": {
                        "Category": "string",
                        "Condition": "PRESENT"|"NOT_PRESENT",
                        "OptionRefId": "string"
                      }
                    }
                    ...
                  ],
                  "DefaultOptionRefId": "string"
                }
              }
            },
            "Weight": double
          }
        }
        ...
      ],
      "Weight": double
    },
    "Question": {
      "Title": "string",
      "Instructions": "string",
      "RefId": "string",
      "NotApplicableEnabled": true|false,
      "QuestionType": "TEXT"|"SINGLESELECT"|"NUMERIC",
      "QuestionTypeProperties": {
        "Numeric": {
          "MinValue": integer,
          "MaxValue": integer,
          "Options": [
            {
              "MinValue": integer,
              "MaxValue": integer,
              "Score": integer,
              "AutomaticFail": true|false
            }
            ...
          ],
          "Automation": {
            "PropertyValue": {
              "Label": "OVERALL_CUSTOMER_SENTIMENT_SCORE"|"OVERALL_AGENT_SENTIMENT_SCORE"|"NON_TALK_TIME"|"NON_TALK_TIME_PERCENTAGE"|"NUMBER_OF_INTERRUPTIONS"|"CONTACT_DURATION"|"AGENT_INTERACTION_DURATION"|"CUSTOMER_HOLD_TIME"
            }
          }
        },
        "SingleSelect": {
          "Options": [
            {
              "RefId": "string",
              "Text": "string",
              "Score": integer,
              "AutomaticFail": true|false
            }
            ...
          ],
          "DisplayAs": "DROPDOWN"|"RADIO",
          "Automation": {
            "Options": [
              {
                "RuleCategory": {
                  "Category": "string",
                  "Condition": "PRESENT"|"NOT_PRESENT",
                  "OptionRefId": "string"
                }
              }
              ...
            ],
            "DefaultOptionRefId": "string"
          }
        }
      },
      "Weight": double
    }
  }
  ...
]

--scoring-strategy (structure)

Стратегия оценки формы оценки.

Mode -> (string)

Режим оценки формы оценки.

Status -> (string)

Статус оценки формы оценки.

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

Mode=string,Status=string

JSON синтаксис:

{
  "Mode": "QUESTION_ONLY"|"SECTION_ONLY",
  "Status": "ENABLED"|"DISABLED"
}

--client-token (string)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если не указано, Amazon Web Services SDK заполняет это поле. Дополнительную информацию об идемпотентности см. в разделе Обеспечение безопасности повторных попыток с помощью идемпотентных API .

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

Вывод

EvaluationFormId -> (строка)

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

EvaluationFormArn -> (строка)

Amazon Resource Name (ARN) ресурса формы оценки.

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

Spec-Zone.ru

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