aws-sdk-transcribestreamingservice 1.42.0 → 1.44.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -10,19 +10,22 @@
10
10
  module Aws::TranscribeStreamingService
11
11
  module Types
12
12
 
13
- # A list of possible transcriptions for the audio.
13
+ # A list of possible alternative transcriptions for the input audio.
14
+ # Each alternative may contain one or more of `Items`, `Entities`, or
15
+ # `Transcript`.
14
16
  #
15
17
  # @!attribute [rw] transcript
16
- # The text that was transcribed from the audio.
18
+ # Contains transcribed text.
17
19
  # @return [String]
18
20
  #
19
21
  # @!attribute [rw] items
20
- # One or more alternative interpretations of the input audio.
22
+ # Contains words, phrases, or punctuation marks in your transcription
23
+ # output.
21
24
  # @return [Array<Types::Item>]
22
25
  #
23
26
  # @!attribute [rw] entities
24
- # Contains the entities identified as personally identifiable
25
- # information (PII) in the transcription output.
27
+ # Contains entities identified as personally identifiable information
28
+ # (PII) in your transcription output.
26
29
  # @return [Array<Types::Entity>]
27
30
  #
28
31
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/Alternative AWS API Documentation
@@ -35,16 +38,14 @@ module Aws::TranscribeStreamingService
35
38
  include Aws::Structure
36
39
  end
37
40
 
38
- # Provides a wrapper for the audio chunks that you are sending.
41
+ # A wrapper for your audio chunks. Your audio stream consists of one or
42
+ # more audio events, which consist of one or more audio chunks.
39
43
  #
40
- # For information on audio encoding in Amazon Transcribe, see [Speech
41
- # input][1]. For information on audio encoding formats in Amazon
42
- # Transcribe Medical, see [Speech input][2].
44
+ # For more information, see [Event stream encoding][1].
43
45
  #
44
46
  #
45
47
  #
46
- # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/input.html
47
- # [2]: https://docs.aws.amazon.com/transcribe/latest/dg/input-med.html
48
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html
48
49
  #
49
50
  # @note When making an API call, you may pass AudioEvent
50
51
  # data as a hash:
@@ -68,10 +69,9 @@ module Aws::TranscribeStreamingService
68
69
  end
69
70
 
70
71
  # One or more arguments to the `StartStreamTranscription` or
71
- # `StartMedicalStreamTranscription` operation was invalid. For example,
72
- # `MediaEncoding` was not set to a valid encoding, or `LanguageCode` was
73
- # not set to a valid code. Check the parameters and try your request
74
- # again.
72
+ # `StartMedicalStreamTranscription` operation was not valid. For
73
+ # example, `MediaEncoding` or `LanguageCode` used not valid values.
74
+ # Check the specified parameters and try your request again.
75
75
  #
76
76
  # @!attribute [rw] message
77
77
  # @return [String]
@@ -100,35 +100,41 @@ module Aws::TranscribeStreamingService
100
100
  include Aws::Structure
101
101
  end
102
102
 
103
- # The entity identified as personally identifiable information (PII).
103
+ # Contains entities identified as personally identifiable information
104
+ # (PII) in your transcription output, along with various associated
105
+ # attributes. Examples include category, confidence score, type,
106
+ # stability score, and start and end times.
104
107
  #
105
108
  # @!attribute [rw] start_time
106
- # The start time of speech that was identified as PII.
109
+ # The start time, in milliseconds, of the utterance that was
110
+ # identified as PII.
107
111
  # @return [Float]
108
112
  #
109
113
  # @!attribute [rw] end_time
110
- # The end time of speech that was identified as PII.
114
+ # The end time, in milliseconds, of the utterance that was identified
115
+ # as PII.
111
116
  # @return [Float]
112
117
  #
113
118
  # @!attribute [rw] category
114
- # The category of information identified in this entity; for example,
115
- # PII.
119
+ # The category of information identified. The only category is `PII`.
116
120
  # @return [String]
117
121
  #
118
122
  # @!attribute [rw] type
119
- # The type of PII identified in this entity; for example, name or
120
- # credit card number.
123
+ # The type of PII identified. For example, `NAME` or
124
+ # `CREDIT_DEBIT_NUMBER`.
121
125
  # @return [String]
122
126
  #
123
127
  # @!attribute [rw] content
124
- # The words in the transcription output that have been identified as a
125
- # PII entity.
128
+ # The word or words identified as PII.
126
129
  # @return [String]
127
130
  #
128
131
  # @!attribute [rw] confidence
129
- # A value between zero and one that Amazon Transcribe assigns to PII
130
- # identified in the source audio. Larger values indicate a higher
131
- # confidence in PII identification.
132
+ # The confidence score associated with the identified PII entity in
133
+ # your audio.
134
+ #
135
+ # Confidence scores are values between 0 and 1. A larger value
136
+ # indicates a higher probability that the identified entity correctly
137
+ # matches the entity spoken in your media.
132
138
  # @return [Float]
133
139
  #
134
140
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/Entity AWS API Documentation
@@ -144,9 +150,8 @@ module Aws::TranscribeStreamingService
144
150
  include Aws::Structure
145
151
  end
146
152
 
147
- # A problem occurred while processing the audio. Amazon Transcribe or
148
- # Amazon Transcribe Medical terminated processing. Try your request
149
- # again.
153
+ # A problem occurred while processing the audio. Amazon Transcribe
154
+ # terminated processing.
150
155
  #
151
156
  # @!attribute [rw] message
152
157
  # @return [String]
@@ -160,50 +165,51 @@ module Aws::TranscribeStreamingService
160
165
  include Aws::Structure
161
166
  end
162
167
 
163
- # A word, phrase, or punctuation mark that is transcribed from the input
164
- # audio.
168
+ # A word, phrase, or punctuation mark in your transcription output,
169
+ # along with various associated attributes, such as confidence score,
170
+ # type, and start and end times.
165
171
  #
166
172
  # @!attribute [rw] start_time
167
- # The offset from the beginning of the audio stream to the beginning
168
- # of the audio that resulted in the item.
173
+ # The start time, in milliseconds, of the transcribed item.
169
174
  # @return [Float]
170
175
  #
171
176
  # @!attribute [rw] end_time
172
- # The offset from the beginning of the audio stream to the end of the
173
- # audio that resulted in the item.
177
+ # The end time, in milliseconds, of the transcribed item.
174
178
  # @return [Float]
175
179
  #
176
180
  # @!attribute [rw] type
177
- # The type of the item. `PRONUNCIATION` indicates that the item is a
178
- # word that was recognized in the input audio. `PUNCTUATION` indicates
179
- # that the item was interpreted as a pause in the input audio.
181
+ # The type of item identified. Options are: `PRONUNCIATION` (spoken
182
+ # words) and `PUNCTUATION`.
180
183
  # @return [String]
181
184
  #
182
185
  # @!attribute [rw] content
183
- # The word or punctuation that was recognized in the input audio.
186
+ # The word or punctuation that was transcribed.
184
187
  # @return [String]
185
188
  #
186
189
  # @!attribute [rw] vocabulary_filter_match
187
- # Indicates whether a word in the item matches a word in the
188
- # vocabulary filter you've chosen for your media stream. If `true`
189
- # then a word in the item matches your vocabulary filter.
190
+ # Indicates whether the specified item matches a word in the
191
+ # vocabulary filter included in your request. If `true`, there is a
192
+ # vocabulary filter match.
190
193
  # @return [Boolean]
191
194
  #
192
195
  # @!attribute [rw] speaker
193
- # If speaker identification is enabled, shows the speakers identified
194
- # in the media stream.
196
+ # If speaker partitioning is enabled, `Speaker` labels the speaker of
197
+ # the specified item.
195
198
  # @return [String]
196
199
  #
197
200
  # @!attribute [rw] confidence
198
- # A value between zero and one for an item that is a confidence score
199
- # that Amazon Transcribe assigns to each word or phrase that it
200
- # transcribes.
201
+ # The confidence score associated with a word or phrase in your
202
+ # transcript.
203
+ #
204
+ # Confidence scores are values between 0 and 1. A larger value
205
+ # indicates a higher probability that the identified item correctly
206
+ # matches the item spoken in your media.
201
207
  # @return [Float]
