ByoungSooPark/kittycad.py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

I HAVE GENERATED YOUR NEW DOCS!

Browse Source
This commit is contained in:
github-actions[bot]
2024-10-02 21:22:42 +00:00
parent c582a0c2eb
commit ea52adf049
2030 changed files with 23637 additions and 13065 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/html/_autosummary/kittycad.api.ml.create_text_to_cad.html
View File

@ -185,9 +185,9 @@
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.ml.create_text_to_cad.asyncio">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.api.ml.create_text_to_cad.</span></span><span class="sig-name descname"><span class="pre">asyncio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kcl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/ml/create_text_to_cad.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/ml/create_text_to_cad.html#asyncio"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.ml.create_text_to_cad.asyncio" title="Link to this definition"></a></dt>
<dd><p>Because our source of truth for the resulting model is a STEP file, you will always have STEP file contents when you list your generated models. Any other formats you request here will also be returned when you list your generated models.
This operation is performed asynchronously, the <a class="reference internal" href="kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title="kittycad.models.api_call_with_price.ApiCallWithPrice.id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">id</span></code></a> of the operation will be returned. You can use the <a class="reference internal" href="kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title="kittycad.models.api_call_with_price.ApiCallWithPrice.id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">id</span></code></a> returned from the request to get status information about the async operation from the <code class="xref any docutils literal notranslate"><span class="pre">/async/operations/{id}</span></code> endpoint.
One thing to note, if you hit the cache, this endpoint will return right away. So you only have to wait if the status is not <code class="xref any docutils literal notranslate"><span class="pre">Completed</span></code> or <code class="xref any docutils literal notranslate"><span class="pre">Failed</span></code>.</p>
<dd><p>Because our source of truth for the resulting model is a STEP file, you will always have STEP file contents when you list your generated models. Any other formats you request here will also be returned when you list your generated models.</p>
<p>This operation is performed asynchronously, the <a class="reference internal" href="kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title="kittycad.models.api_call_with_price.ApiCallWithPrice.id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">id</span></code></a> of the operation will be returned. You can use the <a class="reference internal" href="kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title="kittycad.models.api_call_with_price.ApiCallWithPrice.id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">id</span></code></a> returned from the request to get status information about the async operation from the <code class="xref any docutils literal notranslate"><span class="pre">/async/operations/{id}</span></code> endpoint.</p>
<p>One thing to note, if you hit the cache, this endpoint will return right away. So you only have to wait if the status is not <code class="xref any docutils literal notranslate"><span class="pre">Completed</span></code> or <code class="xref any docutils literal notranslate"><span class="pre">Failed</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference internal" href="kittycad.models.text_to_cad.TextToCad.html#kittycad.models.text_to_cad.TextToCad" title="kittycad.models.text_to_cad.TextToCad"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextToCad</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</span></p>
@ -208,9 +208,9 @@ One thing to note, if you hit the cache, this endpoint will return right away. S
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.ml.create_text_to_cad.sync">
<span class="sig-prename descclassname"><span class="pre">kittycad.api.ml.create_text_to_cad.</span></span><span class="sig-name descname"><span class="pre">sync</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_format</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kcl</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/ml/create_text_to_cad.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/ml/create_text_to_cad.html#sync"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.ml.create_text_to_cad.sync" title="Link to this definition"></a></dt>
<dd><p>Because our source of truth for the resulting model is a STEP file, you will always have STEP file contents when you list your generated models. Any other formats you request here will also be returned when you list your generated models.
This operation is performed asynchronously, the <a class="reference internal" href="kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title="kittycad.models.api_call_with_price.ApiCallWithPrice.id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">id</span></code></a> of the operation will be returned. You can use the <a class="reference internal" href="kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title="kittycad.models.api_call_with_price.ApiCallWithPrice.id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">id</span></code></a> returned from the request to get status information about the async operation from the <code class="xref any docutils literal notranslate"><span class="pre">/async/operations/{id}</span></code> endpoint.
One thing to note, if you hit the cache, this endpoint will return right away. So you only have to wait if the status is not <code class="xref any docutils literal notranslate"><span class="pre">Completed</span></code> or <code class="xref any docutils literal notranslate"><span class="pre">Failed</span></code>.</p>
<dd><p>Because our source of truth for the resulting model is a STEP file, you will always have STEP file contents when you list your generated models. Any other formats you request here will also be returned when you list your generated models.</p>
<p>This operation is performed asynchronously, the <a class="reference internal" href="kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title="kittycad.models.api_call_with_price.ApiCallWithPrice.id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">id</span></code></a> of the operation will be returned. You can use the <a class="reference internal" href="kittycad.models.api_call_with_price.ApiCallWithPrice.html#kittycad.models.api_call_with_price.ApiCallWithPrice.id" title="kittycad.models.api_call_with_price.ApiCallWithPrice.id"><code class="xref any py py-attr docutils literal notranslate"><span class="pre">id</span></code></a> returned from the request to get status information about the async operation from the <code class="xref any docutils literal notranslate"><span class="pre">/async/operations/{id}</span></code> endpoint.</p>
<p>One thing to note, if you hit the cache, this endpoint will return right away. So you only have to wait if the status is not <code class="xref any docutils literal notranslate"><span class="pre">Completed</span></code> or <code class="xref any docutils literal notranslate"><span class="pre">Failed</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference internal" href="kittycad.models.text_to_cad.TextToCad.html#kittycad.models.text_to_cad.TextToCad" title="kittycad.models.text_to_cad.TextToCad"><code class="xref py py-class docutils literal notranslate"><span class="pre">TextToCad</span></code></a>, <a class="reference internal" href="kittycad.models.error.Error.html#kittycad.models.error.Error" title="kittycad.models.error.Error"><code class="xref py py-class docutils literal notranslate"><span class="pre">Error</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</span></p>