aws-sdk-transcribeservice 1.125.0 → 1.127.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-transcribeservice/client.rb +15 -3
- data/lib/aws-sdk-transcribeservice/client_api.rb +11 -0
- data/lib/aws-sdk-transcribeservice/types.rb +47 -3
- data/lib/aws-sdk-transcribeservice.rb +1 -1
- data/sig/client.rbs +6 -1
- data/sig/types.rbs +12 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 212c1b14f98e639d20fd3be11e7abec5df4d626870d72d9d4184ab247e6d9736
|
4
|
+
data.tar.gz: 5cde5e4ea03afbab9da47e721d8a6e9b42f10480536155d541cafbee88292d48
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 22cbbb198f9342e430e2fd44262eb8bc10e76463f7991d2df28977b2bd3194ad77f5a5f162a4bbe744c5b7392fb3cb5b5750bfe6b2554692470963b32d9e9b2e
|
7
|
+
data.tar.gz: e46687fbb7f1217524b5871f4234d44d7bf09d80d8bdfab20282f08a87841209a8aed4094f7a2964aa6d6975307b449efd339975438766f0065e9acb9bda04ec
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.127.0 (2025-08-12)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - AWS HealthScribe now supports specifying preferred patient pronouns through the MedicalScribeContext parameter for use in the generated clinical notes.
|
8
|
+
|
9
|
+
1.126.0 (2025-08-08)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Update documentation to use key ARN only in OutputEncryptionKMSKeyId request parameter
|
13
|
+
|
4
14
|
1.125.0 (2025-08-04)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.127.0
|
@@ -1700,6 +1700,7 @@ module Aws::TranscribeService
|
|
1700
1700
|
# resp.medical_scribe_job.channel_definitions #=> Array
|
1701
1701
|
# resp.medical_scribe_job.channel_definitions[0].channel_id #=> Integer
|
1702
1702
|
# resp.medical_scribe_job.channel_definitions[0].participant_role #=> String, one of "PATIENT", "CLINICIAN"
|
1703
|
+
# resp.medical_scribe_job.medical_scribe_context_provided #=> Boolean
|
1703
1704
|
# resp.medical_scribe_job.tags #=> Array
|
1704
1705
|
# resp.medical_scribe_job.tags[0].key #=> String
|
1705
1706
|
# resp.medical_scribe_job.tags[0].value #=> String
|
@@ -3001,7 +3002,7 @@ module Aws::TranscribeService
|
|
3001
3002
|
# * `OutputBucketName`: The Amazon S3 bucket where you want your output
|
3002
3003
|
# files stored.
|
3003
3004
|
#
|
3004
|
-
# * `Settings`: A `MedicalScribeSettings`
|
3005
|
+
# * `Settings`: A `MedicalScribeSettings` object that must set exactly
|
3005
3006
|
# one of `ShowSpeakerLabels` or `ChannelIdentification` to true. If
|
3006
3007
|
# `ShowSpeakerLabels` is true, `MaxSpeakerLabels` must also be set.
|
3007
3008
|
#
|
@@ -3135,7 +3136,7 @@ module Aws::TranscribeService
|
|
3135
3136
|
#
|
3136
3137
|
# @option params [Array<Types::Tag>] :tags
|
3137
3138
|
# Adds one or more custom tags, each in the form of a key:value pair, to
|
3138
|
-
# the
|
3139
|
+
# the Medical Scribe job.
|
3139
3140
|
#
|
3140
3141
|
# To learn more about using tags with Amazon Transcribe, refer to
|
3141
3142
|
# [Tagging resources][1].
|
@@ -3144,6 +3145,11 @@ module Aws::TranscribeService
|
|
3144
3145
|
#
|
3145
3146
|
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
|
3146
3147
|
#
|
3148
|
+
# @option params [Types::MedicalScribeContext] :medical_scribe_context
|
3149
|
+
# The `MedicalScribeContext` object that contains contextual information
|
3150
|
+
# which is used during clinical note generation to add relevant context
|
3151
|
+
# to the note.
|
3152
|
+
#
|
3147
3153
|
# @return [Types::StartMedicalScribeJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3148
3154
|
#
|
3149
3155
|
# * {Types::StartMedicalScribeJobResponse#medical_scribe_job #medical_scribe_job} => Types::MedicalScribeJob
|
@@ -3185,6 +3191,11 @@ module Aws::TranscribeService
|
|
3185
3191
|
# value: "TagValue", # required
|
3186
3192
|
# },
|
3187
3193
|
# ],
|
3194
|
+
# medical_scribe_context: {
|
3195
|
+
# patient_context: {
|
3196
|
+
# pronouns: "HE_HIM", # accepts HE_HIM, SHE_HER, THEY_THEM
|
3197
|
+
# },
|
3198
|
+
# },
|
3188
3199
|
# })
|
3189
3200
|
#
|
3190
3201
|
# @example Response structure
|
@@ -3211,6 +3222,7 @@ module Aws::TranscribeService
|
|
3211
3222
|
# resp.medical_scribe_job.channel_definitions #=> Array
|
3212
3223
|
# resp.medical_scribe_job.channel_definitions[0].channel_id #=> Integer
|
3213
3224
|
# resp.medical_scribe_job.channel_definitions[0].participant_role #=> String, one of "PATIENT", "CLINICIAN"
|
3225
|
+
# resp.medical_scribe_job.medical_scribe_context_provided #=> Boolean
|
3214
3226
|
# resp.medical_scribe_job.tags #=> Array
|
3215
3227
|
# resp.medical_scribe_job.tags[0].key #=> String
|
3216
3228
|
# resp.medical_scribe_job.tags[0].value #=> String
|
@@ -4572,7 +4584,7 @@ module Aws::TranscribeService
|
|
4572
4584
|
tracer: tracer
|
4573
4585
|
)
|
4574
4586
|
context[:gem_name] = 'aws-sdk-transcribeservice'
|
4575
|
-
context[:gem_version] = '1.
|
4587
|
+
context[:gem_version] = '1.127.0'
|
4576
4588
|
Seahorse::Client::Request.new(handlers, context)
|
4577
4589
|
end
|
4578
4590
|
|
@@ -129,6 +129,7 @@ module Aws::TranscribeService
|
|
129
129
|
MedicalScribeChannelDefinition = Shapes::StructureShape.new(name: 'MedicalScribeChannelDefinition')
|
130
130
|
MedicalScribeChannelDefinitions = Shapes::ListShape.new(name: 'MedicalScribeChannelDefinitions')
|
131
131
|
MedicalScribeChannelId = Shapes::IntegerShape.new(name: 'MedicalScribeChannelId')
|
132
|
+
MedicalScribeContext = Shapes::StructureShape.new(name: 'MedicalScribeContext')
|
132
133
|
MedicalScribeJob = Shapes::StructureShape.new(name: 'MedicalScribeJob')
|
133
134
|
MedicalScribeJobStatus = Shapes::StringShape.new(name: 'MedicalScribeJobStatus')
|
134
135
|
MedicalScribeJobSummaries = Shapes::ListShape.new(name: 'MedicalScribeJobSummaries')
|
@@ -137,6 +138,7 @@ module Aws::TranscribeService
|
|
137
138
|
MedicalScribeNoteTemplate = Shapes::StringShape.new(name: 'MedicalScribeNoteTemplate')
|
138
139
|
MedicalScribeOutput = Shapes::StructureShape.new(name: 'MedicalScribeOutput')
|
139
140
|
MedicalScribeParticipantRole = Shapes::StringShape.new(name: 'MedicalScribeParticipantRole')
|
141
|
+
MedicalScribePatientContext = Shapes::StructureShape.new(name: 'MedicalScribePatientContext')
|
140
142
|
MedicalScribeSettings = Shapes::StructureShape.new(name: 'MedicalScribeSettings')
|
141
143
|
MedicalTranscript = Shapes::StructureShape.new(name: 'MedicalTranscript')
|
142
144
|
MedicalTranscriptionJob = Shapes::StructureShape.new(name: 'MedicalTranscriptionJob')
|
@@ -160,6 +162,7 @@ module Aws::TranscribeService
|
|
160
162
|
Phrases = Shapes::ListShape.new(name: 'Phrases')
|
161
163
|
PiiEntityType = Shapes::StringShape.new(name: 'PiiEntityType')
|
162
164
|
PiiEntityTypes = Shapes::ListShape.new(name: 'PiiEntityTypes')
|
165
|
+
Pronouns = Shapes::StringShape.new(name: 'Pronouns')
|
163
166
|
RedactionOutput = Shapes::StringShape.new(name: 'RedactionOutput')
|
164
167
|
RedactionType = Shapes::StringShape.new(name: 'RedactionType')
|
165
168
|
RelativeTimeRange = Shapes::StructureShape.new(name: 'RelativeTimeRange')
|
@@ -642,6 +645,9 @@ module Aws::TranscribeService
|
|
642
645
|
|
643
646
|
MedicalScribeChannelDefinitions.member = Shapes::ShapeRef.new(shape: MedicalScribeChannelDefinition)
|
644
647
|
|
648
|
+
MedicalScribeContext.add_member(:patient_context, Shapes::ShapeRef.new(shape: MedicalScribePatientContext, location_name: "PatientContext"))
|
649
|
+
MedicalScribeContext.struct_class = Types::MedicalScribeContext
|
650
|
+
|
645
651
|
MedicalScribeJob.add_member(:medical_scribe_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, location_name: "MedicalScribeJobName"))
|
646
652
|
MedicalScribeJob.add_member(:medical_scribe_job_status, Shapes::ShapeRef.new(shape: MedicalScribeJobStatus, location_name: "MedicalScribeJobStatus"))
|
647
653
|
MedicalScribeJob.add_member(:language_code, Shapes::ShapeRef.new(shape: MedicalScribeLanguageCode, location_name: "LanguageCode"))
|
@@ -654,6 +660,7 @@ module Aws::TranscribeService
|
|
654
660
|
MedicalScribeJob.add_member(:settings, Shapes::ShapeRef.new(shape: MedicalScribeSettings, location_name: "Settings"))
|
655
661
|
MedicalScribeJob.add_member(:data_access_role_arn, Shapes::ShapeRef.new(shape: DataAccessRoleArn, location_name: "DataAccessRoleArn"))
|
656
662
|
MedicalScribeJob.add_member(:channel_definitions, Shapes::ShapeRef.new(shape: MedicalScribeChannelDefinitions, location_name: "ChannelDefinitions"))
|
663
|
+
MedicalScribeJob.add_member(:medical_scribe_context_provided, Shapes::ShapeRef.new(shape: Boolean, location_name: "MedicalScribeContextProvided"))
|
657
664
|
MedicalScribeJob.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
658
665
|
MedicalScribeJob.struct_class = Types::MedicalScribeJob
|
659
666
|
|
@@ -672,6 +679,9 @@ module Aws::TranscribeService
|
|
672
679
|
MedicalScribeOutput.add_member(:clinical_document_uri, Shapes::ShapeRef.new(shape: Uri, required: true, location_name: "ClinicalDocumentUri"))
|
673
680
|
MedicalScribeOutput.struct_class = Types::MedicalScribeOutput
|
674
681
|
|
682
|
+
MedicalScribePatientContext.add_member(:pronouns, Shapes::ShapeRef.new(shape: Pronouns, location_name: "Pronouns"))
|
683
|
+
MedicalScribePatientContext.struct_class = Types::MedicalScribePatientContext
|
684
|
+
|
675
685
|
MedicalScribeSettings.add_member(:show_speaker_labels, Shapes::ShapeRef.new(shape: Boolean, location_name: "ShowSpeakerLabels"))
|
676
686
|
MedicalScribeSettings.add_member(:max_speaker_labels, Shapes::ShapeRef.new(shape: MaxSpeakers, location_name: "MaxSpeakerLabels"))
|
677
687
|
MedicalScribeSettings.add_member(:channel_identification, Shapes::ShapeRef.new(shape: Boolean, location_name: "ChannelIdentification"))
|
@@ -804,6 +814,7 @@ module Aws::TranscribeService
|
|
804
814
|
StartMedicalScribeJobRequest.add_member(:settings, Shapes::ShapeRef.new(shape: MedicalScribeSettings, required: true, location_name: "Settings"))
|
805
815
|
StartMedicalScribeJobRequest.add_member(:channel_definitions, Shapes::ShapeRef.new(shape: MedicalScribeChannelDefinitions, location_name: "ChannelDefinitions"))
|
806
816
|
StartMedicalScribeJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
817
|
+
StartMedicalScribeJobRequest.add_member(:medical_scribe_context, Shapes::ShapeRef.new(shape: MedicalScribeContext, location_name: "MedicalScribeContext"))
|
807
818
|
StartMedicalScribeJobRequest.struct_class = Types::StartMedicalScribeJobRequest
|
808
819
|
|
809
820
|
StartMedicalScribeJobResponse.add_member(:medical_scribe_job, Shapes::ShapeRef.new(shape: MedicalScribeJob, location_name: "MedicalScribeJob"))
|
@@ -2824,6 +2824,21 @@ module Aws::TranscribeService
|
|
2824
2824
|
include Aws::Structure
|
2825
2825
|
end
|
2826
2826
|
|
2827
|
+
# The `MedicalScribeContext` object that contains contextual information
|
2828
|
+
# used to generate customized clinical notes.
|
2829
|
+
#
|
2830
|
+
# @!attribute [rw] patient_context
|
2831
|
+
# Contains patient-specific information.
|
2832
|
+
# @return [Types::MedicalScribePatientContext]
|
2833
|
+
#
|
2834
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalScribeContext AWS API Documentation
|
2835
|
+
#
|
2836
|
+
class MedicalScribeContext < Struct.new(
|
2837
|
+
:patient_context)
|
2838
|
+
SENSITIVE = []
|
2839
|
+
include Aws::Structure
|
2840
|
+
end
|
2841
|
+
|
2827
2842
|
# Provides detailed information about a Medical Scribe job.
|
2828
2843
|
#
|
2829
2844
|
# To view the status of the specified Medical Scribe job, check the
|
@@ -2951,9 +2966,14 @@ module Aws::TranscribeService
|
|
2951
2966
|
# speaking).
|
2952
2967
|
# @return [Array<Types::MedicalScribeChannelDefinition>]
|
2953
2968
|
#
|
2969
|
+
# @!attribute [rw] medical_scribe_context_provided
|
2970
|
+
# Indicates whether the `MedicalScribeContext` object was provided
|
2971
|
+
# when the Medical Scribe job was started.
|
2972
|
+
# @return [Boolean]
|
2973
|
+
#
|
2954
2974
|
# @!attribute [rw] tags
|
2955
2975
|
# Adds one or more custom tags, each in the form of a key:value pair,
|
2956
|
-
# to the
|
2976
|
+
# to the Medical Scribe job.
|
2957
2977
|
#
|
2958
2978
|
# To learn more about using tags with Amazon Transcribe, refer to
|
2959
2979
|
# [Tagging resources][1].
|
@@ -2978,6 +2998,7 @@ module Aws::TranscribeService
|
|
2978
2998
|
:settings,
|
2979
2999
|
:data_access_role_arn,
|
2980
3000
|
:channel_definitions,
|
3001
|
+
:medical_scribe_context_provided,
|
2981
3002
|
:tags)
|
2982
3003
|
SENSITIVE = []
|
2983
3004
|
include Aws::Structure
|
@@ -3076,6 +3097,22 @@ module Aws::TranscribeService
|
|
3076
3097
|
include Aws::Structure
|
3077
3098
|
end
|
3078
3099
|
|
3100
|
+
# Contains patient-specific information used to customize the clinical
|
3101
|
+
# note generation.
|
3102
|
+
#
|
3103
|
+
# @!attribute [rw] pronouns
|
3104
|
+
# The patient's preferred pronouns that the user wants to provide as
|
3105
|
+
# a context for clinical note generation.
|
3106
|
+
# @return [String]
|
3107
|
+
#
|
3108
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalScribePatientContext AWS API Documentation
|
3109
|
+
#
|
3110
|
+
class MedicalScribePatientContext < Struct.new(
|
3111
|
+
:pronouns)
|
3112
|
+
SENSITIVE = [:pronouns]
|
3113
|
+
include Aws::Structure
|
3114
|
+
end
|
3115
|
+
|
3079
3116
|
# Makes it possible to control how your Medical Scribe job is processed
|
3080
3117
|
# using a `MedicalScribeSettings` object. Specify
|
3081
3118
|
# `ChannelIdentification` if `ChannelDefinitions` are set. Enabled
|
@@ -4265,7 +4302,7 @@ module Aws::TranscribeService
|
|
4265
4302
|
#
|
4266
4303
|
# @!attribute [rw] tags
|
4267
4304
|
# Adds one or more custom tags, each in the form of a key:value pair,
|
4268
|
-
# to the
|
4305
|
+
# to the Medical Scribe job.
|
4269
4306
|
#
|
4270
4307
|
# To learn more about using tags with Amazon Transcribe, refer to
|
4271
4308
|
# [Tagging resources][1].
|
@@ -4275,6 +4312,12 @@ module Aws::TranscribeService
|
|
4275
4312
|
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
|
4276
4313
|
# @return [Array<Types::Tag>]
|
4277
4314
|
#
|
4315
|
+
# @!attribute [rw] medical_scribe_context
|
4316
|
+
# The `MedicalScribeContext` object that contains contextual
|
4317
|
+
# information which is used during clinical note generation to add
|
4318
|
+
# relevant context to the note.
|
4319
|
+
# @return [Types::MedicalScribeContext]
|
4320
|
+
#
|
4278
4321
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartMedicalScribeJobRequest AWS API Documentation
|
4279
4322
|
#
|
4280
4323
|
class StartMedicalScribeJobRequest < Struct.new(
|
@@ -4286,7 +4329,8 @@ module Aws::TranscribeService
|
|
4286
4329
|
:data_access_role_arn,
|
4287
4330
|
:settings,
|
4288
4331
|
:channel_definitions,
|
4289
|
-
:tags
|
4332
|
+
:tags,
|
4333
|
+
:medical_scribe_context)
|
4290
4334
|
SENSITIVE = []
|
4291
4335
|
include Aws::Structure
|
4292
4336
|
end
|
data/sig/client.rbs
CHANGED
@@ -652,7 +652,12 @@ module Aws
|
|
652
652
|
key: ::String,
|
653
653
|
value: ::String
|
654
654
|
},
|
655
|
-
]
|
655
|
+
],
|
656
|
+
?medical_scribe_context: {
|
657
|
+
patient_context: {
|
658
|
+
pronouns: ("HE_HIM" | "SHE_HER" | "THEY_THEM")?
|
659
|
+
}?
|
660
|
+
}
|
656
661
|
) -> _StartMedicalScribeJobResponseSuccess
|
657
662
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartMedicalScribeJobResponseSuccess
|
658
663
|
|
data/sig/types.rbs
CHANGED
@@ -559,6 +559,11 @@ module Aws::TranscribeService
|
|
559
559
|
SENSITIVE: []
|
560
560
|
end
|
561
561
|
|
562
|
+
class MedicalScribeContext
|
563
|
+
attr_accessor patient_context: Types::MedicalScribePatientContext
|
564
|
+
SENSITIVE: []
|
565
|
+
end
|
566
|
+
|
562
567
|
class MedicalScribeJob
|
563
568
|
attr_accessor medical_scribe_job_name: ::String
|
564
569
|
attr_accessor medical_scribe_job_status: ("QUEUED" | "IN_PROGRESS" | "FAILED" | "COMPLETED")
|
@@ -572,6 +577,7 @@ module Aws::TranscribeService
|
|
572
577
|
attr_accessor settings: Types::MedicalScribeSettings
|
573
578
|
attr_accessor data_access_role_arn: ::String
|
574
579
|
attr_accessor channel_definitions: ::Array[Types::MedicalScribeChannelDefinition]
|
580
|
+
attr_accessor medical_scribe_context_provided: bool
|
575
581
|
attr_accessor tags: ::Array[Types::Tag]
|
576
582
|
SENSITIVE: []
|
577
583
|
end
|
@@ -593,6 +599,11 @@ module Aws::TranscribeService
|
|
593
599
|
SENSITIVE: []
|
594
600
|
end
|
595
601
|
|
602
|
+
class MedicalScribePatientContext
|
603
|
+
attr_accessor pronouns: ("HE_HIM" | "SHE_HER" | "THEY_THEM")
|
604
|
+
SENSITIVE: [:pronouns]
|
605
|
+
end
|
606
|
+
|
596
607
|
class MedicalScribeSettings
|
597
608
|
attr_accessor show_speaker_labels: bool
|
598
609
|
attr_accessor max_speaker_labels: ::Integer
|
@@ -748,6 +759,7 @@ module Aws::TranscribeService
|
|
748
759
|
attr_accessor settings: Types::MedicalScribeSettings
|
749
760
|
attr_accessor channel_definitions: ::Array[Types::MedicalScribeChannelDefinition]
|
750
761
|
attr_accessor tags: ::Array[Types::Tag]
|
762
|
+
attr_accessor medical_scribe_context: Types::MedicalScribeContext
|
751
763
|
SENSITIVE: []
|
752
764
|
end
|
753
765
|
|