RubyGems - azure_stt - Versions diffs - 0.3.0 → 0.4.0 - Mend

azure_stt 0.3.0 → 0.4.0

Files changed (51) hide show

checksums.yaml +4 -4
data/.github/workflows/ci.yml +1 -1
data/CHANGELOG.md +10 -1
data/Gemfile +1 -0
data/README.md +2 -2
data/azure_stt.gemspec +2 -2
data/docs/AzureSTT/Client.html +148 -39
data/docs/AzureSTT/Configuration.html +4 -4
data/docs/AzureSTT/Error.html +4 -170
data/docs/AzureSTT/Models/Base.html +4 -4
data/docs/AzureSTT/Models/CombinedRecognizedPhrases.html +4 -4
data/docs/AzureSTT/Models/File.html +5 -5
data/docs/AzureSTT/Models/RecognizedPhrase.html +4 -4
data/docs/AzureSTT/Models/Report.html +4 -4
data/docs/AzureSTT/Models/Result.html +4 -4
data/docs/AzureSTT/Models/Sentence.html +4 -4
data/docs/AzureSTT/Models/Transcription.html +5 -5
data/docs/AzureSTT/Models/Word.html +4 -4
data/docs/AzureSTT/Models.html +4 -4
data/docs/AzureSTT/NetError.html +161 -11
data/docs/AzureSTT/Parsers/Base.html +4 -4
data/docs/AzureSTT/Parsers/CombinedRecognizedPhrases.html +4 -4
data/docs/AzureSTT/Parsers/File.html +4 -4
data/docs/AzureSTT/Parsers/RecognizedPhrase.html +4 -4
data/docs/AzureSTT/Parsers/Report.html +4 -4
data/docs/AzureSTT/Parsers/Result.html +4 -4
data/docs/AzureSTT/Parsers/Sentence.html +4 -4
data/docs/AzureSTT/Parsers/Transcription.html +4 -4
data/docs/AzureSTT/Parsers/Word.html +4 -4
data/docs/AzureSTT/Parsers.html +4 -4
data/docs/AzureSTT/ServiceError.html +161 -11
data/docs/AzureSTT/Session.html +132 -24
data/docs/AzureSTT/Types.html +4 -4
data/docs/AzureSTT.html +4 -4
data/docs/AzureStt_.html +5 -5
data/docs/_index.html +5 -5
data/docs/file.README.html +133 -95
data/docs/frames.html +1 -1
data/docs/index.html +133 -95
data/docs/method_list.html +66 -34
data/docs/top-level-namespace.html +4 -4
data/lib/azure_stt/client.rb +9 -8
data/lib/azure_stt/errors.rb +16 -9
data/lib/azure_stt/models/file.rb +1 -1
data/lib/azure_stt/models/transcription.rb +1 -1
data/lib/azure_stt/session.rb +4 -4
data/lib/azure_stt/version.rb +1 -1
metadata +4 -7
data/docs/AzureBatchTranscription/Configuration.html +0 -212
data/docs/AzureBatchTranscription.html +0 -301
data/docs/AzureSTT/Transcription.html +0 -635

data/docs/AzureSTT/Transcription.html DELETED Viewed

