@isdk/ai-tool 0.5.3 → 0.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (282) hide show
  1. package/docs/classes/BinarySemaphore.md +25 -25
  2. package/docs/classes/CancelableAbility.md +25 -25
  3. package/docs/classes/ClientTools.md +55 -55
  4. package/docs/classes/EnvPromptTemplate.md +19 -19
  5. package/docs/classes/EventClient.md +78 -78
  6. package/docs/classes/EventServer.md +79 -79
  7. package/docs/classes/EventToolFunc.md +47 -47
  8. package/docs/classes/FStringPromptTemplate.md +19 -19
  9. package/docs/classes/FewShotPromptTemplate.md +23 -23
  10. package/docs/classes/GolangPromptTemplate.md +19 -19
  11. package/docs/classes/HFEnvironment.md +10 -10
  12. package/docs/classes/HFInterpreter.md +5 -5
  13. package/docs/classes/HFTemplate.md +5 -5
  14. package/docs/classes/HfPromptTemplate.md +19 -19
  15. package/docs/classes/IntSet.md +12 -12
  16. package/docs/classes/PromptExampleSelector.md +9 -9
  17. package/docs/classes/PromptTemplate.md +18 -18
  18. package/docs/classes/ReadableStreamError.md +2 -2
  19. package/docs/classes/ResClientTools.md +62 -62
  20. package/docs/classes/ResServerTools.md +63 -63
  21. package/docs/classes/SSEChannel.md +16 -16
  22. package/docs/classes/Semaphore.md +26 -26
  23. package/docs/classes/ServerTools.md +51 -51
  24. package/docs/classes/SignalGate.md +9 -9
  25. package/docs/classes/TaskAbortController.md +8 -8
  26. package/docs/classes/ToolFunc.md +44 -44
  27. package/docs/classes/YamlTypeBaseObject.md +2 -2
  28. package/docs/enumerations/AsyncFeatureBits.md +4 -4
  29. package/docs/enumerations/AsyncFeatures.md +4 -4
  30. package/docs/enumerations/HashAlgorithm.md +12 -12
  31. package/docs/functions/AIArgProcessor.md +1 -1
  32. package/docs/functions/AIStream.md +1 -1
  33. package/docs/functions/ChoiceArgProcessor.md +1 -1
  34. package/docs/functions/ObjectArgsToArgsInfo.md +1 -1
  35. package/docs/functions/RateLimit.md +1 -1
  36. package/docs/functions/TemplateArgProcessor.md +1 -1
  37. package/docs/functions/assignDirs.md +1 -1
  38. package/docs/functions/backendEventable.md +1 -1
  39. package/docs/functions/beforeShutdown.md +1 -1
  40. package/docs/functions/completeSentences.md +1 -1
  41. package/docs/functions/concatText.md +1 -1
  42. package/docs/functions/countLLMTokens.md +1 -1
  43. package/docs/functions/countRegexMatches.md +1 -1
  44. package/docs/functions/createCallbacksTransformer.md +1 -1
  45. package/docs/functions/createEmptyReadableStream.md +1 -1
  46. package/docs/functions/createEndWithRepetitionDetector.md +1 -1
  47. package/docs/functions/createEventStreamTransformer.md +1 -1
  48. package/docs/functions/createHfValueFunc.md +1 -1
  49. package/docs/functions/createLRUCache.md +1 -1
  50. package/docs/functions/createYamlObjectTag.md +1 -1
  51. package/docs/functions/dateToText.md +1 -1
  52. package/docs/functions/decodeCharset.md +1 -1
  53. package/docs/functions/detectCharset.md +1 -1
  54. package/docs/functions/encodeLLMTokens.md +1 -1
  55. package/docs/functions/ensureQuoted.md +1 -1
  56. package/docs/functions/expandConfig.md +1 -1
  57. package/docs/functions/expandEnv.md +1 -1
  58. package/docs/functions/expandObjEnv.md +1 -1
  59. package/docs/functions/expandPath.md +1 -1
  60. package/docs/functions/extNameLevel.md +1 -1
  61. package/docs/functions/fileIsExists.md +1 -1
  62. package/docs/functions/filenameReservedRegex.md +1 -1
  63. package/docs/functions/filterValidFnScope.md +1 -1
  64. package/docs/functions/findIndexNonEmptyFrom.md +1 -1
  65. package/docs/functions/findPort.md +1 -1
  66. package/docs/functions/formatTextWithSpace.md +1 -1
  67. package/docs/functions/getAllEnumKeys.md +1 -1
  68. package/docs/functions/getConfigFileNames.md +1 -1
  69. package/docs/functions/getConfigs.md +1 -1
  70. package/docs/functions/getEnvVairables.md +1 -1
  71. package/docs/functions/getFileMetaInfo.md +1 -1
  72. package/docs/functions/getHashAlgoBySize.md +1 -1
  73. package/docs/functions/getKeysPath.md +1 -1
  74. package/docs/functions/getLLMTokenizer.md +1 -1
  75. package/docs/functions/getMultiLevelExtname.md +1 -1
  76. package/docs/functions/getPackageDir.md +1 -1
  77. package/docs/functions/getRealFilepath.md +1 -1
  78. package/docs/functions/getResponseErrorReadableStream.md +1 -1
  79. package/docs/functions/getXDGConfigs.md +1 -1
  80. package/docs/functions/hasDirectoryIn.md +1 -1
  81. package/docs/functions/hash.md +1 -1
  82. package/docs/functions/hashFile.md +1 -1
  83. package/docs/functions/hashStream.md +1 -1
  84. package/docs/functions/hfParse.md +1 -1
  85. package/docs/functions/hfTokenize.md +1 -1
  86. package/docs/functions/initShutdown.md +1 -1
  87. package/docs/functions/interpolateEnv.md +1 -1
  88. package/docs/functions/interpolateFString.md +1 -1
  89. package/docs/functions/interpolateGolangTemplate.md +1 -1
  90. package/docs/functions/isLangUsingSpaces.md +1 -1
  91. package/docs/functions/isListItemString.md +1 -1
  92. package/docs/functions/isModelNameMatched.md +1 -1
  93. package/docs/functions/isPunctuationChar.md +1 -1
  94. package/docs/functions/isQuoted.md +1 -1
  95. package/docs/functions/isRegExp.md +1 -1
  96. package/docs/functions/isSameString.md +1 -1
  97. package/docs/functions/isSectionString.md +1 -1
  98. package/docs/functions/isSentenceEnding.md +1 -1
  99. package/docs/functions/isSepLineString.md +1 -1
  100. package/docs/functions/isStrWrapped.md +1 -1
  101. package/docs/functions/isSubdirectory.md +1 -1
  102. package/docs/functions/isTitleString.md +1 -1
  103. package/docs/functions/isValidFilename.md +1 -1
  104. package/docs/functions/isValidFilepath.md +1 -1
  105. package/docs/functions/isWebStream.md +1 -1
  106. package/docs/functions/jsonFilterToWhere.md +1 -1
  107. package/docs/functions/jsonToMarkdownStr.md +1 -1
  108. package/docs/functions/loadAIConfig.md +1 -1
  109. package/docs/functions/loadConfig.md +1 -1
  110. package/docs/functions/loadConfigFile.md +1 -1
  111. package/docs/functions/loadFileFromPaths.md +1 -1
  112. package/docs/functions/loadTextFromPaths.md +1 -1
  113. package/docs/functions/lrucache.md +1 -1
  114. package/docs/functions/makeToolFuncCancelable.md +1 -1
  115. package/docs/functions/matchUrlProtocol.md +1 -1
  116. package/docs/functions/memoize.md +1 -1
  117. package/docs/functions/messagesToText.md +1 -1
  118. package/docs/functions/paramsSizeToScaleStr.md +1 -1
  119. package/docs/functions/parseCommand.md +1 -1
  120. package/docs/functions/parseFString.md +1 -1
  121. package/docs/functions/parseJsJson.md +1 -1
  122. package/docs/functions/parseJsJsonSimpleSync.md +1 -1
  123. package/docs/functions/parseObjectArgInfo.md +1 -1
  124. package/docs/functions/parseObjectArgumentInfos.md +1 -1
  125. package/docs/functions/parseObjectArguments.md +1 -1
  126. package/docs/functions/parseObjectArgumentsAsArgInfos.md +1 -1
  127. package/docs/functions/parseYaml.md +1 -1
  128. package/docs/functions/quoteStr.md +1 -1
  129. package/docs/functions/reControlCharsRegex.md +1 -1
  130. package/docs/functions/readFilenamesRecursiveSync.md +1 -1
  131. package/docs/functions/readTextFileChunks.md +1 -1
  132. package/docs/functions/readTextFileChunksEx.md +1 -1
  133. package/docs/functions/readableFromAsyncIterable.md +1 -1
  134. package/docs/functions/registerCoreTools.md +1 -1
  135. package/docs/functions/registerYamlTag.md +1 -1
  136. package/docs/functions/removeMarkdownBold.md +1 -1
  137. package/docs/functions/removeMarkdownBoldAndItalic.md +1 -1
  138. package/docs/functions/removeMarkdownItalic.md +1 -1
  139. package/docs/functions/replaceWithPlaceholder.md +1 -1
  140. package/docs/functions/restoreFromPlacehoders.md +1 -1
  141. package/docs/functions/sanitizeFilename.md +1 -1
  142. package/docs/functions/sanitizeFilepath.md +1 -1
  143. package/docs/functions/saveConfigFile.md +1 -1
  144. package/docs/functions/scaleStrToParamsSize.md +1 -1
  145. package/docs/functions/shutdown.md +1 -1
  146. package/docs/functions/simplifyObjectArguments.md +1 -1
  147. package/docs/functions/sortedValues.md +1 -1
  148. package/docs/functions/splitChunks.md +1 -1
  149. package/docs/functions/splitParagraph.md +1 -1
  150. package/docs/functions/splitSentence.md +1 -1
  151. package/docs/functions/stringifyYaml.md +1 -1
  152. package/docs/functions/stripConsoleColor.md +1 -1
  153. package/docs/functions/textToDate.md +1 -1
  154. package/docs/functions/toDateTime.md +1 -1
  155. package/docs/functions/trimStartOfStreamHelper.md +1 -1
  156. package/docs/functions/truncTo.md +1 -1
  157. package/docs/functions/truncateByToken.md +1 -1
  158. package/docs/functions/truncateToTokenLimit.md +1 -1
  159. package/docs/functions/truncateToTokenLimitEx.md +1 -1
  160. package/docs/functions/uuid.md +1 -1
  161. package/docs/functions/wait.md +1 -1
  162. package/docs/functions/xxhash.md +1 -1
  163. package/docs/functions/xxhash32.md +1 -1
  164. package/docs/functions/xxhash64.md +1 -1
  165. package/docs/functions/xxhashAsStr.md +1 -1
  166. package/docs/interfaces/AIChatAssistantMessageParam.md +12 -12
  167. package/docs/interfaces/AIChatContentPartImage.md +3 -3
  168. package/docs/interfaces/AIChatContentPartText.md +3 -3
  169. package/docs/interfaces/AIChatMessageParamBase.md +7 -7
  170. package/docs/interfaces/AIChatMessageToolCall.md +4 -4
  171. package/docs/interfaces/AIChatSystemMessageParam.md +9 -9
  172. package/docs/interfaces/AIChatToolChoiceFuncObject.md +3 -3
  173. package/docs/interfaces/AIChatToolChoiceObject.md +2 -2
  174. package/docs/interfaces/AIChatToolFunc.md +5 -5
  175. package/docs/interfaces/AIChatToolFuncParam.md +3 -3
  176. package/docs/interfaces/AIChatToolMessageParam.md +10 -10
  177. package/docs/interfaces/AIChatToolParam.md +2 -2
  178. package/docs/interfaces/AIChatToolTypeObject.md +2 -2
  179. package/docs/interfaces/AIChatUserMessageParam.md +13 -13
  180. package/docs/interfaces/AIChoiceConfig.md +8 -8
  181. package/docs/interfaces/AIResult.md +6 -6
  182. package/docs/interfaces/AIStreamParser.md +2 -2
  183. package/docs/interfaces/AIStreamParserOptions.md +2 -2
  184. package/docs/interfaces/BaseFunc.md +10 -10
  185. package/docs/interfaces/BaseFuncItem.md +9 -9
  186. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
  187. package/docs/interfaces/BinarySemaphoreOptions.md +5 -5
  188. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
  189. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
  190. package/docs/interfaces/CancelableAbilityOptions.md +4 -4
  191. package/docs/interfaces/ClientFuncItem.md +12 -12
  192. package/docs/interfaces/DotenvExpandOptions.md +4 -4
  193. package/docs/interfaces/DotenvExpandOutput.md +3 -3
  194. package/docs/interfaces/DotenvParseInput.md +1 -1
  195. package/docs/interfaces/DotenvParseOutput.md +1 -1
  196. package/docs/interfaces/DotenvPopulateInput.md +1 -1
  197. package/docs/interfaces/EventClientFuncParams.md +5 -5
  198. package/docs/interfaces/EventServerFuncParams.md +6 -6
  199. package/docs/interfaces/FewShotPromptTemplateOptions.md +12 -12
  200. package/docs/interfaces/FuncItem.md +10 -10
  201. package/docs/interfaces/FuncParam.md +7 -7
  202. package/docs/interfaces/FuncParams.md +1 -1
  203. package/docs/interfaces/Funcs.md +1 -1
  204. package/docs/interfaces/HashAlgoParams.md +4 -4
  205. package/docs/interfaces/IFileMetaInfo.md +8 -8
  206. package/docs/interfaces/IReadTextFileChunksOptions.md +11 -11
  207. package/docs/interfaces/ITruncateToTokenLimitOptions.md +10 -10
  208. package/docs/interfaces/JsonFilter.md +1 -1
  209. package/docs/interfaces/ParseObjectArgumentOptions.md +11 -11
  210. package/docs/interfaces/PromptExampleSelectorOptions.md +3 -3
  211. package/docs/interfaces/PromptTemplateOptions.md +7 -7
  212. package/docs/interfaces/RemoteFuncItem.md +12 -12
  213. package/docs/interfaces/ReplacePlacehoderOptions.md +5 -5
  214. package/docs/interfaces/ResClientFuncParams.md +3 -3
  215. package/docs/interfaces/ResServerFuncParams.md +6 -6
  216. package/docs/interfaces/SanitizeFilenameOptions.md +3 -3
  217. package/docs/interfaces/SectionStringOptions.md +3 -3
  218. package/docs/interfaces/SemaphoreOptions.md +7 -7
  219. package/docs/interfaces/SemaphoreTaskItem.md +5 -5
  220. package/docs/interfaces/ServerFuncItem.md +13 -13
  221. package/docs/interfaces/ServerFuncParams.md +3 -3
  222. package/docs/interfaces/SplitSentenceOptions.md +5 -5
  223. package/docs/interfaces/StreamCallbacksAndOptions.md +5 -5
  224. package/docs/interfaces/TaskAbortControllers.md +1 -1
  225. package/docs/interfaces/TaskPromise.md +2 -2
  226. package/docs/interfaces/ToolFuncPackage.md +4 -4
  227. package/docs/type-aliases/AIChatContentPart.md +1 -1
  228. package/docs/type-aliases/AIChatMessageParam.md +1 -1
  229. package/docs/type-aliases/AIChatRole.md +1 -1
  230. package/docs/type-aliases/AIChatToolChoiceParam.md +1 -1
  231. package/docs/type-aliases/AIMessageType.md +1 -1
  232. package/docs/type-aliases/AIModelNameRule.md +1 -1
  233. package/docs/type-aliases/AIModelNameRuleFn.md +1 -1
  234. package/docs/type-aliases/AIModelNameRules.md +1 -1
  235. package/docs/type-aliases/AITextGenerationFinishReason.md +1 -1
  236. package/docs/type-aliases/ActionName.md +1 -1
  237. package/docs/type-aliases/AsyncTaskId.md +1 -1
  238. package/docs/type-aliases/BeforeShutdownListener.md +1 -1
  239. package/docs/type-aliases/EventErrorListenerFn.md +1 -1
  240. package/docs/type-aliases/EventListenerFn.md +1 -1
  241. package/docs/type-aliases/FStringPromptTemplateNode.md +1 -1
  242. package/docs/type-aliases/FuncParamType.md +1 -1
  243. package/docs/type-aliases/PromptExamples.md +1 -1
  244. package/docs/type-aliases/PromptTemplateType.md +1 -1
  245. package/docs/type-aliases/PromptType.md +1 -1
  246. package/docs/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
  247. package/docs/type-aliases/TFunc.md +1 -1
  248. package/docs/variables/AIChatRoles.md +1 -1
  249. package/docs/variables/AIMessageTypes.md +1 -1
  250. package/docs/variables/AITextGenerationFinishReasons.md +1 -1
  251. package/docs/variables/ActionNames.md +1 -1
  252. package/docs/variables/ClientToolFuncSchema.md +1 -1
  253. package/docs/variables/DEFAULT_CONFIG_NAME.md +1 -1
  254. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
  255. package/docs/variables/EventBusName.md +1 -1
  256. package/docs/variables/EventName.md +1 -1
  257. package/docs/variables/FilenameReservedRegex.md +1 -1
  258. package/docs/variables/HFBuiltins.md +1 -1
  259. package/docs/variables/LLM_TOKENIZER_NAMES.md +1 -1
  260. package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
  261. package/docs/variables/PASSING_SCORE.md +1 -1
  262. package/docs/variables/PromptTemplateTypes.md +1 -1
  263. package/docs/variables/PromptTypes.md +1 -1
  264. package/docs/variables/RStreamErrCode.md +1 -1
  265. package/docs/variables/RemoteToolFuncSchema.md +1 -1
  266. package/docs/variables/ResponseRStreamErrCode.md +1 -1
  267. package/docs/variables/SHUTDOWN_SIGNALS.md +1 -1
  268. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
  269. package/docs/variables/SecondaryCache.md +1 -1
  270. package/docs/variables/ServerToolFuncSchema.md +1 -1
  271. package/docs/variables/ToolAsyncCancelableBit.md +1 -1
  272. package/docs/variables/ToolAsyncMultiTaskBit.md +1 -1
  273. package/docs/variables/ToolAsyncPriorityBit.md +1 -1
  274. package/docs/variables/ToolFuncSchema.md +1 -1
  275. package/docs/variables/WindowsReservedNameRegex.md +1 -1
  276. package/docs/variables/base32768.md +1 -1
  277. package/docs/variables/defaultTemplateFormat.md +1 -1
  278. package/docs/variables/event.md +1 -1
  279. package/docs/variables/eventClient.md +1 -1
  280. package/docs/variables/eventServer.md +1 -1
  281. package/docs/variables/lrucache.md +1 -1
  282. package/package.json +1 -1
