You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Comprehend::Types::DetectEntitiesRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DetectEntitiesRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  text: "CustomerInputString", # required
  language_code: "en", # accepts en, es, fr, de, it, pt, ar, hi, ja, ko, zh, zh-TW
  endpoint_arn: "EntityRecognizerEndpointArn",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint_arn ⇒ String

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

Returns:

  • (String) —

    The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model.

#language_code ⇒ String

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

Possible values:

  • en
  • es
  • fr
  • de
  • it
  • pt
  • ar
  • hi
  • ja
  • ko
  • zh
  • zh-TW

Returns:

  • (String) —

    The language of the input documents.

#text ⇒ String

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

Returns:

  • (String) —

    A UTF-8 text string.