:doc:`Comprehend <../../comprehend>` / Client / batch_detect_key_phrases

************************
batch_detect_key_phrases
************************



.. py:method:: Comprehend.Client.batch_detect_key_phrases(**kwargs)

  

  Detects the key noun phrases found in a batch of documents.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/BatchDetectKeyPhrases>`_  


  **Request Syntax**
  ::

    response = client.batch_detect_key_phrases(
        TextList=[
            'string',
        ],
        LanguageCode='en'|'es'|'fr'|'de'|'it'|'pt'|'ar'|'hi'|'ja'|'ko'|'zh'|'zh-TW'
    )
    
  :type TextList: list
  :param TextList: **[REQUIRED]** 

    A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

    

  
    - *(string) --* 

    

  :type LanguageCode: string
  :param LanguageCode: **[REQUIRED]** 

    The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

    

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

    
    ::

      {
          'ResultList': [
              {
                  'Index': 123,
                  'KeyPhrases': [
                      {
                          'Score': ...,
                          'Text': 'string',
                          'BeginOffset': 123,
                          'EndOffset': 123
                      },
                  ]
              },
          ],
          'ErrorList': [
              {
                  'Index': 123,
                  'ErrorCode': 'string',
                  'ErrorMessage': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ResultList** *(list) --* 

        A list of objects containing the results of the operation. The results are sorted in ascending order by the ``Index`` field and match the order of the documents in the input list. If all of the documents contain an error, the ``ResultList`` is empty.

        
        

        - *(dict) --* 

          The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.

          
          

          - **Index** *(integer) --* 

            The zero-based index of the document in the input list.

            
          

          - **KeyPhrases** *(list) --* 

            One or more  KeyPhrase objects, one for each key phrase detected in the document.

            
            

            - *(dict) --* 

              Describes a key noun phrase.

              
              

              - **Score** *(float) --* 

                The level of confidence that Amazon Comprehend has in the accuracy of the detection.

                
              

              - **Text** *(string) --* 

                The text of a key noun phrase.

                
              

              - **BeginOffset** *(integer) --* 

                The zero-based offset from the beginning of the source text to the first character in the key phrase.

                
              

              - **EndOffset** *(integer) --* 

                The zero-based offset from the beginning of the source text to the last character in the key phrase.

                
          
        
      
    
      

      - **ErrorList** *(list) --* 

        A list containing one object for each document that contained an error. The results are sorted in ascending order by the ``Index`` field and match the order of the documents in the input list. If there are no errors in the batch, the ``ErrorList`` is empty.

        
        

        - *(dict) --* 

          Describes an error that occurred while processing a document in a batch. The operation returns on ``BatchItemError`` object for each document that contained an error.

          
          

          - **Index** *(integer) --* 

            The zero-based index of the document in the input list.

            
          

          - **ErrorCode** *(string) --* 

            The numeric error code of the error.

            
          

          - **ErrorMessage** *(string) --* 

            A text description of the error.

            
      
    
  
  **Exceptions**
  
  *   :py:class:`Comprehend.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`Comprehend.Client.exceptions.TextSizeLimitExceededException`

  
  *   :py:class:`Comprehend.Client.exceptions.UnsupportedLanguageException`

  
  *   :py:class:`Comprehend.Client.exceptions.BatchSizeLimitExceededException`

  
  *   :py:class:`Comprehend.Client.exceptions.InternalServerException`

  