package/docs/classes/EnvPromptTemplate.md CHANGED
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: EnvPromptTemplate
8
8
 
9
- Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/env-prompt-template.ts#L5)
9
+ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/env-prompt-template.ts#L5)
10
10
 
11
11
  ## Extends
12
12
 
@@ -18,7 +18,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:5](https:/
18
18
 
19
19
  > **new EnvPromptTemplate**(`template`?, `options`?): [`EnvPromptTemplate`](EnvPromptTemplate.md)
20
20
 
21
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L69)
21
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L69)
22
22
 
23
23
  #### Parameters
24
24
 
@@ -44,7 +44,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://gi
44
44
 
45
45
  > **compiledTemplate**: `any`
46
46
 
47
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L21)
47
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L21)
48
48
 
49
49
  #### Inherited from
50
50
 
@@ -56,7 +56,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://gi
56
56
 
57
57
  > **data**: `undefined` \| `Record`\<`string`, `any`\>
58
58
 
59
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L24)
59
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L24)
60
60
 
61
61
  #### Inherited from
62
62
 
@@ -68,7 +68,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://gi
68
68
 
69
69
  > **inputVariables**: `undefined` \| `string`[]
70
70
 
71
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L25)
71
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L25)
72
72
 
73
73
  #### Inherited from
74
74
 
