Module: Aws::TranscribeStreamingService::Types

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

Defined Under Namespace

Classes: Alternative, AudioEvent, AudioStream, BadRequestException, CallAnalyticsEntity, CallAnalyticsItem, CallAnalyticsLanguageWithScore, CallAnalyticsTranscriptResultStream, CategoryEvent, ChannelDefinition, CharacterOffsets, ClinicalNoteGenerationResult, ClinicalNoteGenerationSettings, ConfigurationEvent, ConflictException, Entity, GetMedicalScribeStreamRequest, GetMedicalScribeStreamResponse, InternalFailureException, IssueDetected, Item, LanguageWithScore, LimitExceededException, MedicalAlternative, MedicalEntity, MedicalItem, MedicalResult, MedicalScribeAudioEvent, MedicalScribeChannelDefinition, MedicalScribeConfigurationEvent, MedicalScribeContext, MedicalScribeEncryptionSettings, MedicalScribeInputStream, MedicalScribePatientContext, MedicalScribePostStreamAnalyticsResult, MedicalScribePostStreamAnalyticsSettings, MedicalScribeResultStream, MedicalScribeSessionControlEvent, MedicalScribeStreamDetails, MedicalScribeTranscriptEvent, MedicalScribeTranscriptItem, MedicalScribeTranscriptSegment, MedicalTranscript, MedicalTranscriptEvent, MedicalTranscriptResultStream, PointsOfInterest, PostCallAnalyticsSettings, ResourceNotFoundException, Result, ServiceUnavailableException, StartCallAnalyticsStreamTranscriptionRequest, StartCallAnalyticsStreamTranscriptionResponse, StartMedicalScribeStreamRequest, StartMedicalScribeStreamResponse, StartMedicalStreamTranscriptionRequest, StartMedicalStreamTranscriptionResponse, StartStreamTranscriptionRequest, StartStreamTranscriptionResponse, TimestampRange, Transcript, TranscriptEvent, TranscriptResultStream, UtteranceEvent

Instance Attribute Summary collapse

Instance Attribute Details

#audio_chunk ⇒ String

An audio blob containing the next segment of audio from your application, with a maximum duration of 1 second. The maximum size in bytes varies based on audio properties.

Find recommended size in [Transcribing streaming best practices].

Size calculation: ‘Duration (s) * Sample Rate (Hz) * Number of Channels * 2 (Bytes per Sample)`

For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would be ‘1 * 16000 * 2 * 2 = 64000 bytes`.

For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be ‘1 * 8000 * 1 * 2 = 16000 bytes`.

[1]: docs.aws.amazon.com/transcribe/latest/dg/streaming.html#best-practices

Returns:

  • (String) 


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

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) 


3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 3081

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

#channel_definitions ⇒ Array<Types::MedicalScribeChannelDefinition>

Specify which speaker is on which audio channel.

Returns:



437
438
439
440
441
442
443
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 437

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

#encryption_settings ⇒ Types::MedicalScribeEncryptionSettings

Specify the encryption settings for your streaming session.

Returns:



979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 979

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :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) 


3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 3081

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:



3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 3081

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

#is_partial ⇒ Boolean

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

Returns:

  • (Boolean) 


3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 3081

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:



3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 3081

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:



3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 3081

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) 


3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 3081

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:



3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 3081

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

#matched_categories ⇒ Array<String>

Lists the categories that were matched in your audio segment.

Returns:

  • (Array<String>) 


243
244
245
246
247
248
249
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 243

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:



243
244
245
246
247
248
249
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 243

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

#medical_scribe_context ⇒ Types::MedicalScribeContext

The ‘MedicalScribeContext` object that contains contextual information used to generate customized clinical notes.

Returns:



979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 979

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

Returns:

  • (String) 


91
92
93
94
95
96
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 91

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) 


3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 3081

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

#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:



437
438
439
440
441
442
443
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 437

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

#post_stream_analytics_settings ⇒ Types::MedicalScribePostStreamAnalyticsSettings

Specify settings for post-stream analytics.

Returns:



979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 979

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#resource_access_role_arn ⇒ String

The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 output bucket you specified, and use your KMS key if supplied. If the role that you specify doesn’t have the appropriate permissions, your request fails.

IAM role ARNs have the format ‘arn:partition:iam::account:role/role-name-with-path`. For example: `arn:aws:iam::111122223333:role/Admin`.

For more information, see [Amazon Web Services HealthScribe].

[1]: docs.aws.amazon.com/transcribe/latest/dg/health-scribe-streaming.html

Returns:

  • (String) 


979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 979

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#sentiment ⇒ String

Provides the sentiment that was detected in the specified segment.

Returns:

  • (String) 


3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 3081

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) 


1434
1435
1436
1437
1438
1439
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1434

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

#transcript_segment ⇒ Types::MedicalScribeTranscriptSegment

The ‘TranscriptSegment` associated with a `MedicalScribeTranscriptEvent`.

Returns:



1284
1285
1286
1287
1288
1289
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1284

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

#type ⇒ String

The type of ‘MedicalScribeSessionControlEvent`.

Possible Values:

  • ‘END_OF_SESSION` - Indicates the audio streaming is complete. After you send an END_OF_SESSION event, Amazon Web Services HealthScribe starts the post-stream analytics. The session can’t be resumed after this event is sent. After Amazon Web Services HealthScribe processes the event, the real-time ‘StreamStatus` is `COMPLETED`. You get the `StreamStatus` and other stream details with the [GetMedicalScribeStream] API operation. For more information about different streaming statuses, see the `StreamStatus` description in the [MedicalScribeStreamDetails].

^

[1]: docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_GetMedicalScribeStream.html [2]: docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_MedicalScribeStreamDetails.html

Returns:

  • (String) 


1149
1150
1151
1152
1153
1154
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 1149

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

#utterance_id ⇒ String

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

Returns:

  • (String) 


3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 3081

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

#vocabulary_filter_method ⇒ String

Specify how you want your custom vocabulary filter applied to the streaming session.

To replace words with ‘***`, specify `mask`.

To delete words, specify ‘remove`.

To flag words without changing them, specify ‘tag`.

Returns:

  • (String) 


979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 979

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_filter_name ⇒ String

Specify the name of the custom vocabulary filter you want to include in your streaming session. Custom vocabulary filter names are case-sensitive.

If you include ‘VocabularyFilterName` in the `MedicalScribeConfigurationEvent`, you must also include `VocabularyFilterMethod`.

Returns:

  • (String) 


979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 979

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end

#vocabulary_name ⇒ String

Specify the name of the custom vocabulary you want to use for your streaming session. Custom vocabulary names are case-sensitive.

Returns:

  • (String) 


979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/aws-sdk-transcribestreamingservice/types.rb', line 979

class MedicalScribeConfigurationEvent < Struct.new(
  :vocabulary_name,
  :vocabulary_filter_name,
  :vocabulary_filter_method,
  :resource_access_role_arn,
  :channel_definitions,
  :encryption_settings,
  :post_stream_analytics_settings,
  :medical_scribe_context,
  :event_type)
  SENSITIVE = []
  include Aws::Structure
end