Struct aws_sdk_comprehend::operation::classify_document::ClassifyDocumentOutput

#[non_exhaustive]
pub struct ClassifyDocumentOutput {
    pub classes: Option<Vec<DocumentClass>>,
    pub labels: Option<Vec<DocumentLabel>>,
    pub document_metadata: Option<DocumentMetadata>,
    pub document_type: Option<Vec<DocumentTypeListItem>>,
    pub errors: Option<Vec<ErrorsListItem>>,
    pub warnings: Option<Vec<WarningsListItem>>,
    /* private fields */
}

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.

classes: Option<Vec<DocumentClass>>

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

labels: Option<Vec<DocumentLabel>>

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

document_metadata: Option<DocumentMetadata>

Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.

document_type: Option<Vec<DocumentTypeListItem>>

The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

errors: Option<Vec<ErrorsListItem>>

Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

warnings: Option<Vec<WarningsListItem>>

Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.

The field is empty if the system generated no warnings.

Implementations

impl ClassifyDocumentOutput

pub fn classes(&self) -> Option<&[DocumentClass]>

The classes used by the document being analyzed. These are used for multi-class trained models. Individual classes are mutually exclusive and each document is expected to have only a single class assigned to it. For example, an animal can be a dog or a cat, but not both at the same time.

pub fn labels(&self) -> Option<&[DocumentLabel]>

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not mutually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

pub fn document_metadata(&self) -> Option<&DocumentMetadata>

Extraction information about the document. This field is present in the response only if your request includes the Byte parameter.

pub fn document_type(&self) -> Option<&[DocumentTypeListItem]>

The document type for each page in the input document. This field is present in the response only if your request includes the Byte parameter.

pub fn errors(&self) -> Option<&[ErrorsListItem]>

Page-level errors that the system detected while processing the input document. The field is empty if the system encountered no errors.

pub fn warnings(&self) -> Option<&[WarningsListItem]>

Warnings detected while processing the input document. The response includes a warning if there is a mismatch between the input document type and the model type associated with the endpoint that you specified. The response can also include warnings for individual pages that have a mismatch.

The field is empty if the system generated no warnings.

impl ClassifyDocumentOutput

pub fn builder() -> ClassifyDocumentOutputBuilder

Creates a new builder-style object to manufacture ClassifyDocumentOutput.

Trait Implementations

impl Clone for ClassifyDocumentOutput

fn clone(&self) -> ClassifyDocumentOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClassifyDocumentOutput

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

Formats the value using the given formatter.

impl PartialEq for ClassifyDocumentOutput

fn eq(&self, other: &ClassifyDocumentOutput) -> 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 RequestId for ClassifyDocumentOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for ClassifyDocumentOutput