202
208
  #
203
209
  # @!attribute [rw] stable
204
- # If partial result stabilization has been enabled, indicates whether
205
- # the word or phrase in the item is stable. If `Stable` is `true`, the
206
- # result is stable.
210
+ # If partial result stabilization is enabled, `Stable` indicates
211
+ # whether the specified item is stable (`true`) or if it may change
212
+ # when the segment is complete (`false`).
207
213
  # @return [Boolean]
208
214
  #
209
215
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/Item AWS API Documentation
@@ -221,19 +227,20 @@ module Aws::TranscribeStreamingService
221
227
  include Aws::Structure
222
228
  end
223
229
 
224
- # The language codes of the identified languages and their associated
225
- # confidence scores. The confidence score is a value between zero and
226
- # one; a larger value indicates a higher confidence in the identified
227
- # language.
230
+ # The language code that represents the language identified in your
231
+ # audio, including the associated confidence score. If you enabled
232
+ # channel identification in your request and each channel contained a
233
+ # different language, you will have more than one `LanguageWithScore`
234
+ # result.
228
235
  #
229
236
  # @!attribute [rw] language_code
230
- # The language code of the language identified by Amazon Transcribe.
237
+ # The language code of the identified language.
231
238
  # @return [String]
232
239
  #
233
240
  # @!attribute [rw] score
234
- # The confidence score for the associated language code. Confidence
235
- # scores are values between zero and one; larger values indicate a
236
- # higher confidence in the identified language.
241
+ # The confidence score associated with the identified language code.
242
+ # Confidence scores are values between zero and one; larger values
243
+ # indicate a higher confidence in the identified language.
237
244
  # @return [Float]
238
245
  #
239
246
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/LanguageWithScore AWS API Documentation
@@ -245,11 +252,9 @@ module Aws::TranscribeStreamingService
245
252
  include Aws::Structure
246
253
  end
247
254
 
248
- # You have exceeded the maximum number of concurrent transcription
249
- # streams, are starting transcription streams too quickly, or the
250
- # maximum audio length of 4 hours. Wait until a stream has finished
251
- # processing, or break your audio stream into smaller chunks and try
252
- # your request again.
255
+ # Your client has exceeded one of the Amazon Transcribe limits. This is
256
+ # typically the audio length limit. Break your audio stream into smaller
257
+ # chunks and try your request again.
253
258
  #
254
259
  # @!attribute [rw] message
255
260
  # @return [String]
@@ -263,20 +268,22 @@ module Aws::TranscribeStreamingService
263
268
  include Aws::Structure
264
269
  end
265
270
 
266
- # A list of possible transcriptions for the audio.
271
+ # A list of possible alternative transcriptions for the input audio.
272
+ # Each alternative may contain one or more of `Items`, `Entities`, or
273
+ # `Transcript`.
267
274
  #
268
275
  # @!attribute [rw] transcript
269
- # The text that was transcribed from the audio.
276
+ # Contains transcribed text.
270
277
  # @return [String]
271
278
  #
272
279
  # @!attribute [rw] items
273
- # A list of objects that contains words and punctuation marks that
274
- # represents one or more interpretations of the input audio.
280
+ # Contains words, phrases, or punctuation marks in your transcription
281
+ # output.
275
282
  # @return [Array<Types::MedicalItem>]
276
283
  #
277
284
  # @!attribute [rw] entities
278
- # Contains the medical entities identified as personal health
279
- # information in the transcription output.
285
+ # Contains entities identified as personal health information (PHI) in
286
+ # your transcription output.
280
287
  # @return [Array<Types::MedicalEntity>]
281
288
  #
282
289
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalAlternative AWS API Documentation
@@ -289,32 +296,36 @@ module Aws::TranscribeStreamingService
289
296
  include Aws::Structure
290
297
  end
291
298
 
292
- # The medical entity identified as personal health information.
299
+ # Contains entities identified as personal health information (PHI) in
300
+ # your transcription output, along with various associated attributes.
301
+ # Examples include category, confidence score, type, stability score,
302
+ # and start and end times.
293
303
  #
294
304
  # @!attribute [rw] start_time
295
- # The start time of the speech that was identified as a medical
296
- # entity.
305
+ # The start time, in milliseconds, of the utterance that was
306
+ # identified as PHI.
297
307
  # @return [Float]
298
308
  #
299
309
  # @!attribute [rw] end_time
300
- # The end time of the speech that was identified as a medical entity.
310
+ # The end time, in milliseconds, of the utterance that was identified
311
+ # as PHI.
301
312
  # @return [Float]
302
313
  #
303
314
  # @!attribute [rw] category
304
- # The type of personal health information of the medical entity.
315
+ # The category of information identified. The only category is `PHI`.
305
316
  # @return [String]
306
317
  #
307
318
  # @!attribute [rw] content
308
- # The word or words in the transcription output that have been
309
- # identified as a medical entity.
319
+ # The word or words identified as PHI.
310
320
  # @return [String]
311
321
  #
312
322
  # @!attribute [rw] confidence
313
- # A value between zero and one that Amazon Transcribe Medical assigned
314
- # to the personal health information that it identified in the source
315
- # audio. Larger values indicate that Amazon Transcribe Medical has
316
- # higher confidence in the personal health information that it
317
- # identified.
323
+ # The confidence score associated with the identified PHI entity in
324
+ # your audio.
325
+ #
326
+ # Confidence scores are values between 0 and 1. A larger value
327
+ # indicates a higher probability that the identified entity correctly
328
+ # matches the entity spoken in your media.
318
329
  # @return [Float]
319
330
  #
320
331
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalEntity AWS API Documentation
@@ -329,42 +340,39 @@ module Aws::TranscribeStreamingService
329
340
  include Aws::Structure
330
341
  end
331
342
 
332
- # A word, phrase, or punctuation mark that is transcribed from the input
333
- # audio.
343
+ # A word, phrase, or punctuation mark in your transcription output,
344
+ # along with various associated attributes, such as confidence score,
345
+ # type, and start and end times.
334
346
  #
335
347
  # @!attribute [rw] start_time
336
- # The number of seconds into an audio stream that indicates the
337
- # creation time of an item.
348
+ # The start time, in milliseconds, of the transcribed item.
338
349
  # @return [Float]
339
350
  #
340
351
  # @!attribute [rw] end_time
341
- # The number of seconds into an audio stream that indicates the
342
- # creation time of an item.
352
+ # The end time, in milliseconds, of the transcribed item.
343
353
  # @return [Float]
344
354
  #
345
355
  # @!attribute [rw] type
346
- # The type of the item. `PRONUNCIATION` indicates that the item is a
347
- # word that was recognized in the input audio. `PUNCTUATION` indicates
348
- # that the item was interpreted as a pause in the input audio, such as
349
- # a period to indicate the end of a sentence.
356
+ # The type of item identified. Options are: `PRONUNCIATION` (spoken
357
+ # words) and `PUNCTUATION`.
350
358
  # @return [String]
351
359
  #
352
360
  # @!attribute [rw] content
353
- # The word or punctuation mark that was recognized in the input audio.
361
+ # The word or punctuation that was transcribed.
354
362
  # @return [String]
355
363
  #
356
364
  # @!attribute [rw] confidence
357
- # A value between 0 and 1 for an item that is a confidence score that
358
- # Amazon Transcribe Medical assigns to each word that it transcribes.
365
+ # The confidence score associated with a word or phrase in your
366
+ # transcript.
367
+ #
368
+ # Confidence scores are values between 0 and 1. A larger value
369
+ # indicates a higher probability that the identified item correctly
370
+ # matches the item spoken in your media.
359
371
  # @return [Float]
360
372
  #
361
373
  # @!attribute [rw] speaker
