[ aws . bedrock-agent ]
update-agent
Описание
Обновляет конфигурацию агента.
См. также: Документацию AWS API
update-agent использует значения типов документов. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для ввода команд, опций и вложенных параметров, помеченных типом document, необходимо указать JSON. Краткая синтаксическая запись не поддерживает типы документов.
Синтаксис
update-agent
[--agent-collaboration <value>]
--agent-id <value>
--agent-name <value>
--agent-resource-role-arn <value>
[--custom-orchestration <value>]
[--customer-encryption-key-arn <value>]
[--description <value>]
--foundation-model <value>
[--guardrail-configuration <value>]
[--idle-session-ttl-in-seconds <value>]
[--instruction <value>]
[--memory-configuration <value>]
[--orchestration-type <value>]
[--prompt-override-configuration <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-collaboration (строка)
Роль агента в сотрудничестве.
Возможные значения:
SUPERVISORSUPERVISOR_ROUTERDISABLED
--agent-id (строка)
--agent-name (строка)
--agent-resource-role-arn (строка)
--custom-orchestration (структура)
Содержит подробности настроенной пользовательской оркестрации для агента.
executor -> (структура помеченного объединения)
Структура исполнителя, вызывающего действия в пользовательской оркестрации.
Примечание
Это структура помеченного объединения. Может быть задан только один из следующих ключей верхнего уровня:lambda.lambda -> (строка)
Сокращенная запись:
executor={lambda=string}
Формат JSON:
{
"executor": {
"lambda": "string"
}
}
--customer-encryption-key-arn (строка)
--description (строка)
--foundation-model (строка)
Идентификатор модели, которую вы хотите использовать для оркестрации агентом, который вы создаёте.
modelId для предоставления зависит от типа модели или пропускной способности, которую вы используете:
- Если вы используете базовую модель, укажите идентификатор модели или её ARN. Список идентификаторов моделей для баз моделей см. в руководстве пользователя Amazon Bedrock в разделе Amazon Bedrock base model IDs (on-demand throughput).
- Если вы используете профиль вывода, укажите идентификатор профиля вывода или его ARN. Список идентификаторов профилей вывода см. в руководстве пользователя Amazon Bedrock в разделе Supported Regions and models for cross-region inference.
- Если вы используете модель с выделенной пропускной способностью, укажите ARN выделенной пропускной способности. Дополнительную информацию см. в руководстве пользователя Amazon Bedrock в разделе Run inference using a Provisioned Throughput.
- Если вы используете пользовательскую модель, сначала приобретите выделенную пропускную способность для неё. Затем укажите ARN полученной выделенной модели. Дополнительную информацию см. в руководстве пользователя Amazon Bedrock в разделе Use a custom model in Amazon Bedrock.
- Если вы используете импортированную модель, укажите ARN импортированной модели. ARN модели можно получить из успешного вызова CreateModelImportJob или на странице «Импортированные модели» в консоли Amazon Bedrock.
--guardrail-configuration (структура)
Уникальная конфигурация Guardrail, назначенная агенту при обновлении.
guardrailIdentifier -> (строка)
guardrailVersion -> (строка)
Сокращенная запись:
guardrailIdentifier=string,guardrailVersion=string
Формат JSON:
{
"guardrailIdentifier": "string",
"guardrailVersion": "string"
}
--idle-session-ttl-in-seconds (целое число)
Количество секунд, в течение которого Amazon Bedrock хранит информацию о разговоре пользователя с агентом.
Взаимодействие пользователя остается активным в течение указанного времени. Если в течение этого времени не происходит никакого разговора, сессия истекает, и Amazon Bedrock удаляет все предоставленные данные до истечения срока ожидания.
--instruction (строка)
--memory-configuration (структура)
Указывает новую конфигурацию памяти для агента.
enabledMemoryTypes -> (список)
Тип памяти, который хранится.
(строка)
sessionSummaryConfiguration -> (структура)
Содержит конфигурацию для типа памяти SESSION_SUMMARY, включенного для агента.
maxRecentSessions -> (целое число)
storageDays -> (целое число)
Сокращенная запись:
enabledMemoryTypes=string,string,sessionSummaryConfiguration={maxRecentSessions=integer},storageDays=integer
Формат JSON:
{
"enabledMemoryTypes": ["SESSION_SUMMARY", ...],
"sessionSummaryConfiguration": {
"maxRecentSessions": integer
},
"storageDays": integer
}
--orchestration-type (строка)
Указывает тип стратегии оркестрации для агента. По умолчанию он установлен на тип оркестрации DEFAULT.
Возможные значения:
DEFAULTCUSTOM_ORCHESTRATION
--prompt-override-configuration (структура)
Содержит конфигурации для переопределения подсказок в разных частях последовательности агента. Дополнительную информацию см. в разделе Расширенные подсказки.
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 -> (строка)
Формат JSON:
{
"overrideLambda": "string",
"promptConfigurations": [
{
"additionalModelRequestFields": {...},
"basePromptTemplate": "string",
"foundationModel": "string",
"inferenceConfiguration": {
"maximumLength": integer,
"stopSequences": ["string", ...],
"temperature": float,
"topK": integer,
"topP": float
},
"parserMode": "DEFAULT"|"OVERRIDDEN",
"promptCreationMode": "DEFAULT"|"OVERRIDDEN",
"promptState": "ENABLED"|"DISABLED",
"promptType": "PRE_PROCESSING"|"ORCHESTRATION"|"POST_PROCESSING"|"KNOWLEDGE_BASE_RESPONSE_GENERATION"|"MEMORY_SUMMARIZATION"
}
...
]
}
--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 (boolean)
Включить отладку логирования.
--endpoint-url (string)
Переопределить URL команды заданным URL.
--no-verify-ssl (boolean)
По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (boolean)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (string)
Стиль форматирования вывода команд.
- json
- text
- table
- yaml
- yaml-stream
--query (string)
Запрос JMESPath для фильтрации данных ответа.
--profile (string)
Использовать определенный профиль из файла учетных данных.
--region (string)
Использовать определённую область. Переопределяет настройки из конфигурации/переменных окружения.
--version (string)
Отобразить версию этого инструмента.
--color (string)
Включить/выключить вывод цвета.
- on
- off
- auto
--no-sign-request (boolean)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.
--ca-bundle (string)
Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки из конфигурации/переменных окружения.
--cli-read-timeout (int)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаут. Значение по умолчанию — 60 секунд.
--cli-connect-timeout (int)
Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаут. Значение по умолчанию — 60 секунд.
--cli-binary-format (string)
Стиль форматирования для двоичных блоков. По умолчанию используется формат 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 (boolean)
Отключить пагинатор CLI для вывода.
--cli-auto-prompt (boolean)
Автоматически запрашивать параметры ввода CLI.
--no-cli-auto-prompt (boolean)
Отключить автоматическое запросы параметров ввода 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.