Module: Aws::TranscribeStreamingService::Types

Defined in:
lib/aws-sdk-transcribestreamingservice/types.rb

Defined Under Namespace

Classes: Alternative, AudioEvent, AudioStream, BadRequestException, CallAnalyticsEntity, CallAnalyticsItem, CallAnalyticsTranscriptResultStream, CategoryEvent, ChannelDefinition, CharacterOffsets, ConfigurationEvent, ConflictException, Entity, InternalFailureException, IssueDetected, Item, LanguageWithScore, LimitExceededException, MedicalAlternative, MedicalEntity, MedicalItem, MedicalResult, MedicalTranscript, MedicalTranscriptEvent, MedicalTranscriptResultStream, PointsOfInterest, PostCallAnalyticsSettings, Result, ServiceUnavailableException, StartCallAnalyticsStreamTranscriptionRequest, StartCallAnalyticsStreamTranscriptionResponse, StartMedicalStreamTranscriptionRequest, StartMedicalStreamTranscriptionResponse, StartStreamTranscriptionRequest, StartStreamTranscriptionResponse, TimestampRange, Transcript, TranscriptEvent, TranscriptResultStream, UtteranceEvent

Instance Attribute Summary collapse

Instance Attribute Details

#audio_chunk ⇒ String

An audio blob that contains the next part of the audio that you want to transcribe. The maximum audio chunk size is 32 KB.

Returns:

  • (String) 


57
58
59
60
61
62
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 57

class AudioEvent < Struct.new(
  :audio_chunk,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#begin_offset_millis ⇒ Integer

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

Returns:

  • (Integer) 


2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 2101

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

#channel_definitions ⇒ Array<Types::ChannelDefinition>

Indicates which speaker is on which audio channel.

Returns:



285
286
287
288
289
290
291
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 285

class ConfigurationEvent < Struct.new(
  :channel_definitions,
  :post_call_analytics_settings,
  :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) 


2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 2101

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:



2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 2101

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

#is_partial ⇒ Boolean

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

Returns:

  • (Boolean) 


2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 2101

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:



2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 2101

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:



2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 2101

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

#matched_categories ⇒ Array<String>

Lists the categories that were matched in your audio segment.

Returns:

  • (Array<String>) 


205
206
207
208
209
210
211
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 205

class CategoryEvent < Struct.new(
  :matched_categories,
  :matched_details,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#matched_details ⇒ Hash<String,Types::PointsOfInterest>

Contains information about the matched categories, including category names and timestamps.

Returns:



205
206
207
208
209
210
211
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 205

class CategoryEvent < Struct.new(
  :matched_categories,
  :matched_details,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

Returns:

  • (String) 


75
76
77
78
79
80
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 75

class BadRequestException < Struct.new(
  :message,
  :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) 


2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 2101

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

#post_call_analytics_settings ⇒ Types::PostCallAnalyticsSettings

Provides additional optional settings for your Call Analytics post-call request, including encryption and output locations for your redacted transcript.

‘PostCallAnalyticsSettings` provides you with the same insights as a Call Analytics post-call transcription. Refer to [Post-call analytics] for more information on this feature.

[1]: docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html

Returns:



285
286
287
288
289
290
291
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 285

class ConfigurationEvent < Struct.new(
  :channel_definitions,
  :post_call_analytics_settings,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#sentiment ⇒ String

Provides the sentiment that was detected in the specified segment.

Returns:

  • (String) 


2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 2101

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) 


702
703
704
705
706
707
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 702

class MedicalTranscriptEvent < Struct.new(
  :transcript,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#utterance_id ⇒ String

The unique identifier that is associated with the specified ‘UtteranceEvent`.

Returns:

  • (String) 


2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 2101

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