[ aws . bedrock-agent ]
get-agent
Описание
Получает информацию об агенте.
См. также: Документацию API AWS
get-agent использует типы документов. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая синтаксическая запись не поддерживает типы документов.
Синтаксис
get-agent
--agent-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]
Параметры
--agent-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.
Вывод
agent -> (структура)
Содержит сведения об агенте.
agentArn -> (строка)
agentCollaboration -> (строка)
agentId -> (строка)
agentName -> (строка)
agentResourceRoleArn -> (строка)
agentStatus -> (строка)
Статус агента и готовность к использованию. Возможные статусы:
- CREATING – Агент создается.
- PREPARING – Агент подготавливается.
- PREPARED – Агент подготовлен и готов к вызову.
- NOT_PREPARED – Агент создан, но не подготовлен.
- FAILED – Операция API агента завершилась ошибкой.
- UPDATING – Агент обновляется.
- DELETING – Агент удаляется.
agentVersion -> (строка)
clientToken -> (строка)
createdAt -> (метка времени)
customOrchestration -> (структура)
Содержит настройки пользовательской оркестрации для агента.
executor -> (структура помеченного объединения)
Структура исполнителя, вызывающего действия в пользовательской оркестрации.
Примечание
Это структура помеченного объединения. Только один из следующих ключей верхнего уровня может быть установлен:lambda.lambda -> (строка)
customerEncryptionKeyArn -> (строка)
description -> (строка)
failureReasons -> (список)
Содержит причины, по которым вызываемая операция API, связанная с агентом, завершилась ошибкой.
(строка)
foundationModel -> (строка)
guardrailConfiguration -> (структура)
Сведения о защитных ограждениях, связанных с агентом.
guardrailIdentifier -> (строка)
guardrailVersion -> (строка)
idleSessionTTLInSeconds -> (целое число)
Количество секунд, в течение которого Amazon Bedrock сохраняет информацию о разговоре пользователя с агентом.
Взаимодействие пользователя остается активным в течение указанного периода времени. Если в течение этого времени не происходит никакого разговора, сессия истекает, и Amazon Bedrock удаляет все предоставленные данные до истечения срока ожидания.
instruction -> (строка)
memoryConfiguration -> (структура)
Содержит конфигурацию памяти для агента.
enabledMemoryTypes -> (список)
Тип хранимой памяти.
(строка)
sessionSummaryConfiguration -> (структура)
Содержит конфигурацию типа памяти SESSION_SUMMARY, включенного для агента.
maxRecentSessions -> (целое число)
storageDays -> (целое число)
orchestrationType -> (строка)
preparedAt -> (метка времени)
promptOverrideConfiguration -> (структура)
Содержит конфигурации для переопределения шаблонов запросов в разных частях последовательности агента. Дополнительную информацию см. в разделе Дополнительные запросы.
overrideLambda -> (строка)
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 -> (строка)
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 -> (метка времени)
© Copyright 2025, Amazon Web Services. Created using Sphinx.