@isdk/ai-tool 0.6.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 (473) hide show
  1. package/README.cn.md +103 -237
  2. package/README.md +101 -186
  3. package/dist/chunk-4XRPAC7C.mjs +1 -0
  4. package/dist/chunk-VIG2GB47.mjs +1 -1
  5. package/dist/funcs.d.mts +1 -1
  6. package/dist/funcs.d.ts +1 -1
  7. package/dist/funcs.js +1 -1
  8. package/dist/funcs.mjs +1 -1
  9. package/dist/index-DEUnmyUq.d.mts +1792 -0
  10. package/dist/index-DEUnmyUq.d.ts +1792 -0
  11. package/dist/index.d.mts +1068 -9
  12. package/dist/index.d.ts +1068 -9
  13. package/dist/index.js +1 -1
  14. package/dist/index.mjs +1 -1
  15. package/dist/test/util.js +1 -1
  16. package/docs/api/README.md +165 -0
  17. package/docs/{_media → api/_media}/CONTRIBUTING.md +3 -3
  18. package/docs/api/_media/pubsub.md +326 -0
  19. package/docs/api/_media/server_client_tools.md +88 -0
  20. package/docs/api/_media/toolFunc.md +183 -0
  21. package/docs/api/_media/transport.md +137 -0
  22. package/docs/{classes → api/classes}/AbortError.md +139 -54
  23. package/docs/api/classes/AlreadyExistsError.md +431 -0
  24. package/docs/api/classes/BaseError.md +440 -0
  25. package/docs/{classes → api/classes}/BinarySemaphore.md +25 -25
  26. package/docs/{classes → api/classes}/CancelableAbility.md +25 -25
  27. package/docs/api/classes/ClientToolTransport.md +310 -0
  28. package/docs/{classes → api/classes}/ClientTools.md +646 -180
  29. package/docs/{classes → api/classes}/CommonError.md +139 -54
  30. package/docs/{classes → api/classes}/ConfigFile.md +54 -5
  31. package/docs/{classes → api/classes}/EnvPromptTemplate.md +94 -48
  32. package/docs/{classes → api/classes}/EventClient.md +742 -234
  33. package/docs/{classes → api/classes}/EventEmitter.md +12 -12
  34. package/docs/{classes → api/classes}/EventServer.md +670 -209
  35. package/docs/{classes → api/classes}/EventToolFunc.md +561 -109
  36. package/docs/{classes → api/classes}/FStringPromptTemplate.md +94 -48
  37. package/docs/{classes → api/classes}/FewShotPromptTemplate.md +100 -52
  38. package/docs/{classes → api/classes}/GolangPromptTemplate.md +99 -53
  39. package/docs/api/classes/HttpClientToolTransport.md +324 -0
  40. package/docs/api/classes/HttpServerToolTransport.md +332 -0
  41. package/docs/{classes → api/classes}/IntSet.md +12 -12
  42. package/docs/{classes → api/classes}/LRUCache.md +26 -26
  43. package/docs/api/classes/NotFoundError.md +431 -0
  44. package/docs/api/classes/NotImplementationError.md +431 -0
  45. package/docs/{classes → api/classes}/PromptExampleSelector.md +9 -9
  46. package/docs/{classes → api/classes}/PromptTemplate.md +91 -47
  47. package/docs/api/classes/ReadableStreamError.md +451 -0
  48. package/docs/api/classes/ResClientTools.md +3365 -0
  49. package/docs/api/classes/ResServerTools.md +3342 -0
  50. package/docs/api/classes/RpcMethodsClientTool.md +3275 -0
  51. package/docs/api/classes/RpcMethodsServerTool.md +3224 -0
  52. package/docs/api/classes/SSEChannel.md +272 -0
  53. package/docs/{classes → api/classes}/Semaphore.md +26 -26
  54. package/docs/api/classes/ServerToolTransport.md +323 -0
  55. package/docs/{classes → api/classes}/ServerTools.md +583 -120
  56. package/docs/{classes → api/classes}/SignalGate.md +9 -9
  57. package/docs/api/classes/SseClientPubSubTransport.md +92 -0
  58. package/docs/api/classes/SseServerPubSubTransport.md +234 -0
  59. package/docs/{classes → api/classes}/TaskAbortController.md +9 -9
  60. package/docs/api/classes/ToolFunc.md +2665 -0
  61. package/docs/api/classes/ToolTransport.md +143 -0
  62. package/docs/api/classes/YamlTypeBaseObject.md +31 -0
  63. package/docs/api/enumerations/AsyncFeatureBits.md +33 -0
  64. package/docs/api/enumerations/AsyncFeatures.md +33 -0
  65. package/docs/api/enumerations/ErrorCode.md +177 -0
  66. package/docs/api/enumerations/HashAlgorithm.md +97 -0
  67. package/docs/{functions → api/functions}/AIArgProcessor.md +1 -1
  68. package/docs/{functions → api/functions}/AIStream.md +1 -1
  69. package/docs/{functions → api/functions}/ChoiceArgProcessor.md +1 -1
  70. package/docs/api/functions/DefaultDateFormat.md +21 -0
  71. package/docs/{functions → api/functions}/ObjectArgsToArgsInfo.md +1 -1
  72. package/docs/{functions → api/functions}/RateLimit.md +1 -1
  73. package/docs/{functions → api/functions}/TemplateArgProcessor.md +1 -1
  74. package/docs/api/functions/addDate.md +71 -0
  75. package/docs/{functions → api/functions}/assignDirs.md +1 -1
  76. package/docs/{functions → api/functions}/backendEventable.md +1 -1
  77. package/docs/{functions → api/functions}/beforeShutdown.md +1 -1
  78. package/docs/api/functions/calcPerplexity.md +60 -0
  79. package/docs/api/functions/calcPerplexitySimple.md +42 -0
  80. package/docs/api/functions/canonicalize.md +33 -0
  81. package/docs/{functions → api/functions}/completeSentences.md +1 -1
  82. package/docs/{functions → api/functions}/concatText.md +1 -1
  83. package/docs/{functions → api/functions}/countLLMTokens.md +1 -1
  84. package/docs/{functions → api/functions}/countRegexMatches.md +1 -1
  85. package/docs/{functions → api/functions}/createAbilityInjector.md +4 -4
  86. package/docs/{functions → api/functions}/createCallbacksTransformer.md +1 -1
  87. package/docs/{functions → api/functions}/createEmptyReadableStream.md +1 -1
  88. package/docs/{functions → api/functions}/createEndWithRepetitionDetector.md +1 -1
  89. package/docs/{functions → api/functions}/createError.md +1 -1
  90. package/docs/{functions → api/functions}/createEventStreamTransformer.md +1 -1
  91. package/docs/{functions → api/functions}/createHfValueFunc.md +1 -1
  92. package/docs/{functions → api/functions}/createLRUCache.md +1 -1
  93. package/docs/{functions → api/functions}/createYamlObjectTag.md +1 -1
  94. package/docs/{functions → api/functions}/dateToText.md +1 -1
  95. package/docs/{functions → api/functions}/decodeCharset.md +1 -1
  96. package/docs/api/functions/defaultsWithConcat.md +74 -0
  97. package/docs/{functions → api/functions}/detectCharset.md +1 -1
  98. package/docs/{functions → api/functions}/encodeLLMTokens.md +1 -1
  99. package/docs/{functions → api/functions}/ensureQuoted.md +1 -1
  100. package/docs/{functions → api/functions}/eventable.md +1 -1
  101. package/docs/{functions → api/functions}/expandConfig.md +1 -1
  102. package/docs/{functions → api/functions}/expandEnv.md +1 -1
  103. package/docs/{functions → api/functions}/expandObjEnv.md +1 -1
  104. package/docs/{functions → api/functions}/expandPath.md +1 -1
  105. package/docs/api/functions/expandPathInObject.md +29 -0
  106. package/docs/api/functions/expandPaths.md +25 -0
  107. package/docs/{functions → api/functions}/extNameLevel.md +1 -1
  108. package/docs/{functions → api/functions}/fileIsExists.md +1 -1
  109. package/docs/{functions → api/functions}/filterValidFnScope.md +1 -1
  110. package/docs/{functions → api/functions}/findIndexNonEmptyFrom.md +1 -1
  111. package/docs/{functions → api/functions}/findPort.md +1 -1
  112. package/docs/{functions → api/functions}/formatISO.md +1 -1
  113. package/docs/{functions → api/functions}/formatTextWithSpace.md +1 -1
  114. package/docs/api/functions/funcGetMeta.md +27 -0
  115. package/docs/api/functions/funcWithMeta.md +41 -0
  116. package/docs/api/functions/genUrlParamsStr.md +27 -0
  117. package/docs/{functions → api/functions}/getAllEnumKeys.md +1 -1
  118. package/docs/{functions → api/functions}/getConfigFileNames.md +1 -1
  119. package/docs/{functions → api/functions}/getConfigs.md +1 -1
  120. package/docs/{functions → api/functions}/getEnvVairables.md +1 -1
  121. package/docs/{functions → api/functions}/getFileMetaInfo.md +1 -1
  122. package/docs/{functions → api/functions}/getHashAlgoBySize.md +1 -1
  123. package/docs/{functions → api/functions}/getKeysPath.md +1 -1
  124. package/docs/{functions → api/functions}/getLLMTokenizer.md +1 -1
  125. package/docs/{functions → api/functions}/getMultiLevelExtname.md +1 -1
  126. package/docs/{functions → api/functions}/getPackageDir.md +1 -1
  127. package/docs/{functions → api/functions}/getRealFilepath.md +1 -1
  128. package/docs/{functions → api/functions}/getResponseErrorReadableStream.md +1 -1
  129. package/docs/{functions → api/functions}/getXDGConfigs.md +1 -1
  130. package/docs/{functions → api/functions}/hasDirectoryIn.md +1 -1
  131. package/docs/{functions → api/functions}/hash.md +1 -1
  132. package/docs/{functions → api/functions}/hashFile.md +1 -1
  133. package/docs/api/functions/hashObject.md +25 -0
  134. package/docs/{functions → api/functions}/hashStream.md +1 -1
  135. package/docs/api/functions/initShutdown.md +15 -0
  136. package/docs/{functions → api/functions}/isLangUsingSpaces.md +1 -1
  137. package/docs/{functions → api/functions}/isListItemString.md +1 -1
  138. package/docs/{functions → api/functions}/isModelNameMatched.md +1 -1
  139. package/docs/{functions → api/functions}/isPunctuationChar.md +1 -1
  140. package/docs/{functions → api/functions}/isQuoted.md +1 -1
  141. package/docs/{functions → api/functions}/isRegExp.md +1 -1
  142. package/docs/{functions → api/functions}/isSameString.md +1 -1
  143. package/docs/{functions → api/functions}/isSectionString.md +1 -1
  144. package/docs/{functions → api/functions}/isSentenceEnding.md +1 -1
  145. package/docs/{functions → api/functions}/isSepLineString.md +1 -1
  146. package/docs/{functions → api/functions}/isStrWrapped.md +1 -1
  147. package/docs/{functions → api/functions}/isSubdirectory.md +2 -2
  148. package/docs/{functions → api/functions}/isTitleString.md +1 -1
  149. package/docs/{functions → api/functions}/isValidFilename.md +1 -1
  150. package/docs/{functions → api/functions}/isValidFilepath.md +1 -1
  151. package/docs/{functions → api/functions}/isWebStream.md +1 -1
  152. package/docs/api/functions/joinSplitWords.md +46 -0
  153. package/docs/{functions → api/functions}/jsonFilterToWhere.md +1 -1
  154. package/docs/{functions → api/functions}/jsonToMarkdownStr.md +9 -1
  155. package/docs/{functions → api/functions}/loadAIConfig.md +1 -1
  156. package/docs/{functions → api/functions}/loadConfig.md +1 -1
  157. package/docs/{functions → api/functions}/loadConfigFile.md +1 -1
  158. package/docs/{functions → api/functions}/loadFileFromPaths.md +1 -1
  159. package/docs/{functions → api/functions}/loadTextFromPaths.md +1 -1
  160. package/docs/{functions → api/functions}/lrucache.md +1 -1
  161. package/docs/{functions → api/functions}/makeToolFuncCancelable.md +1 -1
  162. package/docs/{functions → api/functions}/matchUrlProtocol.md +1 -1
  163. package/docs/{functions → api/functions}/memoize.md +1 -1
  164. package/docs/api/functions/mergeArray.md +57 -0
  165. package/docs/{functions → api/functions}/messagesToText.md +1 -1
  166. package/docs/api/functions/normalizePath.md +21 -0
  167. package/docs/{functions → api/functions}/paramsSizeToScaleStr.md +1 -1
  168. package/docs/{functions → api/functions}/parseCommand.md +1 -1
  169. package/docs/{functions → api/functions}/parseDateFormat.md +1 -1
  170. package/docs/{functions → api/functions}/parseISO.md +1 -1
  171. package/docs/{functions → api/functions}/parseJsJson.md +1 -1
  172. package/docs/{functions → api/functions}/parseJsJsonSimpleSync.md +1 -1
  173. package/docs/{functions → api/functions}/parseObjectArgInfo.md +1 -1
  174. package/docs/{functions → api/functions}/parseObjectArgumentInfos.md +1 -1
  175. package/docs/{functions → api/functions}/parseObjectArguments.md +1 -1
  176. package/docs/{functions → api/functions}/parseObjectArgumentsAsArgInfos.md +1 -1
  177. package/docs/{functions → api/functions}/parseYaml.md +1 -1
  178. package/docs/api/functions/pruneSubdirectories.md +35 -0
  179. package/docs/api/functions/pruneSubdirectoriesInPlace.md +38 -0
  180. package/docs/{functions → api/functions}/quoteStr.md +1 -1
  181. package/docs/{functions → api/functions}/readFilenamesRecursiveSync.md +1 -1
  182. package/docs/{functions → api/functions}/readTextFileChunks.md +1 -1
  183. package/docs/{functions → api/functions}/readTextFileChunksEx.md +1 -1
  184. package/docs/{functions → api/functions}/readableFromAsyncIterable.md +1 -1
  185. package/docs/{functions → api/functions}/registerCoreTools.md +1 -1
  186. package/docs/{functions → api/functions}/registerYamlTag.md +1 -1
  187. package/docs/{functions → api/functions}/removeMarkdownBold.md +1 -1
  188. package/docs/{functions → api/functions}/removeMarkdownBoldAndItalic.md +1 -1
  189. package/docs/{functions → api/functions}/removeMarkdownItalic.md +1 -1
  190. package/docs/{functions → api/functions}/replaceWithPlaceholder.md +1 -1
  191. package/docs/{functions → api/functions}/restoreFromPlacehoders.md +1 -1
  192. package/docs/{functions → api/functions}/sanitizeFilename.md +1 -1
  193. package/docs/{functions → api/functions}/sanitizeFilepath.md +1 -1
  194. package/docs/{functions → api/functions}/saveConfigFile.md +1 -1
  195. package/docs/{functions → api/functions}/scaleStrToParamsSize.md +1 -1
  196. package/docs/{functions → api/functions}/shutdown.md +1 -1
  197. package/docs/{functions → api/functions}/simplifyObjectArguments.md +1 -1
  198. package/docs/api/functions/sleep.md +36 -0
  199. package/docs/{functions → api/functions}/sortedValues.md +1 -1
  200. package/docs/{functions → api/functions}/splitChunks.md +1 -1
  201. package/docs/{functions → api/functions}/splitParagraph.md +1 -1
  202. package/docs/{functions → api/functions}/splitSentence.md +1 -1
  203. package/docs/api/functions/splitWords.md +42 -0
  204. package/docs/{functions → api/functions}/stringifyYaml.md +1 -1
  205. package/docs/{functions → api/functions}/stripConsoleColor.md +1 -1
  206. package/docs/{functions → api/functions}/textToDate.md +1 -1
  207. package/docs/{functions → api/functions}/throwError.md +3 -3
  208. package/docs/{functions → api/functions}/toDate.md +1 -1
  209. package/docs/{functions → api/functions}/toDateTime.md +1 -1
  210. package/docs/{functions → api/functions}/toRegExp.md +1 -1
  211. package/docs/{functions → api/functions}/trimStartOfStreamHelper.md +1 -1
  212. package/docs/{functions → api/functions}/truncTo.md +1 -1
  213. package/docs/{functions → api/functions}/truncateByToken.md +1 -1
  214. package/docs/{functions → api/functions}/truncateToTokenLimit.md +1 -1
  215. package/docs/{functions → api/functions}/truncateToTokenLimitEx.md +1 -1
  216. package/docs/{functions → api/functions}/uuid.md +1 -1
  217. package/docs/{functions → api/functions}/uuidParse.md +1 -1
  218. package/docs/{functions → api/functions}/uuidStringify.md +1 -1
  219. package/docs/{functions → api/functions}/uuidValidate.md +1 -1
  220. package/docs/{functions → api/functions}/uuidVersion.md +1 -1
  221. package/docs/{functions → api/functions}/uuidv1.md +9 -5
  222. package/docs/{functions → api/functions}/uuidv4.md +9 -5
  223. package/docs/{functions → api/functions}/uuidv5.md +9 -5
  224. package/docs/api/functions/wait.md +45 -0
  225. package/docs/{functions → api/functions}/wrapEventEmitter.md +1 -1
  226. package/docs/{functions → api/functions}/xxhash.md +1 -1
  227. package/docs/{functions → api/functions}/xxhash32.md +1 -1
  228. package/docs/{functions → api/functions}/xxhash64.md +1 -1
  229. package/docs/{functions → api/functions}/xxhashAsStr.md +1 -1
  230. package/docs/api/functions/yieldExec.md +27 -0
  231. package/docs/{globals.md → api/globals.md} +50 -1
  232. package/docs/api/interfaces/AIChatAssistantMessageParam.md +129 -0
  233. package/docs/api/interfaces/AIChatContentPartImage.md +29 -0
  234. package/docs/api/interfaces/AIChatContentPartText.md +25 -0
  235. package/docs/api/interfaces/AIChatMessageParamBase.md +68 -0
  236. package/docs/api/interfaces/AIChatMessageToolCall.md +41 -0
  237. package/docs/{interfaces → api/interfaces}/AIChatSystemMessageParam.md +9 -9
  238. package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +37 -0
  239. package/docs/api/interfaces/AIChatToolChoiceObject.md +25 -0
  240. package/docs/api/interfaces/AIChatToolFunc.md +41 -0
  241. package/docs/api/interfaces/AIChatToolFuncParam.md +37 -0
  242. package/docs/api/interfaces/AIChatToolMessageParam.md +113 -0
  243. package/docs/api/interfaces/AIChatToolParam.md +25 -0
  244. package/docs/api/interfaces/AIChatToolTypeObject.md +17 -0
  245. package/docs/api/interfaces/AIChatUserMessageParam.md +137 -0
  246. package/docs/api/interfaces/AIChoiceConfig.md +65 -0
  247. package/docs/api/interfaces/AIResult.md +65 -0
  248. package/docs/{interfaces → api/interfaces}/AIStreamParser.md +2 -2
  249. package/docs/api/interfaces/AIStreamParserOptions.md +21 -0
  250. package/docs/api/interfaces/BaseFunc.md +299 -0
  251. package/docs/api/interfaces/BaseFuncItem.md +221 -0
  252. package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
  253. package/docs/api/interfaces/BinarySemaphoreOptions.md +57 -0
  254. package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
  255. package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
  256. package/docs/api/interfaces/CancelableAbilityOptions.md +113 -0
  257. package/docs/api/interfaces/ClientFuncItem.md +326 -0
  258. package/docs/api/interfaces/EventClientFuncParams.md +51 -0
  259. package/docs/api/interfaces/EventServerFuncParams.md +73 -0
  260. package/docs/{interfaces → api/interfaces}/FewShotPromptTemplateOptions.md +24 -12
  261. package/docs/api/interfaces/FuncItem.md +281 -0
  262. package/docs/api/interfaces/FuncParam.md +51 -0
  263. package/docs/api/interfaces/FuncParams.md +28 -0
  264. package/docs/api/interfaces/Funcs.md +15 -0
  265. package/docs/api/interfaces/HashAlgoParams.md +33 -0
  266. package/docs/api/interfaces/IClientToolTransport.md +155 -0
  267. package/docs/api/interfaces/IFileMetaInfo.md +65 -0
  268. package/docs/api/interfaces/IPubSubClientTransport.md +70 -0
  269. package/docs/api/interfaces/IPubSubServerTransport.md +241 -0
  270. package/docs/api/interfaces/IReadTextFileChunksOptions.md +143 -0
  271. package/docs/api/interfaces/IServerToolTransport.md +159 -0
  272. package/docs/api/interfaces/IToolTransport.md +73 -0
  273. package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +99 -0
  274. package/docs/api/interfaces/JsonFilter.md +13 -0
  275. package/docs/api/interfaces/ParseObjectArgumentOptions.md +89 -0
  276. package/docs/api/interfaces/ProbabilityItem.md +41 -0
  277. package/docs/api/interfaces/PromptExampleSelectorOptions.md +34 -0
  278. package/docs/{interfaces → api/interfaces}/PromptTemplateOptions.md +15 -7
  279. package/docs/api/interfaces/PubSubClient.md +27 -0
  280. package/docs/api/interfaces/PubSubClientStream.md +196 -0
  281. package/docs/api/interfaces/PubSubServerSession.md +103 -0
  282. package/docs/api/interfaces/RemoteFuncItem.md +316 -0
  283. package/docs/api/interfaces/ReplacePlacehoderOptions.md +41 -0
  284. package/docs/api/interfaces/ResClientFuncParams.md +37 -0
  285. package/docs/api/interfaces/ResServerFuncParams.md +77 -0
  286. package/docs/api/interfaces/RpcMethodsClientFuncParams.md +25 -0
  287. package/docs/api/interfaces/RpcMethodsServerFuncParams.md +61 -0
  288. package/docs/api/interfaces/SanitizeFilenameOptions.md +25 -0
  289. package/docs/api/interfaces/SectionStringOptions.md +25 -0
  290. package/docs/api/interfaces/SemaphoreOptions.md +89 -0
  291. package/docs/api/interfaces/SemaphoreTaskItem.md +73 -0
  292. package/docs/api/interfaces/ServerFuncItem.md +339 -0
  293. package/docs/api/interfaces/ServerFuncParams.md +42 -0
  294. package/docs/api/interfaces/SplitSentenceOptions.md +41 -0
  295. package/docs/{interfaces → api/interfaces}/StreamCallbacksAndOptions.md +5 -5
  296. package/docs/{interfaces → api/interfaces}/TaskAbortControllers.md +1 -1
  297. package/docs/{interfaces → api/interfaces}/TaskPromise.md +6 -6
  298. package/docs/api/interfaces/ToolFuncPackage.md +57 -0
  299. package/docs/{namespaces → api/namespaces}/EventStates/variables/ABORT.md +1 -1
  300. package/docs/{namespaces → api/namespaces}/EventStates/variables/CONTINUE.md +1 -1
  301. package/docs/{namespaces → api/namespaces}/EventStates/variables/DONE.md +1 -1
  302. package/docs/{namespaces → api/namespaces}/EventStates/variables/STOPPED.md +1 -1
  303. package/docs/{namespaces → api/namespaces}/uuidv5/variables/DNS.md +1 -1
  304. package/docs/{namespaces → api/namespaces}/uuidv5/variables/URL.md +1 -1
  305. package/docs/{type-aliases → api/type-aliases}/AIChatContentPart.md +1 -1
  306. package/docs/{type-aliases → api/type-aliases}/AIChatMessageParam.md +1 -1
  307. package/docs/{type-aliases → api/type-aliases}/AIChatRole.md +1 -1
  308. package/docs/{type-aliases → api/type-aliases}/AIChatToolChoiceParam.md +1 -1
  309. package/docs/{type-aliases → api/type-aliases}/AIMessageType.md +1 -1
  310. package/docs/api/type-aliases/AIModelNameRule.md +14 -0
  311. package/docs/api/type-aliases/AIModelNameRuleFn.md +28 -0
  312. package/docs/api/type-aliases/AIModelNameRules.md +13 -0
  313. package/docs/{type-aliases → api/type-aliases}/AITextGenerationFinishReason.md +1 -1
  314. package/docs/api/type-aliases/ActionName.md +13 -0
  315. package/docs/api/type-aliases/ArrayMergeWay.md +11 -0
  316. package/docs/api/type-aliases/AsyncTaskId.md +11 -0
  317. package/docs/{type-aliases → api/type-aliases}/BeforeShutdownListener.md +1 -1
  318. package/docs/{type-aliases → api/type-aliases}/EventErrorListenerFn.md +1 -1
  319. package/docs/{type-aliases → api/type-aliases}/EventListenerFn.md +1 -1
  320. package/docs/api/type-aliases/FuncParamType.md +13 -0
  321. package/docs/{type-aliases → api/type-aliases}/PromptExamples.md +1 -1
  322. package/docs/api/type-aliases/PubSubClientId.md +14 -0
  323. package/docs/api/type-aliases/PubSubCtx.md +37 -0
  324. package/docs/api/type-aliases/RpcMethodHandler.md +34 -0
  325. package/docs/{type-aliases → api/type-aliases}/SemaphoreIsReadyFuncType.md +1 -1
  326. package/docs/api/type-aliases/TFunc.md +33 -0
  327. package/docs/{variables → api/variables}/AIChatRoles.md +1 -1
  328. package/docs/{variables → api/variables}/AIMessageTypes.md +1 -1
  329. package/docs/{variables → api/variables}/AITextGenerationFinishReasons.md +1 -1
  330. package/docs/{variables → api/variables}/AbortErrorCode.md +1 -1
  331. package/docs/api/variables/ActionNames.md +13 -0
  332. package/docs/{variables → api/variables}/AlreadyExistsErrorCode.md +1 -1
  333. package/docs/api/variables/ArrayMergeWay.md +25 -0
  334. package/docs/api/variables/ArrayMergeWaySymbol.md +11 -0
  335. package/docs/api/variables/ClientToolFuncSchema.md +83 -0
  336. package/docs/{variables → api/variables}/DEFAULT_CONFIG_NAME.md +1 -1
  337. package/docs/{variables → api/variables}/DefaultAsyncSemaphoreCapacity.md +1 -1
  338. package/docs/api/variables/EventBusName.md +11 -0
  339. package/docs/api/variables/EventName.md +11 -0
  340. package/docs/{variables → api/variables}/FilenameReservedRegex.md +1 -1
  341. package/docs/api/variables/FuncMetaSymbol.md +15 -0
  342. package/docs/{variables → api/variables}/InternalErrorCode.md +1 -1
  343. package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES.md +1 -1
  344. package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES_MAP.md +1 -1
  345. package/docs/{variables → api/variables}/NotFoundErrorCode.md +1 -1
  346. package/docs/{variables → api/variables}/NotImplementedErrorCode.md +1 -1
  347. package/docs/api/variables/PASSING_SCORE.md +13 -0
  348. package/docs/api/variables/RStreamErrCode.md +11 -0
  349. package/docs/api/variables/RemoteToolFuncSchema.md +84 -0
  350. package/docs/api/variables/ResponseRStreamErrCode.md +11 -0
  351. package/docs/api/variables/RpcMethodsClientToolSchema.md +49 -0
  352. package/docs/api/variables/RpcMethodsServerToolSchema.md +21 -0
  353. package/docs/{variables → api/variables}/SHUTDOWN_SIGNALS.md +1 -1
  354. package/docs/{variables → api/variables}/SSEChannelAlreadyClosedErrCode.md +1 -1
  355. package/docs/api/variables/SecondaryCache.md +11 -0
  356. package/docs/api/variables/ServerToolFuncSchema.md +83 -0
  357. package/docs/api/variables/StrangeHumanName.md +11 -0
  358. package/docs/api/variables/ToolAsyncCancelableBit.md +11 -0
  359. package/docs/api/variables/ToolAsyncMultiTaskBit.md +11 -0
  360. package/docs/api/variables/ToolAsyncPriorityBit.md +11 -0
  361. package/docs/{variables → api/variables}/ToolFuncSchema.md +14 -1
  362. package/docs/{variables → api/variables}/WindowsReservedNameRegex.md +1 -1
  363. package/docs/api/variables/base32768.md +11 -0
  364. package/docs/{variables → api/variables}/defaultTemplateFormat.md +1 -1
  365. package/docs/api/variables/event.md +11 -0
  366. package/docs/api/variables/eventClient.md +11 -0
  367. package/docs/api/variables/eventServer.md +11 -0
  368. package/docs/api/variables/lrucache.md +11 -0
  369. package/docs/{variables → api/variables}/mimeType.md +1 -1
  370. package/docs/{variables → api/variables}/uuidNIL.md +1 -1
  371. package/docs/pubsub.md +326 -0
  372. package/docs/server_client_tools.md +88 -0
  373. package/docs/toolFunc.md +183 -0
  374. package/docs/transport.md +137 -0
  375. package/package.json +37 -39
  376. package/dist/chunk-OYDBRUZJ.mjs +0 -1
  377. package/dist/index-BkwhCK1q.d.mts +0 -899
  378. package/dist/index-BkwhCK1q.d.ts +0 -899
  379. package/docs/README.md +0 -250
  380. package/docs/classes/AlreadyExistsError.md +0 -346
  381. package/docs/classes/BaseError.md +0 -359
  382. package/docs/classes/NotFoundError.md +0 -346
  383. package/docs/classes/NotImplementationError.md +0 -346
  384. package/docs/classes/ReadableStreamError.md +0 -366
  385. package/docs/classes/ResClientTools.md +0 -2451
  386. package/docs/classes/ResServerTools.md +0 -2427
  387. package/docs/classes/SSEChannel.md +0 -270
  388. package/docs/classes/ToolFunc.md +0 -2201
  389. package/docs/classes/YamlTypeBaseObject.md +0 -31
  390. package/docs/enumerations/AsyncFeatureBits.md +0 -33
  391. package/docs/enumerations/AsyncFeatures.md +0 -33
  392. package/docs/enumerations/ErrorCode.md +0 -177
  393. package/docs/enumerations/HashAlgorithm.md +0 -97
  394. package/docs/functions/canonicalize.md +0 -21
  395. package/docs/functions/initShutdown.md +0 -15
  396. package/docs/functions/wait.md +0 -21
  397. package/docs/interfaces/AIChatAssistantMessageParam.md +0 -129
  398. package/docs/interfaces/AIChatContentPartImage.md +0 -29
  399. package/docs/interfaces/AIChatContentPartText.md +0 -25
  400. package/docs/interfaces/AIChatMessageParamBase.md +0 -68
  401. package/docs/interfaces/AIChatMessageToolCall.md +0 -41
  402. package/docs/interfaces/AIChatToolChoiceFuncObject.md +0 -37
  403. package/docs/interfaces/AIChatToolChoiceObject.md +0 -25
  404. package/docs/interfaces/AIChatToolFunc.md +0 -41
  405. package/docs/interfaces/AIChatToolFuncParam.md +0 -37
  406. package/docs/interfaces/AIChatToolMessageParam.md +0 -113
  407. package/docs/interfaces/AIChatToolParam.md +0 -25
  408. package/docs/interfaces/AIChatToolTypeObject.md +0 -17
  409. package/docs/interfaces/AIChatUserMessageParam.md +0 -137
  410. package/docs/interfaces/AIChoiceConfig.md +0 -65
  411. package/docs/interfaces/AIResult.md +0 -65
  412. package/docs/interfaces/AIStreamParserOptions.md +0 -21
  413. package/docs/interfaces/BaseFunc.md +0 -157
  414. package/docs/interfaces/BaseFuncItem.md +0 -101
  415. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +0 -25
  416. package/docs/interfaces/BinarySemaphoreOptions.md +0 -57
  417. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +0 -25
  418. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +0 -37
  419. package/docs/interfaces/CancelableAbilityOptions.md +0 -113
  420. package/docs/interfaces/ClientFuncItem.md +0 -175
  421. package/docs/interfaces/EventClientFuncParams.md +0 -51
  422. package/docs/interfaces/EventServerFuncParams.md +0 -67
  423. package/docs/interfaces/FuncItem.md +0 -143
  424. package/docs/interfaces/FuncParam.md +0 -61
  425. package/docs/interfaces/FuncParams.md +0 -13
  426. package/docs/interfaces/Funcs.md +0 -13
  427. package/docs/interfaces/HashAlgoParams.md +0 -33
  428. package/docs/interfaces/IFileMetaInfo.md +0 -65
  429. package/docs/interfaces/IReadTextFileChunksOptions.md +0 -143
  430. package/docs/interfaces/ITruncateToTokenLimitOptions.md +0 -99
  431. package/docs/interfaces/JsonFilter.md +0 -13
  432. package/docs/interfaces/ParseObjectArgumentOptions.md +0 -89
  433. package/docs/interfaces/PromptExampleSelectorOptions.md +0 -34
  434. package/docs/interfaces/RemoteFuncItem.md +0 -164
  435. package/docs/interfaces/ReplacePlacehoderOptions.md +0 -41
  436. package/docs/interfaces/ResClientFuncParams.md +0 -37
  437. package/docs/interfaces/ResServerFuncParams.md +0 -69
  438. package/docs/interfaces/SanitizeFilenameOptions.md +0 -25
  439. package/docs/interfaces/SectionStringOptions.md +0 -25
  440. package/docs/interfaces/SemaphoreOptions.md +0 -89
  441. package/docs/interfaces/SemaphoreTaskItem.md +0 -73
  442. package/docs/interfaces/ServerFuncItem.md +0 -183
  443. package/docs/interfaces/ServerFuncParams.md +0 -35
  444. package/docs/interfaces/SplitSentenceOptions.md +0 -41
  445. package/docs/interfaces/ToolFuncPackage.md +0 -47
  446. package/docs/type-aliases/AIModelNameRule.md +0 -11
  447. package/docs/type-aliases/AIModelNameRuleFn.md +0 -21
  448. package/docs/type-aliases/AIModelNameRules.md +0 -11
  449. package/docs/type-aliases/ActionName.md +0 -11
  450. package/docs/type-aliases/AsyncTaskId.md +0 -11
  451. package/docs/type-aliases/FuncParamType.md +0 -11
  452. package/docs/type-aliases/TFunc.md +0 -25
  453. package/docs/variables/ActionNames.md +0 -11
  454. package/docs/variables/ClientToolFuncSchema.md +0 -101
  455. package/docs/variables/EventBusName.md +0 -11
  456. package/docs/variables/EventName.md +0 -11
  457. package/docs/variables/PASSING_SCORE.md +0 -11
  458. package/docs/variables/RStreamErrCode.md +0 -11
  459. package/docs/variables/RemoteToolFuncSchema.md +0 -101
  460. package/docs/variables/ResponseRStreamErrCode.md +0 -11
  461. package/docs/variables/SecondaryCache.md +0 -11
  462. package/docs/variables/ServerToolFuncSchema.md +0 -101
  463. package/docs/variables/ToolAsyncCancelableBit.md +0 -11
  464. package/docs/variables/ToolAsyncMultiTaskBit.md +0 -11
  465. package/docs/variables/ToolAsyncPriorityBit.md +0 -11
  466. package/docs/variables/base32768.md +0 -11
  467. package/docs/variables/event.md +0 -11
  468. package/docs/variables/eventClient.md +0 -11
  469. package/docs/variables/eventServer.md +0 -11
  470. package/docs/variables/lrucache.md +0 -11
  471. /package/docs/{_media → api/_media}/LICENSE-MIT +0 -0
  472. /package/docs/{namespaces → api/namespaces}/EventStates/README.md +0 -0
  473. /package/docs/{namespaces → api/namespaces}/uuidv5/README.md +0 -0
