Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

list-ai-agent-versions

Описание

Список версий AI Agent.

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

list-ai-agent-versions — это постраничная операция. Для получения всего набора результатов могут быть выпущены несколько вызовов API. Вы можете отключить постраничный вывод, указав аргумент --no-paginate. При использовании --output text и аргумента --query в ответе с постраничным выводом, аргумент --query должен извлекать данные из результатов следующих выражений запроса: aiAgentVersionSummaries

Синтаксис

  list-ai-agent-versions
--assistant-id <value>
--ai-agent-id <value>
[--origin <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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 (строка)

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

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

Идентификатор Amazon Q in Connect AI Agent, для которого необходимо получить список версий.

--origin (строка)

Источник версий AI Agent, которые нужно вывести. SYSTEM для AI Agent по умолчанию, созданного Q in Connect, или CUSTOMER для AI Agent, созданного с помощью API создания AI Agent.

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

  • SYSTEM
  • CUSTOMER

--cli-input-json | --cli-input-yaml (строка) Чтение аргументов из предоставленной JSON-строки. JSON-строка следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставлены в командной строке, эти значения переопределяют значения, предоставленные в JSON. Невозможно передавать произвольные двоичные данные с помощью значения, предоставленного в JSON, так как строка будет воспринята буквально. Это не может быть указано вместе с --cli-input-yaml.

--starting-token (строка)

Токен, указывающий, где начать постраничный вывод. Это NextToken из ранее урезанного ответа.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

--page-size (целое число)

Размер каждой страницы при вызове AWS-сервиса. Это не влияет на количество элементов, возвращаемых в выводе команды. Уменьшение размера страницы приводит к большему количеству вызовов AWS-сервиса, извлекая меньше элементов в каждом вызове. Это может помочь предотвратить истечение времени ожидания вызовов AWS-сервиса.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

--max-items (целое число)

Общее количество элементов, которое нужно вернуть в выводе команды. Если общее количество доступных элементов превышает указанное значение, в выводе команды предоставляется NextToken. Для возобновления постраничного вывода укажите значение NextToken в аргументе starting-token последующей команды. Не используйте элемент ответа NextToken напрямую вне AWS CLI.

Примеры использования см. в разделе «Постраничный вывод» в Руководстве пользователя AWS Command Line Interface.

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

Включение/выключение цветного вывода.

  • вкл
  • выкл
  • авто

--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.

Вывод

aiAgentVersionSummaries -> (список)

Резюме версий AI-агентов.

(структура)

Резюме версии AI-агента.

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

Данные для резюме версии AI-агента.

name -> (строка)

Название AI-агента.

assistantId -> (строка)

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

assistantArn -> (строка)

Amazon Resource Name (ARN) ассистента Amazon Q в Connect.

aiAgentId -> (строка)

Идентификатор AI-агента.

type -> (строка)

Тип AI-агента.

aiAgentArn -> (строка)

Amazon Resource Name (ARN) AI-агента.

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

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

visibilityStatus -> (строка)

Статус видимости AI-агента.

configuration -> (меченый объединительный структура)

Настройка AI-агента.

Примечание

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

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

Настройка AI-агентов типа MANUAL_SEARCH.

answerGenerationAIPromptId -> (строка)

Идентификатор AI-запроса для запроса генерации ответа, используемого агентом MANUAL_SEARCH AI.

answerGenerationAIGuardrailId -> (строка)

Идентификатор AI-защиты для защиты генерации ответа, используемой агентом MANUAL_SEARCH AI.

associationConfigurations -> (список)

Настройки ассоциации для переопределения поведения этого AI-агента.

(структура)

Настройка ассоциации ассистента Amazon Q в Connect.

associationId -> (строка)

Идентификатор ассоциации для этой настройки ассоциации.

associationType -> (строка)

Тип ассоциации для этой настройки ассоциации.

associationConfigurationData -> (меченый объединительный структура)

Данные настройки ассоциации ассистента Amazon Q в Connect.

Примечание

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

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

Данные настройки ассоциации типа KNOWLEDGE_BASE ассистента Amazon Q в Connect.

contentTagFilter -> (меченый объединительный структура)

Объект, который можно использовать для указания условий тегов.

Примечание

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

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

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

andConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

orConditions -> (список)

Список условий, которые будут применяться вместе с условием OR.

(меченый объединительный структура)

Список условий, которые будут применяться вместе с условием OR.

Примечание

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

andConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

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

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

maxResults -> (целое число)

Максимальное количество результатов на страницу.

overrideKnowledgeBaseSearchType -> (строка)

Тип поиска, используемый в базе знаний для этого запроса. Значения могут быть SEMANTIC, использующий векторные вложения, или HYBRID, использующий векторные вложения и обычный текст.

locale -> (строка)

Локаль, которая определяет язык и региональные настройки для определения языка ответа QueryAssistant.

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

Настройка AI-агентов типа ANSWER_RECOMMENDATION.

intentLabelingGenerationAIPromptId -> (строка)

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

queryReformulationAIPromptId -> (строка)

Идентификатор AI-запроса для запроса переформулировки запроса, используемого агентом ANSWER_RECOMMENDATION AI.

answerGenerationAIPromptId -> (строка)

Идентификатор AI-запроса для запроса генерации ответа, используемого агентом ANSWER_RECOMMENDATION AI.

answerGenerationAIGuardrailId -> (строка)

Идентификатор AI-защиты для защиты генерации ответа, используемой агентом ANSWER_RECOMMENDATION AI.

associationConfigurations -> (список)

Настройки ассоциации для переопределения поведения этого AI-агента.

(структура)

Настройка ассоциации ассистента Amazon Q в Connect.

associationId -> (строка)

Идентификатор ассоциации для этой настройки ассоциации.

associationType -> (строка)

Тип ассоциации для этой настройки ассоциации.

associationConfigurationData -> (меченый объединительный структура)

Данные настройки ассоциации ассистента Amazon Q в Connect.

Примечание

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

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

Данные настройки ассоциации типа KNOWLEDGE_BASE ассистента Amazon Q в Connect.

contentTagFilter -> (меченый объединительный структура)

Объект, который можно использовать для указания условий тегов.

Примечание

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

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

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

andConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

orConditions -> (список)

Список условий, которые будут применяться вместе с условием OR.

(меченый объединительный структура)

Список условий, которые будут применяться вместе с условием OR.

Примечание

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

andConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

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

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

maxResults -> (целое число)

Максимальное количество результатов на страницу.

overrideKnowledgeBaseSearchType -> (строка)

Тип поиска, используемый в базе знаний для этого запроса. Значения могут быть SEMANTIC, использующий векторные вложения, или HYBRID, использующий векторные вложения и обычный текст.

locale -> (строка)

Локаль, определяющая язык и региональные настройки для определения языка ответа QueryAssistant.

Примечание

Изменение этой локали на что-либо, кроме en_US, en_GB или en_AU, отключит рекомендации, генерируемые транскриптами контактов для помощи агенту, так как эта функция не поддерживается на нескольких языках.

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

Настройка агентов ИИ типа SELF_SERVICE.

selfServicePreProcessingAIPromptId -> (строка)

Идентификатор подсказки ИИ для предварительной обработки запросов Self Service, используемый агентом ИИ SELF_SERVICE.

selfServiceAnswerGenerationAIPromptId -> (строка)

Идентификатор подсказки ИИ для генерации ответов Self Service, используемый агентом ИИ SELF_SERVICE.

selfServiceAIGuardrailId -> (строка)

Идентификатор AI Guardrail, используемый агентом ИИ SELF_SERVICE.

associationConfigurations -> (список)

Конфигурации ассоциаций для переопределения поведения в этом агенте ИИ.

(структура)

Настройка ассоциации Amazon Q в Connect Assistant.

associationId -> (строка)

Идентификатор ассоциации для этой конфигурации ассоциации.

associationType -> (строка)

Тип ассоциации для этой конфигурации ассоциации.

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

Данные конфигурации ассоциации Amazon Q в Connect Assistant.

Примечание

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

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

Данные конфигурации ассоциации Amazon Q в Connect Assistant типа KNOWLEDGE_BASE.

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

Объект, который может использоваться для указания условий тегов.

Примечание

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

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

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

andConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

orConditions -> (список)

Список условий, которые будут применяться вместе с условием OR.

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

Список условий, которые будут применяться вместе с условием OR.

Примечание

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

andConditions -> (список)

Список условий, которые будут применяться вместе с условием AND.

(структура)

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

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

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

key -> (строка)

Ключ тега в условии тега.

value -> (строка)

Значение тега в условии тега.

maxResults -> (целое число)

Максимальное количество результатов, возвращаемых за страницу.

overrideKnowledgeBaseSearchType -> (строка)

Тип поиска, который будет использоваться против базы знаний для этого запроса. Значения могут быть SEMANTIC, использующие векторные вложения, или HYBRID, использующие векторные вложения и обычный текст.

origin -> (строка)

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

description -> (строка)

Описание агента ИИ.

status -> (строка)

Статус агента ИИ.

tags -> (карта)

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

key -> (строка)

value -> (строка)

versionNumber -> (длинное целое число)

Номер версии этого агента ИИ.

nextToken -> (строка)

Токен для следующего набора результатов. Используйте значение, возвращенное в предыдущем ответе, в следующем запросе, чтобы получить следующий набор результатов.

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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