@isdk/ai-tool 0.7.0 → 0.7.1

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 (296) hide show
  1. package/dist/{chunk-LNTIQQNN.mjs → chunk-4XRPAC7C.mjs} +1 -1
  2. package/dist/funcs.d.mts +1 -1
  3. package/dist/funcs.d.ts +1 -1
  4. package/dist/funcs.mjs +1 -1
  5. package/dist/{index-BCco-g_I.d.mts → index-DEUnmyUq.d.mts} +12 -1
  6. package/dist/{index-BCco-g_I.d.ts → index-DEUnmyUq.d.ts} +12 -1
  7. package/dist/index.d.mts +3 -3
  8. package/dist/index.d.ts +3 -3
  9. package/dist/index.js +1 -1
  10. package/dist/index.mjs +1 -1
  11. package/docs/api/classes/BinarySemaphore.md +25 -25
  12. package/docs/api/classes/CancelableAbility.md +25 -25
  13. package/docs/api/classes/ClientToolTransport.md +12 -12
  14. package/docs/api/classes/ClientTools.md +65 -61
  15. package/docs/api/classes/EventClient.md +105 -90
  16. package/docs/api/classes/EventServer.md +96 -88
  17. package/docs/api/classes/EventToolFunc.md +52 -52
  18. package/docs/api/classes/FewShotPromptTemplate.md +11 -11
  19. package/docs/api/classes/HttpClientToolTransport.md +13 -13
  20. package/docs/api/classes/HttpServerToolTransport.md +24 -16
  21. package/docs/api/classes/IntSet.md +12 -12
  22. package/docs/api/classes/PromptExampleSelector.md +9 -9
  23. package/docs/api/classes/ReadableStreamError.md +2 -2
  24. package/docs/api/classes/ResClientTools.md +560 -73
  25. package/docs/api/classes/ResServerTools.md +560 -74
  26. package/docs/api/classes/RpcMethodsClientTool.md +3275 -0
  27. package/docs/api/classes/RpcMethodsServerTool.md +3224 -0
  28. package/docs/api/classes/SSEChannel.md +16 -16
  29. package/docs/api/classes/Semaphore.md +26 -26
  30. package/docs/api/classes/ServerToolTransport.md +13 -13
  31. package/docs/api/classes/ServerTools.md +61 -57
  32. package/docs/api/classes/SignalGate.md +9 -9
  33. package/docs/api/classes/SseClientPubSubTransport.md +3 -3
  34. package/docs/api/classes/SseServerPubSubTransport.md +8 -8
  35. package/docs/api/classes/TaskAbortController.md +8 -8
  36. package/docs/api/classes/ToolFunc.md +50 -50
  37. package/docs/api/classes/ToolTransport.md +7 -7
  38. package/docs/api/classes/YamlTypeBaseObject.md +2 -2
  39. package/docs/api/enumerations/AsyncFeatureBits.md +4 -4
  40. package/docs/api/enumerations/AsyncFeatures.md +4 -4
  41. package/docs/api/enumerations/HashAlgorithm.md +12 -12
  42. package/docs/api/functions/AIArgProcessor.md +1 -1
  43. package/docs/api/functions/AIStream.md +1 -1
  44. package/docs/api/functions/ChoiceArgProcessor.md +1 -1
  45. package/docs/api/functions/DefaultDateFormat.md +1 -1
  46. package/docs/api/functions/ObjectArgsToArgsInfo.md +1 -1
  47. package/docs/api/functions/RateLimit.md +1 -1
  48. package/docs/api/functions/TemplateArgProcessor.md +1 -1
  49. package/docs/api/functions/assignDirs.md +1 -1
  50. package/docs/api/functions/backendEventable.md +1 -1
  51. package/docs/api/functions/beforeShutdown.md +1 -1
  52. package/docs/api/functions/calcPerplexity.md +1 -1
  53. package/docs/api/functions/calcPerplexitySimple.md +1 -1
  54. package/docs/api/functions/completeSentences.md +1 -1
  55. package/docs/api/functions/concatText.md +1 -1
  56. package/docs/api/functions/countLLMTokens.md +1 -1
  57. package/docs/api/functions/countRegexMatches.md +1 -1
  58. package/docs/api/functions/createCallbacksTransformer.md +1 -1
  59. package/docs/api/functions/createEmptyReadableStream.md +1 -1
  60. package/docs/api/functions/createEndWithRepetitionDetector.md +1 -1
  61. package/docs/api/functions/createEventStreamTransformer.md +1 -1
  62. package/docs/api/functions/createLRUCache.md +1 -1
  63. package/docs/api/functions/createYamlObjectTag.md +1 -1
  64. package/docs/api/functions/dateToText.md +1 -1
  65. package/docs/api/functions/decodeCharset.md +1 -1
  66. package/docs/api/functions/defaultsWithConcat.md +1 -1
  67. package/docs/api/functions/detectCharset.md +1 -1
  68. package/docs/api/functions/encodeLLMTokens.md +1 -1
  69. package/docs/api/functions/ensureQuoted.md +1 -1
  70. package/docs/api/functions/expandConfig.md +1 -1
  71. package/docs/api/functions/expandPath.md +1 -1
  72. package/docs/api/functions/expandPathInObject.md +1 -1
  73. package/docs/api/functions/expandPaths.md +1 -1
  74. package/docs/api/functions/fileIsExists.md +1 -1
  75. package/docs/api/functions/filterValidFnScope.md +1 -1
  76. package/docs/api/functions/findIndexNonEmptyFrom.md +1 -1
  77. package/docs/api/functions/findPort.md +1 -1
  78. package/docs/api/functions/formatTextWithSpace.md +1 -1
  79. package/docs/api/functions/funcGetMeta.md +1 -1
  80. package/docs/api/functions/funcWithMeta.md +1 -1
  81. package/docs/api/functions/genUrlParamsStr.md +1 -1
  82. package/docs/api/functions/getAllEnumKeys.md +1 -1
  83. package/docs/api/functions/getConfigFileNames.md +1 -1
  84. package/docs/api/functions/getConfigs.md +1 -1
  85. package/docs/api/functions/getFileMetaInfo.md +1 -1
  86. package/docs/api/functions/getHashAlgoBySize.md +1 -1
  87. package/docs/api/functions/getKeysPath.md +1 -1
  88. package/docs/api/functions/getLLMTokenizer.md +1 -1
  89. package/docs/api/functions/getPackageDir.md +1 -1
  90. package/docs/api/functions/getRealFilepath.md +1 -1
  91. package/docs/api/functions/getResponseErrorReadableStream.md +1 -1
  92. package/docs/api/functions/getXDGConfigs.md +1 -1
  93. package/docs/api/functions/hasDirectoryIn.md +1 -1
  94. package/docs/api/functions/hash.md +1 -1
  95. package/docs/api/functions/hashFile.md +1 -1
  96. package/docs/api/functions/hashObject.md +1 -1
  97. package/docs/api/functions/hashStream.md +1 -1
  98. package/docs/api/functions/initShutdown.md +1 -1
  99. package/docs/api/functions/isLangUsingSpaces.md +1 -1
  100. package/docs/api/functions/isListItemString.md +1 -1
  101. package/docs/api/functions/isModelNameMatched.md +1 -1
  102. package/docs/api/functions/isPunctuationChar.md +1 -1
  103. package/docs/api/functions/isQuoted.md +1 -1
  104. package/docs/api/functions/isRegExp.md +1 -1
  105. package/docs/api/functions/isSameString.md +1 -1
  106. package/docs/api/functions/isSectionString.md +1 -1
  107. package/docs/api/functions/isSentenceEnding.md +1 -1
  108. package/docs/api/functions/isSepLineString.md +1 -1
  109. package/docs/api/functions/isStrWrapped.md +1 -1
  110. package/docs/api/functions/isSubdirectory.md +1 -1
  111. package/docs/api/functions/isTitleString.md +1 -1
  112. package/docs/api/functions/isWebStream.md +1 -1
  113. package/docs/api/functions/joinSplitWords.md +1 -1
  114. package/docs/api/functions/jsonFilterToWhere.md +1 -1
  115. package/docs/api/functions/jsonToMarkdownStr.md +1 -1
  116. package/docs/api/functions/loadAIConfig.md +1 -1
  117. package/docs/api/functions/loadConfig.md +1 -1
  118. package/docs/api/functions/loadConfigFile.md +1 -1
  119. package/docs/api/functions/loadFileFromPaths.md +1 -1
  120. package/docs/api/functions/loadTextFromPaths.md +1 -1
  121. package/docs/api/functions/lrucache.md +1 -1
  122. package/docs/api/functions/makeToolFuncCancelable.md +1 -1
  123. package/docs/api/functions/matchUrlProtocol.md +1 -1
  124. package/docs/api/functions/memoize.md +1 -1
  125. package/docs/api/functions/mergeArray.md +1 -1
  126. package/docs/api/functions/messagesToText.md +1 -1
  127. package/docs/api/functions/normalizePath.md +1 -1
  128. package/docs/api/functions/paramsSizeToScaleStr.md +1 -1
  129. package/docs/api/functions/parseCommand.md +1 -1
  130. package/docs/api/functions/parseJsJson.md +1 -1
  131. package/docs/api/functions/parseJsJsonSimpleSync.md +1 -1
  132. package/docs/api/functions/parseObjectArgInfo.md +1 -1
  133. package/docs/api/functions/parseObjectArgumentInfos.md +1 -1
  134. package/docs/api/functions/parseObjectArguments.md +1 -1
  135. package/docs/api/functions/parseObjectArgumentsAsArgInfos.md +1 -1
  136. package/docs/api/functions/pruneSubdirectories.md +1 -1
  137. package/docs/api/functions/pruneSubdirectoriesInPlace.md +1 -1
  138. package/docs/api/functions/quoteStr.md +1 -1
  139. package/docs/api/functions/readFilenamesRecursiveSync.md +1 -1
  140. package/docs/api/functions/readTextFileChunks.md +1 -1
  141. package/docs/api/functions/readTextFileChunksEx.md +1 -1
  142. package/docs/api/functions/readableFromAsyncIterable.md +1 -1
  143. package/docs/api/functions/registerCoreTools.md +1 -1
  144. package/docs/api/functions/removeMarkdownBold.md +1 -1
  145. package/docs/api/functions/removeMarkdownBoldAndItalic.md +1 -1
  146. package/docs/api/functions/removeMarkdownItalic.md +1 -1
  147. package/docs/api/functions/replaceWithPlaceholder.md +1 -1
  148. package/docs/api/functions/restoreFromPlacehoders.md +1 -1
  149. package/docs/api/functions/saveConfigFile.md +1 -1
  150. package/docs/api/functions/scaleStrToParamsSize.md +1 -1
  151. package/docs/api/functions/shutdown.md +1 -1
  152. package/docs/api/functions/simplifyObjectArguments.md +1 -1
  153. package/docs/api/functions/sleep.md +1 -1
  154. package/docs/api/functions/sortedValues.md +1 -1
  155. package/docs/api/functions/splitChunks.md +1 -1
  156. package/docs/api/functions/splitParagraph.md +1 -1
  157. package/docs/api/functions/splitSentence.md +1 -1
  158. package/docs/api/functions/splitWords.md +1 -1
  159. package/docs/api/functions/stripConsoleColor.md +1 -1
  160. package/docs/api/functions/textToDate.md +1 -1
  161. package/docs/api/functions/toDateTime.md +1 -1
  162. package/docs/api/functions/trimStartOfStreamHelper.md +1 -1
  163. package/docs/api/functions/truncTo.md +1 -1
  164. package/docs/api/functions/truncateByToken.md +1 -1
  165. package/docs/api/functions/truncateToTokenLimit.md +1 -1
  166. package/docs/api/functions/truncateToTokenLimitEx.md +1 -1
  167. package/docs/api/functions/uuid.md +1 -1
  168. package/docs/api/functions/wait.md +1 -1
  169. package/docs/api/functions/xxhash.md +1 -1
  170. package/docs/api/functions/xxhash32.md +1 -1
  171. package/docs/api/functions/xxhash64.md +1 -1
  172. package/docs/api/functions/xxhashAsStr.md +1 -1
  173. package/docs/api/functions/yieldExec.md +1 -1
  174. package/docs/api/globals.md +6 -0
  175. package/docs/api/interfaces/AIChatAssistantMessageParam.md +12 -12
  176. package/docs/api/interfaces/AIChatContentPartImage.md +3 -3
  177. package/docs/api/interfaces/AIChatContentPartText.md +3 -3
  178. package/docs/api/interfaces/AIChatMessageParamBase.md +7 -7
  179. package/docs/api/interfaces/AIChatMessageToolCall.md +4 -4
  180. package/docs/api/interfaces/AIChatSystemMessageParam.md +9 -9
  181. package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +3 -3
  182. package/docs/api/interfaces/AIChatToolChoiceObject.md +2 -2
  183. package/docs/api/interfaces/AIChatToolFunc.md +5 -5
  184. package/docs/api/interfaces/AIChatToolFuncParam.md +3 -3
  185. package/docs/api/interfaces/AIChatToolMessageParam.md +10 -10
  186. package/docs/api/interfaces/AIChatToolParam.md +2 -2
  187. package/docs/api/interfaces/AIChatToolTypeObject.md +2 -2
  188. package/docs/api/interfaces/AIChatUserMessageParam.md +13 -13
  189. package/docs/api/interfaces/AIChoiceConfig.md +8 -8
  190. package/docs/api/interfaces/AIResult.md +6 -6
  191. package/docs/api/interfaces/AIStreamParser.md +2 -2
  192. package/docs/api/interfaces/AIStreamParserOptions.md +2 -2
  193. package/docs/api/interfaces/BaseFunc.md +15 -15
  194. package/docs/api/interfaces/BaseFuncItem.md +14 -14
  195. package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
  196. package/docs/api/interfaces/BinarySemaphoreOptions.md +5 -5
  197. package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
  198. package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
  199. package/docs/api/interfaces/CancelableAbilityOptions.md +4 -4
  200. package/docs/api/interfaces/ClientFuncItem.md +17 -17
  201. package/docs/api/interfaces/EventClientFuncParams.md +5 -5
  202. package/docs/api/interfaces/EventServerFuncParams.md +6 -6
  203. package/docs/api/interfaces/FewShotPromptTemplateOptions.md +6 -6
  204. package/docs/api/interfaces/FuncItem.md +15 -15
  205. package/docs/api/interfaces/FuncParam.md +5 -5
  206. package/docs/api/interfaces/FuncParams.md +1 -1
  207. package/docs/api/interfaces/Funcs.md +1 -1
  208. package/docs/api/interfaces/HashAlgoParams.md +4 -4
  209. package/docs/api/interfaces/IClientToolTransport.md +7 -7
  210. package/docs/api/interfaces/IFileMetaInfo.md +8 -8
  211. package/docs/api/interfaces/IPubSubClientTransport.md +3 -3
  212. package/docs/api/interfaces/IPubSubServerTransport.md +9 -9
  213. package/docs/api/interfaces/IReadTextFileChunksOptions.md +11 -11
  214. package/docs/api/interfaces/IServerToolTransport.md +8 -8
  215. package/docs/api/interfaces/IToolTransport.md +5 -5
  216. package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +10 -10
  217. package/docs/api/interfaces/JsonFilter.md +1 -1
  218. package/docs/api/interfaces/ParseObjectArgumentOptions.md +11 -11
  219. package/docs/api/interfaces/ProbabilityItem.md +4 -4
  220. package/docs/api/interfaces/PromptExampleSelectorOptions.md +3 -3
  221. package/docs/api/interfaces/PubSubClient.md +2 -2
  222. package/docs/api/interfaces/PubSubClientStream.md +9 -9
  223. package/docs/api/interfaces/PubSubServerSession.md +7 -7
  224. package/docs/api/interfaces/RemoteFuncItem.md +17 -17
  225. package/docs/api/interfaces/ReplacePlacehoderOptions.md +5 -5
  226. package/docs/api/interfaces/ResClientFuncParams.md +5 -5
  227. package/docs/api/interfaces/ResServerFuncParams.md +14 -10
  228. package/docs/api/interfaces/RpcMethodsClientFuncParams.md +25 -0
  229. package/docs/api/interfaces/RpcMethodsServerFuncParams.md +61 -0
  230. package/docs/api/interfaces/SectionStringOptions.md +3 -3
  231. package/docs/api/interfaces/SemaphoreOptions.md +7 -7
  232. package/docs/api/interfaces/SemaphoreTaskItem.md +5 -5
  233. package/docs/api/interfaces/ServerFuncItem.md +18 -18
  234. package/docs/api/interfaces/ServerFuncParams.md +4 -3
  235. package/docs/api/interfaces/SplitSentenceOptions.md +5 -5
  236. package/docs/api/interfaces/StreamCallbacksAndOptions.md +5 -5
  237. package/docs/api/interfaces/TaskAbortControllers.md +1 -1
  238. package/docs/api/interfaces/TaskPromise.md +2 -2
  239. package/docs/api/interfaces/ToolFuncPackage.md +4 -4
  240. package/docs/api/type-aliases/AIChatContentPart.md +1 -1
  241. package/docs/api/type-aliases/AIChatMessageParam.md +1 -1
  242. package/docs/api/type-aliases/AIChatRole.md +1 -1
  243. package/docs/api/type-aliases/AIChatToolChoiceParam.md +1 -1
  244. package/docs/api/type-aliases/AIMessageType.md +1 -1
  245. package/docs/api/type-aliases/AIModelNameRule.md +1 -1
  246. package/docs/api/type-aliases/AIModelNameRuleFn.md +1 -1
  247. package/docs/api/type-aliases/AIModelNameRules.md +1 -1
  248. package/docs/api/type-aliases/AITextGenerationFinishReason.md +1 -1
  249. package/docs/api/type-aliases/ActionName.md +1 -1
  250. package/docs/api/type-aliases/ArrayMergeWay.md +1 -1
  251. package/docs/api/type-aliases/AsyncTaskId.md +1 -1
  252. package/docs/api/type-aliases/BeforeShutdownListener.md +1 -1
  253. package/docs/api/type-aliases/EventErrorListenerFn.md +1 -1
  254. package/docs/api/type-aliases/EventListenerFn.md +1 -1
  255. package/docs/api/type-aliases/FuncParamType.md +1 -1
  256. package/docs/api/type-aliases/PromptExamples.md +1 -1
  257. package/docs/api/type-aliases/PubSubClientId.md +1 -1
  258. package/docs/api/type-aliases/PubSubCtx.md +1 -1
  259. package/docs/api/type-aliases/RpcMethodHandler.md +1 -1
  260. package/docs/api/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
  261. package/docs/api/type-aliases/TFunc.md +1 -1
  262. package/docs/api/variables/AIChatRoles.md +1 -1
  263. package/docs/api/variables/AIMessageTypes.md +1 -1
  264. package/docs/api/variables/AITextGenerationFinishReasons.md +1 -1
  265. package/docs/api/variables/ActionNames.md +1 -1
  266. package/docs/api/variables/ArrayMergeWay.md +1 -1
  267. package/docs/api/variables/ArrayMergeWaySymbol.md +1 -1
  268. package/docs/api/variables/ClientToolFuncSchema.md +1 -1
  269. package/docs/api/variables/DEFAULT_CONFIG_NAME.md +1 -1
  270. package/docs/api/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
  271. package/docs/api/variables/EventBusName.md +1 -1
  272. package/docs/api/variables/EventName.md +1 -1
  273. package/docs/api/variables/FuncMetaSymbol.md +1 -1
  274. package/docs/api/variables/LLM_TOKENIZER_NAMES.md +1 -1
  275. package/docs/api/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
  276. package/docs/api/variables/PASSING_SCORE.md +1 -1
  277. package/docs/api/variables/RStreamErrCode.md +1 -1
  278. package/docs/api/variables/RemoteToolFuncSchema.md +1 -1
  279. package/docs/api/variables/ResponseRStreamErrCode.md +1 -1
  280. package/docs/api/variables/RpcMethodsClientToolSchema.md +49 -0
  281. package/docs/api/variables/RpcMethodsServerToolSchema.md +21 -0
  282. package/docs/api/variables/SHUTDOWN_SIGNALS.md +1 -1
  283. package/docs/api/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
  284. package/docs/api/variables/SecondaryCache.md +1 -1
  285. package/docs/api/variables/ServerToolFuncSchema.md +1 -1
  286. package/docs/api/variables/StrangeHumanName.md +1 -1
  287. package/docs/api/variables/ToolAsyncCancelableBit.md +1 -1
  288. package/docs/api/variables/ToolAsyncMultiTaskBit.md +1 -1
  289. package/docs/api/variables/ToolAsyncPriorityBit.md +1 -1
  290. package/docs/api/variables/ToolFuncSchema.md +1 -1
  291. package/docs/api/variables/base32768.md +1 -1
  292. package/docs/api/variables/event.md +1 -1
  293. package/docs/api/variables/eventClient.md +1 -1
  294. package/docs/api/variables/eventServer.md +1 -1
  295. package/docs/api/variables/lrucache.md +1 -1
  296. package/package.json +3 -3
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: AIResult\<TValue, TOptions\>
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:16](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L16)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:16](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L16)
10
10
 
