@isdk/ai-tool 0.5.1 → 0.5.2

package/docs/functions/getKeysPath.md

@@ -1,38 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / getKeysPath
-
-# Function: getKeysPath()
-
-> **getKeysPath**\<`TValue`\>(`value`): `string`[]
-
-Defined in: [packages/ai-tool/src/utils/get-keys-path.ts:21](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/get-keys-path.ts#L21)
-
-Retrieves an array of all key paths as strings for a nested object or array.
-
-## Type Parameters
-
-• **TValue** *extends* `object`
-
-## Parameters
-
-### value
-
-`TValue`
-
-The object or array to extract the paths from.
-
-## Returns
-
-`string`[]
-
-- An array of strings containing all the key paths.
-
-## Example
-
-```
-const obj = { a: { b: { c: 1 } }, d: [0, { e: 2 }] };
-console.log(getKeysPath(obj)); // Output: ['a.b.c', 'd[0]', 'd[1].e']
-```

package/docs/functions/getLLMTokenizer.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / getLLMTokenizer
-
-# Function: getLLMTokenizer()
-
-> **getLLMTokenizer**(`modelId`): `Promise`\<`PreTrainedTokenizer`\>
-
-Defined in: [packages/ai-tool/src/utils/llm-tokenizer.ts:58](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/llm-tokenizer.ts#L58)
-
-## Parameters
-
-### modelId
-
-`string`
-
-## Returns
-
-`Promise`\<`PreTrainedTokenizer`\>

package/docs/functions/getMultiLevelExtname.md

@@ -1,33 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / getMultiLevelExtname
-
-# Function: getMultiLevelExtname()
-
-> **getMultiLevelExtname**(`filename`, `level`): `string`
-
-Defined in: [packages/ai-tool/src/utils/filename.ts:174](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/filename.ts#L174)
-
-Retrieves multi-level file extension
-
-## Parameters
-
-### filename
-
-`string`
-
-The file name
-
-### level
-
-`number` = `1`
-
-The level, default is 1, indicating the number of extension levels to retrieve
-
-## Returns
-
-`string`
-
-Returns a concatenated string of multiple extensions, or an empty string if no extension is found

package/docs/functions/getPackageDir.md

@@ -1,39 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / getPackageDir
-
-# Function: getPackageDir()
-
-> **getPackageDir**(`cwd`): `string`
-
-Defined in: [packages/ai-tool/src/utils/get-package-dir.ts:18](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/get-package-dir.ts#L18)
-
-Retrieves the package directory from the current working directory.
-
-## Parameters
-
-### cwd
-
-`string`
-
-The current working directory.
-
-Notes:
-- The project root directory must contain either the `src` (source files directory) or `dist` (compiled files directory) as a fallback.
-- If `packageDirectorySync` fails to find the package directory, it falls back to checking for `src` or `dist` directories.
-- If none of these directories are found, an error is thrown.
- *
-
-## Returns
-
-`string`
-
-## Example
-
-```ts
-// Example usage
-const packageDir = getPackageDir(__dirname);
-console.log(packageDir); // Output: '/path/to/project'
-```

package/docs/functions/getRealFilepath.md

@@ -1,34 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / getRealFilepath
-
-# Function: getRealFilepath()
-
-> **getRealFilepath**(`filepath`): `string`
-
-Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:195](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/load-file-from-paths.ts#L195)
-
-Resolves the real file path, handling symbolic links.
-
-## Parameters
-
-### filepath
-
-`string`
-
-The file path to resolve.
-
-## Returns
-
-`string`
-
-The real file path.
-
-## Example
-
-```typescript
-const realPath = getRealFilepath('/path/to/symbolic/link');
-console.log(realPath); // Outputs the resolved path.
-```

package/docs/functions/getResponseErrorReadableStream.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / getResponseErrorReadableStream
-
-# Function: getResponseErrorReadableStream()
-
-> **getResponseErrorReadableStream**(`body`?): `ReadableStream`\<`any`\>
-
-Defined in: [packages/ai-tool/src/utils/stream/error-readable-stream.ts:12](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/stream/error-readable-stream.ts#L12)
-
-## Parameters
-
-### body?
-
-`null` | `ReadableStream`\<`Uint8Array`\<`ArrayBufferLike`\>\>
-
-## Returns
-
-`ReadableStream`\<`any`\>

package/docs/functions/getXDGConfigs.md

@@ -1,37 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / getXDGConfigs
-
-# Function: getXDGConfigs()
-
-> **getXDGConfigs**(`config`): `object`
-
-Defined in: [packages/ai-tool/src/utils/load-config.ts:57](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/load-config.ts#L57)
-
-## Parameters
-
-### config
-
-`any`
-
-## Returns
-
-`object`
-
-### XDG\_BIN\_HOME
-
-> **XDG\_BIN\_HOME**: `string`
-
-### XDG\_CACHE\_HOME
-
-> **XDG\_CACHE\_HOME**: `any` = `config.cacheDir`
-
-### XDG\_CONFIG\_HOME
-
-> **XDG\_CONFIG\_HOME**: `any` = `config.configDir`
-
-### XDG\_DATA\_HOME
-
-> **XDG\_DATA\_HOME**: `any` = `config.dataDir`

package/docs/functions/hasDirectoryIn.md

@@ -1,40 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / hasDirectoryIn
-
-# Function: hasDirectoryIn()
-
-> **hasDirectoryIn**(`dir`, `dirs`?): `undefined` \| `boolean`
-
-Defined in: [packages/ai-tool/src/utils/has-directory-in.ts:37](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/has-directory-in.ts#L37)
-
-Checks if a given directory is a subdirectory of any directory in the provided array.
-
-## Parameters
-
-### dir
-
-`string`
-
-The directory path to check.
-
-### dirs?
-
-`string`[]
-
-An array of directory paths.
-
-## Returns
-
-`undefined` \| `boolean`
-
-true if the given directory is a subdirectory of any directory in the array; otherwise, false.
-
-## Example
-
-```ts
-// Returns true if 'subdir' is within 'parentdir'
-hasDirectoryIn('parentdir/subdir', ['parentdir', 'otherdir']); // true
-```

package/docs/functions/hash.md

@@ -1,25 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / hash
-
-# Function: hash()
-
-> **hash**(`value`, `__namedParameters`): `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
-
-Defined in: [packages/ai-tool/src/utils/hash/hash.ts:31](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/hash/hash.ts#L31)
-
-## Parameters
-
-### value
-
-`IDataType`
-
-### \_\_namedParameters
-
-[`HashAlgoParams`](../interfaces/HashAlgoParams.md) = `{}`
-
-## Returns
-
-`Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>

package/docs/functions/hashFile.md

@@ -1,25 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / hashFile
-
-# Function: hashFile()
-
-> **hashFile**(`filepath`, `options`?): `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
-
-Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:204](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/load-file-from-paths.ts#L204)
-
-## Parameters
-
-### filepath
-
-`string`
-
-### options?
-
-[`HashAlgoParams`](../interfaces/HashAlgoParams.md)
-
-## Returns
-
-`Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>

package/docs/functions/hashStream.md

@@ -1,25 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / hashStream
-
-# Function: hashStream()
-
-> **hashStream**(`stream`, `__namedParameters`): `Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>
-
-Defined in: [packages/ai-tool/src/utils/hash/hash.ts:16](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/hash/hash.ts#L16)
-
-## Parameters
-
-### stream
-
-`ReadableStream`
-
-### \_\_namedParameters
-
-[`HashAlgoParams`](../interfaces/HashAlgoParams.md) = `{}`
-
-## Returns
-
-`Promise`\<`string` \| `Uint8Array`\<`ArrayBufferLike`\>\>

package/docs/functions/hfParse.md

@@ -1,24 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / hfParse
-
-# Function: hfParse()
-
-> **hfParse**(`tokens`): `Program`
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/parser.ts:33](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/jinja/src/parser.ts#L33)
-
-Generate the Abstract Syntax Tree (AST) from a list of tokens.
-Operator precedence can be found here: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Operator_precedence#table
-
-## Parameters
-
-### tokens
-
-`Token`[]
-
-## Returns
-
-`Program`

package/docs/functions/hfTokenize.md

@@ -1,27 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / hfTokenize
-
-# Function: hfTokenize()
-
-> **hfTokenize**(`source`, `options`): `Token`[]
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/lexer.ts:203](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/jinja/src/lexer.ts#L203)
-
-Generate a list of tokens from a source string.
-
-## Parameters
-
-### source
-
-`string`
-
-### options
-
-`PreprocessOptions` = `{}`
-
-## Returns
-
-`Token`[]

package/docs/functions/initShutdown.md

@@ -1,15 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / initShutdown
-
-# Function: initShutdown()
-
-> **initShutdown**(): `void`
-
-Defined in: [packages/ai-tool/src/utils/node/before-shutdown.ts:103](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/node/before-shutdown.ts#L103)
-
-## Returns
-
-`void`

package/docs/functions/interpolateEnv.md

@@ -1,29 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / interpolateEnv
-
-# Function: interpolateEnv()
-
-> **interpolateEnv**(`value`, `processEnv`, `parsed`?): `any`
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:31](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/env.ts#L31)
-
-## Parameters
-
-### value
-
-`string`
-
-### processEnv
-
-`Record`\<`string`, `any`\>
-
-### parsed?
-
-`Record`\<`string`, `any`\>
-
-## Returns
-
-`any`

package/docs/functions/interpolateFString.md

@@ -1,29 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / interpolateFString
-
-# Function: interpolateFString()
-
-> **interpolateFString**(`nodes`, `values`): `string`
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/python.ts:71](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/python.ts#L71)
-
-Type that represents a function that takes a template string and a set
-of input values, and returns a string where all variables in the
-template have been replaced with their corresponding values.
-
-## Parameters
-
-### nodes
-
-[`FStringPromptTemplateNode`](../type-aliases/FStringPromptTemplateNode.md)[]
-
-### values
-
-`Record`\<`string`, `any`\>
-
-## Returns
-
-`string`

package/docs/functions/interpolateGolangTemplate.md

@@ -1,35 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / interpolateGolangTemplate
-
-# Function: interpolateGolangTemplate()
-
-> **interpolateGolangTemplate**(`str`, `variables`, `initVars`?): `string`
-
-Defined in: [packages/ai-tool/src/utils/prompt/template/golang.ts:269](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/prompt/template/golang.ts#L269)
-
-Parse and interpolate template
-
-## Parameters
-
-### str
-
-`string`
-
-golang style template
-
-### variables
-
-`Record`\<`string`, `any`\>
-
-object of variables to insert
-
-### initVars?
-
-`boolean`
-
-## Returns
-
-`string`

package/docs/functions/isLangUsingSpaces.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / isLangUsingSpaces
-
-# Function: isLangUsingSpaces()
-
-> **isLangUsingSpaces**(`isoCode`): `boolean`
-
-Defined in: [packages/ai-tool/src/utils/split-sentence.ts:260](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/split-sentence.ts#L260)
-
-## Parameters
-
-### isoCode
-
-`string`
-
-## Returns
-
-`boolean`

package/docs/functions/isListItemString.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / isListItemString
-
-# Function: isListItemString()
-
-> **isListItemString**(`text`): `null` \| `RegExpExecArray`
-
-Defined in: [packages/ai-tool/src/utils/split-sentence.ts:223](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/split-sentence.ts#L223)
-
-## Parameters
-
-### text
-
-`string`
-
-## Returns
-
-`null` \| `RegExpExecArray`

package/docs/functions/isModelNameMatched.md

@@ -1,47 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / isModelNameMatched
-
-# Function: isModelNameMatched()
-
-> **isModelNameMatched**(`modelName`, `rule`?): `undefined` \| `string` \| `RegExpExecArray`
-
-Defined in: [packages/ai-tool/src/utils/is-model-name-matched.ts:21](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/is-model-name-matched.ts#L21)
-
-Checks if the provided model name matches the given rule.
-
-## Parameters
-
-### modelName
-
-`string`
-
-The name of the model to check.
-
-### rule?
-
-[`AIModelNameRules`](../type-aliases/AIModelNameRules.md)
-
-An optional rule that can be a string, an array of strings, a regular expression, or a function.
-
-## Returns
-
-`undefined` \| `string` \| `RegExpExecArray`
-
-matched result if the model name matches the rule, undefined otherwise.
-
-## Example
-
-```ts
-IsModelNameMatched("gpt-3", "gpt-3") // returns true
-IsModelNameMatched("GPT-3", "gpt-3") // returns true
-IsModelNameMatched("GPT-3", ["gpt-3", "gpt-4"]) // returns true
-IsModelNameMatched("gpt-3", /^gpt-\d+$/) // returns true
-IsModelNameMatched("gpt-3", (modelName) => modelName.startsWith("gpt-")) // returns true
-IsModelNameMatched("gpt-2", "gpt-3") // returns false
-IsModelNameMatched("gpt-2", ["gpt-3", "gpt-4"]) // returns false
-IsModelNameMatched("gpt-2", /^gpt-\d+$/) // returns false
-IsModelNameMatched("gpt-2", (modelName) => modelName.startsWith("gpt-")) // returns false
-```

package/docs/functions/isPunctuationChar.md

@@ -1,36 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / isPunctuationChar
-
-# Function: isPunctuationChar()
-
-> **isPunctuationChar**(`char`): `boolean`
-
-Defined in: [packages/ai-tool/src/utils/split-sentence.ts:245](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/split-sentence.ts#L245)
-
-Checks if the given character is a punctuation mark.
-This function supports both Chinese and English punctuation marks.
-
-## Parameters
-
-### char
-
-`string`
-
-The character to check.
-
-## Returns
-
-`boolean`
-
-`true` if the character is a punctuation mark, otherwise `false`.
-
-## Example
-
-```typescript
-isPunctuationChar('。'); // returns true
-isPunctuationChar('!');  // returns true
-isPunctuationChar('a');  // returns false
-```

package/docs/functions/isQuoted.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / isQuoted
-
-# Function: isQuoted()
-
-> **isQuoted**(`s`): `boolean`
-
-Defined in: [packages/ai-tool/src/utils/parse-command.ts:195](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/parse-command.ts#L195)
-
-## Parameters
-
-### s
-
-`string`
-
-## Returns
-
-`boolean`

package/docs/functions/isRegExp.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md)
-
-***
-
-[@isdk/ai-tool](../globals.md) / isRegExp
-
-# Function: isRegExp()
-
-> **isRegExp**(`value`): `boolean`
-
-Defined in: [packages/ai-tool/src/utils/isRegExp.ts:3](https://github.com/isdk/ai-tool.js/blob/6a89194ac34437a1bc58f7ec590cd22976939ca6/src/utils/isRegExp.ts#L3)
-
-## Parameters
-
-### value
-
-`any`
-
-## Returns
-
-`boolean`