@isdk/ai-tool 0.5.1 → 0.5.3
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/funcs.js +1 -1
- package/dist/index.js +1 -1
- package/docs/classes/AbortError.md +4 -4
- package/docs/classes/AlreadyExistsError.md +4 -4
- package/docs/classes/BaseError.md +4 -4
- package/docs/classes/BinarySemaphore.md +25 -25
- package/docs/classes/CancelableAbility.md +25 -25
- package/docs/classes/ClientTools.md +93 -93
- package/docs/classes/CommonError.md +4 -4
- package/docs/classes/EnvPromptTemplate.md +19 -19
- package/docs/classes/EventClient.md +116 -116
- package/docs/classes/EventServer.md +117 -117
- package/docs/classes/EventToolFunc.md +85 -85
- package/docs/classes/FStringPromptTemplate.md +19 -19
- package/docs/classes/FewShotPromptTemplate.md +23 -23
- package/docs/classes/GolangPromptTemplate.md +19 -19
- package/docs/classes/HFEnvironment.md +10 -10
- package/docs/classes/HFInterpreter.md +5 -5
- package/docs/classes/HFTemplate.md +5 -5
- package/docs/classes/HfPromptTemplate.md +19 -19
- package/docs/classes/IntSet.md +12 -12
- package/docs/classes/NotFoundError.md +4 -4
- package/docs/classes/NotImplementationError.md +4 -4
- package/docs/classes/PromptExampleSelector.md +9 -9
- package/docs/classes/PromptTemplate.md +18 -18
- package/docs/classes/ReadableStreamError.md +6 -6
- package/docs/classes/ResClientTools.md +100 -100
- package/docs/classes/ResServerTools.md +101 -101
- package/docs/classes/SSEChannel.md +16 -16
- package/docs/classes/Semaphore.md +26 -26
- package/docs/classes/ServerTools.md +89 -89
- package/docs/classes/SignalGate.md +9 -9
- package/docs/classes/TaskAbortController.md +9 -9
- package/docs/classes/ToolFunc.md +82 -82
- package/docs/classes/YamlTypeBaseObject.md +2 -2
- package/docs/enumerations/AsyncFeatureBits.md +4 -4
- package/docs/enumerations/AsyncFeatures.md +4 -4
- package/docs/enumerations/HashAlgorithm.md +12 -12
- package/docs/functions/AIArgProcessor.md +1 -1
- package/docs/functions/AIStream.md +1 -1
- package/docs/functions/ChoiceArgProcessor.md +1 -1
- package/docs/functions/ObjectArgsToArgsInfo.md +1 -1
- package/docs/functions/RateLimit.md +1 -1
- package/docs/functions/TemplateArgProcessor.md +1 -1
- package/docs/functions/assignDirs.md +1 -1
- package/docs/functions/backendEventable.md +1 -1
- package/docs/functions/beforeShutdown.md +1 -1
- package/docs/functions/completeSentences.md +1 -1
- package/docs/functions/concatText.md +1 -1
- package/docs/functions/countLLMTokens.md +1 -1
- package/docs/functions/countRegexMatches.md +1 -1
- package/docs/functions/createCallbacksTransformer.md +1 -1
- package/docs/functions/createEmptyReadableStream.md +1 -1
- package/docs/functions/createEndWithRepetitionDetector.md +1 -1
- package/docs/functions/createEventStreamTransformer.md +1 -1
- package/docs/functions/createHfValueFunc.md +1 -1
- package/docs/functions/createLRUCache.md +1 -1
- package/docs/functions/createYamlObjectTag.md +1 -1
- package/docs/functions/dateToText.md +1 -1
- package/docs/functions/decodeCharset.md +1 -1
- package/docs/functions/detectCharset.md +1 -1
- package/docs/functions/encodeLLMTokens.md +1 -1
- package/docs/functions/ensureQuoted.md +1 -1
- package/docs/functions/expandConfig.md +1 -1
- package/docs/functions/expandEnv.md +1 -1
- package/docs/functions/expandObjEnv.md +1 -1
- package/docs/functions/expandPath.md +1 -1
- package/docs/functions/extNameLevel.md +1 -1
- package/docs/functions/fileIsExists.md +1 -1
- package/docs/functions/filenameReservedRegex.md +1 -1
- package/docs/functions/filterValidFnScope.md +1 -1
- package/docs/functions/findIndexNonEmptyFrom.md +1 -1
- package/docs/functions/findPort.md +1 -1
- package/docs/functions/formatTextWithSpace.md +1 -1
- package/docs/functions/getAllEnumKeys.md +1 -1
- package/docs/functions/getConfigFileNames.md +1 -1
- package/docs/functions/getConfigs.md +1 -1
- package/docs/functions/getEnvVairables.md +1 -1
- package/docs/functions/getFileMetaInfo.md +1 -1
- package/docs/functions/getHashAlgoBySize.md +1 -1
- package/docs/functions/getKeysPath.md +1 -1
- package/docs/functions/getLLMTokenizer.md +1 -1
- package/docs/functions/getMultiLevelExtname.md +1 -1
- package/docs/functions/getPackageDir.md +1 -1
- package/docs/functions/getRealFilepath.md +1 -1
- package/docs/functions/getResponseErrorReadableStream.md +1 -1
- package/docs/functions/getXDGConfigs.md +1 -1
- package/docs/functions/hasDirectoryIn.md +1 -1
- package/docs/functions/hash.md +1 -1
- package/docs/functions/hashFile.md +1 -1
- package/docs/functions/hashStream.md +1 -1
- package/docs/functions/hfParse.md +1 -1
- package/docs/functions/hfTokenize.md +1 -1
- package/docs/functions/initShutdown.md +1 -1
- package/docs/functions/interpolateEnv.md +1 -1
- package/docs/functions/interpolateFString.md +1 -1
- package/docs/functions/interpolateGolangTemplate.md +1 -1
- package/docs/functions/isLangUsingSpaces.md +1 -1
- package/docs/functions/isListItemString.md +1 -1
- package/docs/functions/isModelNameMatched.md +1 -1
- package/docs/functions/isPunctuationChar.md +1 -1
- package/docs/functions/isQuoted.md +1 -1
- package/docs/functions/isRegExp.md +1 -1
- package/docs/functions/isSameString.md +1 -1
- package/docs/functions/isSectionString.md +1 -1
- package/docs/functions/isSentenceEnding.md +1 -1
- package/docs/functions/isSepLineString.md +1 -1
- package/docs/functions/isStrWrapped.md +1 -1
- package/docs/functions/isSubdirectory.md +1 -1
- package/docs/functions/isTitleString.md +1 -1
- package/docs/functions/isValidFilename.md +1 -1
- package/docs/functions/isValidFilepath.md +1 -1
- package/docs/functions/isWebStream.md +1 -1
- package/docs/functions/jsonFilterToWhere.md +1 -1
- package/docs/functions/jsonToMarkdownStr.md +1 -1
- package/docs/functions/loadAIConfig.md +1 -1
- package/docs/functions/loadConfig.md +1 -1
- package/docs/functions/loadConfigFile.md +1 -1
- package/docs/functions/loadFileFromPaths.md +1 -1
- package/docs/functions/loadTextFromPaths.md +1 -1
- package/docs/functions/lrucache.md +1 -1
- package/docs/functions/makeToolFuncCancelable.md +1 -1
- package/docs/functions/matchUrlProtocol.md +1 -1
- package/docs/functions/memoize.md +1 -1
- package/docs/functions/messagesToText.md +1 -1
- package/docs/functions/paramsSizeToScaleStr.md +1 -1
- package/docs/functions/parseCommand.md +1 -1
- package/docs/functions/parseFString.md +1 -1
- package/docs/functions/parseJsJson.md +1 -1
- package/docs/functions/parseJsJsonSimpleSync.md +1 -1
- package/docs/functions/parseObjectArgInfo.md +1 -1
- package/docs/functions/parseObjectArgumentInfos.md +1 -1
- package/docs/functions/parseObjectArguments.md +1 -1
- package/docs/functions/parseObjectArgumentsAsArgInfos.md +1 -1
- package/docs/functions/parseYaml.md +1 -1
- package/docs/functions/quoteStr.md +1 -1
- package/docs/functions/reControlCharsRegex.md +1 -1
- package/docs/functions/readFilenamesRecursiveSync.md +1 -1
- package/docs/functions/readTextFileChunks.md +1 -1
- package/docs/functions/readTextFileChunksEx.md +1 -1
- package/docs/functions/readableFromAsyncIterable.md +1 -1
- package/docs/functions/registerCoreTools.md +1 -1
- package/docs/functions/registerYamlTag.md +1 -1
- package/docs/functions/removeMarkdownBold.md +1 -1
- package/docs/functions/removeMarkdownBoldAndItalic.md +1 -1
- package/docs/functions/removeMarkdownItalic.md +1 -1
- package/docs/functions/replaceWithPlaceholder.md +1 -1
- package/docs/functions/restoreFromPlacehoders.md +1 -1
- package/docs/functions/sanitizeFilename.md +1 -1
- package/docs/functions/sanitizeFilepath.md +1 -1
- package/docs/functions/saveConfigFile.md +1 -1
- package/docs/functions/scaleStrToParamsSize.md +1 -1
- package/docs/functions/shutdown.md +1 -1
- package/docs/functions/simplifyObjectArguments.md +1 -1
- package/docs/functions/sortedValues.md +1 -1
- package/docs/functions/splitChunks.md +1 -1
- package/docs/functions/splitParagraph.md +1 -1
- package/docs/functions/splitSentence.md +1 -1
- package/docs/functions/stringifyYaml.md +1 -1
- package/docs/functions/stripConsoleColor.md +1 -1
- package/docs/functions/textToDate.md +1 -1
- package/docs/functions/toDateTime.md +1 -1
- package/docs/functions/trimStartOfStreamHelper.md +1 -1
- package/docs/functions/truncTo.md +1 -1
- package/docs/functions/truncateByToken.md +1 -1
- package/docs/functions/truncateToTokenLimit.md +1 -1
- package/docs/functions/truncateToTokenLimitEx.md +1 -1
- package/docs/functions/uuid.md +1 -1
- package/docs/functions/wait.md +1 -1
- package/docs/functions/xxhash.md +1 -1
- package/docs/functions/xxhash32.md +1 -1
- package/docs/functions/xxhash64.md +1 -1
- package/docs/functions/xxhashAsStr.md +1 -1
- package/docs/interfaces/AIChatAssistantMessageParam.md +12 -12
- package/docs/interfaces/AIChatContentPartImage.md +3 -3
- package/docs/interfaces/AIChatContentPartText.md +3 -3
- package/docs/interfaces/AIChatMessageParamBase.md +7 -7
- package/docs/interfaces/AIChatMessageToolCall.md +4 -4
- package/docs/interfaces/AIChatSystemMessageParam.md +9 -9
- package/docs/interfaces/AIChatToolChoiceFuncObject.md +3 -3
- package/docs/interfaces/AIChatToolChoiceObject.md +2 -2
- package/docs/interfaces/AIChatToolFunc.md +5 -5
- package/docs/interfaces/AIChatToolFuncParam.md +3 -3
- package/docs/interfaces/AIChatToolMessageParam.md +10 -10
- package/docs/interfaces/AIChatToolParam.md +2 -2
- package/docs/interfaces/AIChatToolTypeObject.md +2 -2
- package/docs/interfaces/AIChatUserMessageParam.md +13 -13
- package/docs/interfaces/AIChoiceConfig.md +8 -8
- package/docs/interfaces/AIResult.md +6 -6
- package/docs/interfaces/AIStreamParser.md +2 -2
- package/docs/interfaces/AIStreamParserOptions.md +2 -2
- package/docs/interfaces/BaseFunc.md +10 -10
- package/docs/interfaces/BaseFuncItem.md +9 -9
- package/docs/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
- package/docs/interfaces/BinarySemaphoreOptions.md +5 -5
- package/docs/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
- package/docs/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
- package/docs/interfaces/CancelableAbilityOptions.md +4 -4
- package/docs/interfaces/ClientFuncItem.md +12 -12
- package/docs/interfaces/DotenvExpandOptions.md +4 -4
- package/docs/interfaces/DotenvExpandOutput.md +3 -3
- package/docs/interfaces/DotenvParseInput.md +1 -1
- package/docs/interfaces/DotenvParseOutput.md +1 -1
- package/docs/interfaces/DotenvPopulateInput.md +1 -1
- package/docs/interfaces/EventClientFuncParams.md +5 -5
- package/docs/interfaces/EventServerFuncParams.md +6 -6
- package/docs/interfaces/FewShotPromptTemplateOptions.md +12 -12
- package/docs/interfaces/FuncItem.md +10 -10
- package/docs/interfaces/FuncParam.md +7 -7
- package/docs/interfaces/FuncParams.md +1 -1
- package/docs/interfaces/Funcs.md +1 -1
- package/docs/interfaces/HashAlgoParams.md +4 -4
- package/docs/interfaces/IFileMetaInfo.md +8 -8
- package/docs/interfaces/IReadTextFileChunksOptions.md +11 -11
- package/docs/interfaces/ITruncateToTokenLimitOptions.md +10 -10
- package/docs/interfaces/JsonFilter.md +1 -1
- package/docs/interfaces/ParseObjectArgumentOptions.md +11 -11
- package/docs/interfaces/PromptExampleSelectorOptions.md +3 -3
- package/docs/interfaces/PromptTemplateOptions.md +7 -7
- package/docs/interfaces/RemoteFuncItem.md +12 -12
- package/docs/interfaces/ReplacePlacehoderOptions.md +5 -5
- package/docs/interfaces/ResClientFuncParams.md +3 -3
- package/docs/interfaces/ResServerFuncParams.md +6 -6
- package/docs/interfaces/SanitizeFilenameOptions.md +3 -3
- package/docs/interfaces/SectionStringOptions.md +3 -3
- package/docs/interfaces/SemaphoreOptions.md +7 -7
- package/docs/interfaces/SemaphoreTaskItem.md +5 -5
- package/docs/interfaces/ServerFuncItem.md +13 -13
- package/docs/interfaces/ServerFuncParams.md +3 -3
- package/docs/interfaces/SplitSentenceOptions.md +5 -5
- package/docs/interfaces/StreamCallbacksAndOptions.md +5 -5
- package/docs/interfaces/TaskAbortControllers.md +1 -1
- package/docs/interfaces/TaskPromise.md +6 -6
- package/docs/interfaces/ToolFuncPackage.md +4 -4
- package/docs/type-aliases/AIChatContentPart.md +1 -1
- package/docs/type-aliases/AIChatMessageParam.md +1 -1
- package/docs/type-aliases/AIChatRole.md +1 -1
- package/docs/type-aliases/AIChatToolChoiceParam.md +1 -1
- package/docs/type-aliases/AIMessageType.md +1 -1
- package/docs/type-aliases/AIModelNameRule.md +1 -1
- package/docs/type-aliases/AIModelNameRuleFn.md +1 -1
- package/docs/type-aliases/AIModelNameRules.md +1 -1
- package/docs/type-aliases/AITextGenerationFinishReason.md +1 -1
- package/docs/type-aliases/ActionName.md +1 -1
- package/docs/type-aliases/AsyncTaskId.md +1 -1
- package/docs/type-aliases/BeforeShutdownListener.md +1 -1
- package/docs/type-aliases/EventErrorListenerFn.md +1 -1
- package/docs/type-aliases/EventListenerFn.md +1 -1
- package/docs/type-aliases/FStringPromptTemplateNode.md +1 -1
- package/docs/type-aliases/FuncParamType.md +1 -1
- package/docs/type-aliases/PromptExamples.md +1 -1
- package/docs/type-aliases/PromptTemplateType.md +1 -1
- package/docs/type-aliases/PromptType.md +1 -1
- package/docs/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/type-aliases/TFunc.md +1 -1
- package/docs/variables/AIChatRoles.md +1 -1
- package/docs/variables/AIMessageTypes.md +1 -1
- package/docs/variables/AITextGenerationFinishReasons.md +1 -1
- package/docs/variables/ActionNames.md +1 -1
- package/docs/variables/ClientToolFuncSchema.md +1 -1
- package/docs/variables/DEFAULT_CONFIG_NAME.md +1 -1
- package/docs/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
- package/docs/variables/EventBusName.md +1 -1
- package/docs/variables/EventName.md +1 -1
- package/docs/variables/FilenameReservedRegex.md +1 -1
- package/docs/variables/HFBuiltins.md +1 -1
- package/docs/variables/LLM_TOKENIZER_NAMES.md +1 -1
- package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
- package/docs/variables/PASSING_SCORE.md +1 -1
- package/docs/variables/PromptTemplateTypes.md +1 -1
- package/docs/variables/PromptTypes.md +1 -1
- package/docs/variables/RStreamErrCode.md +1 -1
- package/docs/variables/RemoteToolFuncSchema.md +1 -1
- package/docs/variables/ResponseRStreamErrCode.md +1 -1
- package/docs/variables/SHUTDOWN_SIGNALS.md +1 -1
- package/docs/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
- package/docs/variables/SecondaryCache.md +1 -1
- package/docs/variables/ServerToolFuncSchema.md +1 -1
- package/docs/variables/ToolAsyncCancelableBit.md +1 -1
- package/docs/variables/ToolAsyncMultiTaskBit.md +1 -1
- package/docs/variables/ToolAsyncPriorityBit.md +1 -1
- package/docs/variables/ToolFuncSchema.md +1 -1
- package/docs/variables/WindowsReservedNameRegex.md +1 -1
- package/docs/variables/base32768.md +1 -1
- package/docs/variables/defaultTemplateFormat.md +1 -1
- package/docs/variables/event.md +1 -1
- package/docs/variables/eventClient.md +1 -1
- package/docs/variables/eventServer.md +1 -1
- package/docs/variables/lrucache.md +1 -1
- package/package.json +2 -2
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ServerFuncItem
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L13)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:13](https://github.com/isdk/ai
|
|
|
22
22
|
|
|
23
23
|
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L35)
|
|
26
26
|
|
|
27
27
|
#### Inherited from
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai
|
|
|
34
34
|
|
|
35
35
|
> `optional` **allowExportFunc**: `boolean`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
37
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L14)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai
|
|
|
42
42
|
|
|
43
43
|
> `optional` **apiRoot**: `string`
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/
|
|
45
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L34)
|
|
46
46
|
|
|
47
47
|
#### Inherited from
|
|
48
48
|
|
|
@@ -54,7 +54,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai
|
|
|
54
54
|
|
|
55
55
|
> `optional` **fetchOptions**: `any`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/
|
|
57
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L36)
|
|
58
58
|
|
|
59
59
|
#### Inherited from
|
|
60
60
|
|
|
@@ -66,7 +66,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai
|
|
|
66
66
|
|
|
67
67
|
> `optional` **isApi**: `boolean`
|
|
68
68
|
|
|
69
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
69
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L29)
|
|
70
70
|
|
|
71
71
|
#### Inherited from
|
|
72
72
|
|
|
@@ -78,7 +78,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
|
|
|
78
78
|
|
|
79
79
|
> `optional` **name**: `string`
|
|
80
80
|
|
|
81
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
81
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L23)
|
|
82
82
|
|
|
83
83
|
#### Inherited from
|
|
84
84
|
|
|
@@ -90,7 +90,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-to
|
|
|
90
90
|
|
|
91
91
|
> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
|
|
92
92
|
|
|
93
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
93
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L24)
|
|
94
94
|
|
|
95
95
|
#### Inherited from
|
|
96
96
|
|
|
@@ -102,7 +102,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-to
|
|
|
102
102
|
|
|
103
103
|
> `optional` **result**: `string`
|
|
104
104
|
|
|
105
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
105
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L25)
|
|
106
106
|
|
|
107
107
|
#### Inherited from
|
|
108
108
|
|
|
@@ -114,7 +114,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-to
|
|
|
114
114
|
|
|
115
115
|
> `optional` **scope**: `any`
|
|
116
116
|
|
|
117
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
117
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L26)
|
|
118
118
|
|
|
119
119
|
#### Inherited from
|
|
120
120
|
|
|
@@ -126,7 +126,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
|
|
|
126
126
|
|
|
127
127
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
128
128
|
|
|
129
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
129
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L28)
|
|
130
130
|
|
|
131
131
|
#### Parameters
|
|
132
132
|
|
|
@@ -152,7 +152,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
152
152
|
|
|
153
153
|
> `optional` **stream**: `boolean`
|
|
154
154
|
|
|
155
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/
|
|
155
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L30)
|
|
156
156
|
|
|
157
157
|
#### Inherited from
|
|
158
158
|
|
|
@@ -164,7 +164,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
|
|
|
164
164
|
|
|
165
165
|
> `optional` **tags**: `string` \| `string`[]
|
|
166
166
|
|
|
167
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
167
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L27)
|
|
168
168
|
|
|
169
169
|
#### Inherited from
|
|
170
170
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ServerFuncParams
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L8)
|
|
10
10
|
|
|
11
11
|
Convention: Always pass _req, _res
|
|
12
12
|
|
|
@@ -24,7 +24,7 @@ Convention: Always pass _req, _res
|
|
|
24
24
|
|
|
25
25
|
> `optional` **\_req**: `IncomingMessage`
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
27
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L9)
|
|
28
28
|
|
|
29
29
|
***
|
|
30
30
|
|
|
@@ -32,4 +32,4 @@ Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-
|
|
|
32
32
|
|
|
33
33
|
> `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
35
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L10)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: SplitSentenceOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/split-sentence.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/split-sentence.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L25)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/utils/split-sentence.ts:25](https://github.com
|
|
|
14
14
|
|
|
15
15
|
> `optional` **best**: `boolean`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/utils/split-sentence.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/split-sentence.ts:26](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L26)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/utils/split-sentence.ts:26](https://github.com
|
|
|
22
22
|
|
|
23
23
|
> `optional` **completeSentence**: `boolean`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/split-sentence.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/split-sentence.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L27)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/ai-tool/src/utils/split-sentence.ts:27](https://github.com
|
|
|
30
30
|
|
|
31
31
|
> `optional` **ignoreEmptyLine**: `boolean`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/ai-tool/src/utils/split-sentence.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/split-sentence.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L29)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,4 +38,4 @@ Defined in: [packages/ai-tool/src/utils/split-sentence.ts:29](https://github.com
|
|
|
38
38
|
|
|
39
39
|
> `optional` **isMarkdown**: `boolean`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/ai-tool/src/utils/split-sentence.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
41
|
+
Defined in: [packages/ai-tool/src/utils/split-sentence.ts:28](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L28)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: StreamCallbacksAndOptions\<I, O\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-callbacks-stream.ts#L5)
|
|
10
10
|
|
|
11
11
|
Configuration options and helper callback methods for stream lifecycle events.
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Configuration options and helper callback methods for stream lifecycle events.
|
|
|
22
22
|
|
|
23
23
|
> `optional` **onError**: (`error`) => `void` \| `Promise`\<`void`\>
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:12](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-callbacks-stream.ts#L12)
|
|
26
26
|
|
|
27
27
|
#### Parameters
|
|
28
28
|
|
|
@@ -40,7 +40,7 @@ Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:12](ht
|
|
|
40
40
|
|
|
41
41
|
> `optional` **onFinal**: (`controller`) => `void` \| `Promise`\<`void`\>
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
43
|
+
Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:11](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-callbacks-stream.ts#L11)
|
|
44
44
|
|
|
45
45
|
`onFinal`: Called once when the stream is closed with the final completion message.
|
|
46
46
|
|
|
@@ -60,7 +60,7 @@ Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:11](ht
|
|
|
60
60
|
|
|
61
61
|
> `optional` **onStart**: (`controller`) => `void` \| `Promise`\<`void`\>
|
|
62
62
|
|
|
63
|
-
Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:7](https://github.com/isdk/ai-tool.js/blob/
|
|
63
|
+
Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:7](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-callbacks-stream.ts#L7)
|
|
64
64
|
|
|
65
65
|
`onStart`: Called once when the stream is initialized.
|
|
66
66
|
|
|
@@ -80,7 +80,7 @@ Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:7](htt
|
|
|
80
80
|
|
|
81
81
|
> `optional` **onTransform**: (`chunk`, `controller`) => `void` \| `O` \| `Promise`\<`void` \| `O`\>
|
|
82
82
|
|
|
83
|
-
Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
83
|
+
Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-callbacks-stream.ts#L9)
|
|
84
84
|
|
|
85
85
|
`onToken`: Called for each tokenized message.
|
|
86
86
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: TaskAbortControllers
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:66](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:66](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L66)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: TaskPromise\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:70](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:70](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L70)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:70](https://github
|
|
|
22
22
|
|
|
23
23
|
> `readonly` **\[toStringTag\]**: `string`
|
|
24
24
|
|
|
25
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.
|
|
25
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:176
|
|
26
26
|
|
|
27
27
|
#### Inherited from
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Defined in: node\_modules/.pnpm/typescript@5.7.2/node\_modules/typescript/lib/li
|
|
|
34
34
|
|
|
35
35
|
> `optional` **task**: [`TaskAbortController`](../classes/TaskAbortController.md)
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:71](https://github.com/isdk/ai-tool.js/blob/
|
|
37
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:71](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L71)
|
|
38
38
|
|
|
39
39
|
## Methods
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:71](https://github
|
|
|
42
42
|
|
|
43
43
|
> **catch**\<`TResult`\>(`onrejected`?): `Promise`\<`T` \| `TResult`\>
|
|
44
44
|
|
|
45
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.
|
|
45
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1557
|
|
46
46
|
|
|
47
47
|
Attaches a callback for only the rejection of the Promise.
|
|
48
48
|
|
|
@@ -74,7 +74,7 @@ A Promise for the completion of the callback.
|
|
|
74
74
|
|
|
75
75
|
> **finally**(`onfinally`?): `Promise`\<`T`\>
|
|
76
76
|
|
|
77
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.
|
|
77
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2018.promise.d.ts:29
|
|
78
78
|
|
|
79
79
|
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
|
|
80
80
|
resolved value cannot be modified from the callback.
|
|
@@ -103,7 +103,7 @@ A Promise for the completion of the callback.
|
|
|
103
103
|
|
|
104
104
|
> **then**\<`TResult1`, `TResult2`\>(`onfulfilled`?, `onrejected`?): `Promise`\<`TResult1` \| `TResult2`\>
|
|
105
105
|
|
|
106
|
-
Defined in: node\_modules/.pnpm/typescript@5.7.
|
|
106
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1550
|
|
107
107
|
|
|
108
108
|
Attaches callbacks for the resolution and/or rejection of the Promise.
|
|
109
109
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ToolFuncPackage
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L45)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-to
|
|
|
14
14
|
|
|
15
15
|
> **name**: `string`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L46)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-to
|
|
|
22
22
|
|
|
23
23
|
> **register**: (`data`?) => `void`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L47)
|
|
26
26
|
|
|
27
27
|
#### Parameters
|
|
28
28
|
|
|
@@ -40,7 +40,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-to
|
|
|
40
40
|
|
|
41
41
|
> `optional` **unregister**: () => `void`
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/
|
|
43
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L48)
|
|
44
44
|
|
|
45
45
|
#### Returns
|
|
46
46
|
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **AIChatContentPart**: [`AIChatContentPartText`](../interfaces/AIChatContentPartText.md) \| [`AIChatContentPartImage`](../interfaces/AIChatContentPartImage.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/chat.ts:82](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:82](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L82)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **AIChatMessageParam**: [`AIChatMessageParamBase`](../interfaces/AIChatMessageParamBase.md) \| [`AIChatSystemMessageParam`](../interfaces/AIChatSystemMessageParam.md) \| [`AIChatUserMessageParam`](../interfaces/AIChatUserMessageParam.md) \| [`AIChatAssistantMessageParam`](../interfaces/AIChatAssistantMessageParam.md) \| [`AIChatToolMessageParam`](../interfaces/AIChatToolMessageParam.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/chat.ts:46](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:46](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L46)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **AIChatRole**: *typeof* [`AIChatRoles`](../variables/AIChatRoles.md)\[`number`\] & `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/chat.ts:44](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:44](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L44)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **AIChatToolChoiceParam**: `"auto"` \| `"none"` \| `"required"` \| [`AIChatToolChoiceObject`](../interfaces/AIChatToolChoiceObject.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/chat.ts:141](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:141](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L141)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **AIMessageType**: *typeof* [`AIMessageTypes`](../variables/AIMessageTypes.md)\[`number`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/chat.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:38](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L38)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **AIModelNameRule**: `string` \| `RegExp` \| [`AIModelNameRuleFn`](AIModelNameRuleFn.md)
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L10)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **AIModelNameRuleFn**: (`name`) => `string` \| `RegExpExecArray` \| `undefined`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:8](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L8)
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **AIModelNameRules**: [`AIModelNameRule`](AIModelNameRule.md) \| [`AIModelNameRule`](AIModelNameRule.md)[]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:11](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L11)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **AITextGenerationFinishReason**: *typeof* [`AITextGenerationFinishReasons`](../variables/AITextGenerationFinishReasons.md)\[`number`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/chat.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:14](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L14)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **ActionName**: *typeof* [`ActionNames`](../variables/ActionNames.md)\[`number`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:6](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:6](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L6)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **AsyncTaskId**: `string` \| `number`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/cancelable-ability.ts#L27)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **BeforeShutdownListener**: (`signalOrEvent`) => `Promise`\<`void`\> \| `void`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/node/before-shutdown.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/node/before-shutdown.ts:13](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/node/before-shutdown.ts#L13)
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **EventErrorListenerFn**: (`this`, `err`, `name`, ...`args`) => `any`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:11](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/event/event-ability.ts#L11)
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **EventListenerFn**: (`this`, `name`, ...`args`) => `any`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/event/event-ability.ts#L10)
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **FStringPromptTemplateNode**: \{ `text`: `string`; `type`: `"literal"`; \} \| \{ `name`: `string`; `type`: `"variable"`; \}
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/python.ts:6](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/python.ts:6](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/python.ts#L6)
|
|
12
12
|
|
|
13
13
|
Type that represents a node in a parsed format string. It can be either
|
|
14
14
|
a literal text or a variable name.
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **FuncParamType**: `string`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:6](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:6](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L6)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **PromptExamples**\<`T`\>: `Iterable`\<`PromiseLike`\<`T`\> \| `T`\> \| `AsyncIterable`\<`T`\>
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:3](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:3](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-example-selector.ts#L3)
|
|
12
12
|
|
|
13
13
|
## Type Parameters
|
|
14
14
|
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **PromptTemplateType**: *typeof* [`PromptTemplateTypes`](../variables/PromptTemplateTypes.md)\[`number`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:17](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:17](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/consts.ts#L17)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> **PromptType**: *typeof* [`PromptTypes`](../variables/PromptTypes.md)\[`number`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/consts.ts#L10)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **SemaphoreIsReadyFuncType**: () => `Promise`\<`boolean`\> \| `boolean`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:11](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L11)
|
|
12
12
|
|
|
13
13
|
## Returns
|
|
14
14
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> **TFunc**: (`this`, ...`params`) => `any`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:20](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:20](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L20)
|
|
12
12
|
|
|
13
13
|
## Parameters
|
|
14
14
|
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **AIChatRoles**: readonly \[`"user"`, `"assistant"`, `"system"`, `"tool"`, `"tool_calls"`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/chat.ts:43](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:43](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L43)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **AIMessageTypes**: readonly \[`"human"`, `"ai"`, `"generic"`, `"system"`, `"tool"`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/chat.ts:37](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:37](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L37)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **AITextGenerationFinishReasons**: readonly \[`"stop"`, `"length"`, `"content_filter"`, `"tool_calls"`, `"function_call"`, `"abort"`, `"error"`, `"other"`, `null`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/chat.ts:4](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:4](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/chat.ts#L4)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **ActionNames**: readonly \[`"get"`, `"post"`, `"put"`, `"delete"`, `"patch"`, `"list"`, `"res"`\]
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L5)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **ClientToolFuncSchema**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:159](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:159](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/client-tools.ts#L159)
|
|
12
12
|
|
|
13
13
|
## Type declaration
|
|
14
14
|
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **DEFAULT\_CONFIG\_NAME**: `".ai"` = `'.ai'`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/load-config.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/load-config.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/load-config.ts#L5)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **DefaultAsyncSemaphoreCapacity**: `32` = `32`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/async-semaphore.ts#L9)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **EventBusName**: `"event-bus"` = `'event-bus'`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/event/event-ability.ts#L9)
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **EventName**: `"event"` = `'event'`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:8](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/event/event-ability.ts#L8)
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **FilenameReservedRegex**: `RegExp`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/filename.ts:8](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/filename.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/filename.ts#L8)
|
|
12
12
|
|
|
13
13
|
Regular expression pattern for reserved characters in a filename.
|
|
14
14
|
do not use /g global option here: when the regex is executed multiple times, it will always begin where it left off last time.
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
> `const` **HFBuiltins**: `object`
|
|
10
10
|
|
|
11
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/builtins.ts:68](https://github.com/isdk/ai-tool.js/blob/
|
|
11
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/builtins.ts:68](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/jinja/src/builtins.ts#L68)
|
|
12
12
|
|
|
13
13
|
## Type declaration
|
|
14
14
|
|