get-ai-prompt
Описание
Получает и отображает подсказку Amazon Q в Connect AI.
См. также: Документация API AWS
Синтаксис
get-ai-prompt
--assistant-id <value>
--ai-prompt-id <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]
Параметры
--assistant-id (строка)
--ai-prompt-id (строка)
--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
- текст
- таблица
- 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.
Вывод
aiPrompt -> (структура)
Данные подсказки AI.
assistantId -> (строка)
assistantArn -> (строка)
aiPromptId -> (строка)
aiPromptArn -> (строка)
name -> (строка)
type -> (строка)
templateType -> (строка)
modelId -> (строка)
Идентификатор модели, используемой для этой подсказки AI. Поддерживаются следующие идентификаторы моделей:
anthropic.claude-3-haiku--v1:0apac.amazon.nova-lite-v1:0apac.amazon.nova-micro-v1:0apac.amazon.nova-pro-v1:0apac.anthropic.claude-3-5-sonnet--v2:0apac.anthropic.claude-3-haiku-20240307-v1:0eu.amazon.nova-lite-v1:0eu.amazon.nova-micro-v1:0eu.amazon.nova-pro-v1:0eu.anthropic.claude-3-7-sonnet-20250219-v1:0eu.anthropic.claude-3-haiku-20240307-v1:0us.amazon.nova-lite-v1:0us.amazon.nova-micro-v1:0us.amazon.nova-pro-v1:0us.anthropic.claude-3-5-haiku-20241022-v1:0us.anthropic.claude-3-7-sonnet-20250219-v1:0us.anthropic.claude-3-haiku-20240307-v1:0
apiFormat -> (строка)
templateConfiguration -> (структура помеченного союза)
Настройка шаблона подсказки для этой подсказки AI.
Примечание
Это структура помеченного союза. Только один из следующих верхних ключей может быть установлен:textFullAIPromptEditTemplateConfiguration.textFullAIPromptEditTemplateConfiguration -> (структура)
Настройка шаблона подсказки, поддерживающего полную настройку текстовой подсказки с помощью YAML-подсказки.
text -> (строка)
modifiedTime -> (метка времени)
description -> (строка)
visibilityStatus -> (строка)
tags -> (карта)
Теги, используемые для организации, отслеживания или управления доступом к этому ресурсу.
key -> (строка)
value -> (строка)
origin -> (строка)
SYSTEM для подсказки AI по умолчанию, созданной в Q in Connect, или CUSTOMER для подсказки AI, созданной с помощью API создания подсказок AI.status -> (строка)
versionNumber -> (целое число)
aiPromptId в запросе).
© Copyright 2025, Amazon Web Services. Created using Sphinx.
|
|