agentbase-web-sdk 2.9.0 → 2.12.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 +2456 -664
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +2456 -665
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +2456 -664
- package/package.json +3 -3
- package/types/enums/data-api-catalog-data-source-database-type.d.ts +6 -0
- package/types/enums/data-api-catalog-data-source-visibility-source.d.ts +7 -0
- package/types/enums/data-api-catalog-database-availability.d.ts +5 -0
- package/types/enums/data-api-catalog-database-classification.d.ts +4 -0
- package/types/enums/data-api-catalog-database-status.d.ts +4 -0
- package/types/enums/data-api-catalog-database-visibility-source.d.ts +7 -0
- package/types/enums/data-api-filter-logic.d.ts +4 -0
- package/types/enums/data-api-owned-binding-principal-type.d.ts +4 -0
- package/types/enums/data-api-owned-binding-status.d.ts +4 -0
- package/types/enums/memory-pipeline-run-result-status.d.ts +4 -0
- package/types/enums/memory-pipeline-run-scenario.d.ts +6 -0
- package/types/enums/memory-pipeline-run-status.d.ts +6 -0
- 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/scene.d.ts +4 -0
- package/types/enums/status.d.ts +7 -1
- package/types/enums/timezone.d.ts +1 -0
- package/types/index.d.ts +19 -2
- package/types/models.d.ts +798 -4
- package/types/services/account.d.ts +85 -2
- package/types/services/ai-gateway.d.ts +90 -0
- package/types/services/data-api.d.ts +257 -0
- package/types/services/functions.d.ts +35 -7
- package/types/services/knowledge-bases.d.ts +186 -2
- package/types/services/llm-gateway.d.ts +8 -1
- package/types/services/memory.d.ts +600 -19
|
@@ -17,11 +17,12 @@ import { FeedbackType } from '../enums/feedback-type';
|
|
|
17
17
|
import { ValidationStatus } from '../enums/validation-status';
|
|
18
18
|
import { Outcome } from '../enums/outcome';
|
|
19
19
|
import { VerificationSource } from '../enums/verification-source';
|
|
20
|
-
import { Kinds } from '../enums/kinds';
|
|
21
20
|
import { ProfileType } from '../enums/profile-type';
|
|
21
|
+
import { Kinds } from '../enums/kinds';
|
|
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,17 +86,20 @@ 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.
|
|
93
96
|
* @param {MemorySensitivity} params.sensitivity - Content classification. Secret values must use Agentbase Secret or variables.
|
|
94
97
|
* @param {MemoryHandlingPolicy} params.handlingPolicy - Processing restriction. no_model requires infer=false.
|
|
95
98
|
* @param {object} params.metadata - Memory metadata.
|
|
99
|
+
* @param {object} params.sourceContext - Optional source conversationTime (YYYY-MM-DD or RFC3339 with offset) and timeZone (IANA). Missing conversation time stays unknown; it is not the event or import time.
|
|
96
100
|
* @param {boolean} params.infer - Use configured model-assisted extraction and cross-type deduplication. Defaults to true.
|
|
97
101
|
* @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
|
|
102
|
+
* @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
103
|
* @throws {AgentbaseException}
|
|
100
104
|
* @returns {Promise<{}>}
|
|
101
105
|
*/
|
|
@@ -104,14 +108,17 @@ export declare class Memory {
|
|
|
104
108
|
scope: MemoryScope;
|
|
105
109
|
memoryType: string;
|
|
106
110
|
recordKind: RecordKind;
|
|
111
|
+
pipelineId?: string;
|
|
107
112
|
content?: string;
|
|
108
113
|
messages?: Models.MemoryMessage[];
|
|
114
|
+
media?: object;
|
|
109
115
|
agentId?: string;
|
|
110
116
|
runId?: string;
|
|
111
117
|
sessionId?: string;
|
|
112
118
|
sensitivity?: MemorySensitivity;
|
|
113
119
|
handlingPolicy?: MemoryHandlingPolicy;
|
|
114
120
|
metadata?: object;
|
|
121
|
+
sourceContext?: object;
|
|
115
122
|
infer?: boolean;
|
|
116
123
|
reRemember?: boolean;
|
|
117
124
|
async?: boolean;
|
|
@@ -123,26 +130,30 @@ export declare class Memory {
|
|
|
123
130
|
* @param {MemoryScope} scope - Memory visibility scope.
|
|
124
131
|
* @param {string} memoryType - Memory type. With infer=true, conversation input is retained as source evidence and derived records use long_term.
|
|
125
132
|
* @param {RecordKind} recordKind - Memory record kind. With infer=true, conversation input derives fact records.
|
|
126
|
-
* @param {string}
|
|
133
|
+
* @param {string} pipelineId - Optional published add-memory Pipeline ID. Omit to use the project default or system default.
|
|
134
|
+
* @param {string} content - Compatibility memory text. Required when messages and media are omitted.
|
|
127
135
|
* @param {Models.MemoryMessage[]} messages - Optional typed role/content messages used as source evidence.
|
|
136
|
+
* @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
137
|
* @param {string} agentId - Optional agent ID.
|
|
129
138
|
* @param {string} runId - Optional run ID.
|
|
130
139
|
* @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.
|
|
131
140
|
* @param {MemorySensitivity} sensitivity - Content classification. Secret values must use Agentbase Secret or variables.
|
|
132
141
|
* @param {MemoryHandlingPolicy} handlingPolicy - Processing restriction. no_model requires infer=false.
|
|
133
142
|
* @param {object} metadata - Memory metadata.
|
|
143
|
+
* @param {object} sourceContext - Optional source conversationTime (YYYY-MM-DD or RFC3339 with offset) and timeZone (IANA). Missing conversation time stays unknown; it is not the event or import time.
|
|
134
144
|
* @param {boolean} infer - Use configured model-assisted extraction and cross-type deduplication. Defaults to true.
|
|
135
145
|
* @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
|
|
146
|
+
* @param {boolean} async - Queue memory creation and return immediately. Defaults to the infer value for text; media always requires true, including infer=false.
|
|
137
147
|
* @throws {AgentbaseException}
|
|
138
148
|
* @returns {Promise<{}>}
|
|
139
149
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
140
150
|
*/
|
|
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<{}>;
|
|
151
|
+
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, sourceContext?: object, infer?: boolean, reRemember?: boolean, async?: boolean): Promise<{}>;
|
|
142
152
|
/**
|
|
143
153
|
* Forget memory records in one bounded pass. Repeat while hasMore is true and inspect failed and items before considering the scope fully deleted.
|
|
144
154
|
*
|
|
145
155
|
* @param {string} params.userId - Target user ID.
|
|
156
|
+
* @param {string} params.memorySubStoreId - Memory sub-store for erasure.
|
|
146
157
|
* @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
158
|
* @param {string} params.reason - Forgetting reason.
|
|
148
159
|
* @param {string} params.source - Forgetting source.
|
|
@@ -151,6 +162,7 @@ export declare class Memory {
|
|
|
151
162
|
*/
|
|
152
163
|
deleteMany(params?: {
|
|
153
164
|
userId?: string;
|
|
165
|
+
memorySubStoreId?: string;
|
|
154
166
|
limit?: number;
|
|
155
167
|
reason?: string;
|
|
156
168
|
source?: string;
|
|
@@ -159,6 +171,7 @@ export declare class Memory {
|
|
|
159
171
|
* Forget memory records in one bounded pass. Repeat while hasMore is true and inspect failed and items before considering the scope fully deleted.
|
|
160
172
|
*
|
|
161
173
|
* @param {string} userId - Target user ID.
|
|
174
|
+
* @param {string} memorySubStoreId - Memory sub-store for erasure.
|
|
162
175
|
* @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
176
|
* @param {string} reason - Forgetting reason.
|
|
164
177
|
* @param {string} source - Forgetting source.
|
|
@@ -166,7 +179,7 @@ export declare class Memory {
|
|
|
166
179
|
* @returns {Promise<Models.MemoryBulkDeleteResponse>}
|
|
167
180
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
168
181
|
*/
|
|
169
|
-
deleteMany(userId?: string, limit?: number, reason?: string, source?: string): Promise<Models.MemoryBulkDeleteResponse>;
|
|
182
|
+
deleteMany(userId?: string, memorySubStoreId?: string, limit?: number, reason?: string, source?: string): Promise<Models.MemoryBulkDeleteResponse>;
|
|
170
183
|
/**
|
|
171
184
|
* Run a bounded batch of memory operations.
|
|
172
185
|
*
|
|
@@ -518,6 +531,7 @@ export declare class Memory {
|
|
|
518
531
|
* @param {string} params.sessionId - Source session ID.
|
|
519
532
|
* @param {string} params.runId - Source run ID.
|
|
520
533
|
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
534
|
+
* @param {string} params.pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
521
535
|
* @param {string} params.sourceId - Persisted source ID.
|
|
522
536
|
* @param {SourceType} params.sourceType - Persisted source type.
|
|
523
537
|
* @param {Models.DistillationMessage[]} params.messages - Bounded conversation messages.
|
|
@@ -534,6 +548,7 @@ export declare class Memory {
|
|
|
534
548
|
sessionId?: string;
|
|
535
549
|
runId?: string;
|
|
536
550
|
memorySubStoreId?: string;
|
|
551
|
+
pipelineId?: string;
|
|
537
552
|
sourceId?: string;
|
|
538
553
|
sourceType?: SourceType;
|
|
539
554
|
messages?: Models.DistillationMessage[];
|
|
@@ -550,6 +565,7 @@ export declare class Memory {
|
|
|
550
565
|
* @param {string} sessionId - Source session ID.
|
|
551
566
|
* @param {string} runId - Source run ID.
|
|
552
567
|
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
568
|
+
* @param {string} pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
553
569
|
* @param {string} sourceId - Persisted source ID.
|
|
554
570
|
* @param {SourceType} sourceType - Persisted source type.
|
|
555
571
|
* @param {Models.DistillationMessage[]} messages - Bounded conversation messages.
|
|
@@ -560,7 +576,7 @@ export declare class Memory {
|
|
|
560
576
|
* @returns {Promise<{}>}
|
|
561
577
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
562
578
|
*/
|
|
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<{}>;
|
|
579
|
+
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
580
|
/**
|
|
565
581
|
* Get a distillation job and its output references.
|
|
566
582
|
*
|
|
@@ -944,6 +960,7 @@ export declare class Memory {
|
|
|
944
960
|
* Create a memory import job.
|
|
945
961
|
*
|
|
946
962
|
* @param {string} params.userId - Target user ID.
|
|
963
|
+
* @param {string} params.pipelineId - Published add-memory Pipeline ID applied to every imported record. Omit to use the default Pipeline.
|
|
947
964
|
* @param {Format} params.format - Import format.
|
|
948
965
|
* @param {string} params.data - Raw JSON or JSONL import data.
|
|
949
966
|
* @param {Models.MemoryRecordInput[]} params.records - Structured memory records.
|
|
@@ -953,6 +970,7 @@ export declare class Memory {
|
|
|
953
970
|
*/
|
|
954
971
|
createImport(params: {
|
|
955
972
|
userId: string;
|
|
973
|
+
pipelineId?: string;
|
|
956
974
|
format?: Format;
|
|
957
975
|
data?: string;
|
|
958
976
|
records?: Models.MemoryRecordInput[];
|
|
@@ -962,6 +980,7 @@ export declare class Memory {
|
|
|
962
980
|
* Create a memory import job.
|
|
963
981
|
*
|
|
964
982
|
* @param {string} userId - Target user ID.
|
|
983
|
+
* @param {string} pipelineId - Published add-memory Pipeline ID applied to every imported record. Omit to use the default Pipeline.
|
|
965
984
|
* @param {Format} format - Import format.
|
|
966
985
|
* @param {string} data - Raw JSON or JSONL import data.
|
|
967
986
|
* @param {Models.MemoryRecordInput[]} records - Structured memory records.
|
|
@@ -970,7 +989,7 @@ export declare class Memory {
|
|
|
970
989
|
* @returns {Promise<{}>}
|
|
971
990
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
972
991
|
*/
|
|
973
|
-
createImport(userId: string, format?: Format, data?: string, records?: Models.MemoryRecordInput[], dryRun?: boolean): Promise<{}>;
|
|
992
|
+
createImport(userId: string, pipelineId?: string, format?: Format, data?: string, records?: Models.MemoryRecordInput[], dryRun?: boolean): Promise<{}>;
|
|
974
993
|
/**
|
|
975
994
|
* Get a memory import job by its unique ID.
|
|
976
995
|
*
|
|
@@ -990,6 +1009,89 @@ export declare class Memory {
|
|
|
990
1009
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
991
1010
|
*/
|
|
992
1011
|
getImport(importId: string): Promise<{}>;
|
|
1012
|
+
/**
|
|
1013
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1014
|
+
*
|
|
1015
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1016
|
+
* @param {string} params.userId - Target user ID.
|
|
1017
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1018
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1019
|
+
* @param {string} params.runId - Source run ID.
|
|
1020
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1021
|
+
* @param {number} params.limit - Page size, maximum 100.
|
|
1022
|
+
* @param {number} params.offset - Page offset.
|
|
1023
|
+
* @param {Status} params.status - Review status.
|
|
1024
|
+
* @param {string} params.knowledgeId - Knowledge ID filter.
|
|
1025
|
+
* @throws {AgentbaseException}
|
|
1026
|
+
* @returns {Promise<{}>}
|
|
1027
|
+
*/
|
|
1028
|
+
listKnowledgeReviews(params?: {
|
|
1029
|
+
scope?: Scope;
|
|
1030
|
+
userId?: string;
|
|
1031
|
+
agentId?: string;
|
|
1032
|
+
sessionId?: string;
|
|
1033
|
+
runId?: string;
|
|
1034
|
+
memorySubStoreId?: string;
|
|
1035
|
+
limit?: number;
|
|
1036
|
+
offset?: number;
|
|
1037
|
+
status?: Status;
|
|
1038
|
+
knowledgeId?: string;
|
|
1039
|
+
}): Promise<{}>;
|
|
1040
|
+
/**
|
|
1041
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1042
|
+
*
|
|
1043
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1044
|
+
* @param {string} userId - Target user ID.
|
|
1045
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1046
|
+
* @param {string} sessionId - Source session ID.
|
|
1047
|
+
* @param {string} runId - Source run ID.
|
|
1048
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1049
|
+
* @param {number} limit - Page size, maximum 100.
|
|
1050
|
+
* @param {number} offset - Page offset.
|
|
1051
|
+
* @param {Status} status - Review status.
|
|
1052
|
+
* @param {string} knowledgeId - Knowledge ID filter.
|
|
1053
|
+
* @throws {AgentbaseException}
|
|
1054
|
+
* @returns {Promise<{}>}
|
|
1055
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1056
|
+
*/
|
|
1057
|
+
listKnowledgeReviews(scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, limit?: number, offset?: number, status?: Status, knowledgeId?: string): Promise<{}>;
|
|
1058
|
+
/**
|
|
1059
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1060
|
+
*
|
|
1061
|
+
* @param {string} params.reviewId - reviewId
|
|
1062
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1063
|
+
* @param {string} params.userId - Target user ID.
|
|
1064
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1065
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1066
|
+
* @param {string} params.runId - Source run ID.
|
|
1067
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1068
|
+
* @throws {AgentbaseException}
|
|
1069
|
+
* @returns {Promise<{}>}
|
|
1070
|
+
*/
|
|
1071
|
+
getKnowledgeReview(params: {
|
|
1072
|
+
reviewId: string;
|
|
1073
|
+
scope?: Scope;
|
|
1074
|
+
userId?: string;
|
|
1075
|
+
agentId?: string;
|
|
1076
|
+
sessionId?: string;
|
|
1077
|
+
runId?: string;
|
|
1078
|
+
memorySubStoreId?: string;
|
|
1079
|
+
}): Promise<{}>;
|
|
1080
|
+
/**
|
|
1081
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1082
|
+
*
|
|
1083
|
+
* @param {string} reviewId - reviewId
|
|
1084
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1085
|
+
* @param {string} userId - Target user ID.
|
|
1086
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1087
|
+
* @param {string} sessionId - Source session ID.
|
|
1088
|
+
* @param {string} runId - Source run ID.
|
|
1089
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1090
|
+
* @throws {AgentbaseException}
|
|
1091
|
+
* @returns {Promise<{}>}
|
|
1092
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1093
|
+
*/
|
|
1094
|
+
getKnowledgeReview(reviewId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
993
1095
|
/**
|
|
994
1096
|
* Update managed knowledge state.
|
|
995
1097
|
*
|
|
@@ -1082,6 +1184,129 @@ export declare class Memory {
|
|
|
1082
1184
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1083
1185
|
*/
|
|
1084
1186
|
forgetKnowledge(knowledgeId: string, expectedVersion: number, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, reason?: string, source?: string): Promise<{}>;
|
|
1187
|
+
/**
|
|
1188
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1189
|
+
*
|
|
1190
|
+
* @param {string} params.knowledgeId - knowledgeId
|
|
1191
|
+
* @param {string} params.toRevisionId - Candidate revision.
|
|
1192
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1193
|
+
* @param {string} params.userId - Target user ID.
|
|
1194
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1195
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1196
|
+
* @param {string} params.runId - Source run ID.
|
|
1197
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1198
|
+
* @param {string} params.fromRevisionId - Base revision; empty compares a new item.
|
|
1199
|
+
* @throws {AgentbaseException}
|
|
1200
|
+
* @returns {Promise<{}>}
|
|
1201
|
+
*/
|
|
1202
|
+
getKnowledgeDiff(params: {
|
|
1203
|
+
knowledgeId: string;
|
|
1204
|
+
toRevisionId: string;
|
|
1205
|
+
scope?: Scope;
|
|
1206
|
+
userId?: string;
|
|
1207
|
+
agentId?: string;
|
|
1208
|
+
sessionId?: string;
|
|
1209
|
+
runId?: string;
|
|
1210
|
+
memorySubStoreId?: string;
|
|
1211
|
+
fromRevisionId?: string;
|
|
1212
|
+
}): Promise<{}>;
|
|
1213
|
+
/**
|
|
1214
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1215
|
+
*
|
|
1216
|
+
* @param {string} knowledgeId - knowledgeId
|
|
1217
|
+
* @param {string} toRevisionId - Candidate revision.
|
|
1218
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1219
|
+
* @param {string} userId - Target user ID.
|
|
1220
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1221
|
+
* @param {string} sessionId - Source session ID.
|
|
1222
|
+
* @param {string} runId - Source run ID.
|
|
1223
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1224
|
+
* @param {string} fromRevisionId - Base revision; empty compares a new item.
|
|
1225
|
+
* @throws {AgentbaseException}
|
|
1226
|
+
* @returns {Promise<{}>}
|
|
1227
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1228
|
+
*/
|
|
1229
|
+
getKnowledgeDiff(knowledgeId: string, toRevisionId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, fromRevisionId?: string): Promise<{}>;
|
|
1230
|
+
/**
|
|
1231
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1232
|
+
*
|
|
1233
|
+
* @param {string} params.knowledgeId - knowledgeId
|
|
1234
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1235
|
+
* @param {string} params.userId - Target user ID.
|
|
1236
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1237
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1238
|
+
* @param {string} params.runId - Source run ID.
|
|
1239
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1240
|
+
* @throws {AgentbaseException}
|
|
1241
|
+
* @returns {Promise<{}>}
|
|
1242
|
+
*/
|
|
1243
|
+
listKnowledgeEvents(params: {
|
|
1244
|
+
knowledgeId: string;
|
|
1245
|
+
scope?: Scope;
|
|
1246
|
+
userId?: string;
|
|
1247
|
+
agentId?: string;
|
|
1248
|
+
sessionId?: string;
|
|
1249
|
+
runId?: string;
|
|
1250
|
+
memorySubStoreId?: string;
|
|
1251
|
+
}): Promise<{}>;
|
|
1252
|
+
/**
|
|
1253
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1254
|
+
*
|
|
1255
|
+
* @param {string} knowledgeId - knowledgeId
|
|
1256
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1257
|
+
* @param {string} userId - Target user ID.
|
|
1258
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1259
|
+
* @param {string} sessionId - Source session ID.
|
|
1260
|
+
* @param {string} runId - Source run ID.
|
|
1261
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1262
|
+
* @throws {AgentbaseException}
|
|
1263
|
+
* @returns {Promise<{}>}
|
|
1264
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1265
|
+
*/
|
|
1266
|
+
listKnowledgeEvents(knowledgeId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string): Promise<{}>;
|
|
1267
|
+
/**
|
|
1268
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1269
|
+
*
|
|
1270
|
+
* @param {string} params.knowledgeId - knowledgeId
|
|
1271
|
+
* @param {Scope} params.scope - Knowledge ownership scope.
|
|
1272
|
+
* @param {string} params.userId - Target user ID.
|
|
1273
|
+
* @param {string} params.agentId - Agent ID for agent scope.
|
|
1274
|
+
* @param {string} params.sessionId - Source session ID.
|
|
1275
|
+
* @param {string} params.runId - Source run ID.
|
|
1276
|
+
* @param {string} params.memorySubStoreId - Bound memory sub-store ID.
|
|
1277
|
+
* @param {number} params.limit - Page size, maximum 100.
|
|
1278
|
+
* @param {number} params.offset - Page offset.
|
|
1279
|
+
* @throws {AgentbaseException}
|
|
1280
|
+
* @returns {Promise<{}>}
|
|
1281
|
+
*/
|
|
1282
|
+
listKnowledgeRevisions(params: {
|
|
1283
|
+
knowledgeId: string;
|
|
1284
|
+
scope?: Scope;
|
|
1285
|
+
userId?: string;
|
|
1286
|
+
agentId?: string;
|
|
1287
|
+
sessionId?: string;
|
|
1288
|
+
runId?: string;
|
|
1289
|
+
memorySubStoreId?: string;
|
|
1290
|
+
limit?: number;
|
|
1291
|
+
offset?: number;
|
|
1292
|
+
}): Promise<{}>;
|
|
1293
|
+
/**
|
|
1294
|
+
* Manage immutable Knowledge versions and optional human review.
|
|
1295
|
+
*
|
|
1296
|
+
* @param {string} knowledgeId - knowledgeId
|
|
1297
|
+
* @param {Scope} scope - Knowledge ownership scope.
|
|
1298
|
+
* @param {string} userId - Target user ID.
|
|
1299
|
+
* @param {string} agentId - Agent ID for agent scope.
|
|
1300
|
+
* @param {string} sessionId - Source session ID.
|
|
1301
|
+
* @param {string} runId - Source run ID.
|
|
1302
|
+
* @param {string} memorySubStoreId - Bound memory sub-store ID.
|
|
1303
|
+
* @param {number} limit - Page size, maximum 100.
|
|
1304
|
+
* @param {number} offset - Page offset.
|
|
1305
|
+
* @throws {AgentbaseException}
|
|
1306
|
+
* @returns {Promise<{}>}
|
|
1307
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1308
|
+
*/
|
|
1309
|
+
listKnowledgeRevisions(knowledgeId: string, scope?: Scope, userId?: string, agentId?: string, sessionId?: string, runId?: string, memorySubStoreId?: string, limit?: number, offset?: number): Promise<{}>;
|
|
1085
1310
|
/**
|
|
1086
1311
|
* Record bounded evidence for a knowledge revision.
|
|
1087
1312
|
*
|
|
@@ -1158,6 +1383,34 @@ export declare class Memory {
|
|
|
1158
1383
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1159
1384
|
*/
|
|
1160
1385
|
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<{}>;
|
|
1386
|
+
/**
|
|
1387
|
+
* List live user memory profiles.
|
|
1388
|
+
*
|
|
1389
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
1390
|
+
* @param {number} params.limit - Maximum number of profiles.
|
|
1391
|
+
* @param {string} params.userId - Target user ID.
|
|
1392
|
+
* @param {ProfileType} params.profileType - Profile type. Omit to include every type.
|
|
1393
|
+
* @throws {AgentbaseException}
|
|
1394
|
+
* @returns {Promise<{}>}
|
|
1395
|
+
*/
|
|
1396
|
+
listProfiles(params?: {
|
|
1397
|
+
cursor?: string;
|
|
1398
|
+
limit?: number;
|
|
1399
|
+
userId?: string;
|
|
1400
|
+
profileType?: ProfileType;
|
|
1401
|
+
}): Promise<{}>;
|
|
1402
|
+
/**
|
|
1403
|
+
* List live user memory profiles.
|
|
1404
|
+
*
|
|
1405
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
1406
|
+
* @param {number} limit - Maximum number of profiles.
|
|
1407
|
+
* @param {string} userId - Target user ID.
|
|
1408
|
+
* @param {ProfileType} profileType - Profile type. Omit to include every type.
|
|
1409
|
+
* @throws {AgentbaseException}
|
|
1410
|
+
* @returns {Promise<{}>}
|
|
1411
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1412
|
+
*/
|
|
1413
|
+
listProfiles(cursor?: string, limit?: number, userId?: string, profileType?: ProfileType): Promise<{}>;
|
|
1161
1414
|
/**
|
|
1162
1415
|
* Get a memory quality report.
|
|
1163
1416
|
*
|
|
@@ -1218,11 +1471,12 @@ export declare class Memory {
|
|
|
1218
1471
|
*/
|
|
1219
1472
|
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<{}>;
|
|
1220
1473
|
/**
|
|
1221
|
-
* Search memory records
|
|
1474
|
+
* Search visible memory records. When memoryLinking is enabled, includes one bounded hop of L1 evidence and typed links between returned records. Historical facts remain visible.
|
|
1222
1475
|
*
|
|
1223
|
-
* @param {string} params.query - Search query.
|
|
1476
|
+
* @param {string} params.query - Search query. May be omitted with media.
|
|
1224
1477
|
* @param {string} params.searchMode - Recall mode override.
|
|
1225
1478
|
* @param {object} params.retrieval - Recall route overrides. sparse=false skips model-generated sparse recall for this request; omitted defaults to the project setting.
|
|
1479
|
+
* @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
1480
|
* @param {string} params.userId - Target user ID.
|
|
1227
1481
|
* @param {string} params.agentId - Agent ID filter.
|
|
1228
1482
|
* @param {string} params.runId - Run ID filter.
|
|
@@ -1230,6 +1484,7 @@ export declare class Memory {
|
|
|
1230
1484
|
* @param {string} params.memoryType - Memory type filter.
|
|
1231
1485
|
* @param {string} params.recordKind - Record kind filter.
|
|
1232
1486
|
* @param {object} params.filter - Structured memory filter.
|
|
1487
|
+
* @param {object} params.temporal - Optional mode current, asOf or history; asOf requires a timestamp with timezone. Uncertain facts are returned separately.
|
|
1233
1488
|
* @param {number} params.limit - Maximum results; zero uses the project default.
|
|
1234
1489
|
* @param {string} params.cursor - Pagination cursor.
|
|
1235
1490
|
* @param {string} params.sort - Sort mode.
|
|
@@ -1240,10 +1495,11 @@ export declare class Memory {
|
|
|
1240
1495
|
* @throws {AgentbaseException}
|
|
1241
1496
|
* @returns {Promise<{}>}
|
|
1242
1497
|
*/
|
|
1243
|
-
search(params
|
|
1244
|
-
query
|
|
1498
|
+
search(params?: {
|
|
1499
|
+
query?: string;
|
|
1245
1500
|
searchMode?: string;
|
|
1246
1501
|
retrieval?: object;
|
|
1502
|
+
media?: object;
|
|
1247
1503
|
userId?: string;
|
|
1248
1504
|
agentId?: string;
|
|
1249
1505
|
runId?: string;
|
|
@@ -1251,6 +1507,7 @@ export declare class Memory {
|
|
|
1251
1507
|
memoryType?: string;
|
|
1252
1508
|
recordKind?: string;
|
|
1253
1509
|
filter?: object;
|
|
1510
|
+
temporal?: object;
|
|
1254
1511
|
limit?: number;
|
|
1255
1512
|
cursor?: string;
|
|
1256
1513
|
sort?: string;
|
|
@@ -1260,11 +1517,12 @@ export declare class Memory {
|
|
|
1260
1517
|
accessMode?: MemoryAccessMode;
|
|
1261
1518
|
}): Promise<{}>;
|
|
1262
1519
|
/**
|
|
1263
|
-
* Search memory records
|
|
1520
|
+
* Search visible memory records. When memoryLinking is enabled, includes one bounded hop of L1 evidence and typed links between returned records. Historical facts remain visible.
|
|
1264
1521
|
*
|
|
1265
|
-
* @param {string} query - Search query.
|
|
1522
|
+
* @param {string} query - Search query. May be omitted with media.
|
|
1266
1523
|
* @param {string} searchMode - Recall mode override.
|
|
1267
1524
|
* @param {object} retrieval - Recall route overrides. sparse=false skips model-generated sparse recall for this request; omitted defaults to the project setting.
|
|
1525
|
+
* @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
1526
|
* @param {string} userId - Target user ID.
|
|
1269
1527
|
* @param {string} agentId - Agent ID filter.
|
|
1270
1528
|
* @param {string} runId - Run ID filter.
|
|
@@ -1272,6 +1530,7 @@ export declare class Memory {
|
|
|
1272
1530
|
* @param {string} memoryType - Memory type filter.
|
|
1273
1531
|
* @param {string} recordKind - Record kind filter.
|
|
1274
1532
|
* @param {object} filter - Structured memory filter.
|
|
1533
|
+
* @param {object} temporal - Optional mode current, asOf or history; asOf requires a timestamp with timezone. Uncertain facts are returned separately.
|
|
1275
1534
|
* @param {number} limit - Maximum results; zero uses the project default.
|
|
1276
1535
|
* @param {string} cursor - Pagination cursor.
|
|
1277
1536
|
* @param {string} sort - Sort mode.
|
|
@@ -1283,7 +1542,7 @@ export declare class Memory {
|
|
|
1283
1542
|
* @returns {Promise<{}>}
|
|
1284
1543
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1285
1544
|
*/
|
|
1286
|
-
search(query
|
|
1545
|
+
search(query?: string, searchMode?: string, retrieval?: object, media?: object, userId?: string, agentId?: string, runId?: string, scope?: string, memoryType?: string, recordKind?: string, filter?: object, temporal?: object, limit?: number, cursor?: string, sort?: string, memorySubStoreId?: string, sessionId?: string, groupId?: string, accessMode?: MemoryAccessMode): Promise<{}>;
|
|
1287
1546
|
/**
|
|
1288
1547
|
* Get memory session aggregates.
|
|
1289
1548
|
*
|
|
@@ -1525,6 +1784,7 @@ export declare class Memory {
|
|
|
1525
1784
|
* Create a user memory profile extraction.
|
|
1526
1785
|
*
|
|
1527
1786
|
* @param {string} params.userId - Target user ID.
|
|
1787
|
+
* @param {string} params.pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
1528
1788
|
* @param {ProfileType} params.profileType - Profile type.
|
|
1529
1789
|
* @param {Models.MemoryMessage[]} params.messages - Typed role/content messages used as source evidence.
|
|
1530
1790
|
* @param {string[]} params.sourceMemoryIds - Existing memory IDs used as replacement evidence.
|
|
@@ -1535,6 +1795,7 @@ export declare class Memory {
|
|
|
1535
1795
|
*/
|
|
1536
1796
|
createProfileExtraction(params: {
|
|
1537
1797
|
userId: string;
|
|
1798
|
+
pipelineId?: string;
|
|
1538
1799
|
profileType?: ProfileType;
|
|
1539
1800
|
messages?: Models.MemoryMessage[];
|
|
1540
1801
|
sourceMemoryIds?: string[];
|
|
@@ -1545,6 +1806,7 @@ export declare class Memory {
|
|
|
1545
1806
|
* Create a user memory profile extraction.
|
|
1546
1807
|
*
|
|
1547
1808
|
* @param {string} userId - Target user ID.
|
|
1809
|
+
* @param {string} pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
1548
1810
|
* @param {ProfileType} profileType - Profile type.
|
|
1549
1811
|
* @param {Models.MemoryMessage[]} messages - Typed role/content messages used as source evidence.
|
|
1550
1812
|
* @param {string[]} sourceMemoryIds - Existing memory IDs used as replacement evidence.
|
|
@@ -1554,29 +1816,32 @@ export declare class Memory {
|
|
|
1554
1816
|
* @returns {Promise<{}>}
|
|
1555
1817
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1556
1818
|
*/
|
|
1557
|
-
createProfileExtraction(userId: string, profileType?: ProfileType, messages?: Models.MemoryMessage[], sourceMemoryIds?: string[], sessionId?: string, mode?: ProfileExtractionMode): Promise<{}>;
|
|
1819
|
+
createProfileExtraction(userId: string, pipelineId?: string, profileType?: ProfileType, messages?: Models.MemoryMessage[], sourceMemoryIds?: string[], sessionId?: string, mode?: ProfileExtractionMode): Promise<{}>;
|
|
1558
1820
|
/**
|
|
1559
1821
|
* Create a user memory profile rebuild.
|
|
1560
1822
|
*
|
|
1561
1823
|
* @param {string} params.userId - Target user ID.
|
|
1824
|
+
* @param {string} params.pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
1562
1825
|
* @param {ProfileType} params.profileType - Profile type.
|
|
1563
1826
|
* @throws {AgentbaseException}
|
|
1564
1827
|
* @returns {Promise<{}>}
|
|
1565
1828
|
*/
|
|
1566
1829
|
createProfileRebuild(params: {
|
|
1567
1830
|
userId: string;
|
|
1831
|
+
pipelineId?: string;
|
|
1568
1832
|
profileType?: ProfileType;
|
|
1569
1833
|
}): Promise<{}>;
|
|
1570
1834
|
/**
|
|
1571
1835
|
* Create a user memory profile rebuild.
|
|
1572
1836
|
*
|
|
1573
1837
|
* @param {string} userId - Target user ID.
|
|
1838
|
+
* @param {string} pipelineId - Optional published Pipeline ID for this scenario. Omit to use its default.
|
|
1574
1839
|
* @param {ProfileType} profileType - Profile type.
|
|
1575
1840
|
* @throws {AgentbaseException}
|
|
1576
1841
|
* @returns {Promise<{}>}
|
|
1577
1842
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1578
1843
|
*/
|
|
1579
|
-
createProfileRebuild(userId: string, profileType?: ProfileType): Promise<{}>;
|
|
1844
|
+
createProfileRebuild(userId: string, pipelineId?: string, profileType?: ProfileType): Promise<{}>;
|
|
1580
1845
|
/**
|
|
1581
1846
|
* List the sources for a user memory profile.
|
|
1582
1847
|
*
|
|
@@ -1653,6 +1918,7 @@ export declare class Memory {
|
|
|
1653
1918
|
* Delete a memory record by its unique ID.
|
|
1654
1919
|
*
|
|
1655
1920
|
* @param {string} params.memoryId - Memory unique ID.
|
|
1921
|
+
* @param {string} params.memorySubStoreId - Memory sub-store for erasure.
|
|
1656
1922
|
* @param {string} params.reason - Forgetting reason.
|
|
1657
1923
|
* @param {string} params.source - Forgetting source.
|
|
1658
1924
|
* @throws {AgentbaseException}
|
|
@@ -1660,6 +1926,7 @@ export declare class Memory {
|
|
|
1660
1926
|
*/
|
|
1661
1927
|
delete(params: {
|
|
1662
1928
|
memoryId: string;
|
|
1929
|
+
memorySubStoreId?: string;
|
|
1663
1930
|
reason?: string;
|
|
1664
1931
|
source?: string;
|
|
1665
1932
|
}): Promise<{}>;
|
|
@@ -1667,13 +1934,14 @@ export declare class Memory {
|
|
|
1667
1934
|
* Delete a memory record by its unique ID.
|
|
1668
1935
|
*
|
|
1669
1936
|
* @param {string} memoryId - Memory unique ID.
|
|
1937
|
+
* @param {string} memorySubStoreId - Memory sub-store for erasure.
|
|
1670
1938
|
* @param {string} reason - Forgetting reason.
|
|
1671
1939
|
* @param {string} source - Forgetting source.
|
|
1672
1940
|
* @throws {AgentbaseException}
|
|
1673
1941
|
* @returns {Promise<{}>}
|
|
1674
1942
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1675
1943
|
*/
|
|
1676
|
-
delete(memoryId: string, reason?: string, source?: string): Promise<{}>;
|
|
1944
|
+
delete(memoryId: string, memorySubStoreId?: string, reason?: string, source?: string): Promise<{}>;
|
|
1677
1945
|
/**
|
|
1678
1946
|
* List active read grants for one memory.
|
|
1679
1947
|
*
|
|
@@ -1768,4 +2036,317 @@ export declare class Memory {
|
|
|
1768
2036
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1769
2037
|
*/
|
|
1770
2038
|
listSources(memoryId: string, cursor?: string, limit?: number): Promise<{}>;
|
|
2039
|
+
/**
|
|
2040
|
+
* List Pipeline trial runs in the current project and scenario.
|
|
2041
|
+
*
|
|
2042
|
+
* @param {Scenario} params.scenario - Pipeline scenario.
|
|
2043
|
+
* @param {number} params.limit - Maximum number of trial runs.
|
|
2044
|
+
* @param {string} params.cursor - Opaque pagination cursor.
|
|
2045
|
+
* @throws {AgentbaseException}
|
|
2046
|
+
* @returns {Promise<Models.MemoryPipelineRunList>}
|
|
2047
|
+
*/
|
|
2048
|
+
listPipelineRuns(params?: {
|
|
2049
|
+
scenario?: Scenario;
|
|
2050
|
+
limit?: number;
|
|
2051
|
+
cursor?: string;
|
|
2052
|
+
}): Promise<Models.MemoryPipelineRunList>;
|
|
2053
|
+
/**
|
|
2054
|
+
* List Pipeline trial runs in the current project and scenario.
|
|
2055
|
+
*
|
|
2056
|
+
* @param {Scenario} scenario - Pipeline scenario.
|
|
2057
|
+
* @param {number} limit - Maximum number of trial runs.
|
|
2058
|
+
* @param {string} cursor - Opaque pagination cursor.
|
|
2059
|
+
* @throws {AgentbaseException}
|
|
2060
|
+
* @returns {Promise<Models.MemoryPipelineRunList>}
|
|
2061
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2062
|
+
*/
|
|
2063
|
+
listPipelineRuns(scenario?: Scenario, limit?: number, cursor?: string): Promise<Models.MemoryPipelineRunList>;
|
|
2064
|
+
/**
|
|
2065
|
+
* Compare saved Pipeline versions against bounded samples without business writes. Candidate configurations and sample inputs are frozen when the run is accepted.
|
|
2066
|
+
*
|
|
2067
|
+
* @param {string} params.name - Trial run name, from 1 to 256 UTF-8 bytes after trimming.
|
|
2068
|
+
* @param {Scenario} params.scenario - Shared scenario of all candidates.
|
|
2069
|
+
* @param {object[]} params.candidates - One to eight objects containing pipelineId and saved versionId.
|
|
2070
|
+
* @param {object[]} params.samples - One to twenty objects containing a unique id and scenario-specific data object.
|
|
2071
|
+
* @throws {AgentbaseException}
|
|
2072
|
+
* @returns {Promise<Models.MemoryPipelineRun>}
|
|
2073
|
+
*/
|
|
2074
|
+
createPipelineRun(params: {
|
|
2075
|
+
name: string;
|
|
2076
|
+
scenario: Scenario;
|
|
2077
|
+
candidates: object[];
|
|
2078
|
+
samples: object[];
|
|
2079
|
+
}): Promise<Models.MemoryPipelineRun>;
|
|
2080
|
+
/**
|
|
2081
|
+
* Compare saved Pipeline versions against bounded samples without business writes. Candidate configurations and sample inputs are frozen when the run is accepted.
|
|
2082
|
+
*
|
|
2083
|
+
* @param {string} name - Trial run name, from 1 to 256 UTF-8 bytes after trimming.
|
|
2084
|
+
* @param {Scenario} scenario - Shared scenario of all candidates.
|
|
2085
|
+
* @param {object[]} candidates - One to eight objects containing pipelineId and saved versionId.
|
|
2086
|
+
* @param {object[]} samples - One to twenty objects containing a unique id and scenario-specific data object.
|
|
2087
|
+
* @throws {AgentbaseException}
|
|
2088
|
+
* @returns {Promise<Models.MemoryPipelineRun>}
|
|
2089
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2090
|
+
*/
|
|
2091
|
+
createPipelineRun(name: string, scenario: Scenario, candidates: object[], samples: object[]): Promise<Models.MemoryPipelineRun>;
|
|
2092
|
+
/**
|
|
2093
|
+
* Read the frozen inputs, progress, and per-sample results of a Pipeline trial run.
|
|
2094
|
+
*
|
|
2095
|
+
* @param {string} params.runId - Trial run ID.
|
|
2096
|
+
* @throws {AgentbaseException}
|
|
2097
|
+
* @returns {Promise<Models.MemoryPipelineRun>}
|
|
2098
|
+
*/
|
|
2099
|
+
getPipelineRun(params: {
|
|
2100
|
+
runId: string;
|
|
2101
|
+
}): Promise<Models.MemoryPipelineRun>;
|
|
2102
|
+
/**
|
|
2103
|
+
* Read the frozen inputs, progress, and per-sample results of a Pipeline trial run.
|
|
2104
|
+
*
|
|
2105
|
+
* @param {string} runId - Trial run ID.
|
|
2106
|
+
* @throws {AgentbaseException}
|
|
2107
|
+
* @returns {Promise<Models.MemoryPipelineRun>}
|
|
2108
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2109
|
+
*/
|
|
2110
|
+
getPipelineRun(runId: string): Promise<Models.MemoryPipelineRun>;
|
|
2111
|
+
/**
|
|
2112
|
+
* Configure Memory Pipelines.
|
|
2113
|
+
*
|
|
2114
|
+
* @param {Scenario} params.scenario - Pipeline scenario. Each scenario has its own default.
|
|
2115
|
+
* @throws {AgentbaseException}
|
|
2116
|
+
* @returns {Promise<{}>}
|
|
2117
|
+
*/
|
|
2118
|
+
listPipelines(params?: {
|
|
2119
|
+
scenario?: Scenario;
|
|
2120
|
+
}): Promise<{}>;
|
|
2121
|
+
/**
|
|
2122
|
+
* Configure Memory Pipelines.
|
|
2123
|
+
*
|
|
2124
|
+
* @param {Scenario} scenario - Pipeline scenario. Each scenario has its own default.
|
|
2125
|
+
* @throws {AgentbaseException}
|
|
2126
|
+
* @returns {Promise<{}>}
|
|
2127
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2128
|
+
*/
|
|
2129
|
+
listPipelines(scenario?: Scenario): Promise<{}>;
|
|
2130
|
+
/**
|
|
2131
|
+
* Configure Memory Pipelines.
|
|
2132
|
+
*
|
|
2133
|
+
* @param {Scenario} params.scenario - Pipeline scenario. Each scenario has its own default.
|
|
2134
|
+
* @param {boolean} params.fromDefaults - Create with current default step parameters.
|
|
2135
|
+
* @param {object} params.config - Ordered step configurations for the selected scenario.
|
|
2136
|
+
* @throws {AgentbaseException}
|
|
2137
|
+
* @returns {Promise<{}>}
|
|
2138
|
+
*/
|
|
2139
|
+
createPipeline(params?: {
|
|
2140
|
+
scenario?: Scenario;
|
|
2141
|
+
fromDefaults?: boolean;
|
|
2142
|
+
config?: object;
|
|
2143
|
+
}): Promise<{}>;
|
|
2144
|
+
/**
|
|
2145
|
+
* Configure Memory Pipelines.
|
|
2146
|
+
*
|
|
2147
|
+
* @param {Scenario} scenario - Pipeline scenario. Each scenario has its own default.
|
|
2148
|
+
* @param {boolean} fromDefaults - Create with current default step parameters.
|
|
2149
|
+
* @param {object} config - Ordered step configurations for the selected scenario.
|
|
2150
|
+
* @throws {AgentbaseException}
|
|
2151
|
+
* @returns {Promise<{}>}
|
|
2152
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2153
|
+
*/
|
|
2154
|
+
createPipeline(scenario?: Scenario, fromDefaults?: boolean, config?: object): Promise<{}>;
|
|
2155
|
+
/**
|
|
2156
|
+
* Configure Memory Pipelines.
|
|
2157
|
+
*
|
|
2158
|
+
* @param {Scenario} params.scenario - Pipeline scenario. Each scenario has its own default.
|
|
2159
|
+
* @param {string} params.pipelineId - Published Pipeline ID, or null to restore the system default.
|
|
2160
|
+
* @param {number} params.expectedRevision - Revision from the reviewed Pipeline. Required when pipelineId is not null.
|
|
2161
|
+
* @throws {AgentbaseException}
|
|
2162
|
+
* @returns {Promise<{}>}
|
|
2163
|
+
*/
|
|
2164
|
+
setDefaultPipeline(params?: {
|
|
2165
|
+
scenario?: Scenario;
|
|
2166
|
+
pipelineId?: string;
|
|
2167
|
+
expectedRevision?: number;
|
|
2168
|
+
}): Promise<{}>;
|
|
2169
|
+
/**
|
|
2170
|
+
* Configure Memory Pipelines.
|
|
2171
|
+
*
|
|
2172
|
+
* @param {Scenario} scenario - Pipeline scenario. Each scenario has its own default.
|
|
2173
|
+
* @param {string} pipelineId - Published Pipeline ID, or null to restore the system default.
|
|
2174
|
+
* @param {number} expectedRevision - Revision from the reviewed Pipeline. Required when pipelineId is not null.
|
|
2175
|
+
* @throws {AgentbaseException}
|
|
2176
|
+
* @returns {Promise<{}>}
|
|
2177
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2178
|
+
*/
|
|
2179
|
+
setDefaultPipeline(scenario?: Scenario, pipelineId?: string, expectedRevision?: number): Promise<{}>;
|
|
2180
|
+
/**
|
|
2181
|
+
* Configure a Memory Pipeline.
|
|
2182
|
+
*
|
|
2183
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2184
|
+
* @throws {AgentbaseException}
|
|
2185
|
+
* @returns {Promise<{}>}
|
|
2186
|
+
*/
|
|
2187
|
+
getPipeline(params: {
|
|
2188
|
+
pipelineId: string;
|
|
2189
|
+
}): Promise<{}>;
|
|
2190
|
+
/**
|
|
2191
|
+
* Configure a Memory Pipeline.
|
|
2192
|
+
*
|
|
2193
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2194
|
+
* @throws {AgentbaseException}
|
|
2195
|
+
* @returns {Promise<{}>}
|
|
2196
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2197
|
+
*/
|
|
2198
|
+
getPipeline(pipelineId: string): Promise<{}>;
|
|
2199
|
+
/**
|
|
2200
|
+
* Configure a Memory Pipeline.
|
|
2201
|
+
*
|
|
2202
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2203
|
+
* @param {number} params.expectedRevision - Expected editing revision.
|
|
2204
|
+
* @param {object} params.config - Complete Pipeline configuration.
|
|
2205
|
+
* @throws {AgentbaseException}
|
|
2206
|
+
* @returns {Promise<{}>}
|
|
2207
|
+
*/
|
|
2208
|
+
updatePipeline(params: {
|
|
2209
|
+
pipelineId: string;
|
|
2210
|
+
expectedRevision: number;
|
|
2211
|
+
config: object;
|
|
2212
|
+
}): Promise<{}>;
|
|
2213
|
+
/**
|
|
2214
|
+
* Configure a Memory Pipeline.
|
|
2215
|
+
*
|
|
2216
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2217
|
+
* @param {number} expectedRevision - Expected editing revision.
|
|
2218
|
+
* @param {object} config - Complete Pipeline configuration.
|
|
2219
|
+
* @throws {AgentbaseException}
|
|
2220
|
+
* @returns {Promise<{}>}
|
|
2221
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2222
|
+
*/
|
|
2223
|
+
updatePipeline(pipelineId: string, expectedRevision: number, config: object): Promise<{}>;
|
|
2224
|
+
/**
|
|
2225
|
+
* Delete a Memory Pipeline. Accepted tasks and existing business data are kept.
|
|
2226
|
+
*
|
|
2227
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2228
|
+
* @param {number} params.expectedRevision - Expected editing revision.
|
|
2229
|
+
* @throws {AgentbaseException}
|
|
2230
|
+
* @returns {Promise<{}>}
|
|
2231
|
+
*/
|
|
2232
|
+
deletePipeline(params: {
|
|
2233
|
+
pipelineId: string;
|
|
2234
|
+
expectedRevision: number;
|
|
2235
|
+
}): Promise<{}>;
|
|
2236
|
+
/**
|
|
2237
|
+
* Delete a Memory Pipeline. Accepted tasks and existing business data are kept.
|
|
2238
|
+
*
|
|
2239
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2240
|
+
* @param {number} expectedRevision - Expected editing revision.
|
|
2241
|
+
* @throws {AgentbaseException}
|
|
2242
|
+
* @returns {Promise<{}>}
|
|
2243
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2244
|
+
*/
|
|
2245
|
+
deletePipeline(pipelineId: string, expectedRevision: number): Promise<{}>;
|
|
2246
|
+
/**
|
|
2247
|
+
* Configure a Memory Pipeline.
|
|
2248
|
+
*
|
|
2249
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2250
|
+
* @param {string} params.versionId - Saved configuration version.
|
|
2251
|
+
* @param {number} params.expectedRevision - Expected editing revision.
|
|
2252
|
+
* @param {boolean} params.makeDefault - Make this the project default when publishing.
|
|
2253
|
+
* @throws {AgentbaseException}
|
|
2254
|
+
* @returns {Promise<{}>}
|
|
2255
|
+
*/
|
|
2256
|
+
publishPipeline(params: {
|
|
2257
|
+
pipelineId: string;
|
|
2258
|
+
versionId: string;
|
|
2259
|
+
expectedRevision: number;
|
|
2260
|
+
makeDefault?: boolean;
|
|
2261
|
+
}): Promise<{}>;
|
|
2262
|
+
/**
|
|
2263
|
+
* Configure a Memory Pipeline.
|
|
2264
|
+
*
|
|
2265
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2266
|
+
* @param {string} versionId - Saved configuration version.
|
|
2267
|
+
* @param {number} expectedRevision - Expected editing revision.
|
|
2268
|
+
* @param {boolean} makeDefault - Make this the project default when publishing.
|
|
2269
|
+
* @throws {AgentbaseException}
|
|
2270
|
+
* @returns {Promise<{}>}
|
|
2271
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2272
|
+
*/
|
|
2273
|
+
publishPipeline(pipelineId: string, versionId: string, expectedRevision: number, makeDefault?: boolean): Promise<{}>;
|
|
2274
|
+
/**
|
|
2275
|
+
* Configure a Memory Pipeline.
|
|
2276
|
+
*
|
|
2277
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2278
|
+
* @param {string} params.versionId - Previously published version.
|
|
2279
|
+
* @param {number} params.expectedRevision - Expected editing revision.
|
|
2280
|
+
* @throws {AgentbaseException}
|
|
2281
|
+
* @returns {Promise<{}>}
|
|
2282
|
+
*/
|
|
2283
|
+
rollbackPipeline(params: {
|
|
2284
|
+
pipelineId: string;
|
|
2285
|
+
versionId: string;
|
|
2286
|
+
expectedRevision: number;
|
|
2287
|
+
}): Promise<{}>;
|
|
2288
|
+
/**
|
|
2289
|
+
* Configure a Memory Pipeline.
|
|
2290
|
+
*
|
|
2291
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2292
|
+
* @param {string} versionId - Previously published version.
|
|
2293
|
+
* @param {number} expectedRevision - Expected editing revision.
|
|
2294
|
+
* @throws {AgentbaseException}
|
|
2295
|
+
* @returns {Promise<{}>}
|
|
2296
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2297
|
+
*/
|
|
2298
|
+
rollbackPipeline(pipelineId: string, versionId: string, expectedRevision: number): Promise<{}>;
|
|
2299
|
+
/**
|
|
2300
|
+
* Validate a Memory Pipeline.
|
|
2301
|
+
*
|
|
2302
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2303
|
+
* @param {string} params.versionId - Saved configuration version or current system default hash.
|
|
2304
|
+
* @param {object} params.data - Sample input for the Pipeline scenario, evaluated without business writes.
|
|
2305
|
+
* @param {Scenario} params.scenario - Scenario for system default validation.
|
|
2306
|
+
* @throws {AgentbaseException}
|
|
2307
|
+
* @returns {Promise<{}>}
|
|
2308
|
+
*/
|
|
2309
|
+
validatePipeline(params: {
|
|
2310
|
+
pipelineId: string;
|
|
2311
|
+
versionId: string;
|
|
2312
|
+
data: object;
|
|
2313
|
+
scenario?: Scenario;
|
|
2314
|
+
}): Promise<{}>;
|
|
2315
|
+
/**
|
|
2316
|
+
* Validate a Memory Pipeline.
|
|
2317
|
+
*
|
|
2318
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2319
|
+
* @param {string} versionId - Saved configuration version or current system default hash.
|
|
2320
|
+
* @param {object} data - Sample input for the Pipeline scenario, evaluated without business writes.
|
|
2321
|
+
* @param {Scenario} scenario - Scenario for system default validation.
|
|
2322
|
+
* @throws {AgentbaseException}
|
|
2323
|
+
* @returns {Promise<{}>}
|
|
2324
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2325
|
+
*/
|
|
2326
|
+
validatePipeline(pipelineId: string, versionId: string, data: object, scenario?: Scenario): Promise<{}>;
|
|
2327
|
+
/**
|
|
2328
|
+
* Configure a Memory Pipeline.
|
|
2329
|
+
*
|
|
2330
|
+
* @param {string} params.pipelineId - Pipeline ID.
|
|
2331
|
+
* @param {string} params.versionId - Optional exact configuration version, including retained history after Pipeline deletion.
|
|
2332
|
+
* @param {number | bigint} params.beforeRevision - Load versions older than this revision; omit for the newest 100 versions.
|
|
2333
|
+
* @throws {AgentbaseException}
|
|
2334
|
+
* @returns {Promise<{}>}
|
|
2335
|
+
*/
|
|
2336
|
+
listPipelineVersions(params: {
|
|
2337
|
+
pipelineId: string;
|
|
2338
|
+
versionId?: string;
|
|
2339
|
+
beforeRevision?: number | bigint;
|
|
2340
|
+
}): Promise<{}>;
|
|
2341
|
+
/**
|
|
2342
|
+
* Configure a Memory Pipeline.
|
|
2343
|
+
*
|
|
2344
|
+
* @param {string} pipelineId - Pipeline ID.
|
|
2345
|
+
* @param {string} versionId - Optional exact configuration version, including retained history after Pipeline deletion.
|
|
2346
|
+
* @param {number | bigint} beforeRevision - Load versions older than this revision; omit for the newest 100 versions.
|
|
2347
|
+
* @throws {AgentbaseException}
|
|
2348
|
+
* @returns {Promise<{}>}
|
|
2349
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
2350
|
+
*/
|
|
2351
|
+
listPipelineVersions(pipelineId: string, versionId?: string, beforeRevision?: number | bigint): Promise<{}>;
|
|
1771
2352
|
}
|