@isdk/ai-tool 0.5.4 → 0.5.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/classes/BinarySemaphore.md +25 -25
- package/docs/classes/CancelableAbility.md +25 -25
- package/docs/classes/ClientTools.md +55 -55
- package/docs/classes/EnvPromptTemplate.md +19 -19
- package/docs/classes/EventClient.md +78 -78
- package/docs/classes/EventServer.md +79 -79
- package/docs/classes/EventToolFunc.md +47 -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 +62 -62
- package/docs/classes/ResServerTools.md +63 -63
- package/docs/classes/SSEChannel.md +16 -16
- package/docs/classes/Semaphore.md +26 -26
- package/docs/classes/ServerTools.md +51 -51
- package/docs/classes/SignalGate.md +9 -9
- package/docs/classes/TaskAbortController.md +8 -8
- package/docs/classes/ToolFunc.md +44 -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 +10 -10
- package/docs/interfaces/BaseFuncItem.md +9 -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 +12 -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 +10 -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 +12 -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 +13 -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 +1 -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: ClientTools
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/client-tools.ts#L8)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/client-tools.ts:8](https://github.com/isdk/ai-
|
|
|
22
22
|
|
|
23
23
|
> **new ClientTools**(`name`, `options`): [`ClientTools`](ClientTools.md)
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:192](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:192](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L192)
|
|
26
26
|
|
|
27
27
|
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
28
28
|
|
|
@@ -62,7 +62,7 @@ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-ma
|
|
|
62
62
|
|
|
63
63
|
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
64
64
|
|
|
65
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/
|
|
65
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/utils/consts.ts#L35)
|
|
66
66
|
|
|
67
67
|
#### Inherited from
|
|
68
68
|
|
|
@@ -74,7 +74,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai
|
|
|
74
74
|
|
|
75
75
|
> **apiRoot**: `undefined` \| `string`
|
|
76
76
|
|
|
77
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
77
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:16](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/client-tools.ts#L16)
|
|
78
78
|
|
|
79
79
|
#### Inherited from
|
|
80
80
|
|
|
@@ -118,7 +118,7 @@ The default options for export and assign
|
|
|
118
118
|
|
|
119
119
|
> `optional` **fetchOptions**: `any`
|
|
120
120
|
|
|
121
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/
|
|
121
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/utils/consts.ts#L36)
|
|
122
122
|
|
|
123
123
|
#### Inherited from
|
|
124
124
|
|
|
@@ -130,7 +130,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai
|
|
|
130
130
|
|
|
131
131
|
> `optional` **isApi**: `boolean`
|
|
132
132
|
|
|
133
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
133
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L29)
|
|
134
134
|
|
|
135
135
|
#### Inherited from
|
|
136
136
|
|
|
@@ -142,7 +142,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
|
|
|
142
142
|
|
|
143
143
|
> `optional` **name**: `string`
|
|
144
144
|
|
|
145
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
145
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L23)
|
|
146
146
|
|
|
147
147
|
#### Inherited from
|
|
148
148
|
|
|
@@ -168,7 +168,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
168
168
|
|
|
169
169
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
170
170
|
|
|
171
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
171
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L24)
|
|
172
172
|
|
|
173
173
|
#### Inherited from
|
|
174
174
|
|
|
@@ -180,7 +180,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-to
|
|
|
180
180
|
|
|
181
181
|
> `optional` **result**: `string`
|
|
182
182
|
|
|
183
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
183
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L25)
|
|
184
184
|
|
|
185
185
|
#### Inherited from
|
|
186
186
|
|
|
@@ -192,7 +192,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-to
|
|
|
192
192
|
|
|
193
193
|
> `optional` **scope**: `any`
|
|
194
194
|
|
|
195
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
195
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L26)
|
|
196
196
|
|
|
197
197
|
#### Inherited from
|
|
198
198
|
|
|
@@ -204,7 +204,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
|
|
|
204
204
|
|
|
205
205
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
206
206
|
|
|
207
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
207
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L28)
|
|
208
208
|
|
|
209
209
|
#### Parameters
|
|
210
210
|
|
|
@@ -230,7 +230,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
230
230
|
|
|
231
231
|
> `optional` **stream**: `boolean`
|
|
232
232
|
|
|
233
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/
|
|
233
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L30)
|
|
234
234
|
|
|
235
235
|
#### Inherited from
|
|
236
236
|
|
|
@@ -242,7 +242,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
|
|
|
242
242
|
|
|
243
243
|
> `optional` **tags**: `string` \| `string`[]
|
|
244
244
|
|
|
245
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
245
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L27)
|
|
246
246
|
|
|
247
247
|
#### Inherited from
|
|
248
248
|
|
|
@@ -254,7 +254,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-to
|
|
|
254
254
|
|
|
255
255
|
> `static` **dataPath**: `string`
|
|
256
256
|
|
|
257
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/
|
|
257
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L57)
|
|
258
258
|
|
|
259
259
|
#### Inherited from
|
|
260
260
|
|
|
@@ -266,7 +266,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-to
|
|
|
266
266
|
|
|
267
267
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
268
268
|
|
|
269
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/
|
|
269
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L56)
|
|
270
270
|
|
|
271
271
|
#### Inherited from
|
|
272
272
|
|
|
@@ -280,7 +280,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-to
|
|
|
280
280
|
|
|
281
281
|
> **get** `static` **apiRoot**(): `undefined` \| `string`
|
|
282
282
|
|
|
283
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:19](https://github.com/isdk/ai-tool.js/blob/
|
|
283
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:19](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/client-tools.ts#L19)
|
|
284
284
|
|
|
285
285
|
##### Returns
|
|
286
286
|
|
|
@@ -296,7 +296,7 @@ Defined in: [packages/ai-tool/src/client-tools.ts:19](https://github.com/isdk/ai
|
|
|
296
296
|
|
|
297
297
|
> **arr2ObjParams**(`params`): `any`[]
|
|
298
298
|
|
|
299
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/
|
|
299
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L236)
|
|
300
300
|
|
|
301
301
|
#### Parameters
|
|
302
302
|
|
|
@@ -568,7 +568,7 @@ the defined attributes of the object
|
|
|
568
568
|
|
|
569
569
|
> **errorFrom**(`res`): `Promise`\<[`CommonError`](CommonError.md)\>
|
|
570
570
|
|
|
571
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:118](https://github.com/isdk/ai-tool.js/blob/
|
|
571
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:118](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/client-tools.ts#L118)
|
|
572
572
|
|
|
573
573
|
#### Parameters
|
|
574
574
|
|
|
@@ -618,7 +618,7 @@ the dest object.
|
|
|
618
618
|
|
|
619
619
|
> **fetch**(`objParam`?, `act`?, `subName`?): `Promise`\<`Response`\>
|
|
620
620
|
|
|
621
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:74](https://github.com/isdk/ai-tool.js/blob/
|
|
621
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:74](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/client-tools.ts#L74)
|
|
622
622
|
|
|
623
623
|
#### Parameters
|
|
624
624
|
|
|
@@ -644,7 +644,7 @@ Defined in: [packages/ai-tool/src/client-tools.ts:74](https://github.com/isdk/ai
|
|
|
644
644
|
|
|
645
645
|
> **func**(`objParam`): `Promise`\<`any`\>
|
|
646
646
|
|
|
647
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:149](https://github.com/isdk/ai-tool.js/blob/
|
|
647
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:149](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/client-tools.ts#L149)
|
|
648
648
|
|
|
649
649
|
#### Parameters
|
|
650
650
|
|
|
@@ -666,7 +666,7 @@ Defined in: [packages/ai-tool/src/client-tools.ts:149](https://github.com/isdk/a
|
|
|
666
666
|
|
|
667
667
|
> **getFunc**(`name`?): `any`
|
|
668
668
|
|
|
669
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-tool.js/blob/
|
|
669
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L289)
|
|
670
670
|
|
|
671
671
|
#### Parameters
|
|
672
672
|
|
|
@@ -688,7 +688,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-t
|
|
|
688
688
|
|
|
689
689
|
> **getFuncWithPos**(`name`?): `any`
|
|
690
690
|
|
|
691
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/
|
|
691
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L313)
|
|
692
692
|
|
|
693
693
|
#### Parameters
|
|
694
694
|
|
|
@@ -730,7 +730,7 @@ the descriptors of properties object
|
|
|
730
730
|
|
|
731
731
|
> **getUrlParams**(`objParam`): `string`
|
|
732
732
|
|
|
733
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:63](https://github.com/isdk/ai-tool.js/blob/
|
|
733
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:63](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/client-tools.ts#L63)
|
|
734
734
|
|
|
735
735
|
#### Parameters
|
|
736
736
|
|
|
@@ -748,7 +748,7 @@ Defined in: [packages/ai-tool/src/client-tools.ts:63](https://github.com/isdk/ai
|
|
|
748
748
|
|
|
749
749
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
750
750
|
|
|
751
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:318](https://github.com/isdk/ai-tool.js/blob/
|
|
751
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:318](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L318)
|
|
752
752
|
|
|
753
753
|
#### Parameters
|
|
754
754
|
|
|
@@ -878,7 +878,7 @@ The source object
|
|
|
878
878
|
|
|
879
879
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
880
880
|
|
|
881
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:324](https://github.com/isdk/ai-tool.js/blob/
|
|
881
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:324](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L324)
|
|
882
882
|
|
|
883
883
|
#### Parameters
|
|
884
884
|
|
|
@@ -932,7 +932,7 @@ the dest object.
|
|
|
932
932
|
|
|
933
933
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
934
934
|
|
|
935
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:249](https://github.com/isdk/ai-tool.js/blob/
|
|
935
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:249](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L249)
|
|
936
936
|
|
|
937
937
|
#### Parameters
|
|
938
938
|
|
|
@@ -980,7 +980,7 @@ A property name.
|
|
|
980
980
|
|
|
981
981
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
982
982
|
|
|
983
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-tool.js/blob/
|
|
983
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L219)
|
|
984
984
|
|
|
985
985
|
#### Returns
|
|
986
986
|
|
|
@@ -996,7 +996,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-t
|
|
|
996
996
|
|
|
997
997
|
> **run**(`params`?): `Promise`\<`any`\>
|
|
998
998
|
|
|
999
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-tool.js/blob/
|
|
999
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L276)
|
|
1000
1000
|
|
|
1001
1001
|
#### Parameters
|
|
1002
1002
|
|
|
@@ -1018,7 +1018,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-t
|
|
|
1018
1018
|
|
|
1019
1019
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
1020
1020
|
|
|
1021
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-tool.js/blob/
|
|
1021
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L280)
|
|
1022
1022
|
|
|
1023
1023
|
#### Parameters
|
|
1024
1024
|
|
|
@@ -1044,7 +1044,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-t
|
|
|
1044
1044
|
|
|
1045
1045
|
> **runAsSync**(`name`, `params`?): `any`
|
|
1046
1046
|
|
|
1047
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-tool.js/blob/
|
|
1047
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L284)
|
|
1048
1048
|
|
|
1049
1049
|
#### Parameters
|
|
1050
1050
|
|
|
@@ -1070,7 +1070,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-t
|
|
|
1070
1070
|
|
|
1071
1071
|
> **runSync**(`params`?): `any`
|
|
1072
1072
|
|
|
1073
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-tool.js/blob/
|
|
1073
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L262)
|
|
1074
1074
|
|
|
1075
1075
|
#### Parameters
|
|
1076
1076
|
|
|
@@ -1092,7 +1092,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-t
|
|
|
1092
1092
|
|
|
1093
1093
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1094
1094
|
|
|
1095
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/
|
|
1095
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L305)
|
|
1096
1096
|
|
|
1097
1097
|
#### Parameters
|
|
1098
1098
|
|
|
@@ -1114,7 +1114,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-t
|
|
|
1114
1114
|
|
|
1115
1115
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1116
1116
|
|
|
1117
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/
|
|
1117
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L309)
|
|
1118
1118
|
|
|
1119
1119
|
#### Parameters
|
|
1120
1120
|
|
|
@@ -1140,7 +1140,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-t
|
|
|
1140
1140
|
|
|
1141
1141
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1142
1142
|
|
|
1143
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-tool.js/blob/
|
|
1143
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L301)
|
|
1144
1144
|
|
|
1145
1145
|
#### Parameters
|
|
1146
1146
|
|
|
@@ -1166,7 +1166,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-t
|
|
|
1166
1166
|
|
|
1167
1167
|
> **runWithPosSync**(...`params`): `any`
|
|
1168
1168
|
|
|
1169
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/
|
|
1169
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L294)
|
|
1170
1170
|
|
|
1171
1171
|
#### Parameters
|
|
1172
1172
|
|
|
@@ -1266,7 +1266,7 @@ Returns a string representation of an object.
|
|
|
1266
1266
|
|
|
1267
1267
|
> **unregister**(): `any`
|
|
1268
1268
|
|
|
1269
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:232](https://github.com/isdk/ai-tool.js/blob/
|
|
1269
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:232](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L232)
|
|
1270
1270
|
|
|
1271
1271
|
#### Returns
|
|
1272
1272
|
|
|
@@ -1656,7 +1656,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
1656
1656
|
|
|
1657
1657
|
> `static` **fetch**(`name`, `objParam`?): `Promise`\<`any`\>
|
|
1658
1658
|
|
|
1659
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:56](https://github.com/isdk/ai-tool.js/blob/
|
|
1659
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:56](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/client-tools.ts#L56)
|
|
1660
1660
|
|
|
1661
1661
|
#### Parameters
|
|
1662
1662
|
|
|
@@ -1824,7 +1824,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
1824
1824
|
|
|
1825
1825
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
1826
1826
|
|
|
1827
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/
|
|
1827
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L59)
|
|
1828
1828
|
|
|
1829
1829
|
#### Parameters
|
|
1830
1830
|
|
|
@@ -1846,7 +1846,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-to
|
|
|
1846
1846
|
|
|
1847
1847
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
1848
1848
|
|
|
1849
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-tool.js/blob/
|
|
1849
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L87)
|
|
1850
1850
|
|
|
1851
1851
|
#### Parameters
|
|
1852
1852
|
|
|
@@ -1868,7 +1868,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-to
|
|
|
1868
1868
|
|
|
1869
1869
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
1870
1870
|
|
|
1871
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-tool.js/blob/
|
|
1871
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L67)
|
|
1872
1872
|
|
|
1873
1873
|
#### Parameters
|
|
1874
1874
|
|
|
@@ -1890,7 +1890,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-to
|
|
|
1890
1890
|
|
|
1891
1891
|
> `static` **getFunc**(`name`): `any`
|
|
1892
1892
|
|
|
1893
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-tool.js/blob/
|
|
1893
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L128)
|
|
1894
1894
|
|
|
1895
1895
|
#### Parameters
|
|
1896
1896
|
|
|
@@ -1912,7 +1912,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-t
|
|
|
1912
1912
|
|
|
1913
1913
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
1914
1914
|
|
|
1915
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:149](https://github.com/isdk/ai-tool.js/blob/
|
|
1915
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:149](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L149)
|
|
1916
1916
|
|
|
1917
1917
|
#### Parameters
|
|
1918
1918
|
|
|
@@ -2094,7 +2094,7 @@ The object that references the prototype.
|
|
|
2094
2094
|
|
|
2095
2095
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2096
2096
|
|
|
2097
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:105](https://github.com/isdk/ai-tool.js/blob/
|
|
2097
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:105](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L105)
|
|
2098
2098
|
|
|
2099
2099
|
#### Parameters
|
|
2100
2100
|
|
|
@@ -2308,7 +2308,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2308
2308
|
|
|
2309
2309
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2310
2310
|
|
|
2311
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-tool.js/blob/
|
|
2311
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L63)
|
|
2312
2312
|
|
|
2313
2313
|
#### Returns
|
|
2314
2314
|
|
|
@@ -2324,7 +2324,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-to
|
|
|
2324
2324
|
|
|
2325
2325
|
> `static` **loadFrom**(): `Promise`\<`void`\>
|
|
2326
2326
|
|
|
2327
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
2327
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:29](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/client-tools.ts#L29)
|
|
2328
2328
|
|
|
2329
2329
|
#### Returns
|
|
2330
2330
|
|
|
@@ -2336,7 +2336,7 @@ Defined in: [packages/ai-tool/src/client-tools.ts:29](https://github.com/isdk/ai
|
|
|
2336
2336
|
|
|
2337
2337
|
> `static` **loadFromSync**(`items`): `void`
|
|
2338
2338
|
|
|
2339
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/
|
|
2339
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/client-tools.ts#L41)
|
|
2340
2340
|
|
|
2341
2341
|
#### Parameters
|
|
2342
2342
|
|
|
@@ -2386,7 +2386,7 @@ Object to make non-extensible.
|
|
|
2386
2386
|
|
|
2387
2387
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2388
2388
|
|
|
2389
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-tool.js/blob/
|
|
2389
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L154)
|
|
2390
2390
|
|
|
2391
2391
|
##### Parameters
|
|
2392
2392
|
|
|
@@ -2410,7 +2410,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-t
|
|
|
2410
2410
|
|
|
2411
2411
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2412
2412
|
|
|
2413
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/
|
|
2413
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L155)
|
|
2414
2414
|
|
|
2415
2415
|
##### Parameters
|
|
2416
2416
|
|
|
@@ -2434,7 +2434,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-t
|
|
|
2434
2434
|
|
|
2435
2435
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2436
2436
|
|
|
2437
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-tool.js/blob/
|
|
2437
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L156)
|
|
2438
2438
|
|
|
2439
2439
|
##### Parameters
|
|
2440
2440
|
|
|
@@ -2460,7 +2460,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-t
|
|
|
2460
2460
|
|
|
2461
2461
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
2462
2462
|
|
|
2463
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-tool.js/blob/
|
|
2463
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L112)
|
|
2464
2464
|
|
|
2465
2465
|
#### Parameters
|
|
2466
2466
|
|
|
@@ -2486,7 +2486,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-t
|
|
|
2486
2486
|
|
|
2487
2487
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
2488
2488
|
|
|
2489
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-tool.js/blob/
|
|
2489
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L120)
|
|
2490
2490
|
|
|
2491
2491
|
#### Parameters
|
|
2492
2492
|
|
|
@@ -2512,7 +2512,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-t
|
|
|
2512
2512
|
|
|
2513
2513
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2514
2514
|
|
|
2515
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-tool.js/blob/
|
|
2515
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L133)
|
|
2516
2516
|
|
|
2517
2517
|
#### Parameters
|
|
2518
2518
|
|
|
@@ -2538,7 +2538,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-t
|
|
|
2538
2538
|
|
|
2539
2539
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2540
2540
|
|
|
2541
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:141](https://github.com/isdk/ai-tool.js/blob/
|
|
2541
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:141](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L141)
|
|
2542
2542
|
|
|
2543
2543
|
#### Parameters
|
|
2544
2544
|
|
|
@@ -2594,7 +2594,7 @@ Object on which to lock the attributes.
|
|
|
2594
2594
|
|
|
2595
2595
|
> `static` **setApiRoot**(`v`): `void`
|
|
2596
2596
|
|
|
2597
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
2597
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:23](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/client-tools.ts#L23)
|
|
2598
2598
|
|
|
2599
2599
|
#### Parameters
|
|
2600
2600
|
|
|
@@ -2644,7 +2644,7 @@ The value of the new prototype or null.
|
|
|
2644
2644
|
|
|
2645
2645
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2646
2646
|
|
|
2647
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/
|
|
2647
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/83a1524a1644365964efc043a7a7991d8fd46b49/src/tool-func.ts#L184)
|
|
2648
2648
|
|
|
2649
2649
|
#### Parameters
|
|
2650
2650
|
|