azure_stt 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (89) hide show
  1. checksums.yaml +7 -0
  2. data/.github/dependabot.yml +6 -0
  3. data/.github/workflows/ci.yml +33 -0
  4. data/.gitignore +56 -0
  5. data/.rubocop.yml +22 -0
  6. data/CHANGELOG.md +28 -0
  7. data/CODE_OF_CONDUCT.md +74 -0
  8. data/Gemfile +24 -0
  9. data/Gemfile.lock +141 -0
  10. data/LICENSE +21 -0
  11. data/README.md +129 -0
  12. data/Rakefile +27 -0
  13. data/azure_stt.gemspec +29 -0
  14. data/bin/console +15 -0
  15. data/bin/setup +8 -0
  16. data/docs/AzureBatchTranscription.html +301 -0
  17. data/docs/AzureBatchTranscription/Configuration.html +212 -0
  18. data/docs/AzureSTT.html +305 -0
  19. data/docs/AzureSTT/Client.html +1008 -0
  20. data/docs/AzureSTT/Configuration.html +282 -0
  21. data/docs/AzureSTT/Error.html +305 -0
  22. data/docs/AzureSTT/Models.html +135 -0
  23. data/docs/AzureSTT/Models/Base.html +139 -0
  24. data/docs/AzureSTT/Models/CombinedRecognizedPhrases.html +538 -0
  25. data/docs/AzureSTT/Models/File.html +794 -0
  26. data/docs/AzureSTT/Models/RecognizedPhrase.html +769 -0
  27. data/docs/AzureSTT/Models/Report.html +384 -0
  28. data/docs/AzureSTT/Models/Result.html +796 -0
  29. data/docs/AzureSTT/Models/Sentence.html +615 -0
  30. data/docs/AzureSTT/Models/Transcription.html +1415 -0
  31. data/docs/AzureSTT/Models/Word.html +615 -0
  32. data/docs/AzureSTT/NetError.html +159 -0
  33. data/docs/AzureSTT/Parsers.html +128 -0
  34. data/docs/AzureSTT/Parsers/Base.html +404 -0
  35. data/docs/AzureSTT/Parsers/CombinedRecognizedPhrases.html +156 -0
  36. data/docs/AzureSTT/Parsers/File.html +156 -0
  37. data/docs/AzureSTT/Parsers/RecognizedPhrase.html +156 -0
  38. data/docs/AzureSTT/Parsers/Report.html +156 -0
  39. data/docs/AzureSTT/Parsers/Result.html +156 -0
  40. data/docs/AzureSTT/Parsers/Sentence.html +156 -0
  41. data/docs/AzureSTT/Parsers/Transcription.html +156 -0
  42. data/docs/AzureSTT/Parsers/Word.html +156 -0
  43. data/docs/AzureSTT/ServiceError.html +159 -0
  44. data/docs/AzureSTT/Session.html +767 -0
  45. data/docs/AzureSTT/Transcription.html +635 -0
  46. data/docs/AzureSTT/Types.html +116 -0
  47. data/docs/AzureStt_.html +121 -0
  48. data/docs/_index.html +392 -0
  49. data/docs/class_list.html +51 -0
  50. data/docs/css/common.css +1 -0
  51. data/docs/css/full_list.css +58 -0
  52. data/docs/css/style.css +497 -0
  53. data/docs/file.README.html +201 -0
  54. data/docs/file_list.html +56 -0
  55. data/docs/frames.html +17 -0
  56. data/docs/index.html +201 -0
  57. data/docs/js/app.js +314 -0
  58. data/docs/js/full_list.js +216 -0
  59. data/docs/js/jquery.js +4 -0
  60. data/docs/method_list.html +707 -0
  61. data/docs/top-level-namespace.html +110 -0
  62. data/env.sample +2 -0
  63. data/lib/azure_stt.rb +20 -0
  64. data/lib/azure_stt/client.rb +189 -0
  65. data/lib/azure_stt/configuration.rb +28 -0
  66. data/lib/azure_stt/errors.rb +25 -0
  67. data/lib/azure_stt/models.rb +30 -0
  68. data/lib/azure_stt/models/base.rb +27 -0
  69. data/lib/azure_stt/models/combined_recognized_phrases.rb +48 -0
  70. data/lib/azure_stt/models/file.rb +72 -0
  71. data/lib/azure_stt/models/recognized_phrase.rb +70 -0
  72. data/lib/azure_stt/models/report.rb +31 -0
  73. data/lib/azure_stt/models/result.rb +76 -0
  74. data/lib/azure_stt/models/sentence.rb +53 -0
  75. data/lib/azure_stt/models/transcription.rb +185 -0
  76. data/lib/azure_stt/models/word.rb +54 -0
  77. data/lib/azure_stt/parsers.rb +19 -0
  78. data/lib/azure_stt/parsers/base.rb +42 -0
  79. data/lib/azure_stt/parsers/combined_recognized_phrases.rb +28 -0
  80. data/lib/azure_stt/parsers/file.rb +28 -0
  81. data/lib/azure_stt/parsers/recognized_phrase.rb +45 -0
  82. data/lib/azure_stt/parsers/report.rb +25 -0
  83. data/lib/azure_stt/parsers/result.rb +56 -0
  84. data/lib/azure_stt/parsers/sentence.rb +45 -0
  85. data/lib/azure_stt/parsers/transcription.rb +34 -0
  86. data/lib/azure_stt/parsers/word.rb +28 -0
  87. data/lib/azure_stt/session.rb +100 -0
  88. data/lib/azure_stt/version.rb +5 -0
  89. metadata +158 -0
