Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!
Get Started for Free

comprehend_describe_entity_recognizer

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on


Description

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

Usage

comprehend_describe_entity_recognizer(EntityRecognizerArn)

Arguments

EntityRecognizerArn

[required] The Amazon Resource Name (ARN) that identifies the entity recognizer.

Value

A list with the following syntax:

list(
  EntityRecognizerProperties = list(
    EntityRecognizerArn = "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",
      EntityTypes = list(
        list(
          Type = "string"
        )
      ),
      Documents = list(
        S3Uri = "string"
      ),
      Annotations = list(
        S3Uri = "string"
      ),
      EntityList = list(
        S3Uri = "string"
      ),
      AugmentedManifests = list(
        list(
          S3Uri = "string",
          AttributeNames = list(
            "string"
          )
        )
      )
    ),
    RecognizerMetadata = list(
      NumberOfTrainedDocuments = 123,
      NumberOfTestDocuments = 123,
      EvaluationMetrics = list(
        Precision = 123.0,
        Recall = 123.0,
        F1Score = 123.0
      ),
      EntityTypes = list(
        list(
          Type = "string",
          EvaluationMetrics = list(
            Precision = 123.0,
            Recall = 123.0,
            F1Score = 123.0
          ),
          NumberOfTrainMentions = 123
        )
      )
    ),
    DataAccessRoleArn = "string",
    VolumeKmsKeyId = "string",
    VpcConfig = list(
      SecurityGroupIds = list(
        "string"
      ),
      Subnets = list(
        "string"
      )
    )
  )
)

Request syntax

svc$describe_entity_recognizer(
  EntityRecognizerArn = "string"
)

paws.machine.learning

Amazon Web Services Machine Learning Services

v0.1.11
Apache License (>= 2.0)
Authors
David Kretch [aut, cre], Adam Banker [aut], Amazon.com, Inc. [cph]
Initial release

We don't support your browser anymore

Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.