@isdk/ai-tool 0.2.0 → 0.2.1

package/docs/variables/AlreadyExistsErrorCode.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@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.1/node\_modules/@isdk/common-error/dist/index.d.ts:30

package/docs/variables/ClientToolFuncSchema.md

@@ -0,0 +1,87 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / ClientToolFuncSchema
+
+# Variable: ClientToolFuncSchema
+
+> `const` **ClientToolFuncSchema**: `object`
+
+## 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'`
+
+## Defined in
+
+[packages/ai-tool/src/client-tools.ts:153](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/client-tools.ts#L153)

package/docs/variables/DefaultAsyncSemaphoreCapacity.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / DefaultAsyncSemaphoreCapacity
+
+# Variable: DefaultAsyncSemaphoreCapacity
+
+> `const` **DefaultAsyncSemaphoreCapacity**: `32` = `32`
+
+## Defined in
+
+[packages/ai-tool/src/utils/async-semaphore.ts:6](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/async-semaphore.ts#L6)

package/docs/variables/EventBusName.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@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:7](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/event/event-ability.ts#L7)

package/docs/variables/EventName.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / EventName
+
+# Variable: EventName
+
+> `const` **EventName**: `"event"` = `'event'`
+
+## Defined in
+
+[packages/ai-tool/src/utils/event/event-ability.ts:6](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/event/event-ability.ts#L6)

package/docs/variables/FilenameReservedRegex.md

@@ -0,0 +1,16 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / FilenameReservedRegex
+
+# Variable: FilenameReservedRegex
+
+> `const` **FilenameReservedRegex**: `RegExp`
+
+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.
+
+## Defined in
+
+[packages/ai-tool/src/utils/filename.ts:8](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/filename.ts#L8)

package/docs/variables/HFBuiltins.md

@@ -0,0 +1,92 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / HFBuiltins
+
+# Variable: HFBuiltins
+
+> `const` **HFBuiltins**: `object`
+
+## Type declaration
+
+### 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?**: `string` \| `number`
+
+Optional, specifies the index or key to select. Negative values indicate indices from the end.
+
+#### 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` \| `object`
+
+• **depth?**: `number`
+
+#### Returns
+
+`string`
+
+## Defined in
+
+[packages/ai-tool/src/utils/prompt/template/jinja/src/builtins.ts:61](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/template/jinja/src/builtins.ts#L61)

package/docs/variables/InternalErrorCode.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@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.1/node\_modules/@isdk/common-error/dist/index.d.ts:27

package/docs/variables/NotFoundErrorCode.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@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.1/node\_modules/@isdk/common-error/dist/index.d.ts:29

package/docs/variables/NotImplementedErrorCode.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@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.1/node\_modules/@isdk/common-error/dist/index.d.ts:28

package/docs/variables/PASSING_SCORE.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / PASSING\_SCORE
+
+# Variable: PASSING\_SCORE
+
+> `const` **PASSING\_SCORE**: `0.618` = `0.618`
+
+## Defined in
+
+[packages/ai-tool/src/utils/consts.ts:3](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/consts.ts#L3)

package/docs/variables/PromptTemplateTypes.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / PromptTemplateTypes
+
+# Variable: PromptTemplateTypes
+
+> `const` **PromptTemplateTypes**: readonly [`"internal"`, `"hf"`, `"fill"`]
+
+## Defined in
+
+[packages/ai-tool/src/utils/prompt/consts.ts:12](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/consts.ts#L12)

package/docs/variables/PromptTypes.md

@@ -0,0 +1,16 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / PromptTypes
+
+# Variable: PromptTypes
+
+> `const` **PromptTypes**: readonly [`"chat"`, `"char"`, `"plan"`]
+
+Prompt Type
+defaults to `chat`
+
+## Defined in
+
+[packages/ai-tool/src/utils/prompt/consts.ts:5](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/consts.ts#L5)

package/docs/variables/RStreamErrCode.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / RStreamErrCode
+
+# Variable: RStreamErrCode
+
+> `const` **RStreamErrCode**: `600` = `600`
+
+## Defined in
+
+[packages/ai-tool/src/utils/stream/error-readable-stream.ts:3](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/error-readable-stream.ts#L3)

package/docs/variables/RemoteToolFuncSchema.md

@@ -0,0 +1,87 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / RemoteToolFuncSchema
+
+# Variable: RemoteToolFuncSchema
+
+> `const` **RemoteToolFuncSchema**: `object`
+
+## 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'`
+
+## Defined in
+
+[packages/ai-tool/src/utils/consts.ts:13](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/consts.ts#L13)

package/docs/variables/ResponseRStreamErrCode.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / ResponseRStreamErrCode
+
+# Variable: ResponseRStreamErrCode
+
+> `const` **ResponseRStreamErrCode**: `601` = `601`
+
+## Defined in
+
+[packages/ai-tool/src/utils/stream/error-readable-stream.ts:4](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/stream/error-readable-stream.ts#L4)

package/docs/variables/SSEChannelAlreadyClosedErrCode.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / SSEChannelAlreadyClosedErrCode
+
+# Variable: SSEChannelAlreadyClosedErrCode
+
+> `const` **SSEChannelAlreadyClosedErrCode**: `498` = `498`
+
+## Defined in
+
+[packages/ai-tool/src/utils/event/sse-channel.ts:17](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/event/sse-channel.ts#L17)

package/docs/variables/ServerToolFuncSchema.md

@@ -0,0 +1,87 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / ServerToolFuncSchema
+
+# Variable: ServerToolFuncSchema
+
+> `const` **ServerToolFuncSchema**: `object`
+
+## 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'`
+
+## Defined in
+
+[packages/ai-tool/src/server-tools.ts:62](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/server-tools.ts#L62)

package/docs/variables/ToolAsyncCancelableBit.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / ToolAsyncCancelableBit
+
+# Variable: ToolAsyncCancelableBit
+
+> `const` **ToolAsyncCancelableBit**: `1` = `1`
+
+## Defined in
+
+[packages/ai-tool/src/tool-func.ts:8](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L8)

package/docs/variables/ToolAsyncMultiTaskBit.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / ToolAsyncMultiTaskBit
+
+# Variable: ToolAsyncMultiTaskBit
+
+> `const` **ToolAsyncMultiTaskBit**: `0` = `0`
+
+## Defined in
+
+[packages/ai-tool/src/tool-func.ts:7](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L7)

package/docs/variables/ToolAsyncPriorityBit.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md) • **Docs**
+
+***
+
+[@isdk/ai-tool](../globals.md) / ToolAsyncPriorityBit
+
+# Variable: ToolAsyncPriorityBit
+
+> `const` **ToolAsyncPriorityBit**: `2` = `2`
+
+## Defined in
+
+[packages/ai-tool/src/tool-func.ts:9](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/tool-func.ts#L9)