aws-sdk-transcribeservice 1.0.0 → 1.1.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
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c6de1e1feef3ca49f85f901b9c5a912e6ba4cc19
|
4
|
+
data.tar.gz: 0e3a414fac70c427f871dd1447ba4f540ba32280
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 89aacad7cdb5315f77cda197c0af9684a30c65af95ad2ddae196f779231434750cb016d5d98b424a671558caeedd48401f971667638b5cdebacc1cb24cd2c9a7
|
7
|
+
data.tar.gz: d48f7208003be223ee4c5c4eb1a667982eb166b2d453dfd7c87bf5a0ccf155ed223d251b79cef69bc646c0fa811e8d46590cc231ab67049e33e92dbeb2936a83
|
@@ -155,10 +155,78 @@ module Aws::TranscribeService
|
|
155
155
|
|
156
156
|
# @!group API Operations
|
157
157
|
|
158
|
+
# Creates a new custom vocabulary that you can use to change the way
|
159
|
+
# Amazon Transcribe handles transcription of an audio file.
|
160
|
+
#
|
161
|
+
# @option params [required, String] :vocabulary_name
|
162
|
+
# The name of the vocabulary. The name must be unique within an AWS
|
163
|
+
# account. The name is case-sensitive.
|
164
|
+
#
|
165
|
+
# @option params [required, String] :language_code
|
166
|
+
# The language code of the vocabulary entries.
|
167
|
+
#
|
168
|
+
# @option params [required, Array<String>] :phrases
|
169
|
+
# An array of strings that contains the vocabulary entries.
|
170
|
+
#
|
171
|
+
# @return [Types::CreateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
172
|
+
#
|
173
|
+
# * {Types::CreateVocabularyResponse#vocabulary_name #vocabulary_name} => String
|
174
|
+
# * {Types::CreateVocabularyResponse#language_code #language_code} => String
|
175
|
+
# * {Types::CreateVocabularyResponse#vocabulary_state #vocabulary_state} => String
|
176
|
+
# * {Types::CreateVocabularyResponse#last_modified_time #last_modified_time} => Time
|
177
|
+
# * {Types::CreateVocabularyResponse#failure_reason #failure_reason} => String
|
178
|
+
#
|
179
|
+
# @example Request syntax with placeholder values
|
180
|
+
#
|
181
|
+
# resp = client.create_vocabulary({
|
182
|
+
# vocabulary_name: "VocabularyName", # required
|
183
|
+
# language_code: "en-US", # required, accepts en-US, es-US
|
184
|
+
# phrases: ["Phrase"], # required
|
185
|
+
# })
|
186
|
+
#
|
187
|
+
# @example Response structure
|
188
|
+
#
|
189
|
+
# resp.vocabulary_name #=> String
|
190
|
+
# resp.language_code #=> String, one of "en-US", "es-US"
|
191
|
+
# resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
|
192
|
+
# resp.last_modified_time #=> Time
|
193
|
+
# resp.failure_reason #=> String
|
194
|
+
#
|
195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabulary AWS API Documentation
|
196
|
+
#
|
197
|
+
# @overload create_vocabulary(params = {})
|
198
|
+
# @param [Hash] params ({})
|
199
|
+
def create_vocabulary(params = {}, options = {})
|
200
|
+
req = build_request(:create_vocabulary, params)
|
201
|
+
req.send_request(options)
|
202
|
+
end
|
203
|
+
|
204
|
+
# Deletes a vocabulary from Amazon Transcribe.
|
205
|
+
#
|
206
|
+
# @option params [required, String] :vocabulary_name
|
207
|
+
# The name of the vocabulary to delete.
|
208
|
+
#
|
209
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
210
|
+
#
|
211
|
+
# @example Request syntax with placeholder values
|
212
|
+
#
|
213
|
+
# resp = client.delete_vocabulary({
|
214
|
+
# vocabulary_name: "VocabularyName", # required
|
215
|
+
# })
|
216
|
+
#
|
217
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabulary AWS API Documentation
|
218
|
+
#
|
219
|
+
# @overload delete_vocabulary(params = {})
|
220
|
+
# @param [Hash] params ({})
|
221
|
+
def delete_vocabulary(params = {}, options = {})
|
222
|
+
req = build_request(:delete_vocabulary, params)
|
223
|
+
req.send_request(options)
|
224
|
+
end
|
225
|
+
|
158
226
|
# Returns information about a transcription job. To see the status of
|
159
|
-
# the job, check the `
|
160
|
-
# job is finished and you can find the results at the
|
161
|
-
# in the `TranscriptionFileUri` field.
|
227
|
+
# the job, check the `TranscriptionJobStatus` field. If the status is
|
228
|
+
# `COMPLETED`, the job is finished and you can find the results at the
|
229
|
+
# location specified in the `TranscriptionFileUri` field.
|
162
230
|
#
|
163
231
|
# @option params [required, String] :transcription_job_name
|
164
232
|
# The name of the job.
|
@@ -185,6 +253,9 @@ module Aws::TranscribeService
|
|
185
253
|
# resp.transcription_job.creation_time #=> Time
|
186
254
|
# resp.transcription_job.completion_time #=> Time
|
187
255
|
# resp.transcription_job.failure_reason #=> String
|
256
|
+
# resp.transcription_job.settings.vocabulary_name #=> String
|
257
|
+
# resp.transcription_job.settings.show_speaker_labels #=> Boolean
|
258
|
+
# resp.transcription_job.settings.max_speaker_labels #=> Integer
|
188
259
|
#
|
189
260
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetTranscriptionJob AWS API Documentation
|
190
261
|
#
|
@@ -195,18 +266,63 @@ module Aws::TranscribeService
|
|
195
266
|
req.send_request(options)
|
196
267
|
end
|
197
268
|
|
269
|
+
# Gets information about a vocabulary.
|
270
|
+
#
|
271
|
+
# @option params [required, String] :vocabulary_name
|
272
|
+
# The name of the vocabulary to return information about. The name is
|
273
|
+
# case-sensitive.
|
274
|
+
#
|
275
|
+
# @return [Types::GetVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
276
|
+
#
|
277
|
+
# * {Types::GetVocabularyResponse#vocabulary_name #vocabulary_name} => String
|
278
|
+
# * {Types::GetVocabularyResponse#language_code #language_code} => String
|
279
|
+
# * {Types::GetVocabularyResponse#vocabulary_state #vocabulary_state} => String
|
280
|
+
# * {Types::GetVocabularyResponse#last_modified_time #last_modified_time} => Time
|
281
|
+
# * {Types::GetVocabularyResponse#failure_reason #failure_reason} => String
|
282
|
+
# * {Types::GetVocabularyResponse#download_uri #download_uri} => String
|
283
|
+
#
|
284
|
+
# @example Request syntax with placeholder values
|
285
|
+
#
|
286
|
+
# resp = client.get_vocabulary({
|
287
|
+
# vocabulary_name: "VocabularyName", # required
|
288
|
+
# })
|
289
|
+
#
|
290
|
+
# @example Response structure
|
291
|
+
#
|
292
|
+
# resp.vocabulary_name #=> String
|
293
|
+
# resp.language_code #=> String, one of "en-US", "es-US"
|
294
|
+
# resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
|
295
|
+
# resp.last_modified_time #=> Time
|
296
|
+
# resp.failure_reason #=> String
|
297
|
+
# resp.download_uri #=> String
|
298
|
+
#
|
299
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabulary AWS API Documentation
|
300
|
+
#
|
301
|
+
# @overload get_vocabulary(params = {})
|
302
|
+
# @param [Hash] params ({})
|
303
|
+
def get_vocabulary(params = {}, options = {})
|
304
|
+
req = build_request(:get_vocabulary, params)
|
305
|
+
req.send_request(options)
|
306
|
+
end
|
307
|
+
|
198
308
|
# Lists transcription jobs with the specified status.
|
199
309
|
#
|
200
|
-
# @option params [
|
310
|
+
# @option params [String] :status
|
201
311
|
# When specified, returns only transcription jobs with the specified
|
202
312
|
# status.
|
203
313
|
#
|
314
|
+
# @option params [String] :job_name_contains
|
315
|
+
# When specified, the jobs returned in the list are limited to jobs
|
316
|
+
# whose name contains the specified string.
|
317
|
+
#
|
204
318
|
# @option params [String] :next_token
|
205
319
|
# If the result of the previous request to `ListTranscriptionJobs` was
|
206
320
|
# truncated, include the `NextToken` to fetch the next set of jobs.
|
207
321
|
#
|
208
322
|
# @option params [Integer] :max_results
|
209
|
-
# The maximum number of jobs to return in the response.
|
323
|
+
# The maximum number of jobs to return in the response. If there are
|
324
|
+
# fewer results in the list, this response contains only the actual
|
325
|
+
# results.
|
210
326
|
#
|
211
327
|
# @return [Types::ListTranscriptionJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
212
328
|
#
|
@@ -217,7 +333,8 @@ module Aws::TranscribeService
|
|
217
333
|
# @example Request syntax with placeholder values
|
218
334
|
#
|
219
335
|
# resp = client.list_transcription_jobs({
|
220
|
-
# status: "IN_PROGRESS", #
|
336
|
+
# status: "IN_PROGRESS", # accepts IN_PROGRESS, FAILED, COMPLETED
|
337
|
+
# job_name_contains: "TranscriptionJobName",
|
221
338
|
# next_token: "NextToken",
|
222
339
|
# max_results: 1,
|
223
340
|
# })
|
@@ -243,6 +360,62 @@ module Aws::TranscribeService
|
|
243
360
|
req.send_request(options)
|
244
361
|
end
|
245
362
|
|
363
|
+
# Returns a list of vocabularies that match the specified criteria. If
|
364
|
+
# no criteria are specified, returns the entire list of vocabularies.
|
365
|
+
#
|
366
|
+
# @option params [String] :next_token
|
367
|
+
# If the result of the previous request to `ListVocabularies` was
|
368
|
+
# truncated, include the `NextToken` to fetch the next set of jobs.
|
369
|
+
#
|
370
|
+
# @option params [Integer] :max_results
|
371
|
+
# The maximum number of vocabularies to return in the response. If there
|
372
|
+
# are fewer results in the list, this response contains only the actual
|
373
|
+
# results.
|
374
|
+
#
|
375
|
+
# @option params [String] :state_equals
|
376
|
+
# When specified, only returns vocabularies with the `VocabularyState`
|
377
|
+
# field equal to the specified state.
|
378
|
+
#
|
379
|
+
# @option params [String] :name_contains
|
380
|
+
# When specified, the vocabularies returned in the list are limited to
|
381
|
+
# vocabularies whose name contains the specified string. The search is
|
382
|
+
# case-insensitive, `ListVocabularies` will return both
|
383
|
+
# "vocabularyname" and "VocabularyName" in the response list.
|
384
|
+
#
|
385
|
+
# @return [Types::ListVocabulariesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
386
|
+
#
|
387
|
+
# * {Types::ListVocabulariesResponse#status #status} => String
|
388
|
+
# * {Types::ListVocabulariesResponse#next_token #next_token} => String
|
389
|
+
# * {Types::ListVocabulariesResponse#vocabularies #vocabularies} => Array<Types::VocabularyInfo>
|
390
|
+
#
|
391
|
+
# @example Request syntax with placeholder values
|
392
|
+
#
|
393
|
+
# resp = client.list_vocabularies({
|
394
|
+
# next_token: "NextToken",
|
395
|
+
# max_results: 1,
|
396
|
+
# state_equals: "PENDING", # accepts PENDING, READY, FAILED
|
397
|
+
# name_contains: "VocabularyName",
|
398
|
+
# })
|
399
|
+
#
|
400
|
+
# @example Response structure
|
401
|
+
#
|
402
|
+
# resp.status #=> String, one of "IN_PROGRESS", "FAILED", "COMPLETED"
|
403
|
+
# resp.next_token #=> String
|
404
|
+
# resp.vocabularies #=> Array
|
405
|
+
# resp.vocabularies[0].vocabulary_name #=> String
|
406
|
+
# resp.vocabularies[0].language_code #=> String, one of "en-US", "es-US"
|
407
|
+
# resp.vocabularies[0].last_modified_time #=> Time
|
408
|
+
# resp.vocabularies[0].vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
|
409
|
+
#
|
410
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabularies AWS API Documentation
|
411
|
+
#
|
412
|
+
# @overload list_vocabularies(params = {})
|
413
|
+
# @param [Hash] params ({})
|
414
|
+
def list_vocabularies(params = {}, options = {})
|
415
|
+
req = build_request(:list_vocabularies, params)
|
416
|
+
req.send_request(options)
|
417
|
+
end
|
418
|
+
|
246
419
|
# Starts an asynchronous job to transcribe speech to text.
|
247
420
|
#
|
248
421
|
# @option params [required, String] :transcription_job_name
|
@@ -260,6 +433,10 @@ module Aws::TranscribeService
|
|
260
433
|
# @option params [required, Types::Media] :media
|
261
434
|
# An object that describes the input media for a transcription job.
|
262
435
|
#
|
436
|
+
# @option params [Types::Settings] :settings
|
437
|
+
# A `Settings` object that provides optional settings for a
|
438
|
+
# transcription job.
|
439
|
+
#
|
263
440
|
# @return [Types::StartTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
264
441
|
#
|
265
442
|
# * {Types::StartTranscriptionJobResponse#transcription_job #transcription_job} => Types::TranscriptionJob
|
@@ -274,6 +451,11 @@ module Aws::TranscribeService
|
|
274
451
|
# media: { # required
|
275
452
|
# media_file_uri: "Uri",
|
276
453
|
# },
|
454
|
+
# settings: {
|
455
|
+
# vocabulary_name: "VocabularyName",
|
456
|
+
# show_speaker_labels: false,
|
457
|
+
# max_speaker_labels: 1,
|
458
|
+
# },
|
277
459
|
# })
|
278
460
|
#
|
279
461
|
# @example Response structure
|
@@ -288,6 +470,9 @@ module Aws::TranscribeService
|
|
288
470
|
# resp.transcription_job.creation_time #=> Time
|
289
471
|
# resp.transcription_job.completion_time #=> Time
|
290
472
|
# resp.transcription_job.failure_reason #=> String
|
473
|
+
# resp.transcription_job.settings.vocabulary_name #=> String
|
474
|
+
# resp.transcription_job.settings.show_speaker_labels #=> Boolean
|
475
|
+
# resp.transcription_job.settings.max_speaker_labels #=> Integer
|
291
476
|
#
|
292
477
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartTranscriptionJob AWS API Documentation
|
293
478
|
#
|
@@ -298,6 +483,48 @@ module Aws::TranscribeService
|
|
298
483
|
req.send_request(options)
|
299
484
|
end
|
300
485
|
|
486
|
+
# Updates an existing vocabulary with new values.
|
487
|
+
#
|
488
|
+
# @option params [required, String] :vocabulary_name
|
489
|
+
# The name of the vocabulary to update. The name is case-sensitive.
|
490
|
+
#
|
491
|
+
# @option params [required, String] :language_code
|
492
|
+
# The language code of the vocabulary entries.
|
493
|
+
#
|
494
|
+
# @option params [required, Array<String>] :phrases
|
495
|
+
# An array of strings containing the vocabulary entries.
|
496
|
+
#
|
497
|
+
# @return [Types::UpdateVocabularyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
498
|
+
#
|
499
|
+
# * {Types::UpdateVocabularyResponse#vocabulary_name #vocabulary_name} => String
|
500
|
+
# * {Types::UpdateVocabularyResponse#language_code #language_code} => String
|
501
|
+
# * {Types::UpdateVocabularyResponse#last_modified_time #last_modified_time} => Time
|
502
|
+
# * {Types::UpdateVocabularyResponse#vocabulary_state #vocabulary_state} => String
|
503
|
+
#
|
504
|
+
# @example Request syntax with placeholder values
|
505
|
+
#
|
506
|
+
# resp = client.update_vocabulary({
|
507
|
+
# vocabulary_name: "VocabularyName", # required
|
508
|
+
# language_code: "en-US", # required, accepts en-US, es-US
|
509
|
+
# phrases: ["Phrase"], # required
|
510
|
+
# })
|
511
|
+
#
|
512
|
+
# @example Response structure
|
513
|
+
#
|
514
|
+
# resp.vocabulary_name #=> String
|
515
|
+
# resp.language_code #=> String, one of "en-US", "es-US"
|
516
|
+
# resp.last_modified_time #=> Time
|
517
|
+
# resp.vocabulary_state #=> String, one of "PENDING", "READY", "FAILED"
|
518
|
+
#
|
519
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabulary AWS API Documentation
|
520
|
+
#
|
521
|
+
# @overload update_vocabulary(params = {})
|
522
|
+
# @param [Hash] params ({})
|
523
|
+
def update_vocabulary(params = {}, options = {})
|
524
|
+
req = build_request(:update_vocabulary, params)
|
525
|
+
req.send_request(options)
|
526
|
+
end
|
527
|
+
|
301
528
|
# @!endgroup
|
302
529
|
|
303
530
|
# @param params ({})
|
@@ -311,7 +538,7 @@ module Aws::TranscribeService
|
|
311
538
|
params: params,
|
312
539
|
config: config)
|
313
540
|
context[:gem_name] = 'aws-sdk-transcribeservice'
|
314
|
-
context[:gem_version] = '1.
|
541
|
+
context[:gem_version] = '1.1.0'
|
315
542
|
Seahorse::Client::Request.new(handlers, context)
|
316
543
|
end
|
317
544
|
|
@@ -12,22 +12,34 @@ module Aws::TranscribeService
|
|
12
12
|
include Seahorse::Model
|
13
13
|
|
14
14
|
BadRequestException = Shapes::StructureShape.new(name: 'BadRequestException')
|
15
|
+
Boolean = Shapes::BooleanShape.new(name: 'Boolean')
|
15
16
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
17
|
+
CreateVocabularyRequest = Shapes::StructureShape.new(name: 'CreateVocabularyRequest')
|
18
|
+
CreateVocabularyResponse = Shapes::StructureShape.new(name: 'CreateVocabularyResponse')
|
16
19
|
DateTime = Shapes::TimestampShape.new(name: 'DateTime')
|
20
|
+
DeleteVocabularyRequest = Shapes::StructureShape.new(name: 'DeleteVocabularyRequest')
|
17
21
|
FailureReason = Shapes::StringShape.new(name: 'FailureReason')
|
18
22
|
GetTranscriptionJobRequest = Shapes::StructureShape.new(name: 'GetTranscriptionJobRequest')
|
19
23
|
GetTranscriptionJobResponse = Shapes::StructureShape.new(name: 'GetTranscriptionJobResponse')
|
24
|
+
GetVocabularyRequest = Shapes::StructureShape.new(name: 'GetVocabularyRequest')
|
25
|
+
GetVocabularyResponse = Shapes::StructureShape.new(name: 'GetVocabularyResponse')
|
20
26
|
InternalFailureException = Shapes::StructureShape.new(name: 'InternalFailureException')
|
21
27
|
LanguageCode = Shapes::StringShape.new(name: 'LanguageCode')
|
22
28
|
LimitExceededException = Shapes::StructureShape.new(name: 'LimitExceededException')
|
23
29
|
ListTranscriptionJobsRequest = Shapes::StructureShape.new(name: 'ListTranscriptionJobsRequest')
|
24
30
|
ListTranscriptionJobsResponse = Shapes::StructureShape.new(name: 'ListTranscriptionJobsResponse')
|
31
|
+
ListVocabulariesRequest = Shapes::StructureShape.new(name: 'ListVocabulariesRequest')
|
32
|
+
ListVocabulariesResponse = Shapes::StructureShape.new(name: 'ListVocabulariesResponse')
|
25
33
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
34
|
+
MaxSpeakers = Shapes::IntegerShape.new(name: 'MaxSpeakers')
|
26
35
|
Media = Shapes::StructureShape.new(name: 'Media')
|
27
36
|
MediaFormat = Shapes::StringShape.new(name: 'MediaFormat')
|
28
37
|
MediaSampleRateHertz = Shapes::IntegerShape.new(name: 'MediaSampleRateHertz')
|
29
38
|
NextToken = Shapes::StringShape.new(name: 'NextToken')
|
30
39
|
NotFoundException = Shapes::StructureShape.new(name: 'NotFoundException')
|
40
|
+
Phrase = Shapes::StringShape.new(name: 'Phrase')
|
41
|
+
Phrases = Shapes::ListShape.new(name: 'Phrases')
|
42
|
+
Settings = Shapes::StructureShape.new(name: 'Settings')
|
31
43
|
StartTranscriptionJobRequest = Shapes::StructureShape.new(name: 'StartTranscriptionJobRequest')
|
32
44
|
StartTranscriptionJobResponse = Shapes::StructureShape.new(name: 'StartTranscriptionJobResponse')
|
33
45
|
String = Shapes::StringShape.new(name: 'String')
|
@@ -37,7 +49,28 @@ module Aws::TranscribeService
|
|
37
49
|
TranscriptionJobStatus = Shapes::StringShape.new(name: 'TranscriptionJobStatus')
|
38
50
|
TranscriptionJobSummaries = Shapes::ListShape.new(name: 'TranscriptionJobSummaries')
|
39
51
|
TranscriptionJobSummary = Shapes::StructureShape.new(name: 'TranscriptionJobSummary')
|
52
|
+
UpdateVocabularyRequest = Shapes::StructureShape.new(name: 'UpdateVocabularyRequest')
|
53
|
+
UpdateVocabularyResponse = Shapes::StructureShape.new(name: 'UpdateVocabularyResponse')
|
40
54
|
Uri = Shapes::StringShape.new(name: 'Uri')
|
55
|
+
Vocabularies = Shapes::ListShape.new(name: 'Vocabularies')
|
56
|
+
VocabularyInfo = Shapes::StructureShape.new(name: 'VocabularyInfo')
|
57
|
+
VocabularyName = Shapes::StringShape.new(name: 'VocabularyName')
|
58
|
+
VocabularyState = Shapes::StringShape.new(name: 'VocabularyState')
|
59
|
+
|
60
|
+
CreateVocabularyRequest.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, required: true, location_name: "VocabularyName"))
|
61
|
+
CreateVocabularyRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
62
|
+
CreateVocabularyRequest.add_member(:phrases, Shapes::ShapeRef.new(shape: Phrases, required: true, location_name: "Phrases"))
|
63
|
+
CreateVocabularyRequest.struct_class = Types::CreateVocabularyRequest
|
64
|
+
|
65
|
+
CreateVocabularyResponse.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "VocabularyName"))
|
66
|
+
CreateVocabularyResponse.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
67
|
+
CreateVocabularyResponse.add_member(:vocabulary_state, Shapes::ShapeRef.new(shape: VocabularyState, location_name: "VocabularyState"))
|
68
|
+
CreateVocabularyResponse.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "LastModifiedTime"))
|
69
|
+
CreateVocabularyResponse.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
|
70
|
+
CreateVocabularyResponse.struct_class = Types::CreateVocabularyResponse
|
71
|
+
|
72
|
+
DeleteVocabularyRequest.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, required: true, location_name: "VocabularyName"))
|
73
|
+
DeleteVocabularyRequest.struct_class = Types::DeleteVocabularyRequest
|
41
74
|
|
42
75
|
GetTranscriptionJobRequest.add_member(:transcription_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, required: true, location_name: "TranscriptionJobName"))
|
43
76
|
GetTranscriptionJobRequest.struct_class = Types::GetTranscriptionJobRequest
|
@@ -45,7 +78,19 @@ module Aws::TranscribeService
|
|
45
78
|
GetTranscriptionJobResponse.add_member(:transcription_job, Shapes::ShapeRef.new(shape: TranscriptionJob, location_name: "TranscriptionJob"))
|
46
79
|
GetTranscriptionJobResponse.struct_class = Types::GetTranscriptionJobResponse
|
47
80
|
|
48
|
-
|
81
|
+
GetVocabularyRequest.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, required: true, location_name: "VocabularyName"))
|
82
|
+
GetVocabularyRequest.struct_class = Types::GetVocabularyRequest
|
83
|
+
|
84
|
+
GetVocabularyResponse.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "VocabularyName"))
|
85
|
+
GetVocabularyResponse.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
86
|
+
GetVocabularyResponse.add_member(:vocabulary_state, Shapes::ShapeRef.new(shape: VocabularyState, location_name: "VocabularyState"))
|
87
|
+
GetVocabularyResponse.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "LastModifiedTime"))
|
88
|
+
GetVocabularyResponse.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
|
89
|
+
GetVocabularyResponse.add_member(:download_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "DownloadUri"))
|
90
|
+
GetVocabularyResponse.struct_class = Types::GetVocabularyResponse
|
91
|
+
|
92
|
+
ListTranscriptionJobsRequest.add_member(:status, Shapes::ShapeRef.new(shape: TranscriptionJobStatus, location_name: "Status"))
|
93
|
+
ListTranscriptionJobsRequest.add_member(:job_name_contains, Shapes::ShapeRef.new(shape: TranscriptionJobName, location_name: "JobNameContains"))
|
49
94
|
ListTranscriptionJobsRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
50
95
|
ListTranscriptionJobsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
51
96
|
ListTranscriptionJobsRequest.struct_class = Types::ListTranscriptionJobsRequest
|
@@ -55,14 +100,33 @@ module Aws::TranscribeService
|
|
55
100
|
ListTranscriptionJobsResponse.add_member(:transcription_job_summaries, Shapes::ShapeRef.new(shape: TranscriptionJobSummaries, location_name: "TranscriptionJobSummaries"))
|
56
101
|
ListTranscriptionJobsResponse.struct_class = Types::ListTranscriptionJobsResponse
|
57
102
|
|
103
|
+
ListVocabulariesRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
104
|
+
ListVocabulariesRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: MaxResults, location_name: "MaxResults"))
|
105
|
+
ListVocabulariesRequest.add_member(:state_equals, Shapes::ShapeRef.new(shape: VocabularyState, location_name: "StateEquals"))
|
106
|
+
ListVocabulariesRequest.add_member(:name_contains, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "NameContains"))
|
107
|
+
ListVocabulariesRequest.struct_class = Types::ListVocabulariesRequest
|
108
|
+
|
109
|
+
ListVocabulariesResponse.add_member(:status, Shapes::ShapeRef.new(shape: TranscriptionJobStatus, location_name: "Status"))
|
110
|
+
ListVocabulariesResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "NextToken"))
|
111
|
+
ListVocabulariesResponse.add_member(:vocabularies, Shapes::ShapeRef.new(shape: Vocabularies, location_name: "Vocabularies"))
|
112
|
+
ListVocabulariesResponse.struct_class = Types::ListVocabulariesResponse
|
113
|
+
|
58
114
|
Media.add_member(:media_file_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "MediaFileUri"))
|
59
115
|
Media.struct_class = Types::Media
|
60
116
|
|
117
|
+
Phrases.member = Shapes::ShapeRef.new(shape: Phrase)
|
118
|
+
|
119
|
+
Settings.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "VocabularyName"))
|
120
|
+
Settings.add_member(:show_speaker_labels, Shapes::ShapeRef.new(shape: Boolean, location_name: "ShowSpeakerLabels"))
|
121
|
+
Settings.add_member(:max_speaker_labels, Shapes::ShapeRef.new(shape: MaxSpeakers, location_name: "MaxSpeakerLabels"))
|
122
|
+
Settings.struct_class = Types::Settings
|
123
|
+
|
61
124
|
StartTranscriptionJobRequest.add_member(:transcription_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, required: true, location_name: "TranscriptionJobName"))
|
62
125
|
StartTranscriptionJobRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
63
126
|
StartTranscriptionJobRequest.add_member(:media_sample_rate_hertz, Shapes::ShapeRef.new(shape: MediaSampleRateHertz, location_name: "MediaSampleRateHertz"))
|
64
127
|
StartTranscriptionJobRequest.add_member(:media_format, Shapes::ShapeRef.new(shape: MediaFormat, required: true, location_name: "MediaFormat"))
|
65
128
|
StartTranscriptionJobRequest.add_member(:media, Shapes::ShapeRef.new(shape: Media, required: true, location_name: "Media"))
|
129
|
+
StartTranscriptionJobRequest.add_member(:settings, Shapes::ShapeRef.new(shape: Settings, location_name: "Settings"))
|
66
130
|
StartTranscriptionJobRequest.struct_class = Types::StartTranscriptionJobRequest
|
67
131
|
|
68
132
|
StartTranscriptionJobResponse.add_member(:transcription_job, Shapes::ShapeRef.new(shape: TranscriptionJob, location_name: "TranscriptionJob"))
|
@@ -81,6 +145,7 @@ module Aws::TranscribeService
|
|
81
145
|
TranscriptionJob.add_member(:creation_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "CreationTime"))
|
82
146
|
TranscriptionJob.add_member(:completion_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "CompletionTime"))
|
83
147
|
TranscriptionJob.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
|
148
|
+
TranscriptionJob.add_member(:settings, Shapes::ShapeRef.new(shape: Settings, location_name: "Settings"))
|
84
149
|
TranscriptionJob.struct_class = Types::TranscriptionJob
|
85
150
|
|
86
151
|
TranscriptionJobSummaries.member = Shapes::ShapeRef.new(shape: TranscriptionJobSummary)
|
@@ -93,6 +158,25 @@ module Aws::TranscribeService
|
|
93
158
|
TranscriptionJobSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
|
94
159
|
TranscriptionJobSummary.struct_class = Types::TranscriptionJobSummary
|
95
160
|
|
161
|
+
UpdateVocabularyRequest.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, required: true, location_name: "VocabularyName"))
|
162
|
+
UpdateVocabularyRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
|
163
|
+
UpdateVocabularyRequest.add_member(:phrases, Shapes::ShapeRef.new(shape: Phrases, required: true, location_name: "Phrases"))
|
164
|
+
UpdateVocabularyRequest.struct_class = Types::UpdateVocabularyRequest
|
165
|
+
|
166
|
+
UpdateVocabularyResponse.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "VocabularyName"))
|
167
|
+
UpdateVocabularyResponse.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
168
|
+
UpdateVocabularyResponse.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "LastModifiedTime"))
|
169
|
+
UpdateVocabularyResponse.add_member(:vocabulary_state, Shapes::ShapeRef.new(shape: VocabularyState, location_name: "VocabularyState"))
|
170
|
+
UpdateVocabularyResponse.struct_class = Types::UpdateVocabularyResponse
|
171
|
+
|
172
|
+
Vocabularies.member = Shapes::ShapeRef.new(shape: VocabularyInfo)
|
173
|
+
|
174
|
+
VocabularyInfo.add_member(:vocabulary_name, Shapes::ShapeRef.new(shape: VocabularyName, location_name: "VocabularyName"))
|
175
|
+
VocabularyInfo.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
176
|
+
VocabularyInfo.add_member(:last_modified_time, Shapes::ShapeRef.new(shape: DateTime, location_name: "LastModifiedTime"))
|
177
|
+
VocabularyInfo.add_member(:vocabulary_state, Shapes::ShapeRef.new(shape: VocabularyState, location_name: "VocabularyState"))
|
178
|
+
VocabularyInfo.struct_class = Types::VocabularyInfo
|
179
|
+
|
96
180
|
|
97
181
|
# @api private
|
98
182
|
API = Seahorse::Model::Api.new.tap do |api|
|
@@ -109,6 +193,29 @@ module Aws::TranscribeService
|
|
109
193
|
"targetPrefix" => "Transcribe",
|
110
194
|
}
|
111
195
|
|
196
|
+
api.add_operation(:create_vocabulary, Seahorse::Model::Operation.new.tap do |o|
|
197
|
+
o.name = "CreateVocabulary"
|
198
|
+
o.http_method = "POST"
|
199
|
+
o.http_request_uri = "/"
|
200
|
+
o.input = Shapes::ShapeRef.new(shape: CreateVocabularyRequest)
|
201
|
+
o.output = Shapes::ShapeRef.new(shape: CreateVocabularyResponse)
|
202
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
203
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
204
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
205
|
+
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
206
|
+
end)
|
207
|
+
|
208
|
+
api.add_operation(:delete_vocabulary, Seahorse::Model::Operation.new.tap do |o|
|
209
|
+
o.name = "DeleteVocabulary"
|
210
|
+
o.http_method = "POST"
|
211
|
+
o.http_request_uri = "/"
|
212
|
+
o.input = Shapes::ShapeRef.new(shape: DeleteVocabularyRequest)
|
213
|
+
o.output = Shapes::ShapeRef.new(shape: Shapes::StructureShape.new(struct_class: Aws::EmptyStructure))
|
214
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
215
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
216
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
217
|
+
end)
|
218
|
+
|
112
219
|
api.add_operation(:get_transcription_job, Seahorse::Model::Operation.new.tap do |o|
|
113
220
|
o.name = "GetTranscriptionJob"
|
114
221
|
o.http_method = "POST"
|
@@ -121,6 +228,18 @@ module Aws::TranscribeService
|
|
121
228
|
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
122
229
|
end)
|
123
230
|
|
231
|
+
api.add_operation(:get_vocabulary, Seahorse::Model::Operation.new.tap do |o|
|
232
|
+
o.name = "GetVocabulary"
|
233
|
+
o.http_method = "POST"
|
234
|
+
o.http_request_uri = "/"
|
235
|
+
o.input = Shapes::ShapeRef.new(shape: GetVocabularyRequest)
|
236
|
+
o.output = Shapes::ShapeRef.new(shape: GetVocabularyResponse)
|
237
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
238
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
239
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
240
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
241
|
+
end)
|
242
|
+
|
124
243
|
api.add_operation(:list_transcription_jobs, Seahorse::Model::Operation.new.tap do |o|
|
125
244
|
o.name = "ListTranscriptionJobs"
|
126
245
|
o.http_method = "POST"
|
@@ -138,6 +257,23 @@ module Aws::TranscribeService
|
|
138
257
|
)
|
139
258
|
end)
|
140
259
|
|
260
|
+
api.add_operation(:list_vocabularies, Seahorse::Model::Operation.new.tap do |o|
|
261
|
+
o.name = "ListVocabularies"
|
262
|
+
o.http_method = "POST"
|
263
|
+
o.http_request_uri = "/"
|
264
|
+
o.input = Shapes::ShapeRef.new(shape: ListVocabulariesRequest)
|
265
|
+
o.output = Shapes::ShapeRef.new(shape: ListVocabulariesResponse)
|
266
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
267
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
268
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
269
|
+
o[:pager] = Aws::Pager.new(
|
270
|
+
limit_key: "max_results",
|
271
|
+
tokens: {
|
272
|
+
"next_token" => "next_token"
|
273
|
+
}
|
274
|
+
)
|
275
|
+
end)
|
276
|
+
|
141
277
|
api.add_operation(:start_transcription_job, Seahorse::Model::Operation.new.tap do |o|
|
142
278
|
o.name = "StartTranscriptionJob"
|
143
279
|
o.http_method = "POST"
|
@@ -149,6 +285,18 @@ module Aws::TranscribeService
|
|
149
285
|
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
150
286
|
o.errors << Shapes::ShapeRef.new(shape: ConflictException)
|
151
287
|
end)
|
288
|
+
|
289
|
+
api.add_operation(:update_vocabulary, Seahorse::Model::Operation.new.tap do |o|
|
290
|
+
o.name = "UpdateVocabulary"
|
291
|
+
o.http_method = "POST"
|
292
|
+
o.http_request_uri = "/"
|
293
|
+
o.input = Shapes::ShapeRef.new(shape: UpdateVocabularyRequest)
|
294
|
+
o.output = Shapes::ShapeRef.new(shape: UpdateVocabularyResponse)
|
295
|
+
o.errors << Shapes::ShapeRef.new(shape: BadRequestException)
|
296
|
+
o.errors << Shapes::ShapeRef.new(shape: LimitExceededException)
|
297
|
+
o.errors << Shapes::ShapeRef.new(shape: InternalFailureException)
|
298
|
+
o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
|
299
|
+
end)
|
152
300
|
end
|
153
301
|
|
154
302
|
end
|
@@ -8,6 +8,89 @@
|
|
8
8
|
module Aws::TranscribeService
|
9
9
|
module Types
|
10
10
|
|
11
|
+
# @note When making an API call, you may pass CreateVocabularyRequest
|
12
|
+
# data as a hash:
|
13
|
+
#
|
14
|
+
# {
|
15
|
+
# vocabulary_name: "VocabularyName", # required
|
16
|
+
# language_code: "en-US", # required, accepts en-US, es-US
|
17
|
+
# phrases: ["Phrase"], # required
|
18
|
+
# }
|
19
|
+
#
|
20
|
+
# @!attribute [rw] vocabulary_name
|
21
|
+
# The name of the vocabulary. The name must be unique within an AWS
|
22
|
+
# account. The name is case-sensitive.
|
23
|
+
# @return [String]
|
24
|
+
#
|
25
|
+
# @!attribute [rw] language_code
|
26
|
+
# The language code of the vocabulary entries.
|
27
|
+
# @return [String]
|
28
|
+
#
|
29
|
+
# @!attribute [rw] phrases
|
30
|
+
# An array of strings that contains the vocabulary entries.
|
31
|
+
# @return [Array<String>]
|
32
|
+
#
|
33
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyRequest AWS API Documentation
|
34
|
+
#
|
35
|
+
class CreateVocabularyRequest < Struct.new(
|
36
|
+
:vocabulary_name,
|
37
|
+
:language_code,
|
38
|
+
:phrases)
|
39
|
+
include Aws::Structure
|
40
|
+
end
|
41
|
+
|
42
|
+
# @!attribute [rw] vocabulary_name
|
43
|
+
# The name of the vocabulary.
|
44
|
+
# @return [String]
|
45
|
+
#
|
46
|
+
# @!attribute [rw] language_code
|
47
|
+
# The language code of the vocabulary entries.
|
48
|
+
# @return [String]
|
49
|
+
#
|
50
|
+
# @!attribute [rw] vocabulary_state
|
51
|
+
# The processing state of the vocabulary. When the `VocabularyState`
|
52
|
+
# field contains `READY` the vocabulary is ready to be used in a
|
53
|
+
# `StartTranscriptionJob` request.
|
54
|
+
# @return [String]
|
55
|
+
#
|
56
|
+
# @!attribute [rw] last_modified_time
|
57
|
+
# The date and time that the vocabulary was created.
|
58
|
+
# @return [Time]
|
59
|
+
#
|
60
|
+
# @!attribute [rw] failure_reason
|
61
|
+
# If the `VocabularyState` field is `FAILED`, this field contains
|
62
|
+
# information about why the job failed.
|
63
|
+
# @return [String]
|
64
|
+
#
|
65
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyResponse AWS API Documentation
|
66
|
+
#
|
67
|
+
class CreateVocabularyResponse < Struct.new(
|
68
|
+
:vocabulary_name,
|
69
|
+
:language_code,
|
70
|
+
:vocabulary_state,
|
71
|
+
:last_modified_time,
|
72
|
+
:failure_reason)
|
73
|
+
include Aws::Structure
|
74
|
+
end
|
75
|
+
|
76
|
+
# @note When making an API call, you may pass DeleteVocabularyRequest
|
77
|
+
# data as a hash:
|
78
|
+
#
|
79
|
+
# {
|
80
|
+
# vocabulary_name: "VocabularyName", # required
|
81
|
+
# }
|
82
|
+
#
|
83
|
+
# @!attribute [rw] vocabulary_name
|
84
|
+
# The name of the vocabulary to delete.
|
85
|
+
# @return [String]
|
86
|
+
#
|
87
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/DeleteVocabularyRequest AWS API Documentation
|
88
|
+
#
|
89
|
+
class DeleteVocabularyRequest < Struct.new(
|
90
|
+
:vocabulary_name)
|
91
|
+
include Aws::Structure
|
92
|
+
end
|
93
|
+
|
11
94
|
# @note When making an API call, you may pass GetTranscriptionJobRequest
|
12
95
|
# data as a hash:
|
13
96
|
#
|
@@ -37,11 +120,70 @@ module Aws::TranscribeService
|
|
37
120
|
include Aws::Structure
|
38
121
|
end
|
39
122
|
|
123
|
+
# @note When making an API call, you may pass GetVocabularyRequest
|
124
|
+
# data as a hash:
|
125
|
+
#
|
126
|
+
# {
|
127
|
+
# vocabulary_name: "VocabularyName", # required
|
128
|
+
# }
|
129
|
+
#
|
130
|
+
# @!attribute [rw] vocabulary_name
|
131
|
+
# The name of the vocabulary to return information about. The name is
|
132
|
+
# case-sensitive.
|
133
|
+
# @return [String]
|
134
|
+
#
|
135
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyRequest AWS API Documentation
|
136
|
+
#
|
137
|
+
class GetVocabularyRequest < Struct.new(
|
138
|
+
:vocabulary_name)
|
139
|
+
include Aws::Structure
|
140
|
+
end
|
141
|
+
|
142
|
+
# @!attribute [rw] vocabulary_name
|
143
|
+
# The name of the vocabulary to return.
|
144
|
+
# @return [String]
|
145
|
+
#
|
146
|
+
# @!attribute [rw] language_code
|
147
|
+
# The language code of the vocabulary entries.
|
148
|
+
# @return [String]
|
149
|
+
#
|
150
|
+
# @!attribute [rw] vocabulary_state
|
151
|
+
# The processing state of the vocabulary.
|
152
|
+
# @return [String]
|
153
|
+
#
|
154
|
+
# @!attribute [rw] last_modified_time
|
155
|
+
# The date and time that the vocabulary was last modified.
|
156
|
+
# @return [Time]
|
157
|
+
#
|
158
|
+
# @!attribute [rw] failure_reason
|
159
|
+
# If the `VocabularyState` field is `FAILED`, this field contains
|
160
|
+
# information about why the job failed.
|
161
|
+
# @return [String]
|
162
|
+
#
|
163
|
+
# @!attribute [rw] download_uri
|
164
|
+
# The S3 location where the vocabulary is stored. Use this URI to get
|
165
|
+
# the contents of the vocabulary. The URI is available for a limited
|
166
|
+
# time.
|
167
|
+
# @return [String]
|
168
|
+
#
|
169
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetVocabularyResponse AWS API Documentation
|
170
|
+
#
|
171
|
+
class GetVocabularyResponse < Struct.new(
|
172
|
+
:vocabulary_name,
|
173
|
+
:language_code,
|
174
|
+
:vocabulary_state,
|
175
|
+
:last_modified_time,
|
176
|
+
:failure_reason,
|
177
|
+
:download_uri)
|
178
|
+
include Aws::Structure
|
179
|
+
end
|
180
|
+
|
40
181
|
# @note When making an API call, you may pass ListTranscriptionJobsRequest
|
41
182
|
# data as a hash:
|
42
183
|
#
|
43
184
|
# {
|
44
|
-
# status: "IN_PROGRESS", #
|
185
|
+
# status: "IN_PROGRESS", # accepts IN_PROGRESS, FAILED, COMPLETED
|
186
|
+
# job_name_contains: "TranscriptionJobName",
|
45
187
|
# next_token: "NextToken",
|
46
188
|
# max_results: 1,
|
47
189
|
# }
|
@@ -51,19 +193,27 @@ module Aws::TranscribeService
|
|
51
193
|
# status.
|
52
194
|
# @return [String]
|
53
195
|
#
|
196
|
+
# @!attribute [rw] job_name_contains
|
197
|
+
# When specified, the jobs returned in the list are limited to jobs
|
198
|
+
# whose name contains the specified string.
|
199
|
+
# @return [String]
|
200
|
+
#
|
54
201
|
# @!attribute [rw] next_token
|
55
202
|
# If the result of the previous request to `ListTranscriptionJobs` was
|
56
203
|
# truncated, include the `NextToken` to fetch the next set of jobs.
|
57
204
|
# @return [String]
|
58
205
|
#
|
59
206
|
# @!attribute [rw] max_results
|
60
|
-
# The maximum number of jobs to return in the response.
|
207
|
+
# The maximum number of jobs to return in the response. If there are
|
208
|
+
# fewer results in the list, this response contains only the actual
|
209
|
+
# results.
|
61
210
|
# @return [Integer]
|
62
211
|
#
|
63
212
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobsRequest AWS API Documentation
|
64
213
|
#
|
65
214
|
class ListTranscriptionJobsRequest < Struct.new(
|
66
215
|
:status,
|
216
|
+
:job_name_contains,
|
67
217
|
:next_token,
|
68
218
|
:max_results)
|
69
219
|
include Aws::Structure
|
@@ -75,11 +225,11 @@ module Aws::TranscribeService
|
|
75
225
|
#
|
76
226
|
# @!attribute [rw] next_token
|
77
227
|
# The `ListTranscriptionJobs` operation returns a page of jobs at a
|
78
|
-
# time. The size of the page is set by the `MaxResults`
|
79
|
-
# there are more jobs in the list than the page size,
|
80
|
-
# Transcribe returns the `NextPage` token. Include the token in
|
81
|
-
# next request to the `ListTranscriptionJobs` operation to return
|
82
|
-
# the next page of jobs.
|
228
|
+
# time. The maximum size of the page is set by the `MaxResults`
|
229
|
+
# parameter. If there are more jobs in the list than the page size,
|
230
|
+
# Amazon Transcribe returns the `NextPage` token. Include the token in
|
231
|
+
# the next request to the `ListTranscriptionJobs` operation to return
|
232
|
+
# in the next page of jobs.
|
83
233
|
# @return [String]
|
84
234
|
#
|
85
235
|
# @!attribute [rw] transcription_job_summaries
|
@@ -96,6 +246,76 @@ module Aws::TranscribeService
|
|
96
246
|
include Aws::Structure
|
97
247
|
end
|
98
248
|
|
249
|
+
# @note When making an API call, you may pass ListVocabulariesRequest
|
250
|
+
# data as a hash:
|
251
|
+
#
|
252
|
+
# {
|
253
|
+
# next_token: "NextToken",
|
254
|
+
# max_results: 1,
|
255
|
+
# state_equals: "PENDING", # accepts PENDING, READY, FAILED
|
256
|
+
# name_contains: "VocabularyName",
|
257
|
+
# }
|
258
|
+
#
|
259
|
+
# @!attribute [rw] next_token
|
260
|
+
# If the result of the previous request to `ListVocabularies` was
|
261
|
+
# truncated, include the `NextToken` to fetch the next set of jobs.
|
262
|
+
# @return [String]
|
263
|
+
#
|
264
|
+
# @!attribute [rw] max_results
|
265
|
+
# The maximum number of vocabularies to return in the response. If
|
266
|
+
# there are fewer results in the list, this response contains only the
|
267
|
+
# actual results.
|
268
|
+
# @return [Integer]
|
269
|
+
#
|
270
|
+
# @!attribute [rw] state_equals
|
271
|
+
# When specified, only returns vocabularies with the `VocabularyState`
|
272
|
+
# field equal to the specified state.
|
273
|
+
# @return [String]
|
274
|
+
#
|
275
|
+
# @!attribute [rw] name_contains
|
276
|
+
# When specified, the vocabularies returned in the list are limited to
|
277
|
+
# vocabularies whose name contains the specified string. The search is
|
278
|
+
# case-insensitive, `ListVocabularies` will return both
|
279
|
+
# "vocabularyname" and "VocabularyName" in the response list.
|
280
|
+
# @return [String]
|
281
|
+
#
|
282
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabulariesRequest AWS API Documentation
|
283
|
+
#
|
284
|
+
class ListVocabulariesRequest < Struct.new(
|
285
|
+
:next_token,
|
286
|
+
:max_results,
|
287
|
+
:state_equals,
|
288
|
+
:name_contains)
|
289
|
+
include Aws::Structure
|
290
|
+
end
|
291
|
+
|
292
|
+
# @!attribute [rw] status
|
293
|
+
# The requested vocabulary state.
|
294
|
+
# @return [String]
|
295
|
+
#
|
296
|
+
# @!attribute [rw] next_token
|
297
|
+
# The `ListVocabularies` operation returns a page of vocabularies at a
|
298
|
+
# time. The maximum size of the page is set by the `MaxResults`
|
299
|
+
# parameter. If there are more jobs in the list than the page size,
|
300
|
+
# Amazon Transcribe returns the `NextPage` token. Include the token in
|
301
|
+
# the next request to the `ListVocabularies` operation to return in
|
302
|
+
# the next page of jobs.
|
303
|
+
# @return [String]
|
304
|
+
#
|
305
|
+
# @!attribute [rw] vocabularies
|
306
|
+
# A list of objects that describe the vocabularies that match the
|
307
|
+
# search criteria in the request.
|
308
|
+
# @return [Array<Types::VocabularyInfo>]
|
309
|
+
#
|
310
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListVocabulariesResponse AWS API Documentation
|
311
|
+
#
|
312
|
+
class ListVocabulariesResponse < Struct.new(
|
313
|
+
:status,
|
314
|
+
:next_token,
|
315
|
+
:vocabularies)
|
316
|
+
include Aws::Structure
|
317
|
+
end
|
318
|
+
|
99
319
|
# Describes the input media file in a transcription request.
|
100
320
|
#
|
101
321
|
# @note When making an API call, you may pass Media
|
@@ -106,7 +326,9 @@ module Aws::TranscribeService
|
|
106
326
|
# }
|
107
327
|
#
|
108
328
|
# @!attribute [rw] media_file_uri
|
109
|
-
# The S3 location of the input media file. The
|
329
|
+
# The S3 location of the input media file. The URI must be in the same
|
330
|
+
# region as the API endpoint that you are calling. The general form
|
331
|
+
# is:
|
110
332
|
#
|
111
333
|
# `
|
112
334
|
# https://<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
|
@@ -114,9 +336,16 @@ module Aws::TranscribeService
|
|
114
336
|
#
|
115
337
|
# For example:
|
116
338
|
#
|
117
|
-
# `https://s3-us-
|
339
|
+
# `https://s3-us-east-1.amazonaws.com/examplebucket/example.mp4`
|
118
340
|
#
|
119
|
-
# `https://s3-us-
|
341
|
+
# `https://s3-us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4`
|
342
|
+
#
|
343
|
+
# For more information about S3 object names, see [Object Keys][1] in
|
344
|
+
# the *Amazon S3 Developer Guide*.
|
345
|
+
#
|
346
|
+
#
|
347
|
+
#
|
348
|
+
# [1]: http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#object-keys
|
120
349
|
# @return [String]
|
121
350
|
#
|
122
351
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Media AWS API Documentation
|
@@ -126,6 +355,46 @@ module Aws::TranscribeService
|
|
126
355
|
include Aws::Structure
|
127
356
|
end
|
128
357
|
|
358
|
+
# Provides optional settings for the `StartTranscriptionJob` operation.
|
359
|
+
#
|
360
|
+
# @note When making an API call, you may pass Settings
|
361
|
+
# data as a hash:
|
362
|
+
#
|
363
|
+
# {
|
364
|
+
# vocabulary_name: "VocabularyName",
|
365
|
+
# show_speaker_labels: false,
|
366
|
+
# max_speaker_labels: 1,
|
367
|
+
# }
|
368
|
+
#
|
369
|
+
# @!attribute [rw] vocabulary_name
|
370
|
+
# The name of a vocabulary to use when processing the transcription
|
371
|
+
# job.
|
372
|
+
# @return [String]
|
373
|
+
#
|
374
|
+
# @!attribute [rw] show_speaker_labels
|
375
|
+
# Determines whether the transcription job should use speaker
|
376
|
+
# recognition to identify different speakers in the input audio. If
|
377
|
+
# you set the `ShowSpeakerLabels` field to true, you must also set the
|
378
|
+
# maximum number of speaker labels `MaxSpeakerLabels` field.
|
379
|
+
# @return [Boolean]
|
380
|
+
#
|
381
|
+
# @!attribute [rw] max_speaker_labels
|
382
|
+
# The maximum number of speakers to identify in the input audio. If
|
383
|
+
# there are more speakers in the audio than this number, multiple
|
384
|
+
# speakers will be identified as a single speaker. If you specify the
|
385
|
+
# `MaxSpeakerLabels` field, you must set the `ShowSpeakerLabels` field
|
386
|
+
# to true.
|
387
|
+
# @return [Integer]
|
388
|
+
#
|
389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Settings AWS API Documentation
|
390
|
+
#
|
391
|
+
class Settings < Struct.new(
|
392
|
+
:vocabulary_name,
|
393
|
+
:show_speaker_labels,
|
394
|
+
:max_speaker_labels)
|
395
|
+
include Aws::Structure
|
396
|
+
end
|
397
|
+
|
129
398
|
# @note When making an API call, you may pass StartTranscriptionJobRequest
|
130
399
|
# data as a hash:
|
131
400
|
#
|
@@ -137,6 +406,11 @@ module Aws::TranscribeService
|
|
137
406
|
# media: { # required
|
138
407
|
# media_file_uri: "Uri",
|
139
408
|
# },
|
409
|
+
# settings: {
|
410
|
+
# vocabulary_name: "VocabularyName",
|
411
|
+
# show_speaker_labels: false,
|
412
|
+
# max_speaker_labels: 1,
|
413
|
+
# },
|
140
414
|
# }
|
141
415
|
#
|
142
416
|
# @!attribute [rw] transcription_job_name
|
@@ -160,6 +434,11 @@ module Aws::TranscribeService
|
|
160
434
|
# An object that describes the input media for a transcription job.
|
161
435
|
# @return [Types::Media]
|
162
436
|
#
|
437
|
+
# @!attribute [rw] settings
|
438
|
+
# A `Settings` object that provides optional settings for a
|
439
|
+
# transcription job.
|
440
|
+
# @return [Types::Settings]
|
441
|
+
#
|
163
442
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartTranscriptionJobRequest AWS API Documentation
|
164
443
|
#
|
165
444
|
class StartTranscriptionJobRequest < Struct.new(
|
@@ -167,7 +446,8 @@ module Aws::TranscribeService
|
|
167
446
|
:language_code,
|
168
447
|
:media_sample_rate_hertz,
|
169
448
|
:media_format,
|
170
|
-
:media
|
449
|
+
:media,
|
450
|
+
:settings)
|
171
451
|
include Aws::Structure
|
172
452
|
end
|
173
453
|
|
@@ -185,18 +465,8 @@ module Aws::TranscribeService
|
|
185
465
|
# Describes the output of a transcription job.
|
186
466
|
#
|
187
467
|
# @!attribute [rw] transcript_file_uri
|
188
|
-
# The S3 location where the transcription result is stored.
|
189
|
-
#
|
190
|
-
#
|
191
|
-
# `
|
192
|
-
# https://<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
|
193
|
-
# `
|
194
|
-
#
|
195
|
-
# For example:
|
196
|
-
#
|
197
|
-
# `https://s3-us-west-2.amazonaws.com/examplebucket/example.json`
|
198
|
-
#
|
199
|
-
# `https://s3-us-west-2.amazonaws.com/examplebucket/mediadocs/example.json`
|
468
|
+
# The S3 location where the transcription result is stored. Use this
|
469
|
+
# URI to access the results of the transcription job.
|
200
470
|
# @return [String]
|
201
471
|
#
|
202
472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Transcript AWS API Documentation
|
@@ -214,7 +484,7 @@ module Aws::TranscribeService
|
|
214
484
|
# @return [String]
|
215
485
|
#
|
216
486
|
# @!attribute [rw] transcription_job_status
|
217
|
-
# The
|
487
|
+
# The status of the transcription job.
|
218
488
|
# @return [String]
|
219
489
|
#
|
220
490
|
# @!attribute [rw] language_code
|
@@ -251,6 +521,10 @@ module Aws::TranscribeService
|
|
251
521
|
# contains information about why the job failed.
|
252
522
|
# @return [String]
|
253
523
|
#
|
524
|
+
# @!attribute [rw] settings
|
525
|
+
# Optional settings for the transcription job.
|
526
|
+
# @return [Types::Settings]
|
527
|
+
#
|
254
528
|
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptionJob AWS API Documentation
|
255
529
|
#
|
256
530
|
class TranscriptionJob < Struct.new(
|
@@ -263,7 +537,8 @@ module Aws::TranscribeService
|
|
263
537
|
:transcript,
|
264
538
|
:creation_time,
|
265
539
|
:completion_time,
|
266
|
-
:failure_reason
|
540
|
+
:failure_reason,
|
541
|
+
:settings)
|
267
542
|
include Aws::Structure
|
268
543
|
end
|
269
544
|
|
@@ -308,5 +583,92 @@ module Aws::TranscribeService
|
|
308
583
|
include Aws::Structure
|
309
584
|
end
|
310
585
|
|
586
|
+
# @note When making an API call, you may pass UpdateVocabularyRequest
|
587
|
+
# data as a hash:
|
588
|
+
#
|
589
|
+
# {
|
590
|
+
# vocabulary_name: "VocabularyName", # required
|
591
|
+
# language_code: "en-US", # required, accepts en-US, es-US
|
592
|
+
# phrases: ["Phrase"], # required
|
593
|
+
# }
|
594
|
+
#
|
595
|
+
# @!attribute [rw] vocabulary_name
|
596
|
+
# The name of the vocabulary to update. The name is case-sensitive.
|
597
|
+
# @return [String]
|
598
|
+
#
|
599
|
+
# @!attribute [rw] language_code
|
600
|
+
# The language code of the vocabulary entries.
|
601
|
+
# @return [String]
|
602
|
+
#
|
603
|
+
# @!attribute [rw] phrases
|
604
|
+
# An array of strings containing the vocabulary entries.
|
605
|
+
# @return [Array<String>]
|
606
|
+
#
|
607
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabularyRequest AWS API Documentation
|
608
|
+
#
|
609
|
+
class UpdateVocabularyRequest < Struct.new(
|
610
|
+
:vocabulary_name,
|
611
|
+
:language_code,
|
612
|
+
:phrases)
|
613
|
+
include Aws::Structure
|
614
|
+
end
|
615
|
+
|
616
|
+
# @!attribute [rw] vocabulary_name
|
617
|
+
# The name of the vocabulary that was updated.
|
618
|
+
# @return [String]
|
619
|
+
#
|
620
|
+
# @!attribute [rw] language_code
|
621
|
+
# The language code of the vocabulary entries.
|
622
|
+
# @return [String]
|
623
|
+
#
|
624
|
+
# @!attribute [rw] last_modified_time
|
625
|
+
# The date and time that the vocabulary was updated.
|
626
|
+
# @return [Time]
|
627
|
+
#
|
628
|
+
# @!attribute [rw] vocabulary_state
|
629
|
+
# The processing state of the vocabulary. When the `VocabularyState`
|
630
|
+
# field contains `READY` the vocabulary is ready to be used in a
|
631
|
+
# `StartTranscriptionJob` request.
|
632
|
+
# @return [String]
|
633
|
+
#
|
634
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/UpdateVocabularyResponse AWS API Documentation
|
635
|
+
#
|
636
|
+
class UpdateVocabularyResponse < Struct.new(
|
637
|
+
:vocabulary_name,
|
638
|
+
:language_code,
|
639
|
+
:last_modified_time,
|
640
|
+
:vocabulary_state)
|
641
|
+
include Aws::Structure
|
642
|
+
end
|
643
|
+
|
644
|
+
# Provides information about a custom vocabulary.
|
645
|
+
#
|
646
|
+
# @!attribute [rw] vocabulary_name
|
647
|
+
# The name of the vocabulary.
|
648
|
+
# @return [String]
|
649
|
+
#
|
650
|
+
# @!attribute [rw] language_code
|
651
|
+
# The language code of the vocabulary entries.
|
652
|
+
# @return [String]
|
653
|
+
#
|
654
|
+
# @!attribute [rw] last_modified_time
|
655
|
+
# The date and time that the vocabulary was last modified.
|
656
|
+
# @return [Time]
|
657
|
+
#
|
658
|
+
# @!attribute [rw] vocabulary_state
|
659
|
+
# The processing state of the vocabulary. If the state is `READY` you
|
660
|
+
# can use the vocabulary in a `StartTranscriptionJob` request.
|
661
|
+
# @return [String]
|
662
|
+
#
|
663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/VocabularyInfo AWS API Documentation
|
664
|
+
#
|
665
|
+
class VocabularyInfo < Struct.new(
|
666
|
+
:vocabulary_name,
|
667
|
+
:language_code,
|
668
|
+
:last_modified_time,
|
669
|
+
:vocabulary_state)
|
670
|
+
include Aws::Structure
|
671
|
+
end
|
672
|
+
|
311
673
|
end
|
312
674
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-transcribeservice
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.1.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-04-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
75
75
|
version: '0'
|
76
76
|
requirements: []
|
77
77
|
rubyforge_project:
|
78
|
-
rubygems_version: 2.5.
|
78
|
+
rubygems_version: 2.5.2.2
|
79
79
|
signing_key:
|
80
80
|
specification_version: 4
|
81
81
|
summary: AWS SDK for Ruby - Amazon Transcribe Service
|