update-retriever
Описание
Обновляет ретривер, используемый для вашего приложения Amazon Q Business.
См. также: Документацию API AWS
Синтаксис
update-retriever
--application-id <value>
--retriever-id <value>
[--configuration <value>]
[--display-name <value>]
[--role-arn <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]
Параметры
--application-id (строка)
--retriever-id (строка)
--configuration (структура помеченного объединения)
Предоставляет информацию о конфигурации ретривера, используемого для вашего приложения Amazon Q Business.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих верхних ключей:nativeIndexConfiguration, kendraIndexConfiguration.nativeIndexConfiguration -> (структура)
Предоставляет информацию о конфигурации индекса Amazon Q Business, используемого в качестве ретривера для вашего приложения Amazon Q Business.
indexId -> (строка)
boostingOverride -> (карта)
Переопределяет значения по умолчанию для усиления, применяемого Amazon Q Business к поддерживаемым типам данных атрибутов документов.
key -> (строка)
value -> (структура помеченного объединения)
Предоставляет информацию об усилении поддерживаемых типов атрибутов документов Amazon Q Business. При совпадении запроса пользователя чат с атрибутами документов, усиленными этим параметром, Amazon Q Business имеет приоритет в генерации ответов из контента, соответствующего усиленным атрибутам документов.
Примечание
Для использования типов атрибутов документовSTRING и STRING_LIST для усиления в консоли и API, они должны быть включены для поиска с помощью объекта DocumentAttributeConfiguration API UpdateIndex. Если поиск по этим атрибутам не включен, усиливать атрибуты этих типов данных в консоли или API невозможно.Дополнительную информацию о работе усиления атрибутов документов в Amazon Q Business см. в разделе Усиление с помощью атрибутов документов.
Примечание
Это структура помеченного объединения. Можно установить только один из следующих верхних ключей:numberConfiguration, stringConfiguration, dateConfiguration, stringListConfiguration.numberConfiguration -> (структура)
Предоставляет информацию об усилении атрибутов документов типа NUMBER.
boostingLevel -> (строка)
NUMBER.boostingType -> (строка)
stringConfiguration -> (структура)
Предоставляет информацию об усилении атрибутов документов типа STRING.
boostingLevel -> (строка)
attributeValueBoosting -> (карта)
Указывает конкретные значения атрибута документа типа STRING, которые необходимо усилить.
key -> (строка)
value -> (строка)
dateConfiguration -> (структура)
Предоставляет информацию об усилении атрибутов документов типа DATE.
boostingLevel -> (строка)
boostingDurationInSeconds -> (целое число)
DATE.stringListConfiguration -> (структура)
Предоставляет информацию об усилении атрибутов документов типа STRING_LIST.
boostingLevel -> (строка)
kendraIndexConfiguration -> (структура)
Предоставляет информацию о конфигурации индекса Amazon Kendra, используемого в качестве ретривера для вашего приложения Amazon Q Business.
indexId -> (строка)
Синтаксис JSON:
{
"nativeIndexConfiguration": {
"indexId": "string",
"boostingOverride": {"string": {
"numberConfiguration": {
"boostingLevel": "NONE"|"LOW"|"MEDIUM"|"HIGH"|"VERY_HIGH",
"boostingType": "PRIORITIZE_LARGER_VALUES"|"PRIORITIZE_SMALLER_VALUES"
},
"stringConfiguration": {
"boostingLevel": "NONE"|"LOW"|"MEDIUM"|"HIGH"|"VERY_HIGH",
"attributeValueBoosting": {"string": "LOW"|"MEDIUM"|"HIGH"|"VERY_HIGH"
...}
},
"dateConfiguration": {
"boostingLevel": "NONE"|"LOW"|"MEDIUM"|"HIGH"|"VERY_HIGH",
"boostingDurationInSeconds": long
},
"stringListConfiguration": {
"boostingLevel": "NONE"|"LOW"|"MEDIUM"|"HIGH"|"VERY_HIGH"
}
}
...}
},
"kendraIndexConfiguration": {
"indexId": "string"
}
}
--display-name (строка)
--role-arn (строка)
--cli-input-json | --cli-input-yaml (строка) Считывает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, указанному в --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения с помощью значения JSON, поскольку строка будет принята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки запроса API. При отсутствии значения или значении input выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, при указании значения yaml-input будет выведен пример входного YAML, который можно использовать с --cli-input-yaml. При указании значения output он валидирует входные данные команды и возвращает пример выходного JSON для данной команды. Сгенерированный каркас JSON не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.
Глобальные параметры
--debug (булево)
Включить отладочную запись в журнал.
--endpoint-url (строка)
Переопределить URL по умолчанию команды указанным URL.
--no-verify-ssl (булево)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки сертификатов SSL по умолчанию.
--no-paginate (булево)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI сделает только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования вывода команды.
- json
- текст
- таблица
- yaml
- yaml-поток
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- включен
- выключен
- автоматически
--no-sign-request (булево)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (строка)
Файл с набором сертификатов CA для проверки сертификатов SSL. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение равно 0, чтение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения сокета в секундах. Если значение равно 0, подключение сокета будет выполняться блокирующим образом без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены в виде строки, закодированной в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI версии 1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, отображающего двоичный блок, fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть правильно отформатировано для заданной конфигурации cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (булево)
Отключить постраничный вывод для CLI.
--cli-auto-prompt (булево)
Автоматически запрашивать параметры входных данных CLI.
--no-cli-auto-prompt (булево)
Отключить автоматическое запросить параметров входных данных CLI.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.