@@ -80,7 +80,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://gi
80
80
 
81
81
  > **template**: `string`
82
82
 
83
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L22)
83
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L22)
84
84
 
85
85
  #### Inherited from
86
86
 
@@ -92,7 +92,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://gi
92
92
 
93
93
  > **templateFormat**: `undefined` \| `string`
94
94
 
95
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L23)
95
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L23)
96
96
 
97
97
  #### Inherited from
98
98
 
@@ -262,7 +262,7 @@ The Root Factory class
262
262
 
263
263
  > **\_format**(`data`): `string`
264
264
 
265
- Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:35](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/env-prompt-template.ts#L35)
265
+ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:35](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/env-prompt-template.ts#L35)
266
266
 
267
267
  #### Parameters
268
268
 
@@ -284,7 +284,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:35](https:
284
284
 
285
285
  > **\_initialize**(`options`?): `void`
286
286
 
287
- Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/env-prompt-template.ts#L27)
287
+ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/env-prompt-template.ts#L27)
288
288
 
289
289
  #### Parameters
290
290
 
@@ -306,7 +306,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:27](https:
306
306
 
307
307
  > **filterData**(`data`): `Record`\<`string`, `any`\>
308
308
 
309
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L62)
309
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L62)
310
310
 
311
311
  Validate/filter the data in inputVariables
