more docs

Econify · May 30, 2024 · 8946849 · 8946849
1 parent cc0964b
commit 8946849
Show file tree

Hide file tree

Showing 75 changed files with 102 additions and 87 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 **a typescript utility library for building LLM applications+agents for node and the browser**
 
+[![Documentation](https://img.shields.io/badge/docs-generative--ts-blue)](https://econify.github.io/generative-ts/)
+
 generative-ts is an unopinionated, web-first utility library for LLM applications. Its core functionality revolves around providing a type-safe interface for interacting with a wide variety of LLM providers using their "native" APIs. It's *not* a heavy abstraction or wrapper around a bunch of existing SDKs. It *is* tiny, portable, and comes with some useful extra features.
 
 ## Features

diff --git a/docs/.nojekyll → docs/api-reference/.nojekyll b/docs/.nojekyll → docs/api-reference/.nojekyll
diff --git a/docs/assets/category-nav.css → docs/api-reference/assets/category-nav.css b/docs/assets/category-nav.css → docs/api-reference/assets/category-nav.css
diff --git a/docs/assets/highlight.css → docs/api-reference/assets/highlight.css b/docs/assets/highlight.css → docs/api-reference/assets/highlight.css
diff --git a/docs/assets/icons.js → docs/api-reference/assets/icons.js b/docs/assets/icons.js → docs/api-reference/assets/icons.js
diff --git a/docs/assets/icons.svg → docs/api-reference/assets/icons.svg b/docs/assets/icons.svg → docs/api-reference/assets/icons.svg
diff --git a/docs/assets/lib/category-nav.js → .../api-reference/assets/lib/category-nav.js b/docs/assets/lib/category-nav.js → .../api-reference/assets/lib/category-nav.js
diff --git a/docs/assets/main.js → docs/api-reference/assets/main.js b/docs/assets/main.js → docs/api-reference/assets/main.js
diff --git a/docs/assets/navigation.js → docs/api-reference/assets/navigation.js b/docs/assets/navigation.js → docs/api-reference/assets/navigation.js
diff --git a/docs/assets/search.js → docs/api-reference/assets/search.js b/docs/assets/search.js → docs/api-reference/assets/search.js
diff --git a/docs/assets/style.css → docs/api-reference/assets/style.css b/docs/assets/style.css → docs/api-reference/assets/style.css
diff --git a/docs/assets/style/category-nav.css → ...i-reference/assets/style/category-nav.css b/docs/assets/style/category-nav.css → ...i-reference/assets/style/category-nav.css
diff --git a/docs/classes/BaseModelProvider.html → ...-reference/classes/BaseModelProvider.html b/docs/classes/BaseModelProvider.html → ...-reference/classes/BaseModelProvider.html
diff --git a/docs/classes/EjsTemplate.html → docs/api-reference/classes/EjsTemplate.html b/docs/classes/EjsTemplate.html → docs/api-reference/classes/EjsTemplate.html
diff --git a/docs/classes/HttpModelProvider.html → ...-reference/classes/HttpModelProvider.html b/docs/classes/HttpModelProvider.html → ...-reference/classes/HttpModelProvider.html
diff --git a/...ctions/createAwsBedrockModelProvider.html → ...ctions/createAwsBedrockModelProvider.html b/...ctions/createAwsBedrockModelProvider.html → ...ctions/createAwsBedrockModelProvider.html
diff --git a/...ions/createCohereLegacyModelProvider.html → ...ions/createCohereLegacyModelProvider.html b/...ions/createCohereLegacyModelProvider.html → ...ions/createCohereLegacyModelProvider.html
diff --git a/docs/functions/createGroqModelProvider.html → ...ce/functions/createGroqModelProvider.html b/docs/functions/createGroqModelProvider.html → ...ce/functions/createGroqModelProvider.html
diff --git a/...ateHuggingfaceInferenceModelProvider.html → ...ateHuggingfaceInferenceModelProvider.html b/...ateHuggingfaceInferenceModelProvider.html → ...ateHuggingfaceInferenceModelProvider.html
diff --git a/...unctions/createLmStudioModelProvider.html → ...unctions/createLmStudioModelProvider.html b/...unctions/createLmStudioModelProvider.html → ...unctions/createLmStudioModelProvider.html
diff --git a/...ctions/createOpenAiChatModelProvider.html → ...ctions/createOpenAiChatModelProvider.html b/...ctions/createOpenAiChatModelProvider.html → ...ctions/createOpenAiChatModelProvider.html
diff --git a/docs/hierarchy.html → docs/api-reference/hierarchy.html b/docs/hierarchy.html → docs/api-reference/hierarchy.html
diff --git a/docs/index.html → docs/api-reference/index.html b/docs/index.html → docs/api-reference/index.html
@@ -1,4 +1,5 @@
 <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>generative-ts - v0.1.0-alpha.5</title><meta name="description" content="Documentation for generative-ts"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script><link rel="stylesheet" href="assets/style/category-nav.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar tsd-navigation__header__toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">generative-ts</a><div class="tsd-navigation__header__toolbar__right"><div id="tsd-toolbar-links"></div><div id="tsd-navigation-theme" class="tsd-navigation__header__toolbar__theme"><div class="theme-normal svg-22"><svg class="icon" viewBox="0 0 1024 1024" xmlns="http://www.w3.org/2000/svg" p-id="4180" width="200" height="200"><path d="M512 938.666667c235.648 0 426.666667-191.018667 426.666667-426.666667S747.648 85.333333 512 85.333333 85.333333 276.352 85.333333 512s191.018667 426.666667 426.666667 426.666667z m0-64v-725.333334a362.666667 362.666667 0 0 1 0 725.333334z" fill="currentColor" p-id="4181"></path></svg></div><div class="theme-os svg-20"><svg class="icon" viewBox="0 0 1024 1024" xmlns="http://www.w3.org/2000/svg" p-id="5207" width="200" height="200"><path d="M338.488889 617.244444h-28.444445l-19.911111-54.044444H210.488889l-19.911111 54.044444h-28.444445l73.955556-193.422222h25.6l76.8 193.422222zM284.444444 540.444444l-28.444444-79.644444-2.844444-14.222222-2.844445 14.222222-28.444444 79.644444H284.444444zM509.155556 537.6c0 54.044444-25.6 82.488889-73.955556 82.488889-48.355556 0-71.111111-25.6-71.111111-79.644445v-119.466666h25.6v116.622222c0 39.822222 17.066667 59.733333 48.355555 59.733333s48.355556-19.911111 48.355556-56.888889v-119.466666h25.6l-2.844444 116.622222zM674.133333 443.733333h-56.888889v173.511111h-25.6v-173.511111h-54.044444v-22.755555h136.533333zM676.977778 520.533333c0-31.288889 8.533333-56.888889 25.6-73.955555 17.066667-19.911111 39.822222-28.444444 68.266666-28.444445 25.6 0 48.355556 8.533333 65.422223 28.444445s25.6 42.666667 25.6 71.111111c0 31.288889-8.533333 56.888889-25.6 73.955555-17.066667 19.911111-39.822222 28.444444-68.266667 28.444445s-48.355556-8.533333-65.422222-28.444445c-17.066667-17.066667-25.6-39.822222-25.6-71.111111z m28.444444 0c0 22.755556 5.688889 42.666667 17.066667 56.888889 11.377778 14.222222 28.444444 22.755556 48.355555 22.755556s36.977778-5.688889 48.355556-19.911111c11.377778-14.222222 17.066667-31.288889 17.066667-56.888889 0-25.6-5.688889-45.511111-17.066667-56.888889-11.377778-14.222222-28.444444-19.911111-48.355556-19.911111s-36.977778 8.533333-48.355555 22.755555c-11.377778 8.533333-17.066667 28.444444-17.066667 51.2z" fill="currentColor" p-id="5208"></path><path d="M992.711111 520.533333c0 133.688889-54.044444 253.155556-142.222222 341.333334-88.177778 88.177778-207.644444 142.222222-338.488889 142.222222s-253.155556-54.044444-338.488889-142.222222-142.222222-207.644444-142.222222-341.333334 54.044444-253.155556 142.222222-341.333333c88.177778-88.177778 207.644444-142.222222 338.488889-142.222222s253.155556 54.044444 338.488889 142.222222 142.222222 207.644444 142.222222 341.333333z m-173.511111 307.2c79.644444-79.644444 128-187.733333 128-307.2s-48.355556-227.555556-128-307.2S634.311111 85.333333 512 85.333333c-119.466667 0-227.555556 48.355556-307.2 128-76.8 76.8-125.155556 184.888889-125.155556 304.355556s48.355556 227.555556 128 307.2c79.644444 79.644444 187.733333 128 307.2 128s227.555556-48.355556 304.355556-125.155556z" fill="currentColor" p-id="5209"></path></svg></div></div></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>generative-ts - v0.1.0-alpha.5</h2></div><div class="tsd-panel tsd-typography"><a id="md:generative-ts" class="tsd-anchor"></a><h1><a href="#md:generative-ts">generative-ts</a></h1><p><strong>a typescript utility library for building LLM applications+agents for node and the browser</strong></p>
+<p><a href="https://econify.github.io/generative-ts/"><img src="https://img.shields.io/badge/docs-generative--ts-blue" alt="Documentation"></a></p>
 <p>generative-ts is an unopinionated, web-first utility library for LLM applications. Its core functionality revolves around providing a type-safe interface for interacting with a wide variety of LLM providers using their &quot;native&quot; APIs. It&#39;s <em>not</em> a heavy abstraction or wrapper around a bunch of existing SDKs. It <em>is</em> tiny, portable, and comes with some useful extra features.</p>
 <a id="md:features" class="tsd-anchor"></a><h2><a href="#md:features">Features</a></h2><ul>
 <li><strong>Simple</strong>: Provides support for many different <a href="#md:model-providers">model providers</a>, giving typesafe interfaces to the APIs as they&#39;re already defined</li>

diff --git a/docs/interfaces/Ai21Jurassic2Options.html → ...ence/interfaces/Ai21Jurassic2Options.html b/docs/interfaces/Ai21Jurassic2Options.html → ...ence/interfaces/Ai21Jurassic2Options.html