@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,11 +6,20 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ResClientTools
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L9)
|
|
10
|
+
|
|
11
|
+
Represents a client-side proxy for a remote tool function.
|
|
12
|
+
|
|
13
|
+
A `ClientTools` instance is a `ToolFunc` that, when executed, does not run
|
|
14
|
+
local code. Instead, it serializes the parameters and uses an injected
|
|
15
|
+
transport layer (`IClientToolTransport`) to make a remote procedure call
|
|
16
|
+
to its corresponding `ServerTools` counterpart.
|
|
17
|
+
|
|
18
|
+
These tools are typically created dynamically by loading definitions from a server.
|
|
10
19
|
|
|
11
20
|
## Extends
|
|
12
21
|
|
|
13
|
-
- `RpcMethodsClientTool`
|
|
22
|
+
- [`RpcMethodsClientTool`](RpcMethodsClientTool.md)
|
|
14
23
|
|
|
15
24
|
## Extended by
|
|
16
25
|
|
|
@@ -26,9 +35,9 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:9](https://
|
|
|
26
35
|
|
|
27
36
|
> **new ResClientTools**(`name`, `options`?): [`ResClientTools`](ResClientTools.md)
|
|
28
37
|
|
|
29
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/
|
|
38
|
+
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)
|
|
30
39
|
|
|
31
|
-
|
|
40
|
+
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
32
41
|
|
|
33
42
|
#### Parameters
|
|
34
43
|
|
|
@@ -48,6 +57,10 @@ Configuration options if not provided in the first argument.
|
|
|
48
57
|
|
|
49
58
|
[`ResClientTools`](ResClientTools.md)
|
|
50
59
|
|
|
60
|
+
#### Inherited from
|
|
61
|
+
|
|
62
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`constructor`](RpcMethodsClientTool.md#constructors)
|
|
63
|
+
|
|
51
64
|
## Properties
|
|
52
65
|
|
|
53
66
|
### $attributes
|
|
@@ -56,34 +69,46 @@ Configuration options if not provided in the first argument.
|
|
|
56
69
|
|
|
57
70
|
Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L5)
|
|
58
71
|
|
|
72
|
+
#### Inherited from
|
|
73
|
+
|
|
74
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`$attributes`](RpcMethodsClientTool.md#$attributes)
|
|
75
|
+
|
|
59
76
|
***
|
|
60
77
|
|
|
61
78
|
### action?
|
|
62
79
|
|
|
63
80
|
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
64
81
|
|
|
65
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/
|
|
82
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/consts.ts#L95)
|
|
66
83
|
|
|
67
84
|
The action to be used for the remote call. This typically represents an RPC method name.
|
|
68
85
|
Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
|
|
69
86
|
|
|
87
|
+
#### Inherited from
|
|
88
|
+
|
|
89
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`action`](RpcMethodsClientTool.md#action)
|
|
90
|
+
|
|
70
91
|
***
|
|
71
92
|
|
|
72
93
|
### alias?
|
|
73
94
|
|
|
74
95
|
> `optional` **alias**: `string` \| `string`[]
|
|
75
96
|
|
|
76
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/
|
|
97
|
+
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)
|
|
77
98
|
|
|
78
99
|
Optional aliases for the function name.
|
|
79
100
|
|
|
101
|
+
#### Inherited from
|
|
102
|
+
|
|
103
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`alias`](RpcMethodsClientTool.md#alias)
|
|
104
|
+
|
|
80
105
|
***
|
|
81
106
|
|
|
82
107
|
### asyncFeatures?
|
|
83
108
|
|
|
84
109
|
> `optional` **asyncFeatures**: `number`
|
|
85
110
|
|
|
86
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/
|
|
111
|
+
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)
|
|
87
112
|
|
|
88
113
|
A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
|
|
89
114
|
This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
|
|
@@ -103,6 +128,10 @@ const func = new ToolFunc({
|
|
|
103
128
|
});
|
|
104
129
|
```
|
|
105
130
|
|
|
131
|
+
#### Inherited from
|
|
132
|
+
|
|
133
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`asyncFeatures`](RpcMethodsClientTool.md#asyncfeatures)
|
|
134
|
+
|
|
106
135
|
***
|
|
107
136
|
|
|
108
137
|
### constructor
|
|
@@ -131,13 +160,17 @@ The default options for export and assign
|
|
|
131
160
|
|
|
132
161
|
> `optional` **export**: `IMergeOptions`
|
|
133
162
|
|
|
163
|
+
#### Inherited from
|
|
164
|
+
|
|
165
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`defaultOptions`](RpcMethodsClientTool.md#defaultoptions)
|
|
166
|
+
|
|
134
167
|
***
|
|
135
168
|
|
|
136
169
|
### depends?
|
|
137
170
|
|
|
138
171
|
> `optional` **depends**: `object`
|
|
139
172
|
|
|
140
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/
|
|
173
|
+
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)
|
|
141
174
|
|
|
142
175
|
A map of dependencies this function has on other tool functions.
|
|
143
176
|
Declaring dependencies ensures that they are automatically registered when this function is registered.
|
|
@@ -166,23 +199,31 @@ const mainFunc = new ToolFunc({
|
|
|
166
199
|
mainFunc.register();
|
|
167
200
|
```
|
|
168
201
|
|
|
202
|
+
#### Inherited from
|
|
203
|
+
|
|
204
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`depends`](RpcMethodsClientTool.md#depends)
|
|
205
|
+
|
|
169
206
|
***
|
|
170
207
|
|
|
171
208
|
### description?
|
|
172
209
|
|
|
173
210
|
> `optional` **description**: `string`
|
|
174
211
|
|
|
175
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/
|
|
212
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L172)
|
|
176
213
|
|
|
177
214
|
A detailed description of what the function does.
|
|
178
215
|
|
|
216
|
+
#### Inherited from
|
|
217
|
+
|
|
218
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`description`](RpcMethodsClientTool.md#description)
|
|
219
|
+
|
|
179
220
|
***
|
|
180
221
|
|
|
181
222
|
### ~~fetchOptions?~~
|
|
182
223
|
|
|
183
224
|
> `optional` **fetchOptions**: `any`
|
|
184
225
|
|
|
185
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:101](https://github.com/isdk/ai-tool.js/blob/
|
|
226
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:101](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/utils/consts.ts#L101)
|
|
186
227
|
|
|
187
228
|
Options to be passed to the underlying `fetch` call in an HTTP transport.
|
|
188
229
|
|
|
@@ -190,26 +231,38 @@ Options to be passed to the underlying `fetch` call in an HTTP transport.
|
|
|
190
231
|
|
|
191
232
|
Use `transport` instead.
|
|
192
233
|
|
|
234
|
+
#### Inherited from
|
|
235
|
+
|
|
236
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`fetchOptions`](RpcMethodsClientTool.md#fetchoptions)
|
|
237
|
+
|
|
193
238
|
***
|
|
194
239
|
|
|
195
240
|
### isApi?
|
|
196
241
|
|
|
197
242
|
> `optional` **isApi**: `boolean`
|
|
198
243
|
|
|
199
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/
|
|
244
|
+
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)
|
|
200
245
|
|
|
201
246
|
If true, indicates that this function should be treated as a server-side API.
|
|
202
247
|
|
|
248
|
+
#### Inherited from
|
|
249
|
+
|
|
250
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isApi`](RpcMethodsClientTool.md#isapi)
|
|
251
|
+
|
|
203
252
|
***
|
|
204
253
|
|
|
205
254
|
### name?
|
|
206
255
|
|
|
207
256
|
> `optional` **name**: `string`
|
|
208
257
|
|
|
209
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/
|
|
258
|
+
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)
|
|
210
259
|
|
|
211
260
|
The unique name of the function.
|
|
212
261
|
|
|
262
|
+
#### Inherited from
|
|
263
|
+
|
|
264
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`name`](RpcMethodsClientTool.md#name-3)
|
|
265
|
+
|
|
213
266
|
***
|
|
214
267
|
|
|
215
268
|
### nonExported1stChar
|
|
@@ -220,43 +273,59 @@ Defined in: [property-manager.js/src/abstract.d.ts:78](https://github.com/snowyu
|
|
|
220
273
|
|
|
221
274
|
the property with the default prefix '$' will not be exported.
|
|
222
275
|
|
|
276
|
+
#### Inherited from
|
|
277
|
+
|
|
278
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`nonExported1stChar`](RpcMethodsClientTool.md#nonexported1stchar)
|
|
279
|
+
|
|
223
280
|
***
|
|
224
281
|
|
|
225
282
|
### params?
|
|
226
283
|
|
|
227
284
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
228
285
|
|
|
229
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/
|
|
286
|
+
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)
|
|
230
287
|
|
|
231
288
|
Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
|
|
232
289
|
|
|
290
|
+
#### Inherited from
|
|
291
|
+
|
|
292
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`params`](RpcMethodsClientTool.md#params)
|
|
293
|
+
|
|
233
294
|
***
|
|
234
295
|
|
|
235
296
|
### result?
|
|
236
297
|
|
|
237
298
|
> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
|
|
238
299
|
|
|
239
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/
|
|
300
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L86)
|
|
240
301
|
|
|
241
302
|
The expected return type of the function, described as a string or a JSON schema object.
|
|
242
303
|
|
|
304
|
+
#### Inherited from
|
|
305
|
+
|
|
306
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`result`](RpcMethodsClientTool.md#result)
|
|
307
|
+
|
|
243
308
|
***
|
|
244
309
|
|
|
245
310
|
### scope?
|
|
246
311
|
|
|
247
312
|
> `optional` **scope**: `any`
|
|
248
313
|
|
|
249
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/
|
|
314
|
+
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)
|
|
250
315
|
|
|
251
316
|
The execution scope or context (`this`) for the function.
|
|
252
317
|
|
|
318
|
+
#### Inherited from
|
|
319
|
+
|
|
320
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`scope`](RpcMethodsClientTool.md#scope)
|
|
321
|
+
|
|
253
322
|
***
|
|
254
323
|
|
|
255
324
|
### setup()?
|
|
256
325
|
|
|
257
326
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
258
327
|
|
|
259
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/
|
|
328
|
+
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)
|
|
260
329
|
|
|
261
330
|
A lifecycle hook called once during the `ToolFunc` instance's initialization.
|
|
262
331
|
It allows for initial setup, state configuration, or property modification on the instance
|
|
@@ -292,44 +361,64 @@ const myFunc = new ToolFunc({
|
|
|
292
361
|
console.log(myFunc.customState); // Outputs: 'configured'
|
|
293
362
|
```
|
|
294
363
|
|
|
364
|
+
#### Inherited from
|
|
365
|
+
|
|
366
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`setup`](RpcMethodsClientTool.md#setup)
|
|
367
|
+
|
|
295
368
|
***
|
|
296
369
|
|
|
297
370
|
### stream?
|
|
298
371
|
|
|
299
372
|
> `optional` **stream**: `boolean`
|
|
300
373
|
|
|
301
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/
|
|
374
|
+
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)
|
|
302
375
|
|
|
303
376
|
If true, indicates that the function has the *capability* to stream its output.
|
|
304
377
|
Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
|
|
305
378
|
|
|
379
|
+
#### Inherited from
|
|
380
|
+
|
|
381
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`stream`](RpcMethodsClientTool.md#stream)
|
|
382
|
+
|
|
306
383
|
***
|
|
307
384
|
|
|
308
385
|
### tags?
|
|
309
386
|
|
|
310
387
|
> `optional` **tags**: `string` \| `string`[]
|
|
311
388
|
|
|
312
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/
|
|
389
|
+
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)
|
|
313
390
|
|
|
314
391
|
Tags for grouping or filtering functions.
|
|
315
392
|
|
|
393
|
+
#### Inherited from
|
|
394
|
+
|
|
395
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`tags`](RpcMethodsClientTool.md#tags)
|
|
396
|
+
|
|
316
397
|
***
|
|
317
398
|
|
|
318
399
|
### title?
|
|
319
400
|
|
|
320
401
|
> `optional` **title**: `string`
|
|
321
402
|
|
|
322
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/
|
|
403
|
+
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)
|
|
323
404
|
|
|
324
405
|
A concise, human-readable title for the function, often used in UI or by AI.
|
|
325
406
|
|
|
407
|
+
#### Inherited from
|
|
408
|
+
|
|
409
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`title`](RpcMethodsClientTool.md#title)
|
|
410
|
+
|
|
326
411
|
***
|
|
327
412
|
|
|
328
413
|
### action?
|
|
329
414
|
|
|
330
415
|
> `static` `optional` **action**: `string`
|
|
331
416
|
|
|
332
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:32](https://github.com/isdk/ai-tool.js/blob/
|
|
417
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:32](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L32)
|
|
418
|
+
|
|
419
|
+
#### Inherited from
|
|
420
|
+
|
|
421
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`action`](RpcMethodsClientTool.md#action-1)
|
|
333
422
|
|
|
334
423
|
***
|
|
335
424
|
|
|
@@ -337,7 +426,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:32](https://git
|
|
|
337
426
|
|
|
338
427
|
> `static` **aliases**: `object` = `{}`
|
|
339
428
|
|
|
340
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/
|
|
429
|
+
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)
|
|
341
430
|
|
|
342
431
|
A static map of aliases to their corresponding function names.
|
|
343
432
|
|
|
@@ -345,37 +434,49 @@ A static map of aliases to their corresponding function names.
|
|
|
345
434
|
|
|
346
435
|
\[`name`: `string`\]: `string`
|
|
347
436
|
|
|
437
|
+
#### Inherited from
|
|
438
|
+
|
|
439
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`aliases`](RpcMethodsClientTool.md#aliases)
|
|
440
|
+
|
|
348
441
|
***
|
|
349
442
|
|
|
350
443
|
### dataPath
|
|
351
444
|
|
|
352
445
|
> `static` **dataPath**: `string`
|
|
353
446
|
|
|
354
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/
|
|
447
|
+
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)
|
|
355
448
|
|
|
356
449
|
A conventional property to designate a file path for saving the registered `ToolFunc` data.
|
|
357
450
|
Note: The `ToolFunc` class itself does not implement persistence logic. It is up to the
|
|
358
451
|
developer to use this path to save and load the `ToolFunc.items` registry if needed.
|
|
359
452
|
|
|
453
|
+
#### Inherited from
|
|
454
|
+
|
|
455
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`dataPath`](RpcMethodsClientTool.md#datapath)
|
|
456
|
+
|
|
360
457
|
***
|
|
361
458
|
|
|
362
459
|
### items
|
|
363
460
|
|
|
364
461
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
365
462
|
|
|
366
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/
|
|
463
|
+
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)
|
|
367
464
|
|
|
368
465
|
A static registry of all `ToolFunc` instances, indexed by name.
|
|
369
466
|
|
|
467
|
+
#### Inherited from
|
|
468
|
+
|
|
469
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`items`](RpcMethodsClientTool.md#items)
|
|
470
|
+
|
|
370
471
|
## Accessors
|
|
371
472
|
|
|
372
|
-
### apiRoot
|
|
473
|
+
### ~~apiRoot~~
|
|
373
474
|
|
|
374
475
|
#### Get Signature
|
|
375
476
|
|
|
376
477
|
> **get** **apiRoot**(): `string`
|
|
377
478
|
|
|
378
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:109](https://github.com/isdk/ai-tool.js/blob/
|
|
479
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:109](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L109)
|
|
379
480
|
|
|
380
481
|
##### Deprecated
|
|
381
482
|
|
|
@@ -386,6 +487,16 @@ The actual endpoint is managed by the transport.
|
|
|
386
487
|
|
|
387
488
|
`string`
|
|
388
489
|
|
|
490
|
+
The root endpoint for the remote service.
|
|
491
|
+
|
|
492
|
+
#### Deprecated
|
|
493
|
+
|
|
494
|
+
Use `transport` instead.
|
|
495
|
+
|
|
496
|
+
#### Inherited from
|
|
497
|
+
|
|
498
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`apiRoot`](RpcMethodsClientTool.md#apiroot)
|
|
499
|
+
|
|
389
500
|
***
|
|
390
501
|
|
|
391
502
|
### apiRoot
|
|
@@ -394,7 +505,7 @@ The actual endpoint is managed by the transport.
|
|
|
394
505
|
|
|
395
506
|
> **get** `static` **apiRoot**(): `string`
|
|
396
507
|
|
|
397
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:40](https://github.com/isdk/ai-tool.js/blob/
|
|
508
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:40](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L40)
|
|
398
509
|
|
|
399
510
|
##### Deprecated
|
|
400
511
|
|
|
@@ -405,6 +516,10 @@ The actual endpoint is managed by the transport.
|
|
|
405
516
|
|
|
406
517
|
`string`
|
|
407
518
|
|
|
519
|
+
#### Inherited from
|
|
520
|
+
|
|
521
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`apiRoot`](RpcMethodsClientTool.md#apiroot-2)
|
|
522
|
+
|
|
408
523
|
***
|
|
409
524
|
|
|
410
525
|
### transport
|
|
@@ -413,19 +528,23 @@ The actual endpoint is managed by the transport.
|
|
|
413
528
|
|
|
414
529
|
> **get** `static` **transport**(): [`IClientToolTransport`](../interfaces/IClientToolTransport.md)
|
|
415
530
|
|
|
416
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:60](https://github.com/isdk/ai-tool.js/blob/
|
|
531
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:60](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L60)
|
|
417
532
|
|
|
418
533
|
##### Returns
|
|
419
534
|
|
|
420
535
|
[`IClientToolTransport`](../interfaces/IClientToolTransport.md)
|
|
421
536
|
|
|
537
|
+
#### Inherited from
|
|
538
|
+
|
|
539
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`transport`](RpcMethodsClientTool.md#transport)
|
|
540
|
+
|
|
422
541
|
## Methods
|
|
423
542
|
|
|
424
543
|
### \_func()
|
|
425
544
|
|
|
426
545
|
> **\_func**(`action`, `options`): `Promise`\<`any`\>
|
|
427
546
|
|
|
428
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.com/isdk/ai-tool.js/blob/
|
|
547
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/rpc-methods-client-tool.ts#L19)
|
|
429
548
|
|
|
430
549
|
#### Parameters
|
|
431
550
|
|
|
@@ -435,19 +554,23 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:19](
|
|
|
435
554
|
|
|
436
555
|
##### options
|
|
437
556
|
|
|
438
|
-
`RpcMethodsClientFuncParams`
|
|
557
|
+
[`RpcMethodsClientFuncParams`](../interfaces/RpcMethodsClientFuncParams.md)
|
|
439
558
|
|
|
440
559
|
#### Returns
|
|
441
560
|
|
|
442
561
|
`Promise`\<`any`\>
|
|
443
562
|
|
|
563
|
+
#### Inherited from
|
|
564
|
+
|
|
565
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`_func`](RpcMethodsClientTool.md#_func)
|
|
566
|
+
|
|
444
567
|
***
|
|
445
568
|
|
|
446
569
|
### arr2ObjParams()
|
|
447
570
|
|
|
448
571
|
> **arr2ObjParams**(`params`): `any`[]
|
|
449
572
|
|
|
450
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/
|
|
573
|
+
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)
|
|
451
574
|
|
|
452
575
|
Converts an array of positional arguments into a named parameters object.
|
|
453
576
|
This is used internally to support functions defined with named parameters.
|
|
@@ -466,6 +589,10 @@ An array of positional arguments.
|
|
|
466
589
|
|
|
467
590
|
An array containing a single parameters object.
|
|
468
591
|
|
|
592
|
+
#### Inherited from
|
|
593
|
+
|
|
594
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`arr2ObjParams`](RpcMethodsClientTool.md#arr2objparams)
|
|
595
|
+
|
|
469
596
|
***
|
|
470
597
|
|
|
471
598
|
### assign()
|
|
@@ -494,13 +621,17 @@ the source object
|
|
|
494
621
|
|
|
495
622
|
this object
|
|
496
623
|
|
|
624
|
+
#### Inherited from
|
|
625
|
+
|
|
626
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assign`](RpcMethodsClientTool.md#assign)
|
|
627
|
+
|
|
497
628
|
***
|
|
498
629
|
|
|
499
630
|
### assignMethods()
|
|
500
631
|
|
|
501
632
|
> **assignMethods**(`methods`): `void`
|
|
502
633
|
|
|
503
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:32](https://github.com/isdk/ai-tool.js/blob/
|
|
634
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:32](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/rpc-methods-client-tool.ts#L32)
|
|
504
635
|
|
|
505
636
|
#### Parameters
|
|
506
637
|
|
|
@@ -512,6 +643,10 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:32](
|
|
|
512
643
|
|
|
513
644
|
`void`
|
|
514
645
|
|
|
646
|
+
#### Inherited from
|
|
647
|
+
|
|
648
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assignMethods`](RpcMethodsClientTool.md#assignmethods)
|
|
649
|
+
|
|
515
650
|
***
|
|
516
651
|
|
|
517
652
|
### assignProperty()
|
|
@@ -556,6 +691,10 @@ the attributes object
|
|
|
556
691
|
|
|
557
692
|
`void`
|
|
558
693
|
|
|
694
|
+
#### Inherited from
|
|
695
|
+
|
|
696
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assignProperty`](RpcMethodsClientTool.md#assignproperty)
|
|
697
|
+
|
|
559
698
|
***
|
|
560
699
|
|
|
561
700
|
### assignPropertyTo()
|
|
@@ -606,6 +745,10 @@ The attributes object of the property
|
|
|
606
745
|
|
|
607
746
|
`void`
|
|
608
747
|
|
|
748
|
+
#### Inherited from
|
|
749
|
+
|
|
750
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assignPropertyTo`](RpcMethodsClientTool.md#assignpropertyto)
|
|
751
|
+
|
|
609
752
|
***
|
|
610
753
|
|
|
611
754
|
### assignTo()
|
|
@@ -634,6 +777,10 @@ the destination object
|
|
|
634
777
|
|
|
635
778
|
the dest object
|
|
636
779
|
|
|
780
|
+
#### Inherited from
|
|
781
|
+
|
|
782
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assignTo`](RpcMethodsClientTool.md#assignto)
|
|
783
|
+
|
|
637
784
|
***
|
|
638
785
|
|
|
639
786
|
### clone()
|
|
@@ -656,6 +803,10 @@ Create a new object with the same values of attributes.
|
|
|
656
803
|
|
|
657
804
|
the new object
|
|
658
805
|
|
|
806
|
+
#### Inherited from
|
|
807
|
+
|
|
808
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`clone`](RpcMethodsClientTool.md#clone)
|
|
809
|
+
|
|
659
810
|
***
|
|
660
811
|
|
|
661
812
|
### cloneTo()
|
|
@@ -684,6 +835,10 @@ the destination object
|
|
|
684
835
|
|
|
685
836
|
the new dest object
|
|
686
837
|
|
|
838
|
+
#### Inherited from
|
|
839
|
+
|
|
840
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`cloneTo`](RpcMethodsClientTool.md#cloneto)
|
|
841
|
+
|
|
687
842
|
***
|
|
688
843
|
|
|
689
844
|
### defineProperties()
|
|
@@ -706,13 +861,17 @@ the defined attributes of the object
|
|
|
706
861
|
|
|
707
862
|
`any`
|
|
708
863
|
|
|
864
|
+
#### Inherited from
|
|
865
|
+
|
|
866
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`defineProperties`](RpcMethodsClientTool.md#defineproperties)
|
|
867
|
+
|
|
709
868
|
***
|
|
710
869
|
|
|
711
870
|
### delete()?
|
|
712
871
|
|
|
713
872
|
> `optional` **delete**(`__namedParameters`): `any`
|
|
714
873
|
|
|
715
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
874
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L13)
|
|
716
875
|
|
|
717
876
|
#### Parameters
|
|
718
877
|
|
|
@@ -752,13 +911,17 @@ the destination object
|
|
|
752
911
|
|
|
753
912
|
the dest object.
|
|
754
913
|
|
|
914
|
+
#### Inherited from
|
|
915
|
+
|
|
916
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`exportTo`](RpcMethodsClientTool.md#exportto)
|
|
917
|
+
|
|
755
918
|
***
|
|
756
919
|
|
|
757
920
|
### fetch()
|
|
758
921
|
|
|
759
922
|
> **fetch**(`options`, `action`): `Promise`\<`any`\>
|
|
760
923
|
|
|
761
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isdk/ai-tool.js/blob/
|
|
924
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L18)
|
|
762
925
|
|
|
763
926
|
#### Parameters
|
|
764
927
|
|
|
@@ -774,13 +937,17 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:18](https:/
|
|
|
774
937
|
|
|
775
938
|
`Promise`\<`any`\>
|
|
776
939
|
|
|
940
|
+
#### Inherited from
|
|
941
|
+
|
|
942
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`fetch`](RpcMethodsClientTool.md#fetch)
|
|
943
|
+
|
|
777
944
|
***
|
|
778
945
|
|
|
779
946
|
### func()
|
|
780
947
|
|
|
781
948
|
> **func**(`options`): `Promise`\<`any`\>
|
|
782
949
|
|
|
783
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
950
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:24](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/rpc-methods-client-tool.ts#L24)
|
|
784
951
|
|
|
785
952
|
The core implementation for a client-side tool. When a `ClientTools` instance
|
|
786
953
|
is "run", this `func` method is executed. It delegates the call to the
|
|
@@ -790,7 +957,7 @@ configured transport, which handles the network communication.
|
|
|
790
957
|
|
|
791
958
|
##### options
|
|
792
959
|
|
|
793
|
-
`RpcMethodsClientFuncParams`
|
|
960
|
+
[`RpcMethodsClientFuncParams`](../interfaces/RpcMethodsClientFuncParams.md)
|
|
794
961
|
|
|
795
962
|
#### Returns
|
|
796
963
|
|
|
@@ -798,13 +965,17 @@ configured transport, which handles the network communication.
|
|
|
798
965
|
|
|
799
966
|
The result from the remote tool.
|
|
800
967
|
|
|
968
|
+
#### Inherited from
|
|
969
|
+
|
|
970
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`func`](RpcMethodsClientTool.md#func)
|
|
971
|
+
|
|
801
972
|
***
|
|
802
973
|
|
|
803
974
|
### get()?
|
|
804
975
|
|
|
805
976
|
> `optional` **get**(`__namedParameters`): `any`
|
|
806
977
|
|
|
807
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
978
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L10)
|
|
808
979
|
|
|
809
980
|
#### Parameters
|
|
810
981
|
|
|
@@ -822,7 +993,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:10](https:/
|
|
|
822
993
|
|
|
823
994
|
> **getFunc**(`name`?): `any`
|
|
824
995
|
|
|
825
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/
|
|
996
|
+
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)
|
|
826
997
|
|
|
827
998
|
Gets a bound function reference for execution with named parameters.
|
|
828
999
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -842,13 +1013,17 @@ Optional name of the function to retrieve.
|
|
|
842
1013
|
|
|
843
1014
|
A function reference or `undefined` if not found.
|
|
844
1015
|
|
|
1016
|
+
#### Inherited from
|
|
1017
|
+
|
|
1018
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getFunc`](RpcMethodsClientTool.md#getfunc)
|
|
1019
|
+
|
|
845
1020
|
***
|
|
846
1021
|
|
|
847
1022
|
### getFuncWithPos()
|
|
848
1023
|
|
|
849
1024
|
> **getFuncWithPos**(`name`?): `any`
|
|
850
1025
|
|
|
851
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/
|
|
1026
|
+
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)
|
|
852
1027
|
|
|
853
1028
|
Gets a bound function reference suitable for positional argument execution.
|
|
854
1029
|
If a name is provided, it retrieves a different function from the registry.
|
|
@@ -868,6 +1043,10 @@ Optional name of the function to retrieve.
|
|
|
868
1043
|
|
|
869
1044
|
A function reference or `undefined` if not found.
|
|
870
1045
|
|
|
1046
|
+
#### Inherited from
|
|
1047
|
+
|
|
1048
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getFuncWithPos`](RpcMethodsClientTool.md#getfuncwithpos)
|
|
1049
|
+
|
|
871
1050
|
***
|
|
872
1051
|
|
|
873
1052
|
### getProperties()
|
|
@@ -884,13 +1063,17 @@ Get the defined attributes.
|
|
|
884
1063
|
|
|
885
1064
|
the descriptors of properties object
|
|
886
1065
|
|
|
1066
|
+
#### Inherited from
|
|
1067
|
+
|
|
1068
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getProperties`](RpcMethodsClientTool.md#getproperties)
|
|
1069
|
+
|
|
887
1070
|
***
|
|
888
1071
|
|
|
889
1072
|
### hasAsyncFeature()
|
|
890
1073
|
|
|
891
1074
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
892
1075
|
|
|
893
|
-
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/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/tool-func.ts#L787)
|
|
894
1077
|
|
|
895
1078
|
Checks if the current function instance supports a specific async feature.
|
|
896
1079
|
|
|
@@ -908,6 +1091,10 @@ The async feature bit to check for.
|
|
|
908
1091
|
|
|
909
1092
|
`true` if the feature is supported, otherwise `false`.
|
|
910
1093
|
|
|
1094
|
+
#### Inherited from
|
|
1095
|
+
|
|
1096
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`hasAsyncFeature`](RpcMethodsClientTool.md#hasasyncfeature)
|
|
1097
|
+
|
|
911
1098
|
***
|
|
912
1099
|
|
|
913
1100
|
### hasOwnProperty()
|
|
@@ -930,6 +1117,10 @@ A property name.
|
|
|
930
1117
|
|
|
931
1118
|
`boolean`
|
|
932
1119
|
|
|
1120
|
+
#### Inherited from
|
|
1121
|
+
|
|
1122
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`hasOwnProperty`](RpcMethodsClientTool.md#hasownproperty)
|
|
1123
|
+
|
|
933
1124
|
***
|
|
934
1125
|
|
|
935
1126
|
### initialize()
|
|
@@ -952,6 +1143,10 @@ Initialize object and assign attribute values from src if src exists.
|
|
|
952
1143
|
|
|
953
1144
|
this object.
|
|
954
1145
|
|
|
1146
|
+
#### Inherited from
|
|
1147
|
+
|
|
1148
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`initialize`](RpcMethodsClientTool.md#initialize)
|
|
1149
|
+
|
|
955
1150
|
***
|
|
956
1151
|
|
|
957
1152
|
### isPrototypeOf()
|
|
@@ -974,6 +1169,10 @@ Another object whose prototype chain is to be checked.
|
|
|
974
1169
|
|
|
975
1170
|
`boolean`
|
|
976
1171
|
|
|
1172
|
+
#### Inherited from
|
|
1173
|
+
|
|
1174
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isPrototypeOf`](RpcMethodsClientTool.md#isprototypeof)
|
|
1175
|
+
|
|
977
1176
|
***
|
|
978
1177
|
|
|
979
1178
|
### isSame()
|
|
@@ -1000,13 +1199,17 @@ The source object
|
|
|
1000
1199
|
|
|
1001
1200
|
`boolean`
|
|
1002
1201
|
|
|
1202
|
+
#### Inherited from
|
|
1203
|
+
|
|
1204
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isSame`](RpcMethodsClientTool.md#issame)
|
|
1205
|
+
|
|
1003
1206
|
***
|
|
1004
1207
|
|
|
1005
1208
|
### isStream()
|
|
1006
1209
|
|
|
1007
1210
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
1008
1211
|
|
|
1009
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/
|
|
1212
|
+
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)
|
|
1010
1213
|
|
|
1011
1214
|
Determines if a function call should produce a stream.
|
|
1012
1215
|
|
|
@@ -1030,13 +1233,17 @@ The runtime parameters passed to the function call.
|
|
|
1030
1233
|
|
|
1031
1234
|
`true` if the call should be streamed, `false` or `undefined` otherwise.
|
|
1032
1235
|
|
|
1236
|
+
#### Inherited from
|
|
1237
|
+
|
|
1238
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isStream`](RpcMethodsClientTool.md#isstream)
|
|
1239
|
+
|
|
1033
1240
|
***
|
|
1034
1241
|
|
|
1035
1242
|
### list()?
|
|
1036
1243
|
|
|
1037
1244
|
> `optional` **list**(`options`?): `any`
|
|
1038
1245
|
|
|
1039
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
1246
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L14)
|
|
1040
1247
|
|
|
1041
1248
|
#### Parameters
|
|
1042
1249
|
|
|
@@ -1076,13 +1283,17 @@ The destination object
|
|
|
1076
1283
|
|
|
1077
1284
|
the dest object.
|
|
1078
1285
|
|
|
1286
|
+
#### Inherited from
|
|
1287
|
+
|
|
1288
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`mergeTo`](RpcMethodsClientTool.md#mergeto)
|
|
1289
|
+
|
|
1079
1290
|
***
|
|
1080
1291
|
|
|
1081
1292
|
### obj2ArrParams()
|
|
1082
1293
|
|
|
1083
1294
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
1084
1295
|
|
|
1085
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/
|
|
1296
|
+
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)
|
|
1086
1297
|
|
|
1087
1298
|
Converts a named parameters object into an array of positional arguments.
|
|
1088
1299
|
This is used for functions defined with positional parameters.
|
|
@@ -1101,13 +1312,17 @@ A named parameters object.
|
|
|
1101
1312
|
|
|
1102
1313
|
An array of positional arguments.
|
|
1103
1314
|
|
|
1315
|
+
#### Inherited from
|
|
1316
|
+
|
|
1317
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`obj2ArrParams`](RpcMethodsClientTool.md#obj2arrparams)
|
|
1318
|
+
|
|
1104
1319
|
***
|
|
1105
1320
|
|
|
1106
1321
|
### post()?
|
|
1107
1322
|
|
|
1108
1323
|
> `optional` **post**(`options`): `any`
|
|
1109
1324
|
|
|
1110
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
1325
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L11)
|
|
1111
1326
|
|
|
1112
1327
|
#### Parameters
|
|
1113
1328
|
|
|
@@ -1141,13 +1356,17 @@ A property name.
|
|
|
1141
1356
|
|
|
1142
1357
|
`boolean`
|
|
1143
1358
|
|
|
1359
|
+
#### Inherited from
|
|
1360
|
+
|
|
1361
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`propertyIsEnumerable`](RpcMethodsClientTool.md#propertyisenumerable)
|
|
1362
|
+
|
|
1144
1363
|
***
|
|
1145
1364
|
|
|
1146
1365
|
### put()?
|
|
1147
1366
|
|
|
1148
1367
|
> `optional` **put**(`__namedParameters`): `any`
|
|
1149
1368
|
|
|
1150
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
1369
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/res-client-tools.ts#L12)
|
|
1151
1370
|
|
|
1152
1371
|
#### Parameters
|
|
1153
1372
|
|
|
@@ -1165,7 +1384,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:12](https:/
|
|
|
1165
1384
|
|
|
1166
1385
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
1167
1386
|
|
|
1168
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/
|
|
1387
|
+
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
1388
|
|
|
1170
1389
|
Registers the current `ToolFunc` instance into the static registry.
|
|
1171
1390
|
Also registers any declared dependencies.
|
|
@@ -1176,13 +1395,17 @@ Also registers any declared dependencies.
|
|
|
1176
1395
|
|
|
1177
1396
|
The instance itself upon successful registration, or `false` if it already exists.
|
|
1178
1397
|
|
|
1398
|
+
#### Inherited from
|
|
1399
|
+
|
|
1400
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`register`](RpcMethodsClientTool.md#register)
|
|
1401
|
+
|
|
1179
1402
|
***
|
|
1180
1403
|
|
|
1181
1404
|
### run()
|
|
1182
1405
|
|
|
1183
1406
|
> **run**(`params`?): `Promise`\<`any`\>
|
|
1184
1407
|
|
|
1185
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:686](https://github.com/isdk/ai-tool.js/blob/
|
|
1408
|
+
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)
|
|
1186
1409
|
|
|
1187
1410
|
Executes the function asynchronously with a named parameters object.
|
|
1188
1411
|
|
|
@@ -1200,13 +1423,17 @@ The parameters object for the function.
|
|
|
1200
1423
|
|
|
1201
1424
|
A promise that resolves with the function's result.
|
|
1202
1425
|
|
|
1426
|
+
#### Inherited from
|
|
1427
|
+
|
|
1428
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`run`](RpcMethodsClientTool.md#run)
|
|
1429
|
+
|
|
1203
1430
|
***
|
|
1204
1431
|
|
|
1205
1432
|
### runAs()
|
|
1206
1433
|
|
|
1207
1434
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
1208
1435
|
|
|
1209
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/
|
|
1436
|
+
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)
|
|
1210
1437
|
|
|
1211
1438
|
Asynchronously executes another registered function by name.
|
|
1212
1439
|
This method delegates to `runAsSync()` internally.
|
|
@@ -1231,13 +1458,17 @@ Optional parameters to pass to the function.
|
|
|
1231
1458
|
|
|
1232
1459
|
A promise that resolves with the result of the function execution.
|
|
1233
1460
|
|
|
1461
|
+
#### Inherited from
|
|
1462
|
+
|
|
1463
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runAs`](RpcMethodsClientTool.md#runas)
|
|
1464
|
+
|
|
1234
1465
|
***
|
|
1235
1466
|
|
|
1236
1467
|
### runAsSync()
|
|
1237
1468
|
|
|
1238
1469
|
> **runAsSync**(`name`, `params`?): `any`
|
|
1239
1470
|
|
|
1240
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/
|
|
1471
|
+
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)
|
|
1241
1472
|
|
|
1242
1473
|
Synchronously executes another registered function by name.
|
|
1243
1474
|
This is a convenience method that forwards the call to the static `runSync()` method.
|
|
@@ -1262,13 +1493,17 @@ Optional parameters to pass to the function.
|
|
|
1262
1493
|
|
|
1263
1494
|
The result of the function execution.
|
|
1264
1495
|
|
|
1496
|
+
#### Inherited from
|
|
1497
|
+
|
|
1498
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runAsSync`](RpcMethodsClientTool.md#runassync)
|
|
1499
|
+
|
|
1265
1500
|
***
|
|
1266
1501
|
|
|
1267
1502
|
### runSync()
|
|
1268
1503
|
|
|
1269
1504
|
> **runSync**(`params`?): `any`
|
|
1270
1505
|
|
|
1271
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/
|
|
1506
|
+
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)
|
|
1272
1507
|
|
|
1273
1508
|
Executes the function synchronously with a named parameters object.
|
|
1274
1509
|
|
|
@@ -1290,13 +1525,17 @@ The result of the function execution.
|
|
|
1290
1525
|
|
|
1291
1526
|
Will throw an error if an array of parameters is passed to a function that expects an object.
|
|
1292
1527
|
|
|
1528
|
+
#### Inherited from
|
|
1529
|
+
|
|
1530
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runSync`](RpcMethodsClientTool.md#runsync)
|
|
1531
|
+
|
|
1293
1532
|
***
|
|
1294
1533
|
|
|
1295
1534
|
### runWithPos()
|
|
1296
1535
|
|
|
1297
1536
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1298
1537
|
|
|
1299
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/
|
|
1538
|
+
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)
|
|
1300
1539
|
|
|
1301
1540
|
Executes the function asynchronously using positional arguments.
|
|
1302
1541
|
Delegates to `runWithPosSync()` internally.
|
|
@@ -1315,13 +1554,17 @@ Positional arguments passed to the function.
|
|
|
1315
1554
|
|
|
1316
1555
|
A promise that resolves with the result of the function execution.
|
|
1317
1556
|
|
|
1557
|
+
#### Inherited from
|
|
1558
|
+
|
|
1559
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPos`](RpcMethodsClientTool.md#runwithpos)
|
|
1560
|
+
|
|
1318
1561
|
***
|
|
1319
1562
|
|
|
1320
1563
|
### runWithPosAs()
|
|
1321
1564
|
|
|
1322
1565
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1323
1566
|
|
|
1324
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/
|
|
1567
|
+
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)
|
|
1325
1568
|
|
|
1326
1569
|
Asynchronously executes another function by name using positional arguments.
|
|
1327
1570
|
Delegates to `runWithPosAsSync()` internally.
|
|
@@ -1346,13 +1589,17 @@ Positional arguments to pass to the function.
|
|
|
1346
1589
|
|
|
1347
1590
|
A promise that resolves with the result of the function execution.
|
|
1348
1591
|
|
|
1592
|
+
#### Inherited from
|
|
1593
|
+
|
|
1594
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPosAs`](RpcMethodsClientTool.md#runwithposas)
|
|
1595
|
+
|
|
1349
1596
|
***
|
|
1350
1597
|
|
|
1351
1598
|
### runWithPosAsSync()
|
|
1352
1599
|
|
|
1353
1600
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1354
1601
|
|
|
1355
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/
|
|
1602
|
+
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)
|
|
1356
1603
|
|
|
1357
1604
|
Synchronously executes another function by name using positional arguments.
|
|
1358
1605
|
This is a convenience wrapper around the static `runWithPosSync()` method.
|
|
@@ -1377,13 +1624,17 @@ Positional arguments to pass to the function.
|
|
|
1377
1624
|
|
|
1378
1625
|
The result of the function execution.
|
|
1379
1626
|
|
|
1627
|
+
#### Inherited from
|
|
1628
|
+
|
|
1629
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPosAsSync`](RpcMethodsClientTool.md#runwithposassync)
|
|
1630
|
+
|
|
1380
1631
|
***
|
|
1381
1632
|
|
|
1382
1633
|
### runWithPosSync()
|
|
1383
1634
|
|
|
1384
1635
|
> **runWithPosSync**(...`params`): `any`
|
|
1385
1636
|
|
|
1386
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/
|
|
1637
|
+
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)
|
|
1387
1638
|
|
|
1388
1639
|
Executes the function synchronously using positional arguments.
|
|
1389
1640
|
If the function expects named parameters, it converts the arguments automatically.
|
|
@@ -1402,6 +1653,10 @@ Positional arguments passed to the function.
|
|
|
1402
1653
|
|
|
1403
1654
|
The result of the function execution.
|
|
1404
1655
|
|
|
1656
|
+
#### Inherited from
|
|
1657
|
+
|
|
1658
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPosSync`](RpcMethodsClientTool.md#runwithpossync)
|
|
1659
|
+
|
|
1405
1660
|
***
|
|
1406
1661
|
|
|
1407
1662
|
### toJSON()
|
|
@@ -1414,6 +1669,10 @@ Defined in: [property-manager.js/src/abstract.d.ts:182](https://github.com/snowy
|
|
|
1414
1669
|
|
|
1415
1670
|
`any`
|
|
1416
1671
|
|
|
1672
|
+
#### Inherited from
|
|
1673
|
+
|
|
1674
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`toJSON`](RpcMethodsClientTool.md#tojson)
|
|
1675
|
+
|
|
1417
1676
|
***
|
|
1418
1677
|
|
|
1419
1678
|
### toLocaleString()
|
|
@@ -1428,6 +1687,10 @@ Returns a date converted to a string using the current locale.
|
|
|
1428
1687
|
|
|
1429
1688
|
`string`
|
|
1430
1689
|
|
|
1690
|
+
#### Inherited from
|
|
1691
|
+
|
|
1692
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`toLocaleString`](RpcMethodsClientTool.md#tolocalestring)
|
|
1693
|
+
|
|
1431
1694
|
***
|
|
1432
1695
|
|
|
1433
1696
|
### toObject()
|
|
@@ -1450,6 +1713,10 @@ Convert the attributes to the json object
|
|
|
1450
1713
|
|
|
1451
1714
|
the json object.
|
|
1452
1715
|
|
|
1716
|
+
#### Inherited from
|
|
1717
|
+
|
|
1718
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`toObject`](RpcMethodsClientTool.md#toobject)
|
|
1719
|
+
|
|
1453
1720
|
***
|
|
1454
1721
|
|
|
1455
1722
|
### toString()
|
|
@@ -1464,13 +1731,17 @@ Returns a string representation of an object.
|
|
|
1464
1731
|
|
|
1465
1732
|
`string`
|
|
1466
1733
|
|
|
1734
|
+
#### Inherited from
|
|
1735
|
+
|
|
1736
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`toString`](RpcMethodsClientTool.md#tostring)
|
|
1737
|
+
|
|
1467
1738
|
***
|
|
1468
1739
|
|
|
1469
1740
|
### unregister()
|
|
1470
1741
|
|
|
1471
1742
|
> **unregister**(): `any`
|
|
1472
1743
|
|
|
1473
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/
|
|
1744
|
+
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)
|
|
1474
1745
|
|
|
1475
1746
|
Removes the current `ToolFunc` instance from the static registry.
|
|
1476
1747
|
|
|
@@ -1480,6 +1751,10 @@ Removes the current `ToolFunc` instance from the static registry.
|
|
|
1480
1751
|
|
|
1481
1752
|
The instance that was unregistered.
|
|
1482
1753
|
|
|
1754
|
+
#### Inherited from
|
|
1755
|
+
|
|
1756
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`unregister`](RpcMethodsClientTool.md#unregister)
|
|
1757
|
+
|
|
1483
1758
|
***
|
|
1484
1759
|
|
|
1485
1760
|
### valueOf()
|
|
@@ -1494,6 +1769,10 @@ Returns the primitive value of the specified object.
|
|
|
1494
1769
|
|
|
1495
1770
|
`Object`
|
|
1496
1771
|
|
|
1772
|
+
#### Inherited from
|
|
1773
|
+
|
|
1774
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`valueOf`](RpcMethodsClientTool.md#valueof)
|
|
1775
|
+
|
|
1497
1776
|
***
|
|
1498
1777
|
|
|
1499
1778
|
### assign()
|
|
@@ -1531,6 +1810,10 @@ The source object from which to copy properties.
|
|
|
1531
1810
|
|
|
1532
1811
|
`T` & `U`
|
|
1533
1812
|
|
|
1813
|
+
##### Inherited from
|
|
1814
|
+
|
|
1815
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assign`](RpcMethodsClientTool.md#assign-2)
|
|
1816
|
+
|
|
1534
1817
|
#### Call Signature
|
|
1535
1818
|
|
|
1536
1819
|
> `static` **assign**\<`T`, `U`, `V`\>(`target`, `source1`, `source2`): `T` & `U` & `V`
|
|
@@ -1572,6 +1855,10 @@ The second source object from which to copy properties.
|
|
|
1572
1855
|
|
|
1573
1856
|
`T` & `U` & `V`
|
|
1574
1857
|
|
|
1858
|
+
##### Inherited from
|
|
1859
|
+
|
|
1860
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assign`](RpcMethodsClientTool.md#assign-2)
|
|
1861
|
+
|
|
1575
1862
|
#### Call Signature
|
|
1576
1863
|
|
|
1577
1864
|
> `static` **assign**\<`T`, `U`, `V`, `W`\>(`target`, `source1`, `source2`, `source3`): `T` & `U` & `V` & `W`
|
|
@@ -1621,6 +1908,10 @@ The third source object from which to copy properties.
|
|
|
1621
1908
|
|
|
1622
1909
|
`T` & `U` & `V` & `W`
|
|
1623
1910
|
|
|
1911
|
+
##### Inherited from
|
|
1912
|
+
|
|
1913
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assign`](RpcMethodsClientTool.md#assign-2)
|
|
1914
|
+
|
|
1624
1915
|
#### Call Signature
|
|
1625
1916
|
|
|
1626
1917
|
> `static` **assign**(`target`, ...`sources`): `any`
|
|
@@ -1648,6 +1939,10 @@ One or more source objects from which to copy properties
|
|
|
1648
1939
|
|
|
1649
1940
|
`any`
|
|
1650
1941
|
|
|
1942
|
+
##### Inherited from
|
|
1943
|
+
|
|
1944
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`assign`](RpcMethodsClientTool.md#assign-2)
|
|
1945
|
+
|
|
1651
1946
|
***
|
|
1652
1947
|
|
|
1653
1948
|
### create()
|
|
@@ -1672,6 +1967,10 @@ Object to use as a prototype. May be null.
|
|
|
1672
1967
|
|
|
1673
1968
|
`any`
|
|
1674
1969
|
|
|
1970
|
+
##### Inherited from
|
|
1971
|
+
|
|
1972
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`create`](RpcMethodsClientTool.md#create)
|
|
1973
|
+
|
|
1675
1974
|
#### Call Signature
|
|
1676
1975
|
|
|
1677
1976
|
> `static` **create**(`o`, `properties`): `any`
|
|
@@ -1698,6 +1997,10 @@ JavaScript object that contains one or more property descriptors.
|
|
|
1698
1997
|
|
|
1699
1998
|
`any`
|
|
1700
1999
|
|
|
2000
|
+
##### Inherited from
|
|
2001
|
+
|
|
2002
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`create`](RpcMethodsClientTool.md#create)
|
|
2003
|
+
|
|
1701
2004
|
***
|
|
1702
2005
|
|
|
1703
2006
|
### defineProperties()
|
|
@@ -1726,6 +2029,10 @@ Adds one or more properties to an object, and/or modifies attributes of existing
|
|
|
1726
2029
|
|
|
1727
2030
|
`any`
|
|
1728
2031
|
|
|
2032
|
+
#### Inherited from
|
|
2033
|
+
|
|
2034
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`defineProperties`](RpcMethodsClientTool.md#defineproperties-2)
|
|
2035
|
+
|
|
1729
2036
|
***
|
|
1730
2037
|
|
|
1731
2038
|
### defineProperty()
|
|
@@ -1764,6 +2071,10 @@ Descriptor for the property. It can be for a data property or an accessor proper
|
|
|
1764
2071
|
|
|
1765
2072
|
`T`
|
|
1766
2073
|
|
|
2074
|
+
#### Inherited from
|
|
2075
|
+
|
|
2076
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`defineProperty`](RpcMethodsClientTool.md#defineproperty)
|
|
2077
|
+
|
|
1767
2078
|
***
|
|
1768
2079
|
|
|
1769
2080
|
### entries()
|
|
@@ -1792,6 +2103,10 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
1792
2103
|
|
|
1793
2104
|
\[`string`, `T`\][]
|
|
1794
2105
|
|
|
2106
|
+
##### Inherited from
|
|
2107
|
+
|
|
2108
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`entries`](RpcMethodsClientTool.md#entries)
|
|
2109
|
+
|
|
1795
2110
|
#### Call Signature
|
|
1796
2111
|
|
|
1797
2112
|
> `static` **entries**(`o`): \[`string`, `any`\][]
|
|
@@ -1810,13 +2125,17 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
1810
2125
|
|
|
1811
2126
|
\[`string`, `any`\][]
|
|
1812
2127
|
|
|
2128
|
+
##### Inherited from
|
|
2129
|
+
|
|
2130
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`entries`](RpcMethodsClientTool.md#entries)
|
|
2131
|
+
|
|
1813
2132
|
***
|
|
1814
2133
|
|
|
1815
2134
|
### fetch()
|
|
1816
2135
|
|
|
1817
2136
|
> `static` **fetch**(`name`, `objParam`?, ...`args`?): `Promise`\<`any`\>
|
|
1818
2137
|
|
|
1819
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/
|
|
2138
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L98)
|
|
1820
2139
|
|
|
1821
2140
|
#### Parameters
|
|
1822
2141
|
|
|
@@ -1836,6 +2155,10 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:98](https://git
|
|
|
1836
2155
|
|
|
1837
2156
|
`Promise`\<`any`\>
|
|
1838
2157
|
|
|
2158
|
+
#### Inherited from
|
|
2159
|
+
|
|
2160
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`fetch`](RpcMethodsClientTool.md#fetch-2)
|
|
2161
|
+
|
|
1839
2162
|
***
|
|
1840
2163
|
|
|
1841
2164
|
### freeze()
|
|
@@ -1864,6 +2187,10 @@ Object on which to lock the attributes.
|
|
|
1864
2187
|
|
|
1865
2188
|
`T`
|
|
1866
2189
|
|
|
2190
|
+
##### Inherited from
|
|
2191
|
+
|
|
2192
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`freeze`](RpcMethodsClientTool.md#freeze)
|
|
2193
|
+
|
|
1867
2194
|
#### Call Signature
|
|
1868
2195
|
|
|
1869
2196
|
> `static` **freeze**\<`T`, `U`\>(`o`): `Readonly`\<`T`\>
|
|
@@ -1890,6 +2217,10 @@ Object on which to lock the attributes.
|
|
|
1890
2217
|
|
|
1891
2218
|
`Readonly`\<`T`\>
|
|
1892
2219
|
|
|
2220
|
+
##### Inherited from
|
|
2221
|
+
|
|
2222
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`freeze`](RpcMethodsClientTool.md#freeze)
|
|
2223
|
+
|
|
1893
2224
|
#### Call Signature
|
|
1894
2225
|
|
|
1895
2226
|
> `static` **freeze**\<`T`\>(`o`): `Readonly`\<`T`\>
|
|
@@ -1914,6 +2245,10 @@ Object on which to lock the attributes.
|
|
|
1914
2245
|
|
|
1915
2246
|
`Readonly`\<`T`\>
|
|
1916
2247
|
|
|
2248
|
+
##### Inherited from
|
|
2249
|
+
|
|
2250
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`freeze`](RpcMethodsClientTool.md#freeze)
|
|
2251
|
+
|
|
1917
2252
|
***
|
|
1918
2253
|
|
|
1919
2254
|
### fromEntries()
|
|
@@ -1942,6 +2277,10 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
1942
2277
|
|
|
1943
2278
|
`object`
|
|
1944
2279
|
|
|
2280
|
+
##### Inherited from
|
|
2281
|
+
|
|
2282
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`fromEntries`](RpcMethodsClientTool.md#fromentries)
|
|
2283
|
+
|
|
1945
2284
|
#### Call Signature
|
|
1946
2285
|
|
|
1947
2286
|
> `static` **fromEntries**(`entries`): `any`
|
|
@@ -1962,13 +2301,17 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
1962
2301
|
|
|
1963
2302
|
`any`
|
|
1964
2303
|
|
|
2304
|
+
##### Inherited from
|
|
2305
|
+
|
|
2306
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`fromEntries`](RpcMethodsClientTool.md#fromentries)
|
|
2307
|
+
|
|
1965
2308
|
***
|
|
1966
2309
|
|
|
1967
2310
|
### get()
|
|
1968
2311
|
|
|
1969
2312
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
1970
2313
|
|
|
1971
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/
|
|
2314
|
+
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)
|
|
1972
2315
|
|
|
1973
2316
|
Retrieves a registered function by its name or alias.
|
|
1974
2317
|
|
|
@@ -1986,13 +2329,17 @@ The name or alias of the function to retrieve.
|
|
|
1986
2329
|
|
|
1987
2330
|
The `ToolFunc` instance if found, otherwise `undefined`.
|
|
1988
2331
|
|
|
2332
|
+
#### Inherited from
|
|
2333
|
+
|
|
2334
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`get`](RpcMethodsClientTool.md#get)
|
|
2335
|
+
|
|
1989
2336
|
***
|
|
1990
2337
|
|
|
1991
2338
|
### getAllByTag()
|
|
1992
2339
|
|
|
1993
2340
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
1994
2341
|
|
|
1995
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/
|
|
2342
|
+
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)
|
|
1996
2343
|
|
|
1997
2344
|
Retrieves all registered functions that have a specific tag.
|
|
1998
2345
|
|
|
@@ -2010,13 +2357,17 @@ The tag to search for.
|
|
|
2010
2357
|
|
|
2011
2358
|
An array of matching `ToolFunc` instances.
|
|
2012
2359
|
|
|
2360
|
+
#### Inherited from
|
|
2361
|
+
|
|
2362
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getAllByTag`](RpcMethodsClientTool.md#getallbytag)
|
|
2363
|
+
|
|
2013
2364
|
***
|
|
2014
2365
|
|
|
2015
2366
|
### getByTag()
|
|
2016
2367
|
|
|
2017
2368
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2018
2369
|
|
|
2019
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/
|
|
2370
|
+
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)
|
|
2020
2371
|
|
|
2021
2372
|
Finds the first registered function that has a specific tag.
|
|
2022
2373
|
|
|
@@ -2034,13 +2385,17 @@ The tag to search for.
|
|
|
2034
2385
|
|
|
2035
2386
|
The first matching `ToolFunc` instance, or `undefined` if none is found.
|
|
2036
2387
|
|
|
2388
|
+
#### Inherited from
|
|
2389
|
+
|
|
2390
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getByTag`](RpcMethodsClientTool.md#getbytag)
|
|
2391
|
+
|
|
2037
2392
|
***
|
|
2038
2393
|
|
|
2039
2394
|
### getFunc()
|
|
2040
2395
|
|
|
2041
2396
|
> `static` **getFunc**(`name`): `any`
|
|
2042
2397
|
|
|
2043
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/
|
|
2398
|
+
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)
|
|
2044
2399
|
|
|
2045
2400
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2046
2401
|
This reference is suitable for execution with an object of named parameters.
|
|
@@ -2059,13 +2414,17 @@ The name of the function.
|
|
|
2059
2414
|
|
|
2060
2415
|
A bound function reference, or `undefined` if not found.
|
|
2061
2416
|
|
|
2417
|
+
#### Inherited from
|
|
2418
|
+
|
|
2419
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getFunc`](RpcMethodsClientTool.md#getfunc-2)
|
|
2420
|
+
|
|
2062
2421
|
***
|
|
2063
2422
|
|
|
2064
2423
|
### getFuncWithPos()
|
|
2065
2424
|
|
|
2066
2425
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
2067
2426
|
|
|
2068
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/
|
|
2427
|
+
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)
|
|
2069
2428
|
|
|
2070
2429
|
Retrieves a bound, runnable function reference for a registered function.
|
|
2071
2430
|
This reference is suitable for execution with positional arguments.
|
|
@@ -2084,6 +2443,10 @@ The name of the function.
|
|
|
2084
2443
|
|
|
2085
2444
|
A bound function reference, or `undefined` if not found.
|
|
2086
2445
|
|
|
2446
|
+
#### Inherited from
|
|
2447
|
+
|
|
2448
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getFuncWithPos`](RpcMethodsClientTool.md#getfuncwithpos-2)
|
|
2449
|
+
|
|
2087
2450
|
***
|
|
2088
2451
|
|
|
2089
2452
|
### getOwnPropertyDescriptor()
|
|
@@ -2113,6 +2476,10 @@ Name of the property.
|
|
|
2113
2476
|
|
|
2114
2477
|
`undefined` \| `PropertyDescriptor`
|
|
2115
2478
|
|
|
2479
|
+
#### Inherited from
|
|
2480
|
+
|
|
2481
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getOwnPropertyDescriptor`](RpcMethodsClientTool.md#getownpropertydescriptor)
|
|
2482
|
+
|
|
2116
2483
|
***
|
|
2117
2484
|
|
|
2118
2485
|
### getOwnPropertyDescriptors()
|
|
@@ -2139,6 +2506,10 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2139
2506
|
|
|
2140
2507
|
\{ \[P in string \| number \| symbol\]: TypedPropertyDescriptor\<T\[P\]\> \} & `object`
|
|
2141
2508
|
|
|
2509
|
+
#### Inherited from
|
|
2510
|
+
|
|
2511
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getOwnPropertyDescriptors`](RpcMethodsClientTool.md#getownpropertydescriptors)
|
|
2512
|
+
|
|
2142
2513
|
***
|
|
2143
2514
|
|
|
2144
2515
|
### getOwnPropertyNames()
|
|
@@ -2162,6 +2533,10 @@ Object that contains the own properties.
|
|
|
2162
2533
|
|
|
2163
2534
|
`string`[]
|
|
2164
2535
|
|
|
2536
|
+
#### Inherited from
|
|
2537
|
+
|
|
2538
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getOwnPropertyNames`](RpcMethodsClientTool.md#getownpropertynames)
|
|
2539
|
+
|
|
2165
2540
|
***
|
|
2166
2541
|
|
|
2167
2542
|
### getOwnPropertySymbols()
|
|
@@ -2184,6 +2559,10 @@ Object to retrieve the symbols from.
|
|
|
2184
2559
|
|
|
2185
2560
|
`symbol`[]
|
|
2186
2561
|
|
|
2562
|
+
#### Inherited from
|
|
2563
|
+
|
|
2564
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getOwnPropertySymbols`](RpcMethodsClientTool.md#getownpropertysymbols)
|
|
2565
|
+
|
|
2187
2566
|
***
|
|
2188
2567
|
|
|
2189
2568
|
### getProperties()
|
|
@@ -2198,6 +2577,10 @@ get all properties descriptor include inherited.
|
|
|
2198
2577
|
|
|
2199
2578
|
`PropDescriptors`
|
|
2200
2579
|
|
|
2580
|
+
#### Inherited from
|
|
2581
|
+
|
|
2582
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getProperties`](RpcMethodsClientTool.md#getproperties-2)
|
|
2583
|
+
|
|
2201
2584
|
***
|
|
2202
2585
|
|
|
2203
2586
|
### getPrototypeOf()
|
|
@@ -2220,13 +2603,17 @@ The object that references the prototype.
|
|
|
2220
2603
|
|
|
2221
2604
|
`any`
|
|
2222
2605
|
|
|
2606
|
+
#### Inherited from
|
|
2607
|
+
|
|
2608
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`getPrototypeOf`](RpcMethodsClientTool.md#getprototypeof)
|
|
2609
|
+
|
|
2223
2610
|
***
|
|
2224
2611
|
|
|
2225
2612
|
### hasAsyncFeature()
|
|
2226
2613
|
|
|
2227
2614
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2228
2615
|
|
|
2229
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/
|
|
2616
|
+
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)
|
|
2230
2617
|
|
|
2231
2618
|
Checks if any registered function has a specific asynchronous feature.
|
|
2232
2619
|
|
|
@@ -2244,6 +2631,10 @@ The async feature bit to check for.
|
|
|
2244
2631
|
|
|
2245
2632
|
`true` if the feature is present in any function, otherwise `false`.
|
|
2246
2633
|
|
|
2634
|
+
#### Inherited from
|
|
2635
|
+
|
|
2636
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`hasAsyncFeature`](RpcMethodsClientTool.md#hasasyncfeature-2)
|
|
2637
|
+
|
|
2247
2638
|
***
|
|
2248
2639
|
|
|
2249
2640
|
### hasOwn()
|
|
@@ -2272,6 +2663,10 @@ A property name.
|
|
|
2272
2663
|
|
|
2273
2664
|
`boolean`
|
|
2274
2665
|
|
|
2666
|
+
#### Inherited from
|
|
2667
|
+
|
|
2668
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`hasOwn`](RpcMethodsClientTool.md#hasown)
|
|
2669
|
+
|
|
2275
2670
|
***
|
|
2276
2671
|
|
|
2277
2672
|
### is()
|
|
@@ -2300,6 +2695,10 @@ The second value.
|
|
|
2300
2695
|
|
|
2301
2696
|
`boolean`
|
|
2302
2697
|
|
|
2698
|
+
#### Inherited from
|
|
2699
|
+
|
|
2700
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`is`](RpcMethodsClientTool.md#is)
|
|
2701
|
+
|
|
2303
2702
|
***
|
|
2304
2703
|
|
|
2305
2704
|
### isExtensible()
|
|
@@ -2322,6 +2721,10 @@ Object to test.
|
|
|
2322
2721
|
|
|
2323
2722
|
`boolean`
|
|
2324
2723
|
|
|
2724
|
+
#### Inherited from
|
|
2725
|
+
|
|
2726
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isExtensible`](RpcMethodsClientTool.md#isextensible)
|
|
2727
|
+
|
|
2325
2728
|
***
|
|
2326
2729
|
|
|
2327
2730
|
### isFrozen()
|
|
@@ -2344,6 +2747,10 @@ Object to test.
|
|
|
2344
2747
|
|
|
2345
2748
|
`boolean`
|
|
2346
2749
|
|
|
2750
|
+
#### Inherited from
|
|
2751
|
+
|
|
2752
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isFrozen`](RpcMethodsClientTool.md#isfrozen)
|
|
2753
|
+
|
|
2347
2754
|
***
|
|
2348
2755
|
|
|
2349
2756
|
### isSealed()
|
|
@@ -2366,6 +2773,10 @@ Object to test.
|
|
|
2366
2773
|
|
|
2367
2774
|
`boolean`
|
|
2368
2775
|
|
|
2776
|
+
#### Inherited from
|
|
2777
|
+
|
|
2778
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`isSealed`](RpcMethodsClientTool.md#issealed)
|
|
2779
|
+
|
|
2369
2780
|
***
|
|
2370
2781
|
|
|
2371
2782
|
### keys()
|
|
@@ -2390,6 +2801,10 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2390
2801
|
|
|
2391
2802
|
`string`[]
|
|
2392
2803
|
|
|
2804
|
+
##### Inherited from
|
|
2805
|
+
|
|
2806
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`keys`](RpcMethodsClientTool.md#keys)
|
|
2807
|
+
|
|
2393
2808
|
#### Call Signature
|
|
2394
2809
|
|
|
2395
2810
|
> `static` **keys**(`o`): `string`[]
|
|
@@ -2408,13 +2823,17 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2408
2823
|
|
|
2409
2824
|
`string`[]
|
|
2410
2825
|
|
|
2826
|
+
##### Inherited from
|
|
2827
|
+
|
|
2828
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`keys`](RpcMethodsClientTool.md#keys)
|
|
2829
|
+
|
|
2411
2830
|
***
|
|
2412
2831
|
|
|
2413
2832
|
### list()
|
|
2414
2833
|
|
|
2415
2834
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2416
2835
|
|
|
2417
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/
|
|
2836
|
+
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)
|
|
2418
2837
|
|
|
2419
2838
|
Returns the complete map of all registered functions.
|
|
2420
2839
|
|
|
@@ -2424,13 +2843,17 @@ Returns the complete map of all registered functions.
|
|
|
2424
2843
|
|
|
2425
2844
|
The map of `ToolFunc` instances.
|
|
2426
2845
|
|
|
2846
|
+
#### Inherited from
|
|
2847
|
+
|
|
2848
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`list`](RpcMethodsClientTool.md#list)
|
|
2849
|
+
|
|
2427
2850
|
***
|
|
2428
2851
|
|
|
2429
2852
|
### loadFrom()
|
|
2430
2853
|
|
|
2431
2854
|
> `static` **loadFrom**(`items`?): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
|
|
2432
2855
|
|
|
2433
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:68](https://github.com/isdk/ai-tool.js/blob/
|
|
2856
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:68](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L68)
|
|
2434
2857
|
|
|
2435
2858
|
Loads tool definitions from the remote server via the configured transport.
|
|
2436
2859
|
This method populates the local `ToolFunc` registry with `ClientTools` stubs.
|
|
@@ -2445,13 +2868,17 @@ This method populates the local `ToolFunc` registry with `ClientTools` stubs.
|
|
|
2445
2868
|
|
|
2446
2869
|
`Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
|
|
2447
2870
|
|
|
2871
|
+
#### Inherited from
|
|
2872
|
+
|
|
2873
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`loadFrom`](RpcMethodsClientTool.md#loadfrom)
|
|
2874
|
+
|
|
2448
2875
|
***
|
|
2449
2876
|
|
|
2450
2877
|
### loadFromSync()
|
|
2451
2878
|
|
|
2452
2879
|
> `static` **loadFromSync**(`items`): `void`
|
|
2453
2880
|
|
|
2454
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:84](https://github.com/isdk/ai-tool.js/blob/
|
|
2881
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:84](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L84)
|
|
2455
2882
|
|
|
2456
2883
|
Synchronously loads tool definitions from a provided object, registering
|
|
2457
2884
|
each one as a `ClientTools` instance.
|
|
@@ -2468,6 +2895,10 @@ A map of tool function metadata, typically from a server.
|
|
|
2468
2895
|
|
|
2469
2896
|
`void`
|
|
2470
2897
|
|
|
2898
|
+
#### Inherited from
|
|
2899
|
+
|
|
2900
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`loadFromSync`](RpcMethodsClientTool.md#loadfromsync)
|
|
2901
|
+
|
|
2471
2902
|
***
|
|
2472
2903
|
|
|
2473
2904
|
### preventExtensions()
|
|
@@ -2494,6 +2925,10 @@ Object to make non-extensible.
|
|
|
2494
2925
|
|
|
2495
2926
|
`T`
|
|
2496
2927
|
|
|
2928
|
+
#### Inherited from
|
|
2929
|
+
|
|
2930
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`preventExtensions`](RpcMethodsClientTool.md#preventextensions)
|
|
2931
|
+
|
|
2497
2932
|
***
|
|
2498
2933
|
|
|
2499
2934
|
### register()
|
|
@@ -2502,7 +2937,7 @@ Object to make non-extensible.
|
|
|
2502
2937
|
|
|
2503
2938
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2504
2939
|
|
|
2505
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/
|
|
2940
|
+
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)
|
|
2506
2941
|
|
|
2507
2942
|
Registers a new tool function.
|
|
2508
2943
|
|
|
@@ -2530,11 +2965,15 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2530
2965
|
|
|
2531
2966
|
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2532
2967
|
|
|
2968
|
+
##### Inherited from
|
|
2969
|
+
|
|
2970
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`register`](RpcMethodsClientTool.md#register-2)
|
|
2971
|
+
|
|
2533
2972
|
#### Call Signature
|
|
2534
2973
|
|
|
2535
2974
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2536
2975
|
|
|
2537
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/
|
|
2976
|
+
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)
|
|
2538
2977
|
|
|
2539
2978
|
Registers a new tool function.
|
|
2540
2979
|
|
|
@@ -2562,11 +3001,15 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2562
3001
|
|
|
2563
3002
|
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2564
3003
|
|
|
3004
|
+
##### Inherited from
|
|
3005
|
+
|
|
3006
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`register`](RpcMethodsClientTool.md#register-2)
|
|
3007
|
+
|
|
2565
3008
|
#### Call Signature
|
|
2566
3009
|
|
|
2567
3010
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2568
3011
|
|
|
2569
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/
|
|
3012
|
+
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)
|
|
2570
3013
|
|
|
2571
3014
|
Registers a new tool function.
|
|
2572
3015
|
|
|
@@ -2594,13 +3037,17 @@ The new `ToolFunc` instance, or `false` if a function with that name already exi
|
|
|
2594
3037
|
|
|
2595
3038
|
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2596
3039
|
|
|
3040
|
+
##### Inherited from
|
|
3041
|
+
|
|
3042
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`register`](RpcMethodsClientTool.md#register-2)
|
|
3043
|
+
|
|
2597
3044
|
***
|
|
2598
3045
|
|
|
2599
3046
|
### run()
|
|
2600
3047
|
|
|
2601
3048
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
2602
3049
|
|
|
2603
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/
|
|
3050
|
+
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)
|
|
2604
3051
|
|
|
2605
3052
|
Asynchronously executes a registered function by name with named parameters.
|
|
2606
3053
|
|
|
@@ -2628,13 +3075,17 @@ A promise that resolves with the function's result.
|
|
|
2628
3075
|
|
|
2629
3076
|
If the function with the given name is not found.
|
|
2630
3077
|
|
|
3078
|
+
#### Inherited from
|
|
3079
|
+
|
|
3080
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`run`](RpcMethodsClientTool.md#run-2)
|
|
3081
|
+
|
|
2631
3082
|
***
|
|
2632
3083
|
|
|
2633
3084
|
### runSync()
|
|
2634
3085
|
|
|
2635
3086
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
2636
3087
|
|
|
2637
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/
|
|
3088
|
+
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)
|
|
2638
3089
|
|
|
2639
3090
|
Synchronously executes a registered function by name with named parameters.
|
|
2640
3091
|
|
|
@@ -2662,13 +3113,17 @@ The result of the function's execution.
|
|
|
2662
3113
|
|
|
2663
3114
|
If the function with the given name is not found.
|
|
2664
3115
|
|
|
3116
|
+
#### Inherited from
|
|
3117
|
+
|
|
3118
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runSync`](RpcMethodsClientTool.md#runsync-2)
|
|
3119
|
+
|
|
2665
3120
|
***
|
|
2666
3121
|
|
|
2667
3122
|
### runWithPos()
|
|
2668
3123
|
|
|
2669
3124
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2670
3125
|
|
|
2671
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/
|
|
3126
|
+
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)
|
|
2672
3127
|
|
|
2673
3128
|
Asynchronously executes a function using positional arguments.
|
|
2674
3129
|
|
|
@@ -2696,13 +3151,17 @@ A promise that resolves with the function's result.
|
|
|
2696
3151
|
|
|
2697
3152
|
If the function with the given name is not found.
|
|
2698
3153
|
|
|
3154
|
+
#### Inherited from
|
|
3155
|
+
|
|
3156
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPos`](RpcMethodsClientTool.md#runwithpos-2)
|
|
3157
|
+
|
|
2699
3158
|
***
|
|
2700
3159
|
|
|
2701
3160
|
### runWithPosSync()
|
|
2702
3161
|
|
|
2703
3162
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2704
3163
|
|
|
2705
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/
|
|
3164
|
+
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)
|
|
2706
3165
|
|
|
2707
3166
|
Synchronously executes a function using positional arguments.
|
|
2708
3167
|
|
|
@@ -2730,6 +3189,10 @@ The result of the function's execution.
|
|
|
2730
3189
|
|
|
2731
3190
|
If the function with the given name is not found.
|
|
2732
3191
|
|
|
3192
|
+
#### Inherited from
|
|
3193
|
+
|
|
3194
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`runWithPosSync`](RpcMethodsClientTool.md#runwithpossync-2)
|
|
3195
|
+
|
|
2733
3196
|
***
|
|
2734
3197
|
|
|
2735
3198
|
### seal()
|
|
@@ -2756,6 +3219,10 @@ Object on which to lock the attributes.
|
|
|
2756
3219
|
|
|
2757
3220
|
`T`
|
|
2758
3221
|
|
|
3222
|
+
#### Inherited from
|
|
3223
|
+
|
|
3224
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`seal`](RpcMethodsClientTool.md#seal)
|
|
3225
|
+
|
|
2759
3226
|
***
|
|
2760
3227
|
|
|
2761
3228
|
### setPrototypeOf()
|
|
@@ -2784,13 +3251,17 @@ The value of the new prototype or null.
|
|
|
2784
3251
|
|
|
2785
3252
|
`any`
|
|
2786
3253
|
|
|
3254
|
+
#### Inherited from
|
|
3255
|
+
|
|
3256
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`setPrototypeOf`](RpcMethodsClientTool.md#setprototypeof)
|
|
3257
|
+
|
|
2787
3258
|
***
|
|
2788
3259
|
|
|
2789
3260
|
### setTransport()
|
|
2790
3261
|
|
|
2791
3262
|
> `static` **setTransport**(`transport`): `void`
|
|
2792
3263
|
|
|
2793
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:50](https://github.com/isdk/ai-tool.js/blob/
|
|
3264
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/client-tools.ts:50](https://github.com/isdk/ai-tool.js/blob/4ebf370aaec9c78535cb40ffc19656d7bddcb145/src/client-tools.ts#L50)
|
|
2794
3265
|
|
|
2795
3266
|
Injects the client-side transport implementation. This is a crucial step
|
|
2796
3267
|
to enable communication with the server.
|
|
@@ -2807,13 +3278,17 @@ The transport instance to use for all client-server communication.
|
|
|
2807
3278
|
|
|
2808
3279
|
`void`
|
|
2809
3280
|
|
|
3281
|
+
#### Inherited from
|
|
3282
|
+
|
|
3283
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`setTransport`](RpcMethodsClientTool.md#settransport)
|
|
3284
|
+
|
|
2810
3285
|
***
|
|
2811
3286
|
|
|
2812
3287
|
### unregister()
|
|
2813
3288
|
|
|
2814
3289
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2815
3290
|
|
|
2816
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/
|
|
3291
|
+
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)
|
|
2817
3292
|
|
|
2818
3293
|
Unregisters a function by its name, also removing any associated aliases.
|
|
2819
3294
|
|
|
@@ -2831,6 +3306,10 @@ The name of the function to unregister.
|
|
|
2831
3306
|
|
|
2832
3307
|
The unregistered `ToolFunc` instance, or `undefined` if it was not found.
|
|
2833
3308
|
|
|
3309
|
+
#### Inherited from
|
|
3310
|
+
|
|
3311
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`unregister`](RpcMethodsClientTool.md#unregister-2)
|
|
3312
|
+
|
|
2834
3313
|
***
|
|
2835
3314
|
|
|
2836
3315
|
### values()
|
|
@@ -2859,6 +3338,10 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2859
3338
|
|
|
2860
3339
|
`T`[]
|
|
2861
3340
|
|
|
3341
|
+
##### Inherited from
|
|
3342
|
+
|
|
3343
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`values`](RpcMethodsClientTool.md#values)
|
|
3344
|
+
|
|
2862
3345
|
#### Call Signature
|
|
2863
3346
|
|
|
2864
3347
|
> `static` **values**(`o`): `any`[]
|
|
@@ -2876,3 +3359,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2876
3359
|
##### Returns
|
|
2877
3360
|
|
|
2878
3361
|
`any`[]
|
|
3362
|
+
|
|
3363
|
+
##### Inherited from
|
|
3364
|
+
|
|
3365
|
+
[`RpcMethodsClientTool`](RpcMethodsClientTool.md).[`values`](RpcMethodsClientTool.md#values)
|