Spec-Zone.ru › AWS CLI v2

[ aws . kendra ]

get-query-suggestions

Описание

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

В настоящее время эта функция не поддерживается в регионе Amazon Web Services GovCloud (US-West).

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

Синтаксис

  get-query-suggestions
--index-id <value>
--query-text <value>
[--max-suggestions-count <value>]
[--suggestion-types <value>]
[--attribute-suggestions-config <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 (строка)

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

--query-text (строка)

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

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

Amazon Kendra не отображает какие-либо предложения, если пользователь вводит меньше двух символов или больше 60 символов. Запрос также должен иметь как минимум один результат поиска и содержать как минимум одно слово более чем из четырёх символов.

--max-suggestions-count (целое число)

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

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

Тип предложений, на основе которого следует формировать предложения по запросам. Типы предложений: история запросов или поля/атрибуты документов. Можно установить только один тип.

Если вы установите историю запросов в качестве типа предложений, Amazon Kendra предлагает запросы, релевантные вашим пользователям, на основе популярных запросов в истории запросов.

Если вы установите поля/атрибуты документов в качестве типа предложений, Amazon Kendra предлагает запросы, релевантные вашим пользователям, на основе содержимого полей документов.

(строка)

Синтаксис:

"string" "string" ...

Where valid values are:
  QUERY
  DOCUMENT_ATTRIBUTES

--attribute-suggestions-config (структура)

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

SuggestionAttributes -> (список)

Список ключей или имён полей атрибутов документов для использования в предложениях по запросам. Если содержимое любого из полей совпадает с тем, что пользователь начинает набирать в качестве своего запроса, то содержимое поля возвращается как предложение по запросу.

(строка)

AdditionalResponseAttributes -> (список)

Список дополнительных ключей или имён полей атрибутов документов для включения в ответ. Дополнительные поля могут быть использованы для предоставления дополнительной информации в ответе. Дополнительные поля не используются для формирования предложений.

(строка)

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

Фильтры результатов поиска на основе полей/атрибутов документов.

AndAllFilters -> (список)

Выполняет логическую операцию AND над всеми указанными вами фильтрами.

(структура)

Фильтры результатов поиска на основе атрибутов или полей документов.

Вы можете фильтровать результаты, используя атрибуты для ваших конкретных документов. Атрибуты должны существовать в вашем индексе. Например, если ваши документы включают пользовательский атрибут «Департамент», вы можете фильтровать документы, относящиеся к отделу «HR». Для фильтрации результатов или документов с «Департаментом», равным «HR», вы будете использовать операцию EqualsTo.

Вы можете использовать AndAllFilters и OrAllFilters в сочетании друг с другом или с другими операциями, такими как EqualsTo. Например:

AndAllFilters
  • EqualsTo : «Департамент», «HR»
  • OrAllFilters
    • ContainsAny : «Название проекта», [«новые сотрудники», «приём на работу»]

Этот пример фильтрует результаты или документы, относящиеся к отделу HR AND относятся к проектам, содержащим «новых сотрудников» OR «приём на работу» в названии проекта (необходимо использовать ContainAny с StringListValue). В этом примере фильтрация выполняется на глубине 2.

Фильтрацию нельзя выполнять на глубине более 2, в противном случае вы получите исключение ValidationException с сообщением «AttributeFilter не может иметь глубину более 2». Также, если вы используете более 10 фильтров атрибутов в данном списке для AndAllFilters или OrAllFilters, вы получите исключение ValidationException с сообщением «AttributeFilter не может иметь длину более 10».

Примеры использования AttributeFilter см. в разделе Использование атрибутов документов для фильтрации результатов поиска.

AndAllFilters -> (список)

Выполняет логическую операцию AND над всеми указанными вами фильтрами.

(… рекурсивно…)

OrAllFilters -> (список)

Выполняет логическую операцию OR над всеми указанными вами фильтрами.

(… рекурсивно…)

(… рекурсивно…)EqualsTo -> (структура)

Выполняет операцию сравнения по значению для атрибутов/полей документов.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

LongValue -> (целое)

Целое значение.

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

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Возвращает true, когда документ содержит все указанные атрибуты/поля документов. Этот фильтр применим только к StringListValue.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

LongValue -> (целое)

Целое значение.

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

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Возвращает true, когда документ содержит любой из указанных атрибутов/полей документов. Этот фильтр применим только к StringListValue.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

LongValue -> (целое)

Целое значение.

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

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Выполняет операцию «больше чем» для атрибутов/полей документов и их значений. Используйте с типом атрибута документа Date или Long.

Key -> (строка)

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

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

…

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

…

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

…

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

…

OrAllFilters -> (список)

Выполняет логическое OR действие над всеми указанными фильтрами.

(структура)

Фильтры результатов поиска на основе атрибутов или полей документов.

Вы можете фильтровать результаты, используя атрибуты для ваших конкретных документов. Атрибуты должны существовать в вашем индексе. Например, если ваши документы содержат пользовательский атрибут «Отдел», вы можете фильтровать документы, относящиеся к отделу «HR». Вы можете использовать операцию EqualsTo, чтобы фильтровать результаты или документы, у которых «Отдел» равен «HR».

Вы можете использовать AndAllFilters и OrAllFilters в комбинации друг с другом или с другими операциями, такими как EqualsTo. Например:

AndAllFilters
  • EqualsTo : «Отдел», «HR»
  • OrAllFilters
    • ContainsAny : «Название проекта», [«новые сотрудники», «прием на работу»]

Этот пример фильтрует результаты или документы, относящиеся к отделу HR AND, а также к проектам, содержащим «новые сотрудники» OR или «прием на работу» в названии проекта (необходимо использовать ContainAny с StringListValue). Этот пример фильтрует с глубиной 2.

Вы не можете фильтровать с глубиной более 2, иначе получите исключение ValidationException с сообщением «AttributeFilter не может иметь глубину более 2». Кроме того, если вы используете более 10 фильтров атрибутов в заданном списке для AndAllFilters или OrAllFilters, вы получите исключение ValidationException с сообщением «AttributeFilter не может иметь длину более 10».

Примеры использования AttributeFilter см. в разделе Использование атрибутов документов для фильтрации результатов поиска.

AndAllFilters -> (список)

Выполняет логическое AND действие над всеми указанными фильтрами.

(… рекурсивно …)

OrAllFilters -> (список)

Выполняет логическое OR действие над всеми указанными фильтрами.

(… рекурсивно …)

(… рекурсивно …)EqualsTo -> (структура)

Выполняет операцию сравнения на основе равенства для атрибутов/полей документов и их значений.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

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

Целое число типа long.

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

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

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

Возвращает true, если документ содержит все указанные атрибуты/поля документа. Этот фильтр применим только к StringListValue.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

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

Целое число типа long.

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

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

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

Возвращает true, если документ содержит любой из указанных атрибутов/полей документа. Этот фильтр применим только к StringListValue.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

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

Целое число типа long.

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

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

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

Выполняет операцию больше чем для атрибутов/полей документов и их значений. Используйте с типом атрибута документа Date или Long.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

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

Целое число типа long.

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

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

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

Выполняет операцию больше или равно для атрибутов/полей документов и их значений. Используйте с типом атрибута документа Date или Long.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

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

Целое число типа long.

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

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

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

Выполняет операцию меньше чем для атрибутов/полей документов и их значений. Используйте с типом атрибута документа Date или Long.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

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

Целое число типа long.

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

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

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

Выполняет операцию меньше или равно для атрибутов/полей документов и их значений. Используйте с типом атрибута документа Date или Long.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

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

Целое число типа long.

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

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

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

Выполняет логическую операцию NOT над всеми указанными вами фильтрами.

AndAllFilters -> (список)

Выполняет логическую операцию AND над всеми указанными вами фильтрами.

(… рекурсивно…)

OrAllFilters -> (список)

Выполняет логическую операцию OR над всеми указанными вами фильтрами.

(… рекурсивно…)

(… рекурсивно…)EqualsTo -> (структура)

Выполняет операцию сравнения на равенство атрибутов/полей документа и их значений.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

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

Значение целого числа.

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

Дата, представленная в формате ISO 8601.

Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Возвращает true, если документ содержит все указанные атрибуты/поля документа. Этот фильтр применим только к StringListValue.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

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

Значение целого числа.

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

Дата, представленная в формате ISO 8601.

Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Возвращает true, если документ содержит любой из указанных атрибутов/полей документа. Этот фильтр применим только к StringListValue.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

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

Значение целого числа.

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

Дата, представленная в формате ISO 8601.

Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Выполняет операцию «больше чем» над атрибутами/полями документа и их значениями. Используйте с типом атрибута документа Date или Long.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

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

Значение целого числа.

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

Дата, представленная в формате ISO 8601.

Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Выполняет операцию «больше или равно» над атрибутами/полями документа и их значениями. Используйте с типом атрибута документа Date или Long.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

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

Значение целого числа.

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

Дата, представленная в формате ISO 8601.

Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Выполняет операцию «меньше чем» над атрибутами/полями документа и их значениями. Используйте с типом атрибута документа Date или Long.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

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

Значение целого числа.

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

Дата, представленная в формате ISO 8601.

Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Выполняет операцию «меньше или равно» над атрибутами/полями документа и их значениями. Используйте с типом атрибута документа Date или Long.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

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

Значение целого числа.

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

Дата, представленная в формате ISO 8601.

Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Выполняет операцию сравнения на равенство атрибутов/полей документа и их значений.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

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

Значение целого числа.

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

Дата, представленная в формате ISO 8601.

Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Возвращает true, если документ содержит все указанные атрибуты/поля документа. Этот фильтр применим только к StringListValue.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

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

Значение целого числа.

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

Дата, представленная в формате ISO 8601.

Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Возвращает true, если документ содержит любой из указанных атрибутов/полей документа. Этот фильтр применим только к StringListValue.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

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

Значение целого числа.

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

Дата, представленная в формате ISO 8601.

Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Выполняет операцию «больше чем» над атрибутами/полями документа и их значениями. Используйте с типом атрибута документа Date или Long.

Key -> (строка)

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

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

Значение атрибута.

StringValue -> (строка)

Строка, например, «отдел».

StringListValue -> (список)

Список строк. Максимальная длина или количество строк по умолчанию — 10.

(строка)

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

Значение целого числа.

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

Дата, представленная в формате ISO 8601.

Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.

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

Выполняет операцию больше или равно на атрибутах/полях документа и их значениях. Используйте с типом атрибута документа Date или Long.

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

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

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

Значение атрибута.

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

Строка, например, «отдел».

Список строковых значений -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

Целое значение -> (целое)

Целое число со знаком.

Значение даты -> (метка времени)

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате даты-времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

Меньше -> (структура)

Выполняет операцию меньше на атрибутах/полях документа и их значениях. Используйте с типом атрибута документа Date или Long.

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

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

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

Значение атрибута.

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

Строка, например, «отдел».

Список строковых значений -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

Целое значение -> (целое)

Целое число со знаком.

Значение даты -> (метка времени)

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате даты-времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

Меньше или равно -> (структура)

Выполняет операцию меньше или равно на атрибутах/полях документа и их значениях. Используйте с типом атрибута документа Date или Long.

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

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

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

Значение атрибута.

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

Строка, например, «отдел».

Список строковых значений -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

Целое значение -> (целое)

Целое число со знаком.

Значение даты -> (метка времени)

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате даты-времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

Контекст пользователя -> (структура)

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

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

Токен контекста пользователя для фильтрации результатов поиска для пользователя. Он должен быть JWT или JSON-токен.

Идентификатор пользователя -> (строка)

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

Группы -> (список)

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

(строка)

Группы источников данных -> (список)

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

(структура)

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

Идентификатор группы -> (строка)

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

Идентификатор источника данных -> (строка)

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

Синтаксис JSON:

{
  "SuggestionAttributes": ["string", ...],
  "AdditionalResponseAttributes": ["string", ...],
  "AttributeFilter": {
    "AndAllFilters": [
      {
        "AndAllFilters": [
          { ... recursive ... }
          ...
        ],
        "OrAllFilters": [
          { ... recursive ... }
          ...
        ],
        "NotFilter": { ... recursive ... },
        "EqualsTo": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "ContainsAll": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "ContainsAny": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "GreaterThan": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "GreaterThanOrEquals": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "LessThan": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "LessThanOrEquals": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        }
      }
      ...
    ],
    "OrAllFilters": [
      {
        "AndAllFilters": [
          { ... recursive ... }
          ...
        ],
        "OrAllFilters": [
          { ... recursive ... }
          ...
        ],
        "NotFilter": { ... recursive ... },
        "EqualsTo": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "ContainsAll": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "ContainsAny": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "GreaterThan": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "GreaterThanOrEquals": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "LessThan": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        },
        "LessThanOrEquals": {
          "Key": "string",
          "Value": {
            "StringValue": "string",
            "StringListValue": ["string", ...],
            "LongValue": long,
            "DateValue": timestamp
          }
        }
      }
      ...
    ],
    "NotFilter": {
      "AndAllFilters": [
        { ... recursive ... }
        ...
      ],
      "OrAllFilters": [
        { ... recursive ... }
        ...
      ],
      "NotFilter": { ... recursive ... },
      "EqualsTo": {
        "Key": "string",
        "Value": {
          "StringValue": "string",
          "StringListValue": ["string", ...],
          "LongValue": long,
          "DateValue": timestamp
        }
      },
      "ContainsAll": {
        "Key": "string",
        "Value": {
          "StringValue": "string",
          "StringListValue": ["string", ...],
          "LongValue": long,
          "DateValue": timestamp
        }
      },
      "ContainsAny": {
        "Key": "string",
        "Value": {
          "StringValue": "string",
          "StringListValue": ["string", ...],
          "LongValue": long,
          "DateValue": timestamp
        }
      },
      "GreaterThan": {
        "Key": "string",
        "Value": {
          "StringValue": "string",
          "StringListValue": ["string", ...],
          "LongValue": long,
          "DateValue": timestamp
        }
      },
      "GreaterThanOrEquals": {
        "Key": "string",
        "Value": {
          "StringValue": "string",
          "StringListValue": ["string", ...],
          "LongValue": long,
          "DateValue": timestamp
        }
      },
      "LessThan": {
        "Key": "string",
        "Value": {
          "StringValue": "string",
          "StringListValue": ["string", ...],
          "LongValue": long,
          "DateValue": timestamp
        }
      },
      "LessThanOrEquals": {
        "Key": "string",
        "Value": {
          "StringValue": "string",
          "StringListValue": ["string", ...],
          "LongValue": long,
          "DateValue": timestamp
        }
      }
    },
    "EqualsTo": {
      "Key": "string",
      "Value": {
        "StringValue": "string",
        "StringListValue": ["string", ...],
        "LongValue": long,
        "DateValue": timestamp
      }
    },
    "ContainsAll": {
      "Key": "string",
      "Value": {
        "StringValue": "string",
        "StringListValue": ["string", ...],
        "LongValue": long,
        "DateValue": timestamp
      }
    },
    "ContainsAny": {
      "Key": "string",
      "Value": {
        "StringValue": "string",
        "StringListValue": ["string", ...],
        "LongValue": long,
        "DateValue": timestamp
      }
    },
    "GreaterThan": {
      "Key": "string",
      "Value": {
        "StringValue": "string",
        "StringListValue": ["string", ...],
        "LongValue": long,
        "DateValue": timestamp
      }
    },
    "GreaterThanOrEquals": {
      "Key": "string",
      "Value": {
        "StringValue": "string",
        "StringListValue": ["string", ...],
        "LongValue": long,
        "DateValue": timestamp
      }
    },
    "LessThan": {
      "Key": "string",
      "Value": {
        "StringValue": "string",
        "StringListValue": ["string", ...],
        "LongValue": long,
        "DateValue": timestamp
      }
    },
    "LessThanOrEquals": {
      "Key": "string",
      "Value": {
        "StringValue": "string",
        "StringListValue": ["string", ...],
        "LongValue": long,
        "DateValue": timestamp
      }
    }
  },
  "UserContext": {
    "Token": "string",
    "UserId": "string",
    "Groups": ["string", ...],
    "DataSourceGroups": [
      {
        "GroupId": "string",
        "DataSourceId": "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.

Вывод

Идентификатор предложений запросов -> (строка)

Идентификатор списка предложений запросов для индекса.

Предложения -> (список)

Список предложений запросов для индекса.

(структура)

Одно предложение запроса.

Идентификатор -> (строка)

UUID (универсальный уникальный идентификатор) одного предложения запроса.

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

Значение для UUID (универсального уникального идентификатора) одного предложения запроса.

Значение — это текстовая строка предложения.

Текст -> (структура)

Структура SuggestionTextWithHighlights, содержащая текст предложения запроса и выделения.

Текст -> (строка)

Текст предложения запроса для отображения пользователю.

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

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

(структура)

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

Начальная позиция -> (целое число)

Позиция с нулевой базой в строке ответа, где начинается выделение.

Конечная позиция -> (целое число)

Позиция с нулевой базой в строке ответа, где заканчивается выделение.

Документы-источники -> (список)

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

(структура)

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

Идентификатор документа -> (строка)

Идентификатор документа, используемого для предложения запроса.

Атрибуты предложения -> (список)

Поля/атрибуты документа, используемые для предложения запроса.

(строка)

Дополнительные атрибуты -> (список)

Дополнительные поля/атрибуты для включения в ответ. Вы можете использовать дополнительные поля для предоставления дополнительной информации в ответе. Дополнительные поля не используются для формирования предложений.

(структура)

Атрибут или поле метаданных документа. Чтобы создать пользовательские атрибуты документов, см. Пользовательские атрибуты .

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

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

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

Значение атрибута.

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

Строка, например, «отдел».

Список строковых значений -> (список)

Список строк. Максимальная длина или количество строк по умолчанию составляет 10.

(строка)

Целое значение -> (целое)

Целое число со знаком.

Значение даты -> (метка времени)

Дата, представленная в формате ISO 8601.

Важно включить часовой пояс в формате даты-времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.

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

Spec-Zone.ru

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