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/Models/Report.html ADDED
@@ -0,0 +1,384 @@
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::Report
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::Report";
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 (R)</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">Report</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::Report
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::Report</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/report.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <p>Model class for reports from a transcription.</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="#details-instance_method" title="#details (instance method)">#<strong>details</strong> &#x21d2; Types::Array.of(Types::Hash) </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="#failed_transcriptions_count-instance_method" title="#failed_transcriptions_count (instance method)">#<strong>failed_transcriptions_count</strong> &#x21d2; Types::Coercible::Integer </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="#successful_transcriptions_count-instance_method" title="#successful_transcriptions_count (instance method)">#<strong>successful_transcriptions_count</strong> &#x21d2; Types::Coercible::Integer </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
+ </ul>
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+ <div id="instance_attr_details" class="attr_details">
219
+ <h2>Instance Attribute Details</h2>
220
+
221
+
222
+ <span id=""></span>
223
+ <div class="method_details first">
224
+ <h3 class="signature first" id="details-instance_method">
225
+
226
+ #<strong>details</strong> &#x21d2; <tt>Types::Array.of(Types::Hash)</tt> <span class="extras">(readonly)</span>
227
+
228
+
229
+
230
+
231
+
232
+ </h3><div class="docstring">
233
+ <div class="discussion">
234
+
235
+
236
+ </div>
237
+ </div>
238
+ <div class="tags">
239
+
240
+ <p class="tag_title">Returns:</p>
241
+ <ul class="return">
242
+
243
+ <li>
244
+
245
+
246
+ <span class='type'>(<tt>Types::Array.of(Types::Hash)</tt>)</span>
247
+
248
+
249
+
250
+ </li>
251
+
252
+ </ul>
253
+
254
+ </div><table class="source_code">
255
+ <tr>
256
+ <td>
257
+ <pre class="lines">
258
+
259
+
260
+ 28</pre>
261
+ </td>
262
+ <td>
263
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/report.rb', line 28</span>
264
+
265
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:details</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'>Array</span><span class='period'>.</span><span class='id identifier rubyid_of'>of</span><span class='lparen'>(</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><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='rparen'>)</span></pre>
266
+ </td>
267
+ </tr>
268
+ </table>
269
+ </div>
270
+
271
+
272
+ <span id=""></span>
273
+ <div class="method_details ">
274
+ <h3 class="signature " id="failed_transcriptions_count-instance_method">
275
+
276
+ #<strong>failed_transcriptions_count</strong> &#x21d2; <tt>Types::Coercible::Integer</tt> <span class="extras">(readonly)</span>
277
+
278
+
279
+
280
+
281
+
282
+ </h3><div class="docstring">
283
+ <div class="discussion">
284
+
285
+
286
+ </div>
287
+ </div>
288
+ <div class="tags">
289
+
290
+ <p class="tag_title">Returns:</p>
291
+ <ul class="return">
292
+
293
+ <li>
294
+
295
+
296
+ <span class='type'>(<tt>Types::Coercible::Integer</tt>)</span>
297
+
298
+
299
+
300
+ </li>
301
+
302
+ </ul>
303
+
304
+ </div><table class="source_code">
305
+ <tr>
306
+ <td>
307
+ <pre class="lines">
308
+
309
+
310
+ 21</pre>
311
+ </td>
312
+ <td>
313
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/report.rb', line 21</span>
314
+
315
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:failed_transcriptions_count</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'>Integer</span></pre>
316
+ </td>
317
+ </tr>
318
+ </table>
319
+ </div>
320
+
321
+
322
+ <span id=""></span>
323
+ <div class="method_details ">
324
+ <h3 class="signature " id="successful_transcriptions_count-instance_method">
325
+
326
+ #<strong>successful_transcriptions_count</strong> &#x21d2; <tt>Types::Coercible::Integer</tt> <span class="extras">(readonly)</span>
327
+
328
+
329
+
330
+
331
+
332
+ </h3><div class="docstring">
333
+ <div class="discussion">
334
+
335
+
336
+ </div>
337
+ </div>
338
+ <div class="tags">
339
+
340
+ <p class="tag_title">Returns:</p>
341
+ <ul class="return">
342
+
343
+ <li>
344
+
345
+
346
+ <span class='type'>(<tt>Types::Coercible::Integer</tt>)</span>
347
+
348
+
349
+
350
+ </li>
351
+
352
+ </ul>
353
+
354
+ </div><table class="source_code">
355
+ <tr>
356
+ <td>
357
+ <pre class="lines">
358
+
359
+
360
+ 14</pre>
361
+ </td>
362
+ <td>
363
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/report.rb', line 14</span>
364
+
365
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:successful_transcriptions_count</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'>Integer</span></pre>
366
+ </td>
367
+ </tr>
368
+ </table>
369
+ </div>
370
+
371
+ </div>
372
+
373
+
374
+ </div>
375
+
376
+ <div id="footer">
377
+ Generated on Thu Jun 24 14:16:27 2021 by
378
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
379
+ 0.9.26 (ruby-2.6.6).
380
+ </div>
381
+
382
+ </div>
383
+ </body>
384
+ </html>
data/docs/AzureSTT/Models/Result.html ADDED
@@ -0,0 +1,796 @@
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::Result
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::Result";
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 (R)</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">Result</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::Result
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::Result</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/result.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <p>Model class for the results of a transcription when the transcription is successful</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="#combined_recognized_phrases-instance_method" title="#combined_recognized_phrases (instance method)">#<strong>combined_recognized_phrases</strong> &#x21d2; Types::Array.of(CombinedRecognizedPhrases) </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="#duration-instance_method" title="#duration (instance method)">#<strong>duration</strong> &#x21d2; Types::Coercible::String </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="#duration_in_ticks-instance_method" title="#duration_in_ticks (instance method)">#<strong>duration_in_ticks</strong> &#x21d2; Types::Coercible::Integer </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="#recognized_phrases-instance_method" title="#recognized_phrases (instance method)">#<strong>recognized_phrases</strong> &#x21d2; Types::Array.of(RecognizedPhrases) </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="#source-instance_method" title="#source (instance method)">#<strong>source</strong> &#x21d2; Types::Coercible::String </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="#timestamp-instance_method" title="#timestamp (instance method)">#<strong>timestamp</strong> &#x21d2; Types::Date </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
+ </ul>
287
+
288
+
289
+
290
+
291
+
292
+ <h2>
293
+ Instance Method Summary
294
+ <small><a href="#" class="summary_toggle">collapse</a></small>
295
+ </h2>
296
+
297
+ <ul class="summary">
298
+
299
+ <li class="public ">
300
+ <span class="summary_signature">
301
+
302
+ <a href="#sentences-instance_method" title="#sentences (instance method)">#<strong>sentences</strong> &#x21d2; Array[Models::Sentence] </a>
303
+
304
+
305
+
306
+ </span>
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+ <span class="summary_desc"><div class='inline'>
317
+ <p>Get all the best Models::Sentence of a result.</p>
318
+ </div></span>
319
+
320
+ </li>
321
+
322
+
323
+ <li class="public ">
324
+ <span class="summary_signature">
325
+
326
+ <a href="#text-instance_method" title="#text (instance method)">#<strong>text</strong> &#x21d2; String </a>
327
+
328
+
329
+
330
+ </span>
331
+
332
+
333
+
334
+
335
+
336
+
337
+
338
+
339
+
340
+ <span class="summary_desc"><div class='inline'>
341
+ <p>The display field of the first CombinedRecognizedPhrases.</p>
342
+ </div></span>
343
+
344
+ </li>
345
+
346
+
347
+ </ul>
348
+
349
+
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+ <div id="instance_attr_details" class="attr_details">
359
+ <h2>Instance Attribute Details</h2>
360
+
361
+
362
+ <span id=""></span>
363
+ <div class="method_details first">
364
+ <h3 class="signature first" id="combined_recognized_phrases-instance_method">
365
+
366
+ #<strong>combined_recognized_phrases</strong> &#x21d2; <tt>Types::Array.of(<span class='object_link'><a href="CombinedRecognizedPhrases.html" title="AzureSTT::Models::CombinedRecognizedPhrases (class)">CombinedRecognizedPhrases</a></span>)</tt> <span class="extras">(readonly)</span>
367
+
368
+
369
+
370
+
371
+
372
+ </h3><div class="docstring">
373
+ <div class="discussion">
374
+
375
+
376
+ </div>
377
+ </div>
378
+ <div class="tags">
379
+
380
+ <p class="tag_title">Returns:</p>
381
+ <ul class="return">
382
+
383
+ <li>
384
+
385
+
386
+ <span class='type'>(<tt>Types::Array.of(<span class='object_link'><a href="CombinedRecognizedPhrases.html" title="AzureSTT::Models::CombinedRecognizedPhrases (class)">CombinedRecognizedPhrases</a></span>)</tt>)</span>
387
+
388
+
389
+
390
+ </li>
391
+
392
+ </ul>
393
+
394
+ </div><table class="source_code">
395
+ <tr>
396
+ <td>
397
+ <pre class="lines">
398
+
399
+
400
+ 44
401
+ 45</pre>
402
+ </td>
403
+ <td>
404
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/result.rb', line 44</span>
405
+
406
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:combined_recognized_phrases</span><span class='comma'>,</span>
407
+ <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'>Array</span><span class='period'>.</span><span class='id identifier rubyid_of'>of</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="CombinedRecognizedPhrases.html" title="AzureSTT::Models::CombinedRecognizedPhrases (class)">CombinedRecognizedPhrases</a></span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='rparen'>)</span></pre>
408
+ </td>
409
+ </tr>
410
+ </table>
411
+ </div>
412
+
413
+
414
+ <span id=""></span>
415
+ <div class="method_details ">
416
+ <h3 class="signature " id="duration-instance_method">
417
+
418
+ #<strong>duration</strong> &#x21d2; <tt>Types::Coercible::String</tt> <span class="extras">(readonly)</span>
419
+
420
+
421
+
422
+
423
+
424
+ </h3><div class="docstring">
425
+ <div class="discussion">
426
+
427
+
428
+ </div>
429
+ </div>
430
+ <div class="tags">
431
+
432
+ <p class="tag_title">Returns:</p>
433
+ <ul class="return">
434
+
435
+ <li>
436
+
437
+
438
+ <span class='type'>(<tt>Types::Coercible::String</tt>)</span>
439
+
440
+
441
+
442
+ </li>
443
+
444
+ </ul>
445
+
446
+ </div><table class="source_code">
447
+ <tr>
448
+ <td>
449
+ <pre class="lines">
450
+
451
+
452
+ 36</pre>
453
+ </td>
454
+ <td>
455
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/result.rb', line 36</span>
456
+
457
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:duration</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>
458
+ </td>
459
+ </tr>
460
+ </table>
461
+ </div>
462
+
463
+
464
+ <span id=""></span>
465
+ <div class="method_details ">
466
+ <h3 class="signature " id="duration_in_ticks-instance_method">
467
+
468
+ #<strong>duration_in_ticks</strong> &#x21d2; <tt>Types::Coercible::Integer</tt> <span class="extras">(readonly)</span>
469
+
470
+
471
+
472
+
473
+
474
+ </h3><div class="docstring">
475
+ <div class="discussion">
476
+
477
+
478
+ </div>
479
+ </div>
480
+ <div class="tags">
481
+
482
+ <p class="tag_title">Returns:</p>
483
+ <ul class="return">
484
+
485
+ <li>
486
+
487
+
488
+ <span class='type'>(<tt>Types::Coercible::Integer</tt>)</span>
489
+
490
+
491
+
492
+ </li>
493
+
494
+ </ul>
495
+
496
+ </div><table class="source_code">
497
+ <tr>
498
+ <td>
499
+ <pre class="lines">
500
+
501
+
502
+ 29</pre>
503
+ </td>
504
+ <td>
505
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/result.rb', line 29</span>
506
+
507
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:duration_in_ticks</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'>Integer</span></pre>
508
+ </td>
509
+ </tr>
510
+ </table>
511
+ </div>
512
+
513
+
514
+ <span id=""></span>
515
+ <div class="method_details ">
516
+ <h3 class="signature " id="recognized_phrases-instance_method">
517
+
518
+ #<strong>recognized_phrases</strong> &#x21d2; <tt>Types::Array.of(RecognizedPhrases)</tt> <span class="extras">(readonly)</span>
519
+
520
+
521
+
522
+
523
+
524
+ </h3><div class="docstring">
525
+ <div class="discussion">
526
+
527
+
528
+ </div>
529
+ </div>
530
+ <div class="tags">
531
+
532
+ <p class="tag_title">Returns:</p>
533
+ <ul class="return">
534
+
535
+ <li>
536
+
537
+
538
+ <span class='type'>(<tt>Types::Array.of(RecognizedPhrases)</tt>)</span>
539
+
540
+
541
+
542
+ </li>
543
+
544
+ </ul>
545
+
546
+ </div><table class="source_code">
547
+ <tr>
548
+ <td>
549
+ <pre class="lines">
550
+
551
+
552
+ 52
553
+ 53</pre>
554
+ </td>
555
+ <td>
556
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/result.rb', line 52</span>
557
+
558
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:recognized_phrases</span><span class='comma'>,</span>
559
+ <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'>Array</span><span class='period'>.</span><span class='id identifier rubyid_of'>of</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="RecognizedPhrase.html" title="AzureSTT::Models::RecognizedPhrase (class)">RecognizedPhrase</a></span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_default'>default</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span><span class='rparen'>)</span></pre>
560
+ </td>
561
+ </tr>
562
+ </table>
563
+ </div>
564
+
565
+
566
+ <span id=""></span>
567
+ <div class="method_details ">
568
+ <h3 class="signature " id="source-instance_method">
569
+
570
+ #<strong>source</strong> &#x21d2; <tt>Types::Coercible::String</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>Types::Coercible::String</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
+ 15</pre>
605
+ </td>
606
+ <td>
607
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/result.rb', line 15</span>
608
+
609
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:source</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>
610
+ </td>
611
+ </tr>
612
+ </table>
613
+ </div>
614
+
615
+
616
+ <span id=""></span>
617
+ <div class="method_details ">
618
+ <h3 class="signature " id="timestamp-instance_method">
619
+
620
+ #<strong>timestamp</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
+ 22</pre>
655
+ </td>
656
+ <td>
657
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/result.rb', line 22</span>
658
+
659
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:timestamp</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
+ </div>
666
+
667
+
668
+ <div id="instance_method_details" class="method_details_list">
669
+ <h2>Instance Method Details</h2>
670
+
671
+
672
+ <div class="method_details first">
673
+ <h3 class="signature first" id="sentences-instance_method">
674
+
675
+ #<strong>sentences</strong> &#x21d2; <tt>Array[<span class='object_link'><a href="Sentence.html" title="AzureSTT::Models::Sentence (class)">Models::Sentence</a></span>]</tt>
676
+
677
+
678
+
679
+
680
+
681
+ </h3><div class="docstring">
682
+ <div class="discussion">
683
+
684
+ <p>Get all the best Models::Sentence of a result.</p>
685
+
686
+
687
+ </div>
688
+ </div>
689
+ <div class="tags">
690
+
691
+ <p class="tag_title">Returns:</p>
692
+ <ul class="return">
693
+
694
+ <li>
695
+
696
+
697
+ <span class='type'>(<tt>Array[<span class='object_link'><a href="Sentence.html" title="AzureSTT::Models::Sentence (class)">Models::Sentence</a></span>]</tt>)</span>
698
+
699
+
700
+
701
+ </li>
702
+
703
+ </ul>
704
+
705
+ </div><table class="source_code">
706
+ <tr>
707
+ <td>
708
+ <pre class="lines">
709
+
710
+
711
+ 69
712
+ 70
713
+ 71
714
+ 72
715
+ 73</pre>
716
+ </td>
717
+ <td>
718
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/result.rb', line 69</span>
719
+
720
+ <span class='kw'>def</span> <span class='id identifier rubyid_sentences'>sentences</span>
721
+ <span class='id identifier rubyid_recognized_phrases'>recognized_phrases</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_recognized_phrase'>recognized_phrase</span><span class='op'>|</span>
722
+ <span class='id identifier rubyid_recognized_phrase'>recognized_phrase</span><span class='period'>.</span><span class='id identifier rubyid_n_best'>n_best</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
723
+ <span class='kw'>end</span>
724
+ <span class='kw'>end</span></pre>
725
+ </td>
726
+ </tr>
727
+ </table>
728
+ </div>
729
+
730
+ <div class="method_details ">
731
+ <h3 class="signature " id="text-instance_method">
732
+
733
+ #<strong>text</strong> &#x21d2; <tt>String</tt>
734
+
735
+
736
+
737
+
738
+
739
+ </h3><div class="docstring">
740
+ <div class="discussion">
741
+
742
+ <p>The display field of the first CombinedRecognizedPhrases</p>
743
+
744
+
745
+ </div>
746
+ </div>
747
+ <div class="tags">
748
+
749
+ <p class="tag_title">Returns:</p>
750
+ <ul class="return">
751
+
752
+ <li>
753
+
754
+
755
+ <span class='type'>(<tt>String</tt>)</span>
756
+
757
+
758
+
759
+ </li>
760
+
761
+ </ul>
762
+
763
+ </div><table class="source_code">
764
+ <tr>
765
+ <td>
766
+ <pre class="lines">
767
+
768
+
769
+ 60
770
+ 61
771
+ 62</pre>
772
+ </td>
773
+ <td>
774
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/models/result.rb', line 60</span>
775
+
776
+ <span class='kw'>def</span> <span class='id identifier rubyid_text'>text</span>
777
+ <span class='id identifier rubyid_combined_recognized_phrases'>combined_recognized_phrases</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_transcript'>transcript</span>
778
+ <span class='kw'>end</span></pre>
779
+ </td>
780
+ </tr>
781
+ </table>
782
+ </div>
783
+
784
+ </div>
785
+
786
+ </div>
787
+
788
+ <div id="footer">
789
+ Generated on Thu Jun 24 14:16:27 2021 by
790
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
791
+ 0.9.26 (ruby-2.6.6).
792
+ </div>
793
+
794
+ </div>
795
+ </body>
796
+ </html>