Textract / Client / get_adapter_version

get_adapter_version#

Textract.Client.get_adapter_version(**kwargs)#

Gets configuration information for the specified adapter version, including: AdapterId, AdapterVersion, FeatureTypes, Status, StatusMessage, DatasetConfig, KMSKeyId, OutputConfig, Tags and EvaluationMetrics.

Request Syntax

response = client.get_adapter_version(
    AdapterId='string',
    AdapterVersion='string'
)

Parameters:

AdapterId (string) –
[REQUIRED]

A string specifying a unique ID for the adapter version you want to retrieve information for.
AdapterVersion (string) –
[REQUIRED]

A string specifying the adapter version you want to retrieve information for.

Return type:

dict

Returns:

Response Syntax

{
    'AdapterId': 'string',
    'AdapterVersion': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'FeatureTypes': [
        'TABLES'|'FORMS'|'QUERIES'|'SIGNATURES'|'LAYOUT',
    ],
    'Status': 'ACTIVE'|'AT_RISK'|'DEPRECATED'|'CREATION_ERROR'|'CREATION_IN_PROGRESS',
    'StatusMessage': 'string',
    'DatasetConfig': {
        'ManifestS3Object': {
            'Bucket': 'string',
            'Name': 'string',
            'Version': 'string'
        }
    },
    'KMSKeyId': 'string',
    'OutputConfig': {
        'S3Bucket': 'string',
        'S3Prefix': 'string'
    },
    'EvaluationMetrics': [
        {
            'Baseline': {
                'F1Score': ...,
                'Precision': ...,
                'Recall': ...
            },
            'AdapterVersion': {
                'F1Score': ...,
                'Precision': ...,
                'Recall': ...
            },
            'FeatureType': 'TABLES'|'FORMS'|'QUERIES'|'SIGNATURES'|'LAYOUT'
        },
    ],
    'Tags': {
        'string': 'string'
    }
}

Response Structure

(dict) –
- AdapterId (string) –
  
  A string containing a unique ID for the adapter version being retrieved.
- AdapterVersion (string) –
  
  A string containing the adapter version that has been retrieved.
- CreationTime (datetime) –
  
  The time that the adapter version was created.
- FeatureTypes (list) –
  
  List of the targeted feature types for the requested adapter version.
  - (string) –
- Status (string) –
  
  The status of the adapter version that has been requested.
- StatusMessage (string) –
  
  A message that describes the status of the requested adapter version.
- DatasetConfig (dict) –
  
  Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.
  - ManifestS3Object (dict) –
    
    The S3 bucket name and file name that identifies the document.
    
    The AWS Region for the S3 bucket that contains the document must match the Region that you use for Amazon Textract operations.
    
    For Amazon Textract to process a file in an S3 bucket, the user must have permission to access the S3 bucket and file.
    - Bucket (string) –
      
      The name of the S3 bucket. Note that the # character is not valid in the file name.
    - Name (string) –
      
      The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF and TIFF format files.
    - Version (string) –
      
      If the bucket has versioning enabled, you can specify the object version.
- KMSKeyId (string) –
  
  The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
- OutputConfig (dict) –
  
  Sets whether or not your output will go to a user created bucket. Used to set the name of the bucket, and the prefix on the output file.
  
  OutputConfig is an optional parameter which lets you adjust where your output will be placed. By default, Amazon Textract will store the results internally and can only be accessed by the Get API operations. With OutputConfig enabled, you can set the name of the bucket the output will be sent to the file prefix of the results where you can download your results. Additionally, you can set the KMSKeyID parameter to a customer master key (CMK) to encrypt your output. Without this parameter set Amazon Textract will encrypt server-side using the AWS managed CMK for Amazon S3.
  
  Decryption of Customer Content is necessary for processing of the documents by Amazon Textract. If your account is opted out under an AI services opt out policy then all unencrypted Customer Content is immediately and permanently deleted after the Customer Content has been processed by the service. No copy of of the output is retained by Amazon Textract. For information about how to opt out, see Managing AI services opt-out policy.
  
  For more information on data privacy, see the Data Privacy FAQ.
  - S3Bucket (string) –
    
    The name of the bucket your output will go to.
  - S3Prefix (string) –
    
    The prefix of the object key that the output will be saved to. When not enabled, the prefix will be “textract_output”.
- EvaluationMetrics (list) –
  
  The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
  - (dict) –
    
    Contains information on the metrics used to evalute the peformance of a given adapter version. Includes data for baseline model performance and individual adapter version perfromance.
    - Baseline (dict) –
      
      The F1 score, precision, and recall metrics for the baseline model.
      - F1Score (float) –
        
        The F1 score for an adapter version.
      - Precision (float) –
        
        The Precision score for an adapter version.
      - Recall (float) –
        
        The Recall score for an adapter version.
    - AdapterVersion (dict) –
      
      The F1 score, precision, and recall metrics for the baseline model.
      - F1Score (float) –
        
        The F1 score for an adapter version.
      - Precision (float) –
        
        The Precision score for an adapter version.
      - Recall (float) –
        
        The Recall score for an adapter version.
    - FeatureType (string) –
      
      Indicates the feature type being analyzed by a given adapter version.
- Tags (dict) –
  
  A set of tags (key-value pairs) that are associated with the adapter version.
  - (string) –
    - (string) –

Exceptions

Textract.Client.exceptions.InvalidParameterException
Textract.Client.exceptions.AccessDeniedException
Textract.Client.exceptions.ProvisionedThroughputExceededException
Textract.Client.exceptions.InternalServerError
Textract.Client.exceptions.ThrottlingException
Textract.Client.exceptions.ValidationException
Textract.Client.exceptions.ResourceNotFoundException