@isdk/ai-tool 0.5.8 → 0.7.0

package/docs/{classes → api/classes}/FewShotPromptTemplate.md

@@ -6,7 +6,34 @@
 
 # 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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L39)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:39](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L39)
+
+The `StringTemplate` class is a versatile template engine that supports dynamic template creation,
+formatting, and partial data processing. It extends the `BaseFactory` class and provides methods
+for handling template strings, validating input variables, and managing template configurations.
+
+## Example
+
+```typescript
+import { StringTemplate } from './template';
+
+// Register a custom template class
+class CustomTemplate extends StringTemplate {
+  _initialize(options?: StringTemplateOptions): void {}
+  _format(data: Record<string, any>): string {
+    return `Formatted: ${data.text}`;
+  }
+}
+StringTemplate.register(CustomTemplate);
+
+// Create a new instance with a custom template format
+const template = new StringTemplate("{{text}}", { templateFormat: "Custom" });
+console.log(template instanceof CustomTemplate); // Output: true
+
+// Format the template with data
+const result = await template.format({ text: "Hello World" });
+console.log(result); // Output: "Formatted: Hello World"
+```
 
 ## Extends
 
@@ -22,7 +49,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:39](h
 
 > **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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L50)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:50](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L50)
 
 #### Parameters
 
@@ -44,7 +71,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:50](h
 
 > **compiledTemplate**: `any`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L21)
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:54
+
+Declares the compiled template instance.
 
 #### Inherited from
 
@@ -56,7 +85,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://gi
 
 > **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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L24)
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:66
+
+Declares the data object used for template interpolation.
 
 #### Inherited from
 
@@ -68,7 +99,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://gi
 
 > **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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L41)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L41)
 
 ***
 
@@ -76,7 +107,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:41](h
 
 > **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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L40)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:40](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L40)
 
 ***
 
@@ -84,7 +115,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:40](h
 
 > **exampleSeparator**: `string`
 
-Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:43](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L43)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:43](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L43)
 
 ***
 
@@ -92,7 +123,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:43](h
 
 > **inputVariables**: `undefined` \| `string`[]
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L25)
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:70
+
+Declares the list of input variables expected by the template.
 
 #### Inherited from
 
@@ -104,7 +137,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://gi
 
 > **prefix**: `string`
 
-Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:44](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L44)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:44](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L44)
 
 ***
 
@@ -112,7 +145,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:44](h
 
 > **suffix**: `string`
 
-Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:42](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L42)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:42](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L42)
 
 ***
 
@@ -120,7 +153,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:42](h
 
 > **template**: `string`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L22)
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:58
+
+Declares the raw template string.
 
 #### Inherited from
 
@@ -132,7 +167,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://gi
 
 > **templateFormat**: `undefined` \| `string`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L23)
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:62
+
+Declares the format of the template (e.g., 'default').
 
 #### Inherited from
 
@@ -144,7 +181,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://gi
 
 > `abstract` `static` **\_aliases**: \[`string`\]
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:59
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:59
 
 **`Internal`**
 
@@ -161,7 +198,7 @@ the key is alias name, the value is the registered name
 
 > `static` **\_baseNameOnly**: `number`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:82
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:82
 
 **`Internal`**
 
@@ -202,7 +239,7 @@ _baseNameOnly
 
 > `abstract` `static` **\_children**: `object`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:49
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:49
 
 **`Internal`**
 
@@ -226,7 +263,7 @@ _children
 
 > `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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:41
 
 **`Internal`**
 
@@ -248,7 +285,7 @@ _Factory
 
 > **get** `static` **aliases**(): `string`[]
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:200
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:200
 
 the aliases of itself
 
@@ -260,7 +297,7 @@ the aliases of itself
 
 > **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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:196
 
 ##### Parameters
 
@@ -284,7 +321,7 @@ Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factor
 
 > **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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:63
 
 The Root Factory class
 
@@ -302,7 +339,9 @@ The Root Factory class
 
 > **\_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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L69)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L69)
+
+Placeholder method for formatting the template. Must be implemented by subclasses.
 
 #### Parameters
 
@@ -310,10 +349,14 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:69](h
 
 `Record`\<`string`, `any`\>
 
+The data object used for interpolation.
+
 #### Returns
 
 `Promise`\<`string`\>
 
+A formatted string or a promise resolving to the formatted string.
+
 #### Overrides
 
 [`PromptTemplate`](PromptTemplate.md).[`_format`](PromptTemplate.md#_format)
@@ -324,7 +367,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:69](h
 
 > **\_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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L54)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:54](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L54)
+
+Placeholder method for initializing the template. Must be implemented by subclasses.
 
 #### Parameters
 
@@ -332,6 +377,8 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:54](h
 
 [`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
 
