Spec-Zone.ru › AWS CLI v2

[ aws . qconnect ]

list-ai-agents

Описание

Отображает списки агентов ИИ.

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

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

Синтаксис

  list-ai-agents
--assistant-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.

--origin (строка)

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

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

  • 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
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использует определенный профиль из вашего файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отображает версию этого инструмента.

--color (строка)

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

  • включено
  • выключено
  • автоматически

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент указан.

--ca-bundle (строка)

Файл сертификатов CA для использования при проверке сертификатов SSL. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (int)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться без блокировки и без таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (int)

Максимальное время подключения сокета в секундах. Если значение установлено в 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.

Вывод

aiAgentSummaries -> (список)

Резюме агентов ИИ.

(структура)

Резюме агента ИИ.

name -> (строка)

Имя агента ИИ.

assistantId -> (строка)

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

assistantArn -> (строка)

Идентификатор ресурса Amazon (ARN) ассистента Amazon Q в Connect.

aiAgentId -> (строка)

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

type -> (строка)

Тип агента ИИ.

aiAgentArn -> (строка)

Идентификатор ресурса Amazon (ARN) агента ИИ.

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

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

visibilityStatus -> (строка)

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

configuration -> (структура помеченных союзов)

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

Примечание

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

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

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

answerGenerationAIPromptId -> (строка)

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

answerGenerationAIGuardrailId -> (строка)

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

associationConfigurations -> (список)

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

(структура)

Настройки ассоциации ассистента 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 -> (структура)

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

intentLabelingGenerationAIPromptId -> (строка)

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

queryReformulationAIPromptId -> (строка)

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

answerGenerationAIPromptId -> (строка)

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

answerGenerationAIGuardrailId -> (строка)

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

associationConfigurations -> (список)

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

(структура)

Настройки ассоциации ассистента 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 -> (строка)

Идентификатор ограничений ИИ, используемый агентом ИИ 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 -> (строка)

nextToken -> (строка)

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

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

END_OF_DOCUMENT_MARKER

Spec-Zone.ru

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