thirdailicensing.html

<!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 name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>thirdai.licensing &mdash; thirdai  documentation</title>
      <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
      <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />

  
      <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=5929fcd5"></script>
      <script src="_static/doctools.js?v=9bcbadda"></script>
      <script src="_static/sphinx_highlight.js?v=dc90522c"></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="prev" title="thirdai.logging" href="thirdailog.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">
            thirdai
              <img src="_static/thirdai_logo.png" class="logo" alt="Logo"/>
          </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"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="thirdaibase.html">thirdai</a></li>
<li class="toctree-l1"><a class="reference internal" href="thirdaineuraldb.html">thirdai.neural_db</a></li>
<li class="toctree-l1"><a class="reference internal" href="thirdaibolt.html">thirdai.bolt</a></li>
<li class="toctree-l1"><a class="reference internal" href="thirdailog.html">thirdai.logging</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">thirdai.licensing</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#thirdai.licensing.LicenseState"><code class="docutils literal notranslate"><span class="pre">LicenseState</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#thirdai.licensing.activate"><code class="docutils literal notranslate"><span class="pre">activate()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#thirdai.licensing.deactivate"><code class="docutils literal notranslate"><span class="pre">deactivate()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#thirdai.licensing.set_path"><code class="docutils literal notranslate"><span class="pre">set_path()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="#thirdai.licensing.start_heartbeat"><code class="docutils literal notranslate"><span class="pre">start_heartbeat()</span></code></a></li>
</ul>
</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">thirdai</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 active">thirdai.licensing</li>
      <li class="wy-breadcrumbs-aside">
            <a href="_sources/thirdailicensing.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="module-thirdai.licensing">
<span id="thirdai-licensing"></span><h1>thirdai.licensing<a class="headerlink" href="#module-thirdai.licensing" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="thirdai.licensing.LicenseState">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">thirdai.licensing.</span></span><span class="sig-name descname"><span class="pre">LicenseState</span></span><a class="headerlink" href="#thirdai.licensing.LicenseState" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pybind11_object</span></code></p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="thirdai.licensing.activate">
<span class="sig-prename descclassname"><span class="pre">thirdai.licensing.</span></span><span class="sig-name descname"><span class="pre">activate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_key</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#thirdai.licensing.activate" title="Link to this definition"></a></dt>
<dd><p>Set a ThirdAI API access key to authenticate future calls to ThirdAI functions.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="thirdai.licensing.deactivate">
<span class="sig-prename descclassname"><span class="pre">thirdai.licensing.</span></span><span class="sig-name descname"><span class="pre">deactivate</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#thirdai.licensing.deactivate" title="Link to this definition"></a></dt>
<dd><p>Deactivate the currently active license. Future calls to ThirdAI functions may fail.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="thirdai.licensing.set_path">
<span class="sig-prename descclassname"><span class="pre">thirdai.licensing.</span></span><span class="sig-name descname"><span class="pre">set_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">license_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">verbose</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#thirdai.licensing.set_path" title="Link to this definition"></a></dt>
<dd><p>Set a license filepath for any future calls to ThirdAI functions.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="thirdai.licensing.start_heartbeat">
<span class="sig-prename descclassname"><span class="pre">thirdai.licensing.</span></span><span class="sig-name descname"><span class="pre">start_heartbeat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">license_server_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">heartbeat_timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#thirdai.licensing.start_heartbeat" title="Link to this definition"></a></dt>
<dd><p>Starts a ThirdAI heartbeat endpoint to remain authenticated for future calls to ThirdAI functions.</p>
</dd></dl>

</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="thirdailog.html" class="btn btn-neutral float-left" title="thirdai.logging" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2022, t.</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>