@isdk/ai-tool 0.8.0 → 0.8.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/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 +61 -61
- package/docs/api/classes/EventClient.md +88 -88
- package/docs/api/classes/EventServer.md +83 -83
- 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 +15 -15
- 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 +68 -68
- package/docs/api/classes/ResServerTools.md +69 -69
- package/docs/api/classes/RpcMethodsClientTool.md +63 -63
- package/docs/api/classes/RpcMethodsServerTool.md +64 -64
- package/docs/api/classes/SSEChannel.md +19 -19
- package/docs/api/classes/Semaphore.md +26 -26
- package/docs/api/classes/ServerToolTransport.md +13 -13
- package/docs/api/classes/ServerTools.md +57 -57
- package/docs/api/classes/SignalGate.md +9 -9
- package/docs/api/classes/SseClientPubSubTransport.md +4 -4
- package/docs/api/classes/SseServerPubSubTransport.md +10 -10
- 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/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/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/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/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 +7 -7
- 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 +4 -4
- package/docs/api/interfaces/IPubSubServerTransport.md +11 -11
- 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/PubSubClientStream.md +10 -10
- 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 +3 -3
- package/docs/api/interfaces/ResServerFuncParams.md +6 -6
- package/docs/api/interfaces/RpcMethodsClientFuncParams.md +2 -2
- package/docs/api/interfaces/RpcMethodsServerFuncParams.md +4 -4
- 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 +3 -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 +6 -6
- package/docs/api/type-aliases/RpcMethodHandler.md +1 -1
- package/docs/api/type-aliases/SSEClient.md +5 -5
- package/docs/api/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/api/type-aliases/TFunc.md +1 -1
- package/docs/api/type-aliases/UUIDVersions.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/ClientEventPrefix.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 +1 -1
- package/docs/api/variables/RpcMethodsServerToolSchema.md +1 -1
- 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/backendEventable.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/docs/api/variables/makeToolFuncCancelable.md +1 -1
- package/docs/api/variables/wait.md +1 -1
- package/package.json +3 -3
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ResServerTools
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L11)
|
|
10
10
|
|
|
11
11
|
Represents a function that runs on a server and can be exposed to clients.
|
|
12
12
|
|
|
@@ -32,7 +32,7 @@ server-side execution contexts. It is designed to work with a transport layer
|
|
|
32
32
|
|
|
33
33
|
> **new ResServerTools**(`name`, `options`): `ResServerTools`
|
|
34
34
|
|
|
35
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
35
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:27](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L27)
|
|
36
36
|
|
|
37
37
|
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
38
38
|
|
|
@@ -72,7 +72,7 @@ Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/p
|
|
|
72
72
|
|
|
73
73
|
> **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"` = `'res'`
|
|
74
74
|
|
|
75
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:21](https://github.com/isdk/ai-tool.js/blob/
|
|
75
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:21](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L21)
|
|
76
76
|
|
|
77
77
|
The action to be used for the remote call. This typically represents an RPC method name.
|
|
78
78
|
Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
|
|
@@ -87,7 +87,7 @@ Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (
|
|
|
87
87
|
|
|
88
88
|
> `optional` **alias**: `string` \| `string`[]
|
|
89
89
|
|
|
90
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/
|
|
90
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L130)
|
|
91
91
|
|
|
92
92
|
Optional aliases for the function name.
|
|
93
93
|
|
|
@@ -101,7 +101,7 @@ Optional aliases for the function name.
|
|
|
101
101
|
|
|
102
102
|
> `optional` **allowExportFunc**: `boolean`
|
|
103
103
|
|
|
104
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:35](https://github.com/isdk/ai-tool.js/blob/
|
|
104
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:35](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/server-tools.ts#L35)
|
|
105
105
|
|
|
106
106
|
If set to true, the body of the function (`func`) will be serialized and sent
|
|
107
107
|
to the client when tools are loaded. This allows the client to execute the
|
|
@@ -117,7 +117,7 @@ function locally instead of making a remote call. Defaults to false.
|
|
|
117
117
|
|
|
118
118
|
> `optional` **apiRoot**: `string`
|
|
119
119
|
|
|
120
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/
|
|
120
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/consts.ts#L89)
|
|
121
121
|
|
|
122
122
|
The root endpoint for the remote service.
|
|
123
123
|
|
|
@@ -135,7 +135,7 @@ Use `transport` instead.
|
|
|
135
135
|
|
|
136
136
|
> `optional` **asyncFeatures**: `number`
|
|
137
137
|
|
|
138
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/
|
|
138
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L144)
|
|
139
139
|
|
|
140
140
|
A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
|
|
141
141
|
This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
|
|
@@ -197,7 +197,7 @@ The default options for export and assign
|
|
|
197
197
|
|
|
198
198
|
> `optional` **depends**: `object`
|
|
199
199
|
|
|
200
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/
|
|
200
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L167)
|
|
201
201
|
|
|
202
202
|
A map of dependencies this function has on other tool functions.
|
|
203
203
|
Declaring dependencies ensures that they are automatically registered when this function is registered.
|
|
@@ -236,7 +236,7 @@ mainFunc.register();
|
|
|
236
236
|
|
|
237
237
|
> `optional` **description**: `string`
|
|
238
238
|
|
|
239
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/
|
|
239
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L172)
|
|
240
240
|
|
|
241
241
|
A detailed description of what the function does.
|
|
242
242
|
|
|
@@ -250,7 +250,7 @@ A detailed description of what the function does.
|
|
|
250
250
|
|
|
251
251
|
> `optional` **fetchOptions**: `any`
|
|
252
252
|
|
|
253
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:100](https://github.com/isdk/ai-tool.js/blob/
|
|
253
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:100](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/consts.ts#L100)
|
|
254
254
|
|
|
255
255
|
Addtional options to be passed to the underlying `fetch` call in a transport.
|
|
256
256
|
|
|
@@ -264,7 +264,7 @@ Addtional options to be passed to the underlying `fetch` call in a transport.
|
|
|
264
264
|
|
|
265
265
|
> `optional` **isApi**: `boolean`
|
|
266
266
|
|
|
267
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/
|
|
267
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L119)
|
|
268
268
|
|
|
269
269
|
If true, indicates that this function should be treated as a server-side API.
|
|
270
270
|
|
|
@@ -278,7 +278,7 @@ If true, indicates that this function should be treated as a server-side API.
|
|
|
278
278
|
|
|
279
279
|
> **methods**: `string`[]
|
|
280
280
|
|
|
281
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
281
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:11](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/rpc-methods-server-tool.ts#L11)
|
|
282
282
|
|
|
283
283
|
#### Inherited from
|
|
284
284
|
|
|
@@ -290,7 +290,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:11](
|
|
|
290
290
|
|
|
291
291
|
> `optional` **name**: `string`
|
|
292
292
|
|
|
293
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/
|
|
293
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L76)
|
|
294
294
|
|
|
295
295
|
The unique name of the function.
|
|
296
296
|
|
|
@@ -318,7 +318,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
318
318
|
|
|
319
319
|
> **params**: [`FuncParams`](../interfaces/FuncParams.md)
|
|
320
320
|
|
|
321
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:22](https://github.com/isdk/ai-tool.js/blob/
|
|
321
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:22](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L22)
|
|
322
322
|
|
|
323
323
|
Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
|
|
324
324
|
|
|
@@ -332,7 +332,7 @@ Parameter definitions, which can be an object mapping names to definitions or an
|
|
|
332
332
|
|
|
333
333
|
> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
|
|
334
334
|
|
|
335
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/
|
|
335
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L86)
|
|
336
336
|
|
|
337
337
|
The expected return type of the function, described as a string or a JSON schema object.
|
|
338
338
|
|
|
@@ -346,7 +346,7 @@ The expected return type of the function, described as a string or a JSON schema
|
|
|
346
346
|
|
|
347
347
|
> `optional` **scope**: `any`
|
|
348
348
|
|
|
349
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/
|
|
349
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L91)
|
|
350
350
|
|
|
351
351
|
The execution scope or context (`this`) for the function.
|
|
352
352
|
|
|
@@ -360,7 +360,7 @@ The execution scope or context (`this`) for the function.
|
|
|
360
360
|
|
|
361
361
|
> `optional` **setup**: (`this`, `options?`) => `void`
|
|
362
362
|
|
|
363
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/
|
|
363
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L114)
|
|
364
364
|
|
|
365
365
|
A lifecycle hook called once during the `ToolFunc` instance's initialization.
|
|
366
366
|
It allows for initial setup, state configuration, or property modification on the instance
|
|
@@ -406,7 +406,7 @@ console.log(myFunc.customState); // Outputs: 'configured'
|
|
|
406
406
|
|
|
407
407
|
> `optional` **stream**: `boolean`
|
|
408
408
|
|
|
409
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/
|
|
409
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L125)
|
|
410
410
|
|
|
411
411
|
If true, indicates that the function has the *capability* to stream its output.
|
|
412
412
|
Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
|
|
@@ -421,7 +421,7 @@ Whether a specific call is streamed is determined by a `stream` property in the
|
|
|
421
421
|
|
|
422
422
|
> `optional` **tags**: `string` \| `string`[]
|
|
423
423
|
|
|
424
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/
|
|
424
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L96)
|
|
425
425
|
|
|
426
426
|
Tags for grouping or filtering functions.
|
|
427
427
|
|
|
@@ -435,7 +435,7 @@ Tags for grouping or filtering functions.
|
|
|
435
435
|
|
|
436
436
|
> `optional` **title**: `string`
|
|
437
437
|
|
|
438
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/
|
|
438
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L177)
|
|
439
439
|
|
|
440
440
|
A concise, human-readable title for the function, often used in UI or by AI.
|
|
441
441
|
|
|
@@ -449,7 +449,7 @@ A concise, human-readable title for the function, often used in UI or by AI.
|
|
|
449
449
|
|
|
450
450
|
> `static` **aliases**: `object` = `{}`
|
|
451
451
|
|
|
452
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/
|
|
452
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L305)
|
|
453
453
|
|
|
454
454
|
A static map of aliases to their corresponding function names.
|
|
455
455
|
|
|
@@ -467,7 +467,7 @@ A static map of aliases to their corresponding function names.
|
|
|
467
467
|
|
|
468
468
|
> `static` **dataPath**: `string`
|
|
469
469
|
|
|
470
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/
|
|
470
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L312)
|
|
471
471
|
|
|
472
472
|
A conventional property to designate a file path for saving the registered `ToolFunc` data.
|
|
473
473
|
Note: The `ToolFunc` class itself does not implement persistence logic. It is up to the
|
|
@@ -483,7 +483,7 @@ developer to use this path to save and load the `ToolFunc.items` registry if nee
|
|
|
483
483
|
|
|
484
484
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
485
485
|
|
|
486
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/
|
|
486
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L300)
|
|
487
487
|
|
|
488
488
|
A static registry of all `ToolFunc` instances, indexed by name.
|
|
489
489
|
|
|
@@ -497,7 +497,7 @@ A static registry of all `ToolFunc` instances, indexed by name.
|
|
|
497
497
|
|
|
498
498
|
> `static` **SpecialRpcMethodNames**: `any`
|
|
499
499
|
|
|
500
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:20](https://github.com/isdk/ai-tool.js/blob/
|
|
500
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:20](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L20)
|
|
501
501
|
|
|
502
502
|
#### Inherited from
|
|
503
503
|
|
|
@@ -511,7 +511,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:20](https:/
|
|
|
511
511
|
|
|
512
512
|
> **get** **SpecialRpcMethodNames**(): `any`
|
|
513
513
|
|
|
514
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:22](https://github.com/isdk/ai-tool.js/blob/
|
|
514
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:22](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/rpc-methods-server-tool.ts#L22)
|
|
515
515
|
|
|
516
516
|
##### Returns
|
|
517
517
|
|
|
@@ -529,7 +529,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:22](
|
|
|
529
529
|
|
|
530
530
|
> **get** `static` **apiRoot**(): `undefined` \| `string`
|
|
531
531
|
|
|
532
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:57](https://github.com/isdk/ai-tool.js/blob/
|
|
532
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:57](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/server-tools.ts#L57)
|
|
533
533
|
|
|
534
534
|
The conventional root path for the API endpoint.
|
|
535
535
|
|
|
@@ -547,7 +547,7 @@ The conventional root path for the API endpoint.
|
|
|
547
547
|
|
|
548
548
|
> **arr2ObjParams**(`params`): `any`[]
|
|
549
549
|
|
|
550
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/
|
|
550
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L629)
|
|
551
551
|
|
|
552
552
|
Converts an array of positional arguments into a named parameters object.
|
|
553
553
|
This is used internally to support functions defined with named parameters.
|
|
@@ -742,7 +742,7 @@ the dest object
|
|
|
742
742
|
|
|
743
743
|
> **cast**(`key`, `value`): `any`
|
|
744
744
|
|
|
745
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:48](https://github.com/isdk/ai-tool.js/blob/
|
|
745
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:48](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/rpc-methods-server-tool.ts#L48)
|
|
746
746
|
|
|
747
747
|
#### Parameters
|
|
748
748
|
|
|
@@ -768,7 +768,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:48](
|
|
|
768
768
|
|
|
769
769
|
> **castParams**(`params`): [`RpcMethodsServerFuncParams`](../interfaces/RpcMethodsServerFuncParams.md)
|
|
770
770
|
|
|
771
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:40](https://github.com/isdk/ai-tool.js/blob/
|
|
771
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:40](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L40)
|
|
772
772
|
|
|
773
773
|
#### Parameters
|
|
774
774
|
|
|
@@ -874,7 +874,7 @@ the defined attributes of the object
|
|
|
874
874
|
|
|
875
875
|
> `optional` **delete**(`__namedParameters`): `any`
|
|
876
876
|
|
|
877
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:15](https://github.com/isdk/ai-tool.js/blob/
|
|
877
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:15](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L15)
|
|
878
878
|
|
|
879
879
|
#### Parameters
|
|
880
880
|
|
|
@@ -924,7 +924,7 @@ the dest object.
|
|
|
924
924
|
|
|
925
925
|
> **func**(`params`): `any`
|
|
926
926
|
|
|
927
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:68](https://github.com/isdk/ai-tool.js/blob/
|
|
927
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:68](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/rpc-methods-server-tool.ts#L68)
|
|
928
928
|
|
|
929
929
|
Placeholder for the actual server-side function implementation.
|
|
930
930
|
This method is intended to be defined when a `ServerTools` instance is created.
|
|
@@ -953,7 +953,7 @@ The result of the function.
|
|
|
953
953
|
|
|
954
954
|
> `optional` **get**(`__namedParameters`): `any`
|
|
955
955
|
|
|
956
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
956
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L12)
|
|
957
957
|
|
|
958
958
|
#### Parameters
|
|
959
959
|
|
|
@@ -971,7 +971,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:12](https:/
|
|
|
971
971
|
|
|
972
972
|
> **getFunc**(`name?`): `any`
|
|
973
973
|
|
|
974
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/
|
|
974
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L720)
|
|
975
975
|
|
|
976
976
|
Gets a bound function reference for execution with named parameters.
|
|
977
977
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -1001,7 +1001,7 @@ A function reference or `undefined` if not found.
|
|
|
1001
1001
|
|
|
1002
1002
|
> **getFuncWithPos**(`name?`): `any`
|
|
1003
1003
|
|
|
1004
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/
|
|
1004
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L777)
|
|
1005
1005
|
|
|
1006
1006
|
Gets a bound function reference suitable for positional argument execution.
|
|
1007
1007
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -1031,7 +1031,7 @@ A function reference or `undefined` if not found.
|
|
|
1031
1031
|
|
|
1032
1032
|
> **getMethodFromParams**(`params`): `any`
|
|
1033
1033
|
|
|
1034
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:31](https://github.com/isdk/ai-tool.js/blob/
|
|
1034
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:31](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L31)
|
|
1035
1035
|
|
|
1036
1036
|
#### Parameters
|
|
1037
1037
|
|
|
@@ -1073,7 +1073,7 @@ the descriptors of properties object
|
|
|
1073
1073
|
|
|
1074
1074
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
1075
1075
|
|
|
1076
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/
|
|
1076
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L787)
|
|
1077
1077
|
|
|
1078
1078
|
Checks if the current function instance supports a specific async feature.
|
|
1079
1079
|
|
|
@@ -1153,7 +1153,7 @@ this object.
|
|
|
1153
1153
|
|
|
1154
1154
|
> **initRpcMethods**(`methods`): `void`
|
|
1155
1155
|
|
|
1156
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
1156
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-server-tool.ts:27](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/rpc-methods-server-tool.ts#L27)
|
|
1157
1157
|
|
|
1158
1158
|
#### Parameters
|
|
1159
1159
|
|
|
@@ -1231,7 +1231,7 @@ The source object
|
|
|
1231
1231
|
|
|
1232
1232
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
1233
1233
|
|
|
1234
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/
|
|
1234
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L805)
|
|
1235
1235
|
|
|
1236
1236
|
Determines if a function call should produce a stream.
|
|
1237
1237
|
|
|
@@ -1265,7 +1265,7 @@ The runtime parameters passed to the function call.
|
|
|
1265
1265
|
|
|
1266
1266
|
> `optional` **list**(`options?`): `any`
|
|
1267
1267
|
|
|
1268
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
1268
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:16](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L16)
|
|
1269
1269
|
|
|
1270
1270
|
#### Parameters
|
|
1271
1271
|
|
|
@@ -1315,7 +1315,7 @@ the dest object.
|
|
|
1315
1315
|
|
|
1316
1316
|
> **obj2ArrParams**(`params?`): `any`[]
|
|
1317
1317
|
|
|
1318
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/
|
|
1318
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L648)
|
|
1319
1319
|
|
|
1320
1320
|
Converts a named parameters object into an array of positional arguments.
|
|
1321
1321
|
This is used for functions defined with positional parameters.
|
|
@@ -1344,7 +1344,7 @@ An array of positional arguments.
|
|
|
1344
1344
|
|
|
1345
1345
|
> `optional` **post**(`options`): `any`
|
|
1346
1346
|
|
|
1347
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
1347
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L13)
|
|
1348
1348
|
|
|
1349
1349
|
#### Parameters
|
|
1350
1350
|
|
|
@@ -1388,7 +1388,7 @@ A property name.
|
|
|
1388
1388
|
|
|
1389
1389
|
> `optional` **put**(`__namedParameters`): `any`
|
|
1390
1390
|
|
|
1391
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
1391
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-server-tools.ts#L14)
|
|
1392
1392
|
|
|
1393
1393
|
#### Parameters
|
|
1394
1394
|
|
|
@@ -1406,7 +1406,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-server-tools.ts:14](https:/
|
|
|
1406
1406
|
|
|
1407
1407
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
1408
1408
|
|
|
1409
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/
|
|
1409
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L602)
|
|
1410
1410
|
|
|
1411
1411
|
Registers the current `ToolFunc` instance into the static registry.
|
|
1412
1412
|
Also registers any declared dependencies.
|
|
@@ -1427,7 +1427,7 @@ The instance itself upon successful registration, or `false` if it already exist
|
|
|
1427
1427
|
|
|
1428
1428
|
> **run**(`params`, `context?`): `Promise`\<`any`\>
|
|
1429
1429
|
|
|
1430
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/
|
|
1430
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/server-tools.ts#L98)
|
|
1431
1431
|
|
|
1432
1432
|
Overrides the base `run` method to inject transport-specific context.
|
|
1433
1433
|
If a `context` object containing `req` and `reply` is provided, these are
|
|
@@ -1469,7 +1469,7 @@ The result of the function execution.
|
|
|
1469
1469
|
|
|
1470
1470
|
> **runAs**(`name`, `params?`): `Promise`\<`any`\>
|
|
1471
1471
|
|
|
1472
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/
|
|
1472
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L697)
|
|
1473
1473
|
|
|
1474
1474
|
Asynchronously executes another registered function by name.
|
|
1475
1475
|
This method delegates to `runAsSync()` internally.
|
|
@@ -1504,7 +1504,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1504
1504
|
|
|
1505
1505
|
> **runAsSync**(`name`, `params?`): `any`
|
|
1506
1506
|
|
|
1507
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/
|
|
1507
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L708)
|
|
1508
1508
|
|
|
1509
1509
|
Synchronously executes another registered function by name.
|
|
1510
1510
|
This is a convenience method that forwards the call to the static `runSync()` method.
|
|
@@ -1539,7 +1539,7 @@ The result of the function execution.
|
|
|
1539
1539
|
|
|
1540
1540
|
> **runSync**(`params?`): `any`
|
|
1541
1541
|
|
|
1542
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/
|
|
1542
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L667)
|
|
1543
1543
|
|
|
1544
1544
|
Executes the function synchronously with a named parameters object.
|
|
1545
1545
|
|
|
@@ -1571,7 +1571,7 @@ Will throw an error if an array of parameters is passed to a function that expec
|
|
|
1571
1571
|
|
|
1572
1572
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1573
1573
|
|
|
1574
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/
|
|
1574
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L755)
|
|
1575
1575
|
|
|
1576
1576
|
Executes the function asynchronously using positional arguments.
|
|
1577
1577
|
Delegates to `runWithPosSync()` internally.
|
|
@@ -1600,7 +1600,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1600
1600
|
|
|
1601
1601
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1602
1602
|
|
|
1603
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/
|
|
1603
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L766)
|
|
1604
1604
|
|
|
1605
1605
|
Asynchronously executes another function by name using positional arguments.
|
|
1606
1606
|
Delegates to `runWithPosAsSync()` internally.
|
|
@@ -1635,7 +1635,7 @@ A promise that resolves with the result of the function execution.
|
|
|
1635
1635
|
|
|
1636
1636
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1637
1637
|
|
|
1638
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/
|
|
1638
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L745)
|
|
1639
1639
|
|
|
1640
1640
|
Synchronously executes another function by name using positional arguments.
|
|
1641
1641
|
This is a convenience wrapper around the static `runWithPosSync()` method.
|
|
@@ -1670,7 +1670,7 @@ The result of the function execution.
|
|
|
1670
1670
|
|
|
1671
1671
|
> **runWithPosSync**(...`params`): `any`
|
|
1672
1672
|
|
|
1673
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/
|
|
1673
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L731)
|
|
1674
1674
|
|
|
1675
1675
|
Executes the function synchronously using positional arguments.
|
|
1676
1676
|
If the function expects named parameters, it converts the arguments automatically.
|
|
@@ -1777,7 +1777,7 @@ Returns a string representation of an object.
|
|
|
1777
1777
|
|
|
1778
1778
|
> **unregister**(): `any`
|
|
1779
1779
|
|
|
1780
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/
|
|
1780
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L619)
|
|
1781
1781
|
|
|
1782
1782
|
Removes the current `ToolFunc` instance from the static registry.
|
|
1783
1783
|
|
|
@@ -2349,7 +2349,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
2349
2349
|
|
|
2350
2350
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
2351
2351
|
|
|
2352
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/
|
|
2352
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L319)
|
|
2353
2353
|
|
|
2354
2354
|
Retrieves a registered function by its name or alias.
|
|
2355
2355
|
|
|
@@ -2377,7 +2377,7 @@ The `ToolFunc` instance if found, otherwise `undefined`.
|
|
|
2377
2377
|
|
|
2378
2378
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
2379
2379
|
|
|
2380
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/
|
|
2380
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L365)
|
|
2381
2381
|
|
|
2382
2382
|
Retrieves all registered functions that have a specific tag.
|
|
2383
2383
|
|
|
@@ -2405,7 +2405,7 @@ An array of matching `ToolFunc` instances.
|
|
|
2405
2405
|
|
|
2406
2406
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2407
2407
|
|
|
2408
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/
|
|
2408
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L340)
|
|
2409
2409
|
|
|
2410
2410
|
Finds the first registered function that has a specific tag.
|
|
2411
2411
|
|
|
@@ -2433,7 +2433,7 @@ The first matching `ToolFunc` instance, or `undefined` if none is found.
|
|
|
2433
2433
|
|
|
2434
2434
|
> `static` **getFunc**(`name`): `any`
|
|
2435
2435
|
|
|
2436
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/
|
|
2436
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L431)
|
|
2437
2437
|
|
|
2438
2438
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2439
2439
|
This reference is suitable for execution with an object of named parameters.
|
|
@@ -2462,7 +2462,7 @@ A bound function reference, or `undefined` if not found.
|
|
|
2462
2462
|
|
|
2463
2463
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
2464
2464
|
|
|
2465
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/
|
|
2465
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L472)
|
|
2466
2466
|
|
|
2467
2467
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2468
2468
|
This reference is suitable for execution with positional arguments.
|
|
@@ -2653,7 +2653,7 @@ The object that references the prototype.
|
|
|
2653
2653
|
|
|
2654
2654
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2655
2655
|
|
|
2656
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/
|
|
2656
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L388)
|
|
2657
2657
|
|
|
2658
2658
|
Checks if any registered function has a specific asynchronous feature.
|
|
2659
2659
|
|
|
@@ -2873,7 +2873,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2873
2873
|
|
|
2874
2874
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2875
2875
|
|
|
2876
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/
|
|
2876
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L331)
|
|
2877
2877
|
|
|
2878
2878
|
Returns the complete map of all registered functions.
|
|
2879
2879
|
|
|
@@ -2927,7 +2927,7 @@ Object to make non-extensible.
|
|
|
2927
2927
|
|
|
2928
2928
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2929
2929
|
|
|
2930
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/
|
|
2930
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L495)
|
|
2931
2931
|
|
|
2932
2932
|
Registers a new tool function.
|
|
2933
2933
|
|
|
@@ -2959,7 +2959,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2959
2959
|
|
|
2960
2960
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2961
2961
|
|
|
2962
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/
|
|
2962
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L496)
|
|
2963
2963
|
|
|
2964
2964
|
Registers a new tool function.
|
|
2965
2965
|
|
|
@@ -2991,7 +2991,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2991
2991
|
|
|
2992
2992
|
> `static` **register**(`name`, `options?`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2993
2993
|
|
|
2994
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/
|
|
2994
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L497)
|
|
2995
2995
|
|
|
2996
2996
|
Registers a new tool function.
|
|
2997
2997
|
|
|
@@ -3025,7 +3025,7 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
3025
3025
|
|
|
3026
3026
|
> `static` **run**(`name`, `params?`): `Promise`\<`any`\>
|
|
3027
3027
|
|
|
3028
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/
|
|
3028
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L402)
|
|
3029
3029
|
|
|
3030
3030
|
Asynchronously executes a registered function by name with named parameters.
|
|
3031
3031
|
|
|
@@ -3063,7 +3063,7 @@ If the function with the given name is not found.
|
|
|
3063
3063
|
|
|
3064
3064
|
> `static` **runSync**(`name`, `params?`): `any`
|
|
3065
3065
|
|
|
3066
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/
|
|
3066
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L417)
|
|
3067
3067
|
|
|
3068
3068
|
Synchronously executes a registered function by name with named parameters.
|
|
3069
3069
|
|
|
@@ -3101,7 +3101,7 @@ If the function with the given name is not found.
|
|
|
3101
3101
|
|
|
3102
3102
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
3103
3103
|
|
|
3104
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/
|
|
3104
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L443)
|
|
3105
3105
|
|
|
3106
3106
|
Asynchronously executes a function using positional arguments.
|
|
3107
3107
|
|
|
@@ -3139,7 +3139,7 @@ If the function with the given name is not found.
|
|
|
3139
3139
|
|
|
3140
3140
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
3141
3141
|
|
|
3142
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/
|
|
3142
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L458)
|
|
3143
3143
|
|
|
3144
3144
|
Synchronously executes a function using positional arguments.
|
|
3145
3145
|
|
|
@@ -3209,7 +3209,7 @@ Object on which to lock the attributes.
|
|
|
3209
3209
|
|
|
3210
3210
|
> `static` **setApiRoot**(`v`): `void`
|
|
3211
3211
|
|
|
3212
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:61](https://github.com/isdk/ai-tool.js/blob/
|
|
3212
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:61](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/server-tools.ts#L61)
|
|
3213
3213
|
|
|
3214
3214
|
#### Parameters
|
|
3215
3215
|
|
|
@@ -3263,7 +3263,7 @@ The value of the new prototype or null.
|
|
|
3263
3263
|
|
|
3264
3264
|
> `static` **toJSON**(): `object`
|
|
3265
3265
|
|
|
3266
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:74](https://github.com/isdk/ai-tool.js/blob/
|
|
3266
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:74](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/server-tools.ts#L74)
|
|
3267
3267
|
|
|
3268
3268
|
Serializes all registered `ServerTools` instances into a JSON object.
|
|
3269
3269
|
This method is typically called by a transport's discovery endpoint.
|
|
@@ -3287,7 +3287,7 @@ A map of serializable tool definitions.
|
|
|
3287
3287
|
|
|
3288
3288
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
3289
3289
|
|
|
3290
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/
|
|
3290
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L547)
|
|
3291
3291
|
|
|
3292
3292
|
Unregisters a function by its name, also removing any associated aliases.
|
|
3293
3293
|
|