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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb

Overview

Note:

When making an API call, you may pass DetectEntitiesRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[:text]

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint_arnString

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)


1369
1370
1371
1372
1373
1374
1375
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1369

class DetectEntitiesRequest < Struct.new(
  :text,
  :language_code,
  :endpoint_arn)
  SENSITIVE = [:text]
  include Aws::Structure
end

#language_codeString

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.

Returns:

  • (String)


1369
1370
1371
1372
1373
1374
1375
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1369

class DetectEntitiesRequest < Struct.new(
  :text,
  :language_code,
  :endpoint_arn)
  SENSITIVE = [:text]
  include Aws::Structure
end

#textString

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

Returns:

  • (String)


1369
1370
1371
1372
1373
1374
1375
# File 'gems/aws-sdk-comprehend/lib/aws-sdk-comprehend/types.rb', line 1369

class DetectEntitiesRequest < Struct.new(
  :text,
  :language_code,
  :endpoint_arn)
  SENSITIVE = [:text]
  include Aws::Structure
end