Spec-Zone.ru › AWS CLI v2

[ aws . bedrock-agent ]

create-prompt

Описание

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

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

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

Синтаксис

  create-prompt
[--client-token <value>]
[--customer-encryption-key-arn <value>]
[--default-variant <value>]
[--description <value>]
--name <value>
[--tags <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]

Параметры

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, гарантирующий, что запрос API выполняется не более одного раза. Если этот токен соответствует предыдущему запросу, Amazon Bedrock игнорирует запрос, но не возвращает ошибку. Для получения дополнительной информации см. Обеспечение идемпотентности .

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

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

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

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

--description (строка)

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

--name (строка)

Имя запроса.

--tags (массив)

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

ключ -> (строка)

значение -> (строка)

Краткая запись синтаксиса:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--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. Если предоставлено значение null или 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.

Вывод

arn -> (строка)

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

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

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

customerEncryptionKeyArn -> (строка)

Идентификатор ресурса Amazon (ARN) ключа KMS, с помощью которого был зашифрован запрос.

defaultVariant -> (строка)

Имя варианта запроса по умолчанию.

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

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

text -> (строка)

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

role -> (строка)

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

system -> (список)

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

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

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

Примечание

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

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

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

type -> (строка)

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

text -> (строка)

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

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

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

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

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

Примечание

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

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

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

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

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

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

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

name -> (строка)

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

tools -> (список)

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

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

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

Примечание

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

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

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

type -> (строка)

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

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

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

description -> (строка)

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

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

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

Примечание

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

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

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

name -> (строка)

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

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

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

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

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

type -> (строка)

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

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