11
11
  ## Type Parameters
12
12
 
@@ -24,7 +24,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:16](https://githu
24
24
 
25
25
  > `optional` **content**: `TValue`
26
26
 
27
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:20](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L20)
27
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:20](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L20)
28
28
 
29
29
  The generated value.
30
30
 
@@ -34,7 +34,7 @@ The generated value.
34
34
 
35
35
  > `optional` **finishReason**: `null` \| `"length"` \| `"abort"` \| `"stop"` \| `"content_filter"` \| `"tool_calls"` \| `"function_call"` \| `"error"` \| `"other"`
36
36
 
37
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:25](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L25)
37
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:25](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L25)
38
38
 
39
39
  The reason why the generation stopped.
40
40
 
@@ -44,7 +44,7 @@ The reason why the generation stopped.
44
44
 
45
45
  > `optional` **options**: `TOptions`
46
46
 
47
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:26](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L26)
47
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:26](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L26)
48
48
 
49
49
  ***
50
50
 
@@ -52,7 +52,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:26](https://githu
52
52
 
53
53
  > `optional` **stop**: `boolean`
54
54
 
55
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:30](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L30)
55
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:30](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L30)
56
56
 
57
57
  for stream mode
58
58
 
@@ -62,4 +62,4 @@ for stream mode
62
62
 
