azure_stt 0.2.0 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (56) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +6 -3
  3. data/.gitignore +2 -2
  4. data/CHANGELOG.md +16 -1
  5. data/Gemfile +3 -2
  6. data/README.md +2 -2
  7. data/azure_stt.gemspec +5 -2
  8. data/docs/AzureSTT/Client.html +148 -39
  9. data/docs/AzureSTT/Configuration.html +4 -4
  10. data/docs/AzureSTT/Error.html +4 -170
  11. data/docs/AzureSTT/Models/Base.html +4 -4
  12. data/docs/AzureSTT/Models/CombinedRecognizedPhrases.html +4 -4
  13. data/docs/AzureSTT/Models/File.html +5 -5
  14. data/docs/AzureSTT/Models/RecognizedPhrase.html +4 -4
  15. data/docs/AzureSTT/Models/Report.html +4 -4
  16. data/docs/AzureSTT/Models/Result.html +4 -4
  17. data/docs/AzureSTT/Models/Sentence.html +4 -4
  18. data/docs/AzureSTT/Models/Transcription.html +5 -5
  19. data/docs/AzureSTT/Models/Word.html +4 -4
  20. data/docs/AzureSTT/Models.html +4 -4
  21. data/docs/AzureSTT/NetError.html +161 -11
  22. data/docs/AzureSTT/Parsers/Base.html +4 -4
  23. data/docs/AzureSTT/Parsers/CombinedRecognizedPhrases.html +4 -4
  24. data/docs/AzureSTT/Parsers/File.html +4 -4
  25. data/docs/AzureSTT/Parsers/RecognizedPhrase.html +4 -4
  26. data/docs/AzureSTT/Parsers/Report.html +4 -4
  27. data/docs/AzureSTT/Parsers/Result.html +4 -4
  28. data/docs/AzureSTT/Parsers/Sentence.html +4 -4
  29. data/docs/AzureSTT/Parsers/Transcription.html +4 -4
  30. data/docs/AzureSTT/Parsers/Word.html +4 -4
  31. data/docs/AzureSTT/Parsers.html +4 -4
  32. data/docs/AzureSTT/ServiceError.html +161 -11
  33. data/docs/AzureSTT/Session.html +132 -24
  34. data/docs/AzureSTT/Types.html +4 -4
  35. data/docs/AzureSTT.html +4 -4
  36. data/docs/AzureStt_.html +5 -5
  37. data/docs/_index.html +5 -5
  38. data/docs/file.README.html +133 -95
  39. data/docs/frames.html +1 -1
  40. data/docs/index.html +133 -95
  41. data/docs/method_list.html +66 -34
  42. data/docs/top-level-namespace.html +4 -4
  43. data/lib/azure_stt/client.rb +9 -8
  44. data/lib/azure_stt/errors.rb +16 -9
  45. data/lib/azure_stt/models/file.rb +1 -1
  46. data/lib/azure_stt/models/transcription.rb +1 -1
  47. data/lib/azure_stt/parsers/combined_recognized_phrases.rb +1 -1
  48. data/lib/azure_stt/session.rb +8 -10
  49. data/lib/azure_stt/version.rb +1 -1
  50. data/lib/azure_stt.rb +2 -2
  51. metadata +7 -11
  52. data/.github/dependabot.yml +0 -6
  53. data/Gemfile.lock +0 -141
  54. data/docs/AzureBatchTranscription/Configuration.html +0 -212
  55. data/docs/AzureBatchTranscription.html +0 -301
  56. data/docs/AzureSTT/Transcription.html +0 -635
data/docs/AzureSTT/Parsers/CombinedRecognizedPhrases.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: AzureSTT::Parsers::CombinedRecognizedPhrases
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -146,9 +146,9 @@
146
146
  </div>
147
147
 
148
148
  <div id="footer">
149
- Generated on Thu Jun 24 14:16:27 2021 by
150
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
- 0.9.26 (ruby-2.6.6).
149
+ Generated on Wed May 10 12:30:20 2023 by
150
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
+ 0.9.34 (ruby-2.7.7).
152
152
  </div>
153
153
 
154
154
  </div>
