@isdk/ai-tool 0.4.0 → 0.5.1

package/docs/classes/PromptTemplate.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,6 +6,8 @@
 
 # Class: PromptTemplate
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:20](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L20)
+
 ## Extends
 
 - `BaseFactory`
@@ -15,6 +17,7 @@
 - [`HfPromptTemplate`](HfPromptTemplate.md)
 - [`FStringPromptTemplate`](FStringPromptTemplate.md)
 - [`GolangPromptTemplate`](GolangPromptTemplate.md)
+- [`EnvPromptTemplate`](EnvPromptTemplate.md)
 - [`FewShotPromptTemplate`](FewShotPromptTemplate.md)
 
 ## Constructors
@@ -23,11 +26,17 @@
 
 > **new PromptTemplate**(`template`?, `options`?): [`PromptTemplate`](PromptTemplate.md)
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L69)
+
 #### Parameters
 
-• **template?**: `string` \| [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+##### template?
 
-• **options?**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+`string` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+
+##### options?
+
+[`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
@@ -37,19 +46,13 @@
 
 `BaseFactory.constructor`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L69)
-
 ## Properties
 
 ### compiledTemplate
 
 > **compiledTemplate**: `any`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L21)
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L21)
 
 ***
 
@@ -57,9 +60,7 @@
 
 > **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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L24)
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L24)
 
 ***
 
@@ -67,9 +68,7 @@
 
 > **inputVariables**: `undefined` \| `string`[]
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L25)
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L25)
 
 ***
 
@@ -77,9 +76,7 @@
 
 > **template**: `string`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L22)
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L22)
 
 ***
 
@@ -87,15 +84,15 @@
 
 > **templateFormat**: `undefined` \| `string`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L23)
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L23)
 
 ***
 
 ### \_aliases
 
-> `abstract` `static` **\_aliases**: [`string`]
+> `abstract` `static` **\_aliases**: \[`string`\]
+
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:59
 
 **`Internal`**
 
@@ -106,16 +103,14 @@ the key is alias name, the value is the registered name
 
 `BaseFactory._aliases`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:59
-
 ***
 
 ### \_baseNameOnly
 
 > `static` **\_baseNameOnly**: `number`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:82
+
 **`Internal`**
 
 Extracts a specified number of words from a PascalCase class name to use as a base name for registration,
@@ -149,23 +144,21 @@ _baseNameOnly
 
 `BaseFactory._baseNameOnly`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:82
-
 ***
 
 ### \_children
 
 > `abstract` `static` **\_children**: `object`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:49
+
 **`Internal`**
 
 The registered classes in the Factory
 
 #### Index Signature
 
- \[`name`: `string`\]: `any`
+\[`name`: `string`\]: `any`
 
 #### Name
 
@@ -175,16 +168,14 @@ _children
 
 `BaseFactory._children`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:49
-
 ***
 
 ### \_Factory
 
 > `abstract` `static` **\_Factory**: *typeof* `BaseFactory`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:41
+
 **`Internal`**
 
 The Root Factory class
@@ -197,45 +188,55 @@ _Factory
 
 `BaseFactory._Factory`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:41
-
 ## Accessors
 
 ### aliases
 
-> `get` `static` **aliases**(): `string`[]
+#### Get Signature
+
+> **get** `static` **aliases**(): `string`[]
+
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:200
 
 the aliases of itself
 
-> `set` `static` **aliases**(`value`): `void`
+##### Returns
 
-#### Parameters
+`string`[]
 
-• **value**: `string`[]
+#### Set Signature
 
-#### Returns
+> **set** `static` **aliases**(`value`): `void`
+
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:196
+
+##### Parameters
+
+###### value
 
 `string`[]
 
-#### Inherited from
+##### Returns
 
-`BaseFactory.aliases`
+`void`
 
-#### Defined in
+#### Inherited from
 
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:200
+`BaseFactory.aliases`
 
 ***
 
 ### Factory
 
-> `get` `static` **Factory**(): *typeof* `BaseFactory`
+#### Get Signature
+
+> **get** `static` **Factory**(): *typeof* `BaseFactory`
+
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:63
 
 The Root Factory class
 
-#### Returns
+##### Returns
 
 *typeof* `BaseFactory`
 
@@ -243,65 +244,61 @@ The Root Factory class
 
 `BaseFactory.Factory`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:63
-
 ## Methods
 
 ### \_format()
 
 > **\_format**(`data`): `string` \| `Promise`\<`string`\>
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:105](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L105)
+
 #### Parameters
 
-• **data**: `Record`\<`string`, `any`\>
+##### data
+
+`Record`\<`string`, `any`\>
 
 #### Returns
 
 `string` \| `Promise`\<`string`\>
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:105](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L105)
-
 ***
 
 ### \_initialize()
 
 > **\_initialize**(`options`?): `void`
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:92](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L92)
+
 #### Parameters
 
-• **options?**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+##### options?
+
+[`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
 `void`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:92](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L92)
-
 ***
 
 ### filterData()
 
 > **filterData**(`data`): `Record`\<`string`, `any`\>
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L62)
+
 Validate/filter the data in inputVariables
 
 #### Parameters
 
