@isdk/ai-tool 0.0.2

package/docs/interfaces/PromptExampleSelectorOptions.md

@@ -0,0 +1,39 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / PromptExampleSelectorOptions
+
+# Interface: PromptExampleSelectorOptions
+
+## Indexable
+
+▪ [name: `string`]: `any`
+
+## Table of contents
+
+### Properties
+
+- [maxLength](PromptExampleSelectorOptions.md#maxlength)
+- [threshold](PromptExampleSelectorOptions.md#threshold)
+
+## Properties
+
+### maxLength
+
+• `Optional` **maxLength**: `number`
+
+The maximum count of the selected examples, or `undefined` if no limit.
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:9](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-example-selector.ts#L9)
+
+___
+
+### threshold
+
+• `Optional` **threshold**: `number` \| `boolean`
+
+The threshold probability (0-1) at which a sample is selected.
+If `true`, defaults to 0.5; if `false`, disable it.
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:14](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-example-selector.ts#L14)

package/docs/interfaces/PromptTemplateOptions.md

@@ -0,0 +1,84 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / PromptTemplateOptions
+
+# Interface: PromptTemplateOptions
+
+## Hierarchy
+
+- **`PromptTemplateOptions`**
+
+  ↳ [`FewShotPromptTemplateOptions`](FewShotPromptTemplateOptions.md)
+
+## Indexable
+
+▪ [name: `string`]: `any`
+
+## Table of contents
+
+### Properties
+
+- [compiledTemplate](PromptTemplateOptions.md#compiledtemplate)
+- [data](PromptTemplateOptions.md#data)
+- [ignoreInitialize](PromptTemplateOptions.md#ignoreinitialize)
+- [inputVariables](PromptTemplateOptions.md#inputvariables)
+- [template](PromptTemplateOptions.md#template)
+- [templateFormat](PromptTemplateOptions.md#templateformat)
+
+## Properties
+
+### compiledTemplate
+
+• `Optional` **compiledTemplate**: `any`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L15)
+
+___
+
+### data
+
+• `Optional` **data**: `Record`\<`string`, `any`\>
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L12)
+
+___
+
+### ignoreInitialize
+
+• `Optional` **ignoreInitialize**: `boolean`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L16)
+
+___
+
+### inputVariables
+
+• `Optional` **inputVariables**: `string`[]
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L14)
+
+___
+
+### template
+
+• `Optional` **template**: `string`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L11)
+
+___
+
+### templateFormat
+
+• `Optional` **templateFormat**: `string`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/prompt/prompt-template.ts#L13)

package/docs/interfaces/RemoteFuncItem.md

@@ -0,0 +1,167 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / RemoteFuncItem
+
+# Interface: RemoteFuncItem
+
+## Hierarchy
+
+- [`BaseFuncItem`](BaseFuncItem.md)
+
+  ↳ **`RemoteFuncItem`**
+
+  ↳↳ [`ClientFuncItem`](ClientFuncItem.md)
+
+  ↳↳ [`ServerFuncItem`](ServerFuncItem.md)
+
+## Table of contents
+
+### Properties
+
+- [action](RemoteFuncItem.md#action)
+- [apiRoot](RemoteFuncItem.md#apiroot)
+- [fetchOptions](RemoteFuncItem.md#fetchoptions)
+- [name](RemoteFuncItem.md#name)
+- [params](RemoteFuncItem.md#params)
+- [result](RemoteFuncItem.md#result)
+- [scope](RemoteFuncItem.md#scope)
+- [setup](RemoteFuncItem.md#setup)
+- [stream](RemoteFuncItem.md#stream)
+- [tags](RemoteFuncItem.md#tags)
+
+## Properties
+
+### action
+
+• `Optional` **action**: ``"get"`` \| ``"post"`` \| ``"put"`` \| ``"delete"`` \| ``"patch"`` \| ``"list"`` \| ``"res"``
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L36)
+
+___
+
+### apiRoot
+
+• `Optional` **apiRoot**: `string`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L35)
+
+___
+
+### fetchOptions
+
+• `Optional` **fetchOptions**: `any`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:37](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L37)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[name](BaseFuncItem.md#name)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L21)
+
+___
+
+### params
+
+• `Optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[params](BaseFuncItem.md#params)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L22)
+
+___
+
+### result
+
+• `Optional` **result**: `string`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[result](BaseFuncItem.md#result)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L23)
+
+___
+
+### scope
+
+• `Optional` **scope**: `any`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[scope](BaseFuncItem.md#scope)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L24)
+
+___
+
+### setup
+
+• `Optional` **setup**: (`this`: [`ToolFunc`](../classes/ToolFunc.md), `options?`: [`FuncItem`](FuncItem.md)) => `void`
+
+#### Type declaration
+
+▸ (`this`, `options?`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `this` | [`ToolFunc`](../classes/ToolFunc.md) |
+| `options?` | [`FuncItem`](FuncItem.md) |
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[setup](BaseFuncItem.md#setup)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L26)
+
+___
+
+### stream
+
+• `Optional` **stream**: `boolean`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:38](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L38)
+
+___
+
+### tags
+
+• `Optional` **tags**: `string` \| `string`[]
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[tags](BaseFuncItem.md#tags)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L25)

package/docs/interfaces/ResClientFuncParams.md

@@ -0,0 +1,34 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / ResClientFuncParams
+
+# Interface: ResClientFuncParams
+
+## Indexable
+
+▪ [name: `string`]: `any`
+
+## Table of contents
+
+### Properties
+
+- [act](ResClientFuncParams.md#act)
+- [id](ResClientFuncParams.md#id)
+
+## Properties
+
+### act
+
+• `Optional` **act**: `string`
+
+#### Defined in
+
+[packages/ai-tool/src/res-client-tools.ts:7](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-client-tools.ts#L7)
+
+___
+
+### id
+
+• `Optional` **id**: `string` \| `number`
+
+#### Defined in
+
+[packages/ai-tool/src/res-client-tools.ts:6](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-client-tools.ts#L6)

package/docs/interfaces/ResServerFuncParams.md

@@ -0,0 +1,79 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / ResServerFuncParams
+
+# Interface: ResServerFuncParams
+
+Convention: Always pass _req, _res
+
+## Hierarchy
+
+- [`ServerFuncParams`](ServerFuncParams.md)
+
+  ↳ **`ResServerFuncParams`**
+
+## Table of contents
+
+### Properties
+
+- [\_req](ResServerFuncParams.md#_req)
+- [\_res](ResServerFuncParams.md#_res)
+- [act](ResServerFuncParams.md#act)
+- [id](ResServerFuncParams.md#id)
+- [val](ResServerFuncParams.md#val)
+
+## Properties
+
+### \_req
+
+• `Optional` **\_req**: `IncomingMessage`
+
+#### Inherited from
+
+[ServerFuncParams](ServerFuncParams.md).[_req](ServerFuncParams.md#_req)
+
+#### Defined in
+
+[packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/server-tools.ts#L9)
+
+___
+
+### \_res
+
+• `Optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
+
+#### Inherited from
+
+[ServerFuncParams](ServerFuncParams.md).[_res](ServerFuncParams.md#_res)
+
+#### Defined in
+
+[packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/server-tools.ts#L10)
+
+___
+
+### act
+
+• `Optional` **act**: `string`
+
+#### Defined in
+
+[packages/ai-tool/src/res-server-tools.ts:11](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-server-tools.ts#L11)
+
+___
+
+### id
+
+• `Optional` **id**: `string` \| `number`
+
+#### Defined in
+
+[packages/ai-tool/src/res-server-tools.ts:8](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-server-tools.ts#L8)
+
+___
+
+### val
+
+• `Optional` **val**: `any`
+
+#### Defined in
+
+[packages/ai-tool/src/res-server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-server-tools.ts#L10)

package/docs/interfaces/SanitizeFilenameOptions.md

@@ -0,0 +1,30 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / SanitizeFilenameOptions
+
+# Interface: SanitizeFilenameOptions
+
+## Table of contents
+
+### Properties
+
+- [maxLength](SanitizeFilenameOptions.md#maxlength)
+- [replacement](SanitizeFilenameOptions.md#replacement)
+
+## Properties
+
+### maxLength
+
+• `Optional` **maxLength**: `number`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/filename.ts:85](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/filename.ts#L85)
+
+___
+
+### replacement
+
+• `Optional` **replacement**: `string`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/filename.ts:84](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/filename.ts#L84)

package/docs/interfaces/ServerFuncItem.md

@@ -0,0 +1,192 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / ServerFuncItem
+
+# Interface: ServerFuncItem
+
+## Hierarchy
+
+- [`RemoteFuncItem`](RemoteFuncItem.md)
+
+  ↳ **`ServerFuncItem`**
+
+  ↳↳ [`ServerTools`](../classes/ServerTools.md)
+
+## Table of contents
+
+### Properties
+
+- [action](ServerFuncItem.md#action)
+- [allowExportFunc](ServerFuncItem.md#allowexportfunc)
+- [apiRoot](ServerFuncItem.md#apiroot)
+- [fetchOptions](ServerFuncItem.md#fetchoptions)
+- [name](ServerFuncItem.md#name)
+- [params](ServerFuncItem.md#params)
+- [result](ServerFuncItem.md#result)
+- [scope](ServerFuncItem.md#scope)
+- [setup](ServerFuncItem.md#setup)
+- [stream](ServerFuncItem.md#stream)
+- [tags](ServerFuncItem.md#tags)
+
+## Properties
+
+### action
+
+• `Optional` **action**: ``"get"`` \| ``"post"`` \| ``"put"`` \| ``"delete"`` \| ``"patch"`` \| ``"list"`` \| ``"res"``
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[action](RemoteFuncItem.md#action)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L36)
+
+___
+
+### allowExportFunc
+
+• `Optional` **allowExportFunc**: `boolean`
+
+#### Defined in
+
+[packages/ai-tool/src/server-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/server-tools.ts#L14)
+
+___
+
+### apiRoot
+
+• `Optional` **apiRoot**: `string`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[apiRoot](RemoteFuncItem.md#apiroot)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L35)
+
+___
+
+### fetchOptions
+
+• `Optional` **fetchOptions**: `any`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[fetchOptions](RemoteFuncItem.md#fetchoptions)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:37](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L37)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[name](RemoteFuncItem.md#name)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L21)
+
+___
+
+### params
+
+• `Optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[params](RemoteFuncItem.md#params)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L22)
+
+___
+
+### result
+
+• `Optional` **result**: `string`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[result](RemoteFuncItem.md#result)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L23)
+
+___
+
+### scope
+
+• `Optional` **scope**: `any`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[scope](RemoteFuncItem.md#scope)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L24)
+
+___
+
+### setup
+
+• `Optional` **setup**: (`this`: [`ToolFunc`](../classes/ToolFunc.md), `options?`: [`FuncItem`](FuncItem.md)) => `void`
+
+#### Type declaration
+
+▸ (`this`, `options?`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `this` | [`ToolFunc`](../classes/ToolFunc.md) |
+| `options?` | [`FuncItem`](FuncItem.md) |
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[setup](RemoteFuncItem.md#setup)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L26)
+
+___
+
+### stream
+
+• `Optional` **stream**: `boolean`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[stream](RemoteFuncItem.md#stream)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:38](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L38)
+
+___
+
+### tags
+
+• `Optional` **tags**: `string` \| `string`[]
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[tags](RemoteFuncItem.md#tags)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L25)

package/docs/interfaces/ServerFuncParams.md

@@ -0,0 +1,44 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / ServerFuncParams
+
+# Interface: ServerFuncParams
+
+Convention: Always pass _req, _res
+
+## Hierarchy
+
+- **`ServerFuncParams`**
+
+  ↳ [`EventServerFuncParams`](EventServerFuncParams.md)
+
+  ↳ [`ResServerFuncParams`](ResServerFuncParams.md)
+
+## Indexable
+
+▪ [name: `string`]: `any`
+
+## Table of contents
+
+### Properties
+
+- [\_req](ServerFuncParams.md#_req)
+- [\_res](ServerFuncParams.md#_res)
+
+## Properties
+
+### \_req
+
+• `Optional` **\_req**: `IncomingMessage`
+
+#### Defined in
+
+[packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/server-tools.ts#L9)
+
+___
+
+### \_res
+
+• `Optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
+
+#### Defined in
+
+[packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/server-tools.ts#L10)