Struct aws_sdk_comprehend::operation::classify_document::builders::ClassifyDocumentOutputBuilder

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

A builder for ClassifyDocumentOutput.

Implementations

impl ClassifyDocumentOutputBuilder

pub fn classes(self, input: DocumentClass) -> Self

Appends an item to classes.

To override the contents of this collection use set_classes.

The classes used by the document being analyzed. These are used for models trained in multi-class mode. 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.

For prompt safety classification, the response includes only two classes (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class. The value range of the score is zero to one, where one is the highest confidence.

pub fn set_classes(self, input: Option<Vec<DocumentClass>>) -> Self

The classes used by the document being analyzed. These are used for models trained in multi-class mode. 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.

For prompt safety classification, the response includes only two classes (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class. The value range of the score is zero to one, where one is the highest confidence.

pub fn get_classes(&self) -> &Option<Vec<DocumentClass>>

The classes used by the document being analyzed. These are used for models trained in multi-class mode. 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.

For prompt safety classification, the response includes only two classes (SAFE_PROMPT and UNSAFE_PROMPT), along with a confidence score for each class. The value range of the score is zero to one, where one is the highest confidence.

pub fn labels(self, input: DocumentLabel) -> Self

Appends an item to labels.

To override the contents of this collection use set_labels.

The labels used in 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 set_labels(self, input: Option<Vec<DocumentLabel>>) -> Self

The labels used in 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 get_labels(&self) -> &Option<Vec<DocumentLabel>>

The labels used in 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, input: DocumentMetadata) -> Self

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

pub fn set_document_metadata(self, input: Option<DocumentMetadata>) -> Self

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

pub fn get_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, input: DocumentTypeListItem) -> Self

Appends an item to document_type.

To override the contents of this collection use set_document_type.

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 set_document_type(self, input: Option<Vec<DocumentTypeListItem>>) -> Self

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

pub fn errors(self, input: ErrorsListItem) -> Self

Appends an item to errors.

To override the contents of this collection use set_errors.

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

pub fn set_errors(self, input: Option<Vec<ErrorsListItem>>) -> Self

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

pub fn get_errors(&self) -> &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.

pub fn warnings(self, input: WarningsListItem) -> Self

Appends an item to warnings.

To override the contents of this collection use set_warnings.

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.

pub fn set_warnings(self, input: Option<Vec<WarningsListItem>>) -> Self

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.

pub fn get_warnings(&self) -> &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.

pub fn build(self) -> ClassifyDocumentOutput

Consumes the builder and constructs a ClassifyDocumentOutput.

Trait Implementations

impl Clone for ClassifyDocumentOutputBuilder

fn clone(&self) -> ClassifyDocumentOutputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClassifyDocumentOutputBuilder

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

Formats the value using the given formatter.

impl Default for ClassifyDocumentOutputBuilder

fn default() -> ClassifyDocumentOutputBuilder

Returns the “default value” for a type.

impl PartialEq for ClassifyDocumentOutputBuilder

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