Spec-Zone.ru › AWS CLI v2

[ aws . bedrock-agent ]

get-agent-version

Описание

Получает данные о версии агента.

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

get-agent-version использует значения типа документа. Типы документов следуют модели данных JSON, где допустимыми значениями являются: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо указать JSON. Сокращённый синтаксис не поддерживает типы документов.

Синтаксис

  get-agent-version
--agent-id <value>
--agent-version <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]

Опции

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

Уникальный идентификатор агента.

--agent-version (строка)

Версия агента.

--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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

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

--color (строка)

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

  • on
  • off
  • auto

--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-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

Содержит сведения о версии агента.

agentArn -> (строка)

Идентификатор ресурса Amazon (ARN) агента, к которому относится версия.

agentCollaboration -> (строка)

Настройки сотрудничества агента.

agentId -> (строка)

Уникальный идентификатор агента, к которому относится версия.

agentName -> (строка)

Имя агента, к которому относится версия.

agentResourceRoleArn -> (строка)

Идентификатор ресурса Amazon (ARN) роли IAM с разрешениями для вызова операций API для агента.

agentStatus -> (строка)

Состояние агента, к которому относится версия.

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

Время создания версии.

customerEncryptionKeyArn -> (строка)

Идентификатор ресурса Amazon (ARN) ключа KMS, который шифрует агента.

description -> (строка)

Описание версии.

failureReasons -> (список)

Список причин, по которым операция API над версией завершилась неудачей.

(строка)

foundationModel -> (строка)

Фундаментальная модель, используемая версией.

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

Сведения о защите, связанной с агентом.

guardrailIdentifier -> (строка)

Уникальный идентификатор защиты.

guardrailVersion -> (строка)

Версия защиты.

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

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

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

instruction -> (строка)

Инструкции, предоставленные агенту.

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

Содержит сведения о конфигурации памяти для версии агента.

enabledMemoryTypes -> (список)

Тип хранимой памяти.

(строка)

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

Содержит конфигурацию типа памяти SESSION_SUMMARY, включенного для агента.

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

Максимальное количество последних сводок сессий для включения в контекст запроса агента.

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

Количество дней, в течение которых агент настроен на сохранение контекста разговора.

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

Содержит конфигурации для переопределения шаблонов запросов в разных частях последовательности агента. Дополнительная информация: Расширенные запросы .

overrideLambda -> (строка)

ARN функции Lambda, используемой при обработке необработанного выходного значения фундаментальной модели в частях последовательности агента. Если вы указали этот параметр, хотя бы один из promptConfigurations должен содержать значение parserMode, которое установлено в OVERRIDDEN . Дополнительная информация: Функция парсера Lambda в агентах Amazon Bedrock .

promptConfigurations -> (список)

Содержит конфигурации для переопределения шаблона запроса в одной части последовательности агента. Дополнительная информация: Расширенные запросы .

(структура)

Содержит конфигурации для переопределения шаблона запроса в одной части последовательности агента. Дополнительная информация: Расширенные запросы .

additionalModelRequestFields -> (документ)

Если операции Converse или ConverseStream поддерживают модель, additionalModelRequestFields содержит дополнительные параметры вывода, помимо базового набора параметров вывода в поле inferenceConfiguration.

Дополнительная информация: Параметры запроса и поля ответа для вывода моделей в руководстве пользователя Amazon Bedrock.

basePromptTemplate -> (строка)

Определяет шаблон запроса, которым следует заменить стандартный шаблон запроса. Вы можете использовать плейсхолдеры в базовом шаблоне запроса для настройки запроса. Дополнительная информация: Плейсхолдеры шаблонов запроса . Дополнительная информация: Настройка шаблонов запросов .

foundationModel -> (строка)

Фундаментальная модель агента.

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

Содержит параметры вывода, которые нужно использовать при вызове агентом фундаментальной модели в части последовательности агента, определенной параметром promptType . Дополнительная информация: Параметры вывода для моделей.

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

Максимальное количество токенов, разрешенное в генерируемом ответе.

stopSequences -> (список)

Список последовательностей останова. Последовательность останова — это последовательность символов, которая заставляет модель прекратить генерацию ответа.

(строка)

temperature -> (вещественное число)

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

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

При генерации ответа модель определяет вероятность следующего токена на каждой стадии генерации. Значение, заданное для topK, представляет собой количество наиболее вероятных кандидатов, из которых модель выбирает следующий токен в последовательности. Например, если вы зададите topK значение 50, модель выберет следующий токен из 50 наиболее вероятных вариантов.

topP -> (вещественное число)

При генерации ответа модель определяет вероятность следующего токена на каждой стадии генерации. Значение, заданное для Top P, определяет количество наиболее вероятных кандидатов, из которых модель выбирает следующий токен в последовательности. Например, если вы зададите topP значение 0,8, модель выберет следующий токен только из 80% наиболее вероятных вариантов распределения вероятностей следующих токенов.

parserMode -> (строка)

Указывает, нужно ли переопределять стандартную функцию парсера Lambda при обработке необработанного выходного значения фундаментальной модели в части последовательности агента, определенной параметром promptType . Если вы зададите значение как OVERRIDDEN , поле overrideLambda в PromptOverrideConfiguration должно содержать ARN функции Lambda.

promptCreationMode -> (строка)

Указывает, нужно ли переопределять стандартный шаблон запроса для этого promptType . Установите это значение в OVERRIDDEN, чтобы использовать запрос, который вы предоставили в поле basePromptTemplate. Если вы оставите значение как DEFAULT, агент будет использовать стандартный шаблон запроса.

promptState -> (строка)

Указывает, разрешено ли агенту выполнить шаг, указанный в поле promptType . Если вы зададите это значение в DISABLED, агент пропустит этот шаг. Стандартное состояние для каждого promptType выглядит следующим образом.

  • PRE_PROCESSING – ENABLED
  • ORCHESTRATION – ENABLED
  • KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED
  • POST_PROCESSING – DISABLED

promptType -> (строка)

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

recommendedActions -> (список)

Список рекомендуемых действий для успешного выполнения операции API над версией.

(строка)

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

Время последнего обновления версии.

version -> (строка)

Номер версии.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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