312
312
 
@@ -330,7 +330,7 @@ Validate/filter the data in inputVariables
330
330
 
331
331
  > **format**(`data`?): `Promise`\<`string`\>
332
332
 
333
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L109)
333
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L109)
334
334
 
335
335
  #### Parameters
336
336
 
@@ -352,7 +352,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://g
352
352
 
353
353
  > **getVariables**(`template`): `string`[]
354
354
 
355
- Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/env-prompt-template.ts#L23)
355
+ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/env-prompt-template.ts#L23)
356
356
 
357
357
  #### Parameters
358
358
 
@@ -370,7 +370,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:23](https:
370
370
 
371
371
  > `abstract` **initialize**(`options`?): `void`
372
372
 
373
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L96)
373
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L96)
374
374
 
375
375
  **`Internal`**
376
376
 
@@ -396,7 +396,7 @@ initialize instance method
396
396
 
397
397
  > **partial**(`data`): [`PromptTemplate`](PromptTemplate.md)
398
398
 
399
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:139](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L139)
399
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:139](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L139)
400
400
 
401
401
  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.
402
402
 
@@ -424,7 +424,7 @@ the new partial PromptTemplate instance
424
424
 
425
425
  > **toJSON**(`options`): [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
426
426
 
427
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:147](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L147)
427
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:147](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L147)
428
428
 
