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

comprehend_create_entity_recognizer

Creates an entity recognizer using submitted files


Description

Creates an entity recognizer using submitted files. After your create_entity_recognizer request is submitted, you can check job status using the API.

Usage

comprehend_create_entity_recognizer(RecognizerName, DataAccessRoleArn,
  Tags, InputDataConfig, ClientRequestToken, LanguageCode, VolumeKmsKeyId,
  VpcConfig)

Arguments

RecognizerName

[required] The name given to the newly created recognizer. Recognizer names can be a maximum of 256 characters. Alphanumeric characters, hyphens (-) and underscores (_) are allowed. The name must be unique in the account/region.

DataAccessRoleArn

[required] The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

Tags

Tags to be associated with the entity recognizer being created. A tag is a key-value pair that adds as a metadata to a resource used by Amazon Comprehend. For example, a tag with "Sales" as the key might be added to a resource to indicate its use by the sales department.

InputDataConfig

[required] Specifies the format and location of the input data. The S3 bucket containing the input data must be located in the same region as the entity recognizer being created.

ClientRequestToken

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

LanguageCode

[required] You can specify any of the following languages supported by Amazon Comprehend: English ("en"), Spanish ("es"), French ("fr"), Italian ("it"), German ("de"), or Portuguese ("pt"). All documents must be in the same language.

VolumeKmsKeyId

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

  • KMS Key ID: "1234abcd-12ab-34cd-56ef-1234567890ab"

  • Amazon Resource Name (ARN) of a KMS Key: "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

VpcConfig

Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.

Value

A list with the following syntax:

list(
  EntityRecognizerArn = "string"
)

Request syntax

svc$create_entity_recognizer(
  RecognizerName = "string",
  DataAccessRoleArn = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  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"
        )
      )
    )
  ),
  ClientRequestToken = "string",
  LanguageCode = "en"|"es"|"fr"|"de"|"it"|"pt"|"ar"|"hi"|"ja"|"ko"|"zh"|"zh-TW",
  VolumeKmsKeyId = "string",
  VpcConfig = list(
    SecurityGroupIds = list(
      "string"
    ),
    Subnets = list(
      "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.