feat: add auto-generated docs/pages/docs with all typedoc markdown files

dexaai · Nov 3, 2023 · 36beefc · 36beefc
1 parent 0d08c9c
commit 36beefc
Show file tree

Hide file tree

Showing 121 changed files with 4,432 additions and 0 deletions.
diff --git a/docs/pages/docs/.nojekyll b/docs/pages/docs/.nojekyll
@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
diff --git a/docs/pages/docs/README.md b/docs/pages/docs/README.md
@@ -0,0 +1,14 @@
+<p align="center">
+  <a href="https://www.npmjs.com/package/dexa-ai"><img alt="NPM" src="https://img.shields.io/npm/v/dexa-ai.svg" /></a>
+  <a href="https://github.com/dexaai/llm-tools/actions/workflows/test.yml"><img alt="Build Status" src="https://github.com/dexaai/llm-tools/actions/workflows/main.yml/badge.svg" /></a>
+  <a href="https://github.com/dexaai/llm-tools/blob/main/license"><img alt="MIT License" src="https://img.shields.io/badge/license-MIT-blue" /></a>
+  <a href="https://prettier.io"><img alt="Prettier Code Formatting" src="https://img.shields.io/badge/code_style-prettier-brightgreen.svg" /></a>
+</p>
+
+# LLM Tools
+
+TODO
+
+## License
+
+This project is licensed under MIT © [Dexa AI](https://dexa.ai).
diff --git a/docs/pages/docs/_meta.json b/docs/pages/docs/_meta.json
@@ -0,0 +1,14 @@
+{
+  "exports": "Contents",
+  "namespaces": "Namespaces",
+  "classes": "Classes",
+  "interfaces": "Interfaces",
+  "functions": "Functions",
+  "type-aliases": {
+    "title": "Type Aliases",
+    "display": "hidden"
+  },
+  "README": {
+    "display": "hidden"
+  }
+}
diff --git a/docs/pages/docs/classes/AbstractDatastore.md b/docs/pages/docs/classes/AbstractDatastore.md
@@ -0,0 +1,115 @@
+# Class: `abstract` AbstractDatastore`<DocMeta, Filter>`
+
+## Extended By
+
+- [`AbstractHybridDatastore`](AbstractHybridDatastore.md)
+
+## Type parameters
+
+| Parameter |
+| :------ |
+| `DocMeta` extends [`BaseMeta`](../namespaces/Dstore/type-aliases/BaseMeta.md) |
+| `Filter` extends [`BaseFilter`](../namespaces/Dstore/type-aliases/BaseFilter.md)\<`DocMeta`\> |
+
+## Constructors
+
+### new AbstractDatastore(args)
+
+> **new AbstractDatastore**\<`DocMeta`, `Filter`\>(`args`): [`AbstractDatastore`](AbstractDatastore.md)\<`DocMeta`, `Filter`\>
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `args` | [`Opts`](../namespaces/Dstore/interfaces/Opts.md)\<`DocMeta`, `Filter`\> |
+
+#### Returns
+
+[`AbstractDatastore`](AbstractDatastore.md)\<`DocMeta`, `Filter`\>
+
+#### Source
+
+[src/datastore/datastore.ts:30](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L30)
+
+## Properties
+
+| Modifier | Property | Type | Description | Source |
+| :------ | :------ | :------ | :------ | :------ |
+| `abstract` | `datastoreProvider` | [`Provider`](../namespaces/Dstore/type-aliases/Provider.md) | - | [src/datastore/datastore.ts:21](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L21) |
+| `abstract` | `datastoreType` | [`Type`](../namespaces/Dstore/type-aliases/Type.md) | - | [src/datastore/datastore.ts:20](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L20) |
+
+## Methods
+
+### `abstract` delete()
+
+> **`abstract`** **delete**(`docIds`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `docIds` | `string`[] |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Source
+
+[src/datastore/datastore.ts:17](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L17)
+
+***
+
+### `abstract` deleteAll()
+
+> **`abstract`** **deleteAll**(): `Promise`\<`void`\>
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Source
+
+[src/datastore/datastore.ts:18](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L18)
+
+***
+
+### query()
+
+> **query**(`query`, `context`?): `Promise`\<[`QueryResult`](../namespaces/Dstore/interfaces/QueryResult.md)\<`DocMeta`\>\>
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `query` | [`Query`](../namespaces/Dstore/interfaces/Query.md)\<`DocMeta`, `Filter`\> |
+| `context`? | [`Ctx`](../namespaces/Dstore/type-aliases/Ctx.md) |
+
+#### Returns
+
+`Promise`\<[`QueryResult`](../namespaces/Dstore/interfaces/QueryResult.md)\<`DocMeta`\>\>
+
+#### Source
+
+[src/datastore/datastore.ts:46](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L46)
+
+***
+
+### `abstract` upsert()
+
+> **`abstract`** **upsert**(`docs`, `context`?): `Promise`\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `docs` | [`Doc`](../namespaces/Dstore/interfaces/Doc.md)\<`DocMeta`\>[] |
+| `context`? | [`Ctx`](../namespaces/Dstore/type-aliases/Ctx.md) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Source
+
+[src/datastore/datastore.ts:13](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L13)
diff --git a/docs/pages/docs/classes/AbstractHybridDatastore.md b/docs/pages/docs/classes/AbstractHybridDatastore.md
@@ -0,0 +1,135 @@
+# Class: `abstract` AbstractHybridDatastore`<DocMeta, Filter>`
+
+## Extends
+
+- [`AbstractDatastore`](AbstractDatastore.md)\<`DocMeta`, `Filter`\>
+
+## Type parameters
+
+| Parameter |
+| :------ |
+| `DocMeta` extends [`BaseMeta`](../namespaces/Dstore/type-aliases/BaseMeta.md) |
+| `Filter` extends [`BaseFilter`](../namespaces/Dstore/type-aliases/BaseFilter.md)\<`DocMeta`\> |
+
+## Constructors
+
+### new AbstractHybridDatastore(args)
+
+> **new AbstractHybridDatastore**\<`DocMeta`, `Filter`\>(`args`): [`AbstractHybridDatastore`](AbstractHybridDatastore.md)\<`DocMeta`, `Filter`\>
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `args` | [`OptsHybrid`](../namespaces/Dstore/interfaces/OptsHybrid.md)\<`DocMeta`, `Filter`\> |
+
+#### Returns
+
+[`AbstractHybridDatastore`](AbstractHybridDatastore.md)\<`DocMeta`, `Filter`\>
+
+#### Overrides
+
+[`AbstractDatastore`](AbstractDatastore.md).[`constructor`](AbstractDatastore.md#Constructors)
+
+#### Source
+
+[src/datastore/hybrid-datastore.ts:11](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/hybrid-datastore.ts#L11)
+
+## Properties
+
+| Modifier | Property | Type | Description | Inheritance | Source |
+| :------ | :------ | :------ | :------ | :------ | :------ |
+| `abstract` | `datastoreProvider` | [`Provider`](../namespaces/Dstore/type-aliases/Provider.md) | - | [`AbstractDatastore`](AbstractDatastore.md).`datastoreProvider` | [src/datastore/datastore.ts:21](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L21) |
+| `abstract` | `datastoreType` | [`Type`](../namespaces/Dstore/type-aliases/Type.md) | - | [`AbstractDatastore`](AbstractDatastore.md).`datastoreType` | [src/datastore/datastore.ts:20](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L20) |
+
+## Methods
+
+### `abstract` delete()
+
+> **`abstract`** **delete**(`docIds`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `docIds` | `string`[] |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`AbstractDatastore`](AbstractDatastore.md).[`delete`](AbstractDatastore.md#abstract-delete)
+
+#### Source
+
+[src/datastore/datastore.ts:17](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L17)
+
+***
+
+### `abstract` deleteAll()
+
+> **`abstract`** **deleteAll**(): `Promise`\<`void`\>
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`AbstractDatastore`](AbstractDatastore.md).[`deleteAll`](AbstractDatastore.md#abstract-deleteAll)
+
+#### Source
+
+[src/datastore/datastore.ts:18](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L18)
+
+***
+
+### query()
+
+> **query**(`query`, `context`?): `Promise`\<[`QueryResult`](../namespaces/Dstore/interfaces/QueryResult.md)\<`DocMeta`\>\>
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `query` | [`Query`](../namespaces/Dstore/interfaces/Query.md)\<`DocMeta`, `Filter`\> |
+| `context`? | [`Ctx`](../namespaces/Dstore/type-aliases/Ctx.md) |
+
+#### Returns
+
+`Promise`\<[`QueryResult`](../namespaces/Dstore/interfaces/QueryResult.md)\<`DocMeta`\>\>
+
+#### Inherited from
+
+[`AbstractDatastore`](AbstractDatastore.md).[`query`](AbstractDatastore.md#query)
+
+#### Source
+
+[src/datastore/datastore.ts:46](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L46)
+
+***
+
+### `abstract` upsert()
+
+> **`abstract`** **upsert**(`docs`, `context`?): `Promise`\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| :------ | :------ |
+| `docs` | [`Doc`](../namespaces/Dstore/interfaces/Doc.md)\<`DocMeta`\>[] |
+| `context`? | [`Ctx`](../namespaces/Dstore/type-aliases/Ctx.md) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+#### Inherited from
+
+[`AbstractDatastore`](AbstractDatastore.md).[`upsert`](AbstractDatastore.md#abstract-upsert)
+
+#### Source
+
+[src/datastore/datastore.ts:13](https://github.com/dexaai/llm-tools/blob/0d08c9c/src/datastore/datastore.ts#L13)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.