data/docs/AzureSTT/Parsers/File.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: AzureSTT::Parsers::File
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -146,9 +146,9 @@
146
146
  </div>
147
147
 
148
148
  <div id="footer">
149
- Generated on Thu Jun 24 14:16:27 2021 by
150
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
- 0.9.26 (ruby-2.6.6).
149
+ Generated on Wed May 10 12:30:20 2023 by
150
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
+ 0.9.34 (ruby-2.7.7).
152
152
  </div>
153
153
 
154
154
  </div>
data/docs/AzureSTT/Parsers/RecognizedPhrase.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: AzureSTT::Parsers::RecognizedPhrase
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -146,9 +146,9 @@
146
146
  </div>
147
147
 
148
148
  <div id="footer">
149
- Generated on Thu Jun 24 14:16:27 2021 by
150
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
- 0.9.26 (ruby-2.6.6).
149
+ Generated on Wed May 10 12:30:20 2023 by
150
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
+ 0.9.34 (ruby-2.7.7).
152
152
  </div>
153
153
 
154
154
  </div>
data/docs/AzureSTT/Parsers/Report.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: AzureSTT::Parsers::Report
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -146,9 +146,9 @@
146
146
  </div>
147
147
 
148
148
  <div id="footer">
149
- Generated on Thu Jun 24 14:16:27 2021 by
150
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
- 0.9.26 (ruby-2.6.6).
149
+ Generated on Wed May 10 12:30:20 2023 by
150
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
+ 0.9.34 (ruby-2.7.7).
152
152
  </div>
153
153
 
154
154
  </div>
data/docs/AzureSTT/Parsers/Result.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: AzureSTT::Parsers::Result
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -146,9 +146,9 @@
146
146
  </div>
147
147
 
148
148
  <div id="footer">
149
- Generated on Thu Jun 24 14:16:27 2021 by
150
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
- 0.9.26 (ruby-2.6.6).
149
+ Generated on Wed May 10 12:30:20 2023 by
150
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
+ 0.9.34 (ruby-2.7.7).
152
152
  </div>
153
153
 
154
154
  </div>
data/docs/AzureSTT/Parsers/Sentence.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: AzureSTT::Parsers::Sentence
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -146,9 +146,9 @@
146
146
  </div>
147
147
 
148
148
  <div id="footer">
149
- Generated on Thu Jun 24 14:16:27 2021 by
150
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
- 0.9.26 (ruby-2.6.6).
149
+ Generated on Wed May 10 12:30:20 2023 by
150
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
+ 0.9.34 (ruby-2.7.7).
152
152
  </div>
153
153
 
154
154
  </div>
data/docs/AzureSTT/Parsers/Transcription.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: AzureSTT::Parsers::Transcription
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -146,9 +146,9 @@
146
146
  </div>
147
147
 
148
148
  <div id="footer">
149
- Generated on Thu Jun 24 14:16:27 2021 by
150
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
- 0.9.26 (ruby-2.6.6).
149
+ Generated on Wed May 10 12:30:20 2023 by
150
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
+ 0.9.34 (ruby-2.7.7).
152
152
  </div>
153
153
 
154
154
  </div>
data/docs/AzureSTT/Parsers/Word.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: AzureSTT::Parsers::Word
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -146,9 +146,9 @@
146
146
  </div>
147
147
 
148
148
  <div id="footer">
149
- Generated on Thu Jun 24 14:16:27 2021 by
150
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
- 0.9.26 (ruby-2.6.6).
149
+ Generated on Wed May 10 12:30:20 2023 by
150
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
+ 0.9.34 (ruby-2.7.7).
152
152
  </div>
153
153
 
154
154
  </div>
data/docs/AzureSTT/Parsers.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Module: AzureSTT::Parsers
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -118,9 +118,9 @@
118
118
  </div>
119
119
 
120
120
  <div id="footer">
121
- Generated on Thu Jun 24 14:16:27 2021 by
122
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
123
- 0.9.26 (ruby-2.6.6).
121
+ Generated on Wed May 10 12:30:20 2023 by
122
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
123
+ 0.9.34 (ruby-2.7.7).
124
124
  </div>
125
125
 
126
126
  </div>
