@isdk/ai-tool 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/README.cn.md +261 -0
  2. package/README.md +3 -0
  3. package/dist/chunk-EZFPVSGF.mjs +22 -0
  4. package/dist/chunk-PKECBABP.mjs +5085 -0
  5. package/dist/funcs.d.mts +6 -0
  6. package/dist/funcs.d.ts +6 -0
  7. package/dist/funcs.js +5016 -0
  8. package/dist/funcs.mjs +37 -0
  9. package/dist/index-D4KjfAKl.d.mts +606 -0
  10. package/dist/index-D4KjfAKl.d.ts +606 -0
  11. package/dist/index.d.mts +1097 -0
  12. package/dist/index.d.ts +1097 -0
  13. package/dist/index.js +5239 -0
  14. package/dist/index.mjs +399 -0
  15. package/dist/test/util.d.mts +7 -0
  16. package/dist/test/util.d.ts +7 -0
  17. package/dist/test/util.js +98 -0
  18. package/dist/test/util.mjs +61 -0
  19. package/docs/.nojekyll +1 -0
  20. package/docs/README.md +5 -0
  21. package/docs/classes/AbortError.md +359 -0
  22. package/docs/classes/AlreadyExistsError.md +339 -0
  23. package/docs/classes/BaseError.md +346 -0
  24. package/docs/classes/ClientTools.md +2705 -0
  25. package/docs/classes/CommonError.md +368 -0
  26. package/docs/classes/ConfigFile.md +346 -0
  27. package/docs/classes/EventClient.md +3183 -0
  28. package/docs/classes/EventServer.md +3138 -0
  29. package/docs/classes/EventToolFunc.md +2498 -0
  30. package/docs/classes/FStringPromptTemplate.md +1236 -0
  31. package/docs/classes/FewShotPromptTemplate.md +1286 -0
  32. package/docs/classes/GolangPromptTemplate.md +1236 -0
  33. package/docs/classes/HFEnvironment.md +212 -0
  34. package/docs/classes/HFInterpreter.md +386 -0
  35. package/docs/classes/HFTemplate.md +79 -0
  36. package/docs/classes/HfPromptTemplate.md +1236 -0
  37. package/docs/classes/NotFoundError.md +339 -0
  38. package/docs/classes/NotImplementationError.md +339 -0
  39. package/docs/classes/PromptExampleSelector.md +207 -0
  40. package/docs/classes/PromptTemplate.md +1163 -0
  41. package/docs/classes/ReadableStreamError.md +359 -0
  42. package/docs/classes/ResClientTools.md +2859 -0
  43. package/docs/classes/ResServerTools.md +2783 -0
  44. package/docs/classes/SSEChannel.md +289 -0
  45. package/docs/classes/ServerTools.md +2633 -0
  46. package/docs/classes/ToolFunc.md +2124 -0
  47. package/docs/enums/ErrorCode.md +217 -0
  48. package/docs/enums/XXHashAlgorithm.md +30 -0
  49. package/docs/interfaces/AIChatAssistantMessageParam.md +84 -0
  50. package/docs/interfaces/AIChatContentPartImage.md +36 -0
  51. package/docs/interfaces/AIChatContentPartText.md +30 -0
  52. package/docs/interfaces/AIChatMessageParamBase.md +35 -0
  53. package/docs/interfaces/AIChatMessageToolCall.md +48 -0
  54. package/docs/interfaces/AIChatSystemMessageParam.md +51 -0
  55. package/docs/interfaces/AIChatToolMessageParam.md +62 -0
  56. package/docs/interfaces/AIChatUserMessageParam.md +95 -0
  57. package/docs/interfaces/AIResult.md +65 -0
  58. package/docs/interfaces/AIStreamCallbacksAndOptions.md +158 -0
  59. package/docs/interfaces/AIStreamParser.md +33 -0
  60. package/docs/interfaces/AIStreamParserOptions.md +23 -0
  61. package/docs/interfaces/BaseFunc.md +145 -0
  62. package/docs/interfaces/BaseFuncItem.md +99 -0
  63. package/docs/interfaces/ClientFuncItem.md +181 -0
  64. package/docs/interfaces/DotenvExpandOptions.md +51 -0
  65. package/docs/interfaces/DotenvExpandOutput.md +30 -0
  66. package/docs/interfaces/DotenvParseInput.md +7 -0
  67. package/docs/interfaces/DotenvParseOutput.md +7 -0
  68. package/docs/interfaces/DotenvPopulateInput.md +7 -0
  69. package/docs/interfaces/EventClientFuncParams.md +66 -0
  70. package/docs/interfaces/EventServerFuncParams.md +79 -0
  71. package/docs/interfaces/FewShotPromptTemplateOptions.md +179 -0
  72. package/docs/interfaces/FuncItem.md +130 -0
  73. package/docs/interfaces/FuncParam.md +67 -0
  74. package/docs/interfaces/FuncParams.md +7 -0
  75. package/docs/interfaces/Funcs.md +7 -0
  76. package/docs/interfaces/IOptions.md +30 -0
  77. package/docs/interfaces/JsonFilter.md +7 -0
  78. package/docs/interfaces/PromptExampleSelectorOptions.md +39 -0
  79. package/docs/interfaces/PromptTemplateOptions.md +84 -0
  80. package/docs/interfaces/RemoteFuncItem.md +167 -0
  81. package/docs/interfaces/ResClientFuncParams.md +34 -0
  82. package/docs/interfaces/ResServerFuncParams.md +79 -0
  83. package/docs/interfaces/SanitizeFilenameOptions.md +30 -0
  84. package/docs/interfaces/ServerFuncItem.md +192 -0
  85. package/docs/interfaces/ServerFuncParams.md +44 -0
  86. package/docs/modules.md +2707 -0
  87. package/package.json +112 -0
