@isdk/ai-tool 0.5.2 → 0.5.3

package/docs/functions/canonicalize.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / canonicalize
+
+# Function: canonicalize()
+
+> **canonicalize**(`obj`): `string`
+
+Defined in: node\_modules/.pnpm/json-canonicalize@1.0.6/node\_modules/json-canonicalize/types/canonicalize.d.ts:1
+
+## Parameters
+
+### obj
+
+`any`
+
+## Returns
+
+`string`

package/docs/functions/completeSentences.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / completeSentences
+
+# Function: completeSentences()
+
+> **completeSentences**(`sentences`, `__namedParameters`): `string`[]
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:123](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L123)
+
+## Parameters
+
+### sentences
+
+`string`[]
+
+### \_\_namedParameters
+
+[`SplitSentenceOptions`](../interfaces/SplitSentenceOptions.md) = `{}`
+
+## Returns
+
+`string`[]

package/docs/functions/concatText.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / concatText
+
+# Function: concatText()
+
+> **concatText**(`left`, `right`): `string`
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:168](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/split-sentence.ts#L168)
+
+## Parameters
+
+### left
+
+`string`
+
+### right
+
+`string`
+
+## Returns
+
+`string`

package/docs/functions/countLLMTokens.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / countLLMTokens
+
+# Function: countLLMTokens()
+
+> **countLLMTokens**(`text`, `modelId`): `Promise`\<`number`\>
+
+Defined in: [packages/ai-tool/src/utils/llm-tokenizer.ts:74](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/llm-tokenizer.ts#L74)
+
+## Parameters
+
+### text
+
+`string`
+
+### modelId
+
+`string` = `'qwen2.5'`
+
+## Returns
+
+`Promise`\<`number`\>

package/docs/functions/countRegexMatches.md

@@ -0,0 +1,35 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / countRegexMatches
+
+# Function: countRegexMatches()
+
+> **countRegexMatches**(`content`, `regex`): `number`
+
+Defined in: [packages/ai-tool/src/utils/count-regex-matches.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/count-regex-matches.ts#L10)
+
+Counts the number of matches for a given regular expression in a specified string.
+This function ensures that the regular expression is used globally by adding the 'g' flag,
+if it is not already present.
+
+## Parameters
+
+### content
+
+`string`
+
+The string to search within.
+
+### regex
+
+`RegExp`
+
+The regular expression to use for matching.
+
+## Returns
+
+`number`
+
+The total number of matches found.

package/docs/functions/createAbilityInjector.md

@@ -0,0 +1,119 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / createAbilityInjector
+
+# Function: createAbilityInjector()
+
+## Call Signature
+
+> **createAbilityInjector**\<`A`\>(`abilityClass`, `isGetClassFunc`?, `injectorOpts`?): `ClassAbilityFn`\<`A`\>
+
+Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:35
+
+### Type Parameters
+
+• **A** *extends* `ClassEx`
+
+### Parameters
+
+#### abilityClass
+
+`A`
+
+#### isGetClassFunc?
+
+`boolean`
+
+#### injectorOpts?
+
+`AbilityInjectorOptions`
+
+### Returns
+
+`ClassAbilityFn`\<`A`\>
+
+## Call Signature
+
+> **createAbilityInjector**\<`A`\>(`abilityClass`, `aCoreMethod`?, `isGetClassFunc`?, `injectorOpts`?): `ClassAbilityFn`\<`A`\>
+
+Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:36
+
+### Type Parameters
+
+• **A** *extends* `ClassEx`
+
+### Parameters
+
+#### abilityClass
+
+`A`
+
+#### aCoreMethod?
+
+`string` | `string`[]
+
+#### isGetClassFunc?
+
+`boolean`
+
+#### injectorOpts?
+
+`AbilityInjectorOptions`
+
+### Returns
+
+`ClassAbilityFn`\<`A`\>
+
+## Call Signature
+
+> **createAbilityInjector**\<`A`\>(`abilityClass`, `aCoreMethod`?, `injectorOpts`?): `ClassAbilityFn`\<`A`\>
+
+Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:37
+
+### Type Parameters
+
+• **A** *extends* `ClassEx`
+
+### Parameters
+
+#### abilityClass
+
+`A`
+
+#### aCoreMethod?
+
+`string` | `string`[]
+
+#### injectorOpts?
+
+`AbilityInjectorOptions`
+
+### Returns
+
+`ClassAbilityFn`\<`A`\>
+
+## Call Signature
+
+> **createAbilityInjector**\<`A`\>(`abilityClass`, `injectorOpts`?): `ClassAbilityFn`\<`A`\>
+
+Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:38
+
+### Type Parameters
+
+• **A** *extends* `ClassEx`
+
+### Parameters
+
+#### abilityClass
+
+`A`
+
+#### injectorOpts?
+
+`AbilityInjectorOptions`
+
+### Returns
+
+`ClassAbilityFn`\<`A`\>

package/docs/functions/createCallbacksTransformer.md

@@ -0,0 +1,49 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / createCallbacksTransformer
+
+# Function: createCallbacksTransformer()
+
+> **createCallbacksTransformer**\<`I`, `O`\>(`cb`): `TransformStream`\<`I`, `O`\>
+
+Defined in: [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:36](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-callbacks-stream.ts#L36)
+
+Creates a transform stream that invokes optional callback functions.
+The transform stream uses the provided callbacks to execute custom logic at different stages of the stream's lifecycle.
+- `onStart`: Called once when the stream is initialized.
+- `onTransform`: Called for each tokenized message.
+- `onCompletion`: Called every time an AIStream completion message is received. This can occur multiple times when using e.g. OpenAI functions
+- `onFinal`: Called once when the stream is closed with the final completion message.
+
+This function is useful when you want to process a stream of messages and perform specific actions during the stream's lifecycle.
+
+## Type Parameters
+
+• **I** = `any`
+
+• **O** = `any`
+
+## Parameters
+
+### cb
+
+`undefined` | [`StreamCallbacksAndOptions`](../interfaces/StreamCallbacksAndOptions.md)\<`I`, `O`\>
+
+## Returns
+
+`TransformStream`\<`I`, `O`\>
+
+A transform stream that encodes input messages as Uint8Array and allows the execution of custom logic through callbacks.
+
+## Example
+
+```ts
+const callbacks = {
+  onStart: async () => console.log('Stream started'),
+  onTransform: async (chunk) => console.log('Token:',chunk),
+  onFinal: async () => data.close()
+};
+const transformer = createCallbacksTransformer(callbacks);
+```

package/docs/functions/createEmptyReadableStream.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / createEmptyReadableStream
+
+# Function: createEmptyReadableStream()
+
+> **createEmptyReadableStream**(): `ReadableStream`
+
+Defined in: [packages/ai-tool/src/utils/stream/create-empty-stream.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/create-empty-stream.ts#L8)
+
+Creates an empty ReadableStream that immediately closes upon creation.
+This function is used as a fallback for creating a ReadableStream when the response body is null or undefined,
+ensuring that the subsequent pipeline processing doesn't fail due to a lack of a stream.
+
+## Returns
+
+`ReadableStream`
+
+An empty and closed ReadableStream instance.

package/docs/functions/createEndWithRepetitionDetector.md

@@ -0,0 +1,31 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / createEndWithRepetitionDetector
+
+# Function: createEndWithRepetitionDetector()
+
+> **createEndWithRepetitionDetector**(`repetitionThreshold`): (`value`) => `null` \| `RegExpExecArray`
+
+Defined in: [packages/ai-tool/src/utils/end-with-repeated-sequence.ts:3](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/end-with-repeated-sequence.ts#L3)
+
+## Parameters
+
+### repetitionThreshold
+
+`number`
+
+## Returns
+
+`Function`
+
+### Parameters
+
+#### value
+
+`string`
+
+### Returns
+
+`null` \| `RegExpExecArray`

package/docs/functions/createError.md

@@ -0,0 +1,39 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / createError
+
+# Function: createError()
+
+> **createError**(`message`, `name`?, `status`?): [`CommonError`](../classes/CommonError.md)
+
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:153
+
+Create an error object
+
+## Parameters
+
+### message
+
+`string`
+
+Error message
+
+### name?
+
+Error name, optional
+
+`string` | `Record`\<`string`, `any`\>
+
+### status?
+
+Error status code, default to 500
+
+`string` | `number`
+
+## Returns
+
+[`CommonError`](../classes/CommonError.md)
+
+Error object

package/docs/functions/createEventStreamTransformer.md

@@ -0,0 +1,33 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / createEventStreamTransformer
+
+# Function: createEventStreamTransformer()
+
+> **createEventStreamTransformer**\<`TValue`, `TOptions`\>(`customParser`?): `TransformStream`\<`Uint8Array`\<`ArrayBufferLike`\>, [`AIResult`](../interfaces/AIResult.md)\<`TValue`, `TOptions`\>\>
+
+Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:36](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/ai-stream.ts#L36)
+
+Creates a TransformStream that parses events from an EventSource stream using a custom parser.
+
+## Type Parameters
+
+• **TValue** = `any`
+
+• **TOptions** = `any`
+
+## Parameters
+
+### customParser?
+
+[`AIStreamParser`](../interfaces/AIStreamParser.md)\<`any`, `any`\>
+
+Function to handle event data.
+
+## Returns
+
+`TransformStream`\<`Uint8Array`\<`ArrayBufferLike`\>, [`AIResult`](../interfaces/AIResult.md)\<`TValue`, `TOptions`\>\>
+
+TransformStream parsing events.

package/docs/functions/createHfValueFunc.md

@@ -0,0 +1,31 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / createHfValueFunc
+
+# Function: createHfValueFunc()
+
+> **createHfValueFunc**(`fn`): (`_data`) => `Function`
+
+Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:140](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/hf-prompt-template.ts#L140)
+
+## Parameters
+
+### fn
+
+`Function`
+
+## Returns
+
+`Function`
+
+### Parameters
+
+#### \_data
+
+`any`
+
+### Returns
+
+`Function`

package/docs/functions/createLRUCache.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / createLRUCache
+
+# Function: createLRUCache()
+
+> **createLRUCache**(`name`, `options`?): [`ToolFunc`](../classes/ToolFunc.md)
+
+Defined in: [packages/ai-tool/src/funcs/lrucache.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/lrucache.ts#L24)
+
+## Parameters
+
+### name
+
+`string`
+
+### options?
+
+`number` | `ICacheOptions`
+
+## Returns
+
+[`ToolFunc`](../classes/ToolFunc.md)

package/docs/functions/createYamlObjectTag.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / createYamlObjectTag
+
+# Function: createYamlObjectTag()
+
+> **createYamlObjectTag**(`tag`, `BaseObject`): `any`
+
+Defined in: [packages/ai-tool/src/utils/yaml-type-base-object.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/yaml-type-base-object.ts#L10)
+
+## Parameters
+
+### tag
+
+`string`
+
+### BaseObject
+
+*typeof* [`YamlTypeBaseObject`](../classes/YamlTypeBaseObject.md)
+
+## Returns
+
+`any`

package/docs/functions/dateToText.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / dateToText
+
+# Function: dateToText()
+
+> **dateToText**(`date`, `format`): `string`
+
+Defined in: [packages/ai-tool/src/utils/to-datetime.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/to-datetime.ts#L29)
+
+## Parameters
+
+### date
+
+`Date`
+
+### format
+
+`string` = `FormatDateStr`
+
+## Returns
+
+`string`

package/docs/functions/decodeCharset.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / decodeCharset
+
+# Function: decodeCharset()
+
+> **decodeCharset**(`result`, `encoding`?): `string`
+
+Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:113](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/load-file-from-paths.ts#L113)
+
+## Parameters
+
+### result
+
+`Buffer`
+
+### encoding?
+
+`BufferEncoding`
+
+## Returns
+
+`string`

package/docs/functions/detectCharset.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / detectCharset
+
+# Function: detectCharset()
+
+> **detectCharset**(`content`, `options`?): `string`
+
+Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:248](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/load-file-from-paths.ts#L248)
+
+## Parameters
+
+### content
+
+`string` | `Buffer`\<`ArrayBufferLike`\>
+
+### options?
+
+`any`
+
+## Returns
+
+`string`

package/docs/functions/encodeLLMTokens.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / encodeLLMTokens
+
+# Function: encodeLLMTokens()
+
+> **encodeLLMTokens**(`text`, `modelId`): `Promise`\<`number`[]\>
+
+Defined in: [packages/ai-tool/src/utils/llm-tokenizer.ts:68](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/llm-tokenizer.ts#L68)
+
+## Parameters
+
+### text
+
+`string`
+
+### modelId
+
+`string` = `'qwen2.5'`
+
+## Returns
+
+`Promise`\<`number`[]\>

package/docs/functions/ensureQuoted.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ensureQuoted
+
+# Function: ensureQuoted()
+
+> **ensureQuoted**(`s`, `quoteChar`): `string`
+
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:204](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/parse-command.ts#L204)
+
+## Parameters
+
+### s
+
+`string`
+
+### quoteChar
+
+`string` = `'"'`
+
+## Returns
+
+`string`