data/docs/AzureSTT/ServiceError.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Exception: AzureSTT::ServiceError
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -118,40 +118,190 @@
118
118
 
119
119
 
120
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="#code-instance_method" title="#code (instance method)">#<strong>code</strong> &#x21d2; Object </a>
128
+
121
129
 
130
+
131
+ </span>
132
+
133
+
134
+
135
+
136
+ <span class="note title readonly">readonly</span>
137
+
138
+
139
+
140
+
141
+
142
+
143
+
122
144
 
123
- <h2>Instance Attribute Summary</h2>
124
145
 
125
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Error.html" title="AzureSTT::Error (class)">Error</a></span></h3>
126
- <p class="inherited"><span class='object_link'><a href="Error.html#code-instance_method" title="AzureSTT::Error#code (method)">#code</a></span></p>
146
+ <span class="summary_desc"><div class='inline'>
147
+ <p>Returns the value of attribute code.</p>
148
+ </div></span>
149
+
150
+ </li>
151
+
152
+
153
+ </ul>
154
+
127
155
 
128
156
 
129
157
 
130
158
 
159
+ <h2>
160
+ Instance Method Summary
161
+ <small><a href="#" class="summary_toggle">collapse</a></small>
162
+ </h2>
163
+
164
+ <ul class="summary">
165
+
166
+ <li class="public ">
167
+ <span class="summary_signature">
168
+
169
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(code:, message:, azure_message:) &#x21d2; ServiceError </a>
170
+
171
+
172
+
173
+ </span>
131
174
 
132
175
 
176
+ <span class="note title constructor">constructor</span>
133
177
 
134
178
 
135
179
 
136
- <h2>Method Summary</h2>
137
180
 
138
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Error.html" title="AzureSTT::Error (class)">Error</a></span></h3>
139
- <p class="inherited"><span class='object_link'><a href="Error.html#initialize-instance_method" title="AzureSTT::Error#initialize (method)">#initialize</a></span></p>
181
+
182
+
183
+
184
+
185
+ <span class="summary_desc"><div class='inline'>
186
+ <p>A new instance of ServiceError.</p>
187
+ </div></span>
188
+
189
+ </li>
140
190
 
191
+
192
+ </ul>
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
141
202
  <div id="constructor_details" class="method_details_list">
142
203
  <h2>Constructor Details</h2>
143
204
 
144
- <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Error.html#initialize-instance_method" title="AzureSTT::Error#initialize (method)">AzureSTT::Error</a></span></p>
205
+ <div class="method_details first">
206
+ <h3 class="signature first" id="initialize-instance_method">
207
+
208
+ #<strong>initialize</strong>(code:, message:, azure_message:) &#x21d2; <tt><span class='object_link'><a href="" title="AzureSTT::ServiceError (class)">ServiceError</a></span></tt>
209
+
210
+
211
+
212
+
213
+
214
+ </h3><div class="docstring">
215
+ <div class="discussion">
216
+
217
+ <p>Returns a new instance of ServiceError.</p>
218
+
219
+
220
+ </div>
221
+ </div>
222
+ <div class="tags">
223
+
224
+
225
+ </div><table class="source_code">
226
+ <tr>
227
+ <td>
228
+ <pre class="lines">
229
+
230
+
231
+ 15
232
+ 16
233
+ 17
234
+ 18</pre>
235
+ </td>
236
+ <td>
237
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/errors.rb', line 15</span>
238
+
239
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>code:</span><span class='comma'>,</span> <span class='label'>message:</span><span class='comma'>,</span> <span class='label'>azure_message:</span><span class='rparen'>)</span>
240
+ <span class='ivar'>@code</span> <span class='op'>=</span> <span class='id identifier rubyid_code'>code</span>
241
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_message'>message</span><span class='embexpr_end'>}</span><span class='tstring_content'> (</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_code'>code</span><span class='embexpr_end'>}</span><span class='tstring_content'>): </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_azure_message'>azure_message</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
242
+ <span class='kw'>end</span></pre>
243
+ </td>
244
+ </tr>
245
+ </table>
246
+ </div>
247
+
248
+ </div>
249
+
250
+ <div id="instance_attr_details" class="attr_details">
251
+ <h2>Instance Attribute Details</h2>
252
+
253
+
254
+ <span id=""></span>
255
+ <div class="method_details first">
256
+ <h3 class="signature first" id="code-instance_method">
257
+
258
+ #<strong>code</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
259
+
260
+
261
+
262
+
145
263
 
