@isdk/ai-tool 0.5.2 → 0.5.3

package/docs/interfaces/ClientFuncItem.md

@@ -0,0 +1,163 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ClientFuncItem
+
+# Interface: ClientFuncItem
+
+Defined in: [packages/ai-tool/src/client-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/client-tools.ts#L5)
+
+## Extends
+
+- [`RemoteFuncItem`](RemoteFuncItem.md)
+
+## Extended by
+
+- [`ClientTools`](../classes/ClientTools.md)
+
+## Properties
+
+### action?
+
+> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L35)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`action`](RemoteFuncItem.md#action)
+
+***
+
+### apiRoot?
+
+> `optional` **apiRoot**: `string`
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L34)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`apiRoot`](RemoteFuncItem.md#apiroot)
+
+***
+
+### fetchOptions?
+
+> `optional` **fetchOptions**: `any`
+
+Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/consts.ts#L36)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`fetchOptions`](RemoteFuncItem.md#fetchoptions)
+
+***
+
+### isApi?
+
+> `optional` **isApi**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L29)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`isApi`](RemoteFuncItem.md#isapi)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L23)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`name`](RemoteFuncItem.md#name)
+
+***
+
+### params?
+
+> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L24)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`params`](RemoteFuncItem.md#params)
+
+***
+
+### result?
+
+> `optional` **result**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L25)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`result`](RemoteFuncItem.md#result)
+
+***
+
+### scope?
+
+> `optional` **scope**: `any`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L26)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`scope`](RemoteFuncItem.md#scope)
+
+***
+
+### setup()?
+
+> `optional` **setup**: (`this`, `options`?) => `void`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L28)
+
+#### Parameters
+
+##### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+##### options?
+
+[`FuncItem`](FuncItem.md)
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`setup`](RemoteFuncItem.md#setup)
+
+***
+
+### stream?
+
+> `optional` **stream**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L30)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`stream`](RemoteFuncItem.md#stream)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string` \| `string`[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L27)
+
+#### Inherited from
+
+[`RemoteFuncItem`](RemoteFuncItem.md).[`tags`](RemoteFuncItem.md#tags)

package/docs/interfaces/DotenvExpandOptions.md

@@ -0,0 +1,43 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / DotenvExpandOptions
+
+# Interface: DotenvExpandOptions
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:202](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/env.ts#L202)
+
+## Properties
+
+### error?
+
+> `optional` **error**: `Error`
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:203](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/env.ts#L203)
+
+***
+
+### parsed?
+
+> `optional` **parsed**: [`DotenvParseInput`](DotenvParseInput.md)
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:219](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/env.ts#L219)
+
+Default: `object`
+
+Object coming from dotenv's parsed result.
+
+***
+
+### processEnv?
+
+> `optional` **processEnv**: [`DotenvPopulateInput`](DotenvPopulateInput.md)
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:212](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/env.ts#L212)
+
+Default: `process.env`
+
+Specify an object to write your secrets to. Defaults to process.env environment variables.
+
+example: `const processEnv = {}; require('dotenv').config({ processEnv: processEnv })`

package/docs/interfaces/DotenvExpandOutput.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / DotenvExpandOutput
+
+# Interface: DotenvExpandOutput
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:222](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/env.ts#L222)
+
+## Properties
+
+### error?
+
+> `optional` **error**: `Error`
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:223](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/env.ts#L223)
+
+***
+
+### parsed?
+
+> `optional` **parsed**: [`DotenvParseOutput`](DotenvParseOutput.md)
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:224](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/env.ts#L224)

package/docs/interfaces/DotenvParseInput.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / DotenvParseInput
+
+# Interface: DotenvParseInput
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:194](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/env.ts#L194)
+
+## Indexable
+
+\[`name`: `string`\]: `undefined` \| `string`

package/docs/interfaces/DotenvParseOutput.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / DotenvParseOutput
+
+# Interface: DotenvParseOutput
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:198](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/env.ts#L198)
+
+## Indexable
+
+\[`name`: `string`\]: `undefined` \| `string`

package/docs/interfaces/DotenvPopulateInput.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / DotenvPopulateInput
+
+# Interface: DotenvPopulateInput
+
+Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:190](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/template/env.ts#L190)
+
+## Indexable
+
+\[`name`: `string`\]: `undefined` \| `string`

package/docs/interfaces/EventClientFuncParams.md

@@ -0,0 +1,51 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / EventClientFuncParams
+
+# Interface: EventClientFuncParams
+
+Defined in: [packages/ai-tool/src/funcs/event-client.ts:5](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event-client.ts#L5)
+
+## Properties
+
+### act?
+
+> `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"` \| `"init"`
+
+Defined in: [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event-client.ts#L8)
+
+***
+
+### data?
+
+> `optional` **data**: `any`
+
+Defined in: [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event-client.ts#L7)
+
+***
+
+### event?
+
+> `optional` **event**: `string` \| `string`[]
+
+Defined in: [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event-client.ts#L6)
+
+***
+
+### listener()?
+
+> `optional` **listener**: (...`args`) => `void`
+
+Defined in: [packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event-client.ts#L9)
+
+#### Parameters
+
+##### args
+
+...`any`[]
+
+#### Returns
+
+`void`

package/docs/interfaces/EventServerFuncParams.md

@@ -0,0 +1,67 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / EventServerFuncParams
+
+# Interface: EventServerFuncParams
+
+Defined in: [packages/ai-tool/src/funcs/event-server.ts:12](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event-server.ts#L12)
+
+Convention: Always pass _req, _res
+
+## Extends
+
+- [`ServerFuncParams`](ServerFuncParams.md)
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### \_req?
+
+> `optional` **\_req**: `IncomingMessage`
+
+Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L9)
+
+#### Inherited from
+
+[`ServerFuncParams`](ServerFuncParams.md).[`_req`](ServerFuncParams.md#_req)
+
+***
+
+### \_res?
+
+> `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
+
+Defined in: [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/server-tools.ts#L10)
+
+#### Inherited from
+
+[`ServerFuncParams`](ServerFuncParams.md).[`_res`](ServerFuncParams.md#_res)
+
+***
+
+### act?
+
+> `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"`
+
+Defined in: [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event-server.ts#L15)
+
+***
+
+### data?
+
+> `optional` **data**: `any`
+
+Defined in: [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event-server.ts#L14)
+
+***
+
+### event?
+
+> `optional` **event**: `string` \| `string`[]
+
+Defined in: [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/funcs/event-server.ts#L13)

package/docs/interfaces/FewShotPromptTemplateOptions.md

@@ -0,0 +1,147 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / FewShotPromptTemplateOptions
+
+# Interface: FewShotPromptTemplateOptions\<T\>
+
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:10](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/few-shot-prompt-template.ts#L10)
+
+## Extends
+
+- [`PromptTemplateOptions`](PromptTemplateOptions.md)
+
+## Type Parameters
+
+• **T** = `any`
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## 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/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L15)
+
+#### Inherited from
+
+[`PromptTemplateOptions`](PromptTemplateOptions.md).[`compiledTemplate`](PromptTemplateOptions.md#compiledtemplate)
+
+***
+
+### 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/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L12)
+
+#### Inherited from
+
+[`PromptTemplateOptions`](PromptTemplateOptions.md).[`data`](PromptTemplateOptions.md#data)
+
+***
+
+### examplePrompt
+
+> **examplePrompt**: [`PromptTemplateOptions`](PromptTemplateOptions.md) \| [`PromptTemplate`](../classes/PromptTemplate.md)
+
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:19](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/few-shot-prompt-template.ts#L19)
+
+An [PromptTemplate](../classes/PromptTemplate.md) used to format a single example.
+
+***
+
+### examples
+
+> **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
+
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/few-shot-prompt-template.ts#L14)
+
+The few shot examples to use in the prompt.
+
+***
+
+### exampleSeparator?
+
+> `optional` **exampleSeparator**: `string`
+
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/few-shot-prompt-template.ts#L24)
+
+String separator used to join the prefix, the examples, and suffix.
+
+***
+
+### ignoreInitialize?
+
+> `optional` **ignoreInitialize**: `boolean`
+
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L16)
+
+#### Inherited from
+
+[`PromptTemplateOptions`](PromptTemplateOptions.md).[`ignoreInitialize`](PromptTemplateOptions.md#ignoreinitialize)
+
+***
+
+### inputVariables?
+
+> `optional` **inputVariables**: `string`[]
+
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L14)
+
+#### Inherited from
+
+[`PromptTemplateOptions`](PromptTemplateOptions.md).[`inputVariables`](PromptTemplateOptions.md#inputvariables)
+
+***
+
+### prefix?
+
+> `optional` **prefix**: `string`
+
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/few-shot-prompt-template.ts#L31)
+
+A prompt template string to put before the examples.
+
+#### Default Value
+
+`""`
+
+***
+
+### suffix?
+
+> `optional` **suffix**: `string`
+
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:36](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/few-shot-prompt-template.ts#L36)
+
+A prompt template string to put after the examples.
+
+***
+
+### template?
+
+> `optional` **template**: `string`
+
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L11)
+
+#### Inherited from
+
+[`PromptTemplateOptions`](PromptTemplateOptions.md).[`template`](PromptTemplateOptions.md#template)
+
+***
+
+### templateFormat?
+
+> `optional` **templateFormat**: `string`
+
+Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L13)
+
+#### Inherited from
+
+[`PromptTemplateOptions`](PromptTemplateOptions.md).[`templateFormat`](PromptTemplateOptions.md#templateformat)

package/docs/interfaces/FuncItem.md

@@ -0,0 +1,131 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / FuncItem
+
+# Interface: FuncItem
+
+Defined in: [packages/ai-tool/src/tool-func.ts:33](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L33)
+
+## Extends
+
+- [`BaseFuncItem`](BaseFuncItem.md)
+
+## Properties
+
+### func?
+
+> `optional` **func**: [`TFunc`](../type-aliases/TFunc.md)
+
+Defined in: [packages/ai-tool/src/tool-func.ts:34](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L34)
+
+***
+
+### isApi?
+
+> `optional` **isApi**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L29)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`isApi`](BaseFuncItem.md#isapi)
+
+***
+
+### name?
+
+> `optional` **name**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L23)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name)
+
+***
+
+### params?
+
+> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L24)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`params`](BaseFuncItem.md#params)
+
+***
+
+### result?
+
+> `optional` **result**: `string`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L25)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`result`](BaseFuncItem.md#result)
+
+***
+
+### scope?
+
+> `optional` **scope**: `any`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L26)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`scope`](BaseFuncItem.md#scope)
+
+***
+
+### setup()?
+
+> `optional` **setup**: (`this`, `options`?) => `void`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L28)
+
+#### Parameters
+
+##### this
+
+[`ToolFunc`](../classes/ToolFunc.md)
+
+##### options?
+
+[`FuncItem`](FuncItem.md)
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`setup`](BaseFuncItem.md#setup)
+
+***
+
+### stream?
+
+> `optional` **stream**: `boolean`
+
+Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L30)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`stream`](BaseFuncItem.md#stream)
+
+***
+
+### tags?
+
+> `optional` **tags**: `string` \| `string`[]
+
+Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/tool-func.ts#L27)
+
+#### Inherited from
+
+[`BaseFuncItem`](BaseFuncItem.md).[`tags`](BaseFuncItem.md#tags)