agentbase-web-sdk 2.6.0-fix1
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/LICENSE +0 -0
- package/README.md +41 -0
- package/dist/cjs/sdk.js +13833 -0
- package/dist/cjs/sdk.js.map +1 -0
- package/dist/esm/sdk.js +13805 -0
- package/dist/esm/sdk.js.map +1 -0
- package/dist/iife/sdk.js +17632 -0
- package/package.json +50 -0
- package/types/channel.d.ts +79 -0
- package/types/client.d.ts +289 -0
- package/types/enums/authentication-factor.d.ts +6 -0
- package/types/enums/authenticator-type.d.ts +3 -0
- package/types/enums/browser-permission.d.ts +22 -0
- package/types/enums/browser.d.ts +16 -0
- package/types/enums/credit-card.d.ts +19 -0
- package/types/enums/distillation-message-role.d.ts +6 -0
- package/types/enums/distillation-mode.d.ts +4 -0
- package/types/enums/distillation-tool-status.d.ts +4 -0
- package/types/enums/execution-method.d.ts +9 -0
- package/types/enums/execution-status.d.ts +7 -0
- package/types/enums/execution-trigger.d.ts +5 -0
- package/types/enums/export-job-mode.d.ts +4 -0
- package/types/enums/export-mode.d.ts +3 -0
- package/types/enums/feedback-type.d.ts +5 -0
- package/types/enums/flag.d.ts +197 -0
- package/types/enums/format.d.ts +4 -0
- package/types/enums/image-format.d.ts +9 -0
- package/types/enums/image-gravity.d.ts +11 -0
- package/types/enums/kind.d.ts +6 -0
- package/types/enums/kinds.d.ts +6 -0
- package/types/enums/knowledge-base-data-source-document-import-result-status.d.ts +5 -0
- package/types/enums/memory-access-mode.d.ts +4 -0
- package/types/enums/memory-batch-operation.d.ts +5 -0
- package/types/enums/memory-bulk-delete-item-status.d.ts +4 -0
- package/types/enums/memory-bulk-delete-response-status.d.ts +4 -0
- package/types/enums/memory-handling-policy.d.ts +5 -0
- package/types/enums/memory-message-role.d.ts +5 -0
- package/types/enums/memory-record-kind.d.ts +5 -0
- package/types/enums/memory-record-sensitivity.d.ts +5 -0
- package/types/enums/memory-scope.d.ts +7 -0
- package/types/enums/memory-sensitivity.d.ts +6 -0
- package/types/enums/memory-share-subject-type.d.ts +4 -0
- package/types/enums/o-auth-provider.d.ts +45 -0
- package/types/enums/organization-project-deletion-deletion-status.d.ts +5 -0
- package/types/enums/organization-role.d.ts +8 -0
- package/types/enums/organization-usage-range.d.ts +5 -0
- package/types/enums/outcome.d.ts +6 -0
- package/types/enums/profile-extraction-mode.d.ts +4 -0
- package/types/enums/profile-type.d.ts +4 -0
- package/types/enums/project-deletion-restore-status.d.ts +3 -0
- package/types/enums/project-deletion-result-deletion-status.d.ts +5 -0
- package/types/enums/project-deletion-result-status.d.ts +5 -0
- package/types/enums/record-kind.d.ts +5 -0
- package/types/enums/retention-policy.d.ts +3 -0
- package/types/enums/scope.d.ts +5 -0
- package/types/enums/source-type.d.ts +6 -0
- package/types/enums/status.d.ts +17 -0
- package/types/enums/theme.d.ts +4 -0
- package/types/enums/timezone.d.ts +422 -0
- package/types/enums/transaction-action.d.ts +12 -0
- package/types/enums/validation-status.d.ts +6 -0
- package/types/enums/verification-source.d.ts +5 -0
- package/types/id.d.ts +20 -0
- package/types/index.d.ts +87 -0
- package/types/models.d.ts +2537 -0
- package/types/operator.d.ts +180 -0
- package/types/permission.d.ts +43 -0
- package/types/query.d.ts +442 -0
- package/types/role.d.ts +70 -0
- package/types/service.d.ts +11 -0
- package/types/services/account.d.ts +1267 -0
- package/types/services/ai-gateway.d.ts +738 -0
- package/types/services/avatars.d.ts +320 -0
- package/types/services/databases.d.ts +437 -0
- package/types/services/documents-db.d.ts +405 -0
- package/types/services/functions.d.ts +91 -0
- package/types/services/graphql.d.ts +43 -0
- package/types/services/knowledge-bases.d.ts +117 -0
- package/types/services/llm-gateway.d.ts +282 -0
- package/types/services/locale.d.ts +64 -0
- package/types/services/memory.d.ts +1765 -0
- package/types/services/messaging.d.ts +53 -0
- package/types/services/projects.d.ts +129 -0
- package/types/services/realtime.d.ts +197 -0
- package/types/services/self-hosted-organizations.d.ts +495 -0
- package/types/services/storage.d.ts +259 -0
- package/types/services/tables-db.d.ts +434 -0
- package/types/services/teams.d.ts +341 -0
- package/types/services/vectors-db.d.ts +297 -0
|
@@ -0,0 +1,1765 @@
|
|
|
1
|
+
import { Client } from '../client';
|
|
2
|
+
import type { Models } from '../models';
|
|
3
|
+
import { MemoryAccessMode } from '../enums/memory-access-mode';
|
|
4
|
+
import { MemoryScope } from '../enums/memory-scope';
|
|
5
|
+
import { RecordKind } from '../enums/record-kind';
|
|
6
|
+
import { MemorySensitivity } from '../enums/memory-sensitivity';
|
|
7
|
+
import { MemoryHandlingPolicy } from '../enums/memory-handling-policy';
|
|
8
|
+
import { Scope } from '../enums/scope';
|
|
9
|
+
import { Status } from '../enums/status';
|
|
10
|
+
import { Kind } from '../enums/kind';
|
|
11
|
+
import { SourceType } from '../enums/source-type';
|
|
12
|
+
import { DistillationMode } from '../enums/distillation-mode';
|
|
13
|
+
import { Format } from '../enums/format';
|
|
14
|
+
import { ExportMode } from '../enums/export-mode';
|
|
15
|
+
import { ExportJobMode } from '../enums/export-job-mode';
|
|
16
|
+
import { FeedbackType } from '../enums/feedback-type';
|
|
17
|
+
import { ValidationStatus } from '../enums/validation-status';
|
|
18
|
+
import { Outcome } from '../enums/outcome';
|
|
19
|
+
import { VerificationSource } from '../enums/verification-source';
|
|
20
|
+
import { Kinds } from '../enums/kinds';
|
|
21
|
+
import { ProfileType } from '../enums/profile-type';
|
|
22
|
+
import { ProfileExtractionMode } from '../enums/profile-extraction-mode';
|
|
23
|
+
import { RetentionPolicy } from '../enums/retention-policy';
|
|
24
|
+
import { MemoryShareSubjectType } from '../enums/memory-share-subject-type';
|
|
25
|
+
export declare class Memory {
|
|
26
|
+
client: Client;
|
|
27
|
+
constructor(client: Client);
|
|
28
|
+
/**
|
|
29
|
+
* Get an asynchronous memory create job by its unique ID.
|
|
30
|
+
*
|
|
31
|
+
* @param {string} params.jobId - Memory create job unique ID.
|
|
32
|
+
* @throws {AgentbaseException}
|
|
33
|
+
* @returns {Promise<{}>}
|
|
34
|
+
*/
|
|
35
|
+
getJob(params: {
|
|
36
|
+
jobId: string;
|
|
37
|
+
}): Promise<{}>;
|
|
38
|
+
/**
|
|
39
|
+
* Get an asynchronous memory create job by its unique ID.
|
|
40
|
+
*
|
|
41
|
+
* @param {string} jobId - Memory create job unique ID.
|
|
42
|
+
* @throws {AgentbaseException}
|
|
43
|
+
* @returns {Promise<{}>}
|
|
44
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
45
|
+
*/
|
|
46
|
+
getJob(jobId: string): Promise<{}>;
|
|
47
|
+
/**
|
|
48
|
+
* List memory records visible to the current caller.
|
|
49
|
+
*
|
|
50
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
51
|
+
* @param {number} params.limit - Maximum number of memories.
|
|
52
|
+
* @param {object} params.filter - Structured memory filter.
|
|
53
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK.
|
|
54
|
+
* @param {string} params.userId - Target user ID.
|
|
55
|
+
* @param {MemoryAccessMode} params.accessMode - Use owned for owner-filtered compatibility or accessible for the authorized visibility union.
|
|
56
|
+
* @throws {AgentbaseException}
|
|
57
|
+
* @returns {Promise<{}>}
|
|
58
|
+
*/
|
|
59
|
+
list(params?: {
|
|
60
|
+
cursor?: string;
|
|
61
|
+
limit?: number;
|
|
62
|
+
filter?: object;
|
|
63
|
+
queries?: string[];
|
|
64
|
+
userId?: string;
|
|
65
|
+
accessMode?: MemoryAccessMode;
|
|
66
|
+
}): Promise<{}>;
|
|
67
|
+
/**
|
|
68
|
+
* List memory records visible to the current caller.
|
|
69
|
+
*
|
|
70
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
71
|
+
* @param {number} limit - Maximum number of memories.
|
|
72
|
+
* @param {object} filter - Structured memory filter.
|
|
73
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK.
|
|
74
|
+
* @param {string} userId - Target user ID.
|
|
75
|
+
* @param {MemoryAccessMode} accessMode - Use owned for owner-filtered compatibility or accessible for the authorized visibility union.
|
|
76
|
+
* @throws {AgentbaseException}
|
|
77
|
+
* @returns {Promise<{}>}
|
|
78
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
79
|
+
*/
|
|
80
|
+
list(cursor?: string, limit?: number, filter?: object, queries?: string[], userId?: string, accessMode?: MemoryAccessMode): Promise<{}>;
|
|
81
|
+
/**
|
|
82
|
+
* Create a memory record.
|
|
83
|
+
*
|
|
84
|
+
* @param {string} params.userId - Target user ID.
|
|
85
|
+
* @param {MemoryScope} params.scope - Memory visibility scope.
|
|
86
|
+
* @param {string} params.memoryType - Memory type. With infer=true, conversation input is retained as source evidence and derived records use long_term.
|
|
87
|
+
* @param {RecordKind} params.recordKind - Memory record kind. With infer=true, conversation input derives fact records.
|
|
88
|
+
* @param {string} params.content - Compatibility memory text. Required when messages are omitted.
|
|
89
|
+
* @param {Models.MemoryMessage[]} params.messages - Optional typed role/content messages used as source evidence.
|
|
90
|
+
* @param {string} params.agentId - Optional agent ID.
|
|
91
|
+
* @param {string} params.runId - Optional run ID.
|
|
92
|
+
* @param {MemorySensitivity} params.sensitivity - Content classification. Secret values must use AppBase Secret or variables.
|
|
93
|
+
* @param {MemoryHandlingPolicy} params.handlingPolicy - Processing restriction. no_model requires infer=false.
|
|
94
|
+
* @param {object} params.metadata - Memory metadata.
|
|
95
|
+
* @param {boolean} params.infer - Use configured model-assisted extraction and cross-type deduplication. Defaults to true.
|
|
96
|
+
* @param {boolean} params.reRemember - Explicitly create new evidence for forgotten content.
|
|
97
|
+
* @param {boolean} params.async - Queue memory creation and return immediately. Defaults to the infer value, so model-assisted writes are asynchronous unless explicitly overridden.
|
|
98
|
+
* @throws {AgentbaseException}
|
|
99
|
+
* @returns {Promise<{}>}
|
|
100
|
+
*/
|
|
101
|
+
create(params: {
|
|
102
|
+
userId: string;
|
|
103
|
+
scope: MemoryScope;
|
|
104
|
+
memoryType: string;
|
|
105
|
+
recordKind: RecordKind;
|
|
106
|
+
content?: string;
|
|
107
|
+
messages?: Models.MemoryMessage[];
|
|
108
|
+
agentId?: string;
|
|
109
|
+
runId?: string;
|
|
110
|
+
sensitivity?: MemorySensitivity;
|
|
111
|
+
handlingPolicy?: MemoryHandlingPolicy;
|
|
112
|
+
metadata?: object;
|
|
113
|
+
infer?: boolean;
|
|
114
|
+
reRemember?: boolean;
|
|
115
|
+
async?: boolean;
|
|
116
|
+
}): Promise<{}>;
|
|
117
|
+
/**
|
|
118
|
+
* Create a memory record.
|
|
119
|
+
*
|
|
120
|
+
* @param {string} userId - Target user ID.
|
|
121
|
+
* @param {MemoryScope} scope - Memory visibility scope.
|
|
122
|
+
* @param {string} memoryType - Memory type. With infer=true, conversation input is retained as source evidence and derived records use long_term.
|
|
123
|
+
* @param {RecordKind} recordKind - Memory record kind. With infer=true, conversation input derives fact records.
|
|
124
|
+
* @param {string} content - Compatibility memory text. Required when messages are omitted.
|
|
125
|
+
* @param {Models.MemoryMessage[]} messages - Optional typed role/content messages used as source evidence.
|
|
126
|
+
* @param {string} agentId - Optional agent ID.
|
|
127
|
+
* @param {string} runId - Optional run ID.
|
|
128
|
+
* @param {MemorySensitivity} sensitivity - Content classification. Secret values must use AppBase Secret or variables.
|
|
129
|
+
* @param {MemoryHandlingPolicy} handlingPolicy - Processing restriction. no_model requires infer=false.
|
|
130
|
+
* @param {object} metadata - Memory metadata.
|
|
131
|
+
* @param {boolean} infer - Use configured model-assisted extraction and cross-type deduplication. Defaults to true.
|
|
132
|
+
* @param {boolean} reRemember - Explicitly create new evidence for forgotten content.
|
|
133
|
+
* @param {boolean} async - Queue memory creation and return immediately. Defaults to the infer value, so model-assisted writes are asynchronous unless explicitly overridden.
|
|
134
|
+
* @throws {AgentbaseException}
|
|
135
|
+
* @returns {Promise<{}>}
|
|
136
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
137
|
+
*/
|
|
138
|
+
create(userId: string, scope: MemoryScope, memoryType: string, recordKind: RecordKind, content?: string, messages?: Models.MemoryMessage[], agentId?: string, runId?: string, sensitivity?: MemorySensitivity, handlingPolicy?: MemoryHandlingPolicy, metadata?: object, infer?: boolean, reRemember?: boolean, async?: boolean): Promise<{}>;
|
|
139
|
+
/**
|
|
140
|
+
* Forget memory records in one bounded pass. Repeat while hasMore is true and inspect failed and items before considering the scope fully deleted.
|
|
141
|
+
*
|
|
142
|
+
* @param {string} params.userId - Target user ID.
|
|
143
|
+
* @param {number} params.limit - Requested upper bound for this pass, from 1 to 500. The service may process fewer records; repeat while hasMore is true.
|
|
144
|
+
* @param {string} params.reason - Forgetting reason.
|
|
145
|
+
* @param {string} params.source - Forgetting source.
|
|
146
|
+
* @throws {AgentbaseException}
|
|
147
|
+
* @returns {Promise<Models.MemoryBulkDeleteResponse>}
|
|
148
|
+
*/
|
|
149
|
+
deleteMany(params?: {
|
|
150
|
+
userId?: string;
|
|
151
|
+
limit?: number;
|
|
152
|
+
reason?: string;
|
|
153
|
+
source?: string;
|
|
154
|
+
}): Promise<Models.MemoryBulkDeleteResponse>;
|
|
155
|
+
/**
|
|
156
|
+
* Forget memory records in one bounded pass. Repeat while hasMore is true and inspect failed and items before considering the scope fully deleted.
|
|
157
|
+
*
|
|
158
|
+
* @param {string} userId - Target user ID.
|
|
159
|
+
* @param {number} limit - Requested upper bound for this pass, from 1 to 500. The service may process fewer records; repeat while hasMore is true.
|
|
160
|
+
* @param {string} reason - Forgetting reason.
|
|
161
|
+
* @param {string} source - Forgetting source.
|
|
162
|
+
* @throws {AgentbaseException}
|
|
163
|
+
* @returns {Promise<Models.MemoryBulkDeleteResponse>}
|
|
164
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
165
|
+
*/
|
|
166
|
+
deleteMany(userId?: string, limit?: number, reason?: string, source?: string): Promise<Models.MemoryBulkDeleteResponse>;
|
|
167
|
+
/**
|
|
168
|
+
* Run a bounded batch of memory operations.
|
|
169
|
+
*
|
|
170
|
+
* @param {Models.MemoryBatchItem[]} params.items - Bounded create, delete, and search operations.
|
|
171
|
+
* @throws {AgentbaseException}
|
|
172
|
+
* @returns {Promise<{}>}
|
|
173
|
+
*/
|
|
174
|
+
createBatch(params: {
|
|
175
|
+
items: Models.MemoryBatchItem[];
|
|
176
|
+
}): Promise<{}>;
|
|
177
|
+
/**
|
|
178
|
+
* Run a bounded batch of memory operations.
|
|
179
|
+
*
|
|
180
|
+
* @param {Models.MemoryBatchItem[]} items - Bounded create, delete, and search operations.
|
|
181
|
+
* @throws {AgentbaseException}
|
|
182
|
+
* @returns {Promise<{}>}
|
|
183
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
184
|
+
*/
|
|
185
|
+
createBatch(items: Models.MemoryBatchItem[]): Promise<{}>;
|
|
186
|
+
/**
|
|
187
|
+
* List Memory context aggregates.
|
|
188
|
+
*
|
|
189
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
190
|
+
* @param {string} params.userId - Target user ID.
|
|
191
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
192
|
+
* @param {string} params.sessionId - Source session ID.
|
|
193
|
+
* @param {string} params.runId - Source run ID.
|
|
194
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
195
|
+
* @param {Status} params.status - Context lifecycle status.
|
|
196
|
+
* @param {Kind} params.kind - Context hierarchy kind.
|
|
197
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
198
|
+
* @param {number} params.limit - Maximum number of contexts.
|
|
199
|
+
* @throws {AgentbaseException}
|
|
200
|
+
* @returns {Promise<{}>}
|
|
201
|
+
*/
|
|
202
|
+
listContexts(params?: {
|
|
203
|
+
scope?: Scope;
|
|
204
|
+
userId?: string;
|
|
205
|
+
agentId?: string;
|
|
206
|
+
sessionId?: string;
|
|
207
|
+
runId?: string;
|
|
208
|
+
memorySubStoreId?: string;
|
|
209
|
+
status?: Status;
|
|
210
|
+
kind?: Kind;
|
|
211
|
+
cursor?: string;
|
|
212
|
+
limit?: number;
|
|
213
|
+
}): Promise<{}>;
|
|
214
|
+
/**
|
|
215
|
+
* List Memory context aggregates.
|
|
216
|
+
*
|
|
217
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
218
|
+
* @param {string} userId - Target user ID.
|
|
219
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
220
|
+
* @param {string} sessionId - Source session ID.
|
|
221
|
+
* @param {string} runId - Source run ID.
|
|
222
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
223
|
+
* @param {Status} status - Context lifecycle status.
|
|
224
|
+
* @param {Kind} kind - Context hierarchy kind.
|
|
225
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
226
|
+
* @param {number} limit - Maximum number of contexts.
|
|
227
|
+
* @throws {AgentbaseException}
|
|
228
|
+
* @returns {Promise<{}>}
|
|
229
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
230
|
+
*/
|
|
231
|
+
listContexts(scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, status?: Status, kind?: Kind, cursor?: string, limit?: number): Promise<{}>;
|
|
232
|
+
/**
|
|
233
|
+
* Scan changed memories and schedule Dreaming.
|
|
234
|
+
*
|
|
235
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
236
|
+
* @param {string} params.userId - Target user ID.
|
|
237
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
238
|
+
* @param {string} params.sessionId - Source session ID.
|
|
239
|
+
* @param {string} params.runId - Source run ID.
|
|
240
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
241
|
+
* @throws {AgentbaseException}
|
|
242
|
+
* @returns {Promise<{}>}
|
|
243
|
+
*/
|
|
244
|
+
createContextRun(params?: {
|
|
245
|
+
scope?: Scope;
|
|
246
|
+
userId?: string;
|
|
247
|
+
agentId?: string;
|
|
248
|
+
sessionId?: string;
|
|
249
|
+
runId?: string;
|
|
250
|
+
memorySubStoreId?: string;
|
|
251
|
+
}): Promise<{}>;
|
|
252
|
+
/**
|
|
253
|
+
* Scan changed memories and schedule Dreaming.
|
|
254
|
+
*
|
|
255
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
256
|
+
* @param {string} userId - Target user ID.
|
|
257
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
258
|
+
* @param {string} sessionId - Source session ID.
|
|
259
|
+
* @param {string} runId - Source run ID.
|
|
260
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
261
|
+
* @throws {AgentbaseException}
|
|
262
|
+
* @returns {Promise<{}>}
|
|
263
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
264
|
+
*/
|
|
265
|
+
createContextRun(scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
266
|
+
/**
|
|
267
|
+
* Get Dreaming watermark and job status.
|
|
268
|
+
*
|
|
269
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
270
|
+
* @param {string} params.userId - Target user ID.
|
|
271
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
272
|
+
* @param {string} params.sessionId - Source session ID.
|
|
273
|
+
* @param {string} params.runId - Source run ID.
|
|
274
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
275
|
+
* @throws {AgentbaseException}
|
|
276
|
+
* @returns {Promise<{}>}
|
|
277
|
+
*/
|
|
278
|
+
getContextStatus(params?: {
|
|
279
|
+
scope?: Scope;
|
|
280
|
+
userId?: string;
|
|
281
|
+
agentId?: string;
|
|
282
|
+
sessionId?: string;
|
|
283
|
+
runId?: string;
|
|
284
|
+
memorySubStoreId?: string;
|
|
285
|
+
}): Promise<{}>;
|
|
286
|
+
/**
|
|
287
|
+
* Get Dreaming watermark and job status.
|
|
288
|
+
*
|
|
289
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
290
|
+
* @param {string} userId - Target user ID.
|
|
291
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
292
|
+
* @param {string} sessionId - Source session ID.
|
|
293
|
+
* @param {string} runId - Source run ID.
|
|
294
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
295
|
+
* @throws {AgentbaseException}
|
|
296
|
+
* @returns {Promise<{}>}
|
|
297
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
298
|
+
*/
|
|
299
|
+
getContextStatus(scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
300
|
+
/**
|
|
301
|
+
* Get one Memory context aggregate.
|
|
302
|
+
*
|
|
303
|
+
* @param {string} params.contextId - Context knowledge ID.
|
|
304
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
305
|
+
* @param {string} params.userId - Target user ID.
|
|
306
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
307
|
+
* @param {string} params.sessionId - Source session ID.
|
|
308
|
+
* @param {string} params.runId - Source run ID.
|
|
309
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
310
|
+
* @throws {AgentbaseException}
|
|
311
|
+
* @returns {Promise<{}>}
|
|
312
|
+
*/
|
|
313
|
+
getContext(params: {
|
|
314
|
+
contextId: string;
|
|
315
|
+
scope?: Scope;
|
|
316
|
+
userId?: string;
|
|
317
|
+
agentId?: string;
|
|
318
|
+
sessionId?: string;
|
|
319
|
+
runId?: string;
|
|
320
|
+
memorySubStoreId?: string;
|
|
321
|
+
}): Promise<{}>;
|
|
322
|
+
/**
|
|
323
|
+
* Get one Memory context aggregate.
|
|
324
|
+
*
|
|
325
|
+
* @param {string} contextId - Context knowledge ID.
|
|
326
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
327
|
+
* @param {string} userId - Target user ID.
|
|
328
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
329
|
+
* @param {string} sessionId - Source session ID.
|
|
330
|
+
* @param {string} runId - Source run ID.
|
|
331
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
332
|
+
* @throws {AgentbaseException}
|
|
333
|
+
* @returns {Promise<{}>}
|
|
334
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
335
|
+
*/
|
|
336
|
+
getContext(contextId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
337
|
+
/**
|
|
338
|
+
* Activate a verified context shadow.
|
|
339
|
+
*
|
|
340
|
+
* @param {string} params.contextId - Context knowledge ID.
|
|
341
|
+
* @param {number} params.expectedVersion - Expected CAS version.
|
|
342
|
+
* @param {string} params.reason - Bounded governance reason.
|
|
343
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
344
|
+
* @param {string} params.userId - Target user ID.
|
|
345
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
346
|
+
* @param {string} params.sessionId - Source session ID.
|
|
347
|
+
* @param {string} params.runId - Source run ID.
|
|
348
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
349
|
+
* @throws {AgentbaseException}
|
|
350
|
+
* @returns {Promise<{}>}
|
|
351
|
+
*/
|
|
352
|
+
confirmContext(params: {
|
|
353
|
+
contextId: string;
|
|
354
|
+
expectedVersion: number;
|
|
355
|
+
reason: string;
|
|
356
|
+
scope?: Scope;
|
|
357
|
+
userId?: string;
|
|
358
|
+
agentId?: string;
|
|
359
|
+
sessionId?: string;
|
|
360
|
+
runId?: string;
|
|
361
|
+
memorySubStoreId?: string;
|
|
362
|
+
}): Promise<{}>;
|
|
363
|
+
/**
|
|
364
|
+
* Activate a verified context shadow.
|
|
365
|
+
*
|
|
366
|
+
* @param {string} contextId - Context knowledge ID.
|
|
367
|
+
* @param {number} expectedVersion - Expected CAS version.
|
|
368
|
+
* @param {string} reason - Bounded governance reason.
|
|
369
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
370
|
+
* @param {string} userId - Target user ID.
|
|
371
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
372
|
+
* @param {string} sessionId - Source session ID.
|
|
373
|
+
* @param {string} runId - Source run ID.
|
|
374
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
375
|
+
* @throws {AgentbaseException}
|
|
376
|
+
* @returns {Promise<{}>}
|
|
377
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
378
|
+
*/
|
|
379
|
+
confirmContext(contextId: string, expectedVersion: number, reason: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
380
|
+
/**
|
|
381
|
+
* Schedule one context for rebuilding.
|
|
382
|
+
*
|
|
383
|
+
* @param {string} params.contextId - Context knowledge ID.
|
|
384
|
+
* @param {string} params.reason - Bounded rebuild reason.
|
|
385
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
386
|
+
* @param {string} params.userId - Target user ID.
|
|
387
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
388
|
+
* @param {string} params.sessionId - Source session ID.
|
|
389
|
+
* @param {string} params.runId - Source run ID.
|
|
390
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
391
|
+
* @throws {AgentbaseException}
|
|
392
|
+
* @returns {Promise<{}>}
|
|
393
|
+
*/
|
|
394
|
+
rebuildContext(params: {
|
|
395
|
+
contextId: string;
|
|
396
|
+
reason: string;
|
|
397
|
+
scope?: Scope;
|
|
398
|
+
userId?: string;
|
|
399
|
+
agentId?: string;
|
|
400
|
+
sessionId?: string;
|
|
401
|
+
runId?: string;
|
|
402
|
+
memorySubStoreId?: string;
|
|
403
|
+
}): Promise<{}>;
|
|
404
|
+
/**
|
|
405
|
+
* Schedule one context for rebuilding.
|
|
406
|
+
*
|
|
407
|
+
* @param {string} contextId - Context knowledge ID.
|
|
408
|
+
* @param {string} reason - Bounded rebuild reason.
|
|
409
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
410
|
+
* @param {string} userId - Target user ID.
|
|
411
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
412
|
+
* @param {string} sessionId - Source session ID.
|
|
413
|
+
* @param {string} runId - Source run ID.
|
|
414
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
415
|
+
* @throws {AgentbaseException}
|
|
416
|
+
* @returns {Promise<{}>}
|
|
417
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
418
|
+
*/
|
|
419
|
+
rebuildContext(contextId: string, reason: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
420
|
+
/**
|
|
421
|
+
* Move an active context to an older verified revision.
|
|
422
|
+
*
|
|
423
|
+
* @param {string} params.contextId - Context knowledge ID.
|
|
424
|
+
* @param {number} params.expectedVersion - Expected CAS version.
|
|
425
|
+
* @param {number} params.targetRevision - Older verified revision number.
|
|
426
|
+
* @param {string} params.reason - Bounded governance reason.
|
|
427
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
428
|
+
* @param {string} params.userId - Target user ID.
|
|
429
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
430
|
+
* @param {string} params.sessionId - Source session ID.
|
|
431
|
+
* @param {string} params.runId - Source run ID.
|
|
432
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
433
|
+
* @throws {AgentbaseException}
|
|
434
|
+
* @returns {Promise<{}>}
|
|
435
|
+
*/
|
|
436
|
+
rollbackContext(params: {
|
|
437
|
+
contextId: string;
|
|
438
|
+
expectedVersion: number;
|
|
439
|
+
targetRevision: number;
|
|
440
|
+
reason: string;
|
|
441
|
+
scope?: Scope;
|
|
442
|
+
userId?: string;
|
|
443
|
+
agentId?: string;
|
|
444
|
+
sessionId?: string;
|
|
445
|
+
runId?: string;
|
|
446
|
+
memorySubStoreId?: string;
|
|
447
|
+
}): Promise<{}>;
|
|
448
|
+
/**
|
|
449
|
+
* Move an active context to an older verified revision.
|
|
450
|
+
*
|
|
451
|
+
* @param {string} contextId - Context knowledge ID.
|
|
452
|
+
* @param {number} expectedVersion - Expected CAS version.
|
|
453
|
+
* @param {number} targetRevision - Older verified revision number.
|
|
454
|
+
* @param {string} reason - Bounded governance reason.
|
|
455
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
456
|
+
* @param {string} userId - Target user ID.
|
|
457
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
458
|
+
* @param {string} sessionId - Source session ID.
|
|
459
|
+
* @param {string} runId - Source run ID.
|
|
460
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
461
|
+
* @throws {AgentbaseException}
|
|
462
|
+
* @returns {Promise<{}>}
|
|
463
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
464
|
+
*/
|
|
465
|
+
rollbackContext(contextId: string, expectedVersion: number, targetRevision: number, reason: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
466
|
+
/**
|
|
467
|
+
* List scoped distillation jobs.
|
|
468
|
+
*
|
|
469
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
470
|
+
* @param {string} params.userId - Target user ID.
|
|
471
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
472
|
+
* @param {string} params.sessionId - Source session ID.
|
|
473
|
+
* @param {string} params.runId - Source run ID.
|
|
474
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
475
|
+
* @param {Status} params.status - Filter by job status.
|
|
476
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
477
|
+
* @param {number} params.limit - Maximum number of distillations.
|
|
478
|
+
* @throws {AgentbaseException}
|
|
479
|
+
* @returns {Promise<{}>}
|
|
480
|
+
*/
|
|
481
|
+
listDistillations(params?: {
|
|
482
|
+
scope?: Scope;
|
|
483
|
+
userId?: string;
|
|
484
|
+
agentId?: string;
|
|
485
|
+
sessionId?: string;
|
|
486
|
+
runId?: string;
|
|
487
|
+
memorySubStoreId?: string;
|
|
488
|
+
status?: Status;
|
|
489
|
+
cursor?: string;
|
|
490
|
+
limit?: number;
|
|
491
|
+
}): Promise<{}>;
|
|
492
|
+
/**
|
|
493
|
+
* List scoped distillation jobs.
|
|
494
|
+
*
|
|
495
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
496
|
+
* @param {string} userId - Target user ID.
|
|
497
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
498
|
+
* @param {string} sessionId - Source session ID.
|
|
499
|
+
* @param {string} runId - Source run ID.
|
|
500
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
501
|
+
* @param {Status} status - Filter by job status.
|
|
502
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
503
|
+
* @param {number} limit - Maximum number of distillations.
|
|
504
|
+
* @throws {AgentbaseException}
|
|
505
|
+
* @returns {Promise<{}>}
|
|
506
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
507
|
+
*/
|
|
508
|
+
listDistillations(scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, status?: Status, cursor?: string, limit?: number): Promise<{}>;
|
|
509
|
+
/**
|
|
510
|
+
* Submit bounded evidence for Experience and Skill distillation, optionally waiting up to 20 seconds.
|
|
511
|
+
*
|
|
512
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
513
|
+
* @param {string} params.userId - Target user ID.
|
|
514
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
515
|
+
* @param {string} params.sessionId - Source session ID.
|
|
516
|
+
* @param {string} params.runId - Source run ID.
|
|
517
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
518
|
+
* @param {string} params.sourceId - Persisted source ID.
|
|
519
|
+
* @param {SourceType} params.sourceType - Persisted source type.
|
|
520
|
+
* @param {Models.DistillationMessage[]} params.messages - Bounded conversation messages.
|
|
521
|
+
* @param {Models.DistillationToolEvent[]} params.toolEvents - Bounded tool execution events.
|
|
522
|
+
* @param {DistillationMode} params.mode - Use async to return immediately or wait to wait up to 20 seconds for a terminal result.
|
|
523
|
+
* @param {string} params.idempotencyKey - Stable key used to deduplicate retries. May be supplied as the Idempotency-Key header.
|
|
524
|
+
* @throws {AgentbaseException}
|
|
525
|
+
* @returns {Promise<{}>}
|
|
526
|
+
*/
|
|
527
|
+
submitDistillation(params?: {
|
|
528
|
+
scope?: Scope;
|
|
529
|
+
userId?: string;
|
|
530
|
+
agentId?: string;
|
|
531
|
+
sessionId?: string;
|
|
532
|
+
runId?: string;
|
|
533
|
+
memorySubStoreId?: string;
|
|
534
|
+
sourceId?: string;
|
|
535
|
+
sourceType?: SourceType;
|
|
536
|
+
messages?: Models.DistillationMessage[];
|
|
537
|
+
toolEvents?: Models.DistillationToolEvent[];
|
|
538
|
+
mode?: DistillationMode;
|
|
539
|
+
idempotencyKey?: string;
|
|
540
|
+
}): Promise<{}>;
|
|
541
|
+
/**
|
|
542
|
+
* Submit bounded evidence for Experience and Skill distillation, optionally waiting up to 20 seconds.
|
|
543
|
+
*
|
|
544
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
545
|
+
* @param {string} userId - Target user ID.
|
|
546
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
547
|
+
* @param {string} sessionId - Source session ID.
|
|
548
|
+
* @param {string} runId - Source run ID.
|
|
549
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
550
|
+
* @param {string} sourceId - Persisted source ID.
|
|
551
|
+
* @param {SourceType} sourceType - Persisted source type.
|
|
552
|
+
* @param {Models.DistillationMessage[]} messages - Bounded conversation messages.
|
|
553
|
+
* @param {Models.DistillationToolEvent[]} toolEvents - Bounded tool execution events.
|
|
554
|
+
* @param {DistillationMode} mode - Use async to return immediately or wait to wait up to 20 seconds for a terminal result.
|
|
555
|
+
* @param {string} idempotencyKey - Stable key used to deduplicate retries. May be supplied as the Idempotency-Key header.
|
|
556
|
+
* @throws {AgentbaseException}
|
|
557
|
+
* @returns {Promise<{}>}
|
|
558
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
559
|
+
*/
|
|
560
|
+
submitDistillation(scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, sourceId?: string, sourceType?: SourceType, messages?: Models.DistillationMessage[], toolEvents?: Models.DistillationToolEvent[], mode?: DistillationMode, idempotencyKey?: string): Promise<{}>;
|
|
561
|
+
/**
|
|
562
|
+
* Get a distillation job and its output references.
|
|
563
|
+
*
|
|
564
|
+
* @param {string} params.distillationId - Distillation unique ID.
|
|
565
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
566
|
+
* @param {string} params.userId - Target user ID.
|
|
567
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
568
|
+
* @param {string} params.sessionId - Source session ID.
|
|
569
|
+
* @param {string} params.runId - Source run ID.
|
|
570
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
571
|
+
* @throws {AgentbaseException}
|
|
572
|
+
* @returns {Promise<{}>}
|
|
573
|
+
*/
|
|
574
|
+
getDistillation(params: {
|
|
575
|
+
distillationId: string;
|
|
576
|
+
scope?: Scope;
|
|
577
|
+
userId?: string;
|
|
578
|
+
agentId?: string;
|
|
579
|
+
sessionId?: string;
|
|
580
|
+
runId?: string;
|
|
581
|
+
memorySubStoreId?: string;
|
|
582
|
+
}): Promise<{}>;
|
|
583
|
+
/**
|
|
584
|
+
* Get a distillation job and its output references.
|
|
585
|
+
*
|
|
586
|
+
* @param {string} distillationId - Distillation unique ID.
|
|
587
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
588
|
+
* @param {string} userId - Target user ID.
|
|
589
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
590
|
+
* @param {string} sessionId - Source session ID.
|
|
591
|
+
* @param {string} runId - Source run ID.
|
|
592
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
593
|
+
* @throws {AgentbaseException}
|
|
594
|
+
* @returns {Promise<{}>}
|
|
595
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
596
|
+
*/
|
|
597
|
+
getDistillation(distillationId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
598
|
+
/**
|
|
599
|
+
* Replay a failed or partial distillation job.
|
|
600
|
+
*
|
|
601
|
+
* @param {string} params.distillationId - Distillation unique ID.
|
|
602
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
603
|
+
* @param {string} params.userId - Target user ID.
|
|
604
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
605
|
+
* @param {string} params.sessionId - Source session ID.
|
|
606
|
+
* @param {string} params.runId - Source run ID.
|
|
607
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
608
|
+
* @throws {AgentbaseException}
|
|
609
|
+
* @returns {Promise<{}>}
|
|
610
|
+
*/
|
|
611
|
+
replayDistillation(params: {
|
|
612
|
+
distillationId: string;
|
|
613
|
+
scope?: Scope;
|
|
614
|
+
userId?: string;
|
|
615
|
+
agentId?: string;
|
|
616
|
+
sessionId?: string;
|
|
617
|
+
runId?: string;
|
|
618
|
+
memorySubStoreId?: string;
|
|
619
|
+
}): Promise<{}>;
|
|
620
|
+
/**
|
|
621
|
+
* Replay a failed or partial distillation job.
|
|
622
|
+
*
|
|
623
|
+
* @param {string} distillationId - Distillation unique ID.
|
|
624
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
625
|
+
* @param {string} userId - Target user ID.
|
|
626
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
627
|
+
* @param {string} sessionId - Source session ID.
|
|
628
|
+
* @param {string} runId - Source run ID.
|
|
629
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
630
|
+
* @throws {AgentbaseException}
|
|
631
|
+
* @returns {Promise<{}>}
|
|
632
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
633
|
+
*/
|
|
634
|
+
replayDistillation(distillationId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
635
|
+
/**
|
|
636
|
+
* List active verified Experiences.
|
|
637
|
+
*
|
|
638
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
639
|
+
* @param {string} params.userId - Target user ID.
|
|
640
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
641
|
+
* @param {string} params.sessionId - Source session ID.
|
|
642
|
+
* @param {string} params.runId - Source run ID.
|
|
643
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
644
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
645
|
+
* @param {number} params.limit - Maximum number of Experiences.
|
|
646
|
+
* @throws {AgentbaseException}
|
|
647
|
+
* @returns {Promise<{}>}
|
|
648
|
+
*/
|
|
649
|
+
listExperiences(params?: {
|
|
650
|
+
scope?: Scope;
|
|
651
|
+
userId?: string;
|
|
652
|
+
agentId?: string;
|
|
653
|
+
sessionId?: string;
|
|
654
|
+
runId?: string;
|
|
655
|
+
memorySubStoreId?: string;
|
|
656
|
+
cursor?: string;
|
|
657
|
+
limit?: number;
|
|
658
|
+
}): Promise<{}>;
|
|
659
|
+
/**
|
|
660
|
+
* List active verified Experiences.
|
|
661
|
+
*
|
|
662
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
663
|
+
* @param {string} userId - Target user ID.
|
|
664
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
665
|
+
* @param {string} sessionId - Source session ID.
|
|
666
|
+
* @param {string} runId - Source run ID.
|
|
667
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
668
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
669
|
+
* @param {number} limit - Maximum number of Experiences.
|
|
670
|
+
* @throws {AgentbaseException}
|
|
671
|
+
* @returns {Promise<{}>}
|
|
672
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
673
|
+
*/
|
|
674
|
+
listExperiences(scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, cursor?: string, limit?: number): Promise<{}>;
|
|
675
|
+
/**
|
|
676
|
+
* Search active verified Experiences using configured recall routes.
|
|
677
|
+
*
|
|
678
|
+
* @param {string} params.query - Semantic search query.
|
|
679
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
680
|
+
* @param {string} params.userId - Target user ID.
|
|
681
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
682
|
+
* @param {string} params.sessionId - Source session ID.
|
|
683
|
+
* @param {string} params.runId - Source run ID.
|
|
684
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
685
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
686
|
+
* @param {number} params.limit - Maximum number of Experiences.
|
|
687
|
+
* @param {object} params.retrieval - Recall route overrides.
|
|
688
|
+
* @throws {AgentbaseException}
|
|
689
|
+
* @returns {Promise<{}>}
|
|
690
|
+
*/
|
|
691
|
+
searchExperiences(params: {
|
|
692
|
+
query: string;
|
|
693
|
+
scope?: Scope;
|
|
694
|
+
userId?: string;
|
|
695
|
+
agentId?: string;
|
|
696
|
+
sessionId?: string;
|
|
697
|
+
runId?: string;
|
|
698
|
+
memorySubStoreId?: string;
|
|
699
|
+
cursor?: string;
|
|
700
|
+
limit?: number;
|
|
701
|
+
retrieval?: object;
|
|
702
|
+
}): Promise<{}>;
|
|
703
|
+
/**
|
|
704
|
+
* Search active verified Experiences using configured recall routes.
|
|
705
|
+
*
|
|
706
|
+
* @param {string} query - Semantic search query.
|
|
707
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
708
|
+
* @param {string} userId - Target user ID.
|
|
709
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
710
|
+
* @param {string} sessionId - Source session ID.
|
|
711
|
+
* @param {string} runId - Source run ID.
|
|
712
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
713
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
714
|
+
* @param {number} limit - Maximum number of Experiences.
|
|
715
|
+
* @param {object} retrieval - Recall route overrides.
|
|
716
|
+
* @throws {AgentbaseException}
|
|
717
|
+
* @returns {Promise<{}>}
|
|
718
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
719
|
+
*/
|
|
720
|
+
searchExperiences(query: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, cursor?: string, limit?: number, retrieval?: object): Promise<{}>;
|
|
721
|
+
/**
|
|
722
|
+
* Get an active verified Experience.
|
|
723
|
+
*
|
|
724
|
+
* @param {string} params.knowledgeId - Experience knowledge ID.
|
|
725
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
726
|
+
* @param {string} params.userId - Target user ID.
|
|
727
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
728
|
+
* @param {string} params.sessionId - Source session ID.
|
|
729
|
+
* @param {string} params.runId - Source run ID.
|
|
730
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
731
|
+
* @throws {AgentbaseException}
|
|
732
|
+
* @returns {Promise<{}>}
|
|
733
|
+
*/
|
|
734
|
+
getExperience(params: {
|
|
735
|
+
knowledgeId: string;
|
|
736
|
+
scope?: Scope;
|
|
737
|
+
userId?: string;
|
|
738
|
+
agentId?: string;
|
|
739
|
+
sessionId?: string;
|
|
740
|
+
runId?: string;
|
|
741
|
+
memorySubStoreId?: string;
|
|
742
|
+
}): Promise<{}>;
|
|
743
|
+
/**
|
|
744
|
+
* Get an active verified Experience.
|
|
745
|
+
*
|
|
746
|
+
* @param {string} knowledgeId - Experience knowledge ID.
|
|
747
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
748
|
+
* @param {string} userId - Target user ID.
|
|
749
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
750
|
+
* @param {string} sessionId - Source session ID.
|
|
751
|
+
* @param {string} runId - Source run ID.
|
|
752
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
753
|
+
* @throws {AgentbaseException}
|
|
754
|
+
* @returns {Promise<{}>}
|
|
755
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
756
|
+
*/
|
|
757
|
+
getExperience(knowledgeId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
758
|
+
/**
|
|
759
|
+
* List immutable provenance sources linked to an Experience.
|
|
760
|
+
*
|
|
761
|
+
* @param {string} params.knowledgeId - Experience knowledge ID.
|
|
762
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
763
|
+
* @param {string} params.userId - Target user ID.
|
|
764
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
765
|
+
* @param {string} params.sessionId - Source session ID.
|
|
766
|
+
* @param {string} params.runId - Source run ID.
|
|
767
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
768
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
769
|
+
* @param {number} params.limit - Maximum sources.
|
|
770
|
+
* @throws {AgentbaseException}
|
|
771
|
+
* @returns {Promise<{}>}
|
|
772
|
+
*/
|
|
773
|
+
listExperienceSources(params: {
|
|
774
|
+
knowledgeId: string;
|
|
775
|
+
scope?: Scope;
|
|
776
|
+
userId?: string;
|
|
777
|
+
agentId?: string;
|
|
778
|
+
sessionId?: string;
|
|
779
|
+
runId?: string;
|
|
780
|
+
memorySubStoreId?: string;
|
|
781
|
+
cursor?: string;
|
|
782
|
+
limit?: number;
|
|
783
|
+
}): Promise<{}>;
|
|
784
|
+
/**
|
|
785
|
+
* List immutable provenance sources linked to an Experience.
|
|
786
|
+
*
|
|
787
|
+
* @param {string} knowledgeId - Experience knowledge ID.
|
|
788
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
789
|
+
* @param {string} userId - Target user ID.
|
|
790
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
791
|
+
* @param {string} sessionId - Source session ID.
|
|
792
|
+
* @param {string} runId - Source run ID.
|
|
793
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
794
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
795
|
+
* @param {number} limit - Maximum sources.
|
|
796
|
+
* @throws {AgentbaseException}
|
|
797
|
+
* @returns {Promise<{}>}
|
|
798
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
799
|
+
*/
|
|
800
|
+
listExperienceSources(knowledgeId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, cursor?: string, limit?: number): Promise<{}>;
|
|
801
|
+
/**
|
|
802
|
+
* Export a bounded set of memories synchronously.
|
|
803
|
+
*
|
|
804
|
+
* @param {string} params.userId - User whose memories are exported.
|
|
805
|
+
* @param {Format} params.format - Export representation.
|
|
806
|
+
* @param {ExportMode} params.mode - Synchronous export mode.
|
|
807
|
+
* @param {boolean} params.includeForgotten - Include forgotten records. Requires system authorization.
|
|
808
|
+
* @param {boolean} params.includeVectors - Include vector projections. Requires system authorization.
|
|
809
|
+
* @param {boolean} params.includeRawSources - Include raw source evidence. Requires system authorization.
|
|
810
|
+
* @throws {AgentbaseException}
|
|
811
|
+
* @returns {Promise<{}>}
|
|
812
|
+
*/
|
|
813
|
+
getExport(params: {
|
|
814
|
+
userId: string;
|
|
815
|
+
format?: Format;
|
|
816
|
+
mode?: ExportMode;
|
|
817
|
+
includeForgotten?: boolean;
|
|
818
|
+
includeVectors?: boolean;
|
|
819
|
+
includeRawSources?: boolean;
|
|
820
|
+
}): Promise<{}>;
|
|
821
|
+
/**
|
|
822
|
+
* Export a bounded set of memories synchronously.
|
|
823
|
+
*
|
|
824
|
+
* @param {string} userId - User whose memories are exported.
|
|
825
|
+
* @param {Format} format - Export representation.
|
|
826
|
+
* @param {ExportMode} mode - Synchronous export mode.
|
|
827
|
+
* @param {boolean} includeForgotten - Include forgotten records. Requires system authorization.
|
|
828
|
+
* @param {boolean} includeVectors - Include vector projections. Requires system authorization.
|
|
829
|
+
* @param {boolean} includeRawSources - Include raw source evidence. Requires system authorization.
|
|
830
|
+
* @throws {AgentbaseException}
|
|
831
|
+
* @returns {Promise<{}>}
|
|
832
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
833
|
+
*/
|
|
834
|
+
getExport(userId: string, format?: Format, mode?: ExportMode, includeForgotten?: boolean, includeVectors?: boolean, includeRawSources?: boolean): Promise<{}>;
|
|
835
|
+
/**
|
|
836
|
+
* Create a memory export job.
|
|
837
|
+
*
|
|
838
|
+
* @param {string} params.userId - User whose memories are exported.
|
|
839
|
+
* @param {Format} params.format - Export representation.
|
|
840
|
+
* @param {boolean} params.includeForgotten - Include forgotten records. Requires system authorization.
|
|
841
|
+
* @param {boolean} params.includeVectors - Include vector projections. Requires system authorization.
|
|
842
|
+
* @param {boolean} params.includeRawSources - Include raw source evidence. Requires system authorization.
|
|
843
|
+
* @param {ExportJobMode} params.mode - Export job execution mode.
|
|
844
|
+
* @throws {AgentbaseException}
|
|
845
|
+
* @returns {Promise<{}>}
|
|
846
|
+
*/
|
|
847
|
+
createExport(params: {
|
|
848
|
+
userId: string;
|
|
849
|
+
format?: Format;
|
|
850
|
+
includeForgotten?: boolean;
|
|
851
|
+
includeVectors?: boolean;
|
|
852
|
+
includeRawSources?: boolean;
|
|
853
|
+
mode?: ExportJobMode;
|
|
854
|
+
}): Promise<{}>;
|
|
855
|
+
/**
|
|
856
|
+
* Create a memory export job.
|
|
857
|
+
*
|
|
858
|
+
* @param {string} userId - User whose memories are exported.
|
|
859
|
+
* @param {Format} format - Export representation.
|
|
860
|
+
* @param {boolean} includeForgotten - Include forgotten records. Requires system authorization.
|
|
861
|
+
* @param {boolean} includeVectors - Include vector projections. Requires system authorization.
|
|
862
|
+
* @param {boolean} includeRawSources - Include raw source evidence. Requires system authorization.
|
|
863
|
+
* @param {ExportJobMode} mode - Export job execution mode.
|
|
864
|
+
* @throws {AgentbaseException}
|
|
865
|
+
* @returns {Promise<{}>}
|
|
866
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
867
|
+
*/
|
|
868
|
+
createExport(userId: string, format?: Format, includeForgotten?: boolean, includeVectors?: boolean, includeRawSources?: boolean, mode?: ExportJobMode): Promise<{}>;
|
|
869
|
+
/**
|
|
870
|
+
* Get a memory export job by its unique ID.
|
|
871
|
+
*
|
|
872
|
+
* @param {string} params.exportId - Memory export job unique ID.
|
|
873
|
+
* @throws {AgentbaseException}
|
|
874
|
+
* @returns {Promise<{}>}
|
|
875
|
+
*/
|
|
876
|
+
getExportJob(params: {
|
|
877
|
+
exportId: string;
|
|
878
|
+
}): Promise<{}>;
|
|
879
|
+
/**
|
|
880
|
+
* Get a memory export job by its unique ID.
|
|
881
|
+
*
|
|
882
|
+
* @param {string} exportId - Memory export job unique ID.
|
|
883
|
+
* @throws {AgentbaseException}
|
|
884
|
+
* @returns {Promise<{}>}
|
|
885
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
886
|
+
*/
|
|
887
|
+
getExportJob(exportId: string): Promise<{}>;
|
|
888
|
+
/**
|
|
889
|
+
* Record feedback for one recalled knowledge revision.
|
|
890
|
+
*
|
|
891
|
+
* @param {string} params.injectionId - Recall injection ID.
|
|
892
|
+
* @param {string} params.knowledgeId - Recalled Skill or Experience knowledge ID. Memory and profile items are not feedback eligible.
|
|
893
|
+
* @param {number} params.revision - Knowledge revision.
|
|
894
|
+
* @param {FeedbackType} params.feedbackType - Feedback type.
|
|
895
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
896
|
+
* @param {string} params.userId - Target user ID.
|
|
897
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
898
|
+
* @param {string} params.sessionId - Source session ID.
|
|
899
|
+
* @param {string} params.runId - Source run ID.
|
|
900
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
901
|
+
* @param {string} params.reasonCode - Optional bounded reason code.
|
|
902
|
+
* @param {string} params.idempotencyKey - Stable key used to deduplicate retries. May be supplied as the Idempotency-Key header.
|
|
903
|
+
* @throws {AgentbaseException}
|
|
904
|
+
* @returns {Promise<{}>}
|
|
905
|
+
*/
|
|
906
|
+
createKnowledgeFeedback(params: {
|
|
907
|
+
injectionId: string;
|
|
908
|
+
knowledgeId: string;
|
|
909
|
+
revision: number;
|
|
910
|
+
feedbackType: FeedbackType;
|
|
911
|
+
scope?: Scope;
|
|
912
|
+
userId?: string;
|
|
913
|
+
agentId?: string;
|
|
914
|
+
sessionId?: string;
|
|
915
|
+
runId?: string;
|
|
916
|
+
memorySubStoreId?: string;
|
|
917
|
+
reasonCode?: string;
|
|
918
|
+
idempotencyKey?: string;
|
|
919
|
+
}): Promise<{}>;
|
|
920
|
+
/**
|
|
921
|
+
* Record feedback for one recalled knowledge revision.
|
|
922
|
+
*
|
|
923
|
+
* @param {string} injectionId - Recall injection ID.
|
|
924
|
+
* @param {string} knowledgeId - Recalled Skill or Experience knowledge ID. Memory and profile items are not feedback eligible.
|
|
925
|
+
* @param {number} revision - Knowledge revision.
|
|
926
|
+
* @param {FeedbackType} feedbackType - Feedback type.
|
|
927
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
928
|
+
* @param {string} userId - Target user ID.
|
|
929
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
930
|
+
* @param {string} sessionId - Source session ID.
|
|
931
|
+
* @param {string} runId - Source run ID.
|
|
932
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
933
|
+
* @param {string} reasonCode - Optional bounded reason code.
|
|
934
|
+
* @param {string} idempotencyKey - Stable key used to deduplicate retries. May be supplied as the Idempotency-Key header.
|
|
935
|
+
* @throws {AgentbaseException}
|
|
936
|
+
* @returns {Promise<{}>}
|
|
937
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
938
|
+
*/
|
|
939
|
+
createKnowledgeFeedback(injectionId: string, knowledgeId: string, revision: number, feedbackType: FeedbackType, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, reasonCode?: string, idempotencyKey?: string): Promise<{}>;
|
|
940
|
+
/**
|
|
941
|
+
* Create a memory import job.
|
|
942
|
+
*
|
|
943
|
+
* @param {string} params.userId - Target user ID.
|
|
944
|
+
* @param {Format} params.format - Import format.
|
|
945
|
+
* @param {string} params.data - Raw JSON or JSONL import data.
|
|
946
|
+
* @param {Models.MemoryRecordInput[]} params.records - Structured memory records.
|
|
947
|
+
* @param {boolean} params.dryRun - Validate without writing records.
|
|
948
|
+
* @throws {AgentbaseException}
|
|
949
|
+
* @returns {Promise<{}>}
|
|
950
|
+
*/
|
|
951
|
+
createImport(params: {
|
|
952
|
+
userId: string;
|
|
953
|
+
format?: Format;
|
|
954
|
+
data?: string;
|
|
955
|
+
records?: Models.MemoryRecordInput[];
|
|
956
|
+
dryRun?: boolean;
|
|
957
|
+
}): Promise<{}>;
|
|
958
|
+
/**
|
|
959
|
+
* Create a memory import job.
|
|
960
|
+
*
|
|
961
|
+
* @param {string} userId - Target user ID.
|
|
962
|
+
* @param {Format} format - Import format.
|
|
963
|
+
* @param {string} data - Raw JSON or JSONL import data.
|
|
964
|
+
* @param {Models.MemoryRecordInput[]} records - Structured memory records.
|
|
965
|
+
* @param {boolean} dryRun - Validate without writing records.
|
|
966
|
+
* @throws {AgentbaseException}
|
|
967
|
+
* @returns {Promise<{}>}
|
|
968
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
969
|
+
*/
|
|
970
|
+
createImport(userId: string, format?: Format, data?: string, records?: Models.MemoryRecordInput[], dryRun?: boolean): Promise<{}>;
|
|
971
|
+
/**
|
|
972
|
+
* Get a memory import job by its unique ID.
|
|
973
|
+
*
|
|
974
|
+
* @param {string} params.importId - Memory import job unique ID.
|
|
975
|
+
* @throws {AgentbaseException}
|
|
976
|
+
* @returns {Promise<{}>}
|
|
977
|
+
*/
|
|
978
|
+
getImport(params: {
|
|
979
|
+
importId: string;
|
|
980
|
+
}): Promise<{}>;
|
|
981
|
+
/**
|
|
982
|
+
* Get a memory import job by its unique ID.
|
|
983
|
+
*
|
|
984
|
+
* @param {string} importId - Memory import job unique ID.
|
|
985
|
+
* @throws {AgentbaseException}
|
|
986
|
+
* @returns {Promise<{}>}
|
|
987
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
988
|
+
*/
|
|
989
|
+
getImport(importId: string): Promise<{}>;
|
|
990
|
+
/**
|
|
991
|
+
* Update managed knowledge state.
|
|
992
|
+
*
|
|
993
|
+
* @param {string} params.knowledgeId - Knowledge ID.
|
|
994
|
+
* @param {number} params.expectedVersion - Expected CAS version.
|
|
995
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
996
|
+
* @param {string} params.userId - Target user ID.
|
|
997
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
998
|
+
* @param {string} params.sessionId - Source session ID.
|
|
999
|
+
* @param {string} params.runId - Source run ID.
|
|
1000
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1001
|
+
* @param {Status} params.status - Target knowledge status.
|
|
1002
|
+
* @param {ValidationStatus} params.validationStatus - Target validation status.
|
|
1003
|
+
* @throws {AgentbaseException}
|
|
1004
|
+
* @returns {Promise<{}>}
|
|
1005
|
+
*/
|
|
1006
|
+
updateKnowledge(params: {
|
|
1007
|
+
knowledgeId: string;
|
|
1008
|
+
expectedVersion: number;
|
|
1009
|
+
scope?: Scope;
|
|
1010
|
+
userId?: string;
|
|
1011
|
+
agentId?: string;
|
|
1012
|
+
sessionId?: string;
|
|
1013
|
+
runId?: string;
|
|
1014
|
+
memorySubStoreId?: string;
|
|
1015
|
+
status?: Status;
|
|
1016
|
+
validationStatus?: ValidationStatus;
|
|
1017
|
+
}): Promise<{}>;
|
|
1018
|
+
/**
|
|
1019
|
+
* Update managed knowledge state.
|
|
1020
|
+
*
|
|
1021
|
+
* @param {string} knowledgeId - Knowledge ID.
|
|
1022
|
+
* @param {number} expectedVersion - Expected CAS version.
|
|
1023
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1024
|
+
* @param {string} userId - Target user ID.
|
|
1025
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1026
|
+
* @param {string} sessionId - Source session ID.
|
|
1027
|
+
* @param {string} runId - Source run ID.
|
|
1028
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1029
|
+
* @param {Status} status - Target knowledge status.
|
|
1030
|
+
* @param {ValidationStatus} validationStatus - Target validation status.
|
|
1031
|
+
* @throws {AgentbaseException}
|
|
1032
|
+
* @returns {Promise<{}>}
|
|
1033
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1034
|
+
*/
|
|
1035
|
+
updateKnowledge(knowledgeId: string, expectedVersion: number, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, status?: Status, validationStatus?: ValidationStatus): Promise<{}>;
|
|
1036
|
+
/**
|
|
1037
|
+
* Write the metadata forgetting marker for managed knowledge.
|
|
1038
|
+
*
|
|
1039
|
+
* @param {string} params.knowledgeId - Knowledge ID.
|
|
1040
|
+
* @param {number} params.expectedVersion - Expected CAS version.
|
|
1041
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1042
|
+
* @param {string} params.userId - Target user ID.
|
|
1043
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1044
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1045
|
+
* @param {string} params.runId - Source run ID.
|
|
1046
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1047
|
+
* @param {string} params.reason - Forgetting reason.
|
|
1048
|
+
* @param {string} params.source - Forgetting marker source.
|
|
1049
|
+
* @throws {AgentbaseException}
|
|
1050
|
+
* @returns {Promise<{}>}
|
|
1051
|
+
*/
|
|
1052
|
+
forgetKnowledge(params: {
|
|
1053
|
+
knowledgeId: string;
|
|
1054
|
+
expectedVersion: number;
|
|
1055
|
+
scope?: Scope;
|
|
1056
|
+
userId?: string;
|
|
1057
|
+
agentId?: string;
|
|
1058
|
+
sessionId?: string;
|
|
1059
|
+
runId?: string;
|
|
1060
|
+
memorySubStoreId?: string;
|
|
1061
|
+
reason?: string;
|
|
1062
|
+
source?: string;
|
|
1063
|
+
}): Promise<{}>;
|
|
1064
|
+
/**
|
|
1065
|
+
* Write the metadata forgetting marker for managed knowledge.
|
|
1066
|
+
*
|
|
1067
|
+
* @param {string} knowledgeId - Knowledge ID.
|
|
1068
|
+
* @param {number} expectedVersion - Expected CAS version.
|
|
1069
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1070
|
+
* @param {string} userId - Target user ID.
|
|
1071
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1072
|
+
* @param {string} sessionId - Source session ID.
|
|
1073
|
+
* @param {string} runId - Source run ID.
|
|
1074
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1075
|
+
* @param {string} reason - Forgetting reason.
|
|
1076
|
+
* @param {string} source - Forgetting marker source.
|
|
1077
|
+
* @throws {AgentbaseException}
|
|
1078
|
+
* @returns {Promise<{}>}
|
|
1079
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1080
|
+
*/
|
|
1081
|
+
forgetKnowledge(knowledgeId: string, expectedVersion: number, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, reason?: string, source?: string): Promise<{}>;
|
|
1082
|
+
/**
|
|
1083
|
+
* Record bounded evidence for a knowledge revision.
|
|
1084
|
+
*
|
|
1085
|
+
* @param {string} params.knowledgeId - Knowledge ID.
|
|
1086
|
+
* @param {number} params.revision - Knowledge revision.
|
|
1087
|
+
* @param {Outcome} params.outcome - Observed outcome.
|
|
1088
|
+
* @param {object} params.evidence - Bounded observation evidence.
|
|
1089
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1090
|
+
* @param {string} params.userId - Target user ID.
|
|
1091
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1092
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1093
|
+
* @param {string} params.runId - Source run ID.
|
|
1094
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1095
|
+
* @param {string} params.sourceId - Evidence source ID.
|
|
1096
|
+
* @param {string} params.injectionId - Recall injection ID.
|
|
1097
|
+
* @param {VerificationSource} params.verificationSource - Deprecated caller hint; AppBase derives the trusted source from authentication.
|
|
1098
|
+
* @param {string} params.toolName - Tool name.
|
|
1099
|
+
* @param {string} params.toolVersion - Tool version.
|
|
1100
|
+
* @param {string} params.toolSchemaVersion - Tool schema version.
|
|
1101
|
+
* @param {string} params.errorFingerprint - Bounded error fingerprint.
|
|
1102
|
+
* @param {number} params.weight - Deprecated caller hint; AppBase derives the trusted weight from authentication.
|
|
1103
|
+
* @param {string} params.observedAt - Observation timestamp.
|
|
1104
|
+
* @param {string} params.idempotencyKey - Stable key used to deduplicate retries. May be supplied as the Idempotency-Key header.
|
|
1105
|
+
* @throws {AgentbaseException}
|
|
1106
|
+
* @returns {Promise<{}>}
|
|
1107
|
+
*/
|
|
1108
|
+
createKnowledgeObservation(params: {
|
|
1109
|
+
knowledgeId: string;
|
|
1110
|
+
revision: number;
|
|
1111
|
+
outcome: Outcome;
|
|
1112
|
+
evidence: object;
|
|
1113
|
+
scope?: Scope;
|
|
1114
|
+
userId?: string;
|
|
1115
|
+
agentId?: string;
|
|
1116
|
+
sessionId?: string;
|
|
1117
|
+
runId?: string;
|
|
1118
|
+
memorySubStoreId?: string;
|
|
1119
|
+
sourceId?: string;
|
|
1120
|
+
injectionId?: string;
|
|
1121
|
+
verificationSource?: VerificationSource;
|
|
1122
|
+
toolName?: string;
|
|
1123
|
+
toolVersion?: string;
|
|
1124
|
+
toolSchemaVersion?: string;
|
|
1125
|
+
errorFingerprint?: string;
|
|
1126
|
+
weight?: number;
|
|
1127
|
+
observedAt?: string;
|
|
1128
|
+
idempotencyKey?: string;
|
|
1129
|
+
}): Promise<{}>;
|
|
1130
|
+
/**
|
|
1131
|
+
* Record bounded evidence for a knowledge revision.
|
|
1132
|
+
*
|
|
1133
|
+
* @param {string} knowledgeId - Knowledge ID.
|
|
1134
|
+
* @param {number} revision - Knowledge revision.
|
|
1135
|
+
* @param {Outcome} outcome - Observed outcome.
|
|
1136
|
+
* @param {object} evidence - Bounded observation evidence.
|
|
1137
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1138
|
+
* @param {string} userId - Target user ID.
|
|
1139
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1140
|
+
* @param {string} sessionId - Source session ID.
|
|
1141
|
+
* @param {string} runId - Source run ID.
|
|
1142
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1143
|
+
* @param {string} sourceId - Evidence source ID.
|
|
1144
|
+
* @param {string} injectionId - Recall injection ID.
|
|
1145
|
+
* @param {VerificationSource} verificationSource - Deprecated caller hint; AppBase derives the trusted source from authentication.
|
|
1146
|
+
* @param {string} toolName - Tool name.
|
|
1147
|
+
* @param {string} toolVersion - Tool version.
|
|
1148
|
+
* @param {string} toolSchemaVersion - Tool schema version.
|
|
1149
|
+
* @param {string} errorFingerprint - Bounded error fingerprint.
|
|
1150
|
+
* @param {number} weight - Deprecated caller hint; AppBase derives the trusted weight from authentication.
|
|
1151
|
+
* @param {string} observedAt - Observation timestamp.
|
|
1152
|
+
* @param {string} idempotencyKey - Stable key used to deduplicate retries. May be supplied as the Idempotency-Key header.
|
|
1153
|
+
* @throws {AgentbaseException}
|
|
1154
|
+
* @returns {Promise<{}>}
|
|
1155
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1156
|
+
*/
|
|
1157
|
+
createKnowledgeObservation(knowledgeId: string, revision: number, outcome: Outcome, evidence: object, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, sourceId?: string, injectionId?: string, verificationSource?: VerificationSource, toolName?: string, toolVersion?: string, toolSchemaVersion?: string, errorFingerprint?: string, weight?: number, observedAt?: string, idempotencyKey?: string): Promise<{}>;
|
|
1158
|
+
/**
|
|
1159
|
+
* Get a memory quality report.
|
|
1160
|
+
*
|
|
1161
|
+
* @throws {AgentbaseException}
|
|
1162
|
+
* @returns {Promise<{}>}
|
|
1163
|
+
*/
|
|
1164
|
+
getQuality(): Promise<{}>;
|
|
1165
|
+
/**
|
|
1166
|
+
* Recall memories, profiles, Skills, and Experiences under one token budget.
|
|
1167
|
+
*
|
|
1168
|
+
* @param {string} params.query - Recall query.
|
|
1169
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1170
|
+
* @param {string} params.userId - Target user ID.
|
|
1171
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1172
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1173
|
+
* @param {string} params.runId - Source run ID.
|
|
1174
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1175
|
+
* @param {Kinds[]} params.kinds - Knowledge kinds to recall.
|
|
1176
|
+
* @param {number} params.limit - Maximum number of recalled items.
|
|
1177
|
+
* @param {number} params.tokenBudget - Maximum context token budget.
|
|
1178
|
+
* @param {object} params.retrieval - Recall route overrides.
|
|
1179
|
+
* @param {MemoryAccessMode} params.accessMode - Use owned for owner-filtered compatibility or accessible for the authorized visibility union.
|
|
1180
|
+
* @throws {AgentbaseException}
|
|
1181
|
+
* @returns {Promise<{}>}
|
|
1182
|
+
*/
|
|
1183
|
+
recallKnowledge(params: {
|
|
1184
|
+
query: string;
|
|
1185
|
+
scope?: Scope;
|
|
1186
|
+
userId?: string;
|
|
1187
|
+
agentId?: string;
|
|
1188
|
+
sessionId?: string;
|
|
1189
|
+
runId?: string;
|
|
1190
|
+
memorySubStoreId?: string;
|
|
1191
|
+
kinds?: Kinds[];
|
|
1192
|
+
limit?: number;
|
|
1193
|
+
tokenBudget?: number;
|
|
1194
|
+
retrieval?: object;
|
|
1195
|
+
accessMode?: MemoryAccessMode;
|
|
1196
|
+
}): Promise<{}>;
|
|
1197
|
+
/**
|
|
1198
|
+
* Recall memories, profiles, Skills, and Experiences under one token budget.
|
|
1199
|
+
*
|
|
1200
|
+
* @param {string} query - Recall query.
|
|
1201
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1202
|
+
* @param {string} userId - Target user ID.
|
|
1203
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1204
|
+
* @param {string} sessionId - Source session ID.
|
|
1205
|
+
* @param {string} runId - Source run ID.
|
|
1206
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1207
|
+
* @param {Kinds[]} kinds - Knowledge kinds to recall.
|
|
1208
|
+
* @param {number} limit - Maximum number of recalled items.
|
|
1209
|
+
* @param {number} tokenBudget - Maximum context token budget.
|
|
1210
|
+
* @param {object} retrieval - Recall route overrides.
|
|
1211
|
+
* @param {MemoryAccessMode} accessMode - Use owned for owner-filtered compatibility or accessible for the authorized visibility union.
|
|
1212
|
+
* @throws {AgentbaseException}
|
|
1213
|
+
* @returns {Promise<{}>}
|
|
1214
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1215
|
+
*/
|
|
1216
|
+
recallKnowledge(query: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, kinds?: Kinds[], limit?: number, tokenBudget?: number, retrieval?: object, accessMode?: MemoryAccessMode): Promise<{}>;
|
|
1217
|
+
/**
|
|
1218
|
+
* Search memory records visible to the current caller.
|
|
1219
|
+
*
|
|
1220
|
+
* @param {string} params.query - Search query.
|
|
1221
|
+
* @param {string} params.searchMode - Recall mode override.
|
|
1222
|
+
* @param {object} params.retrieval - Recall route overrides. sparse=false skips model-generated sparse recall for this request; omitted defaults to the project setting.
|
|
1223
|
+
* @param {string} params.userId - Target user ID.
|
|
1224
|
+
* @param {string} params.agentId - Agent ID filter.
|
|
1225
|
+
* @param {string} params.runId - Run ID filter.
|
|
1226
|
+
* @param {string} params.scope - Scope filter.
|
|
1227
|
+
* @param {string} params.memoryType - Memory type filter.
|
|
1228
|
+
* @param {string} params.recordKind - Record kind filter.
|
|
1229
|
+
* @param {object} params.filter - Structured memory filter.
|
|
1230
|
+
* @param {number} params.limit - Maximum results; zero uses the project default.
|
|
1231
|
+
* @param {string} params.cursor - Pagination cursor.
|
|
1232
|
+
* @param {string} params.sort - Sort mode.
|
|
1233
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1234
|
+
* @param {string} params.sessionId - Session ID filter.
|
|
1235
|
+
* @param {string} params.groupId - Group or entity boundary filter.
|
|
1236
|
+
* @param {MemoryAccessMode} params.accessMode - Use owned for owner-filtered compatibility or accessible for the authorized visibility union.
|
|
1237
|
+
* @throws {AgentbaseException}
|
|
1238
|
+
* @returns {Promise<{}>}
|
|
1239
|
+
*/
|
|
1240
|
+
search(params: {
|
|
1241
|
+
query: string;
|
|
1242
|
+
searchMode?: string;
|
|
1243
|
+
retrieval?: object;
|
|
1244
|
+
userId?: string;
|
|
1245
|
+
agentId?: string;
|
|
1246
|
+
runId?: string;
|
|
1247
|
+
scope?: string;
|
|
1248
|
+
memoryType?: string;
|
|
1249
|
+
recordKind?: string;
|
|
1250
|
+
filter?: object;
|
|
1251
|
+
limit?: number;
|
|
1252
|
+
cursor?: string;
|
|
1253
|
+
sort?: string;
|
|
1254
|
+
memorySubStoreId?: string;
|
|
1255
|
+
sessionId?: string;
|
|
1256
|
+
groupId?: string;
|
|
1257
|
+
accessMode?: MemoryAccessMode;
|
|
1258
|
+
}): Promise<{}>;
|
|
1259
|
+
/**
|
|
1260
|
+
* Search memory records visible to the current caller.
|
|
1261
|
+
*
|
|
1262
|
+
* @param {string} query - Search query.
|
|
1263
|
+
* @param {string} searchMode - Recall mode override.
|
|
1264
|
+
* @param {object} retrieval - Recall route overrides. sparse=false skips model-generated sparse recall for this request; omitted defaults to the project setting.
|
|
1265
|
+
* @param {string} userId - Target user ID.
|
|
1266
|
+
* @param {string} agentId - Agent ID filter.
|
|
1267
|
+
* @param {string} runId - Run ID filter.
|
|
1268
|
+
* @param {string} scope - Scope filter.
|
|
1269
|
+
* @param {string} memoryType - Memory type filter.
|
|
1270
|
+
* @param {string} recordKind - Record kind filter.
|
|
1271
|
+
* @param {object} filter - Structured memory filter.
|
|
1272
|
+
* @param {number} limit - Maximum results; zero uses the project default.
|
|
1273
|
+
* @param {string} cursor - Pagination cursor.
|
|
1274
|
+
* @param {string} sort - Sort mode.
|
|
1275
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1276
|
+
* @param {string} sessionId - Session ID filter.
|
|
1277
|
+
* @param {string} groupId - Group or entity boundary filter.
|
|
1278
|
+
* @param {MemoryAccessMode} accessMode - Use owned for owner-filtered compatibility or accessible for the authorized visibility union.
|
|
1279
|
+
* @throws {AgentbaseException}
|
|
1280
|
+
* @returns {Promise<{}>}
|
|
1281
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1282
|
+
*/
|
|
1283
|
+
search(query: string, searchMode?: string, retrieval?: object, userId?: string, agentId?: string, runId?: string, scope?: string, memoryType?: string, recordKind?: string, filter?: object, limit?: number, cursor?: string, sort?: string, memorySubStoreId?: string, sessionId?: string, groupId?: string, accessMode?: MemoryAccessMode): Promise<{}>;
|
|
1284
|
+
/**
|
|
1285
|
+
* Get memory session aggregates.
|
|
1286
|
+
*
|
|
1287
|
+
* @throws {AgentbaseException}
|
|
1288
|
+
* @returns {Promise<{}>}
|
|
1289
|
+
*/
|
|
1290
|
+
getSessions(): Promise<{}>;
|
|
1291
|
+
/**
|
|
1292
|
+
* List active verified Skills.
|
|
1293
|
+
*
|
|
1294
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1295
|
+
* @param {string} params.userId - Target user ID.
|
|
1296
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1297
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1298
|
+
* @param {string} params.runId - Source run ID.
|
|
1299
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1300
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
1301
|
+
* @param {number} params.limit - Maximum number of Skills.
|
|
1302
|
+
* @throws {AgentbaseException}
|
|
1303
|
+
* @returns {Promise<{}>}
|
|
1304
|
+
*/
|
|
1305
|
+
listSkills(params?: {
|
|
1306
|
+
scope?: Scope;
|
|
1307
|
+
userId?: string;
|
|
1308
|
+
agentId?: string;
|
|
1309
|
+
sessionId?: string;
|
|
1310
|
+
runId?: string;
|
|
1311
|
+
memorySubStoreId?: string;
|
|
1312
|
+
cursor?: string;
|
|
1313
|
+
limit?: number;
|
|
1314
|
+
}): Promise<{}>;
|
|
1315
|
+
/**
|
|
1316
|
+
* List active verified Skills.
|
|
1317
|
+
*
|
|
1318
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1319
|
+
* @param {string} userId - Target user ID.
|
|
1320
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1321
|
+
* @param {string} sessionId - Source session ID.
|
|
1322
|
+
* @param {string} runId - Source run ID.
|
|
1323
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1324
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
1325
|
+
* @param {number} limit - Maximum number of Skills.
|
|
1326
|
+
* @throws {AgentbaseException}
|
|
1327
|
+
* @returns {Promise<{}>}
|
|
1328
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1329
|
+
*/
|
|
1330
|
+
listSkills(scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, cursor?: string, limit?: number): Promise<{}>;
|
|
1331
|
+
/**
|
|
1332
|
+
* Search active verified Skills using configured recall routes.
|
|
1333
|
+
*
|
|
1334
|
+
* @param {string} params.query - Semantic search query.
|
|
1335
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1336
|
+
* @param {string} params.userId - Target user ID.
|
|
1337
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1338
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1339
|
+
* @param {string} params.runId - Source run ID.
|
|
1340
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1341
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
1342
|
+
* @param {number} params.limit - Maximum number of Skills.
|
|
1343
|
+
* @param {object} params.retrieval - Recall route overrides.
|
|
1344
|
+
* @throws {AgentbaseException}
|
|
1345
|
+
* @returns {Promise<{}>}
|
|
1346
|
+
*/
|
|
1347
|
+
searchSkills(params: {
|
|
1348
|
+
query: string;
|
|
1349
|
+
scope?: Scope;
|
|
1350
|
+
userId?: string;
|
|
1351
|
+
agentId?: string;
|
|
1352
|
+
sessionId?: string;
|
|
1353
|
+
runId?: string;
|
|
1354
|
+
memorySubStoreId?: string;
|
|
1355
|
+
cursor?: string;
|
|
1356
|
+
limit?: number;
|
|
1357
|
+
retrieval?: object;
|
|
1358
|
+
}): Promise<{}>;
|
|
1359
|
+
/**
|
|
1360
|
+
* Search active verified Skills using configured recall routes.
|
|
1361
|
+
*
|
|
1362
|
+
* @param {string} query - Semantic search query.
|
|
1363
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1364
|
+
* @param {string} userId - Target user ID.
|
|
1365
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1366
|
+
* @param {string} sessionId - Source session ID.
|
|
1367
|
+
* @param {string} runId - Source run ID.
|
|
1368
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1369
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
1370
|
+
* @param {number} limit - Maximum number of Skills.
|
|
1371
|
+
* @param {object} retrieval - Recall route overrides.
|
|
1372
|
+
* @throws {AgentbaseException}
|
|
1373
|
+
* @returns {Promise<{}>}
|
|
1374
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1375
|
+
*/
|
|
1376
|
+
searchSkills(query: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, cursor?: string, limit?: number, retrieval?: object): Promise<{}>;
|
|
1377
|
+
/**
|
|
1378
|
+
* Get an active verified Skill.
|
|
1379
|
+
*
|
|
1380
|
+
* @param {string} params.knowledgeId - Skill knowledge ID.
|
|
1381
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1382
|
+
* @param {string} params.userId - Target user ID.
|
|
1383
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1384
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1385
|
+
* @param {string} params.runId - Source run ID.
|
|
1386
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1387
|
+
* @throws {AgentbaseException}
|
|
1388
|
+
* @returns {Promise<{}>}
|
|
1389
|
+
*/
|
|
1390
|
+
getSkill(params: {
|
|
1391
|
+
knowledgeId: string;
|
|
1392
|
+
scope?: Scope;
|
|
1393
|
+
userId?: string;
|
|
1394
|
+
agentId?: string;
|
|
1395
|
+
sessionId?: string;
|
|
1396
|
+
runId?: string;
|
|
1397
|
+
memorySubStoreId?: string;
|
|
1398
|
+
}): Promise<{}>;
|
|
1399
|
+
/**
|
|
1400
|
+
* Get an active verified Skill.
|
|
1401
|
+
*
|
|
1402
|
+
* @param {string} knowledgeId - Skill knowledge ID.
|
|
1403
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1404
|
+
* @param {string} userId - Target user ID.
|
|
1405
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1406
|
+
* @param {string} sessionId - Source session ID.
|
|
1407
|
+
* @param {string} runId - Source run ID.
|
|
1408
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1409
|
+
* @throws {AgentbaseException}
|
|
1410
|
+
* @returns {Promise<{}>}
|
|
1411
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1412
|
+
*/
|
|
1413
|
+
getSkill(knowledgeId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
1414
|
+
/**
|
|
1415
|
+
* List immutable provenance sources linked to a Skill.
|
|
1416
|
+
*
|
|
1417
|
+
* @param {string} params.knowledgeId - Skill knowledge ID.
|
|
1418
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1419
|
+
* @param {string} params.userId - Target user ID.
|
|
1420
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1421
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1422
|
+
* @param {string} params.runId - Source run ID.
|
|
1423
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1424
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
1425
|
+
* @param {number} params.limit - Maximum sources.
|
|
1426
|
+
* @throws {AgentbaseException}
|
|
1427
|
+
* @returns {Promise<{}>}
|
|
1428
|
+
*/
|
|
1429
|
+
listSkillSources(params: {
|
|
1430
|
+
knowledgeId: string;
|
|
1431
|
+
scope?: Scope;
|
|
1432
|
+
userId?: string;
|
|
1433
|
+
agentId?: string;
|
|
1434
|
+
sessionId?: string;
|
|
1435
|
+
runId?: string;
|
|
1436
|
+
memorySubStoreId?: string;
|
|
1437
|
+
cursor?: string;
|
|
1438
|
+
limit?: number;
|
|
1439
|
+
}): Promise<{}>;
|
|
1440
|
+
/**
|
|
1441
|
+
* List immutable provenance sources linked to a Skill.
|
|
1442
|
+
*
|
|
1443
|
+
* @param {string} knowledgeId - Skill knowledge ID.
|
|
1444
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1445
|
+
* @param {string} userId - Target user ID.
|
|
1446
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1447
|
+
* @param {string} sessionId - Source session ID.
|
|
1448
|
+
* @param {string} runId - Source run ID.
|
|
1449
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1450
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
1451
|
+
* @param {number} limit - Maximum sources.
|
|
1452
|
+
* @throws {AgentbaseException}
|
|
1453
|
+
* @returns {Promise<{}>}
|
|
1454
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1455
|
+
*/
|
|
1456
|
+
listSkillSources(knowledgeId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, cursor?: string, limit?: number): Promise<{}>;
|
|
1457
|
+
/**
|
|
1458
|
+
* Get memory statistics visible to the current caller.
|
|
1459
|
+
*
|
|
1460
|
+
* @throws {AgentbaseException}
|
|
1461
|
+
* @returns {Promise<{}>}
|
|
1462
|
+
*/
|
|
1463
|
+
getStats(): Promise<{}>;
|
|
1464
|
+
/**
|
|
1465
|
+
* Get a memory activity timeline.
|
|
1466
|
+
*
|
|
1467
|
+
* @throws {AgentbaseException}
|
|
1468
|
+
* @returns {Promise<{}>}
|
|
1469
|
+
*/
|
|
1470
|
+
getTimeline(): Promise<{}>;
|
|
1471
|
+
/**
|
|
1472
|
+
* Get a user memory profile.
|
|
1473
|
+
*
|
|
1474
|
+
* @param {string} params.userId - Target user ID.
|
|
1475
|
+
* @param {ProfileType} params.profileType - Profile type.
|
|
1476
|
+
* @throws {AgentbaseException}
|
|
1477
|
+
* @returns {Promise<{}>}
|
|
1478
|
+
*/
|
|
1479
|
+
getProfile(params: {
|
|
1480
|
+
userId: string;
|
|
1481
|
+
profileType?: ProfileType;
|
|
1482
|
+
}): Promise<{}>;
|
|
1483
|
+
/**
|
|
1484
|
+
* Get a user memory profile.
|
|
1485
|
+
*
|
|
1486
|
+
* @param {string} userId - Target user ID.
|
|
1487
|
+
* @param {ProfileType} profileType - Profile type.
|
|
1488
|
+
* @throws {AgentbaseException}
|
|
1489
|
+
* @returns {Promise<{}>}
|
|
1490
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1491
|
+
*/
|
|
1492
|
+
getProfile(userId: string, profileType?: ProfileType): Promise<{}>;
|
|
1493
|
+
/**
|
|
1494
|
+
* Delete a user memory profile and its derived provenance.
|
|
1495
|
+
*
|
|
1496
|
+
* @param {string} params.userId - Target user ID.
|
|
1497
|
+
* @param {ProfileType} params.profileType - Profile type.
|
|
1498
|
+
* @param {string} params.reason - Profile deletion reason.
|
|
1499
|
+
* @param {string} params.source - Profile deletion source.
|
|
1500
|
+
* @throws {AgentbaseException}
|
|
1501
|
+
* @returns {Promise<{}>}
|
|
1502
|
+
*/
|
|
1503
|
+
deleteProfile(params: {
|
|
1504
|
+
userId: string;
|
|
1505
|
+
profileType?: ProfileType;
|
|
1506
|
+
reason?: string;
|
|
1507
|
+
source?: string;
|
|
1508
|
+
}): Promise<{}>;
|
|
1509
|
+
/**
|
|
1510
|
+
* Delete a user memory profile and its derived provenance.
|
|
1511
|
+
*
|
|
1512
|
+
* @param {string} userId - Target user ID.
|
|
1513
|
+
* @param {ProfileType} profileType - Profile type.
|
|
1514
|
+
* @param {string} reason - Profile deletion reason.
|
|
1515
|
+
* @param {string} source - Profile deletion source.
|
|
1516
|
+
* @throws {AgentbaseException}
|
|
1517
|
+
* @returns {Promise<{}>}
|
|
1518
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1519
|
+
*/
|
|
1520
|
+
deleteProfile(userId: string, profileType?: ProfileType, reason?: string, source?: string): Promise<{}>;
|
|
1521
|
+
/**
|
|
1522
|
+
* Create a user memory profile extraction.
|
|
1523
|
+
*
|
|
1524
|
+
* @param {string} params.userId - Target user ID.
|
|
1525
|
+
* @param {ProfileType} params.profileType - Profile type.
|
|
1526
|
+
* @param {Models.MemoryMessage[]} params.messages - Typed role/content messages used as source evidence.
|
|
1527
|
+
* @param {string[]} params.sourceMemoryIds - Existing memory IDs used as replacement evidence.
|
|
1528
|
+
* @param {ProfileExtractionMode} params.mode - Incrementally update or replace the profile.
|
|
1529
|
+
* @throws {AgentbaseException}
|
|
1530
|
+
* @returns {Promise<{}>}
|
|
1531
|
+
*/
|
|
1532
|
+
createProfileExtraction(params: {
|
|
1533
|
+
userId: string;
|
|
1534
|
+
profileType?: ProfileType;
|
|
1535
|
+
messages?: Models.MemoryMessage[];
|
|
1536
|
+
sourceMemoryIds?: string[];
|
|
1537
|
+
mode?: ProfileExtractionMode;
|
|
1538
|
+
}): Promise<{}>;
|
|
1539
|
+
/**
|
|
1540
|
+
* Create a user memory profile extraction.
|
|
1541
|
+
*
|
|
1542
|
+
* @param {string} userId - Target user ID.
|
|
1543
|
+
* @param {ProfileType} profileType - Profile type.
|
|
1544
|
+
* @param {Models.MemoryMessage[]} messages - Typed role/content messages used as source evidence.
|
|
1545
|
+
* @param {string[]} sourceMemoryIds - Existing memory IDs used as replacement evidence.
|
|
1546
|
+
* @param {ProfileExtractionMode} mode - Incrementally update or replace the profile.
|
|
1547
|
+
* @throws {AgentbaseException}
|
|
1548
|
+
* @returns {Promise<{}>}
|
|
1549
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1550
|
+
*/
|
|
1551
|
+
createProfileExtraction(userId: string, profileType?: ProfileType, messages?: Models.MemoryMessage[], sourceMemoryIds?: string[], mode?: ProfileExtractionMode): Promise<{}>;
|
|
1552
|
+
/**
|
|
1553
|
+
* Create a user memory profile rebuild.
|
|
1554
|
+
*
|
|
1555
|
+
* @param {string} params.userId - Target user ID.
|
|
1556
|
+
* @param {ProfileType} params.profileType - Profile type.
|
|
1557
|
+
* @throws {AgentbaseException}
|
|
1558
|
+
* @returns {Promise<{}>}
|
|
1559
|
+
*/
|
|
1560
|
+
createProfileRebuild(params: {
|
|
1561
|
+
userId: string;
|
|
1562
|
+
profileType?: ProfileType;
|
|
1563
|
+
}): Promise<{}>;
|
|
1564
|
+
/**
|
|
1565
|
+
* Create a user memory profile rebuild.
|
|
1566
|
+
*
|
|
1567
|
+
* @param {string} userId - Target user ID.
|
|
1568
|
+
* @param {ProfileType} profileType - Profile type.
|
|
1569
|
+
* @throws {AgentbaseException}
|
|
1570
|
+
* @returns {Promise<{}>}
|
|
1571
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1572
|
+
*/
|
|
1573
|
+
createProfileRebuild(userId: string, profileType?: ProfileType): Promise<{}>;
|
|
1574
|
+
/**
|
|
1575
|
+
* List the sources for a user memory profile.
|
|
1576
|
+
*
|
|
1577
|
+
* @param {string} params.userId - Target user ID.
|
|
1578
|
+
* @param {ProfileType} params.profileType - Profile type.
|
|
1579
|
+
* @throws {AgentbaseException}
|
|
1580
|
+
* @returns {Promise<{}>}
|
|
1581
|
+
*/
|
|
1582
|
+
listProfileSources(params: {
|
|
1583
|
+
userId: string;
|
|
1584
|
+
profileType?: ProfileType;
|
|
1585
|
+
}): Promise<{}>;
|
|
1586
|
+
/**
|
|
1587
|
+
* List the sources for a user memory profile.
|
|
1588
|
+
*
|
|
1589
|
+
* @param {string} userId - Target user ID.
|
|
1590
|
+
* @param {ProfileType} profileType - Profile type.
|
|
1591
|
+
* @throws {AgentbaseException}
|
|
1592
|
+
* @returns {Promise<{}>}
|
|
1593
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1594
|
+
*/
|
|
1595
|
+
listProfileSources(userId: string, profileType?: ProfileType): Promise<{}>;
|
|
1596
|
+
/**
|
|
1597
|
+
* Get a memory record by its unique ID.
|
|
1598
|
+
*
|
|
1599
|
+
* @param {string} params.memoryId - Memory unique ID.
|
|
1600
|
+
* @throws {AgentbaseException}
|
|
1601
|
+
* @returns {Promise<{}>}
|
|
1602
|
+
*/
|
|
1603
|
+
get(params: {
|
|
1604
|
+
memoryId: string;
|
|
1605
|
+
}): Promise<{}>;
|
|
1606
|
+
/**
|
|
1607
|
+
* Get a memory record by its unique ID.
|
|
1608
|
+
*
|
|
1609
|
+
* @param {string} memoryId - Memory unique ID.
|
|
1610
|
+
* @throws {AgentbaseException}
|
|
1611
|
+
* @returns {Promise<{}>}
|
|
1612
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1613
|
+
*/
|
|
1614
|
+
get(memoryId: string): Promise<{}>;
|
|
1615
|
+
/**
|
|
1616
|
+
* Update a memory record by its unique ID.
|
|
1617
|
+
*
|
|
1618
|
+
* @param {string} params.memoryId - Memory unique ID.
|
|
1619
|
+
* @param {number} params.version - Expected current memory version.
|
|
1620
|
+
* @param {string} params.content - Updated memory text.
|
|
1621
|
+
* @param {object} params.metadata - Metadata merge patch.
|
|
1622
|
+
* @param {RetentionPolicy} params.retentionPolicy - Retention policy.
|
|
1623
|
+
* @throws {AgentbaseException}
|
|
1624
|
+
* @returns {Promise<{}>}
|
|
1625
|
+
*/
|
|
1626
|
+
update(params: {
|
|
1627
|
+
memoryId: string;
|
|
1628
|
+
version: number;
|
|
1629
|
+
content?: string;
|
|
1630
|
+
metadata?: object;
|
|
1631
|
+
retentionPolicy?: RetentionPolicy;
|
|
1632
|
+
}): Promise<{}>;
|
|
1633
|
+
/**
|
|
1634
|
+
* Update a memory record by its unique ID.
|
|
1635
|
+
*
|
|
1636
|
+
* @param {string} memoryId - Memory unique ID.
|
|
1637
|
+
* @param {number} version - Expected current memory version.
|
|
1638
|
+
* @param {string} content - Updated memory text.
|
|
1639
|
+
* @param {object} metadata - Metadata merge patch.
|
|
1640
|
+
* @param {RetentionPolicy} retentionPolicy - Retention policy.
|
|
1641
|
+
* @throws {AgentbaseException}
|
|
1642
|
+
* @returns {Promise<{}>}
|
|
1643
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1644
|
+
*/
|
|
1645
|
+
update(memoryId: string, version: number, content?: string, metadata?: object, retentionPolicy?: RetentionPolicy): Promise<{}>;
|
|
1646
|
+
/**
|
|
1647
|
+
* Delete a memory record by its unique ID.
|
|
1648
|
+
*
|
|
1649
|
+
* @param {string} params.memoryId - Memory unique ID.
|
|
1650
|
+
* @param {string} params.reason - Forgetting reason.
|
|
1651
|
+
* @param {string} params.source - Forgetting source.
|
|
1652
|
+
* @throws {AgentbaseException}
|
|
1653
|
+
* @returns {Promise<{}>}
|
|
1654
|
+
*/
|
|
1655
|
+
delete(params: {
|
|
1656
|
+
memoryId: string;
|
|
1657
|
+
reason?: string;
|
|
1658
|
+
source?: string;
|
|
1659
|
+
}): Promise<{}>;
|
|
1660
|
+
/**
|
|
1661
|
+
* Delete a memory record by its unique ID.
|
|
1662
|
+
*
|
|
1663
|
+
* @param {string} memoryId - Memory unique ID.
|
|
1664
|
+
* @param {string} reason - Forgetting reason.
|
|
1665
|
+
* @param {string} source - Forgetting source.
|
|
1666
|
+
* @throws {AgentbaseException}
|
|
1667
|
+
* @returns {Promise<{}>}
|
|
1668
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1669
|
+
*/
|
|
1670
|
+
delete(memoryId: string, reason?: string, source?: string): Promise<{}>;
|
|
1671
|
+
/**
|
|
1672
|
+
* List active read grants for one memory.
|
|
1673
|
+
*
|
|
1674
|
+
* @param {string} params.memoryId - Memory unique ID.
|
|
1675
|
+
* @throws {AgentbaseException}
|
|
1676
|
+
* @returns {Promise<{}>}
|
|
1677
|
+
*/
|
|
1678
|
+
listShares(params: {
|
|
1679
|
+
memoryId: string;
|
|
1680
|
+
}): Promise<{}>;
|
|
1681
|
+
/**
|
|
1682
|
+
* List active read grants for one memory.
|
|
1683
|
+
*
|
|
1684
|
+
* @param {string} memoryId - Memory unique ID.
|
|
1685
|
+
* @throws {AgentbaseException}
|
|
1686
|
+
* @returns {Promise<{}>}
|
|
1687
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1688
|
+
*/
|
|
1689
|
+
listShares(memoryId: string): Promise<{}>;
|
|
1690
|
+
/**
|
|
1691
|
+
* Grant read access to one memory for a user or group.
|
|
1692
|
+
*
|
|
1693
|
+
* @param {string} params.memoryId - Memory unique ID.
|
|
1694
|
+
* @param {MemoryShareSubjectType} params.subjectType - Share subject type.
|
|
1695
|
+
* @param {string} params.subjectId - Share subject ID.
|
|
1696
|
+
* @param {string} params.expiresAt - Optional RFC3339 expiration, at most 365 days in the future.
|
|
1697
|
+
* @throws {AgentbaseException}
|
|
1698
|
+
* @returns {Promise<{}>}
|
|
1699
|
+
*/
|
|
1700
|
+
createShare(params: {
|
|
1701
|
+
memoryId: string;
|
|
1702
|
+
subjectType: MemoryShareSubjectType;
|
|
1703
|
+
subjectId: string;
|
|
1704
|
+
expiresAt?: string;
|
|
1705
|
+
}): Promise<{}>;
|
|
1706
|
+
/**
|
|
1707
|
+
* Grant read access to one memory for a user or group.
|
|
1708
|
+
*
|
|
1709
|
+
* @param {string} memoryId - Memory unique ID.
|
|
1710
|
+
* @param {MemoryShareSubjectType} subjectType - Share subject type.
|
|
1711
|
+
* @param {string} subjectId - Share subject ID.
|
|
1712
|
+
* @param {string} expiresAt - Optional RFC3339 expiration, at most 365 days in the future.
|
|
1713
|
+
* @throws {AgentbaseException}
|
|
1714
|
+
* @returns {Promise<{}>}
|
|
1715
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1716
|
+
*/
|
|
1717
|
+
createShare(memoryId: string, subjectType: MemoryShareSubjectType, subjectId: string, expiresAt?: string): Promise<{}>;
|
|
1718
|
+
/**
|
|
1719
|
+
* Revoke one memory read grant.
|
|
1720
|
+
*
|
|
1721
|
+
* @param {string} params.memoryId - Memory unique ID.
|
|
1722
|
+
* @param {string} params.shareId - Stable share ID.
|
|
1723
|
+
* @throws {AgentbaseException}
|
|
1724
|
+
* @returns {Promise<{}>}
|
|
1725
|
+
*/
|
|
1726
|
+
deleteShare(params: {
|
|
1727
|
+
memoryId: string;
|
|
1728
|
+
shareId: string;
|
|
1729
|
+
}): Promise<{}>;
|
|
1730
|
+
/**
|
|
1731
|
+
* Revoke one memory read grant.
|
|
1732
|
+
*
|
|
1733
|
+
* @param {string} memoryId - Memory unique ID.
|
|
1734
|
+
* @param {string} shareId - Stable share ID.
|
|
1735
|
+
* @throws {AgentbaseException}
|
|
1736
|
+
* @returns {Promise<{}>}
|
|
1737
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1738
|
+
*/
|
|
1739
|
+
deleteShare(memoryId: string, shareId: string): Promise<{}>;
|
|
1740
|
+
/**
|
|
1741
|
+
* List immutable provenance sources linked to a Memory record.
|
|
1742
|
+
*
|
|
1743
|
+
* @param {string} params.memoryId - Memory ID.
|
|
1744
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
1745
|
+
* @param {number} params.limit - Maximum sources.
|
|
1746
|
+
* @throws {AgentbaseException}
|
|
1747
|
+
* @returns {Promise<{}>}
|
|
1748
|
+
*/
|
|
1749
|
+
listSources(params: {
|
|
1750
|
+
memoryId: string;
|
|
1751
|
+
cursor?: string;
|
|
1752
|
+
limit?: number;
|
|
1753
|
+
}): Promise<{}>;
|
|
1754
|
+
/**
|
|
1755
|
+
* List immutable provenance sources linked to a Memory record.
|
|
1756
|
+
*
|
|
1757
|
+
* @param {string} memoryId - Memory ID.
|
|
1758
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
1759
|
+
* @param {number} limit - Maximum sources.
|
|
1760
|
+
* @throws {AgentbaseException}
|
|
1761
|
+
* @returns {Promise<{}>}
|
|
1762
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1763
|
+
*/
|
|
1764
|
+
listSources(memoryId: string, cursor?: string, limit?: number): Promise<{}>;
|
|
1765
|
+
}
|