data/docs/AzureSTT/Models/Transcription.html ADDED
@@ -0,0 +1,1415 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: AzureSTT::Models::Transcription
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "AzureSTT::Models::Transcription";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (T)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../AzureSTT.html" title="AzureSTT (module)">AzureSTT</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Models.html" title="AzureSTT::Models (module)">Models</a></span></span>
41
+ &raquo;
42
+ <span class="title">Transcription</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: AzureSTT::Models::Transcription
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName"><span class='object_link'><a href="Base.html" title="AzureSTT::Models::Base (class)">Base</a></span></span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Dry::Struct</li>
78
+
79
+ <li class="next"><span class='object_link'><a href="Base.html" title="AzureSTT::Models::Base (class)">Base</a></span></li>
80
+
81
+ <li class="next">AzureSTT::Models::Transcription</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/azure_stt/models/transcription.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <p>Model for a transcription. Contains the results and static methods to create and retrieve the transcriptions.</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+
117
+ </div>
118
+
119
+
120
+
121
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
122
+ <ul class="summary">
123
+
124
+ <li class="public ">
125
+ <span class="summary_signature">
126
+
127
+ <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; AzureSTT::Client </a>
128
+
129
+
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+ <span class="note title readonly">readonly</span>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+ <span class="summary_desc"><div class='inline'></div></span>
147
+
148
+ </li>
149
+
150
+
151
+ <li class="public ">
152
+ <span class="summary_signature">
153
+
154
+ <a href="#created_date_time-instance_method" title="#created_date_time (instance method)">#<strong>created_date_time</strong> &#x21d2; Types::Date </a>
155
+
156
+
157
+
158
+ </span>
159
+
160
+
161
+
162
+
163
+ <span class="note title readonly">readonly</span>
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <span class="summary_desc"><div class='inline'></div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#display_name-instance_method" title="#display_name (instance method)">#<strong>display_name</strong> &#x21d2; Types::Coercible::String </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+ <span class="note title readonly">readonly</span>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'></div></span>
201
+
202
+ </li>
203
+
204
+
205
+ <li class="public ">
206
+ <span class="summary_signature">
207
+
208
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Types::Coercible::String </a>
209
+
210
+
211
+
212
+ </span>
213
+
214
+
215
+
216
+
217
+ <span class="note title readonly">readonly</span>
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+ <span class="summary_desc"><div class='inline'></div></span>
228
+
229
+ </li>
230
+
231
+
232
+ <li class="public ">
233
+ <span class="summary_signature">
234
+
235
+ <a href="#last_action_date_time-instance_method" title="#last_action_date_time (instance method)">#<strong>last_action_date_time</strong> &#x21d2; Types::Date </a>
236
+
237
+
238
+
239
+ </span>
240
+
241
+
242
+
243
+
244
+ <span class="note title readonly">readonly</span>
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+ <span class="summary_desc"><div class='inline'></div></span>
255
+
256
+ </li>
257
+
258
+
259
+ <li class="public ">
260
+ <span class="summary_signature">
261
+
262
+ <a href="#links-instance_method" title="#links (instance method)">#<strong>links</strong> &#x21d2; Types::Hash </a>
263
+
264
+
265
+
266
+ </span>
267
+
268
+
269
+
270
+
271
+ <span class="note title readonly">readonly</span>
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+ <span class="summary_desc"><div class='inline'></div></span>
282
+
283
+ </li>
284
+
285
+
286
+ <li class="public ">
287
+ <span class="summary_signature">
288
+
289
+ <a href="#locale-instance_method" title="#locale (instance method)">#<strong>locale</strong> &#x21d2; Types::Coercible::String </a>
290
+
291
+
292
+
293
+ </span>
294
+
295
+
296
+
297
+
298
+ <span class="note title readonly">readonly</span>
299
+
300
+
301
+
302
+
303
+
304
+
305
+
306
+
307
+
308
+ <span class="summary_desc"><div class='inline'></div></span>
309
+
310
+ </li>
311
+
312
+
313
+ <li class="public ">
314
+ <span class="summary_signature">
315
+
316
+ <a href="#model-instance_method" title="#model (instance method)">#<strong>model</strong> &#x21d2; Types::Coercible::String </a>
317
+
318
+
319
+
320
+ </span>
321
+
322
+
323
+
324
+
325
+ <span class="note title readonly">readonly</span>
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+ <span class="summary_desc"><div class='inline'></div></span>
336
+
337
+ </li>
338
+
339
+
340
+ <li class="public ">
341
+ <span class="summary_signature">
342
+
343
+ <a href="#properties-instance_method" title="#properties (instance method)">#<strong>properties</strong> &#x21d2; Types::Hash </a>
344
+
345
+
346
+
347
+ </span>
348
+
349
+
350
+
351
+
352
+ <span class="note title readonly">readonly</span>
353
+
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+ <span class="summary_desc"><div class='inline'></div></span>
363
+
364
+ </li>
365
+
366
+
367
+ <li class="public ">
368
+ <span class="summary_signature">
369
+
370
+ <a href="#status-instance_method" title="#status (instance method)">#<strong>status</strong> &#x21d2; Types::Coercible::String </a>
371
+
372
+
373
+
374
+ </span>
375
+
376
+
377
+
378
+
379
+ <span class="note title readonly">readonly</span>
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+
388
+
389
+ <span class="summary_desc"><div class='inline'></div></span>
390
+
391
+ </li>
392
+
393
+
394
+ </ul>
395
+
396
+
397
+
398
+
399
+
400
+ <h2>
401
+ Instance Method Summary
402
+ <small><a href="#" class="summary_toggle">collapse</a></small>
403
+ </h2>
404
+
405
+ <ul class="summary">
406
+
407
+ <li class="public ">
408
+ <span class="summary_signature">
409
+
410
+ <a href="#failed%3F-instance_method" title="#failed? (instance method)">#<strong>failed?</strong> &#x21d2; Boolean </a>
411
+
412
+
413
+
414
+ </span>
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+ <span class="summary_desc"><div class='inline'>
425
+ <p>Is the status is failed ?.</p>
426
+ </div></span>
427
+
428
+ </li>
429
+
430
+
431
+ <li class="public ">
432
+ <span class="summary_signature">
433
+
434
+ <a href="#finished%3F-instance_method" title="#finished? (instance method)">#<strong>finished?</strong> &#x21d2; Boolean </a>
435
+
436
+
437
+
438
+ </span>
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+ <span class="summary_desc"><div class='inline'>
449
+ <p>Is the process finished ? (Succeeded or failed).</p>
450
+ </div></span>
451
+
452
+ </li>
453
+
454
+
455
+ <li class="public ">
456
+ <span class="summary_signature">
457
+
458
+ <a href="#report-instance_method" title="#report (instance method)">#<strong>report</strong> &#x21d2; Models::Report </a>
459
+
460
+
461
+
462
+ </span>
463
+
464
+
465
+
466
+
467
+
468
+
469
+
470
+
471
+
472
+ <span class="summary_desc"><div class='inline'>
473
+ <p>Get the report of a transcription from transcriptions/id/files route.</p>
474
+ </div></span>
475
+
476
+ </li>
477
+
478
+
479
+ <li class="public ">
480
+ <span class="summary_signature">
481
+
482
+ <a href="#results-instance_method" title="#results (instance method)">#<strong>results</strong> &#x21d2; Array[Models::Result] </a>
483
+
484
+
485
+
486
+ </span>
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+
496
+ <span class="summary_desc"><div class='inline'>
497
+ <p>Get the results of a transcription.</p>
498
+ </div></span>
499
+
500
+ </li>
501
+
502
+
503
+ <li class="public ">
504
+ <span class="summary_signature">
505
+
506
+ <a href="#running%3F-instance_method" title="#running? (instance method)">#<strong>running?</strong> &#x21d2; Boolean </a>
507
+
508
+
509
+
510
+ </span>
511
+
512
+
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+ <span class="summary_desc"><div class='inline'>
521
+ <p>Is the process still running ?.</p>
522
+ </div></span>
523
+
524
+ </li>
525
+
526
+
527
+ <li class="public ">
528
+ <span class="summary_signature">
529
+
530
+ <a href="#succeeded%3F-instance_method" title="#succeeded? (instance method)">#<strong>succeeded?</strong> &#x21d2; Boolean </a>
531
+
532
+
533
+
534
+ </span>
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+
543
+
544
+ <span class="summary_desc"><div class='inline'>
545
+ <p>Has the process succeeded ?.</p>
546
+ </div></span>
547
+
548
+ </li>
549
+
550
+
551
+ </ul>
552
+
553
+
554
+
555
+
556
+
557
+
558
+
559
+
560
+
561
+
562
+ <div id="instance_attr_details" class="attr_details">
563
+ <h2>Instance Attribute Details</h2>
564
+
565
+
566
+ <span id=""></span>
567
+ <div class="method_details first">
568
+ <h3 class="signature first" id="client-instance_method">
569
+
570
+ #<strong>client</strong> &#x21d2; <tt><span class='object_link'><a href="../Client.html" title="AzureSTT::Client (class)">AzureSTT::Client</a></span></tt> <span class="extras">(readonly)</span>
571
+
572
+
573
+
574
+
575
+
576
+ </h3><div class="docstring">
577
+ <div class="discussion">
578
+
579
+
580
+ </div>
581
+ </div>
582
+ <div class="tags">
583
+
584
+ <p class="tag_title">Returns:</p>
585
+ <ul class="return">
586
+
587
+ <li>
588
+
589
+
590
+ <span class='type'>(<tt><span class='object_link'><a href="../Client.html" title="AzureSTT::Client (class)">AzureSTT::Client</a></span></tt>)</span>
591
+
592
+
593
+
594
+ </li>
595
+
596
+ </ul>
597
+
598
+ </div><table class="source_code">
599
+ <tr>
600
+ <td>
601
+ <pre class="lines">
602
+
603
+
604
+ 85</pre>
605
+ </td>
606
+ <td>
607
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 85</span>
608
+
609
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:client</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Types.html" title="AzureSTT::Types (module)">Types</a></span></span><span class='period'>.</span><span class='const'>Instance</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../AzureSTT.html" title="AzureSTT (module)">AzureSTT</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Client.html" title="AzureSTT::Client (class)">Client</a></span></span><span class='rparen'>)</span></pre>
610
+ </td>
611
+ </tr>
612
+ </table>
613
+ </div>
614
+
615
+
616
+ <span id=""></span>
617
+ <div class="method_details ">
618
+ <h3 class="signature " id="created_date_time-instance_method">
619
+
620
+ #<strong>created_date_time</strong> &#x21d2; <tt>Types::Date</tt> <span class="extras">(readonly)</span>
621
+
622
+
623
+
624
+
625
+
626
+ </h3><div class="docstring">
627
+ <div class="discussion">
628
+
629
+
630
+ </div>
631
+ </div>
632
+ <div class="tags">
633
+
634
+ <p class="tag_title">Returns:</p>
635
+ <ul class="return">
636
+
637
+ <li>
638
+
639
+
640
+ <span class='type'>(<tt>Types::Date</tt>)</span>
641
+
642
+
643
+
644
+ </li>
645
+
646
+ </ul>
647
+
648
+ </div><table class="source_code">
649
+ <tr>
650
+ <td>
651
+ <pre class="lines">
652
+
653
+
654
+ 50</pre>
655
+ </td>
656
+ <td>
657
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 50</span>
658
+
659
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:created_date_time</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Types.html" title="AzureSTT::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Date</span></pre>
660
+ </td>
661
+ </tr>
662
+ </table>
663
+ </div>
664
+
665
+
666
+ <span id=""></span>
667
+ <div class="method_details ">
668
+ <h3 class="signature " id="display_name-instance_method">
669
+
670
+ #<strong>display_name</strong> &#x21d2; <tt>Types::Coercible::String</tt> <span class="extras">(readonly)</span>
671
+
672
+
673
+
674
+
675
+
676
+ </h3><div class="docstring">
677
+ <div class="discussion">
678
+
679
+
680
+ </div>
681
+ </div>
682
+ <div class="tags">
683
+
684
+ <p class="tag_title">Returns:</p>
685
+ <ul class="return">
686
+
687
+ <li>
688
+
689
+
690
+ <span class='type'>(<tt>Types::Coercible::String</tt>)</span>
691
+
692
+
693
+
694
+ </li>
695
+
696
+ </ul>
697
+
698
+ </div><table class="source_code">
699
+ <tr>
700
+ <td>
701
+ <pre class="lines">
702
+
703
+
704
+ 71</pre>
705
+ </td>
706
+ <td>
707
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 71</span>
708
+
709
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:display_name</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Types.html" title="AzureSTT::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Coercible</span><span class='op'>::</span><span class='const'>String</span></pre>
710
+ </td>
711
+ </tr>
712
+ </table>
713
+ </div>
714
+
715
+
716
+ <span id=""></span>
717
+ <div class="method_details ">
718
+ <h3 class="signature " id="id-instance_method">
719
+
720
+ #<strong>id</strong> &#x21d2; <tt>Types::Coercible::String</tt> <span class="extras">(readonly)</span>
721
+
722
+
723
+
724
+
725
+
726
+ </h3><div class="docstring">
727
+ <div class="discussion">
728
+
729
+
730
+ </div>
731
+ </div>
732
+ <div class="tags">
733
+
734
+ <p class="tag_title">Returns:</p>
735
+ <ul class="return">
736
+
737
+ <li>
738
+
739
+
740
+ <span class='type'>(<tt>Types::Coercible::String</tt>)</span>
741
+
742
+
743
+
744
+ </li>
745
+
746
+ </ul>
747
+
748
+ </div><table class="source_code">
749
+ <tr>
750
+ <td>
751
+ <pre class="lines">
752
+
753
+
754
+ 15</pre>
755
+ </td>
756
+ <td>
757
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 15</span>
758
+
759
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:id</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Types.html" title="AzureSTT::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Coercible</span><span class='op'>::</span><span class='const'>String</span></pre>
760
+ </td>
761
+ </tr>
762
+ </table>
763
+ </div>
764
+
765
+
766
+ <span id=""></span>
767
+ <div class="method_details ">
768
+ <h3 class="signature " id="last_action_date_time-instance_method">
769
+
770
+ #<strong>last_action_date_time</strong> &#x21d2; <tt>Types::Date</tt> <span class="extras">(readonly)</span>
771
+
772
+
773
+
774
+
775
+
776
+ </h3><div class="docstring">
777
+ <div class="discussion">
778
+
779
+
780
+ </div>
781
+ </div>
782
+ <div class="tags">
783
+
784
+ <p class="tag_title">Returns:</p>
785
+ <ul class="return">
786
+
787
+ <li>
788
+
789
+
790
+ <span class='type'>(<tt>Types::Date</tt>)</span>
791
+
792
+
793
+
794
+ </li>
795
+
796
+ </ul>
797
+
798
+ </div><table class="source_code">
799
+ <tr>
800
+ <td>
801
+ <pre class="lines">
802
+
803
+
804
+ 43</pre>
805
+ </td>
806
+ <td>
807
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 43</span>
808
+
809
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:last_action_date_time</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Types.html" title="AzureSTT::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Date</span></pre>
810
+ </td>
811
+ </tr>
812
+ </table>
813
+ </div>
814
+
815
+
816
+ <span id=""></span>
817
+ <div class="method_details ">
818
+ <h3 class="signature " id="links-instance_method">
819
+
820
+ #<strong>links</strong> &#x21d2; <tt>Types::Hash</tt> <span class="extras">(readonly)</span>
821
+
822
+
823
+
824
+
825
+
826
+ </h3><div class="docstring">
827
+ <div class="discussion">
828
+
829
+
830
+ </div>
831
+ </div>
832
+ <div class="tags">
833
+
834
+ <p class="tag_title">Returns:</p>
835
+ <ul class="return">
836
+
837
+ <li>
838
+
839
+
840
+ <span class='type'>(<tt>Types::Hash</tt>)</span>
841
+
842
+
843
+
844
+ </li>
845
+
846
+ </ul>
847
+
848
+ </div><table class="source_code">
849
+ <tr>
850
+ <td>
851
+ <pre class="lines">
852
+
853
+
854
+ 36</pre>
855
+ </td>
856
+ <td>
857
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 36</span>
858
+
859
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:links</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Types.html" title="AzureSTT::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Hash</span></pre>
860
+ </td>
861
+ </tr>
862
+ </table>
863
+ </div>
864
+
865
+
866
+ <span id=""></span>
867
+ <div class="method_details ">
868
+ <h3 class="signature " id="locale-instance_method">
869
+
870
+ #<strong>locale</strong> &#x21d2; <tt>Types::Coercible::String</tt> <span class="extras">(readonly)</span>
871
+
872
+
873
+
874
+
875
+
876
+ </h3><div class="docstring">
877
+ <div class="discussion">
878
+
879
+
880
+ </div>
881
+ </div>
882
+ <div class="tags">
883
+
884
+ <p class="tag_title">Returns:</p>
885
+ <ul class="return">
886
+
887
+ <li>
888
+
889
+
890
+ <span class='type'>(<tt>Types::Coercible::String</tt>)</span>
891
+
892
+
893
+
894
+ </li>
895
+
896
+ </ul>
897
+
898
+ </div><table class="source_code">
899
+ <tr>
900
+ <td>
901
+ <pre class="lines">
902
+
903
+
904
+ 64</pre>
905
+ </td>
906
+ <td>
907
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 64</span>
908
+
909
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:locale</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Types.html" title="AzureSTT::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Coercible</span><span class='op'>::</span><span class='const'>String</span></pre>
910
+ </td>
911
+ </tr>
912
+ </table>
913
+ </div>
914
+
915
+
916
+ <span id=""></span>
917
+ <div class="method_details ">
918
+ <h3 class="signature " id="model-instance_method">
919
+
920
+ #<strong>model</strong> &#x21d2; <tt>Types::Coercible::String</tt> <span class="extras">(readonly)</span>
921
+
922
+
923
+
924
+
925
+
926
+ </h3><div class="docstring">
927
+ <div class="discussion">
928
+
929
+
930
+ </div>
931
+ </div>
932
+ <div class="tags">
933
+
934
+ <p class="tag_title">Returns:</p>
935
+ <ul class="return">
936
+
937
+ <li>
938
+
939
+
940
+ <span class='type'>(<tt>Types::Coercible::String</tt>)</span>
941
+
942
+
943
+
944
+ </li>
945
+
946
+ </ul>
947
+
948
+ </div><table class="source_code">
949
+ <tr>
950
+ <td>
951
+ <pre class="lines">
952
+
953
+
954
+ 22</pre>
955
+ </td>
956
+ <td>
957
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 22</span>
958
+
959
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:model</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Types.html" title="AzureSTT::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Coercible</span><span class='op'>::</span><span class='const'>String</span></pre>
960
+ </td>
961
+ </tr>
962
+ </table>
963
+ </div>
964
+
965
+
966
+ <span id=""></span>
967
+ <div class="method_details ">
968
+ <h3 class="signature " id="properties-instance_method">
969
+
970
+ #<strong>properties</strong> &#x21d2; <tt>Types::Hash</tt> <span class="extras">(readonly)</span>
971
+
972
+
973
+
974
+
975
+
976
+ </h3><div class="docstring">
977
+ <div class="discussion">
978
+
979
+
980
+ </div>
981
+ </div>
982
+ <div class="tags">
983
+
984
+ <p class="tag_title">Returns:</p>
985
+ <ul class="return">
986
+
987
+ <li>
988
+
989
+
990
+ <span class='type'>(<tt>Types::Hash</tt>)</span>
991
+
992
+
993
+
994
+ </li>
995
+
996
+ </ul>
997
+
998
+ </div><table class="source_code">
999
+ <tr>
1000
+ <td>
1001
+ <pre class="lines">
1002
+
1003
+
1004
+ 29</pre>
1005
+ </td>
1006
+ <td>
1007
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 29</span>
1008
+
1009
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:properties</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Types.html" title="AzureSTT::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Hash</span></pre>
1010
+ </td>
1011
+ </tr>
1012
+ </table>
1013
+ </div>
1014
+
1015
+
1016
+ <span id=""></span>
1017
+ <div class="method_details ">
1018
+ <h3 class="signature " id="status-instance_method">
1019
+
1020
+ #<strong>status</strong> &#x21d2; <tt>Types::Coercible::String</tt> <span class="extras">(readonly)</span>
1021
+
1022
+
1023
+
1024
+
1025
+
1026
+ </h3><div class="docstring">
1027
+ <div class="discussion">
1028
+
1029
+
1030
+ </div>
1031
+ </div>
1032
+ <div class="tags">
1033
+
1034
+ <p class="tag_title">Returns:</p>
1035
+ <ul class="return">
1036
+
1037
+ <li>
1038
+
1039
+
1040
+ <span class='type'>(<tt>Types::Coercible::String</tt>)</span>
1041
+
1042
+
1043
+
1044
+ </li>
1045
+
1046
+ </ul>
1047
+
1048
+ </div><table class="source_code">
1049
+ <tr>
1050
+ <td>
1051
+ <pre class="lines">
1052
+
1053
+
1054
+ 57</pre>
1055
+ </td>
1056
+ <td>
1057
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 57</span>
1058
+
1059
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:status</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../Types.html" title="AzureSTT::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'>Coercible</span><span class='op'>::</span><span class='const'>String</span></pre>
1060
+ </td>
1061
+ </tr>
1062
+ </table>
1063
+ </div>
1064
+
1065
+ </div>
1066
+
1067
+
1068
+ <div id="instance_method_details" class="method_details_list">
1069
+ <h2>Instance Method Details</h2>
1070
+
1071
+
1072
+ <div class="method_details first">
1073
+ <h3 class="signature first" id="failed?-instance_method">
1074
+
1075
+ #<strong>failed?</strong> &#x21d2; <tt>Boolean</tt>
1076
+
1077
+
1078
+
1079
+
1080
+
1081
+ </h3><div class="docstring">
1082
+ <div class="discussion">
1083
+
1084
+ <p>Is the status is failed ?</p>
1085
+
1086
+
1087
+ </div>
1088
+ </div>
1089
+ <div class="tags">
1090
+
1091
+ <p class="tag_title">Returns:</p>
1092
+ <ul class="return">
1093
+
1094
+ <li>
1095
+
1096
+
1097
+ <span class='type'>(<tt>Boolean</tt>)</span>
1098
+
1099
+
1100
+
1101
+ </li>
1102
+
1103
+ </ul>
1104
+
1105
+ </div><table class="source_code">
1106
+ <tr>
1107
+ <td>
1108
+ <pre class="lines">
1109
+
1110
+
1111
+ 101
1112
+ 102
1113
+ 103</pre>
1114
+ </td>
1115
+ <td>
1116
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 101</span>
1117
+
1118
+ <span class='kw'>def</span> <span class='id identifier rubyid_failed?'>failed?</span>
1119
+ <span class='id identifier rubyid_status'>status</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Failed</span><span class='tstring_end'>&#39;</span></span>
1120
+ <span class='kw'>end</span></pre>
1121
+ </td>
1122
+ </tr>
1123
+ </table>
1124
+ </div>
1125
+
1126
+ <div class="method_details ">
1127
+ <h3 class="signature " id="finished?-instance_method">
1128
+
1129
+ #<strong>finished?</strong> &#x21d2; <tt>Boolean</tt>
1130
+
1131
+
1132
+
1133
+
1134
+
1135
+ </h3><div class="docstring">
1136
+ <div class="discussion">
1137
+
1138
+ <p>Is the process finished ? (Succeeded or failed)</p>
1139
+
1140
+
1141
+ </div>
1142
+ </div>
1143
+ <div class="tags">
1144
+
1145
+ <p class="tag_title">Returns:</p>
1146
+ <ul class="return">
1147
+
1148
+ <li>
1149
+
1150
+
1151
+ <span class='type'>(<tt>Boolean</tt>)</span>
1152
+
1153
+
1154
+
1155
+ </li>
1156
+
1157
+ </ul>
1158
+
1159
+ </div><table class="source_code">
1160
+ <tr>
1161
+ <td>
1162
+ <pre class="lines">
1163
+
1164
+
1165
+ 119
1166
+ 120
1167
+ 121</pre>
1168
+ </td>
1169
+ <td>
1170
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 119</span>
1171
+
1172
+ <span class='kw'>def</span> <span class='id identifier rubyid_finished?'>finished?</span>
1173
+ <span class='id identifier rubyid_succeeded?'>succeeded?</span> <span class='op'>||</span> <span class='id identifier rubyid_failed?'>failed?</span>
1174
+ <span class='kw'>end</span></pre>
1175
+ </td>
1176
+ </tr>
1177
+ </table>
1178
+ </div>
1179
+
1180
+ <div class="method_details ">
1181
+ <h3 class="signature " id="report-instance_method">
1182
+
1183
+ #<strong>report</strong> &#x21d2; <tt><span class='object_link'><a href="Report.html" title="AzureSTT::Models::Report (class)">Models::Report</a></span></tt>
1184
+
1185
+
1186
+
1187
+
1188
+
1189
+ </h3><div class="docstring">
1190
+ <div class="discussion">
1191
+
1192
+ <p>Get the report of a transcription from transcriptions/id/files route</p>
1193
+
1194
+
1195
+ </div>
1196
+ </div>
1197
+ <div class="tags">
1198
+
1199
+ <p class="tag_title">Returns:</p>
1200
+ <ul class="return">
1201
+
1202
+ <li>
1203
+
1204
+
1205
+ <span class='type'>(<tt><span class='object_link'><a href="Report.html" title="AzureSTT::Models::Report (class)">Models::Report</a></span></tt>)</span>
1206
+
1207
+
1208
+
1209
+ </li>
1210
+
1211
+ </ul>
1212
+
1213
+ <p class="tag_title">See Also:</p>
1214
+ <ul class="see">
1215
+
1216
+ <li><a href="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptionFiles/console" target="_parent" title="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptionFiles/console">https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptionFiles/console</a></li>
1217
+
1218
+ </ul>
1219
+
1220
+ </div><table class="source_code">
1221
+ <tr>
1222
+ <td>
1223
+ <pre class="lines">
1224
+
1225
+
1226
+ 130
1227
+ 131
1228
+ 132</pre>
1229
+ </td>
1230
+ <td>
1231
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 130</span>
1232
+
1233
+ <span class='kw'>def</span> <span class='id identifier rubyid_report'>report</span>
1234
+ <span class='ivar'>@report</span> <span class='op'>||=</span> <span class='id identifier rubyid_retrieve_report'>retrieve_report</span>
1235
+ <span class='kw'>end</span></pre>
1236
+ </td>
1237
+ </tr>
1238
+ </table>
1239
+ </div>
1240
+
1241
+ <div class="method_details ">
1242
+ <h3 class="signature " id="results-instance_method">
1243
+
1244
+ #<strong>results</strong> &#x21d2; <tt>Array[<span class='object_link'><a href="Result.html" title="AzureSTT::Models::Result (class)">Models::Result</a></span>]</tt>
1245
+
1246
+
1247
+
1248
+
1249
+
1250
+ </h3><div class="docstring">
1251
+ <div class="discussion">
1252
+
1253
+ <p>Get the results of a transcription. The results are the files containing the speech-to-text. As a transcription process can have multiple files, the results are in an Array.</p>
1254
+
1255
+
1256
+ </div>
1257
+ </div>
1258
+ <div class="tags">
1259
+
1260
+ <p class="tag_title">Returns:</p>
1261
+ <ul class="return">
1262
+
1263
+ <li>
1264
+
1265
+
1266
+ <span class='type'>(<tt>Array[<span class='object_link'><a href="Result.html" title="AzureSTT::Models::Result (class)">Models::Result</a></span>]</tt>)</span>
1267
+
1268
+
1269
+
1270
+ </li>
1271
+
1272
+ </ul>
1273
+
1274
+ </div><table class="source_code">
1275
+ <tr>
1276
+ <td>
1277
+ <pre class="lines">
1278
+
1279
+
1280
+ 141
1281
+ 142
1282
+ 143</pre>
1283
+ </td>
1284
+ <td>
1285
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 141</span>
1286
+
1287
+ <span class='kw'>def</span> <span class='id identifier rubyid_results'>results</span>
1288
+ <span class='ivar'>@results</span> <span class='op'>||=</span> <span class='id identifier rubyid_retrieve_results'>retrieve_results</span>
1289
+ <span class='kw'>end</span></pre>
1290
+ </td>
1291
+ </tr>
1292
+ </table>
1293
+ </div>
1294
+
1295
+ <div class="method_details ">
1296
+ <h3 class="signature " id="running?-instance_method">
1297
+
1298
+ #<strong>running?</strong> &#x21d2; <tt>Boolean</tt>
1299
+
1300
+
1301
+
1302
+
1303
+
1304
+ </h3><div class="docstring">
1305
+ <div class="discussion">
1306
+
1307
+ <p>Is the process still running ?</p>
1308
+
1309
+
1310
+ </div>
1311
+ </div>
1312
+ <div class="tags">
1313
+
1314
+ <p class="tag_title">Returns:</p>
1315
+ <ul class="return">
1316
+
1317
+ <li>
1318
+
1319
+
1320
+ <span class='type'>(<tt>Boolean</tt>)</span>
1321
+
1322
+
1323
+
1324
+ </li>
1325
+
1326
+ </ul>
1327
+
1328
+ </div><table class="source_code">
1329
+ <tr>
1330
+ <td>
1331
+ <pre class="lines">
1332
+
1333
+
1334
+ 92
1335
+ 93
1336
+ 94</pre>
1337
+ </td>
1338
+ <td>
1339
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 92</span>
1340
+
1341
+ <span class='kw'>def</span> <span class='id identifier rubyid_running?'>running?</span>
1342
+ <span class='id identifier rubyid_status'>status</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Running</span><span class='tstring_end'>&#39;</span></span>
1343
+ <span class='kw'>end</span></pre>
1344
+ </td>
1345
+ </tr>
1346
+ </table>
1347
+ </div>
1348
+
1349
+ <div class="method_details ">
1350
+ <h3 class="signature " id="succeeded?-instance_method">
1351
+
1352
+ #<strong>succeeded?</strong> &#x21d2; <tt>Boolean</tt>
1353
+
1354
+
1355
+
1356
+
1357
+
1358
+ </h3><div class="docstring">
1359
+ <div class="discussion">
1360
+
1361
+ <p>Has the process succeeded ?</p>
1362
+
1363
+
1364
+ </div>
1365
+ </div>
1366
+ <div class="tags">
1367
+
1368
+ <p class="tag_title">Returns:</p>
1369
+ <ul class="return">
1370
+
1371
+ <li>
1372
+
1373
+
1374
+ <span class='type'>(<tt>Boolean</tt>)</span>
1375
+
1376
+
1377
+
1378
+ </li>
1379
+
1380
+ </ul>
1381
+
1382
+ </div><table class="source_code">
1383
+ <tr>
1384
+ <td>
1385
+ <pre class="lines">
1386
+
1387
+
1388
+ 110
1389
+ 111
1390
+ 112</pre>
1391
+ </td>
1392
+ <td>
1393
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/transcription.rb', line 110</span>
1394
+
1395
+ <span class='kw'>def</span> <span class='id identifier rubyid_succeeded?'>succeeded?</span>
1396
+ <span class='id identifier rubyid_status'>status</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Succeeded</span><span class='tstring_end'>&#39;</span></span>
1397
+ <span class='kw'>end</span></pre>
1398
+ </td>
1399
+ </tr>
1400
+ </table>
1401
+ </div>
1402
+
1403
+ </div>
1404
+
1405
+ </div>
1406
+
1407
+ <div id="footer">
1408
+ Generated on Thu Jun 24 14:16:27 2021 by
1409
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1410
+ 0.9.26 (ruby-2.6.6).
1411
+ </div>
1412
+
1413
+ </div>
1414
+ </body>
1415
+ </html>