запрос

Описание

Ищет индекс по заданному запросу.

Примечание

Если вы работаете с большими языковыми моделями (LLMs) или реализуете системы извлечения с использованием искусственного интеллекта (RAG), вы можете использовать API Amazon Kendra Retrieve, который может возвращать более длинные семантически релевантные фрагменты. Мы рекомендуем использовать API Retrieve вместо увеличения лимита сервиса для увеличения длины выдержки документации API Query.

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

Ответ на запрос содержит три типа результатов.

Релевантные предложенные ответы. Ответы могут быть текстовыми или табличными фрагментами. Ответ может быть выделен в фрагменте.
Соответствующие часто задаваемые вопросы или вопросы-ответы из вашего файла FAQ.
Релевантные документы. Этот тип результата включает фрагмент документа с заголовком документа. Поисковые термины могут быть выделены во фрагменте.

Вы можете указать, чтобы запрос возвращал только один тип результата, используя параметр QueryResultTypeFilter. Каждый запрос возвращает 100 наиболее релевантных результатов. Если вы отфильтруете тип результата только на вопросы-ответы, будет возвращено максимум четыре результата. Если вы отфильтруете тип результата только на ответы, будет возвращено максимум три результата.

Предупреждение

Если вы используете индекс Amazon Kendra Gen AI Enterprise Edition, вы можете использовать только ATTRIBUTE_FILTER для фильтрации результатов поиска по контексту пользователя. Если вы используете индекс Amazon Kendra Gen AI Enterprise Edition и пытаетесь использовать USER_TOKEN для настройки политики контекста пользователя, Amazon Kendra возвращает ошибку ValidationException.

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

Синтаксис

  query
--index-id <value>
[--query-text <value>]
[--attribute-filter <value>]
[--facets <value>]
[--requested-document-attributes <value>]
[--query-result-type-filter <value>]
[--document-relevance-override-configurations <value>]
[--page-number <value>]
[--page-size <value>]
[--sorting-configuration <value>]
[--sorting-configurations <value>]
[--user-context <value>]
[--visitor-id <value>]
[--spell-correction-configuration <value>]
[--collapse-configuration <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 обрезает запросы до 30 токенизированных слов, исключая знаки препинания и стоп-слова. Обрезка применяется даже при использовании булевых или более сложных запросов. Например, Timeoff AND October AND Category:HR считается 3 токенами: timeoff , october , hr . Дополнительную информацию см. в разделе «Поиск с помощью расширенного синтаксиса запроса» в Руководстве разработчика Amazon Kendra.

--attribute-filter (структура)

Фильтры результатов поиска по полям/атрибутам документов. Вы можете указать только один фильтр атрибута; однако, параметры AndAllFilters , NotFilter и OrAllFilters содержат список других фильтров.

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

Примечание

Для индексов Amazon Kendra Gen AI Enterprise Edition используйте AttributeFilter, чтобы включить фильтрацию документов для конечных пользователей, использующих _email_id, или включать публичные документы (_email_id=null).

AndAllFilters -> (список)

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

(структура)

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

Вы можете фильтровать результаты по атрибутам ваших документов. Атрибуты должны существовать в вашем индексе. Например, если ваши документы включают пользовательский атрибут «Отдел», вы можете фильтровать документы, относящиеся к отделу «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 -> (целое число)

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

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.

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

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

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

Дата, выраженная в формате ISO 8601.

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

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

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

Дата, выраженная в формате ISO 8601.

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

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

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

Дата, выраженная в формате ISO 8601.

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

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

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

Дата, выраженная в формате ISO 8601.

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

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

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

Дата, выраженная в формате ISO 8601.

OrAllFilters -> (список)

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

(структура)

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

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

AndAllFilters

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

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

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

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.

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

Дата, выраженная в формате ISO 8601.

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

Дата, выраженная в формате ISO 8601.

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

Дата, выраженная в формате ISO 8601.

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

Дата, выраженная в формате ISO 8601.

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

Дата, выраженная в формате ISO 8601.

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.

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

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

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

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

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

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

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

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

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

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

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

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

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (целое)

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

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

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

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

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

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

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

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

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

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 .

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

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

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

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

Дата, выраженная в формате ISO 8601.

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

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

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

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

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

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

Дата, выраженная в формате ISO 8601.

Синтаксис JSON:

{
  "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
    }
  }
}

--facets (список)

Массив полей/атрибутов документов для фасетного поиска. Amazon Kendra возвращает счет для каждого указанного ключа поля. Это помогает пользователям сузить поиск.