63
63
  > `optional` **taskId**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
64
64
 
65
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:31](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/chat.ts#L31)
65
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/chat.ts:31](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/chat.ts#L31)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: AIStreamParser()\<T, TOptions\>
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:25](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/stream/ai-stream.ts#L25)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:25](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/stream/ai-stream.ts#L25)
10
10
 
11
11
  Custom parser for AIStream data.
12
12
 
@@ -18,7 +18,7 @@ Custom parser for AIStream data.
18
18
 
19
19
  > **AIStreamParser**(`data`, `options`): `void` \| [`AIResult`](AIResult.md)\<`T`, `TOptions`\>
20
20
 
21
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:26](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/stream/ai-stream.ts#L26)
21
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:26](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/stream/ai-stream.ts#L26)
22
22
 
23
23
  Custom parser for AIStream data.
24
24
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: AIStreamParserOptions
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:14](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/stream/ai-stream.ts#L14)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:14](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/stream/ai-stream.ts#L14)
10
10
 
11
11
  Options for the AIStreamParser.
12
12
 
@@ -16,6 +16,6 @@ Options for the AIStreamParser.
16
16
 
17
17
  > `optional` **event**: `string`
18
18
 
19
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:15](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/stream/ai-stream.ts#L15)
19
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/ai-stream.ts:15](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/stream/ai-stream.ts#L15)
20
20
 
21
21
  The event (type) from the server side event stream.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: BaseFunc
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:196](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L196)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:196](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L196)
10
10
 
