Spec-Zone.ru › AWS CLI v2

[ aws . bedrock-agent ]

create-prompt-version

Описание

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

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

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

Синтаксис

  create-prompt-version
[--client-token <value>]
[--description <value>]
--prompt-identifier <value>
[--tags <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 игнорирует запрос, но не возвращает ошибку. Для получения дополнительной информации, см. Обеспечение идемпотентности.

--description (строка)

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

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

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

--tags (массив)

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

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--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
  • таблица
  • 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.

Вывод

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

Указывает, что блок 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 -> (строка)

Версия созданного запроса. Версии нумеруются последовательно, начиная с 1.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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