Struct aws_sdk_comprehend::client::fluent_builders::ClassifyDocument

pub struct ClassifyDocument { /* private fields */ }

Fluent builder constructing a request to ClassifyDocument.

Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.

You can input plain text or you can upload a single-page input document (text, PDF, Word, or image).

If the system detects errors while processing a page in the input document, the API response includes an entry in Errors that describes the errors.

If the system detects a document-level error in your input document, the API returns an InvalidRequestException error response. For details about this exception, see Errors in semi-structured documents in the Comprehend Developer Guide.

Implementations

impl ClassifyDocument

pub async fn customize(
    self
) -> Result<CustomizableOperation<ClassifyDocument, AwsResponseRetryClassifier>, SdkError<ClassifyDocumentError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<ClassifyDocumentOutput, SdkError<ClassifyDocumentError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

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 endpoint_arn(self, input: impl Into<String>) -> Self

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

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

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

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

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.

pub fn set_bytes(self, input: Option<Blob>) -> Self

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.

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.

Trait Implementations

impl Clone for ClassifyDocument

fn clone(&self) -> ClassifyDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClassifyDocument

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

Formats the value using the given formatter.