@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
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: EventToolFunc
8
8
 
9
- Defined in: [packages/ai-tool/src/funcs/event.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event.ts#L5)
9
+ Defined in: [packages/ai-tool/src/funcs/event.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event.ts#L5)
10
10
 
11
11
  ## Extends
12
12
 
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/funcs/event.ts:5](https://github.com/isdk/ai-t
22
22
 
23
23
  > **new EventToolFunc**(`name`, `options`): [`EventToolFunc`](EventToolFunc.md)
24
24
 
25
- Defined in: [packages/ai-tool/src/tool-func.ts:192](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L192)
25
+ Defined in: [packages/ai-tool/src/tool-func.ts:192](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L192)
26
26
 
27
27
  The initial value of Object.prototype.constructor is the standard built-in Object constructor.
28
28
 
@@ -50,7 +50,7 @@ The initial value of Object.prototype.constructor is the standard built-in Objec
50
50
 
51
51
  > **\_emitter**: [`EventEmitter`](EventEmitter.md)
52
52
 
53
- Defined in: [packages/ai-tool/src/funcs/event.ts:7](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event.ts#L7)
53
+ Defined in: [packages/ai-tool/src/funcs/event.ts:7](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event.ts#L7)
54
54
 
55
55
  ***
56
56
 
@@ -106,7 +106,7 @@ The default options for export and assign
106
106
 
107
107
  > **description**: `string` = `'Return event bus'`
108
108
 
109
- Defined in: [packages/ai-tool/src/funcs/event.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event.ts#L9)
109
+ Defined in: [packages/ai-tool/src/funcs/event.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event.ts#L9)
110
110
 
111
111
  ***
112
112
 
@@ -114,7 +114,7 @@ Defined in: [packages/ai-tool/src/funcs/event.ts:9](https://github.com/isdk/ai-t
114
114
 
115
115
  > `optional` **isApi**: `boolean`
116
116
 
117
- Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L29)
117
+ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L29)
118
118
 
119
119
  #### Inherited from
120
120
 
@@ -126,7 +126,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
126
126
 
127
127
  > `optional` **name**: `string`
128
128
 
129
- Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L23)
129
+ Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L23)
130
130
 
131
131
  #### Inherited from
132
132
 
@@ -152,7 +152,7 @@ the property with the default prefix '$' will not be exported.
152
152
 
153
153
  > `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
154
154
 
155
- Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L24)
155
+ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L24)
156
156
 
157
157
  #### Inherited from
158
158
 
@@ -164,7 +164,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-to
164
164
 
165
165
  > **result**: `string` = `'event'`
166
166
 
167
- Defined in: [packages/ai-tool/src/funcs/event.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event.ts#L10)
167
+ Defined in: [packages/ai-tool/src/funcs/event.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event.ts#L10)
168
168
 
169
169
  #### Overrides
170
170
 
@@ -176,7 +176,7 @@ Defined in: [packages/ai-tool/src/funcs/event.ts:10](https://github.com/isdk/ai-
176
176
 
177
177
  > `optional` **scope**: `any`
178
178
 
179
- Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L26)
179
+ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L26)
180
180
 
181
181
  #### Inherited from
182
182
 
@@ -188,7 +188,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
188
188
 
189
189
  > `optional` **setup**: (`this`, `options`?) => `void`
190
190
 
191
- Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L28)
191
+ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L28)
192
192
 
193
193
  #### Parameters
194
194
 
@@ -214,7 +214,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
214
214
 
215
215
  > `optional` **stream**: `boolean`
216
216
 
217
- Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L30)
217
+ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L30)
218
218
 
219
219
  #### Inherited from
220
220
 
@@ -226,7 +226,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
226
226
 
227
227
  > `optional` **tags**: `string` \| `string`[]
228
228
 
229
- Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L27)
229
+ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L27)
230
230
 
231
231
  #### Inherited from
232
232
 
@@ -238,7 +238,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-to
238
238
 
239
239
  > `static` **dataPath**: `string`
240
240
 
241
- Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L57)
241
+ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L57)
242
242
 
243
243
  #### Inherited from
244
244
 
@@ -250,7 +250,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-to
250
250
 
251
251
  > `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
252
252
 
253
- Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L56)
253
+ Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L56)
254
254
 
255
255
  #### Inherited from
256
256
 
@@ -264,7 +264,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-to
264
264
 
265
265
  > **get** **emitter**(): [`EventEmitter`](EventEmitter.md)
266
266
 
267
- Defined in: [packages/ai-tool/src/funcs/event.ts:12](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event.ts#L12)
267
+ Defined in: [packages/ai-tool/src/funcs/event.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event.ts#L12)
268
268
 
269
269
  ##### Returns
270
270
 
@@ -276,7 +276,7 @@ Defined in: [packages/ai-tool/src/funcs/event.ts:12](https://github.com/isdk/ai-
276
276
 
277
277
  > **arr2ObjParams**(`params`): `any`[]
278
278
 
279
- Defined in: [packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L236)
279
+ Defined in: [packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L236)
280
280
 
281
281
  #### Parameters
282
282
 
@@ -580,7 +580,7 @@ the dest object.
580
580
 
581
581
  > **func**(): [`EventEmitter`](EventEmitter.md)
582
582
 
583
- Defined in: [packages/ai-tool/src/funcs/event.ts:17](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event.ts#L17)
583
+ Defined in: [packages/ai-tool/src/funcs/event.ts:17](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event.ts#L17)
584
584
 
585
585
  #### Returns
586
586
 
@@ -596,7 +596,7 @@ Defined in: [packages/ai-tool/src/funcs/event.ts:17](https://github.com/isdk/ai-
596
596
 
597
597
  > **getFunc**(`name`?): `any`
598
598
 
599
- Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L289)
599
+ Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L289)
600
600
 
601
601
  #### Parameters
602
602
 
@@ -618,7 +618,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-t
618
618
 
619
619
  > **getFuncWithPos**(`name`?): `any`
620
620
 
621
- Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L313)
621
+ Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L313)
622
622
 
623
623
  #### Parameters
624
624
 
@@ -660,7 +660,7 @@ the descriptors of properties object
660
660
 
661
661
  > **hasAsyncFeature**(`feature`): `boolean`
662
662
 
663
- Defined in: [packages/ai-tool/src/tool-func.ts:318](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L318)
663
+ Defined in: [packages/ai-tool/src/tool-func.ts:318](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L318)
664
664
 
665
665
  #### Parameters
666
666
 
@@ -790,7 +790,7 @@ The source object
790
790
 
791
791
  > **isStream**(`params`): `undefined` \| `boolean`
792
792
 
793
- Defined in: [packages/ai-tool/src/tool-func.ts:324](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L324)
793
+ Defined in: [packages/ai-tool/src/tool-func.ts:324](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L324)
794
794
 
795
795
  #### Parameters
796
796
 
@@ -844,7 +844,7 @@ the dest object.
844
844
 
845
845
  > **obj2ArrParams**(`params`?): `any`[]
846
846
 
847
- Defined in: [packages/ai-tool/src/tool-func.ts:249](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L249)
847
+ Defined in: [packages/ai-tool/src/tool-func.ts:249](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L249)
848
848
 
849
849
  #### Parameters
850
850
 
@@ -892,7 +892,7 @@ A property name.
892
892
 
893
893
  > **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
894
894
 
895
- Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L219)
895
+ Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L219)
896
896
 
897
897
  #### Returns
898
898
 
@@ -908,7 +908,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-t
908
908
 
909
909
  > **run**(`params`?): `Promise`\<`any`\>
910
910
 
911
- Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L276)
911
+ Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L276)
912
912
 
