Class: Aws::Comprehend::Types::ClassifyDocumentRequest

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

Use the ‘Bytes` parameter to input a text, PDF, Word or image file. 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 classify documents, 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) 


816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-comprehend/types.rb', line 816

class ClassifyDocumentRequest < Struct.new(
  :text,
  :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:



816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-comprehend/types.rb', line 816

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

#endpoint_arn ⇒ String

The Amazon Resource Number (ARN) of the endpoint. For information about endpoints, see [Managing endpoints].

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

Returns:

  • (String) 


816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-comprehend/types.rb', line 816

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

#text ⇒ String

The document text to be analyzed. If you enter text using this parameter, do not use the ‘Bytes` parameter.

Returns:

  • (String) 


816
817
818
819
820
821
822
823
 
# File 'lib/aws-sdk-comprehend/types.rb', line 816

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