-• **data**: `Record`\<`string`, `any`\>
-
-#### Returns
+##### data
 
 `Record`\<`string`, `any`\>
 
-#### Defined in
+#### Returns
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L62)
+`Record`\<`string`, `any`\>
 
 ***
 
@@ -309,31 +306,35 @@ Validate/filter the data in inputVariables
 
 > **format**(`data`?): `Promise`\<`string`\>
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L109)
+
 #### Parameters
 
-• **data?**: `Record`\<`string`, `any`\>
+##### data?
+
+`Record`\<`string`, `any`\>
 
 #### Returns
 
 `Promise`\<`string`\>
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L109)
-
 ***
 
 ### initialize()
 
 > `abstract` **initialize**(`options`?): `void`
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L96)
+
 **`Internal`**
 
 initialize instance method
 
 #### Parameters
 
-• **options?**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+##### options?
+
+[`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
@@ -343,21 +344,21 @@ initialize instance method
 
 `BaseFactory.initialize`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L96)
-
 ***
 
 ### partial()
 
 > **partial**(`data`): [`PromptTemplate`](PromptTemplate.md)
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:139](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L139)
+
 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
 
-• **data**: `Record`\<`string`, `any`\>
+##### data
+
+`Record`\<`string`, `any`\>
 
 the partial data
 
@@ -367,41 +368,41 @@ the partial data
 
 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/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L139)
-
 ***
 
 ### toJSON()
 
 > **toJSON**(`options`): [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:147](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L147)
+
 #### Parameters
 
-• **options**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) = `...`
+##### options
+
+[`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md) = `...`
 
 #### Returns
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:147](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L147)
-
 ***
 
 ### \_findRootFactory()
 
 > `static` **\_findRootFactory**(`aClass`): `undefined` \| *typeof* `BaseFactory`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:99
+
 **`Internal`**
 
 find the real root factory
 
 #### Parameters
 
-• **aClass**: *typeof* `BaseFactory`
+##### aClass
+
+*typeof* `BaseFactory`
 
 the abstract root factory class
 
@@ -413,19 +414,19 @@ the abstract root factory class
 
 `BaseFactory._findRootFactory`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:99
-
 ***
 
 ### \_get()
 
 > `static` **\_get**(`name`): `any`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:234
+
 #### Parameters
 
-• **name**: `any`
+##### name
+
+`any`
 
 #### Returns
 
@@ -435,27 +436,29 @@ node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-f
 
 `BaseFactory._get`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:234
-
 ***
 
 ### \_register()
 
 > `static` **\_register**(`aClass`, `aOptions`?): `boolean`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:145
+
 **`Internal`**
 
 register the aClass to the factory
 
 #### Parameters
 
-• **aClass**: *typeof* `BaseFactory`
+##### aClass
+
+*typeof* `BaseFactory`
 
 the class to register the Factory
 
-• **aOptions?**: `any`
+##### aOptions?
+
+`any`
 
 the options for the class and the factory
 
@@ -469,24 +472,24 @@ return true if successful.
 
 `BaseFactory._register`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:145
-
 ***
 
 ### cleanAliases()
 
 > `static` **cleanAliases**(`aName`): `void`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:162
+
 remove all aliases of the registered item or itself
 
 #### Parameters
 
-• **aName**: `undefined` \| `string` \| *typeof* `BaseFactory`
+##### aName
 
 the registered item or name
 
+`undefined` | `string` | *typeof* `BaseFactory`
+
 #### Returns
 
 `void`
@@ -495,23 +498,25 @@ the registered item or name
 
 `BaseFactory.cleanAliases`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:162
-
 ***
 
 ### createObject()
 
 > `static` **createObject**(`aName`, `aOptions`): `undefined` \| `BaseFactory`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:241
+
 Create a new object instance of Factory
 
 #### Parameters
 
-• **aName**: `string` \| `BaseFactory`
+##### aName
 
-• **aOptions**: `any`
+`string` | `BaseFactory`
+
+##### aOptions
+
+`any`
 
 #### Returns
 
@@ -521,16 +526,14 @@ Create a new object instance of Factory
 
 `BaseFactory.createObject`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:241
-
 ***
 
 ### findRootFactory()
 
 > `abstract` `static` **findRootFactory**(): `undefined` \| *typeof* `BaseFactory`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:92
+
 **`Internal`**
 
 find the real root factory
@@ -548,21 +551,21 @@ the root factory class
 
 `BaseFactory.findRootFactory`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:92
