:doc:`QConnect <../../qconnect>` / Client / query_assistant

***************
query_assistant
***************



.. py:method:: QConnect.Client.query_assistant(**kwargs)

  

  

  .. warning::

    

    This API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024, you will need to create a new Assistant in the Amazon Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications.

    

   

  Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use `GetRecommendations <https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetRecommendations.html>`__.

  

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/qconnect-2020-10-19/QueryAssistant>`_  


  **Request Syntax**
  ::

    response = client.query_assistant(
        assistantId='string',
        queryText='string',
        nextToken='string',
        maxResults=123,
        sessionId='string',
        queryCondition=[
            {
                'single': {
                    'field': 'RESULT_TYPE',
                    'comparator': 'EQUALS',
                    'value': 'string'
                }
            },
        ],
        queryInputData={
            'queryTextInputData': {
                'text': 'string'
            },
            'intentInputData': {
                'intentId': 'string'
            },
            'caseSummarizationInputData': {
                'caseArn': 'string'
            }
        },
        overrideKnowledgeBaseSearchType='HYBRID'|'SEMANTIC'
    )
    
  :type assistantId: string
  :param assistantId: **[REQUIRED]** 

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

    

  
  :type queryText: string
  :param queryText: 

    The text to search for.

    

  
  :type nextToken: string
  :param nextToken: 

    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.

    

  
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return per page.

    

  
  :type sessionId: string
  :param sessionId: 

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

    

  
  :type queryCondition: list
  :param queryCondition: 

    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.

        

      
        - **field** *(string) --* **[REQUIRED]** 

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

          

        
        - **comparator** *(string) --* **[REQUIRED]** 

          The comparison operator for query condition to query on.

          

        
        - **value** *(string) --* **[REQUIRED]** 

          The value for the query condition to query on.

          

        
      
    

  :type queryInputData: dict
  :param queryInputData: 

    Information about the query.

    .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``queryTextInputData``, ``intentInputData``, ``caseSummarizationInputData``. 

  
    - **queryTextInputData** *(dict) --* 

      Input information for the query.

      

    
      - **text** *(string) --* **[REQUIRED]** 

        The text to search for.

        

      
    
    - **intentInputData** *(dict) --* 

      Input information for the intent.

      

    
      - **intentId** *(string) --* **[REQUIRED]** 

        The identifier of the Amazon Q intent.

        

      
    
    - **caseSummarizationInputData** *(dict) --* 

      Input data for case summarization queries.

      

    
      - **caseArn** *(string) --* **[REQUIRED]** 

        The Amazon Resource Name (ARN) of the case for summarization.

        

      
    
  
  :type overrideKnowledgeBaseSearchType: string
  :param overrideKnowledgeBaseSearchType: 

    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.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'results': [
              {
                  'resultId': 'string',
                  'document': {
                      'contentReference': {
                          'knowledgeBaseArn': 'string',
                          'knowledgeBaseId': 'string',
                          'contentArn': 'string',
                          'contentId': 'string',
                          'sourceURL': 'string',
                          'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE'|'BEDROCK_KB_S3'|'BEDROCK_KB_WEB'|'BEDROCK_KB_CONFLUENCE'|'BEDROCK_KB_SALESFORCE'|'BEDROCK_KB_SHAREPOINT'|'BEDROCK_KB_KENDRA'|'BEDROCK_KB_CUSTOM_DOCUMENT'|'BEDROCK_KB_SQL'
                      },
                      'title': {
                          'text': 'string',
                          'highlights': [
                              {
                                  'beginOffsetInclusive': 123,
                                  'endOffsetExclusive': 123
                              },
                          ]
                      },
                      'excerpt': {
                          'text': 'string',
                          'highlights': [
                              {
                                  'beginOffsetInclusive': 123,
                                  'endOffsetExclusive': 123
                              },
                          ]
                      }
                  },
                  'relevanceScore': 123.0,
                  'data': {
                      'reference': {
                          'contentReference': {
                              'knowledgeBaseArn': 'string',
                              'knowledgeBaseId': 'string',
                              'contentArn': 'string',
                              'contentId': 'string',
                              'sourceURL': 'string',
                              'referenceType': 'WEB_CRAWLER'|'KNOWLEDGE_BASE'|'BEDROCK_KB_S3'|'BEDROCK_KB_WEB'|'BEDROCK_KB_CONFLUENCE'|'BEDROCK_KB_SALESFORCE'|'BEDROCK_KB_SHAREPOINT'|'BEDROCK_KB_KENDRA'|'BEDROCK_KB_CUSTOM_DOCUMENT'|'BEDROCK_KB_SQL'
                          },
                          'generativeReference': {
                              'modelId': 'string',
                              'generationId': 'string'
                          },
                          'suggestedMessageReference': {
                              'aiAgentId': 'string',
                              'aiAgentArn': 'string'
                          }
                      },
                      'details': {
                          'contentData': {
                              'textData': {
                                  'title': {
                                      'text': 'string',
                                      'highlights': [
                                          {
                                              'beginOffsetInclusive': 123,
                                              'endOffsetExclusive': 123
                                          },
                                      ]
                                  },
                                  'excerpt': {
                                      'text': 'string',
                                      'highlights': [
                                          {
                                              'beginOffsetInclusive': 123,
                                              'endOffsetExclusive': 123
                                          },
                                      ]
                                  }
                              },
                              'rankingData': {
                                  'relevanceScore': 123.0,
                                  'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
                              }
                          },
                          'generativeData': {
                              'completion': 'string',
                              'references': [
                                  {'... recursive ...'},
                              ],
                              'rankingData': {
                                  'relevanceScore': 123.0,
                                  'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
                              }
                          },
                          'intentDetectedData': {
                              'intent': 'string',
                              'intentId': 'string',
                              'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
                          },
                          'sourceContentData': {
                              'id': 'string',
                              'type': 'KNOWLEDGE_CONTENT',
                              'textData': {
                                  'title': {
                                      'text': 'string',
                                      'highlights': [
                                          {
                                              'beginOffsetInclusive': 123,
                                              'endOffsetExclusive': 123
                                          },
                                      ]
                                  },
                                  'excerpt': {
                                      'text': 'string',
                                      'highlights': [
                                          {
                                              'beginOffsetInclusive': 123,
                                              'endOffsetExclusive': 123
                                          },
                                      ]
                                  }
                              },
                              'rankingData': {
                                  'relevanceScore': 123.0,
                                  'relevanceLevel': 'HIGH'|'MEDIUM'|'LOW'
                              },
                              'citationSpan': {
                                  'beginOffsetInclusive': 123,
                                  'endOffsetExclusive': 123
                              }
                          },
                          'generativeChunkData': {
                              'completion': 'string',
                              'references': [
                                  {'... recursive ...'},
                              ],
                              'nextChunkToken': 'string'
                          },
                          'emailResponseChunkData': {
                              'completion': 'string',
                              'nextChunkToken': 'string'
                          },
                          'emailOverviewChunkData': {
                              'completion': 'string',
                              'nextChunkToken': 'string'
                          },
                          'emailGenerativeAnswerChunkData': {
                              'completion': 'string',
                              'references': [
                                  {'... recursive ...'},
                              ],
                              'nextChunkToken': 'string'
                          },
                          'caseSummarizationChunkData': {
                              'completion': 'string',
                              'nextChunkToken': 'string'
                          },
                          'suggestedMessageData': {
                              'messageText': 'string'
                          },
                          'notesData': {
                              'completion': 'string'
                          },
                          'notesChunkData': {
                              'completion': 'string',
                              'nextChunkToken': 'string'
                          }
                      }
                  },
                  'type': 'KNOWLEDGE_CONTENT'|'INTENT_ANSWER'|'GENERATIVE_ANSWER'|'GENERATIVE_ANSWER_CHUNK'|'BLOCKED_GENERATIVE_ANSWER_CHUNK'|'INTENT_ANSWER_CHUNK'|'BLOCKED_INTENT_ANSWER_CHUNK'|'EMAIL_RESPONSE_CHUNK'|'EMAIL_OVERVIEW_CHUNK'|'EMAIL_GENERATIVE_ANSWER_CHUNK'|'CASE_SUMMARIZATION_CHUNK'|'BLOCKED_CASE_SUMMARIZATION_CHUNK'|'NOTES'|'NOTES_CHUNK'|'BLOCKED_NOTES_CHUNK'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **results** *(list) --* 

        The results of the query.

        
        

        - *(dict) --* 

          Information about the result.

          
          

          - **resultId** *(string) --* 

            The identifier of the result data.

            
          

          - **document** *(dict) --* 

            The document.

            
            

            - **contentReference** *(dict) --* 

              A reference to the content resource.

              
              

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

                
              

              - **contentArn** *(string) --* 

                The Amazon Resource Name (ARN) of the content.

                
              

              - **contentId** *(string) --* 

                The identifier of the content.

                
              

              - **sourceURL** *(string) --* 

                The web URL of the source content.

                
              

              - **referenceType** *(string) --* 

                The type of reference content.

                
          
            

            - **title** *(dict) --* 

              The title of the document.

              
              

              - **text** *(string) --* 

                Text in 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.

                    
              
            
          
            

            - **excerpt** *(dict) --* 

              The excerpt from the document.

              
              

              - **text** *(string) --* 

                Text in 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.

                    
              
            
          
        
          

          - **relevanceScore** *(float) --* 

            The relevance score of the results.

            
          

          - **data** *(dict) --* 

            Summary of the recommended 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``, ``suggestedMessageReference``.     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.

                
                

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

                  
                

                - **contentArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the content.

                  
                

                - **contentId** *(string) --* 

                  The identifier of the content.

                  
                

                - **sourceURL** *(string) --* 

                  The web URL of the source content.

                  
                

                - **referenceType** *(string) --* 

                  The type of reference content.

                  
            
              

              - **generativeReference** *(dict) --* 

                Reference information about the generative content.

                
                

                - **modelId** *(string) --* 

                  The identifier of the LLM model.

                  
                

                - **generationId** *(string) --* 

                  The identifier of the LLM model.

                  
            
              

              - **suggestedMessageReference** *(dict) --* 

                Reference information for suggested messages.

                
                

                - **aiAgentId** *(string) --* 

                  The identifier of the AI Agent that generated the suggested message.

                  
                

                - **aiAgentArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the AI Agent that generated the suggested message.

                  
            
          
            

            - **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``, ``intentDetectedData``, ``sourceContentData``, ``generativeChunkData``, ``emailResponseChunkData``, ``emailOverviewChunkData``, ``emailGenerativeAnswerChunkData``, ``caseSummarizationChunkData``, ``suggestedMessageData``, ``notesData``, ``notesChunkData``.     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.

                
                

                - **textData** *(dict) --* 

                  Details about the content text data.

                  
                  

                  - **title** *(dict) --* 

                    The text of the document.

                    
                    

                    - **text** *(string) --* 

                      Text in 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.

                          
                    
                  
                
                  

                  - **excerpt** *(dict) --* 

                    The text of the document.

                    
                    

                    - **text** *(string) --* 

                      Text in 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.

                          
                    
                  
                
              
                

                - **rankingData** *(dict) --* 

                  Details about the content ranking data.

                  
                  

                  - **relevanceScore** *(float) --* 

                    The relevance level of the recommendation.

                    
                  

                  - **relevanceLevel** *(string) --* 

                    The relevance score of the content.

                    
              
            
              

              - **generativeData** *(dict) --* 

                Details about the generative data.

                
                

                - **completion** *(string) --* 

                  The LLM response.

                  
                

                - **references** *(list) --* 

                  The references used to generative the LLM response.

                  
                  

                  - *(dict) --* 

                    Summary of the data.

                    
              
                

                - **rankingData** *(dict) --* 

                  Details about the generative content ranking data.

                  
                  

                  - **relevanceScore** *(float) --* 

                    The relevance level of the recommendation.

                    
                  

                  - **relevanceLevel** *(string) --* 

                    The relevance score of the content.

                    
              
            
              

              - **intentDetectedData** *(dict) --* 

                Details about the intent data.

                
                

                - **intent** *(string) --* 

                  The detected intent.

                  
                

                - **intentId** *(string) --* 

                  The identifier of the detected intent.

                  
                

                - **relevanceLevel** *(string) --* 

                  The relevance level of the detected intent.

                  
            
              

              - **sourceContentData** *(dict) --* 

                Details about the content data.

                
                

                - **id** *(string) --* 

                  The identifier of the source content.

                  
                

                - **type** *(string) --* 

                  The type of the source content.

                  
                

                - **textData** *(dict) --* 

                  Details about the source content text data.

                  
                  

                  - **title** *(dict) --* 

                    The text of the document.

                    
                    

                    - **text** *(string) --* 

                      Text in 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.

                          
                    
                  
                
                  

                  - **excerpt** *(dict) --* 

                    The text of the document.

                    
                    

                    - **text** *(string) --* 

                      Text in 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.

                          
                    
                  
                
              
                

                - **rankingData** *(dict) --* 

                  Details about the source content ranking data.

                  
                  

                  - **relevanceScore** *(float) --* 

                    The relevance level of the recommendation.

                    
                  

                  - **relevanceLevel** *(string) --* 

                    The relevance score of the content.

                    
              
                

                - **citationSpan** *(dict) --* 

                  Contains information about where the text with a citation begins and ends in the generated output.

                  
                  

                  - **beginOffsetInclusive** *(integer) --* 

                    Where the text with a citation starts in the generated output.

                    
                  

                  - **endOffsetExclusive** *(integer) --* 

                    Where the text with a citation ends in the generated output.

                    
              
            
              

              - **generativeChunkData** *(dict) --* 

                Details about the generative chunk data.

                
                

                - **completion** *(string) --* 

                  A chunk of the LLM response.

                  
                

                - **references** *(list) --* 

                  The references used to generate the LLM response.

                  
                  

                  - *(dict) --* 

                    Summary of the data.

                    
              
                

                - **nextChunkToken** *(string) --* 

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

                  
            
              

              - **emailResponseChunkData** *(dict) --* 

                Streaming chunk data for email response generation containing partial response content.

                
                

                - **completion** *(string) --* 

                  The partial or complete professional email response text with appropriate greetings and closings.

                  
                

                - **nextChunkToken** *(string) --* 

                  Token for retrieving the next chunk of streaming response data, if available.

                  
            
              

              - **emailOverviewChunkData** *(dict) --* 

                Streaming chunk data for email overview containing partial overview content.

                
                

                - **completion** *(string) --* 

                  The partial or complete overview text content in structured HTML format with customer issues, resolutions, and next steps.

                  
                

                - **nextChunkToken** *(string) --* 

                  Token for retrieving the next chunk of streaming overview data, if available.

                  
            
              

              - **emailGenerativeAnswerChunkData** *(dict) --* 

                Streaming chunk data for email generative answers containing partial knowledge-based response content.

                
                

                - **completion** *(string) --* 

                  The partial or complete text content of the generative answer response.

                  
                

                - **references** *(list) --* 

                  Source references and citations from knowledge base articles used to generate the answer.

                  
                  

                  - *(dict) --* 

                    Summary of the data.

                    
              
                

                - **nextChunkToken** *(string) --* 

                  Token for retrieving the next chunk of streaming response data, if available.

                  
            
              

              - **caseSummarizationChunkData** *(dict) --* 

                Details about case summarization chunk data.

                
                

                - **completion** *(string) --* 

                  A chunk of the case summarization completion.

                  
                

                - **nextChunkToken** *(string) --* 

                  Token for retrieving the next chunk of streaming summarization data, if available.

                  
            
              

              - **suggestedMessageData** *(dict) --* 

                Details about suggested message data.

                
                

                - **messageText** *(string) --* 

                  The text content of the suggested message.

                  
            
              

              - **notesData** *(dict) --* 

                Details about notes data.

                
                

                - **completion** *(string) --* 

                  The completion data for notes.

                  
            
              

              - **notesChunkData** *(dict) --* 

                Details about notes chunk data.

                
                

                - **completion** *(string) --* 

                  A chunk of the notes completion.

                  
                

                - **nextChunkToken** *(string) --* 

                  The token for the next chunk of notes data.

                  
            
          
        
          

          - **type** *(string) --* 

            The type of the query result.

            
      
    
      

      - **nextToken** *(string) --* 

        If there are additional results, this is the token for the next set of results.

        
  
  **Exceptions**
  
  *   :py:class:`QConnect.Client.exceptions.RequestTimeoutException`

  
  *   :py:class:`QConnect.Client.exceptions.ValidationException`

  
  *   :py:class:`QConnect.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`QConnect.Client.exceptions.ResourceNotFoundException`

  