agentbase-web-sdk 2.7.2 → 2.9.0
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.
- package/README.md +2 -2
- package/dist/cjs/sdk.js +160 -6
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +160 -6
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +160 -6
- package/package.json +5 -4
- package/types/enums/timezone.d.ts +0 -1
- package/types/index.d.ts +1 -1
- package/types/models.d.ts +33 -0
- package/types/services/ai-gateway.d.ts +57 -0
- package/types/services/databases.d.ts +4 -0
- package/types/services/documents-db.d.ts +4 -0
- package/types/services/functions.d.ts +56 -0
- package/types/services/knowledge-bases.d.ts +4 -1
- package/types/services/memory.d.ts +4 -1
- package/types/services/storage.d.ts +8 -2
- package/types/services/tables-db.d.ts +4 -0
package/dist/iife/sdk.js
CHANGED
|
@@ -4393,7 +4393,7 @@
|
|
|
4393
4393
|
* Holds configuration such as project.
|
|
4394
4394
|
*/
|
|
4395
4395
|
this.config = {
|
|
4396
|
-
endpoint: 'https://
|
|
4396
|
+
endpoint: 'https://appbase.local/v1',
|
|
4397
4397
|
endpointRealtime: '',
|
|
4398
4398
|
project: '',
|
|
4399
4399
|
organization: '',
|
|
@@ -4412,9 +4412,9 @@
|
|
|
4412
4412
|
'x-sdk-name': 'Agentbase',
|
|
4413
4413
|
'x-sdk-platform': 'client',
|
|
4414
4414
|
'x-sdk-language': 'web',
|
|
4415
|
-
'x-sdk-version': '2.
|
|
4415
|
+
'x-sdk-version': '2.9.0',
|
|
4416
4416
|
'X-AppBase-SDK': 'true',
|
|
4417
|
-
'X-Appwrite-Response-Format': '2.
|
|
4417
|
+
'X-Appwrite-Response-Format': '2.9.0',
|
|
4418
4418
|
};
|
|
4419
4419
|
this.realtime = {
|
|
4420
4420
|
socket: undefined,
|
|
@@ -7900,6 +7900,51 @@
|
|
|
7900
7900
|
};
|
|
7901
7901
|
return this.client.call('post', uri, apiHeaders, payload);
|
|
7902
7902
|
}
|
|
7903
|
+
listLogicalModelMounts(paramsOrFirst) {
|
|
7904
|
+
let params;
|
|
7905
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
7906
|
+
params = (paramsOrFirst || {});
|
|
7907
|
+
}
|
|
7908
|
+
else {
|
|
7909
|
+
params = {
|
|
7910
|
+
id: paramsOrFirst
|
|
7911
|
+
};
|
|
7912
|
+
}
|
|
7913
|
+
const id = params.id;
|
|
7914
|
+
if (typeof id === 'undefined') {
|
|
7915
|
+
throw new AgentbaseException('Missing required parameter: "id"');
|
|
7916
|
+
}
|
|
7917
|
+
const apiPath = '/ai-gateway/resources/logical-models/{id}/mounts'.replace('{id}', id);
|
|
7918
|
+
const payload = {};
|
|
7919
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
7920
|
+
const apiHeaders = {
|
|
7921
|
+
'X-Appwrite-Project': this.client.config.project,
|
|
7922
|
+
};
|
|
7923
|
+
return this.client.call('get', uri, apiHeaders, payload);
|
|
7924
|
+
}
|
|
7925
|
+
replaceLogicalModelMounts(paramsOrFirst) {
|
|
7926
|
+
let params;
|
|
7927
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
7928
|
+
params = (paramsOrFirst || {});
|
|
7929
|
+
}
|
|
7930
|
+
else {
|
|
7931
|
+
params = {
|
|
7932
|
+
id: paramsOrFirst
|
|
7933
|
+
};
|
|
7934
|
+
}
|
|
7935
|
+
const id = params.id;
|
|
7936
|
+
if (typeof id === 'undefined') {
|
|
7937
|
+
throw new AgentbaseException('Missing required parameter: "id"');
|
|
7938
|
+
}
|
|
7939
|
+
const apiPath = '/ai-gateway/resources/logical-models/{id}/mounts'.replace('{id}', id);
|
|
7940
|
+
const payload = {};
|
|
7941
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
7942
|
+
const apiHeaders = {
|
|
7943
|
+
'X-Appwrite-Project': this.client.config.project,
|
|
7944
|
+
'content-type': 'application/json',
|
|
7945
|
+
};
|
|
7946
|
+
return this.client.call('put', uri, apiHeaders, payload);
|
|
7947
|
+
}
|
|
7903
7948
|
testModelDeployment(paramsOrFirst) {
|
|
7904
7949
|
let params;
|
|
7905
7950
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
@@ -8481,6 +8526,29 @@
|
|
|
8481
8526
|
};
|
|
8482
8527
|
return this.client.call('delete', uri, apiHeaders, payload);
|
|
8483
8528
|
}
|
|
8529
|
+
testToolConnection(paramsOrFirst) {
|
|
8530
|
+
let params;
|
|
8531
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
8532
|
+
params = (paramsOrFirst || {});
|
|
8533
|
+
}
|
|
8534
|
+
else {
|
|
8535
|
+
params = {
|
|
8536
|
+
id: paramsOrFirst
|
|
8537
|
+
};
|
|
8538
|
+
}
|
|
8539
|
+
const id = params.id;
|
|
8540
|
+
if (typeof id === 'undefined') {
|
|
8541
|
+
throw new AgentbaseException('Missing required parameter: "id"');
|
|
8542
|
+
}
|
|
8543
|
+
const apiPath = '/ai-gateway/tool-connections/{id}/test'.replace('{id}', id);
|
|
8544
|
+
const payload = {};
|
|
8545
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
8546
|
+
const apiHeaders = {
|
|
8547
|
+
'X-Appwrite-Project': this.client.config.project,
|
|
8548
|
+
'content-type': 'application/json',
|
|
8549
|
+
};
|
|
8550
|
+
return this.client.call('post', uri, apiHeaders, payload);
|
|
8551
|
+
}
|
|
8484
8552
|
}
|
|
8485
8553
|
|
|
8486
8554
|
class Avatars {
|
|
@@ -10037,6 +10105,83 @@
|
|
|
10037
10105
|
constructor(client) {
|
|
10038
10106
|
this.client = client;
|
|
10039
10107
|
}
|
|
10108
|
+
listExecutionPaths(paramsOrFirst, ...rest) {
|
|
10109
|
+
let params;
|
|
10110
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
10111
|
+
params = (paramsOrFirst || {});
|
|
10112
|
+
}
|
|
10113
|
+
else {
|
|
10114
|
+
params = {
|
|
10115
|
+
functionId: paramsOrFirst,
|
|
10116
|
+
limit: rest[0],
|
|
10117
|
+
offset: rest[1],
|
|
10118
|
+
total: rest[2]
|
|
10119
|
+
};
|
|
10120
|
+
}
|
|
10121
|
+
const functionId = params.functionId;
|
|
10122
|
+
const limit = params.limit;
|
|
10123
|
+
const offset = params.offset;
|
|
10124
|
+
const total = params.total;
|
|
10125
|
+
if (typeof functionId === 'undefined') {
|
|
10126
|
+
throw new AgentbaseException('Missing required parameter: "functionId"');
|
|
10127
|
+
}
|
|
10128
|
+
const apiPath = '/functions/{functionId}/execution-paths'.replace('{functionId}', functionId);
|
|
10129
|
+
const payload = {};
|
|
10130
|
+
if (typeof limit !== 'undefined') {
|
|
10131
|
+
payload['limit'] = limit;
|
|
10132
|
+
}
|
|
10133
|
+
if (typeof offset !== 'undefined') {
|
|
10134
|
+
payload['offset'] = offset;
|
|
10135
|
+
}
|
|
10136
|
+
if (typeof total !== 'undefined') {
|
|
10137
|
+
payload['total'] = total;
|
|
10138
|
+
}
|
|
10139
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
10140
|
+
const apiHeaders = {
|
|
10141
|
+
'X-Appwrite-Project': this.client.config.project,
|
|
10142
|
+
};
|
|
10143
|
+
return this.client.call('get', uri, apiHeaders, payload);
|
|
10144
|
+
}
|
|
10145
|
+
listExecutionsByPath(paramsOrFirst, ...rest) {
|
|
10146
|
+
let params;
|
|
10147
|
+
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
10148
|
+
params = (paramsOrFirst || {});
|
|
10149
|
+
}
|
|
10150
|
+
else {
|
|
10151
|
+
params = {
|
|
10152
|
+
functionId: paramsOrFirst,
|
|
10153
|
+
xpath: rest[0],
|
|
10154
|
+
queries: rest[1],
|
|
10155
|
+
total: rest[2]
|
|
10156
|
+
};
|
|
10157
|
+
}
|
|
10158
|
+
const functionId = params.functionId;
|
|
10159
|
+
const xpath = params.xpath;
|
|
10160
|
+
const queries = params.queries;
|
|
10161
|
+
const total = params.total;
|
|
10162
|
+
if (typeof functionId === 'undefined') {
|
|
10163
|
+
throw new AgentbaseException('Missing required parameter: "functionId"');
|
|
10164
|
+
}
|
|
10165
|
+
if (typeof xpath === 'undefined') {
|
|
10166
|
+
throw new AgentbaseException('Missing required parameter: "xpath"');
|
|
10167
|
+
}
|
|
10168
|
+
const apiPath = '/functions/{functionId}/execution-paths/executions'.replace('{functionId}', functionId);
|
|
10169
|
+
const payload = {};
|
|
10170
|
+
if (typeof xpath !== 'undefined') {
|
|
10171
|
+
payload['path'] = xpath;
|
|
10172
|
+
}
|
|
10173
|
+
if (typeof queries !== 'undefined') {
|
|
10174
|
+
payload['queries'] = queries;
|
|
10175
|
+
}
|
|
10176
|
+
if (typeof total !== 'undefined') {
|
|
10177
|
+
payload['total'] = total;
|
|
10178
|
+
}
|
|
10179
|
+
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
10180
|
+
const apiHeaders = {
|
|
10181
|
+
'X-Appwrite-Project': this.client.config.project,
|
|
10182
|
+
};
|
|
10183
|
+
return this.client.call('get', uri, apiHeaders, payload);
|
|
10184
|
+
}
|
|
10040
10185
|
listExecutions(paramsOrFirst, ...rest) {
|
|
10041
10186
|
let params;
|
|
10042
10187
|
if ((paramsOrFirst && typeof paramsOrFirst === 'object' && !Array.isArray(paramsOrFirst))) {
|
|
@@ -10225,13 +10370,15 @@
|
|
|
10225
10370
|
knowledgeBaseId: paramsOrFirst,
|
|
10226
10371
|
sessionId: rest[0],
|
|
10227
10372
|
urls: rest[1],
|
|
10228
|
-
idempotencyKey: rest[2]
|
|
10373
|
+
idempotencyKey: rest[2],
|
|
10374
|
+
versionId: rest[3]
|
|
10229
10375
|
};
|
|
10230
10376
|
}
|
|
10231
10377
|
const knowledgeBaseId = params.knowledgeBaseId;
|
|
10232
10378
|
const sessionId = params.sessionId;
|
|
10233
10379
|
const urls = params.urls;
|
|
10234
10380
|
const idempotencyKey = params.idempotencyKey;
|
|
10381
|
+
const versionId = params.versionId;
|
|
10235
10382
|
if (typeof knowledgeBaseId === 'undefined') {
|
|
10236
10383
|
throw new AgentbaseException('Missing required parameter: "knowledgeBaseId"');
|
|
10237
10384
|
}
|
|
@@ -10252,6 +10399,9 @@
|
|
|
10252
10399
|
if (typeof idempotencyKey !== 'undefined') {
|
|
10253
10400
|
payload['idempotencyKey'] = idempotencyKey;
|
|
10254
10401
|
}
|
|
10402
|
+
if (typeof versionId !== 'undefined') {
|
|
10403
|
+
payload['versionId'] = versionId;
|
|
10404
|
+
}
|
|
10255
10405
|
const uri = new URL(this.client.config.endpoint + apiPath);
|
|
10256
10406
|
const apiHeaders = {
|
|
10257
10407
|
'X-Appwrite-Project': this.client.config.project,
|
|
@@ -13107,13 +13257,15 @@
|
|
|
13107
13257
|
profileType: rest[0],
|
|
13108
13258
|
messages: rest[1],
|
|
13109
13259
|
sourceMemoryIds: rest[2],
|
|
13110
|
-
|
|
13260
|
+
sessionId: rest[3],
|
|
13261
|
+
mode: rest[4]
|
|
13111
13262
|
};
|
|
13112
13263
|
}
|
|
13113
13264
|
const userId = params.userId;
|
|
13114
13265
|
const profileType = params.profileType;
|
|
13115
13266
|
const messages = params.messages;
|
|
13116
13267
|
const sourceMemoryIds = params.sourceMemoryIds;
|
|
13268
|
+
const sessionId = params.sessionId;
|
|
13117
13269
|
const mode = params.mode;
|
|
13118
13270
|
if (typeof userId === 'undefined') {
|
|
13119
13271
|
throw new AgentbaseException('Missing required parameter: "userId"');
|
|
@@ -13129,6 +13281,9 @@
|
|
|
13129
13281
|
if (typeof sourceMemoryIds !== 'undefined') {
|
|
13130
13282
|
payload['sourceMemoryIds'] = sourceMemoryIds;
|
|
13131
13283
|
}
|
|
13284
|
+
if (typeof sessionId !== 'undefined') {
|
|
13285
|
+
payload['sessionId'] = sessionId;
|
|
13286
|
+
}
|
|
13132
13287
|
if (typeof mode !== 'undefined') {
|
|
13133
13288
|
payload['mode'] = mode;
|
|
13134
13289
|
}
|
|
@@ -17605,7 +17760,6 @@
|
|
|
17605
17760
|
Timezone["AsiaBaku"] = "asia/baku";
|
|
17606
17761
|
Timezone["AsiaBangkok"] = "asia/bangkok";
|
|
17607
17762
|
Timezone["AsiaBarnaul"] = "asia/barnaul";
|
|
17608
|
-
Timezone["AsiaBeijing"] = "asia/beijing";
|
|
17609
17763
|
Timezone["AsiaBeirut"] = "asia/beirut";
|
|
17610
17764
|
Timezone["AsiaBishkek"] = "asia/bishkek";
|
|
17611
17765
|
Timezone["AsiaBrunei"] = "asia/brunei";
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "agentbase-web-sdk",
|
|
3
|
-
"homepage": "
|
|
3
|
+
"homepage": "https://appbase.local/support",
|
|
4
4
|
"description": "",
|
|
5
|
-
"version": "2.
|
|
5
|
+
"version": "2.9.0",
|
|
6
6
|
"license": "",
|
|
7
7
|
"main": "dist/cjs/sdk.js",
|
|
8
8
|
"exports": {
|
|
@@ -26,7 +26,8 @@
|
|
|
26
26
|
"scripts": {
|
|
27
27
|
"build": "npm run build:types && npm run build:libs",
|
|
28
28
|
"build:types": "tsc --declaration --emitDeclarationOnly --outDir types",
|
|
29
|
-
"build:libs": "rollup -c"
|
|
29
|
+
"build:libs": "rollup -c",
|
|
30
|
+
"test": "node test/build-output.test.js"
|
|
30
31
|
},
|
|
31
32
|
"engines": {
|
|
32
33
|
"node": ">=18.0.0"
|
|
@@ -48,6 +49,6 @@
|
|
|
48
49
|
"jsdelivr": "dist/iife/sdk.js",
|
|
49
50
|
"unpkg": "dist/iife/sdk.js",
|
|
50
51
|
"agentbase_provenance": {
|
|
51
|
-
"build_manifest_sha256": "
|
|
52
|
+
"build_manifest_sha256": "39dbfc0e23b3e3fcd04cc79a70bac696fcefadfd49dbd2613fbb9ca8901cf6c8"
|
|
52
53
|
}
|
|
53
54
|
}
|
|
@@ -220,7 +220,6 @@ export declare enum Timezone {
|
|
|
220
220
|
AsiaBaku = "asia/baku",
|
|
221
221
|
AsiaBangkok = "asia/bangkok",
|
|
222
222
|
AsiaBarnaul = "asia/barnaul",
|
|
223
|
-
AsiaBeijing = "asia/beijing",
|
|
224
223
|
AsiaBeirut = "asia/beirut",
|
|
225
224
|
AsiaBishkek = "asia/bishkek",
|
|
226
225
|
AsiaBrunei = "asia/brunei",
|
package/types/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Agentbase Agentbase SDK
|
|
3
3
|
*
|
|
4
|
-
* This SDK is compatible with Appwrite server version 2.
|
|
4
|
+
* This SDK is compatible with Appwrite server version 2.9.x.
|
|
5
5
|
* For older versions, please check
|
|
6
6
|
* [previous releases](https://github.com/agentbase/agentbase-web-sdk/releases).
|
|
7
7
|
*/
|
package/types/models.d.ts
CHANGED
|
@@ -190,6 +190,19 @@ export declare namespace Models {
|
|
|
190
190
|
*/
|
|
191
191
|
executions: Execution[];
|
|
192
192
|
};
|
|
193
|
+
/**
|
|
194
|
+
* Execution Paths List
|
|
195
|
+
*/
|
|
196
|
+
export type ExecutionPathList = {
|
|
197
|
+
/**
|
|
198
|
+
* Total number of distinct execution paths.
|
|
199
|
+
*/
|
|
200
|
+
total: number;
|
|
201
|
+
/**
|
|
202
|
+
* List of distinct execution paths.
|
|
203
|
+
*/
|
|
204
|
+
paths: string[];
|
|
205
|
+
};
|
|
193
206
|
/**
|
|
194
207
|
* Countries List
|
|
195
208
|
*/
|
|
@@ -363,6 +376,18 @@ export declare namespace Models {
|
|
|
363
376
|
* Document permissions. [Learn more about permissions]([HOSTNAME]/docs/permissions).
|
|
364
377
|
*/
|
|
365
378
|
$permissions: string[];
|
|
379
|
+
/**
|
|
380
|
+
* Moderation disposition: checking, published, quarantined, private_hold. Only present when moderation is active.
|
|
381
|
+
*/
|
|
382
|
+
moderationStatus: string;
|
|
383
|
+
/**
|
|
384
|
+
* ID of the moderation job processing this document. Only present when moderation is active.
|
|
385
|
+
*/
|
|
386
|
+
moderationJobId: string;
|
|
387
|
+
/**
|
|
388
|
+
* Monotonically increasing version of the document content, used by moderation to track which version was reviewed.
|
|
389
|
+
*/
|
|
390
|
+
contentVersion: number;
|
|
366
391
|
};
|
|
367
392
|
export type DefaultDocument = Document & {
|
|
368
393
|
[key: string]: any;
|
|
@@ -2118,6 +2143,10 @@ export declare namespace Models {
|
|
|
2118
2143
|
* Safe projections of the available model sources.
|
|
2119
2144
|
*/
|
|
2120
2145
|
sources?: object[];
|
|
2146
|
+
/**
|
|
2147
|
+
* Resolved per-model metadata (stored provider metadata merged over the built-in preset catalog) when available.
|
|
2148
|
+
*/
|
|
2149
|
+
metadata?: object;
|
|
2121
2150
|
/**
|
|
2122
2151
|
* Current account-model trial quota when a platform trial source is available.
|
|
2123
2152
|
*/
|
|
@@ -2194,6 +2223,10 @@ export declare namespace Models {
|
|
|
2194
2223
|
* Knowledge base ID this document belongs to.
|
|
2195
2224
|
*/
|
|
2196
2225
|
kbId: string;
|
|
2226
|
+
/**
|
|
2227
|
+
* Knowledge Base Version ID for Version-scoped documents.
|
|
2228
|
+
*/
|
|
2229
|
+
versionId?: string;
|
|
2197
2230
|
/**
|
|
2198
2231
|
* Document name.
|
|
2199
2232
|
*/
|
|
@@ -300,6 +300,44 @@ export declare class AiGateway {
|
|
|
300
300
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
301
301
|
*/
|
|
302
302
|
dryRunPolicy(policyEngineId: string): Promise<{}>;
|
|
303
|
+
/**
|
|
304
|
+
* Manage unified AI Gateway control-plane resources.
|
|
305
|
+
*
|
|
306
|
+
* @param {string} params.id - id path parameter.
|
|
307
|
+
* @throws {AgentbaseException}
|
|
308
|
+
* @returns {Promise<{}>}
|
|
309
|
+
*/
|
|
310
|
+
listLogicalModelMounts(params: {
|
|
311
|
+
id: string;
|
|
312
|
+
}): Promise<{}>;
|
|
313
|
+
/**
|
|
314
|
+
* Manage unified AI Gateway control-plane resources.
|
|
315
|
+
*
|
|
316
|
+
* @param {string} id - id path parameter.
|
|
317
|
+
* @throws {AgentbaseException}
|
|
318
|
+
* @returns {Promise<{}>}
|
|
319
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
320
|
+
*/
|
|
321
|
+
listLogicalModelMounts(id: string): Promise<{}>;
|
|
322
|
+
/**
|
|
323
|
+
* Manage unified AI Gateway control-plane resources.
|
|
324
|
+
*
|
|
325
|
+
* @param {string} params.id - id path parameter.
|
|
326
|
+
* @throws {AgentbaseException}
|
|
327
|
+
* @returns {Promise<{}>}
|
|
328
|
+
*/
|
|
329
|
+
replaceLogicalModelMounts(params: {
|
|
330
|
+
id: string;
|
|
331
|
+
}): Promise<{}>;
|
|
332
|
+
/**
|
|
333
|
+
* Manage unified AI Gateway control-plane resources.
|
|
334
|
+
*
|
|
335
|
+
* @param {string} id - id path parameter.
|
|
336
|
+
* @throws {AgentbaseException}
|
|
337
|
+
* @returns {Promise<{}>}
|
|
338
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
339
|
+
*/
|
|
340
|
+
replaceLogicalModelMounts(id: string): Promise<{}>;
|
|
303
341
|
/**
|
|
304
342
|
* Manage unified AI Gateway control-plane resources.
|
|
305
343
|
*
|
|
@@ -738,4 +776,23 @@ export declare class AiGateway {
|
|
|
738
776
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
739
777
|
*/
|
|
740
778
|
deleteToolConnection(id: string): Promise<{}>;
|
|
779
|
+
/**
|
|
780
|
+
* Manage unified AI Gateway control-plane resources.
|
|
781
|
+
*
|
|
782
|
+
* @param {string} params.id - id path parameter.
|
|
783
|
+
* @throws {AgentbaseException}
|
|
784
|
+
* @returns {Promise<{}>}
|
|
785
|
+
*/
|
|
786
|
+
testToolConnection(params: {
|
|
787
|
+
id: string;
|
|
788
|
+
}): Promise<{}>;
|
|
789
|
+
/**
|
|
790
|
+
* Manage unified AI Gateway control-plane resources.
|
|
791
|
+
*
|
|
792
|
+
* @param {string} id - id path parameter.
|
|
793
|
+
* @throws {AgentbaseException}
|
|
794
|
+
* @returns {Promise<{}>}
|
|
795
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
796
|
+
*/
|
|
797
|
+
testToolConnection(id: string): Promise<{}>;
|
|
741
798
|
}
|
|
@@ -129,6 +129,8 @@ export declare class Databases {
|
|
|
129
129
|
/**
|
|
130
130
|
* Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
|
|
131
131
|
*
|
|
132
|
+
* When Moderation Phase 2 is enabled, unpublished documents (`checking` / `private_hold` / `quarantined`, and similar intermediate dispositions) are hidden from non-creators. The response `total` is corrected approximately: pure pagination subtracts a collection-wide hidden count (clamped so it never exceeds the visible rows on the current page); filtered queries only subtract hidden rows on the current page, so `total` may still over-count when hidden rows fall on other pages. Privileged users and API keys see unfiltered totals.
|
|
133
|
+
*
|
|
132
134
|
* @param {string} params.databaseId - Database ID.
|
|
133
135
|
* @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration]([HOSTNAME]/docs/server/databases#databasesCreateCollection).
|
|
134
136
|
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries]([HOSTNAME]/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
@@ -150,6 +152,8 @@ export declare class Databases {
|
|
|
150
152
|
/**
|
|
151
153
|
* Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
|
|
152
154
|
*
|
|
155
|
+
* When Moderation Phase 2 is enabled, unpublished documents (`checking` / `private_hold` / `quarantined`, and similar intermediate dispositions) are hidden from non-creators. The response `total` is corrected approximately: pure pagination subtracts a collection-wide hidden count (clamped so it never exceeds the visible rows on the current page); filtered queries only subtract hidden rows on the current page, so `total` may still over-count when hidden rows fall on other pages. Privileged users and API keys see unfiltered totals.
|
|
156
|
+
*
|
|
153
157
|
* @param {string} databaseId - Database ID.
|
|
154
158
|
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration]([HOSTNAME]/docs/server/databases#databasesCreateCollection).
|
|
155
159
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries]([HOSTNAME]/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
@@ -117,6 +117,8 @@ export declare class DocumentsDB {
|
|
|
117
117
|
/**
|
|
118
118
|
* Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
|
|
119
119
|
*
|
|
120
|
+
* When Moderation Phase 2 is enabled, unpublished documents (`checking` / `private_hold` / `quarantined`, and similar intermediate dispositions) are hidden from non-creators. The response `total` is corrected approximately: pure pagination subtracts a collection-wide hidden count (clamped so it never exceeds the visible rows on the current page); filtered queries only subtract hidden rows on the current page, so `total` may still over-count when hidden rows fall on other pages. Privileged users and API keys see unfiltered totals.
|
|
121
|
+
*
|
|
120
122
|
* @param {string} params.databaseId - Database ID.
|
|
121
123
|
* @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration]([HOSTNAME]/docs/server/databases#databasesCreateCollection).
|
|
122
124
|
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries]([HOSTNAME]/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
@@ -137,6 +139,8 @@ export declare class DocumentsDB {
|
|
|
137
139
|
/**
|
|
138
140
|
* Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
|
|
139
141
|
*
|
|
142
|
+
* When Moderation Phase 2 is enabled, unpublished documents (`checking` / `private_hold` / `quarantined`, and similar intermediate dispositions) are hidden from non-creators. The response `total` is corrected approximately: pure pagination subtracts a collection-wide hidden count (clamped so it never exceeds the visible rows on the current page); filtered queries only subtract hidden rows on the current page, so `total` may still over-count when hidden rows fall on other pages. Privileged users and API keys see unfiltered totals.
|
|
143
|
+
*
|
|
140
144
|
* @param {string} databaseId - Database ID.
|
|
141
145
|
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration]([HOSTNAME]/docs/server/databases#databasesCreateCollection).
|
|
142
146
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries]([HOSTNAME]/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
@@ -4,6 +4,62 @@ import { ExecutionMethod } from '../enums/execution-method';
|
|
|
4
4
|
export declare class Functions {
|
|
5
5
|
client: Client;
|
|
6
6
|
constructor(client: Client);
|
|
7
|
+
/**
|
|
8
|
+
* Get a paginated list of distinct request paths from the current user function executions.
|
|
9
|
+
*
|
|
10
|
+
* @param {string} params.functionId - Function ID.
|
|
11
|
+
* @param {number} params.limit - Maximum number of execution paths to return.
|
|
12
|
+
* @param {number} params.offset - Number of execution paths to skip.
|
|
13
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0.
|
|
14
|
+
* @throws {AgentbaseException}
|
|
15
|
+
* @returns {Promise<Models.ExecutionPathList>}
|
|
16
|
+
*/
|
|
17
|
+
listExecutionPaths(params: {
|
|
18
|
+
functionId: string;
|
|
19
|
+
limit?: number;
|
|
20
|
+
offset?: number;
|
|
21
|
+
total?: boolean;
|
|
22
|
+
}): Promise<Models.ExecutionPathList>;
|
|
23
|
+
/**
|
|
24
|
+
* Get a paginated list of distinct request paths from the current user function executions.
|
|
25
|
+
*
|
|
26
|
+
* @param {string} functionId - Function ID.
|
|
27
|
+
* @param {number} limit - Maximum number of execution paths to return.
|
|
28
|
+
* @param {number} offset - Number of execution paths to skip.
|
|
29
|
+
* @param {boolean} total - When set to false, the total count returned will be 0.
|
|
30
|
+
* @throws {AgentbaseException}
|
|
31
|
+
* @returns {Promise<Models.ExecutionPathList>}
|
|
32
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
33
|
+
*/
|
|
34
|
+
listExecutionPaths(functionId: string, limit?: number, offset?: number, total?: boolean): Promise<Models.ExecutionPathList>;
|
|
35
|
+
/**
|
|
36
|
+
* Get a paginated list of function executions whose request path exactly matches the given path.
|
|
37
|
+
*
|
|
38
|
+
* @param {string} params.functionId - Function ID.
|
|
39
|
+
* @param {string} params.xpath - Exact execution request path to match.
|
|
40
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. Maximum of 100 queries are allowed, each 4096 characters long.
|
|
41
|
+
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
42
|
+
* @throws {AgentbaseException}
|
|
43
|
+
* @returns {Promise<Models.ExecutionList>}
|
|
44
|
+
*/
|
|
45
|
+
listExecutionsByPath(params: {
|
|
46
|
+
functionId: string;
|
|
47
|
+
xpath: string;
|
|
48
|
+
queries?: string[];
|
|
49
|
+
total?: boolean;
|
|
50
|
+
}): Promise<Models.ExecutionList>;
|
|
51
|
+
/**
|
|
52
|
+
* Get a paginated list of function executions whose request path exactly matches the given path.
|
|
53
|
+
*
|
|
54
|
+
* @param {string} functionId - Function ID.
|
|
55
|
+
* @param {string} xpath - Exact execution request path to match.
|
|
56
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. Maximum of 100 queries are allowed, each 4096 characters long.
|
|
57
|
+
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
58
|
+
* @throws {AgentbaseException}
|
|
59
|
+
* @returns {Promise<Models.ExecutionList>}
|
|
60
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
61
|
+
*/
|
|
62
|
+
listExecutionsByPath(functionId: string, xpath: string, queries?: string[], total?: boolean): Promise<Models.ExecutionList>;
|
|
7
63
|
/**
|
|
8
64
|
* Get a list of all the current user function execution logs. You can use the query params to filter your results.
|
|
9
65
|
*
|
|
@@ -15,6 +15,7 @@ export declare class KnowledgeBases {
|
|
|
15
15
|
* @param {string} params.sessionId - Yuque OAuth session ID from createYuqueOAuthSession.
|
|
16
16
|
* @param {string[]} params.urls - Yuque document URLs to import. Maximum 20 URLs.
|
|
17
17
|
* @param {string} params.idempotencyKey - Optional batch idempotency key prefix.
|
|
18
|
+
* @param {string} params.versionId - Optional DRAFT Version ID. Required for writes when Versioning is ACTIVE.
|
|
18
19
|
* @throws {AgentbaseException}
|
|
19
20
|
* @returns {Promise<Models.KnowledgeBaseDataSourceDocumentImportBatch>}
|
|
20
21
|
*/
|
|
@@ -23,6 +24,7 @@ export declare class KnowledgeBases {
|
|
|
23
24
|
sessionId: string;
|
|
24
25
|
urls: string[];
|
|
25
26
|
idempotencyKey?: string;
|
|
27
|
+
versionId?: string;
|
|
26
28
|
}): Promise<Models.KnowledgeBaseDataSourceDocumentImportBatch>;
|
|
27
29
|
/**
|
|
28
30
|
* Import the current user's personal Yuque documents by URL using an authorized Yuque OAuth session. No team data source is required. Document ownership uses `source=yuque:personal`.
|
|
@@ -36,11 +38,12 @@ export declare class KnowledgeBases {
|
|
|
36
38
|
* @param {string} sessionId - Yuque OAuth session ID from createYuqueOAuthSession.
|
|
37
39
|
* @param {string[]} urls - Yuque document URLs to import. Maximum 20 URLs.
|
|
38
40
|
* @param {string} idempotencyKey - Optional batch idempotency key prefix.
|
|
41
|
+
* @param {string} versionId - Optional DRAFT Version ID. Required for writes when Versioning is ACTIVE.
|
|
39
42
|
* @throws {AgentbaseException}
|
|
40
43
|
* @returns {Promise<Models.KnowledgeBaseDataSourceDocumentImportBatch>}
|
|
41
44
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
42
45
|
*/
|
|
43
|
-
createYuqueDocuments(knowledgeBaseId: string, sessionId: string, urls: string[], idempotencyKey?: string): Promise<Models.KnowledgeBaseDataSourceDocumentImportBatch>;
|
|
46
|
+
createYuqueDocuments(knowledgeBaseId: string, sessionId: string, urls: string[], idempotencyKey?: string, versionId?: string): Promise<Models.KnowledgeBaseDataSourceDocumentImportBatch>;
|
|
44
47
|
/**
|
|
45
48
|
* Delete the current signed-in user's locally stored Yuque OAuth credential for this project. This endpoint is idempotent and returns `204 No Content` when no credential exists. It removes only the encrypted Agentbase copy; it does not revoke the authorization at Yuque.
|
|
46
49
|
*
|
|
@@ -1528,6 +1528,7 @@ export declare class Memory {
|
|
|
1528
1528
|
* @param {ProfileType} params.profileType - Profile type.
|
|
1529
1529
|
* @param {Models.MemoryMessage[]} params.messages - Typed role/content messages used as source evidence.
|
|
1530
1530
|
* @param {string[]} params.sourceMemoryIds - Existing memory IDs used as replacement evidence.
|
|
1531
|
+
* @param {string} params.sessionId - Optional conversation ID used to correlate profile extraction observability.
|
|
1531
1532
|
* @param {ProfileExtractionMode} params.mode - Incrementally update or replace the profile.
|
|
1532
1533
|
* @throws {AgentbaseException}
|
|
1533
1534
|
* @returns {Promise<{}>}
|
|
@@ -1537,6 +1538,7 @@ export declare class Memory {
|
|
|
1537
1538
|
profileType?: ProfileType;
|
|
1538
1539
|
messages?: Models.MemoryMessage[];
|
|
1539
1540
|
sourceMemoryIds?: string[];
|
|
1541
|
+
sessionId?: string;
|
|
1540
1542
|
mode?: ProfileExtractionMode;
|
|
1541
1543
|
}): Promise<{}>;
|
|
1542
1544
|
/**
|
|
@@ -1546,12 +1548,13 @@ export declare class Memory {
|
|
|
1546
1548
|
* @param {ProfileType} profileType - Profile type.
|
|
1547
1549
|
* @param {Models.MemoryMessage[]} messages - Typed role/content messages used as source evidence.
|
|
1548
1550
|
* @param {string[]} sourceMemoryIds - Existing memory IDs used as replacement evidence.
|
|
1551
|
+
* @param {string} sessionId - Optional conversation ID used to correlate profile extraction observability.
|
|
1549
1552
|
* @param {ProfileExtractionMode} mode - Incrementally update or replace the profile.
|
|
1550
1553
|
* @throws {AgentbaseException}
|
|
1551
1554
|
* @returns {Promise<{}>}
|
|
1552
1555
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1553
1556
|
*/
|
|
1554
|
-
createProfileExtraction(userId: string, profileType?: ProfileType, messages?: Models.MemoryMessage[], sourceMemoryIds?: string[], mode?: ProfileExtractionMode): Promise<{}>;
|
|
1557
|
+
createProfileExtraction(userId: string, profileType?: ProfileType, messages?: Models.MemoryMessage[], sourceMemoryIds?: string[], sessionId?: string, mode?: ProfileExtractionMode): Promise<{}>;
|
|
1555
1558
|
/**
|
|
1556
1559
|
* Create a user memory profile rebuild.
|
|
1557
1560
|
*
|
|
@@ -6,7 +6,10 @@ export declare class Storage {
|
|
|
6
6
|
client: Client;
|
|
7
7
|
constructor(client: Client);
|
|
8
8
|
/**
|
|
9
|
-
* Get a list of
|
|
9
|
+
* Get a list of files allowed by the existing bucket and file permissions.
|
|
10
|
+
*
|
|
11
|
+
* When the bucket has `clientFileListing=false`, application clients (including unauthenticated requests, anonymous sessions, user sessions and JWTs) cannot list files. Authenticated server and project management requests remain subject to project authorization and the `files.read` scope. This setting does not change upload or individual file access permissions. Missing or null values retain the previous listing behavior.
|
|
12
|
+
*
|
|
10
13
|
*
|
|
11
14
|
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration]([HOSTNAME]/docs/server/storage#createBucket).
|
|
12
15
|
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries]([HOSTNAME]/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
|
|
@@ -22,7 +25,10 @@ export declare class Storage {
|
|
|
22
25
|
total?: boolean;
|
|
23
26
|
}): Promise<Models.FileList>;
|
|
24
27
|
/**
|
|
25
|
-
* Get a list of
|
|
28
|
+
* Get a list of files allowed by the existing bucket and file permissions.
|
|
29
|
+
*
|
|
30
|
+
* When the bucket has `clientFileListing=false`, application clients (including unauthenticated requests, anonymous sessions, user sessions and JWTs) cannot list files. Authenticated server and project management requests remain subject to project authorization and the `files.read` scope. This setting does not change upload or individual file access permissions. Missing or null values retain the previous listing behavior.
|
|
31
|
+
*
|
|
26
32
|
*
|
|
27
33
|
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration]([HOSTNAME]/docs/server/storage#createBucket).
|
|
28
34
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries]([HOSTNAME]/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded
|
|
@@ -165,6 +165,8 @@ export declare class TablesDB {
|
|
|
165
165
|
/**
|
|
166
166
|
* Get a list of all the user's rows in a given table. You can use the query params to filter your results.
|
|
167
167
|
*
|
|
168
|
+
* When Moderation Phase 2 is enabled, unpublished rows (`checking` / `private_hold` / `quarantined`, and similar intermediate dispositions) are hidden from non-creators. The response `total` is corrected approximately: pure pagination subtracts a table-wide hidden count (clamped so it never exceeds the visible rows on the current page); filtered queries only subtract hidden rows on the current page, so `total` may still over-count when hidden rows fall on other pages. Privileged users and API keys see unfiltered totals.
|
|
169
|
+
*
|
|
168
170
|
* @param {string} params.databaseId - Database ID.
|
|
169
171
|
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration]([HOSTNAME]/docs/products/databases/tables#create-table).
|
|
170
172
|
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries]([HOSTNAME]/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
@@ -185,6 +187,8 @@ export declare class TablesDB {
|
|
|
185
187
|
/**
|
|
186
188
|
* Get a list of all the user's rows in a given table. You can use the query params to filter your results.
|
|
187
189
|
*
|
|
190
|
+
* When Moderation Phase 2 is enabled, unpublished rows (`checking` / `private_hold` / `quarantined`, and similar intermediate dispositions) are hidden from non-creators. The response `total` is corrected approximately: pure pagination subtracts a table-wide hidden count (clamped so it never exceeds the visible rows on the current page); filtered queries only subtract hidden rows on the current page, so `total` may still over-count when hidden rows fall on other pages. Privileged users and API keys see unfiltered totals.
|
|
191
|
+
*
|
|
188
192
|
* @param {string} databaseId - Database ID.
|
|
189
193
|
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration]([HOSTNAME]/docs/products/databases/tables#create-table).
|
|
190
194
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries]([HOSTNAME]/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|