(структура)

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

Например, атрибут или фасет «Отдел» включает значения «HR», «Инженерия» и «Бухгалтерия». Вы можете отобразить эти значения в результатах поиска, чтобы можно было искать документы по отделу.

Вы можете отобразить до 10 значений фасета на фасет для запроса. Если вы хотите увеличить этот лимит, обратитесь в службу поддержки.

DocumentAttributeKey -> (строка)

Уникальный ключ атрибута документа.

Facets -> (список)

Массив атрибутов документов, которые являются вложенными фасетами внутри фасета.

Например, атрибут или фасет «Отдел» включает значение «Инженерия». Кроме того, атрибут или фасет «Подразделение» включает значения «Frontend» и «Backend» для документов, назначенных «Инженерии». Вы можете отображать вложенные фасеты в результатах поиска, чтобы можно было искать документы не только по отделу, но и по подразделению внутри отдела. Это помогает пользователям еще больше сузить поиск.

Вы можете иметь только один вложенный фасет в фасете. Если вы хотите увеличить этот лимит, обратитесь в службу поддержки.

(структура)

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

DocumentAttributeKey -> (строка)

Уникальный ключ атрибута документа.

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

Максимальное количество значений фасета на фасет. По умолчанию — 10. Вы можете использовать это для ограничения количества значений фасета до менее 10. Если вы хотите увеличить значение по умолчанию, обратитесь в службу поддержки.

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

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

DocumentAttributeKey=string,Facets=[{DocumentAttributeKey=string,( ... recursive ... ),MaxResults=integer},{DocumentAttributeKey=string,( ... recursive ... ),MaxResults=integer}],MaxResults=integer ...

Синтаксис JSON:

[
  {
    "DocumentAttributeKey": "string",
    "Facets": [
      {
        "DocumentAttributeKey": "string",
        "Facets": ,
        "MaxResults": integer
      }
      ...
    ],
    "MaxResults": integer
  }
  ...
]

--requested-document-attributes (список)

Массив полей/атрибутов документов, которые нужно включить в ответ. Вы можете ограничить ответ включением определенных полей документов. По умолчанию все атрибуты документов включены в ответ.

(строка)

Синтаксис:

"string" "string" ...

--query-result-type-filter (строка)

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

Возможные значения:

DOCUMENT
QUESTION_ANSWER
ANSWER

--document-relevance-override-configurations (список)

Переопределяет настройки настройки релевантности полей/атрибутов, установленные на уровне индекса.

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

Если для полей на уровне индекса настроены настройки настройки релевантности, и вы используете этот API для переопределения только некоторых из этих полей, то для полей, которые вы не переопределили, важность устанавливается в 1.

(структура)

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

Имя -> (строка)

Имя поля индекса.

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

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

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

Указывает, что это поле определяет, насколько «свеж» документ. Например, если документ 1 был создан 5 ноября, а документ 2 — 31 октября, документ 1 «свежее», чем документ 2. Применимо только к полям DATE.

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

Относительная важность поля в поиске. Более высокие числа обеспечивают больший прирост, чем меньшие.

Duration -> (строка)

Указывает временной период, на который распространяется повышение. Например, чтобы повышение распространялось на документы со значением поля в течение последнего месяца, вы бы использовали «2628000s». Как только значение поля выходит за указанный диапазон, эффект повышения исчезает. Чем выше важность, тем быстрее эффект снижается. Если вы не укажете значение, значение по умолчанию составляет 3 месяца. Значение поля — это числовая строка, за которой следует символ «s», например, «86400s» для одного дня или «604800s» для одной недели.

Применимо только к полям DATE.

RankOrder -> (строка)

Определяет, как следует интерпретировать значения.

Когда поле RankOrder имеет значение ASCENDING, более высокие числа лучше. Например, документ с рейтингом 10 имеет более высокий рейтинг, чем документ с рейтингом 1.

Когда поле RankOrder имеет значение DESCENDING, меньшие числа лучше. Например, в приложении отслеживания задач задача с приоритетом 1 важнее задачи с приоритетом 5.

Применимо только к полям LONG.

ValueImportanceMap -> (карта)

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

Например, вы можете добавить записи в карту с названиями отделов. Если вы добавите «HR»,5 и «Legal»,3, этим отделам будет уделено особое внимание, когда они появятся в метаданных документа. При появлении этих терминов им будет присвоена указанная важность вместо обычной важности для повышения.

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

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

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

