QConnect / Paginator / ListAIAgents

ListAIAgents#

class QConnect.Paginator.ListAIAgents#

paginator = client.get_paginator('list_ai_agents')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from QConnect.Client.list_ai_agents().

Request Syntax

response_iterator = paginator.paginate(
    assistantId='string',
    origin='SYSTEM'|'CUSTOMER',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

assistantId (string) –
[REQUIRED]

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
origin (string) – The origin of the AI Agents to be listed. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
- MaxItems (integer) –
  
  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
- PageSize (integer) –
  
  The size of each page.
- StartingToken (string) –
  
  A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'aiAgentSummaries': [
        {
            'aiAgentArn': 'string',
            'aiAgentId': 'string',
            'assistantArn': 'string',
            'assistantId': 'string',
            'configuration': {
                'answerRecommendationAIAgentConfiguration': {
                    'answerGenerationAIGuardrailId': 'string',
                    'answerGenerationAIPromptId': 'string',
                    'associationConfigurations': [
                        {
                            'associationConfigurationData': {
                                'knowledgeBaseAssociationConfigurationData': {
                                    'contentTagFilter': {
                                        'andConditions': [
                                            {
                                                'key': 'string',
                                                'value': 'string'
                                            },
                                        ],
                                        'orConditions': [
                                            {
                                                'andConditions': [
                                                    {
                                                        'key': 'string',
                                                        'value': 'string'
                                                    },
                                                ],
                                                'tagCondition': {
                                                    'key': 'string',
                                                    'value': 'string'
                                                }
                                            },
                                        ],
                                        'tagCondition': {
                                            'key': 'string',
                                            'value': 'string'
                                        }
                                    },
                                    'maxResults': 123,
                                    'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
                                }
                            },
                            'associationId': 'string',
                            'associationType': 'KNOWLEDGE_BASE'
                        },
                    ],
                    'intentLabelingGenerationAIPromptId': 'string',
                    'locale': 'string',
                    'queryReformulationAIPromptId': 'string'
                },
                'manualSearchAIAgentConfiguration': {
                    'answerGenerationAIGuardrailId': 'string',
                    'answerGenerationAIPromptId': 'string',
                    'associationConfigurations': [
                        {
                            'associationConfigurationData': {
                                'knowledgeBaseAssociationConfigurationData': {
                                    'contentTagFilter': {
                                        'andConditions': [
                                            {
                                                'key': 'string',
                                                'value': 'string'
                                            },
                                        ],
                                        'orConditions': [
                                            {
                                                'andConditions': [
                                                    {
                                                        'key': 'string',
                                                        'value': 'string'
                                                    },
                                                ],
                                                'tagCondition': {
                                                    'key': 'string',
                                                    'value': 'string'
                                                }
                                            },
                                        ],
                                        'tagCondition': {
                                            'key': 'string',
                                            'value': 'string'
                                        }
                                    },
                                    'maxResults': 123,
                                    'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
                                }
                            },
                            'associationId': 'string',
                            'associationType': 'KNOWLEDGE_BASE'
                        },
                    ],
                    'locale': 'string'
                },
                'selfServiceAIAgentConfiguration': {
                    'associationConfigurations': [
                        {
                            'associationConfigurationData': {
                                'knowledgeBaseAssociationConfigurationData': {
                                    'contentTagFilter': {
                                        'andConditions': [
                                            {
                                                'key': 'string',
                                                'value': 'string'
                                            },
                                        ],
                                        'orConditions': [
                                            {
                                                'andConditions': [
                                                    {
                                                        'key': 'string',
                                                        'value': 'string'
                                                    },
                                                ],
                                                'tagCondition': {
                                                    'key': 'string',
                                                    'value': 'string'
                                                }
                                            },
                                        ],
                                        'tagCondition': {
                                            'key': 'string',
                                            'value': 'string'
                                        }
                                    },
                                    'maxResults': 123,
                                    'overrideKnowledgeBaseSearchType': 'HYBRID'|'SEMANTIC'
                                }
                            },
                            'associationId': 'string',
                            'associationType': 'KNOWLEDGE_BASE'
                        },
                    ],
                    'selfServiceAIGuardrailId': 'string',
                    'selfServiceAnswerGenerationAIPromptId': 'string',
                    'selfServicePreProcessingAIPromptId': 'string'
                }
            },
            'description': 'string',
            'modifiedTime': datetime(2015, 1, 1),
            'name': 'string',
            'origin': 'SYSTEM'|'CUSTOMER',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'ACTIVE'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED',
            'tags': {
                'string': 'string'
            },
            'type': 'MANUAL_SEARCH'|'ANSWER_RECOMMENDATION'|'SELF_SERVICE',
            'visibilityStatus': 'SAVED'|'PUBLISHED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- aiAgentSummaries (list) –
  
  The summaries of AI Agents.
  - (dict) –
    
    The summary of the AI Agent.
    - aiAgentArn (string) –
      
      The Amazon Resource Name (ARN) of the AI agent.
    - aiAgentId (string) –
      
      The identifier of the AI Agent.
    - assistantArn (string) –
      
      The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
    - assistantId (string) –
      
      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
    - configuration (dict) –
      
      The configuration for the AI Agent.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: answerRecommendationAIAgentConfiguration, manualSearchAIAgentConfiguration, selfServiceAIAgentConfiguration. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - answerRecommendationAIAgentConfiguration (dict) –
        
        The configuration for AI Agents of type ANSWER_RECOMMENDATION.
        
        answerGenerationAIGuardrailId (string) –
        
        The AI Guardrail identifier for the Answer Generation Guardrail used by the ANSWER_RECOMMENDATION AI Agent.
        
        answerGenerationAIPromptId (string) –
        
        The AI Prompt identifier for the Answer Generation prompt used by the ANSWER_RECOMMENDATION AI Agent.
        
        associationConfigurations (list) –
        
        The association configurations for overriding behavior on this AI Agent.
        
        (dict) –
        
        The configuration for an Amazon Q in Connect Assistant Association.
        
        associationConfigurationData (dict) –
        
        The data of the configuration for an Amazon Q in Connect Assistant Association.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: knowledgeBaseAssociationConfigurationData. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        knowledgeBaseAssociationConfigurationData (dict) –
        
        The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
        
        contentTagFilter (dict) –
        
        An object that can be used to specify Tag conditions.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        andConditions (list) –
        
        A list of conditions which would be applied together with an AND condition.
        
        (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        orConditions (list) –
        
        A list of conditions which would be applied together with an OR condition.
        
        (dict) –
        
        A list of conditions which would be applied together with an OR condition.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: andConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        andConditions (list) –
        
        A list of conditions which would be applied together with an AND condition.
        
        (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        tagCondition (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        tagCondition (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        maxResults (integer) –
        
        The maximum number of results to return per page.
        
        overrideKnowledgeBaseSearchType (string) –
        
        The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
        
        associationId (string) –
        
        The identifier of the association for this Association Configuration.
        
        associationType (string) –
        
        The type of the association for this Association Configuration.
        
        intentLabelingGenerationAIPromptId (string) –
        
        The AI Prompt identifier for the Intent Labeling prompt used by the ANSWER_RECOMMENDATION AI Agent.
        
        locale (string) –
        
        The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
        
        Note
        Changing this locale to anything other than en_US will turn off recommendations triggered by contact transcripts for agent assistance, as this feature is not supported in multiple languages.
        
        queryReformulationAIPromptId (string) –
        
        The AI Prompt identifier for the Query Reformulation prompt used by the ANSWER_RECOMMENDATION AI Agent.
      - manualSearchAIAgentConfiguration (dict) –
        
        The configuration for AI Agents of type MANUAL_SEARCH.
        
        answerGenerationAIGuardrailId (string) –
        
        The AI Guardrail identifier for the Answer Generation guardrail used by the MANUAL_SEARCH AI Agent.
        
        answerGenerationAIPromptId (string) –
        
        The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI Agent.
        
        associationConfigurations (list) –
        
        The association configurations for overriding behavior on this AI Agent.
        
        (dict) –
        
        The configuration for an Amazon Q in Connect Assistant Association.
        
        associationConfigurationData (dict) –
        
        The data of the configuration for an Amazon Q in Connect Assistant Association.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: knowledgeBaseAssociationConfigurationData. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        knowledgeBaseAssociationConfigurationData (dict) –
        
        The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
        
        contentTagFilter (dict) –
        
        An object that can be used to specify Tag conditions.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        andConditions (list) –
        
        A list of conditions which would be applied together with an AND condition.
        
        (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        orConditions (list) –
        
        A list of conditions which would be applied together with an OR condition.
        
        (dict) –
        
        A list of conditions which would be applied together with an OR condition.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: andConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        andConditions (list) –
        
        A list of conditions which would be applied together with an AND condition.
        
        (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        tagCondition (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        tagCondition (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        maxResults (integer) –
        
        The maximum number of results to return per page.
        
        overrideKnowledgeBaseSearchType (string) –
        
        The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
        
        associationId (string) –
        
        The identifier of the association for this Association Configuration.
        
        associationType (string) –
        
        The type of the association for this Association Configuration.
        
        locale (string) –
        
        The locale to which specifies the language and region settings that determine the response language for QueryAssistant.
      - selfServiceAIAgentConfiguration (dict) –
        
        The configuration for AI Agents of type SELF_SERVICE.
        
        associationConfigurations (list) –
        
        The association configurations for overriding behavior on this AI Agent.
        
        (dict) –
        
        The configuration for an Amazon Q in Connect Assistant Association.
        
        associationConfigurationData (dict) –
        
        The data of the configuration for an Amazon Q in Connect Assistant Association.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: knowledgeBaseAssociationConfigurationData. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        knowledgeBaseAssociationConfigurationData (dict) –
        
        The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
        
        contentTagFilter (dict) –
        
        An object that can be used to specify Tag conditions.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: andConditions, orConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        andConditions (list) –
        
        A list of conditions which would be applied together with an AND condition.
        
        (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        orConditions (list) –
        
        A list of conditions which would be applied together with an OR condition.
        
        (dict) –
        
        A list of conditions which would be applied together with an OR condition.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: andConditions, tagCondition. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
        
        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        
        andConditions (list) –
        
        A list of conditions which would be applied together with an AND condition.
        
        (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        tagCondition (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        tagCondition (dict) –
        
        A leaf node condition which can be used to specify a tag condition.
        
        key (string) –
        
        The tag key in the tag condition.
        
        value (string) –
        
        The tag value in the tag condition.
        
        maxResults (integer) –
        
        The maximum number of results to return per page.
        
        overrideKnowledgeBaseSearchType (string) –
        
        The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text
        
        associationId (string) –
        
        The identifier of the association for this Association Configuration.
        
        associationType (string) –
        
        The type of the association for this Association Configuration.
        
        selfServiceAIGuardrailId (string) –
        
        The AI Guardrail identifier used by the SELF_SERVICE AI Agent.
        
        selfServiceAnswerGenerationAIPromptId (string) –
        
        The AI Prompt identifier for the Self Service Answer Generation prompt used by the SELF_SERVICE AI Agent
        
        selfServicePreProcessingAIPromptId (string) –
        
        The AI Prompt identifier for the Self Service Pre-Processing prompt used by the SELF_SERVICE AI Agent
    - description (string) –
      
      The description of the AI Agent.
    - modifiedTime (datetime) –
      
      The time the AI Agent was last modified.
    - name (string) –
      
      The name of the AI Agent.
    - origin (string) –
      
      The origin of the AI Agent. SYSTEM for a default AI Agent created by Q in Connect or CUSTOMER for an AI Agent created by calling AI Agent creation APIs.
    - status (string) –
      
      The status of the AI Agent.
    - tags (dict) –
      
      The tags used to organize, track, or control access for this resource.
      - (string) –
        
        (string) –
    - type (string) –
      
      The type of the AI Agent.
    - visibilityStatus (string) –
      
      The visibility status of the AI Agent.
- NextToken (string) –
  
  A token to resume pagination.