:doc:`Textract <../../textract>` / Client / create_adapter

**************
create_adapter
**************



.. py:method:: Textract.Client.create_adapter(**kwargs)

  

  Creates an adapter, which can be fine-tuned for enhanced performance on user provided documents. Takes an AdapterName and FeatureType. Currently the only supported feature type is ``QUERIES``. You can also provide a Description, Tags, and a ClientRequestToken. You can choose whether or not the adapter should be AutoUpdated with the AutoUpdate argument. By default, AutoUpdate is set to DISABLED.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/textract-2018-06-27/CreateAdapter>`_  


  **Request Syntax**
  ::

    response = client.create_adapter(
        AdapterName='string',
        ClientRequestToken='string',
        Description='string',
        FeatureTypes=[
            'TABLES'|'FORMS'|'QUERIES'|'SIGNATURES'|'LAYOUT',
        ],
        AutoUpdate='ENABLED'|'DISABLED',
        Tags={
            'string': 'string'
        }
    )
    
  :type AdapterName: string
  :param AdapterName: **[REQUIRED]** 

    The name to be assigned to the adapter being created.

    

  
  :type ClientRequestToken: string
  :param ClientRequestToken: 

    Idempotent token is used to recognize the request. If the same token is used with multiple CreateAdapter requests, the same session is returned. This token is employed to avoid unintentionally creating the same session multiple times.

    This field is autopopulated if not provided.

  
  :type Description: string
  :param Description: 

    The description to be assigned to the adapter being created.

    

  
  :type FeatureTypes: list
  :param FeatureTypes: **[REQUIRED]** 

    The type of feature that the adapter is being trained on. Currrenly, supported feature types are: ``QUERIES``

    

  
    - *(string) --* 

    

  :type AutoUpdate: string
  :param AutoUpdate: 

    Controls whether or not the adapter should automatically update.

    

  
  :type Tags: dict
  :param Tags: 

    A list of tags to be added to the adapter.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    
    ::

      {
          'AdapterId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AdapterId** *(string) --* 

        A string containing the unique ID for the adapter that has been created.

        
  
  **Exceptions**
  
  *   :py:class:`Textract.Client.exceptions.InvalidParameterException`

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

  
  *   :py:class:`Textract.Client.exceptions.ConflictException`

  
  *   :py:class:`Textract.Client.exceptions.ProvisionedThroughputExceededException`

  
  *   :py:class:`Textract.Client.exceptions.InternalServerError`

  
  *   :py:class:`Textract.Client.exceptions.IdempotentParameterMismatchException`

  
  *   :py:class:`Textract.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Textract.Client.exceptions.LimitExceededException`

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

  
  *   :py:class:`Textract.Client.exceptions.ServiceQuotaExceededException`

  