-
 ***
 
 ### forEach()
 
 > `static` **forEach**(`cb`): `any`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:227
+
 executes a provided callback function once for each registered element.
 
 #### Parameters
 
-• **cb**
+##### cb
+
+(`ctor`, `name`) => `undefined` \| `string`
 
 the forEach callback function
 
@@ -574,39 +577,39 @@ the forEach callback function
 
 `BaseFactory.forEach`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:227
-
 ***
 
 ### format()
 
 > `static` **format**(`options`): `Promise`\<`string`\>
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L31)
+
 #### Parameters
 
-• **options**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+##### options
+
+[`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
 `Promise`\<`string`\>
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L31)
-
 ***
 
 ### formatIf()
 
 > `static` **formatIf**(`options`): `Promise`\<`undefined` \| `string`\>
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L41)
+
 If the given options.template is the template, perform formatting using that template.
 
 #### Parameters
 
-• **options**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+##### options
+
+[`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 The options object to check for being a template and to format.
 
@@ -616,16 +619,14 @@ The options object to check for being a template and to format.
 
 A Promise that resolves to the formatted result if options is a template; otherwise, no value is returned.
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L41)
-
 ***
 
 ### formatName()
 
 > `abstract` `static` **formatName**(`aName`): `string`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:116
+
 **`Internal`**
 
 format(transform) the name to be registered.
@@ -634,7 +635,9 @@ defaults to returning the name unchanged. By overloading this method, case-insen
 
 #### Parameters
 
-• **aName**: `string`
+##### aName
+
+`string`
 
 #### Returns
 
@@ -644,25 +647,27 @@ defaults to returning the name unchanged. By overloading this method, case-insen
 
 `BaseFactory.formatName`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:116
-
 ***
 
 ### formatNameFromClass()
 
 > `static` **formatNameFromClass**(`aClass`, `aBaseNameOnly`?): `string`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:130
+
 **`Internal`**
 
 format(transform) the name to be registered for the aClass
 
 #### Parameters
 
-• **aClass**: `any`
+##### aClass
 
-• **aBaseNameOnly?**: `number`
+`any`
+
+##### aBaseNameOnly?
+
+`number`
 
 #### Returns
 
@@ -674,29 +679,27 @@ the name to register
 
 `BaseFactory.formatNameFromClass`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:130
-
 ***
 
 ### from()
 
 > `static` **from**(`template`?, `options`?): [`PromptTemplate`](PromptTemplate.md)
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L27)
+
 #### Parameters
 