Name=string,Relevance={Freshness=boolean,Importance=integer,Duration=string,RankOrder=string,ValueImportanceMap={KeyName1=integer,KeyName2=integer}} ...

Синтаксис JSON:

[
  {
    "Name": "string",
    "Relevance": {
      "Freshness": true|false,
      "Importance": integer,
      "Duration": "string",
      "RankOrder": "ASCENDING"|"DESCENDING",
      "ValueImportanceMap": {"string": integer
        ...}
    }
  }
  ...
]

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

Результаты запроса возвращаются страницами размером с параметром PageSize. По умолчанию Amazon Kendra возвращает первую страницу результатов. Используйте этот параметр, чтобы получить страницы результатов после первой.

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

Устанавливает количество результатов, возвращаемых на каждой странице результатов. Размер страницы по умолчанию — 10. Максимальное количество возвращаемых результатов — 100. Если вы запрашиваете более 100 результатов, возвращается только 100.

--sorting-configuration (структура)

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

Если вы не предоставите конфигурацию сортировки, результаты сортируются по релевантности, определенной Amazon Kendra для результата.

DocumentAttributeKey -> (строка)

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

Вы также можете сортировать по следующим встроенным атрибутам:

_category
_created_at
_last_updated_at
_version
_view_count

SortOrder -> (строка)

Порядок возврата результатов. В случае ничьей в качестве решающего фактора используется релевантность, присвоенная результату Amazon Kendra.

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

DocumentAttributeKey=string,SortOrder=string

Синтаксис JSON:

{
  "DocumentAttributeKey": "string",
  "SortOrder": "DESC"|"ASC"
}

--sorting-configurations (список)

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

Вы можете указать до 3 полей, по которым Amazon Kendra должен сортировать результаты, и определить, должны ли результаты сортироваться в порядке возрастания или убывания. Квоту на сортировку полей можно увеличить.

Если вы не предоставите конфигурацию сортировки, результаты будут отсортированы по релевантности, определенной Amazon Kendra для результата. В случае совпадения при сортировке результатов, результаты сортируются по релевантности.

(структура)

Указывает атрибут документа, который нужно использовать для сортировки ответа на запрос Amazon Kendra. Вы можете указать один атрибут для сортировки. Атрибут должен иметь флаг Sortable, установленный в значение true, в противном случае Amazon Kendra вернет исключение.

Вы можете сортировать атрибуты следующих типов.

Значение даты
Значение типа Long
Строковое значение

Вы не можете сортировать атрибуты следующего типа.

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

DocumentAttributeKey -> (строка)

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

Вы также можете сортировать по следующим встроенным атрибутам:

_category
_created_at
_last_updated_at
_version
_view_count

SortOrder -> (строка)

Порядок возврата результатов. В случае совпадений, для определения приоритета используется релевантность, назначенная результату Amazon Kendra.

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

DocumentAttributeKey=string,SortOrder=string ...

Синтаксис JSON:

[
  {
    "DocumentAttributeKey": "string",
    "SortOrder": "DESC"|"ASC"
  }
  ...
]

--user-context (структура)

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

Token -> (строка)

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

UserId -> (строка)

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

Groups -> (список)

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

(строка)

DataSourceGroups -> (список)

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

(структура)

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

GroupId -> (строка)

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

DataSourceId -> (строка)

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

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

Token=string,UserId=string,Groups=string,string,DataSourceGroups=[{GroupId=string,DataSourceId=string},{GroupId=string,DataSourceId=string}]

Синтаксис JSON:

{
  "Token": "string",
  "UserId": "string",
  "Groups": ["string", ...],
  "DataSourceGroups": [
    {
      "GroupId": "string",
      "DataSourceId": "string"
    }
    ...
  ]
}

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

Предоставляет идентификатор для конкретного пользователя. VisitorId должен быть уникальным идентификатором, таким как GUID. Не используйте персональную информацию, такую как адрес электронной почты пользователя, в качестве VisitorId.

--spell-correction-configuration (структура)

Включает предложения по исправлению орфографических ошибок для запросов.

IncludeQuerySpellCheckSuggestions -> (булево)

TRUE для предложения по исправлению орфографических ошибок в запросах.

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

IncludeQuerySpellCheckSuggestions=boolean

Синтаксис JSON:

{
  "IncludeQuerySpellCheckSuggestions": true|false
}

--collapse-configuration (структура)

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

