@isdk/ai-tool 0.4.0 → 0.5.1

package/docs/classes/FewShotPromptTemplate.md

@@ -1,4 +1,4 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
+[**@isdk/ai-tool**](../README.md)
 
 ***
 
@@ -6,6 +6,8 @@
 
 # Class: FewShotPromptTemplate\<T\>
 
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:39](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L39)
+
 ## Extends
 
 - [`PromptTemplate`](PromptTemplate.md)
@@ -20,9 +22,13 @@
 
 > **new FewShotPromptTemplate**\<`T`\>(`options`): [`FewShotPromptTemplate`](FewShotPromptTemplate.md)\<`T`\>
 
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:50](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L50)
+
 #### Parameters
 
-• **options**: [`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
+##### options
+
+[`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
 
 #### Returns
 
@@ -32,47 +38,37 @@
 
 [`PromptTemplate`](PromptTemplate.md).[`constructor`](PromptTemplate.md#constructors)
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:50](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/few-shot-prompt-template.ts#L50)
-
 ## Properties
 
 ### compiledTemplate
 
 > **compiledTemplate**: `any`
 
+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)
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`compiledTemplate`](PromptTemplate.md#compiledtemplate)
 
-#### 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)
-
 ***
 
 ### data
 
 > **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/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/prompt-template.ts#L24)
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`data`](PromptTemplate.md#data)
 
-#### 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)
-
 ***
 
 ### examplePrompt
 
 > **examplePrompt**: `undefined` \| [`PromptTemplate`](PromptTemplate.md)
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/few-shot-prompt-template.ts#L41)
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L41)
 
 ***
 
@@ -80,9 +76,7 @@
 
 > **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:40](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/few-shot-prompt-template.ts#L40)
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:40](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L40)
 
 ***
 
@@ -90,9 +84,7 @@
 
 > **exampleSeparator**: `string`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:43](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/few-shot-prompt-template.ts#L43)
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:43](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L43)
 
 ***
 
@@ -100,23 +92,19 @@
 
 > **inputVariables**: `undefined` \| `string`[]
 
+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)
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`inputVariables`](PromptTemplate.md#inputvariables)
 
-#### 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)
-
 ***
 
 ### prefix
 
 > **prefix**: `string`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:44](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/few-shot-prompt-template.ts#L44)
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:44](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L44)
 
 ***
 
@@ -124,9 +112,7 @@
 
 > **suffix**: `string`
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:42](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/few-shot-prompt-template.ts#L42)
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:42](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L42)
 
 ***
 
@@ -134,13 +120,11 @@
 
 > **template**: `string`
 
-#### Inherited from
+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)
 
