Skip to content

Get Adapter Version

textract_get_adapter_version R Documentation

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

Description

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

Usage

textract_get_adapter_version(AdapterId, AdapterVersion)

Arguments

AdapterId

[required] A string specifying a unique ID for the adapter version you want to retrieve information for.

AdapterVersion

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

Value

A list with the following syntax:

list(
  AdapterId = "string",
  AdapterVersion = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  FeatureTypes = list(
    "TABLES"|"FORMS"|"QUERIES"|"SIGNATURES"|"LAYOUT"
  ),
  Status = "ACTIVE"|"AT_RISK"|"DEPRECATED"|"CREATION_ERROR"|"CREATION_IN_PROGRESS",
  StatusMessage = "string",
  DatasetConfig = list(
    ManifestS3Object = list(
      Bucket = "string",
      Name = "string",
      Version = "string"
    )
  ),
  KMSKeyId = "string",
  OutputConfig = list(
    S3Bucket = "string",
    S3Prefix = "string"
  ),
  EvaluationMetrics = list(
    list(
      Baseline = list(
        F1Score = 123.0,
        Precision = 123.0,
        Recall = 123.0
      ),
      AdapterVersion = list(
        F1Score = 123.0,
        Precision = 123.0,
        Recall = 123.0
      ),
      FeatureType = "TABLES"|"FORMS"|"QUERIES"|"SIGNATURES"|"LAYOUT"
    )
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$get_adapter_version(
  AdapterId = "string",
  AdapterVersion = "string"
)