DocumentAttributeKey -> (строка)

Атрибут документа, используемый для группировки результатов поиска. Вы можете использовать любой атрибут, для которого флаг Sortable установлен в значение true. Вы также можете сортировать по следующим встроенным атрибутам: «_category», «_created_at», «_last_updated_at», «_version», «_view_count».

SortingConfigurations -> (список)

Упорядоченный список атрибутов/полей документов, определяющих основной документ среди тех, что входят в свернутую группу.

(структура)

Вы можете сортировать атрибуты следующих типов:

Значение даты
Значение типа Long
Строковое значение

Вы не можете сортировать атрибуты следующего типа.

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

DocumentAttributeKey -> (строка)

Вы также можете сортировать по следующим встроенным атрибутам:

_category
_created_at
_last_updated_at
_version
_view_count

SortOrder -> (строка)

MissingAttributeKeyStrategy -> (строка)

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

Amazon Kendra предлагает три варианта настройки:

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

Expand -> (булево)

Указывает, следует ли развернуть свёрнутые результаты.

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

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

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

Количество сгруппированных результатов поиска, которые следует развернуть. Например, если вы установите это значение в 10, только первые 10 из 100 групп результатов будут иметь возможность развертывания.

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

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

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

DocumentAttributeKey=string,SortingConfigurations=[{DocumentAttributeKey=string,SortOrder=string},{DocumentAttributeKey=string,SortOrder=string}],MissingAttributeKeyStrategy=string,Expand=boolean,ExpandConfiguration={MaxResultItemsToExpand=integer,MaxExpandedResultsPerItem=integer}

Синтаксис JSON:

{
  "DocumentAttributeKey": "string",
  "SortingConfigurations": [
    {
      "DocumentAttributeKey": "string",
      "SortOrder": "DESC"|"ASC"
    }
    ...
  ],
  "MissingAttributeKeyStrategy": "IGNORE"|"COLLAPSE"|"EXPAND",
  "Expand": true|false,
  "ExpandConfiguration": {
    "MaxResultItemsToExpand": integer,
    "MaxExpandedResultsPerItem": integer
  }
}

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

Вывод

QueryId -> (строка)

Идентификатор поиска. Также используется в API SubmitFeedback для идентификации поиска.

ResultItems -> (список)

Результаты поиска.

(структура)

Один результат поиска.

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

Id -> (строка)

Уникальный идентификатор, полученный объединением идентификатора элемента результата поиска (Id) и идентификатора документа результата поиска (DocumentId). Значение этого поля изменяется при каждом запросе, даже если документы остаются теми же.

Type -> (строка)

Тип документа в ответе. Например, ответ может содержать вопрос-ответ, относящийся к запросу.

Format -> (строка)

Если тип документа в ответе (Type) является (ANSWER), то это либо ответ в формате TABLE, либо TEXT. Если это ответ в формате таблицы, фрагмент таблицы возвращается в формате (TableExcerpt). Если это текстовый ответ, фрагмент текста возвращается в формате (DocumentExcerpt).

AdditionalAttributes -> (список)

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

(структура)

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

Key -> (строка)

Ключ, идентифицирующий атрибут.

ValueType -> (строка)

Тип данных свойства (Value).

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

Объект, содержащий значение атрибута.

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

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

Text -> (строка)

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

Highlights -> (список)

Начало и конец текста, который следует выделить.

(структура)

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

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

Базовая позиция в строке ответа, где начинается выделение.

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

Базовая позиция в строке ответа, где заканчивается выделение.

TopAnswer -> (булево)

Указывает, является ли ответ лучшим ответом. Истина, если это лучший ответ; иначе ложь.

Type -> (строка)

Тип выделения.

DocumentId -> (строка)

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

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

Название документа. Содержит текст заголовка и информацию для выделения соответствующих терминов в заголовке.

Text -> (строка)

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

Highlights -> (список)

Начало и конец текста, который следует выделить.

(структура)

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

Базовая позиция в строке ответа, где начинается выделение.

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

Базовая позиция в строке ответа, где заканчивается выделение.

TopAnswer -> (булево)

Указывает, является ли ответ лучшим ответом. Истина, если это лучший ответ; иначе ложь.

Type -> (строка)

Тип выделения.

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

Выдержка из текста документа. Содержит информацию об выделении соответствующих терминов в выдержке.

Text -> (строка)

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

Highlights -> (список)

Начало и конец текста, который следует выделить.

(структура)

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

