aws-sdk-transcribeservice 1.77.0 → 1.79.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 +293 -253
- data/lib/aws-sdk-transcribeservice/client_api.rb +4 -0
- data/lib/aws-sdk-transcribeservice/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-transcribeservice/endpoint_provider.rb +94 -94
- data/lib/aws-sdk-transcribeservice/types.rb +557 -1423
- data/lib/aws-sdk-transcribeservice.rb +1 -1
- metadata +2 -2
@@ -20,24 +20,14 @@ module Aws::TranscribeService
|
|
20
20
|
# if you include one, you must include both.
|
21
21
|
#
|
22
22
|
# You can use also `First` to search from the start of the audio until
|
23
|
-
# the time you specify, or `Last` to search from the time you
|
24
|
-
# until the end of the audio. For example, setting `First` to
|
25
|
-
# searches for your specified criteria in the audio contained
|
26
|
-
# the start of the media file to the 50,000 millisecond mark.
|
27
|
-
# use `First` and `Last` independently of each other.
|
23
|
+
# the time that you specify, or `Last` to search from the time that you
|
24
|
+
# specify until the end of the audio. For example, setting `First` to
|
25
|
+
# 50000 only searches for your specified criteria in the audio contained
|
26
|
+
# between the start of the media file to the 50,000 millisecond mark.
|
27
|
+
# You can use `First` and `Last` independently of each other.
|
28
28
|
#
|
29
29
|
# If you prefer to use percentage instead of milliseconds, see .
|
30
30
|
#
|
31
|
-
# @note When making an API call, you may pass AbsoluteTimeRange
|
32
|
-
# data as a hash:
|
33
|
-
#
|
34
|
-
# {
|
35
|
-
# start_time: 1,
|
36
|
-
# end_time: 1,
|
37
|
-
# first: 1,
|
38
|
-
# last: 1,
|
39
|
-
# }
|
40
|
-
#
|
41
31
|
# @!attribute [rw] start_time
|
42
32
|
# The time, in milliseconds, when Amazon Transcribe starts searching
|
43
33
|
# for the specified criteria in your audio. If you include `StartTime`
|
@@ -52,14 +42,14 @@ module Aws::TranscribeService
|
|
52
42
|
#
|
53
43
|
# @!attribute [rw] first
|
54
44
|
# The time, in milliseconds, from the start of your media file until
|
55
|
-
# the value
|
56
|
-
#
|
45
|
+
# the specified value. Amazon Transcribe searches for your specified
|
46
|
+
# criteria in this time segment.
|
57
47
|
# @return [Integer]
|
58
48
|
#
|
59
49
|
# @!attribute [rw] last
|
60
|
-
# The time, in milliseconds, from the value
|
61
|
-
#
|
62
|
-
#
|
50
|
+
# The time, in milliseconds, from the specified value until the end of
|
51
|
+
# your media file. Amazon Transcribe searches for your specified
|
52
|
+
# criteria in this time segment.
|
63
53
|
# @return [Integer]
|
64
54
|
#
|
65
55
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/AbsoluteTimeRange AWS API Documentation
|
@@ -137,7 +127,7 @@ module Aws::TranscribeService
|
|
137
127
|
# @return [String]
|
138
128
|
#
|
139
129
|
# @!attribute [rw] media_sample_rate_hertz
|
140
|
-
# The sample rate, in
|
130
|
+
# The sample rate, in hertz, of the audio track in your input media
|
141
131
|
# file.
|
142
132
|
# @return [Integer]
|
143
133
|
#
|
@@ -146,8 +136,8 @@ module Aws::TranscribeService
|
|
146
136
|
# @return [String]
|
147
137
|
#
|
148
138
|
# @!attribute [rw] media
|
149
|
-
#
|
150
|
-
#
|
139
|
+
# Provides the Amazon S3 location of the media file you used in your
|
140
|
+
# Call Analytics request.
|
151
141
|
# @return [Types::Media]
|
152
142
|
#
|
153
143
|
# @!attribute [rw] transcript
|
@@ -204,7 +194,7 @@ module Aws::TranscribeService
|
|
204
194
|
# * `Invalid sample rate for audio file`.
|
205
195
|
#
|
206
196
|
# The sample rate specified in `MediaSampleRateHertz` isn't valid.
|
207
|
-
# The sample rate must be between 8,000 and 48,000
|
197
|
+
# The sample rate must be between 8,000 and 48,000 hertz.
|
208
198
|
#
|
209
199
|
# * `The sample rate provided does not match the detected sample
|
210
200
|
# rate`.
|
@@ -231,20 +221,7 @@ module Aws::TranscribeService
|
|
231
221
|
# @return [String]
|
232
222
|
#
|
233
223
|
# @!attribute [rw] data_access_role_arn
|
234
|
-
# The Amazon Resource Name (ARN)
|
235
|
-
# to access the Amazon S3 bucket that contains your input files. If
|
236
|
-
# the role you specify doesn’t have the appropriate permissions to
|
237
|
-
# access the specified Amazon S3 location, your request fails.
|
238
|
-
#
|
239
|
-
# IAM role ARNs have the format
|
240
|
-
# `arn:partition:iam::account:role/role-name-with-path`. For example:
|
241
|
-
# `arn:aws:iam::111122223333:role/Admin`.
|
242
|
-
#
|
243
|
-
# For more information, see [IAM ARNs][1].
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
# [1]: https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns
|
224
|
+
# The Amazon Resource Name (ARN) you included in your request.
|
248
225
|
# @return [String]
|
249
226
|
#
|
250
227
|
# @!attribute [rw] identified_language_score
|
@@ -257,18 +234,13 @@ module Aws::TranscribeService
|
|
257
234
|
# @return [Float]
|
258
235
|
#
|
259
236
|
# @!attribute [rw] settings
|
260
|
-
#
|
261
|
-
#
|
262
|
-
#
|
263
|
-
# job.
|
237
|
+
# Provides information on any additional settings that were included
|
238
|
+
# in your request. Additional settings include content redaction and
|
239
|
+
# language identification settings.
|
264
240
|
# @return [Types::CallAnalyticsJobSettings]
|
265
241
|
#
|
266
242
|
# @!attribute [rw] channel_definitions
|
267
|
-
#
|
268
|
-
# Analytics job request. For example, if your agent is the first
|
269
|
-
# participant to speak, you would set `ChannelId` to `0` (to indicate
|
270
|
-
# the first channel) and `ParticipantRole` to `AGENT` (to indicate
|
271
|
-
# that it's the agent speaking).
|
243
|
+
# Indicates which speaker is on which channel.
|
272
244
|
# @return [Array<Types::ChannelDefinition>]
|
273
245
|
#
|
274
246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CallAnalyticsJob AWS API Documentation
|
@@ -295,49 +267,26 @@ module Aws::TranscribeService
|
|
295
267
|
|
296
268
|
# Provides additional optional settings for your request, including
|
297
269
|
# content redaction, automatic language identification; allows you to
|
298
|
-
# apply custom language models, vocabulary filters, and custom
|
270
|
+
# apply custom language models, custom vocabulary filters, and custom
|
299
271
|
# vocabularies.
|
300
272
|
#
|
301
|
-
# @note When making an API call, you may pass CallAnalyticsJobSettings
|
302
|
-
# data as a hash:
|
303
|
-
#
|
304
|
-
# {
|
305
|
-
# vocabulary_name: "VocabularyName",
|
306
|
-
# vocabulary_filter_name: "VocabularyFilterName",
|
307
|
-
# vocabulary_filter_method: "remove", # accepts remove, mask, tag
|
308
|
-
# language_model_name: "ModelName",
|
309
|
-
# content_redaction: {
|
310
|
-
# redaction_type: "PII", # required, accepts PII
|
311
|
-
# redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
|
312
|
-
# pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, ALL
|
313
|
-
# },
|
314
|
-
# language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
|
315
|
-
# language_id_settings: {
|
316
|
-
# "af-ZA" => {
|
317
|
-
# vocabulary_name: "VocabularyName",
|
318
|
-
# vocabulary_filter_name: "VocabularyFilterName",
|
319
|
-
# language_model_name: "ModelName",
|
320
|
-
# },
|
321
|
-
# },
|
322
|
-
# }
|
323
|
-
#
|
324
273
|
# @!attribute [rw] vocabulary_name
|
325
274
|
# The name of the custom vocabulary you want to include in your Call
|
326
|
-
# Analytics transcription request.
|
275
|
+
# Analytics transcription request. Custom vocabulary names are case
|
327
276
|
# sensitive.
|
328
277
|
# @return [String]
|
329
278
|
#
|
330
279
|
# @!attribute [rw] vocabulary_filter_name
|
331
280
|
# The name of the custom vocabulary filter you want to include in your
|
332
|
-
# Call Analytics transcription request.
|
333
|
-
# case sensitive.
|
281
|
+
# Call Analytics transcription request. Custom vocabulary filter names
|
282
|
+
# are case sensitive.
|
334
283
|
#
|
335
284
|
# Note that if you include `VocabularyFilterName` in your request, you
|
336
285
|
# must also include `VocabularyFilterMethod`.
|
337
286
|
# @return [String]
|
338
287
|
#
|
339
288
|
# @!attribute [rw] vocabulary_filter_method
|
340
|
-
# Specify how you want your vocabulary filter applied to your
|
289
|
+
# Specify how you want your custom vocabulary filter applied to your
|
341
290
|
# transcript.
|
342
291
|
#
|
343
292
|
# To replace words with `***`, choose `mask`.
|
@@ -349,25 +298,25 @@ module Aws::TranscribeService
|
|
349
298
|
#
|
350
299
|
# @!attribute [rw] language_model_name
|
351
300
|
# The name of the custom language model you want to use when
|
352
|
-
# processing your Call Analytics job. Note that language model
|
353
|
-
# are case sensitive.
|
301
|
+
# processing your Call Analytics job. Note that custom language model
|
302
|
+
# names are case sensitive.
|
354
303
|
#
|
355
|
-
# The language of the specified language model must match the
|
356
|
-
# code you specify in your transcription request. If the
|
357
|
-
# don't match, the language model isn't applied.
|
358
|
-
# or warnings associated with a language mismatch.
|
304
|
+
# The language of the specified custom language model must match the
|
305
|
+
# language code that you specify in your transcription request. If the
|
306
|
+
# languages don't match, the custom language model isn't applied.
|
307
|
+
# There are no errors or warnings associated with a language mismatch.
|
359
308
|
# @return [String]
|
360
309
|
#
|
361
310
|
# @!attribute [rw] content_redaction
|
362
|
-
#
|
363
|
-
# information (PII) in your transcript. If you use
|
364
|
-
# you must also include the sub-parameters:
|
365
|
-
# `RedactionOutput`, and `RedactionType`.
|
311
|
+
# Makes it possible to redact or flag specified personally
|
312
|
+
# identifiable information (PII) in your transcript. If you use
|
313
|
+
# `ContentRedaction`, you must also include the sub-parameters:
|
314
|
+
# `PiiEntityTypes`, `RedactionOutput`, and `RedactionType`.
|
366
315
|
# @return [Types::ContentRedaction]
|
367
316
|
#
|
368
317
|
# @!attribute [rw] language_options
|
369
318
|
# You can specify two or more language codes that represent the
|
370
|
-
# languages you think may be present in your media
|
319
|
+
# languages you think may be present in your media. Including more
|
371
320
|
# than five is not recommended. If you're unsure what languages are
|
372
321
|
# present, do not include this parameter.
|
373
322
|
#
|
@@ -377,40 +326,44 @@ module Aws::TranscribeService
|
|
377
326
|
# For a list of languages supported with Call Analytics, refer to the
|
378
327
|
# [Supported languages][1] table.
|
379
328
|
#
|
329
|
+
# To transcribe speech in Modern Standard Arabic (`ar-SA`), your media
|
330
|
+
# file must be encoded at a sample rate of 16,000 Hz or higher.
|
331
|
+
#
|
380
332
|
#
|
381
333
|
#
|
382
334
|
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
|
383
335
|
# @return [Array<String>]
|
384
336
|
#
|
385
337
|
# @!attribute [rw] language_id_settings
|
386
|
-
# If using automatic language identification
|
387
|
-
#
|
388
|
-
#
|
389
|
-
#
|
390
|
-
#
|
391
|
-
#
|
392
|
-
# You can specify two or more language codes that represent the
|
393
|
-
# languages you think may be present in your media; including more
|
394
|
-
# than five is not recommended. Each language code you include can
|
395
|
-
# have an associated custom language model, custom vocabulary, and
|
396
|
-
# custom vocabulary filter. The languages you specify must match the
|
397
|
-
# languages of the specified custom language models, custom
|
398
|
-
# vocabularies, and custom vocabulary filters.
|
338
|
+
# If using automatic language identification in your request and you
|
339
|
+
# want to apply a custom language model, a custom vocabulary, or a
|
340
|
+
# custom vocabulary filter, include `LanguageIdSettings` with the
|
341
|
+
# relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and
|
342
|
+
# `VocabularyFilterName`).
|
399
343
|
#
|
400
|
-
#
|
401
|
-
#
|
402
|
-
# vocabulary
|
403
|
-
#
|
404
|
-
#
|
344
|
+
# `LanguageIdSettings` supports two to five language codes. Each
|
345
|
+
# language code you include can have an associated custom language
|
346
|
+
# model, custom vocabulary, and custom vocabulary filter. The language
|
347
|
+
# codes that you specify must match the languages of the associated
|
348
|
+
# custom language models, custom vocabularies, and custom vocabulary
|
349
|
+
# filters.
|
405
350
|
#
|
406
|
-
#
|
407
|
-
#
|
408
|
-
#
|
409
|
-
#
|
410
|
-
#
|
411
|
-
#
|
412
|
-
#
|
413
|
-
#
|
351
|
+
# It's recommended that you include `LanguageOptions` when using
|
352
|
+
# `LanguageIdSettings` to ensure that the correct language dialect is
|
353
|
+
# identified. For example, if you specify a custom vocabulary that is
|
354
|
+
# in `en-US` but Amazon Transcribe determines that the language spoken
|
355
|
+
# in your media is `en-AU`, your custom vocabulary *is not* applied to
|
356
|
+
# your transcription. If you include `LanguageOptions` and include
|
357
|
+
# `en-US` as the only English language dialect, your custom vocabulary
|
358
|
+
# *is* applied to your transcription.
|
359
|
+
#
|
360
|
+
# If you want to include a custom language model, custom vocabulary,
|
361
|
+
# or custom vocabulary filter with your request but **do not** want to
|
362
|
+
# use automatic language identification, use instead the ` parameter
|
363
|
+
# with the LanguageModelName, VocabularyName, or VocabularyFilterName
|
364
|
+
# sub-parameters.</p> For a list of languages supported with Call
|
365
|
+
# Analytics, refer to Supported languages and language-specific
|
366
|
+
# features.
|
414
367
|
# `
|
415
368
|
# @return [Hash<String,Types::LanguageIdSettings>]
|
416
369
|
#
|
@@ -532,31 +485,31 @@ module Aws::TranscribeService
|
|
532
485
|
# UTC-7 on May 5, 2022.
|
533
486
|
# @return [Time]
|
534
487
|
#
|
488
|
+
# @!attribute [rw] input_type
|
489
|
+
# The input type associated with the specified category. `POST_CALL`
|
490
|
+
# refers to a category that is applied to batch transcriptions;
|
491
|
+
# `REAL_TIME` refers to a category that is applied to streaming
|
492
|
+
# transcriptions.
|
493
|
+
# @return [String]
|
494
|
+
#
|
535
495
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CategoryProperties AWS API Documentation
|
536
496
|
#
|
537
497
|
class CategoryProperties < Struct.new(
|
538
498
|
:category_name,
|
539
499
|
:rules,
|
540
500
|
:create_time,
|
541
|
-
:last_update_time
|
501
|
+
:last_update_time,
|
502
|
+
:input_type)
|
542
503
|
SENSITIVE = []
|
543
504
|
include Aws::Structure
|
544
505
|
end
|
545
506
|
|
546
|
-
#
|
547
|
-
# if your agent is the first participant to speak, you would
|
548
|
-
# `ChannelId` to `0` (to indicate the first channel) and
|
507
|
+
# Makes it possible to specify which speaker is on which channel. For
|
508
|
+
# example, if your agent is the first participant to speak, you would
|
509
|
+
# set `ChannelId` to `0` (to indicate the first channel) and
|
549
510
|
# `ParticipantRole` to `AGENT` (to indicate that it's the agent
|
550
511
|
# speaking).
|
551
512
|
#
|
552
|
-
# @note When making an API call, you may pass ChannelDefinition
|
553
|
-
# data as a hash:
|
554
|
-
#
|
555
|
-
# {
|
556
|
-
# channel_id: 1,
|
557
|
-
# participant_role: "AGENT", # accepts AGENT, CUSTOMER
|
558
|
-
# }
|
559
|
-
#
|
560
513
|
# @!attribute [rw] channel_id
|
561
514
|
# Specify the audio channel you want to define.
|
562
515
|
# @return [Integer]
|
@@ -589,20 +542,11 @@ module Aws::TranscribeService
|
|
589
542
|
include Aws::Structure
|
590
543
|
end
|
591
544
|
|
592
|
-
#
|
545
|
+
# Makes it possible to redact or flag specified personally identifiable
|
593
546
|
# information (PII) in your transcript. If you use `ContentRedaction`,
|
594
547
|
# you must also include the sub-parameters: `PiiEntityTypes`,
|
595
548
|
# `RedactionOutput`, and `RedactionType`.
|
596
549
|
#
|
597
|
-
# @note When making an API call, you may pass ContentRedaction
|
598
|
-
# data as a hash:
|
599
|
-
#
|
600
|
-
# {
|
601
|
-
# redaction_type: "PII", # required, accepts PII
|
602
|
-
# redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
|
603
|
-
# pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, ALL
|
604
|
-
# }
|
605
|
-
#
|
606
550
|
# @!attribute [rw] redaction_type
|
607
551
|
# Specify the category of information you want to redact; `PII`
|
608
552
|
# (personally identifiable information) is the only valid value. You
|
@@ -637,85 +581,6 @@ module Aws::TranscribeService
|
|
637
581
|
include Aws::Structure
|
638
582
|
end
|
639
583
|
|
640
|
-
# @note When making an API call, you may pass CreateCallAnalyticsCategoryRequest
|
641
|
-
# data as a hash:
|
642
|
-
#
|
643
|
-
# {
|
644
|
-
# category_name: "CategoryName", # required
|
645
|
-
# rules: [ # required
|
646
|
-
# {
|
647
|
-
# non_talk_time_filter: {
|
648
|
-
# threshold: 1,
|
649
|
-
# absolute_time_range: {
|
650
|
-
# start_time: 1,
|
651
|
-
# end_time: 1,
|
652
|
-
# first: 1,
|
653
|
-
# last: 1,
|
654
|
-
# },
|
655
|
-
# relative_time_range: {
|
656
|
-
# start_percentage: 1,
|
657
|
-
# end_percentage: 1,
|
658
|
-
# first: 1,
|
659
|
-
# last: 1,
|
660
|
-
# },
|
661
|
-
# negate: false,
|
662
|
-
# },
|
663
|
-
# interruption_filter: {
|
664
|
-
# threshold: 1,
|
665
|
-
# participant_role: "AGENT", # accepts AGENT, CUSTOMER
|
666
|
-
# absolute_time_range: {
|
667
|
-
# start_time: 1,
|
668
|
-
# end_time: 1,
|
669
|
-
# first: 1,
|
670
|
-
# last: 1,
|
671
|
-
# },
|
672
|
-
# relative_time_range: {
|
673
|
-
# start_percentage: 1,
|
674
|
-
# end_percentage: 1,
|
675
|
-
# first: 1,
|
676
|
-
# last: 1,
|
677
|
-
# },
|
678
|
-
# negate: false,
|
679
|
-
# },
|
680
|
-
# transcript_filter: {
|
681
|
-
# transcript_filter_type: "EXACT", # required, accepts EXACT
|
682
|
-
# absolute_time_range: {
|
683
|
-
# start_time: 1,
|
684
|
-
# end_time: 1,
|
685
|
-
# first: 1,
|
686
|
-
# last: 1,
|
687
|
-
# },
|
688
|
-
# relative_time_range: {
|
689
|
-
# start_percentage: 1,
|
690
|
-
# end_percentage: 1,
|
691
|
-
# first: 1,
|
692
|
-
# last: 1,
|
693
|
-
# },
|
694
|
-
# participant_role: "AGENT", # accepts AGENT, CUSTOMER
|
695
|
-
# negate: false,
|
696
|
-
# targets: ["NonEmptyString"], # required
|
697
|
-
# },
|
698
|
-
# sentiment_filter: {
|
699
|
-
# sentiments: ["POSITIVE"], # required, accepts POSITIVE, NEGATIVE, NEUTRAL, MIXED
|
700
|
-
# absolute_time_range: {
|
701
|
-
# start_time: 1,
|
702
|
-
# end_time: 1,
|
703
|
-
# first: 1,
|
704
|
-
# last: 1,
|
705
|
-
# },
|
706
|
-
# relative_time_range: {
|
707
|
-
# start_percentage: 1,
|
708
|
-
# end_percentage: 1,
|
709
|
-
# first: 1,
|
710
|
-
# last: 1,
|
711
|
-
# },
|
712
|
-
# participant_role: "AGENT", # accepts AGENT, CUSTOMER
|
713
|
-
# negate: false,
|
714
|
-
# },
|
715
|
-
# },
|
716
|
-
# ],
|
717
|
-
# }
|
718
|
-
#
|
719
584
|
# @!attribute [rw] category_name
|
720
585
|
# A unique name, chosen by you, for your Call Analytics category.
|
721
586
|
# It's helpful to use a detailed naming system that will make sense
|
@@ -727,19 +592,36 @@ module Aws::TranscribeService
|
|
727
592
|
# @return [String]
|
728
593
|
#
|
729
594
|
# @!attribute [rw] rules
|
730
|
-
# Rules define a Call Analytics category. When creating a new
|
731
|
-
#
|
732
|
-
#
|
733
|
-
#
|
734
|
-
#
|
735
|
-
#
|
595
|
+
# Rules define a Call Analytics category. When creating a new
|
596
|
+
# category, you must create between 1 and 20 rules for that category.
|
597
|
+
# For each rule, you specify a filter you want applied to the
|
598
|
+
# attributes of a call. For example, you can choose a sentiment filter
|
599
|
+
# that detects if a customer's sentiment was positive during the last
|
600
|
+
# 30 seconds of the call.
|
736
601
|
# @return [Array<Types::Rule>]
|
737
602
|
#
|
603
|
+
# @!attribute [rw] input_type
|
604
|
+
# Choose whether you want to create a streaming or a batch category
|
605
|
+
# for your Call Analytics transcription.
|
606
|
+
#
|
607
|
+
# Specifying `POST_CALL` assigns your category to batch
|
608
|
+
# transcriptions; categories with this input type cannot be applied to
|
609
|
+
# streaming (real-time) transcriptions.
|
610
|
+
#
|
611
|
+
# Specifying `REAL_TIME` assigns your category to streaming
|
612
|
+
# transcriptions; categories with this input type cannot be applied to
|
613
|
+
# batch (post-call) transcriptions.
|
614
|
+
#
|
615
|
+
# If you do not include `InputType`, your category is created as a
|
616
|
+
# batch category by default.
|
617
|
+
# @return [String]
|
618
|
+
#
|
738
619
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateCallAnalyticsCategoryRequest AWS API Documentation
|
739
620
|
#
|
740
621
|
class CreateCallAnalyticsCategoryRequest < Struct.new(
|
741
622
|
:category_name,
|
742
|
-
:rules
|
623
|
+
:rules,
|
624
|
+
:input_type)
|
743
625
|
SENSITIVE = []
|
744
626
|
include Aws::Structure
|
745
627
|
end
|
@@ -757,41 +639,21 @@ module Aws::TranscribeService
|
|
757
639
|
include Aws::Structure
|
758
640
|
end
|
759
641
|
|
760
|
-
# @note When making an API call, you may pass CreateLanguageModelRequest
|
761
|
-
# data as a hash:
|
762
|
-
#
|
763
|
-
# {
|
764
|
-
# language_code: "en-US", # required, accepts en-US, hi-IN, es-US, en-GB, en-AU
|
765
|
-
# base_model_name: "NarrowBand", # required, accepts NarrowBand, WideBand
|
766
|
-
# model_name: "ModelName", # required
|
767
|
-
# input_data_config: { # required
|
768
|
-
# s3_uri: "Uri", # required
|
769
|
-
# tuning_data_s3_uri: "Uri",
|
770
|
-
# data_access_role_arn: "DataAccessRoleArn", # required
|
771
|
-
# },
|
772
|
-
# tags: [
|
773
|
-
# {
|
774
|
-
# key: "TagKey", # required
|
775
|
-
# value: "TagValue", # required
|
776
|
-
# },
|
777
|
-
# ],
|
778
|
-
# }
|
779
|
-
#
|
780
642
|
# @!attribute [rw] language_code
|
781
643
|
# The language code that represents the language of your model. Each
|
782
|
-
# language model must contain terms in only one language, and
|
783
|
-
# language you select for your model must match
|
784
|
-
# training and tuning data.
|
644
|
+
# custom language model must contain terms in only one language, and
|
645
|
+
# the language you select for your custom language model must match
|
646
|
+
# the language of your training and tuning data.
|
785
647
|
#
|
786
648
|
# For a list of supported languages and their associated language
|
787
|
-
# codes, refer to the [Supported languages][1] table. Note that
|
649
|
+
# codes, refer to the [Supported languages][1] table. Note that US
|
788
650
|
# English (`en-US`) is the only language supported with Amazon
|
789
651
|
# Transcribe Medical.
|
790
652
|
#
|
791
653
|
# A custom language model can only be used to transcribe files in the
|
792
|
-
# same language as the model. For example, if you create a
|
793
|
-
# model using US English (`en-US`), you can only apply this
|
794
|
-
# files that contain English audio.
|
654
|
+
# same language as the model. For example, if you create a custom
|
655
|
+
# language model using US English (`en-US`), you can only apply this
|
656
|
+
# model to files that contain English audio.
|
795
657
|
#
|
796
658
|
#
|
797
659
|
#
|
@@ -813,8 +675,8 @@ module Aws::TranscribeService
|
|
813
675
|
#
|
814
676
|
# This name is case sensitive, cannot contain spaces, and must be
|
815
677
|
# unique within an Amazon Web Services account. If you try to create a
|
816
|
-
# new language model with the same name as an existing
|
817
|
-
# you get a `ConflictException` error.
|
678
|
+
# new custom language model with the same name as an existing custom
|
679
|
+
# language model, you get a `ConflictException` error.
|
818
680
|
# @return [String]
|
819
681
|
#
|
820
682
|
# @!attribute [rw] input_data_config
|
@@ -893,29 +755,14 @@ module Aws::TranscribeService
|
|
893
755
|
include Aws::Structure
|
894
756
|
end
|
895
757
|
|
896
|
-
# @note When making an API call, you may pass CreateMedicalVocabularyRequest
|
897
|
-
# data as a hash:
|
898
|
-
#
|
899
|
-
# {
|
900
|
-
# vocabulary_name: "VocabularyName", # required
|
901
|
-
# language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
|
902
|
-
# vocabulary_file_uri: "Uri", # required
|
903
|
-
# tags: [
|
904
|
-
# {
|
905
|
-
# key: "TagKey", # required
|
906
|
-
# value: "TagValue", # required
|
907
|
-
# },
|
908
|
-
# ],
|
909
|
-
# }
|
910
|
-
#
|
911
758
|
# @!attribute [rw] vocabulary_name
|
912
759
|
# A unique name, chosen by you, for your new custom medical
|
913
760
|
# vocabulary.
|
914
761
|
#
|
915
762
|
# This name is case sensitive, cannot contain spaces, and must be
|
916
763
|
# unique within an Amazon Web Services account. If you try to create a
|
917
|
-
# new medical vocabulary with the same name as an existing
|
918
|
-
# vocabulary, you get a `ConflictException` error.
|
764
|
+
# new custom medical vocabulary with the same name as an existing
|
765
|
+
# custom medical vocabulary, you get a `ConflictException` error.
|
919
766
|
# @return [String]
|
920
767
|
#
|
921
768
|
# @!attribute [rw] language_code
|
@@ -935,8 +782,8 @@ module Aws::TranscribeService
|
|
935
782
|
#
|
936
783
|
# @!attribute [rw] tags
|
937
784
|
# Adds one or more custom tags, each in the form of a key:value pair,
|
938
|
-
# to a new medical vocabulary at the time you create this new
|
939
|
-
# vocabulary.
|
785
|
+
# to a new custom medical vocabulary at the time you create this new
|
786
|
+
# custom vocabulary.
|
940
787
|
#
|
941
788
|
# To learn more about using tags with Amazon Transcribe, refer to
|
942
789
|
# [Tagging resources][1].
|
@@ -962,14 +809,14 @@ module Aws::TranscribeService
|
|
962
809
|
# @return [String]
|
963
810
|
#
|
964
811
|
# @!attribute [rw] language_code
|
965
|
-
# The language code you selected for your medical vocabulary.
|
966
|
-
# English (`en-US`) is the only language supported with Amazon
|
812
|
+
# The language code you selected for your custom medical vocabulary.
|
813
|
+
# US English (`en-US`) is the only language supported with Amazon
|
967
814
|
# Transcribe Medical.
|
968
815
|
# @return [String]
|
969
816
|
#
|
970
817
|
# @!attribute [rw] vocabulary_state
|
971
818
|
# The processing state of your custom medical vocabulary. If the state
|
972
|
-
# is `READY`, you can use the vocabulary in a
|
819
|
+
# is `READY`, you can use the custom vocabulary in a
|
973
820
|
# `StartMedicalTranscriptionJob` request.
|
974
821
|
# @return [String]
|
975
822
|
#
|
@@ -1003,40 +850,24 @@ module Aws::TranscribeService
|
|
1003
850
|
include Aws::Structure
|
1004
851
|
end
|
1005
852
|
|
1006
|
-
# @note When making an API call, you may pass CreateVocabularyFilterRequest
|
1007
|
-
# data as a hash:
|
1008
|
-
#
|
1009
|
-
# {
|
1010
|
-
# vocabulary_filter_name: "VocabularyFilterName", # required
|
1011
|
-
# language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
|
1012
|
-
# words: ["Word"],
|
1013
|
-
# vocabulary_filter_file_uri: "Uri",
|
1014
|
-
# tags: [
|
1015
|
-
# {
|
1016
|
-
# key: "TagKey", # required
|
1017
|
-
# value: "TagValue", # required
|
1018
|
-
# },
|
1019
|
-
# ],
|
1020
|
-
# }
|
1021
|
-
#
|
1022
853
|
# @!attribute [rw] vocabulary_filter_name
|
1023
854
|
# A unique name, chosen by you, for your new custom vocabulary filter.
|
1024
855
|
#
|
1025
856
|
# This name is case sensitive, cannot contain spaces, and must be
|
1026
857
|
# unique within an Amazon Web Services account. If you try to create a
|
1027
|
-
# new vocabulary filter with the same name as an existing
|
1028
|
-
# filter, you get a `ConflictException` error.
|
858
|
+
# new custom vocabulary filter with the same name as an existing
|
859
|
+
# custom vocabulary filter, you get a `ConflictException` error.
|
1029
860
|
# @return [String]
|
1030
861
|
#
|
1031
862
|
# @!attribute [rw] language_code
|
1032
863
|
# The language code that represents the language of the entries in
|
1033
|
-
# your vocabulary filter. Each vocabulary filter must contain
|
1034
|
-
# only one language.
|
864
|
+
# your vocabulary filter. Each custom vocabulary filter must contain
|
865
|
+
# terms in only one language.
|
1035
866
|
#
|
1036
|
-
# A vocabulary filter can only be used to transcribe files in
|
1037
|
-
# language as the filter. For example, if you create a
|
1038
|
-
# filter using US English (`en-US`), you can only apply
|
1039
|
-
# files that contain English audio.
|
867
|
+
# A custom vocabulary filter can only be used to transcribe files in
|
868
|
+
# the same language as the filter. For example, if you create a custom
|
869
|
+
# vocabulary filter using US English (`en-US`), you can only apply
|
870
|
+
# this filter to files that contain English audio.
|
1040
871
|
#
|
1041
872
|
# For a list of supported languages and their associated language
|
1042
873
|
# codes, refer to the [Supported languages][1] table.
|
@@ -1047,11 +878,11 @@ module Aws::TranscribeService
|
|
1047
878
|
# @return [String]
|
1048
879
|
#
|
1049
880
|
# @!attribute [rw] words
|
1050
|
-
# Use this parameter if you want to create your vocabulary
|
1051
|
-
# including all desired terms, as comma-separated values,
|
1052
|
-
# request. The other option for creating your vocabulary
|
1053
|
-
# save your entries in a text file and upload them to an
|
1054
|
-
# bucket, then specify the location of your file using the
|
881
|
+
# Use this parameter if you want to create your custom vocabulary
|
882
|
+
# filter by including all desired terms, as comma-separated values,
|
883
|
+
# within your request. The other option for creating your vocabulary
|
884
|
+
# filter is to save your entries in a text file and upload them to an
|
885
|
+
# Amazon S3 bucket, then specify the location of your file using the
|
1055
886
|
# `VocabularyFilterFileUri` parameter.
|
1056
887
|
#
|
1057
888
|
# Note that if you include `Words` in your request, you cannot use
|
@@ -1059,7 +890,7 @@ module Aws::TranscribeService
|
|
1059
890
|
#
|
1060
891
|
# Each language has a character set that contains all allowed
|
1061
892
|
# characters for that specific language. If you use unsupported
|
1062
|
-
# characters, your vocabulary filter request fails. Refer to
|
893
|
+
# characters, your custom vocabulary filter request fails. Refer to
|
1063
894
|
# [Character Sets for Custom Vocabularies][1] to get the character set
|
1064
895
|
# for your language.
|
1065
896
|
#
|
@@ -1083,7 +914,7 @@ module Aws::TranscribeService
|
|
1083
914
|
# @!attribute [rw] tags
|
1084
915
|
# Adds one or more custom tags, each in the form of a key:value pair,
|
1085
916
|
# to a new custom vocabulary filter at the time you create this new
|
1086
|
-
# filter.
|
917
|
+
# vocabulary filter.
|
1087
918
|
#
|
1088
919
|
# To learn more about using tags with Amazon Transcribe, refer to
|
1089
920
|
# [Tagging resources][1].
|
@@ -1110,11 +941,11 @@ module Aws::TranscribeService
|
|
1110
941
|
# @return [String]
|
1111
942
|
#
|
1112
943
|
# @!attribute [rw] language_code
|
1113
|
-
# The language code you selected for your vocabulary filter.
|
944
|
+
# The language code you selected for your custom vocabulary filter.
|
1114
945
|
# @return [String]
|
1115
946
|
#
|
1116
947
|
# @!attribute [rw] last_modified_time
|
1117
|
-
# The date and time you created your vocabulary filter.
|
948
|
+
# The date and time you created your custom vocabulary filter.
|
1118
949
|
#
|
1119
950
|
# Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
|
1120
951
|
# example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
|
@@ -1131,40 +962,24 @@ module Aws::TranscribeService
|
|
1131
962
|
include Aws::Structure
|
1132
963
|
end
|
1133
964
|
|
1134
|
-
# @note When making an API call, you may pass CreateVocabularyRequest
|
1135
|
-
# data as a hash:
|
1136
|
-
#
|
1137
|
-
# {
|
1138
|
-
# vocabulary_name: "VocabularyName", # required
|
1139
|
-
# language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
|
1140
|
-
# phrases: ["Phrase"],
|
1141
|
-
# vocabulary_file_uri: "Uri",
|
1142
|
-
# tags: [
|
1143
|
-
# {
|
1144
|
-
# key: "TagKey", # required
|
1145
|
-
# value: "TagValue", # required
|
1146
|
-
# },
|
1147
|
-
# ],
|
1148
|
-
# }
|
1149
|
-
#
|
1150
965
|
# @!attribute [rw] vocabulary_name
|
1151
966
|
# A unique name, chosen by you, for your new custom vocabulary.
|
1152
967
|
#
|
1153
968
|
# This name is case sensitive, cannot contain spaces, and must be
|
1154
969
|
# unique within an Amazon Web Services account. If you try to create a
|
1155
|
-
# new vocabulary with the same name as an existing
|
1156
|
-
# a `ConflictException` error.
|
970
|
+
# new custom vocabulary with the same name as an existing custom
|
971
|
+
# vocabulary, you get a `ConflictException` error.
|
1157
972
|
# @return [String]
|
1158
973
|
#
|
1159
974
|
# @!attribute [rw] language_code
|
1160
975
|
# The language code that represents the language of the entries in
|
1161
|
-
# your custom vocabulary. Each vocabulary must contain terms in
|
1162
|
-
# one language.
|
976
|
+
# your custom vocabulary. Each custom vocabulary must contain terms in
|
977
|
+
# only one language.
|
1163
978
|
#
|
1164
979
|
# A custom vocabulary can only be used to transcribe files in the same
|
1165
|
-
# language as the vocabulary. For example, if you create a
|
1166
|
-
# using US English (`en-US`), you can only apply
|
1167
|
-
# files that contain English audio.
|
980
|
+
# language as the custom vocabulary. For example, if you create a
|
981
|
+
# custom vocabulary using US English (`en-US`), you can only apply
|
982
|
+
# this custom vocabulary to files that contain English audio.
|
1168
983
|
#
|
1169
984
|
# For a list of supported languages and their associated language
|
1170
985
|
# codes, refer to the [Supported languages][1] table.
|
@@ -1175,19 +990,19 @@ module Aws::TranscribeService
|
|
1175
990
|
# @return [String]
|
1176
991
|
#
|
1177
992
|
# @!attribute [rw] phrases
|
1178
|
-
# Use this parameter if you want to create your vocabulary by
|
993
|
+
# Use this parameter if you want to create your custom vocabulary by
|
1179
994
|
# including all desired terms, as comma-separated values, within your
|
1180
|
-
# request. The other option for creating your vocabulary is to
|
1181
|
-
# your entries in a text file and upload them to an Amazon S3
|
1182
|
-
# then specify the location of your file using the
|
1183
|
-
# parameter.
|
995
|
+
# request. The other option for creating your custom vocabulary is to
|
996
|
+
# save your entries in a text file and upload them to an Amazon S3
|
997
|
+
# bucket, then specify the location of your file using the
|
998
|
+
# `VocabularyFileUri` parameter.
|
1184
999
|
#
|
1185
1000
|
# Note that if you include `Phrases` in your request, you cannot use
|
1186
1001
|
# `VocabularyFileUri`; you must choose one or the other.
|
1187
1002
|
#
|
1188
1003
|
# Each language has a character set that contains all allowed
|
1189
1004
|
# characters for that specific language. If you use unsupported
|
1190
|
-
# characters, your vocabulary filter request fails. Refer to
|
1005
|
+
# characters, your custom vocabulary filter request fails. Refer to
|
1191
1006
|
# [Character Sets for Custom Vocabularies][1] to get the character set
|
1192
1007
|
# for your language.
|
1193
1008
|
#
|
@@ -1210,7 +1025,7 @@ module Aws::TranscribeService
|
|
1210
1025
|
#
|
1211
1026
|
# @!attribute [rw] tags
|
1212
1027
|
# Adds one or more custom tags, each in the form of a key:value pair,
|
1213
|
-
# to a new custom vocabulary at the time you create this new
|
1028
|
+
# to a new custom vocabulary at the time you create this new custom
|
1214
1029
|
# vocabulary.
|
1215
1030
|
#
|
1216
1031
|
# To learn more about using tags with Amazon Transcribe, refer to
|
@@ -1243,8 +1058,8 @@ module Aws::TranscribeService
|
|
1243
1058
|
#
|
1244
1059
|
# @!attribute [rw] vocabulary_state
|
1245
1060
|
# The processing state of your custom vocabulary. If the state is
|
1246
|
-
# `READY`, you can use the vocabulary in a
|
1247
|
-
# request.
|
1061
|
+
# `READY`, you can use the custom vocabulary in a
|
1062
|
+
# `StartTranscriptionJob` request.
|
1248
1063
|
# @return [String]
|
1249
1064
|
#
|
1250
1065
|
# @!attribute [rw] last_modified_time
|
@@ -1257,8 +1072,8 @@ module Aws::TranscribeService
|
|
1257
1072
|
#
|
1258
1073
|
# @!attribute [rw] failure_reason
|
1259
1074
|
# If `VocabularyState` is `FAILED`, `FailureReason` contains
|
1260
|
-
# information about why the vocabulary request failed. See
|
1261
|
-
# [Common Errors][1].
|
1075
|
+
# information about why the custom vocabulary request failed. See
|
1076
|
+
# also: [Common Errors][1].
|
1262
1077
|
#
|
1263
1078
|
#
|
1264
1079
|
#
|
@@ -1277,13 +1092,6 @@ module Aws::TranscribeService
|
|
1277
1092
|
include Aws::Structure
|
1278
1093
|
end
|
1279
1094
|
|
1280
|
-
# @note When making an API call, you may pass DeleteCallAnalyticsCategoryRequest
|
1281
|
-
# data as a hash:
|
1282
|
-
#
|
1283
|
-
# {
|
1284
|
-
# category_name: "CategoryName", # required
|
1285
|
-
# }
|
1286
|
-
#
|
1287
1095
|
# @!attribute [rw] category_name
|
1288
1096
|
# The name of the Call Analytics category you want to delete. Category
|
1289
1097
|
# names are case sensitive.
|
@@ -1301,13 +1109,6 @@ module Aws::TranscribeService
|
|
1301
1109
|
#
|
1302
1110
|
class DeleteCallAnalyticsCategoryResponse < Aws::EmptyStructure; end
|
1303
1111
|
|
1304
|
-
# @note When making an API call, you may pass DeleteCallAnalyticsJobRequest
|
1305
|
-
# data as a hash:
|
1306
|
-
#
|
1307
|
-
# {
|
1308
|
-
# call_analytics_job_name: "CallAnalyticsJobName", # required
|
1309
|
-
# }
|
1310
|
-
#
|
1311
1112
|
# @!attribute [rw] call_analytics_job_name
|
1312
1113
|
# The name of the Call Analytics job you want to delete. Job names are
|
1313
1114
|
# case sensitive.
|
@@ -1325,13 +1126,6 @@ module Aws::TranscribeService
|
|
1325
1126
|
#
|
1326
1127
|
class DeleteCallAnalyticsJobResponse < Aws::EmptyStructure; end
|
1327
1128
|
|
1328
|
-
# @note When making an API call, you may pass DeleteLanguageModelRequest
|
1329
|
-
# data as a hash:
|
1330
|
-
#
|
1331
|
-
# {
|
1332
|
-
# model_name: "ModelName", # required
|
1333
|
-
# }
|
1334
|
-
#
|
1335
1129
|
# @!attribute [rw] model_name
|
1336
1130
|
# The name of the custom language model you want to delete. Model
|
1337
1131
|
# names are case sensitive.
|
@@ -1345,13 +1139,6 @@ module Aws::TranscribeService
|
|
1345
1139
|
include Aws::Structure
|
1346
1140
|
end
|
1347
1141
|
|
1348
|
-
# @note When making an API call, you may pass DeleteMedicalTranscriptionJobRequest
|
1349
|
-
# data as a hash:
|
1350
|
-
#
|
1351
|
-
# {
|
1352
|
-
# medical_transcription_job_name: "TranscriptionJobName", # required
|
1353
|
-
# }
|
1354
|
-
#
|
1355
1142
|
# @!attribute [rw] medical_transcription_job_name
|
1356
1143
|
# The name of the medical transcription job you want to delete. Job
|
1357
1144
|
# names are case sensitive.
|
@@ -1365,16 +1152,9 @@ module Aws::TranscribeService
|
|
1365
1152
|
include Aws::Structure
|
1366
1153
|
end
|
1367
1154
|
|
1368
|
-
# @note When making an API call, you may pass DeleteMedicalVocabularyRequest
|
1369
|
-
# data as a hash:
|
1370
|
-
#
|
1371
|
-
# {
|
1372
|
-
# vocabulary_name: "VocabularyName", # required
|
1373
|
-
# }
|
1374
|
-
#
|
1375
1155
|
# @!attribute [rw] vocabulary_name
|
1376
|
-
# The name of the custom medical vocabulary you want to delete.
|
1377
|
-
#
|
1156
|
+
# The name of the custom medical vocabulary you want to delete. Custom
|
1157
|
+
# medical vocabulary names are case sensitive.
|
1378
1158
|
# @return [String]
|
1379
1159
|
#
|
1380
1160
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteMedicalVocabularyRequest AWS API Documentation
|
@@ -1385,13 +1165,6 @@ module Aws::TranscribeService
|
|
1385
1165
|
include Aws::Structure
|
1386
1166
|
end
|
1387
1167
|
|
1388
|
-
# @note When making an API call, you may pass DeleteTranscriptionJobRequest
|
1389
|
-
# data as a hash:
|
1390
|
-
#
|
1391
|
-
# {
|
1392
|
-
# transcription_job_name: "TranscriptionJobName", # required
|
1393
|
-
# }
|
1394
|
-
#
|
1395
1168
|
# @!attribute [rw] transcription_job_name
|
1396
1169
|
# The name of the transcription job you want to delete. Job names are
|
1397
1170
|
# case sensitive.
|
@@ -1405,16 +1178,9 @@ module Aws::TranscribeService
|
|
1405
1178
|
include Aws::Structure
|
1406
1179
|
end
|
1407
1180
|
|
1408
|
-
# @note When making an API call, you may pass DeleteVocabularyFilterRequest
|
1409
|
-
# data as a hash:
|
1410
|
-
#
|
1411
|
-
# {
|
1412
|
-
# vocabulary_filter_name: "VocabularyFilterName", # required
|
1413
|
-
# }
|
1414
|
-
#
|
1415
1181
|
# @!attribute [rw] vocabulary_filter_name
|
1416
|
-
# The name of the custom vocabulary filter you want to delete.
|
1417
|
-
#
|
1182
|
+
# The name of the custom vocabulary filter you want to delete. Custom
|
1183
|
+
# vocabulary filter names are case sensitive.
|
1418
1184
|
# @return [String]
|
1419
1185
|
#
|
1420
1186
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabularyFilterRequest AWS API Documentation
|
@@ -1425,16 +1191,9 @@ module Aws::TranscribeService
|
|
1425
1191
|
include Aws::Structure
|
1426
1192
|
end
|
1427
1193
|
|
1428
|
-
# @note When making an API call, you may pass DeleteVocabularyRequest
|
1429
|
-
# data as a hash:
|
1430
|
-
#
|
1431
|
-
# {
|
1432
|
-
# vocabulary_name: "VocabularyName", # required
|
1433
|
-
# }
|
1434
|
-
#
|
1435
1194
|
# @!attribute [rw] vocabulary_name
|
1436
|
-
# The name of the custom vocabulary you want to delete.
|
1437
|
-
# names are case sensitive.
|
1195
|
+
# The name of the custom vocabulary you want to delete. Custom
|
1196
|
+
# vocabulary names are case sensitive.
|
1438
1197
|
# @return [String]
|
1439
1198
|
#
|
1440
1199
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabularyRequest AWS API Documentation
|
@@ -1445,13 +1204,6 @@ module Aws::TranscribeService
|
|
1445
1204
|
include Aws::Structure
|
1446
1205
|
end
|
1447
1206
|
|
1448
|
-
# @note When making an API call, you may pass DescribeLanguageModelRequest
|
1449
|
-
# data as a hash:
|
1450
|
-
#
|
1451
|
-
# {
|
1452
|
-
# model_name: "ModelName", # required
|
1453
|
-
# }
|
1454
|
-
#
|
1455
1207
|
# @!attribute [rw] model_name
|
1456
1208
|
# The name of the custom language model you want information about.
|
1457
1209
|
# Model names are case sensitive.
|
@@ -1486,13 +1238,6 @@ module Aws::TranscribeService
|
|
1486
1238
|
include Aws::Structure
|
1487
1239
|
end
|
1488
1240
|
|
1489
|
-
# @note When making an API call, you may pass GetCallAnalyticsCategoryRequest
|
1490
|
-
# data as a hash:
|
1491
|
-
#
|
1492
|
-
# {
|
1493
|
-
# category_name: "CategoryName", # required
|
1494
|
-
# }
|
1495
|
-
#
|
1496
1241
|
# @!attribute [rw] category_name
|
1497
1242
|
# The name of the Call Analytics category you want information about.
|
1498
1243
|
# Category names are case sensitive.
|
@@ -1519,13 +1264,6 @@ module Aws::TranscribeService
|
|
1519
1264
|
include Aws::Structure
|
1520
1265
|
end
|
1521
1266
|
|
1522
|
-
# @note When making an API call, you may pass GetCallAnalyticsJobRequest
|
1523
|
-
# data as a hash:
|
1524
|
-
#
|
1525
|
-
# {
|
1526
|
-
# call_analytics_job_name: "CallAnalyticsJobName", # required
|
1527
|
-
# }
|
1528
|
-
#
|
1529
1267
|
# @!attribute [rw] call_analytics_job_name
|
1530
1268
|
# The name of the Call Analytics job you want information about. Job
|
1531
1269
|
# names are case sensitive.
|
@@ -1552,13 +1290,6 @@ module Aws::TranscribeService
|
|
1552
1290
|
include Aws::Structure
|
1553
1291
|
end
|
1554
1292
|
|
1555
|
-
# @note When making an API call, you may pass GetMedicalTranscriptionJobRequest
|
1556
|
-
# data as a hash:
|
1557
|
-
#
|
1558
|
-
# {
|
1559
|
-
# medical_transcription_job_name: "TranscriptionJobName", # required
|
1560
|
-
# }
|
1561
|
-
#
|
1562
1293
|
# @!attribute [rw] medical_transcription_job_name
|
1563
1294
|
# The name of the medical transcription job you want information
|
1564
1295
|
# about. Job names are case sensitive.
|
@@ -1586,16 +1317,9 @@ module Aws::TranscribeService
|
|
1586
1317
|
include Aws::Structure
|
1587
1318
|
end
|
1588
1319
|
|
1589
|
-
# @note When making an API call, you may pass GetMedicalVocabularyRequest
|
1590
|
-
# data as a hash:
|
1591
|
-
#
|
1592
|
-
# {
|
1593
|
-
# vocabulary_name: "VocabularyName", # required
|
1594
|
-
# }
|
1595
|
-
#
|
1596
1320
|
# @!attribute [rw] vocabulary_name
|
1597
1321
|
# The name of the custom medical vocabulary you want information
|
1598
|
-
# about.
|
1322
|
+
# about. Custom medical vocabulary names are case sensitive.
|
1599
1323
|
# @return [String]
|
1600
1324
|
#
|
1601
1325
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabularyRequest AWS API Documentation
|
@@ -1612,14 +1336,14 @@ module Aws::TranscribeService
|
|
1612
1336
|
# @return [String]
|
1613
1337
|
#
|
1614
1338
|
# @!attribute [rw] language_code
|
1615
|
-
# The language code you selected for your medical vocabulary.
|
1616
|
-
# English (`en-US`) is the only language supported with Amazon
|
1339
|
+
# The language code you selected for your custom medical vocabulary.
|
1340
|
+
# US English (`en-US`) is the only language supported with Amazon
|
1617
1341
|
# Transcribe Medical.
|
1618
1342
|
# @return [String]
|
1619
1343
|
#
|
1620
1344
|
# @!attribute [rw] vocabulary_state
|
1621
1345
|
# The processing state of your custom medical vocabulary. If the state
|
1622
|
-
# is `READY`, you can use the vocabulary in a
|
1346
|
+
# is `READY`, you can use the custom vocabulary in a
|
1623
1347
|
# `StartMedicalTranscriptionJob` request.
|
1624
1348
|
# @return [String]
|
1625
1349
|
#
|
@@ -1634,8 +1358,8 @@ module Aws::TranscribeService
|
|
1634
1358
|
#
|
1635
1359
|
# @!attribute [rw] failure_reason
|
1636
1360
|
# If `VocabularyState` is `FAILED`, `FailureReason` contains
|
1637
|
-
# information about why the medical vocabulary request failed.
|
1638
|
-
# also: [Common Errors][1].
|
1361
|
+
# information about why the custom medical vocabulary request failed.
|
1362
|
+
# See also: [Common Errors][1].
|
1639
1363
|
#
|
1640
1364
|
#
|
1641
1365
|
#
|
@@ -1643,8 +1367,8 @@ module Aws::TranscribeService
|
|
1643
1367
|
# @return [String]
|
1644
1368
|
#
|
1645
1369
|
# @!attribute [rw] download_uri
|
1646
|
-
# The S3 location where the specified medical vocabulary is
|
1647
|
-
# use this URI to view or download the vocabulary.
|
1370
|
+
# The S3 location where the specified custom medical vocabulary is
|
1371
|
+
# stored; use this URI to view or download the custom vocabulary.
|
1648
1372
|
# @return [String]
|
1649
1373
|
#
|
1650
1374
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetMedicalVocabularyResponse AWS API Documentation
|
@@ -1660,13 +1384,6 @@ module Aws::TranscribeService
|
|
1660
1384
|
include Aws::Structure
|
1661
1385
|
end
|
1662
1386
|
|
1663
|
-
# @note When making an API call, you may pass GetTranscriptionJobRequest
|
1664
|
-
# data as a hash:
|
1665
|
-
#
|
1666
|
-
# {
|
1667
|
-
# transcription_job_name: "TranscriptionJobName", # required
|
1668
|
-
# }
|
1669
|
-
#
|
1670
1387
|
# @!attribute [rw] transcription_job_name
|
1671
1388
|
# The name of the transcription job you want information about. Job
|
1672
1389
|
# names are case sensitive.
|
@@ -1693,16 +1410,9 @@ module Aws::TranscribeService
|
|
1693
1410
|
include Aws::Structure
|
1694
1411
|
end
|
1695
1412
|
|
1696
|
-
# @note When making an API call, you may pass GetVocabularyFilterRequest
|
1697
|
-
# data as a hash:
|
1698
|
-
#
|
1699
|
-
# {
|
1700
|
-
# vocabulary_filter_name: "VocabularyFilterName", # required
|
1701
|
-
# }
|
1702
|
-
#
|
1703
1413
|
# @!attribute [rw] vocabulary_filter_name
|
1704
1414
|
# The name of the custom vocabulary filter you want information about.
|
1705
|
-
#
|
1415
|
+
# Custom vocabulary filter names are case sensitive.
|
1706
1416
|
# @return [String]
|
1707
1417
|
#
|
1708
1418
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyFilterRequest AWS API Documentation
|
@@ -1719,11 +1429,12 @@ module Aws::TranscribeService
|
|
1719
1429
|
# @return [String]
|
1720
1430
|
#
|
1721
1431
|
# @!attribute [rw] language_code
|
1722
|
-
# The language code you selected for your vocabulary filter.
|
1432
|
+
# The language code you selected for your custom vocabulary filter.
|
1723
1433
|
# @return [String]
|
1724
1434
|
#
|
1725
1435
|
# @!attribute [rw] last_modified_time
|
1726
|
-
# The date and time the specified vocabulary filter was last
|
1436
|
+
# The date and time the specified custom vocabulary filter was last
|
1437
|
+
# modified.
|
1727
1438
|
#
|
1728
1439
|
# Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
|
1729
1440
|
# example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
|
@@ -1731,8 +1442,8 @@ module Aws::TranscribeService
|
|
1731
1442
|
# @return [Time]
|
1732
1443
|
#
|
1733
1444
|
# @!attribute [rw] download_uri
|
1734
|
-
# The Amazon S3 location where the vocabulary filter is stored;
|
1735
|
-
# this URI to view or download the vocabulary filter.
|
1445
|
+
# The Amazon S3 location where the custom vocabulary filter is stored;
|
1446
|
+
# use this URI to view or download the custom vocabulary filter.
|
1736
1447
|
# @return [String]
|
1737
1448
|
#
|
1738
1449
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyFilterResponse AWS API Documentation
|
@@ -1746,16 +1457,9 @@ module Aws::TranscribeService
|
|
1746
1457
|
include Aws::Structure
|
1747
1458
|
end
|
1748
1459
|
|
1749
|
-
# @note When making an API call, you may pass GetVocabularyRequest
|
1750
|
-
# data as a hash:
|
1751
|
-
#
|
1752
|
-
# {
|
1753
|
-
# vocabulary_name: "VocabularyName", # required
|
1754
|
-
# }
|
1755
|
-
#
|
1756
1460
|
# @!attribute [rw] vocabulary_name
|
1757
|
-
# The name of the custom vocabulary you want information about.
|
1758
|
-
#
|
1461
|
+
# The name of the custom vocabulary you want information about. Custom
|
1462
|
+
# vocabulary names are case sensitive.
|
1759
1463
|
# @return [String]
|
1760
1464
|
#
|
1761
1465
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyRequest AWS API Documentation
|
@@ -1776,12 +1480,12 @@ module Aws::TranscribeService
|
|
1776
1480
|
#
|
1777
1481
|
# @!attribute [rw] vocabulary_state
|
1778
1482
|
# The processing state of your custom vocabulary. If the state is
|
1779
|
-
# `READY`, you can use the vocabulary in a
|
1780
|
-
# request.
|
1483
|
+
# `READY`, you can use the custom vocabulary in a
|
1484
|
+
# `StartTranscriptionJob` request.
|
1781
1485
|
# @return [String]
|
1782
1486
|
#
|
1783
1487
|
# @!attribute [rw] last_modified_time
|
1784
|
-
# The date and time the specified vocabulary was last modified.
|
1488
|
+
# The date and time the specified custom vocabulary was last modified.
|
1785
1489
|
#
|
1786
1490
|
# Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
|
1787
1491
|
# example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
|
@@ -1790,8 +1494,8 @@ module Aws::TranscribeService
|
|
1790
1494
|
#
|
1791
1495
|
# @!attribute [rw] failure_reason
|
1792
1496
|
# If `VocabularyState` is `FAILED`, `FailureReason` contains
|
1793
|
-
# information about why the vocabulary request failed. See
|
1794
|
-
# [Common Errors][1].
|
1497
|
+
# information about why the custom vocabulary request failed. See
|
1498
|
+
# also: [Common Errors][1].
|
1795
1499
|
#
|
1796
1500
|
#
|
1797
1501
|
#
|
@@ -1799,8 +1503,8 @@ module Aws::TranscribeService
|
|
1799
1503
|
# @return [String]
|
1800
1504
|
#
|
1801
1505
|
# @!attribute [rw] download_uri
|
1802
|
-
# The S3 location where the vocabulary is stored; use this URI
|
1803
|
-
# or download the vocabulary.
|
1506
|
+
# The S3 location where the custom vocabulary is stored; use this URI
|
1507
|
+
# to view or download the custom vocabulary.
|
1804
1508
|
# @return [String]
|
1805
1509
|
#
|
1806
1510
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyResponse AWS API Documentation
|
@@ -1824,15 +1528,6 @@ module Aws::TranscribeService
|
|
1824
1528
|
# `S3Uri` and `DataAccessRoleArn`. You can optionally include
|
1825
1529
|
# `TuningDataS3Uri`.
|
1826
1530
|
#
|
1827
|
-
# @note When making an API call, you may pass InputDataConfig
|
1828
|
-
# data as a hash:
|
1829
|
-
#
|
1830
|
-
# {
|
1831
|
-
# s3_uri: "Uri", # required
|
1832
|
-
# tuning_data_s3_uri: "Uri",
|
1833
|
-
# data_access_role_arn: "DataAccessRoleArn", # required
|
1834
|
-
# }
|
1835
|
-
#
|
1836
1531
|
# @!attribute [rw] s3_uri
|
1837
1532
|
# The Amazon S3 location (URI) of the text files you want to use to
|
1838
1533
|
# train your custom language model.
|
@@ -1852,8 +1547,8 @@ module Aws::TranscribeService
|
|
1852
1547
|
# @!attribute [rw] data_access_role_arn
|
1853
1548
|
# The Amazon Resource Name (ARN) of an IAM role that has permissions
|
1854
1549
|
# to access the Amazon S3 bucket that contains your input files. If
|
1855
|
-
# the role you specify doesn’t have the appropriate permissions
|
1856
|
-
# access the specified Amazon S3 location, your request fails.
|
1550
|
+
# the role that you specify doesn’t have the appropriate permissions
|
1551
|
+
# to access the specified Amazon S3 location, your request fails.
|
1857
1552
|
#
|
1858
1553
|
# IAM role ARNs have the format
|
1859
1554
|
# `arn:partition:iam::account:role/role-name-with-path`. For example:
|
@@ -1903,54 +1598,33 @@ module Aws::TranscribeService
|
|
1903
1598
|
#
|
1904
1599
|
# * A lack of interruptions
|
1905
1600
|
#
|
1906
|
-
# See [Rule criteria][1] for usage examples.
|
1601
|
+
# See [Rule criteria for batch categories][1] for usage examples.
|
1907
1602
|
#
|
1908
1603
|
#
|
1909
1604
|
#
|
1910
|
-
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/
|
1911
|
-
#
|
1912
|
-
# @note When making an API call, you may pass InterruptionFilter
|
1913
|
-
# data as a hash:
|
1914
|
-
#
|
1915
|
-
# {
|
1916
|
-
# threshold: 1,
|
1917
|
-
# participant_role: "AGENT", # accepts AGENT, CUSTOMER
|
1918
|
-
# absolute_time_range: {
|
1919
|
-
# start_time: 1,
|
1920
|
-
# end_time: 1,
|
1921
|
-
# first: 1,
|
1922
|
-
# last: 1,
|
1923
|
-
# },
|
1924
|
-
# relative_time_range: {
|
1925
|
-
# start_percentage: 1,
|
1926
|
-
# end_percentage: 1,
|
1927
|
-
# first: 1,
|
1928
|
-
# last: 1,
|
1929
|
-
# },
|
1930
|
-
# negate: false,
|
1931
|
-
# }
|
1605
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch
|
1932
1606
|
#
|
1933
1607
|
# @!attribute [rw] threshold
|
1934
1608
|
# Specify the duration of the interruptions in milliseconds. For
|
1935
|
-
# example, you can flag speech that contains more than
|
1609
|
+
# example, you can flag speech that contains more than 10,000
|
1936
1610
|
# milliseconds of interruptions.
|
1937
1611
|
# @return [Integer]
|
1938
1612
|
#
|
1939
1613
|
# @!attribute [rw] participant_role
|
1940
|
-
# Specify the interrupter you want to flag. Omitting this
|
1941
|
-
# equivalent to specifying both participants.
|
1614
|
+
# Specify the interrupter that you want to flag. Omitting this
|
1615
|
+
# parameter is equivalent to specifying both participants.
|
1942
1616
|
# @return [String]
|
1943
1617
|
#
|
1944
1618
|
# @!attribute [rw] absolute_time_range
|
1945
|
-
#
|
1946
|
-
# during which you want to search for an interruption. See for
|
1947
|
-
# detail.
|
1619
|
+
# Makes it possible to specify a time range (in milliseconds) in your
|
1620
|
+
# audio, during which you want to search for an interruption. See for
|
1621
|
+
# more detail.
|
1948
1622
|
# @return [Types::AbsoluteTimeRange]
|
1949
1623
|
#
|
1950
1624
|
# @!attribute [rw] relative_time_range
|
1951
|
-
#
|
1952
|
-
# file, during which you want to search for an interruption. See
|
1953
|
-
# more detail.
|
1625
|
+
# Makes it possible to specify a time range (in percentage) in your
|
1626
|
+
# media file, during which you want to search for an interruption. See
|
1627
|
+
# for more detail.
|
1954
1628
|
# @return [Types::RelativeTimeRange]
|
1955
1629
|
#
|
1956
1630
|
# @!attribute [rw] negate
|
@@ -1970,7 +1644,7 @@ module Aws::TranscribeService
|
|
1970
1644
|
include Aws::Structure
|
1971
1645
|
end
|
1972
1646
|
|
1973
|
-
#
|
1647
|
+
# Makes it possible to control how your transcription job is processed.
|
1974
1648
|
# Currently, the only `JobExecutionSettings` modification you can choose
|
1975
1649
|
# is enabling job queueing using the `AllowDeferredExecution`
|
1976
1650
|
# sub-parameter.
|
@@ -1979,17 +1653,9 @@ module Aws::TranscribeService
|
|
1979
1653
|
# include the sub-parameters: `AllowDeferredExecution` and
|
1980
1654
|
# `DataAccessRoleArn`.
|
1981
1655
|
#
|
1982
|
-
# @note When making an API call, you may pass JobExecutionSettings
|
1983
|
-
# data as a hash:
|
1984
|
-
#
|
1985
|
-
# {
|
1986
|
-
# allow_deferred_execution: false,
|
1987
|
-
# data_access_role_arn: "DataAccessRoleArn",
|
1988
|
-
# }
|
1989
|
-
#
|
1990
1656
|
# @!attribute [rw] allow_deferred_execution
|
1991
|
-
#
|
1992
|
-
# is exceeded. When `AllowDeferredExecution` is set to `true`,
|
1657
|
+
# Makes it possible to enable job queuing when your concurrent request
|
1658
|
+
# limit is exceeded. When `AllowDeferredExecution` is set to `true`,
|
1993
1659
|
# transcription job requests are placed in a queue until the number of
|
1994
1660
|
# jobs falls below the concurrent request limit. If
|
1995
1661
|
# `AllowDeferredExecution` is set to `false` and the number of
|
@@ -2005,8 +1671,8 @@ module Aws::TranscribeService
|
|
2005
1671
|
# @!attribute [rw] data_access_role_arn
|
2006
1672
|
# The Amazon Resource Name (ARN) of an IAM role that has permissions
|
2007
1673
|
# to access the Amazon S3 bucket that contains your input files. If
|
2008
|
-
# the role you specify doesn’t have the appropriate permissions
|
2009
|
-
# access the specified Amazon S3 location, your request fails.
|
1674
|
+
# the role that you specify doesn’t have the appropriate permissions
|
1675
|
+
# to access the specified Amazon S3 location, your request fails.
|
2010
1676
|
#
|
2011
1677
|
# IAM role ARNs have the format
|
2012
1678
|
# `arn:partition:iam::account:role/role-name-with-path`. For example:
|
@@ -2054,63 +1720,58 @@ module Aws::TranscribeService
|
|
2054
1720
|
include Aws::Structure
|
2055
1721
|
end
|
2056
1722
|
|
2057
|
-
# If using automatic language identification
|
2058
|
-
#
|
2059
|
-
#
|
2060
|
-
#
|
2061
|
-
#
|
2062
|
-
#
|
2063
|
-
#
|
2064
|
-
#
|
2065
|
-
#
|
2066
|
-
#
|
2067
|
-
#
|
2068
|
-
#
|
2069
|
-
#
|
2070
|
-
#
|
2071
|
-
#
|
2072
|
-
#
|
2073
|
-
#
|
2074
|
-
# `
|
2075
|
-
#
|
1723
|
+
# If using automatic language identification in your request and you
|
1724
|
+
# want to apply a custom language model, a custom vocabulary, or a
|
1725
|
+
# custom vocabulary filter, include `LanguageIdSettings` with the
|
1726
|
+
# relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and
|
1727
|
+
# `VocabularyFilterName`). Note that multi-language identification
|
1728
|
+
# (`IdentifyMultipleLanguages`) doesn't support custom language models.
|
1729
|
+
#
|
1730
|
+
# `LanguageIdSettings` supports two to five language codes. Each
|
1731
|
+
# language code you include can have an associated custom language
|
1732
|
+
# model, custom vocabulary, and custom vocabulary filter. The language
|
1733
|
+
# codes that you specify must match the languages of the associated
|
1734
|
+
# custom language models, custom vocabularies, and custom vocabulary
|
1735
|
+
# filters.
|
1736
|
+
#
|
1737
|
+
# It's recommended that you include `LanguageOptions` when using
|
1738
|
+
# `LanguageIdSettings` to ensure that the correct language dialect is
|
1739
|
+
# identified. For example, if you specify a custom vocabulary that is in
|
1740
|
+
# `en-US` but Amazon Transcribe determines that the language spoken in
|
1741
|
+
# your media is `en-AU`, your custom vocabulary *is not* applied to your
|
1742
|
+
# transcription. If you include `LanguageOptions` and include `en-US` as
|
1743
|
+
# the only English language dialect, your custom vocabulary *is* applied
|
1744
|
+
# to your transcription.
|
2076
1745
|
#
|
2077
1746
|
# If you want to include a custom language model with your request but
|
2078
1747
|
# **do not** want to use automatic language identification, use instead
|
2079
|
-
# the ` parameter with the LanguageModelName sub-parameter
|
2080
|
-
#
|
2081
|
-
#
|
1748
|
+
# the ` parameter with the LanguageModelName sub-parameter. If you want
|
1749
|
+
# to include a custom vocabulary or a custom vocabulary filter (or both)
|
1750
|
+
# with your request but do not want to use automatic language
|
2082
1751
|
# identification, use instead the parameter with the VocabularyName or
|
2083
1752
|
# VocabularyFilterName (or both) sub-parameter.</p>
|
2084
1753
|
# `
|
2085
1754
|
#
|
2086
|
-
# @note When making an API call, you may pass LanguageIdSettings
|
2087
|
-
# data as a hash:
|
2088
|
-
#
|
2089
|
-
# {
|
2090
|
-
# vocabulary_name: "VocabularyName",
|
2091
|
-
# vocabulary_filter_name: "VocabularyFilterName",
|
2092
|
-
# language_model_name: "ModelName",
|
2093
|
-
# }
|
2094
|
-
#
|
2095
1755
|
# @!attribute [rw] vocabulary_name
|
2096
1756
|
# The name of the custom vocabulary you want to use when processing
|
2097
|
-
# your transcription job.
|
1757
|
+
# your transcription job. Custom vocabulary names are case sensitive.
|
2098
1758
|
#
|
2099
|
-
# The language of the specified vocabulary must match the
|
2100
|
-
# code you specify in your transcription request. If the
|
2101
|
-
# don't match, the vocabulary isn't applied. There
|
2102
|
-
# warnings associated with a language mismatch.
|
1759
|
+
# The language of the specified custom vocabulary must match the
|
1760
|
+
# language code that you specify in your transcription request. If the
|
1761
|
+
# languages don't match, the custom vocabulary isn't applied. There
|
1762
|
+
# are no errors or warnings associated with a language mismatch.
|
2103
1763
|
# @return [String]
|
2104
1764
|
#
|
2105
1765
|
# @!attribute [rw] vocabulary_filter_name
|
2106
1766
|
# The name of the custom vocabulary filter you want to use when
|
2107
|
-
# processing your transcription job.
|
2108
|
-
# sensitive.
|
1767
|
+
# processing your transcription job. Custom vocabulary filter names
|
1768
|
+
# are case sensitive.
|
2109
1769
|
#
|
2110
|
-
# The language of the specified vocabulary filter must match
|
2111
|
-
# language code you specify in your transcription request. If
|
2112
|
-
# languages don't match, the vocabulary filter isn't
|
2113
|
-
# are no errors or warnings associated with a language
|
1770
|
+
# The language of the specified custom vocabulary filter must match
|
1771
|
+
# the language code that you specify in your transcription request. If
|
1772
|
+
# the languages don't match, the custom vocabulary filter isn't
|
1773
|
+
# applied. There are no errors or warnings associated with a language
|
1774
|
+
# mismatch.
|
2114
1775
|
#
|
2115
1776
|
# Note that if you include `VocabularyFilterName` in your request, you
|
2116
1777
|
# must also include `VocabularyFilterMethod`.
|
@@ -2118,13 +1779,13 @@ module Aws::TranscribeService
|
|
2118
1779
|
#
|
2119
1780
|
# @!attribute [rw] language_model_name
|
2120
1781
|
# The name of the custom language model you want to use when
|
2121
|
-
# processing your transcription job. Note that language model
|
2122
|
-
# are case sensitive.
|
1782
|
+
# processing your transcription job. Note that custom language model
|
1783
|
+
# names are case sensitive.
|
2123
1784
|
#
|
2124
|
-
# The language of the specified language model must match the
|
2125
|
-
# code you specify in your transcription request. If the
|
2126
|
-
# don't match, the language model isn't applied.
|
2127
|
-
# or warnings associated with a language mismatch.
|
1785
|
+
# The language of the specified custom language model must match the
|
1786
|
+
# language code that you specify in your transcription request. If the
|
1787
|
+
# languages don't match, the custom language model isn't applied.
|
1788
|
+
# There are no errors or warnings associated with a language mismatch.
|
2128
1789
|
# @return [String]
|
2129
1790
|
#
|
2130
1791
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/LanguageIdSettings AWS API Documentation
|
@@ -2159,7 +1820,8 @@ module Aws::TranscribeService
|
|
2159
1820
|
# @return [Time]
|
2160
1821
|
#
|
2161
1822
|
# @!attribute [rw] last_modified_time
|
2162
|
-
# The date and time the specified language model was last
|
1823
|
+
# The date and time the specified custom language model was last
|
1824
|
+
# modified.
|
2163
1825
|
#
|
2164
1826
|
# Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
|
2165
1827
|
# example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
|
@@ -2168,9 +1830,9 @@ module Aws::TranscribeService
|
|
2168
1830
|
#
|
2169
1831
|
# @!attribute [rw] language_code
|
2170
1832
|
# The language code used to create your custom language model. Each
|
2171
|
-
# language model must contain terms in only one language, and
|
2172
|
-
# language you select for your model must match
|
2173
|
-
# training and tuning data.
|
1833
|
+
# custom language model must contain terms in only one language, and
|
1834
|
+
# the language you select for your custom language model must match
|
1835
|
+
# the language of your training and tuning data.
|
2174
1836
|
#
|
2175
1837
|
# For a list of supported languages and their associated language
|
2176
1838
|
# codes, refer to the [Supported languages][1] table. Note that U.S.
|
@@ -2196,8 +1858,8 @@ module Aws::TranscribeService
|
|
2196
1858
|
# Shows if a more current base model is available for use with the
|
2197
1859
|
# specified custom language model.
|
2198
1860
|
#
|
2199
|
-
# If `false`, your language model is using the most up-to-date
|
2200
|
-
# model.
|
1861
|
+
# If `false`, your custom language model is using the most up-to-date
|
1862
|
+
# base model.
|
2201
1863
|
#
|
2202
1864
|
# If `true`, there is a newer base model available than the one your
|
2203
1865
|
# language model is using.
|
@@ -2254,14 +1916,6 @@ module Aws::TranscribeService
|
|
2254
1916
|
include Aws::Structure
|
2255
1917
|
end
|
2256
1918
|
|
2257
|
-
# @note When making an API call, you may pass ListCallAnalyticsCategoriesRequest
|
2258
|
-
# data as a hash:
|
2259
|
-
#
|
2260
|
-
# {
|
2261
|
-
# next_token: "NextToken",
|
2262
|
-
# max_results: 1,
|
2263
|
-
# }
|
2264
|
-
#
|
2265
1919
|
# @!attribute [rw] next_token
|
2266
1920
|
# If your `ListCallAnalyticsCategories` request returns more results
|
2267
1921
|
# than can be displayed, `NextToken` is displayed in the response with
|
@@ -2272,7 +1926,7 @@ module Aws::TranscribeService
|
|
2272
1926
|
#
|
2273
1927
|
# @!attribute [rw] max_results
|
2274
1928
|
# The maximum number of Call Analytics categories to return in each
|
2275
|
-
# page of results. If there are fewer results than the value you
|
1929
|
+
# page of results. If there are fewer results than the value that you
|
2276
1930
|
# specify, only the actual results are returned. If you don't specify
|
2277
1931
|
# a value, a default of 5 is used.
|
2278
1932
|
# @return [Integer]
|
@@ -2309,16 +1963,6 @@ module Aws::TranscribeService
|
|
2309
1963
|
include Aws::Structure
|
2310
1964
|
end
|
2311
1965
|
|
2312
|
-
# @note When making an API call, you may pass ListCallAnalyticsJobsRequest
|
2313
|
-
# data as a hash:
|
2314
|
-
#
|
2315
|
-
# {
|
2316
|
-
# status: "QUEUED", # accepts QUEUED, IN_PROGRESS, FAILED, COMPLETED
|
2317
|
-
# job_name_contains: "CallAnalyticsJobName",
|
2318
|
-
# next_token: "NextToken",
|
2319
|
-
# max_results: 1,
|
2320
|
-
# }
|
2321
|
-
#
|
2322
1966
|
# @!attribute [rw] status
|
2323
1967
|
# Returns only Call Analytics jobs with the specified status. Jobs are
|
2324
1968
|
# ordered by creation date, with the newest job first. If you don't
|
@@ -2340,9 +1984,9 @@ module Aws::TranscribeService
|
|
2340
1984
|
#
|
2341
1985
|
# @!attribute [rw] max_results
|
2342
1986
|
# The maximum number of Call Analytics jobs to return in each page of
|
2343
|
-
# results. If there are fewer results than the value you specify,
|
2344
|
-
# the actual results are returned. If you don't specify a value,
|
2345
|
-
# default of 5 is used.
|
1987
|
+
# results. If there are fewer results than the value that you specify,
|
1988
|
+
# only the actual results are returned. If you don't specify a value,
|
1989
|
+
# a default of 5 is used.
|
2346
1990
|
# @return [Integer]
|
2347
1991
|
#
|
2348
1992
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListCallAnalyticsJobsRequest AWS API Documentation
|
@@ -2385,16 +2029,6 @@ module Aws::TranscribeService
|
|
2385
2029
|
include Aws::Structure
|
2386
2030
|
end
|
2387
2031
|
|
2388
|
-
# @note When making an API call, you may pass ListLanguageModelsRequest
|
2389
|
-
# data as a hash:
|
2390
|
-
#
|
2391
|
-
# {
|
2392
|
-
# status_equals: "IN_PROGRESS", # accepts IN_PROGRESS, FAILED, COMPLETED
|
2393
|
-
# name_contains: "ModelName",
|
2394
|
-
# next_token: "NextToken",
|
2395
|
-
# max_results: 1,
|
2396
|
-
# }
|
2397
|
-
#
|
2398
2032
|
# @!attribute [rw] status_equals
|
2399
2033
|
# Returns only custom language models with the specified status.
|
2400
2034
|
# Language models are ordered by creation date, with the newest model
|
@@ -2417,9 +2051,9 @@ module Aws::TranscribeService
|
|
2417
2051
|
#
|
2418
2052
|
# @!attribute [rw] max_results
|
2419
2053
|
# The maximum number of custom language models to return in each page
|
2420
|
-
# of results. If there are fewer results than the value you
|
2421
|
-
# only the actual results are returned. If you don't specify
|
2422
|
-
# a default of 5 is used.
|
2054
|
+
# of results. If there are fewer results than the value that you
|
2055
|
+
# specify, only the actual results are returned. If you don't specify
|
2056
|
+
# a value, a default of 5 is used.
|
2423
2057
|
# @return [Integer]
|
2424
2058
|
#
|
2425
2059
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListLanguageModelsRequest AWS API Documentation
|
@@ -2456,16 +2090,6 @@ module Aws::TranscribeService
|
|
2456
2090
|
include Aws::Structure
|
2457
2091
|
end
|
2458
2092
|
|
2459
|
-
# @note When making an API call, you may pass ListMedicalTranscriptionJobsRequest
|
2460
|
-
# data as a hash:
|
2461
|
-
#
|
2462
|
-
# {
|
2463
|
-
# status: "QUEUED", # accepts QUEUED, IN_PROGRESS, FAILED, COMPLETED
|
2464
|
-
# job_name_contains: "TranscriptionJobName",
|
2465
|
-
# next_token: "NextToken",
|
2466
|
-
# max_results: 1,
|
2467
|
-
# }
|
2468
|
-
#
|
2469
2093
|
# @!attribute [rw] status
|
2470
2094
|
# Returns only medical transcription jobs with the specified status.
|
2471
2095
|
# Jobs are ordered by creation date, with the newest job first. If you
|
@@ -2488,7 +2112,7 @@ module Aws::TranscribeService
|
|
2488
2112
|
#
|
2489
2113
|
# @!attribute [rw] max_results
|
2490
2114
|
# The maximum number of medical transcription jobs to return in each
|
2491
|
-
# page of results. If there are fewer results than the value you
|
2115
|
+
# page of results. If there are fewer results than the value that you
|
2492
2116
|
# specify, only the actual results are returned. If you don't specify
|
2493
2117
|
# a value, a default of 5 is used.
|
2494
2118
|
# @return [Integer]
|
@@ -2533,16 +2157,6 @@ module Aws::TranscribeService
|
|
2533
2157
|
include Aws::Structure
|
2534
2158
|
end
|
2535
2159
|
|
2536
|
-
# @note When making an API call, you may pass ListMedicalVocabulariesRequest
|
2537
|
-
# data as a hash:
|
2538
|
-
#
|
2539
|
-
# {
|
2540
|
-
# next_token: "NextToken",
|
2541
|
-
# max_results: 1,
|
2542
|
-
# state_equals: "PENDING", # accepts PENDING, READY, FAILED
|
2543
|
-
# name_contains: "VocabularyName",
|
2544
|
-
# }
|
2545
|
-
#
|
2546
2160
|
# @!attribute [rw] next_token
|
2547
2161
|
# If your `ListMedicalVocabularies` request returns more results than
|
2548
2162
|
# can be displayed, `NextToken` is displayed in the response with an
|
@@ -2553,14 +2167,14 @@ module Aws::TranscribeService
|
|
2553
2167
|
#
|
2554
2168
|
# @!attribute [rw] max_results
|
2555
2169
|
# The maximum number of custom medical vocabularies to return in each
|
2556
|
-
# page of results. If there are fewer results than the value you
|
2170
|
+
# page of results. If there are fewer results than the value that you
|
2557
2171
|
# specify, only the actual results are returned. If you don't specify
|
2558
2172
|
# a value, a default of 5 is used.
|
2559
2173
|
# @return [Integer]
|
2560
2174
|
#
|
2561
2175
|
# @!attribute [rw] state_equals
|
2562
2176
|
# Returns only custom medical vocabularies with the specified state.
|
2563
|
-
#
|
2177
|
+
# Custom vocabularies are ordered by creation date, with the newest
|
2564
2178
|
# vocabulary first. If you don't include `StateEquals`, all custom
|
2565
2179
|
# medical vocabularies are returned.
|
2566
2180
|
# @return [String]
|
@@ -2583,8 +2197,8 @@ module Aws::TranscribeService
|
|
2583
2197
|
|
2584
2198
|
# @!attribute [rw] status
|
2585
2199
|
# Lists all custom medical vocabularies that have the status specified
|
2586
|
-
# in your request.
|
2587
|
-
# newest vocabulary first.
|
2200
|
+
# in your request. Custom vocabularies are ordered by creation date,
|
2201
|
+
# with the newest vocabulary first.
|
2588
2202
|
# @return [String]
|
2589
2203
|
#
|
2590
2204
|
# @!attribute [rw] next_token
|
@@ -2611,20 +2225,13 @@ module Aws::TranscribeService
|
|
2611
2225
|
include Aws::Structure
|
2612
2226
|
end
|
2613
2227
|
|
2614
|
-
# @note When making an API call, you may pass ListTagsForResourceRequest
|
2615
|
-
# data as a hash:
|
2616
|
-
#
|
2617
|
-
# {
|
2618
|
-
# resource_arn: "TranscribeArn", # required
|
2619
|
-
# }
|
2620
|
-
#
|
2621
2228
|
# @!attribute [rw] resource_arn
|
2622
2229
|
# Returns a list of all tags associated with the specified Amazon
|
2623
2230
|
# Resource Name (ARN). ARNs have the format
|
2624
2231
|
# `arn:partition:service:region:account-id:resource-type/resource-id`.
|
2625
2232
|
#
|
2626
2233
|
# For example,
|
2627
|
-
# `arn:aws:transcribe:us-west-2:
|
2234
|
+
# `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
|
2628
2235
|
#
|
2629
2236
|
# Valid values for `resource-type` are: `transcription-job`,
|
2630
2237
|
# `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
|
@@ -2657,16 +2264,6 @@ module Aws::TranscribeService
|
|
2657
2264
|
include Aws::Structure
|
2658
2265
|
end
|
2659
2266
|
|
2660
|
-
# @note When making an API call, you may pass ListTranscriptionJobsRequest
|
2661
|
-
# data as a hash:
|
2662
|
-
#
|
2663
|
-
# {
|
2664
|
-
# status: "QUEUED", # accepts QUEUED, IN_PROGRESS, FAILED, COMPLETED
|
2665
|
-
# job_name_contains: "TranscriptionJobName",
|
2666
|
-
# next_token: "NextToken",
|
2667
|
-
# max_results: 1,
|
2668
|
-
# }
|
2669
|
-
#
|
2670
2267
|
# @!attribute [rw] status
|
2671
2268
|
# Returns only transcription jobs with the specified status. Jobs are
|
2672
2269
|
# ordered by creation date, with the newest job first. If you don't
|
@@ -2688,9 +2285,9 @@ module Aws::TranscribeService
|
|
2688
2285
|
#
|
2689
2286
|
# @!attribute [rw] max_results
|
2690
2287
|
# The maximum number of transcription jobs to return in each page of
|
2691
|
-
# results. If there are fewer results than the value you specify,
|
2692
|
-
# the actual results are returned. If you don't specify a value,
|
2693
|
-
# default of 5 is used.
|
2288
|
+
# results. If there are fewer results than the value that you specify,
|
2289
|
+
# only the actual results are returned. If you don't specify a value,
|
2290
|
+
# a default of 5 is used.
|
2694
2291
|
# @return [Integer]
|
2695
2292
|
#
|
2696
2293
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobsRequest AWS API Documentation
|
@@ -2733,16 +2330,6 @@ module Aws::TranscribeService
|
|
2733
2330
|
include Aws::Structure
|
2734
2331
|
end
|
2735
2332
|
|
2736
|
-
# @note When making an API call, you may pass ListVocabulariesRequest
|
2737
|
-
# data as a hash:
|
2738
|
-
#
|
2739
|
-
# {
|
2740
|
-
# next_token: "NextToken",
|
2741
|
-
# max_results: 1,
|
2742
|
-
# state_equals: "PENDING", # accepts PENDING, READY, FAILED
|
2743
|
-
# name_contains: "VocabularyName",
|
2744
|
-
# }
|
2745
|
-
#
|
2746
2333
|
# @!attribute [rw] next_token
|
2747
2334
|
# If your `ListVocabularies` request returns more results than can be
|
2748
2335
|
# displayed, `NextToken` is displayed in the response with an
|
@@ -2753,9 +2340,9 @@ module Aws::TranscribeService
|
|
2753
2340
|
#
|
2754
2341
|
# @!attribute [rw] max_results
|
2755
2342
|
# The maximum number of custom vocabularies to return in each page of
|
2756
|
-
# results. If there are fewer results than the value you specify,
|
2757
|
-
# the actual results are returned. If you don't specify a value,
|
2758
|
-
# default of 5 is used.
|
2343
|
+
# results. If there are fewer results than the value that you specify,
|
2344
|
+
# only the actual results are returned. If you don't specify a value,
|
2345
|
+
# a default of 5 is used.
|
2759
2346
|
# @return [Integer]
|
2760
2347
|
#
|
2761
2348
|
# @!attribute [rw] state_equals
|
@@ -2811,15 +2398,6 @@ module Aws::TranscribeService
|
|
2811
2398
|
include Aws::Structure
|
2812
2399
|
end
|
2813
2400
|
|
2814
|
-
# @note When making an API call, you may pass ListVocabularyFiltersRequest
|
2815
|
-
# data as a hash:
|
2816
|
-
#
|
2817
|
-
# {
|
2818
|
-
# next_token: "NextToken",
|
2819
|
-
# max_results: 1,
|
2820
|
-
# name_contains: "VocabularyFilterName",
|
2821
|
-
# }
|
2822
|
-
#
|
2823
2401
|
# @!attribute [rw] next_token
|
2824
2402
|
# If your `ListVocabularyFilters` request returns more results than
|
2825
2403
|
# can be displayed, `NextToken` is displayed in the response with an
|
@@ -2830,7 +2408,7 @@ module Aws::TranscribeService
|
|
2830
2408
|
#
|
2831
2409
|
# @!attribute [rw] max_results
|
2832
2410
|
# The maximum number of custom vocabulary filters to return in each
|
2833
|
-
# page of results. If there are fewer results than the value you
|
2411
|
+
# page of results. If there are fewer results than the value that you
|
2834
2412
|
# specify, only the actual results are returned. If you don't specify
|
2835
2413
|
# a value, a default of 5 is used.
|
2836
2414
|
# @return [Integer]
|
@@ -2876,13 +2454,14 @@ module Aws::TranscribeService
|
|
2876
2454
|
# Describes the Amazon S3 location of the media file you want to use in
|
2877
2455
|
# your request.
|
2878
2456
|
#
|
2879
|
-
#
|
2880
|
-
#
|
2457
|
+
# For information on supported media formats, refer to the
|
2458
|
+
# [MediaFormat][1] parameter or the [Media formats][2] section in the
|
2459
|
+
# Amazon S3 Developer Guide.
|
2881
2460
|
#
|
2882
|
-
#
|
2883
|
-
#
|
2884
|
-
#
|
2885
|
-
#
|
2461
|
+
#
|
2462
|
+
#
|
2463
|
+
# [1]: https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat
|
2464
|
+
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
|
2886
2465
|
#
|
2887
2466
|
# @!attribute [rw] media_file_uri
|
2888
2467
|
# The Amazon S3 location of the media file you want to transcribe. For
|
@@ -2909,7 +2488,8 @@ module Aws::TranscribeService
|
|
2909
2488
|
# be located in the same Amazon Web Services Region where you're
|
2910
2489
|
# making your transcription request.
|
2911
2490
|
#
|
2912
|
-
# `RedactedMediaFileUri`
|
2491
|
+
# `RedactedMediaFileUri` produces a redacted audio file in addition to
|
2492
|
+
# a redacted transcript. It is only supported for Call Analytics
|
2913
2493
|
# (`StartCallAnalyticsJob`) transcription requests.
|
2914
2494
|
# @return [String]
|
2915
2495
|
#
|
@@ -2929,22 +2509,8 @@ module Aws::TranscribeService
|
|
2929
2509
|
# The Amazon S3 location of your transcript. You can use this URI to
|
2930
2510
|
# access or download your transcript.
|
2931
2511
|
#
|
2932
|
-
#
|
2933
|
-
# request
|
2934
|
-
# `OutputKey` in your request, your output is located in the path you
|
2935
|
-
# specified in your request.
|
2936
|
-
#
|
2937
|
-
# If you didn't include `OutputBucketName` in your transcription job
|
2938
|
-
# request, your transcript is stored in a service-managed bucket, and
|
2939
|
-
# `TranscriptFileUri` provides you with a temporary URI you can use
|
2940
|
-
# for secure access to your transcript.
|
2941
|
-
#
|
2942
|
-
# <note markdown="1"> Temporary URIs for service-managed Amazon S3 buckets are only valid
|
2943
|
-
# for 15 minutes. If you get an `AccesDenied` error, you can get a new
|
2944
|
-
# temporary URI by running a `GetTranscriptionJob` or
|
2945
|
-
# `ListTranscriptionJob` request.
|
2946
|
-
#
|
2947
|
-
# </note>
|
2512
|
+
# Note that this is the Amazon S3 location you specified in your
|
2513
|
+
# request using the `OutputBucketName` parameter.
|
2948
2514
|
# @return [String]
|
2949
2515
|
#
|
2950
2516
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscript AWS API Documentation
|
@@ -2984,7 +2550,7 @@ module Aws::TranscribeService
|
|
2984
2550
|
# @return [String]
|
2985
2551
|
#
|
2986
2552
|
# @!attribute [rw] media_sample_rate_hertz
|
2987
|
-
# The sample rate, in
|
2553
|
+
# The sample rate, in hertz, of the audio track in your input media
|
2988
2554
|
# file.
|
2989
2555
|
# @return [Integer]
|
2990
2556
|
#
|
@@ -2995,6 +2561,15 @@ module Aws::TranscribeService
|
|
2995
2561
|
# @!attribute [rw] media
|
2996
2562
|
# Describes the Amazon S3 location of the media file you want to use
|
2997
2563
|
# in your request.
|
2564
|
+
#
|
2565
|
+
# For information on supported media formats, refer to the
|
2566
|
+
# [MediaFormat][1] parameter or the [Media formats][2] section in the
|
2567
|
+
# Amazon S3 Developer Guide.
|
2568
|
+
#
|
2569
|
+
#
|
2570
|
+
#
|
2571
|
+
# [1]: https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat
|
2572
|
+
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
|
2998
2573
|
# @return [Types::Media]
|
2999
2574
|
#
|
3000
2575
|
# @!attribute [rw] transcript
|
@@ -3053,7 +2628,7 @@ module Aws::TranscribeService
|
|
3053
2628
|
# * `Invalid sample rate for audio file`.
|
3054
2629
|
#
|
3055
2630
|
# The sample rate specified in `MediaSampleRateHertz` isn't valid.
|
3056
|
-
# The sample rate must be between 16,000 and 48,000
|
2631
|
+
# The sample rate must be between 16,000 and 48,000 hertz.
|
3057
2632
|
#
|
3058
2633
|
# * `The sample rate provided does not match the detected sample
|
3059
2634
|
# rate`.
|
@@ -3080,20 +2655,15 @@ module Aws::TranscribeService
|
|
3080
2655
|
# @return [String]
|
3081
2656
|
#
|
3082
2657
|
# @!attribute [rw] settings
|
3083
|
-
#
|
3084
|
-
#
|
3085
|
-
#
|
3086
|
-
#
|
2658
|
+
# Provides information on any additional settings that were included
|
2659
|
+
# in your request. Additional settings include channel identification,
|
2660
|
+
# alternative transcriptions, speaker partitioning, custom
|
2661
|
+
# vocabularies, and custom vocabulary filters.
|
3087
2662
|
# @return [Types::MedicalTranscriptionSetting]
|
3088
2663
|
#
|
3089
2664
|
# @!attribute [rw] content_identification_type
|
3090
|
-
#
|
3091
|
-
#
|
3092
|
-
# information (PHI) in a transcription][1].
|
3093
|
-
#
|
3094
|
-
#
|
3095
|
-
#
|
3096
|
-
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html
|
2665
|
+
# Indicates whether content identification was enabled for your
|
2666
|
+
# transcription request.
|
3097
2667
|
# @return [String]
|
3098
2668
|
#
|
3099
2669
|
# @!attribute [rw] specialty
|
@@ -3247,35 +2817,23 @@ module Aws::TranscribeService
|
|
3247
2817
|
end
|
3248
2818
|
|
3249
2819
|
# Allows additional optional settings in your request, including channel
|
3250
|
-
# identification, alternative transcriptions, and speaker
|
3251
|
-
#
|
3252
|
-
# job.
|
3253
|
-
#
|
3254
|
-
# @note When making an API call, you may pass MedicalTranscriptionSetting
|
3255
|
-
# data as a hash:
|
3256
|
-
#
|
3257
|
-
# {
|
3258
|
-
# show_speaker_labels: false,
|
3259
|
-
# max_speaker_labels: 1,
|
3260
|
-
# channel_identification: false,
|
3261
|
-
# show_alternatives: false,
|
3262
|
-
# max_alternatives: 1,
|
3263
|
-
# vocabulary_name: "VocabularyName",
|
3264
|
-
# }
|
2820
|
+
# identification, alternative transcriptions, and speaker partitioning.
|
2821
|
+
# You can use that to apply custom vocabularies to your medical
|
2822
|
+
# transcription job.
|
3265
2823
|
#
|
3266
2824
|
# @!attribute [rw] show_speaker_labels
|
3267
|
-
# Enables speaker
|
3268
|
-
# output. Speaker
|
2825
|
+
# Enables speaker partitioning (diarization) in your transcription
|
2826
|
+
# output. Speaker partitioning labels the speech from individual
|
3269
2827
|
# speakers in your media file.
|
3270
2828
|
#
|
3271
2829
|
# If you enable `ShowSpeakerLabels` in your request, you must also
|
3272
2830
|
# include `MaxSpeakerLabels`.
|
3273
2831
|
#
|
3274
|
-
# You can't include
|
3275
|
-
#
|
3276
|
-
#
|
2832
|
+
# You can't include `ShowSpeakerLabels` and `ChannelIdentification`
|
2833
|
+
# in the same request. Including both parameters returns a
|
2834
|
+
# `BadRequestException`.
|
3277
2835
|
#
|
3278
|
-
# For more information, see [
|
2836
|
+
# For more information, see [Partitioning speakers (diarization)][1].
|
3279
2837
|
#
|
3280
2838
|
#
|
3281
2839
|
#
|
@@ -3283,11 +2841,11 @@ module Aws::TranscribeService
|
|
3283
2841
|
# @return [Boolean]
|
3284
2842
|
#
|
3285
2843
|
# @!attribute [rw] max_speaker_labels
|
3286
|
-
# Specify the maximum number of speakers you want to
|
2844
|
+
# Specify the maximum number of speakers you want to partition in your
|
3287
2845
|
# media.
|
3288
2846
|
#
|
3289
2847
|
# Note that if your media contains more speakers than the specified
|
3290
|
-
# number, multiple speakers
|
2848
|
+
# number, multiple speakers are treated as a single speaker.
|
3291
2849
|
#
|
3292
2850
|
# If you specify the `MaxSpeakerLabels` field, you must set the
|
3293
2851
|
# `ShowSpeakerLabels` field to true.
|
@@ -3350,13 +2908,15 @@ module Aws::TranscribeService
|
|
3350
2908
|
#
|
3351
2909
|
# @!attribute [rw] vocabulary_name
|
3352
2910
|
# The name of the custom vocabulary you want to use when processing
|
3353
|
-
# your medical transcription job.
|
2911
|
+
# your medical transcription job. Custom vocabulary names are case
|
2912
|
+
# sensitive.
|
3354
2913
|
#
|
3355
|
-
# The language of the specified vocabulary must match the
|
3356
|
-
# code you specify in your transcription request. If the
|
3357
|
-
# don't match, the vocabulary isn't applied. There
|
3358
|
-
# warnings associated with a language mismatch. US
|
3359
|
-
# is the only valid language for Amazon Transcribe
|
2914
|
+
# The language of the specified custom vocabulary must match the
|
2915
|
+
# language code that you specify in your transcription request. If the
|
2916
|
+
# languages don't match, the custom vocabulary isn't applied. There
|
2917
|
+
# are no errors or warnings associated with a language mismatch. US
|
2918
|
+
# English (`en-US`) is the only valid language for Amazon Transcribe
|
2919
|
+
# Medical.
|
3360
2920
|
# @return [String]
|
3361
2921
|
#
|
3362
2922
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/MedicalTranscriptionSetting AWS API Documentation
|
@@ -3381,22 +2941,15 @@ module Aws::TranscribeService
|
|
3381
2941
|
# LanguageModelName sub-parameter.</p>
|
3382
2942
|
# `
|
3383
2943
|
#
|
3384
|
-
# @note When making an API call, you may pass ModelSettings
|
3385
|
-
# data as a hash:
|
3386
|
-
#
|
3387
|
-
# {
|
3388
|
-
# language_model_name: "ModelName",
|
3389
|
-
# }
|
3390
|
-
#
|
3391
2944
|
# @!attribute [rw] language_model_name
|
3392
2945
|
# The name of the custom language model you want to use when
|
3393
|
-
# processing your transcription job. Note that language model
|
3394
|
-
# are case sensitive.
|
2946
|
+
# processing your transcription job. Note that custom language model
|
2947
|
+
# names are case sensitive.
|
3395
2948
|
#
|
3396
|
-
# The language of the specified language model must match the
|
3397
|
-
# code you specify in your transcription request. If the
|
3398
|
-
# don't match, the language model isn't applied.
|
3399
|
-
# or warnings associated with a language mismatch.
|
2949
|
+
# The language of the specified custom language model must match the
|
2950
|
+
# language code that you specify in your transcription request. If the
|
2951
|
+
# languages don't match, the custom language model isn't applied.
|
2952
|
+
# There are no errors or warnings associated with a language mismatch.
|
3400
2953
|
# @return [String]
|
3401
2954
|
#
|
3402
2955
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ModelSettings AWS API Documentation
|
@@ -3416,48 +2969,28 @@ module Aws::TranscribeService
|
|
3416
2969
|
#
|
3417
2970
|
# * The presence of speech at specified periods throughout the call
|
3418
2971
|
#
|
3419
|
-
# See [Rule criteria][1] for usage examples.
|
3420
|
-
#
|
3421
|
-
#
|
2972
|
+
# See [Rule criteria for batch categories][1] for usage examples.
|
3422
2973
|
#
|
3423
|
-
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules
|
3424
2974
|
#
|
3425
|
-
# @note When making an API call, you may pass NonTalkTimeFilter
|
3426
|
-
# data as a hash:
|
3427
2975
|
#
|
3428
|
-
#
|
3429
|
-
# threshold: 1,
|
3430
|
-
# absolute_time_range: {
|
3431
|
-
# start_time: 1,
|
3432
|
-
# end_time: 1,
|
3433
|
-
# first: 1,
|
3434
|
-
# last: 1,
|
3435
|
-
# },
|
3436
|
-
# relative_time_range: {
|
3437
|
-
# start_percentage: 1,
|
3438
|
-
# end_percentage: 1,
|
3439
|
-
# first: 1,
|
3440
|
-
# last: 1,
|
3441
|
-
# },
|
3442
|
-
# negate: false,
|
3443
|
-
# }
|
2976
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch
|
3444
2977
|
#
|
3445
2978
|
# @!attribute [rw] threshold
|
3446
|
-
# Specify the duration, in milliseconds, of the period of silence
|
3447
|
-
# want to flag. For example, you can flag a silent period that
|
3448
|
-
#
|
2979
|
+
# Specify the duration, in milliseconds, of the period of silence that
|
2980
|
+
# you want to flag. For example, you can flag a silent period that
|
2981
|
+
# lasts 30,000 milliseconds.
|
3449
2982
|
# @return [Integer]
|
3450
2983
|
#
|
3451
2984
|
# @!attribute [rw] absolute_time_range
|
3452
|
-
#
|
3453
|
-
# during which you want to search for a period of silence. See
|
3454
|
-
# more detail.
|
2985
|
+
# Makes it possible to specify a time range (in milliseconds) in your
|
2986
|
+
# audio, during which you want to search for a period of silence. See
|
2987
|
+
# for more detail.
|
3455
2988
|
# @return [Types::AbsoluteTimeRange]
|
3456
2989
|
#
|
3457
2990
|
# @!attribute [rw] relative_time_range
|
3458
|
-
#
|
3459
|
-
# file, during which you want to search for a period of silence.
|
3460
|
-
# for more detail.
|
2991
|
+
# Makes it possible to specify a time range (in percentage) in your
|
2992
|
+
# media file, during which you want to search for a period of silence.
|
2993
|
+
# See for more detail.
|
3461
2994
|
# @return [Types::RelativeTimeRange]
|
3462
2995
|
#
|
3463
2996
|
# @!attribute [rw] negate
|
@@ -3499,23 +3032,13 @@ module Aws::TranscribeService
|
|
3499
3032
|
# your media file.
|
3500
3033
|
#
|
3501
3034
|
# You can use also `First` to search from the start of the media file
|
3502
|
-
# until the time you specify
|
3503
|
-
# specify until the end of the media file. For example, setting
|
3504
|
-
# to 10 only searches for your specified criteria in the audio
|
3505
|
-
# in the first 10 percent of the media file.
|
3035
|
+
# until the time that you specify. Or use `Last` to search from the time
|
3036
|
+
# that you specify until the end of the media file. For example, setting
|
3037
|
+
# `First` to 10 only searches for your specified criteria in the audio
|
3038
|
+
# contained in the first 10 percent of the media file.
|
3506
3039
|
#
|
3507
3040
|
# If you prefer to use milliseconds instead of percentage, see .
|
3508
3041
|
#
|
3509
|
-
# @note When making an API call, you may pass RelativeTimeRange
|
3510
|
-
# data as a hash:
|
3511
|
-
#
|
3512
|
-
# {
|
3513
|
-
# start_percentage: 1,
|
3514
|
-
# end_percentage: 1,
|
3515
|
-
# first: 1,
|
3516
|
-
# last: 1,
|
3517
|
-
# }
|
3518
|
-
#
|
3519
3042
|
# @!attribute [rw] start_percentage
|
3520
3043
|
# The time, in percentage, when Amazon Transcribe starts searching for
|
3521
3044
|
# the specified criteria in your media file. If you include
|
@@ -3532,14 +3055,14 @@ module Aws::TranscribeService
|
|
3532
3055
|
#
|
3533
3056
|
# @!attribute [rw] first
|
3534
3057
|
# The time, in percentage, from the start of your media file until the
|
3535
|
-
# value
|
3536
|
-
#
|
3058
|
+
# specified value. Amazon Transcribe searches for your specified
|
3059
|
+
# criteria in this time segment.
|
3537
3060
|
# @return [Integer]
|
3538
3061
|
#
|
3539
3062
|
# @!attribute [rw] last
|
3540
|
-
# The time, in percentage, from the value
|
3541
|
-
# your media file
|
3542
|
-
#
|
3063
|
+
# The time, in percentage, from the specified value until the end of
|
3064
|
+
# your media file. Amazon Transcribe searches for your specified
|
3065
|
+
# criteria in this time segment.
|
3543
3066
|
# @return [Integer]
|
3544
3067
|
#
|
3545
3068
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/RelativeTimeRange AWS API Documentation
|
@@ -3553,22 +3076,22 @@ module Aws::TranscribeService
|
|
3553
3076
|
include Aws::Structure
|
3554
3077
|
end
|
3555
3078
|
|
3556
|
-
# A rule is a set of criteria you can specify to flag an attribute
|
3557
|
-
# your Call Analytics output. Rules define a Call Analytics category.
|
3079
|
+
# A rule is a set of criteria that you can specify to flag an attribute
|
3080
|
+
# in your Call Analytics output. Rules define a Call Analytics category.
|
3558
3081
|
#
|
3559
|
-
# Rules can include these parameters: , , , and .
|
3560
|
-
# these parameters, refer to [Rule criteria][1].
|
3082
|
+
# Rules can include these parameters: , , , and .
|
3561
3083
|
#
|
3562
|
-
# To learn more about Call Analytics categories, see [Creating
|
3563
|
-
# categories][
|
3084
|
+
# To learn more about Call Analytics rules and categories, see [Creating
|
3085
|
+
# categories for batch transcriptions][1] and [Creating categories for
|
3086
|
+
# streaming transcriptions][2].
|
3564
3087
|
#
|
3565
3088
|
# To learn more about Call Analytics, see [Analyzing call center audio
|
3566
3089
|
# with Call Analytics][3].
|
3567
3090
|
#
|
3568
3091
|
#
|
3569
3092
|
#
|
3570
|
-
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/
|
3571
|
-
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/
|
3093
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html
|
3094
|
+
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html
|
3572
3095
|
# [3]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html
|
3573
3096
|
#
|
3574
3097
|
# @note Rule is a union - when making an API calls you must set exactly one of the members.
|
@@ -3631,58 +3154,37 @@ module Aws::TranscribeService
|
|
3631
3154
|
# * The presence or absence of a mixed sentiment felt by the customer,
|
3632
3155
|
# the agent, or both at specified points in the call
|
3633
3156
|
#
|
3634
|
-
# See [Rule criteria][1] for examples.
|
3635
|
-
#
|
3636
|
-
#
|
3157
|
+
# See [Rule criteria for batch categories][1] for usage examples.
|
3637
3158
|
#
|
3638
|
-
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules
|
3639
3159
|
#
|
3640
|
-
# @note When making an API call, you may pass SentimentFilter
|
3641
|
-
# data as a hash:
|
3642
3160
|
#
|
3643
|
-
#
|
3644
|
-
# sentiments: ["POSITIVE"], # required, accepts POSITIVE, NEGATIVE, NEUTRAL, MIXED
|
3645
|
-
# absolute_time_range: {
|
3646
|
-
# start_time: 1,
|
3647
|
-
# end_time: 1,
|
3648
|
-
# first: 1,
|
3649
|
-
# last: 1,
|
3650
|
-
# },
|
3651
|
-
# relative_time_range: {
|
3652
|
-
# start_percentage: 1,
|
3653
|
-
# end_percentage: 1,
|
3654
|
-
# first: 1,
|
3655
|
-
# last: 1,
|
3656
|
-
# },
|
3657
|
-
# participant_role: "AGENT", # accepts AGENT, CUSTOMER
|
3658
|
-
# negate: false,
|
3659
|
-
# }
|
3161
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch
|
3660
3162
|
#
|
3661
3163
|
# @!attribute [rw] sentiments
|
3662
|
-
# Specify the sentiments you want to flag.
|
3164
|
+
# Specify the sentiments that you want to flag.
|
3663
3165
|
# @return [Array<String>]
|
3664
3166
|
#
|
3665
3167
|
# @!attribute [rw] absolute_time_range
|
3666
|
-
#
|
3667
|
-
# during which you want to search for the specified sentiments.
|
3668
|
-
# for more detail.
|
3168
|
+
# Makes it possible to specify a time range (in milliseconds) in your
|
3169
|
+
# audio, during which you want to search for the specified sentiments.
|
3170
|
+
# See for more detail.
|
3669
3171
|
# @return [Types::AbsoluteTimeRange]
|
3670
3172
|
#
|
3671
3173
|
# @!attribute [rw] relative_time_range
|
3672
|
-
#
|
3673
|
-
# file, during which you want to search for the specified
|
3674
|
-
# See for more detail.
|
3174
|
+
# Makes it possible to specify a time range (in percentage) in your
|
3175
|
+
# media file, during which you want to search for the specified
|
3176
|
+
# sentiments. See for more detail.
|
3675
3177
|
# @return [Types::RelativeTimeRange]
|
3676
3178
|
#
|
3677
3179
|
# @!attribute [rw] participant_role
|
3678
|
-
# Specify the participant you want to flag. Omitting this
|
3679
|
-
# equivalent to specifying both participants.
|
3180
|
+
# Specify the participant that you want to flag. Omitting this
|
3181
|
+
# parameter is equivalent to specifying both participants.
|
3680
3182
|
# @return [String]
|
3681
3183
|
#
|
3682
3184
|
# @!attribute [rw] negate
|
3683
|
-
# Set to `TRUE` to flag the sentiments you didn't include in
|
3684
|
-
# request. Set to `FALSE` to flag the sentiments you
|
3685
|
-
# request.
|
3185
|
+
# Set to `TRUE` to flag the sentiments that you didn't include in
|
3186
|
+
# your request. Set to `FALSE` to flag the sentiments that you
|
3187
|
+
# specified in your request.
|
3686
3188
|
# @return [Boolean]
|
3687
3189
|
#
|
3688
3190
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/SentimentFilter AWS API Documentation
|
@@ -3698,22 +3200,9 @@ module Aws::TranscribeService
|
|
3698
3200
|
end
|
3699
3201
|
|
3700
3202
|
# Allows additional optional settings in your request, including channel
|
3701
|
-
# identification, alternative transcriptions, and speaker
|
3702
|
-
#
|
3703
|
-
#
|
3704
|
-
# @note When making an API call, you may pass Settings
|
3705
|
-
# data as a hash:
|
3706
|
-
#
|
3707
|
-
# {
|
3708
|
-
# vocabulary_name: "VocabularyName",
|
3709
|
-
# show_speaker_labels: false,
|
3710
|
-
# max_speaker_labels: 1,
|
3711
|
-
# channel_identification: false,
|
3712
|
-
# show_alternatives: false,
|
3713
|
-
# max_alternatives: 1,
|
3714
|
-
# vocabulary_filter_name: "VocabularyFilterName",
|
3715
|
-
# vocabulary_filter_method: "remove", # accepts remove, mask, tag
|
3716
|
-
# }
|
3203
|
+
# identification, alternative transcriptions, and speaker partitioning.
|
3204
|
+
# You can use that to apply custom vocabularies to your transcription
|
3205
|
+
# job.
|
3717
3206
|
#
|
3718
3207
|
# @!attribute [rw] vocabulary_name
|
3719
3208
|
# The name of the custom vocabulary you want to use in your
|
@@ -3723,8 +3212,8 @@ module Aws::TranscribeService
|
|
3723
3212
|
# @return [String]
|
3724
3213
|
#
|
3725
3214
|
# @!attribute [rw] show_speaker_labels
|
3726
|
-
# Enables speaker
|
3727
|
-
# output. Speaker
|
3215
|
+
# Enables speaker partitioning (diarization) in your transcription
|
3216
|
+
# output. Speaker partitioning labels the speech from individual
|
3728
3217
|
# speakers in your media file.
|
3729
3218
|
#
|
3730
3219
|
# If you enable `ShowSpeakerLabels` in your request, you must also
|
@@ -3734,7 +3223,7 @@ module Aws::TranscribeService
|
|
3734
3223
|
# `ChannelIdentification` in the same request. Including both
|
3735
3224
|
# parameters returns a `BadRequestException`.
|
3736
3225
|
#
|
3737
|
-
# For more information, see [
|
3226
|
+
# For more information, see [Partitioning speakers (diarization)][1].
|
3738
3227
|
#
|
3739
3228
|
#
|
3740
3229
|
#
|
@@ -3742,11 +3231,11 @@ module Aws::TranscribeService
|
|
3742
3231
|
# @return [Boolean]
|
3743
3232
|
#
|
3744
3233
|
# @!attribute [rw] max_speaker_labels
|
3745
|
-
# Specify the maximum number of speakers you want to
|
3234
|
+
# Specify the maximum number of speakers you want to partition in your
|
3746
3235
|
# media.
|
3747
3236
|
#
|
3748
3237
|
# Note that if your media contains more speakers than the specified
|
3749
|
-
# number, multiple speakers
|
3238
|
+
# number, multiple speakers are treated as a single speaker.
|
3750
3239
|
#
|
3751
3240
|
# If you specify the `MaxSpeakerLabels` field, you must set the
|
3752
3241
|
# `ShowSpeakerLabels` field to true.
|
@@ -3818,7 +3307,7 @@ module Aws::TranscribeService
|
|
3818
3307
|
# @return [String]
|
3819
3308
|
#
|
3820
3309
|
# @!attribute [rw] vocabulary_filter_method
|
3821
|
-
# Specify how you want your vocabulary filter applied to your
|
3310
|
+
# Specify how you want your custom vocabulary filter applied to your
|
3822
3311
|
# transcript.
|
3823
3312
|
#
|
3824
3313
|
# To replace words with `***`, choose `mask`.
|
@@ -3843,45 +3332,6 @@ module Aws::TranscribeService
|
|
3843
3332
|
include Aws::Structure
|
3844
3333
|
end
|
3845
3334
|
|
3846
|
-
# @note When making an API call, you may pass StartCallAnalyticsJobRequest
|
3847
|
-
# data as a hash:
|
3848
|
-
#
|
3849
|
-
# {
|
3850
|
-
# call_analytics_job_name: "CallAnalyticsJobName", # required
|
3851
|
-
# media: { # required
|
3852
|
-
# media_file_uri: "Uri",
|
3853
|
-
# redacted_media_file_uri: "Uri",
|
3854
|
-
# },
|
3855
|
-
# output_location: "Uri",
|
3856
|
-
# output_encryption_kms_key_id: "KMSKeyId",
|
3857
|
-
# data_access_role_arn: "DataAccessRoleArn",
|
3858
|
-
# settings: {
|
3859
|
-
# vocabulary_name: "VocabularyName",
|
3860
|
-
# vocabulary_filter_name: "VocabularyFilterName",
|
3861
|
-
# vocabulary_filter_method: "remove", # accepts remove, mask, tag
|
3862
|
-
# language_model_name: "ModelName",
|
3863
|
-
# content_redaction: {
|
3864
|
-
# redaction_type: "PII", # required, accepts PII
|
3865
|
-
# redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
|
3866
|
-
# pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, ALL
|
3867
|
-
# },
|
3868
|
-
# language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
|
3869
|
-
# language_id_settings: {
|
3870
|
-
# "af-ZA" => {
|
3871
|
-
# vocabulary_name: "VocabularyName",
|
3872
|
-
# vocabulary_filter_name: "VocabularyFilterName",
|
3873
|
-
# language_model_name: "ModelName",
|
3874
|
-
# },
|
3875
|
-
# },
|
3876
|
-
# },
|
3877
|
-
# channel_definitions: [
|
3878
|
-
# {
|
3879
|
-
# channel_id: 1,
|
3880
|
-
# participant_role: "AGENT", # accepts AGENT, CUSTOMER
|
3881
|
-
# },
|
3882
|
-
# ],
|
3883
|
-
# }
|
3884
|
-
#
|
3885
3335
|
# @!attribute [rw] call_analytics_job_name
|
3886
3336
|
# A unique name, chosen by you, for your Call Analytics job.
|
3887
3337
|
#
|
@@ -3893,7 +3343,7 @@ module Aws::TranscribeService
|
|
3893
3343
|
#
|
3894
3344
|
# @!attribute [rw] media
|
3895
3345
|
# Describes the Amazon S3 location of the media file you want to use
|
3896
|
-
# in your request.
|
3346
|
+
# in your Call Analytics request.
|
3897
3347
|
# @return [Types::Media]
|
3898
3348
|
#
|
3899
3349
|
# @!attribute [rw] output_location
|
@@ -3963,8 +3413,8 @@ module Aws::TranscribeService
|
|
3963
3413
|
# @!attribute [rw] data_access_role_arn
|
3964
3414
|
# The Amazon Resource Name (ARN) of an IAM role that has permissions
|
3965
3415
|
# to access the Amazon S3 bucket that contains your input files. If
|
3966
|
-
# the role you specify doesn’t have the appropriate permissions
|
3967
|
-
# access the specified Amazon S3 location, your request fails.
|
3416
|
+
# the role that you specify doesn’t have the appropriate permissions
|
3417
|
+
# to access the specified Amazon S3 location, your request fails.
|
3968
3418
|
#
|
3969
3419
|
# IAM role ARNs have the format
|
3970
3420
|
# `arn:partition:iam::account:role/role-name-with-path`. For example:
|
@@ -3985,7 +3435,7 @@ module Aws::TranscribeService
|
|
3985
3435
|
# @return [Types::CallAnalyticsJobSettings]
|
3986
3436
|
#
|
3987
3437
|
# @!attribute [rw] channel_definitions
|
3988
|
-
#
|
3438
|
+
# Makes it possible to specify which speaker is on which channel. For
|
3989
3439
|
# example, if your agent is the first participant to speak, you would
|
3990
3440
|
# set `ChannelId` to `0` (to indicate the first channel) and
|
3991
3441
|
# `ParticipantRole` to `AGENT` (to indicate that it's the agent
|
@@ -4019,46 +3469,9 @@ module Aws::TranscribeService
|
|
4019
3469
|
include Aws::Structure
|
4020
3470
|
end
|
4021
3471
|
|
4022
|
-
# @note When making an API call, you may pass StartMedicalTranscriptionJobRequest
|
4023
|
-
# data as a hash:
|
4024
|
-
#
|
4025
|
-
# {
|
4026
|
-
# medical_transcription_job_name: "TranscriptionJobName", # required
|
4027
|
-
# language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
|
4028
|
-
# media_sample_rate_hertz: 1,
|
4029
|
-
# media_format: "mp3", # accepts mp3, mp4, wav, flac, ogg, amr, webm
|
4030
|
-
# media: { # required
|
4031
|
-
# media_file_uri: "Uri",
|
4032
|
-
# redacted_media_file_uri: "Uri",
|
4033
|
-
# },
|
4034
|
-
# output_bucket_name: "OutputBucketName", # required
|
4035
|
-
# output_key: "OutputKey",
|
4036
|
-
# output_encryption_kms_key_id: "KMSKeyId",
|
4037
|
-
# kms_encryption_context: {
|
4038
|
-
# "NonEmptyString" => "NonEmptyString",
|
4039
|
-
# },
|
4040
|
-
# settings: {
|
4041
|
-
# show_speaker_labels: false,
|
4042
|
-
# max_speaker_labels: 1,
|
4043
|
-
# channel_identification: false,
|
4044
|
-
# show_alternatives: false,
|
4045
|
-
# max_alternatives: 1,
|
4046
|
-
# vocabulary_name: "VocabularyName",
|
4047
|
-
# },
|
4048
|
-
# content_identification_type: "PHI", # accepts PHI
|
4049
|
-
# specialty: "PRIMARYCARE", # required, accepts PRIMARYCARE
|
4050
|
-
# type: "CONVERSATION", # required, accepts CONVERSATION, DICTATION
|
4051
|
-
# tags: [
|
4052
|
-
# {
|
4053
|
-
# key: "TagKey", # required
|
4054
|
-
# value: "TagValue", # required
|
4055
|
-
# },
|
4056
|
-
# ],
|
4057
|
-
# }
|
4058
|
-
#
|
4059
3472
|
# @!attribute [rw] medical_transcription_job_name
|
4060
3473
|
# A unique name, chosen by you, for your medical transcription job.
|
4061
|
-
# The name you specify is also used as the default name of your
|
3474
|
+
# The name that you specify is also used as the default name of your
|
4062
3475
|
# transcription output file. If you want to specify a different name
|
4063
3476
|
# for your transcription output, use the `OutputKey` parameter.
|
4064
3477
|
#
|
@@ -4076,13 +3489,13 @@ module Aws::TranscribeService
|
|
4076
3489
|
# @return [String]
|
4077
3490
|
#
|
4078
3491
|
# @!attribute [rw] media_sample_rate_hertz
|
4079
|
-
# The sample rate, in
|
3492
|
+
# The sample rate, in hertz, of the audio track in your input media
|
4080
3493
|
# file.
|
4081
3494
|
#
|
4082
3495
|
# If you don't specify the media sample rate, Amazon Transcribe
|
4083
3496
|
# Medical determines it for you. If you specify the sample rate, it
|
4084
3497
|
# must match the rate detected by Amazon Transcribe Medical; if
|
4085
|
-
# there's a mismatch between the value you specify and the value
|
3498
|
+
# there's a mismatch between the value that you specify and the value
|
4086
3499
|
# detected, your job fails. Therefore, in most cases, it's advised to
|
4087
3500
|
# omit `MediaSampleRateHertz` and let Amazon Transcribe Medical
|
4088
3501
|
# determine the sample rate.
|
@@ -4095,6 +3508,15 @@ module Aws::TranscribeService
|
|
4095
3508
|
# @!attribute [rw] media
|
4096
3509
|
# Describes the Amazon S3 location of the media file you want to use
|
4097
3510
|
# in your request.
|
3511
|
+
#
|
3512
|
+
# For information on supported media formats, refer to the
|
3513
|
+
# [MediaFormat][1] parameter or the [Media formats][2] section in the
|
3514
|
+
# Amazon S3 Developer Guide.
|
3515
|
+
#
|
3516
|
+
#
|
3517
|
+
#
|
3518
|
+
# [1]: https://docs.aws.amazon.com/APIReference/API_StartTranscriptionJob.html#transcribe-StartTranscriptionJob-request-MediaFormat
|
3519
|
+
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio
|
4098
3520
|
# @return [Types::Media]
|
4099
3521
|
#
|
4100
3522
|
# @!attribute [rw] output_bucket_name
|
@@ -4117,10 +3539,6 @@ module Aws::TranscribeService
|
|
4117
3539
|
# [Amazon Web Services Management Console][1]. See also [Permissions
|
4118
3540
|
# Required for IAM User Roles][2].
|
4119
3541
|
#
|
4120
|
-
# If you don't specify `OutputBucketName`, your transcript is placed
|
4121
|
-
# in a service-managed Amazon S3 bucket and you are provided with a
|
4122
|
-
# URI to access your transcript.
|
4123
|
-
#
|
4124
3542
|
#
|
4125
3543
|
#
|
4126
3544
|
# [1]: https://console.aws.amazon.com/s3
|
@@ -4216,7 +3634,7 @@ module Aws::TranscribeService
|
|
4216
3634
|
# @!attribute [rw] settings
|
4217
3635
|
# Specify additional optional settings in your request, including
|
4218
3636
|
# channel identification, alternative transcriptions, and speaker
|
4219
|
-
#
|
3637
|
+
# partitioning. You can use that to apply custom vocabularies to your
|
4220
3638
|
# transcription job.
|
4221
3639
|
# @return [Types::MedicalTranscriptionSetting]
|
4222
3640
|
#
|
@@ -4295,73 +3713,11 @@ module Aws::TranscribeService
|
|
4295
3713
|
include Aws::Structure
|
4296
3714
|
end
|
4297
3715
|
|
4298
|
-
# @note When making an API call, you may pass StartTranscriptionJobRequest
|
4299
|
-
# data as a hash:
|
4300
|
-
#
|
4301
|
-
# {
|
4302
|
-
# transcription_job_name: "TranscriptionJobName", # required
|
4303
|
-
# language_code: "af-ZA", # accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
|
4304
|
-
# media_sample_rate_hertz: 1,
|
4305
|
-
# media_format: "mp3", # accepts mp3, mp4, wav, flac, ogg, amr, webm
|
4306
|
-
# media: { # required
|
4307
|
-
# media_file_uri: "Uri",
|
4308
|
-
# redacted_media_file_uri: "Uri",
|
4309
|
-
# },
|
4310
|
-
# output_bucket_name: "OutputBucketName",
|
4311
|
-
# output_key: "OutputKey",
|
4312
|
-
# output_encryption_kms_key_id: "KMSKeyId",
|
4313
|
-
# kms_encryption_context: {
|
4314
|
-
# "NonEmptyString" => "NonEmptyString",
|
4315
|
-
# },
|
4316
|
-
# settings: {
|
4317
|
-
# vocabulary_name: "VocabularyName",
|
4318
|
-
# show_speaker_labels: false,
|
4319
|
-
# max_speaker_labels: 1,
|
4320
|
-
# channel_identification: false,
|
4321
|
-
# show_alternatives: false,
|
4322
|
-
# max_alternatives: 1,
|
4323
|
-
# vocabulary_filter_name: "VocabularyFilterName",
|
4324
|
-
# vocabulary_filter_method: "remove", # accepts remove, mask, tag
|
4325
|
-
# },
|
4326
|
-
# model_settings: {
|
4327
|
-
# language_model_name: "ModelName",
|
4328
|
-
# },
|
4329
|
-
# job_execution_settings: {
|
4330
|
-
# allow_deferred_execution: false,
|
4331
|
-
# data_access_role_arn: "DataAccessRoleArn",
|
4332
|
-
# },
|
4333
|
-
# content_redaction: {
|
4334
|
-
# redaction_type: "PII", # required, accepts PII
|
4335
|
-
# redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
|
4336
|
-
# pii_entity_types: ["BANK_ACCOUNT_NUMBER"], # accepts BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_NUMBER, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, PIN, EMAIL, ADDRESS, NAME, PHONE, SSN, ALL
|
4337
|
-
# },
|
4338
|
-
# identify_language: false,
|
4339
|
-
# identify_multiple_languages: false,
|
4340
|
-
# language_options: ["af-ZA"], # accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
|
4341
|
-
# subtitles: {
|
4342
|
-
# formats: ["vtt"], # accepts vtt, srt
|
4343
|
-
# output_start_index: 1,
|
4344
|
-
# },
|
4345
|
-
# tags: [
|
4346
|
-
# {
|
4347
|
-
# key: "TagKey", # required
|
4348
|
-
# value: "TagValue", # required
|
4349
|
-
# },
|
4350
|
-
# ],
|
4351
|
-
# language_id_settings: {
|
4352
|
-
# "af-ZA" => {
|
4353
|
-
# vocabulary_name: "VocabularyName",
|
4354
|
-
# vocabulary_filter_name: "VocabularyFilterName",
|
4355
|
-
# language_model_name: "ModelName",
|
4356
|
-
# },
|
4357
|
-
# },
|
4358
|
-
# }
|
4359
|
-
#
|
4360
3716
|
# @!attribute [rw] transcription_job_name
|
4361
3717
|
# A unique name, chosen by you, for your transcription job. The name
|
4362
|
-
# you specify is also used as the default name of your
|
4363
|
-
# output file. If you want to specify a different name
|
4364
|
-
# transcription output, use the `OutputKey` parameter.
|
3718
|
+
# that you specify is also used as the default name of your
|
3719
|
+
# transcription output file. If you want to specify a different name
|
3720
|
+
# for your transcription output, use the `OutputKey` parameter.
|
4365
3721
|
#
|
4366
3722
|
# This name is case sensitive, cannot contain spaces, and must be
|
4367
3723
|
# unique within an Amazon Web Services account. If you try to create a
|
@@ -4396,16 +3752,15 @@ module Aws::TranscribeService
|
|
4396
3752
|
# @return [String]
|
4397
3753
|
#
|
4398
3754
|
# @!attribute [rw] media_sample_rate_hertz
|
4399
|
-
# The sample rate, in
|
3755
|
+
# The sample rate, in hertz, of the audio track in your input media
|
4400
3756
|
# file.
|
4401
3757
|
#
|
4402
3758
|
# If you don't specify the media sample rate, Amazon Transcribe
|
4403
3759
|
# determines it for you. If you specify the sample rate, it must match
|
4404
|
-
# the rate detected by Amazon Transcribe
|
4405
|
-
# between the value you specify and the value detected, your job
|
4406
|
-
# fails.
|
4407
|
-
#
|
4408
|
-
# sample rate.
|
3760
|
+
# the rate detected by Amazon Transcribe. If there's a mismatch
|
3761
|
+
# between the value that you specify and the value detected, your job
|
3762
|
+
# fails. In most cases, you can omit `MediaSampleRateHertz` and let
|
3763
|
+
# Amazon Transcribe determine the sample rate.
|
4409
3764
|
# @return [Integer]
|
4410
3765
|
#
|
4411
3766
|
# @!attribute [rw] media_format
|
@@ -4535,8 +3890,8 @@ module Aws::TranscribeService
|
|
4535
3890
|
# @!attribute [rw] settings
|
4536
3891
|
# Specify additional optional settings in your request, including
|
4537
3892
|
# channel identification, alternative transcriptions, speaker
|
4538
|
-
#
|
4539
|
-
# filters.
|
3893
|
+
# partitioning. You can use that to apply custom vocabularies and
|
3894
|
+
# vocabulary filters.
|
4540
3895
|
#
|
4541
3896
|
# If you want to include a custom vocabulary or a custom vocabulary
|
4542
3897
|
# filter (or both) with your request but **do not** want to use
|
@@ -4564,10 +3919,10 @@ module Aws::TranscribeService
|
|
4564
3919
|
# @return [Types::ModelSettings]
|
4565
3920
|
#
|
4566
3921
|
# @!attribute [rw] job_execution_settings
|
4567
|
-
#
|
4568
|
-
# Currently, the only `JobExecutionSettings` modification
|
4569
|
-
# choose is enabling job queueing using the
|
4570
|
-
# sub-parameter.
|
3922
|
+
# Makes it possible to control how your transcription job is
|
3923
|
+
# processed. Currently, the only `JobExecutionSettings` modification
|
3924
|
+
# you can choose is enabling job queueing using the
|
3925
|
+
# `AllowDeferredExecution` sub-parameter.
|
4571
3926
|
#
|
4572
3927
|
# If you include `JobExecutionSettings` in your request, you must also
|
4573
3928
|
# include the sub-parameters: `AllowDeferredExecution` and
|
@@ -4575,26 +3930,30 @@ module Aws::TranscribeService
|
|
4575
3930
|
# @return [Types::JobExecutionSettings]
|
4576
3931
|
#
|
4577
3932
|
# @!attribute [rw] content_redaction
|
4578
|
-
#
|
4579
|
-
# information (PII) in your transcript. If you use
|
4580
|
-
# you must also include the sub-parameters:
|
4581
|
-
# `RedactionOutput`, and `RedactionType`.
|
3933
|
+
# Makes it possible to redact or flag specified personally
|
3934
|
+
# identifiable information (PII) in your transcript. If you use
|
3935
|
+
# `ContentRedaction`, you must also include the sub-parameters:
|
3936
|
+
# `PiiEntityTypes`, `RedactionOutput`, and `RedactionType`.
|
4582
3937
|
# @return [Types::ContentRedaction]
|
4583
3938
|
#
|
4584
3939
|
# @!attribute [rw] identify_language
|
4585
3940
|
# Enables automatic language identification in your transcription job
|
4586
|
-
# request.
|
3941
|
+
# request. Use this parameter if your media file contains only one
|
3942
|
+
# language. If your media contains multiple languages, use
|
3943
|
+
# `IdentifyMultipleLanguages` instead.
|
4587
3944
|
#
|
4588
3945
|
# If you include `IdentifyLanguage`, you can optionally include a list
|
4589
3946
|
# of language codes, using `LanguageOptions`, that you think may be
|
4590
|
-
# present in your media file. Including
|
4591
|
-
#
|
3947
|
+
# present in your media file. Including `LanguageOptions` restricts
|
3948
|
+
# `IdentifyLanguage` to only the language options that you specify,
|
3949
|
+
# which can improve transcription accuracy.
|
4592
3950
|
#
|
4593
3951
|
# If you want to apply a custom language model, a custom vocabulary,
|
4594
3952
|
# or a custom vocabulary filter to your automatic language
|
4595
3953
|
# identification request, include `LanguageIdSettings` with the
|
4596
3954
|
# relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and
|
4597
|
-
# `VocabularyFilterName`).
|
3955
|
+
# `VocabularyFilterName`). If you include `LanguageIdSettings`, also
|
3956
|
+
# include `LanguageOptions`.
|
4598
3957
|
#
|
4599
3958
|
# Note that you must include one of `LanguageCode`,
|
4600
3959
|
# `IdentifyLanguage`, or `IdentifyMultipleLanguages` in your request.
|
@@ -4605,17 +3964,20 @@ module Aws::TranscribeService
|
|
4605
3964
|
# @!attribute [rw] identify_multiple_languages
|
4606
3965
|
# Enables automatic multi-language identification in your
|
4607
3966
|
# transcription job request. Use this parameter if your media file
|
4608
|
-
# contains more than one language.
|
3967
|
+
# contains more than one language. If your media contains only one
|
3968
|
+
# language, use `IdentifyLanguage` instead.
|
4609
3969
|
#
|
4610
3970
|
# If you include `IdentifyMultipleLanguages`, you can optionally
|
4611
3971
|
# include a list of language codes, using `LanguageOptions`, that you
|
4612
|
-
# think may be present in your media file. Including
|
4613
|
-
#
|
3972
|
+
# think may be present in your media file. Including `LanguageOptions`
|
3973
|
+
# restricts `IdentifyLanguage` to only the language options that you
|
3974
|
+
# specify, which can improve transcription accuracy.
|
4614
3975
|
#
|
4615
3976
|
# If you want to apply a custom vocabulary or a custom vocabulary
|
4616
3977
|
# filter to your automatic language identification request, include
|
4617
3978
|
# `LanguageIdSettings` with the relevant sub-parameters
|
4618
|
-
# (`VocabularyName` and `VocabularyFilterName`).
|
3979
|
+
# (`VocabularyName` and `VocabularyFilterName`). If you include
|
3980
|
+
# `LanguageIdSettings`, also include `LanguageOptions`.
|
4619
3981
|
#
|
4620
3982
|
# Note that you must include one of `LanguageCode`,
|
4621
3983
|
# `IdentifyLanguage`, or `IdentifyMultipleLanguages` in your request.
|
@@ -4625,7 +3987,7 @@ module Aws::TranscribeService
|
|
4625
3987
|
#
|
4626
3988
|
# @!attribute [rw] language_options
|
4627
3989
|
# You can specify two or more language codes that represent the
|
4628
|
-
# languages you think may be present in your media
|
3990
|
+
# languages you think may be present in your media. Including more
|
4629
3991
|
# than five is not recommended. If you're unsure what languages are
|
4630
3992
|
# present, do not include this parameter.
|
4631
3993
|
#
|
@@ -4660,34 +4022,37 @@ module Aws::TranscribeService
|
|
4660
4022
|
# @return [Array<Types::Tag>]
|
4661
4023
|
#
|
4662
4024
|
# @!attribute [rw] language_id_settings
|
4663
|
-
# If using automatic language identification
|
4664
|
-
#
|
4665
|
-
#
|
4666
|
-
#
|
4667
|
-
#
|
4668
|
-
#
|
4669
|
-
#
|
4670
|
-
#
|
4671
|
-
#
|
4672
|
-
# have an associated custom language
|
4673
|
-
# custom vocabulary filter. The
|
4674
|
-
#
|
4675
|
-
# vocabularies, and custom vocabulary
|
4025
|
+
# If using automatic language identification in your request and you
|
4026
|
+
# want to apply a custom language model, a custom vocabulary, or a
|
4027
|
+
# custom vocabulary filter, include `LanguageIdSettings` with the
|
4028
|
+
# relevant sub-parameters (`VocabularyName`, `LanguageModelName`, and
|
4029
|
+
# `VocabularyFilterName`). Note that multi-language identification
|
4030
|
+
# (`IdentifyMultipleLanguages`) doesn't support custom language
|
4031
|
+
# models.
|
4032
|
+
#
|
4033
|
+
# `LanguageIdSettings` supports two to five language codes. Each
|
4034
|
+
# language code you include can have an associated custom language
|
4035
|
+
# model, custom vocabulary, and custom vocabulary filter. The language
|
4036
|
+
# codes that you specify must match the languages of the associated
|
4037
|
+
# custom language models, custom vocabularies, and custom vocabulary
|
4038
|
+
# filters.
|
4676
4039
|
#
|
4677
|
-
#
|
4678
|
-
#
|
4679
|
-
#
|
4680
|
-
# `
|
4681
|
-
#
|
4040
|
+
# It's recommended that you include `LanguageOptions` when using
|
4041
|
+
# `LanguageIdSettings` to ensure that the correct language dialect is
|
4042
|
+
# identified. For example, if you specify a custom vocabulary that is
|
4043
|
+
# in `en-US` but Amazon Transcribe determines that the language spoken
|
4044
|
+
# in your media is `en-AU`, your custom vocabulary *is not* applied to
|
4045
|
+
# your transcription. If you include `LanguageOptions` and include
|
4046
|
+
# `en-US` as the only English language dialect, your custom vocabulary
|
4047
|
+
# *is* applied to your transcription.
|
4682
4048
|
#
|
4683
4049
|
# If you want to include a custom language model with your request but
|
4684
4050
|
# **do not** want to use automatic language identification, use
|
4685
|
-
# instead the ` parameter with the LanguageModelName
|
4686
|
-
#
|
4687
|
-
#
|
4688
|
-
#
|
4689
|
-
#
|
4690
|
-
# sub-parameter.</p>
|
4051
|
+
# instead the ` parameter with the LanguageModelName sub-parameter. If
|
4052
|
+
# you want to include a custom vocabulary or a custom vocabulary
|
4053
|
+
# filter (or both) with your request but do not want to use automatic
|
4054
|
+
# language identification, use instead the parameter with the
|
4055
|
+
# VocabularyName or VocabularyFilterName (or both) sub-parameter.</p>
|
4691
4056
|
# `
|
4692
4057
|
# @return [Hash<String,Types::LanguageIdSettings>]
|
4693
4058
|
#
|
@@ -4739,14 +4104,6 @@ module Aws::TranscribeService
|
|
4739
4104
|
# Note that your subtitle files are placed in the same location as your
|
4740
4105
|
# transcription output.
|
4741
4106
|
#
|
4742
|
-
# @note When making an API call, you may pass Subtitles
|
4743
|
-
# data as a hash:
|
4744
|
-
#
|
4745
|
-
# {
|
4746
|
-
# formats: ["vtt"], # accepts vtt, srt
|
4747
|
-
# output_start_index: 1,
|
4748
|
-
# }
|
4749
|
-
#
|
4750
4107
|
# @!attribute [rw] formats
|
4751
4108
|
# Specify the output format for your subtitle file; if you select both
|
4752
4109
|
# WebVTT (`vtt`) and SubRip (`srt`) formats, two output files are
|
@@ -4834,14 +4191,6 @@ module Aws::TranscribeService
|
|
4834
4191
|
#
|
4835
4192
|
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
|
4836
4193
|
#
|
4837
|
-
# @note When making an API call, you may pass Tag
|
4838
|
-
# data as a hash:
|
4839
|
-
#
|
4840
|
-
# {
|
4841
|
-
# key: "TagKey", # required
|
4842
|
-
# value: "TagValue", # required
|
4843
|
-
# }
|
4844
|
-
#
|
4845
4194
|
# @!attribute [rw] key
|
4846
4195
|
# The first part of a key:value pair that forms a tag associated with
|
4847
4196
|
# a given resource. For example, in the tag `Department:Sales`, the
|
@@ -4867,26 +4216,13 @@ module Aws::TranscribeService
|
|
4867
4216
|
include Aws::Structure
|
4868
4217
|
end
|
4869
4218
|
|
4870
|
-
# @note When making an API call, you may pass TagResourceRequest
|
4871
|
-
# data as a hash:
|
4872
|
-
#
|
4873
|
-
# {
|
4874
|
-
# resource_arn: "TranscribeArn", # required
|
4875
|
-
# tags: [ # required
|
4876
|
-
# {
|
4877
|
-
# key: "TagKey", # required
|
4878
|
-
# value: "TagValue", # required
|
4879
|
-
# },
|
4880
|
-
# ],
|
4881
|
-
# }
|
4882
|
-
#
|
4883
4219
|
# @!attribute [rw] resource_arn
|
4884
4220
|
# The Amazon Resource Name (ARN) of the resource you want to tag. ARNs
|
4885
4221
|
# have the format
|
4886
4222
|
# `arn:partition:service:region:account-id:resource-type/resource-id`.
|
4887
4223
|
#
|
4888
4224
|
# For example,
|
4889
|
-
# `arn:aws:transcribe:us-west-2:
|
4225
|
+
# `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
|
4890
4226
|
#
|
4891
4227
|
# Valid values for `resource-type` are: `transcription-job`,
|
4892
4228
|
# `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
|
@@ -4986,37 +4322,17 @@ module Aws::TranscribeService
|
|
4986
4322
|
#
|
4987
4323
|
# * Custom words or phrases that occur at a specific time frame
|
4988
4324
|
#
|
4989
|
-
# See [Rule criteria][1] for
|
4990
|
-
#
|
4325
|
+
# See [Rule criteria for batch categories][1] and [Rule criteria for
|
4326
|
+
# streaming categories][2] for usage examples.
|
4991
4327
|
#
|
4992
4328
|
#
|
4993
|
-
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics-create-categories.html#call-analytics-create-categories-rules
|
4994
4329
|
#
|
4995
|
-
#
|
4996
|
-
#
|
4997
|
-
#
|
4998
|
-
# {
|
4999
|
-
# transcript_filter_type: "EXACT", # required, accepts EXACT
|
5000
|
-
# absolute_time_range: {
|
5001
|
-
# start_time: 1,
|
5002
|
-
# end_time: 1,
|
5003
|
-
# first: 1,
|
5004
|
-
# last: 1,
|
5005
|
-
# },
|
5006
|
-
# relative_time_range: {
|
5007
|
-
# start_percentage: 1,
|
5008
|
-
# end_percentage: 1,
|
5009
|
-
# first: 1,
|
5010
|
-
# last: 1,
|
5011
|
-
# },
|
5012
|
-
# participant_role: "AGENT", # accepts AGENT, CUSTOMER
|
5013
|
-
# negate: false,
|
5014
|
-
# targets: ["NonEmptyString"], # required
|
5015
|
-
# }
|
4330
|
+
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-batch.html#tca-rules-batch
|
4331
|
+
# [2]: https://docs.aws.amazon.com/transcribe/latest/dg/tca-categories-stream.html#tca-rules-stream
|
5016
4332
|
#
|
5017
4333
|
# @!attribute [rw] transcript_filter_type
|
5018
|
-
# Flag the presence or absence of an exact match to the phrases
|
5019
|
-
# specify. For example, if you specify the phrase "speak to a
|
4334
|
+
# Flag the presence or absence of an exact match to the phrases that
|
4335
|
+
# you specify. For example, if you specify the phrase "speak to a
|
5020
4336
|
# manager" as your `Targets` value, only that exact phrase is
|
5021
4337
|
# flagged.
|
5022
4338
|
#
|
@@ -5026,30 +4342,30 @@ module Aws::TranscribeService
|
|
5026
4342
|
# @return [String]
|
5027
4343
|
#
|
5028
4344
|
# @!attribute [rw] absolute_time_range
|
5029
|
-
#
|
5030
|
-
# during which you want to search for the specified key words
|
5031
|
-
# phrases. See for more detail.
|
4345
|
+
# Makes it possible to specify a time range (in milliseconds) in your
|
4346
|
+
# audio, during which you want to search for the specified key words
|
4347
|
+
# or phrases. See for more detail.
|
5032
4348
|
# @return [Types::AbsoluteTimeRange]
|
5033
4349
|
#
|
5034
4350
|
# @!attribute [rw] relative_time_range
|
5035
|
-
#
|
5036
|
-
# file, during which you want to search for the specified key
|
5037
|
-
# phrases. See for more detail.
|
4351
|
+
# Makes it possible to specify a time range (in percentage) in your
|
4352
|
+
# media file, during which you want to search for the specified key
|
4353
|
+
# words or phrases. See for more detail.
|
5038
4354
|
# @return [Types::RelativeTimeRange]
|
5039
4355
|
#
|
5040
4356
|
# @!attribute [rw] participant_role
|
5041
|
-
# Specify the participant you want to flag. Omitting this
|
5042
|
-
# equivalent to specifying both participants.
|
4357
|
+
# Specify the participant that you want to flag. Omitting this
|
4358
|
+
# parameter is equivalent to specifying both participants.
|
5043
4359
|
# @return [String]
|
5044
4360
|
#
|
5045
4361
|
# @!attribute [rw] negate
|
5046
|
-
# Set to `TRUE` to flag the absence of the phrase you specified
|
5047
|
-
# your request. Set to `FALSE` to flag the presence of the phrase
|
5048
|
-
# specified in your request.
|
4362
|
+
# Set to `TRUE` to flag the absence of the phrase that you specified
|
4363
|
+
# in your request. Set to `FALSE` to flag the presence of the phrase
|
4364
|
+
# that you specified in your request.
|
5049
4365
|
# @return [Boolean]
|
5050
4366
|
#
|
5051
4367
|
# @!attribute [rw] targets
|
5052
|
-
# Specify the phrases you want to flag.
|
4368
|
+
# Specify the phrases that you want to flag.
|
5053
4369
|
# @return [Array<String>]
|
5054
4370
|
#
|
5055
4371
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptFilter AWS API Documentation
|
@@ -5092,22 +4408,14 @@ module Aws::TranscribeService
|
|
5092
4408
|
# @return [String]
|
5093
4409
|
#
|
5094
4410
|
# @!attribute [rw] language_code
|
5095
|
-
# The language code used to create your transcription job.
|
5096
|
-
#
|
5097
|
-
# the
|
5098
|
-
#
|
5099
|
-
# Note that you must include one of `LanguageCode`,
|
5100
|
-
# `IdentifyLanguage`, or `IdentifyMultipleLanguages` in your request.
|
5101
|
-
# If you include more than one of these parameters, your transcription
|
5102
|
-
# job fails.
|
5103
|
-
#
|
5104
|
-
#
|
5105
|
-
#
|
5106
|
-
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
|
4411
|
+
# The language code used to create your transcription job. This
|
4412
|
+
# parameter is used with single-language identification. For
|
4413
|
+
# multi-language identification requests, refer to the plural version
|
4414
|
+
# of this parameter, `LanguageCodes`.
|
5107
4415
|
# @return [String]
|
5108
4416
|
#
|
5109
4417
|
# @!attribute [rw] media_sample_rate_hertz
|
5110
|
-
# The sample rate, in
|
4418
|
+
# The sample rate, in hertz, of the audio track in your input media
|
5111
4419
|
# file.
|
5112
4420
|
# @return [Integer]
|
5113
4421
|
#
|
@@ -5116,8 +4424,8 @@ module Aws::TranscribeService
|
|
5116
4424
|
# @return [String]
|
5117
4425
|
#
|
5118
4426
|
# @!attribute [rw] media
|
5119
|
-
#
|
5120
|
-
#
|
4427
|
+
# Provides the Amazon S3 location of the media file you used in your
|
4428
|
+
# request.
|
5121
4429
|
# @return [Types::Media]
|
5122
4430
|
#
|
5123
4431
|
# @!attribute [rw] transcript
|
@@ -5174,7 +4482,7 @@ module Aws::TranscribeService
|
|
5174
4482
|
# * `Invalid sample rate for audio file`.
|
5175
4483
|
#
|
5176
4484
|
# The sample rate specified in `MediaSampleRateHertz` isn't valid.
|
5177
|
-
# The sample rate must be between 8,000 and 48,000
|
4485
|
+
# The sample rate must be between 8,000 and 48,000 hertz.
|
5178
4486
|
#
|
5179
4487
|
# * `The sample rate provided does not match the detected sample
|
5180
4488
|
# rate`.
|
@@ -5201,39 +4509,25 @@ module Aws::TranscribeService
|
|
5201
4509
|
# @return [String]
|
5202
4510
|
#
|
5203
4511
|
# @!attribute [rw] settings
|
5204
|
-
#
|
5205
|
-
# channel identification,
|
5206
|
-
#
|
5207
|
-
# filters.
|
5208
|
-
#
|
5209
|
-
# If you want to include a custom vocabulary or a custom vocabulary
|
5210
|
-
# filter (or both) with your request but **do not** want to use
|
5211
|
-
# automatic language identification, use `Settings` with the
|
5212
|
-
# `VocabularyName` or `VocabularyFilterName` (or both) sub-parameter.
|
5213
|
-
#
|
5214
|
-
# If you're using automatic language identification with your request
|
5215
|
-
# and want to include a custom language model, a custom vocabulary, or
|
5216
|
-
# a custom vocabulary filter, do not use the `Settings` parameter; use
|
5217
|
-
# instead the ` parameter with the LanguageModelName, VocabularyName
|
5218
|
-
# or VocabularyFilterName sub-parameters.</p>
|
5219
|
-
# `
|
4512
|
+
# Provides information on any additional settings that were included
|
4513
|
+
# in your request. Additional settings include channel identification,
|
4514
|
+
# alternative transcriptions, speaker partitioning, custom
|
4515
|
+
# vocabularies, and custom vocabulary filters.
|
5220
4516
|
# @return [Types::Settings]
|
5221
4517
|
#
|
5222
4518
|
# @!attribute [rw] model_settings
|
5223
|
-
#
|
5224
|
-
#
|
5225
|
-
# you must include the `LanguageModelName` sub-parameter.
|
4519
|
+
# Provides information on the custom language model you included in
|
4520
|
+
# your request.
|
5226
4521
|
# @return [Types::ModelSettings]
|
5227
4522
|
#
|
5228
4523
|
# @!attribute [rw] job_execution_settings
|
5229
|
-
# Provides information about how your transcription job
|
5230
|
-
#
|
5231
|
-
#
|
4524
|
+
# Provides information about how your transcription job was processed.
|
4525
|
+
# This parameter shows if your request was queued and what data access
|
4526
|
+
# role was used.
|
5232
4527
|
# @return [Types::JobExecutionSettings]
|
5233
4528
|
#
|
5234
4529
|
# @!attribute [rw] content_redaction
|
5235
|
-
#
|
5236
|
-
# in your transcript.
|
4530
|
+
# Indicates whether redaction was enabled in your transcript.
|
5237
4531
|
# @return [Types::ContentRedaction]
|
5238
4532
|
#
|
5239
4533
|
# @!attribute [rw] identify_language
|
@@ -5247,22 +4541,7 @@ module Aws::TranscribeService
|
|
5247
4541
|
# @return [Boolean]
|
5248
4542
|
#
|
5249
4543
|
# @!attribute [rw] language_options
|
5250
|
-
#
|
5251
|
-
# languages you think may be present in your media; including more
|
5252
|
-
# than five is not recommended. If you're unsure what languages are
|
5253
|
-
# present, do not include this parameter.
|
5254
|
-
#
|
5255
|
-
# If you include `LanguageOptions` in your request, you must also
|
5256
|
-
# include `IdentifyLanguage`.
|
5257
|
-
#
|
5258
|
-
# For more information, refer to [Supported languages][1].
|
5259
|
-
#
|
5260
|
-
# To transcribe speech in Modern Standard Arabic (`ar-SA`), your media
|
5261
|
-
# file must be encoded at a sample rate of 16,000 Hz or higher.
|
5262
|
-
#
|
5263
|
-
#
|
5264
|
-
#
|
5265
|
-
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
|
4544
|
+
# Provides the language codes you specified in your request.
|
5266
4545
|
# @return [Array<String>]
|
5267
4546
|
#
|
5268
4547
|
# @!attribute [rw] identified_language_score
|
@@ -5279,62 +4558,21 @@ module Aws::TranscribeService
|
|
5279
4558
|
# parameter is used with multi-language identification. For
|
5280
4559
|
# single-language identification requests, refer to the singular
|
5281
4560
|
# version of this parameter, `LanguageCode`.
|
5282
|
-
#
|
5283
|
-
# For a list of supported languages and their associated language
|
5284
|
-
# codes, refer to the [Supported languages][1] table.
|
5285
|
-
#
|
5286
|
-
#
|
5287
|
-
#
|
5288
|
-
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html
|
5289
4561
|
# @return [Array<Types::LanguageCodeItem>]
|
5290
4562
|
#
|
5291
4563
|
# @!attribute [rw] tags
|
5292
|
-
#
|
5293
|
-
#
|
5294
|
-
#
|
5295
|
-
# To learn more about using tags with Amazon Transcribe, refer to
|
5296
|
-
# [Tagging resources][1].
|
5297
|
-
#
|
5298
|
-
#
|
5299
|
-
#
|
5300
|
-
# [1]: https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html
|
4564
|
+
# The tags, each in the form of a key:value pair, assigned to the
|
4565
|
+
# specified transcription job.
|
5301
4566
|
# @return [Array<Types::Tag>]
|
5302
4567
|
#
|
5303
4568
|
# @!attribute [rw] subtitles
|
5304
|
-
#
|
5305
|
-
# request.
|
4569
|
+
# Indicates whether subtitles were generated with your transcription.
|
5306
4570
|
# @return [Types::SubtitlesOutput]
|
5307
4571
|
#
|
5308
4572
|
# @!attribute [rw] language_id_settings
|
5309
|
-
#
|
5310
|
-
#
|
5311
|
-
#
|
5312
|
-
# `LanguageIdSettings` with the relevant sub-parameters
|
5313
|
-
# (`VocabularyName`, `LanguageModelName`, and `VocabularyFilterName`).
|
5314
|
-
#
|
5315
|
-
# You can specify two or more language codes that represent the
|
5316
|
-
# languages you think may be present in your media; including more
|
5317
|
-
# than five is not recommended. Each language code you include can
|
5318
|
-
# have an associated custom language model, custom vocabulary, and
|
5319
|
-
# custom vocabulary filter. The languages you specify must match the
|
5320
|
-
# languages of the specified custom language models, custom
|
5321
|
-
# vocabularies, and custom vocabulary filters.
|
5322
|
-
#
|
5323
|
-
# To include language options using `IdentifyLanguage` **without**
|
5324
|
-
# including a custom language model, a custom vocabulary, or a custom
|
5325
|
-
# vocabulary filter, use `LanguageOptions` instead of
|
5326
|
-
# `LanguageIdSettings`. Including language options can improve the
|
5327
|
-
# accuracy of automatic language identification.
|
5328
|
-
#
|
5329
|
-
# If you want to include a custom language model with your request but
|
5330
|
-
# **do not** want to use automatic language identification, use
|
5331
|
-
# instead the ` parameter with the LanguageModelName
|
5332
|
-
# sub-parameter.</p> If you want to include a custom vocabulary or a
|
5333
|
-
# custom vocabulary filter (or both) with your request but do not want
|
5334
|
-
# to use automatic language identification, use instead the parameter
|
5335
|
-
# with the VocabularyName or VocabularyFilterName (or both)
|
5336
|
-
# sub-parameter.</p>
|
5337
|
-
# `
|
4573
|
+
# Provides the name and language of all custom language models, custom
|
4574
|
+
# vocabularies, and custom vocabulary filters that you included in
|
4575
|
+
# your request.
|
5338
4576
|
# @return [Hash<String,Types::LanguageIdSettings>]
|
5339
4577
|
#
|
5340
4578
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptionJob AWS API Documentation
|
@@ -5502,21 +4740,13 @@ module Aws::TranscribeService
|
|
5502
4740
|
include Aws::Structure
|
5503
4741
|
end
|
5504
4742
|
|
5505
|
-
# @note When making an API call, you may pass UntagResourceRequest
|
5506
|
-
# data as a hash:
|
5507
|
-
#
|
5508
|
-
# {
|
5509
|
-
# resource_arn: "TranscribeArn", # required
|
5510
|
-
# tag_keys: ["TagKey"], # required
|
5511
|
-
# }
|
5512
|
-
#
|
5513
4743
|
# @!attribute [rw] resource_arn
|
5514
4744
|
# The Amazon Resource Name (ARN) of the Amazon Transcribe resource you
|
5515
4745
|
# want to remove tags from. ARNs have the format
|
5516
4746
|
# `arn:partition:service:region:account-id:resource-type/resource-id`.
|
5517
4747
|
#
|
5518
4748
|
# For example,
|
5519
|
-
# `arn:aws:transcribe:us-west-2:
|
4749
|
+
# `arn:aws:transcribe:us-west-2:111122223333:transcription-job/transcription-job-name`.
|
5520
4750
|
#
|
5521
4751
|
# Valid values for `resource-type` are: `transcription-job`,
|
5522
4752
|
# `medical-transcription-job`, `vocabulary`, `medical-vocabulary`,
|
@@ -5541,85 +4771,6 @@ module Aws::TranscribeService
|
|
5541
4771
|
#
|
5542
4772
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
5543
4773
|
|
5544
|
-
# @note When making an API call, you may pass UpdateCallAnalyticsCategoryRequest
|
5545
|
-
# data as a hash:
|
5546
|
-
#
|
5547
|
-
# {
|
5548
|
-
# category_name: "CategoryName", # required
|
5549
|
-
# rules: [ # required
|
5550
|
-
# {
|
5551
|
-
# non_talk_time_filter: {
|
5552
|
-
# threshold: 1,
|
5553
|
-
# absolute_time_range: {
|
5554
|
-
# start_time: 1,
|
5555
|
-
# end_time: 1,
|
5556
|
-
# first: 1,
|
5557
|
-
# last: 1,
|
5558
|
-
# },
|
5559
|
-
# relative_time_range: {
|
5560
|
-
# start_percentage: 1,
|
5561
|
-
# end_percentage: 1,
|
5562
|
-
# first: 1,
|
5563
|
-
# last: 1,
|
5564
|
-
# },
|
5565
|
-
# negate: false,
|
5566
|
-
# },
|
5567
|
-
# interruption_filter: {
|
5568
|
-
# threshold: 1,
|
5569
|
-
# participant_role: "AGENT", # accepts AGENT, CUSTOMER
|
5570
|
-
# absolute_time_range: {
|
5571
|
-
# start_time: 1,
|
5572
|
-
# end_time: 1,
|
5573
|
-
# first: 1,
|
5574
|
-
# last: 1,
|
5575
|
-
# },
|
5576
|
-
# relative_time_range: {
|
5577
|
-
# start_percentage: 1,
|
5578
|
-
# end_percentage: 1,
|
5579
|
-
# first: 1,
|
5580
|
-
# last: 1,
|
5581
|
-
# },
|
5582
|
-
# negate: false,
|
5583
|
-
# },
|
5584
|
-
# transcript_filter: {
|
5585
|
-
# transcript_filter_type: "EXACT", # required, accepts EXACT
|
5586
|
-
# absolute_time_range: {
|
5587
|
-
# start_time: 1,
|
5588
|
-
# end_time: 1,
|
5589
|
-
# first: 1,
|
5590
|
-
# last: 1,
|
5591
|
-
# },
|
5592
|
-
# relative_time_range: {
|
5593
|
-
# start_percentage: 1,
|
5594
|
-
# end_percentage: 1,
|
5595
|
-
# first: 1,
|
5596
|
-
# last: 1,
|
5597
|
-
# },
|
5598
|
-
# participant_role: "AGENT", # accepts AGENT, CUSTOMER
|
5599
|
-
# negate: false,
|
5600
|
-
# targets: ["NonEmptyString"], # required
|
5601
|
-
# },
|
5602
|
-
# sentiment_filter: {
|
5603
|
-
# sentiments: ["POSITIVE"], # required, accepts POSITIVE, NEGATIVE, NEUTRAL, MIXED
|
5604
|
-
# absolute_time_range: {
|
5605
|
-
# start_time: 1,
|
5606
|
-
# end_time: 1,
|
5607
|
-
# first: 1,
|
5608
|
-
# last: 1,
|
5609
|
-
# },
|
5610
|
-
# relative_time_range: {
|
5611
|
-
# start_percentage: 1,
|
5612
|
-
# end_percentage: 1,
|
5613
|
-
# first: 1,
|
5614
|
-
# last: 1,
|
5615
|
-
# },
|
5616
|
-
# participant_role: "AGENT", # accepts AGENT, CUSTOMER
|
5617
|
-
# negate: false,
|
5618
|
-
# },
|
5619
|
-
# },
|
5620
|
-
# ],
|
5621
|
-
# }
|
5622
|
-
#
|
5623
4774
|
# @!attribute [rw] category_name
|
5624
4775
|
# The name of the Call Analytics category you want to update. Category
|
5625
4776
|
# names are case sensitive.
|
@@ -5631,11 +4782,20 @@ module Aws::TranscribeService
|
|
5631
4782
|
# used in the specified category.
|
5632
4783
|
# @return [Array<Types::Rule>]
|
5633
4784
|
#
|
4785
|
+
# @!attribute [rw] input_type
|
4786
|
+
# Choose whether you want to update a streaming or a batch Call
|
4787
|
+
# Analytics category. The input type you specify must match the input
|
4788
|
+
# type specified when the category was created. For example, if you
|
4789
|
+
# created a category with the `POST_CALL` input type, you must use
|
4790
|
+
# `POST_CALL` as the input type when updating this category.
|
4791
|
+
# @return [String]
|
4792
|
+
#
|
5634
4793
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateCallAnalyticsCategoryRequest AWS API Documentation
|
5635
4794
|
#
|
5636
4795
|
class UpdateCallAnalyticsCategoryRequest < Struct.new(
|
5637
4796
|
:category_name,
|
5638
|
-
:rules
|
4797
|
+
:rules,
|
4798
|
+
:input_type)
|
5639
4799
|
SENSITIVE = []
|
5640
4800
|
include Aws::Structure
|
5641
4801
|
end
|
@@ -5653,18 +4813,9 @@ module Aws::TranscribeService
|
|
5653
4813
|
include Aws::Structure
|
5654
4814
|
end
|
5655
4815
|
|
5656
|
-
# @note When making an API call, you may pass UpdateMedicalVocabularyRequest
|
5657
|
-
# data as a hash:
|
5658
|
-
#
|
5659
|
-
# {
|
5660
|
-
# vocabulary_name: "VocabularyName", # required
|
5661
|
-
# language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
|
5662
|
-
# vocabulary_file_uri: "Uri", # required
|
5663
|
-
# }
|
5664
|
-
#
|
5665
4816
|
# @!attribute [rw] vocabulary_name
|
5666
|
-
# The name of the custom medical vocabulary you want to update.
|
5667
|
-
#
|
4817
|
+
# The name of the custom medical vocabulary you want to update. Custom
|
4818
|
+
# medical vocabulary names are case sensitive.
|
5668
4819
|
# @return [String]
|
5669
4820
|
#
|
5670
4821
|
# @!attribute [rw] language_code
|
@@ -5697,8 +4848,8 @@ module Aws::TranscribeService
|
|
5697
4848
|
# @return [String]
|
5698
4849
|
#
|
5699
4850
|
# @!attribute [rw] language_code
|
5700
|
-
# The language code you selected for your medical vocabulary.
|
5701
|
-
# English (`en-US`) is the only language supported with Amazon
|
4851
|
+
# The language code you selected for your custom medical vocabulary.
|
4852
|
+
# US English (`en-US`) is the only language supported with Amazon
|
5702
4853
|
# Transcribe Medical.
|
5703
4854
|
# @return [String]
|
5704
4855
|
#
|
@@ -5713,7 +4864,7 @@ module Aws::TranscribeService
|
|
5713
4864
|
#
|
5714
4865
|
# @!attribute [rw] vocabulary_state
|
5715
4866
|
# The processing state of your custom medical vocabulary. If the state
|
5716
|
-
# is `READY`, you can use the vocabulary in a
|
4867
|
+
# is `READY`, you can use the custom vocabulary in a
|
5717
4868
|
# `StartMedicalTranscriptionJob` request.
|
5718
4869
|
# @return [String]
|
5719
4870
|
#
|
@@ -5728,26 +4879,17 @@ module Aws::TranscribeService
|
|
5728
4879
|
include Aws::Structure
|
5729
4880
|
end
|
5730
4881
|
|
5731
|
-
# @note When making an API call, you may pass UpdateVocabularyFilterRequest
|
5732
|
-
# data as a hash:
|
5733
|
-
#
|
5734
|
-
# {
|
5735
|
-
# vocabulary_filter_name: "VocabularyFilterName", # required
|
5736
|
-
# words: ["Word"],
|
5737
|
-
# vocabulary_filter_file_uri: "Uri",
|
5738
|
-
# }
|
5739
|
-
#
|
5740
4882
|
# @!attribute [rw] vocabulary_filter_name
|
5741
|
-
# The name of the custom vocabulary filter you want to update.
|
5742
|
-
#
|
4883
|
+
# The name of the custom vocabulary filter you want to update. Custom
|
4884
|
+
# vocabulary filter names are case sensitive.
|
5743
4885
|
# @return [String]
|
5744
4886
|
#
|
5745
4887
|
# @!attribute [rw] words
|
5746
|
-
# Use this parameter if you want to update your vocabulary
|
5747
|
-
# including all desired terms, as comma-separated values,
|
5748
|
-
# request. The other option for updating your vocabulary
|
5749
|
-
# save your entries in a text file and upload them to an
|
5750
|
-
# bucket, then specify the location of your file using the
|
4888
|
+
# Use this parameter if you want to update your custom vocabulary
|
4889
|
+
# filter by including all desired terms, as comma-separated values,
|
4890
|
+
# within your request. The other option for updating your vocabulary
|
4891
|
+
# filter is to save your entries in a text file and upload them to an
|
4892
|
+
# Amazon S3 bucket, then specify the location of your file using the
|
5751
4893
|
# `VocabularyFilterFileUri` parameter.
|
5752
4894
|
#
|
5753
4895
|
# Note that if you include `Words` in your request, you cannot use
|
@@ -5755,7 +4897,7 @@ module Aws::TranscribeService
|
|
5755
4897
|
#
|
5756
4898
|
# Each language has a character set that contains all allowed
|
5757
4899
|
# characters for that specific language. If you use unsupported
|
5758
|
-
# characters, your vocabulary filter request fails. Refer to
|
4900
|
+
# characters, your custom vocabulary filter request fails. Refer to
|
5759
4901
|
# [Character Sets for Custom Vocabularies][1] to get the character set
|
5760
4902
|
# for your language.
|
5761
4903
|
#
|
@@ -5791,11 +4933,12 @@ module Aws::TranscribeService
|
|
5791
4933
|
# @return [String]
|
5792
4934
|
#
|
5793
4935
|
# @!attribute [rw] language_code
|
5794
|
-
# The language code you selected for your vocabulary filter.
|
4936
|
+
# The language code you selected for your custom vocabulary filter.
|
5795
4937
|
# @return [String]
|
5796
4938
|
#
|
5797
4939
|
# @!attribute [rw] last_modified_time
|
5798
|
-
# The date and time the specified vocabulary filter was last
|
4940
|
+
# The date and time the specified custom vocabulary filter was last
|
4941
|
+
# updated.
|
5799
4942
|
#
|
5800
4943
|
# Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
|
5801
4944
|
# example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
|
@@ -5812,30 +4955,20 @@ module Aws::TranscribeService
|
|
5812
4955
|
include Aws::Structure
|
5813
4956
|
end
|
5814
4957
|
|
5815
|
-
# @note When making an API call, you may pass UpdateVocabularyRequest
|
5816
|
-
# data as a hash:
|
5817
|
-
#
|
5818
|
-
# {
|
5819
|
-
# vocabulary_name: "VocabularyName", # required
|
5820
|
-
# language_code: "af-ZA", # required, accepts af-ZA, ar-AE, ar-SA, da-DK, de-CH, de-DE, en-AB, en-AU, en-GB, en-IE, en-IN, en-US, en-WL, es-ES, es-US, fa-IR, fr-CA, fr-FR, he-IL, hi-IN, id-ID, it-IT, ja-JP, ko-KR, ms-MY, nl-NL, pt-BR, pt-PT, ru-RU, ta-IN, te-IN, tr-TR, zh-CN, zh-TW, th-TH, en-ZA, en-NZ
|
5821
|
-
# phrases: ["Phrase"],
|
5822
|
-
# vocabulary_file_uri: "Uri",
|
5823
|
-
# }
|
5824
|
-
#
|
5825
4958
|
# @!attribute [rw] vocabulary_name
|
5826
|
-
# The name of the custom vocabulary you want to update.
|
5827
|
-
# names are case sensitive.
|
4959
|
+
# The name of the custom vocabulary you want to update. Custom
|
4960
|
+
# vocabulary names are case sensitive.
|
5828
4961
|
# @return [String]
|
5829
4962
|
#
|
5830
4963
|
# @!attribute [rw] language_code
|
5831
4964
|
# The language code that represents the language of the entries in the
|
5832
|
-
# custom vocabulary you want to update. Each vocabulary must
|
5833
|
-
# terms in only one language.
|
4965
|
+
# custom vocabulary you want to update. Each custom vocabulary must
|
4966
|
+
# contain terms in only one language.
|
5834
4967
|
#
|
5835
4968
|
# A custom vocabulary can only be used to transcribe files in the same
|
5836
|
-
# language as the vocabulary. For example, if you create a
|
5837
|
-
# using US English (`en-US`), you can only apply
|
5838
|
-
# files that contain English audio.
|
4969
|
+
# language as the custom vocabulary. For example, if you create a
|
4970
|
+
# custom vocabulary using US English (`en-US`), you can only apply
|
4971
|
+
# this custom vocabulary to files that contain English audio.
|
5839
4972
|
#
|
5840
4973
|
# For a list of supported languages and their associated language
|
5841
4974
|
# codes, refer to the [Supported languages][1] table.
|
@@ -5846,19 +4979,19 @@ module Aws::TranscribeService
|
|
5846
4979
|
# @return [String]
|
5847
4980
|
#
|
5848
4981
|
# @!attribute [rw] phrases
|
5849
|
-
# Use this parameter if you want to update your vocabulary by
|
4982
|
+
# Use this parameter if you want to update your custom vocabulary by
|
5850
4983
|
# including all desired terms, as comma-separated values, within your
|
5851
|
-
# request. The other option for updating your vocabulary is to
|
5852
|
-
# your entries in a text file and upload them to an Amazon S3
|
5853
|
-
# then specify the location of your file using the
|
5854
|
-
# parameter.
|
4984
|
+
# request. The other option for updating your custom vocabulary is to
|
4985
|
+
# save your entries in a text file and upload them to an Amazon S3
|
4986
|
+
# bucket, then specify the location of your file using the
|
4987
|
+
# `VocabularyFileUri` parameter.
|
5855
4988
|
#
|
5856
4989
|
# Note that if you include `Phrases` in your request, you cannot use
|
5857
4990
|
# `VocabularyFileUri`; you must choose one or the other.
|
5858
4991
|
#
|
5859
4992
|
# Each language has a character set that contains all allowed
|
5860
4993
|
# characters for that specific language. If you use unsupported
|
5861
|
-
# characters, your vocabulary filter request fails. Refer to
|
4994
|
+
# characters, your custom vocabulary filter request fails. Refer to
|
5862
4995
|
# [Character Sets for Custom Vocabularies][1] to get the character set
|
5863
4996
|
# for your language.
|
5864
4997
|
#
|
@@ -5899,7 +5032,7 @@ module Aws::TranscribeService
|
|
5899
5032
|
# @return [String]
|
5900
5033
|
#
|
5901
5034
|
# @!attribute [rw] last_modified_time
|
5902
|
-
# The date and time the specified vocabulary was last updated.
|
5035
|
+
# The date and time the specified custom vocabulary was last updated.
|
5903
5036
|
#
|
5904
5037
|
# Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
|
5905
5038
|
# example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
|
@@ -5908,8 +5041,8 @@ module Aws::TranscribeService
|
|
5908
5041
|
#
|
5909
5042
|
# @!attribute [rw] vocabulary_state
|
5910
5043
|
# The processing state of your custom vocabulary. If the state is
|
5911
|
-
# `READY`, you can use the vocabulary in a
|
5912
|
-
# request.
|
5044
|
+
# `READY`, you can use the custom vocabulary in a
|
5045
|
+
# `StartTranscriptionJob` request.
|
5913
5046
|
# @return [String]
|
5914
5047
|
#
|
5915
5048
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabularyResponse AWS API Documentation
|
@@ -5923,8 +5056,8 @@ module Aws::TranscribeService
|
|
5923
5056
|
include Aws::Structure
|
5924
5057
|
end
|
5925
5058
|
|
5926
|
-
# Provides information about a vocabulary filter, including the
|
5927
|
-
# of the filter, when it was last modified, and its name.
|
5059
|
+
# Provides information about a custom vocabulary filter, including the
|
5060
|
+
# language of the filter, when it was last modified, and its name.
|
5928
5061
|
#
|
5929
5062
|
# @!attribute [rw] vocabulary_filter_name
|
5930
5063
|
# A unique name, chosen by you, for your custom vocabulary filter.
|
@@ -5934,13 +5067,13 @@ module Aws::TranscribeService
|
|
5934
5067
|
#
|
5935
5068
|
# @!attribute [rw] language_code
|
5936
5069
|
# The language code that represents the language of the entries in
|
5937
|
-
# your vocabulary filter. Each vocabulary filter must contain
|
5938
|
-
# only one language.
|
5070
|
+
# your vocabulary filter. Each custom vocabulary filter must contain
|
5071
|
+
# terms in only one language.
|
5939
5072
|
#
|
5940
|
-
# A vocabulary filter can only be used to transcribe files in
|
5941
|
-
# language as the filter. For example, if you create a
|
5942
|
-
# filter using US English (`en-US`), you can only apply
|
5943
|
-
# files that contain English audio.
|
5073
|
+
# A custom vocabulary filter can only be used to transcribe files in
|
5074
|
+
# the same language as the filter. For example, if you create a custom
|
5075
|
+
# vocabulary filter using US English (`en-US`), you can only apply
|
5076
|
+
# this filter to files that contain English audio.
|
5944
5077
|
#
|
5945
5078
|
# For a list of supported languages and their associated language
|
5946
5079
|
# codes, refer to the [Supported languages][1] table.
|
@@ -5951,7 +5084,8 @@ module Aws::TranscribeService
|
|
5951
5084
|
# @return [String]
|
5952
5085
|
#
|
5953
5086
|
# @!attribute [rw] last_modified_time
|
5954
|
-
# The date and time the specified vocabulary filter was last
|
5087
|
+
# The date and time the specified custom vocabulary filter was last
|
5088
|
+
# modified.
|
5955
5089
|
#
|
5956
5090
|
# Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
|
5957
5091
|
# example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
|
@@ -5969,7 +5103,7 @@ module Aws::TranscribeService
|
|
5969
5103
|
end
|
5970
5104
|
|
5971
5105
|
# Provides information about a custom vocabulary, including the language
|
5972
|
-
# of the vocabulary, when it was last modified, its name, and the
|
5106
|
+
# of the custom vocabulary, when it was last modified, its name, and the
|
5973
5107
|
# processing state.
|
5974
5108
|
#
|
5975
5109
|
# @!attribute [rw] vocabulary_name
|
@@ -5979,17 +5113,17 @@ module Aws::TranscribeService
|
|
5979
5113
|
# @return [String]
|
5980
5114
|
#
|
5981
5115
|
# @!attribute [rw] language_code
|
5982
|
-
# The language code used to create your custom vocabulary. Each
|
5116
|
+
# The language code used to create your custom vocabulary. Each custom
|
5983
5117
|
# vocabulary must contain terms in only one language.
|
5984
5118
|
#
|
5985
5119
|
# A custom vocabulary can only be used to transcribe files in the same
|
5986
|
-
# language as the vocabulary. For example, if you create a
|
5987
|
-
# using US English (`en-US`), you can only apply
|
5988
|
-
# files that contain English audio.
|
5120
|
+
# language as the custom vocabulary. For example, if you create a
|
5121
|
+
# custom vocabulary using US English (`en-US`), you can only apply
|
5122
|
+
# this custom vocabulary to files that contain English audio.
|
5989
5123
|
# @return [String]
|
5990
5124
|
#
|
5991
5125
|
# @!attribute [rw] last_modified_time
|
5992
|
-
# The date and time the specified vocabulary was last modified.
|
5126
|
+
# The date and time the specified custom vocabulary was last modified.
|
5993
5127
|
#
|
5994
5128
|
# Timestamps are in the format `YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC`. For
|
5995
5129
|
# example, `2022-05-04T12:32:58.761000-07:00` represents 12:32 PM
|
@@ -5998,8 +5132,8 @@ module Aws::TranscribeService
|
|
5998
5132
|
#
|
5999
5133
|
# @!attribute [rw] vocabulary_state
|
6000
5134
|
# The processing state of your custom vocabulary. If the state is
|
6001
|
-
# `READY`, you can use the vocabulary in a
|
6002
|
-
# request.
|
5135
|
+
# `READY`, you can use the custom vocabulary in a
|
5136
|
+
# `StartTranscriptionJob` request.
|
6003
5137
|
# @return [String]
|
6004
5138
|
#
|
6005
5139
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/VocabularyInfo AWS API Documentation
|