Struct aws_sdk_comprehend::operation::classify_document::builders::ClassifyDocumentFluentBuilder

pub struct ClassifyDocumentFluentBuilder { /* private fields */ }

Fluent builder constructing a request to ClassifyDocument.

Creates a classification request to analyze a single document in real-time. ClassifyDocument supports the following model types:

• Custom classifier - a custom model that you have created and trained. For input, you can provide plain text, a single-page document (PDF, Word, or image), or Amazon Textract API output. For more information, see Custom classification in the Amazon Comprehend Developer Guide.

• Prompt safety classifier - Amazon Comprehend provides a pre-trained model for classifying input prompts for generative AI applications. For input, you provide English plain text input. For prompt safety classification, the response includes only the Classes field. For more information about prompt safety classifiers, see Prompt safety classification in the Amazon Comprehend Developer Guide.

If the system detects errors while processing a page in the input document, the API response includes an Errors field 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 ClassifyDocumentFluentBuilder

pub fn as_input(&self) -> &ClassifyDocumentInputBuilder

Access the ClassifyDocument as a reference.

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

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 customize( self ) -> CustomizableOperation<ClassifyDocumentOutput, ClassifyDocumentError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

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.

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.

Trait Implementations

impl Clone for ClassifyDocumentFluentBuilder

fn clone(&self) -> ClassifyDocumentFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClassifyDocumentFluentBuilder

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

Formats the value using the given formatter.