Class: Aws::TranscribeStreamingService::Types::UtteranceEvent

Inherits:

Struct

• Object
• Struct
• Aws::TranscribeStreamingService::Types::UtteranceEvent

Defined in:

gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #begin_offset_millis ⇒ Integer

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

• #end_offset_millis ⇒ Integer

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

• #entities ⇒ Array<Types::CallAnalyticsEntity>

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

• #event_type ⇒ Object

  Returns the value of attribute event_type.

• #is_partial ⇒ Boolean

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

• #issues_detected ⇒ Array<Types::IssueDetected>

  Provides the issue that was detected in the specified segment.

• #items ⇒ Array<Types::CallAnalyticsItem>

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

• #language_code ⇒ String

  The language code that represents the language spoken in your audio stream.

• #language_identification ⇒ Array<Types::CallAnalyticsLanguageWithScore>

  The language code of the dominant language identified in your stream.

• #participant_role ⇒ String

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

• #sentiment ⇒ String

  Provides the sentiment that was detected in the specified segment.

• #transcript ⇒ String

  Contains transcribed text.

• #utterance_id ⇒ String

  The unique identifier that is associated with the specified UtteranceEvent.

Instance Attribute Details

#begin_offset_millis ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#end_offset_millis ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#entities ⇒ Array<Types::CallAnalyticsEntity>

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

Returns:

• (Array<Types::CallAnalyticsEntity>)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#event_type ⇒ Object

Returns the value of attribute event_type

Returns:

• (Object) —

  the current value of event_type

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

def event_type
  @event_type
end

#is_partial ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#issues_detected ⇒ Array<Types::IssueDetected>

Provides the issue that was detected in the specified segment.

Returns:

• (Array<Types::IssueDetected>)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#items ⇒ Array<Types::CallAnalyticsItem>

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

Returns:

• (Array<Types::CallAnalyticsItem>)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#language_code ⇒ String

The language code that represents the language spoken in your audio stream.

Returns:

• (String)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#language_identification ⇒ Array<Types::CallAnalyticsLanguageWithScore>

The language code of the dominant language identified in your stream.

Returns:

• (Array<Types::CallAnalyticsLanguageWithScore>)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#participant_role ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#sentiment ⇒ String

Provides the sentiment that was detected in the specified segment.

Returns:

• (String)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#transcript ⇒ String

Contains transcribed text.

Returns:

• (String)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#utterance_id ⇒ String

The unique identifier that is associated with the specified UtteranceEvent.

Returns:

• (String)

# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 3100

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :language_code,
  :language_identification,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end