Базовая позиция в строке ответа, где начинается выделение.

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

Базовая позиция в строке ответа, где заканчивается выделение.

TopAnswer -> (булево)

Указывает, является ли ответ лучшим ответом. Истина, если это лучший ответ; иначе ложь.

Type -> (строка)

Тип выделения.

DocumentURI -> (строка)

URI исходного расположения документа.

DocumentAttributes -> (список)

Массив полей/атрибутов документа, присвоенных документу в результатах поиска. Например, автор документа (_author) или URI источника документа (_source_uri).

(структура)

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

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 (плюс 10 секунд) по Центральноевропейскому времени.

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

Указывает уровень уверенности Amazon Kendra в предоставлении релевантного результата для запроса. Каждый результат помещается в категорию, которая указывает степень уверенности: VERY_HIGH, HIGH, MEDIUM и LOW. Вы можете использовать оценку, чтобы определить, соответствует ли ответ требуемому уровню уверенности вашего приложения.

Поле устанавливается в (LOW) только в том случае, если поле (Type) установлено в (DOCUMENT), и Amazon Kendra не уверен, что результат релевантен запросу.

ScoreConfidence -> (строка)

Относительный рейтинг релевантности ответа запросу.

FeedbackToken -> (строка)

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

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

Фрагмент таблицы из документа.

Rows -> (список)

Список строк в фрагменте таблицы.

(структура)

Информация о строке во фрагменте таблицы.

Cells -> (список)

Список ячеек таблицы в строке.

(структура)

Информация о ячейке таблицы в фрагменте таблицы.

Value -> (строка)

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

TopAnswer -> (булево)

TRUE, если ответ ячейки таблицы — лучший ответ. Это значение ячейки или содержимое с наивысшим значением оценки уверенности или наиболее релевантное запросу.

Highlighted -> (булево)

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

Header -> (булево)

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

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

Количество строк в исходной таблице документа.

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

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

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

Значение атрибута документа, на котором свёрнуты результаты.

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

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

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

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

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

ExpandedResults -> (список)

Список результатов в свёрнутой группе.

(структура)

Один расширенный результат в свёрнутой группе результатов поиска.

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

Id -> (строка)

Идентификатор расширенного результата.

DocumentId -> (строка)

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

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

Предоставляет текст и информацию о том, где выделить текст.

Text -> (строка)

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

Highlights -> (список)

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

(структура)

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

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

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

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

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

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

Указывает, является ли ответ лучшим ответом. True, если это лучший ответ; в противном случае false.

Type -> (строка)

Тип выделения.

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

Предоставляет текст и информацию о том, где выделить текст.

Text -> (строка)

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

Highlights -> (список)

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

(структура)

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

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

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

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

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

Указывает, является ли ответ лучшим ответом. True, если это лучший ответ; в противном случае false.

Type -> (строка)

Тип выделения.

DocumentURI -> (строка)

URI исходного расположения документа.

DocumentAttributes -> (список)

Массив атрибутов документа, назначенных документу в результатах поиска. Например, автор документа («_author») или URI источника документа («_source_uri»).

(структура)

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

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

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

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

FacetResults -> (список)

Содержит результаты фацетного поиска. В FacetResult содержатся подсчёты для каждого ключа поля/атрибута, указанного в Facets параметре ввода.

(структура)

Значения фацетов для документов в ответе.

DocumentAttributeKey -> (строка)

Ключ для значений фацетов. Это то же, что и DocumentAttributeKey, указанное в запросе.

DocumentAttributeValueType -> (строка)

Тип данных значения фацета. Это тот же тип, что определён для поля индекса при его создании.

DocumentAttributeValueCountPairs -> (список)

Массив пар ключ/значение, где ключ — значение атрибута, а счёт — количество документов, которые имеют данное значение ключа.

(структура)

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

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

Значение атрибута/поля. Например, «HR».

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

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

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

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

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

Количество документов в ответе, имеющих значение атрибута/поля для ключа.

FacetResults -> (список)

Содержит результаты атрибута/поля документа, которое является вложенным фацетом. В FacetResult содержатся подсчёты для каждого вложенного фацета внутри фацета.

Например, атрибут или фацет «Отдел» включает значение «Инженерный». Кроме того, атрибут или фацет «Подразделение» включает значения «Frontend» и «Backend» для документов, назначенных в «Инженерный». Вы можете отображать вложенные фацеты в результатах поиска, чтобы документы можно было искать не только по отделу, но также по подразделению внутри отдела. Подсчёты документов, относящихся к «Frontend» и «Backend» в «Инженерный», возвращаются для запроса.