362
- # If speaker identification is enabled, shows the integer values that
363
- # correspond to the different speakers identified in the stream. For
364
- # example, if the value of `Speaker` in the stream is either a `0` or
365
- # a `1`, that indicates that Amazon Transcribe Medical has identified
366
- # two speakers in the stream. The value of `0` corresponds to one
367
- # speaker and the value of `1` corresponds to the other speaker.
374
+ # If speaker partitioning is enabled, `Speaker` labels the speaker of
375
+ # the specified item.
368
376
  # @return [String]
369
377
  #
370
378
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalItem AWS API Documentation
@@ -380,45 +388,41 @@ module Aws::TranscribeStreamingService
380
388
  include Aws::Structure
381
389
  end
382
390
 
383
- # The results of transcribing a portion of the input audio stream.
391
+ # The `Result` associated with a ``.
392
+ #
393
+ # Contains a set of transcription results from one or more audio
394
+ # segments, along with additional information per your request
395
+ # parameters. This can include information relating to alternative
396
+ # transcriptions, channel identification, partial result stabilization,
397
+ # language identification, and other transcription-related data.
384
398
  #
385
399
  # @!attribute [rw] result_id
386
- # A unique identifier for the result.
400
+ # Provides a unique identifier for the `Result`.
387
401
  # @return [String]
388
402
  #
389
403
  # @!attribute [rw] start_time
390
- # The time, in seconds, from the beginning of the audio stream to the
391
- # beginning of the result.
404
+ # The start time, in milliseconds, of the `Result`.
392
405
  # @return [Float]
393
406
  #
394
407
  # @!attribute [rw] end_time
395
- # The time, in seconds, from the beginning of the audio stream to the
396
- # end of the result.
408
+ # The end time, in milliseconds, of the `Result`.
397
409
  # @return [Float]
398
410
  #
399
411
  # @!attribute [rw] is_partial
400
- # Amazon Transcribe Medical divides the incoming audio stream into
401
- # segments at natural points in the audio. Transcription results are
402
- # returned based on these segments.
403
- #
404
- # The `IsPartial` field is `true` to indicate that Amazon Transcribe
405
- # Medical has additional transcription data to send. The `IsPartial`
406
- # field is `false` to indicate that this is the last transcription
407
- # result for the segment.
412
+ # Indicates if the segment is complete.
413
+ #
414
+ # If `IsPartial` is `true`, the segment is not complete. If
415
+ # `IsPartial` is `false`, the segment is complete.
408
416
  # @return [Boolean]
409
417
  #
410
418
  # @!attribute [rw] alternatives
411
- # A list of possible transcriptions of the audio. Each alternative
412
- # typically contains one `Item` that contains the result of the
413
- # transcription.
419
+ # A list of possible alternative transcriptions for the input audio.
420
+ # Each alternative may contain one or more of `Items`, `Entities`, or
421
+ # `Transcript`.
414
422
  # @return [Array<Types::MedicalAlternative>]
415
423
  #
416
424
  # @!attribute [rw] channel_id
417
- # When channel identification is enabled, Amazon Transcribe Medical
418
- # transcribes the speech from each audio channel separately.
419
- #
420
- # You can use `ChannelId` to retrieve the transcription results for a
421
- # single channel in your audio stream.
425
+ # Indicates the channel identified for the `Result`.
422
426
  # @return [String]
423
427
  #
424
428
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalResult AWS API Documentation
@@ -434,11 +438,19 @@ module Aws::TranscribeStreamingService
434
438
  include Aws::Structure
435
439
  end
436
440
 
437
- # The medical transcript in a MedicalTranscriptEvent.
441
+ # The `MedicalTranscript` associated with a `.</p> MedicalTranscript
442
+ # contains Results, which contains a set of transcription results from
443
+ # one or more audio segments, along with additional information per your
444
+ # request parameters.
445
+ # `
438
446
  #
439
447
  # @!attribute [rw] results
440
- # MedicalResult objects that contain the results of transcribing a
441
- # portion of the input audio stream. The array can be empty.
448
+ # Contains a set of transcription results from one or more audio
449
+ # segments, along with additional information per your request
450
+ # parameters. This can include information relating to alternative
451
+ # transcriptions, channel identification, partial result
452
+ # stabilization, language identification, and other
453
+ # transcription-related data.
442
454
  # @return [Array<Types::MedicalResult>]
443
455
  #
444
456
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalTranscript AWS API Documentation
@@ -449,12 +461,20 @@ module Aws::TranscribeStreamingService
449
461
  include Aws::Structure
450
462
  end
451
463
 
452
- # Represents a set of transcription results from the server to the
453
- # client. It contains one or more segments of the transcription.
464
+ # The `MedicalTranscriptEvent` associated with a
465
+ # `MedicalTranscriptResultStream`.
466
+ #
467
+ # Contains a set of transcription results from one or more audio
468
+ # segments, along with additional information per your request
469
+ # parameters.
454
470
  #
455
471
  # @!attribute [rw] transcript
456
- # The transcription of the audio stream. The transcription is composed
457
- # of all of the items in the results list.
472
+ # Contains `Results`, which contains a set of transcription results
473
+ # from one or more audio segments, along with additional information
474
+ # per your request parameters. This can include information relating
475
+ # to alternative transcriptions, channel identification, partial
476
+ # result stabilization, language identification, and other
477
+ # transcription-related data.
458
478
  # @return [Types::MedicalTranscript]
459
479
  #
460
480
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/MedicalTranscriptEvent AWS API Documentation
@@ -466,52 +486,54 @@ module Aws::TranscribeStreamingService
466
486
  include Aws::Structure
467
487
  end
468
488
 
469
- # The result of transcribing a portion of the input audio stream.
489
+ # The `Result` associated with a ``.
490
+ #
491
+ # Contains a set of transcription results from one or more audio
492
+ # segments, along with additional information per your request
493
+ # parameters. This can include information relating to alternative
494
+ # transcriptions, channel identification, partial result stabilization,
495
+ # language identification, and other transcription-related data.
470
496
  #
471
497
  # @!attribute [rw] result_id
472
- # A unique identifier for the result.
498
+ # Provides a unique identifier for the `Result`.
473
499
  # @return [String]
474
500
  #
475
501
  # @!attribute [rw] start_time
476
- # The offset in seconds from the beginning of the audio stream to the
477
- # beginning of the result.
502
+ # The start time, in milliseconds, of the `Result`.
478
503
  # @return [Float]
479
504
  #
480
505
  # @!attribute [rw] end_time
481
- # The offset in seconds from the beginning of the audio stream to the
482
- # end of the result.
506
+ # The end time, in milliseconds, of the `Result`.
483
507
  # @return [Float]
484
508
  #
485
509
  # @!attribute [rw] is_partial
486
- # Amazon Transcribe divides the incoming audio stream into segments at
487
- # natural points in the audio. Transcription results are returned
488
- # based on these segments.
510
+ # Indicates if the segment is complete.
489
511
  #
490
- # The `IsPartial` field is `true` to indicate that Amazon Transcribe
491
- # has additional transcription data to send, `false` to indicate that
492
- # this is the last transcription result for the segment.
512
+ # If `IsPartial` is `true`, the segment is not complete. If
513
+ # `IsPartial` is `false`, the segment is complete.
493
514
  # @return [Boolean]
494
515
  #
495
516
  # @!attribute [rw] alternatives
496
- # A list of possible transcriptions for the audio. Each alternative
497
- # typically contains one `item` that contains the result of the
498
- # transcription.
517
+ # A list of possible alternative transcriptions for the input audio.
518
+ # Each alternative may contain one or more of `Items`, `Entities`, or
519
+ # `Transcript`.
499
520
  # @return [Array<Types::Alternative>]
500
521
  #
501
522
  # @!attribute [rw] channel_id
502
- # When channel identification is enabled, Amazon Transcribe
503
- # transcribes the speech from each audio channel separately.
504
- #
505
- # You can use `ChannelId` to retrieve the transcription results for a
506
- # single channel in your audio stream.
523
+ # Indicates the channel identified for the `Result`.
507
524
  # @return [String]
508
525
  #
509
526
  # @!attribute [rw] language_code