+Configuration options for initialization.
+
 #### Returns
 
 `void`
@@ -346,9 +393,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:54](h
 
 > **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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L62)
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:172
 
-Validate/filter the data in inputVariables
+Filters the input data to include only the specified input variables.
 
 #### Parameters
 
@@ -356,10 +403,24 @@ Validate/filter the data in inputVariables
 
 `Record`\<`string`, `any`\>
 
+The data object to validate and filter.
+
 #### Returns
 
 `Record`\<`string`, `any`\>
 
+The filtered data object containing only the allowed keys.
+
+#### Example
+
+```typescript
+const template = new StringTemplate({
+  inputVariables: ['name']
+});
+const filteredData = template.filterData({ name: "Alice", age: 30 });
+console.log(filteredData); // Output: { name: "Alice" }
+```
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`filterData`](PromptTemplate.md#filterdata)
@@ -370,7 +431,9 @@ 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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L109)
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:219
+
+Formats the template using the provided data, supporting asynchronous processing.
 
 #### Parameters
 
@@ -378,10 +441,25 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://g
 
 `Record`\<`string`, `any`\>
 
+The data object used for interpolation.
+
 #### Returns
 
 `Promise`\<`string`\>
 
+A promise that resolves to the formatted template string.
+
+#### Example
+
+```typescript
+const template = new StringTemplate("{{text}}", {
+  templateFormat: "Test",
+  inputVariables: ['text']
+});
+const result = await template.format({ text: "Hello" });
+console.log(result); // Output: "Hello"
+```
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`format`](PromptTemplate.md#format)
@@ -390,13 +468,11 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://g
 
 ### 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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L96)
+> **initialize**(`options`?): `void`
 
-**`Internal`**
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:197
 
-initialize instance method
+Initializes the template instance with the provided options.
 
 #### Parameters
 
@@ -404,6 +480,8 @@ initialize instance method
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
+Configuration options for initialization.
+
 #### Returns
 
 `void`
@@ -418,9 +496,10 @@ initialize instance method
 
 > **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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L139)
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:247
 
-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.
+Creates a new `StringTemplate` instance with partially filled data.
+This is useful for pre-filling some variables while leaving others to be filled later.
 
 #### Parameters
 
@@ -428,13 +507,35 @@ it can make sense to "partial" a prompt template - eg pass in a subset of the re
 
 `Record`\<`string`, `any`\>
 
-the partial data
+The partial data to pre-fill in the new template.
 
 #### Returns
 
 [`PromptTemplate`](PromptTemplate.md)
 
-the new partial PromptTemplate instance
+A new `StringTemplate` instance with the partial data applied.
+
+#### Example
+
+```typescript
+const template = new StringTemplate("{{role}}:{{text}}", {
+  templateFormat: "Test",
+  inputVariables: ['role', 'text']
+});
+const partialTemplate = template.partial({ role: "user" });
+console.log(partialTemplate.data); // Output: { role: "user" }
+const result = await partialTemplate.format({ text: "Hello" });
+console.log(result); // Output: { role: "user", text: "Hello" }
+
+// Example with a function
+function getDate() {
+  return new Date();
+}
+const dateTemplate = template.partial({ date: getDate });
+console.log(dateTemplate.data); // Output: { date: getDate }
+const dateResult = await dateTemplate.format({ role: "user" });
+console.log(dateResult.date instanceof Date); // Output: true
+```
 
 #### Inherited from
 
@@ -446,7 +547,9 @@ the new partial PromptTemplate instance
 
 > **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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L94)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:94](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L94)
+
+Serializes the `StringTemplate` instance into a JSON-compatible object.
 
 #### Parameters
 
