Struct aws_sdk_transcribestreaming::types::UtteranceEvent

#[non_exhaustive]
pub struct UtteranceEvent {
    pub utterance_id: Option<String>,
    pub is_partial: bool,
    pub participant_role: Option<ParticipantRole>,
    pub begin_offset_millis: Option<i64>,
    pub end_offset_millis: Option<i64>,
    pub transcript: Option<String>,
    pub items: Option<Vec<CallAnalyticsItem>>,
    pub entities: Option<Vec<CallAnalyticsEntity>>,
    pub sentiment: Option<Sentiment>,
    pub issues_detected: Option<Vec<IssueDetected>>,
}

Contains set of transcription results from one or more audio segments, along with additional information about the parameters included in your request. For example, channel definitions, partial result stabilization, sentiment, and issue detection.

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.

utterance_id: Option<String>

The unique identifier that is associated with the specified UtteranceEvent.

is_partial: bool

Indicates whether the segment in the UtteranceEvent is complete (FALSE) or partial (TRUE).

participant_role: Option<ParticipantRole>

Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.

begin_offset_millis: Option<i64>

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

end_offset_millis: Option<i64>

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

transcript: Option<String>

Contains transcribed text.

items: Option<Vec<CallAnalyticsItem>>

Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.

entities: Option<Vec<CallAnalyticsEntity>>

Contains entities identified as personally identifiable information (PII) in your transcription output.

sentiment: Option<Sentiment>

Provides the sentiment that was detected in the specified segment.

issues_detected: Option<Vec<IssueDetected>>

Provides the issue that was detected in the specified segment.

Implementations

impl UtteranceEvent

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

The unique identifier that is associated with the specified UtteranceEvent.

pub fn is_partial(&self) -> bool

Indicates whether the segment in the UtteranceEvent is complete (FALSE) or partial (TRUE).

pub fn participant_role(&self) -> Option<&ParticipantRole>

Provides the role of the speaker for each audio channel, either CUSTOMER or AGENT.

pub fn begin_offset_millis(&self) -> Option<i64>

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

pub fn end_offset_millis(&self) -> Option<i64>

The time, in milliseconds, from the beginning of the audio stream to the start of the UtteranceEvent.

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

Contains transcribed text.

pub fn items(&self) -> &[CallAnalyticsItem]

Contains words, phrases, or punctuation marks that are associated with the specified UtteranceEvent.

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

pub fn entities(&self) -> &[CallAnalyticsEntity]

Contains entities identified as personally identifiable information (PII) in your transcription output.

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 sentiment(&self) -> Option<&Sentiment>

Provides the sentiment that was detected in the specified segment.

pub fn issues_detected(&self) -> &[IssueDetected]

Provides the issue that was detected in the specified segment.

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

impl UtteranceEvent

pub fn builder() -> UtteranceEventBuilder

Creates a new builder-style object to manufacture UtteranceEvent.

Trait Implementations

impl Clone for UtteranceEvent

fn clone(&self) -> UtteranceEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UtteranceEvent

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

Formats the value using the given formatter.

impl PartialEq for UtteranceEvent

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