11
11
  Represents a fully-defined tool function where the implementation is mandatory.
12
12
 
@@ -24,7 +24,7 @@ Represents a fully-defined tool function where the implementation is mandatory.
24
24
 
25
25
  > `optional` **alias**: `string` \| `string`[]
26
26
 
27
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L130)
27
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L130)
28
28
 
29
29
  Optional aliases for the function name.
30
30
 
@@ -38,7 +38,7 @@ Optional aliases for the function name.
38
38
 
39
39
  > `optional` **asyncFeatures**: `number`
40
40
 
41
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L144)
41
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L144)
42
42
 
43
43
  A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
44
44
  This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
@@ -68,7 +68,7 @@ const func = new ToolFunc({
68
68
 
69
69
  > `optional` **depends**: `object`
70
70
 
71
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L167)
71
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L167)
72
72
 
73
73
  A map of dependencies this function has on other tool functions.
74
74
  Declaring dependencies ensures that they are automatically registered when this function is registered.
@@ -107,7 +107,7 @@ mainFunc.register();
107
107
 
108
108
  > `optional` **description**: `string`
109
109
 
110
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L172)
110
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L172)
111
111
 
112
112
  A detailed description of what the function does.
113
113
 
@@ -121,7 +121,7 @@ A detailed description of what the function does.
121
121
 
