Regenerate docs

mindsdb · Nov 7, 2023 · 0a20153 · 0a20153
1 parent fc2f2bb
commit 0a20153
Show file tree

Hide file tree

Showing 92 changed files with 2,190 additions and 278 deletions.
diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -7,10 +7,10 @@
     --dark-hl-2: #9CDCFE;
     --light-hl-3: #A31515;
     --dark-hl-3: #CE9178;
-    --light-hl-4: #795E26;
-    --dark-hl-4: #DCDCAA;
-    --light-hl-5: #008000;
-    --dark-hl-5: #6A9955;
+    --light-hl-4: #008000;
+    --dark-hl-4: #6A9955;
+    --light-hl-5: #795E26;
+    --dark-hl-5: #DCDCAA;
     --light-hl-6: #0000FF;
     --dark-hl-6: #569CD6;
     --light-hl-7: #0070C1;

diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/constants.default.html b/docs/classes/constants.default.html
diff --git a/docs/classes/databases_database.default.html b/docs/classes/databases_database.default.html
@@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><span class="target">default</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/database.ts:6</li></ul></aside>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/database.ts#L6">src/databases/database.ts:6</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -73,7 +73,7 @@ <h5>engine: <span class="tsd-signature-type">undefined</span><span class="tsd-si
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <a href="databases_database.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/database.ts:26</li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/database.ts#L26">src/databases/database.ts:26</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="databasesApiClient" class="tsd-anchor"></a>
@@ -82,28 +82,28 @@ <h3 class="tsd-anchor-link"><span>databases<wbr/>Api<wbr/>Client</span><a href="
 <div class="tsd-comment tsd-typography"><p>API client to use for executing database operations.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/database.ts:8</li></ul></aside></section>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/database.ts#L8">src/databases/database.ts:8</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="engine" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>engine</span><a href="#engine" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">engine<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>Engine used to create the database (e.g. postgres).</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/database.ts:17</li></ul></aside></section>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/database.ts#L17">src/databases/database.ts:17</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="name" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>Name of the database.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/database.ts:11</li></ul></aside></section>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/database.ts#L11">src/databases/database.ts:11</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="type" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <div class="tsd-signature">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"><p>Type of the database (e.g. project, data).</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/database.ts:14</li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/database.ts#L14">src/databases/database.ts:14</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="delete" class="tsd-anchor"></a>
@@ -119,7 +119,7 @@ <h3>Throws</h3><ul>
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/database.ts:41</li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/database.ts#L41">src/databases/database.ts:41</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -150,6 +150,10 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
 <li class="tsd-kind-module"><a href="../modules/errors.html">errors</a></li>
 <li class="tsd-kind-module"><a href="../modules/httpAuthenticator.html">http<wbr/>Authenticator</a></li>
 <li class="tsd-kind-module"><a href="../modules/index.html">index</a></li>
+<li class="tsd-kind-module"><a href="../modules/ml_engines_ml_engine.html">ml_<wbr/>engines/ml_<wbr/>engine</a></li>
+<li class="tsd-kind-module"><a href="../modules/ml_engines_ml_enginesApiClient.html">ml_<wbr/>engines/ml_<wbr/>engines<wbr/>Api<wbr/>Client</a></li>
+<li class="tsd-kind-module"><a href="../modules/ml_engines_ml_enginesModule.html">ml_<wbr/>engines/ml_<wbr/>engines<wbr/>Module</a></li>
+<li class="tsd-kind-module"><a href="../modules/ml_engines_ml_enginesRestApiClient.html">ml_<wbr/>engines/ml_<wbr/>engines<wbr/>Rest<wbr/>Api<wbr/>Client</a></li>
 <li class="tsd-kind-module"><a href="../modules/models_model.html">models/model</a></li>
 <li class="tsd-kind-module"><a href="../modules/models_modelsApiClient.html">models/models<wbr/>Api<wbr/>Client</a></li>
 <li class="tsd-kind-module"><a href="../modules/models_modelsModule.html">models/models<wbr/>Module</a></li>

diff --git a/docs/classes/databases_databasesApiClient.default.html b/docs/classes/databases_databasesApiClient.default.html
@@ -26,7 +26,7 @@ <h4>Hierarchy</h4>
 <ul class="tsd-hierarchy">
 <li><a href="databases_databasesRestApiClient.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/databasesApiClient.ts:7</li></ul></aside>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/databasesApiClient.ts#L7">src/databases/databasesApiClient.ts:7</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -85,7 +85,7 @@ <h5><code class="tsd-tag ts-flagOptional">Optional</code> params: <span class="t
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="databases_database.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/databasesApiClient.ts:29</li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/databasesApiClient.ts#L29">src/databases/databasesApiClient.ts:29</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="deleteDatabase" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>delete<wbr/>Database</span><a href="#deleteDatabase" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -106,7 +106,7 @@ <h5>name: <span class="tsd-signature-type">string</span></h5>
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/databasesApiClient.ts:40</li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/databasesApiClient.ts#L40">src/databases/databasesApiClient.ts:40</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAllDatabases" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>get<wbr/>All<wbr/>Databases</span><a href="#getAllDatabases" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -120,7 +120,7 @@ <h3>Returns</h3><ul>
 </div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="databases_database.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/databasesApiClient.ts:12</li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/databasesApiClient.ts#L12">src/databases/databasesApiClient.ts:12</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getDatabase" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagAbstract">Abstract</code> <span>get<wbr/>Database</span><a href="#getDatabase" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -141,7 +141,7 @@ <h5>name: <span class="tsd-signature-type">string</span></h5>
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="databases_database.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in src/databases/databasesApiClient.ts:19</li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/mindsdb/mindsdb-js-sdk/blob/fc2f2bb/src/databases/databasesApiClient.ts#L19">src/databases/databasesApiClient.ts:19</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -172,6 +172,10 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.9389
 <li class="tsd-kind-module"><a href="../modules/errors.html">errors</a></li>
 <li class="tsd-kind-module"><a href="../modules/httpAuthenticator.html">http<wbr/>Authenticator</a></li>
 <li class="tsd-kind-module"><a href="../modules/index.html">index</a></li>
+<li class="tsd-kind-module"><a href="../modules/ml_engines_ml_engine.html">ml_<wbr/>engines/ml_<wbr/>engine</a></li>
+<li class="tsd-kind-module"><a href="../modules/ml_engines_ml_enginesApiClient.html">ml_<wbr/>engines/ml_<wbr/>engines<wbr/>Api<wbr/>Client</a></li>
+<li class="tsd-kind-module"><a href="../modules/ml_engines_ml_enginesModule.html">ml_<wbr/>engines/ml_<wbr/>engines<wbr/>Module</a></li>
+<li class="tsd-kind-module"><a href="../modules/ml_engines_ml_enginesRestApiClient.html">ml_<wbr/>engines/ml_<wbr/>engines<wbr/>Rest<wbr/>Api<wbr/>Client</a></li>
 <li class="tsd-kind-module"><a href="../modules/models_model.html">models/model</a></li>
 <li class="tsd-kind-module"><a href="../modules/models_modelsApiClient.html">models/models<wbr/>Api<wbr/>Client</a></li>
 <li class="tsd-kind-module"><a href="../modules/models_modelsModule.html">models/models<wbr/>Module</a></li>