Skip to content

Commit

Permalink
deploy: 3e377f5
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Sep 26, 2024
1 parent 826d2c7 commit 651d0fa
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 6 deletions.
4 changes: 4 additions & 0 deletions api-reference-docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,10 @@ <h2 id="S">S</h2>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="models.html#model.ImageQuery.text">text (model.ImageQuery attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="models.html#model.Detector.type">type (model.Detector attribute)</a>

Expand Down
44 changes: 40 additions & 4 deletions api-reference-docs/models.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@
<li class="toctree-l3"><a class="reference internal" href="#model.ImageQuery.result"><code class="docutils literal notranslate"><span class="pre">ImageQuery.result</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#model.ImageQuery.result_type"><code class="docutils literal notranslate"><span class="pre">ImageQuery.result_type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#model.ImageQuery.rois"><code class="docutils literal notranslate"><span class="pre">ImageQuery.rois</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#model.ImageQuery.text"><code class="docutils literal notranslate"><span class="pre">ImageQuery.text</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#model.ImageQuery.type"><code class="docutils literal notranslate"><span class="pre">ImageQuery.type</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#model.ImageQuery.model_computed_fields"><code class="docutils literal notranslate"><span class="pre">ImageQuery.model_computed_fields</span></code></a></li>
</ul>
Expand Down Expand Up @@ -1367,6 +1368,18 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;An array of regions of interest (bounding boxes) collected on image&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Rois&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;text&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;anyOf&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;null&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;A text field on image query.&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Text&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;$defs&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
Expand Down Expand Up @@ -1499,7 +1512,8 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
<span class="w"> </span><span class="nt">&quot;ResultTypeEnum&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enum&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="s2">&quot;binary_classification&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;counting&quot;</span>
<span class="w"> </span><span class="s2">&quot;counting&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;multi_classification&quot;</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ResultTypeEnum&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span>
Expand All @@ -1516,7 +1530,8 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
<span class="w"> </span><span class="s2">&quot;result&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;patience_time&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;confidence_threshold&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;rois&quot;</span>
<span class="w"> </span><span class="s2">&quot;rois&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;text&quot;</span>
<span class="w"> </span><span class="p">]</span>
<span class="p">}</span>
</pre></div>
Expand All @@ -1534,6 +1549,7 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
<li><p><a class="reference internal" href="#model.ImageQuery.result" title="model.ImageQuery.result"><code class="xref py py-obj docutils literal notranslate"><span class="pre">result</span> <span class="pre">(model.BinaryClassificationResult</span> <span class="pre">|</span> <span class="pre">model.CountingResult</span> <span class="pre">|</span> <span class="pre">None)</span></code></a></p></li>
<li><p><a class="reference internal" href="#model.ImageQuery.result_type" title="model.ImageQuery.result_type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">result_type</span> <span class="pre">(model.ResultTypeEnum)</span></code></a></p></li>
<li><p><a class="reference internal" href="#model.ImageQuery.rois" title="model.ImageQuery.rois"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rois</span> <span class="pre">(List[model.ROI]</span> <span class="pre">|</span> <span class="pre">None)</span></code></a></p></li>
<li><p><a class="reference internal" href="#model.ImageQuery.text" title="model.ImageQuery.text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">text</span> <span class="pre">(str</span> <span class="pre">|</span> <span class="pre">None)</span></code></a></p></li>
<li><p><a class="reference internal" href="#model.ImageQuery.type" title="model.ImageQuery.type"><code class="xref py py-obj docutils literal notranslate"><span class="pre">type</span> <span class="pre">(model.ImageQueryTypeEnum)</span></code></a></p></li>
</ul>
</dd>
Expand Down Expand Up @@ -1598,6 +1614,12 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
<dd><p>An array of regions of interest (bounding boxes) collected on image</p>
</dd></dl>

<dl class="py attribute pydantic_field">
<dt class="sig sig-object py" id="model.ImageQuery.text">
<em class="property"><span class="pre">field</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">text</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"> <span class="pre">[Required]</span></em><a class="headerlink" href="#model.ImageQuery.text" title="Link to this definition"></a></dt>
<dd><p>A text field on image query.</p>
</dd></dl>

<dl class="py attribute pydantic_field">
<dt class="sig sig-object py" id="model.ImageQuery.type">
<em class="property"><span class="pre">field</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">type</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">ImageQueryTypeEnum</span></em><em class="property"> <span class="pre">[Required]</span></em><a class="headerlink" href="#model.ImageQuery.type" title="Link to this definition"></a></dt>
Expand Down Expand Up @@ -2046,6 +2068,18 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;An array of regions of interest (bounding boxes) collected on image&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Rois&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;text&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;anyOf&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;null&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;A text field on image query.&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Text&quot;</span>
<span class="w"> </span><span class="p">}</span>
<span class="w"> </span><span class="p">},</span>
<span class="w"> </span><span class="nt">&quot;required&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
Expand All @@ -2059,7 +2093,8 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
<span class="w"> </span><span class="s2">&quot;result&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;patience_time&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;confidence_threshold&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;rois&quot;</span>
<span class="w"> </span><span class="s2">&quot;rois&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;text&quot;</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ImageQuery&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;object&quot;</span>
Expand Down Expand Up @@ -2100,7 +2135,8 @@ <h1>API Response Objects<a class="headerlink" href="#api-response-objects" title
<span class="w"> </span><span class="nt">&quot;ResultTypeEnum&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="nt">&quot;enum&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span>
<span class="w"> </span><span class="s2">&quot;binary_classification&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;counting&quot;</span>
<span class="w"> </span><span class="s2">&quot;counting&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="s2">&quot;multi_classification&quot;</span>
<span class="w"> </span><span class="p">],</span>
<span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ResultTypeEnum&quot;</span><span class="p">,</span>
<span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;string&quot;</span>
Expand Down
Binary file modified api-reference-docs/objects.inv
View file
Binary file not shown.
Loading

0 comments on commit 651d0fa

Please sign in to comment.