510
- # The language code of the identified language in your media stream.
527
+ # The language code that represents the language spoken in your audio
528
+ # stream.
511
529
  # @return [String]
512
530
  #
513
531
  # @!attribute [rw] language_identification
514
- # The language code of the dominant language identified in your media.
532
+ # The language code of the dominant language identified in your
533
+ # stream.
534
+ #
535
+ # If you enabled channel identification and each channel of your audio
536
+ # contains a different language, you may have more than one result.
515
537
  # @return [Array<Types::LanguageWithScore>]
516
538
  #
517
539
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/Result AWS API Documentation
@@ -529,7 +551,7 @@ module Aws::TranscribeStreamingService
529
551
  include Aws::Structure
530
552
  end
531
553
 
532
- # Service is currently unavailable. Try your request later.
554
+ # The service is currently unavailable. Try your request later.
533
555
  #
534
556
  # @!attribute [rw] message
535
557
  # @return [String]
@@ -547,7 +569,7 @@ module Aws::TranscribeStreamingService
547
569
  # data as a hash:
548
570
  #
549
571
  # {
550
- # language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
572
+ # language_code: "en-US", # required, accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, hi-IN, th-TH
551
573
  # media_sample_rate_hertz: 1, # required
552
574
  # media_encoding: "pcm", # required, accepts pcm, ogg-opus, flac
553
575
  # vocabulary_name: "VocabularyName",
@@ -562,72 +584,119 @@ module Aws::TranscribeStreamingService
562
584
  # }
563
585
  #
564
586
  # @!attribute [rw] language_code
565
- # Indicates the source language used in the input audio stream. For
566
- # Amazon Transcribe Medical, this is US English (en-US).
587
+ # Specify the language code that represents the language spoken in
588
+ # your audio.
589
+ #
590
+ # Amazon Transcribe Medical only supports US English (`en-US`).
567
591
  # @return [String]
568
592
  #
569
593
  # @!attribute [rw] media_sample_rate_hertz
570
- # The sample rate of the input audio (in Hertz). Amazon Transcribe
571
- # medical supports a range from 16,000 Hz to 48,000 Hz. Note that the
594
+ # The sample rate of the input audio (in hertz). Amazon Transcribe
595
+ # Medical supports a range from 16,000 Hz to 48,000 Hz. Note that the
572
596
  # sample rate you specify must match that of your audio.
573
597
  # @return [Integer]
574
598
  #
575
599
  # @!attribute [rw] media_encoding
576
- # The encoding used for the input audio.
600
+ # Specify the encoding used for the input audio. Supported formats
601
+ # are:
602
+ #
603
+ # * FLAC
604
+ #
605
+ # * OPUS-encoded audio in an Ogg container
606
+ #
607
+ # * PCM (only signed 16-bit little-endian audio formats, which does
608
+ # not include WAV)
609
+ #
610
+ # For more information, see [Media formats][1].
611
+ #
612
+ #
613
+ #
614
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
577
615
  # @return [String]
578
616
  #
579
617
  # @!attribute [rw] vocabulary_name
580
- # The name of the medical custom vocabulary to use when processing the
581
- # real-time stream.
618
+ # Specify the name of the custom vocabulary that you want to use when
619
+ # processing your transcription. Note that vocabulary names are case
620
+ # sensitive.
582
621
  # @return [String]
583
622
  #
584
623
  # @!attribute [rw] specialty
585
- # The medical specialty of the clinician or provider.
624
+ # Specify the medical specialty contained in your audio.
586
625
  # @return [String]
587
626
  #
588
627
  # @!attribute [rw] type
589
- # The type of input audio. Choose `DICTATION` for a provider dictating
590
- # patient notes. Choose `CONVERSATION` for a dialogue between a
591
- # patient and one or more medical professionanls.
628
+ # Specify the type of input audio. For example, choose `DICTATION` for
629
+ # a provider dictating patient notes and `CONVERSATION` for a dialogue
630
+ # between a patient and a medical professional.
592
631
  # @return [String]
593
632
  #
594
633
  # @!attribute [rw] show_speaker_label
595
- # When `true`, enables speaker identification in your real-time
596
- # stream.
634
+ # Enables speaker partitioning (diarization) in your transcription
635
+ # output. Speaker partitioning labels the speech from individual
636
+ # speakers in your media file.
637
+ #
638
+ # For more information, see [Partitioning speakers (diarization)][1].
639
+ #
640
+ #
641
+ #
642
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html
597
643
  # @return [Boolean]
598
644
  #
599
645
  # @!attribute [rw] session_id
600
- # Optional. An identifier for the transcription session. If you don't
601
- # provide a session ID, Amazon Transcribe generates one for you and
602
- # returns it in the response.
646
+ # Specify a name for your transcription session. If you don't include
647
+ # this parameter in your request, Amazon Transcribe Medical generates
648
+ # an ID and returns it in the response.
649
+ #
650
+ # You can use a session ID to retry a streaming session.
603
651
  # @return [String]
604
652
  #
605
653
  # @!attribute [rw] audio_stream
606
- # Represents the audio stream from your application to Amazon
607
- # Transcribe.
654
+ # An encoded stream of audio blobs. Audio streams are encoded as
655
+ # either HTTP/2 or WebSocket data frames.
656
+ #
657
+ # For more information, see [Transcribing streaming audio][1].
658
+ #
659
+ #
660
+ #
661
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html
608
662
  # @return [Types::AudioStream]
609
663
  #
610
664
  # @!attribute [rw] enable_channel_identification
611
- # When `true`, instructs Amazon Transcribe Medical to process each
612
- # audio channel separately and then merge the transcription output of
613
- # each channel into a single transcription.
665
+ # Enables channel identification in multi-channel audio.
666
+ #
667
+ # Channel identification transcribes the audio on each channel
668
+ # independently, then appends the output for each channel into one
669
+ # transcript.
614
670
  #
615
- # Amazon Transcribe Medical also produces a transcription of each
616
- # item. An item includes the start time, end time, and any alternative
617
- # transcriptions.
671
+ # If you have multi-channel audio and do not enable channel
672
+ # identification, your audio is transcribed in a continuous manner and
673
+ # your transcript is not separated by channel.
618
674
  #
619
- # You can't set both `ShowSpeakerLabel` and
620
- # `EnableChannelIdentification` in the same request. If you set both,
621
- # your request returns a `BadRequestException`.
675
+ # For more information, see [Transcribing multi-channel audio][1].
676
+ #
677
+ #
678
+ #
679
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html
622
680
  # @return [Boolean]
623
681
  #
624
682
  # @!attribute [rw] number_of_channels
625
- # The number of channels that are in your audio stream.
683
+ # Specify the number of channels in your audio stream. Up to two
684
+ # channels are supported.
626
685
  # @return [Integer]
627
686
  #
628
687
  # @!attribute [rw] content_identification_type
629
- # Set this field to `PHI` to identify personal health information in
630
- # the transcription output.
688
+ # Labels all personal health information (PHI) identified in your
689
+ # transcript.
690
+ #
691
+ # Content identification is performed at the segment level; PHI is
692
+ # flagged upon complete transcription of an audio segment.
693
+ #
694
+ # For more information, see [Identifying personal health information
695
+ # (PHI) in a transcription][1].
696
+ #
697
+ #
698
+ #
699
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html
631
700
  # @return [String]
632
701
  #
633
702
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartMedicalStreamTranscriptionRequest AWS API Documentation
@@ -650,60 +719,60 @@ module Aws::TranscribeStreamingService
650
719
  end
651
720
 
652
721
  # @!attribute [rw] request_id
653
- # An identifier for the streaming transcription.
722
+ # Provides the identifier for your streaming request.
654
723
  # @return [String]
655
724
  #
656
725
  # @!attribute [rw] language_code
657
- # The language code for the response transcript. For Amazon Transcribe
658
- # Medical, this is US English (en-US).
726
+ # Provides the language code that you specified in your request. This
727
+ # must be `en-US`.
659
728
  # @return [String]
660
729
  #
661
730
  # @!attribute [rw] media_sample_rate_hertz
