QConnect / Paginator / QueryAssistant

QueryAssistant

class QConnect.Paginator.QueryAssistant

paginator = client.get_paginator('query_assistant')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    assistantId='string',
    queryCondition=[
        {
            'single': {
                'comparator': 'EQUALS',
                'field': 'RESULT_TYPE',
                'value': 'string'
            }
        },
    ],
    queryText='string',
    sessionId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• assistantId (string) –

  [REQUIRED]

  The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

• queryCondition (list) –

  Information about how to query content.

  • (dict) –

    Information about how to query content.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: single.

    • single (dict) –

      The condition for the query.

      • comparator (string) – [REQUIRED]

        The comparison operator for query condition to query on.

      • field (string) – [REQUIRED]

        The name of the field for query condition to query on.

      • value (string) – [REQUIRED]

        The value for the query condition to query on.

• queryText (string) –

  [REQUIRED]

  The text to search for.

• sessionId (string) – The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot contain the ARN.

• 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': [
        {
            'data': {
                'details': {
                    'contentData': {
                        'rankingData': {
                            'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
                            'relevanceScore': 123.0
                        },
                        'textData': {
                            'excerpt': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            },
                            'title': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            }
                        }
                    },
                    'generativeData': {
                        'completion': 'string',
                        'rankingData': {
                            'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
                            'relevanceScore': 123.0
                        },
                        'references': [
                            {'... recursive ...'},
                        ]
                    },
                    'sourceContentData': {
                        'id': 'string',
                        'rankingData': {
                            'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW',
                            'relevanceScore': 123.0
                        },
                        'textData': {
                            'excerpt': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            },
                            'title': {
                                'highlights': [
                                    {
                                        'beginOffsetInclusive': 123,
                                        'endOffsetExclusive': 123
                                    },
                                ],
                                'text': 'string'
                            }
                        },
                        'type': 'KNOWLEDGE_CONTENT'
                    }
                },
                'reference': {
                    'contentReference': {
                        'contentArn': 'string',
                        'contentId': 'string',
                        'knowledgeBaseArn': 'string',
                        'knowledgeBaseId': 'string'
                    },
                    'generativeReference': {
                        'generationId': 'string',
                        'modelId': 'string'
                    }
                }
            },
            'document': {
                'contentReference': {
                    'contentArn': 'string',
                    'contentId': 'string',
                    'knowledgeBaseArn': 'string',
                    'knowledgeBaseId': 'string'
                },
                'excerpt': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                },
                'title': {
                    'highlights': [
                        {
                            'beginOffsetInclusive': 123,
                            'endOffsetExclusive': 123
                        },
                    ],
                    'text': 'string'
                }
            },
            'relevanceScore': 123.0,
            'resultId': 'string',
            'type': 'KNOWLEDGE_CONTENT'|'GENERATIVE_ANSWER'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • results (list) –

    The results of the query.

    • (dict) –

      Information about the result.

      • data (dict) –

        Summary of the recommended content.

        • details (dict) –

          Details about the data.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: contentData, generativeData, sourceContentData. 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'}
          

          • contentData (dict) –

            Details about the content data.

            • rankingData (dict) –

              Details about the content ranking data.

              • relevanceLevel (string) –

                The relevance score of the content.

              • relevanceScore (float) –

                The relevance level of the recommendation.

            • textData (dict) –

              Details about the content text data.

              • excerpt (dict) –

                The text of the document.

                • highlights (list) –

                  Highlights in the document text.

                  • (dict) –

                    Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

                    • beginOffsetInclusive (integer) –

                      The offset for the start of the highlight.

                    • endOffsetExclusive (integer) –

                      The offset for the end of the highlight.

                • text (string) –

                  Text in the document.

              • title (dict) –

                The text of the document.

                • highlights (list) –

                  Highlights in the document text.

                  • (dict) –

                    Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

                    • beginOffsetInclusive (integer) –

                      The offset for the start of the highlight.

                    • endOffsetExclusive (integer) –

                      The offset for the end of the highlight.

                • text (string) –

                  Text in the document.

          • generativeData (dict) –

            Details about the generative data.

            • completion (string) –

              The LLM response.

            • rankingData (dict) –

              Details about the generative content ranking data.

              • relevanceLevel (string) –

                The relevance score of the content.

              • relevanceScore (float) –

                The relevance level of the recommendation.

            • references (list) –

              The references used to generative the LLM response.

              • (dict) –

                Summary of the data.

          • sourceContentData (dict) –

            Details about the content data.

            • id (string) –

              The identifier of the source content.

            • rankingData (dict) –

              Details about the source content ranking data.

              • relevanceLevel (string) –

                The relevance score of the content.

              • relevanceScore (float) –

                The relevance level of the recommendation.

            • textData (dict) –

              Details about the source content text data.

              • excerpt (dict) –

                The text of the document.

                • highlights (list) –

                  Highlights in the document text.

                  • (dict) –

                    Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

                    • beginOffsetInclusive (integer) –

                      The offset for the start of the highlight.

                    • endOffsetExclusive (integer) –

                      The offset for the end of the highlight.

                • text (string) –

                  Text in the document.

              • title (dict) –

                The text of the document.

                • highlights (list) –

                  Highlights in the document text.

                  • (dict) –

                    Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

                    • beginOffsetInclusive (integer) –

                      The offset for the start of the highlight.

                    • endOffsetExclusive (integer) –

                      The offset for the end of the highlight.

                • text (string) –

                  Text in the document.

            • type (string) –

              The type of the source content.

        • reference (dict) –

          Reference information about the content.

          Note

          This is a Tagged Union structure. Only one of the following top level keys will be set: contentReference, generativeReference. 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'}
          

          • contentReference (dict) –

            Reference information about the content.

            • contentArn (string) –

              The Amazon Resource Name (ARN) of the content.

            • contentId (string) –

              The identifier of the content.

            • knowledgeBaseArn (string) –

              The Amazon Resource Name (ARN) of the knowledge base.

            • knowledgeBaseId (string) –

              The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it.

          • generativeReference (dict) –

            Reference information about the generative content.

            • generationId (string) –

              The identifier of the LLM model.

            • modelId (string) –

              The identifier of the LLM model.

      • document (dict) –

        The document.

        • contentReference (dict) –

          A reference to the content resource.

          • contentArn (string) –

            The Amazon Resource Name (ARN) of the content.

          • contentId (string) –

            The identifier of the content.

          • knowledgeBaseArn (string) –

            The Amazon Resource Name (ARN) of the knowledge base.

          • knowledgeBaseId (string) –

            The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you’re storing Amazon Q Content resource to it.

        • excerpt (dict) –

          The excerpt from the document.

          • highlights (list) –

            Highlights in the document text.

            • (dict) –

              Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

              • beginOffsetInclusive (integer) –

                The offset for the start of the highlight.

              • endOffsetExclusive (integer) –

                The offset for the end of the highlight.

          • text (string) –

            Text in the document.

        • title (dict) –

          The title of the document.

          • highlights (list) –

            Highlights in the document text.

            • (dict) –

              Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.

              • beginOffsetInclusive (integer) –

                The offset for the start of the highlight.

              • endOffsetExclusive (integer) –

                The offset for the end of the highlight.

          • text (string) –

            Text in the document.

      • relevanceScore (float) –

        The relevance score of the results.

      • resultId (string) –

        The identifier of the result data.

      • type (string) –

        The type of the query result.

  • NextToken (string) –

    A token to resume pagination.