913
913
  #### Parameters
914
914
 
@@ -930,7 +930,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-t
930
930
 
931
931
  > **runAs**(`name`, `params`?): `Promise`\<`any`\>
932
932
 
933
- Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L280)
933
+ Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L280)
934
934
 
935
935
  #### Parameters
936
936
 
@@ -956,7 +956,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-t
956
956
 
957
957
  > **runAsSync**(`name`, `params`?): `any`
958
958
 
959
- Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L284)
959
+ Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L284)
960
960
 
961
961
  #### Parameters
962
962
 
@@ -982,7 +982,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-t
982
982
 
983
983
  > **runSync**(`params`?): `any`
984
984
 
985
- Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L262)
985
+ Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L262)
986
986
 
987
987
  #### Parameters
988
988
 
@@ -1004,7 +1004,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-t
1004
1004
 
1005
1005
  > **runWithPos**(...`params`): `Promise`\<`any`\>
1006
1006
 
1007
- Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L305)
1007
+ Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L305)
1008
1008
 
1009
1009
  #### Parameters
1010
1010
 
@@ -1026,7 +1026,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-t
1026
1026
 
1027
1027
  > **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
1028
1028
 
1029
- Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L309)
1029
+ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L309)
1030
1030
 
1031
1031
  #### Parameters
1032
1032
 
@@ -1052,7 +1052,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-t
1052
1052
 