@@ -0,0 +1,2859 @@
1
+ [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / ResClientTools
2
+
3
+ # Class: ResClientTools
4
+
5
+ ## Hierarchy
6
+
7
+ - [`ClientTools`](ClientTools.md)
8
+
9
+ ↳ **`ResClientTools`**
10
+
11
+ ↳↳ [`EventClient`](EventClient.md)
12
+
13
+ ## Table of contents
14
+
15
+ ### Constructors
16
+
17
+ - [constructor](ResClientTools.md#constructor)
18
+
19
+ ### Properties
20
+
21
+ - [$attributes](ResClientTools.md#$attributes)
22
+ - [action](ResClientTools.md#action)
23
+ - [apiRoot](ResClientTools.md#apiroot)
24
+ - [constructor](ResClientTools.md#constructor-1)
25
+ - [defaultOptions](ResClientTools.md#defaultoptions)
26
+ - [fetchOptions](ResClientTools.md#fetchoptions)
27
+ - [name](ResClientTools.md#name)
28
+ - [nonExported1stChar](ResClientTools.md#nonexported1stchar)
29
+ - [params](ResClientTools.md#params)
30
+ - [result](ResClientTools.md#result)
31
+ - [scope](ResClientTools.md#scope)
32
+ - [setup](ResClientTools.md#setup)
33
+ - [should](ResClientTools.md#should)
34
+ - [stream](ResClientTools.md#stream)
35
+ - [tags](ResClientTools.md#tags)
36
+ - [dataPath](ResClientTools.md#datapath)
37
+ - [items](ResClientTools.md#items)
38
+
39
+ ### Accessors
40
+
41
+ - [apiRoot](ResClientTools.md#apiroot-1)
42
+
43
+ ### Methods
44
+
45
+ - [\_func](ResClientTools.md#_func)
46
+ - [arr2ObjParams](ResClientTools.md#arr2objparams)
47
+ - [assign](ResClientTools.md#assign)
48
+ - [assignMethods](ResClientTools.md#assignmethods)
49
+ - [assignProperty](ResClientTools.md#assignproperty)
50
+ - [assignPropertyTo](ResClientTools.md#assignpropertyto)
51
+ - [assignTo](ResClientTools.md#assignto)
52
+ - [clone](ResClientTools.md#clone)
53
+ - [cloneTo](ResClientTools.md#cloneto)
54
+ - [defineProperties](ResClientTools.md#defineproperties)
55
+ - [delete](ResClientTools.md#delete)
56
+ - [errorFrom](ResClientTools.md#errorfrom)
57
+ - [exportTo](ResClientTools.md#exportto)
58
+ - [fetch](ResClientTools.md#fetch)
59
+ - [func](ResClientTools.md#func)
60
+ - [get](ResClientTools.md#get)
61
+ - [getFunc](ResClientTools.md#getfunc)
62
+ - [getFuncWithPos](ResClientTools.md#getfuncwithpos)
63
+ - [getProperties](ResClientTools.md#getproperties)
64
+ - [getUrlParams](ResClientTools.md#geturlparams)
65
+ - [hasOwnProperty](ResClientTools.md#hasownproperty)
66
+ - [initialize](ResClientTools.md#initialize)
67
+ - [isPrototypeOf](ResClientTools.md#isprototypeof)
68
+ - [isSame](ResClientTools.md#issame)
69
+ - [list](ResClientTools.md#list)
70
+ - [mergeTo](ResClientTools.md#mergeto)
71
+ - [obj2ArrParams](ResClientTools.md#obj2arrparams)
72
+ - [post](ResClientTools.md#post)
73
+ - [propertyIsEnumerable](ResClientTools.md#propertyisenumerable)
74
+ - [put](ResClientTools.md#put)
75
+ - [register](ResClientTools.md#register)
76
+ - [run](ResClientTools.md#run)
77
+ - [runAs](ResClientTools.md#runas)
78
+ - [runAsSync](ResClientTools.md#runassync)
79
+ - [runSync](ResClientTools.md#runsync)
80
+ - [runWithPos](ResClientTools.md#runwithpos)
81
+ - [runWithPosAs](ResClientTools.md#runwithposas)
82
+ - [runWithPosAsSync](ResClientTools.md#runwithposassync)
83
+ - [runWithPosSync](ResClientTools.md#runwithpossync)
84
+ - [toJSON](ResClientTools.md#tojson)
85
+ - [toLocaleString](ResClientTools.md#tolocalestring)
86
+ - [toObject](ResClientTools.md#toobject)
87
+ - [toString](ResClientTools.md#tostring)
88
+ - [unregister](ResClientTools.md#unregister)
89
+ - [valueOf](ResClientTools.md#valueof)
90
+ - [assign](ResClientTools.md#assign-1)
91
+ - [create](ResClientTools.md#create)
92
+ - [defineProperties](ResClientTools.md#defineproperties-1)
93
+ - [defineProperty](ResClientTools.md#defineproperty)
94
+ - [entries](ResClientTools.md#entries)
95
+ - [fetch](ResClientTools.md#fetch-1)
96
+ - [freeze](ResClientTools.md#freeze)
97
+ - [fromEntries](ResClientTools.md#fromentries)
98
+ - [get](ResClientTools.md#get-1)
99
+ - [getAllByTag](ResClientTools.md#getallbytag)
100
+ - [getByTag](ResClientTools.md#getbytag)
101
+ - [getFunc](ResClientTools.md#getfunc-1)
102
+ - [getFuncWithPos](ResClientTools.md#getfuncwithpos-1)
103
+ - [getOwnPropertyDescriptor](ResClientTools.md#getownpropertydescriptor)
104
+ - [getOwnPropertyDescriptors](ResClientTools.md#getownpropertydescriptors)
105
+ - [getOwnPropertyNames](ResClientTools.md#getownpropertynames)
106
+ - [getOwnPropertySymbols](ResClientTools.md#getownpropertysymbols)
107
+ - [getProperties](ResClientTools.md#getproperties-1)
108
+ - [getPrototypeOf](ResClientTools.md#getprototypeof)
109
+ - [hasOwn](ResClientTools.md#hasown)
110
+ - [is](ResClientTools.md#is)
111
+ - [isExtensible](ResClientTools.md#isextensible)
112
+ - [isFrozen](ResClientTools.md#isfrozen)
113
+ - [isSealed](ResClientTools.md#issealed)
114
+ - [keys](ResClientTools.md#keys)
115
+ - [list](ResClientTools.md#list-1)
116
+ - [loadFrom](ResClientTools.md#loadfrom)
117
+ - [loadFromSync](ResClientTools.md#loadfromsync)
118
+ - [preventExtensions](ResClientTools.md#preventextensions)
119
+ - [register](ResClientTools.md#register-1)
120
+ - [run](ResClientTools.md#run-1)
121
+ - [runSync](ResClientTools.md#runsync-1)
122
+ - [runWithPos](ResClientTools.md#runwithpos-1)
123
+ - [runWithPosSync](ResClientTools.md#runwithpossync-1)
124
+ - [seal](ResClientTools.md#seal)
125
+ - [setApiRoot](ResClientTools.md#setapiroot)
126
+ - [setPrototypeOf](ResClientTools.md#setprototypeof)
127
+ - [unregister](ResClientTools.md#unregister-1)
128
+ - [values](ResClientTools.md#values)
129
+
130
+ ## Constructors
131
+
132
+ ### constructor
133
+
134
+ • **new ResClientTools**(`name`, `options?`): [`ResClientTools`](ResClientTools.md)
135
+
136
+ #### Parameters
137
+
138
+ | Name | Type |
139
+ | :------ | :------ |
140
+ | `name` | `string` \| `Function` \| [`FuncItem`](../interfaces/FuncItem.md) |
141
+ | `options` | `any` |
142
+
143
+ #### Returns
144
+
145
+ [`ResClientTools`](ResClientTools.md)
146
+
147
+ #### Inherited from
148
+
149
+ [ClientTools](ClientTools.md).[constructor](ClientTools.md#constructor)
150
+
151
+ #### Defined in
152
+
153
+ [packages/ai-tool/src/tool-func.ts:175](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L175)
154
+
155
+ ## Properties
156
+
157
+ ### $attributes
158
+
159
+ • **$attributes**: `Properties`
160
+
161
+ #### Inherited from
162
+
163
+ [ClientTools](ClientTools.md).[$attributes](ClientTools.md#$attributes)
164
+
165
+ #### Defined in
166
+
167
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/advance.d.ts:5
168
+
169
+ ___
170
+
171
+ ### action
172
+
173
+ • `Optional` **action**: ``"get"`` \| ``"post"`` \| ``"put"`` \| ``"delete"`` \| ``"patch"`` \| ``"list"`` \| ``"res"``
174
+
175
+ #### Inherited from
176
+
177
+ [ClientTools](ClientTools.md).[action](ClientTools.md#action)
178
+
179
+ #### Defined in
180
+
181
+ [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L36)
182
+
183
+ ___
184
+
185
+ ### apiRoot
186
+
187
+ • **apiRoot**: `undefined` \| `string`
188
+
189
+ #### Inherited from
190
+
191
+ [ClientTools](ClientTools.md).[apiRoot](ClientTools.md#apiroot)
192
+
193
+ #### Defined in
194
+
195
+ [packages/ai-tool/src/client-tools.ts:16](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/client-tools.ts#L16)
196
+
197
+ ___
198
+
199
+ ### constructor
200
+
201
+ • **constructor**: `Function`
202
+
203
+ The initial value of Object.prototype.constructor is the standard built-in Object constructor.
204
+
205
+ #### Defined in
206
+
207
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:125
208
+
209
+ ___
210
+
211
+ ### defaultOptions
212
+
213
+ • **defaultOptions**: `Object`
214
+
215
+ The default options for export and assign
216
+
217
+ #### Type declaration
218
+
219
+ | Name | Type |
220
+ | :------ | :------ |
221
+ | `assign?` | `IMergeOptions` |
222
+ | `export?` | `IMergeOptions` |
223
+
224
+ #### Inherited from
225
+
226
+ [ClientTools](ClientTools.md).[defaultOptions](ClientTools.md#defaultoptions)
227
+
228
+ #### Defined in
229
+
230
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:74
231
+
232
+ ___
233
+
234
+ ### fetchOptions
235
+
236
+ • `Optional` **fetchOptions**: `any`
237
+
238
+ #### Inherited from
239
+
240
+ [ClientTools](ClientTools.md).[fetchOptions](ClientTools.md#fetchoptions)
241
+
242
+ #### Defined in
243
+
244
+ [packages/ai-tool/src/utils/consts.ts:37](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L37)
245
+
246
+ ___
247
+
248
+ ### name
249
+
250
+ • `Optional` **name**: `string`
251
+
252
+ #### Inherited from
253
+
254
+ [ClientTools](ClientTools.md).[name](ClientTools.md#name)
255
+
256
+ #### Defined in
257
+
258
+ [packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L21)
259
+
260
+ ___
261
+
262
+ ### nonExported1stChar
263
+
264
+ • **nonExported1stChar**: `string`
265
+
266
+ the property with the default prefix '$' will not be exported.
267
+
268
+ #### Inherited from
269
+
270
+ [ClientTools](ClientTools.md).[nonExported1stChar](ClientTools.md#nonexported1stchar)
271
+
272
+ #### Defined in
273
+
274
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:78
275
+
276
+ ___
277
+
278
+ ### params
279
+
280
+ • `Optional` **params**: [`FuncParams`](../interfaces/FuncParams.md) \| [`FuncParam`](../interfaces/FuncParam.md)[]
281
+
282
+ #### Inherited from
283
+
284
+ [ClientTools](ClientTools.md).[params](ClientTools.md#params)
285
+
286
+ #### Defined in
287
+
288
+ [packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L22)
289
+
290
+ ___
291
+
292
+ ### result
293
+
294
+ • `Optional` **result**: `string`
295
+
296
+ #### Inherited from
297
+
298
+ [ClientTools](ClientTools.md).[result](ClientTools.md#result)
299
+
300
+ #### Defined in
301
+
302
+ [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L23)
303
+
304
+ ___
305
+
306
+ ### scope
307
+
308
+ • `Optional` **scope**: `any`
309
+
310
+ #### Inherited from
311
+
312
+ [ClientTools](ClientTools.md).[scope](ClientTools.md#scope)
313
+
314
+ #### Defined in
315
+
316
+ [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L24)
317
+
318
+ ___
319
+
320
+ ### setup
321
+
322
+ • `Optional` **setup**: (`this`: [`ToolFunc`](ToolFunc.md), `options?`: [`FuncItem`](../interfaces/FuncItem.md)) => `void`
323
+
324
+ #### Type declaration
325
+
326
+ ▸ (`this`, `options?`): `void`
327
+
328
+ ##### Parameters
329
+
330
+ | Name | Type |
331
+ | :------ | :------ |
332
+ | `this` | [`ToolFunc`](ToolFunc.md) |
333
+ | `options?` | [`FuncItem`](../interfaces/FuncItem.md) |
334
+
335
+ ##### Returns
336
+
337
+ `void`
338
+
339
+ #### Inherited from
340
+
341
+ [ClientTools](ClientTools.md).[setup](ClientTools.md#setup)
342
+
343
+ #### Defined in
344
+
345
+ [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L26)
346
+
347
+ ___
348
+
349
+ ### should
350
+
351
+ • **should**: `Assertion`
352
+
353
+ #### Inherited from
354
+
355
+ [ClientTools](ClientTools.md).[should](ClientTools.md#should)
356
+
357
+ #### Defined in
358
+
359
+ node_modules/.pnpm/@types+chai@4.3.16/node_modules/@types/chai/index.d.ts:2100
360
+
361
+ ___
362
+
363
+ ### stream
364
+
365
+ • `Optional` **stream**: `boolean`
366
+
367
+ #### Inherited from
368
+
369
+ [ClientTools](ClientTools.md).[stream](ClientTools.md#stream)
370
+
371
+ #### Defined in
372
+
373
+ [packages/ai-tool/src/utils/consts.ts:38](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L38)
374
+
375
+ ___
376
+
377
+ ### tags
378
+
379
+ • `Optional` **tags**: `string` \| `string`[]
380
+
381
+ #### Inherited from
382
+
383
+ [ClientTools](ClientTools.md).[tags](ClientTools.md#tags)
384
+
385
+ #### Defined in
386
+
387
+ [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L25)
388
+
389
+ ___
390
+
391
+ ### dataPath
392
+
393
+ ▪ `Static` **dataPath**: `string`
394
+
395
+ #### Inherited from
396
+
397
+ [ClientTools](ClientTools.md).[dataPath](ClientTools.md#datapath)
398
+
399
+ #### Defined in
400
+
401
+ [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L47)
402
+
403
+ ___
404
+
405
+ ### items
406
+
407
+ ▪ `Static` **items**: [`Funcs`](../interfaces/Funcs.md) = `{}`
408
+
409
+ #### Inherited from
410
+
411
+ [ClientTools](ClientTools.md).[items](ClientTools.md#items)
412
+
413
+ #### Defined in
414
+
415
+ [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L46)
416
+
417
+ ## Accessors
418
+
419
+ ### apiRoot
420
+
421
+ • `get` **apiRoot**(): `undefined` \| `string`
422
+
423
+ #### Returns
424
+
425
+ `undefined` \| `string`
426
+
427
+ #### Defined in
428
+
429
+ [packages/ai-tool/src/client-tools.ts:19](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/client-tools.ts#L19)
430
+
431
+ ## Methods
432
+
433
+ ### \_func
434
+
435
+ ▸ **_func**(`action`, `options`): `Promise`\<`any`\>
436
+
437
+ #### Parameters
438
+
439
+ | Name | Type |
440
+ | :------ | :------ |
441
+ | `action` | ``"get"`` \| ``"post"`` \| ``"put"`` \| ``"delete"`` \| ``"patch"`` \| ``"list"`` \| ``"res"`` |
442
+ | `options` | [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md) |
443
+
444
+ #### Returns
445
+
446
+ `Promise`\<`any`\>
447
+
448
+ #### Defined in
449
+
450
+ [packages/ai-tool/src/res-client-tools.ts:39](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-client-tools.ts#L39)
451
+
452
+ ___
453
+
454
+ ### arr2ObjParams
455
+
456
+ ▸ **arr2ObjParams**(`params`): `any`[]
457
+
458
+ #### Parameters
459
+
460
+ | Name | Type |
461
+ | :------ | :------ |
462
+ | `params` | `any`[] |
463
+
464
+ #### Returns
465
+
466
+ `any`[]
467
+
468
+ #### Inherited from
469
+
470
+ [ClientTools](ClientTools.md).[arr2ObjParams](ClientTools.md#arr2objparams)
471
+
472
+ #### Defined in
473
+
474
+ [packages/ai-tool/src/tool-func.ts:219](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L219)
475
+
476
+ ___
477
+
478
+ ### assign
479
+
480
+ ▸ **assign**(`src`, `options?`): `this`
481
+
482
+ Assign the values from the src object.
483
+
484
+ #### Parameters
485
+
486
+ | Name | Type | Description |
487
+ | :------ | :------ | :------ |
488
+ | `src` | `any` | the source object |
489
+ | `options?` | `IMergeOptions` | - |
490
+
491
+ #### Returns
492
+
493
+ `this`
494
+
495
+ this object
496
+
497
+ #### Inherited from
498
+
499
+ [ClientTools](ClientTools.md).[assign](ClientTools.md#assign)
500
+
501
+ #### Defined in
502
+
503
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:106
504
+
505
+ ___
506
+
507
+ ### assignMethods
508
+
509
+ ▸ **assignMethods**(`methods`): `void`
510
+
511
+ #### Parameters
512
+
513
+ | Name | Type |
514
+ | :------ | :------ |
515
+ | `methods` | `string`[] |
516
+
517
+ #### Returns
518
+
519
+ `void`
520
+
521
+ #### Defined in
522
+
523
+ [packages/ai-tool/src/res-client-tools.ts:56](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-client-tools.ts#L56)
524
+
525
+ ___
526
+
527
+ ### assignProperty
528
+
529
+ ▸ **assignProperty**(`src`, `name`, `value`, `attrs?`, `options?`): `void`
530
+
531
+ Assign a property of src to this object.
532
+
533
+ #### Parameters
534
+
535
+ | Name | Type | Description |
536
+ | :------ | :------ | :------ |
537
+ | `src` | `any` | the src object |
538
+ | `name` | `string` | the property name to assign |
539
+ | `value` | `any` | the property value to assign |
540
+ | `attrs?` | `any` | the attributes object |
541
+ | `options?` | `IMergeOptions` | |
542
+
543
+ #### Returns
544
+
545
+ `void`
546
+
547
+ #### Inherited from
548
+
549
+ [ClientTools](ClientTools.md).[assignProperty](ClientTools.md#assignproperty)
550
+
551
+ #### Defined in
552
+
553
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:117
554
+
555
+ ___
556
+
557
+ ### assignPropertyTo
558
+
559
+ ▸ **assignPropertyTo**(`dest`, `src`, `name`, `value`, `attrs?`, `options?`): `void`
560
+
561
+ Assign the property value from the src to destination object.
562
+
563
+ #### Parameters
564
+
565
+ | Name | Type | Description |
566
+ | :------ | :------ | :------ |
567
+ | `dest` | `any` | The destination object |
568
+ | `src` | `any` | The src object |
569
+ | `name` | `string` | The property name |
570
+ | `value` | `any` | The property value |
571
+ | `attrs?` | `any` | The attributes object of the property |
572
+ | `options?` | `IMergeOptions` | |
573
+
574
+ #### Returns
575
+
576
+ `void`
577
+
578
+ **`Abstract`**
579
+
580
+ #### Inherited from
581
+
582
+ [ClientTools](ClientTools.md).[assignPropertyTo](ClientTools.md#assignpropertyto)
583
+
584
+ #### Defined in
585
+
586
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:131
587
+
588
+ ___
589
+
590
+ ### assignTo
591
+
592
+ ▸ **assignTo**(`dest?`, `options?`): `any`
593
+
594
+ Assign this attributes to the dest object
595
+
596
+ #### Parameters
597
+
598
+ | Name | Type | Description |
599
+ | :------ | :------ | :------ |
600
+ | `dest?` | `any` | the destination object |
601
+ | `options?` | `IMergeOptions` | - |
602
+
603
+ #### Returns
604
+
605
+ `any`
606
+
607
+ the dest object
608
+
609
+ #### Inherited from
610
+
611
+ [ClientTools](ClientTools.md).[assignTo](ClientTools.md#assignto)
612
+
613
+ #### Defined in
614
+
615
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:191
616
+
617
+ ___
618
+
619
+ ### clone
620
+
621
+ ▸ **clone**(`options?`): `any`
622
+
623
+ Create a new object with the same values of attributes.
624
+
625
+ #### Parameters
626
+
627
+ | Name | Type |
628
+ | :------ | :------ |
629
+ | `options?` | `IMergeOptions` |
630
+
631
+ #### Returns
632
+
633
+ `any`
634
+
635
+ the new object
636
+
637
+ #### Inherited from
638
+
639
+ [ClientTools](ClientTools.md).[clone](ClientTools.md#clone)
640
+
641
+ #### Defined in
642
+
643
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:155
644
+
645
+ ___
646
+
647
+ ### cloneTo
648
+
649
+ ▸ **cloneTo**(`dest`, `options?`): `any`
650
+
651
+ Create and assign the values to the destination object.
652
+
653
+ #### Parameters
654
+
655
+ | Name | Type | Description |
656
+ | :------ | :------ | :------ |
657
+ | `dest` | `any` | the destination object |
658
+ | `options?` | `IMergeOptions` | |
659
+
660
+ #### Returns
661
+
662
+ `any`
663
+
664
+ the new dest object
665
+
666
+ #### Inherited from
667
+
668
+ [ClientTools](ClientTools.md).[cloneTo](ClientTools.md#cloneto)
669
+
670
+ #### Defined in
671
+
672
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:148
673
+
674
+ ___
675
+
676
+ ### defineProperties
677
+
678
+ ▸ **defineProperties**(`aProperties`): `any`
679
+
680
+ Define the attributes of this object.
681
+
682
+ #### Parameters
683
+
684
+ | Name | Type | Description |
685
+ | :------ | :------ | :------ |
686
+ | `aProperties` | `SimplePropDescriptors` | the defined attributes of the object |
687
+
688
+ #### Returns
689
+
690
+ `any`
691
+
692
+ **`Abstract`**
693
+
694
+ #### Inherited from
695
+
696
+ [ClientTools](ClientTools.md).[defineProperties](ClientTools.md#defineproperties)
697
+
698
+ #### Defined in
699
+
700
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:89
701
+
702
+ ___
703
+
704
+ ### delete
705
+
706
+ ▸ **delete**(`«destructured»`): `any`
707
+
708
+ #### Parameters
709
+
710
+ | Name | Type |
711
+ | :------ | :------ |
712
+ | `«destructured»` | [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md) |
713
+
714
+ #### Returns
715
+
716
+ `any`
717
+
718
+ #### Defined in
719
+
720
+ [packages/ai-tool/src/res-client-tools.ts:15](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-client-tools.ts#L15)
721
+
722
+ ___
723
+
724
+ ### errorFrom
725
+
726
+ ▸ **errorFrom**(`res`): `Promise`\<[`CommonError`](CommonError.md)\>
727
+
728
+ #### Parameters
729
+
730
+ | Name | Type |
731
+ | :------ | :------ |
732
+ | `res` | `Response` |
733
+
734
+ #### Returns
735
+
736
+ `Promise`\<[`CommonError`](CommonError.md)\>
737
+
738
+ #### Inherited from
739
+
740
+ [ClientTools](ClientTools.md).[errorFrom](ClientTools.md#errorfrom)
741
+
742
+ #### Defined in
743
+
744
+ [packages/ai-tool/src/client-tools.ts:112](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/client-tools.ts#L112)
745
+
746
+ ___
747
+
748
+ ### exportTo
749
+
750
+ ▸ **exportTo**(`dest`, `options?`): `any`
751
+
752
+ Export attributes to the dest json object.
753
+
754
+ #### Parameters
755
+
756
+ | Name | Type | Description |
757
+ | :------ | :------ | :------ |
758
+ | `dest` | `any` | the destination object |
759
+ | `options?` | `IExportOptions` | - |
760
+
761
+ #### Returns
762
+
763
+ `any`
764
+
765
+ the dest object.
766
+
767
+ #### Inherited from
768
+
769
+ [ClientTools](ClientTools.md).[exportTo](ClientTools.md#exportto)
770
+
771
+ #### Defined in
772
+
773
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:173
774
+
775
+ ___
776
+
777
+ ### fetch
778
+
779
+ ▸ **fetch**(`options`, `action`): `Promise`\<`Response`\>
780
+
781
+ #### Parameters
782
+
783
+ | Name | Type |
784
+ | :------ | :------ |
785
+ | `options` | [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md) |
786
+ | `action` | ``"get"`` \| ``"post"`` \| ``"put"`` \| ``"delete"`` \| ``"patch"`` \| ``"list"`` \| ``"res"`` |
787
+
788
+ #### Returns
789
+
790
+ `Promise`\<`Response`\>
791
+
792
+ #### Inherited from
793
+
794
+ [ClientTools](ClientTools.md).[fetch](ClientTools.md#fetch)
795
+
796
+ #### Defined in
797
+
798
+ [packages/ai-tool/src/res-client-tools.ts:20](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-client-tools.ts#L20)
799
+
800
+ ___
801
+
802
+ ### func
803
+
804
+ ▸ **func**(`options`): `Promise`\<`any`\>
805
+
806
+ #### Parameters
807
+
808
+ | Name | Type |
809
+ | :------ | :------ |
810
+ | `options` | [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md) |
811
+
812
+ #### Returns
813
+
814
+ `Promise`\<`any`\>
815
+
816
+ #### Inherited from
817
+
818
+ [ClientTools](ClientTools.md).[func](ClientTools.md#func)
819
+
820
+ #### Defined in
821
+
822
+ [packages/ai-tool/src/res-client-tools.ts:48](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-client-tools.ts#L48)
823
+
824
+ ___
825
+
826
+ ### get
827
+
828
+ ▸ **get**(`«destructured»`): `any`
829
+
830
+ #### Parameters
831
+
832
+ | Name | Type |
833
+ | :------ | :------ |
834
+ | `«destructured»` | [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md) |
835
+
836
+ #### Returns
837
+
838
+ `any`
839
+
840
+ #### Defined in
841
+
842
+ [packages/ai-tool/src/res-client-tools.ts:12](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-client-tools.ts#L12)
843
+
844
+ ___
845
+
846
+ ### getFunc
847
+
848
+ ▸ **getFunc**(`name?`): `any`
849
+
850
+ #### Parameters
851
+
852
+ | Name | Type |
853
+ | :------ | :------ |
854
+ | `name?` | `string` |
855
+
856
+ #### Returns
857
+
858
+ `any`
859
+
860
+ #### Inherited from
861
+
862
+ [ClientTools](ClientTools.md).[getFunc](ClientTools.md#getfunc)
863
+
864
+ #### Defined in
865
+
866
+ [packages/ai-tool/src/tool-func.ts:273](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L273)
867
+
868
+ ___
869
+
870
+ ### getFuncWithPos
871
+
872
+ ▸ **getFuncWithPos**(`name?`): `any`
873
+
874
+ #### Parameters
875
+
876
+ | Name | Type |
877
+ | :------ | :------ |
878
+ | `name?` | `string` |
879
+
880
+ #### Returns
881
+
882
+ `any`
883
+
884
+ #### Inherited from
885
+
886
+ [ClientTools](ClientTools.md).[getFuncWithPos](ClientTools.md#getfuncwithpos)
887
+
888
+ #### Defined in
889
+
890
+ [packages/ai-tool/src/tool-func.ts:299](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L299)
891
+
892
+ ___
893
+
894
+ ### getProperties
895
+
896
+ ▸ **getProperties**(): `PropDescriptors`
897
+
898
+ Get the defined attributes.
899
+
900
+ #### Returns
901
+
902
+ `PropDescriptors`
903
+
904
+ the descriptors of properties object
905
+
906
+ **`Abstract`**
907
+
908
+ #### Inherited from
909
+
910
+ [ClientTools](ClientTools.md).[getProperties](ClientTools.md#getproperties)
911
+
912
+ #### Defined in
913
+
914
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:98
915
+
916
+ ___
917
+
918
+ ### getUrlParams
919
+
920
+ ▸ **getUrlParams**(`objParam`): `string`
921
+
922
+ #### Parameters
923
+
924
+ | Name | Type |
925
+ | :------ | :------ |
926
+ | `objParam` | `any` |
927
+
928
+ #### Returns
929
+
930
+ `string`
931
+
932
+ #### Inherited from
933
+
934
+ [ClientTools](ClientTools.md).[getUrlParams](ClientTools.md#geturlparams)
935
+
936
+ #### Defined in
937
+
938
+ [packages/ai-tool/src/client-tools.ts:63](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/client-tools.ts#L63)
939
+
940
+ ___
941
+
942
+ ### hasOwnProperty
943
+
944
+ ▸ **hasOwnProperty**(`v`): `boolean`
945
+
946
+ Determines whether an object has a property with the specified name.
947
+
948
+ #### Parameters
949
+
950
+ | Name | Type | Description |
951
+ | :------ | :------ | :------ |
952
+ | `v` | `PropertyKey` | A property name. |
953
+
954
+ #### Returns
955
+
956
+ `boolean`
957
+
958
+ #### Inherited from
959
+
960
+ [ClientTools](ClientTools.md).[hasOwnProperty](ClientTools.md#hasownproperty)
961
+
962
+ #### Defined in
963
+
964
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:140
965
+
966
+ ___
967
+
968
+ ### initialize
969
+
970
+ ▸ **initialize**(`src?`): `this`
971
+
972
+ Initialize object and assign attribute values from src if src exists.
973
+
974
+ #### Parameters
975
+
976
+ | Name | Type |
977
+ | :------ | :------ |
978
+ | `src?` | `any` |
979
+
980
+ #### Returns
981
+
982
+ `this`
983
+
984
+ this object.
985
+
986
+ #### Inherited from
987
+
988
+ [ClientTools](ClientTools.md).[initialize](ClientTools.md#initialize)
989
+
990
+ #### Defined in
991
+
992
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:139
993
+
994
+ ___
995
+
996
+ ### isPrototypeOf
997
+
998
+ ▸ **isPrototypeOf**(`v`): `boolean`
999
+
1000
+ Determines whether an object exists in another object's prototype chain.
1001
+
1002
+ #### Parameters
1003
+
1004
+ | Name | Type | Description |
1005
+ | :------ | :------ | :------ |
1006
+ | `v` | `Object` | Another object whose prototype chain is to be checked. |
1007
+
1008
+ #### Returns
1009
+
1010
+ `boolean`
1011
+
1012
+ #### Inherited from
1013
+
1014
+ [ClientTools](ClientTools.md).[isPrototypeOf](ClientTools.md#isprototypeof)
1015
+
1016
+ #### Defined in
1017
+
1018
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:146
1019
+
1020
+ ___
1021
+
1022
+ ### isSame
1023
+
1024
+ ▸ **isSame**(`src`, `options?`): `boolean`
1025
+
1026
+ Check the src object whether “equals” this object.
1027
+
1028
+ #### Parameters
1029
+
1030
+ | Name | Type | Description |
1031
+ | :------ | :------ | :------ |
1032
+ | `src` | `any` | The source object |
1033
+ | `options?` | `IMergeOptions` | - |
1034
+
1035
+ #### Returns
1036
+
1037
+ `boolean`
1038
+
1039
+ #### Inherited from
1040
+
1041
+ [ClientTools](ClientTools.md).[isSame](ClientTools.md#issame)
1042
+
1043
+ #### Defined in
1044
+
1045
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:200
1046
+
1047
+ ___
1048
+
1049
+ ### list
1050
+
1051
+ ▸ **list**(`options`): `any`
1052
+
1053
+ #### Parameters
1054
+
1055
+ | Name | Type |
1056
+ | :------ | :------ |
1057
+ | `options` | [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md) |
1058
+
1059
+ #### Returns
1060
+
1061
+ `any`
1062
+
1063
+ #### Defined in
1064
+
1065
+ [packages/ai-tool/src/res-client-tools.ts:16](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-client-tools.ts#L16)
1066
+
1067
+ ___
1068
+
1069
+ ### mergeTo
1070
+
1071
+ ▸ **mergeTo**(`dest`, `options?`): `any`
1072
+
1073
+ Merge this attributes to dest object.
1074
+
1075
+ #### Parameters
1076
+
1077
+ | Name | Type | Description |
1078
+ | :------ | :------ | :------ |
1079
+ | `dest` | `any` | The destination object |
1080
+ | `options?` | `IMergeOptions` | - |
1081
+
1082
+ #### Returns
1083
+
1084
+ `any`
1085
+
1086
+ the dest object.
1087
+
1088
+ #### Inherited from
1089
+
1090
+ [ClientTools](ClientTools.md).[mergeTo](ClientTools.md#mergeto)
1091
+
1092
+ #### Defined in
1093
+
1094
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:164
1095
+
1096
+ ___
1097
+
1098
+ ### obj2ArrParams
1099
+
1100
+ ▸ **obj2ArrParams**(`params?`): `any`[]
1101
+
1102
+ #### Parameters
1103
+
1104
+ | Name | Type |
1105
+ | :------ | :------ |
1106
+ | `params?` | `any` |
1107
+
1108
+ #### Returns
1109
+
1110
+ `any`[]
1111
+
1112
+ #### Inherited from
1113
+
1114
+ [ClientTools](ClientTools.md).[obj2ArrParams](ClientTools.md#obj2arrparams)
1115
+
1116
+ #### Defined in
1117
+
1118
+ [packages/ai-tool/src/tool-func.ts:232](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L232)
1119
+
1120
+ ___
1121
+
1122
+ ### post
1123
+
1124
+ ▸ **post**(`options`): `any`
1125
+
1126
+ #### Parameters
1127
+
1128
+ | Name | Type |
1129
+ | :------ | :------ |
1130
+ | `options` | [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md) |
1131
+
1132
+ #### Returns
1133
+
1134
+ `any`
1135
+
1136
+ #### Defined in
1137
+
1138
+ [packages/ai-tool/src/res-client-tools.ts:13](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-client-tools.ts#L13)
1139
+
1140
+ ___
1141
+
1142
+ ### propertyIsEnumerable
1143
+
1144
+ ▸ **propertyIsEnumerable**(`v`): `boolean`
1145
+
1146
+ Determines whether a specified property is enumerable.
1147
+
1148
+ #### Parameters
1149
+
1150
+ | Name | Type | Description |
1151
+ | :------ | :------ | :------ |
1152
+ | `v` | `PropertyKey` | A property name. |
1153
+
1154
+ #### Returns
1155
+
1156
+ `boolean`
1157
+
1158
+ #### Inherited from
1159
+
1160
+ [ClientTools](ClientTools.md).[propertyIsEnumerable](ClientTools.md#propertyisenumerable)
1161
+
1162
+ #### Defined in
1163
+
1164
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:152
1165
+
1166
+ ___
1167
+
1168
+ ### put
1169
+
1170
+ ▸ **put**(`«destructured»`): `any`
1171
+
1172
+ #### Parameters
1173
+
1174
+ | Name | Type |
1175
+ | :------ | :------ |
1176
+ | `«destructured»` | [`ResClientFuncParams`](../interfaces/ResClientFuncParams.md) |
1177
+
1178
+ #### Returns
1179
+
1180
+ `any`
1181
+
1182
+ #### Defined in
1183
+
1184
+ [packages/ai-tool/src/res-client-tools.ts:14](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/res-client-tools.ts#L14)
1185
+
1186
+ ___
1187
+
1188
+ ### register
1189
+
1190
+ ▸ **register**(): `boolean` \| [`ToolFunc`](ToolFunc.md)
1191
+
1192
+ #### Returns
1193
+
1194
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
1195
+
1196
+ #### Inherited from
1197
+
1198
+ [ClientTools](ClientTools.md).[register](ClientTools.md#register)
1199
+
1200
+ #### Defined in
1201
+
1202
+ [packages/ai-tool/src/tool-func.ts:202](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L202)
1203
+
1204
+ ___
1205
+
1206
+ ### run
1207
+
1208
+ ▸ **run**(`params?`): `Promise`\<`any`\>
1209
+
1210
+ #### Parameters
1211
+
1212
+ | Name | Type |
1213
+ | :------ | :------ |
1214
+ | `params?` | `any` |
1215
+
1216
+ #### Returns
1217
+
1218
+ `Promise`\<`any`\>
1219
+
1220
+ #### Inherited from
1221
+
1222
+ [ClientTools](ClientTools.md).[run](ClientTools.md#run)
1223
+
1224
+ #### Defined in
1225
+
1226
+ [packages/ai-tool/src/tool-func.ts:259](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L259)
1227
+
1228
+ ___
1229
+
1230
+ ### runAs
1231
+
1232
+ ▸ **runAs**(`name`, `params?`): `Promise`\<`any`\>
1233
+
1234
+ #### Parameters
1235
+
1236
+ | Name | Type |
1237
+ | :------ | :------ |
1238
+ | `name` | `string` |
1239
+ | `params?` | `any` |
1240
+
1241
+ #### Returns
1242
+
1243
+ `Promise`\<`any`\>
1244
+
1245
+ #### Inherited from
1246
+
1247
+ [ClientTools](ClientTools.md).[runAs](ClientTools.md#runas)
1248
+
1249
+ #### Defined in
1250
+
1251
+ [packages/ai-tool/src/tool-func.ts:263](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L263)
1252
+
1253
+ ___
1254
+
1255
+ ### runAsSync
1256
+
1257
+ ▸ **runAsSync**(`name`, `params?`): `any`
1258
+
1259
+ #### Parameters
1260
+
1261
+ | Name | Type |
1262
+ | :------ | :------ |
1263
+ | `name` | `string` |
1264
+ | `params?` | `any` |
1265
+
1266
+ #### Returns
1267
+
1268
+ `any`
1269
+
1270
+ #### Inherited from
1271
+
1272
+ [ClientTools](ClientTools.md).[runAsSync](ClientTools.md#runassync)
1273
+
1274
+ #### Defined in
1275
+
1276
+ [packages/ai-tool/src/tool-func.ts:268](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L268)
1277
+
1278
+ ___
1279
+
1280
+ ### runSync
1281
+
1282
+ ▸ **runSync**(`params?`): `any`
1283
+
1284
+ #### Parameters
1285
+
1286
+ | Name | Type |
1287
+ | :------ | :------ |
1288
+ | `params?` | `any` |
1289
+
1290
+ #### Returns
1291
+
1292
+ `any`
1293
+
1294
+ #### Inherited from
1295
+
1296
+ [ClientTools](ClientTools.md).[runSync](ClientTools.md#runsync)
1297
+
1298
+ #### Defined in
1299
+
1300
+ [packages/ai-tool/src/tool-func.ts:245](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L245)
1301
+
1302
+ ___
1303
+
1304
+ ### runWithPos
1305
+
1306
+ ▸ **runWithPos**(`...params`): `Promise`\<`any`\>
1307
+
1308
+ #### Parameters
1309
+
1310
+ | Name | Type |
1311
+ | :------ | :------ |
1312
+ | `...params` | `any`[] |
1313
+
1314
+ #### Returns
1315
+
1316
+ `Promise`\<`any`\>
1317
+
1318
+ #### Inherited from
1319
+
1320
+ [ClientTools](ClientTools.md).[runWithPos](ClientTools.md#runwithpos)
1321
+
1322
+ #### Defined in
1323
+
1324
+ [packages/ai-tool/src/tool-func.ts:289](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L289)
1325
+
1326
+ ___
1327
+
1328
+ ### runWithPosAs
1329
+
1330
+ ▸ **runWithPosAs**(`name`, `...params`): `Promise`\<`any`\>
1331
+
1332
+ #### Parameters
1333
+
1334
+ | Name | Type |
1335
+ | :------ | :------ |
1336
+ | `name` | `string` |
1337
+ | `...params` | `any`[] |
1338
+
1339
+ #### Returns
1340
+
1341
+ `Promise`\<`any`\>
1342
+
1343
+ #### Inherited from
1344
+
1345
+ [ClientTools](ClientTools.md).[runWithPosAs](ClientTools.md#runwithposas)
1346
+
1347
+ #### Defined in
1348
+
1349
+ [packages/ai-tool/src/tool-func.ts:294](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L294)
1350
+
1351
+ ___
1352
+
1353
+ ### runWithPosAsSync
1354
+
1355
+ ▸ **runWithPosAsSync**(`name`, `...params`): `any`
1356
+
1357
+ #### Parameters
1358
+
1359
+ | Name | Type |
1360
+ | :------ | :------ |
1361
+ | `name` | `string` |
1362
+ | `...params` | `any`[] |
1363
+
1364
+ #### Returns
1365
+
1366
+ `any`
1367
+
1368
+ #### Inherited from
1369
+
1370
+ [ClientTools](ClientTools.md).[runWithPosAsSync](ClientTools.md#runwithposassync)
1371
+
1372
+ #### Defined in
1373
+
1374
+ [packages/ai-tool/src/tool-func.ts:285](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L285)
1375
+
1376
+ ___
1377
+
1378
+ ### runWithPosSync
1379
+
1380
+ ▸ **runWithPosSync**(`...params`): `any`
1381
+
1382
+ #### Parameters
1383
+
1384
+ | Name | Type |
1385
+ | :------ | :------ |
1386
+ | `...params` | `any`[] |
1387
+
1388
+ #### Returns
1389
+
1390
+ `any`
1391
+
1392
+ #### Inherited from
1393
+
1394
+ [ClientTools](ClientTools.md).[runWithPosSync](ClientTools.md#runwithpossync)
1395
+
1396
+ #### Defined in
1397
+
1398
+ [packages/ai-tool/src/tool-func.ts:278](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L278)
1399
+
1400
+ ___
1401
+
1402
+ ### toJSON
1403
+
1404
+ ▸ **toJSON**(): `any`
1405
+
1406
+ #### Returns
1407
+
1408
+ `any`
1409
+
1410
+ #### Inherited from
1411
+
1412
+ [ClientTools](ClientTools.md).[toJSON](ClientTools.md#tojson)
1413
+
1414
+ #### Defined in
1415
+
1416
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:182
1417
+
1418
+ ___
1419
+
1420
+ ### toLocaleString
1421
+
1422
+ ▸ **toLocaleString**(): `string`
1423
+
1424
+ Returns a date converted to a string using the current locale.
1425
+
1426
+ #### Returns
1427
+
1428
+ `string`
1429
+
1430
+ #### Inherited from
1431
+
1432
+ [ClientTools](ClientTools.md).[toLocaleString](ClientTools.md#tolocalestring)
1433
+
1434
+ #### Defined in
1435
+
1436
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:131
1437
+
1438
+ ___
1439
+
1440
+ ### toObject
1441
+
1442
+ ▸ **toObject**(`options?`): `any`
1443
+
1444
+ Convert the attributes to the json object
1445
+
1446
+ #### Parameters
1447
+
1448
+ | Name | Type |
1449
+ | :------ | :------ |
1450
+ | `options?` | `any` |
1451
+
1452
+ #### Returns
1453
+
1454
+ `any`
1455
+
1456
+ the json object.
1457
+
1458
+ #### Inherited from
1459
+
1460
+ [ClientTools](ClientTools.md).[toObject](ClientTools.md#toobject)
1461
+
1462
+ #### Defined in
1463
+
1464
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/abstract.d.ts:181
1465
+
1466
+ ___
1467
+
1468
+ ### toString
1469
+
1470
+ ▸ **toString**(): `string`
1471
+
1472
+ Returns a string representation of an object.
1473
+
1474
+ #### Returns
1475
+
1476
+ `string`
1477
+
1478
+ #### Inherited from
1479
+
1480
+ [ClientTools](ClientTools.md).[toString](ClientTools.md#tostring)
1481
+
1482
+ #### Defined in
1483
+
1484
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:128
1485
+
1486
+ ___
1487
+
1488
+ ### unregister
1489
+
1490
+ ▸ **unregister**(): `any`
1491
+
1492
+ #### Returns
1493
+
1494
+ `any`
1495
+
1496
+ #### Inherited from
1497
+
1498
+ [ClientTools](ClientTools.md).[unregister](ClientTools.md#unregister)
1499
+
1500
+ #### Defined in
1501
+
1502
+ [packages/ai-tool/src/tool-func.ts:215](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L215)
1503
+
1504
+ ___
1505
+
1506
+ ### valueOf
1507
+
1508
+ ▸ **valueOf**(): `Object`
1509
+
1510
+ Returns the primitive value of the specified object.
1511
+
1512
+ #### Returns
1513
+
1514
+ `Object`
1515
+
1516
+ #### Inherited from
1517
+
1518
+ [ClientTools](ClientTools.md).[valueOf](ClientTools.md#valueof)
1519
+
1520
+ #### Defined in
1521
+
1522
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:134
1523
+
1524
+ ___
1525
+
1526
+ ### assign
1527
+
1528
+ ▸ **assign**\<`T`, `U`\>(`target`, `source`): `T` & `U`
1529
+
1530
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1531
+ target object. Returns the target object.
1532
+
1533
+ #### Type parameters
1534
+
1535
+ | Name | Type |
1536
+ | :------ | :------ |
1537
+ | `T` | extends `Object` |
1538
+ | `U` | `U` |
1539
+
1540
+ #### Parameters
1541
+
1542
+ | Name | Type | Description |
1543
+ | :------ | :------ | :------ |
1544
+ | `target` | `T` | The target object to copy to. |
1545
+ | `source` | `U` | The source object from which to copy properties. |
1546
+
1547
+ #### Returns
1548
+
1549
+ `T` & `U`
1550
+
1551
+ #### Inherited from
1552
+
1553
+ [ClientTools](ClientTools.md).[assign](ClientTools.md#assign-1)
1554
+
1555
+ #### Defined in
1556
+
1557
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.core.d.ts:284
1558
+
1559
+ ▸ **assign**\<`T`, `U`, `V`\>(`target`, `source1`, `source2`): `T` & `U` & `V`
1560
+
1561
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1562
+ target object. Returns the target object.
1563
+
1564
+ #### Type parameters
1565
+
1566
+ | Name | Type |
1567
+ | :------ | :------ |
1568
+ | `T` | extends `Object` |
1569
+ | `U` | `U` |
1570
+ | `V` | `V` |
1571
+
1572
+ #### Parameters
1573
+
1574
+ | Name | Type | Description |
1575
+ | :------ | :------ | :------ |
1576
+ | `target` | `T` | The target object to copy to. |
1577
+ | `source1` | `U` | The first source object from which to copy properties. |
1578
+ | `source2` | `V` | The second source object from which to copy properties. |
1579
+
1580
+ #### Returns
1581
+
1582
+ `T` & `U` & `V`
1583
+
1584
+ #### Inherited from
1585
+
1586
+ [ClientTools](ClientTools.md).[assign](ClientTools.md#assign-1)
1587
+
1588
+ #### Defined in
1589
+
1590
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.core.d.ts:293
1591
+
1592
+ ▸ **assign**\<`T`, `U`, `V`, `W`\>(`target`, `source1`, `source2`, `source3`): `T` & `U` & `V` & `W`
1593
+
1594
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1595
+ target object. Returns the target object.
1596
+
1597
+ #### Type parameters
1598
+
1599
+ | Name | Type |
1600
+ | :------ | :------ |
1601
+ | `T` | extends `Object` |
1602
+ | `U` | `U` |
1603
+ | `V` | `V` |
1604
+ | `W` | `W` |
1605
+
1606
+ #### Parameters
1607
+
1608
+ | Name | Type | Description |
1609
+ | :------ | :------ | :------ |
1610
+ | `target` | `T` | The target object to copy to. |
1611
+ | `source1` | `U` | The first source object from which to copy properties. |
1612
+ | `source2` | `V` | The second source object from which to copy properties. |
1613
+ | `source3` | `W` | The third source object from which to copy properties. |
1614
+
1615
+ #### Returns
1616
+
1617
+ `T` & `U` & `V` & `W`
1618
+
1619
+ #### Inherited from
1620
+
1621
+ [ClientTools](ClientTools.md).[assign](ClientTools.md#assign-1)
1622
+
1623
+ #### Defined in
1624
+
1625
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.core.d.ts:303
1626
+
1627
+ ▸ **assign**(`target`, `...sources`): `any`
1628
+
1629
+ Copy the values of all of the enumerable own properties from one or more source objects to a
1630
+ target object. Returns the target object.
1631
+
1632
+ #### Parameters
1633
+
1634
+ | Name | Type | Description |
1635
+ | :------ | :------ | :------ |
1636
+ | `target` | `object` | The target object to copy to. |
1637
+ | `...sources` | `any`[] | One or more source objects from which to copy properties |
1638
+
1639
+ #### Returns
1640
+
1641
+ `any`
1642
+
1643
+ #### Inherited from
1644
+
1645
+ [ClientTools](ClientTools.md).[assign](ClientTools.md#assign-1)
1646
+
1647
+ #### Defined in
1648
+
1649
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.core.d.ts:311
1650
+
1651
+ ___
1652
+
1653
+ ### create
1654
+
1655
+ ▸ **create**(`o`): `any`
1656
+
1657
+ Creates an object that has the specified prototype or that has null prototype.
1658
+
1659
+ #### Parameters
1660
+
1661
+ | Name | Type | Description |
1662
+ | :------ | :------ | :------ |
1663
+ | `o` | ``null`` \| `object` | Object to use as a prototype. May be null. |
1664
+
1665
+ #### Returns
1666
+
1667
+ `any`
1668
+
1669
+ #### Inherited from
1670
+
1671
+ [ClientTools](ClientTools.md).[create](ClientTools.md#create)
1672
+
1673
+ #### Defined in
1674
+
1675
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:188
1676
+
1677
+ ▸ **create**(`o`, `properties`): `any`
1678
+
1679
+ Creates an object that has the specified prototype, and that optionally contains specified properties.
1680
+
1681
+ #### Parameters
1682
+
1683
+ | Name | Type | Description |
1684
+ | :------ | :------ | :------ |
1685
+ | `o` | ``null`` \| `object` | Object to use as a prototype. May be null |
1686
+ | `properties` | `PropertyDescriptorMap` & `ThisType`\<`any`\> | JavaScript object that contains one or more property descriptors. |
1687
+
1688
+ #### Returns
1689
+
1690
+ `any`
1691
+
1692
+ #### Inherited from
1693
+
1694
+ [ClientTools](ClientTools.md).[create](ClientTools.md#create)
1695
+
1696
+ #### Defined in
1697
+
1698
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:195
1699
+
1700
+ ___
1701
+
1702
+ ### defineProperties
1703
+
1704
+ ▸ **defineProperties**(`aTarget`, `aProperties`, `recreate?`): `any`
1705
+
1706
+ #### Parameters
1707
+
1708
+ | Name | Type |
1709
+ | :------ | :------ |
1710
+ | `aTarget` | `any` |
1711
+ | `aProperties` | `PropDescriptors` |
1712
+ | `recreate?` | `boolean` |
1713
+
1714
+ #### Returns
1715
+
1716
+ `any`
1717
+
1718
+ #### Inherited from
1719
+
1720
+ [ClientTools](ClientTools.md).[defineProperties](ClientTools.md#defineproperties-1)
1721
+
1722
+ #### Defined in
1723
+
1724
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/advance.d.ts:11
1725
+
1726
+ ___
1727
+
1728
+ ### defineProperty
1729
+
1730
+ ▸ **defineProperty**\<`T`\>(`o`, `p`, `attributes`): `T`
1731
+
1732
+ Adds a property to an object, or modifies attributes of an existing property.
1733
+
1734
+ #### Type parameters
1735
+
1736
+ | Name |
1737
+ | :------ |
1738
+ | `T` |
1739
+
1740
+ #### Parameters
1741
+
1742
+ | Name | Type | Description |
1743
+ | :------ | :------ | :------ |
1744
+ | `o` | `T` | Object on which to add or modify the property. This can be a native JavaScript object (that is, a user-defined object or a built in object) or a DOM object. |
1745
+ | `p` | `PropertyKey` | The property name. |
1746
+ | `attributes` | `PropertyDescriptor` & `ThisType`\<`any`\> | Descriptor for the property. It can be for a data property or an accessor property. |
1747
+
1748
+ #### Returns
1749
+
1750
+ `T`
1751
+
1752
+ #### Inherited from
1753
+
1754
+ [ClientTools](ClientTools.md).[defineProperty](ClientTools.md#defineproperty)
1755
+
1756
+ #### Defined in
1757
+
1758
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:203
1759
+
1760
+ ___
1761
+
1762
+ ### entries
1763
+
1764
+ ▸ **entries**\<`T`\>(`o`): [`string`, `T`][]
1765
+
1766
+ Returns an array of key/values of the enumerable properties of an object
1767
+
1768
+ #### Type parameters
1769
+
1770
+ | Name |
1771
+ | :------ |
1772
+ | `T` |
1773
+
1774
+ #### Parameters
1775
+
1776
+ | Name | Type | Description |
1777
+ | :------ | :------ | :------ |
1778
+ | `o` | \{ `[s: string]`: `T`; } \| `ArrayLike`\<`T`\> | Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object. |
1779
+
1780
+ #### Returns
1781
+
1782
+ [`string`, `T`][]
1783
+
1784
+ #### Inherited from
1785
+
1786
+ [ClientTools](ClientTools.md).[entries](ClientTools.md#entries)
1787
+
1788
+ #### Defined in
1789
+
1790
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2017.object.d.ts:36
1791
+
1792
+ ▸ **entries**(`o`): [`string`, `any`][]
1793
+
1794
+ Returns an array of key/values of the enumerable properties of an object
1795
+
1796
+ #### Parameters
1797
+
1798
+ | Name | Type | Description |
1799
+ | :------ | :------ | :------ |
1800
+ | `o` | `Object` | Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object. |
1801
+
1802
+ #### Returns
1803
+
1804
+ [`string`, `any`][]
1805
+
1806
+ #### Inherited from
1807
+
1808
+ [ClientTools](ClientTools.md).[entries](ClientTools.md#entries)
1809
+
1810
+ #### Defined in
1811
+
1812
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2017.object.d.ts:42
1813
+
1814
+ ___
1815
+
1816
+ ### fetch
1817
+
1818
+ ▸ **fetch**(`name`, `objParam?`): `Promise`\<`any`\>
1819
+
1820
+ #### Parameters
1821
+
1822
+ | Name | Type |
1823
+ | :------ | :------ |
1824
+ | `name` | `string` |
1825
+ | `objParam?` | `any` |
1826
+
1827
+ #### Returns
1828
+
1829
+ `Promise`\<`any`\>
1830
+
1831
+ #### Inherited from
1832
+
1833
+ [ClientTools](ClientTools.md).[fetch](ClientTools.md#fetch-1)
1834
+
1835
+ #### Defined in
1836
+
1837
+ [packages/ai-tool/src/client-tools.ts:56](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/client-tools.ts#L56)
1838
+
1839
+ ___
1840
+
1841
+ ### freeze
1842
+
1843
+ ▸ **freeze**\<`T`\>(`f`): `T`
1844
+
1845
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
1846
+
1847
+ #### Type parameters
1848
+
1849
+ | Name | Type |
1850
+ | :------ | :------ |
1851
+ | `T` | extends `Function` |
1852
+
1853
+ #### Parameters
1854
+
1855
+ | Name | Type | Description |
1856
+ | :------ | :------ | :------ |
1857
+ | `f` | `T` | Object on which to lock the attributes. |
1858
+
1859
+ #### Returns
1860
+
1861
+ `T`
1862
+
1863
+ #### Inherited from
1864
+
1865
+ [ClientTools](ClientTools.md).[freeze](ClientTools.md#freeze)
1866
+
1867
+ #### Defined in
1868
+
1869
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:222
1870
+
1871
+ ▸ **freeze**\<`T`, `U`\>(`o`): `Readonly`\<`T`\>
1872
+
1873
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
1874
+
1875
+ #### Type parameters
1876
+
1877
+ | Name | Type |
1878
+ | :------ | :------ |
1879
+ | `T` | extends `Object` |
1880
+ | `U` | extends `string` \| `number` \| `bigint` \| `boolean` \| `symbol` |
1881
+
1882
+ #### Parameters
1883
+
1884
+ | Name | Type | Description |
1885
+ | :------ | :------ | :------ |
1886
+ | `o` | `T` | Object on which to lock the attributes. |
1887
+
1888
+ #### Returns
1889
+
1890
+ `Readonly`\<`T`\>
1891
+
1892
+ #### Inherited from
1893
+
1894
+ [ClientTools](ClientTools.md).[freeze](ClientTools.md#freeze)
1895
+
1896
+ #### Defined in
1897
+
1898
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:228
1899
+
1900
+ ▸ **freeze**\<`T`\>(`o`): `Readonly`\<`T`\>
1901
+
1902
+ Prevents the modification of existing property attributes and values, and prevents the addition of new properties.
1903
+
1904
+ #### Type parameters
1905
+
1906
+ | Name |
1907
+ | :------ |
1908
+ | `T` |
1909
+
1910
+ #### Parameters
1911
+
1912
+ | Name | Type | Description |
1913
+ | :------ | :------ | :------ |
1914
+ | `o` | `T` | Object on which to lock the attributes. |
1915
+
1916
+ #### Returns
1917
+
1918
+ `Readonly`\<`T`\>
1919
+
1920
+ #### Inherited from
1921
+
1922
+ [ClientTools](ClientTools.md).[freeze](ClientTools.md#freeze)
1923
+
1924
+ #### Defined in
1925
+
1926
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:234
1927
+
1928
+ ___
1929
+
1930
+ ### fromEntries
1931
+
1932
+ ▸ **fromEntries**\<`T`\>(`entries`): `Object`
1933
+
1934
+ Returns an object created by key-value entries for properties and methods
1935
+
1936
+ #### Type parameters
1937
+
1938
+ | Name | Type |
1939
+ | :------ | :------ |
1940
+ | `T` | `any` |
1941
+
1942
+ #### Parameters
1943
+
1944
+ | Name | Type | Description |
1945
+ | :------ | :------ | :------ |
1946
+ | `entries` | `Iterable`\<readonly [`PropertyKey`, `T`]\> | An iterable object that contains key-value entries for properties and methods. |
1947
+
1948
+ #### Returns
1949
+
1950
+ `Object`
1951
+
1952
+ #### Inherited from
1953
+
1954
+ [ClientTools](ClientTools.md).[fromEntries](ClientTools.md#fromentries)
1955
+
1956
+ #### Defined in
1957
+
1958
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2019.object.d.ts:26
1959
+
1960
+ ▸ **fromEntries**(`entries`): `any`
1961
+
1962
+ Returns an object created by key-value entries for properties and methods
1963
+
1964
+ #### Parameters
1965
+
1966
+ | Name | Type | Description |
1967
+ | :------ | :------ | :------ |
1968
+ | `entries` | `Iterable`\<readonly `any`[]\> | An iterable object that contains key-value entries for properties and methods. |
1969
+
1970
+ #### Returns
1971
+
1972
+ `any`
1973
+
1974
+ #### Inherited from
1975
+
1976
+ [ClientTools](ClientTools.md).[fromEntries](ClientTools.md#fromentries)
1977
+
1978
+ #### Defined in
1979
+
1980
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2019.object.d.ts:32
1981
+
1982
+ ___
1983
+
1984
+ ### get
1985
+
1986
+ ▸ **get**(`name`): [`ToolFunc`](ToolFunc.md)
1987
+
1988
+ #### Parameters
1989
+
1990
+ | Name | Type |
1991
+ | :------ | :------ |
1992
+ | `name` | `string` |
1993
+
1994
+ #### Returns
1995
+
1996
+ [`ToolFunc`](ToolFunc.md)
1997
+
1998
+ #### Inherited from
1999
+
2000
+ [ClientTools](ClientTools.md).[get](ClientTools.md#get)
2001
+
2002
+ #### Defined in
2003
+
2004
+ [packages/ai-tool/src/tool-func.ts:49](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L49)
2005
+
2006
+ ___
2007
+
2008
+ ### getAllByTag
2009
+
2010
+ ▸ **getAllByTag**(`tagName`): [`ToolFunc`](ToolFunc.md)[]
2011
+
2012
+ #### Parameters
2013
+
2014
+ | Name | Type |
2015
+ | :------ | :------ |
2016
+ | `tagName` | `string` |
2017
+
2018
+ #### Returns
2019
+
2020
+ [`ToolFunc`](ToolFunc.md)[]
2021
+
2022
+ #### Inherited from
2023
+
2024
+ [ClientTools](ClientTools.md).[getAllByTag](ClientTools.md#getallbytag)
2025
+
2026
+ #### Defined in
2027
+
2028
+ [packages/ai-tool/src/tool-func.ts:77](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L77)
2029
+
2030
+ ___
2031
+
2032
+ ### getByTag
2033
+
2034
+ ▸ **getByTag**(`tagName`): `undefined` \| [`ToolFunc`](ToolFunc.md)
2035
+
2036
+ #### Parameters
2037
+
2038
+ | Name | Type |
2039
+ | :------ | :------ |
2040
+ | `tagName` | `string` |
2041
+
2042
+ #### Returns
2043
+
2044
+ `undefined` \| [`ToolFunc`](ToolFunc.md)
2045
+
2046
+ #### Inherited from
2047
+
2048
+ [ClientTools](ClientTools.md).[getByTag](ClientTools.md#getbytag)
2049
+
2050
+ #### Defined in
2051
+
2052
+ [packages/ai-tool/src/tool-func.ts:57](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L57)
2053
+
2054
+ ___
2055
+
2056
+ ### getFunc
2057
+
2058
+ ▸ **getFunc**(`name`): `any`
2059
+
2060
+ #### Parameters
2061
+
2062
+ | Name | Type |
2063
+ | :------ | :------ |
2064
+ | `name` | `string` |
2065
+
2066
+ #### Returns
2067
+
2068
+ `any`
2069
+
2070
+ #### Inherited from
2071
+
2072
+ [ClientTools](ClientTools.md).[getFunc](ClientTools.md#getfunc-1)
2073
+
2074
+ #### Defined in
2075
+
2076
+ [packages/ai-tool/src/tool-func.ts:111](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L111)
2077
+
2078
+ ___
2079
+
2080
+ ### getFuncWithPos
2081
+
2082
+ ▸ **getFuncWithPos**(`name`): `any`
2083
+
2084
+ #### Parameters
2085
+
2086
+ | Name | Type |
2087
+ | :------ | :------ |
2088
+ | `name` | `string` |
2089
+
2090
+ #### Returns
2091
+
2092
+ `any`
2093
+
2094
+ #### Inherited from
2095
+
2096
+ [ClientTools](ClientTools.md).[getFuncWithPos](ClientTools.md#getfuncwithpos-1)
2097
+
2098
+ #### Defined in
2099
+
2100
+ [packages/ai-tool/src/tool-func.ts:132](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L132)
2101
+
2102
+ ___
2103
+
2104
+ ### getOwnPropertyDescriptor
2105
+
2106
+ ▸ **getOwnPropertyDescriptor**(`o`, `p`): `undefined` \| `PropertyDescriptor`
2107
+
2108
+ Gets the own property descriptor of the specified object.
2109
+ An own property descriptor is one that is defined directly on the object and is not inherited from the object's prototype.
2110
+
2111
+ #### Parameters
2112
+
2113
+ | Name | Type | Description |
2114
+ | :------ | :------ | :------ |
2115
+ | `o` | `any` | Object that contains the property. |
2116
+ | `p` | `PropertyKey` | Name of the property. |
2117
+
2118
+ #### Returns
2119
+
2120
+ `undefined` \| `PropertyDescriptor`
2121
+
2122
+ #### Inherited from
2123
+
2124
+ [ClientTools](ClientTools.md).[getOwnPropertyDescriptor](ClientTools.md#getownpropertydescriptor)
2125
+
2126
+ #### Defined in
2127
+
2128
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:175
2129
+
2130
+ ___
2131
+
2132
+ ### getOwnPropertyDescriptors
2133
+
2134
+ ▸ **getOwnPropertyDescriptors**\<`T`\>(`o`): \{ [P in string \| number \| symbol]: TypedPropertyDescriptor\<T[P]\> } & \{ `[x: string]`: `PropertyDescriptor`; }
2135
+
2136
+ Returns an object containing all own property descriptors of an object
2137
+
2138
+ #### Type parameters
2139
+
2140
+ | Name |
2141
+ | :------ |
2142
+ | `T` |
2143
+
2144
+ #### Parameters
2145
+
2146
+ | Name | Type | Description |
2147
+ | :------ | :------ | :------ |
2148
+ | `o` | `T` | Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object. |
2149
+
2150
+ #### Returns
2151
+
2152
+ \{ [P in string \| number \| symbol]: TypedPropertyDescriptor\<T[P]\> } & \{ `[x: string]`: `PropertyDescriptor`; }
2153
+
2154
+ #### Inherited from
2155
+
2156
+ [ClientTools](ClientTools.md).[getOwnPropertyDescriptors](ClientTools.md#getownpropertydescriptors)
2157
+
2158
+ #### Defined in
2159
+
2160
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2017.object.d.ts:48
2161
+
2162
+ ___
2163
+
2164
+ ### getOwnPropertyNames
2165
+
2166
+ ▸ **getOwnPropertyNames**(`o`): `string`[]
2167
+
2168
+ Returns the names of the own properties of an object. The own properties of an object are those that are defined directly
2169
+ on that object, and are not inherited from the object's prototype. The properties of an object include both fields (objects) and functions.
2170
+
2171
+ #### Parameters
2172
+
2173
+ | Name | Type | Description |
2174
+ | :------ | :------ | :------ |
2175
+ | `o` | `any` | Object that contains the own properties. |
2176
+
2177
+ #### Returns
2178
+
2179
+ `string`[]
2180
+
2181
+ #### Inherited from
2182
+
2183
+ [ClientTools](ClientTools.md).[getOwnPropertyNames](ClientTools.md#getownpropertynames)
2184
+
2185
+ #### Defined in
2186
+
2187
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:182
2188
+
2189
+ ___
2190
+
2191
+ ### getOwnPropertySymbols
2192
+
2193
+ ▸ **getOwnPropertySymbols**(`o`): `symbol`[]
2194
+
2195
+ Returns an array of all symbol properties found directly on object o.
2196
+
2197
+ #### Parameters
2198
+
2199
+ | Name | Type | Description |
2200
+ | :------ | :------ | :------ |
2201
+ | `o` | `any` | Object to retrieve the symbols from. |
2202
+
2203
+ #### Returns
2204
+
2205
+ `symbol`[]
2206
+
2207
+ #### Inherited from
2208
+
2209
+ [ClientTools](ClientTools.md).[getOwnPropertySymbols](ClientTools.md#getownpropertysymbols)
2210
+
2211
+ #### Defined in
2212
+
2213
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.core.d.ts:317
2214
+
2215
+ ___
2216
+
2217
+ ### getProperties
2218
+
2219
+ ▸ **getProperties**(): `PropDescriptors`
2220
+
2221
+ get all properties descriptor include inherited.
2222
+
2223
+ #### Returns
2224
+
2225
+ `PropDescriptors`
2226
+
2227
+ #### Inherited from
2228
+
2229
+ [ClientTools](ClientTools.md).[getProperties](ClientTools.md#getproperties-1)
2230
+
2231
+ #### Defined in
2232
+
2233
+ node_modules/.pnpm/property-manager@2.0.0-alpha.5/node_modules/property-manager/lib/advance.d.ts:10
2234
+
2235
+ ___
2236
+
2237
+ ### getPrototypeOf
2238
+
2239
+ ▸ **getPrototypeOf**(`o`): `any`
2240
+
2241
+ Returns the prototype of an object.
2242
+
2243
+ #### Parameters
2244
+
2245
+ | Name | Type | Description |
2246
+ | :------ | :------ | :------ |
2247
+ | `o` | `any` | The object that references the prototype. |
2248
+
2249
+ #### Returns
2250
+
2251
+ `any`
2252
+
2253
+ #### Inherited from
2254
+
2255
+ [ClientTools](ClientTools.md).[getPrototypeOf](ClientTools.md#getprototypeof)
2256
+
2257
+ #### Defined in
2258
+
2259
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:167
2260
+
2261
+ ___
2262
+
2263
+ ### hasOwn
2264
+
2265
+ ▸ **hasOwn**(`o`, `v`): `boolean`
2266
+
2267
+ Determines whether an object has a property with the specified name.
2268
+
2269
+ #### Parameters
2270
+
2271
+ | Name | Type | Description |
2272
+ | :------ | :------ | :------ |
2273
+ | `o` | `object` | An object. |
2274
+ | `v` | `PropertyKey` | A property name. |
2275
+
2276
+ #### Returns
2277
+
2278
+ `boolean`
2279
+
2280
+ #### Inherited from
2281
+
2282
+ [ClientTools](ClientTools.md).[hasOwn](ClientTools.md#hasown)
2283
+
2284
+ #### Defined in
2285
+
2286
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2022.object.d.ts:25
2287
+
2288
+ ___
2289
+
2290
+ ### is
2291
+
2292
+ ▸ **is**(`value1`, `value2`): `boolean`
2293
+
2294
+ Returns true if the values are the same value, false otherwise.
2295
+
2296
+ #### Parameters
2297
+
2298
+ | Name | Type | Description |
2299
+ | :------ | :------ | :------ |
2300
+ | `value1` | `any` | The first value. |
2301
+ | `value2` | `any` | The second value. |
2302
+
2303
+ #### Returns
2304
+
2305
+ `boolean`
2306
+
2307
+ #### Inherited from
2308
+
2309
+ [ClientTools](ClientTools.md).[is](ClientTools.md#is)
2310
+
2311
+ #### Defined in
2312
+
2313
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.core.d.ts:330
2314
+
2315
+ ___
2316
+
2317
+ ### isExtensible
2318
+
2319
+ ▸ **isExtensible**(`o`): `boolean`
2320
+
2321
+ Returns a value that indicates whether new properties can be added to an object.
2322
+
2323
+ #### Parameters
2324
+
2325
+ | Name | Type | Description |
2326
+ | :------ | :------ | :------ |
2327
+ | `o` | `any` | Object to test. |
2328
+
2329
+ #### Returns
2330
+
2331
+ `boolean`
2332
+
2333
+ #### Inherited from
2334
+
2335
+ [ClientTools](ClientTools.md).[isExtensible](ClientTools.md#isextensible)
2336
+
2337
+ #### Defined in
2338
+
2339
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:258
2340
+
2341
+ ___
2342
+
2343
+ ### isFrozen
2344
+
2345
+ ▸ **isFrozen**(`o`): `boolean`
2346
+
2347
+ Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.
2348
+
2349
+ #### Parameters
2350
+
2351
+ | Name | Type | Description |
2352
+ | :------ | :------ | :------ |
2353
+ | `o` | `any` | Object to test. |
2354
+
2355
+ #### Returns
2356
+
2357
+ `boolean`
2358
+
2359
+ #### Inherited from
2360
+
2361
+ [ClientTools](ClientTools.md).[isFrozen](ClientTools.md#isfrozen)
2362
+
2363
+ #### Defined in
2364
+
2365
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:252
2366
+
2367
+ ___
2368
+
2369
+ ### isSealed
2370
+
2371
+ ▸ **isSealed**(`o`): `boolean`
2372
+
2373
+ Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.
2374
+
2375
+ #### Parameters
2376
+
2377
+ | Name | Type | Description |
2378
+ | :------ | :------ | :------ |
2379
+ | `o` | `any` | Object to test. |
2380
+
2381
+ #### Returns
2382
+
2383
+ `boolean`
2384
+
2385
+ #### Inherited from
2386
+
2387
+ [ClientTools](ClientTools.md).[isSealed](ClientTools.md#issealed)
2388
+
2389
+ #### Defined in
2390
+
2391
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:246
2392
+
2393
+ ___
2394
+
2395
+ ### keys
2396
+
2397
+ ▸ **keys**(`o`): `string`[]
2398
+
2399
+ Returns the names of the enumerable string properties and methods of an object.
2400
+
2401
+ #### Parameters
2402
+
2403
+ | Name | Type | Description |
2404
+ | :------ | :------ | :------ |
2405
+ | `o` | `object` | Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object. |
2406
+
2407
+ #### Returns
2408
+
2409
+ `string`[]
2410
+
2411
+ #### Inherited from
2412
+
2413
+ [ClientTools](ClientTools.md).[keys](ClientTools.md#keys)
2414
+
2415
+ #### Defined in
2416
+
2417
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:264
2418
+
2419
+ ▸ **keys**(`o`): `string`[]
2420
+
2421
+ Returns the names of the enumerable string properties and methods of an object.
2422
+
2423
+ #### Parameters
2424
+
2425
+ | Name | Type | Description |
2426
+ | :------ | :------ | :------ |
2427
+ | `o` | `Object` | Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object. |
2428
+
2429
+ #### Returns
2430
+
2431
+ `string`[]
2432
+
2433
+ #### Inherited from
2434
+
2435
+ [ClientTools](ClientTools.md).[keys](ClientTools.md#keys)
2436
+
2437
+ #### Defined in
2438
+
2439
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.core.d.ts:323
2440
+
2441
+ ___
2442
+
2443
+ ### list
2444
+
2445
+ ▸ **list**(): [`Funcs`](../interfaces/Funcs.md)
2446
+
2447
+ #### Returns
2448
+
2449
+ [`Funcs`](../interfaces/Funcs.md)
2450
+
2451
+ #### Inherited from
2452
+
2453
+ [ClientTools](ClientTools.md).[list](ClientTools.md#list)
2454
+
2455
+ #### Defined in
2456
+
2457
+ [packages/ai-tool/src/tool-func.ts:53](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L53)
2458
+
2459
+ ___
2460
+
2461
+ ### loadFrom
2462
+
2463
+ ▸ **loadFrom**(): `Promise`\<`void`\>
2464
+
2465
+ #### Returns
2466
+
2467
+ `Promise`\<`void`\>
2468
+
2469
+ #### Inherited from
2470
+
2471
+ [ClientTools](ClientTools.md).[loadFrom](ClientTools.md#loadfrom)
2472
+
2473
+ #### Defined in
2474
+
2475
+ [packages/ai-tool/src/client-tools.ts:29](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/client-tools.ts#L29)
2476
+
2477
+ ___
2478
+
2479
+ ### loadFromSync
2480
+
2481
+ ▸ **loadFromSync**(`items`): `void`
2482
+
2483
+ #### Parameters
2484
+
2485
+ | Name | Type |
2486
+ | :------ | :------ |
2487
+ | `items` | [`Funcs`](../interfaces/Funcs.md) |
2488
+
2489
+ #### Returns
2490
+
2491
+ `void`
2492
+
2493
+ #### Inherited from
2494
+
2495
+ [ClientTools](ClientTools.md).[loadFromSync](ClientTools.md#loadfromsync)
2496
+
2497
+ #### Defined in
2498
+
2499
+ [packages/ai-tool/src/client-tools.ts:41](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/client-tools.ts#L41)
2500
+
2501
+ ___
2502
+
2503
+ ### preventExtensions
2504
+
2505
+ ▸ **preventExtensions**\<`T`\>(`o`): `T`
2506
+
2507
+ Prevents the addition of new properties to an object.
2508
+
2509
+ #### Type parameters
2510
+
2511
+ | Name |
2512
+ | :------ |
2513
+ | `T` |
2514
+
2515
+ #### Parameters
2516
+
2517
+ | Name | Type | Description |
2518
+ | :------ | :------ | :------ |
2519
+ | `o` | `T` | Object to make non-extensible. |
2520
+
2521
+ #### Returns
2522
+
2523
+ `T`
2524
+
2525
+ #### Inherited from
2526
+
2527
+ [ClientTools](ClientTools.md).[preventExtensions](ClientTools.md#preventextensions)
2528
+
2529
+ #### Defined in
2530
+
2531
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:240
2532
+
2533
+ ___
2534
+
2535
+ ### register
2536
+
2537
+ ▸ **register**(`name`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
2538
+
2539
+ #### Parameters
2540
+
2541
+ | Name | Type |
2542
+ | :------ | :------ |
2543
+ | `name` | `string` |
2544
+ | `options` | [`FuncItem`](../interfaces/FuncItem.md) |
2545
+
2546
+ #### Returns
2547
+
2548
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
2549
+
2550
+ #### Inherited from
2551
+
2552
+ [ClientTools](ClientTools.md).[register](ClientTools.md#register-1)
2553
+
2554
+ #### Defined in
2555
+
2556
+ [packages/ai-tool/src/tool-func.ts:137](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L137)
2557
+
2558
+ ▸ **register**(`func`, `options`): `boolean` \| [`ToolFunc`](ToolFunc.md)
2559
+
2560
+ #### Parameters
2561
+
2562
+ | Name | Type |
2563
+ | :------ | :------ |
2564
+ | `func` | `Function` |
2565
+ | `options` | [`FuncItem`](../interfaces/FuncItem.md) |
2566
+
2567
+ #### Returns
2568
+
2569
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
2570
+
2571
+ #### Inherited from
2572
+
2573
+ [ClientTools](ClientTools.md).[register](ClientTools.md#register-1)
2574
+
2575
+ #### Defined in
2576
+
2577
+ [packages/ai-tool/src/tool-func.ts:138](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L138)
2578
+
2579
+ ▸ **register**(`name`, `options?`): `boolean` \| [`ToolFunc`](ToolFunc.md)
2580
+
2581
+ #### Parameters
2582
+
2583
+ | Name | Type |
2584
+ | :------ | :------ |
2585
+ | `name` | `string` \| `Function` \| [`ToolFunc`](ToolFunc.md) \| [`FuncItem`](../interfaces/FuncItem.md) |
2586
+ | `options?` | [`FuncItem`](../interfaces/FuncItem.md) |
2587
+
2588
+ #### Returns
2589
+
2590
+ `boolean` \| [`ToolFunc`](ToolFunc.md)
2591
+
2592
+ #### Inherited from
2593
+
2594
+ [ClientTools](ClientTools.md).[register](ClientTools.md#register-1)
2595
+
2596
+ #### Defined in
2597
+
2598
+ [packages/ai-tool/src/tool-func.ts:139](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L139)
2599
+
2600
+ ___
2601
+
2602
+ ### run
2603
+
2604
+ ▸ **run**(`name`, `params?`): `Promise`\<`any`\>
2605
+
2606
+ #### Parameters
2607
+
2608
+ | Name | Type |
2609
+ | :------ | :------ |
2610
+ | `name` | `string` |
2611
+ | `params?` | `any` |
2612
+
2613
+ #### Returns
2614
+
2615
+ `Promise`\<`any`\>
2616
+
2617
+ #### Inherited from
2618
+
2619
+ [ClientTools](ClientTools.md).[run](ClientTools.md#run-1)
2620
+
2621
+ #### Defined in
2622
+
2623
+ [packages/ai-tool/src/tool-func.ts:95](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L95)
2624
+
2625
+ ___
2626
+
2627
+ ### runSync
2628
+
2629
+ ▸ **runSync**(`name`, `params?`): `any`
2630
+
2631
+ #### Parameters
2632
+
2633
+ | Name | Type |
2634
+ | :------ | :------ |
2635
+ | `name` | `string` |
2636
+ | `params?` | `any` |
2637
+
2638
+ #### Returns
2639
+
2640
+ `any`
2641
+
2642
+ #### Inherited from
2643
+
2644
+ [ClientTools](ClientTools.md).[runSync](ClientTools.md#runsync-1)
2645
+
2646
+ #### Defined in
2647
+
2648
+ [packages/ai-tool/src/tool-func.ts:103](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L103)
2649
+
2650
+ ___
2651
+
2652
+ ### runWithPos
2653
+
2654
+ ▸ **runWithPos**(`name`, `...params`): `Promise`\<`any`\>
2655
+
2656
+ #### Parameters
2657
+
2658
+ | Name | Type |
2659
+ | :------ | :------ |
2660
+ | `name` | `string` |
2661
+ | `...params` | `any`[] |
2662
+
2663
+ #### Returns
2664
+
2665
+ `Promise`\<`any`\>
2666
+
2667
+ #### Inherited from
2668
+
2669
+ [ClientTools](ClientTools.md).[runWithPos](ClientTools.md#runwithpos-1)
2670
+
2671
+ #### Defined in
2672
+
2673
+ [packages/ai-tool/src/tool-func.ts:116](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L116)
2674
+
2675
+ ___
2676
+
2677
+ ### runWithPosSync
2678
+
2679
+ ▸ **runWithPosSync**(`name`, `...params`): `any`
2680
+
2681
+ #### Parameters
2682
+
2683
+ | Name | Type |
2684
+ | :------ | :------ |
2685
+ | `name` | `string` |
2686
+ | `...params` | `any`[] |
2687
+
2688
+ #### Returns
2689
+
2690
+ `any`
2691
+
2692
+ #### Inherited from
2693
+
2694
+ [ClientTools](ClientTools.md).[runWithPosSync](ClientTools.md#runwithpossync-1)
2695
+
2696
+ #### Defined in
2697
+
2698
+ [packages/ai-tool/src/tool-func.ts:124](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L124)
2699
+
2700
+ ___
2701
+
2702
+ ### seal
2703
+
2704
+ ▸ **seal**\<`T`\>(`o`): `T`
2705
+
2706
+ Prevents the modification of attributes of existing properties, and prevents the addition of new properties.
2707
+
2708
+ #### Type parameters
2709
+
2710
+ | Name |
2711
+ | :------ |
2712
+ | `T` |
2713
+
2714
+ #### Parameters
2715
+
2716
+ | Name | Type | Description |
2717
+ | :------ | :------ | :------ |
2718
+ | `o` | `T` | Object on which to lock the attributes. |
2719
+
2720
+ #### Returns
2721
+
2722
+ `T`
2723
+
2724
+ #### Inherited from
2725
+
2726
+ [ClientTools](ClientTools.md).[seal](ClientTools.md#seal)
2727
+
2728
+ #### Defined in
2729
+
2730
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:216
2731
+
2732
+ ___
2733
+
2734
+ ### setApiRoot
2735
+
2736
+ ▸ **setApiRoot**(`v`): `void`
2737
+
2738
+ #### Parameters
2739
+
2740
+ | Name | Type |
2741
+ | :------ | :------ |
2742
+ | `v` | `string` |
2743
+
2744
+ #### Returns
2745
+
2746
+ `void`
2747
+
2748
+ #### Inherited from
2749
+
2750
+ [ClientTools](ClientTools.md).[setApiRoot](ClientTools.md#setapiroot)
2751
+
2752
+ #### Defined in
2753
+
2754
+ [packages/ai-tool/src/client-tools.ts:23](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/client-tools.ts#L23)
2755
+
2756
+ ___
2757
+
2758
+ ### setPrototypeOf
2759
+
2760
+ ▸ **setPrototypeOf**(`o`, `proto`): `any`
2761
+
2762
+ Sets the prototype of a specified object o to object proto or null. Returns the object o.
2763
+
2764
+ #### Parameters
2765
+
2766
+ | Name | Type | Description |
2767
+ | :------ | :------ | :------ |
2768
+ | `o` | `any` | The object to change its prototype. |
2769
+ | `proto` | ``null`` \| `object` | The value of the new prototype or null. |
2770
+
2771
+ #### Returns
2772
+
2773
+ `any`
2774
+
2775
+ #### Inherited from
2776
+
2777
+ [ClientTools](ClientTools.md).[setPrototypeOf](ClientTools.md#setprototypeof)
2778
+
2779
+ #### Defined in
2780
+
2781
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2015.core.d.ts:337
2782
+
2783
+ ___
2784
+
2785
+ ### unregister
2786
+
2787
+ ▸ **unregister**(`name`): `undefined` \| [`ToolFunc`](ToolFunc.md)
2788
+
2789
+ #### Parameters
2790
+
2791
+ | Name | Type |
2792
+ | :------ | :------ |
2793
+ | `name` | `string` |
2794
+
2795
+ #### Returns
2796
+
2797
+ `undefined` \| [`ToolFunc`](ToolFunc.md)
2798
+
2799
+ #### Inherited from
2800
+
2801
+ [ClientTools](ClientTools.md).[unregister](ClientTools.md#unregister-1)
2802
+
2803
+ #### Defined in
2804
+
2805
+ [packages/ai-tool/src/tool-func.ts:167](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L167)
2806
+
2807
+ ___
2808
+
2809
+ ### values
2810
+
2811
+ ▸ **values**\<`T`\>(`o`): `T`[]
2812
+
2813
+ Returns an array of values of the enumerable properties of an object
2814
+
2815
+ #### Type parameters
2816
+
2817
+ | Name |
2818
+ | :------ |
2819
+ | `T` |
2820
+
2821
+ #### Parameters
2822
+
2823
+ | Name | Type | Description |
2824
+ | :------ | :------ | :------ |
2825
+ | `o` | \{ `[s: string]`: `T`; } \| `ArrayLike`\<`T`\> | Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object. |
2826
+
2827
+ #### Returns
2828
+
2829
+ `T`[]
2830
+
2831
+ #### Inherited from
2832
+
2833
+ [ClientTools](ClientTools.md).[values](ClientTools.md#values)
2834
+
2835
+ #### Defined in
2836
+
2837
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2017.object.d.ts:24
2838
+
2839
+ ▸ **values**(`o`): `any`[]
2840
+
2841
+ Returns an array of values of the enumerable properties of an object
2842
+
2843
+ #### Parameters
2844
+
2845
+ | Name | Type | Description |
2846
+ | :------ | :------ | :------ |
2847
+ | `o` | `Object` | Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object. |
2848
+
2849
+ #### Returns
2850
+
2851
+ `any`[]
2852
+
2853
+ #### Inherited from
2854
+
2855
+ [ClientTools](ClientTools.md).[values](ClientTools.md#values)
2856
+
2857
+ #### Defined in
2858
+
2859
+ node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2017.object.d.ts:30