@isdk/ai-tool 0.5.2 → 0.5.4

package/docs/type-aliases/EventErrorListenerFn.md

@@ -0,0 +1,33 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / EventErrorListenerFn
+
+# Type Alias: EventErrorListenerFn()
+
+> **EventErrorListenerFn**: (`this`, `err`, `name`, ...`args`) => `any`
+
+Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:11](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/event/event-ability.ts#L11)
+
+## Parameters
+
+### this
+
+`Event`
+
+### err
+
+`Error`
+
+### name
+
+`string`
+
+### args
+
+...`any`
+
+## Returns
+
+`any`

package/docs/type-aliases/EventListenerFn.md

@@ -0,0 +1,29 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / EventListenerFn
+
+# Type Alias: EventListenerFn()
+
+> **EventListenerFn**: (`this`, `name`, ...`args`) => `any`
+
+Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/event/event-ability.ts#L10)
+
+## Parameters
+
+### this
+
+`Event`
+
+### name
+
+`string`
+
+### args
+
+...`any`
+
+## Returns
+
+`any`

package/docs/type-aliases/FStringPromptTemplateNode.md

@@ -0,0 +1,14 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / FStringPromptTemplateNode
+
+# Type Alias: FStringPromptTemplateNode
+
+> **FStringPromptTemplateNode**: \{ `text`: `string`; `type`: `"literal"`; \} \| \{ `name`: `string`; `type`: `"variable"`; \}
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/python.ts:6](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/python.ts#L6)
+
+Type that represents a node in a parsed format string. It can be either
+a literal text or a variable name.

package/docs/type-aliases/FuncParamType.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / FuncParamType
+
+# Type Alias: FuncParamType
+
+> **FuncParamType**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:6](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L6)

package/docs/type-aliases/PromptExamples.md

@@ -0,0 +1,15 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / PromptExamples
+
+# Type Alias: PromptExamples\<T\>
+
+> **PromptExamples**\<`T`\>: `Iterable`\<`PromiseLike`\<`T`\> \| `T`\> \| `AsyncIterable`\<`T`\>
+
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:3](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L3)
+
+## Type Parameters
+
+• **T** = `any`

package/docs/type-aliases/PromptTemplateType.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / PromptTemplateType
+
+# Type Alias: PromptTemplateType
+
+> **PromptTemplateType**: *typeof* [`PromptTemplateTypes`](../variables/PromptTemplateTypes.md)\[`number`\]
+
+Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:17](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/consts.ts#L17)

package/docs/type-aliases/PromptType.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / PromptType
+
+# Type Alias: PromptType
+
+> **PromptType**: *typeof* [`PromptTypes`](../variables/PromptTypes.md)\[`number`\]
+
+Defined in: [packages/ai-tool/src/utils/prompt/consts.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/consts.ts#L10)

package/docs/type-aliases/SemaphoreIsReadyFuncType.md

@@ -0,0 +1,15 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / SemaphoreIsReadyFuncType
+
+# Type Alias: SemaphoreIsReadyFuncType()
+
+> **SemaphoreIsReadyFuncType**: () => `Promise`\<`boolean`\> \| `boolean`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:11](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L11)
+
+## Returns
+
+`Promise`\<`boolean`\> \| `boolean`

package/docs/type-aliases/TFunc.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / TFunc
+
+# Type Alias: TFunc()
+
+> **TFunc**: (`this`, ...`params`) => `any`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:20](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L20)
+
+## Parameters
+
+### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+### params
+
+...`any`[]
+
+## Returns
+
+`any`

package/docs/variables/AIChatRoles.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIChatRoles
+
+# Variable: AIChatRoles
+
+> `const` **AIChatRoles**: readonly \[`"user"`, `"assistant"`, `"system"`, `"tool"`, `"tool_calls"`\]
+
+Defined in: [packages/ai-tool/src/utils/chat.ts:43](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L43)

package/docs/variables/AIMessageTypes.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AIMessageTypes
+
+# Variable: AIMessageTypes
+
+> `const` **AIMessageTypes**: readonly \[`"human"`, `"ai"`, `"generic"`, `"system"`, `"tool"`\]
+
+Defined in: [packages/ai-tool/src/utils/chat.ts:37](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L37)

package/docs/variables/AITextGenerationFinishReasons.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AITextGenerationFinishReasons
+
+# Variable: AITextGenerationFinishReasons
+
+> `const` **AITextGenerationFinishReasons**: readonly \[`"stop"`, `"length"`, `"content_filter"`, `"tool_calls"`, `"function_call"`, `"abort"`, `"error"`, `"other"`, `null`\]
+
+Defined in: [packages/ai-tool/src/utils/chat.ts:4](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L4)