662
- # The sample rate of the input audio, in Hertz (Hz).
731
+ # Provides the sample rate that you specified in your request.
663
732
  # @return [Integer]
664
733
  #
665
734
  # @!attribute [rw] media_encoding
666
- # The encoding used for the input audio stream.
735
+ # Provides the media encoding you specified in your request.
667
736
  # @return [String]
668
737
  #
669
738
  # @!attribute [rw] vocabulary_name
670
- # The name of the vocabulary used when processing the stream.
739
+ # Provides the name of the custom vocabulary that you specified in
740
+ # your request.
671
741
  # @return [String]
672
742
  #
673
743
  # @!attribute [rw] specialty
674
- # The specialty in the medical domain.
744
+ # Provides the medical specialty that you specified in your request.
675
745
  # @return [String]
676
746
  #
677
747
  # @!attribute [rw] type
678
- # The type of audio that was transcribed.
748
+ # Provides the type of audio you specified in your request.
679
749
  # @return [String]
680
750
  #
681
751
  # @!attribute [rw] show_speaker_label
682
- # Shows whether speaker identification was enabled in the stream.
752
+ # Shows whether speaker partitioning was enabled for your
753
+ # transcription.
683
754
  # @return [Boolean]
684
755
  #
685
756
  # @!attribute [rw] session_id
686
- # Optional. An identifier for the transcription session. If you don't
687
- # provide a session ID, Amazon Transcribe generates one for you and
688
- # returns it in the response.
757
+ # Provides the identifier for your transcription session.
689
758
  # @return [String]
690
759
  #
691
760
  # @!attribute [rw] transcript_result_stream
692
- # Represents the stream of transcription events from Amazon Transcribe
693
- # Medical to your application.
761
+ # Provides detailed information about your streaming session.
694
762
  # @return [Types::MedicalTranscriptResultStream]
695
763
  #
696
764
  # @!attribute [rw] enable_channel_identification
697
- # Shows whether channel identification has been enabled in the stream.
765
+ # Shows whether channel identification was enabled for your
766
+ # transcription.
698
767
  # @return [Boolean]
699
768
  #
700
769
  # @!attribute [rw] number_of_channels
701
- # The number of channels identified in the stream.
770
+ # Provides the number of channels that you specified in your request.
702
771
  # @return [Integer]
703
772
  #
704
773
  # @!attribute [rw] content_identification_type
705
- # If the value is `PHI`, indicates that you've configured your stream
706
- # to identify personal health information.
774
+ # Shows whether content identification was enabled for your
775
+ # transcription.
707
776
  # @return [String]
708
777
  #
709
778
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartMedicalStreamTranscriptionResponse AWS API Documentation
@@ -730,7 +799,7 @@ module Aws::TranscribeStreamingService
730
799
  # data as a hash:
731
800
  #
732
801
  # {
733
- # language_code: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
802
+ # language_code: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, hi-IN, th-TH
734
803
  # media_sample_rate_hertz: 1, # required
735
804
  # media_encoding: "pcm", # required, accepts pcm, ogg-opus, flac
736
805
  # vocabulary_name: "VocabularyName",
@@ -749,197 +818,354 @@ module Aws::TranscribeStreamingService
749
818
  # language_model_name: "ModelName",
750
819
  # identify_language: false,
751
820
  # language_options: "LanguageOptions",
752
- # preferred_language: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN
821
+ # preferred_language: "en-US", # accepts en-US, en-GB, es-US, fr-CA, fr-FR, en-AU, it-IT, de-DE, pt-BR, ja-JP, ko-KR, zh-CN, hi-IN, th-TH
753
822
  # vocabulary_names: "VocabularyNames",
754
823
  # vocabulary_filter_names: "VocabularyFilterNames",
755
824
  # }
756
825
  #
757
826
  # @!attribute [rw] language_code
758
- # The language code of the input audio stream.
827
+ # Specify the language code that represents the language spoken in
828
+ # your audio.
829
+ #
830
+ # If you're unsure of the language spoken in your audio, consider
831
+ # using `IdentifyLanguage` to enable automatic language
832
+ # identification.
833
+ #
834
+ # For a list of languages supported with Amazon Transcribe streaming,
835
+ # refer to the [Supported languages][1] table.
836
+ #
837
+ #
838
+ #
839
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
759
840
  # @return [String]
760
841
  #
761
842
  # @!attribute [rw] media_sample_rate_hertz
762
- # The sample rate of the input audio (in Hertz). Low-quality audio,
843
+ # The sample rate of the input audio (in hertz). Low-quality audio,
763
844
  # such as telephone audio, is typically around 8,000 Hz. High-quality
764
845
  # audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the
765
846
  # sample rate you specify must match that of your audio.
766
847
  # @return [Integer]
767
848
  #
768
849
  # @!attribute [rw] media_encoding
769
- # The encoding used for the input audio.
850
+ # Specify the encoding used for the input audio. Supported formats
851
+ # are:
852
+ #
853
+ # * FLAC
854
+ #
855
+ # * OPUS-encoded audio in an Ogg container
856
+ #
857
+ # * PCM (only signed 16-bit little-endian audio formats, which does
858
+ # not include WAV)
859
+ #
860
+ # For more information, see [Media formats][1].
861
+ #
862
+ #
863
+ #
864
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
770
865
  # @return [String]
771
866
  #
772
867
  # @!attribute [rw] vocabulary_name
773
- # The name of the custom vocabulary you want to use with your
774
- # transcription.
868
+ # Specify the name of the custom vocabulary that you want to use when
869
+ # processing your transcription. Note that vocabulary names are case
870
+ # sensitive.
871
+ #
872
+ # If the language of the specified custom vocabulary doesn't match
873
+ # the language identified in your media, your job fails.
874
+ #
875
+ # This parameter is **not** intended for use with the
876
+ # `IdentifyLanguage` parameter. If you're including
877
+ # `IdentifyLanguage` in your request and want to use one or more
878
+ # custom vocabularies with your transcription, use the
879
+ # `VocabularyNames` parameter instead.
775
880
  #
776
- # This operation is not intended for use in conjunction with the
777
- # `IdentifyLanguage` operation. If you're using `IdentifyLanguage` in
778
- # your request and want to use one or more custom vocabularies with
779
- # your transcription, use the `VocabularyNames` operation instead.
881
+ # For more information, see [Custom vocabularies][1].
882
+ #
883
+ #
884
+ #
885
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
780
886
  # @return [String]
781
887
  #
782
888
  # @!attribute [rw] session_id
783
- # A identifier for the transcription session. Use this parameter when
784
- # you want to retry a session. If you don't provide a session ID,
785
- # Amazon Transcribe will generate one for you and return it in the
786
- # response.
889
+ # Specify a name for your transcription session. If you don't include
890
+ # this parameter in your request, Amazon Transcribe generates an ID
891
+ # and returns it in the response.
892
+ #
893
+ # You can use a session ID to retry a streaming session.
787
894
  # @return [String]
788
895
  #
789
896
  # @!attribute [rw] audio_stream
790
- # PCM-encoded stream of audio blobs. The audio stream is encoded as an
791
- # HTTP/2 data frame.
897
+ # An encoded stream of audio blobs. Audio streams are encoded as
898
+ # either HTTP/2 or WebSocket data frames.
899
+ #
900
+ # For more information, see [Transcribing streaming audio][1].
901
+ #
902
+ #
903
+ #
904
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html
792
905
  # @return [Types::AudioStream]
793
906
  #
794
907
  # @!attribute [rw] vocabulary_filter_name
795
- # The name of the vocabulary filter you want to use with your
796
- # transcription.
908
+ # Specify the name of the custom vocabulary filter that you want to
909
+ # use when processing your transcription. Note that vocabulary filter
910
+ # names are case sensitive.
797
911
  #
