Spec-Zone.ru › AWS CLI v2

[ aws . cloudsearch ]

define-suggester

Описание

Настраивает подсказчик для домена. Подсказчик позволяет отображать возможные совпадения, прежде чем пользователи закончат ввод своих запросов. При настройке подсказчика необходимо указать имя текстового поля, по которому вы хотите искать возможные совпадения, и уникальное имя для подсказчика. Дополнительную информацию см. в разделе Получение поисковых подсказок в Руководстве разработчика Amazon CloudSearch.

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

Синтаксис

  define-suggester
--domain-name <value>
--suggester <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]

Параметры

--domain-name (строка)

Строка, представляющая имя домена. Имена доменов уникальны для доменов, принадлежащих учетной записи в регионе AWS. Имена доменов начинаются с буквы или цифры и могут содержать следующие символы: a-z (строчные буквы), 0-9 и - (тире).

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

Сведения о конфигурации поискового подсказчика. Каждый подсказчик имеет уникальное имя и указывает текстовое поле, которое вы хотите использовать для подсказок. Для подсказчика можно настроить следующие параметры: FuzzyMatching , SortExpression .

SuggesterName -> (строка)

Имена должны начинаться с буквы и могут содержать следующие символы: a-z (строчные буквы), 0-9 и _ (подчеркивание).

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

Параметры поискового подсказчика.

SourceField -> (строка)

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

FuzzyMatching -> (строка)

Уровень допускаемой неточности при подборе совпадений для строки: none , low , или high . При значении none указанная строка рассматривается как точный префикс. При значении low, предложения должны отличаться от указанной строки не более чем на один символ. При значении high предложения могут отличаться до двух символов. По умолчанию используется none.

SortExpression -> (строка)

Выражение, вычисляющее оценку для каждой подсказки, чтобы управлять их сортировкой. Оценки округляются до ближайшего целого числа, с нижней границей 0 и верхней границей 2^31-1. Оценка релевантности документа не вычисляется для подсказок, поэтому выражения сортировки не могут ссылаться на значение _score . Чтобы отсортировать предложения с помощью числового поля или существующего выражения, просто укажите имя поля или выражения. Если для подсказчика не настроено выражение, предложения сортируются по принципу расположения ближайших совпадений вначале.

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

SuggesterName=string,DocumentSuggesterOptions={SourceField=string,FuzzyMatching=string,SortExpression=string}

Синтаксис JSON:

{
  "SuggesterName": "string",
  "DocumentSuggesterOptions": {
    "SourceField": "string",
    "FuzzyMatching": "none"|"low"|"high",
    "SortExpression": "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 версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, сопоставляемого с двоичным блоком fileb://, всегда будет обрабатываться как двоичный и будет использовать содержимое файла непосредственно, независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для настроенного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (логическое значение)

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

--cli-auto-prompt (логическое значение)

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

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

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

Вывод

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

Значение Suggester и его текущий статус.

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

Сведения о конфигурации поискового подсказчика. Каждый подсказчик имеет уникальное имя и указывает текстовое поле, которое вы хотите использовать для подсказок. Для подсказчика можно настроить следующие параметры: FuzzyMatching , SortExpression .

SuggesterName -> (строка)

Имена должны начинаться с буквы и могут содержать следующие символы: a-z (строчные буквы), 0-9 и _ (подчеркивание).

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

Параметры поискового подсказчика.

SourceField -> (строка)

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

FuzzyMatching -> (строка)

Уровень допускаемой неточности при подборе совпадений для строки: none , low , или high . При значении none указанная строка рассматривается как точный префикс. При значении low, предложения должны отличаться от указанной строки не более чем на один символ. При значении high предложения могут отличаться до двух символов. По умолчанию используется none.

SortExpression -> (строка)

Выражение, вычисляющее оценку для каждой подсказки, чтобы управлять их сортировкой. Оценки округляются до ближайшего целого числа, с нижней границей 0 и верхней границей 2^31-1. Оценка релевантности документа не вычисляется для подсказок, поэтому выражения сортировки не могут ссылаться на значение _score . Чтобы отсортировать предложения с помощью числового поля или существующего выражения, просто укажите имя поля или выражения. Если для подсказчика не настроено выражение, предложения сортируются по принципу расположения ближайших совпадений вначале.

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

Статус параметра конфигурации домена.

CreationDate -> (временная метка)

Временная метка создания этого параметра.

UpdateDate -> (временная метка)

Временная метка последнего обновления этого параметра.

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

Уникальное целое число, указывающее, когда этот параметр был последний раз обновлён.

State -> (строка)

Состояние обработки изменения параметра. Возможные значения:

  • RequiresIndexDocuments : последнее значение параметра не будет развернуто до тех пор, пока не будет вызван IndexDocuments и завершится индексирование.
  • Processing : последнее значение параметра находится в процессе активации.
  • Active : последнее значение параметра полностью развернуто.
  • FailedToValidate : значение параметра несовместимо с данными домена и не может использоваться для индексирования данных. Вы должны либо изменить значение параметра, либо обновить или удалить несовместимые документы.

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

Указывает, что параметр будет удалён после завершения обработки.

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

Spec-Zone.ru

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