1053
1053
  > **runWithPosAsSync**(`name`, ...`params`): `any`
1054
1054
 
1055
- Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L301)
1055
+ Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L301)
1056
1056
 
1057
1057
  #### Parameters
1058
1058
 
@@ -1078,7 +1078,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-t
1078
1078
 
1079
1079
  > **runWithPosSync**(...`params`): `any`
1080
1080
 
1081
- Defined in: [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L294)
1081
+ Defined in: [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L294)
1082
1082
 
1083
1083
  #### Parameters
1084
1084
 
@@ -1178,7 +1178,7 @@ Returns a string representation of an object.
1178
1178
 
1179
1179
  > **unregister**(): `any`
1180
1180
 
1181
- Defined in: [packages/ai-tool/src/tool-func.ts:232](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L232)
1181
+ Defined in: [packages/ai-tool/src/tool-func.ts:232](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L232)
1182
1182
 
1183
1183
  #### Returns
1184
1184
 
@@ -1714,7 +1714,7 @@ An iterable object that contains key-value entries for properties and methods.
1714
1714
 
1715
1715
  > `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
1716
1716
 
1717
- Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L59)
1717
+ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L59)
1718
1718
 
1719
1719
  #### Parameters
1720
1720
 
@@ -1736,7 +1736,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-to
1736
1736
 
1737
1737
  > `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
1738
1738
 
1739
- Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L87)
1739
+ Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L87)
1740
1740
 
1741
1741
  #### Parameters
1742
1742
 
@@ -1758,7 +1758,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-to
1758
1758
 
1759
1759
  > `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
1760
1760
 
1761
- Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L67)
1761
+ Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L67)
1762
1762
 
1763
1763
  #### Parameters
1764
1764
 
@@ -1780,7 +1780,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-to
1780
1780
 
1781
1781
  > `static` **getFunc**(`name`): `any`
1782
1782
 
1783
- Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L128)
1783
+ Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L128)
1784
1784
 
1785
1785
  #### Parameters
1786
1786
 
@@ -1802,7 +1802,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-t
1802
1802
 
1803
1803
  > `static` **getFuncWithPos**(`name`): `any`
1804
1804
 
1805
- Defined in: [packages/ai-tool/src/tool-func.ts:149](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L149)
1805
+ Defined in: [packages/ai-tool/src/tool-func.ts:149](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L149)
1806
1806
 
1807
1807
  #### Parameters
1808
1808
 
@@ -1984,7 +1984,7 @@ The object that references the prototype.
1984
1984
 
1985
1985
  > `static` **hasAsyncFeature**(`feature`): `boolean`
1986
1986
 
1987
- Defined in: [packages/ai-tool/src/tool-func.ts:105](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L105)
1987
+ Defined in: [packages/ai-tool/src/tool-func.ts:105](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L105)
1988
1988
 
1989
1989
  #### Parameters
1990
1990
 
@@ -2198,7 +2198,7 @@ Object that contains the properties and methods. This can be an object that you
2198
2198
 
2199
2199
  > `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
2200
2200
 
2201
- Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L63)
2201
+ Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L63)
2202
2202
 
2203
2203
  #### Returns
2204
2204
 
@@ -2246,7 +2246,7 @@ Object to make non-extensible.
2246
2246
 
