Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

обновить-ai-запрос

Описание

Обновляет запрос к ИИ.

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

Синтаксис

  update-ai-prompt
[--client-token <value>]
--assistant-id <value>
--ai-prompt-id <value>
--visibility-status <value>
[--template-configuration <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. Ссылок не должно содержать ARN.

--ai-prompt-id (строка)

Идентификатор запроса Amazon Q в Connect ИИ.

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

Статус видимости запроса Amazon Q в Connect ИИ.

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

  • SAVED
  • PUBLISHED

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

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

Примечание

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

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

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

text -> (строка)

Текст YAML для шаблона запроса к ИИ.

Сокращенный синтаксис:

textFullAIPromptEditTemplateConfiguration={text=string}

Синтаксис JSON:

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

--description (строка)

Описание запроса к ИИ Amazon Q в Connect.

--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-auto-prompt (логическое значение)

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

--no-cli-auto-prompt (логическое значение)

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

Вывод

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

Данные обновлённого запроса Amazon Q в Connect ИИ.

assistantId -> (строка)

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

assistantArn -> (строка)

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

aiPromptId -> (строка)

Идентификатор запроса Amazon Q в Connect ИИ.

aiPromptArn -> (строка)

Amazon Resource Name (ARN) запроса ИИ.

name -> (строка)

Имя запроса ИИ.

type -> (строка)

Тип этого запроса ИИ.

templateType -> (строка)

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

modelId -> (строка)

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

  • 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, используемый для этого запроса ИИ.

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

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

Примечание

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

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

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

text -> (строка)

Текст YAML для шаблона запроса ИИ.

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

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

description -> (строка)

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

visibilityStatus -> (строка)

Статус видимости запроса ИИ.

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

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

key -> (строка)

value -> (строка)

origin -> (строка)

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

status -> (строка)

Статус запроса ИИ.

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

Spec-Zone.ru

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