Struct aws_sdk_comprehend::operation::classify_document::builders::ClassifyDocumentInputBuilder

#[non_exhaustive]
pub struct ClassifyDocumentInputBuilder { /* private fields */ }

A builder for ClassifyDocumentInput.

Implementations

impl ClassifyDocumentInputBuilder

pub fn text(self, input: impl Into<String>) -> Self

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

pub fn set_text(self, input: Option<String>) -> Self

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

pub fn get_text(&self) -> &Option<String>

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

pub fn endpoint_arn(self, input: impl Into<String>) -> Self

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.

This field is required.

pub fn set_endpoint_arn(self, input: Option<String>) -> Self

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 get_endpoint_arn(&self) -> &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.

pub fn bytes(self, input: Blob) -> Self

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 set_bytes(self, input: Option<Blob>) -> Self

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 get_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, input: DocumentReaderConfig) -> Self

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

pub fn set_document_reader_config( self, input: Option<DocumentReaderConfig> ) -> Self

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

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

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

pub fn build(self) -> Result<ClassifyDocumentInput, BuildError>

Consumes the builder and constructs a ClassifyDocumentInput.

impl ClassifyDocumentInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<ClassifyDocumentOutput, SdkError<ClassifyDocumentError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for ClassifyDocumentInputBuilder

fn clone(&self) -> ClassifyDocumentInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClassifyDocumentInputBuilder

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

Formats the value using the given formatter.

impl Default for ClassifyDocumentInputBuilder

fn default() -> ClassifyDocumentInputBuilder

Returns the “default value” for a type.

impl PartialEq for ClassifyDocumentInputBuilder

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ClassifyDocumentInputBuilder