QConnect / Paginator / ListModels

ListModels¶

class QConnect.Paginator.ListModels¶

paginator = client.get_paginator('list_models')

paginate(**kwargs)¶

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

Request Syntax

response_iterator = paginator.paginate(
    assistantId='string',
    aiPromptType='ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'EMAIL_QUERY_REFORMULATION'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
    modelLifecycle='ACTIVE'|'LEGACY',
    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. The assistant’s region determines which models are available.
aiPromptType (string) – The type of the AI Prompt to filter models by. When specified, only models that support the given AI Prompt type are returned.
modelLifecycle (string) – The lifecycle status of models to filter by. When specified, only models with the given lifecycle status are returned.
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

{
    'modelSummaries': [
        {
            'modelId': 'string',
            'displayName': 'string',
            'crossRegionStatus': 'NONE'|'REGIONAL'|'GLOBAL',
            'supportsPromptCaching': True|False,
            'supportedAIPromptTypes': [
                'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION'|'EMAIL_RESPONSE'|'EMAIL_OVERVIEW'|'EMAIL_GENERATIVE_ANSWER'|'EMAIL_QUERY_REFORMULATION'|'ORCHESTRATION'|'NOTE_TAKING'|'CASE_SUMMARIZATION',
            ],
            'modelLifecycle': 'ACTIVE'|'LEGACY',
            'legacyTimestamp': datetime(2015, 1, 1),
            'endOfLifeTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- modelSummaries (list) –
  
  The summaries of the models available to the assistant.
  - (dict) –
    
    The summary of a model available to an Amazon Q in Connect assistant.
    - modelId (string) –
      
      The identifier of the model.
    - displayName (string) –
      
      The display name of the model.
    - crossRegionStatus (string) –
      
      The cross-region availability status of the model. NONE indicates the model is only available in a single region, REGIONAL indicates the model is available through regional inference, and GLOBAL indicates the model is available through global cross-region inference.
    - supportsPromptCaching (boolean) –
      
      Whether the model supports prompt caching.
    - supportedAIPromptTypes (list) –
      
      The list of AI Prompt types that the model supports.
      - (string) –
    - modelLifecycle (string) –
      
      The current lifecycle of the model. ACTIVE indicates the model is recommended for use and LEGACY indicates the model is still usable but is deprecated.
    - legacyTimestamp (datetime) –
      
      The timestamp when the model lifecycle will transition from ACTIVE to LEGACY.
    - endOfLifeTimestamp (datetime) –
      
      The timestamp when the model will reach end of life and no longer be available for use.
- NextToken (string) –
  
  A token to resume pagination.