Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

создать-ai-prompt

Описание

Создаёт Amazon Q в Connect AI Prompt.

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

Синтаксис

  create-ai-prompt
[--client-token <value>]
--assistant-id <value>
--name <value>
--type <value>
--template-configuration <value>
--visibility-status <value>
--template-type <value>
--model-id <value>
--api-format <value>
[--tags <value>]
[--description <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 (строка)

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

--assistant-id (строка)

Идентификатор помощника Amazon Q в Connect. Может быть либо ID, либо ARN. URL-адреса не могут содержать ARN.

--name (строка)

Имя AI Prompt.

--type (строка)

Тип этого AI Prompt.

Возможные значения:

  • ANSWER_GENERATION
  • INTENT_LABELING_GENERATION
  • QUERY_REFORMULATION
  • SELF_SERVICE_PRE_PROCESSING
  • SELF_SERVICE_ANSWER_GENERATION

--template-configuration (структура помеченных объединений)

Настройка шаблона запроса для этого AI Prompt.

Примечание

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

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

Настройка шаблона запроса, поддерживающая полную настройку текстового запроса с использованием YAML-запроса.

text -> (строка)

YAML-текст шаблона AI Prompt.

Упрощённый синтаксис:

textFullAIPromptEditTemplateConfiguration={text=string}

Синтаксис JSON:

{
  "textFullAIPromptEditTemplateConfiguration": {
    "text": "string"
  }
}

--visibility-status (строка)

Статус видимости AI Prompt.

Возможные значения:

  • SAVED
  • PUBLISHED

--template-type (строка)

Тип шаблона запроса для этого AI Prompt.

Возможные значения:

  • TEXT

--model-id (строка)

Идентификатор модели, используемой для этого AI Prompt.

--api-format (строка)

Формат API AI Prompt.

Рекомендуемые значения: MESSAGES | TEXT_COMPLETIONS

Примечание

Значения ANTHROPIC_CLAUDE_MESSAGES | ANTHROPIC_CLAUDE_TEXT_COMPLETIONS будут устаревшими.

Возможные значения:

  • ANTHROPIC_CLAUDE_MESSAGES
  • ANTHROPIC_CLAUDE_TEXT_COMPLETIONS
  • MESSAGES
  • TEXT_COMPLETIONS

--tags (отображение)

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

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

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

Упрощённый синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--description (строка)

Описание AI Prompt.

--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 (булево)

Отключить вывод AWS CLI.

--cli-auto-prompt (булево)

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

--no-cli-auto-prompt (булево)

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

Вывод

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

Данные AI Prompt.

assistantId -> (строка)

Идентификатор помощника Amazon Q в Connect. Может быть либо ID, либо ARN. URL-адреса не могут содержать ARN.

assistantArn -> (строка)

Amazon Resource Name (ARN) помощника Amazon Q в Connect.

aiPromptId -> (строка)

Идентификатор Amazon Q в Connect AI prompt.

aiPromptArn -> (строка)

Amazon Resource Name (ARN) AI Prompt.

name -> (строка)

Имя AI Prompt

type -> (строка)

Тип этого AI Prompt.

templateType -> (строка)

Тип шаблона запроса для этого AI Prompt.

modelId -> (строка)

Идентификатор модели, используемой для этого AI Prompt. Поддерживаются следующие идентификаторы моделей:

  • anthropic.claude-3-haiku--v1:0
  • apac.amazon.nova-lite-v1:0
  • apac.amazon.nova-micro-v1:0
  • apac.amazon.nova-pro-v1:0
  • apac.anthropic.claude-3-5-sonnet--v2:0
  • apac.anthropic.claude-3-haiku-20240307-v1:0
  • eu.amazon.nova-lite-v1:0
  • eu.amazon.nova-micro-v1:0
  • eu.amazon.nova-pro-v1:0
  • eu.anthropic.claude-3-7-sonnet-20250219-v1:0
  • eu.anthropic.claude-3-haiku-20240307-v1:0
  • us.amazon.nova-lite-v1:0
  • us.amazon.nova-micro-v1:0
  • us.amazon.nova-pro-v1:0
  • us.anthropic.claude-3-5-haiku-20241022-v1:0
  • us.anthropic.claude-3-7-sonnet-20250219-v1:0
  • us.anthropic.claude-3-haiku-20240307-v1:0

apiFormat -> (строка)

Формат API, используемый для этого AI Prompt.

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

Настройка шаблона запроса для этого AI Prompt.

Примечание

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

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

Настройка шаблона запроса, поддерживающая полную настройку текстового запроса с использованием YAML-запроса.

text -> (строка)

YAML-текст шаблона AI Prompt.

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

Время последнего изменения AI Prompt.

description -> (строка)

Описание AI Prompt.

visibilityStatus -> (строка)

Статус видимости AI Prompt.

tags -> (отображение)

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

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

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

origin -> (строка)

Происхождение AI Prompt. SYSTEM для AI Prompt по умолчанию, созданного Q в Connect, или CUSTOMER для AI Prompt, созданного путём вызова API создания AI Prompt.

status -> (строка)

Статус AI Prompt.

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

Spec-Zone.ru

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