Skip to content

GetAdapterVersionResponse

Source code in docs_src/capo_textract/types/get_adapter_version_response.py
class GetAdapterVersionResponse(TypedDict, closed=True):
    adapter_id: NotRequired["capo_textract.types.adapter_id.AdapterId"]
    """<p>A string containing a unique ID for the adapter version being retrieved.</p>"""
    adapter_version: NotRequired["capo_textract.types.adapter_version.AdapterVersion"]
    """<p>A string containing the adapter version that has been retrieved.</p>"""
    creation_time: NotRequired["capo_textract.types.date_time.DateTime"]
    """<p>The time that the adapter version was created.</p>"""
    feature_types: NotRequired["capo_textract.types.feature_types.FeatureTypes"]
    """<p>List of the targeted feature types for the requested adapter version.</p>"""
    status: NotRequired[
        "capo_textract.types.adapter_version_status.AdapterVersionStatus"
    ]
    """<p>The status of the adapter version that has been requested.</p>"""
    status_message: NotRequired[
        "capo_textract.types.adapter_version_status_message.AdapterVersionStatusMessage"
    ]
    """<p>A message that describes the status of the requested adapter version.</p>"""
    dataset_config: NotRequired[
        "capo_textract.types.adapter_version_dataset_config.AdapterVersionDatasetConfig"
    ]
    """<p>Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.</p>"""
    kms_key_id: NotRequired["capo_textract.types.kms_key_id.KMSKeyId"]
    """<p>The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.</p>"""
    output_config: NotRequired["capo_textract.types.output_config.OutputConfig"]
    evaluation_metrics: NotRequired[
        "capo_textract.types.adapter_version_evaluation_metrics.AdapterVersionEvaluationMetrics"
    ]
    """<p>The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.</p>"""
    tags: NotRequired["capo_textract.types.tag_map.TagMap"]
    """<p>A set of tags (key-value pairs) that are associated with the adapter version.</p>"""

adapter_id instance-attribute

adapter_id: NotRequired[AdapterId]

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

adapter_version instance-attribute

adapter_version: NotRequired[AdapterVersion]

A string containing the adapter version that has been retrieved.

creation_time instance-attribute

creation_time: NotRequired[DateTime]

The time that the adapter version was created.

dataset_config instance-attribute

dataset_config: NotRequired[AdapterVersionDatasetConfig]

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

evaluation_metrics instance-attribute

evaluation_metrics: NotRequired[AdapterVersionEvaluationMetrics]

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

feature_types instance-attribute

feature_types: NotRequired[FeatureTypes]

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

kms_key_id instance-attribute

kms_key_id: NotRequired[KMSKeyId]

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

output_config instance-attribute

output_config: NotRequired[OutputConfig]

status instance-attribute

status: NotRequired[AdapterVersionStatus]

The status of the adapter version that has been requested.

status_message instance-attribute

status_message: NotRequired[AdapterVersionStatusMessage]

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

tags instance-attribute

tags: NotRequired[TagMap]

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