QConnect / Paginator / SearchQuickResponses

SearchQuickResponses¶

class QConnect.Paginator.SearchQuickResponses¶

paginator = client.get_paginator('search_quick_responses')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    knowledgeBaseId='string',
    searchExpression={
        'queries': [
            {
                'name': 'string',
                'values': [
                    'string',
                ],
                'operator': 'CONTAINS'|'CONTAINS_AND_PREFIX',
                'allowFuzziness': True|False,
                'priority': 'HIGH'|'MEDIUM'|'LOW'
            },
        ],
        'filters': [
            {
                'name': 'string',
                'values': [
                    'string',
                ],
                'operator': 'EQUALS'|'PREFIX',
                'includeNoExistence': True|False
            },
        ],
        'orderOnField': {
            'name': 'string',
            'order': 'ASC'|'DESC'
        }
    },
    attributes={
        'string': 'string'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

knowledgeBaseId (string) –
[REQUIRED]

The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
searchExpression (dict) –
[REQUIRED]

The search expression for querying the quick response.
- queries (list) –
  
  The quick response query expressions.
  - (dict) –
    
    The quick response fields to query quick responses by.
    
    The following is the list of supported field names.
    - content
    - name
    - description
    - shortcutKey
    - name (string) – [REQUIRED]
      
      The name of the attribute to query the quick responses by.
    - values (list) – [REQUIRED]
      
      The values of the attribute to query the quick responses by.
      - (string) –
    - operator (string) – [REQUIRED]
      
      The operator to use for matching attribute field values in the query.
    - allowFuzziness (boolean) –
      
      Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.
    - priority (string) –
      
      The importance of the attribute field when calculating query result relevancy scores. The value set for this parameter affects the ordering of search results.
- filters (list) –
  
  The configuration of filtering rules applied to quick response query results.
  - (dict) –
    
    The quick response fields to filter the quick response query results by.
    
    The following is the list of supported field names.
    - name
    - description
    - shortcutKey
    - isActive
    - channels
    - language
    - contentType
    - createdTime
    - lastModifiedTime
    - lastModifiedBy
    - groupingConfiguration.criteria
    - groupingConfiguration.values
    - name (string) – [REQUIRED]
      
      The name of the attribute field to filter the quick responses by.
    - values (list) –
      
      The values of attribute field to filter the quick response by.
      - (string) –
    - operator (string) – [REQUIRED]
      
      The operator to use for filtering.
    - includeNoExistence (boolean) –
      
      Whether to treat null value as a match for the attribute field.
- orderOnField (dict) –
  
  The quick response attribute fields on which the query results are ordered.
  - name (string) – [REQUIRED]
    
    The name of the attribute to order the quick response query results by.
  - order (string) –
    
    The order at which the quick responses are sorted by.
attributes (dict) –
The user-defined Amazon Connect contact attributes to be resolved when search results are returned.
- (string) –
  - (string) –
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

{
    'results': [
        {
            'quickResponseArn': 'string',
            'quickResponseId': 'string',
            'knowledgeBaseArn': 'string',
            'knowledgeBaseId': 'string',
            'name': 'string',
            'contentType': 'string',
            'status': 'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'CREATED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'|'DELETED'|'UPDATE_IN_PROGRESS'|'UPDATE_FAILED',
            'contents': {
                'plainText': {
                    'content': 'string'
                },
                'markdown': {
                    'content': 'string'
                }
            },
            'createdTime': datetime(2015, 1, 1),
            'lastModifiedTime': datetime(2015, 1, 1),
            'isActive': True|False,
            'description': 'string',
            'groupingConfiguration': {
                'criteria': 'string',
                'values': [
                    'string',
                ]
            },
            'shortcutKey': 'string',
            'lastModifiedBy': 'string',
            'channels': [
                'string',
            ],
            'language': 'string',
            'attributesNotInterpolated': [
                'string',
            ],
            'attributesInterpolated': [
                'string',
            ],
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- results (list) –
  
  The results of the quick response search.
  - (dict) –
    
    The result of quick response search.
    - quickResponseArn (string) –
      
      The Amazon Resource Name (ARN) of the quick response.
    - quickResponseId (string) –
      
      The identifier of the quick response.
    - knowledgeBaseArn (string) –
      
      The Amazon Resource Name (ARN) of the knowledge base.
    - knowledgeBaseId (string) –
      
      The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
    - name (string) –
      
      The name of the quick response.
    - contentType (string) –
      
      The media type of the quick response content.
      - Use application/x.quickresponse;format=plain for quick response written in plain text.
      - Use application/x.quickresponse;format=markdown for quick response written in richtext.
    - status (string) –
      
      The resource status of the quick response.
    - contents (dict) –
      
      The contents of the quick response.
      - plainText (dict) –
        
        The container quick response content.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: content. 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'}
        
        content (string) –
        
        The content of the quick response.
      - markdown (dict) –
        
        The container quick response content.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys will be set: content. 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'}
        
        content (string) –
        
        The content of the quick response.
    - createdTime (datetime) –
      
      The timestamp when the quick response was created.
    - lastModifiedTime (datetime) –
      
      The timestamp when the quick response search result data was last modified.
    - isActive (boolean) –
      
      Whether the quick response is active.
    - description (string) –
      
      The description of the quick response.
    - groupingConfiguration (dict) –
      
      The configuration information of the user groups that the quick response is accessible to.
      - criteria (string) –
        
        The criteria used for grouping Amazon Q in Connect users.
        
        The following is the list of supported criteria values.
        
        RoutingProfileArn: Grouping the users by their Amazon Connect routing profile ARN. User should have SearchRoutingProfile and DescribeRoutingProfile permissions when setting criteria to this value.
      - values (list) –
        
        The list of values that define different groups of Amazon Q in Connect users.
        
        When setting criteria to RoutingProfileArn, you need to provide a list of ARNs of Amazon Connect routing profiles as values of this parameter.
        
        (string) –
    - shortcutKey (string) –
      
      The shortcut key of the quick response. The value should be unique across the knowledge base.
    - lastModifiedBy (string) –
      
      The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
    - channels (list) –
      
      The Amazon Connect contact channels this quick response applies to. The supported contact channel types include Chat.
      - (string) –
    - language (string) –
      
      The language code value for the language in which the quick response is written.
    - attributesNotInterpolated (list) –
      
      The user defined contact attributes that are not resolved when the search result is returned.
      - (string) –
    - attributesInterpolated (list) –
      
      The user defined contact attributes that are resolved when the search result is returned.
      - (string) –
    - tags (dict) –
      
      The tags used to organize, track, or control access for this resource.
      - (string) –
        
        (string) –
- NextToken (string) –
  
  A token to resume pagination.