@isdk/ai-tool 0.5.6 → 0.5.7
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-OHVYEOHR.mjs → chunk-XLXW6OPN.mjs} +1 -1
- package/dist/funcs.d.mts +1 -1
- package/dist/funcs.d.ts +1 -1
- package/dist/funcs.js +1 -1
- package/dist/funcs.mjs +1 -1
- package/dist/{index-Br-4ZYgE.d.mts → index-BkwhCK1q.d.mts} +7 -0
- package/dist/{index-Br-4ZYgE.d.ts → index-BkwhCK1q.d.ts} +7 -0
- package/dist/index.d.mts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/classes/BinarySemaphore.md +25 -25
- package/docs/classes/CancelableAbility.md +25 -25
- package/docs/classes/ClientTools.md +83 -55
- package/docs/classes/EnvPromptTemplate.md +19 -19
- package/docs/classes/EventClient.md +106 -78
- package/docs/classes/EventServer.md +107 -79
- package/docs/classes/EventToolFunc.md +75 -47
- package/docs/classes/FStringPromptTemplate.md +19 -19
- package/docs/classes/FewShotPromptTemplate.md +23 -23
- package/docs/classes/GolangPromptTemplate.md +19 -19
- package/docs/classes/HFEnvironment.md +10 -10
- package/docs/classes/HFInterpreter.md +5 -5
- package/docs/classes/HFTemplate.md +5 -5
- package/docs/classes/HfPromptTemplate.md +19 -19
- package/docs/classes/IntSet.md +12 -12
- package/docs/classes/PromptExampleSelector.md +9 -9
- package/docs/classes/PromptTemplate.md +18 -18
- package/docs/classes/ReadableStreamError.md +2 -2
- package/docs/classes/ResClientTools.md +82 -62
- package/docs/classes/ResServerTools.md +83 -63
- package/docs/classes/SSEChannel.md +16 -16
- package/docs/classes/Semaphore.md +26 -26
- package/docs/classes/ServerTools.md +79 -51
- package/docs/classes/SignalGate.md +9 -9
- package/docs/classes/TaskAbortController.md +8 -8
- package/docs/classes/ToolFunc.md +68 -44
- package/docs/classes/YamlTypeBaseObject.md +2 -2
- package/docs/enumerations/AsyncFeatureBits.md +4 -4
- package/docs/enumerations/AsyncFeatures.md +4 -4
- package/docs/enumerations/HashAlgorithm.md +12 -12
- package/docs/functions/AIArgProcessor.md +1 -1
- package/docs/functions/AIStream.md +1 -1
- package/docs/functions/ChoiceArgProcessor.md +1 -1
- package/docs/functions/ObjectArgsToArgsInfo.md +1 -1
- package/docs/functions/RateLimit.md +1 -1
- package/docs/functions/TemplateArgProcessor.md +1 -1
- package/docs/functions/assignDirs.md +1 -1
- package/docs/functions/backendEventable.md +1 -1
- package/docs/functions/beforeShutdown.md +1 -1
- package/docs/functions/completeSentences.md +1 -1
- package/docs/functions/concatText.md +1 -1
- package/docs/functions/countLLMTokens.md +1 -1
- package/docs/functions/countRegexMatches.md +1 -1
- package/docs/functions/createCallbacksTransformer.md +1 -1
- package/docs/functions/createEmptyReadableStream.md +1 -1
- package/docs/functions/createEndWithRepetitionDetector.md +1 -1
- package/docs/functions/createEventStreamTransformer.md +1 -1
- package/docs/functions/createHfValueFunc.md +1 -1
- package/docs/functions/createLRUCache.md +1 -1
- package/docs/functions/createYamlObjectTag.md +1 -1
- package/docs/functions/dateToText.md +1 -1
- package/docs/functions/decodeCharset.md +1 -1
- package/docs/functions/detectCharset.md +1 -1
- package/docs/functions/encodeLLMTokens.md +1 -1
- package/docs/functions/ensureQuoted.md +1 -1
- package/docs/functions/expandConfig.md +1 -1
- package/docs/functions/expandEnv.md +1 -1
- package/docs/functions/expandObjEnv.md +1 -1
- package/docs/functions/expandPath.md +1 -1
- package/docs/functions/extNameLevel.md +1 -1
- package/docs/functions/fileIsExists.md +1 -1
- package/docs/functions/filenameReservedRegex.md +1 -1
- package/docs/functions/filterValidFnScope.md +1 -1
- package/docs/functions/findIndexNonEmptyFrom.md +1 -1
- package/docs/functions/findPort.md +1 -1
- package/docs/functions/formatTextWithSpace.md +1 -1
- package/docs/functions/getAllEnumKeys.md +1 -1
- package/docs/functions/getConfigFileNames.md +1 -1
- package/docs/functions/getConfigs.md +1 -1
- package/docs/functions/getEnvVairables.md +1 -1
- package/docs/functions/getFileMetaInfo.md +1 -1
- package/docs/functions/getHashAlgoBySize.md +1 -1
- package/docs/functions/getKeysPath.md +1 -1
- package/docs/functions/getLLMTokenizer.md +1 -1
- package/docs/functions/getMultiLevelExtname.md +1 -1
- package/docs/functions/getPackageDir.md +1 -1
- package/docs/functions/getRealFilepath.md +1 -1
- package/docs/functions/getResponseErrorReadableStream.md +1 -1
- package/docs/functions/getXDGConfigs.md +1 -1
- package/docs/functions/hasDirectoryIn.md +1 -1
- package/docs/functions/hash.md +1 -1
- package/docs/functions/hashFile.md +1 -1
- package/docs/functions/hashStream.md +1 -1
- package/docs/functions/hfParse.md +1 -1
- package/docs/functions/hfTokenize.md +1 -1
- package/docs/functions/initShutdown.md +1 -1
- package/docs/functions/interpolateEnv.md +1 -1
- package/docs/functions/interpolateFString.md +1 -1
- package/docs/functions/interpolateGolangTemplate.md +1 -1
- package/docs/functions/isLangUsingSpaces.md +1 -1
- package/docs/functions/isListItemString.md +1 -1
- package/docs/functions/isModelNameMatched.md +1 -1
- package/docs/functions/isPunctuationChar.md +1 -1
- package/docs/functions/isQuoted.md +1 -1
- package/docs/functions/isRegExp.md +1 -1
- package/docs/functions/isSameString.md +1 -1
- package/docs/functions/isSectionString.md +1 -1
- package/docs/functions/isSentenceEnding.md +1 -1
- package/docs/functions/isSepLineString.md +1 -1
- package/docs/functions/isStrWrapped.md +1 -1
- package/docs/functions/isSubdirectory.md +1 -1
- package/docs/functions/isTitleString.md +1 -1
- package/docs/functions/isValidFilename.md +1 -1
- package/docs/functions/isValidFilepath.md +1 -1
- package/docs/functions/isWebStream.md +1 -1
- package/docs/functions/jsonFilterToWhere.md +1 -1
- package/docs/functions/jsonToMarkdownStr.md +1 -1
- package/docs/functions/loadAIConfig.md +1 -1
- package/docs/functions/loadConfig.md +1 -1
- package/docs/functions/loadConfigFile.md +1 -1
- package/docs/functions/loadFileFromPaths.md +1 -1
- package/docs/functions/loadTextFromPaths.md +1 -1
- package/docs/functions/lrucache.md +1 -1
- package/docs/functions/makeToolFuncCancelable.md +1 -1
- package/docs/functions/matchUrlProtocol.md +1 -1
- package/docs/functions/memoize.md +1 -1
- package/docs/functions/messagesToText.md +1 -1
- package/docs/functions/paramsSizeToScaleStr.md +1 -1
- package/docs/functions/parseCommand.md +1 -1
- package/docs/functions/parseFString.md +1 -1
- package/docs/functions/parseJsJson.md +1 -1
- package/docs/functions/parseJsJsonSimpleSync.md +1 -1
- package/docs/functions/parseObjectArgInfo.md +1 -1
- package/docs/functions/parseObjectArgumentInfos.md +1 -1
- package/docs/functions/parseObjectArguments.md +1 -1
- package/docs/functions/parseObjectArgumentsAsArgInfos.md +1 -1
- package/docs/functions/parseYaml.md +1 -1
- package/docs/functions/quoteStr.md +1 -1
- package/docs/functions/reControlCharsRegex.md +1 -1
- package/docs/functions/readFilenamesRecursiveSync.md +1 -1
- package/docs/functions/readTextFileChunks.md +1 -1
- package/docs/functions/readTextFileChunksEx.md +1 -1
- package/docs/functions/readableFromAsyncIterable.md +1 -1
- package/docs/functions/registerCoreTools.md +1 -1
- package/docs/functions/registerYamlTag.md +1 -1
- package/docs/functions/removeMarkdownBold.md +1 -1
- package/docs/functions/removeMarkdownBoldAndItalic.md +1 -1
- package/docs/functions/removeMarkdownItalic.md +1 -1
- package/docs/functions/replaceWithPlaceholder.md +1 -1
- package/docs/functions/restoreFromPlacehoders.md +1 -1
- package/docs/functions/sanitizeFilename.md +1 -1
- package/docs/functions/sanitizeFilepath.md +1 -1
- package/docs/functions/saveConfigFile.md +1 -1
- package/docs/functions/scaleStrToParamsSize.md +1 -1
- package/docs/functions/shutdown.md +1 -1
- package/docs/functions/simplifyObjectArguments.md +1 -1
- package/docs/functions/sortedValues.md +1 -1
- package/docs/functions/splitChunks.md +1 -1
- package/docs/functions/splitParagraph.md +1 -1
- package/docs/functions/splitSentence.md +1 -1
- package/docs/functions/stringifyYaml.md +1 -1
- package/docs/functions/stripConsoleColor.md +1 -1
- package/docs/functions/textToDate.md +1 -1
- package/docs/functions/toDateTime.md +1 -1
- package/docs/functions/trimStartOfStreamHelper.md +1 -1
- package/docs/functions/truncTo.md +1 -1
- package/docs/functions/truncateByToken.md +1 -1
- package/docs/functions/truncateToTokenLimit.md +1 -1
- package/docs/functions/truncateToTokenLimitEx.md +1 -1
- package/docs/functions/uuid.md +1 -1
- package/docs/functions/wait.md +1 -1
- package/docs/functions/xxhash.md +1 -1
- package/docs/functions/xxhash32.md +1 -1
- package/docs/functions/xxhash64.md +1 -1
- package/docs/functions/xxhashAsStr.md +1 -1
- package/docs/interfaces/AIChatAssistantMessageParam.md +12 -12
- package/docs/interfaces/AIChatContentPartImage.md +3 -3
- package/docs/interfaces/AIChatContentPartText.md +3 -3
- package/docs/interfaces/AIChatMessageParamBase.md +7 -7
- package/docs/interfaces/AIChatMessageToolCall.md +4 -4
- package/docs/interfaces/AIChatSystemMessageParam.md +9 -9
- package/docs/interfaces/AIChatToolChoiceFuncObject.md +3 -3
- package/docs/interfaces/AIChatToolChoiceObject.md +2 -2
- package/docs/interfaces/AIChatToolFunc.md +5 -5
- package/docs/interfaces/AIChatToolFuncParam.md +3 -3
- package/docs/interfaces/AIChatToolMessageParam.md +10 -10
- package/docs/interfaces/AIChatToolParam.md +2 -2
- package/docs/interfaces/AIChatToolTypeObject.md +2 -2
- package/docs/interfaces/AIChatUserMessageParam.md +13 -13
- package/docs/interfaces/AIChoiceConfig.md +8 -8
- package/docs/interfaces/AIResult.md +6 -6
- package/docs/interfaces/AIStreamParser.md +2 -2
- package/docs/interfaces/AIStreamParserOptions.md +2 -2
- package/docs/interfaces/BaseFunc.md +22 -10
- package/docs/interfaces/BaseFuncItem.md +17 -9
- package/docs/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
- package/docs/interfaces/BinarySemaphoreOptions.md +5 -5
- package/docs/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
- package/docs/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
- package/docs/interfaces/CancelableAbilityOptions.md +4 -4
- package/docs/interfaces/ClientFuncItem.md +24 -12
- package/docs/interfaces/DotenvExpandOptions.md +4 -4
- package/docs/interfaces/DotenvExpandOutput.md +3 -3
- package/docs/interfaces/DotenvParseInput.md +1 -1
- package/docs/interfaces/DotenvParseOutput.md +1 -1
- package/docs/interfaces/DotenvPopulateInput.md +1 -1
- package/docs/interfaces/EventClientFuncParams.md +5 -5
- package/docs/interfaces/EventServerFuncParams.md +6 -6
- package/docs/interfaces/FewShotPromptTemplateOptions.md +12 -12
- package/docs/interfaces/FuncItem.md +22 -10
- package/docs/interfaces/FuncParam.md +7 -7
- package/docs/interfaces/FuncParams.md +1 -1
- package/docs/interfaces/Funcs.md +1 -1
- package/docs/interfaces/HashAlgoParams.md +4 -4
- package/docs/interfaces/IFileMetaInfo.md +8 -8
- package/docs/interfaces/IReadTextFileChunksOptions.md +11 -11
- package/docs/interfaces/ITruncateToTokenLimitOptions.md +10 -10
- package/docs/interfaces/JsonFilter.md +1 -1
- package/docs/interfaces/ParseObjectArgumentOptions.md +11 -11
- package/docs/interfaces/PromptExampleSelectorOptions.md +3 -3
- package/docs/interfaces/PromptTemplateOptions.md +7 -7
- package/docs/interfaces/RemoteFuncItem.md +24 -12
- package/docs/interfaces/ReplacePlacehoderOptions.md +5 -5
- package/docs/interfaces/ResClientFuncParams.md +3 -3
- package/docs/interfaces/ResServerFuncParams.md +6 -6
- package/docs/interfaces/SanitizeFilenameOptions.md +3 -3
- package/docs/interfaces/SectionStringOptions.md +3 -3
- package/docs/interfaces/SemaphoreOptions.md +7 -7
- package/docs/interfaces/SemaphoreTaskItem.md +5 -5
- package/docs/interfaces/ServerFuncItem.md +25 -13
- package/docs/interfaces/ServerFuncParams.md +3 -3
- package/docs/interfaces/SplitSentenceOptions.md +5 -5
- package/docs/interfaces/StreamCallbacksAndOptions.md +5 -5
- package/docs/interfaces/TaskAbortControllers.md +1 -1
- package/docs/interfaces/TaskPromise.md +2 -2
- package/docs/interfaces/ToolFuncPackage.md +4 -4
- package/docs/type-aliases/AIChatContentPart.md +1 -1
- package/docs/type-aliases/AIChatMessageParam.md +1 -1
- package/docs/type-aliases/AIChatRole.md +1 -1
- package/docs/type-aliases/AIChatToolChoiceParam.md +1 -1
- package/docs/type-aliases/AIMessageType.md +1 -1
- package/docs/type-aliases/AIModelNameRule.md +1 -1
- package/docs/type-aliases/AIModelNameRuleFn.md +1 -1
- package/docs/type-aliases/AIModelNameRules.md +1 -1
- package/docs/type-aliases/AITextGenerationFinishReason.md +1 -1
- package/docs/type-aliases/ActionName.md +1 -1
- package/docs/type-aliases/AsyncTaskId.md +1 -1
- package/docs/type-aliases/BeforeShutdownListener.md +1 -1
- package/docs/type-aliases/EventErrorListenerFn.md +1 -1
- package/docs/type-aliases/EventListenerFn.md +1 -1
- package/docs/type-aliases/FStringPromptTemplateNode.md +1 -1
- package/docs/type-aliases/FuncParamType.md +1 -1
- package/docs/type-aliases/PromptExamples.md +1 -1
- package/docs/type-aliases/PromptTemplateType.md +1 -1
- package/docs/type-aliases/PromptType.md +1 -1
- package/docs/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/type-aliases/TFunc.md +1 -1
- package/docs/variables/AIChatRoles.md +1 -1
- package/docs/variables/AIMessageTypes.md +1 -1
- package/docs/variables/AITextGenerationFinishReasons.md +1 -1
- package/docs/variables/ActionNames.md +1 -1
- package/docs/variables/ClientToolFuncSchema.md +1 -1
- package/docs/variables/DEFAULT_CONFIG_NAME.md +1 -1
- package/docs/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
- package/docs/variables/EventBusName.md +1 -1
- package/docs/variables/EventName.md +1 -1
- package/docs/variables/FilenameReservedRegex.md +1 -1
- package/docs/variables/HFBuiltins.md +1 -1
- package/docs/variables/LLM_TOKENIZER_NAMES.md +1 -1
- package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
- package/docs/variables/PASSING_SCORE.md +1 -1
- package/docs/variables/PromptTemplateTypes.md +1 -1
- package/docs/variables/PromptTypes.md +1 -1
- package/docs/variables/RStreamErrCode.md +1 -1
- package/docs/variables/RemoteToolFuncSchema.md +1 -1
- package/docs/variables/ResponseRStreamErrCode.md +1 -1
- package/docs/variables/SHUTDOWN_SIGNALS.md +1 -1
- package/docs/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
- package/docs/variables/SecondaryCache.md +1 -1
- package/docs/variables/ServerToolFuncSchema.md +1 -1
- package/docs/variables/ToolAsyncCancelableBit.md +1 -1
- package/docs/variables/ToolAsyncMultiTaskBit.md +1 -1
- package/docs/variables/ToolAsyncPriorityBit.md +1 -1
- package/docs/variables/ToolFuncSchema.md +9 -1
- package/docs/variables/WindowsReservedNameRegex.md +1 -1
- package/docs/variables/base32768.md +1 -1
- package/docs/variables/defaultTemplateFormat.md +1 -1
- package/docs/variables/event.md +1 -1
- package/docs/variables/eventClient.md +1 -1
- package/docs/variables/eventServer.md +1 -1
- package/docs/variables/lrucache.md +1 -1
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ResClientTools
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/res-client-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/res-client-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/res-client-tools.ts#L9)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/ai-tool/src/res-client-tools.ts:9](https://github.com/isdk
|
|
|
26
26
|
|
|
27
27
|
> **new ResClientTools**(`name`, `options`): [`ResClientTools`](ResClientTools.md)
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
29
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:225](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L225)
|
|
30
30
|
|
|
31
31
|
#### Parameters
|
|
32
32
|
|
|
@@ -56,7 +56,15 @@ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-ma
|
|
|
56
56
|
|
|
57
57
|
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
58
58
|
|
|
59
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/
|
|
59
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/consts.ts#L35)
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### alias?
|
|
64
|
+
|
|
65
|
+
> `optional` **alias**: `string` \| `string`[]
|
|
66
|
+
|
|
67
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L31)
|
|
60
68
|
|
|
61
69
|
***
|
|
62
70
|
|
|
@@ -64,7 +72,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai
|
|
|
64
72
|
|
|
65
73
|
> **apiRoot**: `undefined` \| `string`
|
|
66
74
|
|
|
67
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
75
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:16](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/client-tools.ts#L16)
|
|
68
76
|
|
|
69
77
|
***
|
|
70
78
|
|
|
@@ -100,7 +108,7 @@ The default options for export and assign
|
|
|
100
108
|
|
|
101
109
|
> `optional` **fetchOptions**: `any`
|
|
102
110
|
|
|
103
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/
|
|
111
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/utils/consts.ts#L36)
|
|
104
112
|
|
|
105
113
|
***
|
|
106
114
|
|
|
@@ -108,7 +116,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai
|
|
|
108
116
|
|
|
109
117
|
> `optional` **isApi**: `boolean`
|
|
110
118
|
|
|
111
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
119
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L29)
|
|
112
120
|
|
|
113
121
|
***
|
|
114
122
|
|
|
@@ -116,7 +124,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
|
|
|
116
124
|
|
|
117
125
|
> `optional` **name**: `string`
|
|
118
126
|
|
|
119
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
127
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L23)
|
|
120
128
|
|
|
121
129
|
***
|
|
122
130
|
|
|
@@ -134,7 +142,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
134
142
|
|
|
135
143
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
136
144
|
|
|
137
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
145
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L24)
|
|
138
146
|
|
|
139
147
|
***
|
|
140
148
|
|
|
@@ -142,7 +150,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-to
|
|
|
142
150
|
|
|
143
151
|
> `optional` **result**: `string`
|
|
144
152
|
|
|
145
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
153
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L25)
|
|
146
154
|
|
|
147
155
|
***
|
|
148
156
|
|
|
@@ -150,7 +158,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-to
|
|
|
150
158
|
|
|
151
159
|
> `optional` **scope**: `any`
|
|
152
160
|
|
|
153
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
161
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L26)
|
|
154
162
|
|
|
155
163
|
***
|
|
156
164
|
|
|
@@ -158,7 +166,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
|
|
|
158
166
|
|
|
159
167
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
160
168
|
|
|
161
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
169
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L28)
|
|
162
170
|
|
|
163
171
|
#### Parameters
|
|
164
172
|
|
|
@@ -180,7 +188,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
180
188
|
|
|
181
189
|
> `optional` **stream**: `boolean`
|
|
182
190
|
|
|
183
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/
|
|
191
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L30)
|
|
184
192
|
|
|
185
193
|
***
|
|
186
194
|
|
|
@@ -188,7 +196,19 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
|
|
|
188
196
|
|
|
189
197
|
> `optional` **tags**: `string` \| `string`[]
|
|
190
198
|
|
|
191
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
199
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L27)
|
|
200
|
+
|
|
201
|
+
***
|
|
202
|
+
|
|
203
|
+
### aliases
|
|
204
|
+
|
|
205
|
+
> `static` **aliases**: `object` = `{}`
|
|
206
|
+
|
|
207
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:58](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L58)
|
|
208
|
+
|
|
209
|
+
#### Index Signature
|
|
210
|
+
|
|
211
|
+
\[`name`: `string`\]: `string`
|
|
192
212
|
|
|
193
213
|
***
|
|
194
214
|
|
|
@@ -196,7 +216,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-to
|
|
|
196
216
|
|
|
197
217
|
> `static` **dataPath**: `string`
|
|
198
218
|
|
|
199
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
219
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L59)
|
|
200
220
|
|
|
201
221
|
***
|
|
202
222
|
|
|
@@ -204,7 +224,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-to
|
|
|
204
224
|
|
|
205
225
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
206
226
|
|
|
207
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
227
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L57)
|
|
208
228
|
|
|
209
229
|
## Accessors
|
|
210
230
|
|
|
@@ -214,7 +234,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-to
|
|
|
214
234
|
|
|
215
235
|
> **get** `static` **apiRoot**(): `undefined` \| `string`
|
|
216
236
|
|
|
217
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:19](https://github.com/isdk/ai-tool.js/blob/
|
|
237
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:19](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/client-tools.ts#L19)
|
|
218
238
|
|
|
219
239
|
##### Returns
|
|
220
240
|
|
|
@@ -226,7 +246,7 @@ Defined in: [packages/ai-tool/src/client-tools.ts:19](https://github.com/isdk/ai
|
|
|
226
246
|
|
|
227
247
|
> **\_func**(`action`, `options`): `Promise`\<`any`\>
|
|
228
248
|
|
|
229
|
-
Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
249
|
+
Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:10](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/rpc-methods-client-tool.ts#L10)
|
|
230
250
|
|
|
231
251
|
#### Parameters
|
|
232
252
|
|
|
@@ -248,7 +268,7 @@ Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:10](https://github.
|
|
|
248
268
|
|
|
249
269
|
> **arr2ObjParams**(`params`): `any`[]
|
|
250
270
|
|
|
251
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
271
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:269](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L269)
|
|
252
272
|
|
|
253
273
|
#### Parameters
|
|
254
274
|
|
|
@@ -294,7 +314,7 @@ this object
|
|
|
294
314
|
|
|
295
315
|
> **assignMethods**(`methods`): `void`
|
|
296
316
|
|
|
297
|
-
Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
317
|
+
Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:27](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/rpc-methods-client-tool.ts#L27)
|
|
298
318
|
|
|
299
319
|
#### Parameters
|
|
300
320
|
|
|
@@ -506,7 +526,7 @@ the defined attributes of the object
|
|
|
506
526
|
|
|
507
527
|
> `optional` **delete**(`__namedParameters`): `any`
|
|
508
528
|
|
|
509
|
-
Defined in: [packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
529
|
+
Defined in: [packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/res-client-tools.ts#L13)
|
|
510
530
|
|
|
511
531
|
#### Parameters
|
|
512
532
|
|
|
@@ -524,7 +544,7 @@ Defined in: [packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isd
|
|
|
524
544
|
|
|
525
545
|
> **errorFrom**(`res`): `Promise`\<[`CommonError`](CommonError.md)\>
|
|
526
546
|
|
|
527
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:118](https://github.com/isdk/ai-tool.js/blob/
|
|
547
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:118](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/client-tools.ts#L118)
|
|
528
548
|
|
|
529
549
|
#### Parameters
|
|
530
550
|
|
|
@@ -570,7 +590,7 @@ the dest object.
|
|
|
570
590
|
|
|
571
591
|
> **fetch**(`options`, `action`): `Promise`\<`Response`\>
|
|
572
592
|
|
|
573
|
-
Defined in: [packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isdk/ai-tool.js/blob/
|
|
593
|
+
Defined in: [packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/res-client-tools.ts#L18)
|
|
574
594
|
|
|
575
595
|
#### Parameters
|
|
576
596
|
|
|
@@ -592,7 +612,7 @@ Defined in: [packages/ai-tool/src/res-client-tools.ts:18](https://github.com/isd
|
|
|
592
612
|
|
|
593
613
|
> **func**(`options`): `Promise`\<`any`\>
|
|
594
614
|
|
|
595
|
-
Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.com/isdk/ai-tool.js/blob/
|
|
615
|
+
Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/rpc-methods-client-tool.ts#L19)
|
|
596
616
|
|
|
597
617
|
#### Parameters
|
|
598
618
|
|
|
@@ -610,7 +630,7 @@ Defined in: [packages/ai-tool/src/rpc-methods-client-tool.ts:19](https://github.
|
|
|
610
630
|
|
|
611
631
|
> `optional` **get**(`__namedParameters`): `any`
|
|
612
632
|
|
|
613
|
-
Defined in: [packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
633
|
+
Defined in: [packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/res-client-tools.ts#L10)
|
|
614
634
|
|
|
615
635
|
#### Parameters
|
|
616
636
|
|
|
@@ -628,7 +648,7 @@ Defined in: [packages/ai-tool/src/res-client-tools.ts:10](https://github.com/isd
|
|
|
628
648
|
|
|
629
649
|
> **getFunc**(`name`?): `any`
|
|
630
650
|
|
|
631
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
651
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:322](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L322)
|
|
632
652
|
|
|
633
653
|
#### Parameters
|
|
634
654
|
|
|
@@ -646,7 +666,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-t
|
|
|
646
666
|
|
|
647
667
|
> **getFuncWithPos**(`name`?): `any`
|
|
648
668
|
|
|
649
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
669
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:346](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L346)
|
|
650
670
|
|
|
651
671
|
#### Parameters
|
|
652
672
|
|
|
@@ -680,7 +700,7 @@ the descriptors of properties object
|
|
|
680
700
|
|
|
681
701
|
> **getUrlParams**(`objParam`): `string`
|
|
682
702
|
|
|
683
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:63](https://github.com/isdk/ai-tool.js/blob/
|
|
703
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:63](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/client-tools.ts#L63)
|
|
684
704
|
|
|
685
705
|
#### Parameters
|
|
686
706
|
|
|
@@ -698,7 +718,7 @@ Defined in: [packages/ai-tool/src/client-tools.ts:63](https://github.com/isdk/ai
|
|
|
698
718
|
|
|
699
719
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
700
720
|
|
|
701
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
721
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:351](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L351)
|
|
702
722
|
|
|
703
723
|
#### Parameters
|
|
704
724
|
|
|
@@ -808,7 +828,7 @@ The source object
|
|
|
808
828
|
|
|
809
829
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
810
830
|
|
|
811
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
831
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:357](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L357)
|
|
812
832
|
|
|
813
833
|
#### Parameters
|
|
814
834
|
|
|
@@ -826,7 +846,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:324](https://github.com/isdk/ai-t
|
|
|
826
846
|
|
|
827
847
|
> `optional` **list**(`options`): `any`
|
|
828
848
|
|
|
829
|
-
Defined in: [packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
849
|
+
Defined in: [packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/res-client-tools.ts#L14)
|
|
830
850
|
|
|
831
851
|
#### Parameters
|
|
832
852
|
|
|
@@ -872,7 +892,7 @@ the dest object.
|
|
|
872
892
|
|
|
873
893
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
874
894
|
|
|
875
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
895
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:282](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L282)
|
|
876
896
|
|
|
877
897
|
#### Parameters
|
|
878
898
|
|
|
@@ -890,7 +910,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:249](https://github.com/isdk/ai-t
|
|
|
890
910
|
|
|
891
911
|
> `optional` **post**(`options`): `any`
|
|
892
912
|
|
|
893
|
-
Defined in: [packages/ai-tool/src/res-client-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
913
|
+
Defined in: [packages/ai-tool/src/res-client-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/res-client-tools.ts#L11)
|
|
894
914
|
|
|
895
915
|
#### Parameters
|
|
896
916
|
|
|
@@ -930,7 +950,7 @@ A property name.
|
|
|
930
950
|
|
|
931
951
|
> `optional` **put**(`__namedParameters`): `any`
|
|
932
952
|
|
|
933
|
-
Defined in: [packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
953
|
+
Defined in: [packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/res-client-tools.ts#L12)
|
|
934
954
|
|
|
935
955
|
#### Parameters
|
|
936
956
|
|
|
@@ -948,7 +968,7 @@ Defined in: [packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isd
|
|
|
948
968
|
|
|
949
969
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
950
970
|
|
|
951
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
971
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:252](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L252)
|
|
952
972
|
|
|
953
973
|
#### Returns
|
|
954
974
|
|
|
@@ -960,7 +980,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-t
|
|
|
960
980
|
|
|
961
981
|
> **run**(`params`?): `Promise`\<`any`\>
|
|
962
982
|
|
|
963
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
983
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L309)
|
|
964
984
|
|
|
965
985
|
#### Parameters
|
|
966
986
|
|
|
@@ -978,7 +998,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-t
|
|
|
978
998
|
|
|
979
999
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
980
1000
|
|
|
981
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1001
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L313)
|
|
982
1002
|
|
|
983
1003
|
#### Parameters
|
|
984
1004
|
|
|
@@ -1000,7 +1020,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-t
|
|
|
1000
1020
|
|
|
1001
1021
|
> **runAsSync**(`name`, `params`?): `any`
|
|
1002
1022
|
|
|
1003
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1023
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:317](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L317)
|
|
1004
1024
|
|
|
1005
1025
|
#### Parameters
|
|
1006
1026
|
|
|
@@ -1022,7 +1042,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-t
|
|
|
1022
1042
|
|
|
1023
1043
|
> **runSync**(`params`?): `any`
|
|
1024
1044
|
|
|
1025
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1045
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:295](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L295)
|
|
1026
1046
|
|
|
1027
1047
|
#### Parameters
|
|
1028
1048
|
|
|
@@ -1040,7 +1060,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-t
|
|
|
1040
1060
|
|
|
1041
1061
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1042
1062
|
|
|
1043
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1063
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:338](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L338)
|
|
1044
1064
|
|
|
1045
1065
|
#### Parameters
|
|
1046
1066
|
|
|
@@ -1058,7 +1078,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-t
|
|
|
1058
1078
|
|
|
1059
1079
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1060
1080
|
|
|
1061
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1081
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:342](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L342)
|
|
1062
1082
|
|
|
1063
1083
|
#### Parameters
|
|
1064
1084
|
|
|
@@ -1080,7 +1100,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-t
|
|
|
1080
1100
|
|
|
1081
1101
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1082
1102
|
|
|
1083
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1103
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:334](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L334)
|
|
1084
1104
|
|
|
1085
1105
|
#### Parameters
|
|
1086
1106
|
|
|
@@ -1102,7 +1122,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-t
|
|
|
1102
1122
|
|
|
1103
1123
|
> **runWithPosSync**(...`params`): `any`
|
|
1104
1124
|
|
|
1105
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1125
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:327](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L327)
|
|
1106
1126
|
|
|
1107
1127
|
#### Parameters
|
|
1108
1128
|
|
|
@@ -1182,7 +1202,7 @@ Returns a string representation of an object.
|
|
|
1182
1202
|
|
|
1183
1203
|
> **unregister**(): `any`
|
|
1184
1204
|
|
|
1185
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1205
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:265](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L265)
|
|
1186
1206
|
|
|
1187
1207
|
#### Returns
|
|
1188
1208
|
|
|
@@ -1524,7 +1544,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
1524
1544
|
|
|
1525
1545
|
> `static` **fetch**(`name`, `objParam`?): `Promise`\<`any`\>
|
|
1526
1546
|
|
|
1527
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:56](https://github.com/isdk/ai-tool.js/blob/
|
|
1547
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:56](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/client-tools.ts#L56)
|
|
1528
1548
|
|
|
1529
1549
|
#### Parameters
|
|
1530
1550
|
|
|
@@ -1672,7 +1692,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
1672
1692
|
|
|
1673
1693
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
1674
1694
|
|
|
1675
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1695
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:61](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L61)
|
|
1676
1696
|
|
|
1677
1697
|
#### Parameters
|
|
1678
1698
|
|
|
@@ -1690,7 +1710,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-to
|
|
|
1690
1710
|
|
|
1691
1711
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
1692
1712
|
|
|
1693
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1713
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:93](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L93)
|
|
1694
1714
|
|
|
1695
1715
|
#### Parameters
|
|
1696
1716
|
|
|
@@ -1708,7 +1728,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-to
|
|
|
1708
1728
|
|
|
1709
1729
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
1710
1730
|
|
|
1711
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1731
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:73](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L73)
|
|
1712
1732
|
|
|
1713
1733
|
#### Parameters
|
|
1714
1734
|
|
|
@@ -1726,7 +1746,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-to
|
|
|
1726
1746
|
|
|
1727
1747
|
> `static` **getFunc**(`name`): `any`
|
|
1728
1748
|
|
|
1729
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1749
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:134](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L134)
|
|
1730
1750
|
|
|
1731
1751
|
#### Parameters
|
|
1732
1752
|
|
|
@@ -1744,7 +1764,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-t
|
|
|
1744
1764
|
|
|
1745
1765
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
1746
1766
|
|
|
1747
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1767
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L155)
|
|
1748
1768
|
|
|
1749
1769
|
#### Parameters
|
|
1750
1770
|
|
|
@@ -1898,7 +1918,7 @@ The object that references the prototype.
|
|
|
1898
1918
|
|
|
1899
1919
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
1900
1920
|
|
|
1901
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1921
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:111](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L111)
|
|
1902
1922
|
|
|
1903
1923
|
#### Parameters
|
|
1904
1924
|
|
|
@@ -2080,7 +2100,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2080
2100
|
|
|
2081
2101
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2082
2102
|
|
|
2083
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2103
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:69](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L69)
|
|
2084
2104
|
|
|
2085
2105
|
#### Returns
|
|
2086
2106
|
|
|
@@ -2092,7 +2112,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-to
|
|
|
2092
2112
|
|
|
2093
2113
|
> `static` **loadFrom**(): `Promise`\<`void`\>
|
|
2094
2114
|
|
|
2095
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
2115
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:29](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/client-tools.ts#L29)
|
|
2096
2116
|
|
|
2097
2117
|
#### Returns
|
|
2098
2118
|
|
|
@@ -2104,7 +2124,7 @@ Defined in: [packages/ai-tool/src/client-tools.ts:29](https://github.com/isdk/ai
|
|
|
2104
2124
|
|
|
2105
2125
|
> `static` **loadFromSync**(`items`): `void`
|
|
2106
2126
|
|
|
2107
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/
|
|
2127
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/client-tools.ts#L41)
|
|
2108
2128
|
|
|
2109
2129
|
#### Parameters
|
|
2110
2130
|
|
|
@@ -2150,7 +2170,7 @@ Object to make non-extensible.
|
|
|
2150
2170
|
|
|
2151
2171
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2152
2172
|
|
|
2153
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2173
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:160](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L160)
|
|
2154
2174
|
|
|
2155
2175
|
##### Parameters
|
|
2156
2176
|
|
|
@@ -2170,7 +2190,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-t
|
|
|
2170
2190
|
|
|
2171
2191
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2172
2192
|
|
|
2173
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2193
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:161](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L161)
|
|
2174
2194
|
|
|
2175
2195
|
##### Parameters
|
|
2176
2196
|
|
|
@@ -2190,7 +2210,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-t
|
|
|
2190
2210
|
|
|
2191
2211
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2192
2212
|
|
|
2193
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2213
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:162](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L162)
|
|
2194
2214
|
|
|
2195
2215
|
##### Parameters
|
|
2196
2216
|
|
|
@@ -2212,7 +2232,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-t
|
|
|
2212
2232
|
|
|
2213
2233
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
2214
2234
|
|
|
2215
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2235
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:118](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L118)
|
|
2216
2236
|
|
|
2217
2237
|
#### Parameters
|
|
2218
2238
|
|
|
@@ -2234,7 +2254,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-t
|
|
|
2234
2254
|
|
|
2235
2255
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
2236
2256
|
|
|
2237
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2257
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:126](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L126)
|
|
2238
2258
|
|
|
2239
2259
|
#### Parameters
|
|
2240
2260
|
|
|
@@ -2256,7 +2276,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-t
|
|
|
2256
2276
|
|
|
2257
2277
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2258
2278
|
|
|
2259
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2279
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:139](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L139)
|
|
2260
2280
|
|
|
2261
2281
|
#### Parameters
|
|
2262
2282
|
|
|
@@ -2278,7 +2298,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-t
|
|
|
2278
2298
|
|
|
2279
2299
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2280
2300
|
|
|
2281
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2301
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:147](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L147)
|
|
2282
2302
|
|
|
2283
2303
|
#### Parameters
|
|
2284
2304
|
|
|
@@ -2326,7 +2346,7 @@ Object on which to lock the attributes.
|
|
|
2326
2346
|
|
|
2327
2347
|
> `static` **setApiRoot**(`v`): `void`
|
|
2328
2348
|
|
|
2329
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
2349
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:23](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/client-tools.ts#L23)
|
|
2330
2350
|
|
|
2331
2351
|
#### Parameters
|
|
2332
2352
|
|
|
@@ -2372,7 +2392,7 @@ The value of the new prototype or null.
|
|
|
2372
2392
|
|
|
2373
2393
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2374
2394
|
|
|
2375
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2395
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:207](https://github.com/isdk/ai-tool.js/blob/077730e62e6c723611b64a587e36b69766741af4/src/tool-func.ts#L207)
|
|
2376
2396
|
|
|
2377
2397
|
#### Parameters
|
|
2378
2398
|
|