@@ -454,10 +557,26 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:94](h
 
 `this` = `...`
 
+Optional configuration for serialization.
+
 #### Returns
 
 [`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
 
+A JSON-compatible object representing the template's state.
+
+#### Example
+
+```typescript
+const template = new StringTemplate("{{text}}", {
+  templateFormat: "Test",
+  inputVariables: ['text']
+});
+const serialized = template.toJSON();
+console.log(serialized);
+// Output: { template: "{{text}}", templateFormat: "Test", inputVariables: ['text'] }
+```
+
 #### Overrides
 
 [`PromptTemplate`](PromptTemplate.md).[`toJSON`](PromptTemplate.md#tojson)
@@ -468,7 +587,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:94](h
 
 > `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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:99
 
 **`Internal`**
 
@@ -496,7 +615,7 @@ the abstract root factory class
 
 > `static` **\_get**(`name`): `any`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:234
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:234
 
 #### Parameters
 
@@ -518,7 +637,7 @@ Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factor
 
 > `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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:145
 
 **`Internal`**
 
@@ -554,7 +673,7 @@ return true if successful.
 
 > `static` **cleanAliases**(`aName`): `void`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:162
+Defined in: @isdk/ai-tools/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
 
@@ -580,7 +699,7 @@ the registered item or name
 
 > `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
+Defined in: @isdk/ai-tools/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
 
@@ -608,7 +727,7 @@ Create a new object instance of Factory
 
 > `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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:92
 
 **`Internal`**
 
@@ -633,7 +752,7 @@ the root factory class
 
 > `static` **forEach**(`cb`): `any`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:227
+Defined in: @isdk/ai-tools/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.
 
@@ -659,7 +778,9 @@ the forEach callback function
 
 > `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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L31)
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:102
+
+Formats a template using the provided options.
 
 #### Parameters
 
@@ -667,10 +788,25 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://gi
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
+Configuration options for the template.
+
 #### Returns
 
 `Promise`\<`string`\>
 
+A promise that resolves to the formatted template string.
+
+#### Example
+
+```typescript
+const result = await StringTemplate.format({
+  template: "{{text}}",
+  data: { text: "Hello" },
+  templateFormat: "Test"
+});
+console.log(result); // Output: "Hello"
+```
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`format`](PromptTemplate.md#format-2)
@@ -681,9 +817,9 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://gi
 
 > `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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L41)
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:118
 
-If the given options.template is the template, perform formatting using that template.
+Formats a template if the provided options represent a valid template.
 
 #### Parameters
 
@@ -691,13 +827,24 @@ If the given options.template is the template, perform formatting using that tem
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
-The options object to check for being a template and to format.
+Configuration options to check and format.
 
 #### Returns
 
 `Promise`\<`undefined` \| `string`\>
 
-A Promise that resolves to the formatted result if options is a template; otherwise, no value is returned.
+A promise that resolves to the formatted template string if valid; otherwise, undefined.
+
+#### Example
+
+```typescript
+const result = await StringTemplate.formatIf({
+  template: "{{text}}",
+  data: { text: "Valid Template" },
+  templateFormat: "Test"
+});
+console.log(result); // Output: "Valid Template"
+```
 
 #### Inherited from
 
@@ -709,7 +856,7 @@ A Promise that resolves to the formatted result if options is a template; otherw
 
 > `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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:116
 
 **`Internal`**
 
@@ -737,7 +884,7 @@ defaults to returning the name unchanged. By overloading this method, case-insen
 
 > `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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:130
 
 **`Internal`**
 
@@ -769,7 +916,9 @@ the name to register
 
 > `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/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L46)
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:46](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/prompt/few-shot-prompt-template.ts#L46)
+
+Creates a new instance of the `StringTemplate` class.
 
 #### Type Parameters
 
@@ -781,10 +930,24 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:46](h
 
 [`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
 
+Additional configuration options for the template.
+
 #### Returns
 
 [`FewShotPromptTemplate`](FewShotPromptTemplate.md)\<`T`\>
 
+A new `StringTemplate` instance.
+
+#### Example
+
+```typescript
+const template = StringTemplate.from("{{text}}", {
+  templateFormat: "Test",
+  inputVariables: ['text']
+});
+console.log(template instanceof TestStringTemplate); // Output: true
+```
+
 #### Overrides
 
 [`PromptTemplate`](PromptTemplate.md).[`from`](PromptTemplate.md#from)
@@ -795,7 +958,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:46](h
 
 > `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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:233
 
 Get the registered class via name
 
@@ -821,7 +984,7 @@ return the registered class if found the name
 
 > `static` **getAliases**(`aClass`): `string`[]
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:195
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:195
 
 get the aliases of the aClass
 
@@ -849,7 +1012,7 @@ aliases
 
 > `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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:206
 
 Get the display name from aClass
 
@@ -875,7 +1038,7 @@ the class, name or itself, means itself if no aClass
 
 > `static` **getNameFrom**(`aClass`): `string`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:122
+Defined in: @isdk/ai-tools/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
 
@@ -901,7 +1064,7 @@ the unique name in the factory
 
 > `static` **getRealName**(`name`): `any`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:100
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:100
 
 #### Parameters
 
@@ -923,7 +1086,7 @@ Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factor
 
 > `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
+Defined in: @isdk/ai-tools/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
 
@@ -951,7 +1114,9 @@ the unique name in the factory
 
 > `static` **isTemplate**(`templateOpt`): `any`
 
-Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:48](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L48)
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:133
+
+Determines whether the given options represent a valid template.
 
 #### Parameters
 
@@ -959,21 +1124,83 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:48](https://gi
 
 [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
 
+The options object to evaluate.
+
 #### Returns
 
 `any`
 
+A boolean indicating whether the options represent a valid template.
+
+#### Example
+
+```typescript
+const isValid = StringTemplate.isTemplate({
+  template: "{{text}}",
+  templateFormat: "Test"
+});
+console.log(isValid); // Output: true
+```
+
 #### Inherited from
 
 [`PromptTemplate`](PromptTemplate.md).[`isTemplate`](PromptTemplate.md#istemplate)
 
 ***
 
+### matchTemplateSegment()
+
+> `static` **matchTemplateSegment**(`templateOpt`, `index`?): `undefined` \| `RegExpExecArray`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:157
+
+Matches and extracts a single template segment from the provided template options.
+This method is designed to identify individual segments of a template string.
+
+#### Parameters
+
+##### templateOpt
+
+[`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
+
+The template options containing the template string and related configurations.
+
+##### index?
+
+`number`
+
+The default starting position in the template string to begin matching (default: 0).
+               This value is used only if `templateOpt.index` is not provided or invalid.
+
+#### Returns
+
+`undefined` \| `RegExpExecArray`
+
+A `RegExpExecArray` representing the matched template segment, or `undefined` if no match is found.
+         The `index` property of the result can be used to calculate the next position for iteration.
+
+#### Example
+
+```typescript
+const template = "{{name}} is {{age}} years old";
+let match = StringTemplate.matchTemplateSegment({ template });
+while (match) {
+  console.log(match[0]); // Output: "{{name}}"
+  match = StringTemplate.matchTemplateSegment({ template }, match.index + match[0].length);
+}
+```
+
+#### Inherited from
+
+[`PromptTemplate`](PromptTemplate.md).[`matchTemplateSegment`](PromptTemplate.md#matchtemplatesegment)
+
+***
+
 ### 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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:137
 
 register the aClass to the factory
 
@@ -999,7 +1226,7 @@ return true if successful.
 
 > `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
+Defined in: @isdk/ai-tools/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.
 
@@ -1027,7 +1254,7 @@ the registered class if registered, otherwise returns false
 
 > `static` **removeAlias**(...`aliases`): `void`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:167
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:167
 
 remove specified aliases
 
@@ -1053,7 +1280,7 @@ the aliases to remove
 
 > `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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:189
 
 set alias to a class
 
@@ -1083,7 +1310,7 @@ the class to set alias
 
 > `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
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:183
 
 set aliases to a class
 
@@ -1125,7 +1352,7 @@ import { BaseFactory } from 'custom-factory'
 
 > `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
+Defined in: @isdk/ai-tools/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
 
@@ -1157,7 +1384,7 @@ the display name to set
 
 > `static` **unregister**(`aName`): `boolean`
 
-Defined in: node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:157
+Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-factory@2.3.0/node\_modules/custom-factory/lib/base-factory.d.ts:157
 
 unregister this class in the factory