azure_stt 0.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.
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/Session.html ADDED
@@ -0,0 +1,767 @@
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::Session
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::Session";
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 (S)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../AzureSTT.html" title="AzureSTT (module)">AzureSTT</a></span></span>
41
+ &raquo;
42
+ <span class="title">Session</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::Session
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">AzureSTT::Session</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/azure_stt/session.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>A session is the class the end user uses to retrieve the Transcription. It contains a client.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+ <span class="note title readonly">readonly</span>
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>Returns the value of attribute client.</p>
144
+ </div></span>
145
+
146
+ </li>
147
+
148
+
149
+ </ul>
150
+
151
+
152
+
153
+
154
+
155
+ <h2>
156
+ Instance Method Summary
157
+ <small><a href="#" class="summary_toggle">collapse</a></small>
158
+ </h2>
159
+
160
+ <ul class="summary">
161
+
162
+ <li class="public ">
163
+ <span class="summary_signature">
164
+
165
+ <a href="#create_transcription-instance_method" title="#create_transcription (instance method)">#<strong>create_transcription</strong>(content_urls:, properties:, locale:, display_name:) &#x21d2; Models::Transcription </a>
166
+
167
+
168
+
169
+ </span>
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+ <span class="summary_desc"><div class='inline'>
180
+ <p>Create a transcription by calling the API.</p>
181
+ </div></span>
182
+
183
+ </li>
184
+
185
+
186
+ <li class="public ">
187
+ <span class="summary_signature">
188
+
189
+ <a href="#get_transcription-instance_method" title="#get_transcription (instance method)">#<strong>get_transcription</strong>(id) &#x21d2; Models::Transcription </a>
190
+
191
+
192
+
193
+ </span>
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+ <span class="summary_desc"><div class='inline'>
204
+ <p>Get a transcription identified by an id.</p>
205
+ </div></span>
206
+
207
+ </li>
208
+
209
+
210
+ <li class="public ">
211
+ <span class="summary_signature">
212
+
213
+ <a href="#get_transcriptions-instance_method" title="#get_transcriptions (instance method)">#<strong>get_transcriptions</strong>(skip: nil, top: nil) &#x21d2; Array[Models::Transcription] </a>
214
+
215
+
216
+
217
+ </span>
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+ <span class="summary_desc"><div class='inline'>
228
+ <p>Get multiple transcriptions.</p>
229
+ </div></span>
230
+
231
+ </li>
232
+
233
+
234
+ <li class="public ">
235
+ <span class="summary_signature">
236
+
237
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(region: AzureSTT.configuration.region, subscription_key: AzureSTT.configuration.subscription_key) &#x21d2; Session </a>
238
+
239
+
240
+
241
+ </span>
242
+
243
+
244
+ <span class="note title constructor">constructor</span>
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+
253
+ <span class="summary_desc"><div class='inline'>
254
+ <p>Create a session.</p>
255
+ </div></span>
256
+
257
+ </li>
258
+
259
+
260
+ </ul>
261
+
262
+
263
+ <div id="constructor_details" class="method_details_list">
264
+ <h2>Constructor Details</h2>
265
+
266
+ <div class="method_details first">
267
+ <h3 class="signature first" id="initialize-instance_method">
268
+
269
+ #<strong>initialize</strong>(region: AzureSTT.configuration.region, subscription_key: AzureSTT.configuration.subscription_key) &#x21d2; <tt><span class='object_link'><a href="" title="AzureSTT::Session (class)">Session</a></span></tt>
270
+
271
+
272
+
273
+
274
+
275
+ </h3><div class="docstring">
276
+ <div class="discussion">
277
+
278
+ <p>Create a session. If you don&#39;t provide any subscription_key or region, the value is read from configuration.</p>
279
+
280
+ <p>configuration read from configuration</p>
281
+
282
+
283
+ </div>
284
+ </div>
285
+ <div class="tags">
286
+ <p class="tag_title">Parameters:</p>
287
+ <ul class="param">
288
+
289
+ <li>
290
+
291
+ <span class='name'>region</span>
292
+
293
+
294
+ <span class='type'>(<tt>String</tt>)</span>
295
+
296
+
297
+ <em class="default">(defaults to: <tt>AzureSTT.configuration.region</tt>)</em>
298
+
299
+
300
+ &mdash;
301
+ <div class='inline'>
302
+ <p>The region, optional, default is read from</p>
303
+ </div>
304
+
305
+ </li>
306
+
307
+ <li>
308
+
309
+ <span class='name'>subscription_key</span>
310
+
311
+
312
+ <span class='type'>(<tt>String</tt>)</span>
313
+
314
+
315
+ <em class="default">(defaults to: <tt>AzureSTT.configuration.subscription_key</tt>)</em>
316
+
317
+
318
+ &mdash;
319
+ <div class='inline'>
320
+ <p>The subscription, optional, default is</p>
321
+ </div>
322
+
323
+ </li>
324
+
325
+ </ul>
326
+
327
+
328
+ </div><table class="source_code">
329
+ <tr>
330
+ <td>
331
+ <pre class="lines">
332
+
333
+
334
+ 20
335
+ 21
336
+ 22
337
+ 23</pre>
338
+ </td>
339
+ <td>
340
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/session.rb', line 20</span>
341
+
342
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>region:</span> <span class='const'><span class='object_link'><a href="../AzureSTT.html" title="AzureSTT (module)">AzureSTT</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configuration'><span class='object_link'><a href="../AzureSTT.html#configuration-class_method" title="AzureSTT.configuration (method)">configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_region'><span class='object_link'><a href="Configuration.html#region-instance_method" title="AzureSTT::Configuration#region (method)">region</a></span></span><span class='comma'>,</span>
343
+ <span class='label'>subscription_key:</span> <span class='const'><span class='object_link'><a href="../AzureSTT.html" title="AzureSTT (module)">AzureSTT</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configuration'><span class='object_link'><a href="../AzureSTT.html#configuration-class_method" title="AzureSTT.configuration (method)">configuration</a></span></span><span class='period'>.</span><span class='id identifier rubyid_subscription_key'><span class='object_link'><a href="Configuration.html#subscription_key-instance_method" title="AzureSTT::Configuration#subscription_key (method)">subscription_key</a></span></span><span class='rparen'>)</span>
344
+ <span class='ivar'>@client</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='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Client.html#initialize-instance_method" title="AzureSTT::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>region:</span> <span class='id identifier rubyid_region'>region</span><span class='comma'>,</span> <span class='label'>subscription_key:</span> <span class='id identifier rubyid_subscription_key'>subscription_key</span><span class='rparen'>)</span>
345
+ <span class='kw'>end</span></pre>
346
+ </td>
347
+ </tr>
348
+ </table>
349
+ </div>
350
+
351
+ </div>
352
+
353
+ <div id="instance_attr_details" class="attr_details">
354
+ <h2>Instance Attribute Details</h2>
355
+
356
+
357
+ <span id=""></span>
358
+ <div class="method_details first">
359
+ <h3 class="signature first" id="client-instance_method">
360
+
361
+ #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
362
+
363
+
364
+
365
+
366
+
367
+ </h3><div class="docstring">
368
+ <div class="discussion">
369
+
370
+ <p>Returns the value of attribute client.</p>
371
+
372
+
373
+ </div>
374
+ </div>
375
+ <div class="tags">
376
+
377
+
378
+ </div><table class="source_code">
379
+ <tr>
380
+ <td>
381
+ <pre class="lines">
382
+
383
+
384
+ 9
385
+ 10
386
+ 11</pre>
387
+ </td>
388
+ <td>
389
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/session.rb', line 9</span>
390
+
391
+ <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
392
+ <span class='ivar'>@client</span>
393
+ <span class='kw'>end</span></pre>
394
+ </td>
395
+ </tr>
396
+ </table>
397
+ </div>
398
+
399
+ </div>
400
+
401
+
402
+ <div id="instance_method_details" class="method_details_list">
403
+ <h2>Instance Method Details</h2>
404
+
405
+
406
+ <div class="method_details first">
407
+ <h3 class="signature first" id="create_transcription-instance_method">
408
+
409
+ #<strong>create_transcription</strong>(content_urls:, properties:, locale:, display_name:) &#x21d2; <tt><span class='object_link'><a href="Models/Transcription.html" title="AzureSTT::Models::Transcription (class)">Models::Transcription</a></span></tt>
410
+
411
+
412
+
413
+
414
+
415
+ </h3><div class="docstring">
416
+ <div class="discussion">
417
+
418
+ <p>Create a transcription by calling the API.</p>
419
+
420
+ <p>transcription left empty)</p>
421
+
422
+
423
+ </div>
424
+ </div>
425
+ <div class="tags">
426
+ <p class="tag_title">Parameters:</p>
427
+ <ul class="param">
428
+
429
+ <li>
430
+
431
+ <span class='name'>content_urls</span>
432
+
433
+
434
+ <span class='type'>(<tt>Array[String]</tt>)</span>
435
+
436
+
437
+
438
+ &mdash;
439
+ <div class='inline'>
440
+ <p>The urls of your files</p>
441
+ </div>
442
+
443
+ </li>
444
+
445
+ <li>
446
+
447
+ <span class='name'>properties</span>
448
+
449
+
450
+ <span class='type'>(<tt>Hash</tt>)</span>
451
+
452
+
453
+
454
+ &mdash;
455
+ <div class='inline'>
456
+ <p>The properties you want to use for the</p>
457
+ </div>
458
+
459
+ </li>
460
+
461
+ <li>
462
+
463
+ <span class='name'>locale</span>
464
+
465
+
466
+ <span class='type'>(<tt>String</tt>)</span>
467
+
468
+
469
+
470
+ &mdash;
471
+ <div class='inline'>
472
+ <p>The locale of the contained data</p>
473
+ </div>
474
+
475
+ </li>
476
+
477
+ <li>
478
+
479
+ <span class='name'>display_name</span>
480
+
481
+
482
+ <span class='type'>(<tt>String</tt>)</span>
483
+
484
+
485
+
486
+ &mdash;
487
+ <div class='inline'>
488
+ <p>The name of the transcription (can be</p>
489
+ </div>
490
+
491
+ </li>
492
+
493
+ </ul>
494
+
495
+ <p class="tag_title">Returns:</p>
496
+ <ul class="return">
497
+
498
+ <li>
499
+
500
+
501
+ <span class='type'>(<tt><span class='object_link'><a href="Models/Transcription.html" title="AzureSTT::Models::Transcription (class)">Models::Transcription</a></span></tt>)</span>
502
+
503
+
504
+
505
+ &mdash;
506
+ <div class='inline'>
507
+ <p>The transcription</p>
508
+ </div>
509
+
510
+ </li>
511
+
512
+ </ul>
513
+
514
+ <p class="tag_title">See Also:</p>
515
+ <ul class="see">
516
+
517
+ <li><a href="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/CreateTranscription" target="_parent" title="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/CreateTranscription">https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/CreateTranscription</a></li>
518
+
519
+ </ul>
520
+
521
+ </div><table class="source_code">
522
+ <tr>
523
+ <td>
524
+ <pre class="lines">
525
+
526
+
527
+ 39
528
+ 40
529
+ 41
530
+ 42
531
+ 43
532
+ 44
533
+ 45
534
+ 46
535
+ 47
536
+ 48
537
+ 49</pre>
538
+ </td>
539
+ <td>
540
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/session.rb', line 39</span>
541
+
542
+ <span class='kw'>def</span> <span class='id identifier rubyid_create_transcription'>create_transcription</span><span class='lparen'>(</span><span class='label'>content_urls:</span><span class='comma'>,</span> <span class='label'>properties:</span><span class='comma'>,</span> <span class='label'>locale:</span><span class='comma'>,</span> <span class='label'>display_name:</span><span class='rparen'>)</span>
543
+ <span class='id identifier rubyid_transcription_hash'>transcription_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_create_transcription'>create_transcription</span><span class='lparen'>(</span>
544
+ <span class='lbrace'>{</span>
545
+ <span class='label'>contentUrls:</span> <span class='id identifier rubyid_content_urls'>content_urls</span><span class='comma'>,</span>
546
+ <span class='label'>properties:</span> <span class='id identifier rubyid_properties'>properties</span><span class='comma'>,</span>
547
+ <span class='label'>locale:</span> <span class='id identifier rubyid_locale'>locale</span><span class='comma'>,</span>
548
+ <span class='label'>displayName:</span> <span class='id identifier rubyid_display_name'>display_name</span>
549
+ <span class='rbrace'>}</span>
550
+ <span class='rparen'>)</span>
551
+ <span class='id identifier rubyid_build_transcription_from_hash'>build_transcription_from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_transcription_hash'>transcription_hash</span><span class='rparen'>)</span>
552
+ <span class='kw'>end</span></pre>
553
+ </td>
554
+ </tr>
555
+ </table>
556
+ </div>
557
+
558
+ <div class="method_details ">
559
+ <h3 class="signature " id="get_transcription-instance_method">
560
+
561
+ #<strong>get_transcription</strong>(id) &#x21d2; <tt><span class='object_link'><a href="Models/Transcription.html" title="AzureSTT::Models::Transcription (class)">Models::Transcription</a></span></tt>
562
+
563
+
564
+
565
+
566
+
567
+ </h3><div class="docstring">
568
+ <div class="discussion">
569
+
570
+ <p>Get a transcription identified by an id.</p>
571
+
572
+
573
+ </div>
574
+ </div>
575
+ <div class="tags">
576
+ <p class="tag_title">Parameters:</p>
577
+ <ul class="param">
578
+
579
+ <li>
580
+
581
+ <span class='name'>id</span>
582
+
583
+
584
+ <span class='type'>(<tt>String</tt>)</span>
585
+
586
+
587
+
588
+ &mdash;
589
+ <div class='inline'>
590
+ <p>The identifier of the transcription</p>
591
+ </div>
592
+
593
+ </li>
594
+
595
+ </ul>
596
+
597
+ <p class="tag_title">Returns:</p>
598
+ <ul class="return">
599
+
600
+ <li>
601
+
602
+
603
+ <span class='type'>(<tt><span class='object_link'><a href="Models/Transcription.html" title="AzureSTT::Models::Transcription (class)">Models::Transcription</a></span></tt>)</span>
604
+
605
+
606
+
607
+ &mdash;
608
+ <div class='inline'>
609
+ <p>the transcription</p>
610
+ </div>
611
+
612
+ </li>
613
+
614
+ </ul>
615
+
616
+ <p class="tag_title">See Also:</p>
617
+ <ul class="see">
618
+
619
+ <li><a href="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscription" target="_parent" title="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscription">https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscription</a></li>
620
+
621
+ </ul>
622
+
623
+ </div><table class="source_code">
624
+ <tr>
625
+ <td>
626
+ <pre class="lines">
627
+
628
+
629
+ 60
630
+ 61
631
+ 62
632
+ 63</pre>
633
+ </td>
634
+ <td>
635
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/session.rb', line 60</span>
636
+
637
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_transcription'>get_transcription</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
638
+ <span class='id identifier rubyid_transcription_hash'>transcription_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get_transcription'>get_transcription</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
639
+ <span class='id identifier rubyid_build_transcription_from_hash'>build_transcription_from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_transcription_hash'>transcription_hash</span><span class='rparen'>)</span>
640
+ <span class='kw'>end</span></pre>
641
+ </td>
642
+ </tr>
643
+ </table>
644
+ </div>
645
+
646
+ <div class="method_details ">
647
+ <h3 class="signature " id="get_transcriptions-instance_method">
648
+
649
+ #<strong>get_transcriptions</strong>(skip: nil, top: nil) &#x21d2; <tt>Array[<span class='object_link'><a href="Models/Transcription.html" title="AzureSTT::Models::Transcription (class)">Models::Transcription</a></span>]</tt>
650
+
651
+
652
+
653
+
654
+
655
+ </h3><div class="docstring">
656
+ <div class="discussion">
657
+
658
+ <p>Get multiple transcriptions.</p>
659
+
660
+ <p>(optional)</p>
661
+
662
+
663
+ </div>
664
+ </div>
665
+ <div class="tags">
666
+ <p class="tag_title">Parameters:</p>
667
+ <ul class="param">
668
+
669
+ <li>
670
+
671
+ <span class='name'>skip</span>
672
+
673
+
674
+ <span class='type'>(<tt>Integer</tt>)</span>
675
+
676
+
677
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
678
+
679
+
680
+ &mdash;
681
+ <div class='inline'>
682
+ <p>Number of transcriptions that will be skipped (optional)</p>
683
+ </div>
684
+
685
+ </li>
686
+
687
+ <li>
688
+
689
+ <span class='name'>top</span>
690
+
691
+
692
+ <span class='type'>(<tt>Integer</tt>)</span>
693
+
694
+
695
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
696
+
697
+
698
+ &mdash;
699
+ <div class='inline'>
700
+ <p>Number of transcriptions that will be included after skipping</p>
701
+ </div>
702
+
703
+ </li>
704
+
705
+ </ul>
706
+
707
+ <p class="tag_title">Returns:</p>
708
+ <ul class="return">
709
+
710
+ <li>
711
+
712
+
713
+ <span class='type'>(<tt>Array[<span class='object_link'><a href="Models/Transcription.html" title="AzureSTT::Models::Transcription (class)">Models::Transcription</a></span>]</tt>)</span>
714
+
715
+
716
+
717
+ </li>
718
+
719
+ </ul>
720
+
721
+ <p class="tag_title">See Also:</p>
722
+ <ul class="see">
723
+
724
+ <li><a href="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptions" target="_parent" title="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptions">https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-0/operations/GetTranscriptions</a></li>
725
+
726
+ </ul>
727
+
728
+ </div><table class="source_code">
729
+ <tr>
730
+ <td>
731
+ <pre class="lines">
732
+
733
+
734
+ 76
735
+ 77
736
+ 78
737
+ 79
738
+ 80
739
+ 81</pre>
740
+ </td>
741
+ <td>
742
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/session.rb', line 76</span>
743
+
744
+ <span class='kw'>def</span> <span class='id identifier rubyid_get_transcriptions'>get_transcriptions</span><span class='lparen'>(</span><span class='label'>skip:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>top:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
745
+ <span class='id identifier rubyid_transcriptions_array'>transcriptions_array</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_get_transcriptions'>get_transcriptions</span><span class='lparen'>(</span><span class='label'>skip:</span> <span class='id identifier rubyid_skip'>skip</span><span class='comma'>,</span> <span class='label'>top:</span> <span class='id identifier rubyid_top'>top</span><span class='rparen'>)</span>
746
+ <span class='id identifier rubyid_transcriptions_array'>transcriptions_array</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_transcription_hash'>transcription_hash</span><span class='op'>|</span>
747
+ <span class='id identifier rubyid_build_transcription_from_hash'>build_transcription_from_hash</span><span class='lparen'>(</span><span class='id identifier rubyid_transcription_hash'>transcription_hash</span><span class='rparen'>)</span>
748
+ <span class='kw'>end</span>
749
+ <span class='kw'>end</span></pre>
750
+ </td>
751
+ </tr>
752
+ </table>
753
+ </div>
754
+
755
+ </div>
756
+
757
+ </div>
758
+
759
+ <div id="footer">
760
+ Generated on Thu Jun 24 14:16:27 2021 by
761
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
762
+ 0.9.26 (ruby-2.6.6).
763
+ </div>
764
+
765
+ </div>
766
+ </body>
767
+ </html>