-[`PromptTemplate`](PromptTemplate.md).[`template`](PromptTemplate.md#template)
-
-#### Defined in
+#### Inherited from
 
-[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)
+[`PromptTemplate`](PromptTemplate.md).[`template`](PromptTemplate.md#template-1)
 
 ***
 
@@ -148,19 +132,19 @@
 
 > **templateFormat**: `undefined` \| `string`
 
+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)
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`templateFormat`](PromptTemplate.md#templateformat)
 
-#### 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)
-
 ***
 
 ### \_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`**
 
@@ -171,16 +155,14 @@ the key is alias name, the value is the registered name
 
 [`PromptTemplate`](PromptTemplate.md).[`_aliases`](PromptTemplate.md#_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,
@@ -214,23 +196,21 @@ _baseNameOnly
 
 [`PromptTemplate`](PromptTemplate.md).[`_baseNameOnly`](PromptTemplate.md#_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
 
@@ -240,16 +220,14 @@ _children
 
 [`PromptTemplate`](PromptTemplate.md).[`_children`](PromptTemplate.md#_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
@@ -262,45 +240,55 @@ _Factory
 
 [`PromptTemplate`](PromptTemplate.md).[`_Factory`](PromptTemplate.md#_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
 
-[`PromptTemplate`](PromptTemplate.md).[`aliases`](PromptTemplate.md#aliases)
+`void`
 
-#### Defined in
+#### Inherited from
 
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:200
+[`PromptTemplate`](PromptTemplate.md).[`aliases`](PromptTemplate.md#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`
 
@@ -308,19 +296,19 @@ The Root Factory class
 
 [`PromptTemplate`](PromptTemplate.md).[`Factory`](PromptTemplate.md#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`): `Promise`\<`string`\>
 
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L69)
+
 #### Parameters
 
-• **data**: `Record`\<`string`, `any`\>
+##### data
+
+`Record`\<`string`, `any`\>
 
 #### Returns
 
@@ -330,19 +318,19 @@ node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-f
 
 [`PromptTemplate`](PromptTemplate.md).[`_format`](PromptTemplate.md#_format)
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/few-shot-prompt-template.ts#L69)
-
 ***
 
 ### \_initialize()
 
 > **\_initialize**(`options`?): `void`
 
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:54](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L54)
+
 #### Parameters
 
-• **options?**: [`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
+##### options?
+
+[`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
 
 #### Returns
 
@@ -352,21 +340,21 @@ node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-f
 
 [`PromptTemplate`](PromptTemplate.md).[`_initialize`](PromptTemplate.md#_initialize)
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:54](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/few-shot-prompt-template.ts#L54)
-
 ***
 
 ### 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`\>
+##### data
+
+`Record`\<`string`, `any`\>
 
 #### Returns
 
@@ -376,19 +364,19 @@ Validate/filter the data in inputVariables
 
 [`PromptTemplate`](PromptTemplate.md).[`filterData`](PromptTemplate.md#filterdata)
 
-#### Defined in
-
-[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)
-
 ***
 
 ### format()
 
 > **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
 
@@ -398,23 +386,23 @@ Validate/filter the data in inputVariables
 
 [`PromptTemplate`](PromptTemplate.md).[`format`](PromptTemplate.md#format)
 
-#### 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
 
@@ -424,21 +412,21 @@ initialize instance method
 
 [`PromptTemplate`](PromptTemplate.md).[`initialize`](PromptTemplate.md#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
 
@@ -452,19 +440,19 @@ the new partial PromptTemplate instance
 
 [`PromptTemplate`](PromptTemplate.md).[`partial`](PromptTemplate.md#partial)
 
-#### 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`): [`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
 
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:94](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L94)
+
 #### Parameters
 
-• **options**: `this` = `...`
+##### options
+
+`this` = `...`
 
 #### Returns
 
@@ -474,23 +462,23 @@ the new partial PromptTemplate instance
 
 [`PromptTemplate`](PromptTemplate.md).[`toJSON`](PromptTemplate.md#tojson)
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:94](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/few-shot-prompt-template.ts#L94)
-
 ***
 
 ### \_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
 
@@ -502,19 +490,19 @@ the abstract root factory class
 
 [`PromptTemplate`](PromptTemplate.md).[`_findRootFactory`](PromptTemplate.md#_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
 
@@ -524,27 +512,29 @@ node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-f
 
 [`PromptTemplate`](PromptTemplate.md).[`_get`](PromptTemplate.md#_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
 
@@ -558,24 +548,24 @@ return true if successful.
 
 [`PromptTemplate`](PromptTemplate.md).[`_register`](PromptTemplate.md#_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`
@@ -584,23 +574,25 @@ the registered item or name
 
 [`PromptTemplate`](PromptTemplate.md).[`cleanAliases`](PromptTemplate.md#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
+
+`string` | `BaseFactory`
 
-• **aOptions**: `any`
+##### aOptions
+
+`any`
 
 #### Returns
 
@@ -610,16 +602,14 @@ Create a new object instance of Factory
 
 [`PromptTemplate`](PromptTemplate.md).[`createObject`](PromptTemplate.md#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
@@ -637,21 +627,21 @@ the root factory class
 
 [`PromptTemplate`](PromptTemplate.md).[`findRootFactory`](PromptTemplate.md#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
 
@@ -663,19 +653,19 @@ the forEach callback function
 
 [`PromptTemplate`](PromptTemplate.md).[`forEach`](PromptTemplate.md#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
 
@@ -683,11 +673,7 @@ node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-f
 
 #### Inherited from
 
-[`PromptTemplate`](PromptTemplate.md).[`format`](PromptTemplate.md#format-1)
-
-#### 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)
+[`PromptTemplate`](PromptTemplate.md).[`format`](PromptTemplate.md#format-2)
 
 ***
 
@@ -695,11 +681,15 @@ node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-f
 
 > `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.
 
@@ -713,16 +703,14 @@ A Promise that resolves to the formatted result if options is a template; otherw
 
 [`PromptTemplate`](PromptTemplate.md).[`formatIf`](PromptTemplate.md#formatif)
 
-#### 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.
@@ -731,7 +719,9 @@ defaults to returning the name unchanged. By overloading this method, case-insen
 
 #### Parameters
 
-• **aName**: `string`
+##### aName
+
+`string`
 
 #### Returns
 
@@ -741,25 +731,27 @@ defaults to returning the name unchanged. By overloading this method, case-insen
 
 [`PromptTemplate`](PromptTemplate.md).[`formatName`](PromptTemplate.md#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
+
+`any`
 
-• **aBaseNameOnly?**: `number`
+##### aBaseNameOnly?
+
+`number`
 
 #### Returns
 
@@ -771,23 +763,23 @@ the name to register
 
 [`PromptTemplate`](PromptTemplate.md).[`formatNameFromClass`](PromptTemplate.md#formatnamefromclass)
 
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:130
-
 ***
 
 ### from()
 
 > `static` **from**\<`T`\>(`options`): [`FewShotPromptTemplate`](FewShotPromptTemplate.md)\<`T`\>
 
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:46](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/few-shot-prompt-template.ts#L46)
+
 #### Type Parameters
 
 • **T** = `any`
 
 #### Parameters
 
-• **options**: [`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
+##### options
+
+[`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
 
 #### Returns
 
@@ -797,21 +789,21 @@ node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-f
 
 [`PromptTemplate`](PromptTemplate.md).[`from`](PromptTemplate.md#from)
 
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:46](https://github.com/isdk/ai-tool.js/blob/b0813174e9b350ae47231f8e5f885150313123b0/src/utils/prompt/few-shot-prompt-template.ts#L46)
-
 ***
 
 ### get()
 
 > `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
 
@@ -823,24 +815,24 @@ return the registered class if found the name
 
 [`PromptTemplate`](PromptTemplate.md).[`get`](PromptTemplate.md#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`[]
@@ -851,24 +843,24 @@ aliases
 
 [`PromptTemplate`](PromptTemplate.md).[`getAliases`](PromptTemplate.md#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`
@@ -877,21 +869,21 @@ the class, name or itself, means itself if no aClass
 
 [`PromptTemplate`](PromptTemplate.md).[`getDisplayName`](PromptTemplate.md#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
 
@@ -903,19 +895,19 @@ the unique name in the factory
 
 [`PromptTemplate`](PromptTemplate.md).[`getNameFrom`](PromptTemplate.md#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
 
@@ -925,21 +917,21 @@ node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-f
 
 [`PromptTemplate`](PromptTemplate.md).[`getRealName`](PromptTemplate.md#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
 
@@ -953,19 +945,19 @@ the unique name in the factory
 
 [`PromptTemplate`](PromptTemplate.md).[`getRealNameFromAlias`](PromptTemplate.md#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
 
@@ -975,21 +967,21 @@ node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-f
 
 [`PromptTemplate`](PromptTemplate.md).[`isTemplate`](PromptTemplate.md#istemplate)
 
-#### 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
 
@@ -1001,24 +993,24 @@ return true if successful.
 
 [`PromptTemplate`](PromptTemplate.md).[`register`](PromptTemplate.md#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`
@@ -1029,21 +1021,21 @@ the registered class if registered, otherwise returns false
 
 [`PromptTemplate`](PromptTemplate.md).[`registeredClass`](PromptTemplate.md#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
 
@@ -1055,25 +1047,27 @@ the aliases to remove
 
 [`PromptTemplate`](PromptTemplate.md).[`removeAlias`](PromptTemplate.md#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
 
@@ -1083,25 +1077,27 @@ the class to set alias
 
 [`PromptTemplate`](PromptTemplate.md).[`setAlias`](PromptTemplate.md#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
 
@@ -1123,28 +1119,30 @@ import { BaseFactory } from 'custom-factory'
 
 [`PromptTemplate`](PromptTemplate.md).[`setAliases`](PromptTemplate.md#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`
@@ -1153,24 +1151,24 @@ the display name to set
 
 [`PromptTemplate`](PromptTemplate.md).[`setDisplayName`](PromptTemplate.md#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`
@@ -1180,7 +1178,3 @@ true means successful
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`unregister`](PromptTemplate.md#unregister)
-
-#### Defined in
-
-node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:157