@@ -1,635 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Class: AzureSTT::Transcription
-    &mdash; Documentation by YARD 0.9.26
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" />
-<script type="text/javascript">
-  pathId = "AzureSTT::Transcription";
-  relpath = '../';
-</script>
-  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="../class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="../_index.html">Index (T)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../AzureSTT.html" title="AzureSTT (module)">AzureSTT</a></span></span>
-     &raquo;
-    <span class="title">Transcription</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Class: AzureSTT::Transcription
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName"><span class='object_link'><a href="Models/Base.html" title="AzureSTT::Models::Base (class)">Models::Base</a></span></span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">Dry::Struct</li>
-            <li class="next"><span class='object_link'><a href="Models/Base.html" title="AzureSTT::Models::Base (class)">Models::Base</a></span></li>
-            <li class="next">AzureSTT::Transcription</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-    </dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/azure_stt/transcription.rb</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>Model for a transcription. Contains the results and static methods to create and retrieve the transcriptions.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-    <h2>
-      Instance Method Summary
-      <small><a href="#" class="summary_toggle">collapse</a></small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#failed%3F-instance_method" title="#failed? (instance method)">#<strong>failed?</strong>  &#x21d2; Boolean </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Is the status is failed ?.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#finished%3F-instance_method" title="#finished? (instance method)">#<strong>finished?</strong>  &#x21d2; Boolean </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Is the process finished ? (Succeeded or failed).</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#report-instance_method" title="#report (instance method)">#<strong>report</strong>  &#x21d2; Models::Report </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Get the report of a transcription from transcriptions/id/files route.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#results-instance_method" title="#results (instance method)">#<strong>results</strong>  &#x21d2; Array[Models::Result] </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Get the results of a transcription.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#running%3F-instance_method" title="#running? (instance method)">#<strong>running?</strong>  &#x21d2; Boolean </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Is the process still running ?.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#succeeded%3F-instance_method" title="#succeeded? (instance method)">#<strong>succeeded?</strong>  &#x21d2; Boolean </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Has the process succeeded ?.</p>
-</div></span>
-</li>
-    </ul>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="failed?-instance_method">
-    #<strong>failed?</strong>  &#x21d2; <tt>Boolean</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Is the status is failed ?</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-35
-36
-37</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/transcription.rb', line 35</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_failed?'>failed?</span>
-  <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>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="finished?-instance_method">
-    #<strong>finished?</strong>  &#x21d2; <tt>Boolean</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Is the process finished ? (Succeeded or failed)</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-53
-54
-55</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/transcription.rb', line 53</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_finished?'>finished?</span>
-  <span class='id identifier rubyid_succeeded?'>succeeded?</span> <span class='op'>||</span> <span class='id identifier rubyid_failed?'>failed?</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="report-instance_method">
-    #<strong>report</strong>  &#x21d2; <tt><span class='object_link'><a href="Models/Report.html" title="AzureSTT::Models::Report (class)">Models::Report</a></span></tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Get the report of a transcription from transcriptions/id/files route</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="Models/Report.html" title="AzureSTT::Models::Report (class)">Models::Report</a></span></tt>)</span>
-    </li>
-</ul>
-  <p class="tag_title">See Also:</p>
-  <ul class="see">
-      <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>
-  </ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-64
-65
-66</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/transcription.rb', line 64</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_report'>report</span>
-  <span class='ivar'>@report</span> <span class='op'>||=</span> <span class='id identifier rubyid_retrieve_report'>retrieve_report</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="results-instance_method">
-    #<strong>results</strong>  &#x21d2; <tt>Array[<span class='object_link'><a href="Models/Result.html" title="AzureSTT::Models::Result (class)">Models::Result</a></span>]</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<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>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Array[<span class='object_link'><a href="Models/Result.html" title="AzureSTT::Models::Result (class)">Models::Result</a></span>]</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-75
-76
-77</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/transcription.rb', line 75</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_results'>results</span>
-  <span class='ivar'>@results</span> <span class='op'>||=</span> <span class='id identifier rubyid_retrieve_results'>retrieve_results</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="running?-instance_method">
-    #<strong>running?</strong>  &#x21d2; <tt>Boolean</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Is the process still running ?</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-26
-27
-28</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/transcription.rb', line 26</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_running?'>running?</span>
-  <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>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="succeeded?-instance_method">
-    #<strong>succeeded?</strong>  &#x21d2; <tt>Boolean</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Has the process succeeded ?</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-44
-45
-46</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/azure_stt/transcription.rb', line 44</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_succeeded?'>succeeded?</span>
-  <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>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Wed Jun 23 17:42:59 2021 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.26 (ruby-2.6.6).
-</div>
-    </div>
-  </body>
-</html>