Struct aws_sdk_transcribestreaming::types::Entity

#[non_exhaustive]
pub struct Entity {
    pub start_time: f64,
    pub end_time: f64,
    pub category: Option<String>,
    pub type: Option<String>,
    pub content: Option<String>,
    pub confidence: Option<f64>,
}

Contains entities identified as personally identifiable information (PII) in your transcription output, along with various associated attributes. Examples include category, confidence score, type, stability score, and start and end times.

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.

start_time: f64

The start time, in milliseconds, of the utterance that was identified as PII.

end_time: f64

The end time, in milliseconds, of the utterance that was identified as PII.

category: Option<String>

The category of information identified. The only category is PII.

type: Option<String>

The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER.

content: Option<String>

The word or words identified as PII.

confidence: Option<f64>

The confidence score associated with the identified PII entity in your audio.

Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified entity correctly matches the entity spoken in your media.

Implementations

impl Entity

pub fn start_time(&self) -> f64

The start time, in milliseconds, of the utterance that was identified as PII.

pub fn end_time(&self) -> f64

The end time, in milliseconds, of the utterance that was identified as PII.

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

The category of information identified. The only category is PII.

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

The type of PII identified. For example, NAME or CREDIT_DEBIT_NUMBER.

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

The word or words identified as PII.

pub fn confidence(&self) -> Option<f64>

The confidence score associated with the identified PII entity in your audio.

Confidence scores are values between 0 and 1. A larger value indicates a higher probability that the identified entity correctly matches the entity spoken in your media.

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 copy of the value.

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

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 Entity