Class: Aws::Textract::Types::GetAdapterVersionResponse

Inherits:

Struct

• Object
• Struct
• Aws::Textract::Types::GetAdapterVersionResponse

Defined in:

gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #adapter_id ⇒ String

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

• #adapter_version ⇒ String

  A string containing the adapter version that has been retrieved.

• #creation_time ⇒ Time

  The time that the adapter version was created.

• #dataset_config ⇒ Types::AdapterVersionDatasetConfig

  Specifies a dataset used to train a new adapter version.

• #evaluation_metrics ⇒ Array<Types::AdapterVersionEvaluationMetric>

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

• #feature_types ⇒ Array<String>

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

• #kms_key_id ⇒ String

  The identifier for your AWS Key Management Service key (AWS KMS key).

• #output_config ⇒ Types::OutputConfig

  Sets whether or not your output will go to a user created bucket.

• #status ⇒ String

  The status of the adapter version that has been requested.

• #status_message ⇒ String

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

• #tags ⇒ Hash<String,String>

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

Instance Attribute Details

#adapter_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1483

class GetAdapterVersionResponse < Struct.new(
  :adapter_id,
  :adapter_version,
  :creation_time,
  :feature_types,
  :status,
  :status_message,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :evaluation_metrics,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#adapter_version ⇒ String

A string containing the adapter version that has been retrieved.

Returns:

• (String)

# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1483

class GetAdapterVersionResponse < Struct.new(
  :adapter_id,
  :adapter_version,
  :creation_time,
  :feature_types,
  :status,
  :status_message,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :evaluation_metrics,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#creation_time ⇒ Time

The time that the adapter version was created.

Returns:

• (Time)

# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1483

class GetAdapterVersionResponse < Struct.new(
  :adapter_id,
  :adapter_version,
  :creation_time,
  :feature_types,
  :status,
  :status_message,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :evaluation_metrics,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#dataset_config ⇒ Types::AdapterVersionDatasetConfig

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

Returns:

• (Types::AdapterVersionDatasetConfig)

# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1483

class GetAdapterVersionResponse < Struct.new(
  :adapter_id,
  :adapter_version,
  :creation_time,
  :feature_types,
  :status,
  :status_message,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :evaluation_metrics,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#evaluation_metrics ⇒ Array<Types::AdapterVersionEvaluationMetric>

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

Returns:

• (Array<Types::AdapterVersionEvaluationMetric>)

# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1483

class GetAdapterVersionResponse < Struct.new(
  :adapter_id,
  :adapter_version,
  :creation_time,
  :feature_types,
  :status,
  :status_message,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :evaluation_metrics,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#feature_types ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1483

class GetAdapterVersionResponse < Struct.new(
  :adapter_id,
  :adapter_version,
  :creation_time,
  :feature_types,
  :status,
  :status_message,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :evaluation_metrics,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1483

class GetAdapterVersionResponse < Struct.new(
  :adapter_id,
  :adapter_version,
  :creation_time,
  :feature_types,
  :status,
  :status_message,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :evaluation_metrics,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#output_config ⇒ Types::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.

Returns:

• (Types::OutputConfig)

# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1483

class GetAdapterVersionResponse < Struct.new(
  :adapter_id,
  :adapter_version,
  :creation_time,
  :feature_types,
  :status,
  :status_message,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :evaluation_metrics,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The status of the adapter version that has been requested.

Returns:

• (String)

# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1483

class GetAdapterVersionResponse < Struct.new(
  :adapter_id,
  :adapter_version,
  :creation_time,
  :feature_types,
  :status,
  :status_message,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :evaluation_metrics,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status_message ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1483

class GetAdapterVersionResponse < Struct.new(
  :adapter_id,
  :adapter_version,
  :creation_time,
  :feature_types,
  :status,
  :status_message,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :evaluation_metrics,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-textract/lib/aws-sdk-textract/types.rb', line 1483

class GetAdapterVersionResponse < Struct.new(
  :adapter_id,
  :adapter_version,
  :creation_time,
  :feature_types,
  :status,
  :status_message,
  :dataset_config,
  :kms_key_id,
  :output_config,
  :evaluation_metrics,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end