AWSTextractGetAdapterVersionResponse

Objective-C

@interface AWSTextractGetAdapterVersionResponse

Swift

class AWSTextractGetAdapterVersionResponse

  • A string containing a unique ID for the adapter version being retrieved.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable adapterId;

    Swift

    var adapterId: String? { get set }

  • A string containing the adapter version that has been retrieved.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable adapterVersion;

    Swift

    var adapterVersion: String? { get set }

  • The time that the adapter version was created.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable creationTime;

    Swift

    var creationTime: Date? { get set }

  • Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTextractAdapterVersionDatasetConfig *_Nullable datasetConfig;

    Swift

    var datasetConfig: AWSTextractAdapterVersionDatasetConfig? { get set }

  • The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSTextractAdapterVersionEvaluationMetric *> *_Nullable evaluationMetrics;

    Swift

    var evaluationMetrics: [AWSTextractAdapterVersionEvaluationMetric]? { get set }

  • List of the targeted feature types for the requested adapter version.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable featureTypes;

    Swift

    var featureTypes: [String]? { get set }

  • The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable KMSKeyId;

    Swift

    var kmsKeyId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSTextractOutputConfig *_Nullable outputConfig;

    Swift

    var outputConfig: AWSTextractOutputConfig? { get set }

  • The status of the adapter version that has been requested.

    Declaration

    Objective-C

    @property (nonatomic) AWSTextractAdapterVersionStatus status;

    Swift

    var status: AWSTextractAdapterVersionStatus { get set }

  • A message that describes the status of the requested adapter version.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable statusMessage;

    Swift

    var statusMessage: String? { get set }

  • A set of tags (key-value pairs) that are associated with the adapter version.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDictionary<NSString *, NSString *> *_Nullable tags;

    Swift

    var tags: [String : String]? { get set }