package/docs/variables/AbortErrorCode.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AbortErrorCode
+
+# Variable: AbortErrorCode
+
+> `const` **AbortErrorCode**: [`Aborted`](../enumerations/ErrorCode.md#aborted) = `ErrorCode.Aborted`
+
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:31

package/docs/variables/ActionNames.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ActionNames
+
+# Variable: ActionNames
+
+> `const` **ActionNames**: readonly \[`"get"`, `"post"`, `"put"`, `"delete"`, `"patch"`, `"list"`, `"res"`\]
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/consts.ts#L5)

package/docs/variables/AlreadyExistsErrorCode.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / AlreadyExistsErrorCode
+
+# Variable: AlreadyExistsErrorCode
+
+> `const` **AlreadyExistsErrorCode**: [`Conflict`](../enumerations/ErrorCode.md#conflict) = `ErrorCode.Conflict`
+
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:30

package/docs/variables/ClientToolFuncSchema.md

@@ -0,0 +1,101 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ClientToolFuncSchema
+
+# Variable: ClientToolFuncSchema
+
+> `const` **ClientToolFuncSchema**: `object`
+
+Defined in: [packages/ai-tool/src/client-tools.ts:159](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/client-tools.ts#L159)
+
+## Type declaration
+
+### action
+
+> **action**: `object`
+
+#### action.type
+
+> **type**: `string` = `'string'`
+
+#### action.assign()
+
+##### Parameters
+
+###### value
+
+`"get"` | `"post"` | `"put"` | `"delete"` | `"patch"` | `"list"` | `"res"`
+
+###### dest
+
+`any`
+
+###### src?
+
+`any`
+
+###### name?
+
+`string`
+
+###### options?
+
+`any`
+
+##### Returns
+
+`"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
+
+### allowExportFunc
+
+> **allowExportFunc**: `object`
+
+#### allowExportFunc.type
+
+> **type**: `string` = `'boolean'`
+
+### apiRoot
+
+> **apiRoot**: `object`
+
+#### apiRoot.type
+
+> **type**: `string` = `'string'`
+
+#### apiRoot.get()
+
+##### Parameters
+
+###### this
+
+`any`
+
+##### Returns
+
+`any`
+
+#### apiRoot.set()
+
+##### Parameters
+
+###### this
+
+`any`
+
+###### value
+
+`string`
+
+##### Returns
+
+`void`
+
+### fetchOptions
+
+> **fetchOptions**: `object`
+
+#### fetchOptions.type
+
+> **type**: `string` = `'object'`

package/docs/variables/DEFAULT_CONFIG_NAME.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / DEFAULT\_CONFIG\_NAME
+
+# Variable: DEFAULT\_CONFIG\_NAME
+
+> `const` **DEFAULT\_CONFIG\_NAME**: `".ai"` = `'.ai'`
+
+Defined in: [packages/ai-tool/src/utils/load-config.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-config.ts#L5)

package/docs/variables/DefaultAsyncSemaphoreCapacity.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / DefaultAsyncSemaphoreCapacity
+
+# Variable: DefaultAsyncSemaphoreCapacity
+
+> `const` **DefaultAsyncSemaphoreCapacity**: `32` = `32`
+
+Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L9)

package/docs/variables/EventBusName.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / EventBusName
+
+# Variable: EventBusName
+
+> `const` **EventBusName**: `"event-bus"` = `'event-bus'`
+
+Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/event/event-ability.ts#L9)

package/docs/variables/EventName.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / EventName
+
+# Variable: EventName
+
+> `const` **EventName**: `"event"` = `'event'`
+
+Defined in: [packages/ai-tool/src/utils/event/event-ability.ts:8](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/event/event-ability.ts#L8)

package/docs/variables/FilenameReservedRegex.md

@@ -0,0 +1,14 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / FilenameReservedRegex
+
+# Variable: FilenameReservedRegex
+
+> `const` **FilenameReservedRegex**: `RegExp`
+
+Defined in: [packages/ai-tool/src/utils/filename.ts:8](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/filename.ts#L8)
+
+Regular expression pattern for reserved characters in a filename.
+do not use /g global option here: when the regex is executed multiple times, it will always begin where it left off last time.

package/docs/variables/HFBuiltins.md

@@ -0,0 +1,122 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / HFBuiltins
+
+# Variable: HFBuiltins
+
+> `const` **HFBuiltins**: `object`
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/builtins.ts:68](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/builtins.ts#L68)
+
+## Type declaration
+
+### join()
+
+> **join**: (`value`, `separator`) => `any`
+
+#### Parameters
+
+##### value
+
+`any`
+
+##### separator
+
+`string` = `','`
+
+#### Returns
+
+`any`
+
+### randomInt()
+
+> **randomInt**: (`to`, `from`) => `number`
+
+#### Parameters
+
+##### to
+
+`number`
+
+##### from
+
+`number` = `0`
+
+#### Returns
+
+`number`
+
+### select()
+
+> **select**: (`obj`, `index`?) => `any`
+
+Selects an element from the given object, array, or string.
+
+#### Parameters
+
+##### obj
+
+`any`
+
+Can be an object, array, or string to select from.
+
+##### index?
+
+Optional, specifies the index or key to select. Negative values indicate indices from the end.
+
+`string` | `number`
+
+#### Returns
+
+`any`
+
+The selected element, or `undefined` if the input is empty or not provided.
+
+#### Examples
+
+```ts
+// Selecting an element from an array
+const array = ['apple', 'banana', 'cherry']
+console.log(select(array)) // Random element from the array
+console.log(select(array, 1)) // Second element
+console.log(select(array, -1)) // Last element
+```
+
+```ts
+// Selecting a property from an object
+const obj = { fruit1: 'apple', fruit2: 'banana', fruit3: 'cherry' }
+console.log(select(obj)) // Random property from the object
+console.log(select(obj, 'fruit2')) // Property with key 'fruit2'
+```
+
+```ts
+// Selecting a character from a string
+const str = 'hello'
+console.log(select(str)) // Random character from the string
+console.log(select(str, 1)) // Second character
+console.log(select(str, -1)) // Last character
+```
+
+### tojson()
+
+> **tojson**: (`value`, `indent`?, `depth`?) => `string`
+
+#### Parameters
+
+##### value
+
+`any`
+
+##### indent?
+
+`number` | \{ `depth`: `number`; `indent`: `number`; \}
+
+##### depth?
+
+`number`
+
+#### Returns
+
+`string`

package/docs/variables/InternalErrorCode.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / InternalErrorCode
+
+# Variable: InternalErrorCode
+
+> `const` **InternalErrorCode**: [`InternalError`](../enumerations/ErrorCode.md#internalerror) = `ErrorCode.InternalError`
+
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:27

package/docs/variables/LLM_TOKENIZER_NAMES.md

@@ -0,0 +1,81 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / LLM\_TOKENIZER\_NAMES
+
+# Variable: LLM\_TOKENIZER\_NAMES
+
+> `const` **LLM\_TOKENIZER\_NAMES**: `object`
+
+Defined in: [packages/ai-tool/src/utils/llm-tokenizer.ts:13](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/llm-tokenizer.ts#L13)
+
+## Type declaration
+
+### deepseek-ai/DeepSeek-V2-Lite-Chat
+
+> **deepseek-ai/DeepSeek-V2-Lite-Chat**: `string` = `'deepseek2'`
+
+#### Qwen/Qwen2.5-0.5B
+
+> **5B**: `string` = `'Qwen2.5'`
+
+#### unsloth/Llama-3.2-1B-Instruct
+
+> **2-1B-Instruct**: `string` = `'Llama 3.2'`
+
+### Xenova/bert-base-cased
+
+> **Xenova/bert-base-cased**: `string` = `'bert-base-cased'`
+
+### Xenova/c4ai-command-r-v01-tokenizer
+
+> **Xenova/c4ai-command-r-v01-tokenizer**: `string` = `'Cohere Command-R'`
+
+### Xenova/claude-tokenizer
+
+> **Xenova/claude-tokenizer**: `string` = `'Claude'`
+
+### Xenova/gemma-tokenizer
+
+> **Xenova/gemma-tokenizer**: `string` = `'Gemma'`
+
+### Xenova/gemma2-tokenizer
+
+> **Xenova/gemma2-tokenizer**: `string` = `'Gemma2'`
+
+### Xenova/gpt-3
+
+> **Xenova/gpt-3**: `string` = `'gpt-3'`
+
+### Xenova/gpt-4
+
+> **Xenova/gpt-4**: `string` = `'gpt-4 / gpt-3.5-turbo / text-embedding-ada-002'`
+
+### Xenova/grok-1-tokenizer
+
+> **Xenova/grok-1-tokenizer**: `string` = `'Grok-1'`
+
+### Xenova/llama-tokenizer
+
+> **Xenova/llama-tokenizer**: `string` = `'LLaMA / Llama 2'`
+
+### Xenova/llama3-tokenizer-new
+
+> **Xenova/llama3-tokenizer-new**: `string` = `'Llama 3'`
+
+### Xenova/mistral-tokenizer-v1
+
+> **Xenova/mistral-tokenizer-v1**: `string` = `'Mistral v1'`
+
+### Xenova/mistral-tokenizer-v3
+
+> **Xenova/mistral-tokenizer-v3**: `string` = `'Mistral v3'`
+
+### Xenova/t5-small
+
+> **Xenova/t5-small**: `string` = `'T5'`
+
+### Xenova/text-davinci-003
+
+> **Xenova/text-davinci-003**: `string` = `'text-davinci-003 / text-davinci-002'`

package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / LLM\_TOKENIZER\_NAMES\_MAP
+
+# Variable: LLM\_TOKENIZER\_NAMES\_MAP
+
+> `const` **LLM\_TOKENIZER\_NAMES\_MAP**: `any`
+
+Defined in: [packages/ai-tool/src/utils/llm-tokenizer.ts:33](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/llm-tokenizer.ts#L33)

package/docs/variables/NotFoundErrorCode.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / NotFoundErrorCode
+
+# Variable: NotFoundErrorCode
+
+> `const` **NotFoundErrorCode**: [`NotFound`](../enumerations/ErrorCode.md#notfound) = `ErrorCode.NotFound`
+
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:29

package/docs/variables/NotImplementedErrorCode.md

@@ -0,0 +1,11 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / NotImplementedErrorCode
+
+# Variable: NotImplementedErrorCode
+
+> `const` **NotImplementedErrorCode**: [`NotImplemented`](../enumerations/ErrorCode.md#notimplemented) = `ErrorCode.NotImplemented`
+
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:28