264
+ </h3><div class="docstring">
265
+ <div class="discussion">
266
+
267
+ <p>Returns the value of attribute code.</p>
268
+
269
+
270
+ </div>
146
271
  </div>
272
+ <div class="tags">
273
+
274
+
275
+ </div><table class="source_code">
276
+ <tr>
277
+ <td>
278
+ <pre class="lines">
279
+
280
+
281
+ 13
282
+ 14
283
+ 15</pre>
284
+ </td>
285
+ <td>
286
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/errors.rb', line 13</span>
287
+
288
+ <span class='kw'>def</span> <span class='id identifier rubyid_code'>code</span>
289
+ <span class='ivar'>@code</span>
290
+ <span class='kw'>end</span></pre>
291
+ </td>
292
+ </tr>
293
+ </table>
294
+ </div>
295
+
296
+ </div>
147
297
 
148
298
 
149
299
  </div>
150
300
 
151
301
  <div id="footer">
152
- Generated on Thu Jun 24 14:16:27 2021 by
153
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
154
- 0.9.26 (ruby-2.6.6).
302
+ Generated on Wed May 10 12:30:20 2023 by
303
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
304
+ 0.9.34 (ruby-2.7.7).
155
305
  </div>
156
306
 
157
307
  </div>
data/docs/AzureSTT/Session.html CHANGED
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: AzureSTT::Session
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.34
10
10
 
11
11
  </title>
12
12
 
@@ -180,6 +180,30 @@
180
180
  <p>Create a transcription by calling the API.</p>
181
181
  </div></span>
182
182
 
183
+ </li>
184
+
185
+
186
+ <li class="public ">
187
+ <span class="summary_signature">
188
+
189
+ <a href="#delete_transcription-instance_method" title="#delete_transcription (instance method)">#<strong>delete_transcription</strong>(id) &#x21d2; Boolean </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>Delete an API transcription with a given ID.</p>
205
+ </div></span>
206
+
183
207
  </li>
184
208
 
185
209
 
@@ -514,7 +538,7 @@
514
538
  <p class="tag_title">See Also:</p>
515
539
  <ul class="see">
516
540
 
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>
541
+ <li><a href="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/CreateTranscription" target="_parent" title="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/CreateTranscription">https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/CreateTranscription</a></li>
518
542
 
519
543
  </ul>
520
544
 
@@ -532,27 +556,111 @@
532
556
  44
533
557
  45
534
558
  46
535
- 47
536
- 48
537
- 49</pre>
559
+ 47</pre>
538
560
  </td>
539
561
  <td>
540
562
  <pre class="code"><span class="info file"># File 'lib/azure_stt/session.rb', line 39</span>
541
563
 
542
564
  <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
565
  <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>
566
+ <span class='label'>contentUrls:</span> <span class='id identifier rubyid_content_urls'>content_urls</span><span class='comma'>,</span>
567
+ <span class='label'>properties:</span> <span class='id identifier rubyid_properties'>properties</span><span class='comma'>,</span>
568
+ <span class='label'>locale:</span> <span class='id identifier rubyid_locale'>locale</span><span class='comma'>,</span>
569
+ <span class='label'>displayName:</span> <span class='id identifier rubyid_display_name'>display_name</span>
550
570
  <span class='rparen'>)</span>
551
571
  <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
572
  <span class='kw'>end</span></pre>
553
573
  </td>
554
574
  </tr>
555
575
  </table>
