* bump

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* some fixes

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* YOYO NEW API SPEC!

* reformat

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fixups

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* for now force true

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* run the tests on generations

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* add tests

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* update

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* update

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* update

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* update

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fix some types

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* float to top

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fix mypy

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* more noqa

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fixups

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* ruff pass

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* add docs

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fix

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fix

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fix

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fixes

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* even less mypy errors

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* add test

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fixes

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fixes

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fixups

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fixes

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* cleanup

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fix

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* updates

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fix

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* new path

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* fixes for mypy

Signed-off-by: Jess Frazelle <github@jessfraz.com>

* skip tests

Signed-off-by: Jess Frazelle <github@jessfraz.com>

---------

Signed-off-by: Jess Frazelle <github@jessfraz.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
This commit is contained in:
Jess Frazelle
2023-05-04 00:58:06 -07:00
committed by GitHub
parent 8877a3c146
commit fcd317aae4
3187 changed files with 349073 additions and 84754 deletions

View File

@ -0,0 +1,243 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.ai.create_image_to_3d &mdash; kittycad v0.3.8 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/clipboard.min.js"></script>
<script src="../../../../_static/copybutton.js"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.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 class="version">
v0.3.8
</div>
<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>
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/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="../../../index.html">Module code</a></li>
<li class="breadcrumb-item active">kittycad.api.ai.create_image_to_3d</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">
<h1>Source code for kittycad.api.ai.create_image_to_3d</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
<span class="kn">import</span> <span class="nn">httpx</span>
<span class="kn">from</span> <span class="nn">...client</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="kn">from</span> <span class="nn">...models.error</span> <span class="kn">import</span> <span class="n">Error</span>
<span class="kn">from</span> <span class="nn">...models.file_export_format</span> <span class="kn">import</span> <span class="n">FileExportFormat</span>
<span class="kn">from</span> <span class="nn">...models.image_type</span> <span class="kn">import</span> <span class="n">ImageType</span>
<span class="kn">from</span> <span class="nn">...models.mesh</span> <span class="kn">import</span> <span class="n">Mesh</span>
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_image_to_3d.html#kittycad.api.ai.create_image_to_3d._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
<span class="n">input_format</span><span class="p">:</span> <span class="n">ImageType</span><span class="p">,</span>
<span class="n">output_format</span><span class="p">:</span> <span class="n">FileExportFormat</span><span class="p">,</span>
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{}</span><span class="s2">/ai/image-to-3d/</span><span class="si">{input_format}</span><span class="s2">/</span><span class="si">{output_format}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">client</span><span class="o">.</span><span class="n">base_url</span><span class="p">,</span> <span class="n">input_format</span><span class="o">=</span><span class="n">input_format</span><span class="p">,</span> <span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span>
<span class="p">)</span> <span class="c1"># noqa: E501</span>
<span class="n">headers</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
<span class="n">cookies</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
<span class="k">return</span> <span class="p">{</span>
<span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
<span class="s2">&quot;headers&quot;</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
<span class="s2">&quot;cookies&quot;</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
<span class="s2">&quot;timeout&quot;</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
<span class="s2">&quot;content&quot;</span><span class="p">:</span> <span class="n">body</span><span class="p">,</span>
<span class="p">}</span></div>
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_image_to_3d.html#kittycad.api.ai.create_image_to_3d._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
<span class="n">response_200</span> <span class="o">=</span> <span class="n">Mesh</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_200</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_4XX</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_5XX</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_image_to_3d.html#kittycad.api.ai.create_image_to_3d._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
<span class="n">headers</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>
<span class="n">parsed</span><span class="o">=</span><span class="n">_parse_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">),</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_image_to_3d.sync_detailed.html#kittycad.api.ai.create_image_to_3d.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
<span class="n">input_format</span><span class="p">:</span> <span class="n">ImageType</span><span class="p">,</span>
<span class="n">output_format</span><span class="p">:</span> <span class="n">FileExportFormat</span><span class="p">,</span>
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">input_format</span><span class="o">=</span><span class="n">input_format</span><span class="p">,</span>
<span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
<span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_image_to_3d.sync.html#kittycad.api.ai.create_image_to_3d.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
<span class="n">input_format</span><span class="p">:</span> <span class="n">ImageType</span><span class="p">,</span>
<span class="n">output_format</span><span class="p">:</span> <span class="n">FileExportFormat</span><span class="p">,</span>
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
<span class="n">input_format</span><span class="o">=</span><span class="n">input_format</span><span class="p">,</span>
<span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_image_to_3d.asyncio_detailed.html#kittycad.api.ai.create_image_to_3d.asyncio_detailed">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio_detailed</span><span class="p">(</span>
<span class="n">input_format</span><span class="p">:</span> <span class="n">ImageType</span><span class="p">,</span>
<span class="n">output_format</span><span class="p">:</span> <span class="n">FileExportFormat</span><span class="p">,</span>
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">input_format</span><span class="o">=</span><span class="n">input_format</span><span class="p">,</span>
<span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">async</span> <span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span><span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">)</span> <span class="k">as</span> <span class="n">_client</span><span class="p">:</span>
<span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_image_to_3d.asyncio.html#kittycad.api.ai.create_image_to_3d.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
<span class="n">input_format</span><span class="p">:</span> <span class="n">ImageType</span><span class="p">,</span>
<span class="n">output_format</span><span class="p">:</span> <span class="n">FileExportFormat</span><span class="p">,</span>
<span class="n">body</span><span class="p">:</span> <span class="nb">bytes</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="p">(</span>
<span class="k">await</span> <span class="n">asyncio_detailed</span><span class="p">(</span>
<span class="n">input_format</span><span class="o">=</span><span class="n">input_format</span><span class="p">,</span>
<span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, 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>

View File

@ -0,0 +1,237 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.ai.create_text_to_3d &mdash; kittycad v0.3.8 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/graphviz.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/copybutton.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/autoclasstoc.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../../../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/clipboard.min.js"></script>
<script src="../../../../_static/copybutton.js"></script>
<script src="../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.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 class="version">
v0.3.8
</div>
<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>
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.api.html">kittycad.api</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.client.html">kittycad.client</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/kittycad.models.html">kittycad.models</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_autosummary/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="../../../index.html">Module code</a></li>
<li class="breadcrumb-item active">kittycad.api.ai.create_text_to_3d</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">
<h1>Source code for kittycad.api.ai.create_text_to_3d</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Optional</span><span class="p">,</span> <span class="n">Union</span>
<span class="kn">import</span> <span class="nn">httpx</span>
<span class="kn">from</span> <span class="nn">...client</span> <span class="kn">import</span> <span class="n">Client</span>
<span class="kn">from</span> <span class="nn">...models.error</span> <span class="kn">import</span> <span class="n">Error</span>
<span class="kn">from</span> <span class="nn">...models.file_export_format</span> <span class="kn">import</span> <span class="n">FileExportFormat</span>
<span class="kn">from</span> <span class="nn">...models.mesh</span> <span class="kn">import</span> <span class="n">Mesh</span>
<span class="kn">from</span> <span class="nn">...types</span> <span class="kn">import</span> <span class="n">Response</span>
<div class="viewcode-block" id="_get_kwargs"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_text_to_3d.html#kittycad.api.ai.create_text_to_3d._get_kwargs">[docs]</a><span class="k">def</span> <span class="nf">_get_kwargs</span><span class="p">(</span>
<span class="n">output_format</span><span class="p">:</span> <span class="n">FileExportFormat</span><span class="p">,</span>
<span class="n">prompt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">{}</span><span class="s2">/ai/text-to-3d/</span><span class="si">{output_format}</span><span class="s2">&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">client</span><span class="o">.</span><span class="n">base_url</span><span class="p">,</span> <span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span>
<span class="p">)</span> <span class="c1"># noqa: E501</span>
<span class="k">if</span> <span class="n">prompt</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">if</span> <span class="s2">&quot;?&quot;</span> <span class="ow">in</span> <span class="n">url</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;&amp;prompt=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">prompt</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">url</span> <span class="o">=</span> <span class="n">url</span> <span class="o">+</span> <span class="s2">&quot;?prompt=&quot;</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">prompt</span><span class="p">)</span>
<span class="n">headers</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_headers</span><span class="p">()</span>
<span class="n">cookies</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="n">get_cookies</span><span class="p">()</span>
<span class="k">return</span> <span class="p">{</span>
<span class="s2">&quot;url&quot;</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span>
<span class="s2">&quot;headers&quot;</span><span class="p">:</span> <span class="n">headers</span><span class="p">,</span>
<span class="s2">&quot;cookies&quot;</span><span class="p">:</span> <span class="n">cookies</span><span class="p">,</span>
<span class="s2">&quot;timeout&quot;</span><span class="p">:</span> <span class="n">client</span><span class="o">.</span><span class="n">get_timeout</span><span class="p">(),</span>
<span class="p">}</span></div>
<div class="viewcode-block" id="_parse_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_text_to_3d.html#kittycad.api.ai.create_text_to_3d._parse_response">[docs]</a><span class="k">def</span> <span class="nf">_parse_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">200</span><span class="p">:</span>
<span class="n">response_200</span> <span class="o">=</span> <span class="n">Mesh</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_200</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">400</span><span class="p">:</span>
<span class="n">response_4XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_4XX</span>
<span class="k">if</span> <span class="n">response</span><span class="o">.</span><span class="n">status_code</span> <span class="o">==</span> <span class="mi">500</span><span class="p">:</span>
<span class="n">response_5XX</span> <span class="o">=</span> <span class="n">Error</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
<span class="k">return</span> <span class="n">response_5XX</span>
<span class="k">return</span> <span class="kc">None</span></div>
<div class="viewcode-block" id="_build_response"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_text_to_3d.html#kittycad.api.ai.create_text_to_3d._build_response">[docs]</a><span class="k">def</span> <span class="nf">_build_response</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">response</span><span class="p">:</span> <span class="n">httpx</span><span class="o">.</span><span class="n">Response</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="k">return</span> <span class="n">Response</span><span class="p">(</span>
<span class="n">status_code</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">status_code</span><span class="p">,</span>
<span class="n">content</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">content</span><span class="p">,</span>
<span class="n">headers</span><span class="o">=</span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="p">,</span>
<span class="n">parsed</span><span class="o">=</span><span class="n">_parse_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">),</span>
<span class="p">)</span></div>
<div class="viewcode-block" id="sync_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_text_to_3d.sync_detailed.html#kittycad.api.ai.create_text_to_3d.sync_detailed">[docs]</a><span class="k">def</span> <span class="nf">sync_detailed</span><span class="p">(</span>
<span class="n">output_format</span><span class="p">:</span> <span class="n">FileExportFormat</span><span class="p">,</span>
<span class="n">prompt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
<span class="n">prompt</span><span class="o">=</span><span class="n">prompt</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
<span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">,</span>
<span class="o">**</span><span class="n">kwargs</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="sync"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_text_to_3d.sync.html#kittycad.api.ai.create_text_to_3d.sync">[docs]</a><span class="k">def</span> <span class="nf">sync</span><span class="p">(</span>
<span class="n">output_format</span><span class="p">:</span> <span class="n">FileExportFormat</span><span class="p">,</span>
<span class="n">prompt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="n">sync_detailed</span><span class="p">(</span>
<span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
<span class="n">prompt</span><span class="o">=</span><span class="n">prompt</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
<div class="viewcode-block" id="asyncio_detailed"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_text_to_3d.asyncio_detailed.html#kittycad.api.ai.create_text_to_3d.asyncio_detailed">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio_detailed</span><span class="p">(</span>
<span class="n">output_format</span><span class="p">:</span> <span class="n">FileExportFormat</span><span class="p">,</span>
<span class="n">prompt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Response</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="n">kwargs</span> <span class="o">=</span> <span class="n">_get_kwargs</span><span class="p">(</span>
<span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
<span class="n">prompt</span><span class="o">=</span><span class="n">prompt</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
<span class="p">)</span>
<span class="k">async</span> <span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span><span class="n">verify</span><span class="o">=</span><span class="n">client</span><span class="o">.</span><span class="n">verify_ssl</span><span class="p">)</span> <span class="k">as</span> <span class="n">_client</span><span class="p">:</span>
<span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">_client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="k">return</span> <span class="n">_build_response</span><span class="p">(</span><span class="n">response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span></div>
<div class="viewcode-block" id="asyncio"><a class="viewcode-back" href="../../../../_autosummary/kittycad.api.ai.create_text_to_3d.asyncio.html#kittycad.api.ai.create_text_to_3d.asyncio">[docs]</a><span class="k">async</span> <span class="k">def</span> <span class="nf">asyncio</span><span class="p">(</span>
<span class="n">output_format</span><span class="p">:</span> <span class="n">FileExportFormat</span><span class="p">,</span>
<span class="n">prompt</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
<span class="o">*</span><span class="p">,</span>
<span class="n">client</span><span class="p">:</span> <span class="n">Client</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">Mesh</span><span class="p">,</span> <span class="n">Error</span><span class="p">]]:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;This is an alpha endpoint. It will change in the future. The current output is honestly pretty bad. So if you find this endpoint, you get what you pay for, which currently is nothing. But in the future will be made a lot better.&quot;&quot;&quot;</span> <span class="c1"># noqa: E501</span>
<span class="k">return</span> <span class="p">(</span>
<span class="k">await</span> <span class="n">asyncio_detailed</span><span class="p">(</span>
<span class="n">output_format</span><span class="o">=</span><span class="n">output_format</span><span class="p">,</span>
<span class="n">prompt</span><span class="o">=</span><span class="n">prompt</span><span class="p">,</span>
<span class="n">client</span><span class="o">=</span><span class="n">client</span><span class="p">,</span>
<span class="p">)</span>
<span class="p">)</span><span class="o">.</span><span class="n">parsed</span></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2023, 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>