Struct ClassifyDocumentInput

#[non_exhaustive]
pub struct ClassifyDocumentInput {
    pub text: Option<String>,
    pub endpoint_arn: Option<String>,
    pub bytes: Option<Blob>,
    pub document_reader_config: Option<DocumentReaderConfig>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: Option<String>

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

endpoint_arn: Option<String>

The Amazon Resource Number (ARN) of the endpoint.

For prompt safety classification, Amazon Comprehend provides the endpoint ARN. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide

For custom classification, you create an endpoint for your custom model. For more information, see Using Amazon Comprehend endpoints.

bytes: Option<Blob>

Use the Bytes parameter to input a text, PDF, Word or image file.

When you classify a document using a custom model, you can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

To classify a document using the prompt safety classifier, use the Text parameter for input.

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.

document_reader_config: Option<DocumentReaderConfig>

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

Implementations

impl ClassifyDocumentInput

pub fn text(&self) -> Option<&str>

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

pub fn endpoint_arn(&self) -> Option<&str>

The Amazon Resource Number (ARN) of the endpoint.

For prompt safety classification, Amazon Comprehend provides the endpoint ARN. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide

For custom classification, you create an endpoint for your custom model. For more information, see Using Amazon Comprehend endpoints.

pub fn bytes(&self) -> Option<&Blob>

Use the Bytes parameter to input a text, PDF, Word or image file.

When you classify a document using a custom model, you can also use the Bytes parameter to input an Amazon Textract DetectDocumentText or AnalyzeDocument output file.

To classify a document using the prompt safety classifier, use the Text parameter for input.

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.

pub fn document_reader_config(&self) -> Option<&DocumentReaderConfig>

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

impl ClassifyDocumentInput

pub fn builder() -> ClassifyDocumentInputBuilder

Creates a new builder-style object to manufacture ClassifyDocumentInput.

Trait Implementations

impl Clone for ClassifyDocumentInput

fn clone(&self) -> ClassifyDocumentInput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClassifyDocumentInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ClassifyDocumentInput

fn eq(&self, other: &ClassifyDocumentInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ClassifyDocumentInput