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

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 2858

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :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) 


2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 2858

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

#entities ⇒ Array<Types::CallAnalyticsEntity>

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

Returns:



2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 2858

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :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



2858
2859
2860
 
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 2858

def event_type
  @event_type
end

#is_partial ⇒ Boolean

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

Returns:

  • (Boolean) 


2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 2858

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

#issues_detected ⇒ Array<Types::IssueDetected>

Provides the issue that was detected in the specified segment.

Returns:



2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 2858

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :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:



2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 2858

class UtteranceEvent < Struct.new(
  :utterance_id,
  :is_partial,
  :participant_role,
  :begin_offset_millis,
  :end_offset_millis,
  :transcript,
  :items,
  :entities,
  :sentiment,
  :issues_detected,
  :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) 


2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 2858

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

#sentiment ⇒ String

Provides the sentiment that was detected in the specified segment.

Returns:

  • (String) 


2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 2858

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

#transcript ⇒ String

Contains transcribed text.

Returns:

  • (String) 


2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 2858

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

#utterance_id ⇒ String

The unique identifier that is associated with the specified UtteranceEvent.

Returns:

  • (String) 


2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
 
# File 'gems/aws-sdk-transcribestreamingservice/lib/aws-sdk-transcribestreamingservice/types.rb', line 2858

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