Spec-Zone.ru › AWS CLI v2

[ aws . bedrock-agent ]

update-prompt

Описание

Изменяет запрос в вашей библиотеке запросов. Включайте в себя как поля, которые вы хотите сохранить, так и поля, которые хотите заменить. Дополнительную информацию можно найти в разделе Управление запросами в Amazon Bedrock и Редактирование запросов в вашей библиотеке запросов в Руководстве пользователя Amazon Bedrock.

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

update-prompt использует значения типа документа. Типы документов следуют модели данных JSON, где допустимые значения — строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая синтаксическая запись не поддерживает типы документов.

Синтаксис

  update-prompt
[--customer-encryption-key-arn <value>]
[--default-variant <value>]
[--description <value>]
--name <value>
--prompt-identifier <value>
[--variants <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]

Параметры

--customer-encryption-key-arn (строка)

Идентификатор ресурса Amazon (ARN) ключа KMS для шифрования запроса.

--default-variant (строка)

Название варианта по умолчанию для запроса. Это значение должно совпадать с полем name в соответствующем объекте PromptVariant.

--description (строка)

Описание запроса.

--name (строка)

Имя запроса.

--prompt-identifier (строка)

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

--variants (список)

Список объектов, каждый из которых содержит подробности о варианте запроса.

(структура)

Содержит подробности о варианте запроса.

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

Содержит параметры вывода, специфичные для модели, которые отсутствуют в поле inferenceConfiguration. Чтобы увидеть параметры вывода, специфичные для модели, см. Параметры запроса вывода и поля ответа для моделей общего назначения.

genAiResource -> (структура помеченного союза)

Определяет ресурс генеративного ИИ, с которым следует использовать запрос.

Примечание

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

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

Определяет агент Amazon Bedrock, с которым следует использовать запрос.

agentIdentifier -> (строка)

ARN агента, с которым следует использовать запрос.

inferenceConfiguration -> (структура помеченного союза)

Содержит параметры вывода для варианта запроса.

Примечание

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

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

Содержит параметры вывода для текстового запроса.

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

Максимальное количество токенов, возвращаемых в ответе.

stopSequences -> (список)

Список строк, определяющих последовательности, после которых модель прекратит генерацию.

(строка)

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

Управляет случайностью ответа. Выберите меньшее значение для более предсказуемых результатов и большее значение для более неожиданных результатов.

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

Процент наиболее вероятных кандидатов, которые модель рассматривает для следующего токена.

metadata -> (список)

Массив объектов, каждый из которых содержит пару ключ-значение, определяющую тег метаданных и значение для присоединения к варианту запроса.

(структура)

Содержит пару ключ-значение, определяющую тег метаданных и значение для присоединения к варианту запроса. Дополнительную информацию см. в разделе Создание запроса с помощью управления запросами.

key -> (строка)

Ключ тега метаданных для варианта запроса.

value -> (строка)

Значение тега метаданных для варианта запроса.

modelId -> (строка)

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

name -> (строка)

Название варианта запроса.

templateConfiguration -> (структура помеченного союза)

Содержит настройки для шаблона запроса.

Примечание

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

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

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

inputVariables -> (список)

Массив переменных в шаблоне запроса.

(структура)

Содержит информацию о переменной в запросе.

name -> (строка)

Имя переменной.

messages -> (список)

Содержит сообщения в чате для запроса.

(структура)

Входное сообщение или ответ модели. Дополнительную информацию см. в разделе Создание запроса с помощью управления запросами.

content -> (список)

Содержание сообщения.

(структура помеченного союза)

Содержит содержимое сообщения, которое вы передаете модели или получаете от нее. Дополнительную информацию см. в разделе Создание запроса с помощью управления запросами.

Примечание

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

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

Создает контрольную точку кэша внутри сообщения.

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

text -> (строка)

Текст в сообщении.

role -> (строка)

Роль, к которой относится сообщение.

system -> (список)

Содержит системные запросы, чтобы предоставить контекст модели или описать, как она должна себя вести.

(структура помеченного союза)

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

Примечание

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

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

Создает контрольную точку кэша внутри обозначения инструмента.

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

text -> (строка)

Текст в системном запросе.

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

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

