retrieve

Описание

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

Этот API похож на API запросов. Однако по умолчанию API Query возвращает отрывки из текста длиной не более 100 токенов. С помощью API Retrieve можно извлекать более длинные отрывки до 200 токенов и до 100 семантически релевантных отрывков. Это не включает ответы на вопросы или ответы из FAQ вашего индекса. Отрывки — это фрагменты текста, которые могут быть семантически извлечены из нескольких документов и нескольких частей одного документа. Если в крайних случаях ваши документы не возвращают ни одного отрывка с помощью API Retrieve, вы можете альтернативно использовать API Query и его типы ответов.

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

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

Примечание

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

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

API Retrieve использует количество единиц запроса, которые вы настроили для своего индекса. Дополнительную информацию о том, что включено в одну единицу мощности и базовую емкость по умолчанию для индекса, см. в разделе Настройка емкости.

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

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

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

Синтаксис

  retrieve
--index-id <value>
--query-text <value>
[--attribute-filter <value>]
[--requested-document-attributes <value>]
[--document-relevance-override-configurations <value>]
[--page-number <value>]
[--page-size <value>]
[--user-context <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 -> (структура)

Выполняет операцию больше или равно для атрибутов/полей документов и их значений. Используйте с типом атрибута документа 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.

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.

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(строка)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

(строка)

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

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

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

Дата, представленная в формате 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
    }
  }
}

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

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

(строка)

Синтаксис:

"string" "string" ...

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

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

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

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

(структура)

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

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

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

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

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

Актуальность -> (булево)

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

Важность -> (целое число)

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

Продолжительность -> (строка)

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

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

Порядок сортировки -> (строка)

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

Когда поле 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.

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

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

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

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

UserId -> (строка)

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

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

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

(строка)

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"
    }
    ...
  ]
}

--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 (boolean)

Включить отладку регистрации.

--endpoint-url (string)

Переопределить значение URL по умолчанию для команды заданным URL.

--no-verify-ssl (boolean)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет стандартное поведение проверки SSL-сертификатов.

--no-paginate (boolean)

Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.

--output (string)

Стиль форматирования вывода команд.

json
text
table
yaml
yaml-stream

--query (string)

Запрос JMESPath для фильтрации данных ответа.

--profile (string)

Использовать определенный профиль из файла учетных данных.

--region (string)

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

--version (string)

Отобразить версию этого инструмента.

--color (string)

Включить/отключить цветной вывод.

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

Файл с корневым сертификатом для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (string)

Стиль форматирования, используемый для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить кли-пейджер для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

QueryId -> (string)

Идентификатор запроса, используемый для поиска. Вы также можете использовать QueryId для идентификации поиска при использовании API Submitfeedback.

ResultItems -> (list)

Результаты полученных соответствующих пассажей для поиска.

(structure)

Результат одного полученного соответствующего пассажа.

Id -> (string)

Идентификатор результата соответствующего пассажа.

DocumentId -> (string)

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

DocumentTitle -> (string)

Заголовок документа.

Content -> (string)

Содержимое соответствующего пассажа.

DocumentURI -> (string)

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

DocumentAttributes -> (list)

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

(structure)

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

Key -> (string)

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

Value -> (structure)

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

StringValue -> (string)

Строка, такая как "отдел".

StringListValue -> (list)

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

(string)

LongValue -> (long)

Длинное целое значение.

DateValue -> (timestamp)

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

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

ScoreAttributes -> (structure)

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

ScoreConfidence -> (string)

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