Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

создание-списка-блоков-предложений-поиска

Описание

Создает список блоков для исключения определенных запросов из предложений.

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

Вам необходимо указать расположение файла вашего текстового файла списка блоков в вашем ведре S3. В вашем текстовом файле введите каждое слово или фразу блока в отдельной строке.

Сведения о текущих лимитах квот для списков блоков см. в разделе Квоты для Amazon Kendra.

CreateQuerySuggestionsBlockList в настоящее время не поддерживается в регионе Amazon Web Services GovCloud (US-West).

Пример создания списка блоков для предложений по запросам с использованием Python SDK см. в разделе Список блоков предложений по запросам.

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

Синтаксис

  create-query-suggestions-block-list
--index-id <value>
--name <value>
[--description <value>]
--source-s3-path <value>
[--client-token <value>]
--role-arn <value>
[--tags <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]

Параметры

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

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

--name (строка)

Название списка блоков.

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

--description (строка)

Описание списка блоков.

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

--source-s3-path (структура)

Путь S3 к файлу списка блоков в вашем ведре S3.

Каждое слово или фраза блока должно находиться в отдельной строке в текстовом файле.

Сведения о текущих лимитах квот для списков блоков см. в разделе Квоты для Amazon Kendra.

Ведро -> (строка)

Название ведра S3, которое содержит файл.

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

Название файла.

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

Bucket=string,Key=string

Синтаксис JSON:

{
  "Bucket": "string",
  "Key": "string"
}

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

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

--role-arn (строка)

Amazon Resource Name (ARN) роли IAM с разрешением доступа к вашему ведру S3, содержащему текстовый файл списка блоков. Дополнительные сведения см. в разделе Роли доступа IAM для Amazon Kendra.

--tags (список)

Список пар ключ-значение, которые идентифицируют или классифицируют список блоков. Ключи и значения тегов могут содержать символы Unicode, цифры, пробелы и следующие символы: _ . : / = + - @.

(структура)

Пара ключ-значение, которая идентифицирует или классифицирует индекс, FAQ, источник данных или другой ресурс. Ключ и значение тега могут содержать символы Unicode, цифры, пробелы и следующие символы: _ . : / = + - @.

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

Ключ тега. Ключи не чувствительны к регистру и должны быть уникальными для индекса, FAQ, источника данных или другого ресурса.

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

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

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

Key=string,Value=string ...

Синтаксис JSON:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

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

Вывод

Id -> (строка)

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

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

Spec-Zone.ru

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