toolChoice -> (структура помеченного союза)

Определяет инструменты, которые модель должна запросить при вызове.

Примечание

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

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

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

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

Определяет инструменты. Модель автоматически определяет, следует ли вызывать инструмент или сгенерировать текст вместо этого.

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

Определяет конкретный инструмент, который модель должна запросить. Текст не генерируется, но результаты использования инструментов отправляются обратно модели, чтобы помочь в генерации ответа.

name -> (строка)

Имя инструмента.

tools -> (список)

Массив инструментов для передачи модели.

(структура помеченного союза)

Содержит настройки для инструмента, который модель может использовать при генерации ответа. Дополнительную информацию см. в разделе Использование инструмента для завершения ответа модели Amazon Bedrock.

Примечание

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

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

Создает контрольную точку кэша внутри обозначения инструмента

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

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

Спецификация инструмента.

description -> (строка)

Описание инструмента.

inputSchema -> (структура помеченного союза)

Схема входных данных для инструмента.

Примечание

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

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

Объект JSON, определяющий схему входных данных для инструмента.

name -> (строка)

Имя инструмента.

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

Содержит настройки для текста в сообщении для запроса.

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

Контрольная точка кэша в конфигурации шаблона.

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

inputVariables -> (список)

Массив переменных в шаблоне запроса.

(структура)

Содержит информацию о переменной в запросе.

name -> (строка)

Имя переменной.

text -> (строка)

Сообщение для запроса.

templateType -> (строка)

Тип шаблона запроса для использования.

Синтаксис JSON:

[
  {
    "additionalModelRequestFields": {...},
    "genAiResource": {
      "agent": {
        "agentIdentifier": "string"
      }
    },
    "inferenceConfiguration": {
      "text": {
        "maxTokens": integer,
        "stopSequences": ["string", ...],
        "temperature": float,
        "topP": float
      }
    },
    "metadata": [
      {
        "key": "string",
        "value": "string"
      }
      ...
    ],
    "modelId": "string",
    "name": "string",
    "templateConfiguration": {
      "chat": {
        "inputVariables": [
          {
            "name": "string"
          }
          ...
        ],
        "messages": [
          {
            "content": [
              {
                "cachePoint": {
                  "type": "default"
                },
                "text": "string"
              }
              ...
            ],
            "role": "user"|"assistant"
          }
          ...
        ],
        "system": [
          {
            "cachePoint": {
              "type": "default"
            },
            "text": "string"
          }
          ...
        ],
        "toolConfiguration": {
          "toolChoice": {
            "any": {

            },
            "auto": {

            },
            "tool": {
              "name": "string"
            }
          },
          "tools": [
            {
              "cachePoint": {
                "type": "default"
              },
              "toolSpec": {
                "description": "string",
                "inputSchema": {
                  "json": {...}
                },
                "name": "string"
              }
            }
            ...
          ]
        }
      },
      "text": {
        "cachePoint": {
          "type": "default"
        },
        "inputVariables": [
          {
            "name": "string"
          }
          ...
        ],
        "text": "string"
      }
    },
    "templateType": "TEXT"|"CHAT"
  }
  ...
]

--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 V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое соответствует двоичному блоку fileb:// всегда будет обрабатываться как двоичный и будет использовать содержимое файла напрямую независимо от настройки cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для заданного cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Отключить паджинг (постраничный вывод) для вывода.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

arn -> (строка)

Идентификатор ресурса Amazon (ARN) подсказки.

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

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

customerEncryptionKeyArn -> (строка)

Идентификатор ресурса Amazon (ARN) ключа KMS для шифрования подсказки.

defaultVariant -> (строка)

Имя варианта по умолчанию для подсказки. Это значение должно соответствовать полю name в соответствующем объекте PromptVariant.

description -> (строка)

Описание подсказки.

id -> (строка)

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

name -> (строка)

Имя подсказки.

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

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

variants -> (список)

Список объектов, каждый из которых содержит подробную информацию о варианте подсказки.

(структура)

Содержит подробную информацию о варианте подсказки.

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

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

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

Указывает ресурс генеративного ИИ, с которым следует использовать подсказку.

Примечание

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

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

