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

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:text]

Instance Attribute Summary collapse

Instance Attribute Details

#bytes ⇒ String

This field applies only when you use a custom entity recognition model that was trained with PDF annotations. For other cases, enter your text input in the ‘Text` field.

Use the ‘Bytes` parameter to input a text, PDF, Word or image file. Using a plain-text file in the `Bytes` parameter is equivelent to using the `Text` parameter (the `Entities` field in the response is identical).

You can also use the ‘Bytes` parameter to input an Amazon Textract `DetectDocumentText` or `AnalyzeDocument` output file.

Provide the input document as a sequence of base64-encoded bytes. If your code uses an Amazon Web Services SDK to detect entities, the SDK may encode the document file bytes for you.

The maximum length of this field depends on the input document type. For details, see [ Inputs for real-time custom analysis] in the Comprehend Developer Guide.

If you use the ‘Bytes` parameter, do not use the `Text` parameter.

[1]: docs.aws.amazon.com/comprehend/latest/dg/idp-inputs-sync.html

Returns:

  • (String) 


2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-comprehend/types.rb', line 2427

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

#document_reader_config ⇒ Types::DocumentReaderConfig

Provides configuration parameters to override the default actions for extracting text from PDF documents and image files.

Returns:



2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-comprehend/types.rb', line 2427

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

#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.

For information about endpoints, see [Managing endpoints].

[1]: docs.aws.amazon.com/comprehend/latest/dg/manage-endpoints.html

Returns:

  • (String) 


2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-comprehend/types.rb', line 2427

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

#language_code ⇒ String

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. 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.

All input documents must be in the same language.

Returns:

  • (String) 


2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-comprehend/types.rb', line 2427

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

#text ⇒ String

A UTF-8 text string. The maximum string size is 100 KB. If you enter text using this parameter, do not use the ‘Bytes` parameter.

Returns:

  • (String) 


2427
2428
2429
2430
2431
2432
2433
2434
2435
 
# File 'lib/aws-sdk-comprehend/types.rb', line 2427

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