@isdk/ai-tool 0.2.0 → 0.2.1

package/docs/classes/PromptTemplate.md

@@ -1,92 +1,33 @@
-[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / PromptTemplate
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / PromptTemplate
 
 # Class: PromptTemplate
 
-## Hierarchy
+## Extends
 
 - `BaseFactory`
 
-  ↳ **`PromptTemplate`**
-
-  ↳↳ [`HfPromptTemplate`](HfPromptTemplate.md)
-
-  ↳↳ [`FStringPromptTemplate`](FStringPromptTemplate.md)
-
-  ↳↳ [`GolangPromptTemplate`](GolangPromptTemplate.md)
-
-  ↳↳ [`FewShotPromptTemplate`](FewShotPromptTemplate.md)
-
-## Table of contents
-
-### Constructors
-
-- [constructor](PromptTemplate.md#constructor)
-
-### Properties
-
-- [compiledTemplate](PromptTemplate.md#compiledtemplate)
-- [data](PromptTemplate.md#data)
-- [inputVariables](PromptTemplate.md#inputvariables)
-- [template](PromptTemplate.md#template)
-- [templateFormat](PromptTemplate.md#templateformat)
-- [\_Factory](PromptTemplate.md#_factory)
-- [\_aliases](PromptTemplate.md#_aliases)
-- [\_baseNameOnly](PromptTemplate.md#_basenameonly)
-- [\_children](PromptTemplate.md#_children)
-
-### Accessors
-
-- [Factory](PromptTemplate.md#factory)
-- [aliases](PromptTemplate.md#aliases)
-
-### Methods
-
-- [\_format](PromptTemplate.md#_format)
-- [\_initialize](PromptTemplate.md#_initialize)
-- [filterData](PromptTemplate.md#filterdata)
-- [format](PromptTemplate.md#format)
-- [initialize](PromptTemplate.md#initialize)
-- [partial](PromptTemplate.md#partial)
-- [toJSON](PromptTemplate.md#tojson)
-- [\_findRootFactory](PromptTemplate.md#_findrootfactory)
-- [\_get](PromptTemplate.md#_get)
-- [\_register](PromptTemplate.md#_register)
-- [cleanAliases](PromptTemplate.md#cleanaliases)
-- [createObject](PromptTemplate.md#createobject)
-- [findRootFactory](PromptTemplate.md#findrootfactory)
-- [forEach](PromptTemplate.md#foreach)
-- [format](PromptTemplate.md#format-1)
-- [formatIf](PromptTemplate.md#formatif)
-- [formatName](PromptTemplate.md#formatname)
-- [formatNameFromClass](PromptTemplate.md#formatnamefromclass)
-- [from](PromptTemplate.md#from)
-- [get](PromptTemplate.md#get)
-- [getAliases](PromptTemplate.md#getaliases)
-- [getDisplayName](PromptTemplate.md#getdisplayname)
-- [getNameFrom](PromptTemplate.md#getnamefrom)
-- [getRealName](PromptTemplate.md#getrealname)
-- [getRealNameFromAlias](PromptTemplate.md#getrealnamefromalias)
-- [isTemplate](PromptTemplate.md#istemplate)
-- [register](PromptTemplate.md#register)
-- [registeredClass](PromptTemplate.md#registeredclass)
-- [removeAlias](PromptTemplate.md#removealias)
-- [setAlias](PromptTemplate.md#setalias)
-- [setAliases](PromptTemplate.md#setaliases)
-- [setDisplayName](PromptTemplate.md#setdisplayname)
-- [unregister](PromptTemplate.md#unregister)
+## Extended by
+
+- [`HfPromptTemplate`](HfPromptTemplate.md)
+- [`FStringPromptTemplate`](FStringPromptTemplate.md)
+- [`GolangPromptTemplate`](GolangPromptTemplate.md)
+- [`FewShotPromptTemplate`](FewShotPromptTemplate.md)
 
 ## Constructors
 
-### constructor
+### new PromptTemplate()
 
-• **new PromptTemplate**(`template?`, `options?`): [`PromptTemplate`](PromptTemplate.md)
+> **new PromptTemplate**(`template`?, `options`?): [`PromptTemplate`](PromptTemplate.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `template?` | `string` \| [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) |
-| `options?` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) |
+• **template?**: `string` \| [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+
+• **options?**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
@@ -94,108 +35,88 @@
 
 #### Overrides
 
-BaseFactory.constructor
+`BaseFactory.constructor`
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L69)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L69)
 
 ## Properties
 
 ### compiledTemplate
 
-• **compiledTemplate**: `any`
+> **compiledTemplate**: `any`
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L21)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L21)
 
-___
+***
 
 ### data
 
-• **data**: `undefined` \| `Record`\<`string`, `any`\>
+> **data**: `undefined` \| `Record`\<`string`, `any`\>
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L24)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L24)
 
-___
+***
 
 ### inputVariables
 
-• **inputVariables**: `undefined` \| `string`[]
+> **inputVariables**: `undefined` \| `string`[]
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L25)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L25)
 
-___
+***
 
 ### template
 
-• **template**: `string`
+> **template**: `string`
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L22)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L22)
 
-___
+***
 
 ### templateFormat
 
-• **templateFormat**: `undefined` \| `string`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L23)
-
-___
-
-### \_Factory
-
-▪ `Static` **\_Factory**: typeof `BaseFactory`
-
-The Root Factory class
-
-**`Name`**
-
-_Factory
-
-**`Abstract`**
-
-#### Inherited from
-
-BaseFactory.\_Factory
+> **templateFormat**: `undefined` \| `string`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:41
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L23)
 
-___
+***
 
 ### \_aliases
 
-▪ `Static` **\_aliases**: [alias: string]
+> `abstract` `static` **\_aliases**: [`string`]
+
+**`Internal`**
 
 the registered alias items object.
 the key is alias name, the value is the registered name
 
-**`Abstract`**
-
 #### Inherited from
 
-BaseFactory.\_aliases
+`BaseFactory._aliases`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:59
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:59
 
-___
+***
 
 ### \_baseNameOnly
 
-▪ `Static` **\_baseNameOnly**: `number`
+> `static` **\_baseNameOnly**: `number`
+
+**`Internal`**
 
 Extracts a specified number of words from a PascalCase class name to use as a base name for registration,
 only if no `name` is specified. The parameter value indicates the maximum depth of the word extraction.
@@ -205,7 +126,7 @@ The baseNameOnly parameter is a number that specifies which words to extract fro
 If the value is 1, it extracts the first word, 2 extracts the first two words, and 0 uses the entire class name.
 The base name is used to register the class to the factory.
 
-**`Example`**
+#### Example
 
 ```ts
 such as "JsonTextCodec" if baseNameOnly is 1, the first word "Json" will be extracted from "JsonTextCodec" as
@@ -213,11 +134,11 @@ such as "JsonTextCodec" if baseNameOnly is 1, the first word "Json" will be extr
   baseNameOnly is 0, the entire class name "JsonTextCodec" will be used as the base name.
 ```
 
-**`Name`**
+#### Name
 
 _baseNameOnly
 
-**`Default`**
+#### Default
 
 ```ts
 1
@@ -226,109 +147,115 @@ _baseNameOnly
 
 #### Inherited from
 
-BaseFactory.\_baseNameOnly
+`BaseFactory._baseNameOnly`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:82
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:82
 
-___
+***
 
 ### \_children
 
-▪ `Static` **\_children**: `Object`
+> `abstract` `static` **\_children**: `object`
 
-The registered classes in the Factory
+**`Internal`**
 
-**`Name`**
+The registered classes in the Factory
 
-_children
+#### Index Signature
 
-**`Abstract`**
+ \[`name`: `string`\]: `any`
 
-#### Index signature
+#### Name
 
-▪ [name: `string`]: `any`
+_children
 
 #### Inherited from
 
-BaseFactory.\_children
+`BaseFactory._children`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:49
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:49
 
-## Accessors
+***
 
-### Factory
+### \_Factory
+
+> `abstract` `static` **\_Factory**: *typeof* `BaseFactory`
 
-• `get` **Factory**(): typeof `BaseFactory`
+**`Internal`**
 
 The Root Factory class
 
-#### Returns
+#### Name
 
-typeof `BaseFactory`
+_Factory
 
 #### Inherited from
 
-BaseFactory.Factory
+`BaseFactory._Factory`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:63
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:41
 
-___
+## Accessors
 
 ### aliases
 
-• `get` **aliases**(): `string`[]
+> `get` `static` **aliases**(): `string`[]
 
 the aliases of itself
 
+> `set` `static` **aliases**(`value`): `void`
+
+#### Parameters
+
+• **value**: `string`[]
+
 #### Returns
 
 `string`[]
 
 #### Inherited from
 
-BaseFactory.aliases
+`BaseFactory.aliases`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:200
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:200
 
-• `set` **aliases**(`value`): `void`
+***
 
-#### Parameters
+### Factory
 
-| Name | Type |
-| :------ | :------ |
-| `value` | `string`[] |
+> `get` `static` **Factory**(): *typeof* `BaseFactory`
+
+The Root Factory class
 
 #### Returns
 
-`void`
+*typeof* `BaseFactory`
 
 #### Inherited from
 
-BaseFactory.aliases
+`BaseFactory.Factory`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:196
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:63
 
 ## Methods
 
-### \_format
+### \_format()
 
-▸ **_format**(`data`): `string` \| `Promise`\<`string`\>
+> **\_format**(`data`): `string` \| `Promise`\<`string`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `data` | `Record`\<`string`, `any`\> |
+• **data**: `Record`\<`string`, `any`\>
 
 #### Returns
 
@@ -336,19 +263,17 @@ node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-fac
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:105](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L105)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:105](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L105)
 
-___
+***
 
-### \_initialize
+### \_initialize()
 
-▸ **_initialize**(`options?`): `void`
+> **\_initialize**(`options`?): `void`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `options?` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) |
+• **options?**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
@@ -356,21 +281,19 @@ ___
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:92](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L92)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:92](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L92)
 
-___
+***
 
-### filterData
+### filterData()
 
-▸ **filterData**(`data`): `Record`\<`string`, `any`\>
+> **filterData**(`data`): `Record`\<`string`, `any`\>
 
 Validate/filter the data in inputVariables
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `data` | `Record`\<`string`, `any`\> |
+• **data**: `Record`\<`string`, `any`\>
 
 #### Returns
 
@@ -378,19 +301,17 @@ Validate/filter the data in inputVariables
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L62)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L62)
 
-___
+***
 
-### format
+### format()
 
-▸ **format**(`data?`): `Promise`\<`string`\>
+> **format**(`data`?): `Promise`\<`string`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `data?` | `Record`\<`string`, `any`\> |
+• **data?**: `Record`\<`string`, `any`\>
 
 #### Returns
 
@@ -398,19 +319,21 @@ ___
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L109)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L109)
 
-___
+***
 
-### initialize
+### initialize()
 
-▸ **initialize**(`options?`): `void`
+> `abstract` **initialize**(`options`?): `void`
+
+**`Internal`**
+
+initialize instance method
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `options?` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) |
+• **options?**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
@@ -418,25 +341,25 @@ ___
 
 #### Overrides
 
-BaseFactory.initialize
+`BaseFactory.initialize`
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L96)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L96)
 
-___
+***
 
-### partial
+### partial()
 
-▸ **partial**(`data`): [`PromptTemplate`](PromptTemplate.md)
+> **partial**(`data`): [`PromptTemplate`](PromptTemplate.md)
 
 it can make sense to "partial" a prompt template - eg pass in a subset of the required values, as to create a new prompt template which expects only the remaining subset of values.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `data` | `Record`\<`string`, `any`\> | the partial data |
+• **data**: `Record`\<`string`, `any`\>
+
+the partial data
 
 #### Returns
 
@@ -446,19 +369,17 @@ the new partial PromptTemplate instance
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:139](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L139)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:139](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L139)
 
-___
+***
 
-### toJSON
+### toJSON()
 
-▸ **toJSON**(`options?`): [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+> **toJSON**(`options`): [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `options` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) |
+• **options**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) = `...`
 
 #### Returns
 
@@ -466,45 +387,45 @@ ___
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:147](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L147)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:147](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L147)
 
-___
+***
 
-### \_findRootFactory
+### \_findRootFactory()
 
-▸ **_findRootFactory**(`aClass`): `undefined` \| typeof `BaseFactory`
+> `static` **\_findRootFactory**(`aClass`): `undefined` \| *typeof* `BaseFactory`
+
+**`Internal`**
 
 find the real root factory
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `aClass` | typeof `BaseFactory` | the abstract root factory class |
+• **aClass**: *typeof* `BaseFactory`
+
+the abstract root factory class
 
 #### Returns
 
-`undefined` \| typeof `BaseFactory`
+`undefined` \| *typeof* `BaseFactory`
 
 #### Inherited from
 
-BaseFactory.\_findRootFactory
+`BaseFactory._findRootFactory`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:99
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:99
 
-___
+***
 
-### \_get
+### \_get()
 
-▸ **_get**(`name`): `any`
+> `static` **\_get**(`name`): `any`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `name` | `any` |
+• **name**: `any`
 
 #### Returns
 
@@ -512,26 +433,31 @@ ___
 
 #### Inherited from
 
-BaseFactory.\_get
+`BaseFactory._get`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:234
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:234
 
-___
+***
 
-### \_register
+### \_register()
 
-▸ **_register**(`aClass`, `aOptions?`): `boolean`
+> `static` **\_register**(`aClass`, `aOptions`?): `boolean`
+
+**`Internal`**
 
 register the aClass to the factory
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `aClass` | typeof `BaseFactory` | the class to register the Factory |
-| `aOptions?` | `any` | the options for the class and the factory |
+• **aClass**: *typeof* `BaseFactory`
+
+the class to register the Factory
+
+• **aOptions?**: `any`
+
+the options for the class and the factory
 
 #### Returns
 
@@ -541,25 +467,25 @@ return true if successful.
 
 #### Inherited from
 
-BaseFactory.\_register
+`BaseFactory._register`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:145
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:145
 
-___
+***
 
-### cleanAliases
+### cleanAliases()
 
-▸ **cleanAliases**(`aName`): `void`
+> `static` **cleanAliases**(`aName`): `void`
 
 remove all aliases of the registered item or itself
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `aName` | `undefined` \| `string` \| typeof `BaseFactory` | the registered item or name |
+• **aName**: `undefined` \| `string` \| *typeof* `BaseFactory`
+
+the registered item or name
 
 #### Returns
 
@@ -567,26 +493,25 @@ remove all aliases of the registered item or itself
 
 #### Inherited from
 
-BaseFactory.cleanAliases
+`BaseFactory.cleanAliases`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:162
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:162
 
-___
+***
 
-### createObject
+### createObject()
 
-▸ **createObject**(`aName`, `aOptions`): `undefined` \| `BaseFactory`
+> `static` **createObject**(`aName`, `aOptions`): `undefined` \| `BaseFactory`
 
 Create a new object instance of Factory
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `aName` | `string` \| `BaseFactory` |
-| `aOptions` | `any` |
+• **aName**: `string` \| `BaseFactory`
+
+• **aOptions**: `any`
 
 #### Returns
 
@@ -594,17 +519,19 @@ Create a new object instance of Factory
 
 #### Inherited from
 
-BaseFactory.createObject
+`BaseFactory.createObject`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:241
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:241
+
+***
 
-___
+### findRootFactory()
 
-### findRootFactory
+> `abstract` `static` **findRootFactory**(): `undefined` \| *typeof* `BaseFactory`
 
-▸ **findRootFactory**(): `undefined` \| typeof `BaseFactory`
+**`Internal`**
 
 find the real root factory
 
@@ -613,33 +540,31 @@ or set _Factory directly.
 
 #### Returns
 
-`undefined` \| typeof `BaseFactory`
+`undefined` \| *typeof* `BaseFactory`
 
 the root factory class
 
-**`Abstract`**
-
 #### Inherited from
 
-BaseFactory.findRootFactory
+`BaseFactory.findRootFactory`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:92
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:92
 
-___
+***
 
-### forEach
+### forEach()
 
-▸ **forEach**(`cb`): `any`
+> `static` **forEach**(`cb`): `any`
 
 executes a provided callback function once for each registered element.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `cb` | (`ctor`: typeof `BaseFactory`, `name`: `string`) => `undefined` \| `string` | the forEach callback function |
+• **cb**
+
+the forEach callback function
 
 #### Returns
 
@@ -647,23 +572,21 @@ executes a provided callback function once for each registered element.
 
 #### Inherited from
 
-BaseFactory.forEach
+`BaseFactory.forEach`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:227
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:227
 
-___
+***
 
-### format
+### format()
 
-▸ **format**(`options`): `Promise`\<`string`\>
+> `static` **format**(`options`): `Promise`\<`string`\>
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `options` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) |
+• **options**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
@@ -671,21 +594,21 @@ ___
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L31)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L31)
 
-___
+***
 
-### formatIf
+### formatIf()
 
-▸ **formatIf**(`options`): `Promise`\<`undefined` \| `string`\>
+> `static` **formatIf**(`options`): `Promise`\<`undefined` \| `string`\>
 
 If the given options.template is the template, perform formatting using that template.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `options` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) | The options object to check for being a template and to format. |
+• **options**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+
+The options object to check for being a template and to format.
 
 #### Returns
 
@@ -695,13 +618,15 @@ A Promise that resolves to the formatted result if options is a template; otherw
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L41)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L41)
+
+***
 
-___
+### formatName()
 
-### formatName
+> `abstract` `static` **formatName**(`aName`): `string`
 
-▸ **formatName**(`aName`): `string`
+**`Internal`**
 
 format(transform) the name to be registered.
 
@@ -709,38 +634,35 @@ defaults to returning the name unchanged. By overloading this method, case-insen
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `aName` | `string` |
+• **aName**: `string`
 
 #### Returns
 
 `string`
 
-**`Abstract`**
-
 #### Inherited from
 
-BaseFactory.formatName
+`BaseFactory.formatName`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:116
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:116
 
-___
+***
 
-### formatNameFromClass
+### formatNameFromClass()
 
-▸ **formatNameFromClass**(`aClass`, `aBaseNameOnly?`): `string`
+> `static` **formatNameFromClass**(`aClass`, `aBaseNameOnly`?): `string`
+
+**`Internal`**
 
 format(transform) the name to be registered for the aClass
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `aClass` | `any` |
-| `aBaseNameOnly?` | `number` |
+• **aClass**: `any`
+
+• **aBaseNameOnly?**: `number`
 
 #### Returns
 
@@ -750,24 +672,23 @@ the name to register
 
 #### Inherited from
 
-BaseFactory.formatNameFromClass
+`BaseFactory.formatNameFromClass`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:130
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:130
 
-___
+***
 
-### from
+### from()
 
-▸ **from**(`template?`, `options?`): [`PromptTemplate`](PromptTemplate.md)
+> `static` **from**(`template`?, `options`?): [`PromptTemplate`](PromptTemplate.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `template?` | `string` \| [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) |
-| `options?` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) |
+• **template?**: `string` \| [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+
+• **options?**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
@@ -775,49 +696,47 @@ ___
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L27)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L27)
 
-___
+***
 
-### get
+### get()
 
-▸ **get**(`name`): `undefined` \| typeof `BaseFactory`
+> `static` **get**(`name`): `undefined` \| *typeof* `BaseFactory`
 
 Get the registered class via name
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `name` | `any` |
+• **name**: `any`
 
 #### Returns
 
-`undefined` \| typeof `BaseFactory`
+`undefined` \| *typeof* `BaseFactory`
 
 return the registered class if found the name
 
 #### Inherited from
 
-BaseFactory.get
+`BaseFactory.get`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:233
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:233
 
-___
+***
 
-### getAliases
+### getAliases()
 
-▸ **getAliases**(`aClass`): `string`[]
+> `static` **getAliases**(`aClass`): `string`[]
 
 get the aliases of the aClass
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `aClass` | `undefined` \| `string` \| typeof `BaseFactory` | the class or name to get aliases, means itself if no aClass specified |
+• **aClass**: `undefined` \| `string` \| *typeof* `BaseFactory`
+
+the class or name to get aliases, means itself if no aClass specified
 
 #### Returns
 
@@ -827,25 +746,25 @@ aliases
 
 #### Inherited from
 
-BaseFactory.getAliases
+`BaseFactory.getAliases`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:195
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:195
 
-___
+***
 
-### getDisplayName
+### getDisplayName()
 
-▸ **getDisplayName**(`aClass`): `undefined` \| `string`
+> `static` **getDisplayName**(`aClass`): `undefined` \| `string`
 
 Get the display name from aClass
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `aClass` | `undefined` \| `string` \| `Function` | the class, name or itself, means itself if no aClass |
+• **aClass**: `undefined` \| `string` \| `Function`
+
+the class, name or itself, means itself if no aClass
 
 #### Returns
 
@@ -853,25 +772,23 @@ Get the display name from aClass
 
 #### Inherited from
 
-BaseFactory.getDisplayName
+`BaseFactory.getDisplayName`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:206
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:206
 
-___
+***
 
-### getNameFrom
+### getNameFrom()
 
-▸ **getNameFrom**(`aClass`): `string`
+> `static` **getNameFrom**(`aClass`): `string`
 
 Get the unique(registered) name in the factory
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `aClass` | `string` \| `Function` |
+• **aClass**: `string` \| `Function`
 
 #### Returns
 
@@ -881,23 +798,21 @@ the unique name in the factory
 
 #### Inherited from
 
-BaseFactory.getNameFrom
+`BaseFactory.getNameFrom`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:122
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:122
 
-___
+***
 
-### getRealName
+### getRealName()
 
-▸ **getRealName**(`name`): `any`
+> `static` **getRealName**(`name`): `any`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `name` | `any` |
+• **name**: `any`
 
 #### Returns
 
@@ -905,25 +820,25 @@ ___
 
 #### Inherited from
 
-BaseFactory.getRealName
+`BaseFactory.getRealName`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:100
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:100
 
-___
+***
 
-### getRealNameFromAlias
+### getRealNameFromAlias()
 
-▸ **getRealNameFromAlias**(`alias`): `undefined` \| `string`
+> `static` **getRealNameFromAlias**(`alias`): `undefined` \| `string`
 
 get the unique name in the factory from an alias name
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `alias` | `string` | the alias name |
+• **alias**: `string`
+
+the alias name
 
 #### Returns
 
@@ -933,23 +848,21 @@ the unique name in the factory
 
 #### Inherited from
 
-BaseFactory.getRealNameFromAlias
+`BaseFactory.getRealNameFromAlias`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:106
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:106
 
-___
+***
 
-### isTemplate
+### isTemplate()
 
-▸ **isTemplate**(`templateOpt`): `any`
+> `static` **isTemplate**(`templateOpt`): `any`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `templateOpt` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) |
+• **templateOpt**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
@@ -957,21 +870,19 @@ ___
 
 #### Defined in
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:48](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-template.ts#L48)
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:48](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-template.ts#L48)
 
-___
+***
 
-### register
+### register()
 
-▸ **register**(`...args`): `boolean`
+> `static` **register**(...`args`): `boolean`
 
 register the aClass to the factory
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `...args` | `any`[] |
+• ...**args**: `any`[]
 
 #### Returns
 
@@ -981,53 +892,53 @@ return true if successful.
 
 #### Inherited from
 
-BaseFactory.register
+`BaseFactory.register`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:137
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:137
 
-___
+***
 
-### registeredClass
+### registeredClass()
 
-▸ **registeredClass**(`aName`): ``false`` \| typeof `BaseFactory`
+> `static` **registeredClass**(`aName`): `false` \| *typeof* `BaseFactory`
 
 Check the name, alias or itself whether registered.
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `aName` | `undefined` \| `string` | the class name |
+• **aName**: `undefined` \| `string`
+
+the class name
 
 #### Returns
 
-``false`` \| typeof `BaseFactory`
+`false` \| *typeof* `BaseFactory`
 
 the registered class if registered, otherwise returns false
 
 #### Inherited from
 
-BaseFactory.registeredClass
+`BaseFactory.registeredClass`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:151
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:151
 
-___
+***
 
-### removeAlias
+### removeAlias()
 
-▸ **removeAlias**(`...aliases`): `void`
+> `static` **removeAlias**(...`aliases`): `void`
 
 remove specified aliases
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `...aliases` | `string`[] | the aliases to remove |
+• ...**aliases**: `string`[]
+
+the aliases to remove
 
 #### Returns
 
@@ -1035,26 +946,27 @@ remove specified aliases
 
 #### Inherited from
 
-BaseFactory.removeAlias
+`BaseFactory.removeAlias`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:167
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:167
 
-___
+***
 
-### setAlias
+### setAlias()
 
-▸ **setAlias**(`aClass`, `alias`): `void`
+> `static` **setAlias**(`aClass`, `alias`): `void`
 
 set alias to a class
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `aClass` | `undefined` \| `string` \| typeof `BaseFactory` | the class to set alias |
-| `alias` | `string` |  |
+• **aClass**: `undefined` \| `string` \| *typeof* `BaseFactory`
+
+the class to set alias
+
+• **alias**: `string`
 
 #### Returns
 
@@ -1062,32 +974,33 @@ set alias to a class
 
 #### Inherited from
 
-BaseFactory.setAlias
+`BaseFactory.setAlias`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:189
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:189
 
-___
+***
 
-### setAliases
+### setAliases()
 
-▸ **setAliases**(`aClass`, `...aAliases`): `void`
+> `static` **setAliases**(`aClass`, ...`aAliases`): `void`
 
 set aliases to a class
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `aClass` | `undefined` \| `string` \| typeof `BaseFactory` | the class to set aliases |
-| `...aAliases` | `any`[] | - |
+• **aClass**: `undefined` \| `string` \| *typeof* `BaseFactory`
+
+the class to set aliases
+
+• ...**aAliases**: `any`[]
 
 #### Returns
 
 `void`
 
-**`Example`**
+#### Example
 
 ```ts
 import { BaseFactory } from 'custom-factory'
@@ -1101,26 +1014,29 @@ import { BaseFactory } from 'custom-factory'
 
 #### Inherited from
 
-BaseFactory.setAliases
+`BaseFactory.setAliases`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:183
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:183
 
-___
+***
 
-### setDisplayName
+### setDisplayName()
 
-▸ **setDisplayName**(`aClass`, `aDisplayName`): `void`
+> `static` **setDisplayName**(`aClass`, `aDisplayName`): `void`
 
 Set the display name to the aClass
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `aClass` | `undefined` \| `string` \| `Function` | the class, name or itself, means itself if no aClass |
-| `aDisplayName` | `string` \| \{ `displayName`: `string`  } | the display name to set |
+• **aClass**: `undefined` \| `string` \| `Function`
+
+the class, name or itself, means itself if no aClass
+
+• **aDisplayName**: `string` \| `object`
+
+the display name to set
 
 #### Returns
 
@@ -1128,25 +1044,25 @@ Set the display name to the aClass
 
 #### Inherited from
 
-BaseFactory.setDisplayName
+`BaseFactory.setDisplayName`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:212
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:212
 
-___
+***
 
-### unregister
+### unregister()
 
-▸ **unregister**(`aName`): `boolean`
+> `static` **unregister**(`aName`): `boolean`
 
 unregister this class in the factory
 
 #### Parameters
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `aName` | `undefined` \| `string` \| `Function` | the registered name or class, no name means unregister itself. |
+• **aName**: `undefined` \| `string` \| `Function`
+
+the registered name or class, no name means unregister itself.
 
 #### Returns
 
@@ -1156,8 +1072,8 @@ true means successful
 
 #### Inherited from
 
-BaseFactory.unregister
+`BaseFactory.unregister`
 
 #### Defined in
 
-node_modules/.pnpm/custom-factory@2.3.0/node_modules/custom-factory/lib/base-factory.d.ts:157
+node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:157