Указывает агента Amazon Bedrock, с которым следует использовать подсказку.

agentIdentifier -> (строка)

ARN агента, с которым следует использовать подсказку.

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

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

Примечание

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

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

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

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

Максимальное количество токенов, возвращаемых в ответе.

stopSequences -> (список)

Список строк, определяющих последовательности, после которых модель прекратит генерирование.

(строка)

temperature -> (число с плавающей запятой)

Управляет случайностью ответа. Для более предсказуемых результатов выберите меньшее значение, для более неожиданных результатов — большее.

topP -> (число с плавающей запятой)

Процент наиболее вероятных кандидатов, которые модель рассматривает для следующего токена.

metadata -> (список)

Массив объектов, каждый из которых содержит пару «ключ-значение», определяющую тег метаданных и значение, прикрепляемые к варианту подсказки.

(структура)

Содержит пару «ключ-значение», определяющую тег метаданных и значение, прикрепляемые к варианту подсказки. Дополнительную информацию см. в разделе Создание подсказки с помощью управления подсказками .

key -> (строка)

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

value -> (строка)

Значение тега метаданных для варианта подсказки.

modelId -> (строка)

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

name -> (строка)

Имя варианта подсказки.

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

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

Примечание

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

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

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

inputVariables -> (список)

Массив переменных в шаблоне подсказки.

(структура)

Содержит информацию о переменной в подсказке.

name -> (строка)

Имя переменной.

messages -> (список)

Содержит сообщения в чате для подсказки.

(структура)

Входное или ответное сообщение от модели. Дополнительную информацию см. в разделе Создание подсказки с помощью управления подсказками .

content -> (список)

Содержимое сообщения.

(структура помеченного объединения)

Содержит содержимое сообщения, которое вы передаете модели или получаете от нее. Дополнительную информацию см. в разделе Создание подсказки с помощью управления подсказками .

Примечание

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

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

Создает контрольную точку кэша внутри сообщения.

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

text -> (строка)

Текст сообщения.

role -> (строка)

Роль, к которой относится сообщение.

system -> (список)

Содержит системные подсказки для предоставления контекста модели или описания ее поведения.

(структура помеченного объединения)

Содержит системную подсказку для предоставления контекста модели или описания ее поведения. Дополнительную информацию см. в разделе Создание подсказки с помощью управления подсказками .

Примечание

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

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

Создает контрольную точку кэша внутри обозначения инструмента

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

text -> (строка)

Текст системной подсказки.

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

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

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

Определяет, какие инструменты должна запросить модель при вызове.

Примечание

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

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

Определяет инструменты, по крайней мере один из которых должен быть запрошен моделью. Текст не генерируется, но результаты использования инструментов отправляются обратно модели для помощи в генерировании ответа.

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

Определяет инструменты. Модель автоматически определяет, следует ли вызывать инструмент или генерировать текст вместо этого.

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

Определяет конкретный инструмент, который должна запросить модель. Текст не генерируется, но результаты использования инструментов отправляются обратно модели для помощи в генерировании ответа.

name -> (строка)

Имя инструмента.

tools -> (список)

Массив инструментов, передаваемых модели.

(структура помеченного объединения)

Содержит конфигурации для инструмента, который модель может использовать при генерировании ответа. Дополнительную информацию см. в разделе Использование инструмента для завершения ответа модели Amazon Bedrock .

Примечание

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

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

Создает контрольную точку кэша внутри обозначения инструмента

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

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

Спецификация инструмента.

description -> (строка)

Описание инструмента.

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

Схема ввода для инструмента.

Примечание

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

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

JSON-объект, определяющий схему ввода для инструмента.

name -> (строка)

Имя инструмента.

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

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

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

Контрольная точка кэша внутри конфигурации шаблона.

type -> (строка)

Указывает, что CachePointBlock имеет тип по умолчанию

inputVariables -> (список)

Массив переменных в шаблоне подсказки.

(структура)

Содержит информацию о переменной в подсказке.

name -> (строка)

Имя переменной.

text -> (строка)

Сообщение для подсказки.

templateType -> (строка)

Тип шаблона подсказки для использования.

version -> (строка)

Версия подсказки. При обновлении подсказки обновляется версия DRAFT.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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