aws-sdk-transcribestreamingservice 1.73.0 → 1.75.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-transcribestreamingservice/async_client.rb +263 -1
- data/lib/aws-sdk-transcribestreamingservice/client.rb +55 -1
- data/lib/aws-sdk-transcribestreamingservice/client_api.rb +189 -0
- data/lib/aws-sdk-transcribestreamingservice/endpoint_provider.rb +13 -17
- data/lib/aws-sdk-transcribestreamingservice/errors.rb +16 -0
- data/lib/aws-sdk-transcribestreamingservice/event_streams.rb +231 -6
- data/lib/aws-sdk-transcribestreamingservice/types.rb +797 -2
- data/lib/aws-sdk-transcribestreamingservice.rb +2 -2
- data/sig/client.rbs +29 -0
- data/sig/errors.rbs +3 -0
- data/sig/types.rbs +147 -0
- metadata +2 -2
@@ -48,8 +48,24 @@ module Aws::TranscribeStreamingService
|
|
48
48
|
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html
|
49
49
|
#
|
50
50
|
# @!attribute [rw] audio_chunk
|
51
|
-
# An audio blob
|
52
|
-
#
|
51
|
+
# An audio blob containing the next segment of audio from your
|
52
|
+
# application, with a maximum duration of 1 second. The maximum size
|
53
|
+
# in bytes varies based on audio properties.
|
54
|
+
#
|
55
|
+
# Find recommended size in [Transcribing streaming best practices][1].
|
56
|
+
#
|
57
|
+
# Size calculation: `Duration (s) * Sample Rate (Hz) * Number of
|
58
|
+
# Channels * 2 (Bytes per Sample)`
|
59
|
+
#
|
60
|
+
# For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio
|
61
|
+
# would be `1 * 16000 * 2 * 2 = 64000 bytes`.
|
62
|
+
#
|
63
|
+
# For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be `1 *
|
64
|
+
# 8000 * 1 * 2 = 16000 bytes`.
|
65
|
+
#
|
66
|
+
#
|
67
|
+
#
|
68
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#best-practices
|
53
69
|
# @return [String]
|
54
70
|
#
|
55
71
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/AudioEvent AWS API Documentation
|
@@ -259,6 +275,87 @@ module Aws::TranscribeStreamingService
|
|
259
275
|
include Aws::Structure
|
260
276
|
end
|
261
277
|
|
278
|
+
# The details for clinical note generation, including status, and output
|
279
|
+
# locations for clinical note and aggregated transcript if the analytics
|
280
|
+
# completed, or failure reason if the analytics failed.
|
281
|
+
#
|
282
|
+
# @!attribute [rw] clinical_note_output_location
|
283
|
+
# Holds the Amazon S3 URI for the output Clinical Note.
|
284
|
+
# @return [String]
|
285
|
+
#
|
286
|
+
# @!attribute [rw] transcript_output_location
|
287
|
+
# Holds the Amazon S3 URI for the output Transcript.
|
288
|
+
# @return [String]
|
289
|
+
#
|
290
|
+
# @!attribute [rw] status
|
291
|
+
# The status of the clinical note generation.
|
292
|
+
#
|
293
|
+
# Possible Values:
|
294
|
+
#
|
295
|
+
# * `IN_PROGRESS`
|
296
|
+
#
|
297
|
+
# * `FAILED`
|
298
|
+
#
|
299
|
+
# * `COMPLETED`
|
300
|
+
#
|
301
|
+
# After audio streaming finishes, and you send a
|
302
|
+
# `MedicalScribeSessionControlEvent` event (with END\_OF\_SESSION as
|
303
|
+
# the Type), the status is set to `IN_PROGRESS`. If the status is
|
304
|
+
# `COMPLETED`, the analytics completed successfully, and you can find
|
305
|
+
# the results at the locations specified in
|
306
|
+
# `ClinicalNoteOutputLocation` and `TranscriptOutputLocation`. If the
|
307
|
+
# status is `FAILED`, `FailureReason` provides details about the
|
308
|
+
# failure.
|
309
|
+
# @return [String]
|
310
|
+
#
|
311
|
+
# @!attribute [rw] failure_reason
|
312
|
+
# If `ClinicalNoteGenerationResult` is `FAILED`, information about why
|
313
|
+
# it failed.
|
314
|
+
# @return [String]
|
315
|
+
#
|
316
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/ClinicalNoteGenerationResult AWS API Documentation
|
317
|
+
#
|
318
|
+
class ClinicalNoteGenerationResult < Struct.new(
|
319
|
+
:clinical_note_output_location,
|
320
|
+
:transcript_output_location,
|
321
|
+
:status,
|
322
|
+
:failure_reason)
|
323
|
+
SENSITIVE = []
|
324
|
+
include Aws::Structure
|
325
|
+
end
|
326
|
+
|
327
|
+
# The output configuration for aggregated transcript and clinical note
|
328
|
+
# generation.
|
329
|
+
#
|
330
|
+
# @!attribute [rw] output_bucket_name
|
331
|
+
# The name of the Amazon S3 bucket where you want the output of Amazon
|
332
|
+
# Web Services HealthScribe post-stream analytics stored. Don't
|
333
|
+
# include the `S3://` prefix of the specified bucket.
|
334
|
+
#
|
335
|
+
# HealthScribe outputs transcript and clinical note files under the
|
336
|
+
# prefix:
|
337
|
+
# `S3://$output-bucket-name/healthscribe-streaming/session-id/post-stream-analytics/clinical-notes`
|
338
|
+
#
|
339
|
+
# The role `ResourceAccessRoleArn` specified in the
|
340
|
+
# `MedicalScribeConfigurationEvent` must have permission to use the
|
341
|
+
# specified location. You can change Amazon S3 permissions using the [
|
342
|
+
# Amazon Web Services Management Console ][1]. See also [Permissions
|
343
|
+
# Required for IAM User Roles ][2] .
|
344
|
+
#
|
345
|
+
#
|
346
|
+
#
|
347
|
+
# [1]: https://console.aws.amazon.com/s3
|
348
|
+
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user
|
349
|
+
# @return [String]
|
350
|
+
#
|
351
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/ClinicalNoteGenerationSettings AWS API Documentation
|
352
|
+
#
|
353
|
+
class ClinicalNoteGenerationSettings < Struct.new(
|
354
|
+
:output_bucket_name)
|
355
|
+
SENSITIVE = []
|
356
|
+
include Aws::Structure
|
357
|
+
end
|
358
|
+
|
262
359
|
# Allows you to set audio channel definitions and post-call analytics
|
263
360
|
# settings.
|
264
361
|
#
|
@@ -355,6 +452,31 @@ module Aws::TranscribeStreamingService
|
|
355
452
|
include Aws::Structure
|
356
453
|
end
|
357
454
|
|
455
|
+
# @!attribute [rw] session_id
|
456
|
+
# The identifier of the HealthScribe streaming session you want
|
457
|
+
# information about.
|
458
|
+
# @return [String]
|
459
|
+
#
|
460
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/GetMedicalScribeStreamRequest AWS API Documentation
|
461
|
+
#
|
462
|
+
class GetMedicalScribeStreamRequest < Struct.new(
|
463
|
+
:session_id)
|
464
|
+
SENSITIVE = []
|
465
|
+
include Aws::Structure
|
466
|
+
end
|
467
|
+
|
468
|
+
# @!attribute [rw] medical_scribe_stream_details
|
469
|
+
# Provides details about a HealthScribe streaming session.
|
470
|
+
# @return [Types::MedicalScribeStreamDetails]
|
471
|
+
#
|
472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/GetMedicalScribeStreamResponse AWS API Documentation
|
473
|
+
#
|
474
|
+
class GetMedicalScribeStreamResponse < Struct.new(
|
475
|
+
:medical_scribe_stream_details)
|
476
|
+
SENSITIVE = []
|
477
|
+
include Aws::Structure
|
478
|
+
end
|
479
|
+
|
358
480
|
# A problem occurred while processing the audio. Amazon Transcribe
|
359
481
|
# terminated processing.
|
360
482
|
#
|
@@ -658,6 +780,515 @@ module Aws::TranscribeStreamingService
|
|
658
780
|
include Aws::Structure
|
659
781
|
end
|
660
782
|
|
783
|
+
# A wrapper for your audio chunks
|
784
|
+
#
|
785
|
+
# For more information, see [Event stream encoding][1].
|
786
|
+
#
|
787
|
+
#
|
788
|
+
#
|
789
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html
|
790
|
+
#
|
791
|
+
# @!attribute [rw] audio_chunk
|
792
|
+
# An audio blob containing the next segment of audio from your
|
793
|
+
# application, with a maximum duration of 1 second. The maximum size
|
794
|
+
# in bytes varies based on audio properties.
|
795
|
+
#
|
796
|
+
# Find recommended size in [Transcribing streaming best practices][1].
|
797
|
+
#
|
798
|
+
# Size calculation: `Duration (s) * Sample Rate (Hz) * Number of
|
799
|
+
# Channels * 2 (Bytes per Sample)`
|
800
|
+
#
|
801
|
+
# For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio
|
802
|
+
# would be `1 * 16000 * 2 * 2 = 64000 bytes`.
|
803
|
+
#
|
804
|
+
# For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be `1 *
|
805
|
+
# 8000 * 1 * 2 = 16000 bytes`.
|
806
|
+
#
|
807
|
+
#
|
808
|
+
#
|
809
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#best-practices
|
810
|
+
# @return [String]
|
811
|
+
#
|
812
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeAudioEvent AWS API Documentation
|
813
|
+
#
|
814
|
+
class MedicalScribeAudioEvent < Struct.new(
|
815
|
+
:audio_chunk,
|
816
|
+
:event_type)
|
817
|
+
SENSITIVE = []
|
818
|
+
include Aws::Structure
|
819
|
+
end
|
820
|
+
|
821
|
+
# Makes it possible to specify which speaker is on which channel. For
|
822
|
+
# example, if the clinician is the first participant to speak, you would
|
823
|
+
# set the `ChannelId` of the first `ChannelDefinition` in the list to
|
824
|
+
# `0` (to indicate the first channel) and `ParticipantRole` to
|
825
|
+
# `CLINICIAN` (to indicate that it's the clinician speaking). Then you
|
826
|
+
# would set the `ChannelId` of the second `ChannelDefinition` in the
|
827
|
+
# list to `1` (to indicate the second channel) and `ParticipantRole` to
|
828
|
+
# `PATIENT` (to indicate that it's the patient speaking).
|
829
|
+
#
|
830
|
+
# If you don't specify a channel definition, HealthScribe will diarize
|
831
|
+
# the transcription and identify speaker roles for each speaker.
|
832
|
+
#
|
833
|
+
# @!attribute [rw] channel_id
|
834
|
+
# Specify the audio channel you want to define.
|
835
|
+
# @return [Integer]
|
836
|
+
#
|
837
|
+
# @!attribute [rw] participant_role
|
838
|
+
# Specify the participant that you want to flag. The allowed options
|
839
|
+
# are `CLINICIAN` and `PATIENT`.
|
840
|
+
# @return [String]
|
841
|
+
#
|
842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeChannelDefinition AWS API Documentation
|
843
|
+
#
|
844
|
+
class MedicalScribeChannelDefinition < Struct.new(
|
845
|
+
:channel_id,
|
846
|
+
:participant_role)
|
847
|
+
SENSITIVE = []
|
848
|
+
include Aws::Structure
|
849
|
+
end
|
850
|
+
|
851
|
+
# Specify details to configure the streaming session, including channel
|
852
|
+
# definitions, encryption settings, post-stream analytics settings,
|
853
|
+
# resource access role ARN and vocabulary settings.
|
854
|
+
#
|
855
|
+
# Whether you are starting a new session or resuming an existing
|
856
|
+
# session, your first event must be a `MedicalScribeConfigurationEvent`.
|
857
|
+
# If you are resuming a session, then this event must have the same
|
858
|
+
# configurations that you provided to start the session.
|
859
|
+
#
|
860
|
+
# @!attribute [rw] vocabulary_name
|
861
|
+
# Specify the name of the custom vocabulary you want to use for your
|
862
|
+
# streaming session. Custom vocabulary names are case-sensitive.
|
863
|
+
# @return [String]
|
864
|
+
#
|
865
|
+
# @!attribute [rw] vocabulary_filter_name
|
866
|
+
# Specify the name of the custom vocabulary filter you want to include
|
867
|
+
# in your streaming session. Custom vocabulary filter names are
|
868
|
+
# case-sensitive.
|
869
|
+
#
|
870
|
+
# If you include `VocabularyFilterName` in the
|
871
|
+
# `MedicalScribeConfigurationEvent`, you must also include
|
872
|
+
# `VocabularyFilterMethod`.
|
873
|
+
# @return [String]
|
874
|
+
#
|
875
|
+
# @!attribute [rw] vocabulary_filter_method
|
876
|
+
# Specify how you want your custom vocabulary filter applied to the
|
877
|
+
# streaming session.
|
878
|
+
#
|
879
|
+
# To replace words with `***`, specify `mask`.
|
880
|
+
#
|
881
|
+
# To delete words, specify `remove`.
|
882
|
+
#
|
883
|
+
# To flag words without changing them, specify `tag`.
|
884
|
+
# @return [String]
|
885
|
+
#
|
886
|
+
# @!attribute [rw] resource_access_role_arn
|
887
|
+
# The Amazon Resource Name (ARN) of an IAM role that has permissions
|
888
|
+
# to access the Amazon S3 output bucket you specified, and use your
|
889
|
+
# KMS key if supplied. If the role that you specify doesn’t have the
|
890
|
+
# appropriate permissions, your request fails.
|
891
|
+
#
|
892
|
+
# IAM role ARNs have the format
|
893
|
+
# `arn:partition:iam::account:role/role-name-with-path`. For example:
|
894
|
+
# `arn:aws:iam::111122223333:role/Admin`.
|
895
|
+
#
|
896
|
+
# For more information, see [Amazon Web Services HealthScribe][1].
|
897
|
+
#
|
898
|
+
#
|
899
|
+
#
|
900
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe-streaming.html
|
901
|
+
# @return [String]
|
902
|
+
#
|
903
|
+
# @!attribute [rw] channel_definitions
|
904
|
+
# Specify which speaker is on which audio channel.
|
905
|
+
# @return [Array<Types::MedicalScribeChannelDefinition>]
|
906
|
+
#
|
907
|
+
# @!attribute [rw] encryption_settings
|
908
|
+
# Specify the encryption settings for your streaming session.
|
909
|
+
# @return [Types::MedicalScribeEncryptionSettings]
|
910
|
+
#
|
911
|
+
# @!attribute [rw] post_stream_analytics_settings
|
912
|
+
# Specify settings for post-stream analytics.
|
913
|
+
# @return [Types::MedicalScribePostStreamAnalyticsSettings]
|
914
|
+
#
|
915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeConfigurationEvent AWS API Documentation
|
916
|
+
#
|
917
|
+
class MedicalScribeConfigurationEvent < Struct.new(
|
918
|
+
:vocabulary_name,
|
919
|
+
:vocabulary_filter_name,
|
920
|
+
:vocabulary_filter_method,
|
921
|
+
:resource_access_role_arn,
|
922
|
+
:channel_definitions,
|
923
|
+
:encryption_settings,
|
924
|
+
:post_stream_analytics_settings,
|
925
|
+
:event_type)
|
926
|
+
SENSITIVE = []
|
927
|
+
include Aws::Structure
|
928
|
+
end
|
929
|
+
|
930
|
+
# Contains encryption related settings to be used for data encryption
|
931
|
+
# with Key Management Service, including KmsEncryptionContext and
|
932
|
+
# KmsKeyId. The KmsKeyId is required, while KmsEncryptionContext is
|
933
|
+
# optional for additional layer of security.
|
934
|
+
#
|
935
|
+
# By default, Amazon Web Services HealthScribe provides encryption at
|
936
|
+
# rest to protect sensitive customer data using Amazon S3-managed keys.
|
937
|
+
# HealthScribe uses the KMS key you specify as a second layer of
|
938
|
+
# encryption.
|
939
|
+
#
|
940
|
+
# Your `ResourceAccessRoleArn` must permission to use your KMS key. For
|
941
|
+
# more information, see [Data Encryption at rest for Amazon Web Services
|
942
|
+
# HealthScribe][1].
|
943
|
+
#
|
944
|
+
#
|
945
|
+
#
|
946
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe-encryption.html
|
947
|
+
#
|
948
|
+
# @!attribute [rw] kms_encryption_context
|
949
|
+
# A map of plain text, non-secret key:value pairs, known as encryption
|
950
|
+
# context pairs, that provide an added layer of security for your
|
951
|
+
# data. For more information, see [KMSencryption context ][1] and
|
952
|
+
# [Asymmetric keys in KMS ][2].
|
953
|
+
#
|
954
|
+
#
|
955
|
+
#
|
956
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context
|
957
|
+
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html
|
958
|
+
# @return [Hash<String,String>]
|
959
|
+
#
|
960
|
+
# @!attribute [rw] kms_key_id
|
961
|
+
# The ID of the KMS key you want to use for your streaming session.
|
962
|
+
# You can specify its KMS key ID, key Amazon Resource Name (ARN),
|
963
|
+
# alias name, or alias ARN. When using an alias name, prefix it with
|
964
|
+
# `"alias/"`. To specify a KMS key in a different Amazon Web Services
|
965
|
+
# account, you must use the key ARN or alias ARN.
|
966
|
+
#
|
967
|
+
# For example:
|
968
|
+
#
|
969
|
+
# * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
|
970
|
+
#
|
971
|
+
# * Key ARN:
|
972
|
+
# arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
|
973
|
+
#
|
974
|
+
# * Alias name: alias/ExampleAlias
|
975
|
+
#
|
976
|
+
# * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias
|
977
|
+
#
|
978
|
+
# To get the key ID and key ARN for a KMS key, use the [ListKeys][1]
|
979
|
+
# or [DescribeKey][2] KMS API operations. To get the alias name and
|
980
|
+
# alias ARN, use [ListKeys][3] API operation.
|
981
|
+
#
|
982
|
+
#
|
983
|
+
#
|
984
|
+
# [1]: https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html
|
985
|
+
# [2]: https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html
|
986
|
+
# [3]: https://docs.aws.amazon.com/kms/latest/APIReference/API_ListAliases.html
|
987
|
+
# @return [String]
|
988
|
+
#
|
989
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeEncryptionSettings AWS API Documentation
|
990
|
+
#
|
991
|
+
class MedicalScribeEncryptionSettings < Struct.new(
|
992
|
+
:kms_encryption_context,
|
993
|
+
:kms_key_id)
|
994
|
+
SENSITIVE = []
|
995
|
+
include Aws::Structure
|
996
|
+
end
|
997
|
+
|
998
|
+
# Contains details for the result of post-stream analytics.
|
999
|
+
#
|
1000
|
+
# @!attribute [rw] clinical_note_generation_result
|
1001
|
+
# Provides the Clinical Note Generation result for post-stream
|
1002
|
+
# analytics.
|
1003
|
+
# @return [Types::ClinicalNoteGenerationResult]
|
1004
|
+
#
|
1005
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribePostStreamAnalyticsResult AWS API Documentation
|
1006
|
+
#
|
1007
|
+
class MedicalScribePostStreamAnalyticsResult < Struct.new(
|
1008
|
+
:clinical_note_generation_result)
|
1009
|
+
SENSITIVE = []
|
1010
|
+
include Aws::Structure
|
1011
|
+
end
|
1012
|
+
|
1013
|
+
# The settings for post-stream analytics.
|
1014
|
+
#
|
1015
|
+
# @!attribute [rw] clinical_note_generation_settings
|
1016
|
+
# Specify settings for the post-stream clinical note generation.
|
1017
|
+
# @return [Types::ClinicalNoteGenerationSettings]
|
1018
|
+
#
|
1019
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribePostStreamAnalyticsSettings AWS API Documentation
|
1020
|
+
#
|
1021
|
+
class MedicalScribePostStreamAnalyticsSettings < Struct.new(
|
1022
|
+
:clinical_note_generation_settings)
|
1023
|
+
SENSITIVE = []
|
1024
|
+
include Aws::Structure
|
1025
|
+
end
|
1026
|
+
|
1027
|
+
# Specify the lifecycle of your streaming session.
|
1028
|
+
#
|
1029
|
+
# @!attribute [rw] type
|
1030
|
+
# The type of `MedicalScribeSessionControlEvent`.
|
1031
|
+
#
|
1032
|
+
# Possible Values:
|
1033
|
+
#
|
1034
|
+
# * `END_OF_SESSION` - Indicates the audio streaming is complete.
|
1035
|
+
# After you send an END\_OF\_SESSION event, Amazon Web Services
|
1036
|
+
# HealthScribe starts the post-stream analytics. The session can't
|
1037
|
+
# be resumed after this event is sent. After Amazon Web Services
|
1038
|
+
# HealthScribe processes the event, the real-time `StreamStatus` is
|
1039
|
+
# `COMPLETED`. You get the `StreamStatus` and other stream details
|
1040
|
+
# with the [GetMedicalScribeStream][1] API operation. For more
|
1041
|
+
# information about different streaming statuses, see the
|
1042
|
+
# `StreamStatus` description in the [MedicalScribeStreamDetails][2].
|
1043
|
+
#
|
1044
|
+
# ^
|
1045
|
+
#
|
1046
|
+
#
|
1047
|
+
#
|
1048
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_GetMedicalScribeStream.html
|
1049
|
+
# [2]: https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_MedicalScribeStreamDetails.html
|
1050
|
+
# @return [String]
|
1051
|
+
#
|
1052
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeSessionControlEvent AWS API Documentation
|
1053
|
+
#
|
1054
|
+
class MedicalScribeSessionControlEvent < Struct.new(
|
1055
|
+
:type,
|
1056
|
+
:event_type)
|
1057
|
+
SENSITIVE = []
|
1058
|
+
include Aws::Structure
|
1059
|
+
end
|
1060
|
+
|
1061
|
+
# Contains details about a Amazon Web Services HealthScribe streaming
|
1062
|
+
# session.
|
1063
|
+
#
|
1064
|
+
# @!attribute [rw] session_id
|
1065
|
+
# The identifier of the HealthScribe streaming session.
|
1066
|
+
# @return [String]
|
1067
|
+
#
|
1068
|
+
# @!attribute [rw] stream_created_at
|
1069
|
+
# The date and time when the HealthScribe streaming session was
|
1070
|
+
# created.
|
1071
|
+
# @return [Time]
|
1072
|
+
#
|
1073
|
+
# @!attribute [rw] stream_ended_at
|
1074
|
+
# The date and time when the HealthScribe streaming session was ended.
|
1075
|
+
# @return [Time]
|
1076
|
+
#
|
1077
|
+
# @!attribute [rw] language_code
|
1078
|
+
# The Language Code of the HealthScribe streaming session.
|
1079
|
+
# @return [String]
|
1080
|
+
#
|
1081
|
+
# @!attribute [rw] media_sample_rate_hertz
|
1082
|
+
# The sample rate (in hertz) of the HealthScribe streaming session.
|
1083
|
+
# @return [Integer]
|
1084
|
+
#
|
1085
|
+
# @!attribute [rw] media_encoding
|
1086
|
+
# The Media Encoding of the HealthScribe streaming session.
|
1087
|
+
# @return [String]
|
1088
|
+
#
|
1089
|
+
# @!attribute [rw] vocabulary_name
|
1090
|
+
# The vocabulary name of the HealthScribe streaming session.
|
1091
|
+
# @return [String]
|
1092
|
+
#
|
1093
|
+
# @!attribute [rw] vocabulary_filter_name
|
1094
|
+
# The name of the vocabulary filter used for the HealthScribe
|
1095
|
+
# streaming session .
|
1096
|
+
# @return [String]
|
1097
|
+
#
|
1098
|
+
# @!attribute [rw] vocabulary_filter_method
|
1099
|
+
# The method of the vocabulary filter for the HealthScribe streaming
|
1100
|
+
# session.
|
1101
|
+
# @return [String]
|
1102
|
+
#
|
1103
|
+
# @!attribute [rw] resource_access_role_arn
|
1104
|
+
# The Amazon Resource Name (ARN) of the role used in the HealthScribe
|
1105
|
+
# streaming session.
|
1106
|
+
# @return [String]
|
1107
|
+
#
|
1108
|
+
# @!attribute [rw] channel_definitions
|
1109
|
+
# The Channel Definitions of the HealthScribe streaming session.
|
1110
|
+
# @return [Array<Types::MedicalScribeChannelDefinition>]
|
1111
|
+
#
|
1112
|
+
# @!attribute [rw] encryption_settings
|
1113
|
+
# The Encryption Settings of the HealthScribe streaming session.
|
1114
|
+
# @return [Types::MedicalScribeEncryptionSettings]
|
1115
|
+
#
|
1116
|
+
# @!attribute [rw] stream_status
|
1117
|
+
# The streaming status of the HealthScribe streaming session.
|
1118
|
+
#
|
1119
|
+
# Possible Values:
|
1120
|
+
#
|
1121
|
+
# * `IN_PROGRESS`
|
1122
|
+
#
|
1123
|
+
# * `PAUSED`
|
1124
|
+
#
|
1125
|
+
# * `FAILED`
|
1126
|
+
#
|
1127
|
+
# * `COMPLETED`
|
1128
|
+
#
|
1129
|
+
# <note markdown="1"> This status is specific to real-time streaming. A `COMPLETED` status
|
1130
|
+
# doesn't mean that the post-stream analytics is complete. To get
|
1131
|
+
# status of an analytics result, check the `Status` field for the
|
1132
|
+
# analytics result within the
|
1133
|
+
# `MedicalScribePostStreamAnalyticsResult`. For example, you can view
|
1134
|
+
# the status of the `ClinicalNoteGenerationResult`.
|
1135
|
+
#
|
1136
|
+
# </note>
|
1137
|
+
# @return [String]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] post_stream_analytics_settings
|
1140
|
+
# The post-stream analytics settings of the HealthScribe streaming
|
1141
|
+
# session.
|
1142
|
+
# @return [Types::MedicalScribePostStreamAnalyticsSettings]
|
1143
|
+
#
|
1144
|
+
# @!attribute [rw] post_stream_analytics_result
|
1145
|
+
# The result of post-stream analytics for the HealthScribe streaming
|
1146
|
+
# session.
|
1147
|
+
# @return [Types::MedicalScribePostStreamAnalyticsResult]
|
1148
|
+
#
|
1149
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeStreamDetails AWS API Documentation
|
1150
|
+
#
|
1151
|
+
class MedicalScribeStreamDetails < Struct.new(
|
1152
|
+
:session_id,
|
1153
|
+
:stream_created_at,
|
1154
|
+
:stream_ended_at,
|
1155
|
+
:language_code,
|
1156
|
+
:media_sample_rate_hertz,
|
1157
|
+
:media_encoding,
|
1158
|
+
:vocabulary_name,
|
1159
|
+
:vocabulary_filter_name,
|
1160
|
+
:vocabulary_filter_method,
|
1161
|
+
:resource_access_role_arn,
|
1162
|
+
:channel_definitions,
|
1163
|
+
:encryption_settings,
|
1164
|
+
:stream_status,
|
1165
|
+
:post_stream_analytics_settings,
|
1166
|
+
:post_stream_analytics_result)
|
1167
|
+
SENSITIVE = []
|
1168
|
+
include Aws::Structure
|
1169
|
+
end
|
1170
|
+
|
1171
|
+
# The event associated with `MedicalScribeResultStream`.
|
1172
|
+
#
|
1173
|
+
# Contains `MedicalScribeTranscriptSegment`, which contains segment
|
1174
|
+
# related information.
|
1175
|
+
#
|
1176
|
+
# @!attribute [rw] transcript_segment
|
1177
|
+
# The `TranscriptSegment` associated with a
|
1178
|
+
# `MedicalScribeTranscriptEvent`.
|
1179
|
+
# @return [Types::MedicalScribeTranscriptSegment]
|
1180
|
+
#
|
1181
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeTranscriptEvent AWS API Documentation
|
1182
|
+
#
|
1183
|
+
class MedicalScribeTranscriptEvent < Struct.new(
|
1184
|
+
:transcript_segment,
|
1185
|
+
:event_type)
|
1186
|
+
SENSITIVE = []
|
1187
|
+
include Aws::Structure
|
1188
|
+
end
|
1189
|
+
|
1190
|
+
# A word, phrase, or punctuation mark in your transcription output,
|
1191
|
+
# along with various associated attributes, such as confidence score,
|
1192
|
+
# type, and start and end times.
|
1193
|
+
#
|
1194
|
+
# @!attribute [rw] begin_audio_time
|
1195
|
+
# The start time, in milliseconds, of the transcribed item.
|
1196
|
+
# @return [Float]
|
1197
|
+
#
|
1198
|
+
# @!attribute [rw] end_audio_time
|
1199
|
+
# The end time, in milliseconds, of the transcribed item.
|
1200
|
+
# @return [Float]
|
1201
|
+
#
|
1202
|
+
# @!attribute [rw] type
|
1203
|
+
# The type of item identified. Options are: `PRONUNCIATION` (spoken
|
1204
|
+
# words) and `PUNCTUATION`.
|
1205
|
+
# @return [String]
|
1206
|
+
#
|
1207
|
+
# @!attribute [rw] confidence
|
1208
|
+
# The confidence score associated with a word or phrase in your
|
1209
|
+
# transcript.
|
1210
|
+
#
|
1211
|
+
# Confidence scores are values between 0 and 1. A larger value
|
1212
|
+
# indicates a higher probability that the identified item correctly
|
1213
|
+
# matches the item spoken in your media.
|
1214
|
+
# @return [Float]
|
1215
|
+
#
|
1216
|
+
# @!attribute [rw] content
|
1217
|
+
# The word, phrase or punctuation mark that was transcribed.
|
1218
|
+
# @return [String]
|
1219
|
+
#
|
1220
|
+
# @!attribute [rw] vocabulary_filter_match
|
1221
|
+
# Indicates whether the specified item matches a word in the
|
1222
|
+
# vocabulary filter included in your configuration event. If `true`,
|
1223
|
+
# there is a vocabulary filter match.
|
1224
|
+
# @return [Boolean]
|
1225
|
+
#
|
1226
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeTranscriptItem AWS API Documentation
|
1227
|
+
#
|
1228
|
+
class MedicalScribeTranscriptItem < Struct.new(
|
1229
|
+
:begin_audio_time,
|
1230
|
+
:end_audio_time,
|
1231
|
+
:type,
|
1232
|
+
:confidence,
|
1233
|
+
:content,
|
1234
|
+
:vocabulary_filter_match)
|
1235
|
+
SENSITIVE = []
|
1236
|
+
include Aws::Structure
|
1237
|
+
end
|
1238
|
+
|
1239
|
+
# Contains a set of transcription results, along with additional
|
1240
|
+
# information of the segment.
|
1241
|
+
#
|
1242
|
+
# @!attribute [rw] segment_id
|
1243
|
+
# The identifier of the segment.
|
1244
|
+
# @return [String]
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] begin_audio_time
|
1247
|
+
# The start time, in milliseconds, of the segment.
|
1248
|
+
# @return [Float]
|
1249
|
+
#
|
1250
|
+
# @!attribute [rw] end_audio_time
|
1251
|
+
# The end time, in milliseconds, of the segment.
|
1252
|
+
# @return [Float]
|
1253
|
+
#
|
1254
|
+
# @!attribute [rw] content
|
1255
|
+
# Contains transcribed text of the segment.
|
1256
|
+
# @return [String]
|
1257
|
+
#
|
1258
|
+
# @!attribute [rw] items
|
1259
|
+
# Contains words, phrases, or punctuation marks in your segment.
|
1260
|
+
# @return [Array<Types::MedicalScribeTranscriptItem>]
|
1261
|
+
#
|
1262
|
+
# @!attribute [rw] is_partial
|
1263
|
+
# Indicates if the segment is complete.
|
1264
|
+
#
|
1265
|
+
# If `IsPartial` is `true`, the segment is not complete. If
|
1266
|
+
# `IsPartial` is `false`, the segment is complete.
|
1267
|
+
# @return [Boolean]
|
1268
|
+
#
|
1269
|
+
# @!attribute [rw] channel_id
|
1270
|
+
# Indicates which audio channel is associated with the
|
1271
|
+
# `MedicalScribeTranscriptSegment`.
|
1272
|
+
#
|
1273
|
+
# If `MedicalScribeChannelDefinition` is not provided in the
|
1274
|
+
# `MedicalScribeConfigurationEvent`, then this field will not be
|
1275
|
+
# included.
|
1276
|
+
# @return [String]
|
1277
|
+
#
|
1278
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeTranscriptSegment AWS API Documentation
|
1279
|
+
#
|
1280
|
+
class MedicalScribeTranscriptSegment < Struct.new(
|
1281
|
+
:segment_id,
|
1282
|
+
:begin_audio_time,
|
1283
|
+
:end_audio_time,
|
1284
|
+
:content,
|
1285
|
+
:items,
|
1286
|
+
:is_partial,
|
1287
|
+
:channel_id)
|
1288
|
+
SENSITIVE = []
|
1289
|
+
include Aws::Structure
|
1290
|
+
end
|
1291
|
+
|
661
1292
|
# The `MedicalTranscript` associated with a `.</p> MedicalTranscript
|
662
1293
|
# contains Results, which contains a set of transcription results from
|
663
1294
|
# one or more audio segments, along with additional information per your
|
@@ -818,6 +1449,19 @@ module Aws::TranscribeStreamingService
|
|
818
1449
|
include Aws::Structure
|
819
1450
|
end
|
820
1451
|
|
1452
|
+
# The request references a resource which doesn't exist.
|
1453
|
+
#
|
1454
|
+
# @!attribute [rw] message
|
1455
|
+
# @return [String]
|
1456
|
+
#
|
1457
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/ResourceNotFoundException AWS API Documentation
|
1458
|
+
#
|
1459
|
+
class ResourceNotFoundException < Struct.new(
|
1460
|
+
:message)
|
1461
|
+
SENSITIVE = []
|
1462
|
+
include Aws::Structure
|
1463
|
+
end
|
1464
|
+
|
821
1465
|
# The `Result` associated with a ``.
|
822
1466
|
#
|
823
1467
|
# Contains a set of transcription results from one or more audio
|
@@ -1212,6 +1856,104 @@ module Aws::TranscribeStreamingService
|
|
1212
1856
|
include Aws::Structure
|
1213
1857
|
end
|
1214
1858
|
|
1859
|
+
# @!attribute [rw] session_id
|
1860
|
+
# Specify an identifier for your streaming session (in UUID format).
|
1861
|
+
# If you don't include a SessionId in your request, Amazon Web
|
1862
|
+
# Services HealthScribe generates an ID and returns it in the
|
1863
|
+
# response.
|
1864
|
+
# @return [String]
|
1865
|
+
#
|
1866
|
+
# @!attribute [rw] language_code
|
1867
|
+
# Specify the language code for your HealthScribe streaming session.
|
1868
|
+
# @return [String]
|
1869
|
+
#
|
1870
|
+
# @!attribute [rw] media_sample_rate_hertz
|
1871
|
+
# Specify the sample rate of the input audio (in hertz). Amazon Web
|
1872
|
+
# Services HealthScribe supports a range from 16,000 Hz to 48,000 Hz.
|
1873
|
+
# The sample rate you specify must match that of your audio.
|
1874
|
+
# @return [Integer]
|
1875
|
+
#
|
1876
|
+
# @!attribute [rw] media_encoding
|
1877
|
+
# Specify the encoding used for the input audio.
|
1878
|
+
#
|
1879
|
+
# Supported formats are:
|
1880
|
+
#
|
1881
|
+
# * FLAC
|
1882
|
+
#
|
1883
|
+
# * OPUS-encoded audio in an Ogg container
|
1884
|
+
#
|
1885
|
+
# * PCM (only signed 16-bit little-endian audio formats, which does
|
1886
|
+
# not include WAV)
|
1887
|
+
#
|
1888
|
+
# For more information, see [Media formats][1].
|
1889
|
+
#
|
1890
|
+
#
|
1891
|
+
#
|
1892
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
|
1893
|
+
# @return [String]
|
1894
|
+
#
|
1895
|
+
# @!attribute [rw] input_stream
|
1896
|
+
# Specify the input stream where you will send events in real time.
|
1897
|
+
#
|
1898
|
+
# The first element of the input stream must be a
|
1899
|
+
# `MedicalScribeConfigurationEvent`.
|
1900
|
+
# @return [Types::MedicalScribeInputStream]
|
1901
|
+
#
|
1902
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartMedicalScribeStreamRequest AWS API Documentation
|
1903
|
+
#
|
1904
|
+
class StartMedicalScribeStreamRequest < Struct.new(
|
1905
|
+
:session_id,
|
1906
|
+
:language_code,
|
1907
|
+
:media_sample_rate_hertz,
|
1908
|
+
:media_encoding,
|
1909
|
+
:input_stream)
|
1910
|
+
SENSITIVE = []
|
1911
|
+
include Aws::Structure
|
1912
|
+
end
|
1913
|
+
|
1914
|
+
# @!attribute [rw] session_id
|
1915
|
+
# The identifier (in UUID format) for your streaming session.
|
1916
|
+
#
|
1917
|
+
# If you already started streaming, this is same ID as the one you
|
1918
|
+
# specified in your initial `StartMedicalScribeStreamRequest`.
|
1919
|
+
# @return [String]
|
1920
|
+
#
|
1921
|
+
# @!attribute [rw] request_id
|
1922
|
+
# The unique identifier for your streaming request.
|
1923
|
+
# @return [String]
|
1924
|
+
#
|
1925
|
+
# @!attribute [rw] language_code
|
1926
|
+
# The Language Code that you specified in your request. Same as
|
1927
|
+
# provided in the `StartMedicalScribeStreamRequest`.
|
1928
|
+
# @return [String]
|
1929
|
+
#
|
1930
|
+
# @!attribute [rw] media_sample_rate_hertz
|
1931
|
+
# The sample rate (in hertz) that you specified in your request. Same
|
1932
|
+
# as provided in the `StartMedicalScribeStreamRequest`
|
1933
|
+
# @return [Integer]
|
1934
|
+
#
|
1935
|
+
# @!attribute [rw] media_encoding
|
1936
|
+
# The Media Encoding you specified in your request. Same as provided
|
1937
|
+
# in the `StartMedicalScribeStreamRequest`
|
1938
|
+
# @return [String]
|
1939
|
+
#
|
1940
|
+
# @!attribute [rw] result_stream
|
1941
|
+
# The result stream where you will receive the output events.
|
1942
|
+
# @return [Types::MedicalScribeResultStream]
|
1943
|
+
#
|
1944
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartMedicalScribeStreamResponse AWS API Documentation
|
1945
|
+
#
|
1946
|
+
class StartMedicalScribeStreamResponse < Struct.new(
|
1947
|
+
:session_id,
|
1948
|
+
:request_id,
|
1949
|
+
:language_code,
|
1950
|
+
:media_sample_rate_hertz,
|
1951
|
+
:media_encoding,
|
1952
|
+
:result_stream)
|
1953
|
+
SENSITIVE = []
|
1954
|
+
include Aws::Structure
|
1955
|
+
end
|
1956
|
+
|
1215
1957
|
# @!attribute [rw] language_code
|
1216
1958
|
# Specify the language code that represents the language spoken in
|
1217
1959
|
# your audio.
|
@@ -2164,6 +2906,59 @@ module Aws::TranscribeStreamingService
|
|
2164
2906
|
|
2165
2907
|
end
|
2166
2908
|
|
2909
|
+
# An encoded stream of events. The stream is encoded as HTTP/2 data
|
2910
|
+
# frames.
|
2911
|
+
#
|
2912
|
+
# An input stream consists of the following types of events. The first
|
2913
|
+
# element of the input stream must be the
|
2914
|
+
# `MedicalScribeConfigurationEvent` event type.
|
2915
|
+
#
|
2916
|
+
# * `MedicalScribeConfigurationEvent`
|
2917
|
+
#
|
2918
|
+
# * `MedicalScribeAudioEvent`
|
2919
|
+
#
|
2920
|
+
# * `MedicalScribeSessionControlEvent`
|
2921
|
+
#
|
2922
|
+
# EventStream is an Enumerator of Events.
|
2923
|
+
# #event_types #=> Array, returns all modeled event types in the stream
|
2924
|
+
#
|
2925
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeInputStream AWS API Documentation
|
2926
|
+
#
|
2927
|
+
class MedicalScribeInputStream < Enumerator
|
2928
|
+
|
2929
|
+
def event_types
|
2930
|
+
[
|
2931
|
+
:audio_event,
|
2932
|
+
:session_control_event,
|
2933
|
+
:configuration_event
|
2934
|
+
]
|
2935
|
+
end
|
2936
|
+
|
2937
|
+
end
|
2938
|
+
|
2939
|
+
# Result stream where you will receive the output events. The details
|
2940
|
+
# are provided in the `MedicalScribeTranscriptEvent` object.
|
2941
|
+
#
|
2942
|
+
# EventStream is an Enumerator of Events.
|
2943
|
+
# #event_types #=> Array, returns all modeled event types in the stream
|
2944
|
+
#
|
2945
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalScribeResultStream AWS API Documentation
|
2946
|
+
#
|
2947
|
+
class MedicalScribeResultStream < Enumerator
|
2948
|
+
|
2949
|
+
def event_types
|
2950
|
+
[
|
2951
|
+
:transcript_event,
|
2952
|
+
:bad_request_exception,
|
2953
|
+
:limit_exceeded_exception,
|
2954
|
+
:internal_failure_exception,
|
2955
|
+
:conflict_exception,
|
2956
|
+
:service_unavailable_exception
|
2957
|
+
]
|
2958
|
+
end
|
2959
|
+
|
2960
|
+
end
|
2961
|
+
|
2167
2962
|
# Contains detailed information about your streaming session.
|
2168
2963
|
#
|
2169
2964
|
# EventStream is an Enumerator of Events.
|