429
429
  #### Parameters
430
430
 
@@ -637,7 +637,7 @@ the forEach callback function
637
637
 
638
638
  > `static` **format**(`options`): `Promise`\<`string`\>
639
639
 
640
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L31)
640
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L31)
641
641
 
642
642
  #### Parameters
643
643
 
@@ -659,7 +659,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://gi
659
659
 
660
660
  > `static` **formatIf**(`options`): `Promise`\<`undefined` \| `string`\>
661
661
 
662
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L41)
662
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L41)
663
663
 
664
664
  If the given options.template is the template, perform formatting using that template.
665
665
 
@@ -747,7 +747,7 @@ the name to register
747
747
 
748
748
  > `static` **from**(`template`?, `options`?): [`PromptTemplate`](PromptTemplate.md)
749
749
 
750
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L27)
750
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L27)
751
751
 
752
752
  #### Parameters
753
753
 
@@ -929,7 +929,7 @@ the unique name in the factory
929
929
 
930
930
  > `static` **isTemplate**(`templateOpt`): `boolean`
931
931
 
932
- Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:7](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/env-prompt-template.ts#L7)
932
+ Defined in: [packages/ai-tool/src/utils/prompt/env-prompt-template.ts:7](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/env-prompt-template.ts#L7)
933
933
 
934
934
  #### Parameters
935
935