QConnect / Client / list_ai_prompts

list_ai_prompts#

QConnect.Client.list_ai_prompts(**kwargs)#

Lists the AI Prompts available on the Amazon Q in Connect assistant.

See also: AWS API Documentation

Request Syntax

response = client.list_ai_prompts(
    assistantId='string',
    maxResults=123,
    nextToken='string',
    origin='SYSTEM'|'CUSTOMER'
)
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.

  • maxResults (integer) – The maximum number of results to return per page.

  • nextToken (string) – The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

  • origin (string) – The origin of the AI Prompts 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.

Return type:

dict

Returns:

Response Syntax

{
    'aiPromptSummaries': [
        {
            'aiPromptArn': 'string',
            'aiPromptId': 'string',
            'apiFormat': 'ANTHROPIC_CLAUDE_MESSAGES'|'ANTHROPIC_CLAUDE_TEXT_COMPLETIONS',
            'assistantArn': 'string',
            'assistantId': 'string',
            'description': 'string',
            'modelId': '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'
            },
            'templateType': 'TEXT',
            'type': 'ANSWER_GENERATION'|'INTENT_LABELING_GENERATION'|'QUERY_REFORMULATION'|'SELF_SERVICE_PRE_PROCESSING'|'SELF_SERVICE_ANSWER_GENERATION',
            'visibilityStatus': 'SAVED'|'PUBLISHED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • aiPromptSummaries (list) –

      The summaries of the AI Prompts.

      • (dict) –

        The summary of the AI Prompt.

        • aiPromptArn (string) –

          The Amazon Resource Name (ARN) of the AI Prompt.

        • aiPromptId (string) –

          The identifier of the Amazon Q in Connect AI prompt.

        • apiFormat (string) –

          The API format used for this AI Prompt.

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

        • description (string) –

          The description of the AI Prompt.

        • modelId (string) –

          The identifier of the model used for this AI Prompt. Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1.

        • modifiedTime (datetime) –

          The time the AI Prompt was last modified.

        • name (string) –

          The name of the AI Prompt.

        • origin (string) –

          The origin of the AI Prompt. SYSTEM for a default AI Prompt created by Q in Connect or CUSTOMER for an AI Prompt created by calling AI Prompt creation APIs.

        • status (string) –

          The status of the AI Prompt.

        • tags (dict) –

          The tags used to organize, track, or control access for this resource.

          • (string) –

            • (string) –

        • templateType (string) –

          The type of the prompt template for this AI Prompt.

        • type (string) –

          The type of this AI Prompt.

        • visibilityStatus (string) –

          The visibility status of the AI Prompt.

    • nextToken (string) –

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Exceptions