122
122
  > `optional` **isApi**: `boolean`
123
123
 
124
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L119)
124
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L119)
125
125
 
126
126
  If true, indicates that this function should be treated as a server-side API.
127
127
 
@@ -135,7 +135,7 @@ If true, indicates that this function should be treated as a server-side API.
135
135
 
136
136
  > `optional` **name**: `string`
137
137
 
138
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L76)
138
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L76)
139
139
 
140
140
  The unique name of the function.
141
141
 
@@ -149,7 +149,7 @@ The unique name of the function.
149
149
 
150
150
  > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
151
151
 
152
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L81)
152
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L81)
153
153
 
154
154
  Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
155
155
 
@@ -163,7 +163,7 @@ Parameter definitions, which can be an object mapping names to definitions or an
163
163
 
164
164
  > `optional` **result**: `string` \| `Record`\<`string`, `any`\>
165
165
 
166
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L86)
166
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L86)
167
167
 
168
168
  The expected return type of the function, described as a string or a JSON schema object.
169
169
 
@@ -177,7 +177,7 @@ The expected return type of the function, described as a string or a JSON schema
177
177
 
178
178
  > `optional` **scope**: `any`
179
179
 
180
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L91)
180
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L91)
181
181
 
182
182
  The execution scope or context (`this`) for the function.