2247
2247
  > `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
2248
2248
 
2249
- Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L154)
2249
+ Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L154)
2250
2250
 
2251
2251
  ##### Parameters
2252
2252
 
@@ -2270,7 +2270,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-t
2270
2270
 
2271
2271
  > `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
2272
2272
 
2273
- Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L155)
2273
+ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L155)
2274
2274
 
2275
2275
  ##### Parameters
2276
2276
 
@@ -2294,7 +2294,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-t
2294
2294
 
2295
2295
  > `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
2296
2296
 
2297
- Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L156)
2297
+ Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L156)
2298
2298
 
2299
2299
  ##### Parameters
2300
2300
 
@@ -2320,7 +2320,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-t
2320
2320
 
2321
2321
  > `static` **run**(`name`, `params`?): `Promise`\<`any`\>
2322
2322
 
2323
- Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L112)
2323
+ Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L112)
2324
2324
 
2325
2325
  #### Parameters
2326
2326
 
@@ -2346,7 +2346,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-t
2346
2346
 
2347
2347
  > `static` **runSync**(`name`, `params`?): `any`
2348
2348
 
2349
- Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L120)
2349
+ Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L120)
2350
2350
 
2351
2351
  #### Parameters
2352
2352
 
@@ -2372,7 +2372,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-t
2372
2372
 
2373
2373
  > `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
2374
2374
 
2375
- Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L133)
2375
+ Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L133)
2376
2376
 
2377
2377
  #### Parameters
2378
2378
 
@@ -2398,7 +2398,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-t
2398
2398
 
2399
2399
  > `static` **runWithPosSync**(`name`, ...`params`): `any`
2400
2400
 
2401
- Defined in: [packages/ai-tool/src/tool-func.ts:141](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L141)
2401
+ Defined in: [packages/ai-tool/src/tool-func.ts:141](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L141)
2402
2402
 
2403
2403
  #### Parameters
2404
2404
 
@@ -2486,7 +2486,7 @@ The value of the new prototype or null.
2486
2486
 
2487
2487
  > `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
2488
2488
 
2489
- Defined in: [packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L184)
2489
+ Defined in: [packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L184)
2490
2490
 
2491
2491
  #### Parameters
2492
2492
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: FStringPromptTemplate
8
8
 
9
- Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/f-string-prompt-template.ts#L15)
9
+ Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/f-string-prompt-template.ts#L15)
10
10
 
11
11
  ## Extends
12
12
 
@@ -18,7 +18,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:15](h
18
18
 
19
19
  > **new FStringPromptTemplate**(`template`?, `options`?): [`FStringPromptTemplate`](FStringPromptTemplate.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**: [`FStringPromptTemplateNode`](../type-aliases/FStringPromptTemplateNode.md)[]
46
46
 
47
- Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/f-string-prompt-template.ts#L16)
47
+ Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/f-string-prompt-template.ts#L16)
48
48
 
49
49
  #### Overrides
50
50
 
@@ -56,7 +56,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:16](h
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/f-string-prompt-template.ts:56](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/f-string-prompt-template.ts#L56)
265
+ Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:56](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/f-string-prompt-template.ts#L56)
266
266
 
267
267
  #### Parameters
268
268
 
@@ -284,7 +284,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:56](h
284
284
 
285
285
  > **\_initialize**(`options`?): `void`
286
286
 
287
- Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:47](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/f-string-prompt-template.ts#L47)
287
+ Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:47](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/f-string-prompt-template.ts#L47)
288
288
 
289
289
  #### Parameters
290
290
 
@@ -306,7 +306,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:47](h
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/f-string-prompt-template.ts:43](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/f-string-prompt-template.ts#L43)
355
+ Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:43](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/f-string-prompt-template.ts#L43)
356
356
 
357
357
  #### Parameters
358
358
 
@@ -370,7 +370,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:43](h
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/f-string-prompt-template.ts:18](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/f-string-prompt-template.ts#L18)
932
+ Defined in: [packages/ai-tool/src/utils/prompt/f-string-prompt-template.ts:18](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/f-string-prompt-template.ts#L18)
933
933
 
934
934
  #### Parameters
935
935