comprehend_describe_document_classifier: Gets the properties associated with a document classifier

Description Usage Arguments Value Request syntax

View source: R/comprehend_operations.R

Description

Gets the properties associated with a document classifier.

Usage

1

Arguments

DocumentClassifierArn

[required] The Amazon Resource Name (ARN) that identifies the document classifier. The operation returns this identifier in its response.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
list(
  DocumentClassifierProperties = list(
    DocumentClassifierArn = "string",
    LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|"ar"|"hi"|"ja"|"ko"|"zh"|"zh-TW",
    Status = "SUBMITTED"|"TRAINING"|"DELETING"|"STOP_REQUESTED"|"STOPPED"|"IN_ERROR"|"TRAINED",
    Message = "string",
    SubmitTime = as.POSIXct(
      "2015-01-01"
    ),
    EndTime = as.POSIXct(
      "2015-01-01"
    ),
    TrainingStartTime = as.POSIXct(
      "2015-01-01"
    ),
    TrainingEndTime = as.POSIXct(
      "2015-01-01"
    ),
    InputDataConfig = list(
      DataFormat = "COMPREHEND_CSV"|"AUGMENTED_MANIFEST",
      S3Uri = "string",
      LabelDelimiter = "string",
      AugmentedManifests = list(
        list(
          S3Uri = "string",
          AttributeNames = list(
            "string"
          )
        )
      )
    ),
    OutputDataConfig = list(
      S3Uri = "string",
      KmsKeyId = "string"
    ),
    ClassifierMetadata = list(
      NumberOfLabels = 123,
      NumberOfTrainedDocuments = 123,
      NumberOfTestDocuments = 123,
      EvaluationMetrics = list(
        Accuracy = 123.0,
        Precision = 123.0,
        Recall = 123.0,
        F1Score = 123.0,
        MicroPrecision = 123.0,
        MicroRecall = 123.0,
        MicroF1Score = 123.0,
        HammingLoss = 123.0
      )
    ),
    DataAccessRoleArn = "string",
    VolumeKmsKeyId = "string",
    VpcConfig = list(
      SecurityGroupIds = list(
        "string"
      ),
      Subnets = list(
        "string"
      )
    ),
    Mode = "MULTI_CLASS"|"MULTI_LABEL"
  )
)

Request syntax

1
2
3
svc$describe_document_classifier(
  DocumentClassifierArn = "string"
)

paws.machine.learning documentation built on Aug. 23, 2021, 9:14 a.m.