-• **template?**: `string` \| [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+##### template?
 
-• **options?**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+`string` | [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
-#### Returns
+##### options?
 
-[`PromptTemplate`](PromptTemplate.md)
+[`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
-#### Defined in
+#### Returns
 
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L27)
+[`PromptTemplate`](PromptTemplate.md)
 
 ***
 
@@ -704,11 +707,15 @@ node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-f
 
 > `static` **get**(`name`): `undefined` \| *typeof* `BaseFactory`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:233
+
 Get the registered class via name
 
 #### Parameters
 
-• **name**: `any`
+##### name
+
+`any`
 
 #### Returns
 
@@ -720,24 +727,24 @@ return the registered class if found the name
 
 `BaseFactory.get`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:233
-
 ***
 
 ### getAliases()
 
 > `static` **getAliases**(`aClass`): `string`[]
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:195
+
 get the aliases of the aClass
 
 #### Parameters
 
-• **aClass**: `undefined` \| `string` \| *typeof* `BaseFactory`
+##### aClass
 
 the class or name to get aliases, means itself if no aClass specified
 
+`undefined` | `string` | *typeof* `BaseFactory`
+
 #### Returns
 
 `string`[]
@@ -748,24 +755,24 @@ aliases
 
 `BaseFactory.getAliases`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:195
-
 ***
 
 ### getDisplayName()
 
 > `static` **getDisplayName**(`aClass`): `undefined` \| `string`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:206
+
 Get the display name from aClass
 
 #### Parameters
 
-• **aClass**: `undefined` \| `string` \| `Function`
+##### aClass
 
 the class, name or itself, means itself if no aClass
 
+`undefined` | `string` | `Function`
+
 #### Returns
 
 `undefined` \| `string`
@@ -774,21 +781,21 @@ the class, name or itself, means itself if no aClass
 
 `BaseFactory.getDisplayName`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:206
-
 ***
 
 ### getNameFrom()
 
 > `static` **getNameFrom**(`aClass`): `string`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:122
+
 Get the unique(registered) name in the factory
 
 #### Parameters
 
-• **aClass**: `string` \| `Function`
+##### aClass
+
+`string` | `Function`
 
 #### Returns
 
@@ -800,19 +807,19 @@ the unique name in the factory
 
 `BaseFactory.getNameFrom`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:122
-
 ***
 
 ### getRealName()
 
 > `static` **getRealName**(`name`): `any`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:100
+
 #### Parameters
 
-• **name**: `any`
+##### name
+
+`any`
 
 #### Returns
 
@@ -822,21 +829,21 @@ node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-f
 
 `BaseFactory.getRealName`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:100
-
 ***
 
 ### getRealNameFromAlias()
 
 > `static` **getRealNameFromAlias**(`alias`): `undefined` \| `string`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:106
+
 get the unique name in the factory from an alias name
 
 #### Parameters
 
-• **alias**: `string`
+##### alias
+
+`string`
 
 the alias name
 
@@ -850,39 +857,39 @@ the unique name in the factory
 
 `BaseFactory.getRealNameFromAlias`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:106
-
 ***
 
 ### isTemplate()
 
 > `static` **isTemplate**(`templateOpt`): `any`
 
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:48](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L48)
+
 #### Parameters
 
-• **templateOpt**: [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+##### templateOpt
+
+[`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
 #### Returns
 
 `any`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:48](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/prompt-template.ts#L48)
-
 ***
 
 ### register()
 
 > `static` **register**(...`args`): `boolean`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:137
+
 register the aClass to the factory
 
 #### Parameters
 
-• ...**args**: `any`[]
+##### args
+
+...`any`[]
 
 #### Returns
 
@@ -894,24 +901,24 @@ return true if successful.
 
 `BaseFactory.register`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:137
-
 ***
 
 ### registeredClass()
 
 > `static` **registeredClass**(`aName`): `false` \| *typeof* `BaseFactory`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:151
+
 Check the name, alias or itself whether registered.
 
 #### Parameters
 
-• **aName**: `undefined` \| `string`
+##### aName
 
 the class name
 
+`undefined` | `string`
+
 #### Returns
 
 `false` \| *typeof* `BaseFactory`
@@ -922,21 +929,21 @@ the registered class if registered, otherwise returns false
 
 `BaseFactory.registeredClass`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:151
-
 ***
 
 ### removeAlias()
 
 > `static` **removeAlias**(...`aliases`): `void`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:167
+
 remove specified aliases
 
 #### Parameters
 
-• ...**aliases**: `string`[]
+##### aliases
+
+...`string`[]
 
 the aliases to remove
 
@@ -948,25 +955,27 @@ the aliases to remove
 
 `BaseFactory.removeAlias`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:167
-
 ***
 
 ### setAlias()
 
 > `static` **setAlias**(`aClass`, `alias`): `void`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:189
+
 set alias to a class
 
 #### Parameters
 
-• **aClass**: `undefined` \| `string` \| *typeof* `BaseFactory`
+##### aClass
 
 the class to set alias
 
-• **alias**: `string`
+`undefined` | `string` | *typeof* `BaseFactory`
+
+##### alias
+
+`string`
 
 #### Returns
 
@@ -976,25 +985,27 @@ the class to set alias
 
 `BaseFactory.setAlias`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:189
-
 ***
 
 ### setAliases()
 
 > `static` **setAliases**(`aClass`, ...`aAliases`): `void`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:183
+
 set aliases to a class
 
 #### Parameters
 
-• **aClass**: `undefined` \| `string` \| *typeof* `BaseFactory`
+##### aClass
 
 the class to set aliases
 
-• ...**aAliases**: `any`[]
+`undefined` | `string` | *typeof* `BaseFactory`
+
+##### aAliases
+
+...`any`[]
 
 #### Returns
 
@@ -1016,28 +1027,30 @@ import { BaseFactory } from 'custom-factory'
 
 `BaseFactory.setAliases`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:183
-
 ***
 
 ### setDisplayName()
 
 > `static` **setDisplayName**(`aClass`, `aDisplayName`): `void`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:212
+
 Set the display name to the aClass
 
 #### Parameters
 
-• **aClass**: `undefined` \| `string` \| `Function`
+##### aClass
 
 the class, name or itself, means itself if no aClass
 
-• **aDisplayName**: `string` \| `object`
+`undefined` | `string` | `Function`
+
+##### aDisplayName
 
 the display name to set
 
+`string` | \{ `displayName`: `string`; \}
+
 #### Returns
 
 `void`
@@ -1046,24 +1059,24 @@ the display name to set
 
 `BaseFactory.setDisplayName`
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:212
-
 ***
 
 ### unregister()
 
 > `static` **unregister**(`aName`): `boolean`
 
+Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:157
+
 unregister this class in the factory
 
 #### Parameters
 
-• **aName**: `undefined` \| `string` \| `Function`
+##### aName
 
 the registered name or class, no name means unregister itself.
 
+`undefined` | `string` | `Function`
+
 #### Returns
 
 `boolean`
@@ -1073,7 +1086,3 @@ true means successful
 #### Inherited from
 
 `BaseFactory.unregister`
-
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:157