@isdk/ai-tool 0.7.1 → 0.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/chunk-4FKBOPZI.mjs +1 -0
- package/dist/{chunk-VIG2GB47.mjs → chunk-TGTHY57V.mjs} +1 -1
- package/dist/funcs.d.mts +1 -2
- package/dist/funcs.d.ts +1 -2
- package/dist/funcs.js +1 -1
- package/dist/funcs.mjs +1 -1
- package/dist/{index-DEUnmyUq.d.mts → index-BLW3R7VS.d.mts} +103 -69
- package/dist/{index-DEUnmyUq.d.ts → index-BLW3R7VS.d.ts} +103 -69
- package/dist/index.d.mts +100 -37
- package/dist/index.d.ts +100 -37
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/test/util.js +1 -1
- package/dist/test/util.mjs +1 -1
- package/docs/api/{namespaces → @isdk/namespaces}/EventStates/README.md +2 -2
- package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/ABORT.md +2 -2
- package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/CONTINUE.md +2 -2
- package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/DONE.md +2 -2
- package/docs/api/{namespaces → @isdk/namespaces}/EventStates/variables/STOPPED.md +2 -2
- package/docs/api/@isdk/namespaces/uuidv5/README.md +12 -0
- package/docs/api/{namespaces → @isdk/namespaces}/uuidv5/variables/DNS.md +2 -2
- package/docs/api/{namespaces → @isdk/namespaces}/uuidv5/variables/URL.md +2 -2
- package/docs/api/_media/pubsub.md +427 -105
- package/docs/api/_media/server_client_tools.md +5 -3
- package/docs/api/_media/toolFunc.md +3 -1
- package/docs/api/classes/AbortError.md +8 -8
- package/docs/api/classes/AlreadyExistsError.md +8 -8
- package/docs/api/classes/BaseError.md +14 -14
- package/docs/api/classes/BinarySemaphore.md +39 -39
- package/docs/api/classes/CancelableAbility.md +43 -39
- package/docs/api/classes/ClientToolTransport.md +22 -22
- package/docs/api/classes/ClientTools.md +178 -154
- package/docs/api/classes/CommonError.md +12 -12
- package/docs/api/classes/ConfigFile.md +6 -6
- package/docs/api/classes/EnvPromptTemplate.md +14 -14
- package/docs/api/classes/EventClient.md +240 -198
- package/docs/api/classes/EventEmitter.md +14 -14
- package/docs/api/classes/EventServer.md +208 -233
- package/docs/api/classes/EventToolFunc.md +144 -116
- package/docs/api/classes/FStringPromptTemplate.md +14 -14
- package/docs/api/classes/FewShotPromptTemplate.md +30 -26
- package/docs/api/classes/GolangPromptTemplate.md +13 -13
- package/docs/api/classes/HttpClientToolTransport.md +23 -23
- package/docs/api/classes/HttpServerToolTransport.md +32 -27
- package/docs/api/classes/IntSet.md +21 -21
- package/docs/api/classes/LRUCache.md +18 -18
- package/docs/api/classes/NotFoundError.md +8 -8
- package/docs/api/classes/NotImplementationError.md +8 -8
- package/docs/api/classes/PromptExampleSelector.md +17 -15
- package/docs/api/classes/PromptTemplate.md +15 -15
- package/docs/api/classes/ReadableStreamError.md +12 -12
- package/docs/api/classes/ResClientTools.md +180 -152
- package/docs/api/classes/ResServerTools.md +163 -139
- package/docs/api/classes/RpcMethodsClientTool.md +174 -146
- package/docs/api/classes/RpcMethodsServerTool.md +157 -133
- package/docs/api/classes/SSEChannel.md +142 -52
- package/docs/api/classes/Semaphore.md +40 -40
- package/docs/api/classes/ServerToolTransport.md +32 -27
- package/docs/api/classes/ServerTools.md +163 -139
- package/docs/api/classes/SignalGate.md +19 -17
- package/docs/api/classes/SseClientPubSubTransport.md +38 -10
- package/docs/api/classes/SseServerPubSubTransport.md +115 -42
- package/docs/api/classes/TaskAbortController.md +13 -13
- package/docs/api/classes/ToolFunc.md +157 -129
- package/docs/api/classes/ToolTransport.md +13 -13
- package/docs/api/classes/YamlTypeBaseObject.md +5 -5
- package/docs/api/enumerations/AsyncFeatureBits.md +4 -4
- package/docs/api/enumerations/AsyncFeatures.md +4 -4
- package/docs/api/enumerations/HashAlgorithm.md +12 -12
- package/docs/api/functions/AIArgProcessor.md +2 -2
- package/docs/api/functions/AIStream.md +8 -4
- package/docs/api/functions/ChoiceArgProcessor.md +2 -2
- package/docs/api/functions/DefaultDateFormat.md +2 -2
- package/docs/api/functions/ObjectArgsToArgsInfo.md +1 -1
- package/docs/api/functions/RateLimit.md +2 -2
- package/docs/api/functions/TemplateArgProcessor.md +2 -2
- package/docs/api/functions/addDate.md +7 -3
- package/docs/api/functions/assignDirs.md +1 -1
- package/docs/api/functions/beforeShutdown.md +1 -1
- package/docs/api/functions/calcPerplexity.md +2 -2
- package/docs/api/functions/calcPerplexitySimple.md +1 -1
- package/docs/api/functions/canonicalize.md +1 -1
- package/docs/api/functions/completeSentences.md +1 -1
- package/docs/api/functions/concatText.md +1 -1
- package/docs/api/functions/countLLMTokens.md +1 -1
- package/docs/api/functions/countRegexMatches.md +1 -1
- package/docs/api/functions/createAbilityInjector.md +16 -8
- package/docs/api/functions/createCallbacksTransformer.md +7 -3
- package/docs/api/functions/createEmptyReadableStream.md +1 -1
- package/docs/api/functions/createEndWithRepetitionDetector.md +2 -2
- package/docs/api/functions/createError.md +1 -1
- package/docs/api/functions/createEventStreamTransformer.md +8 -4
- package/docs/api/functions/createHfValueFunc.md +1 -1
- package/docs/api/functions/createLRUCache.md +2 -2
- package/docs/api/functions/createYamlObjectTag.md +1 -1
- package/docs/api/functions/dateToText.md +1 -1
- package/docs/api/functions/decodeCharset.md +2 -2
- package/docs/api/functions/defaultsWithConcat.md +1 -1
- package/docs/api/functions/detectCharset.md +2 -2
- package/docs/api/functions/encodeLLMTokens.md +1 -1
- package/docs/api/functions/ensureQuoted.md +1 -1
- package/docs/api/functions/eventable.md +6 -8
- package/docs/api/functions/expandConfig.md +2 -2
- package/docs/api/functions/expandObjEnv.md +1 -1
- package/docs/api/functions/expandPath.md +2 -2
- package/docs/api/functions/expandPathInObject.md +2 -2
- package/docs/api/functions/expandPaths.md +2 -2
- package/docs/api/functions/fileIsExists.md +1 -1
- package/docs/api/functions/filterValidFnScope.md +2 -2
- package/docs/api/functions/findIndexNonEmptyFrom.md +1 -1
- package/docs/api/functions/findPort.md +1 -1
- package/docs/api/functions/formatISO.md +1 -1
- package/docs/api/functions/formatTextWithSpace.md +2 -2
- package/docs/api/functions/funcGetMeta.md +1 -1
- package/docs/api/functions/funcWithMeta.md +2 -2
- package/docs/api/functions/genUrlParamsStr.md +8 -2
- package/docs/api/functions/getAllEnumKeys.md +4 -2
- package/docs/api/functions/getConfigFileNames.md +2 -2
- package/docs/api/functions/getConfigs.md +2 -2
- package/docs/api/functions/getFileMetaInfo.md +1 -1
- package/docs/api/functions/getHashAlgoBySize.md +1 -1
- package/docs/api/functions/getKeysPath.md +4 -2
- package/docs/api/functions/getLLMTokenizer.md +1 -1
- package/docs/api/functions/getMultiLevelExtname.md +1 -1
- package/docs/api/functions/getPackageDir.md +1 -1
- package/docs/api/functions/getRealFilepath.md +1 -1
- package/docs/api/functions/getResponseErrorReadableStream.md +2 -2
- package/docs/api/functions/getXDGConfigs.md +1 -1
- package/docs/api/functions/hasDirectoryIn.md +2 -2
- package/docs/api/functions/hash.md +1 -1
- package/docs/api/functions/hashFile.md +2 -2
- package/docs/api/functions/hashObject.md +2 -2
- package/docs/api/functions/hashStream.md +1 -1
- package/docs/api/functions/initShutdown.md +1 -1
- package/docs/api/functions/isLangUsingSpaces.md +1 -1
- package/docs/api/functions/isListItemString.md +1 -1
- package/docs/api/functions/isModelNameMatched.md +2 -2
- package/docs/api/functions/isPunctuationChar.md +1 -1
- package/docs/api/functions/isQuoted.md +1 -1
- package/docs/api/functions/isRegExp.md +1 -1
- package/docs/api/functions/isSameString.md +1 -1
- package/docs/api/functions/isSectionString.md +2 -2
- package/docs/api/functions/isSentenceEnding.md +1 -1
- package/docs/api/functions/isSepLineString.md +1 -1
- package/docs/api/functions/isStrWrapped.md +1 -1
- package/docs/api/functions/isSubdirectory.md +1 -1
- package/docs/api/functions/isTitleString.md +2 -2
- package/docs/api/functions/isWebStream.md +1 -1
- package/docs/api/functions/joinSplitWords.md +1 -1
- package/docs/api/functions/jsonFilterToWhere.md +2 -2
- package/docs/api/functions/jsonToMarkdownStr.md +2 -2
- package/docs/api/functions/loadAIConfig.md +1 -1
- package/docs/api/functions/loadConfig.md +1 -1
- package/docs/api/functions/loadConfigFile.md +1 -1
- package/docs/api/functions/loadFileFromPaths.md +2 -2
- package/docs/api/functions/loadTextFromPaths.md +3 -3
- package/docs/api/functions/lrucache.md +1 -1
- package/docs/api/functions/matchUrlProtocol.md +1 -1
- package/docs/api/functions/memoize.md +5 -3
- package/docs/api/functions/mergeArray.md +1 -1
- package/docs/api/functions/messagesToText.md +1 -1
- package/docs/api/functions/nanoid.md +45 -0
- package/docs/api/functions/normalizePath.md +1 -1
- package/docs/api/functions/paramsSizeToScaleStr.md +1 -1
- package/docs/api/functions/parseCommand.md +3 -3
- package/docs/api/functions/parseDateFormat.md +7 -3
- package/docs/api/functions/parseISO.md +7 -3
- package/docs/api/functions/parseJsJson.md +2 -2
- package/docs/api/functions/parseJsJsonSimpleSync.md +2 -2
- package/docs/api/functions/parseObjectArgInfo.md +2 -2
- package/docs/api/functions/parseObjectArgumentInfos.md +2 -2
- package/docs/api/functions/parseObjectArguments.md +2 -2
- package/docs/api/functions/parseObjectArgumentsAsArgInfos.md +2 -2
- package/docs/api/functions/parseYaml.md +1 -1
- package/docs/api/functions/pruneSubdirectories.md +1 -1
- package/docs/api/functions/pruneSubdirectoriesInPlace.md +1 -1
- package/docs/api/functions/quoteStr.md +1 -1
- package/docs/api/functions/readFilenamesRecursiveSync.md +2 -2
- package/docs/api/functions/readTextFileChunks.md +2 -2
- package/docs/api/functions/readTextFileChunksEx.md +2 -2
- package/docs/api/functions/readableFromAsyncIterable.md +4 -2
- package/docs/api/functions/registerCoreTools.md +1 -1
- package/docs/api/functions/removeMarkdownBold.md +2 -2
- package/docs/api/functions/removeMarkdownBoldAndItalic.md +2 -2
- package/docs/api/functions/removeMarkdownItalic.md +2 -2
- package/docs/api/functions/replaceWithPlaceholder.md +2 -2
- package/docs/api/functions/restoreFromPlacehoders.md +2 -2
- package/docs/api/functions/sanitizeFilename.md +1 -1
- package/docs/api/functions/sanitizeFilepath.md +1 -1
- package/docs/api/functions/saveConfigFile.md +1 -1
- package/docs/api/functions/scaleStrToParamsSize.md +1 -1
- package/docs/api/functions/shutdown.md +1 -1
- package/docs/api/functions/simplifyObjectArguments.md +1 -1
- package/docs/api/functions/sleep.md +1 -1
- package/docs/api/functions/sortedValues.md +4 -2
- package/docs/api/functions/splitChunks.md +2 -2
- package/docs/api/functions/splitParagraph.md +2 -2
- package/docs/api/functions/splitSentence.md +1 -1
- package/docs/api/functions/splitWords.md +1 -1
- package/docs/api/functions/stringifyYaml.md +1 -1
- package/docs/api/functions/stripConsoleColor.md +1 -1
- package/docs/api/functions/textToDate.md +1 -1
- package/docs/api/functions/throwError.md +1 -1
- package/docs/api/functions/toDate.md +7 -3
- package/docs/api/functions/toDateTime.md +1 -1
- package/docs/api/functions/trimStartOfStreamHelper.md +3 -3
- package/docs/api/functions/truncTo.md +1 -1
- package/docs/api/functions/truncateByToken.md +2 -2
- package/docs/api/functions/truncateToTokenLimit.md +2 -2
- package/docs/api/functions/truncateToTokenLimitEx.md +2 -2
- package/docs/api/functions/uuid.md +15 -6
- package/docs/api/functions/uuidStringify.md +1 -1
- package/docs/api/functions/uuidv1.md +5 -3
- package/docs/api/functions/uuidv4.md +5 -3
- package/docs/api/functions/uuidv5.md +5 -3
- package/docs/api/functions/uuidv6.md +61 -0
- package/docs/api/functions/uuidv7.md +61 -0
- package/docs/api/functions/wrapEventEmitter.md +1 -1
- package/docs/api/functions/xxhash.md +1 -1
- package/docs/api/functions/xxhash32.md +1 -1
- package/docs/api/functions/xxhash64.md +1 -1
- package/docs/api/functions/xxhashAsStr.md +1 -1
- package/docs/api/functions/yieldExec.md +1 -1
- package/docs/api/globals.md +11 -6
- package/docs/api/interfaces/AIChatAssistantMessageParam.md +12 -12
- package/docs/api/interfaces/AIChatContentPartImage.md +3 -3
- package/docs/api/interfaces/AIChatContentPartText.md +3 -3
- package/docs/api/interfaces/AIChatMessageParamBase.md +7 -7
- package/docs/api/interfaces/AIChatMessageToolCall.md +4 -4
- package/docs/api/interfaces/AIChatSystemMessageParam.md +9 -9
- package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +3 -3
- package/docs/api/interfaces/AIChatToolChoiceObject.md +2 -2
- package/docs/api/interfaces/AIChatToolFunc.md +5 -5
- package/docs/api/interfaces/AIChatToolFuncParam.md +3 -3
- package/docs/api/interfaces/AIChatToolMessageParam.md +10 -10
- package/docs/api/interfaces/AIChatToolParam.md +2 -2
- package/docs/api/interfaces/AIChatToolTypeObject.md +2 -2
- package/docs/api/interfaces/AIChatUserMessageParam.md +13 -13
- package/docs/api/interfaces/AIChoiceConfig.md +8 -8
- package/docs/api/interfaces/AIResult.md +12 -8
- package/docs/api/interfaces/AIStreamParser.md +8 -6
- package/docs/api/interfaces/AIStreamParserOptions.md +2 -2
- package/docs/api/interfaces/BaseFunc.md +17 -17
- package/docs/api/interfaces/BaseFuncItem.md +15 -15
- package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
- package/docs/api/interfaces/BinarySemaphoreOptions.md +5 -5
- package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
- package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
- package/docs/api/interfaces/CancelableAbilityOptions.md +4 -4
- package/docs/api/interfaces/ClientFuncItem.md +21 -25
- package/docs/api/interfaces/EventClientFuncParams.md +5 -5
- package/docs/api/interfaces/EventServerFuncParams.md +14 -6
- package/docs/api/interfaces/FewShotPromptTemplateOptions.md +9 -7
- package/docs/api/interfaces/FuncItem.md +18 -18
- package/docs/api/interfaces/FuncParam.md +5 -5
- package/docs/api/interfaces/FuncParams.md +1 -1
- package/docs/api/interfaces/Funcs.md +1 -1
- package/docs/api/interfaces/HashAlgoParams.md +4 -4
- package/docs/api/interfaces/IClientToolTransport.md +9 -9
- package/docs/api/interfaces/IFileMetaInfo.md +8 -8
- package/docs/api/interfaces/IPubSubClientTransport.md +31 -7
- package/docs/api/interfaces/IPubSubServerTransport.md +92 -47
- package/docs/api/interfaces/IReadTextFileChunksOptions.md +13 -13
- package/docs/api/interfaces/IServerToolTransport.md +19 -14
- package/docs/api/interfaces/IToolTransport.md +6 -6
- package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +11 -11
- package/docs/api/interfaces/JsonFilter.md +1 -1
- package/docs/api/interfaces/ParseObjectArgumentOptions.md +11 -11
- package/docs/api/interfaces/ProbabilityItem.md +4 -4
- package/docs/api/interfaces/PromptExampleSelectorOptions.md +3 -3
- package/docs/api/interfaces/PubSubClientStream.md +26 -14
- package/docs/api/interfaces/PubSubServerSession.md +8 -8
- package/docs/api/interfaces/RemoteFuncItem.md +21 -25
- package/docs/api/interfaces/ReplacePlacehoderOptions.md +5 -5
- package/docs/api/interfaces/ResClientFuncParams.md +3 -3
- package/docs/api/interfaces/ResServerFuncParams.md +6 -6
- package/docs/api/interfaces/RpcMethodsClientFuncParams.md +2 -2
- package/docs/api/interfaces/RpcMethodsServerFuncParams.md +4 -4
- package/docs/api/interfaces/SectionStringOptions.md +3 -3
- package/docs/api/interfaces/SemaphoreOptions.md +7 -7
- package/docs/api/interfaces/SemaphoreTaskItem.md +6 -6
- package/docs/api/interfaces/ServerFuncItem.md +22 -26
- package/docs/api/interfaces/ServerFuncParams.md +3 -3
- package/docs/api/interfaces/SplitSentenceOptions.md +5 -5
- package/docs/api/interfaces/StreamCallbacksAndOptions.md +11 -7
- package/docs/api/interfaces/TaskAbortControllers.md +1 -1
- package/docs/api/interfaces/TaskPromise.md +17 -9
- package/docs/api/interfaces/ToolFuncPackage.md +5 -5
- package/docs/api/type-aliases/AIChatContentPart.md +2 -2
- package/docs/api/type-aliases/AIChatMessageParam.md +2 -2
- package/docs/api/type-aliases/AIChatRole.md +2 -2
- package/docs/api/type-aliases/AIChatToolChoiceParam.md +2 -2
- package/docs/api/type-aliases/AIMessageType.md +2 -2
- package/docs/api/type-aliases/AIModelNameRule.md +2 -2
- package/docs/api/type-aliases/AIModelNameRuleFn.md +2 -2
- package/docs/api/type-aliases/AIModelNameRules.md +2 -2
- package/docs/api/type-aliases/AITextGenerationFinishReason.md +2 -2
- package/docs/api/type-aliases/ActionName.md +2 -2
- package/docs/api/type-aliases/ArrayMergeWay.md +2 -2
- package/docs/api/type-aliases/AsyncTaskId.md +2 -2
- package/docs/api/type-aliases/BeforeShutdownListener.md +2 -2
- package/docs/api/type-aliases/EventErrorListenerFn.md +2 -2
- package/docs/api/type-aliases/EventListenerFn.md +2 -2
- package/docs/api/type-aliases/FuncParamType.md +2 -2
- package/docs/api/type-aliases/PromptExamples.md +5 -3
- package/docs/api/type-aliases/PubSubClientId.md +2 -2
- package/docs/api/type-aliases/PubSubCtx.md +24 -4
- package/docs/api/type-aliases/RpcMethodHandler.md +2 -2
- package/docs/api/type-aliases/SSEClient.md +53 -0
- package/docs/api/type-aliases/SemaphoreIsReadyFuncType.md +2 -2
- package/docs/api/type-aliases/TFunc.md +2 -2
- package/docs/api/type-aliases/UUIDVersions.md +11 -0
- package/docs/api/variables/AIChatRoles.md +1 -1
- package/docs/api/variables/AIMessageTypes.md +1 -1
- package/docs/api/variables/AITextGenerationFinishReasons.md +1 -1
- package/docs/api/variables/ActionNames.md +1 -1
- package/docs/api/variables/ArrayMergeWay.md +2 -2
- package/docs/api/variables/ArrayMergeWaySymbol.md +2 -2
- package/docs/api/variables/ClientEventPrefix.md +11 -0
- package/docs/api/variables/ClientToolFuncSchema.md +4 -2
- package/docs/api/variables/DEFAULT_CONFIG_NAME.md +1 -1
- package/docs/api/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
- package/docs/api/variables/EventBusName.md +1 -1
- package/docs/api/variables/EventName.md +1 -1
- package/docs/api/variables/FuncMetaSymbol.md +2 -2
- package/docs/api/variables/LLM_TOKENIZER_NAMES.md +4 -4
- package/docs/api/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
- package/docs/api/variables/PASSING_SCORE.md +1 -1
- package/docs/api/variables/RStreamErrCode.md +1 -1
- package/docs/api/variables/RemoteToolFuncSchema.md +4 -2
- package/docs/api/variables/ResponseRStreamErrCode.md +1 -1
- package/docs/api/variables/RpcMethodsClientToolSchema.md +4 -2
- package/docs/api/variables/RpcMethodsServerToolSchema.md +2 -2
- package/docs/api/variables/SHUTDOWN_SIGNALS.md +1 -1
- package/docs/api/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
- package/docs/api/variables/SecondaryCache.md +1 -1
- package/docs/api/variables/ServerToolFuncSchema.md +4 -2
- package/docs/api/variables/StrangeHumanName.md +1 -1
- package/docs/api/variables/ToolAsyncCancelableBit.md +1 -1
- package/docs/api/variables/ToolAsyncMultiTaskBit.md +1 -1
- package/docs/api/variables/ToolAsyncPriorityBit.md +1 -1
- package/docs/api/variables/ToolFuncSchema.md +4 -2
- package/docs/api/variables/backendEventable.md +11 -0
- package/docs/api/variables/base32768.md +1 -1
- package/docs/api/variables/event.md +1 -1
- package/docs/api/variables/eventClient.md +1 -1
- package/docs/api/variables/eventServer.md +1 -1
- package/docs/api/variables/lrucache.md +1 -1
- package/docs/api/variables/makeToolFuncCancelable.md +11 -0
- package/docs/api/{functions → variables}/wait.md +16 -14
- package/docs/pubsub.md +427 -105
- package/docs/server_client_tools.md +5 -3
- package/docs/toolFunc.md +3 -1
- package/package.json +10 -9
- package/dist/chunk-4XRPAC7C.mjs +0 -1
- package/docs/api/functions/backendEventable.md +0 -29
- package/docs/api/functions/makeToolFuncCancelable.md +0 -29
- package/docs/api/interfaces/PubSubClient.md +0 -27
- package/docs/api/namespaces/uuidv5/README.md +0 -12
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ParseObjectArgumentOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:19](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:19](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L19)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:19](http
|
|
|
14
14
|
|
|
15
15
|
> `optional` **argProcessor**: `ArgProcessor`
|
|
16
16
|
|
|
17
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:22](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:22](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L22)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:22](http
|
|
|
22
22
|
|
|
23
23
|
> `optional` **assigner**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:21](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:21](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L21)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:21](http
|
|
|
30
30
|
|
|
31
31
|
> `optional` **delimiter**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:20](https://github.com/isdk/ai-tool.js/blob/
|
|
33
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:20](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L20)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:20](http
|
|
|
38
38
|
|
|
39
39
|
> `optional` **ignoreIndexNamed**: `boolean`
|
|
40
40
|
|
|
41
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
41
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:26](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L26)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -46,7 +46,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:26](http
|
|
|
46
46
|
|
|
47
47
|
> `optional` **preserveUnresolvedName**: `boolean`
|
|
48
48
|
|
|
49
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
49
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:27](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L27)
|
|
50
50
|
|
|
51
51
|
***
|
|
52
52
|
|
|
@@ -54,7 +54,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:27](http
|
|
|
54
54
|
|
|
55
55
|
> `optional` **raiseError**: `boolean`
|
|
56
56
|
|
|
57
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
57
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:29](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L29)
|
|
58
58
|
|
|
59
59
|
***
|
|
60
60
|
|
|
@@ -62,7 +62,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:29](http
|
|
|
62
62
|
|
|
63
63
|
> `optional` **returnArrayOnly**: `boolean`
|
|
64
64
|
|
|
65
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
65
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:23](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L23)
|
|
66
66
|
|
|
67
67
|
***
|
|
68
68
|
|
|
@@ -70,7 +70,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:23](http
|
|
|
70
70
|
|
|
71
71
|
> `optional` **skipExpression**: `boolean`
|
|
72
72
|
|
|
73
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
73
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:28](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L28)
|
|
74
74
|
|
|
75
75
|
***
|
|
76
76
|
|
|
@@ -78,7 +78,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:28](http
|
|
|
78
78
|
|
|
79
79
|
> `optional` **templateData**: `Record`\<`string`, `any`\>
|
|
80
80
|
|
|
81
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
81
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:25](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L25)
|
|
82
82
|
|
|
83
83
|
***
|
|
84
84
|
|
|
@@ -86,4 +86,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:25](http
|
|
|
86
86
|
|
|
87
87
|
> `optional` **templateFormat**: `string`
|
|
88
88
|
|
|
89
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
89
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:24](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L24)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ProbabilityItem
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:1](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:1](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/calc-perplexity.ts#L1)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:1](htt
|
|
|
14
14
|
|
|
15
15
|
> `optional` **id**: `number`
|
|
16
16
|
|
|
17
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:5](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/calc-perplexity.ts#L5)
|
|
18
18
|
|
|
19
19
|
The id of the token.
|
|
20
20
|
|
|
@@ -24,7 +24,7 @@ The id of the token.
|
|
|
24
24
|
|
|
25
25
|
> **probability**: `number`
|
|
26
26
|
|
|
27
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
27
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:16](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/calc-perplexity.ts#L16)
|
|
28
28
|
|
|
29
29
|
The natural logarithm of the probability (log probability) assigned to this token.
|
|
30
30
|
Using log probabilities helps prevent numerical underflow when multiplying
|
|
@@ -36,6 +36,6 @@ many small probabilities together in language model calculations.
|
|
|
36
36
|
|
|
37
37
|
> **token**: `string`
|
|
38
38
|
|
|
39
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
39
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:9](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/calc-perplexity.ts#L9)
|
|
40
40
|
|
|
41
41
|
The token string being analyzed
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PromptExampleSelectorOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:5](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L5)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-sel
|
|
|
18
18
|
|
|
19
19
|
> `optional` **maxLength**: `number`
|
|
20
20
|
|
|
21
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
21
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:9](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L9)
|
|
22
22
|
|
|
23
23
|
The maximum count of the selected examples, or `undefined` if no limit.
|
|
24
24
|
|
|
@@ -28,7 +28,7 @@ The maximum count of the selected examples, or `undefined` if no limit.
|
|
|
28
28
|
|
|
29
29
|
> `optional` **threshold**: `number` \| `boolean`
|
|
30
30
|
|
|
31
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
31
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:14](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L14)
|
|
32
32
|
|
|
33
33
|
The threshold probability (0-1) at which a sample is selected.
|
|
34
34
|
If `true`, defaults to 0.5; if `false`, disable it.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PubSubClientStream
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:11](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/client.ts#L11)
|
|
10
10
|
|
|
11
11
|
Represents the client-side stream for a PubSub connection.
|
|
12
12
|
|
|
@@ -21,7 +21,7 @@ and managing the connection state.
|
|
|
21
21
|
|
|
22
22
|
> `optional` **addEventListener**: (`event`, `listener`) => `any`
|
|
23
23
|
|
|
24
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:
|
|
24
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:66](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/client.ts#L66)
|
|
25
25
|
|
|
26
26
|
Optional alias for the `on` method for compatibility with the
|
|
27
27
|
standard `EventTarget` interface.
|
|
@@ -34,7 +34,7 @@ standard `EventTarget` interface.
|
|
|
34
34
|
|
|
35
35
|
##### listener
|
|
36
36
|
|
|
37
|
-
(`data`, `ctx
|
|
37
|
+
(`data`, `ctx?`) => `void`
|
|
38
38
|
|
|
39
39
|
#### Returns
|
|
40
40
|
|
|
@@ -42,11 +42,23 @@ standard `EventTarget` interface.
|
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
45
|
+
### clientId
|
|
46
|
+
|
|
47
|
+
> **clientId**: `string`
|
|
48
|
+
|
|
49
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:17](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/client.ts#L17)
|
|
50
|
+
|
|
51
|
+
A unique identifier for this specific stream instance.
|
|
52
|
+
This ID is typically generated by the client transport and sent to the
|
|
53
|
+
server to establish a stable session identity.
|
|
54
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
45
57
|
### close()
|
|
46
58
|
|
|
47
59
|
> **close**: () => `void`
|
|
48
60
|
|
|
49
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:
|
|
61
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:50](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/client.ts#L50)
|
|
50
62
|
|
|
51
63
|
Closes the connection stream.
|
|
52
64
|
|
|
@@ -60,7 +72,7 @@ Closes the connection stream.
|
|
|
60
72
|
|
|
61
73
|
> **off**: (`event`, `listener`) => `void`
|
|
62
74
|
|
|
63
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:
|
|
75
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:45](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/client.ts#L45)
|
|
64
76
|
|
|
65
77
|
Removes a previously registered event listener.
|
|
66
78
|
|
|
@@ -74,7 +86,7 @@ The name of the event.
|
|
|
74
86
|
|
|
75
87
|
##### listener
|
|
76
88
|
|
|
77
|
-
(`data`, `ctx
|
|
89
|
+
(`data`, `ctx?`) => `void`
|
|
78
90
|
|
|
79
91
|
The listener function to remove.
|
|
80
92
|
|
|
@@ -88,7 +100,7 @@ The listener function to remove.
|
|
|
88
100
|
|
|
89
101
|
> **on**: (`event`, `listener`) => `any`
|
|
90
102
|
|
|
91
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:
|
|
103
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:38](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/client.ts#L38)
|
|
92
104
|
|
|
93
105
|
Registers a listener for a specific event from the server.
|
|
94
106
|
|
|
@@ -102,7 +114,7 @@ The name of the event to listen for.
|
|
|
102
114
|
|
|
103
115
|
##### listener
|
|
104
116
|
|
|
105
|
-
(`data`, `ctx
|
|
117
|
+
(`data`, `ctx?`) => `void`
|
|
106
118
|
|
|
107
119
|
The callback function to execute when the event is received.
|
|
108
120
|
It receives the event data and an optional context object.
|
|
@@ -117,7 +129,7 @@ The callback function to execute when the event is received.
|
|
|
117
129
|
|
|
118
130
|
> **protocol**: `string`
|
|
119
131
|
|
|
120
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:
|
|
132
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:22](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/client.ts#L22)
|
|
121
133
|
|
|
122
134
|
The protocol being used for this stream (e.g., 'sse', 'ws', 'ipc').
|
|
123
135
|
|
|
@@ -127,7 +139,7 @@ The protocol being used for this stream (e.g., 'sse', 'ws', 'ipc').
|
|
|
127
139
|
|
|
128
140
|
> `optional` **readyState**: `number`
|
|
129
141
|
|
|
130
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:
|
|
142
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:30](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/client.ts#L30)
|
|
131
143
|
|
|
132
144
|
Optional. Represents the state of the connection.
|
|
133
145
|
This is provided for compatibility with the `EventSource.readyState`
|
|
@@ -140,7 +152,7 @@ and `WebSocket.readyState` properties.
|
|
|
140
152
|
|
|
141
153
|
> `optional` **removeEventListener**: (`event`, `listener`) => `void`
|
|
142
154
|
|
|
143
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:
|
|
155
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:72](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/client.ts#L72)
|
|
144
156
|
|
|
145
157
|
Optional alias for the `off` method for compatibility with the
|
|
146
158
|
standard `EventTarget` interface.
|
|
@@ -153,7 +165,7 @@ standard `EventTarget` interface.
|
|
|
153
165
|
|
|
154
166
|
##### listener
|
|
155
167
|
|
|
156
|
-
(`data`, `ctx
|
|
168
|
+
(`data`, `ctx?`) => `void`
|
|
157
169
|
|
|
158
170
|
#### Returns
|
|
159
171
|
|
|
@@ -163,9 +175,9 @@ standard `EventTarget` interface.
|
|
|
163
175
|
|
|
164
176
|
### send()?
|
|
165
177
|
|
|
166
|
-
> `optional` **send**: (`event`, `data`, `ctx
|
|
178
|
+
> `optional` **send**: (`event`, `data`, `ctx?`) => `void`
|
|
167
179
|
|
|
168
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:
|
|
180
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/client.ts:60](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/client.ts#L60)
|
|
169
181
|
|
|
170
182
|
Optional. Sends a message from the client to the server.
|
|
171
183
|
This method is only available for bidirectional transports like WebSockets or IPC.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: PubSubServerSession
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:14](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/server.ts#L14)
|
|
10
10
|
|
|
11
11
|
Represents an active client connection session on the server.
|
|
12
12
|
This object provides a standardized way for the `EventServer` to interact
|
|
@@ -18,7 +18,7 @@ with a connection, regardless of the underlying transport protocol.
|
|
|
18
18
|
|
|
19
19
|
> `optional` **clientId**: `string`
|
|
20
20
|
|
|
21
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:
|
|
21
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:22](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/server.ts#L22)
|
|
22
22
|
|
|
23
23
|
The unique identifier for the client associated with this session.
|
|
24
24
|
|
|
@@ -28,7 +28,7 @@ The unique identifier for the client associated with this session.
|
|
|
28
28
|
|
|
29
29
|
> **close**: () => `void`
|
|
30
30
|
|
|
31
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:
|
|
31
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:37](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/server.ts#L37)
|
|
32
32
|
|
|
33
33
|
Closes the connection for this session.
|
|
34
34
|
|
|
@@ -42,7 +42,7 @@ Closes the connection for this session.
|
|
|
42
42
|
|
|
43
43
|
> **id**: `string`
|
|
44
44
|
|
|
45
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:
|
|
45
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:18](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/server.ts#L18)
|
|
46
46
|
|
|
47
47
|
A unique identifier for the session, typically generated by the transport layer upon connection.
|
|
48
48
|
|
|
@@ -52,7 +52,7 @@ A unique identifier for the session, typically generated by the transport layer
|
|
|
52
52
|
|
|
53
53
|
> **protocol**: `string`
|
|
54
54
|
|
|
55
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:
|
|
55
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:26](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/server.ts#L26)
|
|
56
56
|
|
|
57
57
|
The protocol being used for this session (e.g., 'sse', 'ws', 'ipc').
|
|
58
58
|
|
|
@@ -62,7 +62,7 @@ The protocol being used for this session (e.g., 'sse', 'ws', 'ipc').
|
|
|
62
62
|
|
|
63
63
|
> `optional` **raw**: `any`
|
|
64
64
|
|
|
65
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:
|
|
65
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:43](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/server.ts#L43)
|
|
66
66
|
|
|
67
67
|
A reference to the raw, underlying connection object or handle
|
|
68
68
|
(e.g., a Node.js `ServerResponse` for SSE, or a WebSocket instance).
|
|
@@ -72,9 +72,9 @@ Use with caution as it is transport-specific.
|
|
|
72
72
|
|
|
73
73
|
### send()
|
|
74
74
|
|
|
75
|
-
> **send**: (`event`, `data`, `ctx
|
|
75
|
+
> **send**: (`event`, `data`, `ctx?`) => `void`
|
|
76
76
|
|
|
77
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:
|
|
77
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:33](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/pubsub/server.ts#L33)
|
|
78
78
|
|
|
79
79
|
Sends an event and data to the client associated with this session.
|
|
80
80
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: RemoteFuncItem
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:83](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:83](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/consts.ts#L83)
|
|
10
10
|
|
|
11
11
|
Base interface for a remote function's configuration, extending `BaseFuncItem`
|
|
12
12
|
with properties required for remote execution.
|
|
@@ -26,7 +26,7 @@ with properties required for remote execution.
|
|
|
26
26
|
|
|
27
27
|
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
28
28
|
|
|
29
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/
|
|
29
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:95](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/consts.ts#L95)
|
|
30
30
|
|
|
31
31
|
The action to be used for the remote call. This typically represents an RPC method name.
|
|
32
32
|
Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (e.g., GET, POST)
|
|
@@ -37,7 +37,7 @@ Only for RESTful HTTP transports, it might be mapped to a standard HTTP method (
|
|
|
37
37
|
|
|
38
38
|
> `optional` **alias**: `string` \| `string`[]
|
|
39
39
|
|
|
40
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/
|
|
40
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:130](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L130)
|
|
41
41
|
|
|
42
42
|
Optional aliases for the function name.
|
|
43
43
|
|
|
@@ -51,7 +51,7 @@ Optional aliases for the function name.
|
|
|
51
51
|
|
|
52
52
|
> `optional` **apiRoot**: `string`
|
|
53
53
|
|
|
54
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/
|
|
54
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:89](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/consts.ts#L89)
|
|
55
55
|
|
|
56
56
|
The root endpoint for the remote service.
|
|
57
57
|
|
|
@@ -65,7 +65,7 @@ Use `transport` instead.
|
|
|
65
65
|
|
|
66
66
|
> `optional` **asyncFeatures**: `number`
|
|
67
67
|
|
|
68
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/
|
|
68
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:144](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L144)
|
|
69
69
|
|
|
70
70
|
A bitmask representing asynchronous features supported by the function, built from `AsyncFeatureBits`.
|
|
71
71
|
This allows the system to understand if a function supports capabilities like cancellation or multi-tasking.
|
|
@@ -95,7 +95,7 @@ const func = new ToolFunc({
|
|
|
95
95
|
|
|
96
96
|
> `optional` **depends**: `object`
|
|
97
97
|
|
|
98
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/
|
|
98
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L167)
|
|
99
99
|
|
|
100
100
|
A map of dependencies this function has on other tool functions.
|
|
101
101
|
Declaring dependencies ensures that they are automatically registered when this function is registered.
|
|
@@ -134,7 +134,7 @@ mainFunc.register();
|
|
|
134
134
|
|
|
135
135
|
> `optional` **description**: `string`
|
|
136
136
|
|
|
137
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/
|
|
137
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:172](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L172)
|
|
138
138
|
|
|
139
139
|
A detailed description of what the function does.
|
|
140
140
|
|
|
@@ -144,17 +144,13 @@ A detailed description of what the function does.
|
|
|
144
144
|
|
|
145
145
|
***
|
|
146
146
|
|
|
147
|
-
###
|
|
147
|
+
### fetchOptions?
|
|
148
148
|
|
|
149
149
|
> `optional` **fetchOptions**: `any`
|
|
150
150
|
|
|
151
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:
|
|
151
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/consts.ts:100](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/consts.ts#L100)
|
|
152
152
|
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
#### Deprecated
|
|
156
|
-
|
|
157
|
-
Use `transport` instead.
|
|
153
|
+
Addtional options to be passed to the underlying `fetch` call in a transport.
|
|
158
154
|
|
|
159
155
|
***
|
|
160
156
|
|
|
@@ -162,7 +158,7 @@ Use `transport` instead.
|
|
|
162
158
|
|
|
163
159
|
> `optional` **isApi**: `boolean`
|
|
164
160
|
|
|
165
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/
|
|
161
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:119](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L119)
|
|
166
162
|
|
|
167
163
|
If true, indicates that this function should be treated as a server-side API.
|
|
168
164
|
|
|
@@ -176,13 +172,13 @@ If true, indicates that this function should be treated as a server-side API.
|
|
|
176
172
|
|
|
177
173
|
> `optional` **name**: `string`
|
|
178
174
|
|
|
179
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/
|
|
175
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:76](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L76)
|
|
180
176
|
|
|
181
177
|
The unique name of the function.
|
|
182
178
|
|
|
183
179
|
#### Inherited from
|
|
184
180
|
|
|
185
|
-
[`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name
|
|
181
|
+
[`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name)
|
|
186
182
|
|
|
187
183
|
***
|
|
188
184
|
|
|
@@ -190,7 +186,7 @@ The unique name of the function.
|
|
|
190
186
|
|
|
191
187
|
> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
|
|
192
188
|
|
|
193
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/
|
|
189
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:81](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L81)
|
|
194
190
|
|
|
195
191
|
Parameter definitions, which can be an object mapping names to definitions or an array for positional parameters.
|
|
196
192
|
|
|
@@ -204,7 +200,7 @@ Parameter definitions, which can be an object mapping names to definitions or an
|
|
|
204
200
|
|
|
205
201
|
> `optional` **result**: `string` \| `Record`\<`string`, `any`\>
|
|
206
202
|
|
|
207
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/
|
|
203
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:86](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L86)
|
|
208
204
|
|
|
209
205
|
The expected return type of the function, described as a string or a JSON schema object.
|
|
210
206
|
|
|
@@ -218,7 +214,7 @@ The expected return type of the function, described as a string or a JSON schema
|
|
|
218
214
|
|
|
219
215
|
> `optional` **scope**: `any`
|
|
220
216
|
|
|
221
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/
|
|
217
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:91](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L91)
|
|
222
218
|
|
|
223
219
|
The execution scope or context (`this`) for the function.
|
|
224
220
|
|
|
@@ -230,9 +226,9 @@ The execution scope or context (`this`) for the function.
|
|
|
230
226
|
|
|
231
227
|
### setup()?
|
|
232
228
|
|
|
233
|
-
> `optional` **setup**: (`this`, `options
|
|
229
|
+
> `optional` **setup**: (`this`, `options?`) => `void`
|
|
234
230
|
|
|
235
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/
|
|
231
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:114](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L114)
|
|
236
232
|
|
|
237
233
|
A lifecycle hook called once during the `ToolFunc` instance's initialization.
|
|
238
234
|
It allows for initial setup, state configuration, or property modification on the instance
|
|
@@ -278,7 +274,7 @@ console.log(myFunc.customState); // Outputs: 'configured'
|
|
|
278
274
|
|
|
279
275
|
> `optional` **stream**: `boolean`
|
|
280
276
|
|
|
281
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/
|
|
277
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:125](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L125)
|
|
282
278
|
|
|
283
279
|
If true, indicates that the function has the *capability* to stream its output.
|
|
284
280
|
Whether a specific call is streamed is determined by a `stream` property in the runtime parameters.
|
|
@@ -293,7 +289,7 @@ Whether a specific call is streamed is determined by a `stream` property in the
|
|
|
293
289
|
|
|
294
290
|
> `optional` **tags**: `string` \| `string`[]
|
|
295
291
|
|
|
296
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/
|
|
292
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:96](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L96)
|
|
297
293
|
|
|
298
294
|
Tags for grouping or filtering functions.
|
|
299
295
|
|
|
@@ -307,7 +303,7 @@ Tags for grouping or filtering functions.
|
|
|
307
303
|
|
|
308
304
|
> `optional` **title**: `string`
|
|
309
305
|
|
|
310
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/
|
|
306
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/tool-func.ts:177](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/tool-func.ts#L177)
|
|
311
307
|
|
|
312
308
|
A concise, human-readable title for the function, often used in UI or by AI.
|
|
313
309
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ReplacePlacehoderOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:464](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:464](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L464)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:464](htt
|
|
|
14
14
|
|
|
15
15
|
> `optional` **endChar**: `string` \| `string`[]
|
|
16
16
|
|
|
17
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:466](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:466](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L466)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:466](htt
|
|
|
22
22
|
|
|
23
23
|
> `optional` **placehoders**: `string`[]
|
|
24
24
|
|
|
25
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:468](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:468](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L468)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:468](htt
|
|
|
30
30
|
|
|
31
31
|
> `optional` **placeholder**: `string`
|
|
32
32
|
|
|
33
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:467](https://github.com/isdk/ai-tool.js/blob/
|
|
33
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:467](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L467)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,4 +38,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:467](htt
|
|
|
38
38
|
|
|
39
39
|
> `optional` **startChar**: `string` \| `string`[]
|
|
40
40
|
|
|
41
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:465](https://github.com/isdk/ai-tool.js/blob/
|
|
41
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/parse-command.ts:465](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/parse-command.ts#L465)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ResClientFuncParams
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-client-tools.ts#L5)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:5](https://
|
|
|
22
22
|
|
|
23
23
|
> `optional` **act**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:5](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/rpc-methods-client-tool.ts#L5)
|
|
26
26
|
|
|
27
27
|
#### Inherited from
|
|
28
28
|
|
|
@@ -34,4 +34,4 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/rpc-methods-client-tool.ts:5](h
|
|
|
34
34
|
|
|
35
35
|
> `optional` **id**: `string` \| `number`
|
|
36
36
|
|
|
37
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/
|
|
37
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/res-client-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/res-client-tools.ts#L6)
|