183
183
 
@@ -191,7 +191,7 @@ The execution scope or context (`this`) for the function.
191
191
 
192
192
  > `optional` **setup**: (`this`, `options`?) => `void`
193
193
 
194
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L114)
194
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L114)
195
195
 
196
196
  A lifecycle hook called once during the `ToolFunc` instance's initialization.
197
197
  It allows for initial setup, state configuration, or property modification on the instance
@@ -237,7 +237,7 @@ console.log(myFunc.customState); // Outputs: 'configured'
237
237
 
238
238
  > `optional` **stream**: `boolean`
239
239
 
240
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L125)
240
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L125)
241
241
 
242
242
  If true, indicates that the function has the *capability* to stream its output.
243
243
  Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
@@ -252,7 +252,7 @@ Whether a specific call is streamed is determined by a `stream` property in the
252
252
 
253
253
  > `optional` **tags**: `string` \| `string`[]
254
254
 
255
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L96)
255
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L96)
256
256
 
257
257
  Tags for grouping or filtering functions.
258
258
 
@@ -266,7 +266,7 @@ Tags for grouping or filtering functions.
266
266
 
267
267
  > `optional` **title**: `string`
268
268
 
269
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L177)
269
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L177)
270
270
 
271
271
  A concise, human-readable title for the function, often used in UI or by AI.