798
- # This operation is not intended for use in conjunction with the
799
- # `IdentifyLanguage` operation. If you're using `IdentifyLanguage` in
800
- # your request and want to use one or more vocabulary filters with
801
- # your transcription, use the `VocabularyFilterNames` operation
802
- # instead.
912
+ # If the language of the specified custom vocabulary filter doesn't
913
+ # match the language identified in your media, your job fails.
914
+ #
915
+ # This parameter is **not** intended for use with the
916
+ # `IdentifyLanguage` parameter. If you're including
917
+ # `IdentifyLanguage` in your request and want to use one or more
918
+ # vocabulary filters with your transcription, use the
919
+ # `VocabularyFilterNames` parameter instead.
920
+ #
921
+ # For more information, see [Using vocabulary filtering with unwanted
922
+ # words][1].
923
+ #
924
+ #
925
+ #
926
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html
803
927
  # @return [String]
804
928
  #
805
929
  # @!attribute [rw] vocabulary_filter_method
806
- # The manner in which you use your vocabulary filter to filter words
807
- # in your transcript. `Remove` removes filtered words from your
808
- # transcription results. `Mask` masks filtered words with a `***` in
809
- # your transcription results. `Tag` keeps the filtered words in your
810
- # transcription results and tags them. The tag appears as
811
- # `VocabularyFilterMatch` equal to `True`.
930
+ # Specify how you want your vocabulary filter applied to your
931
+ # transcript.
932
+ #
933
+ # To replace words with `***`, choose `mask`.
934
+ #
935
+ # To delete words, choose `remove`.
936
+ #
937
+ # To flag words without changing them, choose `tag`.
812
938
  # @return [String]
813
939
  #
814
940
  # @!attribute [rw] show_speaker_label
815
- # When `true`, enables speaker identification in your media stream.
941
+ # Enables speaker partitioning (diarization) in your transcription
942
+ # output. Speaker partitioning labels the speech from individual
943
+ # speakers in your media file.
944
+ #
945
+ # For more information, see [Partitioning speakers (diarization)][1].
946
+ #
947
+ #
948
+ #
949
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html
816
950
  # @return [Boolean]
817
951
  #
818
952
  # @!attribute [rw] enable_channel_identification
819
- # When `true`, instructs Amazon Transcribe to process each audio
820
- # channel separately, then merges the transcription output of each
821
- # channel into a single transcription.
953
+ # Enables channel identification in multi-channel audio.
954
+ #
955
+ # Channel identification transcribes the audio on each channel
956
+ # independently, then appends the output for each channel into one
957
+ # transcript.
958
+ #
959
+ # If you have multi-channel audio and do not enable channel
960
+ # identification, your audio is transcribed in a continuous manner and
961
+ # your transcript is not separated by channel.
962
+ #
963
+ # For more information, see [Transcribing multi-channel audio][1].
822
964
  #
823
- # Amazon Transcribe also produces a transcription of each item. An
824
- # item includes the start time, end time, and any alternative
825
- # transcriptions.
965
+ #
966
+ #
967
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html
826
968
  # @return [Boolean]
827
969
  #
828
970
  # @!attribute [rw] number_of_channels
829
- # The number of channels that are in your audio stream.
971
+ # Specify the number of channels in your audio stream. Up to two
972
+ # channels are supported.
830
973
  # @return [Integer]
831
974
  #
832
975
  # @!attribute [rw] enable_partial_results_stabilization
833
- # When `true`, instructs Amazon Transcribe to present transcription
834
- # results that have the partial results stabilized. Normally, any word
835
- # or phrase from one partial result can change in a subsequent partial
836
- # result. With partial results stabilization enabled, only the last
837
- # few words of one partial result can change in another partial
838
- # result.
976
+ # Enables partial result stabilization for your transcription. Partial
977
+ # result stabilization can reduce latency in your output, but may
978
+ # impact accuracy. For more information, see [Partial-result
979
+ # stabilization][1].
980
+ #
981
+ #
982
+ #
983
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
839
984
  # @return [Boolean]
840
985
  #
841
986
  # @!attribute [rw] partial_results_stability
842
- # You can use this field to set the stability level of the
843
- # transcription results. A higher stability level means that the
844
- # transcription results are less likely to change. Higher stability
845
- # levels can come with lower overall transcription accuracy.
987
+ # Specify the level of stability to use when you enable partial
988
+ # results stabilization (`EnablePartialResultsStabilization`).
989
+ #
990
+ # Low stability provides the highest accuracy. High stability
991
+ # transcribes faster, but with slightly lower accuracy.
992
+ #
993
+ # For more information, see [Partial-result stabilization][1].
994
+ #
995
+ #
996
+ #
997
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization
846
998
  # @return [String]
847
999
  #
848
1000
  # @!attribute [rw] content_identification_type
849
- # Set this field to PII to identify personally identifiable
850
- # information (PII) in the transcription output. Content
851
- # identification is performed only upon complete transcription of the
852
- # audio segments.
1001
+ # Labels all personally identifiable information (PII) identified in
1002
+ # your transcript.
1003
+ #
1004
+ # Content identification is performed at the segment level; PII
1005
+ # specified in `PiiEntityTypes` is flagged upon complete transcription
1006
+ # of an audio segment.
1007
+ #
1008
+ # You can’t set `ContentIdentificationType` and `ContentRedactionType`
1009
+ # in the same request. If you set both, your request returns a
1010
+ # `BadRequestException`.
1011
+ #
1012
+ # For more information, see [Redacting or identifying personally
1013
+ # identifiable information][1].
853
1014
  #
854
- # You can’t set both `ContentIdentificationType` and
855
- # `ContentRedactionType` in the same request. If you set both, your
856
- # request returns a `BadRequestException`.
1015
+ #
1016
+ #
1017
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
857
1018
  # @return [String]
858
1019
  #
859
1020
  # @!attribute [rw] content_redaction_type
860
- # Set this field to PII to redact personally identifiable information
861
- # (PII) in the transcription output. Content redaction is performed
862
- # only upon complete transcription of the audio segments.
1021
+ # Redacts all personally identifiable information (PII) identified in
1022
+ # your transcript.
1023
+ #
1024
+ # Content redaction is performed at the segment level; PII specified
1025
+ # in `PiiEntityTypes` is redacted upon complete transcription of an
1026
+ # audio segment.
1027
+ #
1028
+ # You can’t set `ContentRedactionType` and `ContentIdentificationType`
1029
+ # in the same request. If you set both, your request returns a
1030
+ # `BadRequestException`.
1031
+ #
1032
+ # For more information, see [Redacting or identifying personally
1033
+ # identifiable information][1].
863
1034
  #
864
- # You can’t set both `ContentRedactionType` and
865
- # `ContentIdentificationType` in the same request. If you set both,
866
- # your request returns a `BadRequestException`.
1035
+ #
1036
+ #
1037
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html
867
1038
  # @return [String]
868
1039
  #
869
1040
  # @!attribute [rw] pii_entity_types
870
- # List the PII entity types you want to identify or redact. In order
871
- # to specify entity types, you must have either
872
- # `ContentIdentificationType` or `ContentRedactionType` enabled.
1041
+ # Specify which types of personally identifiable information (PII) you
1042
+ # want to redact in your transcript. You can include as many types as
1043
+ # you'd like, or you can select `ALL`.
873
1044
  #
874
- # `PIIEntityTypes` must be comma-separated; the available values are:
1045
+ # To include `PiiEntityTypes` in your request, you must also include
1046
+ # either `ContentIdentificationType` or `ContentRedactionType`.
1047
+ #
1048
+ # Values must be comma-separated and can include:
875
1049
  # `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_NUMBER`,
876
1050
  # `CREDIT_DEBIT_CVV`, `CREDIT_DEBIT_EXPIRY`, `PIN`, `EMAIL`,
877
- # `ADDRESS`, `NAME`, `PHONE`, `SSN`, and `ALL`.
878
- #
879
- # `PiiEntityTypes` is an optional parameter with a default value of
880
- # `ALL`.
1051
+ # `ADDRESS`, `NAME`, `PHONE`, `SSN`, or `ALL`.
881
1052
  # @return [String]
882
1053
  #
883
1054
  # @!attribute [rw] language_model_name
