Struct aws_sdk_comprehend::model::PiiEntity

#[non_exhaustive]
pub struct PiiEntity {
    pub score: Option<f32>,
    pub type: Option<PiiEntityType>,
    pub begin_offset: Option<i32>,
    pub end_offset: Option<i32>,
}

Provides information about a PII 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<PiiEntityType>

The entity's type.

begin_offset: Option<i32>

A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

end_offset: Option<i32>

A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

Implementations

impl PiiEntity

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<&PiiEntityType>

The entity's type.

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

A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

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

A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

impl PiiEntity

pub fn builder() -> Builder

Creates a new builder-style object to manufacture PiiEntity

Trait Implementations

impl Clone for PiiEntity

fn clone(&self) -> PiiEntity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PiiEntity

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

Formats the value using the given formatter.

impl PartialEq<PiiEntity> for PiiEntity

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for PiiEntity