272
272
 
@@ -280,7 +280,7 @@ A concise, human-readable title for the function, often used in UI or by AI.
280
280
 
281
281
  > **func**(...`params`): `any`
282
282
 
283
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:202](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L202)
283
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:202](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L202)
284
284
 
285
285
  The actual function implementation.
286
286
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: BaseFuncItem
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:71](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L71)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:71](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L71)
10
10
 
11
11
  Base configuration for defining a tool function.
12
12
 
@@ -22,7 +22,7 @@ Base configuration for defining a tool function.
22
22
 
23
23
  > `optional` **alias**: `string` \| `string`[]
24
24
 
25
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L130)
25
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L130)
26
26
 
27
27
  Optional aliases for the function name.
28
28
 
@@ -32,7 +32,7 @@ Optional aliases for the function name.
32
32
 
33
33
  > `optional` **asyncFeatures**: `number`
34
34
 
35
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L144)
35
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L144)
36
36
 
37
37
  A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
38
38
  This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
@@ -58,7 +58,7 @@ const func = new ToolFunc({
58
58
 
59
59
  > `optional` **depends**: `object`
60
60
 
61
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L167)
61
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L167)
62
62
 
63
63
  A map of dependencies this function has on other tool functions.
64
64
  Declaring dependencies ensures that they are automatically registered when this function is registered.
@@ -93,7 +93,7 @@ mainFunc.register();
93
93
 
94
94
  > `optional` **description**: `string`
95
95
 
96
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L172)
96
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L172)
97
97
 
98
98
  A detailed description of what the function does.
99
99
 
@@ -103,7 +103,7 @@ A detailed description of what the function does.
103
103
 
104
104
  > `optional` **isApi**: `boolean`
105
105
 
106
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L119)
106
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L119)
107
107
 
108
108
  If true, indicates that this function should be treated as a server-side API.
109
109
 
@@ -113,7 +113,7 @@ If true, indicates that this function should be treated as a server-side API.
113
113
 
114
114
  > `optional` **name**: `string`
115
115
 
116
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L76)
116
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L76)
117
117
 
118
118
  The unique name of the function.
119
119
 
@@ -123,7 +123,7 @@ The unique name of the function.
123
123
 
124
124
  > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
125
125
 
126
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L81)
126
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L81)
127
127
 
128
128
  Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
129
129
 
@@ -133,7 +133,7 @@ Parameter definitions, which can be an object mapping names to definitions or an
133
133
 
134
134
  > `optional` **result**: `string` \| `Record`\<`string`, `any`\>
135
135
 
136
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L86)
136
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L86)
137
137
 
138
138
  The expected return type of the function, described as a string or a JSON schema object.
139
139
 
@@ -143,7 +143,7 @@ The expected return type of the function, described as a string or a JSON schema
143
143
 
144
144
  > `optional` **scope**: `any`
145
145
 
146
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L91)
146
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L91)
147
147
 
148
148
  The execution scope or context (`this`) for the function.
149
149
 
@@ -153,7 +153,7 @@ The execution scope or context (`this`) for the function.
153
153
 
154
154
  > `optional` **setup**: (`this`, `options`?) => `void`
155
155
 
156
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L114)
156
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L114)
157
157
 
158
158
  A lifecycle hook called once during the `ToolFunc` instance's initialization.
