Struct DetectEntitiesOutputBuilder

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

A builder for DetectEntitiesOutput.

Implementations

impl DetectEntitiesOutputBuilder

pub fn entities(self, input: Entity) -> Self

Appends an item to entities.

To override the contents of this collection use set_entities.

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.

pub fn set_entities(self, input: Option<Vec<Entity>>) -> Self

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.

pub fn get_entities(&self) -> &Option<Vec<Entity>>

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.

pub fn document_metadata(self, input: DocumentMetadata) -> Self

Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.

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

Information about the document, discovered during text extraction. This field is present in the response only if your request used the Byte parameter.

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

Information about the document, discovered during text extraction. This field is present in the response only if your request used 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 used 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 used 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 used the Byte parameter.

pub fn blocks(self, input: Block) -> Self

Appends an item to blocks.

To override the contents of this collection use set_blocks.

Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.

The Block content for a Word input document does not include a Geometry field.

The Block field is not present in the response for plain-text inputs.

pub fn set_blocks(self, input: Option<Vec<Block>>) -> Self

Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.

The Block content for a Word input document does not include a Geometry field.

The Block field is not present in the response for plain-text inputs.

pub fn get_blocks(&self) -> &Option<Vec<Block>>

Information about each block of text in the input document. Blocks are nested. A page block contains a block for each line of text, which contains a block for each word.

The Block content for a Word input document does not include a Geometry field.

The Block field is not present in the response for plain-text inputs.

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 build(self) -> DetectEntitiesOutput

Consumes the builder and constructs a DetectEntitiesOutput.

Trait Implementations

impl Clone for DetectEntitiesOutputBuilder

fn clone(&self) -> DetectEntitiesOutputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DetectEntitiesOutputBuilder

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

Formats the value using the given formatter.

impl Default for DetectEntitiesOutputBuilder

fn default() -> DetectEntitiesOutputBuilder

Returns the “default value” for a type.

impl PartialEq for DetectEntitiesOutputBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for DetectEntitiesOutputBuilder