@isdk/ai-tool 0.5.3 → 0.5.4
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
package/docs/classes/ToolFunc.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ToolFunc
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:51](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:51](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L51)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -28,7 +28,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:51](https://github.com/isdk/ai-to
|
|
|
28
28
|
|
|
29
29
|
> **new ToolFunc**(`name`, `options`): [`ToolFunc`](ToolFunc.md)
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:192](https://github.com/isdk/ai-tool.js/blob/
|
|
31
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:192](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L192)
|
|
32
32
|
|
|
33
33
|
#### Parameters
|
|
34
34
|
|
|
@@ -90,7 +90,7 @@ The default options for export and assign
|
|
|
90
90
|
|
|
91
91
|
> `optional` **isApi**: `boolean`
|
|
92
92
|
|
|
93
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
93
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L29)
|
|
94
94
|
|
|
95
95
|
#### Inherited from
|
|
96
96
|
|
|
@@ -102,7 +102,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
|
|
|
102
102
|
|
|
103
103
|
> `optional` **name**: `string`
|
|
104
104
|
|
|
105
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
105
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L23)
|
|
106
106
|
|
|
107
107
|
#### Inherited from
|
|
108
108
|
|
|
@@ -124,7 +124,7 @@ the property with the default prefix '$' will not be exported.
|
|
|
124
124
|
|
|
125
125
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
126
126
|
|
|
127
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
127
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L24)
|
|
128
128
|
|
|
129
129
|
#### Inherited from
|
|
130
130
|
|
|
@@ -136,7 +136,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-to
|
|
|
136
136
|
|
|
137
137
|
> `optional` **result**: `string`
|
|
138
138
|
|
|
139
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
139
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L25)
|
|
140
140
|
|
|
141
141
|
#### Inherited from
|
|
142
142
|
|
|
@@ -148,7 +148,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-to
|
|
|
148
148
|
|
|
149
149
|
> `optional` **scope**: `any`
|
|
150
150
|
|
|
151
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
151
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L26)
|
|
152
152
|
|
|
153
153
|
#### Inherited from
|
|
154
154
|
|
|
@@ -160,7 +160,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
|
|
|
160
160
|
|
|
161
161
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
162
162
|
|
|
163
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
163
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L28)
|
|
164
164
|
|
|
165
165
|
#### Parameters
|
|
166
166
|
|
|
@@ -186,7 +186,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
186
186
|
|
|
187
187
|
> `optional` **stream**: `boolean`
|
|
188
188
|
|
|
189
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/
|
|
189
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L30)
|
|
190
190
|
|
|
191
191
|
#### Inherited from
|
|
192
192
|
|
|
@@ -198,7 +198,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
|
|
|
198
198
|
|
|
199
199
|
> `optional` **tags**: `string` \| `string`[]
|
|
200
200
|
|
|
201
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
201
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L27)
|
|
202
202
|
|
|
203
203
|
#### Inherited from
|
|
204
204
|
|
|
@@ -210,7 +210,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-to
|
|
|
210
210
|
|
|
211
211
|
> `static` **dataPath**: `string`
|
|
212
212
|
|
|
213
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/
|
|
213
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L57)
|
|
214
214
|
|
|
215
215
|
***
|
|
216
216
|
|
|
@@ -218,7 +218,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-to
|
|
|
218
218
|
|
|
219
219
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
220
220
|
|
|
221
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/
|
|
221
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L56)
|
|
222
222
|
|
|
223
223
|
## Methods
|
|
224
224
|
|
|
@@ -226,7 +226,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-to
|
|
|
226
226
|
|
|
227
227
|
> **arr2ObjParams**(`params`): `any`[]
|
|
228
228
|
|
|
229
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/
|
|
229
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:236](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L236)
|
|
230
230
|
|
|
231
231
|
#### Parameters
|
|
232
232
|
|
|
@@ -494,7 +494,7 @@ the dest object.
|
|
|
494
494
|
|
|
495
495
|
> **func**(...`params`): `any`
|
|
496
496
|
|
|
497
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
497
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:38](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L38)
|
|
498
498
|
|
|
499
499
|
#### Parameters
|
|
500
500
|
|
|
@@ -516,7 +516,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:38](https://github.com/isdk/ai-to
|
|
|
516
516
|
|
|
517
517
|
> **getFunc**(`name`?): `any`
|
|
518
518
|
|
|
519
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-tool.js/blob/
|
|
519
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L289)
|
|
520
520
|
|
|
521
521
|
#### Parameters
|
|
522
522
|
|
|
@@ -534,7 +534,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-t
|
|
|
534
534
|
|
|
535
535
|
> **getFuncWithPos**(`name`?): `any`
|
|
536
536
|
|
|
537
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/
|
|
537
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L313)
|
|
538
538
|
|
|
539
539
|
#### Parameters
|
|
540
540
|
|
|
@@ -568,7 +568,7 @@ the descriptors of properties object
|
|
|
568
568
|
|
|
569
569
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
570
570
|
|
|
571
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:318](https://github.com/isdk/ai-tool.js/blob/
|
|
571
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:318](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L318)
|
|
572
572
|
|
|
573
573
|
#### Parameters
|
|
574
574
|
|
|
@@ -678,7 +678,7 @@ The source object
|
|
|
678
678
|
|
|
679
679
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
680
680
|
|
|
681
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:324](https://github.com/isdk/ai-tool.js/blob/
|
|
681
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:324](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L324)
|
|
682
682
|
|
|
683
683
|
#### Parameters
|
|
684
684
|
|
|
@@ -724,7 +724,7 @@ the dest object.
|
|
|
724
724
|
|
|
725
725
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
726
726
|
|
|
727
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:249](https://github.com/isdk/ai-tool.js/blob/
|
|
727
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:249](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L249)
|
|
728
728
|
|
|
729
729
|
#### Parameters
|
|
730
730
|
|
|
@@ -764,7 +764,7 @@ A property name.
|
|
|
764
764
|
|
|
765
765
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
766
766
|
|
|
767
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-tool.js/blob/
|
|
767
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L219)
|
|
768
768
|
|
|
769
769
|
#### Returns
|
|
770
770
|
|
|
@@ -776,7 +776,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-t
|
|
|
776
776
|
|
|
777
777
|
> **run**(`params`?): `Promise`\<`any`\>
|
|
778
778
|
|
|
779
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-tool.js/blob/
|
|
779
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L276)
|
|
780
780
|
|
|
781
781
|
#### Parameters
|
|
782
782
|
|
|
@@ -794,7 +794,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:276](https://github.com/isdk/ai-t
|
|
|
794
794
|
|
|
795
795
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
796
796
|
|
|
797
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-tool.js/blob/
|
|
797
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L280)
|
|
798
798
|
|
|
799
799
|
#### Parameters
|
|
800
800
|
|
|
@@ -816,7 +816,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:280](https://github.com/isdk/ai-t
|
|
|
816
816
|
|
|
817
817
|
> **runAsSync**(`name`, `params`?): `any`
|
|
818
818
|
|
|
819
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-tool.js/blob/
|
|
819
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L284)
|
|
820
820
|
|
|
821
821
|
#### Parameters
|
|
822
822
|
|
|
@@ -838,7 +838,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:284](https://github.com/isdk/ai-t
|
|
|
838
838
|
|
|
839
839
|
> **runSync**(`params`?): `any`
|
|
840
840
|
|
|
841
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-tool.js/blob/
|
|
841
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L262)
|
|
842
842
|
|
|
843
843
|
#### Parameters
|
|
844
844
|
|
|
@@ -856,7 +856,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:262](https://github.com/isdk/ai-t
|
|
|
856
856
|
|
|
857
857
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
858
858
|
|
|
859
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/
|
|
859
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L305)
|
|
860
860
|
|
|
861
861
|
#### Parameters
|
|
862
862
|
|
|
@@ -874,7 +874,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-t
|
|
|
874
874
|
|
|
875
875
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
876
876
|
|
|
877
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/
|
|
877
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L309)
|
|
878
878
|
|
|
879
879
|
#### Parameters
|
|
880
880
|
|
|
@@ -896,7 +896,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-t
|
|
|
896
896
|
|
|
897
897
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
898
898
|
|
|
899
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-tool.js/blob/
|
|
899
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L301)
|
|
900
900
|
|
|
901
901
|
#### Parameters
|
|
902
902
|
|
|
@@ -918,7 +918,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:301](https://github.com/isdk/ai-t
|
|
|
918
918
|
|
|
919
919
|
> **runWithPosSync**(...`params`): `any`
|
|
920
920
|
|
|
921
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/
|
|
921
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L294)
|
|
922
922
|
|
|
923
923
|
#### Parameters
|
|
924
924
|
|
|
@@ -998,7 +998,7 @@ Returns a string representation of an object.
|
|
|
998
998
|
|
|
999
999
|
> **unregister**(): `any`
|
|
1000
1000
|
|
|
1001
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:232](https://github.com/isdk/ai-tool.js/blob/
|
|
1001
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:232](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L232)
|
|
1002
1002
|
|
|
1003
1003
|
#### Returns
|
|
1004
1004
|
|
|
@@ -1466,7 +1466,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
1466
1466
|
|
|
1467
1467
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
1468
1468
|
|
|
1469
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/
|
|
1469
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L59)
|
|
1470
1470
|
|
|
1471
1471
|
#### Parameters
|
|
1472
1472
|
|
|
@@ -1484,7 +1484,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-to
|
|
|
1484
1484
|
|
|
1485
1485
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
1486
1486
|
|
|
1487
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-tool.js/blob/
|
|
1487
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L87)
|
|
1488
1488
|
|
|
1489
1489
|
#### Parameters
|
|
1490
1490
|
|
|
@@ -1502,7 +1502,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:87](https://github.com/isdk/ai-to
|
|
|
1502
1502
|
|
|
1503
1503
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
1504
1504
|
|
|
1505
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-tool.js/blob/
|
|
1505
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L67)
|
|
1506
1506
|
|
|
1507
1507
|
#### Parameters
|
|
1508
1508
|
|
|
@@ -1520,7 +1520,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:67](https://github.com/isdk/ai-to
|
|
|
1520
1520
|
|
|
1521
1521
|
> `static` **getFunc**(`name`): `any`
|
|
1522
1522
|
|
|
1523
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-tool.js/blob/
|
|
1523
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L128)
|
|
1524
1524
|
|
|
1525
1525
|
#### Parameters
|
|
1526
1526
|
|
|
@@ -1538,7 +1538,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:128](https://github.com/isdk/ai-t
|
|
|
1538
1538
|
|
|
1539
1539
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
1540
1540
|
|
|
1541
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:149](https://github.com/isdk/ai-tool.js/blob/
|
|
1541
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:149](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L149)
|
|
1542
1542
|
|
|
1543
1543
|
#### Parameters
|
|
1544
1544
|
|
|
@@ -1692,7 +1692,7 @@ The object that references the prototype.
|
|
|
1692
1692
|
|
|
1693
1693
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
1694
1694
|
|
|
1695
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:105](https://github.com/isdk/ai-tool.js/blob/
|
|
1695
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:105](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L105)
|
|
1696
1696
|
|
|
1697
1697
|
#### Parameters
|
|
1698
1698
|
|
|
@@ -1874,7 +1874,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
1874
1874
|
|
|
1875
1875
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
1876
1876
|
|
|
1877
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-tool.js/blob/
|
|
1877
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:63](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L63)
|
|
1878
1878
|
|
|
1879
1879
|
#### Returns
|
|
1880
1880
|
|
|
@@ -1914,7 +1914,7 @@ Object to make non-extensible.
|
|
|
1914
1914
|
|
|
1915
1915
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
1916
1916
|
|
|
1917
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-tool.js/blob/
|
|
1917
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L154)
|
|
1918
1918
|
|
|
1919
1919
|
##### Parameters
|
|
1920
1920
|
|
|
@@ -1934,7 +1934,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:154](https://github.com/isdk/ai-t
|
|
|
1934
1934
|
|
|
1935
1935
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
1936
1936
|
|
|
1937
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/
|
|
1937
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L155)
|
|
1938
1938
|
|
|
1939
1939
|
##### Parameters
|
|
1940
1940
|
|
|
@@ -1954,7 +1954,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-t
|
|
|
1954
1954
|
|
|
1955
1955
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
1956
1956
|
|
|
1957
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-tool.js/blob/
|
|
1957
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L156)
|
|
1958
1958
|
|
|
1959
1959
|
##### Parameters
|
|
1960
1960
|
|
|
@@ -1976,7 +1976,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:156](https://github.com/isdk/ai-t
|
|
|
1976
1976
|
|
|
1977
1977
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
1978
1978
|
|
|
1979
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-tool.js/blob/
|
|
1979
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L112)
|
|
1980
1980
|
|
|
1981
1981
|
#### Parameters
|
|
1982
1982
|
|
|
@@ -1998,7 +1998,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:112](https://github.com/isdk/ai-t
|
|
|
1998
1998
|
|
|
1999
1999
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
2000
2000
|
|
|
2001
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-tool.js/blob/
|
|
2001
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L120)
|
|
2002
2002
|
|
|
2003
2003
|
#### Parameters
|
|
2004
2004
|
|
|
@@ -2020,7 +2020,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:120](https://github.com/isdk/ai-t
|
|
|
2020
2020
|
|
|
2021
2021
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2022
2022
|
|
|
2023
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-tool.js/blob/
|
|
2023
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L133)
|
|
2024
2024
|
|
|
2025
2025
|
#### Parameters
|
|
2026
2026
|
|
|
@@ -2042,7 +2042,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:133](https://github.com/isdk/ai-t
|
|
|
2042
2042
|
|
|
2043
2043
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2044
2044
|
|
|
2045
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:141](https://github.com/isdk/ai-tool.js/blob/
|
|
2045
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:141](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L141)
|
|
2046
2046
|
|
|
2047
2047
|
#### Parameters
|
|
2048
2048
|
|
|
@@ -2118,7 +2118,7 @@ The value of the new prototype or null.
|
|
|
2118
2118
|
|
|
2119
2119
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2120
2120
|
|
|
2121
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/
|
|
2121
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:184](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L184)
|
|
2122
2122
|
|
|
2123
2123
|
#### Parameters
|
|
2124
2124
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: YamlTypeBaseObject
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/yaml-type-base-object.ts:3](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/yaml-type-base-object.ts:3](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/yaml-type-base-object.ts#L3)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/ai-tool/src/utils/yaml-type-base-object.ts:3](https://gith
|
|
|
18
18
|
|
|
19
19
|
> **new YamlTypeBaseObject**(`options`?): [`YamlTypeBaseObject`](YamlTypeBaseObject.md)
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/ai-tool/src/utils/yaml-type-base-object.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
21
|
+
Defined in: [packages/ai-tool/src/utils/yaml-type-base-object.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/yaml-type-base-object.ts#L5)
|
|
22
22
|
|
|
23
23
|
#### Parameters
|
|
24
24
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Enumeration: AsyncFeatureBits
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:14](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L14)
|
|
10
10
|
|
|
11
11
|
## Enumeration Members
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:14](https://github
|
|
|
14
14
|
|
|
15
15
|
> **Cancelable**: `1`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:16](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L16)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:16](https://github
|
|
|
22
22
|
|
|
23
23
|
> **MultiTask**: `0`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:15](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:15](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L15)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,4 +30,4 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:15](https://github
|
|
|
30
30
|
|
|
31
31
|
> **Priority**: `2`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:17](https://github.com/isdk/ai-tool.js/blob/
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:17](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L17)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Enumeration: AsyncFeatures
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:21](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:21](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L21)
|
|
10
10
|
|
|
11
11
|
## Enumeration Members
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:21](https://github
|
|
|
14
14
|
|
|
15
15
|
> **Cancelable**: `2`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L23)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:23](https://github
|
|
|
22
22
|
|
|
23
23
|
> **MultiTask**: `1`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:22](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:22](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L22)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,4 +30,4 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:22](https://github
|
|
|
30
30
|
|
|
31
31
|
> **Priority**: `4`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L24)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Enumeration: HashAlgorithm
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L5)
|
|
10
10
|
|
|
11
11
|
## Enumeration Members
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/utils/hash/const.ts:5](https://github.com/isdk
|
|
|
14
14
|
|
|
15
15
|
> **md5**: `1`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:6](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:6](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L6)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/utils/hash/const.ts:6](https://github.com/isdk
|
|
|
22
22
|
|
|
23
23
|
> **ripemd**: `3`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:8](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:8](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L8)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/ai-tool/src/utils/hash/const.ts:8](https://github.com/isdk
|
|
|
30
30
|
|
|
31
31
|
> **sha1**: `2`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:7](https://github.com/isdk/ai-tool.js/blob/
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:7](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L7)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/ai-tool/src/utils/hash/const.ts:7](https://github.com/isdk
|
|
|
38
38
|
|
|
39
39
|
> **sha224**: `11`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
41
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L12)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/ai-tool/src/utils/hash/const.ts:12](https://github.com/isd
|
|
|
46
46
|
|
|
47
47
|
> **sha256**: `8`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
49
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L9)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -54,7 +54,7 @@ Defined in: [packages/ai-tool/src/utils/hash/const.ts:9](https://github.com/isdk
|
|
|
54
54
|
|
|
55
55
|
> **sha384**: `9`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
57
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L10)
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
@@ -62,7 +62,7 @@ Defined in: [packages/ai-tool/src/utils/hash/const.ts:10](https://github.com/isd
|
|
|
62
62
|
|
|
63
63
|
> **sha512**: `10`
|
|
64
64
|
|
|
65
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
65
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:11](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L11)
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
@@ -70,7 +70,7 @@ Defined in: [packages/ai-tool/src/utils/hash/const.ts:11](https://github.com/isd
|
|
|
70
70
|
|
|
71
71
|
> **xxhash**: `111`
|
|
72
72
|
|
|
73
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
73
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:13](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L13)
|
|
74
74
|
|
|
75
75
|
***
|
|
76
76
|
|
|
@@ -78,7 +78,7 @@ Defined in: [packages/ai-tool/src/utils/hash/const.ts:13](https://github.com/isd
|
|
|
78
78
|
|
|
79
79
|
> **xxhash128**: `113`
|
|
80
80
|
|
|
81
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
81
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:16](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L16)
|
|
82
82
|
|
|
83
83
|
***
|
|
84
84
|
|
|
@@ -86,7 +86,7 @@ Defined in: [packages/ai-tool/src/utils/hash/const.ts:16](https://github.com/isd
|
|
|
86
86
|
|
|
87
87
|
> **xxhash32**: `112`
|
|
88
88
|
|
|
89
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:15](https://github.com/isdk/ai-tool.js/blob/
|
|
89
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:15](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L15)
|
|
90
90
|
|
|
91
91
|
***
|
|
92
92
|
|
|
@@ -94,4 +94,4 @@ Defined in: [packages/ai-tool/src/utils/hash/const.ts:15](https://github.com/isd
|
|
|
94
94
|
|
|
95
95
|
> **xxhash64**: `111`
|
|
96
96
|
|
|
97
|
-
Defined in: [packages/ai-tool/src/utils/hash/const.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
97
|
+
Defined in: [packages/ai-tool/src/utils/hash/const.ts:14](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/const.ts#L14)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **AIArgProcessor**(`argInfo`, `ix`, `scope`?, `options`?): `Promise`\<`undefined` \| `string`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/parse-command.ts:187](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:187](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L187)
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **AIStream**\<`T`, `TOptions`\>(`response`, `customParser`?): `ReadableStream`\<[`AIResult`](../interfaces/AIResult.md)\<`T`, `TOptions`\>\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:120](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:120](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/stream/ai-stream.ts#L120)
|
|
12
12
|
|
|
13
13
|
Returns a ReadableStream created from the response, parsed and handled with custom logic.
|
|
14
14
|
The stream goes through two transformation stages, first parsing the events and then
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **ChoiceArgProcessor**(`argInfo`, `_ix`, `scope`?, `options`?): `undefined` \| `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/parse-command.ts:155](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:155](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L155)
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **ObjectArgsToArgsInfo**(`args`): `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/parse-command.ts:86](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:86](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L86)
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **RateLimit**(`rps`, `__namedParameters`): () => `Promise`\<`void`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:476](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:476](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L476)
|
|
12
12
|
|
|
13
13
|
Creates a rate limiter function that blocks with a promise whenever the rate limit is hit and resolves the promise once the call rate is within the limit set by rps. The second argument is optional.
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **TemplateArgProcessor**(`__namedParameters`, `ix`, `scope`?, `options`?): `Promise`\<`undefined` \| `string`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/parse-command.ts:162](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:162](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L162)
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|