884
- # The name of the language model you want to use.
1055
+ # Specify the name of the custom language model that you want to use
1056
+ # when processing your transcription. Note that language model names
1057
+ # are case sensitive.
1058
+ #
1059
+ # The language of the specified language model must match the language
1060
+ # code you specify in your transcription request. If the languages
1061
+ # don't match, the language model isn't applied. There are no errors
1062
+ # or warnings associated with a language mismatch.
1063
+ #
1064
+ # For more information, see [Custom language models][1].
1065
+ #
1066
+ #
1067
+ #
1068
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html
885
1069
  # @return [String]
886
1070
  #
887
1071
  # @!attribute [rw] identify_language
888
- # Optional. Set this value to `true` to enable language identification
889
- # for your media stream.
1072
+ # Enables automatic language identification for your transcription.
1073
+ #
1074
+ # If you include `IdentifyLanguage`, you can optionally include a list
1075
+ # of language codes, using `LanguageOptions`, that you think may be
1076
+ # present in your audio stream. Including language options can improve
1077
+ # transcription accuracy.
1078
+ #
1079
+ # You can also include a preferred language using `PreferredLanguage`.
1080
+ # Adding a preferred language can help Amazon Transcribe identify the
1081
+ # language faster than if you omit this parameter.
1082
+ #
1083
+ # If you have multi-channel audio that contains different languages on
1084
+ # each channel, and you've enabled channel identification, automatic
1085
+ # language identification identifies the dominant language on each
1086
+ # audio channel.
1087
+ #
1088
+ # Note that you must include either `LanguageCode` or
1089
+ # `IdentifyLanguage` in your request. If you include both parameters,
1090
+ # your request fails.
1091
+ #
1092
+ # Streaming language identification can't be combined with custom
1093
+ # language models or redaction.
890
1094
  # @return [Boolean]
891
1095
  #
892
1096
  # @!attribute [rw] language_options
893
- # An object containing a list of languages that might be present in
894
- # your audio.
1097
+ # Specify two or more language codes that represent the languages you
1098
+ # think may be present in your media; including more than five is not
1099
+ # recommended. If you're unsure what languages are present, do not
1100
+ # include this parameter.
1101
+ #
1102
+ # Including language options can improve the accuracy of language
1103
+ # identification.
1104
+ #
1105
+ # If you include `LanguageOptions` in your request, you must also
1106
+ # include `IdentifyLanguage`.
1107
+ #
1108
+ # For a list of languages supported with Amazon Transcribe streaming,
1109
+ # refer to the [Supported languages][1] table.
895
1110
  #
896
- # You must provide two or more language codes to help Amazon
897
- # Transcribe identify the correct language of your media stream with
898
- # the highest possible accuracy. You can only select one variant per
899
- # language; for example, you can't include both `en-US` and `en-UK`
900
- # in the same request.
1111
+ # You can only include one language dialect per language per stream.
1112
+ # For example, you cannot include `en-US` and `en-AU` in the same
1113
+ # request.
901
1114
  #
902
- # You can only use this parameter if you've set `IdentifyLanguage` to
903
- # `true`in your request.
1115
+ #
1116
+ #
1117
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
904
1118
  # @return [String]
905
1119
  #
906
1120
  # @!attribute [rw] preferred_language
907
- # Optional. From the subset of languages codes you provided for
908
- # `LanguageOptions`, you can select one preferred language for your
909
- # transcription.
1121
+ # Specify a preferred language from the subset of languages codes you
1122
+ # specified in `LanguageOptions`.
910
1123
  #
911
- # You can only use this parameter if you've set `IdentifyLanguage` to
912
- # `true`in your request.
1124
+ # You can only use this parameter if you've included
1125
+ # `IdentifyLanguage` and `LanguageOptions` in your request.
913
1126
  # @return [String]
914
1127
  #
915
1128
  # @!attribute [rw] vocabulary_names
916
- # The names of the custom vocabularies you want to use with your
917
- # transcription.
1129
+ # Specify the names of the custom vocabularies that you want to use
1130
+ # when processing your transcription. Note that vocabulary names are
1131
+ # case sensitive.
918
1132
  #
919
- # Note that if the custom vocabularies you specify are in languages
920
- # that don't match the language identified in your media, your job
921
- # fails.
1133
+ # If none of the languages of the specified custom vocabularies match
1134
+ # the language identified in your media, your job fails.
922
1135
  #
923
- # This operation is only intended for use in conjunction with the
924
- # `IdentifyLanguage` operation. If you're not using
1136
+ # This parameter is only intended for use **with** the
1137
+ # `IdentifyLanguage` parameter. If you're **not** including
925
1138
  # `IdentifyLanguage` in your request and want to use a custom
926
1139
  # vocabulary with your transcription, use the `VocabularyName`
927
- # operation instead.
1140
+ # parameter instead.
1141
+ #
1142
+ # For more information, see [Custom vocabularies][1].
1143
+ #
1144
+ #
1145
+ #
1146
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html
928
1147
  # @return [String]
929
1148
  #
930
1149
  # @!attribute [rw] vocabulary_filter_names
931
- # The names of the vocabulary filters you want to use with your
932
- # transcription.
1150
+ # Specify the names of the custom vocabulary filters that you want to
1151
+ # use when processing your transcription. Note that vocabulary filter
1152
+ # names are case sensitive.
1153
+ #
1154
+ # If none of the languages of the specified custom vocabulary filters
1155
+ # match the language identified in your media, your job fails.
1156
+ #
1157
+ # This parameter is only intended for use **with** the
1158
+ # `IdentifyLanguage` parameter. If you're **not** including
1159
+ # `IdentifyLanguage` in your request and want to use a custom
1160
+ # vocabulary filter with your transcription, use the
1161
+ # `VocabularyFilterName` parameter instead.
1162
+ #
1163
+ # For more information, see [Using vocabulary filtering with unwanted
1164
+ # words][1].
933
1165
  #
934
- # Note that if the vocabulary filters you specify are in languages
935
- # that don't match the language identified in your media, your job
936
- # fails.
937
1166
  #
938
- # This operation is only intended for use in conjunction with the
939
- # `IdentifyLanguage` operation. If you're not using
940
- # `IdentifyLanguage` in your request and want to use a vocabulary
941
- # filter with your transcription, use the `VocabularyFilterName`
942
- # operation instead.
1167
+ #
1168
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html
943
1169
  # @return [String]
944
1170
  #
945
1171
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartStreamTranscriptionRequest AWS API Documentation
@@ -972,71 +1198,73 @@ module Aws::TranscribeStreamingService
972
1198
  end
973
1199
 
974
1200
  # @!attribute [rw] request_id
975
- # An identifier for the transcription.
1201
+ # Provides the identifier for your streaming request.
976
1202
  # @return [String]
977
1203
  #
978
1204
  # @!attribute [rw] language_code
979
- # The language code of the input audio stream.
1205
+ # Provides the language code that you specified in your request.
980
1206
  # @return [String]
981
1207
  #
982
1208
  # @!attribute [rw] media_sample_rate_hertz
983
- # The sample rate, in Hertz (Hz), for the input audio stream.
1209
+ # Provides the sample rate that you specified in your request.
984
1210
  # @return [Integer]
985
1211
  #
986
1212
  # @!attribute [rw] media_encoding
987
- # The encoding used for the input audio stream.
1213
+ # Provides the media encoding you specified in your request.
988
1214
  # @return [String]
989
1215
  #
990
1216
  # @!attribute [rw] vocabulary_name
991
- # The name of the custom vocabulary used when processing the stream.
1217
+ # Provides the name of the custom vocabulary that you specified in
1218
+ # your request.
992
1219
  # @return [String]
993
1220
  #
994
1221
  # @!attribute [rw] session_id
995
- # An identifier for a specific transcription session.
1222
+ # Provides the identifier for your transcription session.
996
1223
  # @return [String]
997
1224
  #
998
1225
  # @!attribute [rw] transcript_result_stream
999
- # Represents the stream of transcription events from Amazon Transcribe
1000
- # to your application.
1226
+ # Provides detailed information about your streaming session.
1001
1227
  # @return [Types::TranscriptResultStream]
