[ aws . bedrock-agent ]
get-prompt
Описание
Извлекает информацию о черновике (DRAFT версия) приглашения или его версии, в зависимости от того, включено ли поле promptVersion или нет. Дополнительную информацию см. в руководстве пользователя Amazon Bedrock, раздел «Просмотр информации о приглашениях с помощью управления приглашениями» и «Просмотр информации о версии вашего приглашения».
См. также: Документацию API AWS
get-prompt использует значения типов документов. Типы документов следуют модели данных JSON, где допустимые значения: строки, числа, булевы значения, null, массивы и объекты. Для входных данных команд, опций и вложенных параметров, помеченных типом document, необходимо предоставить JSON. Краткая синтаксическая запись не поддерживает типы документов.
Синтаксис
get-prompt
--prompt-identifier <value>
[--prompt-version <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]
Параметры
--prompt-identifier (строка)
--prompt-version (строка)
--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
- table
- yaml
- yaml-stream
--query (строка)
Запрос JMESPath для фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Регион для использования. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/отключить цветной вывод.
- on
- off
- auto
--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 -> (строка)
createdAt -> (метка времени)
customerEncryptionKeyArn -> (строка)
defaultVariant -> (строка)
name в соответствующем объекте PromptVariant.description -> (строка)
id -> (строка)
name -> (строка)
updatedAt -> (метка времени)
variants -> (список)
Список объектов, каждый из которых содержит подробности о варианте запроса.
(структура)
Содержит подробности о варианте запроса.
additionalModelRequestFields -> (документ)
inferenceConfiguration. Для просмотра параметров вывода, специфичных для модели, см. Параметры запроса и поля ответа для моделей. genAiResource -> (структура помеченного объединения)
Указывает ресурс генеративного ИИ, с которым следует использовать запрос.
Примечание
Это структура помеченного объединения. Только одно из следующих верхнеуровневых ключей может быть установлено:agent.agent -> (структура)
Указывает агент Amazon Bedrock, с которым следует использовать запрос.
agentIdentifier -> (строка)
inferenceConfiguration -> (структура помеченного объединения)
Содержит настройки вывода для варианта запроса.
Примечание
Это структура помеченного объединения. Только одно из следующих верхнеуровневых ключей может быть установлено:text.text -> (структура)
Содержит настройки вывода для текстового запроса.
maxTokens -> (целое число)
stopSequences -> (список)
Список строк, определяющих последовательности, после которых модель прекратит генерацию.
(строка)
temperature -> (вещественное число)
topP -> (вещественное число)
metadata -> (список)
Массив объектов, каждый из которых содержит пару ключ-значение, определяющую метку метаданных и значение для прикрепления к варианту запроса.
(структура)
Содержит пару ключ-значение, определяющую метку метаданных и значение для прикрепления к варианту запроса. Дополнительная информация представлена в разделе Создание запроса с помощью управления запросами.
key -> (строка)
value -> (строка)
modelId -> (строка)
name -> (строка)
templateConfiguration -> (структура помеченного объединения)
Содержит настройки для шаблона запроса.
Примечание
Это структура помеченного объединения. Только одно из следующих верхнеуровневых ключей может быть установлено:chat, text.chat -> (структура)
Содержит настройки для использования запроса в формате диалога.
inputVariables -> (список)
Массив переменных в шаблоне запроса.
(структура)
Содержит информацию о переменной в запросе.
name -> (строка)
messages -> (список)
Содержит сообщения в диалоге для запроса.
(структура)
Ввод или ответ сообщения от модели. Дополнительная информация представлена в разделе Создание запроса с помощью управления запросами.
content -> (список)
Содержание сообщения.
(структура помеченного объединения)
Содержит содержимое сообщения, которое вы передаете модели или получаете от модели. Дополнительная информация представлена в разделе Создание запроса с помощью управления запросами.
Примечание
Это структура помеченного объединения. Только одно из следующих верхнеуровневых ключей может быть установлено:cachePoint, text.cachePoint -> (структура)
Создает контрольную точку кеша внутри сообщения.
type -> (строка)
text -> (строка)
role -> (строка)
system -> (список)
Содержит системные запросы, предоставляющие контекст для модели или описывающие, как она должна вести себя.
(структура помеченного объединения)
Содержит системный запрос, предоставляющий контекст для модели или описывающий, как она должна себя вести. Дополнительная информация представлена в разделе Создание запроса с помощью управления запросами.
Примечание
Это структура помеченного объединения. Только одно из следующих верхнеуровневых ключей может быть установлено:cachePoint, text.cachePoint -> (структура)
Создает контрольную точку кеша внутри назначения инструмента
type -> (строка)
text -> (строка)
toolConfiguration -> (структура)
Информация о настройках инструментов, которые модель может использовать при генерации ответа.
toolChoice -> (структура помеченного объединения)
Определяет инструменты, которые должна запросить модель при вызове.
Примечание
Это структура помеченного объединения. Только одно из следующих верхнеуровневых ключей может быть установлено:any, auto, tool.any -> (структура)
auto -> (структура)
tool -> (структура)
Определяет конкретный инструмент, который модель должна запросить. Текст не генерируется, но результаты использования инструмента передаются модели для помощи в генерации ответа.
name -> (строка)
tools -> (список)
Массив инструментов для передачи модели.
(структура помеченного объединения)
Содержит настройки для инструмента, который модель может использовать при генерации ответа. Дополнительная информация представлена в разделе Использование инструмента для завершения ответа модели Amazon Bedrock.
Примечание
Это структура помеченного объединения. Только одно из следующих верхнеуровневых ключей может быть установлено:cachePoint, toolSpec.cachePoint -> (структура)
Создает контрольную точку кеша внутри назначения инструмента
type -> (строка)
toolSpec -> (структура)
Спецификация для инструмента.
description -> (строка)
inputSchema -> (структура помеченного объединения)
Схема ввода для инструмента.
Примечание
Это структура помеченного объединения. Только одно из следующих верхнеуровневых ключей может быть установлено:json.json -> (документ)
name -> (строка)
text -> (структура)
Содержит настройки для текста в сообщении для запроса.
cachePoint -> (структура)
Контрольная точка кеша в настройках шаблона.
type -> (строка)
inputVariables -> (список)
Массив переменных в шаблоне запроса.
(структура)
Содержит информацию о переменной в запросе.
name -> (строка)
text -> (строка)
templateType -> (строка)
version -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.