Struct Entity

#[non_exhaustive]
pub struct Entity {
    pub score: Option<f32>,
    pub type: Option<EntityType>,
    pub text: Option<String>,
    pub begin_offset: Option<i32>,
    pub end_offset: Option<i32>,
    pub block_references: Option<Vec<BlockReference>>,
}

Provides information about an entity.

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.

score: Option<f32>

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

type: Option<EntityType>

The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

text: Option<String>

The text of the entity.

begin_offset: Option<i32>

The zero-based offset from the beginning of the source text to the first character in the entity.

This field is empty for non-text input.

end_offset: Option<i32>

The zero-based offset from the beginning of the source text to the last character in the entity.

This field is empty for non-text input.

block_references: Option<Vec<BlockReference>>

A reference to each block for this entity. This field is empty for plain-text input.

Implementations

impl Entity

pub fn score(&self) -> Option<f32>

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

pub fn type(&self) -> Option<&EntityType>

The entity type. For entity detection using the built-in model, this field contains one of the standard entity types listed below.

For custom entity detection, this field contains one of the entity types that you specified when you trained your custom model.

pub fn text(&self) -> Option<&str>

The text of the entity.

pub fn begin_offset(&self) -> Option<i32>

The zero-based offset from the beginning of the source text to the first character in the entity.

This field is empty for non-text input.

pub fn end_offset(&self) -> Option<i32>

The zero-based offset from the beginning of the source text to the last character in the entity.

This field is empty for non-text input.

pub fn block_references(&self) -> &[BlockReference]

A reference to each block for this entity. This field is empty for plain-text input.

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

impl Entity

pub fn builder() -> EntityBuilder

Creates a new builder-style object to manufacture Entity.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl PartialEq for Entity

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