/AWS1/CL_TEXGETADAPTERVRSRSP

GetAdapterVersionResponse

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_adapterid TYPE /AWS1/TEXADAPTERID /AWS1/TEXADAPTERID

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

iv_adapterversion TYPE /AWS1/TEXADAPTERVERSION /AWS1/TEXADAPTERVERSION

A string containing the adapter version that has been retrieved.

iv_creationtime TYPE /AWS1/TEXDATETIME /AWS1/TEXDATETIME

The time that the adapter version was created.

it_featuretypes TYPE /AWS1/CL_TEXFEATURETYPES_W=>TT_FEATURETYPES TT_FEATURETYPES

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

iv_status TYPE /AWS1/TEXADAPTERVERSIONSTATUS /AWS1/TEXADAPTERVERSIONSTATUS

The status of the adapter version that has been requested.

iv_statusmessage TYPE /AWS1/TEXADAPTERVRSSTATUSMSG /AWS1/TEXADAPTERVRSSTATUSMSG

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

io_datasetconfig TYPE REF TO /AWS1/CL_TEXADAPTERVRSDSCONFIG /AWS1/CL_TEXADAPTERVRSDSCONFIG

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

iv_kmskeyid TYPE /AWS1/TEXKMSKEYID /AWS1/TEXKMSKEYID

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

io_outputconfig TYPE REF TO /AWS1/CL_TEXOUTPUTCONFIG /AWS1/CL_TEXOUTPUTCONFIG

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.

it_evaluationmetrics TYPE /AWS1/CL_TEXADAPTERVRSEVALME00=>TT_ADAPTERVERSIONEVALMETRICS TT_ADAPTERVERSIONEVALMETRICS

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

it_tags TYPE /AWS1/CL_TEXTAGMAP_W=>TT_TAGMAP TT_TAGMAP

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

---

Queryable Attributes

AdapterId

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

Accessible with the following methods

Method	Description
GET_ADAPTERID()	Getter for ADAPTERID, with configurable default
ASK_ADAPTERID()	Getter for ADAPTERID w/ exceptions if field has no value
HAS_ADAPTERID()	Determine if ADAPTERID has a value

AdapterVersion

A string containing the adapter version that has been retrieved.

Accessible with the following methods

Method	Description
GET_ADAPTERVERSION()	Getter for ADAPTERVERSION, with configurable default
ASK_ADAPTERVERSION()	Getter for ADAPTERVERSION w/ exceptions if field has no valu
HAS_ADAPTERVERSION()	Determine if ADAPTERVERSION has a value

CreationTime

The time that the adapter version was created.

Accessible with the following methods

Method	Description
GET_CREATIONTIME()	Getter for CREATIONTIME, with configurable default
ASK_CREATIONTIME()	Getter for CREATIONTIME w/ exceptions if field has no value
HAS_CREATIONTIME()	Determine if CREATIONTIME has a value

FeatureTypes

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

Accessible with the following methods

Method	Description
GET_FEATURETYPES()	Getter for FEATURETYPES, with configurable default
ASK_FEATURETYPES()	Getter for FEATURETYPES w/ exceptions if field has no value
HAS_FEATURETYPES()	Determine if FEATURETYPES has a value

Status

The status of the adapter version that has been requested.

Accessible with the following methods

Method	Description
GET_STATUS()	Getter for STATUS, with configurable default
ASK_STATUS()	Getter for STATUS w/ exceptions if field has no value
HAS_STATUS()	Determine if STATUS has a value

StatusMessage

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

Accessible with the following methods

Method	Description
GET_STATUSMESSAGE()	Getter for STATUSMESSAGE, with configurable default
ASK_STATUSMESSAGE()	Getter for STATUSMESSAGE w/ exceptions if field has no value
HAS_STATUSMESSAGE()	Determine if STATUSMESSAGE has a value

DatasetConfig

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

Accessible with the following methods

Method	Description
GET_DATASETCONFIG()	Getter for DATASETCONFIG

KMSKeyId

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

Accessible with the following methods

Method	Description
GET_KMSKEYID()	Getter for KMSKEYID, with configurable default
ASK_KMSKEYID()	Getter for KMSKEYID w/ exceptions if field has no value
HAS_KMSKEYID()	Determine if KMSKEYID has a value

OutputConfig

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.

Accessible with the following methods

Method	Description
GET_OUTPUTCONFIG()	Getter for OUTPUTCONFIG

EvaluationMetrics

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

Accessible with the following methods

Method	Description
GET_EVALUATIONMETRICS()	Getter for EVALUATIONMETRICS, with configurable default
ASK_EVALUATIONMETRICS()	Getter for EVALUATIONMETRICS w/ exceptions if field has no v
HAS_EVALUATIONMETRICS()	Determine if EVALUATIONMETRICS has a value

Tags

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

Accessible with the following methods

Method	Description
GET_TAGS()	Getter for TAGS, with configurable default
ASK_TAGS()	Getter for TAGS w/ exceptions if field has no value
HAS_TAGS()	Determine if TAGS has a value