ByoungSooPark/kittycad.py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
cf7e20536c87cfd3f8708ecd3850f6244803ba76
kittycad.py/docs/html/_autosummary/kittycad.api.ml.create_text_to_cad.sync.html
github-actions[bot] fd5580b061 I HAVE GENERATED YOUR NEW DOCS!
2025-01-07 02:19:42 +00:00

179 lines
15 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta property="og:title" content="kittycad.api.ml.create_text_to_cad.sync" />
<meta property="og:type" content="website" />
<meta property="og:url" content="_autosummary/kittycad.api.ml.create_text_to_cad.sync.html" />
<meta property="og:site_name" content="kittycad" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.ml.create_text_to_cad.sync &mdash; kittycad v0.7.4 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d10597a4" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="../_static/graphviz.css?v=fd3f3429" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/autoclasstoc.css?v=08871587" />
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=f9b80c38"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=f281be69"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="kittycad.api.ml.create_text_to_cad.sync_detailed" href="kittycad.api.ml.create_text_to_cad.sync_detailed.html" />
<link rel="prev" title="kittycad.api.ml.create_text_to_cad.asyncio_detailed" href="kittycad.api.ml.create_text_to_cad.asyncio_detailed.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../index.html" class="icon icon-home">
kittycad
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="kittycad.api.html">kittycad.api</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.api_calls.html">kittycad.api.api_calls</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.api_tokens.html">kittycad.api.api_tokens</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.apps.html">kittycad.api.apps</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.beta.html">kittycad.api.beta</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.constant.html">kittycad.api.constant</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.executor.html">kittycad.api.executor</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.file.html">kittycad.api.file</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.hidden.html">kittycad.api.hidden</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.meta.html">kittycad.api.meta</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="kittycad.api.ml.html">kittycad.api.ml</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.ml.create_kcl_code_completions.html">kittycad.api.ml.create_kcl_code_completions</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad.html">kittycad.api.ml.create_text_to_cad</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad.asyncio.html">kittycad.api.ml.create_text_to_cad.asyncio</a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad.asyncio_detailed.html">kittycad.api.ml.create_text_to_cad.asyncio_detailed</a></li>
<li class="toctree-l4 current"><a class="current reference internal" href="#">kittycad.api.ml.create_text_to_cad.sync</a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad.sync_detailed.html">kittycad.api.ml.create_text_to_cad.sync_detailed</a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad.html#kittycad.api.ml.create_text_to_cad._build_response"><code class="docutils literal notranslate"><span class="pre">_build_response()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad.html#kittycad.api.ml.create_text_to_cad._get_kwargs"><code class="docutils literal notranslate"><span class="pre">_get_kwargs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad.html#kittycad.api.ml.create_text_to_cad._parse_response"><code class="docutils literal notranslate"><span class="pre">_parse_response()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad.html#kittycad.api.ml.create_text_to_cad.asyncio"><code class="docutils literal notranslate"><span class="pre">asyncio()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad.html#kittycad.api.ml.create_text_to_cad.asyncio_detailed"><code class="docutils literal notranslate"><span class="pre">asyncio_detailed()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad.html#kittycad.api.ml.create_text_to_cad.sync"><code class="docutils literal notranslate"><span class="pre">sync()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad.html#kittycad.api.ml.create_text_to_cad.sync_detailed"><code class="docutils literal notranslate"><span class="pre">sync_detailed()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad_iteration.html">kittycad.api.ml.create_text_to_cad_iteration</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.ml.create_text_to_cad_model_feedback.html">kittycad.api.ml.create_text_to_cad_model_feedback</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.ml.get_ml_prompt.html">kittycad.api.ml.get_ml_prompt</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.ml.get_text_to_cad_model_for_user.html">kittycad.api.ml.get_text_to_cad_model_for_user</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.ml.list_ml_prompts.html">kittycad.api.ml.list_ml_prompts</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.ml.list_text_to_cad_models_for_user.html">kittycad.api.ml.list_text_to_cad_models_for_user</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.modeling.html">kittycad.api.modeling</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.oauth2.html">kittycad.api.oauth2</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.orgs.html">kittycad.api.orgs</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.payments.html">kittycad.api.payments</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.service_accounts.html">kittycad.api.service_accounts</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.shortlinks.html">kittycad.api.shortlinks</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.store.html">kittycad.api.store</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.unit.html">kittycad.api.unit</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.users.html">kittycad.api.users</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.client.html">kittycad.client</a></li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.models.html">kittycad.models</a></li>
<li class="toctree-l1"><a class="reference internal" href="kittycad.types.html">kittycad.types</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">kittycad</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="kittycad.api.html">kittycad.api</a></li>
<li class="breadcrumb-item"><a href="kittycad.api.ml.html">kittycad.api.ml</a></li>
<li class="breadcrumb-item"><a href="kittycad.api.ml.create_text_to_cad.html">kittycad.api.ml.create_text_to_cad</a></li>
<li class="breadcrumb-item active">kittycad.api.ml.create_text_to_cad.sync</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="kittycad-api-ml-create-text-to-cad-sync">
<h1>kittycad.api.ml.create_text_to_cad.sync<a class="headerlink" href="#kittycad-api-ml-create-text-to-cad-sync" title="Link to this heading"></a></h1>
<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.</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.13)"><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.13)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]</span></p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="kittycad.api.ml.create_text_to_cad.asyncio_detailed.html" class="btn btn-neutral float-left" title="kittycad.api.ml.create_text_to_cad.asyncio_detailed" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="kittycad.api.ml.create_text_to_cad.sync_detailed.html" class="btn btn-neutral float-right" title="kittycad.api.ml.create_text_to_cad.sync_detailed" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, KittyCAD Team Members.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink