@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.
- package/dist/{chunk-LNTIQQNN.mjs → chunk-4XRPAC7C.mjs} +1 -1
- package/dist/funcs.d.mts +1 -1
- package/dist/funcs.d.ts +1 -1
- package/dist/funcs.mjs +1 -1
- package/dist/{index-BCco-g_I.d.mts → index-DEUnmyUq.d.mts} +12 -1
- package/dist/{index-BCco-g_I.d.ts → index-DEUnmyUq.d.ts} +12 -1
- package/dist/index.d.mts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/api/classes/BinarySemaphore.md +25 -25
- package/docs/api/classes/CancelableAbility.md +25 -25
- package/docs/api/classes/ClientToolTransport.md +12 -12
- package/docs/api/classes/ClientTools.md +65 -61
- package/docs/api/classes/EventClient.md +105 -90
- package/docs/api/classes/EventServer.md +96 -88
- package/docs/api/classes/EventToolFunc.md +52 -52
- package/docs/api/classes/FewShotPromptTemplate.md +11 -11
- package/docs/api/classes/HttpClientToolTransport.md +13 -13
- package/docs/api/classes/HttpServerToolTransport.md +24 -16
- package/docs/api/classes/IntSet.md +12 -12
- package/docs/api/classes/PromptExampleSelector.md +9 -9
- package/docs/api/classes/ReadableStreamError.md +2 -2
- package/docs/api/classes/ResClientTools.md +560 -73
- package/docs/api/classes/ResServerTools.md +560 -74
- package/docs/api/classes/RpcMethodsClientTool.md +3275 -0
- package/docs/api/classes/RpcMethodsServerTool.md +3224 -0
- package/docs/api/classes/SSEChannel.md +16 -16
- package/docs/api/classes/Semaphore.md +26 -26
- package/docs/api/classes/ServerToolTransport.md +13 -13
- package/docs/api/classes/ServerTools.md +61 -57
- package/docs/api/classes/SignalGate.md +9 -9
- package/docs/api/classes/SseClientPubSubTransport.md +3 -3
- package/docs/api/classes/SseServerPubSubTransport.md +8 -8
- package/docs/api/classes/TaskAbortController.md +8 -8
- package/docs/api/classes/ToolFunc.md +50 -50
- package/docs/api/classes/ToolTransport.md +7 -7
- package/docs/api/classes/YamlTypeBaseObject.md +2 -2
- package/docs/api/enumerations/AsyncFeatureBits.md +4 -4
- package/docs/api/enumerations/AsyncFeatures.md +4 -4
- package/docs/api/enumerations/HashAlgorithm.md +12 -12
- package/docs/api/functions/AIArgProcessor.md +1 -1
- package/docs/api/functions/AIStream.md +1 -1
- package/docs/api/functions/ChoiceArgProcessor.md +1 -1
- package/docs/api/functions/DefaultDateFormat.md +1 -1
- package/docs/api/functions/ObjectArgsToArgsInfo.md +1 -1
- package/docs/api/functions/RateLimit.md +1 -1
- package/docs/api/functions/TemplateArgProcessor.md +1 -1
- package/docs/api/functions/assignDirs.md +1 -1
- package/docs/api/functions/backendEventable.md +1 -1
- package/docs/api/functions/beforeShutdown.md +1 -1
- package/docs/api/functions/calcPerplexity.md +1 -1
- package/docs/api/functions/calcPerplexitySimple.md +1 -1
- package/docs/api/functions/completeSentences.md +1 -1
- package/docs/api/functions/concatText.md +1 -1
- package/docs/api/functions/countLLMTokens.md +1 -1
- package/docs/api/functions/countRegexMatches.md +1 -1
- package/docs/api/functions/createCallbacksTransformer.md +1 -1
- package/docs/api/functions/createEmptyReadableStream.md +1 -1
- package/docs/api/functions/createEndWithRepetitionDetector.md +1 -1
- package/docs/api/functions/createEventStreamTransformer.md +1 -1
- package/docs/api/functions/createLRUCache.md +1 -1
- package/docs/api/functions/createYamlObjectTag.md +1 -1
- package/docs/api/functions/dateToText.md +1 -1
- package/docs/api/functions/decodeCharset.md +1 -1
- package/docs/api/functions/defaultsWithConcat.md +1 -1
- package/docs/api/functions/detectCharset.md +1 -1
- package/docs/api/functions/encodeLLMTokens.md +1 -1
- package/docs/api/functions/ensureQuoted.md +1 -1
- package/docs/api/functions/expandConfig.md +1 -1
- package/docs/api/functions/expandPath.md +1 -1
- package/docs/api/functions/expandPathInObject.md +1 -1
- package/docs/api/functions/expandPaths.md +1 -1
- package/docs/api/functions/fileIsExists.md +1 -1
- package/docs/api/functions/filterValidFnScope.md +1 -1
- package/docs/api/functions/findIndexNonEmptyFrom.md +1 -1
- package/docs/api/functions/findPort.md +1 -1
- package/docs/api/functions/formatTextWithSpace.md +1 -1
- package/docs/api/functions/funcGetMeta.md +1 -1
- package/docs/api/functions/funcWithMeta.md +1 -1
- package/docs/api/functions/genUrlParamsStr.md +1 -1
- package/docs/api/functions/getAllEnumKeys.md +1 -1
- package/docs/api/functions/getConfigFileNames.md +1 -1
- package/docs/api/functions/getConfigs.md +1 -1
- package/docs/api/functions/getFileMetaInfo.md +1 -1
- package/docs/api/functions/getHashAlgoBySize.md +1 -1
- package/docs/api/functions/getKeysPath.md +1 -1
- package/docs/api/functions/getLLMTokenizer.md +1 -1
- package/docs/api/functions/getPackageDir.md +1 -1
- package/docs/api/functions/getRealFilepath.md +1 -1
- package/docs/api/functions/getResponseErrorReadableStream.md +1 -1
- package/docs/api/functions/getXDGConfigs.md +1 -1
- package/docs/api/functions/hasDirectoryIn.md +1 -1
- package/docs/api/functions/hash.md +1 -1
- package/docs/api/functions/hashFile.md +1 -1
- package/docs/api/functions/hashObject.md +1 -1
- package/docs/api/functions/hashStream.md +1 -1
- package/docs/api/functions/initShutdown.md +1 -1
- package/docs/api/functions/isLangUsingSpaces.md +1 -1
- package/docs/api/functions/isListItemString.md +1 -1
- package/docs/api/functions/isModelNameMatched.md +1 -1
- package/docs/api/functions/isPunctuationChar.md +1 -1
- package/docs/api/functions/isQuoted.md +1 -1
- package/docs/api/functions/isRegExp.md +1 -1
- package/docs/api/functions/isSameString.md +1 -1
- package/docs/api/functions/isSectionString.md +1 -1
- package/docs/api/functions/isSentenceEnding.md +1 -1
- package/docs/api/functions/isSepLineString.md +1 -1
- package/docs/api/functions/isStrWrapped.md +1 -1
- package/docs/api/functions/isSubdirectory.md +1 -1
- package/docs/api/functions/isTitleString.md +1 -1
- package/docs/api/functions/isWebStream.md +1 -1
- package/docs/api/functions/joinSplitWords.md +1 -1
- package/docs/api/functions/jsonFilterToWhere.md +1 -1
- package/docs/api/functions/jsonToMarkdownStr.md +1 -1
- package/docs/api/functions/loadAIConfig.md +1 -1
- package/docs/api/functions/loadConfig.md +1 -1
- package/docs/api/functions/loadConfigFile.md +1 -1
- package/docs/api/functions/loadFileFromPaths.md +1 -1
- package/docs/api/functions/loadTextFromPaths.md +1 -1
- package/docs/api/functions/lrucache.md +1 -1
- package/docs/api/functions/makeToolFuncCancelable.md +1 -1
- package/docs/api/functions/matchUrlProtocol.md +1 -1
- package/docs/api/functions/memoize.md +1 -1
- package/docs/api/functions/mergeArray.md +1 -1
- package/docs/api/functions/messagesToText.md +1 -1
- package/docs/api/functions/normalizePath.md +1 -1
- package/docs/api/functions/paramsSizeToScaleStr.md +1 -1
- package/docs/api/functions/parseCommand.md +1 -1
- package/docs/api/functions/parseJsJson.md +1 -1
- package/docs/api/functions/parseJsJsonSimpleSync.md +1 -1
- package/docs/api/functions/parseObjectArgInfo.md +1 -1
- package/docs/api/functions/parseObjectArgumentInfos.md +1 -1
- package/docs/api/functions/parseObjectArguments.md +1 -1
- package/docs/api/functions/parseObjectArgumentsAsArgInfos.md +1 -1
- package/docs/api/functions/pruneSubdirectories.md +1 -1
- package/docs/api/functions/pruneSubdirectoriesInPlace.md +1 -1
- package/docs/api/functions/quoteStr.md +1 -1
- package/docs/api/functions/readFilenamesRecursiveSync.md +1 -1
- package/docs/api/functions/readTextFileChunks.md +1 -1
- package/docs/api/functions/readTextFileChunksEx.md +1 -1
- package/docs/api/functions/readableFromAsyncIterable.md +1 -1
- package/docs/api/functions/registerCoreTools.md +1 -1
- package/docs/api/functions/removeMarkdownBold.md +1 -1
- package/docs/api/functions/removeMarkdownBoldAndItalic.md +1 -1
- package/docs/api/functions/removeMarkdownItalic.md +1 -1
- package/docs/api/functions/replaceWithPlaceholder.md +1 -1
- package/docs/api/functions/restoreFromPlacehoders.md +1 -1
- package/docs/api/functions/saveConfigFile.md +1 -1
- package/docs/api/functions/scaleStrToParamsSize.md +1 -1
- package/docs/api/functions/shutdown.md +1 -1
- package/docs/api/functions/simplifyObjectArguments.md +1 -1
- package/docs/api/functions/sleep.md +1 -1
- package/docs/api/functions/sortedValues.md +1 -1
- package/docs/api/functions/splitChunks.md +1 -1
- package/docs/api/functions/splitParagraph.md +1 -1
- package/docs/api/functions/splitSentence.md +1 -1
- package/docs/api/functions/splitWords.md +1 -1
- package/docs/api/functions/stripConsoleColor.md +1 -1
- package/docs/api/functions/textToDate.md +1 -1
- package/docs/api/functions/toDateTime.md +1 -1
- package/docs/api/functions/trimStartOfStreamHelper.md +1 -1
- package/docs/api/functions/truncTo.md +1 -1
- package/docs/api/functions/truncateByToken.md +1 -1
- package/docs/api/functions/truncateToTokenLimit.md +1 -1
- package/docs/api/functions/truncateToTokenLimitEx.md +1 -1
- package/docs/api/functions/uuid.md +1 -1
- package/docs/api/functions/wait.md +1 -1
- package/docs/api/functions/xxhash.md +1 -1
- package/docs/api/functions/xxhash32.md +1 -1
- package/docs/api/functions/xxhash64.md +1 -1
- package/docs/api/functions/xxhashAsStr.md +1 -1
- package/docs/api/functions/yieldExec.md +1 -1
- package/docs/api/globals.md +6 -0
- package/docs/api/interfaces/AIChatAssistantMessageParam.md +12 -12
- package/docs/api/interfaces/AIChatContentPartImage.md +3 -3
- package/docs/api/interfaces/AIChatContentPartText.md +3 -3
- package/docs/api/interfaces/AIChatMessageParamBase.md +7 -7
- package/docs/api/interfaces/AIChatMessageToolCall.md +4 -4
- package/docs/api/interfaces/AIChatSystemMessageParam.md +9 -9
- package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +3 -3
- package/docs/api/interfaces/AIChatToolChoiceObject.md +2 -2
- package/docs/api/interfaces/AIChatToolFunc.md +5 -5
- package/docs/api/interfaces/AIChatToolFuncParam.md +3 -3
- package/docs/api/interfaces/AIChatToolMessageParam.md +10 -10
- package/docs/api/interfaces/AIChatToolParam.md +2 -2
- package/docs/api/interfaces/AIChatToolTypeObject.md +2 -2
- package/docs/api/interfaces/AIChatUserMessageParam.md +13 -13
- package/docs/api/interfaces/AIChoiceConfig.md +8 -8
- package/docs/api/interfaces/AIResult.md +6 -6
- package/docs/api/interfaces/AIStreamParser.md +2 -2
- package/docs/api/interfaces/AIStreamParserOptions.md +2 -2
- package/docs/api/interfaces/BaseFunc.md +15 -15
- package/docs/api/interfaces/BaseFuncItem.md +14 -14
- package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
- package/docs/api/interfaces/BinarySemaphoreOptions.md +5 -5
- package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
- package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
- package/docs/api/interfaces/CancelableAbilityOptions.md +4 -4
- package/docs/api/interfaces/ClientFuncItem.md +17 -17
- package/docs/api/interfaces/EventClientFuncParams.md +5 -5
- package/docs/api/interfaces/EventServerFuncParams.md +6 -6
- package/docs/api/interfaces/FewShotPromptTemplateOptions.md +6 -6
- package/docs/api/interfaces/FuncItem.md +15 -15
- package/docs/api/interfaces/FuncParam.md +5 -5
- package/docs/api/interfaces/FuncParams.md +1 -1
- package/docs/api/interfaces/Funcs.md +1 -1
- package/docs/api/interfaces/HashAlgoParams.md +4 -4
- package/docs/api/interfaces/IClientToolTransport.md +7 -7
- package/docs/api/interfaces/IFileMetaInfo.md +8 -8
- package/docs/api/interfaces/IPubSubClientTransport.md +3 -3
- package/docs/api/interfaces/IPubSubServerTransport.md +9 -9
- package/docs/api/interfaces/IReadTextFileChunksOptions.md +11 -11
- package/docs/api/interfaces/IServerToolTransport.md +8 -8
- package/docs/api/interfaces/IToolTransport.md +5 -5
- package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +10 -10
- package/docs/api/interfaces/JsonFilter.md +1 -1
- package/docs/api/interfaces/ParseObjectArgumentOptions.md +11 -11
- package/docs/api/interfaces/ProbabilityItem.md +4 -4
- package/docs/api/interfaces/PromptExampleSelectorOptions.md +3 -3
- package/docs/api/interfaces/PubSubClient.md +2 -2
- package/docs/api/interfaces/PubSubClientStream.md +9 -9
- package/docs/api/interfaces/PubSubServerSession.md +7 -7
- package/docs/api/interfaces/RemoteFuncItem.md +17 -17
- package/docs/api/interfaces/ReplacePlacehoderOptions.md +5 -5
- package/docs/api/interfaces/ResClientFuncParams.md +5 -5
- package/docs/api/interfaces/ResServerFuncParams.md +14 -10
- package/docs/api/interfaces/RpcMethodsClientFuncParams.md +25 -0
- package/docs/api/interfaces/RpcMethodsServerFuncParams.md +61 -0
- package/docs/api/interfaces/SectionStringOptions.md +3 -3
- package/docs/api/interfaces/SemaphoreOptions.md +7 -7
- package/docs/api/interfaces/SemaphoreTaskItem.md +5 -5
- package/docs/api/interfaces/ServerFuncItem.md +18 -18
- package/docs/api/interfaces/ServerFuncParams.md +4 -3
- package/docs/api/interfaces/SplitSentenceOptions.md +5 -5
- package/docs/api/interfaces/StreamCallbacksAndOptions.md +5 -5
- package/docs/api/interfaces/TaskAbortControllers.md +1 -1
- package/docs/api/interfaces/TaskPromise.md +2 -2
- package/docs/api/interfaces/ToolFuncPackage.md +4 -4
- package/docs/api/type-aliases/AIChatContentPart.md +1 -1
- package/docs/api/type-aliases/AIChatMessageParam.md +1 -1
- package/docs/api/type-aliases/AIChatRole.md +1 -1
- package/docs/api/type-aliases/AIChatToolChoiceParam.md +1 -1
- package/docs/api/type-aliases/AIMessageType.md +1 -1
- package/docs/api/type-aliases/AIModelNameRule.md +1 -1
- package/docs/api/type-aliases/AIModelNameRuleFn.md +1 -1
- package/docs/api/type-aliases/AIModelNameRules.md +1 -1
- package/docs/api/type-aliases/AITextGenerationFinishReason.md +1 -1
- package/docs/api/type-aliases/ActionName.md +1 -1
- package/docs/api/type-aliases/ArrayMergeWay.md +1 -1
- package/docs/api/type-aliases/AsyncTaskId.md +1 -1
- package/docs/api/type-aliases/BeforeShutdownListener.md +1 -1
- package/docs/api/type-aliases/EventErrorListenerFn.md +1 -1
- package/docs/api/type-aliases/EventListenerFn.md +1 -1
- package/docs/api/type-aliases/FuncParamType.md +1 -1
- package/docs/api/type-aliases/PromptExamples.md +1 -1
- package/docs/api/type-aliases/PubSubClientId.md +1 -1
- package/docs/api/type-aliases/PubSubCtx.md +1 -1
- package/docs/api/type-aliases/RpcMethodHandler.md +1 -1
- package/docs/api/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/api/type-aliases/TFunc.md +1 -1
- package/docs/api/variables/AIChatRoles.md +1 -1
- package/docs/api/variables/AIMessageTypes.md +1 -1
- package/docs/api/variables/AITextGenerationFinishReasons.md +1 -1
- package/docs/api/variables/ActionNames.md +1 -1
- package/docs/api/variables/ArrayMergeWay.md +1 -1
- package/docs/api/variables/ArrayMergeWaySymbol.md +1 -1
- package/docs/api/variables/ClientToolFuncSchema.md +1 -1
- package/docs/api/variables/DEFAULT_CONFIG_NAME.md +1 -1
- package/docs/api/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
- package/docs/api/variables/EventBusName.md +1 -1
- package/docs/api/variables/EventName.md +1 -1
- package/docs/api/variables/FuncMetaSymbol.md +1 -1
- package/docs/api/variables/LLM_TOKENIZER_NAMES.md +1 -1
- package/docs/api/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
- package/docs/api/variables/PASSING_SCORE.md +1 -1
- package/docs/api/variables/RStreamErrCode.md +1 -1
- package/docs/api/variables/RemoteToolFuncSchema.md +1 -1
- package/docs/api/variables/ResponseRStreamErrCode.md +1 -1
- package/docs/api/variables/RpcMethodsClientToolSchema.md +49 -0
- package/docs/api/variables/RpcMethodsServerToolSchema.md +21 -0
- package/docs/api/variables/SHUTDOWN_SIGNALS.md +1 -1
- package/docs/api/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
- package/docs/api/variables/SecondaryCache.md +1 -1
- package/docs/api/variables/ServerToolFuncSchema.md +1 -1
- package/docs/api/variables/StrangeHumanName.md +1 -1
- package/docs/api/variables/ToolAsyncCancelableBit.md +1 -1
- package/docs/api/variables/ToolAsyncMultiTaskBit.md +1 -1
- package/docs/api/variables/ToolAsyncPriorityBit.md +1 -1
- package/docs/api/variables/ToolFuncSchema.md +1 -1
- package/docs/api/variables/base32768.md +1 -1
- package/docs/api/variables/event.md +1 -1
- package/docs/api/variables/eventClient.md +1 -1
- package/docs/api/variables/eventServer.md +1 -1
- package/docs/api/variables/lrucache.md +1 -1
- package/package.json +3 -3
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: EventToolFunc
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:6](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:6](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event.ts#L6)
|
|
10
10
|
|
|
11
11
|
A manager for creating, registering, and executing reusable tool functions.
|
|
12
12
|
|
|
@@ -77,7 +77,7 @@ main();
|
|
|
77
77
|
|
|
78
78
|
> **new EventToolFunc**(`name`, `options`?): [`EventToolFunc`](EventToolFunc.md)
|
|
79
79
|
|
|
80
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/
|
|
80
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L571)
|
|
81
81
|
|
|
82
82
|
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
83
83
|
|
|
@@ -109,7 +109,7 @@ Configuration options if not provided in the first argument.
|
|
|
109
109
|
|
|
110
110
|
> **\_emitter**: [`EventEmitter`](EventEmitter.md)
|
|
111
111
|
|
|
112
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:7](https://github.com/isdk/ai-tool.js/blob/
|
|
112
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:7](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event.ts#L7)
|
|
113
113
|
|
|
114
114
|
***
|
|
115
115
|
|
|
@@ -129,7 +129,7 @@ Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/p
|
|
|
129
129
|
|
|
130
130
|
> `optional` **alias**: `string` \| `string`[]
|
|
131
131
|
|
|
132
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/
|
|
132
|
+
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)
|
|
133
133
|
|
|
134
134
|
Optional aliases for the function name.
|
|
135
135
|
|
|
@@ -143,7 +143,7 @@ Optional aliases for the function name.
|
|
|
143
143
|
|
|
144
144
|
> `optional` **asyncFeatures**: `number`
|
|
145
145
|
|
|
146
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/
|
|
146
|
+
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)
|
|
147
147
|
|
|
148
148
|
A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
|
|
149
149
|
This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
|
|
@@ -209,7 +209,7 @@ The default options for export and assign
|
|
|
209
209
|
|
|
210
210
|
> `optional` **depends**: `object`
|
|
211
211
|
|
|
212
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/
|
|
212
|
+
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)
|
|
213
213
|
|
|
214
214
|
A map of dependencies this function has on other tool functions.
|
|
215
215
|
Declaring dependencies ensures that they are automatically registered when this function is registered.
|
|
@@ -248,7 +248,7 @@ mainFunc.register();
|
|
|
248
248
|
|
|
249
249
|
> **description**: `string` = `'Return event bus'`
|
|
250
250
|
|
|
251
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
251
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:9](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event.ts#L9)
|
|
252
252
|
|
|
253
253
|
A detailed description of what the function does.
|
|
254
254
|
|
|
@@ -262,7 +262,7 @@ A detailed description of what the function does.
|
|
|
262
262
|
|
|
263
263
|
> `optional` **isApi**: `boolean`
|
|
264
264
|
|
|
265
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/
|
|
265
|
+
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)
|
|
266
266
|
|
|
267
267
|
If true, indicates that this function should be treated as a server-side API.
|
|
268
268
|
|
|
@@ -276,7 +276,7 @@ If true, indicates that this function should be treated as a server-side API.
|
|
|
276
276
|
|
|
277
277
|
> `optional` **name**: `string`
|
|
278
278
|
|
|
279
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/
|
|
279
|
+
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)
|
|
280
280
|
|
|
281
281
|
The unique name of the function.
|
|
282
282
|
|
|
@@ -304,7 +304,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
304
304
|
|
|
305
305
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
306
306
|
|
|
307
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/
|
|
307
|
+
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)
|
|
308
308
|
|
|
309
309
|
Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
|
|
310
310
|
|
|
@@ -318,7 +318,7 @@ Parameter definitions, which can be an object mapping names to definitions or an
|
|
|
318
318
|
|
|
319
319
|
> **result**: `string` = `'event'`
|
|
320
320
|
|
|
321
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
321
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:10](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event.ts#L10)
|
|
322
322
|
|
|
323
323
|
The expected return type of the function, described as a string or a JSON schema object.
|
|
324
324
|
|
|
@@ -332,7 +332,7 @@ The expected return type of the function, described as a string or a JSON schema
|
|
|
332
332
|
|
|
333
333
|
> `optional` **scope**: `any`
|
|
334
334
|
|
|
335
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/
|
|
335
|
+
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)
|
|
336
336
|
|
|
337
337
|
The execution scope or context (`this`) for the function.
|
|
338
338
|
|
|
@@ -346,7 +346,7 @@ The execution scope or context (`this`) for the function.
|
|
|
346
346
|
|
|
347
347
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
348
348
|
|
|
349
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/
|
|
349
|
+
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)
|
|
350
350
|
|
|
351
351
|
A lifecycle hook called once during the `ToolFunc` instance's initialization.
|
|
352
352
|
It allows for initial setup, state configuration, or property modification on the instance
|
|
@@ -392,7 +392,7 @@ console.log(myFunc.customState); // Outputs: 'configured'
|
|
|
392
392
|
|
|
393
393
|
> `optional` **stream**: `boolean`
|
|
394
394
|
|
|
395
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/
|
|
395
|
+
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)
|
|
396
396
|
|
|
397
397
|
If true, indicates that the function has the *capability* to stream its output.
|
|
398
398
|
Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
|
|
@@ -407,7 +407,7 @@ Whether a specific call is streamed is determined by a `stream` property in the
|
|
|
407
407
|
|
|
408
408
|
> `optional` **tags**: `string` \| `string`[]
|
|
409
409
|
|
|
410
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/
|
|
410
|
+
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)
|
|
411
411
|
|
|
412
412
|
Tags for grouping or filtering functions.
|
|
413
413
|
|
|
@@ -421,7 +421,7 @@ Tags for grouping or filtering functions.
|
|
|
421
421
|
|
|
422
422
|
> `optional` **title**: `string`
|
|
423
423
|
|
|
424
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/
|
|
424
|
+
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)
|
|
425
425
|
|
|
426
426
|
A concise, human-readable title for the function, often used in UI or by AI.
|
|
427
427
|
|
|
@@ -435,7 +435,7 @@ A concise, human-readable title for the function, often used in UI or by AI.
|
|
|
435
435
|
|
|
436
436
|
> `static` **aliases**: `object` = `{}`
|
|
437
437
|
|
|
438
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/
|
|
438
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L305)
|
|
439
439
|
|
|
440
440
|
A static map of aliases to their corresponding function names.
|
|
441
441
|
|
|
@@ -453,7 +453,7 @@ A static map of aliases to their corresponding function names.
|
|
|
453
453
|
|
|
454
454
|
> `static` **dataPath**: `string`
|
|
455
455
|
|
|
456
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/
|
|
456
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L312)
|
|
457
457
|
|
|
458
458
|
A conventional property to designate a file path for saving the registered `ToolFunc` data.
|
|
459
459
|
Note: The `ToolFunc` class itself does not implement persistence logic. It is up to the
|
|
@@ -469,7 +469,7 @@ developer to use this path to save and load the `ToolFunc.items` registry if nee
|
|
|
469
469
|
|
|
470
470
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
471
471
|
|
|
472
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/
|
|
472
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L300)
|
|
473
473
|
|
|
474
474
|
A static registry of all `ToolFunc` instances, indexed by name.
|
|
475
475
|
|
|
@@ -485,7 +485,7 @@ A static registry of all `ToolFunc` instances, indexed by name.
|
|
|
485
485
|
|
|
486
486
|
> **get** **emitter**(): [`EventEmitter`](EventEmitter.md)
|
|
487
487
|
|
|
488
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
488
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:12](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event.ts#L12)
|
|
489
489
|
|
|
490
490
|
##### Returns
|
|
491
491
|
|
|
@@ -497,7 +497,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:12](https://gith
|
|
|
497
497
|
|
|
498
498
|
> **arr2ObjParams**(`params`): `any`[]
|
|
499
499
|
|
|
500
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/
|
|
500
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L629)
|
|
501
501
|
|
|
502
502
|
Converts an array of positional arguments into a named parameters object.
|
|
503
503
|
This is used internally to support functions defined with named parameters.
|
|
@@ -808,7 +808,7 @@ the dest object.
|
|
|
808
808
|
|
|
809
809
|
> **func**(): [`EventEmitter`](EventEmitter.md)
|
|
810
810
|
|
|
811
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
811
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/funcs/event.ts:16](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/funcs/event.ts#L16)
|
|
812
812
|
|
|
813
813
|
The actual function implementation.
|
|
814
814
|
|
|
@@ -828,7 +828,7 @@ The result of the function.
|
|
|
828
828
|
|
|
829
829
|
> **getFunc**(`name`?): `any`
|
|
830
830
|
|
|
831
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/
|
|
831
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L720)
|
|
832
832
|
|
|
833
833
|
Gets a bound function reference for execution with named parameters.
|
|
834
834
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -858,7 +858,7 @@ A function reference or `undefined` if not found.
|
|
|
858
858
|
|
|
859
859
|
> **getFuncWithPos**(`name`?): `any`
|
|
860
860
|
|
|
861
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/
|
|
861
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L777)
|
|
862
862
|
|
|
863
863
|
Gets a bound function reference suitable for positional argument execution.
|
|
864
864
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -908,7 +908,7 @@ the descriptors of properties object
|
|
|
908
908
|
|
|
909
909
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
910
910
|
|
|
911
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/
|
|
911
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L787)
|
|
912
912
|
|
|
913
913
|
Checks if the current function instance supports a specific async feature.
|
|
914
914
|
|
|
@@ -1044,7 +1044,7 @@ The source object
|
|
|
1044
1044
|
|
|
1045
1045
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
1046
1046
|
|
|
1047
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/
|
|
1047
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L805)
|
|
1048
1048
|
|
|
1049
1049
|
Determines if a function call should produce a stream.
|
|
1050
1050
|
|
|
@@ -1110,7 +1110,7 @@ the dest object.
|
|
|
1110
1110
|
|
|
1111
1111
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
1112
1112
|
|
|
1113
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/
|
|
1113
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L648)
|
|
1114
1114
|
|
|
1115
1115
|
Converts a named parameters object into an array of positional arguments.
|
|
1116
1116
|
This is used for functions defined with positional parameters.
|
|
@@ -1165,7 +1165,7 @@ A property name.
|
|
|
1165
1165
|
|
|
1166
1166
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
1167
1167
|
|
|
1168
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/
|
|
1168
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L602)
|
|
1169
1169
|
|
|
1170
1170
|
Registers the current `ToolFunc` instance into the static registry.
|
|
1171
1171
|
Also registers any declared dependencies.
|
|
@@ -1186,7 +1186,7 @@ The instance itself upon successful registration, or `false` if it already exist
|
|
|
1186
1186
|
|
|
1187
1187
|
> **run**(`params`?): `Promise`\<`any`\>
|
|
1188
1188
|
|
|
1189
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:686](https://github.com/isdk/ai-tool.js/blob/
|
|
1189
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:686](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L686)
|
|
1190
1190
|
|
|
1191
1191
|
Executes the function asynchronously with a named parameters object.
|
|
1192
1192
|
|
|
@@ -1214,7 +1214,7 @@ A promise that resolves with the function's result.
|
|
|
1214
1214
|
|
|
1215
1215
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
1216
1216
|
|
|
1217
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/
|
|
1217
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L697)
|
|
1218
1218
|
|
|
1219
1219
|
Asynchronously executes another registered function by name.
|
|
1220
1220
|
This method delegates to `runAsSync()` internally.
|
|
@@ -1249,7 +1249,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1249
1249
|
|
|
1250
1250
|
> **runAsSync**(`name`, `params`?): `any`
|
|
1251
1251
|
|
|
1252
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/
|
|
1252
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L708)
|
|
1253
1253
|
|
|
1254
1254
|
Synchronously executes another registered function by name.
|
|
1255
1255
|
This is a convenience method that forwards the call to the static `runSync()` method.
|
|
@@ -1284,7 +1284,7 @@ The result of the function execution.
|
|
|
1284
1284
|
|
|
1285
1285
|
> **runSync**(`params`?): `any`
|
|
1286
1286
|
|
|
1287
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/
|
|
1287
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L667)
|
|
1288
1288
|
|
|
1289
1289
|
Executes the function synchronously with a named parameters object.
|
|
1290
1290
|
|
|
@@ -1316,7 +1316,7 @@ Will throw an error if an array of parameters is passed to a function that expec
|
|
|
1316
1316
|
|
|
1317
1317
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1318
1318
|
|
|
1319
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/
|
|
1319
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L755)
|
|
1320
1320
|
|
|
1321
1321
|
Executes the function asynchronously using positional arguments.
|
|
1322
1322
|
Delegates to `runWithPosSync()` internally.
|
|
@@ -1345,7 +1345,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1345
1345
|
|
|
1346
1346
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1347
1347
|
|
|
1348
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/
|
|
1348
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L766)
|
|
1349
1349
|
|
|
1350
1350
|
Asynchronously executes another function by name using positional arguments.
|
|
1351
1351
|
Delegates to `runWithPosAsSync()` internally.
|
|
@@ -1380,7 +1380,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1380
1380
|
|
|
1381
1381
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1382
1382
|
|
|
1383
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/
|
|
1383
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L745)
|
|
1384
1384
|
|
|
1385
1385
|
Synchronously executes another function by name using positional arguments.
|
|
1386
1386
|
This is a convenience wrapper around the static `runWithPosSync()` method.
|
|
@@ -1415,7 +1415,7 @@ The result of the function execution.
|
|
|
1415
1415
|
|
|
1416
1416
|
> **runWithPosSync**(...`params`): `any`
|
|
1417
1417
|
|
|
1418
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/
|
|
1418
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L731)
|
|
1419
1419
|
|
|
1420
1420
|
Executes the function synchronously using positional arguments.
|
|
1421
1421
|
If the function expects named parameters, it converts the arguments automatically.
|
|
@@ -1522,7 +1522,7 @@ Returns a string representation of an object.
|
|
|
1522
1522
|
|
|
1523
1523
|
> **unregister**(): `any`
|
|
1524
1524
|
|
|
1525
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/
|
|
1525
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L619)
|
|
1526
1526
|
|
|
1527
1527
|
Removes the current `ToolFunc` instance from the static registry.
|
|
1528
1528
|
|
|
@@ -2062,7 +2062,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
2062
2062
|
|
|
2063
2063
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
2064
2064
|
|
|
2065
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/
|
|
2065
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L319)
|
|
2066
2066
|
|
|
2067
2067
|
Retrieves a registered function by its name or alias.
|
|
2068
2068
|
|
|
@@ -2090,7 +2090,7 @@ The `ToolFunc` instance if found, otherwise `undefined`.
|
|
|
2090
2090
|
|
|
2091
2091
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
2092
2092
|
|
|
2093
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/
|
|
2093
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L365)
|
|
2094
2094
|
|
|
2095
2095
|
Retrieves all registered functions that have a specific tag.
|
|
2096
2096
|
|
|
@@ -2118,7 +2118,7 @@ An array of matching `ToolFunc` instances.
|
|
|
2118
2118
|
|
|
2119
2119
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2120
2120
|
|
|
2121
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/
|
|
2121
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L340)
|
|
2122
2122
|
|
|
2123
2123
|
Finds the first registered function that has a specific tag.
|
|
2124
2124
|
|
|
@@ -2146,7 +2146,7 @@ The first matching `ToolFunc` instance, or `undefined` if none is found.
|
|
|
2146
2146
|
|
|
2147
2147
|
> `static` **getFunc**(`name`): `any`
|
|
2148
2148
|
|
|
2149
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/
|
|
2149
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L431)
|
|
2150
2150
|
|
|
2151
2151
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2152
2152
|
This reference is suitable for execution with an object of named parameters.
|
|
@@ -2175,7 +2175,7 @@ A bound function reference, or `undefined` if not found.
|
|
|
2175
2175
|
|
|
2176
2176
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
2177
2177
|
|
|
2178
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/
|
|
2178
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L472)
|
|
2179
2179
|
|
|
2180
2180
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2181
2181
|
This reference is suitable for execution with positional arguments.
|
|
@@ -2364,7 +2364,7 @@ The object that references the prototype.
|
|
|
2364
2364
|
|
|
2365
2365
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2366
2366
|
|
|
2367
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/
|
|
2367
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L388)
|
|
2368
2368
|
|
|
2369
2369
|
Checks if any registered function has a specific asynchronous feature.
|
|
2370
2370
|
|
|
@@ -2584,7 +2584,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2584
2584
|
|
|
2585
2585
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2586
2586
|
|
|
2587
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/
|
|
2587
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L331)
|
|
2588
2588
|
|
|
2589
2589
|
Returns the complete map of all registered functions.
|
|
2590
2590
|
|
|
@@ -2636,7 +2636,7 @@ Object to make non-extensible.
|
|
|
2636
2636
|
|
|
2637
2637
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2638
2638
|
|
|
2639
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/
|
|
2639
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L495)
|
|
2640
2640
|
|
|
2641
2641
|
Registers a new tool function.
|
|
2642
2642
|
|
|
@@ -2672,7 +2672,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2672
2672
|
|
|
2673
2673
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2674
2674
|
|
|
2675
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/
|
|
2675
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L496)
|
|
2676
2676
|
|
|
2677
2677
|
Registers a new tool function.
|
|
2678
2678
|
|
|
@@ -2708,7 +2708,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2708
2708
|
|
|
2709
2709
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2710
2710
|
|
|
2711
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/
|
|
2711
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L497)
|
|
2712
2712
|
|
|
2713
2713
|
Registers a new tool function.
|
|
2714
2714
|
|
|
@@ -2746,7 +2746,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2746
2746
|
|
|
2747
2747
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
2748
2748
|
|
|
2749
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/
|
|
2749
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L402)
|
|
2750
2750
|
|
|
2751
2751
|
Asynchronously executes a registered function by name with named parameters.
|
|
2752
2752
|
|
|
@@ -2784,7 +2784,7 @@ If the function with the given name is not found.
|
|
|
2784
2784
|
|
|
2785
2785
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
2786
2786
|
|
|
2787
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/
|
|
2787
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L417)
|
|
2788
2788
|
|
|
2789
2789
|
Synchronously executes a registered function by name with named parameters.
|
|
2790
2790
|
|
|
@@ -2822,7 +2822,7 @@ If the function with the given name is not found.
|
|
|
2822
2822
|
|
|
2823
2823
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2824
2824
|
|
|
2825
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/
|
|
2825
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L443)
|
|
2826
2826
|
|
|
2827
2827
|
Asynchronously executes a function using positional arguments.
|
|
2828
2828
|
|
|
@@ -2860,7 +2860,7 @@ If the function with the given name is not found.
|
|
|
2860
2860
|
|
|
2861
2861
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2862
2862
|
|
|
2863
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/
|
|
2863
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L458)
|
|
2864
2864
|
|
|
2865
2865
|
Synchronously executes a function using positional arguments.
|
|
2866
2866
|
|
|
@@ -2960,7 +2960,7 @@ The value of the new prototype or null.
|
|
|
2960
2960
|
|
|
2961
2961
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2962
2962
|
|
|
2963
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/
|
|
2963
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L547)
|
|
2964
2964
|
|
|
2965
2965
|
Unregisters a function by its name, also removing any associated aliases.
|
|
2966
2966
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: FewShotPromptTemplate\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:39](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:39](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/prompt/few-shot-prompt-template.ts#L39)
|
|
10
10
|
|
|
11
11
|
The `StringTemplate` class is a versatile template engine that supports dynamic template creation,
|
|
12
12
|
formatting, and partial data processing. It extends the `BaseFactory` class and provides methods
|
|
@@ -49,7 +49,7 @@ console.log(result); // Output: "Formatted: Hello World"
|
|
|
49
49
|
|
|
50
50
|
> **new FewShotPromptTemplate**\<`T`\>(`options`): [`FewShotPromptTemplate`](FewShotPromptTemplate.md)\<`T`\>
|
|
51
51
|
|
|
52
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:50](https://github.com/isdk/ai-tool.js/blob/
|
|
52
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:50](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/prompt/few-shot-prompt-template.ts#L50)
|
|
53
53
|
|
|
54
54
|
#### Parameters
|
|
55
55
|
|
|
@@ -99,7 +99,7 @@ Declares the data object used for template interpolation.
|
|
|
99
99
|
|
|
100
100
|
> **examplePrompt**: `undefined` \| [`PromptTemplate`](PromptTemplate.md)
|
|
101
101
|
|
|
102
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/
|
|
102
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/prompt/few-shot-prompt-template.ts#L41)
|
|
103
103
|
|
|
104
104
|
***
|
|
105
105
|
|
|
@@ -107,7 +107,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-te
|
|
|
107
107
|
|
|
108
108
|
> **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
|
|
109
109
|
|
|
110
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:40](https://github.com/isdk/ai-tool.js/blob/
|
|
110
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:40](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/prompt/few-shot-prompt-template.ts#L40)
|
|
111
111
|
|
|
112
112
|
***
|
|
113
113
|
|
|
@@ -115,7 +115,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-te
|
|
|
115
115
|
|
|
116
116
|
> **exampleSeparator**: `string`
|
|
117
117
|
|
|
118
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:43](https://github.com/isdk/ai-tool.js/blob/
|
|
118
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:43](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/prompt/few-shot-prompt-template.ts#L43)
|
|
119
119
|
|
|
120
120
|
***
|
|
121
121
|
|
|
@@ -137,7 +137,7 @@ Declares the list of input variables expected by the template.
|
|
|
137
137
|
|
|
138
138
|
> **prefix**: `string`
|
|
139
139
|
|
|
140
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:44](https://github.com/isdk/ai-tool.js/blob/
|
|
140
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:44](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/prompt/few-shot-prompt-template.ts#L44)
|
|
141
141
|
|
|
142
142
|
***
|
|
143
143
|
|
|
@@ -145,7 +145,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-te
|
|
|
145
145
|
|
|
146
146
|
> **suffix**: `string`
|
|
147
147
|
|
|
148
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:42](https://github.com/isdk/ai-tool.js/blob/
|
|
148
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:42](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/prompt/few-shot-prompt-template.ts#L42)
|
|
149
149
|
|
|
150
150
|
***
|
|
151
151
|
|
|
@@ -339,7 +339,7 @@ The Root Factory class
|
|
|
339
339
|
|
|
340
340
|
> **\_format**(`data`): `Promise`\<`string`\>
|
|
341
341
|
|
|
342
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/
|
|
342
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/prompt/few-shot-prompt-template.ts#L69)
|
|
343
343
|
|
|
344
344
|
Placeholder method for formatting the template. Must be implemented by subclasses.
|
|
345
345
|
|
|
@@ -367,7 +367,7 @@ A formatted string or a promise resolving to the formatted string.
|
|
|
367
367
|
|
|
368
368
|
> **\_initialize**(`options`?): `void`
|
|
369
369
|
|
|
370
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:54](https://github.com/isdk/ai-tool.js/blob/
|
|
370
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:54](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/prompt/few-shot-prompt-template.ts#L54)
|
|
371
371
|
|
|
372
372
|
Placeholder method for initializing the template. Must be implemented by subclasses.
|
|
373
373
|
|
|
@@ -547,7 +547,7 @@ console.log(dateResult.date instanceof Date); // Output: true
|
|
|
547
547
|
|
|
548
548
|
> **toJSON**(`options`): [`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
|
|
549
549
|
|
|
550
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:94](https://github.com/isdk/ai-tool.js/blob/
|
|
550
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:94](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/prompt/few-shot-prompt-template.ts#L94)
|
|
551
551
|
|
|
552
552
|
Serializes the `StringTemplate` instance into a JSON-compatible object.
|
|
553
553
|
|
|
@@ -916,7 +916,7 @@ the name to register
|
|
|
916
916
|
|
|
917
917
|
> `static` **from**\<`T`\>(`options`): [`FewShotPromptTemplate`](FewShotPromptTemplate.md)\<`T`\>
|
|
918
918
|
|
|
919
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:46](https://github.com/isdk/ai-tool.js/blob/
|
|
919
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:46](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/prompt/few-shot-prompt-template.ts#L46)
|
|
920
920
|
|
|
921
921
|
Creates a new instance of the `StringTemplate` class.
|
|
922
922
|
|