Spec-Zone.ru › AWS CLI v2

[ aws . wisdom ]

Поиск быстрых ответов

Описание

Ищет существующие быстрые ответы Wisdom в базе знаний Wisdom.

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

search-quick-responses является постраничной операцией. Для получения всего набора результатов могут потребоваться несколько API-вызовов. Вы можете отключить постраничность, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничностью, аргумент --query должен извлекать данные из результатов следующих выражений запроса: results

Синтаксис

  search-quick-responses
[--attributes <value>]
--knowledge-base-id <value>
--search-expression <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]

Параметры

--attributes (отображение)

Определяемые пользователем атрибуты контактов Amazon Connect, которые должны быть разрешены при возвращении результатов поиска.

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

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

Сокращенная запись:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--knowledge-base-id (строка)

Идентификатор базы знаний. Это должна быть база знаний типа QUICK_RESPONSES. Может быть либо ID, либо ARN. В URL-адресах не может содержаться ARN.

--search-expression (структура)

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

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

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

(структура)

Поля быстрого ответа для фильтрации результатов запроса быстрого ответа.

Вот список поддерживаемых имен полей:

  • name
  • description
  • shortcutKey
  • isActive
  • channels
  • language
  • contentType
  • createdTime
  • lastModifiedTime
  • lastModifiedBy
  • groupingConfiguration.criteria
  • groupingConfiguration.values

includeNoExistence -> (логическое)

Указывает, нужно ли обрабатывать значение NULL как соответствие для поля атрибута.

name -> (строка)

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

operator -> (строка)

Оператор для использования при фильтрации.

values -> (список)

Значения поля атрибута для фильтрации быстрого ответа.

(строка)

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

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

name -> (строка)

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

order -> (строка)

Порядок сортировки быстрых ответов.

queries -> (список)

Выражения запроса быстрого ответа.

(структура)

Поля быстрого ответа для запроса быстрого ответа.

Вот список поддерживаемых имен полей:

  • content
  • name
  • description
  • shortcutKey

allowFuzziness -> (логическое)

Указывает, ожидает ли запрос только точные совпадения значений поля атрибута. Результаты запроса будут включать только точные совпадения, если этот параметр установлен в значение false.

name -> (строка)

Имя атрибута для запроса быстрого ответа.

operator -> (строка)

Оператор для сопоставления значений поля атрибута в запросе.

priority -> (строка)

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

values -> (список)

Значения атрибута для запроса быстрого ответа.

(строка)

Синтаксис JSON:

{
  "filters": [
    {
      "includeNoExistence": true|false,
      "name": "string",
      "operator": "EQUALS"|"PREFIX",
      "values": ["string", ...]
    }
    ...
  ],
  "orderOnField": {
    "name": "string",
    "order": "ASC"|"DESC"
  },
  "queries": [
    {
      "allowFuzziness": true|false,
      "name": "string",
      "operator": "CONTAINS"|"CONTAINS_AND_PREFIX",
      "priority": "HIGH"|"MEDIUM"|"LOW",
      "values": ["string", ...]
    }
    ...
  ]
}

--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения переопределяют значения, предоставленные в JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного значения JSON, так как строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

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

Токен для указания точки начала постраничной обработки. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

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

Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, предоставляется NextToken в выводе команды. Для возобновления постраничной обработки укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе Постраничная обработка в Руководстве пользователя AWS Command Line Interface.

--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-auto-prompt (логическое)

Автоматически запрашивать параметры ввода командной строки.

--no-cli-auto-prompt (логическое)

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

Вывод

nextToken -> (строка)

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

results -> (список)

Результаты поиска быстрого ответа.

(структура)

Результат поиска быстрого ответа.

attributesInterpolated -> (список)

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

(строка)

attributesNotInterpolated -> (список)

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

(строка)

channels -> (список)

Каналы контактов Amazon Connect, к которым применяется этот быстрый ответ. Поддерживаемые типы каналов контактов включают Chat .

(строка)

contentType -> (строка)

Тип содержимого быстрого ответа.

  • Используйте application/x.quickresponse;format=plain для быстрого ответа, написанного простым текстом.
  • Используйте application/x.quickresponse;format=markdown для быстрого ответа, написанного в формате richtext.

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

Содержимое быстрого ответа.

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

Содержимое контейнера быстрого ответа.

Примечание

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

content -> (строка)

Содержимое быстрого ответа.

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

Содержимое контейнера быстрого ответа.

Примечание

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

content -> (строка)

Содержимое быстрого ответа.

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

Метка времени создания быстрого ответа.

description -> (строка)

Описание быстрого ответа.

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

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

criteria -> (строка)

Критерии, используемые для группировки пользователей Wisdom.

Вот список поддерживаемых значений критериев.

  • RoutingProfileArn : Группировка пользователей по их ARN профиля маршрутизации Amazon Connect. Пользователь должен иметь разрешения SearchRoutingProfile и DescribeRoutingProfile при установке критерия на это значение.

values -> (список)

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

  • При установке criteria на RoutingProfileArn, необходимо предоставить список ARN профилей маршрутизации Amazon Connect в качестве значений этого параметра.

(строка)

isActive -> (логическое значение)

Активен ли быстрый ответ.

knowledgeBaseArn -> (строка)

Amazon Resource Name (ARN) базы знаний.

knowledgeBaseId -> (строка)

Идентификатор базы знаний. Это не должно быть база знаний типа QUICK_RESPONSES, если вы сохраняете ресурс Wisdom Content в ней. Может быть либо ID, либо ARN. URL-адреса не могут содержать ARN.

language -> (строка)

Код языка, на котором написан быстрый ответ.

lastModifiedBy -> (строка)

Amazon Resource Name (ARN) пользователя, который последний раз обновил данные результата поиска быстрого ответа.

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

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

name -> (строка)

Название быстрого ответа.

quickResponseArn -> (строка)

Amazon Resource Name (ARN) быстрого ответа.

quickResponseId -> (строка)

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

shortcutKey -> (строка)

Сокращенная клавиша быстрого ответа. Значение должно быть уникальным для базы знаний.

status -> (строка)

Статус ресурса быстрого ответа.

tags -> (карта)

Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.

key -> (строка)

value -> (строка)

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

Spec-Zone.ru

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