@@ -1,41 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatMessageToolCall
6
-
7
- # Interface: AIChatMessageToolCall
8
-
9
- Defined in: [packages/ai-tool/src/utils/chat.ts:108](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L108)
10
-
11
- ## Properties
12
-
13
- ### function
14
-
15
- > **function**: `object`
16
-
17
- Defined in: [packages/ai-tool/src/utils/chat.ts:111](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L111)
18
-
19
- #### arguments
20
-
21
- > **arguments**: `string`
22
-
23
- #### name
24
-
25
- > **name**: `string`
26
-
27
- ***
28
-
29
- ### id
30
-
31
- > **id**: `string`
32
-
33
- Defined in: [packages/ai-tool/src/utils/chat.ts:110](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L110)
34
-
35
- ***
36
-
37
- ### type
38
-
39
- > **type**: `"function"`
40
-
41
- Defined in: [packages/ai-tool/src/utils/chat.ts:109](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L109)
@@ -1,37 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatToolChoiceFuncObject
6
-
7
- # Interface: AIChatToolChoiceFuncObject
8
-
9
- Defined in: [packages/ai-tool/src/utils/chat.ts:148](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L148)
10
-
11
- ## Extends
12
-
13
- - [`AIChatToolChoiceObject`](AIChatToolChoiceObject.md)
14
-
15
- ## Indexable
16
-
17
- \[`key`: `string`\]: `any`
18
-
19
- ## Properties
20
-
21
- ### function
22
-
23
- > **function**: [`AIChatToolTypeObject`](AIChatToolTypeObject.md)
24
-
25
- Defined in: [packages/ai-tool/src/utils/chat.ts:150](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L150)
26
-
27
- ***
28
-
29
- ### type
30
-
31
- > **type**: `"function"`
32
-
33
- Defined in: [packages/ai-tool/src/utils/chat.ts:149](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L149)
34
-
35
- #### Overrides
36
-
37
- [`AIChatToolChoiceObject`](AIChatToolChoiceObject.md).[`type`](AIChatToolChoiceObject.md#type)
@@ -1,25 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatToolChoiceObject
6
-
7
- # Interface: AIChatToolChoiceObject
8
-
9
- Defined in: [packages/ai-tool/src/utils/chat.ts:143](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L143)
10
-
11
- ## Extended by
12
-
13
- - [`AIChatToolChoiceFuncObject`](AIChatToolChoiceFuncObject.md)
14
-
15
- ## Indexable
16
-
17
- \[`key`: `string`\]: `any`
18
-
19
- ## Properties
20
-
21
- ### type
22
-
23
- > **type**: `string`
24
-
25
- Defined in: [packages/ai-tool/src/utils/chat.ts:144](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L144)
@@ -1,41 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatToolFunc
6
-
7
- # Interface: AIChatToolFunc
8
-
9
- Defined in: [packages/ai-tool/src/utils/chat.ts:134](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L134)
10
-
11
- ## Properties
12
-
13
- ### description?
14
-
15
- > `optional` **description**: `string`
16
-
17
- Defined in: [packages/ai-tool/src/utils/chat.ts:136](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L136)
18
-
19
- ***
20
-
21
- ### name
22
-
23
- > **name**: `string`
24
-
25
- Defined in: [packages/ai-tool/src/utils/chat.ts:135](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L135)
26
-
27
- ***
28
-
29
- ### parameters?
30
-
31
- > `optional` **parameters**: `any`
32
-
33
- Defined in: [packages/ai-tool/src/utils/chat.ts:137](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L137)
34
-
35
- ***
36
-
37
- ### strict?
38
-
39
- > `optional` **strict**: `boolean`
40
-
41
- Defined in: [packages/ai-tool/src/utils/chat.ts:138](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L138)
@@ -1,37 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatToolFuncParam
6
-
7
- # Interface: AIChatToolFuncParam
8
-
9
- Defined in: [packages/ai-tool/src/utils/chat.ts:129](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L129)
10
-
11
- ## Extends
12
-
13
- - [`AIChatToolParam`](AIChatToolParam.md)
14
-
15
- ## Indexable
16
-
17
- \[`key`: `string`\]: `any`
18
-
19
- ## Properties
20
-
21
- ### function
22
-
23
- > **function**: [`AIChatToolFunc`](AIChatToolFunc.md)
24
-
25
- Defined in: [packages/ai-tool/src/utils/chat.ts:131](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L131)
26
-
27
- ***
28
-
29
- ### type
30
-
31
- > **type**: `"function"`
32
-
33
- Defined in: [packages/ai-tool/src/utils/chat.ts:130](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L130)
34
-
35
- #### Overrides
36
-
37
- [`AIChatToolParam`](AIChatToolParam.md).[`type`](AIChatToolParam.md#type)
@@ -1,113 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatToolMessageParam
6
-
7
- # Interface: AIChatToolMessageParam
8
-
9
- Defined in: [packages/ai-tool/src/utils/chat.ts:117](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L117)
10
-
11
- ## Extends
12
-
13
- - [`AIChatMessageParamBase`](AIChatMessageParamBase.md)
14
-
15
- ## Indexable
16
-
17
- \[`name`: `string`\]: `any`
18
-
19
- ## Properties
20
-
21
- ### content
22
-
23
- > **content**: `string`
24
-
25
- Defined in: [packages/ai-tool/src/utils/chat.ts:119](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L119)
26
-
27
- ***
28
-
29
- ### private?
30
-
31
- > `optional` **private**: `boolean`
32
-
33
- Defined in: [packages/ai-tool/src/utils/chat.ts:57](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L57)
34
-
35
- #### Inherited from
36
-
37
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`private`](AIChatMessageParamBase.md#private)
38
-
39
- ***
40
-
41
- ### replies?
42
-
43
- > `optional` **replies**: `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
44
-
45
- Defined in: [packages/ai-tool/src/utils/chat.ts:56](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L56)
46
-
47
- #### Inherited from
48
-
49
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`replies`](AIChatMessageParamBase.md#replies)
50
-
51
- ***
52
-
53
- ### role
54
-
55
- > **role**: `"tool"`
56
-
57
- Defined in: [packages/ai-tool/src/utils/chat.ts:118](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L118)
58
-
59
- #### Overrides
60
-
61
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`role`](AIChatMessageParamBase.md#role)
62
-
63
- ***
64
-
65
- ### templateFormat?
66
-
67
- > `optional` **templateFormat**: `string`
68
-
69
- Defined in: [packages/ai-tool/src/utils/chat.ts:121](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L121)
70
-
71
- ***
72
-
73
- ### thinking?
74
-
75
- > `optional` **thinking**: `string`
76
-
77
- Defined in: [packages/ai-tool/src/utils/chat.ts:59](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L59)
78
-
79
- #### Inherited from
80
-
81
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`thinking`](AIChatMessageParamBase.md#thinking)
82
-
83
- ***
84
-
85
- ### tool\_call\_id
86
-
87
- > **tool\_call\_id**: `string`
88
-
89
- Defined in: [packages/ai-tool/src/utils/chat.ts:120](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L120)
90
-
91
- ***
92
-
93
- ### tools?
94
-
95
- > `optional` **tools**: `Record`\<`string`, `string`\>
96
-
97
- Defined in: [packages/ai-tool/src/utils/chat.ts:58](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L58)
98
-
99
- #### Inherited from
100
-
101
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`tools`](AIChatMessageParamBase.md#tools)
102
-
103
- ***
104
-
105
- ### toRole?
106
-
107
- > `optional` **toRole**: `string` \| `string`[] \| `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
108
-
109
- Defined in: [packages/ai-tool/src/utils/chat.ts:55](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L55)
110
-
111
- #### Inherited from
112
-
113
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`toRole`](AIChatMessageParamBase.md#torole)
@@ -1,25 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatToolParam
6
-
7
- # Interface: AIChatToolParam
8
-
9
- Defined in: [packages/ai-tool/src/utils/chat.ts:124](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L124)
10
-
11
- ## Extended by
12
-
13
- - [`AIChatToolFuncParam`](AIChatToolFuncParam.md)
14
-
15
- ## Indexable
16
-
17
- \[`key`: `string`\]: `any`
18
-
19
- ## Properties
20
-
21
- ### type
22
-
23
- > **type**: `string`
24
-
25
- Defined in: [packages/ai-tool/src/utils/chat.ts:125](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L125)
@@ -1,17 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatToolTypeObject
6
-
7
- # Interface: AIChatToolTypeObject
8
-
9
- Defined in: [packages/ai-tool/src/utils/chat.ts:153](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L153)
10
-
11
- ## Properties
12
-
13
- ### name
14
-
15
- > **name**: `string`
16
-
17
- Defined in: [packages/ai-tool/src/utils/chat.ts:154](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L154)
@@ -1,137 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatUserMessageParam
6
-
7
- # Interface: AIChatUserMessageParam
8
-
9
- Defined in: [packages/ai-tool/src/utils/chat.ts:69](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L69)
10
-
11
- ## Extends
12
-
13
- - [`AIChatMessageParamBase`](AIChatMessageParamBase.md)
14
-
15
- ## Indexable
16
-
17
- \[`name`: `string`\]: `any`
18
-
19
- ## Properties
20
-
21
- ### charId?
22
-
23
- > `optional` **charId**: `string`
24
-
25
- Defined in: [packages/ai-tool/src/utils/chat.ts:76](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L76)
26
-
27
- ***
28
-
29
- ### content
30
-
31
- > **content**: `string` \| [`AIChatContentPart`](../type-aliases/AIChatContentPart.md)[]
32
-
33
- Defined in: [packages/ai-tool/src/utils/chat.ts:71](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L71)
34
-
35
- ***
36
-
37
- ### createdAt?
38
-
39
- > `optional` **createdAt**: `string` \| `Date`
40
-
41
- Defined in: [packages/ai-tool/src/utils/chat.ts:73](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L73)
42
-
43
- ***
44
-
45
- ### from?
46
-
47
- > `optional` **from**: `string`
48
-
49
- Defined in: [packages/ai-tool/src/utils/chat.ts:78](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L78)
50
-
51
- ***
52
-
53
- ### private?
54
-
55
- > `optional` **private**: `boolean`
56
-
57
- Defined in: [packages/ai-tool/src/utils/chat.ts:57](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L57)
58
-
59
- #### Inherited from
60
-
61
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`private`](AIChatMessageParamBase.md#private)
62
-
63
- ***
64
-
65
- ### replies?
66
-
67
- > `optional` **replies**: `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
68
-
69
- Defined in: [packages/ai-tool/src/utils/chat.ts:56](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L56)
70
-
71
- #### Inherited from
72
-
73
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`replies`](AIChatMessageParamBase.md#replies)
74
-
75
- ***
76
-
77
- ### role
78
-
79
- > **role**: `"user"`
80
-
81
- Defined in: [packages/ai-tool/src/utils/chat.ts:70](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L70)
82
-
83
- #### Overrides
84
-
85
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`role`](AIChatMessageParamBase.md#role)
86
-
87
- ***
88
-
89
- ### templateFormat?
90
-
91
- > `optional` **templateFormat**: `string`
92
-
93
- Defined in: [packages/ai-tool/src/utils/chat.ts:79](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L79)
94
-
95
- ***
96
-
97
- ### thinking?
98
-
99
- > `optional` **thinking**: `string`
100
-
101
- Defined in: [packages/ai-tool/src/utils/chat.ts:59](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L59)
102
-
103
- #### Inherited from
104
-
105
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`thinking`](AIChatMessageParamBase.md#thinking)
106
-
107
- ***
108
-
109
- ### tools?
110
-
111
- > `optional` **tools**: `Record`\<`string`, `string`\>
112
-
113
- Defined in: [packages/ai-tool/src/utils/chat.ts:58](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L58)
114
-
115
- #### Inherited from
116
-
117
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`tools`](AIChatMessageParamBase.md#tools)
118
-
119
- ***
120
-
121
- ### toRole?
122
-
123
- > `optional` **toRole**: `string` \| `string`[] \| `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
124
-
125
- Defined in: [packages/ai-tool/src/utils/chat.ts:55](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L55)
126
-
127
- #### Inherited from
128
-
129
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`toRole`](AIChatMessageParamBase.md#torole)
130
-
131
- ***
132
-
133
- ### updatedAt?
134
-
135
- > `optional` **updatedAt**: `string` \| `Date`
136
-
137
- Defined in: [packages/ai-tool/src/utils/chat.ts:74](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L74)
@@ -1,65 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChoiceConfig
6
-
7
- # Interface: AIChoiceConfig
8
-
9
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:9](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L9)
10
-
11
- ## Properties
12
-
13
- ### end?
14
-
15
- > `optional` **end**: `string`
16
-
17
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:16](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L16)
18
-
19
- ***
20
-
21
- ### items?
22
-
23
- > `optional` **items**: `string`[]
24
-
25
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:10](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L10)
26
-
27
- ***
28
-
29
- ### maxPick?
30
-
31
- > `optional` **maxPick**: `number`
32
-
33
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:11](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L11)
34
-
35
- ***
36
-
37
- ### minPick?
38
-
39
- > `optional` **minPick**: `number`
40
-
41
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:12](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L12)
42
-
43
- ***
44
-
45
- ### prefix?
46
-
47
- > `optional` **prefix**: `string`
48
-
49
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:14](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L14)
50
-
51
- ***
52
-
53
- ### separator?
54
-
55
- > `optional` **separator**: `string`
56
-
57
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:13](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L13)
58
-
59
- ***
60
-
61
- ### type?
62
-
63
- > `optional` **type**: `"ai"` \| `"random"`
64
-
65
- Defined in: [packages/ai-tool/src/utils/parse-command.ts:15](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/parse-command.ts#L15)
@@ -1,65 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIResult
6
-
7
- # Interface: AIResult\<TValue, TOptions\>
8
-
9
- Defined in: [packages/ai-tool/src/utils/chat.ts:16](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L16)
10
-
11
- ## Type Parameters
12
-
13
- • **TValue** = `any`
14
-
15
- • **TOptions** = `any`
16
-
17
- ## Indexable
18
-
19
- \[`name`: `string`\]: `any`
20
-
21
- ## Properties
22
-
23
- ### content?
24
-
25
- > `optional` **content**: `TValue`
26
-
27
- Defined in: [packages/ai-tool/src/utils/chat.ts:20](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L20)
28
-
29
- The generated value.
30
-
31
- ***
32
-
33
- ### finishReason?
34
-
35
- > `optional` **finishReason**: `null` \| `"length"` \| `"abort"` \| `"stop"` \| `"content_filter"` \| `"tool_calls"` \| `"function_call"` \| `"error"` \| `"other"`
36
-
37
- Defined in: [packages/ai-tool/src/utils/chat.ts:25](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L25)
38
-
39
- The reason why the generation stopped.
40
-
41
- ***
42
-
43
- ### options?
44
-
45
- > `optional` **options**: `TOptions`
46
-
47
- Defined in: [packages/ai-tool/src/utils/chat.ts:26](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L26)
48
-
49
- ***
50
-
51
- ### stop?
52
-
53
- > `optional` **stop**: `boolean`
54
-
55
- Defined in: [packages/ai-tool/src/utils/chat.ts:30](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L30)
56
-
57
- for stream mode
58
-
59
- ***
60
-
61
- ### taskId?
62
-
63
- > `optional` **taskId**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
64
-
65
- Defined in: [packages/ai-tool/src/utils/chat.ts:31](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/chat.ts#L31)
@@ -1,21 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md)
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIStreamParserOptions
6
-
7
- # Interface: AIStreamParserOptions
8
-
9
- Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:14](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/stream/ai-stream.ts#L14)
10
-
11
- Options for the AIStreamParser.
12
-
13
- ## Properties
14
-
15
- ### event?
16
-
17
- > `optional` **event**: `string`
18
-
19
- Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:15](https://github.com/isdk/ai-tool.js/blob/b0ee9498dddfa5222989cf00502bb34c601df743/src/utils/stream/ai-stream.ts#L15)
20
-
21
- The event (type) from the server side event stream.