1002
1228
  #
1003
1229
  # @!attribute [rw] vocabulary_filter_name
1004
- # The name of the vocabulary filter used when processing the stream.
1230
+ # Provides the name of the custom vocabulary filter that you specified
1231
+ # in your request.
1005
1232
  # @return [String]
1006
1233
  #
1007
1234
  # @!attribute [rw] vocabulary_filter_method
1008
- # The vocabulary filtering method used when processing the stream.
1235
+ # Provides the vocabulary filtering method used in your transcription.
1009
1236
  # @return [String]
1010
1237
  #
1011
1238
  # @!attribute [rw] show_speaker_label
1012
- # Shows whether speaker identification was enabled in the
1239
+ # Shows whether speaker partitioning was enabled for your
1013
1240
  # transcription.
1014
1241
  # @return [Boolean]
1015
1242
  #
1016
1243
  # @!attribute [rw] enable_channel_identification
1017
- # Shows whether channel identification was enabled in the stream.
1244
+ # Shows whether channel identification was enabled for your
1245
+ # transcription.
1018
1246
  # @return [Boolean]
1019
1247
  #
1020
1248
  # @!attribute [rw] number_of_channels
1021
- # The number of channels identified in the stream.
1249
+ # Provides the number of channels that you specified in your request.
1022
1250
  # @return [Integer]
1023
1251
  #
1024
1252
  # @!attribute [rw] enable_partial_results_stabilization
1025
- # Shows whether partial results stabilization was enabled in the
1253
+ # Shows whether partial results stabilization was enabled for your
1026
1254
  # transcription.
1027
1255
  # @return [Boolean]
1028
1256
  #
1029
1257
  # @!attribute [rw] partial_results_stability
1030
- # If partial results stabilization has been enabled in the stream,
1031
- # shows the stability level.
1258
+ # Provides the stabilization level used for your transcription.
1032
1259
  # @return [String]
1033
1260
  #
1034
1261
  # @!attribute [rw] content_identification_type
1035
- # Shows whether content identification was enabled in this stream.
1262
+ # Shows whether content identification was enabled for your
1263
+ # transcription.
1036
1264
  # @return [String]
1037
1265
  #
1038
1266
  # @!attribute [rw] content_redaction_type
1039
- # Shows whether content redaction was enabled in this stream.
1267
+ # Shows whether content redaction was enabled for your transcription.
1040
1268
  # @return [String]
1041
1269
  #
1042
1270
  # @!attribute [rw] pii_entity_types
@@ -1044,28 +1272,31 @@ module Aws::TranscribeStreamingService
1044
1272
  # @return [String]
1045
1273
  #
1046
1274
  # @!attribute [rw] language_model_name
1047
- # The name of the custom language model used in the transcription.
1275
+ # Provides the name of the custom language model that you specified in
1276
+ # your request.
1048
1277
  # @return [String]
1049
1278
  #
1050
1279
  # @!attribute [rw] identify_language
1051
- # The language code of the language identified in your media stream.
1280
+ # Shows whether automatic language identification was enabled for your
1281
+ # transcription.
1052
1282
  # @return [Boolean]
1053
1283
  #
1054
1284
  # @!attribute [rw] language_options
1055
- # The language codes used in the identification of your media
1056
- # stream's predominant language.
1285
+ # Provides the language codes that you specified in your request.
1057
1286
  # @return [String]
1058
1287
  #
1059
1288
  # @!attribute [rw] preferred_language
1060
- # The preferred language you specified in your request.
1289
+ # Provides the preferred language that you specified in your request.
1061
1290
  # @return [String]
1062
1291
  #
1063
1292
  # @!attribute [rw] vocabulary_names
1064
- # The name of the custom vocabulary used when processing the stream.
1293
+ # Provides the names of the custom vocabularies that you specified in
1294
+ # your request.
1065
1295
  # @return [String]
1066
1296
  #
1067
1297
  # @!attribute [rw] vocabulary_filter_names
1068
- # The name of the vocabulary filter used when processing the stream.
1298
+ # Provides the names of the custom vocabulary filters that you
1299
+ # specified in your request.
1069
1300
  # @return [String]
1070
1301
  #
1071
1302
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/StartStreamTranscriptionResponse AWS API Documentation
@@ -1098,11 +1329,19 @@ module Aws::TranscribeStreamingService
1098
1329
  include Aws::Structure
1099
1330
  end
1100
1331
 
1101
- # The transcription in a TranscriptEvent.
1332
+ # The `Transcript` associated with a `.</p> Transcript contains
1333
+ # Results, which contains a set of transcription results from one or
1334
+ # more audio segments, along with additional information per your
1335
+ # request parameters.
1336
+ # `
1102
1337
  #
1103
1338
  # @!attribute [rw] results
1104
- # Result objects that contain the results of transcribing a portion of
1105
- # the input audio stream. The array can be empty.
1339
+ # Contains a set of transcription results from one or more audio
1340
+ # segments, along with additional information per your request
1341
+ # parameters. This can include information relating to alternative
1342
+ # transcriptions, channel identification, partial result
1343
+ # stabilization, language identification, and other
1344
+ # transcription-related data.
1106
1345
  # @return [Array<Types::Result>]
1107
1346
  #
1108
1347
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/Transcript AWS API Documentation
@@ -1113,12 +1352,19 @@ module Aws::TranscribeStreamingService
1113
1352
  include Aws::Structure
1114
1353
  end
1115
1354
 
1116
- # Represents a set of transcription results from the server to the
1117
- # client. It contains one or more segments of the transcription.
1355
+ # The `TranscriptEvent` associated with a `TranscriptResultStream`.
1356
+ #
1357
+ # Contains a set of transcription results from one or more audio
1358
+ # segments, along with additional information per your request
1359
+ # parameters.
1118
1360
  #
1119
1361
  # @!attribute [rw] transcript
1120
- # The transcription of the audio stream. The transcription is composed
1121
- # of all of the items in the results list.
1362
+ # Contains `Results`, which contains a set of transcription results
1363
+ # from one or more audio segments, along with additional information
1364
+ # per your request parameters. This can include information relating
1365
+ # to alternative transcriptions, channel identification, partial
1366
+ # result stabilization, language identification, and other
1367
+ # transcription-related data.
1122
1368
  # @return [Types::Transcript]
1123
1369
  #
1124
1370
  # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-streaming-2017-10-26/TranscriptEvent AWS API Documentation
@@ -1130,8 +1376,14 @@ module Aws::TranscribeStreamingService
1130
1376
  include Aws::Structure
1131
1377
  end
1132
1378
 
1133
- # Represents the audio stream from your application to Amazon
1134
- # Transcribe.
1379
+ # An encoded stream of audio blobs. Audio streams are encoded as either
1380
+ # HTTP/2 or WebSocket data frames.
1381
+ #
1382
+ # For more information, see [Transcribing streaming audio][1].
1383
+ #
1384
+ #
1385
+ #
1386
+ # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html
1135
1387
  #
1136
1388
  # @note When making an API call, you may pass AudioStream
1137
1389
  # data as a hash:
@@ -1157,8 +1409,7 @@ module Aws::TranscribeStreamingService
1157
1409
 
1158
1410
  end
1159
1411
 
1160
- # Represents the transcription result stream from Amazon Transcribe
1161
- # Medical to your application.
1412
+ # Contains detailed information about your streaming session.
1162
1413
  #
1163
1414
  # EventStream is an Enumerator of Events.
1164
1415
  # #event_types #=> Array, returns all modeled event types in the stream
@@ -1180,8 +1431,7 @@ module Aws::TranscribeStreamingService
1180
1431
 
1181
1432
  end
1182
1433
 
1183
- # Represents the transcription result stream from Amazon Transcribe to
1184
- # your application.
1434
+ # Contains detailed information about your streaming session.
1185
1435
  #
1186
1436
  # EventStream is an Enumerator of Events.
1187
1437
  # #event_types #=> Array, returns all modeled event types in the stream