search-relevant-content
Description
Поиск релевантного контента в приложении Amazon Q Business на основе запроса. Эта операция принимает текст поискового запроса, идентификатор приложения Amazon Q Business и необязательные фильтры (например, источник контента и максимальное количество результатов) в качестве входных данных. Она возвращает список релевантных элементов контента, где каждый элемент включает текст контента, уникальный идентификатор документа, название документа, URI документа, любые соответствующие атрибуты документа и атрибуты оценки, указывающие уровень достоверности релевантности.
См. также: AWS API Documentation
search-relevant-content - это операция с разбивкой на страницы. Для получения всего набора данных результатов может быть выдано несколько вызовов API. Вы можете отключить разбиение на страницы, предоставив аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с разбивкой на страницы аргумент --query должен извлекать данные из результатов следующих выражений запроса: relevantContent
Synopsis
search-relevant-content
--application-id <value>
--query-text <value>
--content-source <value>
[--attribute-filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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]
Options
--application-id (string)
--query-text (string)
--content-source (tagged union structure)
Источник контента для поиска.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:retriever.retriever -> (structure)
Ретривер для использования в качестве источника контента.
retrieverId -> (string)
Shorthand Syntax:
retriever={retrieverId=string}
JSON Syntax:
{
"retriever": {
"retrieverId": "string"
}
}
--attribute-filter (structure)
Включает фильтрацию ответов на основе атрибутов документа или полей метаданных.
andAllFilters -> (list)
Выполняет логическую операцию AND над всеми предоставленными фильтрами.
(structure)
Включает фильтрацию ответов на основе атрибутов документа или полей метаданных.
andAllFilters -> (list)
Выполняет логическую операцию AND над всеми предоставленными фильтрами.
( … recursive … )
orAllFilters -> (list)
Выполняет логическую операцию OR над всеми предоставленными фильтрами.
( … recursive … )
( … recursive … )equalsTo -> (structure)
Выполняет операцию равенства над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue, longValue, stringListValue и stringValue.
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 - это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
containsAll -> (structure)
Возвращает true, когда документ содержит все указанные атрибуты документа или поля метаданных. Поддерживается для следующих типов значений атрибутов документа: stringListValue.
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 - это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
containsAny -> (structure)
Возвращает true, когда документ содержит любой из указанных атрибутов документа или полей метаданных. Поддерживается для следующих типов значений атрибутов документа: stringListValue.
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 - это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
greaterThan -> (structure)
Выполняет операцию «больше чем» над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue.
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 - это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
greaterThanOrEquals -> (structure)
Выполняет операцию «больше или равно чем» над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue.
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 - это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
lessThan -> (structure)
Выполняет операцию «меньше чем» над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue.
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 - это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
lessThanOrEquals -> (structure)
Выполняет операцию «меньше или равно чем» над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue.
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 - это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
orAllFilters -> (list)
Выполняет логическую OR операцию над всеми предоставленными фильтрами.
(структура)
Включает фильтрацию ответов на основе атрибутов документа или полей метаданных.
andAllFilters -> (список)
Выполняет логическую AND операцию над всеми предоставленными фильтрами.
(… рекурсивно …)
orAllFilters -> (список)
Выполняет логическую OR операцию над всеми предоставленными фильтрами.
(… рекурсивно …)
(… рекурсивно …)equalsTo -> (структура)
Выполняет операцию равенства по двум атрибутам документа или полям метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue, longValue, stringListValue и stringValue.
name -> (строка)
value -> (структура помеченного объединения)
Значение атрибута.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (целое)
dateValue -> (метка времени)
Дата, выраженная в формате ISO 8601.
Важно включать часовой пояс в формате ISO 8601 даты и времени. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
containsAll -> (структура)
Возвращает true, когда документ содержит все указанные атрибуты документа или поля метаданных. Поддерживается для следующих типов значений атрибутов документа: stringListValue.
name -> (строка)
value -> (структура помеченного объединения)
Значение атрибута.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (целое)
dateValue -> (метка времени)
Дата, выраженная в формате ISO 8601.
Важно включать часовой пояс в формате ISO 8601 даты и времени. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
containsAny -> (структура)
Возвращает true, когда документ содержит любой из указанных атрибутов документа или полей метаданных. Поддерживается для следующих типов значений атрибутов документа: stringListValue.
name -> (строка)
value -> (структура помеченного объединения)
Значение атрибута.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (целое)
dateValue -> (метка времени)
Дата, выраженная в формате ISO 8601.
Важно включать часовой пояс в формате ISO 8601 даты и времени. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
greaterThan -> (структура)
Выполняет операцию больше, чем по двум атрибутам документа или полям метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue.
name -> (строка)
value -> (структура помеченного объединения)
Значение атрибута.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (целое)
dateValue -> (метка времени)
Дата, выраженная в формате ISO 8601.
Важно включать часовой пояс в формате ISO 8601 даты и времени. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
greaterThanOrEquals -> (структура)
Выполняет операцию больше или равно по двум атрибутам документа или полям метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue.
name -> (строка)
value -> (структура помеченного объединения)
Значение атрибута.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (целое)
dateValue -> (метка времени)
Дата, выраженная в формате ISO 8601.
Важно включать часовой пояс в формате ISO 8601 даты и времени. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
lessThan -> (структура)
Выполняет операцию меньше, чем по двум атрибутам документа или полям метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue.
name -> (строка)
value -> (структура помеченного объединения)
Значение атрибута.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (целое)
dateValue -> (метка времени)
Дата, выраженная в формате ISO 8601.
Важно включать часовой пояс в формате ISO 8601 даты и времени. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
lessThanOrEquals -> (структура)
Выполняет операцию меньше или равно по двум атрибутам документа или полям метаданных. Поддерживается для следующих типов значений атрибутов: dateValue и longValue.
name -> (строка)
value -> (структура помеченного объединения)
Значение атрибута.
Примечание
Это структура помеченного объединения. Может быть установлено только одно из следующих верхнеуровневых ключей:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (целое)
dateValue -> (метка времени)
Дата, выраженная в формате ISO 8601.
Важно включать часовой пояс в формате ISO 8601 даты и времени. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
notFilter -> (структура)
Выполняет логическую NOT операцию над всеми предоставленными фильтрами.
andAllFilters -> (list)
Выполняет логическую AND операцию над всеми предоставленными фильтрами.
( … recursive … )
orAllFilters -> (list)
Выполняет логическую OR операцию над всеми предоставленными фильтрами.
( … recursive … )
( … recursive … )equalsTo -> (structure)
Выполняет операцию равенства над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue , longValue , stringListValue и stringValue .
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Примечание
Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
containsAll -> (structure)
Возвращает true, когда документ содержит все указанные атрибуты документа или поля метаданных. Поддерживается для следующих типов значений атрибутов документа: stringListValue .
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Примечание
Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
containsAny -> (structure)
Возвращает true, когда документ содержит любой из указанных атрибутов документа или полей метаданных. Поддерживается для следующих типов значений атрибутов документа: stringListValue .
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Примечание
Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
greaterThan -> (structure)
Выполняет операцию «больше чем» над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue .
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Примечание
Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
greaterThanOrEquals -> (structure)
Выполняет операцию «больше или равно чем» над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue .
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Примечание
Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
lessThan -> (structure)
Выполняет операцию «меньше чем» над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue .
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Примечание
Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
lessThanOrEquals -> (structure)
Выполняет операцию «меньше или равно чем» над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue .
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Примечание
Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
equalsTo -> (structure)
Выполняет операцию равенства над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue , longValue , stringListValue и stringValue .
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Примечание
Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
containsAll -> (structure)
Возвращает true, когда документ содержит все указанные атрибуты документа или поля метаданных. Поддерживается для следующих типов значений атрибутов документа: stringListValue .
name -> (string)
value -> (tagged union structure)
Значение атрибута.
Примечание
Это структура Tagged Union. Только один из следующих ключей верхнего уровня может быть установлен:stringValue, stringListValue, longValue, dateValue.stringValue -> (string)
stringListValue -> (list)
Список строк.
(string)
longValue -> (long)
dateValue -> (timestamp)
Дата, выраженная как строка ISO 8601.
Важно, чтобы часовой пояс был включен в формат даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по центральноевропейскому времени.
containsAny -> (structure)
Возвращает true, когда документ содержит любой из указанных атрибутов документа или метаданных. Поддерживается для следующих типов значений атрибутов документа: stringListValue .
name -> (строка)
value -> (структура помеченного союза)
Значение атрибута.
Примечание
Это структура помеченного союза. Может быть установлено только одно из следующих ключевых слов верхнего уровня:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (длинное целое)
dateValue -> (метка времени)
Дата, представленная в формате ISO 8601.
Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
greaterThan -> (структура)
Выполняет операцию больше, чем над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue .
name -> (строка)
value -> (структура помеченного союза)
Значение атрибута.
Примечание
Это структура помеченного союза. Может быть установлено только одно из следующих ключевых слов верхнего уровня:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (длинное целое)
dateValue -> (метка времени)
Дата, представленная в формате ISO 8601.
Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
greaterThanOrEquals -> (структура)
Выполняет операцию больше или равно над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue .
name -> (строка)
value -> (структура помеченного союза)
Значение атрибута.
Примечание
Это структура помеченного союза. Может быть установлено только одно из следующих ключевых слов верхнего уровня:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (длинное целое)
dateValue -> (метка времени)
Дата, представленная в формате ISO 8601.
Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
lessThan -> (структура)
Выполняет операцию меньше, чем над двумя атрибутами документа или полями метаданных. Поддерживается для следующих типов значений атрибутов документа: dateValue и longValue .
name -> (строка)
value -> (структура помеченного союза)
Значение атрибута.
Примечание
Это структура помеченного союза. Может быть установлено только одно из следующих ключевых слов верхнего уровня:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (длинное целое)
dateValue -> (метка времени)
Дата, представленная в формате ISO 8601.
Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
lessThanOrEquals -> (структура)
Выполняет операцию меньше или равно над двумя атрибутами документа или полями метаданных. Поддерживается для следующего типа значений атрибутов документа: dateValue и longValue .
name -> (строка)
value -> (структура помеченного союза)
Значение атрибута.
Примечание
Это структура помеченного союза. Может быть установлено только одно из следующих ключевых слов верхнего уровня:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (длинное целое)
dateValue -> (метка времени)
Дата, представленная в формате ISO 8601.
Важно включить часовой пояс в формате даты и времени ISO 8601. Например, 2012-03-25T12:30:10+01:00 — это формат даты и времени ISO 8601 для 25 марта 2012 года в 12:30 (плюс 10 секунд) по Центральноевропейскому времени.
Синтаксис JSON:
{
"andAllFilters": [
{
"andAllFilters": [
{ ... recursive ... }
...
],
"orAllFilters": [
{ ... recursive ... }
...
],
"notFilter": { ... recursive ... },
"equalsTo": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"containsAll": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"containsAny": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"greaterThan": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"greaterThanOrEquals": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"lessThan": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"lessThanOrEquals": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
}
}
...
],
"orAllFilters": [
{
"andAllFilters": [
{ ... recursive ... }
...
],
"orAllFilters": [
{ ... recursive ... }
...
],
"notFilter": { ... recursive ... },
"equalsTo": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"containsAll": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"containsAny": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"greaterThan": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"greaterThanOrEquals": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"lessThan": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"lessThanOrEquals": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
}
}
...
],
"notFilter": {
"andAllFilters": [
{ ... recursive ... }
...
],
"orAllFilters": [
{ ... recursive ... }
...
],
"notFilter": { ... recursive ... },
"equalsTo": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"containsAll": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"containsAny": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"greaterThan": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"greaterThanOrEquals": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"lessThan": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"lessThanOrEquals": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
}
},
"equalsTo": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"containsAll": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"containsAny": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"greaterThan": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"greaterThanOrEquals": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"lessThan": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
},
"lessThanOrEquals": {
"name": "string",
"value": {
"stringValue": "string",
"stringListValue": ["string", ...],
"longValue": long,
"dateValue": timestamp
}
}
}
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передавать произвольные двоичные значения с помощью значения, предоставленного JSON, так как строка будет взята буквально. Это может не быть указано вместе с --cli-input-yaml.
--starting-token (строка)
Токен для указания начальной точки для постраничной навигации. Это NextToken из ранее усеченного ответа.
Примеры использования см. в разделе «Постраничная навигация» в Руководстве пользователя AWS Command Line Interface.
--page-size (целое число)
Размер каждой страницы для получения в вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Установка меньшего размера страницы приводит к большему количеству вызовов AWS-сервиса, получая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.
Примеры использования см. в разделе «Постраничная навигация» в Руководстве пользователя AWS Command Line Interface.
--max-items (целое число)
Общее количество элементов для возврата в выводе команды. Если общее количество доступных элементов больше указанного значения, в выводе команды предоставляется NextToken. Для возобновления постраничной навигации укажите значение NextToken в аргументе starting-token последующей команды. **Не** используйте элемент ответа NextToken напрямую вне AWS CLI.
Примеры использования см. в разделе «Постраничная навигация» в Руководстве пользователя AWS Command Line Interface.
--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 (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться в блокирующем режиме без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 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.
Вывод
relevantContent -> (список)
Список найденных элементов контента, относящихся к запросу.
(структура)
Представляет собой элемент контента, относящийся к поисковому запросу.
content -> (строка)
documentId -> (строка)
documentTitle -> (строка)
documentUri -> (строка)
documentAttributes -> (список)
Дополнительные атрибуты документа, содержащего соответствующий контент.
(структура)
Атрибут или поле метаданных документа.
name -> (строка)
value -> (меченый союз структур)
Значение атрибута.
Примечание
Это структура меченого союза. Может быть установлено только одно из следующих ключевых слов верхнего уровня:stringValue, stringListValue, longValue, dateValue.stringValue -> (строка)
stringListValue -> (список)
Список строк.
(строка)
longValue -> (целое)
dateValue -> (метка времени)
Дата, представленная в формате ISO 8601.
Важно, чтобы в формате даты-времени ISO 8601 был указан часовой пояс. Например, 2012-03-25T12:30:10+01:00 — это формат даты-времени ISO 8601 для 25 марта 2012 года в 12:30 по Центральноевропейскому времени.
scoreAttributes -> (структура)
Атрибуты, связанные со значением релевантности контента.
scoreConfidence -> (строка)
nextToken -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.