(структура)

Значения фацетов для документов в ответе.

DocumentAttributeKey -> (строка)

Ключ для значений фацетов. Это то же, что и DocumentAttributeKey, указанное в запросе.

DocumentAttributeValueType -> (строка)

Тип данных значения фацета. Это тот же тип, что определён для поля индекса при его создании.

DocumentAttributeValueCountPairs -> (список)

(структура)

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

Значение атрибута/поля. Например, «HR».

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

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

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

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

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

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

Количество документов в ответе, имеющих значение атрибута/поля для ключа.

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

Общее количество найденных элементов по запросу. Однако вы можете получить не более 100 элементов. Например, если поиск нашёл 192 элемента, вы можете получить только первые 100 элементов.

Warnings -> (список)

Список кодов предупреждений и их сообщений о проблемах с запросом.

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

(структура)

Код предупреждения и сообщение, объясняющее проблему с запросом.

Message -> (строка)

Сообщение, объясняющее проблему с запросом.

Code -> (строка)

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

SpellCorrectedQueries -> (список)

Список информации, связанной с предлагаемыми исправлениями орфографических ошибок в запросе.

(структура)

Запрос с предлагаемыми исправлениями орфографических ошибок.

SuggestedQueryText -> (строка)

Запрос с предложенными исправлениями орфографических ошибок.

Corrections -> (список)

Исправленные неверно написанные слова или слова в запросе.

(структура)

Исправленное неверно написанное слово в запросе.

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

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

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

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

Term -> (строка)

Строка или текст неправильно написанного слова в запросе.

CorrectedTerm -> (строка)

Строка или текст исправленного неверно написанного слова в запросе.

FeaturedResultsItems -> (список)

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

(структура)

Один выделенный элемент результата поиска. Выделенный результат отображается в верхней части страницы результатов поиска, располагаясь выше всех остальных результатов для определённых запросов. Если запрос точно совпадает с документом, то некоторые документы выделяются в результатах поиска.

Id -> (строка)

Идентификатор выделенного результата.

Type -> (строка)

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

AdditionalAttributes -> (список)

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

(структура)

Атрибут, возвращаемый из запроса к индексу.

Key -> (строка)

Ключ, идентифицирующий атрибут.

ValueType -> (строка)

Тип данных свойства Value.

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

Объект, содержащий значение атрибута.

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

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

Text -> (строка)

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

Highlights -> (список)

Начало и конец текста, который необходимо выделить.

(структура)

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

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

Базовая позиция в строке ответа, где начинается выделение (с нуля).

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

Базовая позиция в строке ответа, где заканчивается выделение (с нуля).

TopAnswer -> (булево)

Указывает, является ли ответ лучшим ответом. True, если это лучший ответ; иначе, false.

Type -> (строка)

Тип выделения.

DocumentId -> (строка)

Идентификатор выделенного документа.

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

Предоставляет текст и информацию о том, где выделить текст.

Text -> (строка)

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

Highlights -> (список)

Начало и конец текста, который необходимо выделить.

(структура)

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

Базовая позиция в строке ответа, где начинается выделение (с нуля).

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

Базовая позиция в строке ответа, где заканчивается выделение (с нуля).

TopAnswer -> (булево)

Указывает, является ли ответ лучшим ответом. True, если это лучший ответ; иначе, false.

Type -> (строка)

Тип выделения.

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

Предоставляет текст и информацию о том, где выделить текст.

Text -> (строка)

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

Highlights -> (список)

Начало и конец текста, который необходимо выделить.

(структура)

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

Базовая позиция в строке ответа, где начинается выделение (с нуля).

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

Базовая позиция в строке ответа, где заканчивается выделение (с нуля).

TopAnswer -> (булево)

Указывает, является ли ответ лучшим ответом. True, если это лучший ответ; иначе, false.

Type -> (строка)

Тип выделения.

DocumentURI -> (строка)

Исходный URI расположения выделенного документа.

DocumentAttributes -> (список)

Массив атрибутов документа, назначенных выделенному документу в результатах поиска. Например, автор документа (_author ) или исходный URI (_source_uri ) документа.

(структура)

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

Key -> (строка)

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

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

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

StringValue -> (строка)

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

StringListValue -> (список)

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

(строка)

LongValue -> (длинное целое)

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

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

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

FeedbackToken -> (строка)

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