576
+ </div>
577
+
578
+ <div class="method_details ">
579
+ <h3 class="signature " id="delete_transcription-instance_method">
580
+
581
+ #<strong>delete_transcription</strong>(id) &#x21d2; <tt>Boolean</tt>
582
+
583
+
584
+
585
+
586
+
587
+ </h3><div class="docstring">
588
+ <div class="discussion">
589
+
590
+ <p>Delete an API transcription with a given ID. The transcription will not exist anymore in the API, therefore you won&#39;t be able to retrieve it.</p>
591
+
592
+ <p>an error else</p>
593
+
594
+
595
+ </div>
596
+ </div>
597
+ <div class="tags">
598
+ <p class="tag_title">Parameters:</p>
599
+ <ul class="param">
600
+
601
+ <li>
602
+
603
+ <span class='name'>id</span>
604
+
605
+
606
+ <span class='type'>(<tt>String</tt>)</span>
607
+
608
+
609
+
610
+ &mdash;
611
+ <div class='inline'>
612
+ <p>The id of the transcription in the API</p>
613
+ </div>
614
+
615
+ </li>
616
+
617
+ </ul>
618
+
619
+ <p class="tag_title">Returns:</p>
620
+ <ul class="return">
621
+
622
+ <li>
623
+
624
+
625
+ <span class='type'>(<tt>Boolean</tt>)</span>
626
+
627
+
628
+
629
+ &mdash;
630
+ <div class='inline'>
631
+ <p>true if the transcription had been deleted, raises</p>
632
+ </div>
633
+
634
+ </li>
635
+
636
+ </ul>
637
+
638
+ <p class="tag_title">See Also:</p>
639
+ <ul class="see">
640
+
641
+ <li><a href="https://westus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/DeleteTranscription" target="_parent" title="https://westus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/DeleteTranscription">https://westus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/DeleteTranscription</a></li>
642
+
643
+ </ul>
644
+
645
+ </div><table class="source_code">
646
+ <tr>
647
+ <td>
648
+ <pre class="lines">
649
+
650
+
651
+ 92
652
+ 93
653
+ 94</pre>
654
+ </td>
655
+ <td>
656
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/session.rb', line 92</span>
657
+
658
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete_transcription'>delete_transcription</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
659
+ <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_delete_transcription'>delete_transcription</span><span class='lparen'>(</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span>
660
+ <span class='kw'>end</span></pre>
661
+ </td>
662
+ </tr>
663
+ </table>
556
664
  </div>
557
665
 
558
666
  <div class="method_details ">
@@ -616,7 +724,7 @@
616
724
  <p class="tag_title">See Also:</p>
617
725
  <ul class="see">
618
726
 
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>
727
+ <li><a href="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscription" target="_parent" title="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscription">https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscription</a></li>
620
728
 
621
729
  </ul>
622
730
 
@@ -626,13 +734,13 @@
626
734
  <pre class="lines">
627
735
 
628
736
 
737
+ 58
738
+ 59
629
739
  60
630
- 61
631
- 62
632
- 63</pre>
740
+ 61</pre>
633
741
  </td>
634
742
  <td>
635
- <pre class="code"><span class="info file"># File 'lib/azure_stt/session.rb', line 60</span>
743
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/session.rb', line 58</span>
636
744
 
637
745
  <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
746
  <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>
@@ -721,7 +829,7 @@
721
829
  <p class="tag_title">See Also:</p>
722
830
  <ul class="see">
723
831
 
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>
832
+ <li><a href="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscriptions" target="_parent" title="https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscriptions">https://centralus.dev.cognitive.microsoft.com/docs/services/speech-to-text-api-v3-1/operations/GetTranscriptions</a></li>
725
833
 
726
834
  </ul>
727
835
 
@@ -731,15 +839,15 @@
731
839
  <pre class="lines">
732
840
 
733
841
 
842
+ 74
843
+ 75
734
844
  76
735
845
  77
736
846
  78
737
- 79
738
- 80
739
- 81</pre>
847
+ 79</pre>
740
848
  </td>
741
849
  <td>
742
- <pre class="code"><span class="info file"># File 'lib/azure_stt/session.rb', line 76</span>
850
+ <pre class="code"><span class="info file"># File 'lib/azure_stt/session.rb', line 74</span>
743
851
 
744
852
  <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
853
  <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>
@@ -757,9 +865,9 @@
757
865
  </div>
758
866
 
759
867
  <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).
868
+ Generated on Wed May 10 12:30:20 2023 by
869
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
870
+ 0.9.34 (ruby-2.7.7).
763
871
  </div>
764
872
 
765
873
  </div>