Struct DetectEntitiesOutput

#[non_exhaustive]
pub struct DetectEntitiesOutput {
    pub entities: Option<Vec<Entity>>,
    pub document_metadata: Option<DocumentMetadata>,
    pub document_type: Option<Vec<DocumentTypeListItem>>,
    pub blocks: Option<Vec<Block>>,
    pub errors: Option<Vec<ErrorsListItem>>,
    /* 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.

entities: 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.

document_metadata: 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.

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 used the Byte parameter.

blocks: 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.

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.

Implementations

impl DetectEntitiesOutput

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .entities.is_none().

pub fn 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) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .document_type.is_none().

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .blocks.is_none().

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

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .errors.is_none().

impl DetectEntitiesOutput

pub fn builder() -> DetectEntitiesOutputBuilder

Creates a new builder-style object to manufacture DetectEntitiesOutput.

Trait Implementations

impl Clone for DetectEntitiesOutput

fn clone(&self) -> DetectEntitiesOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DetectEntitiesOutput

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

Formats the value using the given formatter.

impl PartialEq for DetectEntitiesOutput

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

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

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 RequestId for DetectEntitiesOutput

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

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

impl StructuralPartialEq for DetectEntitiesOutput