Spec-Zone.ru › AWS CLI v2

[ aws . qbusiness ]

get-retriever

Описание

Получает информацию об используемом ретривере приложения Amazon Q Business.

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

Синтаксис

  get-retriever
--application-id <value>
--retriever-id <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 (строка)

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

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

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

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

Вывод

applicationId -> (строка)

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

retrieverId -> (строка)

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

retrieverArn -> (строка)

Amazon Resource Name (ARN) роли IAM, связанной с ретривером.

type -> (строка)

Тип ретривера.

status -> (строка)

Статус ретривера.

displayName -> (строка)

Имя ретривера.

configuration -> (структура помеченной объединения)

Предоставляет информацию о конфигурации ретривера, используемого для вашего приложения Amazon Q Business.

Примечание

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

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

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

indexId -> (строка)

Идентификатор индекса Amazon Q Business.

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 -> (строка)

Идентификатор индекса Amazon Kendra.

roleArn -> (строка)

Amazon Resource Name (ARN) роли с разрешениями на доступ к ретриверу и необходимым ресурсам.

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

Временная метка Unix, когда был создан ретривер.

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

Временная метка Unix, когда ретривер был последний раз обновлен.

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

Spec-Zone.ru

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