agentbase-web-sdk 2.9.0 → 2.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/cjs/sdk.js +812 -69
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +813 -70
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +812 -69
- package/package.json +2 -2
- package/types/enums/method.d.ts +9 -0
- package/types/enums/path-match.d.ts +4 -0
- package/types/enums/scenario.d.ts +6 -0
- package/types/enums/status.d.ts +5 -1
- package/types/index.d.ts +4 -1
- package/types/services/functions.d.ts +33 -7
- package/types/services/memory.d.ts +488 -16
|
@@ -22,6 +22,7 @@ import { ProfileType } from '../enums/profile-type';
|
|
|
22
22
|
import { ProfileExtractionMode } from '../enums/profile-extraction-mode';
|
|
23
23
|
import { RetentionPolicy } from '../enums/retention-policy';
|
|
24
24
|
import { MemoryShareSubjectType } from '../enums/memory-share-subject-type';
|
|
25
|
+
import { Scenario } from '../enums/scenario';
|
|
25
26
|
export declare class Memory {
|
|
26
27
|
client: Client;
|
|
27
28
|
constructor(client: Client);
|
|
@@ -85,8 +86,10 @@ export declare class Memory {
|
|
|
85
86
|
* @param {MemoryScope} params.scope - Memory visibility scope.
|
|
86
87
|
* @param {string} params.memoryType - Memory type. With infer=true, conversation input is retained as source evidence and derived records use long_term.
|
|
87
88
|
* @param {RecordKind} params.recordKind - Memory record kind. With infer=true, conversation input derives fact records.
|
|
88
|
-
* @param {string} params.
|
|
89
|
+
* @param {string} params.pipelineId - Optional published add-memory Pipeline ID. Omit to use the project default or system default.
|
|
90
|
+
* @param {string} params.content - Compatibility memory text. Required when messages and media are omitted.
|
|
89
91
|
* @param {Models.MemoryMessage[]} params.messages - Optional typed role/content messages used as source evidence.
|
|
92
|
+
* @param {object} params.media - Optional Storage file reference {bucketId, fileId}. Accepts one PNG, JPEG, WebP or PDF up to 8 MiB; PDFs allow at most 10 pages. Requires files.read and configured vision routing. Media writes require async=true.
|
|
90
93
|
* @param {string} params.agentId - Optional agent ID.
|
|
91
94
|
* @param {string} params.runId - Optional run ID.
|
|
92
95
|
* @param {string} params.sessionId - Optional conversation ID (max 128 characters). With infer=true, bounded history is loaded only for user, group, and project scopes; private and strict_private never hydrate history.
|
|
@@ -95,7 +98,7 @@ export declare class Memory {
|
|
|
95
98
|
* @param {object} params.metadata - Memory metadata.
|
|
96
99
|
* @param {boolean} params.infer - Use configured model-assisted extraction and cross-type deduplication. Defaults to true.
|
|
97
100
|
* @param {boolean} params.reRemember - Explicitly create new evidence for forgotten content.
|
|
98
|
-
* @param {boolean} params.async - Queue memory creation and return immediately. Defaults to the infer value
|
|
101
|
+
* @param {boolean} params.async - Queue memory creation and return immediately. Defaults to the infer value for text; media always requires true, including infer=false.
|
|
99
102
|
* @throws {AgentbaseException}
|
|
100
103
|
* @returns {Promise<{}>}
|
|
101
104
|
*/
|
|
@@ -104,8 +107,10 @@ export declare class Memory {
|
|
|
104
107
|
scope: MemoryScope;
|
|
105
108
|
memoryType: string;
|
|
106
109
|
recordKind: RecordKind;
|
|
110
|
+
pipelineId?: string;
|
|
107
111
|
content?: string;
|
|
108
112
|
messages?: Models.MemoryMessage[];
|
|
113
|
+
media?: object;
|
|
109
114
|
agentId?: string;
|
|
110
115
|
runId?: string;
|
|
111
116
|
sessionId?: string;
|
|
@@ -123,8 +128,10 @@ export declare class Memory {
|
|
|
123
128
|
* @param {MemoryScope} scope - Memory visibility scope.
|
|
124
129
|
* @param {string} memoryType - Memory type. With infer=true, conversation input is retained as source evidence and derived records use long_term.
|
|
125
130
|
* @param {RecordKind} recordKind - Memory record kind. With infer=true, conversation input derives fact records.
|
|
126
|
-
* @param {string}
|
|
131
|
+
* @param {string} pipelineId - Optional published add-memory Pipeline ID. Omit to use the project default or system default.
|
|
132
|
+
* @param {string} content - Compatibility memory text. Required when messages and media are omitted.
|
|
127
133
|
* @param {Models.MemoryMessage[]} messages - Optional typed role/content messages used as source evidence.
|
|
134
|
+
* @param {object} media - Optional Storage file reference {bucketId, fileId}. Accepts one PNG, JPEG, WebP or PDF up to 8 MiB; PDFs allow at most 10 pages. Requires files.read and configured vision routing. Media writes require async=true.
|
|
128
135
|
* @param {string} agentId - Optional agent ID.
|
|
129
136
|
* @param {string} runId - Optional run ID.
|
|
130
137
|
* @param {string} sessionId - Optional conversation ID (max 128 characters). With infer=true, bounded history is loaded only for user, group, and project scopes; private and strict_private never hydrate history.
|
|
@@ -133,16 +140,17 @@ export declare class Memory {
|
|
|
133
140
|
* @param {object} metadata - Memory metadata.
|
|
134
141
|
* @param {boolean} infer - Use configured model-assisted extraction and cross-type deduplication. Defaults to true.
|
|
135
142
|
* @param {boolean} reRemember - Explicitly create new evidence for forgotten content.
|
|
136
|
-
* @param {boolean} async - Queue memory creation and return immediately. Defaults to the infer value
|
|
143
|
+
* @param {boolean} async - Queue memory creation and return immediately. Defaults to the infer value for text; media always requires true, including infer=false.
|
|
137
144
|
* @throws {AgentbaseException}
|
|
138
145
|
* @returns {Promise<{}>}
|
|
139
146
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
140
147
|
*/
|
|
141
|
-
create(userId: string, scope: MemoryScope, memoryType: string, recordKind: RecordKind, content?: string, messages?: Models.MemoryMessage[], agentId?: string, runId?: string, sessionId?: string, sensitivity?: MemorySensitivity, handlingPolicy?: MemoryHandlingPolicy, metadata?: object, infer?: boolean, reRemember?: boolean, async?: boolean): Promise<{}>;
|
|
148
|
+
create(userId: string, scope: MemoryScope, memoryType: string, recordKind: RecordKind, pipelineId?: string, content?: string, messages?: Models.MemoryMessage[], media?: object, agentId?: string, runId?: string, sessionId?: string, sensitivity?: MemorySensitivity, handlingPolicy?: MemoryHandlingPolicy, metadata?: object, infer?: boolean, reRemember?: boolean, async?: boolean): Promise<{}>;
|
|
142
149
|
/**
|
|
143
150
|
* Forget memory records in one bounded pass. Repeat while hasMore is true and inspect failed and items before considering the scope fully deleted.
|
|
144
151
|
*
|
|
145
152
|
* @param {string} params.userId - Target user ID.
|
|
153
|
+
* @param {string} params.memorySubStoreId - Memory sub-store for erasure.
|
|
146
154
|
* @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.
|
|
147
155
|
* @param {string} params.reason - Forgetting reason.
|
|
148
156
|
* @param {string} params.source - Forgetting source.
|
|
@@ -151,6 +159,7 @@ export declare class Memory {
|
|
|
151
159
|
*/
|
|
152
160
|
deleteMany(params?: {
|
|
153
161
|
userId?: string;
|
|
162
|
+
memorySubStoreId?: string;
|
|
154
163
|
limit?: number;
|
|
155
164
|
reason?: string;
|
|
156
165
|
source?: string;
|
|
@@ -159,6 +168,7 @@ export declare class Memory {
|
|
|
159
168
|
* Forget memory records in one bounded pass. Repeat while hasMore is true and inspect failed and items before considering the scope fully deleted.
|
|
160
169
|
*
|
|
161
170
|
* @param {string} userId - Target user ID.
|
|
171
|
+
* @param {string} memorySubStoreId - Memory sub-store for erasure.
|
|
162
172
|
* @param {number} limit - Requested upper bound for this pass, from 1 to 500. The service may process fewer records; repeat while hasMore is true.
|
|
163
173
|
* @param {string} reason - Forgetting reason.
|
|
164
174
|
* @param {string} source - Forgetting source.
|
|
@@ -166,7 +176,7 @@ export declare class Memory {
|
|
|
166
176
|
* @returns {Promise<Models.MemoryBulkDeleteResponse>}
|
|
167
177
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
168
178
|
*/
|
|
169
|
-
deleteMany(userId?: string, limit?: number, reason?: string, source?: string): Promise<Models.MemoryBulkDeleteResponse>;
|
|
179
|
+
deleteMany(userId?: string, memorySubStoreId?: string, limit?: number, reason?: string, source?: string): Promise<Models.MemoryBulkDeleteResponse>;
|
|
170
180
|
/**
|
|
171
181
|
* Run a bounded batch of memory operations.
|
|
172
182
|
*
|
|
@@ -518,6 +528,7 @@ export declare class Memory {
|
|
|
518
528
|
* @param {string} params.sessionId - Source session ID.
|
|
519
529
|
* @param {string} params.runId - Source run ID.
|
|
520
530
|
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
531
|
+
* @param {string} params.pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
521
532
|
* @param {string} params.sourceId - Persisted source ID.
|
|
522
533
|
* @param {SourceType} params.sourceType - Persisted source type.
|
|
523
534
|
* @param {Models.DistillationMessage[]} params.messages - Bounded conversation messages.
|
|
@@ -534,6 +545,7 @@ export declare class Memory {
|
|
|
534
545
|
sessionId?: string;
|
|
535
546
|
runId?: string;
|
|
536
547
|
memorySubStoreId?: string;
|
|
548
|
+
pipelineId?: string;
|
|
537
549
|
sourceId?: string;
|
|
538
550
|
sourceType?: SourceType;
|
|
539
551
|
messages?: Models.DistillationMessage[];
|
|
@@ -550,6 +562,7 @@ export declare class Memory {
|
|
|
550
562
|
* @param {string} sessionId - Source session ID.
|
|
551
563
|
* @param {string} runId - Source run ID.
|
|
552
564
|
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
565
|
+
* @param {string} pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
553
566
|
* @param {string} sourceId - Persisted source ID.
|
|
554
567
|
* @param {SourceType} sourceType - Persisted source type.
|
|
555
568
|
* @param {Models.DistillationMessage[]} messages - Bounded conversation messages.
|
|
@@ -560,7 +573,7 @@ export declare class Memory {
|
|
|
560
573
|
* @returns {Promise<{}>}
|
|
561
574
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
562
575
|
*/
|
|
563
|
-
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<{}>;
|
|
576
|
+
submitDistillation(scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, pipelineId?: string, sourceId?: string, sourceType?: SourceType, messages?: Models.DistillationMessage[], toolEvents?: Models.DistillationToolEvent[], mode?: DistillationMode, idempotencyKey?: string): Promise<{}>;
|
|
564
577
|
/**
|
|
565
578
|
* Get a distillation job and its output references.
|
|
566
579
|
*
|
|
@@ -944,6 +957,7 @@ export declare class Memory {
|
|
|
944
957
|
* Create a memory import job.
|
|
945
958
|
*
|
|
946
959
|
* @param {string} params.userId - Target user ID.
|
|
960
|
+
* @param {string} params.pipelineId - Published add-memory Pipeline ID applied to every imported record. Omit to use the default Pipeline.
|
|
947
961
|
* @param {Format} params.format - Import format.
|
|
948
962
|
* @param {string} params.data - Raw JSON or JSONL import data.
|
|
949
963
|
* @param {Models.MemoryRecordInput[]} params.records - Structured memory records.
|
|
@@ -953,6 +967,7 @@ export declare class Memory {
|
|
|
953
967
|
*/
|
|
954
968
|
createImport(params: {
|
|
955
969
|
userId: string;
|
|
970
|
+
pipelineId?: string;
|
|
956
971
|
format?: Format;
|
|
957
972
|
data?: string;
|
|
958
973
|
records?: Models.MemoryRecordInput[];
|
|
@@ -962,6 +977,7 @@ export declare class Memory {
|
|
|
962
977
|
* Create a memory import job.
|
|
963
978
|
*
|
|
964
979
|
* @param {string} userId - Target user ID.
|
|
980
|
+
* @param {string} pipelineId - Published add-memory Pipeline ID applied to every imported record. Omit to use the default Pipeline.
|
|
965
981
|
* @param {Format} format - Import format.
|
|
966
982
|
* @param {string} data - Raw JSON or JSONL import data.
|
|
967
983
|
* @param {Models.MemoryRecordInput[]} records - Structured memory records.
|
|
@@ -970,7 +986,7 @@ export declare class Memory {
|
|
|
970
986
|
* @returns {Promise<{}>}
|
|
971
987
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
972
988
|
*/
|
|
973
|
-
createImport(userId: string, format?: Format, data?: string, records?: Models.MemoryRecordInput[], dryRun?: boolean): Promise<{}>;
|
|
989
|
+
createImport(userId: string, pipelineId?: string, format?: Format, data?: string, records?: Models.MemoryRecordInput[], dryRun?: boolean): Promise<{}>;
|
|
974
990
|
/**
|
|
975
991
|
* Get a memory import job by its unique ID.
|
|
976
992
|
*
|
|
@@ -990,6 +1006,89 @@ export declare class Memory {
|
|
|
990
1006
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
991
1007
|
*/
|
|
992
1008
|
getImport(importId: string): Promise<{}>;
|
|
1009
|
+
/**
|
|
1010
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1011
|
+
*
|
|
1012
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1013
|
+
* @param {string} params.userId - Target user ID.
|
|
1014
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1015
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1016
|
+
* @param {string} params.runId - Source run ID.
|
|
1017
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1018
|
+
* @param {number} params.limit - Page size, maximum 100.
|
|
1019
|
+
* @param {number} params.offset - Page offset.
|
|
1020
|
+
* @param {Status} params.status - Review status.
|
|
1021
|
+
* @param {string} params.knowledgeId - Knowledge ID filter.
|
|
1022
|
+
* @throws {AgentbaseException}
|
|
1023
|
+
* @returns {Promise<{}>}
|
|
1024
|
+
*/
|
|
1025
|
+
listKnowledgeReviews(params?: {
|
|
1026
|
+
scope?: Scope;
|
|
1027
|
+
userId?: string;
|
|
1028
|
+
agentId?: string;
|
|
1029
|
+
sessionId?: string;
|
|
1030
|
+
runId?: string;
|
|
1031
|
+
memorySubStoreId?: string;
|
|
1032
|
+
limit?: number;
|
|
1033
|
+
offset?: number;
|
|
1034
|
+
status?: Status;
|
|
1035
|
+
knowledgeId?: string;
|
|
1036
|
+
}): Promise<{}>;
|
|
1037
|
+
/**
|
|
1038
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1039
|
+
*
|
|
1040
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1041
|
+
* @param {string} userId - Target user ID.
|
|
1042
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1043
|
+
* @param {string} sessionId - Source session ID.
|
|
1044
|
+
* @param {string} runId - Source run ID.
|
|
1045
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1046
|
+
* @param {number} limit - Page size, maximum 100.
|
|
1047
|
+
* @param {number} offset - Page offset.
|
|
1048
|
+
* @param {Status} status - Review status.
|
|
1049
|
+
* @param {string} knowledgeId - Knowledge ID filter.
|
|
1050
|
+
* @throws {AgentbaseException}
|
|
1051
|
+
* @returns {Promise<{}>}
|
|
1052
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1053
|
+
*/
|
|
1054
|
+
listKnowledgeReviews(scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, limit?: number, offset?: number, status?: Status, knowledgeId?: string): Promise<{}>;
|
|
1055
|
+
/**
|
|
1056
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1057
|
+
*
|
|
1058
|
+
* @param {string} params.reviewId - reviewId
|
|
1059
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1060
|
+
* @param {string} params.userId - Target user ID.
|
|
1061
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1062
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1063
|
+
* @param {string} params.runId - Source run ID.
|
|
1064
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1065
|
+
* @throws {AgentbaseException}
|
|
1066
|
+
* @returns {Promise<{}>}
|
|
1067
|
+
*/
|
|
1068
|
+
getKnowledgeReview(params: {
|
|
1069
|
+
reviewId: string;
|
|
1070
|
+
scope?: Scope;
|
|
1071
|
+
userId?: string;
|
|
1072
|
+
agentId?: string;
|
|
1073
|
+
sessionId?: string;
|
|
1074
|
+
runId?: string;
|
|
1075
|
+
memorySubStoreId?: string;
|
|
1076
|
+
}): Promise<{}>;
|
|
1077
|
+
/**
|
|
1078
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1079
|
+
*
|
|
1080
|
+
* @param {string} reviewId - reviewId
|
|
1081
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1082
|
+
* @param {string} userId - Target user ID.
|
|
1083
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1084
|
+
* @param {string} sessionId - Source session ID.
|
|
1085
|
+
* @param {string} runId - Source run ID.
|
|
1086
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1087
|
+
* @throws {AgentbaseException}
|
|
1088
|
+
* @returns {Promise<{}>}
|
|
1089
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1090
|
+
*/
|
|
1091
|
+
getKnowledgeReview(reviewId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
993
1092
|
/**
|
|
994
1093
|
* Update managed knowledge state.
|
|
995
1094
|
*
|
|
@@ -1082,6 +1181,129 @@ export declare class Memory {
|
|
|
1082
1181
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1083
1182
|
*/
|
|
1084
1183
|
forgetKnowledge(knowledgeId: string, expectedVersion: number, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, reason?: string, source?: string): Promise<{}>;
|
|
1184
|
+
/**
|
|
1185
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1186
|
+
*
|
|
1187
|
+
* @param {string} params.knowledgeId - knowledgeId
|
|
1188
|
+
* @param {string} params.toRevisionId - Candidate revision.
|
|
1189
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1190
|
+
* @param {string} params.userId - Target user ID.
|
|
1191
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1192
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1193
|
+
* @param {string} params.runId - Source run ID.
|
|
1194
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1195
|
+
* @param {string} params.fromRevisionId - Base revision; empty compares a new item.
|
|
1196
|
+
* @throws {AgentbaseException}
|
|
1197
|
+
* @returns {Promise<{}>}
|
|
1198
|
+
*/
|
|
1199
|
+
getKnowledgeDiff(params: {
|
|
1200
|
+
knowledgeId: string;
|
|
1201
|
+
toRevisionId: string;
|
|
1202
|
+
scope?: Scope;
|
|
1203
|
+
userId?: string;
|
|
1204
|
+
agentId?: string;
|
|
1205
|
+
sessionId?: string;
|
|
1206
|
+
runId?: string;
|
|
1207
|
+
memorySubStoreId?: string;
|
|
1208
|
+
fromRevisionId?: string;
|
|
1209
|
+
}): Promise<{}>;
|
|
1210
|
+
/**
|
|
1211
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1212
|
+
*
|
|
1213
|
+
* @param {string} knowledgeId - knowledgeId
|
|
1214
|
+
* @param {string} toRevisionId - Candidate revision.
|
|
1215
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1216
|
+
* @param {string} userId - Target user ID.
|
|
1217
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1218
|
+
* @param {string} sessionId - Source session ID.
|
|
1219
|
+
* @param {string} runId - Source run ID.
|
|
1220
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1221
|
+
* @param {string} fromRevisionId - Base revision; empty compares a new item.
|
|
1222
|
+
* @throws {AgentbaseException}
|
|
1223
|
+
* @returns {Promise<{}>}
|
|
1224
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1225
|
+
*/
|
|
1226
|
+
getKnowledgeDiff(knowledgeId: string, toRevisionId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, fromRevisionId?: string): Promise<{}>;
|
|
1227
|
+
/**
|
|
1228
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1229
|
+
*
|
|
1230
|
+
* @param {string} params.knowledgeId - knowledgeId
|
|
1231
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1232
|
+
* @param {string} params.userId - Target user ID.
|
|
1233
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1234
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1235
|
+
* @param {string} params.runId - Source run ID.
|
|
1236
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1237
|
+
* @throws {AgentbaseException}
|
|
1238
|
+
* @returns {Promise<{}>}
|
|
1239
|
+
*/
|
|
1240
|
+
listKnowledgeEvents(params: {
|
|
1241
|
+
knowledgeId: string;
|
|
1242
|
+
scope?: Scope;
|
|
1243
|
+
userId?: string;
|
|
1244
|
+
agentId?: string;
|
|
1245
|
+
sessionId?: string;
|
|
1246
|
+
runId?: string;
|
|
1247
|
+
memorySubStoreId?: string;
|
|
1248
|
+
}): Promise<{}>;
|
|
1249
|
+
/**
|
|
1250
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1251
|
+
*
|
|
1252
|
+
* @param {string} knowledgeId - knowledgeId
|
|
1253
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1254
|
+
* @param {string} userId - Target user ID.
|
|
1255
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1256
|
+
* @param {string} sessionId - Source session ID.
|
|
1257
|
+
* @param {string} runId - Source run ID.
|
|
1258
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1259
|
+
* @throws {AgentbaseException}
|
|
1260
|
+
* @returns {Promise<{}>}
|
|
1261
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1262
|
+
*/
|
|
1263
|
+
listKnowledgeEvents(knowledgeId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
1264
|
+
/**
|
|
1265
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1266
|
+
*
|
|
1267
|
+
* @param {string} params.knowledgeId - knowledgeId
|
|
1268
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1269
|
+
* @param {string} params.userId - Target user ID.
|
|
1270
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1271
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1272
|
+
* @param {string} params.runId - Source run ID.
|
|
1273
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1274
|
+
* @param {number} params.limit - Page size, maximum 100.
|
|
1275
|
+
* @param {number} params.offset - Page offset.
|
|
1276
|
+
* @throws {AgentbaseException}
|
|
1277
|
+
* @returns {Promise<{}>}
|
|
1278
|
+
*/
|
|
1279
|
+
listKnowledgeRevisions(params: {
|
|
1280
|
+
knowledgeId: string;
|
|
1281
|
+
scope?: Scope;
|
|
1282
|
+
userId?: string;
|
|
1283
|
+
agentId?: string;
|
|
1284
|
+
sessionId?: string;
|
|
1285
|
+
runId?: string;
|
|
1286
|
+
memorySubStoreId?: string;
|
|
1287
|
+
limit?: number;
|
|
1288
|
+
offset?: number;
|
|
1289
|
+
}): Promise<{}>;
|
|
1290
|
+
/**
|
|
1291
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1292
|
+
*
|
|
1293
|
+
* @param {string} knowledgeId - knowledgeId
|
|
1294
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1295
|
+
* @param {string} userId - Target user ID.
|
|
1296
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1297
|
+
* @param {string} sessionId - Source session ID.
|
|
1298
|
+
* @param {string} runId - Source run ID.
|
|
1299
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1300
|
+
* @param {number} limit - Page size, maximum 100.
|
|
1301
|
+
* @param {number} offset - Page offset.
|
|
1302
|
+
* @throws {AgentbaseException}
|
|
1303
|
+
* @returns {Promise<{}>}
|
|
1304
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1305
|
+
*/
|
|
1306
|
+
listKnowledgeRevisions(knowledgeId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, limit?: number, offset?: number): Promise<{}>;
|
|
1085
1307
|
/**
|
|
1086
1308
|
* Record bounded evidence for a knowledge revision.
|
|
1087
1309
|
*
|
|
@@ -1220,9 +1442,10 @@ export declare class Memory {
|
|
|
1220
1442
|
/**
|
|
1221
1443
|
* Search memory records visible to the current caller.
|
|
1222
1444
|
*
|
|
1223
|
-
* @param {string} params.query - Search query.
|
|
1445
|
+
* @param {string} params.query - Search query. May be omitted with media.
|
|
1224
1446
|
* @param {string} params.searchMode - Recall mode override.
|
|
1225
1447
|
* @param {object} params.retrieval - Recall route overrides. sparse=false skips model-generated sparse recall for this request; omitted defaults to the project setting.
|
|
1448
|
+
* @param {object} params.media - Optional Storage image reference {bucketId, fileId}. Accepts one PNG, JPEG or WebP up to 8 MiB. Requires files.read and configured vision routing; parsed text is used for retrieval without writing a memory.
|
|
1226
1449
|
* @param {string} params.userId - Target user ID.
|
|
1227
1450
|
* @param {string} params.agentId - Agent ID filter.
|
|
1228
1451
|
* @param {string} params.runId - Run ID filter.
|
|
@@ -1240,10 +1463,11 @@ export declare class Memory {
|
|
|
1240
1463
|
* @throws {AgentbaseException}
|
|
1241
1464
|
* @returns {Promise<{}>}
|
|
1242
1465
|
*/
|
|
1243
|
-
search(params
|
|
1244
|
-
query
|
|
1466
|
+
search(params?: {
|
|
1467
|
+
query?: string;
|
|
1245
1468
|
searchMode?: string;
|
|
1246
1469
|
retrieval?: object;
|
|
1470
|
+
media?: object;
|
|
1247
1471
|
userId?: string;
|
|
1248
1472
|
agentId?: string;
|
|
1249
1473
|
runId?: string;
|
|
@@ -1262,9 +1486,10 @@ export declare class Memory {
|
|
|
1262
1486
|
/**
|
|
1263
1487
|
* Search memory records visible to the current caller.
|
|
1264
1488
|
*
|
|
1265
|
-
* @param {string} query - Search query.
|
|
1489
|
+
* @param {string} query - Search query. May be omitted with media.
|
|
1266
1490
|
* @param {string} searchMode - Recall mode override.
|
|
1267
1491
|
* @param {object} retrieval - Recall route overrides. sparse=false skips model-generated sparse recall for this request; omitted defaults to the project setting.
|
|
1492
|
+
* @param {object} media - Optional Storage image reference {bucketId, fileId}. Accepts one PNG, JPEG or WebP up to 8 MiB. Requires files.read and configured vision routing; parsed text is used for retrieval without writing a memory.
|
|
1268
1493
|
* @param {string} userId - Target user ID.
|
|
1269
1494
|
* @param {string} agentId - Agent ID filter.
|
|
1270
1495
|
* @param {string} runId - Run ID filter.
|
|
@@ -1283,7 +1508,7 @@ export declare class Memory {
|
|
|
1283
1508
|
* @returns {Promise<{}>}
|
|
1284
1509
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1285
1510
|
*/
|
|
1286
|
-
search(query
|
|
1511
|
+
search(query?: string, searchMode?: string, retrieval?: object, media?: 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<{}>;
|
|
1287
1512
|
/**
|
|
1288
1513
|
* Get memory session aggregates.
|
|
1289
1514
|
*
|
|
@@ -1525,6 +1750,7 @@ export declare class Memory {
|
|
|
1525
1750
|
* Create a user memory profile extraction.
|
|
1526
1751
|
*
|
|
1527
1752
|
* @param {string} params.userId - Target user ID.
|
|
1753
|
+
* @param {string} params.pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
1528
1754
|
* @param {ProfileType} params.profileType - Profile type.
|
|
1529
1755
|
* @param {Models.MemoryMessage[]} params.messages - Typed role/content messages used as source evidence.
|
|
1530
1756
|
* @param {string[]} params.sourceMemoryIds - Existing memory IDs used as replacement evidence.
|
|
@@ -1535,6 +1761,7 @@ export declare class Memory {
|
|
|
1535
1761
|
*/
|
|
1536
1762
|
createProfileExtraction(params: {
|
|
1537
1763
|
userId: string;
|
|
1764
|
+
pipelineId?: string;
|
|
1538
1765
|
profileType?: ProfileType;
|
|
1539
1766
|
messages?: Models.MemoryMessage[];
|
|
1540
1767
|
sourceMemoryIds?: string[];
|
|
@@ -1545,6 +1772,7 @@ export declare class Memory {
|
|
|
1545
1772
|
* Create a user memory profile extraction.
|
|
1546
1773
|
*
|
|
1547
1774
|
* @param {string} userId - Target user ID.
|
|
1775
|
+
* @param {string} pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
1548
1776
|
* @param {ProfileType} profileType - Profile type.
|
|
1549
1777
|
* @param {Models.MemoryMessage[]} messages - Typed role/content messages used as source evidence.
|
|
1550
1778
|
* @param {string[]} sourceMemoryIds - Existing memory IDs used as replacement evidence.
|
|
@@ -1554,29 +1782,32 @@ export declare class Memory {
|
|
|
1554
1782
|
* @returns {Promise<{}>}
|
|
1555
1783
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1556
1784
|
*/
|
|
1557
|
-
createProfileExtraction(userId: string, profileType?: ProfileType, messages?: Models.MemoryMessage[], sourceMemoryIds?: string[], sessionId?: string, mode?: ProfileExtractionMode): Promise<{}>;
|
|
1785
|
+
createProfileExtraction(userId: string, pipelineId?: string, profileType?: ProfileType, messages?: Models.MemoryMessage[], sourceMemoryIds?: string[], sessionId?: string, mode?: ProfileExtractionMode): Promise<{}>;
|
|
1558
1786
|
/**
|
|
1559
1787
|
* Create a user memory profile rebuild.
|
|
1560
1788
|
*
|
|
1561
1789
|
* @param {string} params.userId - Target user ID.
|
|
1790
|
+
* @param {string} params.pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
1562
1791
|
* @param {ProfileType} params.profileType - Profile type.
|
|
1563
1792
|
* @throws {AgentbaseException}
|
|
1564
1793
|
* @returns {Promise<{}>}
|
|
1565
1794
|
*/
|
|
1566
1795
|
createProfileRebuild(params: {
|
|
1567
1796
|
userId: string;
|
|
1797
|
+
pipelineId?: string;
|
|
1568
1798
|
profileType?: ProfileType;
|
|
1569
1799
|
}): Promise<{}>;
|
|
1570
1800
|
/**
|
|
1571
1801
|
* Create a user memory profile rebuild.
|
|
1572
1802
|
*
|
|
1573
1803
|
* @param {string} userId - Target user ID.
|
|
1804
|
+
* @param {string} pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
1574
1805
|
* @param {ProfileType} profileType - Profile type.
|
|
1575
1806
|
* @throws {AgentbaseException}
|
|
1576
1807
|
* @returns {Promise<{}>}
|
|
1577
1808
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1578
1809
|
*/
|
|
1579
|
-
createProfileRebuild(userId: string, profileType?: ProfileType): Promise<{}>;
|
|
1810
|
+
createProfileRebuild(userId: string, pipelineId?: string, profileType?: ProfileType): Promise<{}>;
|
|
1580
1811
|
/**
|
|
1581
1812
|
* List the sources for a user memory profile.
|
|
1582
1813
|
*
|
|
@@ -1653,6 +1884,7 @@ export declare class Memory {
|
|
|
1653
1884
|
* Delete a memory record by its unique ID.
|
|
1654
1885
|
*
|
|
1655
1886
|
* @param {string} params.memoryId - Memory unique ID.
|
|
1887
|
+
* @param {string} params.memorySubStoreId - Memory sub-store for erasure.
|
|
1656
1888
|
* @param {string} params.reason - Forgetting reason.
|
|
1657
1889
|
* @param {string} params.source - Forgetting source.
|
|
1658
1890
|
* @throws {AgentbaseException}
|
|
@@ -1660,6 +1892,7 @@ export declare class Memory {
|
|
|
1660
1892
|
*/
|
|
1661
1893
|
delete(params: {
|
|
1662
1894
|
memoryId: string;
|
|
1895
|
+
memorySubStoreId?: string;
|
|
1663
1896
|
reason?: string;
|
|
1664
1897
|
source?: string;
|
|
1665
1898
|
}): Promise<{}>;
|
|
@@ -1667,13 +1900,14 @@ export declare class Memory {
|
|
|
1667
1900
|
* Delete a memory record by its unique ID.
|
|
1668
1901
|
*
|
|
1669
1902
|
* @param {string} memoryId - Memory unique ID.
|
|
1903
|
+
* @param {string} memorySubStoreId - Memory sub-store for erasure.
|
|
1670
1904
|
* @param {string} reason - Forgetting reason.
|
|
1671
1905
|
* @param {string} source - Forgetting source.
|
|
1672
1906
|
* @throws {AgentbaseException}
|
|
1673
1907
|
* @returns {Promise<{}>}
|
|
1674
1908
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1675
1909
|
*/
|
|
1676
|
-
delete(memoryId: string, reason?: string, source?: string): Promise<{}>;
|
|
1910
|
+
delete(memoryId: string, memorySubStoreId?: string, reason?: string, source?: string): Promise<{}>;
|
|
1677
1911
|
/**
|
|
1678
1912
|
* List active read grants for one memory.
|
|
1679
1913
|
*
|
|
@@ -1768,4 +2002,242 @@ export declare class Memory {
|
|
|
1768
2002
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1769
2003
|
*/
|
|
1770
2004
|
listSources(memoryId: string, cursor?: string, limit?: number): Promise<{}>;
|
|
2005
|
+
/**
|
|
2006
|
+
* Configure Memory Pipelines.
|
|
2007
|
+
*
|
|
2008
|
+
* @param {Scenario} params.scenario - Pipeline scenario. Each scenario has its own default.
|
|
2009
|
+
* @throws {AgentbaseException}
|
|
2010
|
+
* @returns {Promise<{}>}
|
|
2011
|
+
*/
|
|
2012
|
+
listPipelines(params?: {
|
|
2013
|
+
scenario?: Scenario;
|
|
2014
|
+
}): Promise<{}>;
|
|
2015
|
+
/**
|
|
2016
|
+
* Configure Memory Pipelines.
|
|
2017
|
+
*
|
|
2018
|
+
* @param {Scenario} scenario - Pipeline scenario. Each scenario has its own default.
|
|
2019
|
+
* @throws {AgentbaseException}
|
|
2020
|
+
* @returns {Promise<{}>}
|
|
2021
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2022
|
+
*/
|
|
2023
|
+
listPipelines(scenario?: Scenario): Promise<{}>;
|
|
2024
|
+
/**
|
|
2025
|
+
* Configure Memory Pipelines.
|
|
2026
|
+
*
|
|
2027
|
+
* @param {Scenario} params.scenario - Pipeline scenario. Each scenario has its own default.
|
|
2028
|
+
* @param {boolean} params.fromDefaults - Create with current default step parameters.
|
|
2029
|
+
* @param {object} params.config - Ordered step configurations for the selected scenario.
|
|
2030
|
+
* @throws {AgentbaseException}
|
|
2031
|
+
* @returns {Promise<{}>}
|
|
2032
|
+
*/
|
|
2033
|
+
createPipeline(params?: {
|
|
2034
|
+
scenario?: Scenario;
|
|
2035
|
+
fromDefaults?: boolean;
|
|
2036
|
+
config?: object;
|
|
2037
|
+
}): Promise<{}>;
|
|
2038
|
+
/**
|
|
2039
|
+
* Configure Memory Pipelines.
|
|
2040
|
+
*
|
|
2041
|
+
* @param {Scenario} scenario - Pipeline scenario. Each scenario has its own default.
|
|
2042
|
+
* @param {boolean} fromDefaults - Create with current default step parameters.
|
|
2043
|
+
* @param {object} config - Ordered step configurations for the selected scenario.
|
|
2044
|
+
* @throws {AgentbaseException}
|
|
2045
|
+
* @returns {Promise<{}>}
|
|
2046
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2047
|
+
*/
|
|
2048
|
+
createPipeline(scenario?: Scenario, fromDefaults?: boolean, config?: object): Promise<{}>;
|
|
2049
|
+
/**
|
|
2050
|
+
* Configure Memory Pipelines.
|
|
2051
|
+
*
|
|
2052
|
+
* @param {Scenario} params.scenario - Pipeline scenario. Each scenario has its own default.
|
|
2053
|
+
* @param {string} params.pipelineId - Published Pipeline ID, or null to restore the system default.
|
|
2054
|
+
* @param {number} params.expectedRevision - Revision from the reviewed Pipeline. Required when pipelineId is not null.
|
|
2055
|
+
* @throws {AgentbaseException}
|
|
2056
|
+
* @returns {Promise<{}>}
|
|
2057
|
+
*/
|
|
2058
|
+
setDefaultPipeline(params?: {
|
|
2059
|
+
scenario?: Scenario;
|
|
2060
|
+
pipelineId?: string;
|
|
2061
|
+
expectedRevision?: number;
|
|
2062
|
+
}): Promise<{}>;
|
|
2063
|
+
/**
|
|
2064
|
+
* Configure Memory Pipelines.
|
|
2065
|
+
*
|
|
2066
|
+
* @param {Scenario} scenario - Pipeline scenario. Each scenario has its own default.
|
|
2067
|
+
* @param {string} pipelineId - Published Pipeline ID, or null to restore the system default.
|
|
2068
|
+
* @param {number} expectedRevision - Revision from the reviewed Pipeline. Required when pipelineId is not null.
|
|
2069
|
+
* @throws {AgentbaseException}
|
|
2070
|
+
* @returns {Promise<{}>}
|
|
2071
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2072
|
+
*/
|
|
2073
|
+
setDefaultPipeline(scenario?: Scenario, pipelineId?: string, expectedRevision?: number): Promise<{}>;
|
|
2074
|
+
/**
|
|
2075
|
+
* Configure a Memory Pipeline.
|
|
2076
|
+
*
|
|
2077
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2078
|
+
* @throws {AgentbaseException}
|
|
2079
|
+
* @returns {Promise<{}>}
|
|
2080
|
+
*/
|
|
2081
|
+
getPipeline(params: {
|
|
2082
|
+
pipelineId: string;
|
|
2083
|
+
}): Promise<{}>;
|
|
2084
|
+
/**
|
|
2085
|
+
* Configure a Memory Pipeline.
|
|
2086
|
+
*
|
|
2087
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2088
|
+
* @throws {AgentbaseException}
|
|
2089
|
+
* @returns {Promise<{}>}
|
|
2090
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2091
|
+
*/
|
|
2092
|
+
getPipeline(pipelineId: string): Promise<{}>;
|
|
2093
|
+
/**
|
|
2094
|
+
* Configure a Memory Pipeline.
|
|
2095
|
+
*
|
|
2096
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2097
|
+
* @param {number} params.expectedRevision - Expected editing revision.
|
|
2098
|
+
* @param {object} params.config - Complete Pipeline configuration.
|
|
2099
|
+
* @throws {AgentbaseException}
|
|
2100
|
+
* @returns {Promise<{}>}
|
|
2101
|
+
*/
|
|
2102
|
+
updatePipeline(params: {
|
|
2103
|
+
pipelineId: string;
|
|
2104
|
+
expectedRevision: number;
|
|
2105
|
+
config: object;
|
|
2106
|
+
}): Promise<{}>;
|
|
2107
|
+
/**
|
|
2108
|
+
* Configure a Memory Pipeline.
|
|
2109
|
+
*
|
|
2110
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2111
|
+
* @param {number} expectedRevision - Expected editing revision.
|
|
2112
|
+
* @param {object} config - Complete Pipeline configuration.
|
|
2113
|
+
* @throws {AgentbaseException}
|
|
2114
|
+
* @returns {Promise<{}>}
|
|
2115
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2116
|
+
*/
|
|
2117
|
+
updatePipeline(pipelineId: string, expectedRevision: number, config: object): Promise<{}>;
|
|
2118
|
+
/**
|
|
2119
|
+
* Delete a Memory Pipeline. Accepted tasks and existing business data are kept.
|
|
2120
|
+
*
|
|
2121
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2122
|
+
* @param {number} params.expectedRevision - Expected editing revision.
|
|
2123
|
+
* @throws {AgentbaseException}
|
|
2124
|
+
* @returns {Promise<{}>}
|
|
2125
|
+
*/
|
|
2126
|
+
deletePipeline(params: {
|
|
2127
|
+
pipelineId: string;
|
|
2128
|
+
expectedRevision: number;
|
|
2129
|
+
}): Promise<{}>;
|
|
2130
|
+
/**
|
|
2131
|
+
* Delete a Memory Pipeline. Accepted tasks and existing business data are kept.
|
|
2132
|
+
*
|
|
2133
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2134
|
+
* @param {number} expectedRevision - Expected editing revision.
|
|
2135
|
+
* @throws {AgentbaseException}
|
|
2136
|
+
* @returns {Promise<{}>}
|
|
2137
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2138
|
+
*/
|
|
2139
|
+
deletePipeline(pipelineId: string, expectedRevision: number): Promise<{}>;
|
|
2140
|
+
/**
|
|
2141
|
+
* Configure a Memory Pipeline.
|
|
2142
|
+
*
|
|
2143
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2144
|
+
* @param {string} params.versionId - Saved configuration version.
|
|
2145
|
+
* @param {number} params.expectedRevision - Expected editing revision.
|
|
2146
|
+
* @param {boolean} params.makeDefault - Make this the project default when publishing.
|
|
2147
|
+
* @throws {AgentbaseException}
|
|
2148
|
+
* @returns {Promise<{}>}
|
|
2149
|
+
*/
|
|
2150
|
+
publishPipeline(params: {
|
|
2151
|
+
pipelineId: string;
|
|
2152
|
+
versionId: string;
|
|
2153
|
+
expectedRevision: number;
|
|
2154
|
+
makeDefault?: boolean;
|
|
2155
|
+
}): Promise<{}>;
|
|
2156
|
+
/**
|
|
2157
|
+
* Configure a Memory Pipeline.
|
|
2158
|
+
*
|
|
2159
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2160
|
+
* @param {string} versionId - Saved configuration version.
|
|
2161
|
+
* @param {number} expectedRevision - Expected editing revision.
|
|
2162
|
+
* @param {boolean} makeDefault - Make this the project default when publishing.
|
|
2163
|
+
* @throws {AgentbaseException}
|
|
2164
|
+
* @returns {Promise<{}>}
|
|
2165
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2166
|
+
*/
|
|
2167
|
+
publishPipeline(pipelineId: string, versionId: string, expectedRevision: number, makeDefault?: boolean): Promise<{}>;
|
|
2168
|
+
/**
|
|
2169
|
+
* Configure a Memory Pipeline.
|
|
2170
|
+
*
|
|
2171
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2172
|
+
* @param {string} params.versionId - Previously published version.
|
|
2173
|
+
* @param {number} params.expectedRevision - Expected editing revision.
|
|
2174
|
+
* @throws {AgentbaseException}
|
|
2175
|
+
* @returns {Promise<{}>}
|
|
2176
|
+
*/
|
|
2177
|
+
rollbackPipeline(params: {
|
|
2178
|
+
pipelineId: string;
|
|
2179
|
+
versionId: string;
|
|
2180
|
+
expectedRevision: number;
|
|
2181
|
+
}): Promise<{}>;
|
|
2182
|
+
/**
|
|
2183
|
+
* Configure a Memory Pipeline.
|
|
2184
|
+
*
|
|
2185
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2186
|
+
* @param {string} versionId - Previously published version.
|
|
2187
|
+
* @param {number} expectedRevision - Expected editing revision.
|
|
2188
|
+
* @throws {AgentbaseException}
|
|
2189
|
+
* @returns {Promise<{}>}
|
|
2190
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2191
|
+
*/
|
|
2192
|
+
rollbackPipeline(pipelineId: string, versionId: string, expectedRevision: number): Promise<{}>;
|
|
2193
|
+
/**
|
|
2194
|
+
* Validate a Memory Pipeline.
|
|
2195
|
+
*
|
|
2196
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2197
|
+
* @param {string} params.versionId - Saved configuration version.
|
|
2198
|
+
* @param {object} params.data - Sample input for the Pipeline scenario, evaluated without business writes.
|
|
2199
|
+
* @throws {AgentbaseException}
|
|
2200
|
+
* @returns {Promise<{}>}
|
|
2201
|
+
*/
|
|
2202
|
+
validatePipeline(params: {
|
|
2203
|
+
pipelineId: string;
|
|
2204
|
+
versionId: string;
|
|
2205
|
+
data: object;
|
|
2206
|
+
}): Promise<{}>;
|
|
2207
|
+
/**
|
|
2208
|
+
* Validate a Memory Pipeline.
|
|
2209
|
+
*
|
|
2210
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2211
|
+
* @param {string} versionId - Saved configuration version.
|
|
2212
|
+
* @param {object} data - Sample input for the Pipeline scenario, evaluated without business writes.
|
|
2213
|
+
* @throws {AgentbaseException}
|
|
2214
|
+
* @returns {Promise<{}>}
|
|
2215
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2216
|
+
*/
|
|
2217
|
+
validatePipeline(pipelineId: string, versionId: string, data: object): Promise<{}>;
|
|
2218
|
+
/**
|
|
2219
|
+
* Configure a Memory Pipeline.
|
|
2220
|
+
*
|
|
2221
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2222
|
+
* @param {string} params.versionId - Optional exact configuration version, including retained history after Pipeline deletion.
|
|
2223
|
+
* @param {number | bigint} params.beforeRevision - Load versions older than this revision; omit for the newest 100 versions.
|
|
2224
|
+
* @throws {AgentbaseException}
|
|
2225
|
+
* @returns {Promise<{}>}
|
|
2226
|
+
*/
|
|
2227
|
+
listPipelineVersions(params: {
|
|
2228
|
+
pipelineId: string;
|
|
2229
|
+
versionId?: string;
|
|
2230
|
+
beforeRevision?: number | bigint;
|
|
2231
|
+
}): Promise<{}>;
|
|
2232
|
+
/**
|
|
2233
|
+
* Configure a Memory Pipeline.
|
|
2234
|
+
*
|
|
2235
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2236
|
+
* @param {string} versionId - Optional exact configuration version, including retained history after Pipeline deletion.
|
|
2237
|
+
* @param {number | bigint} beforeRevision - Load versions older than this revision; omit for the newest 100 versions.
|
|
2238
|
+
* @throws {AgentbaseException}
|
|
2239
|
+
* @returns {Promise<{}>}
|
|
2240
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2241
|
+
*/
|
|
2242
|
+
listPipelineVersions(pipelineId: string, versionId?: string, beforeRevision?: number | bigint): Promise<{}>;
|
|
1771
2243
|
}
|