@isdk/ai-tool 0.8.0 → 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/docs/api/classes/BinarySemaphore.md +25 -25
- package/docs/api/classes/CancelableAbility.md +25 -25
- package/docs/api/classes/ClientToolTransport.md +12 -12
- package/docs/api/classes/ClientTools.md +61 -61
- package/docs/api/classes/EventClient.md +88 -88
- package/docs/api/classes/EventServer.md +83 -83
- package/docs/api/classes/EventToolFunc.md +52 -52
- package/docs/api/classes/FewShotPromptTemplate.md +11 -11
- package/docs/api/classes/HttpClientToolTransport.md +13 -13
- package/docs/api/classes/HttpServerToolTransport.md +15 -15
- package/docs/api/classes/IntSet.md +12 -12
- package/docs/api/classes/PromptExampleSelector.md +9 -9
- package/docs/api/classes/ReadableStreamError.md +2 -2
- package/docs/api/classes/ResClientTools.md +68 -68
- package/docs/api/classes/ResServerTools.md +69 -69
- package/docs/api/classes/RpcMethodsClientTool.md +63 -63
- package/docs/api/classes/RpcMethodsServerTool.md +64 -64
- package/docs/api/classes/SSEChannel.md +19 -19
- package/docs/api/classes/Semaphore.md +26 -26
- package/docs/api/classes/ServerToolTransport.md +13 -13
- package/docs/api/classes/ServerTools.md +57 -57
- package/docs/api/classes/SignalGate.md +9 -9
- package/docs/api/classes/SseClientPubSubTransport.md +4 -4
- package/docs/api/classes/SseServerPubSubTransport.md +10 -10
- package/docs/api/classes/TaskAbortController.md +8 -8
- package/docs/api/classes/ToolFunc.md +50 -50
- package/docs/api/classes/ToolTransport.md +7 -7
- package/docs/api/classes/YamlTypeBaseObject.md +2 -2
- 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 +1 -1
- package/docs/api/functions/AIStream.md +1 -1
- package/docs/api/functions/ChoiceArgProcessor.md +1 -1
- package/docs/api/functions/DefaultDateFormat.md +1 -1
- package/docs/api/functions/ObjectArgsToArgsInfo.md +1 -1
- package/docs/api/functions/RateLimit.md +1 -1
- package/docs/api/functions/TemplateArgProcessor.md +1 -1
- package/docs/api/functions/assignDirs.md +1 -1
- package/docs/api/functions/beforeShutdown.md +1 -1
- package/docs/api/functions/calcPerplexity.md +1 -1
- package/docs/api/functions/calcPerplexitySimple.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/createCallbacksTransformer.md +1 -1
- package/docs/api/functions/createEmptyReadableStream.md +1 -1
- package/docs/api/functions/createEndWithRepetitionDetector.md +1 -1
- package/docs/api/functions/createEventStreamTransformer.md +1 -1
- package/docs/api/functions/createLRUCache.md +1 -1
- package/docs/api/functions/createYamlObjectTag.md +1 -1
- package/docs/api/functions/dateToText.md +1 -1
- package/docs/api/functions/decodeCharset.md +1 -1
- package/docs/api/functions/defaultsWithConcat.md +1 -1
- package/docs/api/functions/detectCharset.md +1 -1
- package/docs/api/functions/encodeLLMTokens.md +1 -1
- package/docs/api/functions/ensureQuoted.md +1 -1
- package/docs/api/functions/expandConfig.md +1 -1
- package/docs/api/functions/expandPath.md +1 -1
- package/docs/api/functions/expandPathInObject.md +1 -1
- package/docs/api/functions/expandPaths.md +1 -1
- package/docs/api/functions/fileIsExists.md +1 -1
- package/docs/api/functions/filterValidFnScope.md +1 -1
- package/docs/api/functions/findIndexNonEmptyFrom.md +1 -1
- package/docs/api/functions/findPort.md +1 -1
- package/docs/api/functions/formatTextWithSpace.md +1 -1
- package/docs/api/functions/funcGetMeta.md +1 -1
- package/docs/api/functions/funcWithMeta.md +1 -1
- package/docs/api/functions/genUrlParamsStr.md +1 -1
- package/docs/api/functions/getAllEnumKeys.md +1 -1
- package/docs/api/functions/getConfigFileNames.md +1 -1
- package/docs/api/functions/getConfigs.md +1 -1
- package/docs/api/functions/getFileMetaInfo.md +1 -1
- package/docs/api/functions/getHashAlgoBySize.md +1 -1
- package/docs/api/functions/getKeysPath.md +1 -1
- package/docs/api/functions/getLLMTokenizer.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 +1 -1
- package/docs/api/functions/getXDGConfigs.md +1 -1
- package/docs/api/functions/hasDirectoryIn.md +1 -1
- package/docs/api/functions/hash.md +1 -1
- package/docs/api/functions/hashFile.md +1 -1
- package/docs/api/functions/hashObject.md +1 -1
- 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 +1 -1
- 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 +1 -1
- 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 +1 -1
- package/docs/api/functions/isWebStream.md +1 -1
- package/docs/api/functions/joinSplitWords.md +1 -1
- package/docs/api/functions/jsonFilterToWhere.md +1 -1
- package/docs/api/functions/jsonToMarkdownStr.md +1 -1
- 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 +1 -1
- package/docs/api/functions/loadTextFromPaths.md +1 -1
- package/docs/api/functions/lrucache.md +1 -1
- package/docs/api/functions/matchUrlProtocol.md +1 -1
- package/docs/api/functions/memoize.md +1 -1
- package/docs/api/functions/mergeArray.md +1 -1
- package/docs/api/functions/messagesToText.md +1 -1
- package/docs/api/functions/normalizePath.md +1 -1
- package/docs/api/functions/paramsSizeToScaleStr.md +1 -1
- package/docs/api/functions/parseCommand.md +1 -1
- package/docs/api/functions/parseJsJson.md +1 -1
- package/docs/api/functions/parseJsJsonSimpleSync.md +1 -1
- package/docs/api/functions/parseObjectArgInfo.md +1 -1
- package/docs/api/functions/parseObjectArgumentInfos.md +1 -1
- package/docs/api/functions/parseObjectArguments.md +1 -1
- package/docs/api/functions/parseObjectArgumentsAsArgInfos.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 +1 -1
- package/docs/api/functions/readTextFileChunks.md +1 -1
- package/docs/api/functions/readTextFileChunksEx.md +1 -1
- package/docs/api/functions/readableFromAsyncIterable.md +1 -1
- package/docs/api/functions/registerCoreTools.md +1 -1
- package/docs/api/functions/removeMarkdownBold.md +1 -1
- package/docs/api/functions/removeMarkdownBoldAndItalic.md +1 -1
- package/docs/api/functions/removeMarkdownItalic.md +1 -1
- package/docs/api/functions/replaceWithPlaceholder.md +1 -1
- package/docs/api/functions/restoreFromPlacehoders.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 +1 -1
- package/docs/api/functions/splitChunks.md +1 -1
- package/docs/api/functions/splitParagraph.md +1 -1
- package/docs/api/functions/splitSentence.md +1 -1
- package/docs/api/functions/splitWords.md +1 -1
- package/docs/api/functions/stripConsoleColor.md +1 -1
- package/docs/api/functions/textToDate.md +1 -1
- package/docs/api/functions/toDateTime.md +1 -1
- package/docs/api/functions/trimStartOfStreamHelper.md +1 -1
- package/docs/api/functions/truncTo.md +1 -1
- package/docs/api/functions/truncateByToken.md +1 -1
- package/docs/api/functions/truncateToTokenLimit.md +1 -1
- package/docs/api/functions/truncateToTokenLimitEx.md +1 -1
- package/docs/api/functions/uuid.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/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 +6 -6
- package/docs/api/interfaces/AIStreamParser.md +2 -2
- package/docs/api/interfaces/AIStreamParserOptions.md +2 -2
- package/docs/api/interfaces/BaseFunc.md +15 -15
- package/docs/api/interfaces/BaseFuncItem.md +14 -14
- 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 +17 -17
- package/docs/api/interfaces/EventClientFuncParams.md +5 -5
- package/docs/api/interfaces/EventServerFuncParams.md +7 -7
- package/docs/api/interfaces/FewShotPromptTemplateOptions.md +6 -6
- package/docs/api/interfaces/FuncItem.md +15 -15
- 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 +7 -7
- package/docs/api/interfaces/IFileMetaInfo.md +8 -8
- package/docs/api/interfaces/IPubSubClientTransport.md +4 -4
- package/docs/api/interfaces/IPubSubServerTransport.md +11 -11
- package/docs/api/interfaces/IReadTextFileChunksOptions.md +11 -11
- package/docs/api/interfaces/IServerToolTransport.md +8 -8
- package/docs/api/interfaces/IToolTransport.md +5 -5
- package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +10 -10
- 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 +10 -10
- package/docs/api/interfaces/PubSubServerSession.md +7 -7
- package/docs/api/interfaces/RemoteFuncItem.md +17 -17
- 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 +5 -5
- package/docs/api/interfaces/ServerFuncItem.md +18 -18
- package/docs/api/interfaces/ServerFuncParams.md +3 -3
- package/docs/api/interfaces/SplitSentenceOptions.md +5 -5
- package/docs/api/interfaces/StreamCallbacksAndOptions.md +5 -5
- package/docs/api/interfaces/TaskAbortControllers.md +1 -1
- package/docs/api/interfaces/TaskPromise.md +2 -2
- package/docs/api/interfaces/ToolFuncPackage.md +4 -4
- package/docs/api/type-aliases/AIChatContentPart.md +1 -1
- package/docs/api/type-aliases/AIChatMessageParam.md +1 -1
- package/docs/api/type-aliases/AIChatRole.md +1 -1
- package/docs/api/type-aliases/AIChatToolChoiceParam.md +1 -1
- package/docs/api/type-aliases/AIMessageType.md +1 -1
- package/docs/api/type-aliases/AIModelNameRule.md +1 -1
- package/docs/api/type-aliases/AIModelNameRuleFn.md +1 -1
- package/docs/api/type-aliases/AIModelNameRules.md +1 -1
- package/docs/api/type-aliases/AITextGenerationFinishReason.md +1 -1
- package/docs/api/type-aliases/ActionName.md +1 -1
- package/docs/api/type-aliases/ArrayMergeWay.md +1 -1
- package/docs/api/type-aliases/AsyncTaskId.md +1 -1
- package/docs/api/type-aliases/BeforeShutdownListener.md +1 -1
- package/docs/api/type-aliases/EventErrorListenerFn.md +1 -1
- package/docs/api/type-aliases/EventListenerFn.md +1 -1
- package/docs/api/type-aliases/FuncParamType.md +1 -1
- package/docs/api/type-aliases/PromptExamples.md +1 -1
- package/docs/api/type-aliases/PubSubClientId.md +1 -1
- package/docs/api/type-aliases/PubSubCtx.md +6 -6
- package/docs/api/type-aliases/RpcMethodHandler.md +1 -1
- package/docs/api/type-aliases/SSEClient.md +5 -5
- package/docs/api/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/api/type-aliases/TFunc.md +1 -1
- package/docs/api/type-aliases/UUIDVersions.md +1 -1
- 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 +1 -1
- package/docs/api/variables/ArrayMergeWaySymbol.md +1 -1
- package/docs/api/variables/ClientEventPrefix.md +1 -1
- package/docs/api/variables/ClientToolFuncSchema.md +1 -1
- 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 +1 -1
- package/docs/api/variables/LLM_TOKENIZER_NAMES.md +1 -1
- 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 +1 -1
- package/docs/api/variables/ResponseRStreamErrCode.md +1 -1
- package/docs/api/variables/RpcMethodsClientToolSchema.md +1 -1
- package/docs/api/variables/RpcMethodsServerToolSchema.md +1 -1
- 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 +1 -1
- 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 +1 -1
- package/docs/api/variables/backendEventable.md +1 -1
- 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 +1 -1
- package/docs/api/variables/wait.md +1 -1
- package/package.json +3 -3
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: HttpClientToolTransport
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:9](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-client.ts#L9)
|
|
10
10
|
|
|
11
11
|
A concrete client transport implementation that uses the browser/node `fetch` API.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ A concrete client transport implementation that uses the browser/node `fetch` AP
|
|
|
20
20
|
|
|
21
21
|
> **new HttpClientToolTransport**(`apiRoot`): `HttpClientToolTransport`
|
|
22
22
|
|
|
23
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:41](https://github.com/isdk/ai-tool.js/blob/
|
|
23
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:41](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/client.ts#L41)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -42,7 +42,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:41](https:
|
|
|
42
42
|
|
|
43
43
|
> **apiRoot**: `string`
|
|
44
44
|
|
|
45
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:37](https://github.com/isdk/ai-tool.js/blob/
|
|
45
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:37](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/client.ts#L37)
|
|
46
46
|
|
|
47
47
|
The root endpoint for the remote service.
|
|
48
48
|
For HTTP, this is a URL. For IPC, it could be a channel name.
|
|
@@ -57,7 +57,7 @@ For HTTP, this is a URL. For IPC, it could be a channel name.
|
|
|
57
57
|
|
|
58
58
|
> `optional` **options**: `any`
|
|
59
59
|
|
|
60
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:36](https://github.com/isdk/ai-tool.js/blob/
|
|
60
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:36](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/base.ts#L36)
|
|
61
61
|
|
|
62
62
|
Additional options for the transport start or fetch, passed by mount.
|
|
63
63
|
|
|
@@ -71,7 +71,7 @@ Additional options for the transport start or fetch, passed by mount.
|
|
|
71
71
|
|
|
72
72
|
> **Tools**: *typeof* [`ClientTools`](ClientTools.md)
|
|
73
73
|
|
|
74
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
74
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:38](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/client.ts#L38)
|
|
75
75
|
|
|
76
76
|
#### Inherited from
|
|
77
77
|
|
|
@@ -83,7 +83,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:38](https:
|
|
|
83
83
|
|
|
84
84
|
> **\_fetch**(`name`, `args?`, `act?`, `subName?`, `fetchOptions?`): `Promise`\<`Response`\>
|
|
85
85
|
|
|
86
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
86
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:26](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-client.ts#L26)
|
|
87
87
|
|
|
88
88
|
#### Parameters
|
|
89
89
|
|
|
@@ -121,7 +121,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:26](h
|
|
|
121
121
|
|
|
122
122
|
> **\_mount**(`clientTools`, `apiPrefix`, `options?`): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
|
|
123
123
|
|
|
124
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:49](https://github.com/isdk/ai-tool.js/blob/
|
|
124
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:49](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/client.ts#L49)
|
|
125
125
|
|
|
126
126
|
#### Parameters
|
|
127
127
|
|
|
@@ -151,7 +151,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:49](https:
|
|
|
151
151
|
|
|
152
152
|
> **errorFrom**(`name`, `res`): `Promise`\<[`CommonError`](CommonError.md)\>
|
|
153
153
|
|
|
154
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:84](https://github.com/isdk/ai-tool.js/blob/
|
|
154
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:84](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-client.ts#L84)
|
|
155
155
|
|
|
156
156
|
**`Internal`**
|
|
157
157
|
|
|
@@ -181,7 +181,7 @@ A structured error object.
|
|
|
181
181
|
|
|
182
182
|
> **fetch**(`name`, `args?`, `act?`, `subName?`, `fetchOptions?`): `Promise`\<`any`\>
|
|
183
183
|
|
|
184
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:64](https://github.com/isdk/ai-tool.js/blob/
|
|
184
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/client.ts:64](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/client.ts#L64)
|
|
185
185
|
|
|
186
186
|
Fetches data from the server.
|
|
187
187
|
|
|
@@ -231,7 +231,7 @@ A promise that resolves with the fetched data.
|
|
|
231
231
|
|
|
232
232
|
> **loadApis**(): `Promise`\<[`Funcs`](../interfaces/Funcs.md)\>
|
|
233
233
|
|
|
234
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:15](https://github.com/isdk/ai-tool.js/blob/
|
|
234
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:15](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-client.ts#L15)
|
|
235
235
|
|
|
236
236
|
Connects to the server's discovery endpoint to get the list of available tools.
|
|
237
237
|
|
|
@@ -251,7 +251,7 @@ A promise that resolves to a map of tool function metadata.
|
|
|
251
251
|
|
|
252
252
|
> **mount**(`Tools`, `apiRoot?`, `options?`): `any`
|
|
253
253
|
|
|
254
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:42](https://github.com/isdk/ai-tool.js/blob/
|
|
254
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:42](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/base.ts#L42)
|
|
255
255
|
|
|
256
256
|
#### Parameters
|
|
257
257
|
|
|
@@ -281,7 +281,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:42](https://
|
|
|
281
281
|
|
|
282
282
|
> **setApiRoot**(`apiRoot`): `void`
|
|
283
283
|
|
|
284
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
284
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/base.ts#L38)
|
|
285
285
|
|
|
286
286
|
#### Parameters
|
|
287
287
|
|
|
@@ -303,7 +303,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://
|
|
|
303
303
|
|
|
304
304
|
> **toObject**(`res`, `args?`): `Promise`\<`any`\>
|
|
305
305
|
|
|
306
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:114](https://github.com/isdk/ai-tool.js/blob/
|
|
306
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-client.ts:114](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-client.ts#L114)
|
|
307
307
|
|
|
308
308
|
#### Parameters
|
|
309
309
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: HttpServerToolTransport
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:12](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-server.ts#L12)
|
|
10
10
|
|
|
11
11
|
A concrete server transport implementation using Node.js's built-in HTTP server.
|
|
12
12
|
|
|
@@ -20,7 +20,7 @@ A concrete server transport implementation using Node.js's built-in HTTP server.
|
|
|
20
20
|
|
|
21
21
|
> **new HttpServerToolTransport**(`options?`): `HttpServerToolTransport`
|
|
22
22
|
|
|
23
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
23
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:16](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-server.ts#L16)
|
|
24
24
|
|
|
25
25
|
#### Parameters
|
|
26
26
|
|
|
@@ -42,7 +42,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:16](h
|
|
|
42
42
|
|
|
43
43
|
> **apiRoot**: `string`
|
|
44
44
|
|
|
45
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:48](https://github.com/isdk/ai-tool.js/blob/
|
|
45
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:48](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/server.ts#L48)
|
|
46
46
|
|
|
47
47
|
The root endpoint for the remote service.
|
|
48
48
|
For HTTP, this is a URL. For IPC, it could be a channel name.
|
|
@@ -57,7 +57,7 @@ For HTTP, this is a URL. For IPC, it could be a channel name.
|
|
|
57
57
|
|
|
58
58
|
> `optional` **options**: `any`
|
|
59
59
|
|
|
60
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:50](https://github.com/isdk/ai-tool.js/blob/
|
|
60
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:50](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/server.ts#L50)
|
|
61
61
|
|
|
62
62
|
Additional options for the transport start or fetch, passed by mount.
|
|
63
63
|
|
|
@@ -71,7 +71,7 @@ Additional options for the transport start or fetch, passed by mount.
|
|
|
71
71
|
|
|
72
72
|
> **server**: `Server`
|
|
73
73
|
|
|
74
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
74
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:13](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-server.ts#L13)
|
|
75
75
|
|
|
76
76
|
***
|
|
77
77
|
|
|
@@ -79,7 +79,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:13](h
|
|
|
79
79
|
|
|
80
80
|
> **Tools**: *typeof* [`ServerTools`](ServerTools.md)
|
|
81
81
|
|
|
82
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:49](https://github.com/isdk/ai-tool.js/blob/
|
|
82
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:49](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/server.ts#L49)
|
|
83
83
|
|
|
84
84
|
#### Inherited from
|
|
85
85
|
|
|
@@ -91,7 +91,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:49](https:
|
|
|
91
91
|
|
|
92
92
|
> **\_mount**(`Tools`, `apiPrefix`, `options?`): `void`
|
|
93
93
|
|
|
94
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:52](https://github.com/isdk/ai-tool.js/blob/
|
|
94
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:52](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/server.ts#L52)
|
|
95
95
|
|
|
96
96
|
#### Parameters
|
|
97
97
|
|
|
@@ -121,7 +121,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:52](https:
|
|
|
121
121
|
|
|
122
122
|
> **\_start**(`options`): `Promise`\<`void`\>
|
|
123
123
|
|
|
124
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:160](https://github.com/isdk/ai-tool.js/blob/
|
|
124
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:160](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-server.ts#L160)
|
|
125
125
|
|
|
126
126
|
#### Parameters
|
|
127
127
|
|
|
@@ -149,7 +149,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:160](
|
|
|
149
149
|
|
|
150
150
|
> **addDiscoveryHandler**(`apiPrefix`, `handler`): `void`
|
|
151
151
|
|
|
152
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:61](https://github.com/isdk/ai-tool.js/blob/
|
|
152
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:61](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-server.ts#L61)
|
|
153
153
|
|
|
154
154
|
#### Parameters
|
|
155
155
|
|
|
@@ -175,7 +175,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:61](h
|
|
|
175
175
|
|
|
176
176
|
> **addRpcHandler**(`serverTools`, `apiPrefix`, `options?`): `void`
|
|
177
177
|
|
|
178
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:66](https://github.com/isdk/ai-tool.js/blob/
|
|
178
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:66](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-server.ts#L66)
|
|
179
179
|
|
|
180
180
|
#### Parameters
|
|
181
181
|
|
|
@@ -205,7 +205,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:66](h
|
|
|
205
205
|
|
|
206
206
|
> **getRaw**(): `Server`
|
|
207
207
|
|
|
208
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:193](https://github.com/isdk/ai-tool.js/blob/
|
|
208
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:193](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-server.ts#L193)
|
|
209
209
|
|
|
210
210
|
Gets the underlying raw server instance.
|
|
211
211
|
|
|
@@ -223,7 +223,7 @@ Gets the underlying raw server instance.
|
|
|
223
223
|
|
|
224
224
|
> **mount**(`Tools`, `apiRoot?`, `options?`): `any`
|
|
225
225
|
|
|
226
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:42](https://github.com/isdk/ai-tool.js/blob/
|
|
226
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:42](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/base.ts#L42)
|
|
227
227
|
|
|
228
228
|
Mounts the ServerTools registry, creating the necessary API routes.
|
|
229
229
|
|
|
@@ -266,7 +266,7 @@ A container for transport-specific options. For example,
|
|
|
266
266
|
|
|
267
267
|
> **setApiRoot**(`apiRoot`): `void`
|
|
268
268
|
|
|
269
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
269
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/base.ts#L38)
|
|
270
270
|
|
|
271
271
|
#### Parameters
|
|
272
272
|
|
|
@@ -288,7 +288,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:38](https://
|
|
|
288
288
|
|
|
289
289
|
> **start**(`options?`): `Promise`\<`any`\>
|
|
290
290
|
|
|
291
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:58](https://github.com/isdk/ai-tool.js/blob/
|
|
291
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:58](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/server.ts#L58)
|
|
292
292
|
|
|
293
293
|
Starts the transport layer, making it listen for incoming connections.
|
|
294
294
|
|
|
@@ -314,7 +314,7 @@ Protocol-specific options (e.g., { port, host }).
|
|
|
314
314
|
|
|
315
315
|
> **stop**(`force?`): `Promise`\<`void`\>
|
|
316
316
|
|
|
317
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:176](https://github.com/isdk/ai-tool.js/blob/
|
|
317
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/http-server.ts:176](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/transports/http-server.ts#L176)
|
|
318
318
|
|
|
319
319
|
Stops the server instance gracefully.
|
|
320
320
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: IntSet
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:6](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:6](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L6)
|
|
10
10
|
|
|
11
11
|
Represents a set of integers using a bit field.
|
|
12
12
|
Each bit in the bit field represents an integer starting from 0,
|
|
@@ -18,7 +18,7 @@ where the flag value 0 represents the 0th bit, 1 represents the 1st bit, and so
|
|
|
18
18
|
|
|
19
19
|
> **new IntSet**(`bitField`): `IntSet`
|
|
20
20
|
|
|
21
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:21](https://github.com/isdk/ai-tool.js/blob/
|
|
21
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:21](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L21)
|
|
22
22
|
|
|
23
23
|
#### Parameters
|
|
24
24
|
|
|
@@ -36,7 +36,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:21](https://git
|
|
|
36
36
|
|
|
37
37
|
> **add**(`flag`): `IntSet`
|
|
38
38
|
|
|
39
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
39
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:29](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L29)
|
|
40
40
|
|
|
41
41
|
Adds an element to the set.
|
|
42
42
|
|
|
@@ -59,7 +59,7 @@ The flag value representing the bit position to set.
|
|
|
59
59
|
|
|
60
60
|
> **clear**(): `IntSet`
|
|
61
61
|
|
|
62
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:57](https://github.com/isdk/ai-tool.js/blob/
|
|
62
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:57](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L57)
|
|
63
63
|
|
|
64
64
|
Clears all elements from the set.
|
|
65
65
|
|
|
@@ -73,7 +73,7 @@ Clears all elements from the set.
|
|
|
73
73
|
|
|
74
74
|
> **delete**(`flag`): `IntSet`
|
|
75
75
|
|
|
76
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:39](https://github.com/isdk/ai-tool.js/blob/
|
|
76
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:39](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L39)
|
|
77
77
|
|
|
78
78
|
Removes an element from the set.
|
|
79
79
|
|
|
@@ -95,7 +95,7 @@ The flag value representing the bit position to set. 0 represents the 0th bit
|
|
|
95
95
|
|
|
96
96
|
> **has**(`flag`): `boolean`
|
|
97
97
|
|
|
98
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:50](https://github.com/isdk/ai-tool.js/blob/
|
|
98
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:50](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L50)
|
|
99
99
|
|
|
100
100
|
Determines whether an element is in the set.
|
|
101
101
|
|
|
@@ -119,7 +119,7 @@ true if the element is in the set; otherwise, false.
|
|
|
119
119
|
|
|
120
120
|
> **toJSON**(): `number`
|
|
121
121
|
|
|
122
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:70](https://github.com/isdk/ai-tool.js/blob/
|
|
122
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:70](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L70)
|
|
123
123
|
|
|
124
124
|
#### Returns
|
|
125
125
|
|
|
@@ -131,7 +131,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:70](https://git
|
|
|
131
131
|
|
|
132
132
|
> **toString**(): `string`
|
|
133
133
|
|
|
134
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:66](https://github.com/isdk/ai-tool.js/blob/
|
|
134
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:66](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L66)
|
|
135
135
|
|
|
136
136
|
#### Returns
|
|
137
137
|
|
|
@@ -143,7 +143,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:66](https://git
|
|
|
143
143
|
|
|
144
144
|
> **valueOf**(): `number`
|
|
145
145
|
|
|
146
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:62](https://github.com/isdk/ai-tool.js/blob/
|
|
146
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:62](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L62)
|
|
147
147
|
|
|
148
148
|
#### Returns
|
|
149
149
|
|
|
@@ -155,7 +155,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:62](https://git
|
|
|
155
155
|
|
|
156
156
|
> `static` **add**(`bitField`, `flag`): `number`
|
|
157
157
|
|
|
158
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
158
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:12](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L12)
|
|
159
159
|
|
|
160
160
|
#### Parameters
|
|
161
161
|
|
|
@@ -177,7 +177,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:12](https://git
|
|
|
177
177
|
|
|
178
178
|
> `static` **delete**(`bitField`, `flag`): `number`
|
|
179
179
|
|
|
180
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
180
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:16](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L16)
|
|
181
181
|
|
|
182
182
|
#### Parameters
|
|
183
183
|
|
|
@@ -199,7 +199,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:16](https://git
|
|
|
199
199
|
|
|
200
200
|
> `static` **has**(`bitField`, `flag`): `boolean`
|
|
201
201
|
|
|
202
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:8](https://github.com/isdk/ai-tool.js/blob/
|
|
202
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/intset.ts:8](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/intset.ts#L8)
|
|
203
203
|
|
|
204
204
|
#### Parameters
|
|
205
205
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: PromptExampleSelector\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:46](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:46](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L46)
|
|
10
10
|
|
|
11
11
|
The `PromptExampleSelector` class provides a mechanism to selectively choose examples from a given set based on
|
|
12
12
|
configurable options such as maximum length and probability threshold. This class is meant to be extended and customized
|
|
@@ -48,7 +48,7 @@ The type of the prompt examples.
|
|
|
48
48
|
|
|
49
49
|
> **new PromptExampleSelector**\<`T`\>(`examples`, `options?`): `PromptExampleSelector`\<`T`\>
|
|
50
50
|
|
|
51
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:62](https://github.com/isdk/ai-tool.js/blob/
|
|
51
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:62](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L62)
|
|
52
52
|
|
|
53
53
|
Constructs a new `PromptExampleSelector` instance with the given examples and options.
|
|
54
54
|
|
|
@@ -76,7 +76,7 @@ An optional configuration object.
|
|
|
76
76
|
|
|
77
77
|
> **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
|
|
78
78
|
|
|
79
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:55](https://github.com/isdk/ai-tool.js/blob/
|
|
79
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:55](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L55)
|
|
80
80
|
|
|
81
81
|
The collection of prompt examples.
|
|
82
82
|
|
|
@@ -86,7 +86,7 @@ The collection of prompt examples.
|
|
|
86
86
|
|
|
87
87
|
> **maxLength**: `undefined` \| `number`
|
|
88
88
|
|
|
89
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](https://github.com/isdk/ai-tool.js/blob/
|
|
89
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L47)
|
|
90
90
|
|
|
91
91
|
***
|
|
92
92
|
|
|
@@ -94,7 +94,7 @@ Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-sel
|
|
|
94
94
|
|
|
95
95
|
> **threshold**: `undefined` \| `number`
|
|
96
96
|
|
|
97
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:51](https://github.com/isdk/ai-tool.js/blob/
|
|
97
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:51](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L51)
|
|
98
98
|
|
|
99
99
|
The probability threshold (0-1) for selecting an example. If `undefined`, no filtering by probability occurs.
|
|
100
100
|
|
|
@@ -104,7 +104,7 @@ The probability threshold (0-1) for selecting an example. If `undefined`, no fil
|
|
|
104
104
|
|
|
105
105
|
> **\[asyncIterator\]**(): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
|
|
106
106
|
|
|
107
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:119](https://github.com/isdk/ai-tool.js/blob/
|
|
107
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:119](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L119)
|
|
108
108
|
|
|
109
109
|
Returns an asynchronous iterator for the selected examples.
|
|
110
110
|
|
|
@@ -120,7 +120,7 @@ An asynchronous iterator over the selected examples.
|
|
|
120
120
|
|
|
121
121
|
> **initialize**(`examples`, `options?`): `void`
|
|
122
122
|
|
|
123
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:71](https://github.com/isdk/ai-tool.js/blob/
|
|
123
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:71](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L71)
|
|
124
124
|
|
|
125
125
|
Initializes the selector with examples and options.
|
|
126
126
|
|
|
@@ -148,7 +148,7 @@ An optional configuration object.
|
|
|
148
148
|
|
|
149
149
|
> **selectExample**(`example`, `threshold?`): `void` \| `T`
|
|
150
150
|
|
|
151
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:92](https://github.com/isdk/ai-tool.js/blob/
|
|
151
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:92](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L92)
|
|
152
152
|
|
|
153
153
|
Select an example. Can overwrite this in subclasses.
|
|
154
154
|
|
|
@@ -178,7 +178,7 @@ The selected example, or `undefined` if not selected.
|
|
|
178
178
|
|
|
179
179
|
> **selectExamples**(`examples`): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
|
|
180
180
|
|
|
181
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:103](https://github.com/isdk/ai-tool.js/blob/
|
|
181
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:103](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/prompt/prompt-example-selector.ts#L103)
|
|
182
182
|
|
|
183
183
|
Asynchronously selects examples from the given examples, applying the configured threshold (if any).
|
|
184
184
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: ReadableStreamError
|
|
8
8
|
|
|
9
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/error-readable-stream.ts:6](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/error-readable-stream.ts:6](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/stream/error-readable-stream.ts#L6)
|
|
10
10
|
|
|
11
11
|
BaseError class that extends the Error class.
|
|
12
12
|
|
|
@@ -47,7 +47,7 @@ fromJSON - Creates a new BaseError instance from a JSON representation.
|
|
|
47
47
|
|
|
48
48
|
> **new ReadableStreamError**(`msg`, `code`): `ReadableStreamError`
|
|
49
49
|
|
|
50
|
-
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/error-readable-stream.ts:7](https://github.com/isdk/ai-tool.js/blob/
|
|
50
|
+
Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/stream/error-readable-stream.ts:7](https://github.com/isdk/ai-tool.js/blob/fb1809b53cc75a30928176c26910792b6b8a96e1/src/utils/stream/error-readable-stream.ts#L7)
|
|
51
51
|
|
|
52
52
|
#### Parameters
|
|
53
53
|
|