159
159
  It allows for initial setup, state configuration, or property modification on the instance
@@ -195,7 +195,7 @@ console.log(myFunc.customState); // Outputs: 'configured'
195
195
 
196
196
  > `optional` **stream**: `boolean`
197
197
 
198
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L125)
198
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L125)
199
199
 
200
200
  If true, indicates that the function has the *capability* to stream its output.
201
201
  Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
@@ -206,7 +206,7 @@ Whether a specific call is streamed is determined by a `stream` property in the
206
206
 
207
207
  > `optional` **tags**: `string` \| `string`[]
208
208
 
209
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L96)
209
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L96)
210
210
 
211
211
  Tags for grouping or filtering functions.
212
212
 
@@ -216,6 +216,6 @@ Tags for grouping or filtering functions.
216
216
 
217
217
  > `optional` **title**: `string`
218
218
 
219
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L177)
219
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L177)
220
220
 
221
221
  A concise, human-readable title for the function, often used in UI or by AI.
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: BinarySemaphoreAcquireOptions
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:28](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L28)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:28](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L28)
10
10
 
11
11
  ## Extended by
12
12
 
@@ -22,4 +22,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:28](ht
22
22
 
23
23
  > `optional` **signal**: `AbortSignal`
24
24
 
25
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:29](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L29)
25
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:29](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L29)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: BinarySemaphoreOptions
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:21](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L21)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:21](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L21)
10
10
 
11
11
  ## Extended by
12
12
 
@@ -18,7 +18,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:21](ht
18
18
 
19
19
  > `optional` **capacity**: `number`
20
20
 
21
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:25](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L25)
21
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:25](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L25)
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:25](ht
26
26
 
27
27
  > `optional` **initFn**: () => `any`
28
28
 
29
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:22](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L22)
29
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:22](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L22)
30
30
 
31
31
  #### Returns
32
32
 
@@ -38,7 +38,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:22](ht
38
38
 
39
39
  > `optional` **pauseFn**: () => `void`
40
40
 
41
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:23](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L23)
41
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:23](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L23)
42
42
 
43
43
  #### Returns
44
44
 
@@ -50,7 +50,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:23](ht
50
50
 
51
51
  > `optional` **resumeFn**: () => `void`
52
52
 
53
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:24](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L24)
53
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:24](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L24)
54
54
 
55
55
  #### Returns
56
56
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: BinarySemaphoreReleaseOptions
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:33](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L33)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:33](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L33)
10
10
 
11
11
  ## Extended by
12
12
 
@@ -22,4 +22,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:33](ht
22
22
 
23
23
  > `optional` **token**: `any`
24
24
 
25
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:34](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L34)
25
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:34](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L34)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: BinarySemaphoreReleaserFunc()
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:38](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L38)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:38](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L38)
10
10
 
11
11
  ## Extends
12
12
 
@@ -14,7 +14,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:38](ht
14
14
 
15
15
  > **BinarySemaphoreReleaserFunc**(): `void`
16
16
 
17
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:39](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L39)
17
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:39](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L39)
18
18
 
19
19
  ## Returns
20
20
 
@@ -30,7 +30,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:39](ht
30
30
 
31
31
  > `optional` **token**: `any`
32
32
 
33
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:34](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/async-semaphore.ts#L34)
33
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/async-semaphore.ts:34](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/async-semaphore.ts#L34)
34
34
 
35
35
  #### Inherited from
36
36
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: CancelableAbilityOptions
8
8
 
9
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:29](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L29)
9
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:29](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L29)
10
10
 
11
11
  ## Extends
12
12
 
@@ -22,7 +22,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:29]
22
22
 
23
23
  > `optional` **asyncFeatures**: [`AsyncFeatures`](../enumerations/AsyncFeatures.md)
24
24
 
25
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:30](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L30)
25
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:30](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L30)
26
26
 
27
27
  ***
28
28
 
@@ -78,7 +78,7 @@ Defined in: @isdk/ai-tools/node\_modules/.pnpm/custom-ability@2.0.1/node\_module
78
78
 
79
79
  > `optional` **isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
80
80
 
81
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:32](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L32)
81
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:32](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L32)
82
82
 
83
83
  ***
84
84
 
@@ -86,7 +86,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:32]
86
86
 
87
87
  > `optional` **maxTaskConcurrency**: `number`
88
88
 
89
- Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:31](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/cancelable-ability.ts#L31)
89
+ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/cancelable-ability.ts:31](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/cancelable-ability.ts#L31)
90
90
 
91
91
  ***
92
92