@isdk/ai-tool 0.5.8 → 0.7.0
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/README.cn.md +103 -237
- package/README.md +101 -186
- package/dist/chunk-LNTIQQNN.mjs +1 -0
- package/dist/chunk-VIG2GB47.mjs +1 -1
- package/dist/funcs.d.mts +1 -1
- package/dist/funcs.d.ts +1 -1
- package/dist/funcs.js +1 -1
- package/dist/funcs.mjs +1 -1
- package/dist/index-BCco-g_I.d.mts +1781 -0
- package/dist/index-BCco-g_I.d.ts +1781 -0
- package/dist/index.d.mts +1083 -650
- package/dist/index.d.ts +1083 -650
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/test/util.js +1 -1
- package/docs/api/README.md +165 -0
- package/docs/{_media → api/_media}/CONTRIBUTING.md +3 -3
- package/docs/api/_media/pubsub.md +326 -0
- package/docs/api/_media/server_client_tools.md +88 -0
- package/docs/api/_media/toolFunc.md +183 -0
- package/docs/api/_media/transport.md +137 -0
- package/docs/{classes → api/classes}/AbortError.md +139 -54
- package/docs/api/classes/AlreadyExistsError.md +431 -0
- package/docs/api/classes/BaseError.md +440 -0
- package/docs/{classes → api/classes}/BinarySemaphore.md +25 -25
- package/docs/{classes → api/classes}/CancelableAbility.md +25 -25
- package/docs/api/classes/ClientToolTransport.md +310 -0
- package/docs/{classes → api/classes}/ClientTools.md +642 -180
- package/docs/{classes → api/classes}/CommonError.md +139 -54
- package/docs/api/classes/ConfigFile.md +218 -0
- package/docs/{classes → api/classes}/EnvPromptTemplate.md +308 -65
- package/docs/{classes → api/classes}/EventClient.md +725 -232
- package/docs/{classes → api/classes}/EventEmitter.md +12 -12
- package/docs/{classes → api/classes}/EventServer.md +658 -205
- package/docs/{classes → api/classes}/EventToolFunc.md +561 -109
- package/docs/{classes → api/classes}/FStringPromptTemplate.md +309 -66
- package/docs/{classes → api/classes}/FewShotPromptTemplate.md +290 -63
- package/docs/{classes → api/classes}/GolangPromptTemplate.md +308 -65
- package/docs/api/classes/HttpClientToolTransport.md +324 -0
- package/docs/api/classes/HttpServerToolTransport.md +324 -0
- package/docs/{classes → api/classes}/IntSet.md +12 -12
- package/docs/{classes → api/classes}/LRUCache.md +26 -26
- package/docs/api/classes/NotFoundError.md +431 -0
- package/docs/api/classes/NotImplementationError.md +431 -0
- package/docs/{classes → api/classes}/PromptExampleSelector.md +9 -9
- package/docs/{classes → api/classes}/PromptTemplate.md +303 -63
- package/docs/api/classes/ReadableStreamError.md +451 -0
- package/docs/api/classes/ResClientTools.md +2878 -0
- package/docs/api/classes/ResServerTools.md +2856 -0
- package/docs/api/classes/SSEChannel.md +272 -0
- package/docs/{classes → api/classes}/Semaphore.md +26 -26
- package/docs/api/classes/ServerToolTransport.md +323 -0
- package/docs/{classes → api/classes}/ServerTools.md +579 -120
- package/docs/{classes → api/classes}/SignalGate.md +9 -9
- package/docs/api/classes/SseClientPubSubTransport.md +92 -0
- package/docs/api/classes/SseServerPubSubTransport.md +234 -0
- package/docs/{classes → api/classes}/TaskAbortController.md +9 -9
- package/docs/api/classes/ToolFunc.md +2665 -0
- package/docs/api/classes/ToolTransport.md +143 -0
- package/docs/api/classes/YamlTypeBaseObject.md +31 -0
- package/docs/api/enumerations/AsyncFeatureBits.md +33 -0
- package/docs/api/enumerations/AsyncFeatures.md +33 -0
- package/docs/api/enumerations/ErrorCode.md +177 -0
- package/docs/api/enumerations/HashAlgorithm.md +97 -0
- package/docs/{functions → api/functions}/AIArgProcessor.md +1 -1
- package/docs/{functions → api/functions}/AIStream.md +1 -1
- package/docs/{functions → api/functions}/ChoiceArgProcessor.md +1 -1
- package/docs/api/functions/DefaultDateFormat.md +21 -0
- package/docs/{functions → api/functions}/ObjectArgsToArgsInfo.md +1 -1
- package/docs/{functions → api/functions}/RateLimit.md +1 -1
- package/docs/{functions → api/functions}/TemplateArgProcessor.md +1 -1
- package/docs/api/functions/addDate.md +71 -0
- package/docs/{functions → api/functions}/assignDirs.md +1 -1
- package/docs/{functions → api/functions}/backendEventable.md +1 -1
- package/docs/{functions → api/functions}/beforeShutdown.md +1 -1
- package/docs/api/functions/calcPerplexity.md +60 -0
- package/docs/api/functions/calcPerplexitySimple.md +42 -0
- package/docs/api/functions/canonicalize.md +33 -0
- package/docs/{functions → api/functions}/completeSentences.md +1 -1
- package/docs/{functions → api/functions}/concatText.md +1 -1
- package/docs/{functions → api/functions}/countLLMTokens.md +1 -1
- package/docs/{functions → api/functions}/countRegexMatches.md +1 -1
- package/docs/{functions → api/functions}/createAbilityInjector.md +4 -4
- package/docs/{functions → api/functions}/createCallbacksTransformer.md +1 -1
- package/docs/{functions → api/functions}/createEmptyReadableStream.md +1 -1
- package/docs/{functions → api/functions}/createEndWithRepetitionDetector.md +1 -1
- package/docs/{functions → api/functions}/createError.md +1 -1
- package/docs/{functions → api/functions}/createEventStreamTransformer.md +1 -1
- package/docs/{functions → api/functions}/createHfValueFunc.md +1 -1
- package/docs/{functions → api/functions}/createLRUCache.md +1 -1
- package/docs/{functions → api/functions}/createYamlObjectTag.md +1 -1
- package/docs/{functions → api/functions}/dateToText.md +1 -1
- package/docs/{functions → api/functions}/decodeCharset.md +1 -1
- package/docs/api/functions/defaultsWithConcat.md +74 -0
- package/docs/{functions → api/functions}/detectCharset.md +1 -1
- package/docs/{functions → api/functions}/encodeLLMTokens.md +1 -1
- package/docs/{functions → api/functions}/ensureQuoted.md +1 -1
- package/docs/{functions → api/functions}/eventable.md +1 -1
- package/docs/api/functions/expandConfig.md +25 -0
- package/docs/{functions → api/functions}/expandEnv.md +4 -4
- package/docs/{functions → api/functions}/expandObjEnv.md +4 -4
- package/docs/{functions → api/functions}/expandPath.md +1 -1
- package/docs/api/functions/expandPathInObject.md +29 -0
- package/docs/api/functions/expandPaths.md +25 -0
- package/docs/{functions → api/functions}/extNameLevel.md +1 -1
- package/docs/{functions → api/functions}/fileIsExists.md +1 -1
- package/docs/{functions → api/functions}/filterValidFnScope.md +1 -1
- package/docs/{functions → api/functions}/findIndexNonEmptyFrom.md +1 -1
- package/docs/{functions → api/functions}/findPort.md +1 -1
- package/docs/{functions → api/functions}/formatISO.md +1 -1
- package/docs/{functions → api/functions}/formatTextWithSpace.md +1 -1
- package/docs/api/functions/funcGetMeta.md +27 -0
- package/docs/api/functions/funcWithMeta.md +41 -0
- package/docs/api/functions/genUrlParamsStr.md +27 -0
- package/docs/{functions → api/functions}/getAllEnumKeys.md +1 -1
- package/docs/{functions → api/functions}/getConfigFileNames.md +1 -1
- package/docs/{functions → api/functions}/getConfigs.md +1 -1
- package/docs/{functions → api/functions}/getEnvVairables.md +1 -1
- package/docs/{functions → api/functions}/getFileMetaInfo.md +1 -1
- package/docs/{functions → api/functions}/getHashAlgoBySize.md +1 -1
- package/docs/{functions → api/functions}/getKeysPath.md +1 -1
- package/docs/{functions → api/functions}/getLLMTokenizer.md +1 -1
- package/docs/{functions → api/functions}/getMultiLevelExtname.md +4 -4
- package/docs/{functions → api/functions}/getPackageDir.md +1 -1
- package/docs/{functions → api/functions}/getRealFilepath.md +1 -1
- package/docs/{functions → api/functions}/getResponseErrorReadableStream.md +1 -1
- package/docs/{functions → api/functions}/getXDGConfigs.md +1 -1
- package/docs/{functions → api/functions}/hasDirectoryIn.md +1 -1
- package/docs/{functions → api/functions}/hash.md +1 -1
- package/docs/{functions → api/functions}/hashFile.md +1 -1
- package/docs/api/functions/hashObject.md +25 -0
- package/docs/{functions → api/functions}/hashStream.md +1 -1
- package/docs/api/functions/initShutdown.md +15 -0
- package/docs/{functions → api/functions}/isLangUsingSpaces.md +1 -1
- package/docs/{functions → api/functions}/isListItemString.md +1 -1
- package/docs/{functions → api/functions}/isModelNameMatched.md +1 -1
- package/docs/{functions → api/functions}/isPunctuationChar.md +1 -1
- package/docs/{functions → api/functions}/isQuoted.md +1 -1
- package/docs/{functions → api/functions}/isRegExp.md +1 -1
- package/docs/{functions → api/functions}/isSameString.md +1 -1
- package/docs/{functions → api/functions}/isSectionString.md +1 -1
- package/docs/{functions → api/functions}/isSentenceEnding.md +1 -1
- package/docs/{functions → api/functions}/isSepLineString.md +1 -1
- package/docs/{functions → api/functions}/isStrWrapped.md +1 -1
- package/docs/{functions → api/functions}/isSubdirectory.md +2 -2
- package/docs/{functions → api/functions}/isTitleString.md +1 -1
- package/docs/{functions → api/functions}/isValidFilename.md +1 -1
- package/docs/{functions → api/functions}/isValidFilepath.md +1 -1
- package/docs/{functions → api/functions}/isWebStream.md +1 -1
- package/docs/api/functions/joinSplitWords.md +46 -0
- package/docs/{functions → api/functions}/jsonFilterToWhere.md +1 -1
- package/docs/{functions → api/functions}/jsonToMarkdownStr.md +9 -1
- package/docs/{functions → api/functions}/loadAIConfig.md +1 -1
- package/docs/{functions → api/functions}/loadConfig.md +1 -1
- package/docs/{functions → api/functions}/loadConfigFile.md +1 -1
- package/docs/{functions → api/functions}/loadFileFromPaths.md +1 -1
- package/docs/{functions → api/functions}/loadTextFromPaths.md +1 -1
- package/docs/{functions → api/functions}/lrucache.md +1 -1
- package/docs/{functions → api/functions}/makeToolFuncCancelable.md +1 -1
- package/docs/{functions → api/functions}/matchUrlProtocol.md +1 -1
- package/docs/{functions → api/functions}/memoize.md +1 -1
- package/docs/api/functions/mergeArray.md +57 -0
- package/docs/{functions → api/functions}/messagesToText.md +1 -1
- package/docs/api/functions/normalizePath.md +21 -0
- package/docs/{functions → api/functions}/paramsSizeToScaleStr.md +1 -1
- package/docs/{functions → api/functions}/parseCommand.md +1 -1
- package/docs/{functions → api/functions}/parseDateFormat.md +1 -1
- package/docs/{functions → api/functions}/parseISO.md +1 -1
- package/docs/{functions → api/functions}/parseJsJson.md +1 -1
- package/docs/{functions → api/functions}/parseJsJsonSimpleSync.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArgInfo.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArgumentInfos.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArguments.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArgumentsAsArgInfos.md +1 -1
- package/docs/api/functions/parseYaml.md +45 -0
- package/docs/api/functions/pruneSubdirectories.md +35 -0
- package/docs/api/functions/pruneSubdirectoriesInPlace.md +38 -0
- package/docs/{functions → api/functions}/quoteStr.md +1 -1
- package/docs/{functions → api/functions}/readFilenamesRecursiveSync.md +7 -1
- package/docs/{functions → api/functions}/readTextFileChunks.md +1 -1
- package/docs/{functions → api/functions}/readTextFileChunksEx.md +1 -1
- package/docs/{functions → api/functions}/readableFromAsyncIterable.md +1 -1
- package/docs/{functions → api/functions}/registerCoreTools.md +1 -1
- package/docs/api/functions/registerYamlTag.md +37 -0
- package/docs/{functions → api/functions}/removeMarkdownBold.md +1 -1
- package/docs/{functions → api/functions}/removeMarkdownBoldAndItalic.md +1 -1
- package/docs/{functions → api/functions}/removeMarkdownItalic.md +1 -1
- package/docs/{functions → api/functions}/replaceWithPlaceholder.md +1 -1
- package/docs/{functions → api/functions}/restoreFromPlacehoders.md +1 -1
- package/docs/{functions → api/functions}/sanitizeFilename.md +4 -4
- package/docs/{functions → api/functions}/sanitizeFilepath.md +4 -4
- package/docs/{functions → api/functions}/saveConfigFile.md +1 -1
- package/docs/{functions → api/functions}/scaleStrToParamsSize.md +1 -1
- package/docs/{functions → api/functions}/shutdown.md +1 -1
- package/docs/{functions → api/functions}/simplifyObjectArguments.md +1 -1
- package/docs/api/functions/sleep.md +36 -0
- package/docs/{functions → api/functions}/sortedValues.md +1 -1
- package/docs/{functions → api/functions}/splitChunks.md +1 -1
- package/docs/{functions → api/functions}/splitParagraph.md +1 -1
- package/docs/{functions → api/functions}/splitSentence.md +1 -1
- package/docs/api/functions/splitWords.md +42 -0
- package/docs/api/functions/stringifyYaml.md +45 -0
- package/docs/{functions → api/functions}/stripConsoleColor.md +1 -1
- package/docs/{functions → api/functions}/textToDate.md +1 -1
- package/docs/{functions → api/functions}/throwError.md +3 -3
- package/docs/{functions → api/functions}/toDate.md +1 -1
- package/docs/{functions → api/functions}/toDateTime.md +1 -1
- package/docs/{functions → api/functions}/toRegExp.md +1 -1
- package/docs/{functions → api/functions}/trimStartOfStreamHelper.md +1 -1
- package/docs/{functions → api/functions}/truncTo.md +1 -1
- package/docs/{functions → api/functions}/truncateByToken.md +1 -1
- package/docs/{functions → api/functions}/truncateToTokenLimit.md +1 -1
- package/docs/{functions → api/functions}/truncateToTokenLimitEx.md +1 -1
- package/docs/{functions → api/functions}/uuid.md +1 -1
- package/docs/{functions → api/functions}/uuidParse.md +1 -1
- package/docs/{functions → api/functions}/uuidStringify.md +1 -1
- package/docs/{functions → api/functions}/uuidValidate.md +1 -1
- package/docs/{functions → api/functions}/uuidVersion.md +1 -1
- package/docs/{functions → api/functions}/uuidv1.md +9 -5
- package/docs/{functions → api/functions}/uuidv4.md +9 -5
- package/docs/{functions → api/functions}/uuidv5.md +9 -5
- package/docs/api/functions/wait.md +45 -0
- package/docs/{functions → api/functions}/wrapEventEmitter.md +1 -1
- package/docs/{functions → api/functions}/xxhash.md +1 -1
- package/docs/{functions → api/functions}/xxhash32.md +1 -1
- package/docs/{functions → api/functions}/xxhash64.md +1 -1
- package/docs/{functions → api/functions}/xxhashAsStr.md +1 -1
- package/docs/api/functions/yieldExec.md +27 -0
- package/docs/{globals.md → api/globals.md} +44 -24
- package/docs/api/interfaces/AIChatAssistantMessageParam.md +129 -0
- package/docs/api/interfaces/AIChatContentPartImage.md +29 -0
- package/docs/api/interfaces/AIChatContentPartText.md +25 -0
- package/docs/api/interfaces/AIChatMessageParamBase.md +68 -0
- package/docs/api/interfaces/AIChatMessageToolCall.md +41 -0
- package/docs/{interfaces → api/interfaces}/AIChatSystemMessageParam.md +9 -9
- package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +37 -0
- package/docs/api/interfaces/AIChatToolChoiceObject.md +25 -0
- package/docs/api/interfaces/AIChatToolFunc.md +41 -0
- package/docs/api/interfaces/AIChatToolFuncParam.md +37 -0
- package/docs/api/interfaces/AIChatToolMessageParam.md +113 -0
- package/docs/api/interfaces/AIChatToolParam.md +25 -0
- package/docs/api/interfaces/AIChatToolTypeObject.md +17 -0
- package/docs/api/interfaces/AIChatUserMessageParam.md +137 -0
- package/docs/api/interfaces/AIChoiceConfig.md +65 -0
- package/docs/api/interfaces/AIResult.md +65 -0
- package/docs/{interfaces → api/interfaces}/AIStreamParser.md +2 -2
- package/docs/api/interfaces/AIStreamParserOptions.md +21 -0
- package/docs/api/interfaces/BaseFunc.md +299 -0
- package/docs/api/interfaces/BaseFuncItem.md +221 -0
- package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
- package/docs/api/interfaces/BinarySemaphoreOptions.md +57 -0
- package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
- package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
- package/docs/api/interfaces/CancelableAbilityOptions.md +113 -0
- package/docs/api/interfaces/ClientFuncItem.md +326 -0
- package/docs/api/interfaces/EventClientFuncParams.md +51 -0
- package/docs/api/interfaces/EventServerFuncParams.md +73 -0
- package/docs/api/interfaces/FewShotPromptTemplateOptions.md +159 -0
- package/docs/api/interfaces/FuncItem.md +281 -0
- package/docs/api/interfaces/FuncParam.md +51 -0
- package/docs/api/interfaces/FuncParams.md +28 -0
- package/docs/api/interfaces/Funcs.md +15 -0
- package/docs/api/interfaces/HashAlgoParams.md +33 -0
- package/docs/api/interfaces/IClientToolTransport.md +155 -0
- package/docs/api/interfaces/IFileMetaInfo.md +65 -0
- package/docs/api/interfaces/IPubSubClientTransport.md +70 -0
- package/docs/api/interfaces/IPubSubServerTransport.md +241 -0
- package/docs/{interfaces → api/interfaces}/IReadTextFileChunksOptions.md +12 -12
- package/docs/api/interfaces/IServerToolTransport.md +159 -0
- package/docs/api/interfaces/IToolTransport.md +73 -0
- package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +99 -0
- package/docs/api/interfaces/JsonFilter.md +13 -0
- package/docs/api/interfaces/ParseObjectArgumentOptions.md +89 -0
- package/docs/api/interfaces/ProbabilityItem.md +41 -0
- package/docs/api/interfaces/PromptExampleSelectorOptions.md +34 -0
- package/docs/api/interfaces/PromptTemplateOptions.md +73 -0
- package/docs/api/interfaces/PubSubClient.md +27 -0
- package/docs/api/interfaces/PubSubClientStream.md +196 -0
- package/docs/api/interfaces/PubSubServerSession.md +103 -0
- package/docs/api/interfaces/RemoteFuncItem.md +316 -0
- package/docs/api/interfaces/ReplacePlacehoderOptions.md +41 -0
- package/docs/api/interfaces/ResClientFuncParams.md +37 -0
- package/docs/api/interfaces/ResServerFuncParams.md +73 -0
- package/docs/api/interfaces/SanitizeFilenameOptions.md +25 -0
- package/docs/api/interfaces/SectionStringOptions.md +25 -0
- package/docs/api/interfaces/SemaphoreOptions.md +89 -0
- package/docs/api/interfaces/SemaphoreTaskItem.md +73 -0
- package/docs/api/interfaces/ServerFuncItem.md +339 -0
- package/docs/api/interfaces/ServerFuncParams.md +41 -0
- package/docs/api/interfaces/SplitSentenceOptions.md +41 -0
- package/docs/{interfaces → api/interfaces}/StreamCallbacksAndOptions.md +5 -5
- package/docs/{interfaces → api/interfaces}/TaskAbortControllers.md +1 -1
- package/docs/{interfaces → api/interfaces}/TaskPromise.md +6 -6
- package/docs/api/interfaces/ToolFuncPackage.md +57 -0
- package/docs/{namespaces → api/namespaces}/EventStates/variables/ABORT.md +1 -1
- package/docs/{namespaces → api/namespaces}/EventStates/variables/CONTINUE.md +1 -1
- package/docs/{namespaces → api/namespaces}/EventStates/variables/DONE.md +1 -1
- package/docs/{namespaces → api/namespaces}/EventStates/variables/STOPPED.md +1 -1
- package/docs/{namespaces → api/namespaces}/uuidv5/variables/DNS.md +1 -1
- package/docs/{namespaces → api/namespaces}/uuidv5/variables/URL.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatContentPart.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatMessageParam.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatRole.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatToolChoiceParam.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIMessageType.md +1 -1
- package/docs/api/type-aliases/AIModelNameRule.md +14 -0
- package/docs/api/type-aliases/AIModelNameRuleFn.md +28 -0
- package/docs/api/type-aliases/AIModelNameRules.md +13 -0
- package/docs/{type-aliases → api/type-aliases}/AITextGenerationFinishReason.md +1 -1
- package/docs/api/type-aliases/ActionName.md +13 -0
- package/docs/api/type-aliases/ArrayMergeWay.md +11 -0
- package/docs/api/type-aliases/AsyncTaskId.md +11 -0
- package/docs/{type-aliases → api/type-aliases}/BeforeShutdownListener.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/EventErrorListenerFn.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/EventListenerFn.md +1 -1
- package/docs/api/type-aliases/FuncParamType.md +13 -0
- package/docs/{type-aliases → api/type-aliases}/PromptExamples.md +1 -1
- package/docs/api/type-aliases/PubSubClientId.md +14 -0
- package/docs/api/type-aliases/PubSubCtx.md +37 -0
- package/docs/api/type-aliases/RpcMethodHandler.md +34 -0
- package/docs/{type-aliases → api/type-aliases}/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/api/type-aliases/TFunc.md +33 -0
- package/docs/{variables → api/variables}/AIChatRoles.md +1 -1
- package/docs/{variables → api/variables}/AIMessageTypes.md +1 -1
- package/docs/{variables → api/variables}/AITextGenerationFinishReasons.md +1 -1
- package/docs/{variables → api/variables}/AbortErrorCode.md +1 -1
- package/docs/api/variables/ActionNames.md +13 -0
- package/docs/{variables → api/variables}/AlreadyExistsErrorCode.md +1 -1
- package/docs/api/variables/ArrayMergeWay.md +25 -0
- package/docs/api/variables/ArrayMergeWaySymbol.md +11 -0
- package/docs/api/variables/ClientToolFuncSchema.md +83 -0
- package/docs/{variables → api/variables}/DEFAULT_CONFIG_NAME.md +1 -1
- package/docs/{variables → api/variables}/DefaultAsyncSemaphoreCapacity.md +1 -1
- package/docs/api/variables/EventBusName.md +11 -0
- package/docs/api/variables/EventName.md +11 -0
- package/docs/{variables → api/variables}/FilenameReservedRegex.md +1 -1
- package/docs/api/variables/FuncMetaSymbol.md +15 -0
- package/docs/{variables → api/variables}/InternalErrorCode.md +1 -1
- package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES.md +1 -1
- package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES_MAP.md +1 -1
- package/docs/{variables → api/variables}/NotFoundErrorCode.md +1 -1
- package/docs/{variables → api/variables}/NotImplementedErrorCode.md +1 -1
- package/docs/api/variables/PASSING_SCORE.md +13 -0
- package/docs/api/variables/RStreamErrCode.md +11 -0
- package/docs/api/variables/RemoteToolFuncSchema.md +84 -0
- package/docs/api/variables/ResponseRStreamErrCode.md +11 -0
- package/docs/{variables → api/variables}/SHUTDOWN_SIGNALS.md +1 -1
- package/docs/{variables → api/variables}/SSEChannelAlreadyClosedErrCode.md +1 -1
- package/docs/api/variables/SecondaryCache.md +11 -0
- package/docs/api/variables/ServerToolFuncSchema.md +83 -0
- package/docs/api/variables/StrangeHumanName.md +11 -0
- package/docs/api/variables/ToolAsyncCancelableBit.md +11 -0
- package/docs/api/variables/ToolAsyncMultiTaskBit.md +11 -0
- package/docs/api/variables/ToolAsyncPriorityBit.md +11 -0
- package/docs/{variables → api/variables}/ToolFuncSchema.md +14 -1
- package/docs/{variables → api/variables}/WindowsReservedNameRegex.md +1 -1
- package/docs/api/variables/base32768.md +11 -0
- package/docs/api/variables/defaultTemplateFormat.md +11 -0
- package/docs/api/variables/event.md +11 -0
- package/docs/api/variables/eventClient.md +11 -0
- package/docs/api/variables/eventServer.md +11 -0
- package/docs/api/variables/lrucache.md +11 -0
- package/docs/{variables → api/variables}/mimeType.md +1 -1
- package/docs/{variables → api/variables}/uuidNIL.md +1 -1
- package/docs/pubsub.md +326 -0
- package/docs/server_client_tools.md +88 -0
- package/docs/toolFunc.md +183 -0
- package/docs/transport.md +137 -0
- package/package.json +38 -38
- package/dist/chunk-YVFGQB4L.mjs +0 -1
- package/dist/index-BkwhCK1q.d.mts +0 -899
- package/dist/index-BkwhCK1q.d.ts +0 -899
- package/docs/README.md +0 -250
- package/docs/classes/AlreadyExistsError.md +0 -346
- package/docs/classes/BaseError.md +0 -359
- package/docs/classes/ConfigFile.md +0 -353
- package/docs/classes/HFEnvironment.md +0 -184
- package/docs/classes/HFInterpreter.md +0 -77
- package/docs/classes/HFTemplate.md +0 -67
- package/docs/classes/HfPromptTemplate.md +0 -1158
- package/docs/classes/NotFoundError.md +0 -346
- package/docs/classes/NotImplementationError.md +0 -346
- package/docs/classes/ReadableStreamError.md +0 -366
- package/docs/classes/ResClientTools.md +0 -2451
- package/docs/classes/ResServerTools.md +0 -2427
- package/docs/classes/SSEChannel.md +0 -270
- package/docs/classes/ToolFunc.md +0 -2201
- package/docs/classes/YamlTypeBaseObject.md +0 -31
- package/docs/enumerations/AsyncFeatureBits.md +0 -33
- package/docs/enumerations/AsyncFeatures.md +0 -33
- package/docs/enumerations/ErrorCode.md +0 -177
- package/docs/enumerations/HashAlgorithm.md +0 -97
- package/docs/functions/canonicalize.md +0 -21
- package/docs/functions/expandConfig.md +0 -25
- package/docs/functions/filenameReservedRegex.md +0 -20
- package/docs/functions/hfParse.md +0 -24
- package/docs/functions/hfTokenize.md +0 -27
- package/docs/functions/initShutdown.md +0 -15
- package/docs/functions/interpolateEnv.md +0 -29
- package/docs/functions/interpolateFString.md +0 -29
- package/docs/functions/interpolateGolangTemplate.md +0 -35
- package/docs/functions/parseFString.md +0 -26
- package/docs/functions/parseYaml.md +0 -25
- package/docs/functions/reControlCharsRegex.md +0 -19
- package/docs/functions/registerYamlTag.md +0 -21
- package/docs/functions/stringifyYaml.md +0 -25
- package/docs/functions/wait.md +0 -21
- package/docs/interfaces/AIChatAssistantMessageParam.md +0 -129
- package/docs/interfaces/AIChatContentPartImage.md +0 -29
- package/docs/interfaces/AIChatContentPartText.md +0 -25
- package/docs/interfaces/AIChatMessageParamBase.md +0 -68
- package/docs/interfaces/AIChatMessageToolCall.md +0 -41
- package/docs/interfaces/AIChatToolChoiceFuncObject.md +0 -37
- package/docs/interfaces/AIChatToolChoiceObject.md +0 -25
- package/docs/interfaces/AIChatToolFunc.md +0 -41
- package/docs/interfaces/AIChatToolFuncParam.md +0 -37
- package/docs/interfaces/AIChatToolMessageParam.md +0 -113
- package/docs/interfaces/AIChatToolParam.md +0 -25
- package/docs/interfaces/AIChatToolTypeObject.md +0 -17
- package/docs/interfaces/AIChatUserMessageParam.md +0 -137
- package/docs/interfaces/AIChoiceConfig.md +0 -65
- package/docs/interfaces/AIResult.md +0 -65
- package/docs/interfaces/AIStreamParserOptions.md +0 -21
- package/docs/interfaces/BaseFunc.md +0 -157
- package/docs/interfaces/BaseFuncItem.md +0 -101
- package/docs/interfaces/BinarySemaphoreAcquireOptions.md +0 -25
- package/docs/interfaces/BinarySemaphoreOptions.md +0 -57
- package/docs/interfaces/BinarySemaphoreReleaseOptions.md +0 -25
- package/docs/interfaces/BinarySemaphoreReleaserFunc.md +0 -37
- package/docs/interfaces/CancelableAbilityOptions.md +0 -113
- package/docs/interfaces/ClientFuncItem.md +0 -175
- package/docs/interfaces/DotenvExpandOptions.md +0 -43
- package/docs/interfaces/DotenvExpandOutput.md +0 -25
- package/docs/interfaces/DotenvParseInput.md +0 -13
- package/docs/interfaces/DotenvParseOutput.md +0 -13
- package/docs/interfaces/DotenvPopulateInput.md +0 -13
- package/docs/interfaces/EventClientFuncParams.md +0 -51
- package/docs/interfaces/EventServerFuncParams.md +0 -67
- package/docs/interfaces/FewShotPromptTemplateOptions.md +0 -147
- package/docs/interfaces/FuncItem.md +0 -143
- package/docs/interfaces/FuncParam.md +0 -61
- package/docs/interfaces/FuncParams.md +0 -13
- package/docs/interfaces/Funcs.md +0 -13
- package/docs/interfaces/HashAlgoParams.md +0 -33
- package/docs/interfaces/IFileMetaInfo.md +0 -65
- package/docs/interfaces/ITruncateToTokenLimitOptions.md +0 -99
- package/docs/interfaces/JsonFilter.md +0 -13
- package/docs/interfaces/ParseObjectArgumentOptions.md +0 -89
- package/docs/interfaces/PromptExampleSelectorOptions.md +0 -34
- package/docs/interfaces/PromptTemplateOptions.md +0 -65
- package/docs/interfaces/RemoteFuncItem.md +0 -164
- package/docs/interfaces/ReplacePlacehoderOptions.md +0 -41
- package/docs/interfaces/ResClientFuncParams.md +0 -37
- package/docs/interfaces/ResServerFuncParams.md +0 -69
- package/docs/interfaces/SanitizeFilenameOptions.md +0 -25
- package/docs/interfaces/SectionStringOptions.md +0 -25
- package/docs/interfaces/SemaphoreOptions.md +0 -89
- package/docs/interfaces/SemaphoreTaskItem.md +0 -73
- package/docs/interfaces/ServerFuncItem.md +0 -183
- package/docs/interfaces/ServerFuncParams.md +0 -35
- package/docs/interfaces/SplitSentenceOptions.md +0 -41
- package/docs/interfaces/ToolFuncPackage.md +0 -47
- package/docs/type-aliases/AIModelNameRule.md +0 -11
- package/docs/type-aliases/AIModelNameRuleFn.md +0 -21
- package/docs/type-aliases/AIModelNameRules.md +0 -11
- package/docs/type-aliases/ActionName.md +0 -11
- package/docs/type-aliases/AsyncTaskId.md +0 -11
- package/docs/type-aliases/FStringPromptTemplateNode.md +0 -14
- package/docs/type-aliases/FuncParamType.md +0 -11
- package/docs/type-aliases/PromptTemplateType.md +0 -11
- package/docs/type-aliases/PromptType.md +0 -11
- package/docs/type-aliases/TFunc.md +0 -25
- package/docs/variables/ActionNames.md +0 -11
- package/docs/variables/ClientToolFuncSchema.md +0 -101
- package/docs/variables/EventBusName.md +0 -11
- package/docs/variables/EventName.md +0 -11
- package/docs/variables/HFBuiltins.md +0 -122
- package/docs/variables/PASSING_SCORE.md +0 -11
- package/docs/variables/PromptTemplateTypes.md +0 -11
- package/docs/variables/PromptTypes.md +0 -14
- package/docs/variables/RStreamErrCode.md +0 -11
- package/docs/variables/RemoteToolFuncSchema.md +0 -101
- package/docs/variables/ResponseRStreamErrCode.md +0 -11
- package/docs/variables/SecondaryCache.md +0 -11
- package/docs/variables/ServerToolFuncSchema.md +0 -101
- package/docs/variables/ToolAsyncCancelableBit.md +0 -11
- package/docs/variables/ToolAsyncMultiTaskBit.md +0 -11
- package/docs/variables/ToolAsyncPriorityBit.md +0 -11
- package/docs/variables/base32768.md +0 -11
- package/docs/variables/defaultTemplateFormat.md +0 -11
- package/docs/variables/event.md +0 -11
- package/docs/variables/eventClient.md +0 -11
- package/docs/variables/eventServer.md +0 -11
- package/docs/variables/lrucache.md +0 -11
- /package/docs/{_media → api/_media}/LICENSE-MIT +0 -0
- /package/docs/{namespaces → api/namespaces}/EventStates/README.md +0 -0
- /package/docs/{namespaces → api/namespaces}/uuidv5/README.md +0 -0
|
@@ -6,7 +6,13 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ServerTools
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L41)
|
|
10
|
+
|
|
11
|
+
Represents a function that runs on a server and can be exposed to clients.
|
|
12
|
+
|
|
13
|
+
`ServerTools` extends `ToolFunc` by adding logic for serialization and handling
|
|
14
|
+
server-side execution contexts. It is designed to work with a transport layer
|
|
15
|
+
(see `transports`) to expose its registered functions over a network.
|
|
10
16
|
|
|
11
17
|
## Extends
|
|
12
18
|
|
|
@@ -20,9 +26,9 @@ Defined in: [packages/ai-tool/src/server-tools.ts:17](https://github.com/isdk/ai
|
|
|
20
26
|
|
|
21
27
|
### new ServerTools()
|
|
22
28
|
|
|
23
|
-
> **new ServerTools**(`name`, `options
|
|
29
|
+
> **new ServerTools**(`name`, `options`?): [`ServerTools`](ServerTools.md)
|
|
24
30
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
31
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:571](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L571)
|
|
26
32
|
|
|
27
33
|
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
28
34
|
|
|
@@ -30,12 +36,16 @@ The initial value of Object.prototype.constructor is the standard built-in Objec
|
|
|
30
36
|
|
|
31
37
|
##### name
|
|
32
38
|
|
|
39
|
+
Can be a function name, a function implementation, or a configuration object.
|
|
40
|
+
|
|
33
41
|
`string` | `Function` | [`FuncItem`](../interfaces/FuncItem.md)
|
|
34
42
|
|
|
35
|
-
##### options
|
|
43
|
+
##### options?
|
|
36
44
|
|
|
37
45
|
`any` = `{}`
|
|
38
46
|
|
|
47
|
+
Configuration options if not provided in the first argument.
|
|
48
|
+
|
|
39
49
|
#### Returns
|
|
40
50
|
|
|
41
51
|
[`ServerTools`](ServerTools.md)
|
|
@@ -50,7 +60,7 @@ The initial value of Object.prototype.constructor is the standard built-in Objec
|
|
|
50
60
|
|
|
51
61
|
> **$attributes**: `Properties`
|
|
52
62
|
|
|
53
|
-
Defined in:
|
|
63
|
+
Defined in: [property-manager.js/src/advance.d.ts:5](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L5)
|
|
54
64
|
|
|
55
65
|
#### Inherited from
|
|
56
66
|
|
|
@@ -62,7 +72,10 @@ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-ma
|
|
|
62
72
|
|
|
63
73
|
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
64
74
|
|
|
65
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:
|
|
75
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L95)
|
|
76
|
+
|
|
77
|
+
The action to be used for the remote call. This typically represents an RPC method name.
|
|
78
|
+
Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
|
|
66
79
|
|
|
67
80
|
#### Inherited from
|
|
68
81
|
|
|
@@ -74,7 +87,9 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai
|
|
|
74
87
|
|
|
75
88
|
> `optional` **alias**: `string` \| `string`[]
|
|
76
89
|
|
|
77
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
90
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L130)
|
|
91
|
+
|
|
92
|
+
Optional aliases for the function name.
|
|
78
93
|
|
|
79
94
|
#### Inherited from
|
|
80
95
|
|
|
@@ -86,7 +101,11 @@ Defined in: [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-to
|
|
|
86
101
|
|
|
87
102
|
> `optional` **allowExportFunc**: `boolean`
|
|
88
103
|
|
|
89
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:
|
|
104
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:35](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L35)
|
|
105
|
+
|
|
106
|
+
If set to true, the body of the function (`func`) will be serialized and sent
|
|
107
|
+
to the client when tools are loaded. This allows the client to execute the
|
|
108
|
+
function locally instead of making a remote call. Defaults to false.
|
|
90
109
|
|
|
91
110
|
#### Inherited from
|
|
92
111
|
|
|
@@ -94,11 +113,17 @@ Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai
|
|
|
94
113
|
|
|
95
114
|
***
|
|
96
115
|
|
|
97
|
-
### apiRoot
|
|
116
|
+
### ~~apiRoot?~~
|
|
98
117
|
|
|
99
118
|
> `optional` **apiRoot**: `string`
|
|
100
119
|
|
|
101
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:
|
|
120
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L89)
|
|
121
|
+
|
|
122
|
+
The root endpoint for the remote service.
|
|
123
|
+
|
|
124
|
+
#### Deprecated
|
|
125
|
+
|
|
126
|
+
Use `transport` instead.
|
|
102
127
|
|
|
103
128
|
#### Inherited from
|
|
104
129
|
|
|
@@ -106,11 +131,41 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai
|
|
|
106
131
|
|
|
107
132
|
***
|
|
108
133
|
|
|
134
|
+
### asyncFeatures?
|
|
135
|
+
|
|
136
|
+
> `optional` **asyncFeatures**: `number`
|
|
137
|
+
|
|
138
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L144)
|
|
139
|
+
|
|
140
|
+
A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
|
|
141
|
+
This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
|
|
142
|
+
|
|
143
|
+
#### See
|
|
144
|
+
|
|
145
|
+
AsyncFeatureBits from `@src/utils/cancelable-ability.ts`
|
|
146
|
+
|
|
147
|
+
#### Example
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
import { AsyncFeatures } from './utils';
|
|
151
|
+
const func = new ToolFunc({
|
|
152
|
+
name: 'cancellableTask',
|
|
153
|
+
asyncFeatures: AsyncFeatures.Cancelable | AsyncFeatures.MultiTask,
|
|
154
|
+
// ...
|
|
155
|
+
});
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
#### Inherited from
|
|
159
|
+
|
|
160
|
+
[`ToolFunc`](ToolFunc.md).[`asyncFeatures`](ToolFunc.md#asyncfeatures)
|
|
161
|
+
|
|
162
|
+
***
|
|
163
|
+
|
|
109
164
|
### constructor
|
|
110
165
|
|
|
111
166
|
> **constructor**: `Function`
|
|
112
167
|
|
|
113
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:125
|
|
168
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:125
|
|
114
169
|
|
|
115
170
|
The initial value of Object.prototype.constructor is the standard built-in Object constructor.
|
|
116
171
|
|
|
@@ -120,7 +175,7 @@ The initial value of Object.prototype.constructor is the standard built-in Objec
|
|
|
120
175
|
|
|
121
176
|
> **defaultOptions**: `object`
|
|
122
177
|
|
|
123
|
-
Defined in:
|
|
178
|
+
Defined in: [property-manager.js/src/abstract.d.ts:74](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L74)
|
|
124
179
|
|
|
125
180
|
The default options for export and assign
|
|
126
181
|
|
|
@@ -138,11 +193,70 @@ The default options for export and assign
|
|
|
138
193
|
|
|
139
194
|
***
|
|
140
195
|
|
|
141
|
-
###
|
|
196
|
+
### depends?
|
|
197
|
+
|
|
198
|
+
> `optional` **depends**: `object`
|
|
199
|
+
|
|
200
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L167)
|
|
201
|
+
|
|
202
|
+
A map of dependencies this function has on other tool functions.
|
|
203
|
+
Declaring dependencies ensures that they are automatically registered when this function is registered.
|
|
204
|
+
This is crucial for building modular functions that rely on each other without needing to manage registration order manually.
|
|
205
|
+
|
|
206
|
+
#### Index Signature
|
|
207
|
+
|
|
208
|
+
\[`name`: `string`\]: [`ToolFunc`](ToolFunc.md)
|
|
209
|
+
|
|
210
|
+
#### Example
|
|
211
|
+
|
|
212
|
+
```ts
|
|
213
|
+
const helperFunc = new ToolFunc({ name: 'helper', func: () => 'world' });
|
|
214
|
+
const mainFunc = new ToolFunc({
|
|
215
|
+
name: 'main',
|
|
216
|
+
depends: {
|
|
217
|
+
helper: helperFunc,
|
|
218
|
+
},
|
|
219
|
+
func() {
|
|
220
|
+
// We can now safely run the dependency
|
|
221
|
+
const result = this.runSync('helper');
|
|
222
|
+
return `Hello, ${result}`;
|
|
223
|
+
}
|
|
224
|
+
});
|
|
225
|
+
// When mainFunc is registered, helperFunc will be registered automatically.
|
|
226
|
+
mainFunc.register();
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
#### Inherited from
|
|
230
|
+
|
|
231
|
+
[`ToolFunc`](ToolFunc.md).[`depends`](ToolFunc.md#depends)
|
|
232
|
+
|
|
233
|
+
***
|
|
234
|
+
|
|
235
|
+
### description?
|
|
236
|
+
|
|
237
|
+
> `optional` **description**: `string`
|
|
238
|
+
|
|
239
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L172)
|
|
240
|
+
|
|
241
|
+
A detailed description of what the function does.
|
|
242
|
+
|
|
243
|
+
#### Inherited from
|
|
244
|
+
|
|
245
|
+
[`ToolFunc`](ToolFunc.md).[`description`](ToolFunc.md#description)
|
|
246
|
+
|
|
247
|
+
***
|
|
248
|
+
|
|
249
|
+
### ~~fetchOptions?~~
|
|
142
250
|
|
|
143
251
|
> `optional` **fetchOptions**: `any`
|
|
144
252
|
|
|
145
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:
|
|
253
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:101](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/consts.ts#L101)
|
|
254
|
+
|
|
255
|
+
Options to be passed to the underlying `fetch` call in an HTTP transport.
|
|
256
|
+
|
|
257
|
+
#### Deprecated
|
|
258
|
+
|
|
259
|
+
Use `transport` instead.
|
|
146
260
|
|
|
147
261
|
#### Inherited from
|
|
148
262
|
|
|
@@ -154,7 +268,9 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai
|
|
|
154
268
|
|
|
155
269
|
> `optional` **isApi**: `boolean`
|
|
156
270
|
|
|
157
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
271
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L119)
|
|
272
|
+
|
|
273
|
+
If true, indicates that this function should be treated as a server-side API.
|
|
158
274
|
|
|
159
275
|
#### Inherited from
|
|
160
276
|
|
|
@@ -166,11 +282,13 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
|
|
|
166
282
|
|
|
167
283
|
> `optional` **name**: `string`
|
|
168
284
|
|
|
169
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
285
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L76)
|
|
286
|
+
|
|
287
|
+
The unique name of the function.
|
|
170
288
|
|
|
171
289
|
#### Inherited from
|
|
172
290
|
|
|
173
|
-
[`ToolFunc`](ToolFunc.md).[`name`](ToolFunc.md#name-
|
|
291
|
+
[`ToolFunc`](ToolFunc.md).[`name`](ToolFunc.md#name-3)
|
|
174
292
|
|
|
175
293
|
***
|
|
176
294
|
|
|
@@ -178,7 +296,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-to
|
|
|
178
296
|
|
|
179
297
|
> **nonExported1stChar**: `string`
|
|
180
298
|
|
|
181
|
-
Defined in:
|
|
299
|
+
Defined in: [property-manager.js/src/abstract.d.ts:78](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L78)
|
|
182
300
|
|
|
183
301
|
the property with the default prefix '$' will not be exported.
|
|
184
302
|
|
|
@@ -192,7 +310,9 @@ the property with the default prefix '$' will not be exported.
|
|
|
192
310
|
|
|
193
311
|
> `optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
|
|
194
312
|
|
|
195
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
313
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L81)
|
|
314
|
+
|
|
315
|
+
Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
|
|
196
316
|
|
|
197
317
|
#### Inherited from
|
|
198
318
|
|
|
@@ -202,9 +322,11 @@ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-to
|
|
|
202
322
|
|
|
203
323
|
### result?
|
|
204
324
|
|
|
205
|
-
> `optional` **result**: `string`
|
|
325
|
+
> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
|
|
206
326
|
|
|
207
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
327
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L86)
|
|
328
|
+
|
|
329
|
+
The expected return type of the function, described as a string or a JSON schema object.
|
|
208
330
|
|
|
209
331
|
#### Inherited from
|
|
210
332
|
|
|
@@ -216,7 +338,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-to
|
|
|
216
338
|
|
|
217
339
|
> `optional` **scope**: `any`
|
|
218
340
|
|
|
219
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
341
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L91)
|
|
342
|
+
|
|
343
|
+
The execution scope or context (`this`) for the function.
|
|
220
344
|
|
|
221
345
|
#### Inherited from
|
|
222
346
|
|
|
@@ -228,7 +352,11 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
|
|
|
228
352
|
|
|
229
353
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
230
354
|
|
|
231
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
355
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L114)
|
|
356
|
+
|
|
357
|
+
A lifecycle hook called once during the `ToolFunc` instance's initialization.
|
|
358
|
+
It allows for initial setup, state configuration, or property modification on the instance
|
|
359
|
+
before it is used or registered. The `this` context is the `ToolFunc` instance itself.
|
|
232
360
|
|
|
233
361
|
#### Parameters
|
|
234
362
|
|
|
@@ -240,10 +368,26 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
240
368
|
|
|
241
369
|
[`FuncItem`](../interfaces/FuncItem.md)
|
|
242
370
|
|
|
371
|
+
The configuration options for the function.
|
|
372
|
+
|
|
243
373
|
#### Returns
|
|
244
374
|
|
|
245
375
|
`void`
|
|
246
376
|
|
|
377
|
+
#### Example
|
|
378
|
+
|
|
379
|
+
```ts
|
|
380
|
+
const myFunc = new ToolFunc({
|
|
381
|
+
name: 'myFunc',
|
|
382
|
+
customState: 'initial',
|
|
383
|
+
setup() {
|
|
384
|
+
// `this` is the myFunc instance
|
|
385
|
+
this.customState = 'configured';
|
|
386
|
+
}
|
|
387
|
+
});
|
|
388
|
+
console.log(myFunc.customState); // Outputs: 'configured'
|
|
389
|
+
```
|
|
390
|
+
|
|
247
391
|
#### Inherited from
|
|
248
392
|
|
|
249
393
|
[`ToolFunc`](ToolFunc.md).[`setup`](ToolFunc.md#setup)
|
|
@@ -254,7 +398,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
254
398
|
|
|
255
399
|
> `optional` **stream**: `boolean`
|
|
256
400
|
|
|
257
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
401
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L125)
|
|
402
|
+
|
|
403
|
+
If true, indicates that the function has the *capability* to stream its output.
|
|
404
|
+
Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
|
|
258
405
|
|
|
259
406
|
#### Inherited from
|
|
260
407
|
|
|
@@ -266,7 +413,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
|
|
|
266
413
|
|
|
267
414
|
> `optional` **tags**: `string` \| `string`[]
|
|
268
415
|
|
|
269
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
416
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L96)
|
|
417
|
+
|
|
418
|
+
Tags for grouping or filtering functions.
|
|
270
419
|
|
|
271
420
|
#### Inherited from
|
|
272
421
|
|
|
@@ -274,11 +423,27 @@ Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-to
|
|
|
274
423
|
|
|
275
424
|
***
|
|
276
425
|
|
|
426
|
+
### title?
|
|
427
|
+
|
|
428
|
+
> `optional` **title**: `string`
|
|
429
|
+
|
|
430
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L177)
|
|
431
|
+
|
|
432
|
+
A concise, human-readable title for the function, often used in UI or by AI.
|
|
433
|
+
|
|
434
|
+
#### Inherited from
|
|
435
|
+
|
|
436
|
+
[`ToolFunc`](ToolFunc.md).[`title`](ToolFunc.md#title)
|
|
437
|
+
|
|
438
|
+
***
|
|
439
|
+
|
|
277
440
|
### aliases
|
|
278
441
|
|
|
279
442
|
> `static` **aliases**: `object` = `{}`
|
|
280
443
|
|
|
281
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
444
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:305](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L305)
|
|
445
|
+
|
|
446
|
+
A static map of aliases to their corresponding function names.
|
|
282
447
|
|
|
283
448
|
#### Index Signature
|
|
284
449
|
|
|
@@ -294,7 +459,11 @@ Defined in: [packages/ai-tool/src/tool-func.ts:58](https://github.com/isdk/ai-to
|
|
|
294
459
|
|
|
295
460
|
> `static` **dataPath**: `string`
|
|
296
461
|
|
|
297
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
462
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:312](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L312)
|
|
463
|
+
|
|
464
|
+
A conventional property to designate a file path for saving the registered `ToolFunc` data.
|
|
465
|
+
Note: The `ToolFunc` class itself does not implement persistence logic. It is up to the
|
|
466
|
+
developer to use this path to save and load the `ToolFunc.items` registry if needed.
|
|
298
467
|
|
|
299
468
|
#### Inherited from
|
|
300
469
|
|
|
@@ -306,7 +475,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:59](https://github.com/isdk/ai-to
|
|
|
306
475
|
|
|
307
476
|
> `static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
|
|
308
477
|
|
|
309
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
478
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:300](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L300)
|
|
479
|
+
|
|
480
|
+
A static registry of all `ToolFunc` instances, indexed by name.
|
|
310
481
|
|
|
311
482
|
#### Inherited from
|
|
312
483
|
|
|
@@ -320,7 +491,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-to
|
|
|
320
491
|
|
|
321
492
|
> **get** `static` **apiRoot**(): `undefined` \| `string`
|
|
322
493
|
|
|
323
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:
|
|
494
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:57](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L57)
|
|
495
|
+
|
|
496
|
+
The conventional root path for the API endpoint.
|
|
324
497
|
|
|
325
498
|
##### Returns
|
|
326
499
|
|
|
@@ -336,7 +509,10 @@ Defined in: [packages/ai-tool/src/server-tools.ts:26](https://github.com/isdk/ai
|
|
|
336
509
|
|
|
337
510
|
> **arr2ObjParams**(`params`): `any`[]
|
|
338
511
|
|
|
339
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
512
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:629](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L629)
|
|
513
|
+
|
|
514
|
+
Converts an array of positional arguments into a named parameters object.
|
|
515
|
+
This is used internally to support functions defined with named parameters.
|
|
340
516
|
|
|
341
517
|
#### Parameters
|
|
342
518
|
|
|
@@ -344,10 +520,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:269](https://github.com/isdk/ai-t
|
|
|
344
520
|
|
|
345
521
|
`any`[]
|
|
346
522
|
|
|
523
|
+
An array of positional arguments.
|
|
524
|
+
|
|
347
525
|
#### Returns
|
|
348
526
|
|
|
349
527
|
`any`[]
|
|
350
528
|
|
|
529
|
+
An array containing a single parameters object.
|
|
530
|
+
|
|
351
531
|
#### Inherited from
|
|
352
532
|
|
|
353
533
|
[`ToolFunc`](ToolFunc.md).[`arr2ObjParams`](ToolFunc.md#arr2objparams)
|
|
@@ -358,7 +538,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:269](https://github.com/isdk/ai-t
|
|
|
358
538
|
|
|
359
539
|
> **assign**(`src`, `options`?): `this`
|
|
360
540
|
|
|
361
|
-
Defined in:
|
|
541
|
+
Defined in: [property-manager.js/src/abstract.d.ts:106](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L106)
|
|
362
542
|
|
|
363
543
|
Assign the values from the src object.
|
|
364
544
|
|
|
@@ -390,7 +570,7 @@ this object
|
|
|
390
570
|
|
|
391
571
|
> **assignProperty**(`src`, `name`, `value`, `attrs`?, `options`?): `void`
|
|
392
572
|
|
|
393
|
-
Defined in:
|
|
573
|
+
Defined in: [property-manager.js/src/abstract.d.ts:117](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L117)
|
|
394
574
|
|
|
395
575
|
Assign a property of src to this object.
|
|
396
576
|
|
|
@@ -438,7 +618,7 @@ the attributes object
|
|
|
438
618
|
|
|
439
619
|
> `abstract` **assignPropertyTo**(`dest`, `src`, `name`, `value`, `attrs`?, `options`?): `void`
|
|
440
620
|
|
|
441
|
-
Defined in:
|
|
621
|
+
Defined in: [property-manager.js/src/abstract.d.ts:131](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L131)
|
|
442
622
|
|
|
443
623
|
Assign the property value from the src to destination object.
|
|
444
624
|
|
|
@@ -492,7 +672,7 @@ The attributes object of the property
|
|
|
492
672
|
|
|
493
673
|
> **assignTo**(`dest`?, `options`?): `any`
|
|
494
674
|
|
|
495
|
-
Defined in:
|
|
675
|
+
Defined in: [property-manager.js/src/abstract.d.ts:191](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L191)
|
|
496
676
|
|
|
497
677
|
Assign this attributes to the dest object
|
|
498
678
|
|
|
@@ -524,7 +704,7 @@ the dest object
|
|
|
524
704
|
|
|
525
705
|
> **clone**(`options`?): `any`
|
|
526
706
|
|
|
527
|
-
Defined in:
|
|
707
|
+
Defined in: [property-manager.js/src/abstract.d.ts:155](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L155)
|
|
528
708
|
|
|
529
709
|
Create a new object with the same values of attributes.
|
|
530
710
|
|
|
@@ -550,7 +730,7 @@ the new object
|
|
|
550
730
|
|
|
551
731
|
> **cloneTo**(`dest`, `options`?): `any`
|
|
552
732
|
|
|
553
|
-
Defined in:
|
|
733
|
+
Defined in: [property-manager.js/src/abstract.d.ts:148](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L148)
|
|
554
734
|
|
|
555
735
|
Create and assign the values to the destination object.
|
|
556
736
|
|
|
@@ -582,7 +762,7 @@ the new dest object
|
|
|
582
762
|
|
|
583
763
|
> `abstract` **defineProperties**(`aProperties`): `any`
|
|
584
764
|
|
|
585
|
-
Defined in:
|
|
765
|
+
Defined in: [property-manager.js/src/abstract.d.ts:89](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L89)
|
|
586
766
|
|
|
587
767
|
Define the attributes of this object.
|
|
588
768
|
|
|
@@ -608,7 +788,7 @@ the defined attributes of the object
|
|
|
608
788
|
|
|
609
789
|
> **exportTo**(`dest`, `options`?): `any`
|
|
610
790
|
|
|
611
|
-
Defined in:
|
|
791
|
+
Defined in: [property-manager.js/src/abstract.d.ts:173](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L173)
|
|
612
792
|
|
|
613
793
|
Export attributes to the dest json object.
|
|
614
794
|
|
|
@@ -638,18 +818,27 @@ the dest object.
|
|
|
638
818
|
|
|
639
819
|
### func()
|
|
640
820
|
|
|
641
|
-
> **func**(`
|
|
821
|
+
> **func**(`params`): `any`
|
|
822
|
+
|
|
823
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:112](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L112)
|
|
642
824
|
|
|
643
|
-
|
|
825
|
+
Placeholder for the actual server-side function implementation.
|
|
826
|
+
This method is intended to be defined when a `ServerTools` instance is created.
|
|
644
827
|
|
|
645
828
|
#### Parameters
|
|
646
829
|
|
|
647
|
-
#####
|
|
830
|
+
##### params
|
|
831
|
+
|
|
832
|
+
[`ServerFuncParams`](../interfaces/ServerFuncParams.md)
|
|
833
|
+
|
|
834
|
+
The parameters for the function.
|
|
648
835
|
|
|
649
836
|
#### Returns
|
|
650
837
|
|
|
651
838
|
`any`
|
|
652
839
|
|
|
840
|
+
The result of the function.
|
|
841
|
+
|
|
653
842
|
#### Inherited from
|
|
654
843
|
|
|
655
844
|
[`ToolFunc`](ToolFunc.md).[`func`](ToolFunc.md#func)
|
|
@@ -660,7 +849,11 @@ Defined in: [packages/ai-tool/src/server-tools.ts:59](https://github.com/isdk/ai
|
|
|
660
849
|
|
|
661
850
|
> **getFunc**(`name`?): `any`
|
|
662
851
|
|
|
663
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
852
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:720](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L720)
|
|
853
|
+
|
|
854
|
+
Gets a bound function reference for execution with named parameters.
|
|
855
|
+
If a name is provided, it retrieves a different function from the registry.
|
|
856
|
+
Otherwise, it returns a bound version of this instance's `runSync`.
|
|
664
857
|
|
|
665
858
|
#### Parameters
|
|
666
859
|
|
|
@@ -668,10 +861,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:322](https://github.com/isdk/ai-t
|
|
|
668
861
|
|
|
669
862
|
`string`
|
|
670
863
|
|
|
864
|
+
Optional name of the function to retrieve.
|
|
865
|
+
|
|
671
866
|
#### Returns
|
|
672
867
|
|
|
673
868
|
`any`
|
|
674
869
|
|
|
870
|
+
A function reference or `undefined` if not found.
|
|
871
|
+
|
|
675
872
|
#### Inherited from
|
|
676
873
|
|
|
677
874
|
[`ToolFunc`](ToolFunc.md).[`getFunc`](ToolFunc.md#getfunc)
|
|
@@ -682,7 +879,11 @@ Defined in: [packages/ai-tool/src/tool-func.ts:322](https://github.com/isdk/ai-t
|
|
|
682
879
|
|
|
683
880
|
> **getFuncWithPos**(`name`?): `any`
|
|
684
881
|
|
|
685
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
882
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:777](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L777)
|
|
883
|
+
|
|
884
|
+
Gets a bound function reference suitable for positional argument execution.
|
|
885
|
+
If a name is provided, it retrieves a different function from the registry.
|
|
886
|
+
Otherwise, it returns a bound version of this instance's `runWithPosSync`.
|
|
686
887
|
|
|
687
888
|
#### Parameters
|
|
688
889
|
|
|
@@ -690,10 +891,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:346](https://github.com/isdk/ai-t
|
|
|
690
891
|
|
|
691
892
|
`string`
|
|
692
893
|
|
|
894
|
+
Optional name of the function to retrieve.
|
|
895
|
+
|
|
693
896
|
#### Returns
|
|
694
897
|
|
|
695
898
|
`any`
|
|
696
899
|
|
|
900
|
+
A function reference or `undefined` if not found.
|
|
901
|
+
|
|
697
902
|
#### Inherited from
|
|
698
903
|
|
|
699
904
|
[`ToolFunc`](ToolFunc.md).[`getFuncWithPos`](ToolFunc.md#getfuncwithpos)
|
|
@@ -704,7 +909,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:346](https://github.com/isdk/ai-t
|
|
|
704
909
|
|
|
705
910
|
> `abstract` **getProperties**(): `PropDescriptors`
|
|
706
911
|
|
|
707
|
-
Defined in:
|
|
912
|
+
Defined in: [property-manager.js/src/abstract.d.ts:98](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L98)
|
|
708
913
|
|
|
709
914
|
Get the defined attributes.
|
|
710
915
|
|
|
@@ -724,7 +929,9 @@ the descriptors of properties object
|
|
|
724
929
|
|
|
725
930
|
> **hasAsyncFeature**(`feature`): `boolean`
|
|
726
931
|
|
|
727
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
932
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:787](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L787)
|
|
933
|
+
|
|
934
|
+
Checks if the current function instance supports a specific async feature.
|
|
728
935
|
|
|
729
936
|
#### Parameters
|
|
730
937
|
|
|
@@ -732,10 +939,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:351](https://github.com/isdk/ai-t
|
|
|
732
939
|
|
|
733
940
|
[`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
|
|
734
941
|
|
|
942
|
+
The async feature bit to check for.
|
|
943
|
+
|
|
735
944
|
#### Returns
|
|
736
945
|
|
|
737
946
|
`boolean`
|
|
738
947
|
|
|
948
|
+
`true` if the feature is supported, otherwise `false`.
|
|
949
|
+
|
|
739
950
|
#### Inherited from
|
|
740
951
|
|
|
741
952
|
[`ToolFunc`](ToolFunc.md).[`hasAsyncFeature`](ToolFunc.md#hasasyncfeature)
|
|
@@ -746,7 +957,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:351](https://github.com/isdk/ai-t
|
|
|
746
957
|
|
|
747
958
|
> **hasOwnProperty**(`v`): `boolean`
|
|
748
959
|
|
|
749
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:140
|
|
960
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:140
|
|
750
961
|
|
|
751
962
|
Determines whether an object has a property with the specified name.
|
|
752
963
|
|
|
@@ -772,7 +983,7 @@ A property name.
|
|
|
772
983
|
|
|
773
984
|
> **initialize**(`src`?): `this`
|
|
774
985
|
|
|
775
|
-
Defined in:
|
|
986
|
+
Defined in: [property-manager.js/src/abstract.d.ts:139](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L139)
|
|
776
987
|
|
|
777
988
|
Initialize object and assign attribute values from src if src exists.
|
|
778
989
|
|
|
@@ -798,7 +1009,7 @@ this object.
|
|
|
798
1009
|
|
|
799
1010
|
> **isPrototypeOf**(`v`): `boolean`
|
|
800
1011
|
|
|
801
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:146
|
|
1012
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:146
|
|
802
1013
|
|
|
803
1014
|
Determines whether an object exists in another object's prototype chain.
|
|
804
1015
|
|
|
@@ -824,7 +1035,7 @@ Another object whose prototype chain is to be checked.
|
|
|
824
1035
|
|
|
825
1036
|
> **isSame**(`src`, `options`?): `boolean`
|
|
826
1037
|
|
|
827
|
-
Defined in:
|
|
1038
|
+
Defined in: [property-manager.js/src/abstract.d.ts:200](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L200)
|
|
828
1039
|
|
|
829
1040
|
Check the src object whether “equals” this object.
|
|
830
1041
|
|
|
@@ -854,7 +1065,15 @@ The source object
|
|
|
854
1065
|
|
|
855
1066
|
> **isStream**(`params`): `undefined` \| `boolean`
|
|
856
1067
|
|
|
857
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1068
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:805](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L805)
|
|
1069
|
+
|
|
1070
|
+
Determines if a function call should produce a stream.
|
|
1071
|
+
|
|
1072
|
+
The logic is as follows:
|
|
1073
|
+
1. It first checks if the function is generally capable of streaming (`this.stream`).
|
|
1074
|
+
2. If it is, it then checks if a `stream` parameter is formally declared in the function's `params` definition.
|
|
1075
|
+
3. If both are true, the method returns the value of the `stream` property from the runtime `params` object.
|
|
1076
|
+
Otherwise, it returns the function's static `stream` capability.
|
|
858
1077
|
|
|
859
1078
|
#### Parameters
|
|
860
1079
|
|
|
@@ -862,10 +1081,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:357](https://github.com/isdk/ai-t
|
|
|
862
1081
|
|
|
863
1082
|
`any`
|
|
864
1083
|
|
|
1084
|
+
The runtime parameters passed to the function call.
|
|
1085
|
+
|
|
865
1086
|
#### Returns
|
|
866
1087
|
|
|
867
1088
|
`undefined` \| `boolean`
|
|
868
1089
|
|
|
1090
|
+
`true` if the call should be streamed, `false` or `undefined` otherwise.
|
|
1091
|
+
|
|
869
1092
|
#### Inherited from
|
|
870
1093
|
|
|
871
1094
|
[`ToolFunc`](ToolFunc.md).[`isStream`](ToolFunc.md#isstream)
|
|
@@ -876,7 +1099,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:357](https://github.com/isdk/ai-t
|
|
|
876
1099
|
|
|
877
1100
|
> **mergeTo**(`dest`, `options`?): `any`
|
|
878
1101
|
|
|
879
|
-
Defined in:
|
|
1102
|
+
Defined in: [property-manager.js/src/abstract.d.ts:164](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L164)
|
|
880
1103
|
|
|
881
1104
|
Merge this attributes to dest object.
|
|
882
1105
|
|
|
@@ -908,7 +1131,10 @@ the dest object.
|
|
|
908
1131
|
|
|
909
1132
|
> **obj2ArrParams**(`params`?): `any`[]
|
|
910
1133
|
|
|
911
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1134
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:648](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L648)
|
|
1135
|
+
|
|
1136
|
+
Converts a named parameters object into an array of positional arguments.
|
|
1137
|
+
This is used for functions defined with positional parameters.
|
|
912
1138
|
|
|
913
1139
|
#### Parameters
|
|
914
1140
|
|
|
@@ -916,10 +1142,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:282](https://github.com/isdk/ai-t
|
|
|
916
1142
|
|
|
917
1143
|
`any`
|
|
918
1144
|
|
|
1145
|
+
A named parameters object.
|
|
1146
|
+
|
|
919
1147
|
#### Returns
|
|
920
1148
|
|
|
921
1149
|
`any`[]
|
|
922
1150
|
|
|
1151
|
+
An array of positional arguments.
|
|
1152
|
+
|
|
923
1153
|
#### Inherited from
|
|
924
1154
|
|
|
925
1155
|
[`ToolFunc`](ToolFunc.md).[`obj2ArrParams`](ToolFunc.md#obj2arrparams)
|
|
@@ -930,7 +1160,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:282](https://github.com/isdk/ai-t
|
|
|
930
1160
|
|
|
931
1161
|
> **propertyIsEnumerable**(`v`): `boolean`
|
|
932
1162
|
|
|
933
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:152
|
|
1163
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:152
|
|
934
1164
|
|
|
935
1165
|
Determines whether a specified property is enumerable.
|
|
936
1166
|
|
|
@@ -956,12 +1186,17 @@ A property name.
|
|
|
956
1186
|
|
|
957
1187
|
> **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
958
1188
|
|
|
959
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1189
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:602](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L602)
|
|
1190
|
+
|
|
1191
|
+
Registers the current `ToolFunc` instance into the static registry.
|
|
1192
|
+
Also registers any declared dependencies.
|
|
960
1193
|
|
|
961
1194
|
#### Returns
|
|
962
1195
|
|
|
963
1196
|
`boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
964
1197
|
|
|
1198
|
+
The instance itself upon successful registration, or `false` if it already exists.
|
|
1199
|
+
|
|
965
1200
|
#### Inherited from
|
|
966
1201
|
|
|
967
1202
|
[`ToolFunc`](ToolFunc.md).[`register`](ToolFunc.md#register)
|
|
@@ -970,13 +1205,31 @@ Defined in: [packages/ai-tool/src/tool-func.ts:252](https://github.com/isdk/ai-t
|
|
|
970
1205
|
|
|
971
1206
|
### run()
|
|
972
1207
|
|
|
973
|
-
> **run**(`params`?): `Promise`\<`any`\>
|
|
1208
|
+
> **run**(`params`, `context`?): `Promise`\<`any`\>
|
|
1209
|
+
|
|
1210
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:98](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L98)
|
|
974
1211
|
|
|
975
|
-
|
|
1212
|
+
Overrides the base `run` method to inject transport-specific context.
|
|
1213
|
+
If a `context` object containing `req` and `reply` is provided, these are
|
|
1214
|
+
added to the parameters as `_req` and `_res` before execution.
|
|
976
1215
|
|
|
977
1216
|
#### Parameters
|
|
978
1217
|
|
|
979
|
-
##### params
|
|
1218
|
+
##### params
|
|
1219
|
+
|
|
1220
|
+
[`ServerFuncParams`](../interfaces/ServerFuncParams.md)
|
|
1221
|
+
|
|
1222
|
+
The parameters for the function.
|
|
1223
|
+
|
|
1224
|
+
##### context?
|
|
1225
|
+
|
|
1226
|
+
The transport-level context.
|
|
1227
|
+
|
|
1228
|
+
###### reply
|
|
1229
|
+
|
|
1230
|
+
`any`
|
|
1231
|
+
|
|
1232
|
+
###### req
|
|
980
1233
|
|
|
981
1234
|
`any`
|
|
982
1235
|
|
|
@@ -984,6 +1237,8 @@ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-t
|
|
|
984
1237
|
|
|
985
1238
|
`Promise`\<`any`\>
|
|
986
1239
|
|
|
1240
|
+
The result of the function execution.
|
|
1241
|
+
|
|
987
1242
|
#### Inherited from
|
|
988
1243
|
|
|
989
1244
|
[`ToolFunc`](ToolFunc.md).[`run`](ToolFunc.md#run)
|
|
@@ -994,7 +1249,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:309](https://github.com/isdk/ai-t
|
|
|
994
1249
|
|
|
995
1250
|
> **runAs**(`name`, `params`?): `Promise`\<`any`\>
|
|
996
1251
|
|
|
997
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1252
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:697](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L697)
|
|
1253
|
+
|
|
1254
|
+
Asynchronously executes another registered function by name.
|
|
1255
|
+
This method delegates to `runAsSync()` internally.
|
|
998
1256
|
|
|
999
1257
|
#### Parameters
|
|
1000
1258
|
|
|
@@ -1002,14 +1260,20 @@ Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-t
|
|
|
1002
1260
|
|
|
1003
1261
|
`string`
|
|
1004
1262
|
|
|
1263
|
+
The name of the target function to run.
|
|
1264
|
+
|
|
1005
1265
|
##### params?
|
|
1006
1266
|
|
|
1007
1267
|
`any`
|
|
1008
1268
|
|
|
1269
|
+
Optional parameters to pass to the function.
|
|
1270
|
+
|
|
1009
1271
|
#### Returns
|
|
1010
1272
|
|
|
1011
1273
|
`Promise`\<`any`\>
|
|
1012
1274
|
|
|
1275
|
+
A promise that resolves with the result of the function execution.
|
|
1276
|
+
|
|
1013
1277
|
#### Inherited from
|
|
1014
1278
|
|
|
1015
1279
|
[`ToolFunc`](ToolFunc.md).[`runAs`](ToolFunc.md#runas)
|
|
@@ -1020,7 +1284,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:313](https://github.com/isdk/ai-t
|
|
|
1020
1284
|
|
|
1021
1285
|
> **runAsSync**(`name`, `params`?): `any`
|
|
1022
1286
|
|
|
1023
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1287
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:708](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L708)
|
|
1288
|
+
|
|
1289
|
+
Synchronously executes another registered function by name.
|
|
1290
|
+
This is a convenience method that forwards the call to the static `runSync()` method.
|
|
1024
1291
|
|
|
1025
1292
|
#### Parameters
|
|
1026
1293
|
|
|
@@ -1028,14 +1295,20 @@ Defined in: [packages/ai-tool/src/tool-func.ts:317](https://github.com/isdk/ai-t
|
|
|
1028
1295
|
|
|
1029
1296
|
`string`
|
|
1030
1297
|
|
|
1298
|
+
The name of the target function to run.
|
|
1299
|
+
|
|
1031
1300
|
##### params?
|
|
1032
1301
|
|
|
1033
1302
|
`any`
|
|
1034
1303
|
|
|
1304
|
+
Optional parameters to pass to the function.
|
|
1305
|
+
|
|
1035
1306
|
#### Returns
|
|
1036
1307
|
|
|
1037
1308
|
`any`
|
|
1038
1309
|
|
|
1310
|
+
The result of the function execution.
|
|
1311
|
+
|
|
1039
1312
|
#### Inherited from
|
|
1040
1313
|
|
|
1041
1314
|
[`ToolFunc`](ToolFunc.md).[`runAsSync`](ToolFunc.md#runassync)
|
|
@@ -1046,7 +1319,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:317](https://github.com/isdk/ai-t
|
|
|
1046
1319
|
|
|
1047
1320
|
> **runSync**(`params`?): `any`
|
|
1048
1321
|
|
|
1049
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1322
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:667](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L667)
|
|
1323
|
+
|
|
1324
|
+
Executes the function synchronously with a named parameters object.
|
|
1050
1325
|
|
|
1051
1326
|
#### Parameters
|
|
1052
1327
|
|
|
@@ -1054,10 +1329,18 @@ Defined in: [packages/ai-tool/src/tool-func.ts:295](https://github.com/isdk/ai-t
|
|
|
1054
1329
|
|
|
1055
1330
|
`any`
|
|
1056
1331
|
|
|
1332
|
+
The parameters object for the function.
|
|
1333
|
+
|
|
1057
1334
|
#### Returns
|
|
1058
1335
|
|
|
1059
1336
|
`any`
|
|
1060
1337
|
|
|
1338
|
+
The result of the function execution.
|
|
1339
|
+
|
|
1340
|
+
#### Throws
|
|
1341
|
+
|
|
1342
|
+
Will throw an error if an array of parameters is passed to a function that expects an object.
|
|
1343
|
+
|
|
1061
1344
|
#### Inherited from
|
|
1062
1345
|
|
|
1063
1346
|
[`ToolFunc`](ToolFunc.md).[`runSync`](ToolFunc.md#runsync)
|
|
@@ -1068,7 +1351,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:295](https://github.com/isdk/ai-t
|
|
|
1068
1351
|
|
|
1069
1352
|
> **runWithPos**(...`params`): `Promise`\<`any`\>
|
|
1070
1353
|
|
|
1071
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1354
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:755](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L755)
|
|
1355
|
+
|
|
1356
|
+
Executes the function asynchronously using positional arguments.
|
|
1357
|
+
Delegates to `runWithPosSync()` internally.
|
|
1072
1358
|
|
|
1073
1359
|
#### Parameters
|
|
1074
1360
|
|
|
@@ -1076,10 +1362,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:338](https://github.com/isdk/ai-t
|
|
|
1076
1362
|
|
|
1077
1363
|
...`any`[]
|
|
1078
1364
|
|
|
1365
|
+
Positional arguments passed to the function.
|
|
1366
|
+
|
|
1079
1367
|
#### Returns
|
|
1080
1368
|
|
|
1081
1369
|
`Promise`\<`any`\>
|
|
1082
1370
|
|
|
1371
|
+
A promise that resolves with the result of the function execution.
|
|
1372
|
+
|
|
1083
1373
|
#### Inherited from
|
|
1084
1374
|
|
|
1085
1375
|
[`ToolFunc`](ToolFunc.md).[`runWithPos`](ToolFunc.md#runwithpos)
|
|
@@ -1090,7 +1380,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:338](https://github.com/isdk/ai-t
|
|
|
1090
1380
|
|
|
1091
1381
|
> **runWithPosAs**(`name`, ...`params`): `Promise`\<`any`\>
|
|
1092
1382
|
|
|
1093
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1383
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:766](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L766)
|
|
1384
|
+
|
|
1385
|
+
Asynchronously executes another function by name using positional arguments.
|
|
1386
|
+
Delegates to `runWithPosAsSync()` internally.
|
|
1094
1387
|
|
|
1095
1388
|
#### Parameters
|
|
1096
1389
|
|
|
@@ -1098,14 +1391,20 @@ Defined in: [packages/ai-tool/src/tool-func.ts:342](https://github.com/isdk/ai-t
|
|
|
1098
1391
|
|
|
1099
1392
|
`string`
|
|
1100
1393
|
|
|
1394
|
+
The name of the target function to run.
|
|
1395
|
+
|
|
1101
1396
|
##### params
|
|
1102
1397
|
|
|
1103
1398
|
...`any`[]
|
|
1104
1399
|
|
|
1400
|
+
Positional arguments to pass to the function.
|
|
1401
|
+
|
|
1105
1402
|
#### Returns
|
|
1106
1403
|
|
|
1107
1404
|
`Promise`\<`any`\>
|
|
1108
1405
|
|
|
1406
|
+
A promise that resolves with the result of the function execution.
|
|
1407
|
+
|
|
1109
1408
|
#### Inherited from
|
|
1110
1409
|
|
|
1111
1410
|
[`ToolFunc`](ToolFunc.md).[`runWithPosAs`](ToolFunc.md#runwithposas)
|
|
@@ -1116,7 +1415,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:342](https://github.com/isdk/ai-t
|
|
|
1116
1415
|
|
|
1117
1416
|
> **runWithPosAsSync**(`name`, ...`params`): `any`
|
|
1118
1417
|
|
|
1119
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1418
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:745](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L745)
|
|
1419
|
+
|
|
1420
|
+
Synchronously executes another function by name using positional arguments.
|
|
1421
|
+
This is a convenience wrapper around the static `runWithPosSync()` method.
|
|
1120
1422
|
|
|
1121
1423
|
#### Parameters
|
|
1122
1424
|
|
|
@@ -1124,14 +1426,20 @@ Defined in: [packages/ai-tool/src/tool-func.ts:334](https://github.com/isdk/ai-t
|
|
|
1124
1426
|
|
|
1125
1427
|
`string`
|
|
1126
1428
|
|
|
1429
|
+
The name of the target function to run.
|
|
1430
|
+
|
|
1127
1431
|
##### params
|
|
1128
1432
|
|
|
1129
1433
|
...`any`[]
|
|
1130
1434
|
|
|
1435
|
+
Positional arguments to pass to the function.
|
|
1436
|
+
|
|
1131
1437
|
#### Returns
|
|
1132
1438
|
|
|
1133
1439
|
`any`
|
|
1134
1440
|
|
|
1441
|
+
The result of the function execution.
|
|
1442
|
+
|
|
1135
1443
|
#### Inherited from
|
|
1136
1444
|
|
|
1137
1445
|
[`ToolFunc`](ToolFunc.md).[`runWithPosAsSync`](ToolFunc.md#runwithposassync)
|
|
@@ -1142,7 +1450,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:334](https://github.com/isdk/ai-t
|
|
|
1142
1450
|
|
|
1143
1451
|
> **runWithPosSync**(...`params`): `any`
|
|
1144
1452
|
|
|
1145
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1453
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:731](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L731)
|
|
1454
|
+
|
|
1455
|
+
Executes the function synchronously using positional arguments.
|
|
1456
|
+
If the function expects named parameters, it converts the arguments automatically.
|
|
1146
1457
|
|
|
1147
1458
|
#### Parameters
|
|
1148
1459
|
|
|
@@ -1150,10 +1461,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:327](https://github.com/isdk/ai-t
|
|
|
1150
1461
|
|
|
1151
1462
|
...`any`[]
|
|
1152
1463
|
|
|
1464
|
+
Positional arguments passed to the function.
|
|
1465
|
+
|
|
1153
1466
|
#### Returns
|
|
1154
1467
|
|
|
1155
1468
|
`any`
|
|
1156
1469
|
|
|
1470
|
+
The result of the function execution.
|
|
1471
|
+
|
|
1157
1472
|
#### Inherited from
|
|
1158
1473
|
|
|
1159
1474
|
[`ToolFunc`](ToolFunc.md).[`runWithPosSync`](ToolFunc.md#runwithpossync)
|
|
@@ -1164,7 +1479,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:327](https://github.com/isdk/ai-t
|
|
|
1164
1479
|
|
|
1165
1480
|
> **toJSON**(): `any`
|
|
1166
1481
|
|
|
1167
|
-
Defined in:
|
|
1482
|
+
Defined in: [property-manager.js/src/abstract.d.ts:182](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L182)
|
|
1168
1483
|
|
|
1169
1484
|
#### Returns
|
|
1170
1485
|
|
|
@@ -1180,7 +1495,7 @@ Defined in: node\_modules/.pnpm/property-manager@2.0.0/node\_modules/property-ma
|
|
|
1180
1495
|
|
|
1181
1496
|
> **toLocaleString**(): `string`
|
|
1182
1497
|
|
|
1183
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:131
|
|
1498
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:131
|
|
1184
1499
|
|
|
1185
1500
|
Returns a date converted to a string using the current locale.
|
|
1186
1501
|
|
|
@@ -1198,7 +1513,7 @@ Returns a date converted to a string using the current locale.
|
|
|
1198
1513
|
|
|
1199
1514
|
> **toObject**(`options`?): `any`
|
|
1200
1515
|
|
|
1201
|
-
Defined in:
|
|
1516
|
+
Defined in: [property-manager.js/src/abstract.d.ts:181](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/abstract.d.ts#L181)
|
|
1202
1517
|
|
|
1203
1518
|
Convert the attributes to the json object
|
|
1204
1519
|
|
|
@@ -1224,7 +1539,7 @@ the json object.
|
|
|
1224
1539
|
|
|
1225
1540
|
> **toString**(): `string`
|
|
1226
1541
|
|
|
1227
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:128
|
|
1542
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:128
|
|
1228
1543
|
|
|
1229
1544
|
Returns a string representation of an object.
|
|
1230
1545
|
|
|
@@ -1242,12 +1557,16 @@ Returns a string representation of an object.
|
|
|
1242
1557
|
|
|
1243
1558
|
> **unregister**(): `any`
|
|
1244
1559
|
|
|
1245
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
1560
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:619](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L619)
|
|
1561
|
+
|
|
1562
|
+
Removes the current `ToolFunc` instance from the static registry.
|
|
1246
1563
|
|
|
1247
1564
|
#### Returns
|
|
1248
1565
|
|
|
1249
1566
|
`any`
|
|
1250
1567
|
|
|
1568
|
+
The instance that was unregistered.
|
|
1569
|
+
|
|
1251
1570
|
#### Inherited from
|
|
1252
1571
|
|
|
1253
1572
|
[`ToolFunc`](ToolFunc.md).[`unregister`](ToolFunc.md#unregister)
|
|
@@ -1258,7 +1577,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:265](https://github.com/isdk/ai-t
|
|
|
1258
1577
|
|
|
1259
1578
|
> **valueOf**(): `Object`
|
|
1260
1579
|
|
|
1261
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:134
|
|
1580
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:134
|
|
1262
1581
|
|
|
1263
1582
|
Returns the primitive value of the specified object.
|
|
1264
1583
|
|
|
@@ -1278,7 +1597,7 @@ Returns the primitive value of the specified object.
|
|
|
1278
1597
|
|
|
1279
1598
|
> `static` **assign**\<`T`, `U`\>(`target`, `source`): `T` & `U`
|
|
1280
1599
|
|
|
1281
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:286
|
|
1600
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:286
|
|
1282
1601
|
|
|
1283
1602
|
Copy the values of all of the enumerable own properties from one or more source objects to a
|
|
1284
1603
|
target object. Returns the target object.
|
|
@@ -1315,7 +1634,7 @@ The source object from which to copy properties.
|
|
|
1315
1634
|
|
|
1316
1635
|
> `static` **assign**\<`T`, `U`, `V`\>(`target`, `source1`, `source2`): `T` & `U` & `V`
|
|
1317
1636
|
|
|
1318
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:295
|
|
1637
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:295
|
|
1319
1638
|
|
|
1320
1639
|
Copy the values of all of the enumerable own properties from one or more source objects to a
|
|
1321
1640
|
target object. Returns the target object.
|
|
@@ -1360,7 +1679,7 @@ The second source object from which to copy properties.
|
|
|
1360
1679
|
|
|
1361
1680
|
> `static` **assign**\<`T`, `U`, `V`, `W`\>(`target`, `source1`, `source2`, `source3`): `T` & `U` & `V` & `W`
|
|
1362
1681
|
|
|
1363
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:305
|
|
1682
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:305
|
|
1364
1683
|
|
|
1365
1684
|
Copy the values of all of the enumerable own properties from one or more source objects to a
|
|
1366
1685
|
target object. Returns the target object.
|
|
@@ -1413,7 +1732,7 @@ The third source object from which to copy properties.
|
|
|
1413
1732
|
|
|
1414
1733
|
> `static` **assign**(`target`, ...`sources`): `any`
|
|
1415
1734
|
|
|
1416
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:313
|
|
1735
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:313
|
|
1417
1736
|
|
|
1418
1737
|
Copy the values of all of the enumerable own properties from one or more source objects to a
|
|
1419
1738
|
target object. Returns the target object.
|
|
@@ -1448,7 +1767,7 @@ One or more source objects from which to copy properties
|
|
|
1448
1767
|
|
|
1449
1768
|
> `static` **create**(`o`): `any`
|
|
1450
1769
|
|
|
1451
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:188
|
|
1770
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:188
|
|
1452
1771
|
|
|
1453
1772
|
Creates an object that has the specified prototype or that has null prototype.
|
|
1454
1773
|
|
|
@@ -1472,7 +1791,7 @@ Object to use as a prototype. May be null.
|
|
|
1472
1791
|
|
|
1473
1792
|
> `static` **create**(`o`, `properties`): `any`
|
|
1474
1793
|
|
|
1475
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:195
|
|
1794
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:195
|
|
1476
1795
|
|
|
1477
1796
|
Creates an object that has the specified prototype, and that optionally contains specified properties.
|
|
1478
1797
|
|
|
@@ -1504,7 +1823,7 @@ JavaScript object that contains one or more property descriptors.
|
|
|
1504
1823
|
|
|
1505
1824
|
> `static` **defineProperties**(`aTarget`, `aProperties`, `recreate`?): `any`
|
|
1506
1825
|
|
|
1507
|
-
Defined in:
|
|
1826
|
+
Defined in: [property-manager.js/src/advance.d.ts:11](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L11)
|
|
1508
1827
|
|
|
1509
1828
|
Adds one or more properties to an object, and/or modifies attributes of existing properties.
|
|
1510
1829
|
|
|
@@ -1536,7 +1855,7 @@ Adds one or more properties to an object, and/or modifies attributes of existing
|
|
|
1536
1855
|
|
|
1537
1856
|
> `static` **defineProperty**\<`T`\>(`o`, `p`, `attributes`): `T`
|
|
1538
1857
|
|
|
1539
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:203
|
|
1858
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:203
|
|
1540
1859
|
|
|
1541
1860
|
Adds a property to an object, or modifies attributes of an existing property.
|
|
1542
1861
|
|
|
@@ -1580,7 +1899,7 @@ Descriptor for the property. It can be for a data property or an accessor proper
|
|
|
1580
1899
|
|
|
1581
1900
|
> `static` **entries**\<`T`\>(`o`): \[`string`, `T`\][]
|
|
1582
1901
|
|
|
1583
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:36
|
|
1902
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:36
|
|
1584
1903
|
|
|
1585
1904
|
Returns an array of key/values of the enumerable own properties of an object
|
|
1586
1905
|
|
|
@@ -1608,7 +1927,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
1608
1927
|
|
|
1609
1928
|
> `static` **entries**(`o`): \[`string`, `any`\][]
|
|
1610
1929
|
|
|
1611
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:42
|
|
1930
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:42
|
|
1612
1931
|
|
|
1613
1932
|
Returns an array of key/values of the enumerable own properties of an object
|
|
1614
1933
|
|
|
@@ -1634,7 +1953,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
1634
1953
|
|
|
1635
1954
|
> `static` **freeze**\<`T`\>(`f`): `T`
|
|
1636
1955
|
|
|
1637
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:222
|
|
1956
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:222
|
|
1638
1957
|
|
|
1639
1958
|
Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
|
|
1640
1959
|
|
|
@@ -1662,7 +1981,7 @@ Object on which to lock the attributes.
|
|
|
1662
1981
|
|
|
1663
1982
|
> `static` **freeze**\<`T`, `U`\>(`o`): `Readonly`\<`T`\>
|
|
1664
1983
|
|
|
1665
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:228
|
|
1984
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:228
|
|
1666
1985
|
|
|
1667
1986
|
Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
|
|
1668
1987
|
|
|
@@ -1692,7 +2011,7 @@ Object on which to lock the attributes.
|
|
|
1692
2011
|
|
|
1693
2012
|
> `static` **freeze**\<`T`\>(`o`): `Readonly`\<`T`\>
|
|
1694
2013
|
|
|
1695
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:234
|
|
2014
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:234
|
|
1696
2015
|
|
|
1697
2016
|
Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
|
|
1698
2017
|
|
|
@@ -1724,7 +2043,7 @@ Object on which to lock the attributes.
|
|
|
1724
2043
|
|
|
1725
2044
|
> `static` **fromEntries**\<`T`\>(`entries`): `object`
|
|
1726
2045
|
|
|
1727
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:26
|
|
2046
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:26
|
|
1728
2047
|
|
|
1729
2048
|
Returns an object created by key-value entries for properties and methods
|
|
1730
2049
|
|
|
@@ -1752,7 +2071,7 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
1752
2071
|
|
|
1753
2072
|
> `static` **fromEntries**(`entries`): `any`
|
|
1754
2073
|
|
|
1755
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:32
|
|
2074
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2019.object.d.ts:32
|
|
1756
2075
|
|
|
1757
2076
|
Returns an object created by key-value entries for properties and methods
|
|
1758
2077
|
|
|
@@ -1778,7 +2097,9 @@ An iterable object that contains key-value entries for properties and methods.
|
|
|
1778
2097
|
|
|
1779
2098
|
> `static` **get**(`name`): [`ToolFunc`](ToolFunc.md)
|
|
1780
2099
|
|
|
1781
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2100
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:319](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L319)
|
|
2101
|
+
|
|
2102
|
+
Retrieves a registered function by its name or alias.
|
|
1782
2103
|
|
|
1783
2104
|
#### Parameters
|
|
1784
2105
|
|
|
@@ -1786,10 +2107,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:61](https://github.com/isdk/ai-to
|
|
|
1786
2107
|
|
|
1787
2108
|
`string`
|
|
1788
2109
|
|
|
2110
|
+
The name or alias of the function to retrieve.
|
|
2111
|
+
|
|
1789
2112
|
#### Returns
|
|
1790
2113
|
|
|
1791
2114
|
[`ToolFunc`](ToolFunc.md)
|
|
1792
2115
|
|
|
2116
|
+
The `ToolFunc` instance if found, otherwise `undefined`.
|
|
2117
|
+
|
|
1793
2118
|
#### Inherited from
|
|
1794
2119
|
|
|
1795
2120
|
[`ToolFunc`](ToolFunc.md).[`get`](ToolFunc.md#get)
|
|
@@ -1800,7 +2125,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:61](https://github.com/isdk/ai-to
|
|
|
1800
2125
|
|
|
1801
2126
|
> `static` **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
|
|
1802
2127
|
|
|
1803
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2128
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:365](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L365)
|
|
2129
|
+
|
|
2130
|
+
Retrieves all registered functions that have a specific tag.
|
|
1804
2131
|
|
|
1805
2132
|
#### Parameters
|
|
1806
2133
|
|
|
@@ -1808,10 +2135,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:93](https://github.com/isdk/ai-to
|
|
|
1808
2135
|
|
|
1809
2136
|
`string`
|
|
1810
2137
|
|
|
2138
|
+
The tag to search for.
|
|
2139
|
+
|
|
1811
2140
|
#### Returns
|
|
1812
2141
|
|
|
1813
2142
|
[`ToolFunc`](ToolFunc.md)[]
|
|
1814
2143
|
|
|
2144
|
+
An array of matching `ToolFunc` instances.
|
|
2145
|
+
|
|
1815
2146
|
#### Inherited from
|
|
1816
2147
|
|
|
1817
2148
|
[`ToolFunc`](ToolFunc.md).[`getAllByTag`](ToolFunc.md#getallbytag)
|
|
@@ -1822,7 +2153,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:93](https://github.com/isdk/ai-to
|
|
|
1822
2153
|
|
|
1823
2154
|
> `static` **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
1824
2155
|
|
|
1825
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2156
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:340](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L340)
|
|
2157
|
+
|
|
2158
|
+
Finds the first registered function that has a specific tag.
|
|
1826
2159
|
|
|
1827
2160
|
#### Parameters
|
|
1828
2161
|
|
|
@@ -1830,10 +2163,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:73](https://github.com/isdk/ai-to
|
|
|
1830
2163
|
|
|
1831
2164
|
`string`
|
|
1832
2165
|
|
|
2166
|
+
The tag to search for.
|
|
2167
|
+
|
|
1833
2168
|
#### Returns
|
|
1834
2169
|
|
|
1835
2170
|
`undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
1836
2171
|
|
|
2172
|
+
The first matching `ToolFunc` instance, or `undefined` if none is found.
|
|
2173
|
+
|
|
1837
2174
|
#### Inherited from
|
|
1838
2175
|
|
|
1839
2176
|
[`ToolFunc`](ToolFunc.md).[`getByTag`](ToolFunc.md#getbytag)
|
|
@@ -1844,7 +2181,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:73](https://github.com/isdk/ai-to
|
|
|
1844
2181
|
|
|
1845
2182
|
> `static` **getFunc**(`name`): `any`
|
|
1846
2183
|
|
|
1847
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2184
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:431](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L431)
|
|
2185
|
+
|
|
2186
|
+
Retrieves a bound, runnable function reference for a registered function.
|
|
2187
|
+
This reference is suitable for execution with an object of named parameters.
|
|
1848
2188
|
|
|
1849
2189
|
#### Parameters
|
|
1850
2190
|
|
|
@@ -1852,10 +2192,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:134](https://github.com/isdk/ai-t
|
|
|
1852
2192
|
|
|
1853
2193
|
`string`
|
|
1854
2194
|
|
|
2195
|
+
The name of the function.
|
|
2196
|
+
|
|
1855
2197
|
#### Returns
|
|
1856
2198
|
|
|
1857
2199
|
`any`
|
|
1858
2200
|
|
|
2201
|
+
A bound function reference, or `undefined` if not found.
|
|
2202
|
+
|
|
1859
2203
|
#### Inherited from
|
|
1860
2204
|
|
|
1861
2205
|
[`ToolFunc`](ToolFunc.md).[`getFunc`](ToolFunc.md#getfunc-2)
|
|
@@ -1866,7 +2210,10 @@ Defined in: [packages/ai-tool/src/tool-func.ts:134](https://github.com/isdk/ai-t
|
|
|
1866
2210
|
|
|
1867
2211
|
> `static` **getFuncWithPos**(`name`): `any`
|
|
1868
2212
|
|
|
1869
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2213
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:472](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L472)
|
|
2214
|
+
|
|
2215
|
+
Retrieves a bound, runnable function reference for a registered function.
|
|
2216
|
+
This reference is suitable for execution with positional arguments.
|
|
1870
2217
|
|
|
1871
2218
|
#### Parameters
|
|
1872
2219
|
|
|
@@ -1874,10 +2221,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-t
|
|
|
1874
2221
|
|
|
1875
2222
|
`string`
|
|
1876
2223
|
|
|
2224
|
+
The name of the function.
|
|
2225
|
+
|
|
1877
2226
|
#### Returns
|
|
1878
2227
|
|
|
1879
2228
|
`any`
|
|
1880
2229
|
|
|
2230
|
+
A bound function reference, or `undefined` if not found.
|
|
2231
|
+
|
|
1881
2232
|
#### Inherited from
|
|
1882
2233
|
|
|
1883
2234
|
[`ToolFunc`](ToolFunc.md).[`getFuncWithPos`](ToolFunc.md#getfuncwithpos-2)
|
|
@@ -1888,7 +2239,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:155](https://github.com/isdk/ai-t
|
|
|
1888
2239
|
|
|
1889
2240
|
> `static` **getOwnPropertyDescriptor**(`o`, `p`): `undefined` \| `PropertyDescriptor`
|
|
1890
2241
|
|
|
1891
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:175
|
|
2242
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:175
|
|
1892
2243
|
|
|
1893
2244
|
Gets the own property descriptor of the specified object.
|
|
1894
2245
|
An own property descriptor is one that is defined directly on the object and is not inherited from the object's prototype.
|
|
@@ -1921,7 +2272,7 @@ Name of the property.
|
|
|
1921
2272
|
|
|
1922
2273
|
> `static` **getOwnPropertyDescriptors**\<`T`\>(`o`): \{ \[P in string \| number \| symbol\]: TypedPropertyDescriptor\<T\[P\]\> \} & `object`
|
|
1923
2274
|
|
|
1924
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:48
|
|
2275
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:48
|
|
1925
2276
|
|
|
1926
2277
|
Returns an object containing all own property descriptors of an object
|
|
1927
2278
|
|
|
@@ -1951,7 +2302,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
1951
2302
|
|
|
1952
2303
|
> `static` **getOwnPropertyNames**(`o`): `string`[]
|
|
1953
2304
|
|
|
1954
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:182
|
|
2305
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:182
|
|
1955
2306
|
|
|
1956
2307
|
Returns the names of the own properties of an object. The own properties of an object are those that are defined directly
|
|
1957
2308
|
on that object, and are not inherited from the object's prototype. The properties of an object include both fields (objects) and functions.
|
|
@@ -1978,7 +2329,7 @@ Object that contains the own properties.
|
|
|
1978
2329
|
|
|
1979
2330
|
> `static` **getOwnPropertySymbols**(`o`): `symbol`[]
|
|
1980
2331
|
|
|
1981
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:319
|
|
2332
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:319
|
|
1982
2333
|
|
|
1983
2334
|
Returns an array of all symbol properties found directly on object o.
|
|
1984
2335
|
|
|
@@ -2004,7 +2355,7 @@ Object to retrieve the symbols from.
|
|
|
2004
2355
|
|
|
2005
2356
|
> `static` **getProperties**(): `PropDescriptors`
|
|
2006
2357
|
|
|
2007
|
-
Defined in:
|
|
2358
|
+
Defined in: [property-manager.js/src/advance.d.ts:10](https://github.com/snowyu/property-manager.js/blob/e9ebf4c62be9b6d84e5868ed098df041a53bb90a/src/advance.d.ts#L10)
|
|
2008
2359
|
|
|
2009
2360
|
get all properties descriptor include inherited.
|
|
2010
2361
|
|
|
@@ -2022,7 +2373,7 @@ get all properties descriptor include inherited.
|
|
|
2022
2373
|
|
|
2023
2374
|
> `static` **getPrototypeOf**(`o`): `any`
|
|
2024
2375
|
|
|
2025
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:167
|
|
2376
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:167
|
|
2026
2377
|
|
|
2027
2378
|
Returns the prototype of an object.
|
|
2028
2379
|
|
|
@@ -2048,7 +2399,9 @@ The object that references the prototype.
|
|
|
2048
2399
|
|
|
2049
2400
|
> `static` **hasAsyncFeature**(`feature`): `boolean`
|
|
2050
2401
|
|
|
2051
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2402
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:388](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L388)
|
|
2403
|
+
|
|
2404
|
+
Checks if any registered function has a specific asynchronous feature.
|
|
2052
2405
|
|
|
2053
2406
|
#### Parameters
|
|
2054
2407
|
|
|
@@ -2056,10 +2409,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:111](https://github.com/isdk/ai-t
|
|
|
2056
2409
|
|
|
2057
2410
|
[`AsyncFeatureBits`](../enumerations/AsyncFeatureBits.md)
|
|
2058
2411
|
|
|
2412
|
+
The async feature bit to check for.
|
|
2413
|
+
|
|
2059
2414
|
#### Returns
|
|
2060
2415
|
|
|
2061
2416
|
`boolean`
|
|
2062
2417
|
|
|
2418
|
+
`true` if the feature is present in any function, otherwise `false`.
|
|
2419
|
+
|
|
2063
2420
|
#### Inherited from
|
|
2064
2421
|
|
|
2065
2422
|
[`ToolFunc`](ToolFunc.md).[`hasAsyncFeature`](ToolFunc.md#hasasyncfeature-2)
|
|
@@ -2070,7 +2427,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:111](https://github.com/isdk/ai-t
|
|
|
2070
2427
|
|
|
2071
2428
|
> `static` **hasOwn**(`o`, `v`): `boolean`
|
|
2072
2429
|
|
|
2073
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.object.d.ts:25
|
|
2430
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.object.d.ts:25
|
|
2074
2431
|
|
|
2075
2432
|
Determines whether an object has a property with the specified name.
|
|
2076
2433
|
|
|
@@ -2102,7 +2459,7 @@ A property name.
|
|
|
2102
2459
|
|
|
2103
2460
|
> `static` **is**(`value1`, `value2`): `boolean`
|
|
2104
2461
|
|
|
2105
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:332
|
|
2462
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:332
|
|
2106
2463
|
|
|
2107
2464
|
Returns true if the values are the same value, false otherwise.
|
|
2108
2465
|
|
|
@@ -2134,7 +2491,7 @@ The second value.
|
|
|
2134
2491
|
|
|
2135
2492
|
> `static` **isExtensible**(`o`): `boolean`
|
|
2136
2493
|
|
|
2137
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:258
|
|
2494
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:258
|
|
2138
2495
|
|
|
2139
2496
|
Returns a value that indicates whether new properties can be added to an object.
|
|
2140
2497
|
|
|
@@ -2160,7 +2517,7 @@ Object to test.
|
|
|
2160
2517
|
|
|
2161
2518
|
> `static` **isFrozen**(`o`): `boolean`
|
|
2162
2519
|
|
|
2163
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:252
|
|
2520
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:252
|
|
2164
2521
|
|
|
2165
2522
|
Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.
|
|
2166
2523
|
|
|
@@ -2186,7 +2543,7 @@ Object to test.
|
|
|
2186
2543
|
|
|
2187
2544
|
> `static` **isSealed**(`o`): `boolean`
|
|
2188
2545
|
|
|
2189
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:246
|
|
2546
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:246
|
|
2190
2547
|
|
|
2191
2548
|
Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.
|
|
2192
2549
|
|
|
@@ -2214,7 +2571,7 @@ Object to test.
|
|
|
2214
2571
|
|
|
2215
2572
|
> `static` **keys**(`o`): `string`[]
|
|
2216
2573
|
|
|
2217
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:264
|
|
2574
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:264
|
|
2218
2575
|
|
|
2219
2576
|
Returns the names of the enumerable string properties and methods of an object.
|
|
2220
2577
|
|
|
@@ -2238,7 +2595,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2238
2595
|
|
|
2239
2596
|
> `static` **keys**(`o`): `string`[]
|
|
2240
2597
|
|
|
2241
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:325
|
|
2598
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:325
|
|
2242
2599
|
|
|
2243
2600
|
Returns the names of the enumerable string properties and methods of an object.
|
|
2244
2601
|
|
|
@@ -2262,12 +2619,16 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2262
2619
|
|
|
2263
2620
|
> `static` **list**(): [`Funcs`](../interfaces/Funcs.md)
|
|
2264
2621
|
|
|
2265
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2622
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:331](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L331)
|
|
2623
|
+
|
|
2624
|
+
Returns the complete map of all registered functions.
|
|
2266
2625
|
|
|
2267
2626
|
#### Returns
|
|
2268
2627
|
|
|
2269
2628
|
[`Funcs`](../interfaces/Funcs.md)
|
|
2270
2629
|
|
|
2630
|
+
The map of `ToolFunc` instances.
|
|
2631
|
+
|
|
2271
2632
|
#### Inherited from
|
|
2272
2633
|
|
|
2273
2634
|
[`ToolFunc`](ToolFunc.md).[`list`](ToolFunc.md#list)
|
|
@@ -2278,7 +2639,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:69](https://github.com/isdk/ai-to
|
|
|
2278
2639
|
|
|
2279
2640
|
> `static` **preventExtensions**\<`T`\>(`o`): `T`
|
|
2280
2641
|
|
|
2281
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:240
|
|
2642
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:240
|
|
2282
2643
|
|
|
2283
2644
|
Prevents the addition of new properties to an object.
|
|
2284
2645
|
|
|
@@ -2310,7 +2671,9 @@ Object to make non-extensible.
|
|
|
2310
2671
|
|
|
2311
2672
|
> `static` **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2312
2673
|
|
|
2313
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2674
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:495](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L495)
|
|
2675
|
+
|
|
2676
|
+
Registers a new tool function.
|
|
2314
2677
|
|
|
2315
2678
|
##### Parameters
|
|
2316
2679
|
|
|
@@ -2318,14 +2681,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:160](https://github.com/isdk/ai-t
|
|
|
2318
2681
|
|
|
2319
2682
|
`string`
|
|
2320
2683
|
|
|
2684
|
+
The name of the function.
|
|
2685
|
+
|
|
2321
2686
|
###### options
|
|
2322
2687
|
|
|
2323
2688
|
[`FuncItem`](../interfaces/FuncItem.md)
|
|
2324
2689
|
|
|
2690
|
+
The function's configuration.
|
|
2691
|
+
|
|
2325
2692
|
##### Returns
|
|
2326
2693
|
|
|
2327
2694
|
`boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2328
2695
|
|
|
2696
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2697
|
+
|
|
2698
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2699
|
+
|
|
2700
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2701
|
+
|
|
2329
2702
|
##### Inherited from
|
|
2330
2703
|
|
|
2331
2704
|
[`ToolFunc`](ToolFunc.md).[`register`](ToolFunc.md#register-2)
|
|
@@ -2334,7 +2707,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:160](https://github.com/isdk/ai-t
|
|
|
2334
2707
|
|
|
2335
2708
|
> `static` **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2336
2709
|
|
|
2337
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2710
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:496](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L496)
|
|
2711
|
+
|
|
2712
|
+
Registers a new tool function.
|
|
2338
2713
|
|
|
2339
2714
|
##### Parameters
|
|
2340
2715
|
|
|
@@ -2342,14 +2717,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:161](https://github.com/isdk/ai-t
|
|
|
2342
2717
|
|
|
2343
2718
|
`Function`
|
|
2344
2719
|
|
|
2720
|
+
The function implementation.
|
|
2721
|
+
|
|
2345
2722
|
###### options
|
|
2346
2723
|
|
|
2347
2724
|
[`FuncItem`](../interfaces/FuncItem.md)
|
|
2348
2725
|
|
|
2726
|
+
The function's configuration.
|
|
2727
|
+
|
|
2349
2728
|
##### Returns
|
|
2350
2729
|
|
|
2351
2730
|
`boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2352
2731
|
|
|
2732
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2733
|
+
|
|
2734
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2735
|
+
|
|
2736
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2737
|
+
|
|
2353
2738
|
##### Inherited from
|
|
2354
2739
|
|
|
2355
2740
|
[`ToolFunc`](ToolFunc.md).[`register`](ToolFunc.md#register-2)
|
|
@@ -2358,22 +2743,34 @@ Defined in: [packages/ai-tool/src/tool-func.ts:161](https://github.com/isdk/ai-t
|
|
|
2358
2743
|
|
|
2359
2744
|
> `static` **register**(`name`, `options`?): `boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2360
2745
|
|
|
2361
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2746
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:497](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L497)
|
|
2747
|
+
|
|
2748
|
+
Registers a new tool function.
|
|
2362
2749
|
|
|
2363
2750
|
##### Parameters
|
|
2364
2751
|
|
|
2365
2752
|
###### name
|
|
2366
2753
|
|
|
2754
|
+
The name of the function.
|
|
2755
|
+
|
|
2367
2756
|
`string` | `Function` | [`ToolFunc`](ToolFunc.md) | [`FuncItem`](../interfaces/FuncItem.md)
|
|
2368
2757
|
|
|
2369
2758
|
###### options?
|
|
2370
2759
|
|
|
2371
2760
|
[`FuncItem`](../interfaces/FuncItem.md)
|
|
2372
2761
|
|
|
2762
|
+
The function's configuration.
|
|
2763
|
+
|
|
2373
2764
|
##### Returns
|
|
2374
2765
|
|
|
2375
2766
|
`boolean` \| [`ToolFunc`](ToolFunc.md)
|
|
2376
2767
|
|
|
2768
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2769
|
+
|
|
2770
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2771
|
+
|
|
2772
|
+
The new `ToolFunc` instance, or `false` if a function with that name already exists.
|
|
2773
|
+
|
|
2377
2774
|
##### Inherited from
|
|
2378
2775
|
|
|
2379
2776
|
[`ToolFunc`](ToolFunc.md).[`register`](ToolFunc.md#register-2)
|
|
@@ -2384,7 +2781,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:162](https://github.com/isdk/ai-t
|
|
|
2384
2781
|
|
|
2385
2782
|
> `static` **run**(`name`, `params`?): `Promise`\<`any`\>
|
|
2386
2783
|
|
|
2387
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2784
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:402](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L402)
|
|
2785
|
+
|
|
2786
|
+
Asynchronously executes a registered function by name with named parameters.
|
|
2388
2787
|
|
|
2389
2788
|
#### Parameters
|
|
2390
2789
|
|
|
@@ -2392,14 +2791,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:118](https://github.com/isdk/ai-t
|
|
|
2392
2791
|
|
|
2393
2792
|
`string`
|
|
2394
2793
|
|
|
2794
|
+
The name of the function to run.
|
|
2795
|
+
|
|
2395
2796
|
##### params?
|
|
2396
2797
|
|
|
2397
2798
|
`any`
|
|
2398
2799
|
|
|
2800
|
+
The parameters object for the function.
|
|
2801
|
+
|
|
2399
2802
|
#### Returns
|
|
2400
2803
|
|
|
2401
2804
|
`Promise`\<`any`\>
|
|
2402
2805
|
|
|
2806
|
+
A promise that resolves with the function's result.
|
|
2807
|
+
|
|
2808
|
+
#### Throws
|
|
2809
|
+
|
|
2810
|
+
If the function with the given name is not found.
|
|
2811
|
+
|
|
2403
2812
|
#### Inherited from
|
|
2404
2813
|
|
|
2405
2814
|
[`ToolFunc`](ToolFunc.md).[`run`](ToolFunc.md#run-2)
|
|
@@ -2410,7 +2819,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:118](https://github.com/isdk/ai-t
|
|
|
2410
2819
|
|
|
2411
2820
|
> `static` **runSync**(`name`, `params`?): `any`
|
|
2412
2821
|
|
|
2413
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2822
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:417](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L417)
|
|
2823
|
+
|
|
2824
|
+
Synchronously executes a registered function by name with named parameters.
|
|
2414
2825
|
|
|
2415
2826
|
#### Parameters
|
|
2416
2827
|
|
|
@@ -2418,14 +2829,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:126](https://github.com/isdk/ai-t
|
|
|
2418
2829
|
|
|
2419
2830
|
`string`
|
|
2420
2831
|
|
|
2832
|
+
The name of the function to run.
|
|
2833
|
+
|
|
2421
2834
|
##### params?
|
|
2422
2835
|
|
|
2423
2836
|
`any`
|
|
2424
2837
|
|
|
2838
|
+
The parameters object for the function.
|
|
2839
|
+
|
|
2425
2840
|
#### Returns
|
|
2426
2841
|
|
|
2427
2842
|
`any`
|
|
2428
2843
|
|
|
2844
|
+
The result of the function's execution.
|
|
2845
|
+
|
|
2846
|
+
#### Throws
|
|
2847
|
+
|
|
2848
|
+
If the function with the given name is not found.
|
|
2849
|
+
|
|
2429
2850
|
#### Inherited from
|
|
2430
2851
|
|
|
2431
2852
|
[`ToolFunc`](ToolFunc.md).[`runSync`](ToolFunc.md#runsync-2)
|
|
@@ -2436,7 +2857,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:126](https://github.com/isdk/ai-t
|
|
|
2436
2857
|
|
|
2437
2858
|
> `static` **runWithPos**(`name`, ...`params`): `Promise`\<`any`\>
|
|
2438
2859
|
|
|
2439
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2860
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:443](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L443)
|
|
2861
|
+
|
|
2862
|
+
Asynchronously executes a function using positional arguments.
|
|
2440
2863
|
|
|
2441
2864
|
#### Parameters
|
|
2442
2865
|
|
|
@@ -2444,14 +2867,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:139](https://github.com/isdk/ai-t
|
|
|
2444
2867
|
|
|
2445
2868
|
`string`
|
|
2446
2869
|
|
|
2870
|
+
The name of the function to run.
|
|
2871
|
+
|
|
2447
2872
|
##### params
|
|
2448
2873
|
|
|
2449
2874
|
...`any`[]
|
|
2450
2875
|
|
|
2876
|
+
Positional arguments to pass to the function.
|
|
2877
|
+
|
|
2451
2878
|
#### Returns
|
|
2452
2879
|
|
|
2453
2880
|
`Promise`\<`any`\>
|
|
2454
2881
|
|
|
2882
|
+
A promise that resolves with the function's result.
|
|
2883
|
+
|
|
2884
|
+
#### Throws
|
|
2885
|
+
|
|
2886
|
+
If the function with the given name is not found.
|
|
2887
|
+
|
|
2455
2888
|
#### Inherited from
|
|
2456
2889
|
|
|
2457
2890
|
[`ToolFunc`](ToolFunc.md).[`runWithPos`](ToolFunc.md#runwithpos-2)
|
|
@@ -2462,7 +2895,9 @@ Defined in: [packages/ai-tool/src/tool-func.ts:139](https://github.com/isdk/ai-t
|
|
|
2462
2895
|
|
|
2463
2896
|
> `static` **runWithPosSync**(`name`, ...`params`): `any`
|
|
2464
2897
|
|
|
2465
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
2898
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:458](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L458)
|
|
2899
|
+
|
|
2900
|
+
Synchronously executes a function using positional arguments.
|
|
2466
2901
|
|
|
2467
2902
|
#### Parameters
|
|
2468
2903
|
|
|
@@ -2470,14 +2905,24 @@ Defined in: [packages/ai-tool/src/tool-func.ts:147](https://github.com/isdk/ai-t
|
|
|
2470
2905
|
|
|
2471
2906
|
`string`
|
|
2472
2907
|
|
|
2908
|
+
The name of the function to run.
|
|
2909
|
+
|
|
2473
2910
|
##### params
|
|
2474
2911
|
|
|
2475
2912
|
...`any`[]
|
|
2476
2913
|
|
|
2914
|
+
Positional arguments to pass to the function.
|
|
2915
|
+
|
|
2477
2916
|
#### Returns
|
|
2478
2917
|
|
|
2479
2918
|
`any`
|
|
2480
2919
|
|
|
2920
|
+
The result of the function's execution.
|
|
2921
|
+
|
|
2922
|
+
#### Throws
|
|
2923
|
+
|
|
2924
|
+
If the function with the given name is not found.
|
|
2925
|
+
|
|
2481
2926
|
#### Inherited from
|
|
2482
2927
|
|
|
2483
2928
|
[`ToolFunc`](ToolFunc.md).[`runWithPosSync`](ToolFunc.md#runwithpossync-2)
|
|
@@ -2488,7 +2933,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:147](https://github.com/isdk/ai-t
|
|
|
2488
2933
|
|
|
2489
2934
|
> `static` **seal**\<`T`\>(`o`): `T`
|
|
2490
2935
|
|
|
2491
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:216
|
|
2936
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:216
|
|
2492
2937
|
|
|
2493
2938
|
Prevents the modification of attributes of existing properties, and prevents the addition of new properties.
|
|
2494
2939
|
|
|
@@ -2518,7 +2963,7 @@ Object on which to lock the attributes.
|
|
|
2518
2963
|
|
|
2519
2964
|
> `static` **setApiRoot**(`v`): `void`
|
|
2520
2965
|
|
|
2521
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:
|
|
2966
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:61](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L61)
|
|
2522
2967
|
|
|
2523
2968
|
#### Parameters
|
|
2524
2969
|
|
|
@@ -2536,7 +2981,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:30](https://github.com/isdk/ai
|
|
|
2536
2981
|
|
|
2537
2982
|
> `static` **setPrototypeOf**(`o`, `proto`): `any`
|
|
2538
2983
|
|
|
2539
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:339
|
|
2984
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.core.d.ts:339
|
|
2540
2985
|
|
|
2541
2986
|
Sets the prototype of a specified object o to object proto or null. Returns the object o.
|
|
2542
2987
|
|
|
@@ -2568,19 +3013,29 @@ The value of the new prototype or null.
|
|
|
2568
3013
|
|
|
2569
3014
|
> `static` **toJSON**(): `object`
|
|
2570
3015
|
|
|
2571
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:
|
|
3016
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/server-tools.ts:74](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/server-tools.ts#L74)
|
|
3017
|
+
|
|
3018
|
+
Serializes all registered `ServerTools` instances into a JSON object.
|
|
3019
|
+
This method is typically called by a transport's discovery endpoint.
|
|
3020
|
+
|
|
3021
|
+
It filters for tools that are instances of `ServerTools` or marked as `isApi`.
|
|
3022
|
+
It omits the `func` body from the output unless `allowExportFunc` is true.
|
|
2572
3023
|
|
|
2573
3024
|
#### Returns
|
|
2574
3025
|
|
|
2575
3026
|
`object`
|
|
2576
3027
|
|
|
3028
|
+
A map of serializable tool definitions.
|
|
3029
|
+
|
|
2577
3030
|
***
|
|
2578
3031
|
|
|
2579
3032
|
### unregister()
|
|
2580
3033
|
|
|
2581
3034
|
> `static` **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2582
3035
|
|
|
2583
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:
|
|
3036
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:547](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/tool-func.ts#L547)
|
|
3037
|
+
|
|
3038
|
+
Unregisters a function by its name, also removing any associated aliases.
|
|
2584
3039
|
|
|
2585
3040
|
#### Parameters
|
|
2586
3041
|
|
|
@@ -2588,10 +3043,14 @@ Defined in: [packages/ai-tool/src/tool-func.ts:207](https://github.com/isdk/ai-t
|
|
|
2588
3043
|
|
|
2589
3044
|
`string`
|
|
2590
3045
|
|
|
3046
|
+
The name of the function to unregister.
|
|
3047
|
+
|
|
2591
3048
|
#### Returns
|
|
2592
3049
|
|
|
2593
3050
|
`undefined` \| [`ToolFunc`](ToolFunc.md)
|
|
2594
3051
|
|
|
3052
|
+
The unregistered `ToolFunc` instance, or `undefined` if it was not found.
|
|
3053
|
+
|
|
2595
3054
|
#### Inherited from
|
|
2596
3055
|
|
|
2597
3056
|
[`ToolFunc`](ToolFunc.md).[`unregister`](ToolFunc.md#unregister-2)
|
|
@@ -2604,7 +3063,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:207](https://github.com/isdk/ai-t
|
|
|
2604
3063
|
|
|
2605
3064
|
> `static` **values**\<`T`\>(`o`): `T`[]
|
|
2606
3065
|
|
|
2607
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:24
|
|
3066
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:24
|
|
2608
3067
|
|
|
2609
3068
|
Returns an array of values of the enumerable own properties of an object
|
|
2610
3069
|
|
|
@@ -2632,7 +3091,7 @@ Object that contains the properties and methods. This can be an object that you
|
|
|
2632
3091
|
|
|
2633
3092
|
> `static` **values**(`o`): `any`[]
|
|
2634
3093
|
|
|
2635
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:30
|
|
3094
|
+
Defined in: @isdk/ai-tools/node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2017.object.d.ts:30
|
|
2636
3095
|
|
|
2637
3096
|
Returns an array of values of the enumerable own properties of an object
|
|
2638
3097
|
|