@aws-sdk/client-bedrock-agentcore 3.1038.0 → 3.1040.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 +105 -7
- package/dist-cjs/index.js +275 -0
- package/dist-cjs/schemas/schemas_0.js +851 -99
- package/dist-es/BedrockAgentCore.js +34 -0
- package/dist-es/commands/CreateABTestCommand.js +16 -0
- package/dist-es/commands/DeleteABTestCommand.js +16 -0
- package/dist-es/commands/DeleteBatchEvaluationCommand.js +16 -0
- package/dist-es/commands/DeleteRecommendationCommand.js +16 -0
- package/dist-es/commands/GetABTestCommand.js +16 -0
- package/dist-es/commands/GetBatchEvaluationCommand.js +16 -0
- package/dist-es/commands/GetRecommendationCommand.js +16 -0
- package/dist-es/commands/ListABTestsCommand.js +16 -0
- package/dist-es/commands/ListBatchEvaluationsCommand.js +16 -0
- package/dist-es/commands/ListRecommendationsCommand.js +16 -0
- package/dist-es/commands/StartBatchEvaluationCommand.js +16 -0
- package/dist-es/commands/StartRecommendationCommand.js +16 -0
- package/dist-es/commands/StopBatchEvaluationCommand.js +16 -0
- package/dist-es/commands/UpdateABTestCommand.js +16 -0
- package/dist-es/commands/index.js +14 -0
- package/dist-es/index.js +1 -0
- package/dist-es/models/enums.js +60 -0
- package/dist-es/models/models_1.js +1 -0
- package/dist-es/pagination/ListABTestsPaginator.js +4 -0
- package/dist-es/pagination/ListBatchEvaluationsPaginator.js +4 -0
- package/dist-es/pagination/ListRecommendationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/schemas/schemas_0.js +843 -93
- package/dist-types/BedrockAgentCore.d.ts +122 -0
- package/dist-types/BedrockAgentCoreClient.d.ts +16 -2
- package/dist-types/commands/BatchCreateMemoryRecordsCommand.d.ts +10 -0
- package/dist-types/commands/BatchUpdateMemoryRecordsCommand.d.ts +10 -0
- package/dist-types/commands/CreateABTestCommand.d.ts +134 -0
- package/dist-types/commands/DeleteABTestCommand.d.ts +97 -0
- package/dist-types/commands/DeleteBatchEvaluationCommand.d.ts +97 -0
- package/dist-types/commands/DeleteRecommendationCommand.d.ts +93 -0
- package/dist-types/commands/GetABTestCommand.d.ts +165 -0
- package/dist-types/commands/GetBatchEvaluationCommand.d.ts +148 -0
- package/dist-types/commands/GetMemoryRecordCommand.d.ts +7 -2
- package/dist-types/commands/GetRecommendationCommand.d.ts +220 -0
- package/dist-types/commands/GetResourceOauth2TokenCommand.d.ts +7 -1
- package/dist-types/commands/ListABTestsCommand.d.ts +103 -0
- package/dist-types/commands/ListBatchEvaluationsCommand.d.ts +126 -0
- package/dist-types/commands/ListMemoryRecordsCommand.d.ts +25 -2
- package/dist-types/commands/ListRecommendationsCommand.d.ts +100 -0
- package/dist-types/commands/RetrieveMemoryRecordsCommand.d.ts +16 -6
- package/dist-types/commands/SearchRegistryRecordsCommand.d.ts +2 -1
- package/dist-types/commands/StartBatchEvaluationCommand.d.ts +172 -0
- package/dist-types/commands/StartRecommendationCommand.d.ts +300 -0
- package/dist-types/commands/StopBatchEvaluationCommand.d.ts +98 -0
- package/dist-types/commands/UpdateABTestCommand.d.ts +136 -0
- package/dist-types/commands/index.d.ts +14 -0
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/enums.d.ts +116 -0
- package/dist-types/models/models_0.d.ts +2595 -386
- package/dist-types/models/models_1.d.ts +147 -0
- package/dist-types/pagination/ListABTestsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListBatchEvaluationsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListRecommendationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/schemas/schemas_0.d.ts +99 -0
- package/dist-types/ts3.4/BedrockAgentCore.d.ts +262 -0
- package/dist-types/ts3.4/BedrockAgentCoreClient.d.ts +84 -0
- package/dist-types/ts3.4/commands/CreateABTestCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteABTestCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/DeleteBatchEvaluationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteRecommendationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetABTestCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetBatchEvaluationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetRecommendationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListABTestsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListBatchEvaluationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListRecommendationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/SearchRegistryRecordsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartBatchEvaluationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartRecommendationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StopBatchEvaluationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateABTestCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/index.d.ts +14 -0
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/enums.d.ts +73 -0
- package/dist-types/ts3.4/models/models_0.d.ts +801 -43
- package/dist-types/ts3.4/models/models_1.d.ts +40 -0
- package/dist-types/ts3.4/pagination/ListABTestsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListBatchEvaluationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListRecommendationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +99 -0
- package/package.json +7 -7
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { DocumentType as __DocumentType, StreamingBlobTypes } from "@smithy/types";
|
|
2
|
-
import type { AutomationStreamStatus, BrowserActionStatus, BrowserEnterprisePolicyType, BrowserSessionStatus, CodeInterpreterSessionStatus, CommandExecutionStatus, ContentBlockType,
|
|
2
|
+
import type { ABTestExecutionStatus, ABTestStatus, AutomationStreamStatus, BatchEvaluationStatus, BrowserActionStatus, BrowserEnterprisePolicyType, BrowserSessionStatus, CloudWatchLogsFilterOperator, CodeInterpreterSessionStatus, CommandExecutionStatus, ContentBlockType, EventFilterCondition, ExtractionJobStatus, HarnessConversationRole, HarnessStopReason, HarnessToolType, HarnessToolUseStatus, HarnessToolUseType, LanguageRuntime, MemoryRecordOperatorType, MemoryRecordStatus, MouseButton, Oauth2FlowType, OAuthGrantType, OperatorType, ProgrammingLanguage, RecommendationStatus, RecommendationType, ResourceContentType, Role, ScreenshotFormat, SessionStatus, TaskStatus, ToolName } from "./enums";
|
|
3
3
|
import type { AccessDeniedException, ConflictException, InternalServerException, ResourceNotFoundException, RuntimeClientError, ServiceQuotaExceededException, ThrottlingException, ValidationException } from "./errors";
|
|
4
4
|
/**
|
|
5
5
|
* <p> The agent card definition for A2A descriptors, including the schema version and inline content that describes the agent's capabilities.</p>
|
|
@@ -28,6 +28,238 @@ export interface A2aDescriptor {
|
|
|
28
28
|
*/
|
|
29
29
|
agentCard: AgentCardDefinition | undefined;
|
|
30
30
|
}
|
|
31
|
+
/**
|
|
32
|
+
* <p>An online evaluation configuration associated with a specific A/B test variant.</p>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
export interface PerVariantOnlineEvaluationConfig {
|
|
36
|
+
/**
|
|
37
|
+
* <p>The name of the variant this evaluation configuration applies to.</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
name: string | undefined;
|
|
41
|
+
/**
|
|
42
|
+
* <p>The Amazon Resource Name (ARN) of the online evaluation configuration for this variant.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
onlineEvaluationConfigArn: string | undefined;
|
|
46
|
+
}
|
|
47
|
+
/**
|
|
48
|
+
* <p>The evaluation configuration for an A/B test, specifying which online evaluation configurations to use for measuring variant performance.</p>
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
export type ABTestEvaluationConfig = ABTestEvaluationConfig.OnlineEvaluationConfigArnMember | ABTestEvaluationConfig.PerVariantOnlineEvaluationConfigMember | ABTestEvaluationConfig.$UnknownMember;
|
|
52
|
+
/**
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
export declare namespace ABTestEvaluationConfig {
|
|
56
|
+
/**
|
|
57
|
+
* <p>The Amazon Resource Name (ARN) of a single online evaluation configuration to use for both variants.</p>
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
interface OnlineEvaluationConfigArnMember {
|
|
61
|
+
onlineEvaluationConfigArn: string;
|
|
62
|
+
perVariantOnlineEvaluationConfig?: never;
|
|
63
|
+
$unknown?: never;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* <p>Per-variant online evaluation configurations, allowing different evaluation settings for each variant.</p>
|
|
67
|
+
* @public
|
|
68
|
+
*/
|
|
69
|
+
interface PerVariantOnlineEvaluationConfigMember {
|
|
70
|
+
onlineEvaluationConfigArn?: never;
|
|
71
|
+
perVariantOnlineEvaluationConfig: PerVariantOnlineEvaluationConfig[];
|
|
72
|
+
$unknown?: never;
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
interface $UnknownMember {
|
|
78
|
+
onlineEvaluationConfigArn?: never;
|
|
79
|
+
perVariantOnlineEvaluationConfig?: never;
|
|
80
|
+
$unknown: [string, any];
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* @deprecated unused in schema-serde mode.
|
|
84
|
+
*
|
|
85
|
+
*/
|
|
86
|
+
interface Visitor<T> {
|
|
87
|
+
onlineEvaluationConfigArn: (value: string) => T;
|
|
88
|
+
perVariantOnlineEvaluationConfig: (value: PerVariantOnlineEvaluationConfig[]) => T;
|
|
89
|
+
_: (name: string, value: any) => T;
|
|
90
|
+
}
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* <p>Statistics for the control variant in an A/B test.</p>
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
export interface ControlStats {
|
|
97
|
+
/**
|
|
98
|
+
* <p>The name of the control variant.</p>
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
variantName: string | undefined;
|
|
102
|
+
/**
|
|
103
|
+
* <p>The number of sessions evaluated for the control variant.</p>
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
sampleSize: number | undefined;
|
|
107
|
+
/**
|
|
108
|
+
* <p>The mean evaluation score for the control variant.</p>
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
mean: number | undefined;
|
|
112
|
+
}
|
|
113
|
+
/**
|
|
114
|
+
* <p>A confidence interval for a statistical measurement.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
export interface ConfidenceInterval {
|
|
118
|
+
/**
|
|
119
|
+
* <p>The lower bound of the confidence interval.</p>
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
lower?: number | undefined;
|
|
123
|
+
/**
|
|
124
|
+
* <p>The upper bound of the confidence interval.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
upper?: number | undefined;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* <p>Statistical results for a treatment variant compared against the control.</p>
|
|
131
|
+
* @public
|
|
132
|
+
*/
|
|
133
|
+
export interface VariantResult {
|
|
134
|
+
/**
|
|
135
|
+
* <p>The name of the treatment variant.</p>
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
variantName: string | undefined;
|
|
139
|
+
/**
|
|
140
|
+
* <p>The number of sessions evaluated for this variant.</p>
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
sampleSize: number | undefined;
|
|
144
|
+
/**
|
|
145
|
+
* <p>The mean evaluation score for this variant.</p>
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
mean: number | undefined;
|
|
149
|
+
/**
|
|
150
|
+
* <p>The absolute change in mean score compared to the control variant.</p>
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
absoluteChange?: number | undefined;
|
|
154
|
+
/**
|
|
155
|
+
* <p>The percentage change in mean score compared to the control variant.</p>
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
percentChange?: number | undefined;
|
|
159
|
+
/**
|
|
160
|
+
* <p>The p-value indicating the statistical significance of the observed difference.</p>
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
pValue?: number | undefined;
|
|
164
|
+
/**
|
|
165
|
+
* <p>The confidence interval for the observed difference.</p>
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
168
|
+
confidenceInterval?: ConfidenceInterval | undefined;
|
|
169
|
+
/**
|
|
170
|
+
* <p>Whether the observed difference is statistically significant.</p>
|
|
171
|
+
* @public
|
|
172
|
+
*/
|
|
173
|
+
isSignificant: boolean | undefined;
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* <p>Statistical metrics for a single evaluator comparing control and treatment variants.</p>
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
export interface EvaluatorMetric {
|
|
180
|
+
/**
|
|
181
|
+
* <p>The Amazon Resource Name (ARN) of the evaluator.</p>
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
evaluatorArn: string | undefined;
|
|
185
|
+
/**
|
|
186
|
+
* <p>The statistics for the control variant.</p>
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
controlStats: ControlStats | undefined;
|
|
190
|
+
/**
|
|
191
|
+
* <p>The results for each treatment variant compared against the control.</p>
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
variantResults: VariantResult[] | undefined;
|
|
195
|
+
}
|
|
196
|
+
/**
|
|
197
|
+
* <p>The statistical results of an A/B test.</p>
|
|
198
|
+
* @public
|
|
199
|
+
*/
|
|
200
|
+
export interface ABTestResults {
|
|
201
|
+
/**
|
|
202
|
+
* <p>The timestamp when the analysis was performed.</p>
|
|
203
|
+
* @public
|
|
204
|
+
*/
|
|
205
|
+
analysisTimestamp?: Date | undefined;
|
|
206
|
+
/**
|
|
207
|
+
* <p>The per-evaluator metrics comparing control and treatment variants.</p>
|
|
208
|
+
* @public
|
|
209
|
+
*/
|
|
210
|
+
evaluatorMetrics: EvaluatorMetric[] | undefined;
|
|
211
|
+
}
|
|
212
|
+
/**
|
|
213
|
+
* <p>Summary information about an A/B test.</p>
|
|
214
|
+
* @public
|
|
215
|
+
*/
|
|
216
|
+
export interface ABTestSummary {
|
|
217
|
+
/**
|
|
218
|
+
* <p>The unique identifier of the A/B test.</p>
|
|
219
|
+
* @public
|
|
220
|
+
*/
|
|
221
|
+
abTestId: string | undefined;
|
|
222
|
+
/**
|
|
223
|
+
* <p>The Amazon Resource Name (ARN) of the A/B test.</p>
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
abTestArn: string | undefined;
|
|
227
|
+
/**
|
|
228
|
+
* <p>The name of the A/B test.</p>
|
|
229
|
+
* @public
|
|
230
|
+
*/
|
|
231
|
+
name: string | undefined;
|
|
232
|
+
/**
|
|
233
|
+
* <p>The current status of the A/B test.</p>
|
|
234
|
+
* @public
|
|
235
|
+
*/
|
|
236
|
+
status: ABTestStatus | undefined;
|
|
237
|
+
/**
|
|
238
|
+
* <p>The execution status of the A/B test.</p>
|
|
239
|
+
* @public
|
|
240
|
+
*/
|
|
241
|
+
executionStatus: ABTestExecutionStatus | undefined;
|
|
242
|
+
/**
|
|
243
|
+
* <p>The description of the A/B test.</p>
|
|
244
|
+
* @public
|
|
245
|
+
*/
|
|
246
|
+
description?: string | undefined;
|
|
247
|
+
/**
|
|
248
|
+
* <p>The Amazon Resource Name (ARN) of the gateway used for traffic splitting.</p>
|
|
249
|
+
* @public
|
|
250
|
+
*/
|
|
251
|
+
gatewayArn?: string | undefined;
|
|
252
|
+
/**
|
|
253
|
+
* <p>The timestamp when the A/B test was created.</p>
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
createdAt: Date | undefined;
|
|
257
|
+
/**
|
|
258
|
+
* <p>The timestamp when the A/B test was last updated.</p>
|
|
259
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
updatedAt: Date | undefined;
|
|
262
|
+
}
|
|
31
263
|
/**
|
|
32
264
|
* <p>Contains summary information about an actor in an AgentCore Memory resource.</p>
|
|
33
265
|
* @public
|
|
@@ -650,113 +882,160 @@ export interface AgentSkillsDescriptor {
|
|
|
650
882
|
skillDefinition?: SkillDefinition | undefined;
|
|
651
883
|
}
|
|
652
884
|
/**
|
|
885
|
+
* <p>A value used in filter comparisons, supporting different data types.</p>
|
|
653
886
|
* @public
|
|
654
887
|
*/
|
|
655
|
-
export
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
traceId?: string | undefined;
|
|
888
|
+
export type FilterValue = FilterValue.BooleanValueMember | FilterValue.DoubleValueMember | FilterValue.StringValueMember | FilterValue.$UnknownMember;
|
|
889
|
+
/**
|
|
890
|
+
* @public
|
|
891
|
+
*/
|
|
892
|
+
export declare namespace FilterValue {
|
|
661
893
|
/**
|
|
662
|
-
* <p>
|
|
894
|
+
* <p>A string value for text-based filtering.</p>
|
|
663
895
|
* @public
|
|
664
896
|
*/
|
|
665
|
-
|
|
897
|
+
interface StringValueMember {
|
|
898
|
+
stringValue: string;
|
|
899
|
+
doubleValue?: never;
|
|
900
|
+
booleanValue?: never;
|
|
901
|
+
$unknown?: never;
|
|
902
|
+
}
|
|
666
903
|
/**
|
|
667
|
-
* <p>
|
|
904
|
+
* <p>A numeric value for numerical filtering and comparisons.</p>
|
|
668
905
|
* @public
|
|
669
906
|
*/
|
|
670
|
-
|
|
907
|
+
interface DoubleValueMember {
|
|
908
|
+
stringValue?: never;
|
|
909
|
+
doubleValue: number;
|
|
910
|
+
booleanValue?: never;
|
|
911
|
+
$unknown?: never;
|
|
912
|
+
}
|
|
671
913
|
/**
|
|
672
|
-
* <p>
|
|
914
|
+
* <p>A boolean value for true/false filtering conditions.</p>
|
|
673
915
|
* @public
|
|
674
916
|
*/
|
|
675
|
-
|
|
917
|
+
interface BooleanValueMember {
|
|
918
|
+
stringValue?: never;
|
|
919
|
+
doubleValue?: never;
|
|
920
|
+
booleanValue: boolean;
|
|
921
|
+
$unknown?: never;
|
|
922
|
+
}
|
|
676
923
|
/**
|
|
677
|
-
* <p>The unique identifier of the browser session from which to save the profile. The session must be active when saving the profile.</p>
|
|
678
924
|
* @public
|
|
679
925
|
*/
|
|
680
|
-
|
|
926
|
+
interface $UnknownMember {
|
|
927
|
+
stringValue?: never;
|
|
928
|
+
doubleValue?: never;
|
|
929
|
+
booleanValue?: never;
|
|
930
|
+
$unknown: [string, any];
|
|
931
|
+
}
|
|
681
932
|
/**
|
|
682
|
-
*
|
|
683
|
-
*
|
|
933
|
+
* @deprecated unused in schema-serde mode.
|
|
934
|
+
*
|
|
684
935
|
*/
|
|
685
|
-
|
|
936
|
+
interface Visitor<T> {
|
|
937
|
+
stringValue: (value: string) => T;
|
|
938
|
+
doubleValue: (value: number) => T;
|
|
939
|
+
booleanValue: (value: boolean) => T;
|
|
940
|
+
_: (name: string, value: any) => T;
|
|
941
|
+
}
|
|
686
942
|
}
|
|
687
943
|
/**
|
|
944
|
+
* <p>A filter for narrowing down agent traces from CloudWatch Logs based on key-value comparisons.</p>
|
|
688
945
|
* @public
|
|
689
946
|
*/
|
|
690
|
-
export interface
|
|
947
|
+
export interface CloudWatchLogsFilter {
|
|
691
948
|
/**
|
|
692
|
-
* <p>The
|
|
949
|
+
* <p>The key or field name to filter on within the agent trace data.</p>
|
|
693
950
|
* @public
|
|
694
951
|
*/
|
|
695
|
-
|
|
952
|
+
key: string | undefined;
|
|
696
953
|
/**
|
|
697
|
-
* <p>The
|
|
954
|
+
* <p>The comparison operator to use for filtering.</p>
|
|
698
955
|
* @public
|
|
699
956
|
*/
|
|
700
|
-
|
|
957
|
+
operator: CloudWatchLogsFilterOperator | undefined;
|
|
701
958
|
/**
|
|
702
|
-
* <p>The
|
|
959
|
+
* <p>The value to compare against using the specified operator.</p>
|
|
703
960
|
* @public
|
|
704
961
|
*/
|
|
705
|
-
|
|
962
|
+
value: FilterValue | undefined;
|
|
963
|
+
}
|
|
964
|
+
/**
|
|
965
|
+
* <p>A rule configuration for filtering agent traces from CloudWatch Logs.</p>
|
|
966
|
+
* @public
|
|
967
|
+
*/
|
|
968
|
+
export interface CloudWatchLogsRule {
|
|
706
969
|
/**
|
|
707
|
-
* <p>The
|
|
970
|
+
* <p>The list of filters to apply when reading agent traces.</p>
|
|
708
971
|
* @public
|
|
709
972
|
*/
|
|
710
|
-
|
|
973
|
+
filters?: CloudWatchLogsFilter[] | undefined;
|
|
711
974
|
}
|
|
712
975
|
/**
|
|
976
|
+
* <p>Configuration for reading agent traces from CloudWatch Logs for recommendation analysis.</p>
|
|
713
977
|
* @public
|
|
714
978
|
*/
|
|
715
|
-
export interface
|
|
979
|
+
export interface CloudWatchLogsTraceConfig {
|
|
716
980
|
/**
|
|
717
|
-
* <p>The
|
|
981
|
+
* <p>The list of CloudWatch log group ARNs to read agent traces from.</p>
|
|
718
982
|
* @public
|
|
719
983
|
*/
|
|
720
|
-
|
|
984
|
+
logGroupArns: string[] | undefined;
|
|
721
985
|
/**
|
|
722
|
-
* <p>The
|
|
986
|
+
* <p>The list of service names to filter traces within the specified log groups.</p>
|
|
723
987
|
* @public
|
|
724
988
|
*/
|
|
725
|
-
|
|
726
|
-
}
|
|
727
|
-
/**
|
|
728
|
-
* <p>The Amazon Web Services Secrets Manager location configuration.</p>
|
|
729
|
-
* @public
|
|
730
|
-
*/
|
|
731
|
-
export interface SecretsManagerLocation {
|
|
989
|
+
serviceNames: string[] | undefined;
|
|
732
990
|
/**
|
|
733
|
-
* <p>The
|
|
991
|
+
* <p>The start time of the time range to read traces from.</p>
|
|
734
992
|
* @public
|
|
735
993
|
*/
|
|
736
|
-
|
|
994
|
+
startTime: Date | undefined;
|
|
995
|
+
/**
|
|
996
|
+
* <p>The end time of the time range to read traces from.</p>
|
|
997
|
+
* @public
|
|
998
|
+
*/
|
|
999
|
+
endTime: Date | undefined;
|
|
1000
|
+
/**
|
|
1001
|
+
* <p>Optional rule configuration for filtering traces.</p>
|
|
1002
|
+
* @public
|
|
1003
|
+
*/
|
|
1004
|
+
rule?: CloudWatchLogsRule | undefined;
|
|
737
1005
|
}
|
|
738
1006
|
/**
|
|
739
|
-
* <p>The
|
|
1007
|
+
* <p>The configuration specifying where to read agent traces from for recommendation analysis.</p>
|
|
740
1008
|
* @public
|
|
741
1009
|
*/
|
|
742
|
-
export type
|
|
1010
|
+
export type AgentTracesConfig = AgentTracesConfig.CloudwatchLogsMember | AgentTracesConfig.SessionSpansMember | AgentTracesConfig.$UnknownMember;
|
|
743
1011
|
/**
|
|
744
1012
|
* @public
|
|
745
1013
|
*/
|
|
746
|
-
export declare namespace
|
|
1014
|
+
export declare namespace AgentTracesConfig {
|
|
747
1015
|
/**
|
|
748
|
-
* <p>
|
|
1016
|
+
* <p>Agent traces provided as inline session spans in OpenTelemetry format.</p>
|
|
749
1017
|
* @public
|
|
750
1018
|
*/
|
|
751
|
-
interface
|
|
752
|
-
|
|
1019
|
+
interface SessionSpansMember {
|
|
1020
|
+
sessionSpans: __DocumentType[];
|
|
1021
|
+
cloudwatchLogs?: never;
|
|
1022
|
+
$unknown?: never;
|
|
1023
|
+
}
|
|
1024
|
+
/**
|
|
1025
|
+
* <p>Agent traces read from CloudWatch Logs.</p>
|
|
1026
|
+
* @public
|
|
1027
|
+
*/
|
|
1028
|
+
interface CloudwatchLogsMember {
|
|
1029
|
+
sessionSpans?: never;
|
|
1030
|
+
cloudwatchLogs: CloudWatchLogsTraceConfig;
|
|
753
1031
|
$unknown?: never;
|
|
754
1032
|
}
|
|
755
1033
|
/**
|
|
756
1034
|
* @public
|
|
757
1035
|
*/
|
|
758
1036
|
interface $UnknownMember {
|
|
759
|
-
|
|
1037
|
+
sessionSpans?: never;
|
|
1038
|
+
cloudwatchLogs?: never;
|
|
760
1039
|
$unknown: [string, any];
|
|
761
1040
|
}
|
|
762
1041
|
/**
|
|
@@ -764,28 +1043,148 @@ export declare namespace CertificateLocation {
|
|
|
764
1043
|
*
|
|
765
1044
|
*/
|
|
766
1045
|
interface Visitor<T> {
|
|
767
|
-
|
|
1046
|
+
sessionSpans: (value: __DocumentType[]) => T;
|
|
1047
|
+
cloudwatchLogs: (value: CloudWatchLogsTraceConfig) => T;
|
|
768
1048
|
_: (name: string, value: any) => T;
|
|
769
1049
|
}
|
|
770
1050
|
}
|
|
771
1051
|
/**
|
|
772
|
-
* <p>A certificate to install in the browser or code interpreter session.</p>
|
|
773
1052
|
* @public
|
|
774
1053
|
*/
|
|
775
|
-
export interface
|
|
1054
|
+
export interface SaveBrowserSessionProfileRequest {
|
|
776
1055
|
/**
|
|
777
|
-
* <p>The
|
|
1056
|
+
* <p>The trace identifier for request tracking.</p>
|
|
778
1057
|
* @public
|
|
779
1058
|
*/
|
|
780
|
-
|
|
781
|
-
}
|
|
782
|
-
/**
|
|
783
|
-
* <p>The Amazon S3 location configuration of a resource.</p>
|
|
784
|
-
* @public
|
|
785
|
-
*/
|
|
786
|
-
export interface S3Location {
|
|
1059
|
+
traceId?: string | undefined;
|
|
787
1060
|
/**
|
|
788
|
-
* <p>The
|
|
1061
|
+
* <p>The parent trace information for distributed tracing.</p>
|
|
1062
|
+
* @public
|
|
1063
|
+
*/
|
|
1064
|
+
traceParent?: string | undefined;
|
|
1065
|
+
/**
|
|
1066
|
+
* <p>The unique identifier for the browser profile. This identifier is used to reference the profile when starting new browser sessions. The identifier must follow the pattern of an alphanumeric name (up to 48 characters) followed by a hyphen and a 10-character alphanumeric suffix.</p>
|
|
1067
|
+
* @public
|
|
1068
|
+
*/
|
|
1069
|
+
profileIdentifier: string | undefined;
|
|
1070
|
+
/**
|
|
1071
|
+
* <p>The unique identifier of the browser associated with the session from which to save the profile.</p>
|
|
1072
|
+
* @public
|
|
1073
|
+
*/
|
|
1074
|
+
browserIdentifier: string | undefined;
|
|
1075
|
+
/**
|
|
1076
|
+
* <p>The unique identifier of the browser session from which to save the profile. The session must be active when saving the profile.</p>
|
|
1077
|
+
* @public
|
|
1078
|
+
*/
|
|
1079
|
+
sessionId: string | undefined;
|
|
1080
|
+
/**
|
|
1081
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock AgentCore ignores the request, but does not return an error.</p>
|
|
1082
|
+
* @public
|
|
1083
|
+
*/
|
|
1084
|
+
clientToken?: string | undefined;
|
|
1085
|
+
}
|
|
1086
|
+
/**
|
|
1087
|
+
* @public
|
|
1088
|
+
*/
|
|
1089
|
+
export interface SaveBrowserSessionProfileResponse {
|
|
1090
|
+
/**
|
|
1091
|
+
* <p>The unique identifier of the saved browser profile.</p>
|
|
1092
|
+
* @public
|
|
1093
|
+
*/
|
|
1094
|
+
profileIdentifier: string | undefined;
|
|
1095
|
+
/**
|
|
1096
|
+
* <p>The unique identifier of the browser associated with the session from which the profile was saved.</p>
|
|
1097
|
+
* @public
|
|
1098
|
+
*/
|
|
1099
|
+
browserIdentifier: string | undefined;
|
|
1100
|
+
/**
|
|
1101
|
+
* <p>The unique identifier of the browser session from which the profile was saved.</p>
|
|
1102
|
+
* @public
|
|
1103
|
+
*/
|
|
1104
|
+
sessionId: string | undefined;
|
|
1105
|
+
/**
|
|
1106
|
+
* <p>The timestamp when the browser profile was last updated. This value is in ISO 8601 format.</p>
|
|
1107
|
+
* @public
|
|
1108
|
+
*/
|
|
1109
|
+
lastUpdatedAt: Date | undefined;
|
|
1110
|
+
}
|
|
1111
|
+
/**
|
|
1112
|
+
* @public
|
|
1113
|
+
*/
|
|
1114
|
+
export interface GetBrowserSessionRequest {
|
|
1115
|
+
/**
|
|
1116
|
+
* <p>The unique identifier of the browser associated with the session.</p>
|
|
1117
|
+
* @public
|
|
1118
|
+
*/
|
|
1119
|
+
browserIdentifier: string | undefined;
|
|
1120
|
+
/**
|
|
1121
|
+
* <p>The unique identifier of the browser session to retrieve.</p>
|
|
1122
|
+
* @public
|
|
1123
|
+
*/
|
|
1124
|
+
sessionId: string | undefined;
|
|
1125
|
+
}
|
|
1126
|
+
/**
|
|
1127
|
+
* <p>The Amazon Web Services Secrets Manager location configuration.</p>
|
|
1128
|
+
* @public
|
|
1129
|
+
*/
|
|
1130
|
+
export interface SecretsManagerLocation {
|
|
1131
|
+
/**
|
|
1132
|
+
* <p>The ARN of the Amazon Web Services Secrets Manager secret containing the certificate.</p>
|
|
1133
|
+
* @public
|
|
1134
|
+
*/
|
|
1135
|
+
secretArn: string | undefined;
|
|
1136
|
+
}
|
|
1137
|
+
/**
|
|
1138
|
+
* <p>The location from which to retrieve a certificate.</p>
|
|
1139
|
+
* @public
|
|
1140
|
+
*/
|
|
1141
|
+
export type CertificateLocation = CertificateLocation.SecretsManagerMember | CertificateLocation.$UnknownMember;
|
|
1142
|
+
/**
|
|
1143
|
+
* @public
|
|
1144
|
+
*/
|
|
1145
|
+
export declare namespace CertificateLocation {
|
|
1146
|
+
/**
|
|
1147
|
+
* <p>The Amazon Web Services Secrets Manager location of the certificate.</p>
|
|
1148
|
+
* @public
|
|
1149
|
+
*/
|
|
1150
|
+
interface SecretsManagerMember {
|
|
1151
|
+
secretsManager: SecretsManagerLocation;
|
|
1152
|
+
$unknown?: never;
|
|
1153
|
+
}
|
|
1154
|
+
/**
|
|
1155
|
+
* @public
|
|
1156
|
+
*/
|
|
1157
|
+
interface $UnknownMember {
|
|
1158
|
+
secretsManager?: never;
|
|
1159
|
+
$unknown: [string, any];
|
|
1160
|
+
}
|
|
1161
|
+
/**
|
|
1162
|
+
* @deprecated unused in schema-serde mode.
|
|
1163
|
+
*
|
|
1164
|
+
*/
|
|
1165
|
+
interface Visitor<T> {
|
|
1166
|
+
secretsManager: (value: SecretsManagerLocation) => T;
|
|
1167
|
+
_: (name: string, value: any) => T;
|
|
1168
|
+
}
|
|
1169
|
+
}
|
|
1170
|
+
/**
|
|
1171
|
+
* <p>A certificate to install in the browser or code interpreter session.</p>
|
|
1172
|
+
* @public
|
|
1173
|
+
*/
|
|
1174
|
+
export interface Certificate {
|
|
1175
|
+
/**
|
|
1176
|
+
* <p>The location of the certificate.</p>
|
|
1177
|
+
* @public
|
|
1178
|
+
*/
|
|
1179
|
+
location: CertificateLocation | undefined;
|
|
1180
|
+
}
|
|
1181
|
+
/**
|
|
1182
|
+
* <p>The Amazon S3 location configuration of a resource.</p>
|
|
1183
|
+
* @public
|
|
1184
|
+
*/
|
|
1185
|
+
export interface S3Location {
|
|
1186
|
+
/**
|
|
1187
|
+
* <p>The name of the Amazon S3 bucket where the resource is stored.</p>
|
|
789
1188
|
* @public
|
|
790
1189
|
*/
|
|
791
1190
|
bucket: string | undefined;
|
|
@@ -2393,195 +2792,1698 @@ export interface CompleteResourceTokenAuthRequest {
|
|
|
2393
2792
|
export interface CompleteResourceTokenAuthResponse {
|
|
2394
2793
|
}
|
|
2395
2794
|
/**
|
|
2396
|
-
* <p>
|
|
2795
|
+
* <p>A filter to restrict which gateway target paths are included in the A/B test.</p>
|
|
2397
2796
|
* @public
|
|
2398
2797
|
*/
|
|
2399
|
-
export
|
|
2798
|
+
export interface GatewayFilter {
|
|
2799
|
+
/**
|
|
2800
|
+
* <p>A list of target path patterns to include in the A/B test.</p>
|
|
2801
|
+
* @public
|
|
2802
|
+
*/
|
|
2803
|
+
targetPaths?: string[] | undefined;
|
|
2804
|
+
}
|
|
2400
2805
|
/**
|
|
2806
|
+
* <p>A reference to a specific version of a configuration bundle.</p>
|
|
2401
2807
|
* @public
|
|
2402
2808
|
*/
|
|
2403
|
-
export
|
|
2809
|
+
export interface ConfigurationBundleRef {
|
|
2404
2810
|
/**
|
|
2405
|
-
* <p>
|
|
2811
|
+
* <p>The Amazon Resource Name (ARN) of the configuration bundle.</p>
|
|
2406
2812
|
* @public
|
|
2407
2813
|
*/
|
|
2408
|
-
|
|
2409
|
-
sessionSpans: __DocumentType[];
|
|
2410
|
-
$unknown?: never;
|
|
2411
|
-
}
|
|
2814
|
+
bundleArn: string | undefined;
|
|
2412
2815
|
/**
|
|
2816
|
+
* <p>The version of the configuration bundle.</p>
|
|
2413
2817
|
* @public
|
|
2414
2818
|
*/
|
|
2415
|
-
|
|
2416
|
-
sessionSpans?: never;
|
|
2417
|
-
$unknown: [string, any];
|
|
2418
|
-
}
|
|
2419
|
-
/**
|
|
2420
|
-
* @deprecated unused in schema-serde mode.
|
|
2421
|
-
*
|
|
2422
|
-
*/
|
|
2423
|
-
interface Visitor<T> {
|
|
2424
|
-
sessionSpans: (value: __DocumentType[]) => T;
|
|
2425
|
-
_: (name: string, value: any) => T;
|
|
2426
|
-
}
|
|
2819
|
+
bundleVersion: string | undefined;
|
|
2427
2820
|
}
|
|
2428
2821
|
/**
|
|
2429
|
-
* <p>
|
|
2822
|
+
* <p>A reference to a gateway target.</p>
|
|
2430
2823
|
* @public
|
|
2431
2824
|
*/
|
|
2432
|
-
export
|
|
2825
|
+
export interface TargetRef {
|
|
2826
|
+
/**
|
|
2827
|
+
* <p>The name of the gateway target.</p>
|
|
2828
|
+
* @public
|
|
2829
|
+
*/
|
|
2830
|
+
name: string | undefined;
|
|
2831
|
+
}
|
|
2433
2832
|
/**
|
|
2833
|
+
* <p>The configuration for an A/B test variant.</p>
|
|
2434
2834
|
* @public
|
|
2435
2835
|
*/
|
|
2436
|
-
export
|
|
2836
|
+
export interface VariantConfiguration {
|
|
2437
2837
|
/**
|
|
2438
|
-
* <p>
|
|
2838
|
+
* <p>A reference to a configuration bundle version to use for this variant.</p>
|
|
2439
2839
|
* @public
|
|
2440
2840
|
*/
|
|
2441
|
-
|
|
2442
|
-
text: string;
|
|
2443
|
-
$unknown?: never;
|
|
2444
|
-
}
|
|
2841
|
+
configurationBundle?: ConfigurationBundleRef | undefined;
|
|
2445
2842
|
/**
|
|
2843
|
+
* <p>A reference to a gateway target to route traffic to for this variant.</p>
|
|
2446
2844
|
* @public
|
|
2447
2845
|
*/
|
|
2448
|
-
|
|
2449
|
-
text?: never;
|
|
2450
|
-
$unknown: [string, any];
|
|
2451
|
-
}
|
|
2452
|
-
/**
|
|
2453
|
-
* @deprecated unused in schema-serde mode.
|
|
2454
|
-
*
|
|
2455
|
-
*/
|
|
2456
|
-
interface Visitor<T> {
|
|
2457
|
-
text: (value: string) => T;
|
|
2458
|
-
_: (name: string, value: any) => T;
|
|
2459
|
-
}
|
|
2846
|
+
target?: TargetRef | undefined;
|
|
2460
2847
|
}
|
|
2461
2848
|
/**
|
|
2462
|
-
* <p>
|
|
2849
|
+
* <p>A variant in an A/B test, representing either the control (C) or treatment (T1) configuration.</p>
|
|
2463
2850
|
* @public
|
|
2464
2851
|
*/
|
|
2465
|
-
export interface
|
|
2852
|
+
export interface Variant {
|
|
2466
2853
|
/**
|
|
2467
|
-
* <p>
|
|
2854
|
+
* <p>The name of the variant. Must be <code>C</code> for control or <code>T1</code> for treatment.</p>
|
|
2468
2855
|
* @public
|
|
2469
2856
|
*/
|
|
2470
|
-
|
|
2857
|
+
name: string | undefined;
|
|
2471
2858
|
/**
|
|
2472
|
-
* <p>
|
|
2859
|
+
* <p>The percentage of traffic to route to this variant. Weights across all variants must sum to 100.</p>
|
|
2473
2860
|
* @public
|
|
2474
2861
|
*/
|
|
2475
|
-
|
|
2862
|
+
weight: number | undefined;
|
|
2476
2863
|
/**
|
|
2477
|
-
* <p>
|
|
2864
|
+
* <p>The configuration for this variant, including the configuration bundle or target reference.</p>
|
|
2478
2865
|
* @public
|
|
2479
2866
|
*/
|
|
2480
|
-
|
|
2867
|
+
variantConfiguration: VariantConfiguration | undefined;
|
|
2481
2868
|
}
|
|
2482
|
-
/**
|
|
2483
|
-
* <p> The contextual information associated with an evaluation, including span context details that identify the specific traces and sessions being evaluated within the agent's execution flow. </p>
|
|
2484
|
-
* @public
|
|
2485
|
-
*/
|
|
2486
|
-
export type Context = Context.SpanContextMember | Context.$UnknownMember;
|
|
2487
2869
|
/**
|
|
2488
2870
|
* @public
|
|
2489
2871
|
*/
|
|
2490
|
-
export
|
|
2872
|
+
export interface CreateABTestRequest {
|
|
2491
2873
|
/**
|
|
2492
|
-
* <p>
|
|
2874
|
+
* <p>The name of the A/B test. Must be unique within your account.</p>
|
|
2493
2875
|
* @public
|
|
2494
2876
|
*/
|
|
2495
|
-
|
|
2496
|
-
spanContext: SpanContext;
|
|
2497
|
-
$unknown?: never;
|
|
2498
|
-
}
|
|
2877
|
+
name: string | undefined;
|
|
2499
2878
|
/**
|
|
2879
|
+
* <p>The description of the A/B test.</p>
|
|
2500
2880
|
* @public
|
|
2501
2881
|
*/
|
|
2502
|
-
|
|
2503
|
-
spanContext?: never;
|
|
2504
|
-
$unknown: [string, any];
|
|
2505
|
-
}
|
|
2882
|
+
description?: string | undefined;
|
|
2506
2883
|
/**
|
|
2507
|
-
*
|
|
2508
|
-
*
|
|
2884
|
+
* <p>The Amazon Resource Name (ARN) of the gateway to use for traffic splitting.</p>
|
|
2885
|
+
* @public
|
|
2509
2886
|
*/
|
|
2510
|
-
|
|
2511
|
-
spanContext: (value: SpanContext) => T;
|
|
2512
|
-
_: (name: string, value: any) => T;
|
|
2513
|
-
}
|
|
2514
|
-
}
|
|
2515
|
-
/**
|
|
2516
|
-
* <p> The expected tool call trajectory for trajectory-based evaluation. </p>
|
|
2517
|
-
* @public
|
|
2518
|
-
*/
|
|
2519
|
-
export interface EvaluationExpectedTrajectory {
|
|
2887
|
+
gatewayArn: string | undefined;
|
|
2520
2888
|
/**
|
|
2521
|
-
* <p>
|
|
2889
|
+
* <p>The list of variants for the A/B test. Must contain exactly two variants: a control (C) and a treatment (T1), each with a configuration bundle or target reference and a traffic weight.</p>
|
|
2522
2890
|
* @public
|
|
2523
2891
|
*/
|
|
2524
|
-
|
|
2525
|
-
}
|
|
2526
|
-
/**
|
|
2527
|
-
* <p> A reference input containing ground truth data for evaluation, scoped to a specific context level (session or trace) through its span context. </p>
|
|
2528
|
-
* @public
|
|
2529
|
-
*/
|
|
2530
|
-
export interface EvaluationReferenceInput {
|
|
2892
|
+
variants: Variant[] | undefined;
|
|
2531
2893
|
/**
|
|
2532
|
-
* <p>
|
|
2894
|
+
* <p>Optional filter to restrict which gateway target paths are included in the A/B test.</p>
|
|
2533
2895
|
* @public
|
|
2534
2896
|
*/
|
|
2535
|
-
|
|
2897
|
+
gatewayFilter?: GatewayFilter | undefined;
|
|
2536
2898
|
/**
|
|
2537
|
-
* <p>
|
|
2899
|
+
* <p>The evaluation configuration specifying which online evaluation configurations to use for measuring variant performance.</p>
|
|
2538
2900
|
* @public
|
|
2539
2901
|
*/
|
|
2540
|
-
|
|
2902
|
+
evaluationConfig: ABTestEvaluationConfig | undefined;
|
|
2541
2903
|
/**
|
|
2542
|
-
* <p>
|
|
2904
|
+
* <p>The IAM role ARN that grants permissions for the A/B test to access gateway and evaluation resources.</p>
|
|
2543
2905
|
* @public
|
|
2544
2906
|
*/
|
|
2545
|
-
|
|
2907
|
+
roleArn: string | undefined;
|
|
2546
2908
|
/**
|
|
2547
|
-
* <p>
|
|
2909
|
+
* <p>Whether to enable the A/B test immediately upon creation. If true, traffic splitting begins automatically.</p>
|
|
2548
2910
|
* @public
|
|
2549
2911
|
*/
|
|
2550
|
-
|
|
2912
|
+
enableOnCreate?: boolean | undefined;
|
|
2913
|
+
/**
|
|
2914
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.</p>
|
|
2915
|
+
* @public
|
|
2916
|
+
*/
|
|
2917
|
+
clientToken?: string | undefined;
|
|
2551
2918
|
}
|
|
2552
|
-
/**
|
|
2553
|
-
* <p> The specification of which trace or span IDs to evaluate within the provided input data. Allows precise targeting of evaluation at different levels: tool calls, traces, or sessions. </p>
|
|
2554
|
-
* @public
|
|
2555
|
-
*/
|
|
2556
|
-
export type EvaluationTarget = EvaluationTarget.SpanIdsMember | EvaluationTarget.TraceIdsMember | EvaluationTarget.$UnknownMember;
|
|
2557
2919
|
/**
|
|
2558
2920
|
* @public
|
|
2559
2921
|
*/
|
|
2560
|
-
export
|
|
2922
|
+
export interface CreateABTestResponse {
|
|
2561
2923
|
/**
|
|
2562
|
-
* <p>
|
|
2924
|
+
* <p>The unique identifier of the created A/B test.</p>
|
|
2563
2925
|
* @public
|
|
2564
2926
|
*/
|
|
2565
|
-
|
|
2566
|
-
spanIds: string[];
|
|
2567
|
-
traceIds?: never;
|
|
2568
|
-
$unknown?: never;
|
|
2569
|
-
}
|
|
2927
|
+
abTestId: string | undefined;
|
|
2570
2928
|
/**
|
|
2571
|
-
* <p>
|
|
2929
|
+
* <p>The Amazon Resource Name (ARN) of the created A/B test.</p>
|
|
2572
2930
|
* @public
|
|
2573
2931
|
*/
|
|
2574
|
-
|
|
2575
|
-
spanIds?: never;
|
|
2576
|
-
traceIds: string[];
|
|
2577
|
-
$unknown?: never;
|
|
2578
|
-
}
|
|
2932
|
+
abTestArn: string | undefined;
|
|
2579
2933
|
/**
|
|
2934
|
+
* <p>The name of the A/B test.</p>
|
|
2580
2935
|
* @public
|
|
2581
2936
|
*/
|
|
2582
|
-
|
|
2583
|
-
|
|
2937
|
+
name?: string | undefined;
|
|
2938
|
+
/**
|
|
2939
|
+
* <p>The status of the A/B test.</p>
|
|
2940
|
+
* @public
|
|
2941
|
+
*/
|
|
2942
|
+
status: ABTestStatus | undefined;
|
|
2943
|
+
/**
|
|
2944
|
+
* <p>The execution status indicating whether the A/B test is currently running.</p>
|
|
2945
|
+
* @public
|
|
2946
|
+
*/
|
|
2947
|
+
executionStatus: ABTestExecutionStatus | undefined;
|
|
2948
|
+
/**
|
|
2949
|
+
* <p>The timestamp when the A/B test was created.</p>
|
|
2950
|
+
* @public
|
|
2951
|
+
*/
|
|
2952
|
+
createdAt: Date | undefined;
|
|
2953
|
+
}
|
|
2954
|
+
/**
|
|
2955
|
+
* @public
|
|
2956
|
+
*/
|
|
2957
|
+
export interface DeleteABTestRequest {
|
|
2958
|
+
/**
|
|
2959
|
+
* <p>The unique identifier of the A/B test to delete.</p>
|
|
2960
|
+
* @public
|
|
2961
|
+
*/
|
|
2962
|
+
abTestId: string | undefined;
|
|
2963
|
+
}
|
|
2964
|
+
/**
|
|
2965
|
+
* @public
|
|
2966
|
+
*/
|
|
2967
|
+
export interface DeleteABTestResponse {
|
|
2968
|
+
/**
|
|
2969
|
+
* <p>The unique identifier of the deleted A/B test.</p>
|
|
2970
|
+
* @public
|
|
2971
|
+
*/
|
|
2972
|
+
abTestId: string | undefined;
|
|
2973
|
+
/**
|
|
2974
|
+
* <p>The Amazon Resource Name (ARN) of the deleted A/B test.</p>
|
|
2975
|
+
* @public
|
|
2976
|
+
*/
|
|
2977
|
+
abTestArn: string | undefined;
|
|
2978
|
+
/**
|
|
2979
|
+
* <p>The status of the A/B test deletion operation.</p>
|
|
2980
|
+
* @public
|
|
2981
|
+
*/
|
|
2982
|
+
status: ABTestStatus | undefined;
|
|
2983
|
+
}
|
|
2984
|
+
/**
|
|
2985
|
+
* @public
|
|
2986
|
+
*/
|
|
2987
|
+
export interface DeleteBatchEvaluationRequest {
|
|
2988
|
+
/**
|
|
2989
|
+
* <p>The unique identifier of the batch evaluation to delete.</p>
|
|
2990
|
+
* @public
|
|
2991
|
+
*/
|
|
2992
|
+
batchEvaluationId: string | undefined;
|
|
2993
|
+
}
|
|
2994
|
+
/**
|
|
2995
|
+
* @public
|
|
2996
|
+
*/
|
|
2997
|
+
export interface DeleteBatchEvaluationResponse {
|
|
2998
|
+
/**
|
|
2999
|
+
* <p>The unique identifier of the deleted batch evaluation.</p>
|
|
3000
|
+
* @public
|
|
3001
|
+
*/
|
|
3002
|
+
batchEvaluationId: string | undefined;
|
|
3003
|
+
/**
|
|
3004
|
+
* <p>The Amazon Resource Name (ARN) of the deleted batch evaluation.</p>
|
|
3005
|
+
* @public
|
|
3006
|
+
*/
|
|
3007
|
+
batchEvaluationArn: string | undefined;
|
|
3008
|
+
/**
|
|
3009
|
+
* <p>The status of the batch evaluation deletion operation.</p>
|
|
3010
|
+
* @public
|
|
3011
|
+
*/
|
|
3012
|
+
status: BatchEvaluationStatus | undefined;
|
|
3013
|
+
}
|
|
3014
|
+
/**
|
|
3015
|
+
* @public
|
|
3016
|
+
*/
|
|
3017
|
+
export interface DeleteRecommendationRequest {
|
|
3018
|
+
/**
|
|
3019
|
+
* <p>The unique identifier of the recommendation to delete.</p>
|
|
3020
|
+
* @public
|
|
3021
|
+
*/
|
|
3022
|
+
recommendationId: string | undefined;
|
|
3023
|
+
}
|
|
3024
|
+
/**
|
|
3025
|
+
* @public
|
|
3026
|
+
*/
|
|
3027
|
+
export interface DeleteRecommendationResponse {
|
|
3028
|
+
/**
|
|
3029
|
+
* <p>The unique identifier of the deleted recommendation.</p>
|
|
3030
|
+
* @public
|
|
3031
|
+
*/
|
|
3032
|
+
recommendationId: string | undefined;
|
|
3033
|
+
/**
|
|
3034
|
+
* <p>The status of the recommendation deletion operation.</p>
|
|
3035
|
+
* @public
|
|
3036
|
+
*/
|
|
3037
|
+
status: RecommendationStatus | undefined;
|
|
3038
|
+
}
|
|
3039
|
+
/**
|
|
3040
|
+
* <p> The input data structure containing agent session spans in OpenTelemetry format. Supports traces from frameworks like Strands (AgentCore Runtime) and LangGraph with OpenInference instrumentation for comprehensive evaluation. </p>
|
|
3041
|
+
* @public
|
|
3042
|
+
*/
|
|
3043
|
+
export type EvaluationInput = EvaluationInput.SessionSpansMember | EvaluationInput.$UnknownMember;
|
|
3044
|
+
/**
|
|
3045
|
+
* @public
|
|
3046
|
+
*/
|
|
3047
|
+
export declare namespace EvaluationInput {
|
|
3048
|
+
/**
|
|
3049
|
+
* <p> The collection of spans representing agent execution traces within a session. Each span contains detailed information about tool calls, model interactions, and other agent activities that can be evaluated for quality and performance. </p>
|
|
3050
|
+
* @public
|
|
3051
|
+
*/
|
|
3052
|
+
interface SessionSpansMember {
|
|
3053
|
+
sessionSpans: __DocumentType[];
|
|
3054
|
+
$unknown?: never;
|
|
3055
|
+
}
|
|
3056
|
+
/**
|
|
3057
|
+
* @public
|
|
3058
|
+
*/
|
|
3059
|
+
interface $UnknownMember {
|
|
3060
|
+
sessionSpans?: never;
|
|
3061
|
+
$unknown: [string, any];
|
|
3062
|
+
}
|
|
3063
|
+
/**
|
|
3064
|
+
* @deprecated unused in schema-serde mode.
|
|
3065
|
+
*
|
|
3066
|
+
*/
|
|
3067
|
+
interface Visitor<T> {
|
|
3068
|
+
sessionSpans: (value: __DocumentType[]) => T;
|
|
3069
|
+
_: (name: string, value: any) => T;
|
|
3070
|
+
}
|
|
3071
|
+
}
|
|
3072
|
+
/**
|
|
3073
|
+
* <p> A content block for ground truth data in evaluation reference inputs. Supports text content for expected responses and assertions. </p>
|
|
3074
|
+
* @public
|
|
3075
|
+
*/
|
|
3076
|
+
export type EvaluationContent = EvaluationContent.TextMember | EvaluationContent.$UnknownMember;
|
|
3077
|
+
/**
|
|
3078
|
+
* @public
|
|
3079
|
+
*/
|
|
3080
|
+
export declare namespace EvaluationContent {
|
|
3081
|
+
/**
|
|
3082
|
+
* <p> The text content of the ground truth data. Used for expected response text and assertion statements. </p>
|
|
3083
|
+
* @public
|
|
3084
|
+
*/
|
|
3085
|
+
interface TextMember {
|
|
3086
|
+
text: string;
|
|
3087
|
+
$unknown?: never;
|
|
3088
|
+
}
|
|
3089
|
+
/**
|
|
3090
|
+
* @public
|
|
3091
|
+
*/
|
|
3092
|
+
interface $UnknownMember {
|
|
3093
|
+
text?: never;
|
|
3094
|
+
$unknown: [string, any];
|
|
3095
|
+
}
|
|
3096
|
+
/**
|
|
3097
|
+
* @deprecated unused in schema-serde mode.
|
|
3098
|
+
*
|
|
3099
|
+
*/
|
|
3100
|
+
interface Visitor<T> {
|
|
3101
|
+
text: (value: string) => T;
|
|
3102
|
+
_: (name: string, value: any) => T;
|
|
3103
|
+
}
|
|
3104
|
+
}
|
|
3105
|
+
/**
|
|
3106
|
+
* <p> The contextual information that uniquely identifies a span within the distributed tracing system. Contains session, trace, and span identifiers used to correlate evaluation results with specific agent execution points. </p>
|
|
3107
|
+
* @public
|
|
3108
|
+
*/
|
|
3109
|
+
export interface SpanContext {
|
|
3110
|
+
/**
|
|
3111
|
+
* <p> The unique identifier of the session containing this span. Sessions represent complete conversation flows and are detected using configurable <code>SessionTimeoutMinutes</code> (default 15 minutes). </p>
|
|
3112
|
+
* @public
|
|
3113
|
+
*/
|
|
3114
|
+
sessionId: string | undefined;
|
|
3115
|
+
/**
|
|
3116
|
+
* <p> The unique identifier of the trace containing this span. Traces represent individual request-response interactions within a session and group related spans together. </p>
|
|
3117
|
+
* @public
|
|
3118
|
+
*/
|
|
3119
|
+
traceId?: string | undefined;
|
|
3120
|
+
/**
|
|
3121
|
+
* <p> The unique identifier of the specific span being referenced. Spans represent individual operations like tool calls, model invocations, or other discrete actions within the agent's execution. </p>
|
|
3122
|
+
* @public
|
|
3123
|
+
*/
|
|
3124
|
+
spanId?: string | undefined;
|
|
3125
|
+
}
|
|
3126
|
+
/**
|
|
3127
|
+
* <p> The contextual information associated with an evaluation, including span context details that identify the specific traces and sessions being evaluated within the agent's execution flow. </p>
|
|
3128
|
+
* @public
|
|
3129
|
+
*/
|
|
3130
|
+
export type Context = Context.SpanContextMember | Context.$UnknownMember;
|
|
3131
|
+
/**
|
|
3132
|
+
* @public
|
|
3133
|
+
*/
|
|
3134
|
+
export declare namespace Context {
|
|
3135
|
+
/**
|
|
3136
|
+
* <p> The span context information that uniquely identifies the trace and span being evaluated, including session ID, trace ID, and span ID for precise targeting within the agent's execution flow. </p>
|
|
3137
|
+
* @public
|
|
3138
|
+
*/
|
|
3139
|
+
interface SpanContextMember {
|
|
3140
|
+
spanContext: SpanContext;
|
|
3141
|
+
$unknown?: never;
|
|
3142
|
+
}
|
|
3143
|
+
/**
|
|
3144
|
+
* @public
|
|
3145
|
+
*/
|
|
3146
|
+
interface $UnknownMember {
|
|
3147
|
+
spanContext?: never;
|
|
3148
|
+
$unknown: [string, any];
|
|
3149
|
+
}
|
|
3150
|
+
/**
|
|
3151
|
+
* @deprecated unused in schema-serde mode.
|
|
3152
|
+
*
|
|
3153
|
+
*/
|
|
3154
|
+
interface Visitor<T> {
|
|
3155
|
+
spanContext: (value: SpanContext) => T;
|
|
3156
|
+
_: (name: string, value: any) => T;
|
|
3157
|
+
}
|
|
3158
|
+
}
|
|
3159
|
+
/**
|
|
3160
|
+
* <p> The expected tool call trajectory for trajectory-based evaluation. </p>
|
|
3161
|
+
* @public
|
|
3162
|
+
*/
|
|
3163
|
+
export interface EvaluationExpectedTrajectory {
|
|
3164
|
+
/**
|
|
3165
|
+
* <p> The list of tool names representing the expected tool call sequence. </p>
|
|
3166
|
+
* @public
|
|
3167
|
+
*/
|
|
3168
|
+
toolNames?: string[] | undefined;
|
|
3169
|
+
}
|
|
3170
|
+
/**
|
|
3171
|
+
* <p> A reference input containing ground truth data for evaluation, scoped to a specific context level (session or trace) through its span context. </p>
|
|
3172
|
+
* @public
|
|
3173
|
+
*/
|
|
3174
|
+
export interface EvaluationReferenceInput {
|
|
3175
|
+
/**
|
|
3176
|
+
* <p> The contextual information associated with an evaluation, including span context details that identify the specific traces and sessions being evaluated within the agent's execution flow. </p>
|
|
3177
|
+
* @public
|
|
3178
|
+
*/
|
|
3179
|
+
context: Context | undefined;
|
|
3180
|
+
/**
|
|
3181
|
+
* <p> The expected response for trace-level evaluation. Built-in evaluators that support this field compare the agent's actual response against this value for assessment. Custom evaluators can access it through the <code>\{expected_response\}</code> placeholder in their instructions. </p>
|
|
3182
|
+
* @public
|
|
3183
|
+
*/
|
|
3184
|
+
expectedResponse?: EvaluationContent | undefined;
|
|
3185
|
+
/**
|
|
3186
|
+
* <p> A list of assertion statements for session-level evaluation. Each assertion describes an expected behavior or outcome the agent should demonstrate during the session. </p>
|
|
3187
|
+
* @public
|
|
3188
|
+
*/
|
|
3189
|
+
assertions?: EvaluationContent[] | undefined;
|
|
3190
|
+
/**
|
|
3191
|
+
* <p> The expected tool call sequence for session-level trajectory evaluation. Contains a list of tool names representing the tools the agent is expected to invoke. </p>
|
|
3192
|
+
* @public
|
|
3193
|
+
*/
|
|
3194
|
+
expectedTrajectory?: EvaluationExpectedTrajectory | undefined;
|
|
3195
|
+
}
|
|
3196
|
+
/**
|
|
3197
|
+
* <p> The specification of which trace or span IDs to evaluate within the provided input data. Allows precise targeting of evaluation at different levels: tool calls, traces, or sessions. </p>
|
|
3198
|
+
* @public
|
|
3199
|
+
*/
|
|
3200
|
+
export type EvaluationTarget = EvaluationTarget.SpanIdsMember | EvaluationTarget.TraceIdsMember | EvaluationTarget.$UnknownMember;
|
|
3201
|
+
/**
|
|
3202
|
+
* @public
|
|
3203
|
+
*/
|
|
3204
|
+
export declare namespace EvaluationTarget {
|
|
3205
|
+
/**
|
|
3206
|
+
* <p> The list of specific span IDs to evaluate within the provided traces. Used to target evaluation at individual tool calls or specific operations within the agent's execution flow. </p>
|
|
3207
|
+
* @public
|
|
3208
|
+
*/
|
|
3209
|
+
interface SpanIdsMember {
|
|
3210
|
+
spanIds: string[];
|
|
2584
3211
|
traceIds?: never;
|
|
3212
|
+
$unknown?: never;
|
|
3213
|
+
}
|
|
3214
|
+
/**
|
|
3215
|
+
* <p> The list of trace IDs to evaluate, representing complete request-response interactions. Used to evaluate entire conversation turns or specific agent interactions within a session. </p>
|
|
3216
|
+
* @public
|
|
3217
|
+
*/
|
|
3218
|
+
interface TraceIdsMember {
|
|
3219
|
+
spanIds?: never;
|
|
3220
|
+
traceIds: string[];
|
|
3221
|
+
$unknown?: never;
|
|
3222
|
+
}
|
|
3223
|
+
/**
|
|
3224
|
+
* @public
|
|
3225
|
+
*/
|
|
3226
|
+
interface $UnknownMember {
|
|
3227
|
+
spanIds?: never;
|
|
3228
|
+
traceIds?: never;
|
|
3229
|
+
$unknown: [string, any];
|
|
3230
|
+
}
|
|
3231
|
+
/**
|
|
3232
|
+
* @deprecated unused in schema-serde mode.
|
|
3233
|
+
*
|
|
3234
|
+
*/
|
|
3235
|
+
interface Visitor<T> {
|
|
3236
|
+
spanIds: (value: string[]) => T;
|
|
3237
|
+
traceIds: (value: string[]) => T;
|
|
3238
|
+
_: (name: string, value: any) => T;
|
|
3239
|
+
}
|
|
3240
|
+
}
|
|
3241
|
+
/**
|
|
3242
|
+
* @public
|
|
3243
|
+
*/
|
|
3244
|
+
export interface EvaluateRequest {
|
|
3245
|
+
/**
|
|
3246
|
+
* <p> The unique identifier of the evaluator to use for scoring. Can be a built-in evaluator (e.g., <code>Builtin.Helpfulness</code>, <code>Builtin.Correctness</code>) or a custom evaluator Id created through the control plane API. </p>
|
|
3247
|
+
* @public
|
|
3248
|
+
*/
|
|
3249
|
+
evaluatorId: string | undefined;
|
|
3250
|
+
/**
|
|
3251
|
+
* <p> The input data containing agent session spans to be evaluated. Includes a list of spans in OpenTelemetry format from supported frameworks like Strands (AgentCore Runtime) or LangGraph with OpenInference instrumentation. </p>
|
|
3252
|
+
* @public
|
|
3253
|
+
*/
|
|
3254
|
+
evaluationInput: EvaluationInput | undefined;
|
|
3255
|
+
/**
|
|
3256
|
+
* <p> The specific trace or span IDs to evaluate within the provided input. Allows targeting evaluation at different levels: individual tool calls, single request-response interactions (traces), or entire conversation sessions. </p>
|
|
3257
|
+
* @public
|
|
3258
|
+
*/
|
|
3259
|
+
evaluationTarget?: EvaluationTarget | undefined;
|
|
3260
|
+
/**
|
|
3261
|
+
* <p> Ground truth data to compare against agent responses during evaluation. Allows to provide expected responses, assertions, and expected tool trajectories at different evaluation levels. Session-level reference inputs apply to the entire conversation, while trace-level reference inputs target specific request-response interactions identified by trace ID. </p>
|
|
3262
|
+
* @public
|
|
3263
|
+
*/
|
|
3264
|
+
evaluationReferenceInputs?: EvaluationReferenceInput[] | undefined;
|
|
3265
|
+
}
|
|
3266
|
+
/**
|
|
3267
|
+
* <p> The token consumption statistics for language model operations during evaluation. Provides detailed breakdown of input, output, and total tokens used for cost tracking and performance monitoring. </p>
|
|
3268
|
+
* @public
|
|
3269
|
+
*/
|
|
3270
|
+
export interface TokenUsage {
|
|
3271
|
+
/**
|
|
3272
|
+
* <p> The number of tokens consumed for input processing during the evaluation. Includes tokens from the evaluation prompt, agent traces, and any additional context provided to the evaluator model. </p>
|
|
3273
|
+
* @public
|
|
3274
|
+
*/
|
|
3275
|
+
inputTokens?: number | undefined;
|
|
3276
|
+
/**
|
|
3277
|
+
* <p> The number of tokens generated by the evaluator model in its response. Includes tokens for the score, explanation, and any additional output produced during the evaluation process. </p>
|
|
3278
|
+
* @public
|
|
3279
|
+
*/
|
|
3280
|
+
outputTokens?: number | undefined;
|
|
3281
|
+
/**
|
|
3282
|
+
* <p> The total number of tokens consumed during the evaluation, calculated as the sum of input and output tokens. Used for cost calculation and rate limiting within the service limits. </p>
|
|
3283
|
+
* @public
|
|
3284
|
+
*/
|
|
3285
|
+
totalTokens?: number | undefined;
|
|
3286
|
+
}
|
|
3287
|
+
/**
|
|
3288
|
+
* <p> The comprehensive result of an evaluation containing the score, explanation, evaluator metadata, and execution details. Provides both quantitative ratings and qualitative insights about agent performance. </p>
|
|
3289
|
+
* @public
|
|
3290
|
+
*/
|
|
3291
|
+
export interface EvaluationResultContent {
|
|
3292
|
+
/**
|
|
3293
|
+
* <p> The Amazon Resource Name (ARN) of the evaluator used to generate this result. For custom evaluators, this is the full ARN; for built-in evaluators, this follows the pattern <code>Builtin.\{EvaluatorName\}</code>. </p>
|
|
3294
|
+
* @public
|
|
3295
|
+
*/
|
|
3296
|
+
evaluatorArn: string | undefined;
|
|
3297
|
+
/**
|
|
3298
|
+
* <p> The unique identifier of the evaluator that produced this result. This matches the <code>evaluatorId</code> provided in the evaluation request and can be used to identify which evaluator generated specific results. </p>
|
|
3299
|
+
* @public
|
|
3300
|
+
*/
|
|
3301
|
+
evaluatorId: string | undefined;
|
|
3302
|
+
/**
|
|
3303
|
+
* <p> The human-readable name of the evaluator used for this evaluation. For built-in evaluators, this is the descriptive name (e.g., "Helpfulness", "Correctness"); for custom evaluators, this is the user-defined name. </p>
|
|
3304
|
+
* @public
|
|
3305
|
+
*/
|
|
3306
|
+
evaluatorName: string | undefined;
|
|
3307
|
+
/**
|
|
3308
|
+
* <p> The detailed explanation provided by the evaluator describing the reasoning behind the assigned score. This qualitative feedback helps understand why specific ratings were given and provides actionable insights for improvement. </p>
|
|
3309
|
+
* @public
|
|
3310
|
+
*/
|
|
3311
|
+
explanation?: string | undefined;
|
|
3312
|
+
/**
|
|
3313
|
+
* <p> The contextual information associated with this evaluation result, including span context details that identify the specific traces and sessions that were evaluated. </p>
|
|
3314
|
+
* @public
|
|
3315
|
+
*/
|
|
3316
|
+
context: Context | undefined;
|
|
3317
|
+
/**
|
|
3318
|
+
* <p> The numerical score assigned by the evaluator according to its configured rating scale. For numerical scales, this is a decimal value within the defined range. This field is not allowed for categorical scales. </p>
|
|
3319
|
+
* @public
|
|
3320
|
+
*/
|
|
3321
|
+
value?: number | undefined;
|
|
3322
|
+
/**
|
|
3323
|
+
* <p> The categorical label assigned by the evaluator when using a categorical rating scale. This provides a human-readable description of the evaluation result (e.g., "Excellent", "Good", "Poor") corresponding to the numerical value. For numerical scales, this field is optional and provides a natural language explanation of what the value means (e.g., value 0.5 = "Somewhat Helpful"). </p>
|
|
3324
|
+
* @public
|
|
3325
|
+
*/
|
|
3326
|
+
label?: string | undefined;
|
|
3327
|
+
/**
|
|
3328
|
+
* <p> The token consumption statistics for this evaluation, including input tokens, output tokens, and total tokens used by the underlying language model during the evaluation process. </p>
|
|
3329
|
+
* @public
|
|
3330
|
+
*/
|
|
3331
|
+
tokenUsage?: TokenUsage | undefined;
|
|
3332
|
+
/**
|
|
3333
|
+
* <p> The error message describing what went wrong if the evaluation failed. Provides detailed information about evaluation failures to help diagnose and resolve issues with evaluator configuration or input data. </p>
|
|
3334
|
+
* @public
|
|
3335
|
+
*/
|
|
3336
|
+
errorMessage?: string | undefined;
|
|
3337
|
+
/**
|
|
3338
|
+
* <p> The error code indicating the type of failure that occurred during evaluation. Used to programmatically identify and handle different categories of evaluation errors. </p>
|
|
3339
|
+
* @public
|
|
3340
|
+
*/
|
|
3341
|
+
errorCode?: string | undefined;
|
|
3342
|
+
/**
|
|
3343
|
+
* <p> The list of reference input field names that were provided but not used by the evaluator. Helps identify which ground truth data was not consumed during evaluation. </p>
|
|
3344
|
+
* @public
|
|
3345
|
+
*/
|
|
3346
|
+
ignoredReferenceInputFields?: string[] | undefined;
|
|
3347
|
+
}
|
|
3348
|
+
/**
|
|
3349
|
+
* @public
|
|
3350
|
+
*/
|
|
3351
|
+
export interface EvaluateResponse {
|
|
3352
|
+
/**
|
|
3353
|
+
* <p> The detailed evaluation results containing scores, explanations, and metadata. Includes the evaluator information, numerical or categorical ratings based on the evaluator's rating scale, and token usage statistics for the evaluation process. </p>
|
|
3354
|
+
* @public
|
|
3355
|
+
*/
|
|
3356
|
+
evaluationResults: EvaluationResultContent[] | undefined;
|
|
3357
|
+
}
|
|
3358
|
+
/**
|
|
3359
|
+
* @public
|
|
3360
|
+
*/
|
|
3361
|
+
export interface GetABTestRequest {
|
|
3362
|
+
/**
|
|
3363
|
+
* <p>The unique identifier of the A/B test to retrieve.</p>
|
|
3364
|
+
* @public
|
|
3365
|
+
*/
|
|
3366
|
+
abTestId: string | undefined;
|
|
3367
|
+
}
|
|
3368
|
+
/**
|
|
3369
|
+
* @public
|
|
3370
|
+
*/
|
|
3371
|
+
export interface GetABTestResponse {
|
|
3372
|
+
/**
|
|
3373
|
+
* <p>The unique identifier of the A/B test.</p>
|
|
3374
|
+
* @public
|
|
3375
|
+
*/
|
|
3376
|
+
abTestId: string | undefined;
|
|
3377
|
+
/**
|
|
3378
|
+
* <p>The Amazon Resource Name (ARN) of the A/B test.</p>
|
|
3379
|
+
* @public
|
|
3380
|
+
*/
|
|
3381
|
+
abTestArn: string | undefined;
|
|
3382
|
+
/**
|
|
3383
|
+
* <p>The name of the A/B test.</p>
|
|
3384
|
+
* @public
|
|
3385
|
+
*/
|
|
3386
|
+
name: string | undefined;
|
|
3387
|
+
/**
|
|
3388
|
+
* <p>The description of the A/B test.</p>
|
|
3389
|
+
* @public
|
|
3390
|
+
*/
|
|
3391
|
+
description?: string | undefined;
|
|
3392
|
+
/**
|
|
3393
|
+
* <p>The current status of the A/B test.</p>
|
|
3394
|
+
* @public
|
|
3395
|
+
*/
|
|
3396
|
+
status: ABTestStatus | undefined;
|
|
3397
|
+
/**
|
|
3398
|
+
* <p>The execution status indicating whether the A/B test is currently running.</p>
|
|
3399
|
+
* @public
|
|
3400
|
+
*/
|
|
3401
|
+
executionStatus: ABTestExecutionStatus | undefined;
|
|
3402
|
+
/**
|
|
3403
|
+
* <p>The Amazon Resource Name (ARN) of the gateway used for traffic splitting.</p>
|
|
3404
|
+
* @public
|
|
3405
|
+
*/
|
|
3406
|
+
gatewayArn: string | undefined;
|
|
3407
|
+
/**
|
|
3408
|
+
* <p>The list of variants in the A/B test.</p>
|
|
3409
|
+
* @public
|
|
3410
|
+
*/
|
|
3411
|
+
variants: Variant[] | undefined;
|
|
3412
|
+
/**
|
|
3413
|
+
* <p>The gateway filter restricting which target paths are included.</p>
|
|
3414
|
+
* @public
|
|
3415
|
+
*/
|
|
3416
|
+
gatewayFilter?: GatewayFilter | undefined;
|
|
3417
|
+
/**
|
|
3418
|
+
* <p>The evaluation configuration for measuring variant performance.</p>
|
|
3419
|
+
* @public
|
|
3420
|
+
*/
|
|
3421
|
+
evaluationConfig: ABTestEvaluationConfig | undefined;
|
|
3422
|
+
/**
|
|
3423
|
+
* <p>The IAM role ARN used by the A/B test.</p>
|
|
3424
|
+
* @public
|
|
3425
|
+
*/
|
|
3426
|
+
roleArn?: string | undefined;
|
|
3427
|
+
/**
|
|
3428
|
+
* <p>The identifier of the current run of the A/B test.</p>
|
|
3429
|
+
* @public
|
|
3430
|
+
*/
|
|
3431
|
+
currentRunId?: string | undefined;
|
|
3432
|
+
/**
|
|
3433
|
+
* <p>The error details if the A/B test encountered failures.</p>
|
|
3434
|
+
* @public
|
|
3435
|
+
*/
|
|
3436
|
+
errorDetails?: string[] | undefined;
|
|
3437
|
+
/**
|
|
3438
|
+
* <p>The timestamp when the A/B test was started.</p>
|
|
3439
|
+
* @public
|
|
3440
|
+
*/
|
|
3441
|
+
startedAt?: Date | undefined;
|
|
3442
|
+
/**
|
|
3443
|
+
* <p>The timestamp when the A/B test was stopped.</p>
|
|
3444
|
+
* @public
|
|
3445
|
+
*/
|
|
3446
|
+
stoppedAt?: Date | undefined;
|
|
3447
|
+
/**
|
|
3448
|
+
* <p>The timestamp when the A/B test will automatically expire.</p>
|
|
3449
|
+
* @public
|
|
3450
|
+
*/
|
|
3451
|
+
maxDurationExpiresAt?: Date | undefined;
|
|
3452
|
+
/**
|
|
3453
|
+
* <p>The timestamp when the A/B test was created.</p>
|
|
3454
|
+
* @public
|
|
3455
|
+
*/
|
|
3456
|
+
createdAt: Date | undefined;
|
|
3457
|
+
/**
|
|
3458
|
+
* <p>The timestamp when the A/B test was last updated.</p>
|
|
3459
|
+
* @public
|
|
3460
|
+
*/
|
|
3461
|
+
updatedAt: Date | undefined;
|
|
3462
|
+
/**
|
|
3463
|
+
* <p>The statistical results of the A/B test, including per-evaluator metrics and significance analysis.</p>
|
|
3464
|
+
* @public
|
|
3465
|
+
*/
|
|
3466
|
+
results?: ABTestResults | undefined;
|
|
3467
|
+
}
|
|
3468
|
+
/**
|
|
3469
|
+
* @public
|
|
3470
|
+
*/
|
|
3471
|
+
export interface GetBatchEvaluationRequest {
|
|
3472
|
+
/**
|
|
3473
|
+
* <p>The unique identifier of the batch evaluation to retrieve.</p>
|
|
3474
|
+
* @public
|
|
3475
|
+
*/
|
|
3476
|
+
batchEvaluationId: string | undefined;
|
|
3477
|
+
}
|
|
3478
|
+
/**
|
|
3479
|
+
* <p>A time range filter for selecting sessions. Specifies the start and end times to narrow down which sessions are included.</p>
|
|
3480
|
+
* @public
|
|
3481
|
+
*/
|
|
3482
|
+
export interface SessionFilterConfig {
|
|
3483
|
+
/**
|
|
3484
|
+
* <p>The start time of the time range. Only sessions with activity at or after this timestamp are included.</p>
|
|
3485
|
+
* @public
|
|
3486
|
+
*/
|
|
3487
|
+
startTime?: Date | undefined;
|
|
3488
|
+
/**
|
|
3489
|
+
* <p>The end time of the time range. Only sessions with activity before this timestamp are included.</p>
|
|
3490
|
+
* @public
|
|
3491
|
+
*/
|
|
3492
|
+
endTime?: Date | undefined;
|
|
3493
|
+
}
|
|
3494
|
+
/**
|
|
3495
|
+
* <p>Filter configuration for narrowing down CloudWatch Logs sessions for evaluation.</p>
|
|
3496
|
+
* @public
|
|
3497
|
+
*/
|
|
3498
|
+
export interface CloudWatchFilterConfig {
|
|
3499
|
+
/**
|
|
3500
|
+
* <p>A list of specific session IDs to evaluate. If specified, only these sessions are included in the evaluation.</p>
|
|
3501
|
+
* @public
|
|
3502
|
+
*/
|
|
3503
|
+
sessionIds?: string[] | undefined;
|
|
3504
|
+
/**
|
|
3505
|
+
* <p>The time range filter for selecting sessions to evaluate.</p>
|
|
3506
|
+
* @public
|
|
3507
|
+
*/
|
|
3508
|
+
timeRange?: SessionFilterConfig | undefined;
|
|
3509
|
+
}
|
|
3510
|
+
/**
|
|
3511
|
+
* <p>The configuration for reading agent traces from CloudWatch Logs.</p>
|
|
3512
|
+
* @public
|
|
3513
|
+
*/
|
|
3514
|
+
export interface CloudWatchLogsSource {
|
|
3515
|
+
/**
|
|
3516
|
+
* <p>The list of agent service names to filter traces within the specified log groups.</p>
|
|
3517
|
+
* @public
|
|
3518
|
+
*/
|
|
3519
|
+
serviceNames: string[] | undefined;
|
|
3520
|
+
/**
|
|
3521
|
+
* <p>The list of CloudWatch log group names to read agent traces from. Maximum of 5 log groups.</p>
|
|
3522
|
+
* @public
|
|
3523
|
+
*/
|
|
3524
|
+
logGroupNames: string[] | undefined;
|
|
3525
|
+
/**
|
|
3526
|
+
* <p>Optional filter configuration to narrow down which sessions to evaluate.</p>
|
|
3527
|
+
* @public
|
|
3528
|
+
*/
|
|
3529
|
+
filterConfig?: CloudWatchFilterConfig | undefined;
|
|
3530
|
+
}
|
|
3531
|
+
/**
|
|
3532
|
+
* Where to pull session spans from
|
|
3533
|
+
* @public
|
|
3534
|
+
*/
|
|
3535
|
+
export type DataSourceConfig = DataSourceConfig.CloudWatchLogsMember | DataSourceConfig.$UnknownMember;
|
|
3536
|
+
/**
|
|
3537
|
+
* @public
|
|
3538
|
+
*/
|
|
3539
|
+
export declare namespace DataSourceConfig {
|
|
3540
|
+
/**
|
|
3541
|
+
* Pull session spans from CloudWatch
|
|
3542
|
+
* @public
|
|
3543
|
+
*/
|
|
3544
|
+
interface CloudWatchLogsMember {
|
|
3545
|
+
cloudWatchLogs: CloudWatchLogsSource;
|
|
3546
|
+
$unknown?: never;
|
|
3547
|
+
}
|
|
3548
|
+
/**
|
|
3549
|
+
* @public
|
|
3550
|
+
*/
|
|
3551
|
+
interface $UnknownMember {
|
|
3552
|
+
cloudWatchLogs?: never;
|
|
3553
|
+
$unknown: [string, any];
|
|
3554
|
+
}
|
|
3555
|
+
/**
|
|
3556
|
+
* @deprecated unused in schema-serde mode.
|
|
3557
|
+
*
|
|
3558
|
+
*/
|
|
3559
|
+
interface Visitor<T> {
|
|
3560
|
+
cloudWatchLogs: (value: CloudWatchLogsSource) => T;
|
|
3561
|
+
_: (name: string, value: any) => T;
|
|
3562
|
+
}
|
|
3563
|
+
}
|
|
3564
|
+
/**
|
|
3565
|
+
* <p>Aggregated statistics for an evaluator.</p>
|
|
3566
|
+
* @public
|
|
3567
|
+
*/
|
|
3568
|
+
export interface EvaluatorStatistics {
|
|
3569
|
+
/**
|
|
3570
|
+
* <p>The average score across all evaluated sessions for this evaluator.</p>
|
|
3571
|
+
* @public
|
|
3572
|
+
*/
|
|
3573
|
+
averageScore?: number | undefined;
|
|
3574
|
+
}
|
|
3575
|
+
/**
|
|
3576
|
+
* <p>Summary statistics for a single evaluator within a batch evaluation.</p>
|
|
3577
|
+
* @public
|
|
3578
|
+
*/
|
|
3579
|
+
export interface EvaluatorSummary {
|
|
3580
|
+
/**
|
|
3581
|
+
* <p>The unique identifier of the evaluator.</p>
|
|
3582
|
+
* @public
|
|
3583
|
+
*/
|
|
3584
|
+
evaluatorId?: string | undefined;
|
|
3585
|
+
/**
|
|
3586
|
+
* <p>The aggregated statistics for this evaluator.</p>
|
|
3587
|
+
* @public
|
|
3588
|
+
*/
|
|
3589
|
+
statistics?: EvaluatorStatistics | undefined;
|
|
3590
|
+
/**
|
|
3591
|
+
* <p>The total number of sessions evaluated by this evaluator.</p>
|
|
3592
|
+
* @public
|
|
3593
|
+
*/
|
|
3594
|
+
totalEvaluated?: number | undefined;
|
|
3595
|
+
/**
|
|
3596
|
+
* <p>The total number of sessions that failed evaluation by this evaluator.</p>
|
|
3597
|
+
* @public
|
|
3598
|
+
*/
|
|
3599
|
+
totalFailed?: number | undefined;
|
|
3600
|
+
}
|
|
3601
|
+
/**
|
|
3602
|
+
* <p>Aggregated results from a batch evaluation, including session completion counts and evaluator score summaries.</p>
|
|
3603
|
+
* @public
|
|
3604
|
+
*/
|
|
3605
|
+
export interface EvaluationJobResults {
|
|
3606
|
+
/**
|
|
3607
|
+
* <p>The number of sessions that have been successfully evaluated.</p>
|
|
3608
|
+
* @public
|
|
3609
|
+
*/
|
|
3610
|
+
numberOfSessionsCompleted?: number | undefined;
|
|
3611
|
+
/**
|
|
3612
|
+
* <p>The number of sessions currently being evaluated.</p>
|
|
3613
|
+
* @public
|
|
3614
|
+
*/
|
|
3615
|
+
numberOfSessionsInProgress?: number | undefined;
|
|
3616
|
+
/**
|
|
3617
|
+
* <p>The number of sessions that failed evaluation.</p>
|
|
3618
|
+
* @public
|
|
3619
|
+
*/
|
|
3620
|
+
numberOfSessionsFailed?: number | undefined;
|
|
3621
|
+
/**
|
|
3622
|
+
* <p>The total number of sessions included in the batch evaluation.</p>
|
|
3623
|
+
* @public
|
|
3624
|
+
*/
|
|
3625
|
+
totalNumberOfSessions?: number | undefined;
|
|
3626
|
+
/**
|
|
3627
|
+
* <p>The number of sessions that were ignored during evaluation.</p>
|
|
3628
|
+
* @public
|
|
3629
|
+
*/
|
|
3630
|
+
numberOfSessionsIgnored?: number | undefined;
|
|
3631
|
+
/**
|
|
3632
|
+
* <p>A list of per-evaluator summary statistics.</p>
|
|
3633
|
+
* @public
|
|
3634
|
+
*/
|
|
3635
|
+
evaluatorSummaries?: EvaluatorSummary[] | undefined;
|
|
3636
|
+
}
|
|
3637
|
+
/**
|
|
3638
|
+
* An evaluator to run against sessions
|
|
3639
|
+
* @public
|
|
3640
|
+
*/
|
|
3641
|
+
export interface Evaluator {
|
|
3642
|
+
/**
|
|
3643
|
+
* <p>The unique identifier of the evaluator. Can reference built-in evaluators (e.g., <code>Builtin.Helpfulness</code>) or custom evaluators.</p>
|
|
3644
|
+
* @public
|
|
3645
|
+
*/
|
|
3646
|
+
evaluatorId: string | undefined;
|
|
3647
|
+
}
|
|
3648
|
+
/**
|
|
3649
|
+
* CloudWatch Logs destination for batch evaluation results
|
|
3650
|
+
* @public
|
|
3651
|
+
*/
|
|
3652
|
+
export interface CloudWatchOutputConfig {
|
|
3653
|
+
/**
|
|
3654
|
+
* <p>The name of the CloudWatch log group where evaluation results will be written.</p>
|
|
3655
|
+
* @public
|
|
3656
|
+
*/
|
|
3657
|
+
logGroupName: string | undefined;
|
|
3658
|
+
/**
|
|
3659
|
+
* <p>The name of the CloudWatch log stream where evaluation results will be written.</p>
|
|
3660
|
+
* @public
|
|
3661
|
+
*/
|
|
3662
|
+
logStreamName: string | undefined;
|
|
3663
|
+
}
|
|
3664
|
+
/**
|
|
3665
|
+
* Output destination configuration
|
|
3666
|
+
* @public
|
|
3667
|
+
*/
|
|
3668
|
+
export type OutputConfig = OutputConfig.CloudWatchConfigMember | OutputConfig.$UnknownMember;
|
|
3669
|
+
/**
|
|
3670
|
+
* @public
|
|
3671
|
+
*/
|
|
3672
|
+
export declare namespace OutputConfig {
|
|
3673
|
+
/**
|
|
3674
|
+
* <p>The CloudWatch Logs configuration for writing evaluation results.</p>
|
|
3675
|
+
* @public
|
|
3676
|
+
*/
|
|
3677
|
+
interface CloudWatchConfigMember {
|
|
3678
|
+
cloudWatchConfig: CloudWatchOutputConfig;
|
|
3679
|
+
$unknown?: never;
|
|
3680
|
+
}
|
|
3681
|
+
/**
|
|
3682
|
+
* @public
|
|
3683
|
+
*/
|
|
3684
|
+
interface $UnknownMember {
|
|
3685
|
+
cloudWatchConfig?: never;
|
|
3686
|
+
$unknown: [string, any];
|
|
3687
|
+
}
|
|
3688
|
+
/**
|
|
3689
|
+
* @deprecated unused in schema-serde mode.
|
|
3690
|
+
*
|
|
3691
|
+
*/
|
|
3692
|
+
interface Visitor<T> {
|
|
3693
|
+
cloudWatchConfig: (value: CloudWatchOutputConfig) => T;
|
|
3694
|
+
_: (name: string, value: any) => T;
|
|
3695
|
+
}
|
|
3696
|
+
}
|
|
3697
|
+
/**
|
|
3698
|
+
* @public
|
|
3699
|
+
*/
|
|
3700
|
+
export interface GetBatchEvaluationResponse {
|
|
3701
|
+
/**
|
|
3702
|
+
* <p>The unique identifier of the batch evaluation.</p>
|
|
3703
|
+
* @public
|
|
3704
|
+
*/
|
|
3705
|
+
batchEvaluationId: string | undefined;
|
|
3706
|
+
/**
|
|
3707
|
+
* <p>The Amazon Resource Name (ARN) of the batch evaluation.</p>
|
|
3708
|
+
* @public
|
|
3709
|
+
*/
|
|
3710
|
+
batchEvaluationArn: string | undefined;
|
|
3711
|
+
/**
|
|
3712
|
+
* <p>The name of the batch evaluation.</p>
|
|
3713
|
+
* @public
|
|
3714
|
+
*/
|
|
3715
|
+
batchEvaluationName: string | undefined;
|
|
3716
|
+
/**
|
|
3717
|
+
* <p>The current status of the batch evaluation.</p>
|
|
3718
|
+
* @public
|
|
3719
|
+
*/
|
|
3720
|
+
status: BatchEvaluationStatus | undefined;
|
|
3721
|
+
/**
|
|
3722
|
+
* <p>The timestamp when the batch evaluation was created.</p>
|
|
3723
|
+
* @public
|
|
3724
|
+
*/
|
|
3725
|
+
createdAt: Date | undefined;
|
|
3726
|
+
/**
|
|
3727
|
+
* <p>The list of evaluators applied during the batch evaluation.</p>
|
|
3728
|
+
* @public
|
|
3729
|
+
*/
|
|
3730
|
+
evaluators?: Evaluator[] | undefined;
|
|
3731
|
+
/**
|
|
3732
|
+
* <p>The data source configuration specifying where agent traces are pulled from.</p>
|
|
3733
|
+
* @public
|
|
3734
|
+
*/
|
|
3735
|
+
dataSourceConfig?: DataSourceConfig | undefined;
|
|
3736
|
+
/**
|
|
3737
|
+
* <p>The output configuration specifying where evaluation results are written.</p>
|
|
3738
|
+
* @public
|
|
3739
|
+
*/
|
|
3740
|
+
outputConfig?: OutputConfig | undefined;
|
|
3741
|
+
/**
|
|
3742
|
+
* <p>The aggregated evaluation results, including session completion counts and evaluator score summaries.</p>
|
|
3743
|
+
* @public
|
|
3744
|
+
*/
|
|
3745
|
+
evaluationResults?: EvaluationJobResults | undefined;
|
|
3746
|
+
/**
|
|
3747
|
+
* <p>The error details if the batch evaluation encountered failures.</p>
|
|
3748
|
+
* @public
|
|
3749
|
+
*/
|
|
3750
|
+
errorDetails?: string[] | undefined;
|
|
3751
|
+
/**
|
|
3752
|
+
* <p>The description of the batch evaluation.</p>
|
|
3753
|
+
* @public
|
|
3754
|
+
*/
|
|
3755
|
+
description?: string | undefined;
|
|
3756
|
+
/**
|
|
3757
|
+
* <p>The timestamp when the batch evaluation was last updated.</p>
|
|
3758
|
+
* @public
|
|
3759
|
+
*/
|
|
3760
|
+
updatedAt?: Date | undefined;
|
|
3761
|
+
}
|
|
3762
|
+
/**
|
|
3763
|
+
* @public
|
|
3764
|
+
*/
|
|
3765
|
+
export interface GetRecommendationRequest {
|
|
3766
|
+
/**
|
|
3767
|
+
* <p>The unique identifier of the recommendation to retrieve.</p>
|
|
3768
|
+
* @public
|
|
3769
|
+
*/
|
|
3770
|
+
recommendationId: string | undefined;
|
|
3771
|
+
}
|
|
3772
|
+
/**
|
|
3773
|
+
* <p>A reference to an evaluator used for recommendation assessment.</p>
|
|
3774
|
+
* @public
|
|
3775
|
+
*/
|
|
3776
|
+
export interface RecommendationEvaluatorReference {
|
|
3777
|
+
/**
|
|
3778
|
+
* <p>The Amazon Resource Name (ARN) of the evaluator.</p>
|
|
3779
|
+
* @public
|
|
3780
|
+
*/
|
|
3781
|
+
evaluatorArn: string | undefined;
|
|
3782
|
+
}
|
|
3783
|
+
/**
|
|
3784
|
+
* <p>The evaluation configuration for assessing recommendation quality.</p>
|
|
3785
|
+
* @public
|
|
3786
|
+
*/
|
|
3787
|
+
export interface RecommendationEvaluationConfig {
|
|
3788
|
+
/**
|
|
3789
|
+
* <p>The list of evaluators to use for assessing recommendation quality.</p>
|
|
3790
|
+
* @public
|
|
3791
|
+
*/
|
|
3792
|
+
evaluators: RecommendationEvaluatorReference[] | undefined;
|
|
3793
|
+
}
|
|
3794
|
+
/**
|
|
3795
|
+
* <p>A system prompt sourced from a configuration bundle version.</p>
|
|
3796
|
+
* @public
|
|
3797
|
+
*/
|
|
3798
|
+
export interface SystemPromptConfigurationBundle {
|
|
3799
|
+
/**
|
|
3800
|
+
* <p>The Amazon Resource Name (ARN) of the configuration bundle.</p>
|
|
3801
|
+
* @public
|
|
3802
|
+
*/
|
|
3803
|
+
bundleArn: string | undefined;
|
|
3804
|
+
/**
|
|
3805
|
+
* <p>The version identifier of the configuration bundle.</p>
|
|
3806
|
+
* @public
|
|
3807
|
+
*/
|
|
3808
|
+
versionId: string | undefined;
|
|
3809
|
+
/**
|
|
3810
|
+
* <p>The JSON path within the configuration bundle that contains the system prompt.</p>
|
|
3811
|
+
* @public
|
|
3812
|
+
*/
|
|
3813
|
+
systemPromptJsonPath: string | undefined;
|
|
3814
|
+
}
|
|
3815
|
+
/**
|
|
3816
|
+
* <p>The system prompt input, either as inline text or from a configuration bundle.</p>
|
|
3817
|
+
* @public
|
|
3818
|
+
*/
|
|
3819
|
+
export type SystemPromptConfig = SystemPromptConfig.ConfigurationBundleMember | SystemPromptConfig.TextMember | SystemPromptConfig.$UnknownMember;
|
|
3820
|
+
/**
|
|
3821
|
+
* @public
|
|
3822
|
+
*/
|
|
3823
|
+
export declare namespace SystemPromptConfig {
|
|
3824
|
+
/**
|
|
3825
|
+
* <p>The system prompt text provided inline.</p>
|
|
3826
|
+
* @public
|
|
3827
|
+
*/
|
|
3828
|
+
interface TextMember {
|
|
3829
|
+
text: string;
|
|
3830
|
+
configurationBundle?: never;
|
|
3831
|
+
$unknown?: never;
|
|
3832
|
+
}
|
|
3833
|
+
/**
|
|
3834
|
+
* <p>The system prompt sourced from a configuration bundle version.</p>
|
|
3835
|
+
* @public
|
|
3836
|
+
*/
|
|
3837
|
+
interface ConfigurationBundleMember {
|
|
3838
|
+
text?: never;
|
|
3839
|
+
configurationBundle: SystemPromptConfigurationBundle;
|
|
3840
|
+
$unknown?: never;
|
|
3841
|
+
}
|
|
3842
|
+
/**
|
|
3843
|
+
* @public
|
|
3844
|
+
*/
|
|
3845
|
+
interface $UnknownMember {
|
|
3846
|
+
text?: never;
|
|
3847
|
+
configurationBundle?: never;
|
|
3848
|
+
$unknown: [string, any];
|
|
3849
|
+
}
|
|
3850
|
+
/**
|
|
3851
|
+
* @deprecated unused in schema-serde mode.
|
|
3852
|
+
*
|
|
3853
|
+
*/
|
|
3854
|
+
interface Visitor<T> {
|
|
3855
|
+
text: (value: string) => T;
|
|
3856
|
+
configurationBundle: (value: SystemPromptConfigurationBundle) => T;
|
|
3857
|
+
_: (name: string, value: any) => T;
|
|
3858
|
+
}
|
|
3859
|
+
}
|
|
3860
|
+
/**
|
|
3861
|
+
* <p>Configuration for generating system prompt optimization recommendations.</p>
|
|
3862
|
+
* @public
|
|
3863
|
+
*/
|
|
3864
|
+
export interface SystemPromptRecommendationConfig {
|
|
3865
|
+
/**
|
|
3866
|
+
* <p>The current system prompt to optimize.</p>
|
|
3867
|
+
* @public
|
|
3868
|
+
*/
|
|
3869
|
+
systemPrompt: SystemPromptConfig | undefined;
|
|
3870
|
+
/**
|
|
3871
|
+
* <p>The agent traces to analyze for generating recommendations.</p>
|
|
3872
|
+
* @public
|
|
3873
|
+
*/
|
|
3874
|
+
agentTraces: AgentTracesConfig | undefined;
|
|
3875
|
+
/**
|
|
3876
|
+
* <p>The evaluation configuration specifying which evaluator to use for assessing recommendation quality.</p>
|
|
3877
|
+
* @public
|
|
3878
|
+
*/
|
|
3879
|
+
evaluationConfig: RecommendationEvaluationConfig | undefined;
|
|
3880
|
+
}
|
|
3881
|
+
/**
|
|
3882
|
+
* <p>Maps a tool name to its JSON path within a configuration bundle.</p>
|
|
3883
|
+
* @public
|
|
3884
|
+
*/
|
|
3885
|
+
export interface ConfigurationBundleToolEntry {
|
|
3886
|
+
/**
|
|
3887
|
+
* <p>The name of the tool.</p>
|
|
3888
|
+
* @public
|
|
3889
|
+
*/
|
|
3890
|
+
toolName: string | undefined;
|
|
3891
|
+
/**
|
|
3892
|
+
* <p>The JSON path within the configuration bundle's components that contains the tool description.</p>
|
|
3893
|
+
* @public
|
|
3894
|
+
*/
|
|
3895
|
+
toolDescriptionJsonPath: string | undefined;
|
|
3896
|
+
}
|
|
3897
|
+
/**
|
|
3898
|
+
* <p>Tool descriptions sourced from a configuration bundle version.</p>
|
|
3899
|
+
* @public
|
|
3900
|
+
*/
|
|
3901
|
+
export interface ToolDescriptionConfigurationBundle {
|
|
3902
|
+
/**
|
|
3903
|
+
* <p>The Amazon Resource Name (ARN) of the configuration bundle.</p>
|
|
3904
|
+
* @public
|
|
3905
|
+
*/
|
|
3906
|
+
bundleArn: string | undefined;
|
|
3907
|
+
/**
|
|
3908
|
+
* <p>The version identifier of the configuration bundle.</p>
|
|
3909
|
+
* @public
|
|
3910
|
+
*/
|
|
3911
|
+
versionId: string | undefined;
|
|
3912
|
+
/**
|
|
3913
|
+
* <p>The list of tool entries mapping tool names to their JSON paths within the bundle.</p>
|
|
3914
|
+
* @public
|
|
3915
|
+
*/
|
|
3916
|
+
tools: ConfigurationBundleToolEntry[] | undefined;
|
|
3917
|
+
}
|
|
3918
|
+
/**
|
|
3919
|
+
* <p>The tool description content.</p>
|
|
3920
|
+
* @public
|
|
3921
|
+
*/
|
|
3922
|
+
export type ToolDescriptionConfig = ToolDescriptionConfig.TextMember | ToolDescriptionConfig.$UnknownMember;
|
|
3923
|
+
/**
|
|
3924
|
+
* @public
|
|
3925
|
+
*/
|
|
3926
|
+
export declare namespace ToolDescriptionConfig {
|
|
3927
|
+
/**
|
|
3928
|
+
* <p>The tool description as inline text.</p>
|
|
3929
|
+
* @public
|
|
3930
|
+
*/
|
|
3931
|
+
interface TextMember {
|
|
3932
|
+
text: string;
|
|
3933
|
+
$unknown?: never;
|
|
3934
|
+
}
|
|
3935
|
+
/**
|
|
3936
|
+
* @public
|
|
3937
|
+
*/
|
|
3938
|
+
interface $UnknownMember {
|
|
3939
|
+
text?: never;
|
|
3940
|
+
$unknown: [string, any];
|
|
3941
|
+
}
|
|
3942
|
+
/**
|
|
3943
|
+
* @deprecated unused in schema-serde mode.
|
|
3944
|
+
*
|
|
3945
|
+
*/
|
|
3946
|
+
interface Visitor<T> {
|
|
3947
|
+
text: (value: string) => T;
|
|
3948
|
+
_: (name: string, value: any) => T;
|
|
3949
|
+
}
|
|
3950
|
+
}
|
|
3951
|
+
/**
|
|
3952
|
+
* <p>A tool description input containing the tool name and its current description.</p>
|
|
3953
|
+
* @public
|
|
3954
|
+
*/
|
|
3955
|
+
export interface ToolDescriptionInput {
|
|
3956
|
+
/**
|
|
3957
|
+
* <p>The name of the tool.</p>
|
|
3958
|
+
* @public
|
|
3959
|
+
*/
|
|
3960
|
+
toolName: string | undefined;
|
|
3961
|
+
/**
|
|
3962
|
+
* <p>The current description of the tool to optimize.</p>
|
|
3963
|
+
* @public
|
|
3964
|
+
*/
|
|
3965
|
+
toolDescription: ToolDescriptionConfig | undefined;
|
|
3966
|
+
}
|
|
3967
|
+
/**
|
|
3968
|
+
* <p>Inline tool description input containing a list of tools.</p>
|
|
3969
|
+
* @public
|
|
3970
|
+
*/
|
|
3971
|
+
export interface ToolDescriptionTextInput {
|
|
3972
|
+
/**
|
|
3973
|
+
* <p>The list of tool descriptions to optimize.</p>
|
|
3974
|
+
* @public
|
|
3975
|
+
*/
|
|
3976
|
+
tools: ToolDescriptionInput[] | undefined;
|
|
3977
|
+
}
|
|
3978
|
+
/**
|
|
3979
|
+
* <p>The source of tool descriptions, either inline text or from a configuration bundle.</p>
|
|
3980
|
+
* @public
|
|
3981
|
+
*/
|
|
3982
|
+
export type ToolDescriptionSource = ToolDescriptionSource.ConfigurationBundleMember | ToolDescriptionSource.ToolDescriptionTextMember | ToolDescriptionSource.$UnknownMember;
|
|
3983
|
+
/**
|
|
3984
|
+
* @public
|
|
3985
|
+
*/
|
|
3986
|
+
export declare namespace ToolDescriptionSource {
|
|
3987
|
+
/**
|
|
3988
|
+
* <p>Tool descriptions provided as inline text.</p>
|
|
3989
|
+
* @public
|
|
3990
|
+
*/
|
|
3991
|
+
interface ToolDescriptionTextMember {
|
|
3992
|
+
toolDescriptionText: ToolDescriptionTextInput;
|
|
3993
|
+
configurationBundle?: never;
|
|
3994
|
+
$unknown?: never;
|
|
3995
|
+
}
|
|
3996
|
+
/**
|
|
3997
|
+
* <p>Tool descriptions sourced from a configuration bundle version.</p>
|
|
3998
|
+
* @public
|
|
3999
|
+
*/
|
|
4000
|
+
interface ConfigurationBundleMember {
|
|
4001
|
+
toolDescriptionText?: never;
|
|
4002
|
+
configurationBundle: ToolDescriptionConfigurationBundle;
|
|
4003
|
+
$unknown?: never;
|
|
4004
|
+
}
|
|
4005
|
+
/**
|
|
4006
|
+
* @public
|
|
4007
|
+
*/
|
|
4008
|
+
interface $UnknownMember {
|
|
4009
|
+
toolDescriptionText?: never;
|
|
4010
|
+
configurationBundle?: never;
|
|
4011
|
+
$unknown: [string, any];
|
|
4012
|
+
}
|
|
4013
|
+
/**
|
|
4014
|
+
* @deprecated unused in schema-serde mode.
|
|
4015
|
+
*
|
|
4016
|
+
*/
|
|
4017
|
+
interface Visitor<T> {
|
|
4018
|
+
toolDescriptionText: (value: ToolDescriptionTextInput) => T;
|
|
4019
|
+
configurationBundle: (value: ToolDescriptionConfigurationBundle) => T;
|
|
4020
|
+
_: (name: string, value: any) => T;
|
|
4021
|
+
}
|
|
4022
|
+
}
|
|
4023
|
+
/**
|
|
4024
|
+
* <p>Configuration for generating tool description optimization recommendations.</p>
|
|
4025
|
+
* @public
|
|
4026
|
+
*/
|
|
4027
|
+
export interface ToolDescriptionRecommendationConfig {
|
|
4028
|
+
/**
|
|
4029
|
+
* <p>The current tool descriptions to optimize.</p>
|
|
4030
|
+
* @public
|
|
4031
|
+
*/
|
|
4032
|
+
toolDescription: ToolDescriptionSource | undefined;
|
|
4033
|
+
/**
|
|
4034
|
+
* <p>The agent traces to analyze for generating tool description recommendations.</p>
|
|
4035
|
+
* @public
|
|
4036
|
+
*/
|
|
4037
|
+
agentTraces: AgentTracesConfig | undefined;
|
|
4038
|
+
}
|
|
4039
|
+
/**
|
|
4040
|
+
* <p>The configuration for a recommendation, varying by recommendation type.</p>
|
|
4041
|
+
* @public
|
|
4042
|
+
*/
|
|
4043
|
+
export type RecommendationConfig = RecommendationConfig.SystemPromptRecommendationConfigMember | RecommendationConfig.ToolDescriptionRecommendationConfigMember | RecommendationConfig.$UnknownMember;
|
|
4044
|
+
/**
|
|
4045
|
+
* @public
|
|
4046
|
+
*/
|
|
4047
|
+
export declare namespace RecommendationConfig {
|
|
4048
|
+
/**
|
|
4049
|
+
* <p>The configuration for a system prompt recommendation.</p>
|
|
4050
|
+
* @public
|
|
4051
|
+
*/
|
|
4052
|
+
interface SystemPromptRecommendationConfigMember {
|
|
4053
|
+
systemPromptRecommendationConfig: SystemPromptRecommendationConfig;
|
|
4054
|
+
toolDescriptionRecommendationConfig?: never;
|
|
4055
|
+
$unknown?: never;
|
|
4056
|
+
}
|
|
4057
|
+
/**
|
|
4058
|
+
* <p>The configuration for a tool description recommendation.</p>
|
|
4059
|
+
* @public
|
|
4060
|
+
*/
|
|
4061
|
+
interface ToolDescriptionRecommendationConfigMember {
|
|
4062
|
+
systemPromptRecommendationConfig?: never;
|
|
4063
|
+
toolDescriptionRecommendationConfig: ToolDescriptionRecommendationConfig;
|
|
4064
|
+
$unknown?: never;
|
|
4065
|
+
}
|
|
4066
|
+
/**
|
|
4067
|
+
* @public
|
|
4068
|
+
*/
|
|
4069
|
+
interface $UnknownMember {
|
|
4070
|
+
systemPromptRecommendationConfig?: never;
|
|
4071
|
+
toolDescriptionRecommendationConfig?: never;
|
|
4072
|
+
$unknown: [string, any];
|
|
4073
|
+
}
|
|
4074
|
+
/**
|
|
4075
|
+
* @deprecated unused in schema-serde mode.
|
|
4076
|
+
*
|
|
4077
|
+
*/
|
|
4078
|
+
interface Visitor<T> {
|
|
4079
|
+
systemPromptRecommendationConfig: (value: SystemPromptRecommendationConfig) => T;
|
|
4080
|
+
toolDescriptionRecommendationConfig: (value: ToolDescriptionRecommendationConfig) => T;
|
|
4081
|
+
_: (name: string, value: any) => T;
|
|
4082
|
+
}
|
|
4083
|
+
}
|
|
4084
|
+
/**
|
|
4085
|
+
* <p>A configuration bundle reference in a recommendation result.</p>
|
|
4086
|
+
* @public
|
|
4087
|
+
*/
|
|
4088
|
+
export interface RecommendationResultConfigurationBundle {
|
|
4089
|
+
/**
|
|
4090
|
+
* <p>The Amazon Resource Name (ARN) of the configuration bundle.</p>
|
|
4091
|
+
* @public
|
|
4092
|
+
*/
|
|
4093
|
+
bundleArn: string | undefined;
|
|
4094
|
+
/**
|
|
4095
|
+
* <p>The version identifier of the configuration bundle containing the recommendation.</p>
|
|
4096
|
+
* @public
|
|
4097
|
+
*/
|
|
4098
|
+
versionId: string | undefined;
|
|
4099
|
+
}
|
|
4100
|
+
/**
|
|
4101
|
+
* <p>The result of a system prompt recommendation, containing the optimized prompt.</p>
|
|
4102
|
+
* @public
|
|
4103
|
+
*/
|
|
4104
|
+
export interface SystemPromptRecommendationResult {
|
|
4105
|
+
/**
|
|
4106
|
+
* <p>The optimized system prompt text generated by the recommendation.</p>
|
|
4107
|
+
* @public
|
|
4108
|
+
*/
|
|
4109
|
+
recommendedSystemPrompt?: string | undefined;
|
|
4110
|
+
/**
|
|
4111
|
+
* <p>The configuration bundle containing the recommended system prompt, if the input was sourced from a configuration bundle.</p>
|
|
4112
|
+
* @public
|
|
4113
|
+
*/
|
|
4114
|
+
configurationBundle?: RecommendationResultConfigurationBundle | undefined;
|
|
4115
|
+
/**
|
|
4116
|
+
* <p>The error code if the recommendation failed.</p>
|
|
4117
|
+
* @public
|
|
4118
|
+
*/
|
|
4119
|
+
errorCode?: string | undefined;
|
|
4120
|
+
/**
|
|
4121
|
+
* <p>The error message if the recommendation failed.</p>
|
|
4122
|
+
* @public
|
|
4123
|
+
*/
|
|
4124
|
+
errorMessage?: string | undefined;
|
|
4125
|
+
}
|
|
4126
|
+
/**
|
|
4127
|
+
* <p>The output for a single tool description recommendation.</p>
|
|
4128
|
+
* @public
|
|
4129
|
+
*/
|
|
4130
|
+
export interface ToolDescriptionOutput {
|
|
4131
|
+
/**
|
|
4132
|
+
* <p>The name of the tool.</p>
|
|
4133
|
+
* @public
|
|
4134
|
+
*/
|
|
4135
|
+
toolName: string | undefined;
|
|
4136
|
+
/**
|
|
4137
|
+
* <p>The optimized tool description text generated by the recommendation.</p>
|
|
4138
|
+
* @public
|
|
4139
|
+
*/
|
|
4140
|
+
recommendedToolDescription?: string | undefined;
|
|
4141
|
+
}
|
|
4142
|
+
/**
|
|
4143
|
+
* <p>The result of a tool description recommendation, containing optimized descriptions.</p>
|
|
4144
|
+
* @public
|
|
4145
|
+
*/
|
|
4146
|
+
export interface ToolDescriptionRecommendationResult {
|
|
4147
|
+
/**
|
|
4148
|
+
* <p>The list of tools with their recommended descriptions.</p>
|
|
4149
|
+
* @public
|
|
4150
|
+
*/
|
|
4151
|
+
tools?: ToolDescriptionOutput[] | undefined;
|
|
4152
|
+
/**
|
|
4153
|
+
* <p>The configuration bundle containing the recommended tool descriptions, if the input was sourced from a configuration bundle.</p>
|
|
4154
|
+
* @public
|
|
4155
|
+
*/
|
|
4156
|
+
configurationBundle?: RecommendationResultConfigurationBundle | undefined;
|
|
4157
|
+
/**
|
|
4158
|
+
* <p>The error code if the recommendation failed.</p>
|
|
4159
|
+
* @public
|
|
4160
|
+
*/
|
|
4161
|
+
errorCode?: string | undefined;
|
|
4162
|
+
/**
|
|
4163
|
+
* <p>The error message if the recommendation failed.</p>
|
|
4164
|
+
* @public
|
|
4165
|
+
*/
|
|
4166
|
+
errorMessage?: string | undefined;
|
|
4167
|
+
}
|
|
4168
|
+
/**
|
|
4169
|
+
* <p>The result of a recommendation, containing the optimized output.</p>
|
|
4170
|
+
* @public
|
|
4171
|
+
*/
|
|
4172
|
+
export type RecommendationResult = RecommendationResult.SystemPromptRecommendationResultMember | RecommendationResult.ToolDescriptionRecommendationResultMember | RecommendationResult.$UnknownMember;
|
|
4173
|
+
/**
|
|
4174
|
+
* @public
|
|
4175
|
+
*/
|
|
4176
|
+
export declare namespace RecommendationResult {
|
|
4177
|
+
/**
|
|
4178
|
+
* <p>The result of a system prompt recommendation.</p>
|
|
4179
|
+
* @public
|
|
4180
|
+
*/
|
|
4181
|
+
interface SystemPromptRecommendationResultMember {
|
|
4182
|
+
systemPromptRecommendationResult: SystemPromptRecommendationResult;
|
|
4183
|
+
toolDescriptionRecommendationResult?: never;
|
|
4184
|
+
$unknown?: never;
|
|
4185
|
+
}
|
|
4186
|
+
/**
|
|
4187
|
+
* <p>The result of a tool description recommendation.</p>
|
|
4188
|
+
* @public
|
|
4189
|
+
*/
|
|
4190
|
+
interface ToolDescriptionRecommendationResultMember {
|
|
4191
|
+
systemPromptRecommendationResult?: never;
|
|
4192
|
+
toolDescriptionRecommendationResult: ToolDescriptionRecommendationResult;
|
|
4193
|
+
$unknown?: never;
|
|
4194
|
+
}
|
|
4195
|
+
/**
|
|
4196
|
+
* @public
|
|
4197
|
+
*/
|
|
4198
|
+
interface $UnknownMember {
|
|
4199
|
+
systemPromptRecommendationResult?: never;
|
|
4200
|
+
toolDescriptionRecommendationResult?: never;
|
|
4201
|
+
$unknown: [string, any];
|
|
4202
|
+
}
|
|
4203
|
+
/**
|
|
4204
|
+
* @deprecated unused in schema-serde mode.
|
|
4205
|
+
*
|
|
4206
|
+
*/
|
|
4207
|
+
interface Visitor<T> {
|
|
4208
|
+
systemPromptRecommendationResult: (value: SystemPromptRecommendationResult) => T;
|
|
4209
|
+
toolDescriptionRecommendationResult: (value: ToolDescriptionRecommendationResult) => T;
|
|
4210
|
+
_: (name: string, value: any) => T;
|
|
4211
|
+
}
|
|
4212
|
+
}
|
|
4213
|
+
/**
|
|
4214
|
+
* @public
|
|
4215
|
+
*/
|
|
4216
|
+
export interface GetRecommendationResponse {
|
|
4217
|
+
/**
|
|
4218
|
+
* <p>The unique identifier of the recommendation.</p>
|
|
4219
|
+
* @public
|
|
4220
|
+
*/
|
|
4221
|
+
recommendationId: string | undefined;
|
|
4222
|
+
/**
|
|
4223
|
+
* <p>The Amazon Resource Name (ARN) of the recommendation.</p>
|
|
4224
|
+
* @public
|
|
4225
|
+
*/
|
|
4226
|
+
recommendationArn: string | undefined;
|
|
4227
|
+
/**
|
|
4228
|
+
* <p>The name of the recommendation.</p>
|
|
4229
|
+
* @public
|
|
4230
|
+
*/
|
|
4231
|
+
name: string | undefined;
|
|
4232
|
+
/**
|
|
4233
|
+
* <p>The description of the recommendation.</p>
|
|
4234
|
+
* @public
|
|
4235
|
+
*/
|
|
4236
|
+
description?: string | undefined;
|
|
4237
|
+
/**
|
|
4238
|
+
* <p>The type of recommendation.</p>
|
|
4239
|
+
* @public
|
|
4240
|
+
*/
|
|
4241
|
+
type: RecommendationType | undefined;
|
|
4242
|
+
/**
|
|
4243
|
+
* <p>The configuration for the recommendation.</p>
|
|
4244
|
+
* @public
|
|
4245
|
+
*/
|
|
4246
|
+
recommendationConfig: RecommendationConfig | undefined;
|
|
4247
|
+
/**
|
|
4248
|
+
* <p>The current status of the recommendation.</p>
|
|
4249
|
+
* @public
|
|
4250
|
+
*/
|
|
4251
|
+
status: RecommendationStatus | undefined;
|
|
4252
|
+
/**
|
|
4253
|
+
* <p>The timestamp when the recommendation was created.</p>
|
|
4254
|
+
* @public
|
|
4255
|
+
*/
|
|
4256
|
+
createdAt: Date | undefined;
|
|
4257
|
+
/**
|
|
4258
|
+
* <p>The timestamp when the recommendation was last updated.</p>
|
|
4259
|
+
* @public
|
|
4260
|
+
*/
|
|
4261
|
+
updatedAt: Date | undefined;
|
|
4262
|
+
/**
|
|
4263
|
+
* <p>The result of the recommendation, containing the optimized system prompt or tool descriptions. Only present when the recommendation status is <code>COMPLETED</code>.</p>
|
|
4264
|
+
* @public
|
|
4265
|
+
*/
|
|
4266
|
+
recommendationResult?: RecommendationResult | undefined;
|
|
4267
|
+
}
|
|
4268
|
+
/**
|
|
4269
|
+
* @public
|
|
4270
|
+
*/
|
|
4271
|
+
export interface ListABTestsRequest {
|
|
4272
|
+
/**
|
|
4273
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
4274
|
+
* @public
|
|
4275
|
+
*/
|
|
4276
|
+
maxResults?: number | undefined;
|
|
4277
|
+
/**
|
|
4278
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
4279
|
+
* @public
|
|
4280
|
+
*/
|
|
4281
|
+
nextToken?: string | undefined;
|
|
4282
|
+
}
|
|
4283
|
+
/**
|
|
4284
|
+
* @public
|
|
4285
|
+
*/
|
|
4286
|
+
export interface ListABTestsResponse {
|
|
4287
|
+
/**
|
|
4288
|
+
* <p>The list of A/B test summaries.</p>
|
|
4289
|
+
* @public
|
|
4290
|
+
*/
|
|
4291
|
+
abTests: ABTestSummary[] | undefined;
|
|
4292
|
+
/**
|
|
4293
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
4294
|
+
* @public
|
|
4295
|
+
*/
|
|
4296
|
+
nextToken?: string | undefined;
|
|
4297
|
+
}
|
|
4298
|
+
/**
|
|
4299
|
+
* @public
|
|
4300
|
+
*/
|
|
4301
|
+
export interface ListBatchEvaluationsRequest {
|
|
4302
|
+
/**
|
|
4303
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
4304
|
+
* @public
|
|
4305
|
+
*/
|
|
4306
|
+
maxResults?: number | undefined;
|
|
4307
|
+
/**
|
|
4308
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
4309
|
+
* @public
|
|
4310
|
+
*/
|
|
4311
|
+
nextToken?: string | undefined;
|
|
4312
|
+
}
|
|
4313
|
+
/**
|
|
4314
|
+
* Summary representation for list responses
|
|
4315
|
+
* @public
|
|
4316
|
+
*/
|
|
4317
|
+
export interface BatchEvaluationSummary {
|
|
4318
|
+
/**
|
|
4319
|
+
* <p>The unique identifier of the batch evaluation.</p>
|
|
4320
|
+
* @public
|
|
4321
|
+
*/
|
|
4322
|
+
batchEvaluationId: string | undefined;
|
|
4323
|
+
/**
|
|
4324
|
+
* <p>The Amazon Resource Name (ARN) of the batch evaluation.</p>
|
|
4325
|
+
* @public
|
|
4326
|
+
*/
|
|
4327
|
+
batchEvaluationArn: string | undefined;
|
|
4328
|
+
/**
|
|
4329
|
+
* <p>The name of the batch evaluation.</p>
|
|
4330
|
+
* @public
|
|
4331
|
+
*/
|
|
4332
|
+
batchEvaluationName: string | undefined;
|
|
4333
|
+
/**
|
|
4334
|
+
* <p>The current status of the batch evaluation.</p>
|
|
4335
|
+
* @public
|
|
4336
|
+
*/
|
|
4337
|
+
status: BatchEvaluationStatus | undefined;
|
|
4338
|
+
/**
|
|
4339
|
+
* <p>The timestamp when the batch evaluation was created.</p>
|
|
4340
|
+
* @public
|
|
4341
|
+
*/
|
|
4342
|
+
createdAt: Date | undefined;
|
|
4343
|
+
/**
|
|
4344
|
+
* <p>The description of the batch evaluation.</p>
|
|
4345
|
+
* @public
|
|
4346
|
+
*/
|
|
4347
|
+
description?: string | undefined;
|
|
4348
|
+
/**
|
|
4349
|
+
* <p>The list of evaluators applied during the batch evaluation.</p>
|
|
4350
|
+
* @public
|
|
4351
|
+
*/
|
|
4352
|
+
evaluators?: Evaluator[] | undefined;
|
|
4353
|
+
/**
|
|
4354
|
+
* <p>The aggregated evaluation results.</p>
|
|
4355
|
+
* @public
|
|
4356
|
+
*/
|
|
4357
|
+
evaluationResults?: EvaluationJobResults | undefined;
|
|
4358
|
+
/**
|
|
4359
|
+
* <p>The error details if the batch evaluation encountered failures.</p>
|
|
4360
|
+
* @public
|
|
4361
|
+
*/
|
|
4362
|
+
errorDetails?: string[] | undefined;
|
|
4363
|
+
/**
|
|
4364
|
+
* <p>The timestamp when the batch evaluation was last updated.</p>
|
|
4365
|
+
* @public
|
|
4366
|
+
*/
|
|
4367
|
+
updatedAt?: Date | undefined;
|
|
4368
|
+
}
|
|
4369
|
+
/**
|
|
4370
|
+
* @public
|
|
4371
|
+
*/
|
|
4372
|
+
export interface ListBatchEvaluationsResponse {
|
|
4373
|
+
/**
|
|
4374
|
+
* <p>The list of batch evaluation summaries.</p>
|
|
4375
|
+
* @public
|
|
4376
|
+
*/
|
|
4377
|
+
batchEvaluations: BatchEvaluationSummary[] | undefined;
|
|
4378
|
+
/**
|
|
4379
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
4380
|
+
* @public
|
|
4381
|
+
*/
|
|
4382
|
+
nextToken?: string | undefined;
|
|
4383
|
+
}
|
|
4384
|
+
/**
|
|
4385
|
+
* @public
|
|
4386
|
+
*/
|
|
4387
|
+
export interface ListRecommendationsRequest {
|
|
4388
|
+
/**
|
|
4389
|
+
* <p>The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the <code>nextToken</code> field when making another request to return the next batch of results.</p>
|
|
4390
|
+
* @public
|
|
4391
|
+
*/
|
|
4392
|
+
maxResults?: number | undefined;
|
|
4393
|
+
/**
|
|
4394
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, enter the token returned in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
4395
|
+
* @public
|
|
4396
|
+
*/
|
|
4397
|
+
nextToken?: string | undefined;
|
|
4398
|
+
/**
|
|
4399
|
+
* <p>Optional filter to return only recommendations with the specified status.</p>
|
|
4400
|
+
* @public
|
|
4401
|
+
*/
|
|
4402
|
+
statusFilter?: RecommendationStatus | undefined;
|
|
4403
|
+
}
|
|
4404
|
+
/**
|
|
4405
|
+
* <p>Summary information about a recommendation.</p>
|
|
4406
|
+
* @public
|
|
4407
|
+
*/
|
|
4408
|
+
export interface RecommendationSummary {
|
|
4409
|
+
/**
|
|
4410
|
+
* <p>The unique identifier of the recommendation.</p>
|
|
4411
|
+
* @public
|
|
4412
|
+
*/
|
|
4413
|
+
recommendationId: string | undefined;
|
|
4414
|
+
/**
|
|
4415
|
+
* <p>The Amazon Resource Name (ARN) of the recommendation.</p>
|
|
4416
|
+
* @public
|
|
4417
|
+
*/
|
|
4418
|
+
recommendationArn: string | undefined;
|
|
4419
|
+
/**
|
|
4420
|
+
* <p>The name of the recommendation.</p>
|
|
4421
|
+
* @public
|
|
4422
|
+
*/
|
|
4423
|
+
name: string | undefined;
|
|
4424
|
+
/**
|
|
4425
|
+
* <p>The description of the recommendation.</p>
|
|
4426
|
+
* @public
|
|
4427
|
+
*/
|
|
4428
|
+
description?: string | undefined;
|
|
4429
|
+
/**
|
|
4430
|
+
* <p>The type of recommendation.</p>
|
|
4431
|
+
* @public
|
|
4432
|
+
*/
|
|
4433
|
+
type: RecommendationType | undefined;
|
|
4434
|
+
/**
|
|
4435
|
+
* <p>The current status of the recommendation.</p>
|
|
4436
|
+
* @public
|
|
4437
|
+
*/
|
|
4438
|
+
status: RecommendationStatus | undefined;
|
|
4439
|
+
/**
|
|
4440
|
+
* <p>The timestamp when the recommendation was created.</p>
|
|
4441
|
+
* @public
|
|
4442
|
+
*/
|
|
4443
|
+
createdAt: Date | undefined;
|
|
4444
|
+
/**
|
|
4445
|
+
* <p>The timestamp when the recommendation was last updated.</p>
|
|
4446
|
+
* @public
|
|
4447
|
+
*/
|
|
4448
|
+
updatedAt: Date | undefined;
|
|
4449
|
+
}
|
|
4450
|
+
/**
|
|
4451
|
+
* @public
|
|
4452
|
+
*/
|
|
4453
|
+
export interface ListRecommendationsResponse {
|
|
4454
|
+
/**
|
|
4455
|
+
* <p>The list of recommendation summaries.</p>
|
|
4456
|
+
* @public
|
|
4457
|
+
*/
|
|
4458
|
+
recommendationSummaries: RecommendationSummary[] | undefined;
|
|
4459
|
+
/**
|
|
4460
|
+
* <p>If the total number of results is greater than the <code>maxResults</code> value provided in the request, use this token when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
4461
|
+
* @public
|
|
4462
|
+
*/
|
|
4463
|
+
nextToken?: string | undefined;
|
|
4464
|
+
}
|
|
4465
|
+
/**
|
|
4466
|
+
* <p>The input for a ground truth conversation turn.</p>
|
|
4467
|
+
* @public
|
|
4468
|
+
*/
|
|
4469
|
+
export type GroundTruthTurnInput = GroundTruthTurnInput.PromptMember | GroundTruthTurnInput.$UnknownMember;
|
|
4470
|
+
/**
|
|
4471
|
+
* @public
|
|
4472
|
+
*/
|
|
4473
|
+
export declare namespace GroundTruthTurnInput {
|
|
4474
|
+
/**
|
|
4475
|
+
* <p>The text prompt for this conversation turn.</p>
|
|
4476
|
+
* @public
|
|
4477
|
+
*/
|
|
4478
|
+
interface PromptMember {
|
|
4479
|
+
prompt: string;
|
|
4480
|
+
$unknown?: never;
|
|
4481
|
+
}
|
|
4482
|
+
/**
|
|
4483
|
+
* @public
|
|
4484
|
+
*/
|
|
4485
|
+
interface $UnknownMember {
|
|
4486
|
+
prompt?: never;
|
|
2585
4487
|
$unknown: [string, any];
|
|
2586
4488
|
}
|
|
2587
4489
|
/**
|
|
@@ -2589,127 +4491,413 @@ export declare namespace EvaluationTarget {
|
|
|
2589
4491
|
*
|
|
2590
4492
|
*/
|
|
2591
4493
|
interface Visitor<T> {
|
|
2592
|
-
|
|
2593
|
-
traceIds: (value: string[]) => T;
|
|
4494
|
+
prompt: (value: string) => T;
|
|
2594
4495
|
_: (name: string, value: any) => T;
|
|
2595
4496
|
}
|
|
2596
4497
|
}
|
|
2597
4498
|
/**
|
|
4499
|
+
* <p>Ground truth data for a single conversation turn.</p>
|
|
2598
4500
|
* @public
|
|
2599
4501
|
*/
|
|
2600
|
-
export interface
|
|
4502
|
+
export interface GroundTruthTurn {
|
|
2601
4503
|
/**
|
|
2602
|
-
* <p>
|
|
4504
|
+
* <p>The input for this conversation turn.</p>
|
|
2603
4505
|
* @public
|
|
2604
4506
|
*/
|
|
2605
|
-
|
|
4507
|
+
input?: GroundTruthTurnInput | undefined;
|
|
2606
4508
|
/**
|
|
2607
|
-
* <p>
|
|
4509
|
+
* <p>The expected response for this conversation turn.</p>
|
|
2608
4510
|
* @public
|
|
2609
4511
|
*/
|
|
2610
|
-
|
|
4512
|
+
expectedResponse?: EvaluationContent | undefined;
|
|
4513
|
+
}
|
|
4514
|
+
/**
|
|
4515
|
+
* <p>Inline ground truth data containing assertions, expected trajectories, and per-turn expected responses.</p>
|
|
4516
|
+
* @public
|
|
4517
|
+
*/
|
|
4518
|
+
export interface InlineGroundTruth {
|
|
2611
4519
|
/**
|
|
2612
|
-
*
|
|
4520
|
+
* assertions for evaluation, reuses common model EvaluationContentList
|
|
2613
4521
|
* @public
|
|
2614
4522
|
*/
|
|
2615
|
-
|
|
4523
|
+
assertions?: EvaluationContent[] | undefined;
|
|
2616
4524
|
/**
|
|
2617
|
-
*
|
|
4525
|
+
* expectedTrajectory for evaluation, reuses common model EvaluationExpectedTrajectory
|
|
2618
4526
|
* @public
|
|
2619
4527
|
*/
|
|
2620
|
-
|
|
4528
|
+
expectedTrajectory?: EvaluationExpectedTrajectory | undefined;
|
|
4529
|
+
/**
|
|
4530
|
+
* <p>A list of per-turn ground truth data, each containing an input prompt and expected response.</p>
|
|
4531
|
+
* @public
|
|
4532
|
+
*/
|
|
4533
|
+
turns?: GroundTruthTurn[] | undefined;
|
|
2621
4534
|
}
|
|
2622
4535
|
/**
|
|
2623
|
-
*
|
|
4536
|
+
* Where to pull ground truth from
|
|
2624
4537
|
* @public
|
|
2625
4538
|
*/
|
|
2626
|
-
export
|
|
4539
|
+
export type GroundTruthSource = GroundTruthSource.InlineMember | GroundTruthSource.$UnknownMember;
|
|
4540
|
+
/**
|
|
4541
|
+
* @public
|
|
4542
|
+
*/
|
|
4543
|
+
export declare namespace GroundTruthSource {
|
|
2627
4544
|
/**
|
|
2628
|
-
*
|
|
4545
|
+
* Provide ground truth inline
|
|
2629
4546
|
* @public
|
|
2630
4547
|
*/
|
|
2631
|
-
|
|
4548
|
+
interface InlineMember {
|
|
4549
|
+
inline: InlineGroundTruth;
|
|
4550
|
+
$unknown?: never;
|
|
4551
|
+
}
|
|
2632
4552
|
/**
|
|
2633
|
-
* <p> The number of tokens generated by the evaluator model in its response. Includes tokens for the score, explanation, and any additional output produced during the evaluation process. </p>
|
|
2634
4553
|
* @public
|
|
2635
4554
|
*/
|
|
2636
|
-
|
|
4555
|
+
interface $UnknownMember {
|
|
4556
|
+
inline?: never;
|
|
4557
|
+
$unknown: [string, any];
|
|
4558
|
+
}
|
|
2637
4559
|
/**
|
|
2638
|
-
*
|
|
4560
|
+
* @deprecated unused in schema-serde mode.
|
|
4561
|
+
*
|
|
4562
|
+
*/
|
|
4563
|
+
interface Visitor<T> {
|
|
4564
|
+
inline: (value: InlineGroundTruth) => T;
|
|
4565
|
+
_: (name: string, value: any) => T;
|
|
4566
|
+
}
|
|
4567
|
+
}
|
|
4568
|
+
/**
|
|
4569
|
+
* <p>Metadata for a specific session in a batch evaluation, including ground truth data and test scenario identifiers.</p>
|
|
4570
|
+
* @public
|
|
4571
|
+
*/
|
|
4572
|
+
export interface SessionMetadataShape {
|
|
4573
|
+
/**
|
|
4574
|
+
* <p>The unique identifier of the session this metadata applies to.</p>
|
|
2639
4575
|
* @public
|
|
2640
4576
|
*/
|
|
2641
|
-
|
|
4577
|
+
sessionId: string | undefined;
|
|
4578
|
+
/**
|
|
4579
|
+
* <p>An optional test scenario identifier for categorizing and tracking evaluation results.</p>
|
|
4580
|
+
* @public
|
|
4581
|
+
*/
|
|
4582
|
+
testScenarioId?: string | undefined;
|
|
4583
|
+
/**
|
|
4584
|
+
* <p>The ground truth data for this session, including expected responses and assertions.</p>
|
|
4585
|
+
* @public
|
|
4586
|
+
*/
|
|
4587
|
+
groundTruth?: GroundTruthSource | undefined;
|
|
4588
|
+
/**
|
|
4589
|
+
* <p>Additional key-value metadata associated with this session.</p>
|
|
4590
|
+
* @public
|
|
4591
|
+
*/
|
|
4592
|
+
metadata?: Record<string, string> | undefined;
|
|
2642
4593
|
}
|
|
2643
4594
|
/**
|
|
2644
|
-
* <p>
|
|
4595
|
+
* <p>Metadata for the evaluation, including session-specific ground truth data.</p>
|
|
2645
4596
|
* @public
|
|
2646
4597
|
*/
|
|
2647
|
-
export
|
|
4598
|
+
export type EvaluationMetadata = EvaluationMetadata.SessionMetadataMember | EvaluationMetadata.$UnknownMember;
|
|
4599
|
+
/**
|
|
4600
|
+
* @public
|
|
4601
|
+
*/
|
|
4602
|
+
export declare namespace EvaluationMetadata {
|
|
2648
4603
|
/**
|
|
2649
|
-
* <p>
|
|
4604
|
+
* <p>A list of session metadata entries containing ground truth data and test scenario identifiers for specific sessions.</p>
|
|
2650
4605
|
* @public
|
|
2651
4606
|
*/
|
|
2652
|
-
|
|
4607
|
+
interface SessionMetadataMember {
|
|
4608
|
+
sessionMetadata: SessionMetadataShape[];
|
|
4609
|
+
$unknown?: never;
|
|
4610
|
+
}
|
|
2653
4611
|
/**
|
|
2654
|
-
* <p> The unique identifier of the evaluator that produced this result. This matches the <code>evaluatorId</code> provided in the evaluation request and can be used to identify which evaluator generated specific results. </p>
|
|
2655
4612
|
* @public
|
|
2656
4613
|
*/
|
|
2657
|
-
|
|
4614
|
+
interface $UnknownMember {
|
|
4615
|
+
sessionMetadata?: never;
|
|
4616
|
+
$unknown: [string, any];
|
|
4617
|
+
}
|
|
2658
4618
|
/**
|
|
2659
|
-
*
|
|
4619
|
+
* @deprecated unused in schema-serde mode.
|
|
4620
|
+
*
|
|
4621
|
+
*/
|
|
4622
|
+
interface Visitor<T> {
|
|
4623
|
+
sessionMetadata: (value: SessionMetadataShape[]) => T;
|
|
4624
|
+
_: (name: string, value: any) => T;
|
|
4625
|
+
}
|
|
4626
|
+
}
|
|
4627
|
+
/**
|
|
4628
|
+
* @public
|
|
4629
|
+
*/
|
|
4630
|
+
export interface StartBatchEvaluationRequest {
|
|
4631
|
+
/**
|
|
4632
|
+
* <p>The name of the batch evaluation. Must be unique within your account.</p>
|
|
2660
4633
|
* @public
|
|
2661
4634
|
*/
|
|
2662
|
-
|
|
4635
|
+
batchEvaluationName: string | undefined;
|
|
2663
4636
|
/**
|
|
2664
|
-
* <p>
|
|
4637
|
+
* <p>The list of evaluators to apply during the batch evaluation. Can include both built-in evaluators and custom evaluators. Maximum of 10 evaluators.</p>
|
|
2665
4638
|
* @public
|
|
2666
4639
|
*/
|
|
2667
|
-
|
|
4640
|
+
evaluators?: Evaluator[] | undefined;
|
|
2668
4641
|
/**
|
|
2669
|
-
* <p>
|
|
4642
|
+
* <p>The data source configuration that specifies where to pull agent session traces from for evaluation.</p>
|
|
2670
4643
|
* @public
|
|
2671
4644
|
*/
|
|
2672
|
-
|
|
4645
|
+
dataSourceConfig: DataSourceConfig | undefined;
|
|
2673
4646
|
/**
|
|
2674
|
-
* <p>
|
|
4647
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.</p>
|
|
2675
4648
|
* @public
|
|
2676
4649
|
*/
|
|
2677
|
-
|
|
4650
|
+
clientToken?: string | undefined;
|
|
2678
4651
|
/**
|
|
2679
|
-
* <p>
|
|
4652
|
+
* <p>Optional metadata for the evaluation, including session-specific ground truth data and test scenario identifiers.</p>
|
|
2680
4653
|
* @public
|
|
2681
4654
|
*/
|
|
2682
|
-
|
|
4655
|
+
evaluationMetadata?: EvaluationMetadata | undefined;
|
|
2683
4656
|
/**
|
|
2684
|
-
* <p>
|
|
4657
|
+
* <p>The description of the batch evaluation.</p>
|
|
2685
4658
|
* @public
|
|
2686
4659
|
*/
|
|
2687
|
-
|
|
4660
|
+
description?: string | undefined;
|
|
4661
|
+
}
|
|
4662
|
+
/**
|
|
4663
|
+
* @public
|
|
4664
|
+
*/
|
|
4665
|
+
export interface StartBatchEvaluationResponse {
|
|
2688
4666
|
/**
|
|
2689
|
-
* <p>
|
|
4667
|
+
* <p>The unique identifier of the created batch evaluation.</p>
|
|
2690
4668
|
* @public
|
|
2691
4669
|
*/
|
|
2692
|
-
|
|
4670
|
+
batchEvaluationId: string | undefined;
|
|
2693
4671
|
/**
|
|
2694
|
-
* <p>
|
|
4672
|
+
* <p>The Amazon Resource Name (ARN) of the created batch evaluation.</p>
|
|
2695
4673
|
* @public
|
|
2696
4674
|
*/
|
|
2697
|
-
|
|
4675
|
+
batchEvaluationArn: string | undefined;
|
|
2698
4676
|
/**
|
|
2699
|
-
* <p>
|
|
4677
|
+
* <p>The name of the batch evaluation.</p>
|
|
2700
4678
|
* @public
|
|
2701
4679
|
*/
|
|
2702
|
-
|
|
4680
|
+
batchEvaluationName: string | undefined;
|
|
4681
|
+
/**
|
|
4682
|
+
* <p>The list of evaluators applied during the batch evaluation.</p>
|
|
4683
|
+
* @public
|
|
4684
|
+
*/
|
|
4685
|
+
evaluators?: Evaluator[] | undefined;
|
|
4686
|
+
/**
|
|
4687
|
+
* <p>The status of the batch evaluation.</p>
|
|
4688
|
+
* @public
|
|
4689
|
+
*/
|
|
4690
|
+
status: BatchEvaluationStatus | undefined;
|
|
4691
|
+
/**
|
|
4692
|
+
* <p>The timestamp when the batch evaluation was created.</p>
|
|
4693
|
+
* @public
|
|
4694
|
+
*/
|
|
4695
|
+
createdAt: Date | undefined;
|
|
4696
|
+
/**
|
|
4697
|
+
* <p>The output configuration specifying where evaluation results are written.</p>
|
|
4698
|
+
* @public
|
|
4699
|
+
*/
|
|
4700
|
+
outputConfig?: OutputConfig | undefined;
|
|
4701
|
+
/**
|
|
4702
|
+
* <p>The description of the batch evaluation.</p>
|
|
4703
|
+
* @public
|
|
4704
|
+
*/
|
|
4705
|
+
description?: string | undefined;
|
|
2703
4706
|
}
|
|
2704
4707
|
/**
|
|
2705
4708
|
* @public
|
|
2706
4709
|
*/
|
|
2707
|
-
export interface
|
|
4710
|
+
export interface StartRecommendationRequest {
|
|
4711
|
+
/**
|
|
4712
|
+
* <p>The name of the recommendation. Must be unique within your account.</p>
|
|
4713
|
+
* @public
|
|
4714
|
+
*/
|
|
4715
|
+
name: string | undefined;
|
|
4716
|
+
/**
|
|
4717
|
+
* <p>The description of the recommendation.</p>
|
|
4718
|
+
* @public
|
|
4719
|
+
*/
|
|
4720
|
+
description?: string | undefined;
|
|
4721
|
+
/**
|
|
4722
|
+
* <p>The type of recommendation to generate. Valid values are <code>SYSTEM_PROMPT_RECOMMENDATION</code> for system prompt optimization or <code>TOOL_DESCRIPTION_RECOMMENDATION</code> for tool description optimization.</p>
|
|
4723
|
+
* @public
|
|
4724
|
+
*/
|
|
4725
|
+
type: RecommendationType | undefined;
|
|
4726
|
+
/**
|
|
4727
|
+
* <p>The configuration for the recommendation, including the input to optimize, agent traces to analyze, and evaluation settings.</p>
|
|
4728
|
+
* @public
|
|
4729
|
+
*/
|
|
4730
|
+
recommendationConfig: RecommendationConfig | undefined;
|
|
4731
|
+
/**
|
|
4732
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.</p>
|
|
4733
|
+
* @public
|
|
4734
|
+
*/
|
|
4735
|
+
clientToken?: string | undefined;
|
|
4736
|
+
}
|
|
4737
|
+
/**
|
|
4738
|
+
* @public
|
|
4739
|
+
*/
|
|
4740
|
+
export interface StartRecommendationResponse {
|
|
4741
|
+
/**
|
|
4742
|
+
* <p>The unique identifier of the created recommendation.</p>
|
|
4743
|
+
* @public
|
|
4744
|
+
*/
|
|
4745
|
+
recommendationId: string | undefined;
|
|
4746
|
+
/**
|
|
4747
|
+
* <p>The Amazon Resource Name (ARN) of the created recommendation.</p>
|
|
4748
|
+
* @public
|
|
4749
|
+
*/
|
|
4750
|
+
recommendationArn: string | undefined;
|
|
4751
|
+
/**
|
|
4752
|
+
* <p>The name of the recommendation.</p>
|
|
4753
|
+
* @public
|
|
4754
|
+
*/
|
|
4755
|
+
name: string | undefined;
|
|
4756
|
+
/**
|
|
4757
|
+
* <p>The description of the recommendation.</p>
|
|
4758
|
+
* @public
|
|
4759
|
+
*/
|
|
4760
|
+
description?: string | undefined;
|
|
4761
|
+
/**
|
|
4762
|
+
* <p>The type of recommendation.</p>
|
|
4763
|
+
* @public
|
|
4764
|
+
*/
|
|
4765
|
+
type: RecommendationType | undefined;
|
|
4766
|
+
/**
|
|
4767
|
+
* <p>The configuration for the recommendation.</p>
|
|
4768
|
+
* @public
|
|
4769
|
+
*/
|
|
4770
|
+
recommendationConfig: RecommendationConfig | undefined;
|
|
4771
|
+
/**
|
|
4772
|
+
* <p>The status of the recommendation.</p>
|
|
4773
|
+
* @public
|
|
4774
|
+
*/
|
|
4775
|
+
status: RecommendationStatus | undefined;
|
|
4776
|
+
/**
|
|
4777
|
+
* <p>The timestamp when the recommendation was created.</p>
|
|
4778
|
+
* @public
|
|
4779
|
+
*/
|
|
4780
|
+
createdAt: Date | undefined;
|
|
4781
|
+
/**
|
|
4782
|
+
* <p>The timestamp when the recommendation was last updated.</p>
|
|
4783
|
+
* @public
|
|
4784
|
+
*/
|
|
4785
|
+
updatedAt: Date | undefined;
|
|
4786
|
+
}
|
|
4787
|
+
/**
|
|
4788
|
+
* @public
|
|
4789
|
+
*/
|
|
4790
|
+
export interface StopBatchEvaluationRequest {
|
|
4791
|
+
/**
|
|
4792
|
+
* <p>The unique identifier of the batch evaluation to stop.</p>
|
|
4793
|
+
* @public
|
|
4794
|
+
*/
|
|
4795
|
+
batchEvaluationId: string | undefined;
|
|
4796
|
+
}
|
|
4797
|
+
/**
|
|
4798
|
+
* @public
|
|
4799
|
+
*/
|
|
4800
|
+
export interface StopBatchEvaluationResponse {
|
|
4801
|
+
/**
|
|
4802
|
+
* <p>The unique identifier of the stopped batch evaluation.</p>
|
|
4803
|
+
* @public
|
|
4804
|
+
*/
|
|
4805
|
+
batchEvaluationId: string | undefined;
|
|
4806
|
+
/**
|
|
4807
|
+
* <p>The Amazon Resource Name (ARN) of the stopped batch evaluation.</p>
|
|
4808
|
+
* @public
|
|
4809
|
+
*/
|
|
4810
|
+
batchEvaluationArn: string | undefined;
|
|
4811
|
+
/**
|
|
4812
|
+
* <p>The status of the batch evaluation after the stop request.</p>
|
|
4813
|
+
* @public
|
|
4814
|
+
*/
|
|
4815
|
+
status: BatchEvaluationStatus | undefined;
|
|
4816
|
+
/**
|
|
4817
|
+
* <p>The description of the batch evaluation.</p>
|
|
4818
|
+
* @public
|
|
4819
|
+
*/
|
|
4820
|
+
description?: string | undefined;
|
|
4821
|
+
}
|
|
4822
|
+
/**
|
|
4823
|
+
* @public
|
|
4824
|
+
*/
|
|
4825
|
+
export interface UpdateABTestRequest {
|
|
4826
|
+
/**
|
|
4827
|
+
* <p>The unique identifier of the A/B test to update.</p>
|
|
4828
|
+
* @public
|
|
4829
|
+
*/
|
|
4830
|
+
abTestId: string | undefined;
|
|
4831
|
+
/**
|
|
4832
|
+
* <p>A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, the service ignores the request, but does not return an error.</p>
|
|
4833
|
+
* @public
|
|
4834
|
+
*/
|
|
4835
|
+
clientToken?: string | undefined;
|
|
4836
|
+
/**
|
|
4837
|
+
* <p>The updated name of the A/B test.</p>
|
|
4838
|
+
* @public
|
|
4839
|
+
*/
|
|
4840
|
+
name?: string | undefined;
|
|
4841
|
+
/**
|
|
4842
|
+
* <p>The updated description of the A/B test.</p>
|
|
4843
|
+
* @public
|
|
4844
|
+
*/
|
|
4845
|
+
description?: string | undefined;
|
|
4846
|
+
/**
|
|
4847
|
+
* <p>The updated list of variants.</p>
|
|
4848
|
+
* @public
|
|
4849
|
+
*/
|
|
4850
|
+
variants?: Variant[] | undefined;
|
|
4851
|
+
/**
|
|
4852
|
+
* <p>The updated gateway filter.</p>
|
|
4853
|
+
* @public
|
|
4854
|
+
*/
|
|
4855
|
+
gatewayFilter?: GatewayFilter | undefined;
|
|
4856
|
+
/**
|
|
4857
|
+
* <p>The updated evaluation configuration.</p>
|
|
4858
|
+
* @public
|
|
4859
|
+
*/
|
|
4860
|
+
evaluationConfig?: ABTestEvaluationConfig | undefined;
|
|
4861
|
+
/**
|
|
4862
|
+
* <p>The updated IAM role ARN.</p>
|
|
4863
|
+
* @public
|
|
4864
|
+
*/
|
|
4865
|
+
roleArn?: string | undefined;
|
|
4866
|
+
/**
|
|
4867
|
+
* <p>The updated execution status to enable or disable the A/B test.</p>
|
|
4868
|
+
* @public
|
|
4869
|
+
*/
|
|
4870
|
+
executionStatus?: ABTestExecutionStatus | undefined;
|
|
4871
|
+
}
|
|
4872
|
+
/**
|
|
4873
|
+
* @public
|
|
4874
|
+
*/
|
|
4875
|
+
export interface UpdateABTestResponse {
|
|
4876
|
+
/**
|
|
4877
|
+
* <p>The unique identifier of the updated A/B test.</p>
|
|
4878
|
+
* @public
|
|
4879
|
+
*/
|
|
4880
|
+
abTestId: string | undefined;
|
|
4881
|
+
/**
|
|
4882
|
+
* <p>The Amazon Resource Name (ARN) of the updated A/B test.</p>
|
|
4883
|
+
* @public
|
|
4884
|
+
*/
|
|
4885
|
+
abTestArn: string | undefined;
|
|
4886
|
+
/**
|
|
4887
|
+
* <p>The status of the A/B test.</p>
|
|
4888
|
+
* @public
|
|
4889
|
+
*/
|
|
4890
|
+
status: ABTestStatus | undefined;
|
|
4891
|
+
/**
|
|
4892
|
+
* <p>The execution status of the A/B test.</p>
|
|
4893
|
+
* @public
|
|
4894
|
+
*/
|
|
4895
|
+
executionStatus: ABTestExecutionStatus | undefined;
|
|
2708
4896
|
/**
|
|
2709
|
-
* <p>
|
|
4897
|
+
* <p>The timestamp when the A/B test was updated.</p>
|
|
2710
4898
|
* @public
|
|
2711
4899
|
*/
|
|
2712
|
-
|
|
4900
|
+
updatedAt: Date | undefined;
|
|
2713
4901
|
}
|
|
2714
4902
|
/**
|
|
2715
4903
|
* @public
|
|
@@ -2785,6 +4973,16 @@ export interface GetResourceOauth2TokenRequest {
|
|
|
2785
4973
|
* @public
|
|
2786
4974
|
*/
|
|
2787
4975
|
customState?: string | undefined;
|
|
4976
|
+
/**
|
|
4977
|
+
* <p>The resources to include in the token request. These are used to specify the target resources for which the OAuth2 token is being requested.</p>
|
|
4978
|
+
* @public
|
|
4979
|
+
*/
|
|
4980
|
+
resources?: string[] | undefined;
|
|
4981
|
+
/**
|
|
4982
|
+
* <p>The audiences to include in the token request. These are used to specify the intended recipients of the OAuth2 token.</p>
|
|
4983
|
+
* @public
|
|
4984
|
+
*/
|
|
4985
|
+
audiences?: string[] | undefined;
|
|
2788
4986
|
}
|
|
2789
4987
|
/**
|
|
2790
4988
|
* @public
|
|
@@ -3906,7 +6104,7 @@ export interface HarnessAgentCoreGatewayConfig {
|
|
|
3906
6104
|
*/
|
|
3907
6105
|
gatewayArn: string | undefined;
|
|
3908
6106
|
/**
|
|
3909
|
-
* <p>How
|
|
6107
|
+
* <p>How harness authenticates to this Gateway. Defaults to AWS_IAM (SigV4) if omitted.</p>
|
|
3910
6108
|
* @public
|
|
3911
6109
|
*/
|
|
3912
6110
|
outboundAuth?: HarnessGatewayOutboundAuth | undefined;
|
|
@@ -3938,7 +6136,7 @@ export interface HarnessRemoteMcpConfig {
|
|
|
3938
6136
|
*/
|
|
3939
6137
|
url: string | undefined;
|
|
3940
6138
|
/**
|
|
3941
|
-
*
|
|
6139
|
+
* <p>Custom headers to include when connecting to the remote MCP server.</p>
|
|
3942
6140
|
* @public
|
|
3943
6141
|
*/
|
|
3944
6142
|
headers?: Record<string, string> | undefined;
|
|
@@ -4750,6 +6948,81 @@ export declare namespace MemoryContent {
|
|
|
4750
6948
|
_: (name: string, value: any) => T;
|
|
4751
6949
|
}
|
|
4752
6950
|
}
|
|
6951
|
+
/**
|
|
6952
|
+
* <p>The value of a memory record metadata entry.</p>
|
|
6953
|
+
* @public
|
|
6954
|
+
*/
|
|
6955
|
+
export type MemoryRecordMetadataValue = MemoryRecordMetadataValue.DateTimeValueMember | MemoryRecordMetadataValue.NumberValueMember | MemoryRecordMetadataValue.StringListValueMember | MemoryRecordMetadataValue.StringValueMember | MemoryRecordMetadataValue.$UnknownMember;
|
|
6956
|
+
/**
|
|
6957
|
+
* @public
|
|
6958
|
+
*/
|
|
6959
|
+
export declare namespace MemoryRecordMetadataValue {
|
|
6960
|
+
/**
|
|
6961
|
+
* <p>A string value.</p>
|
|
6962
|
+
* @public
|
|
6963
|
+
*/
|
|
6964
|
+
interface StringValueMember {
|
|
6965
|
+
stringValue: string;
|
|
6966
|
+
stringListValue?: never;
|
|
6967
|
+
numberValue?: never;
|
|
6968
|
+
dateTimeValue?: never;
|
|
6969
|
+
$unknown?: never;
|
|
6970
|
+
}
|
|
6971
|
+
/**
|
|
6972
|
+
* <p>A list of string values.</p>
|
|
6973
|
+
* @public
|
|
6974
|
+
*/
|
|
6975
|
+
interface StringListValueMember {
|
|
6976
|
+
stringValue?: never;
|
|
6977
|
+
stringListValue: string[];
|
|
6978
|
+
numberValue?: never;
|
|
6979
|
+
dateTimeValue?: never;
|
|
6980
|
+
$unknown?: never;
|
|
6981
|
+
}
|
|
6982
|
+
/**
|
|
6983
|
+
* <p>A numeric value.</p>
|
|
6984
|
+
* @public
|
|
6985
|
+
*/
|
|
6986
|
+
interface NumberValueMember {
|
|
6987
|
+
stringValue?: never;
|
|
6988
|
+
stringListValue?: never;
|
|
6989
|
+
numberValue: number;
|
|
6990
|
+
dateTimeValue?: never;
|
|
6991
|
+
$unknown?: never;
|
|
6992
|
+
}
|
|
6993
|
+
/**
|
|
6994
|
+
* <p>A timestamp value in ISO 8601 UTC format.</p>
|
|
6995
|
+
* @public
|
|
6996
|
+
*/
|
|
6997
|
+
interface DateTimeValueMember {
|
|
6998
|
+
stringValue?: never;
|
|
6999
|
+
stringListValue?: never;
|
|
7000
|
+
numberValue?: never;
|
|
7001
|
+
dateTimeValue: Date;
|
|
7002
|
+
$unknown?: never;
|
|
7003
|
+
}
|
|
7004
|
+
/**
|
|
7005
|
+
* @public
|
|
7006
|
+
*/
|
|
7007
|
+
interface $UnknownMember {
|
|
7008
|
+
stringValue?: never;
|
|
7009
|
+
stringListValue?: never;
|
|
7010
|
+
numberValue?: never;
|
|
7011
|
+
dateTimeValue?: never;
|
|
7012
|
+
$unknown: [string, any];
|
|
7013
|
+
}
|
|
7014
|
+
/**
|
|
7015
|
+
* @deprecated unused in schema-serde mode.
|
|
7016
|
+
*
|
|
7017
|
+
*/
|
|
7018
|
+
interface Visitor<T> {
|
|
7019
|
+
stringValue: (value: string) => T;
|
|
7020
|
+
stringListValue: (value: string[]) => T;
|
|
7021
|
+
numberValue: (value: number) => T;
|
|
7022
|
+
dateTimeValue: (value: Date) => T;
|
|
7023
|
+
_: (name: string, value: any) => T;
|
|
7024
|
+
}
|
|
7025
|
+
}
|
|
4753
7026
|
/**
|
|
4754
7027
|
* <p>Input structure to create a new memory record.</p>
|
|
4755
7028
|
* @public
|
|
@@ -4780,6 +7053,11 @@ export interface MemoryRecordCreateInput {
|
|
|
4780
7053
|
* @public
|
|
4781
7054
|
*/
|
|
4782
7055
|
memoryStrategyId?: string | undefined;
|
|
7056
|
+
/**
|
|
7057
|
+
* <p>Metadata key-value pairs to be stored with the memory record.</p>
|
|
7058
|
+
* @public
|
|
7059
|
+
*/
|
|
7060
|
+
metadata?: Record<string, MemoryRecordMetadataValue> | undefined;
|
|
4783
7061
|
}
|
|
4784
7062
|
/**
|
|
4785
7063
|
* @public
|
|
@@ -4918,6 +7196,11 @@ export interface MemoryRecordUpdateInput {
|
|
|
4918
7196
|
* @public
|
|
4919
7197
|
*/
|
|
4920
7198
|
memoryStrategyId?: string | undefined;
|
|
7199
|
+
/**
|
|
7200
|
+
* <p>Metadata key-value pairs to be stored with the memory record.</p>
|
|
7201
|
+
* @public
|
|
7202
|
+
*/
|
|
7203
|
+
metadata?: Record<string, MemoryRecordMetadataValue> | undefined;
|
|
4921
7204
|
}
|
|
4922
7205
|
/**
|
|
4923
7206
|
* @public
|
|
@@ -5337,7 +7620,7 @@ export interface MemoryRecord {
|
|
|
5337
7620
|
* <p>A map of metadata key-value pairs associated with a memory record.</p>
|
|
5338
7621
|
* @public
|
|
5339
7622
|
*/
|
|
5340
|
-
metadata?: Record<string,
|
|
7623
|
+
metadata?: Record<string, MemoryRecordMetadataValue> | undefined;
|
|
5341
7624
|
}
|
|
5342
7625
|
/**
|
|
5343
7626
|
* @public
|
|
@@ -5714,6 +7997,93 @@ export interface ListMemoryExtractionJobsOutput {
|
|
|
5714
7997
|
*/
|
|
5715
7998
|
nextToken?: string | undefined;
|
|
5716
7999
|
}
|
|
8000
|
+
/**
|
|
8001
|
+
* <p>The left-hand side of a memory record metadata filter expression.</p>
|
|
8002
|
+
* @public
|
|
8003
|
+
*/
|
|
8004
|
+
export type MemoryRecordLeftExpression = MemoryRecordLeftExpression.MetadataKeyMember | MemoryRecordLeftExpression.$UnknownMember;
|
|
8005
|
+
/**
|
|
8006
|
+
* @public
|
|
8007
|
+
*/
|
|
8008
|
+
export declare namespace MemoryRecordLeftExpression {
|
|
8009
|
+
/**
|
|
8010
|
+
* <p>The metadata key to filter on.</p>
|
|
8011
|
+
* @public
|
|
8012
|
+
*/
|
|
8013
|
+
interface MetadataKeyMember {
|
|
8014
|
+
metadataKey: string;
|
|
8015
|
+
$unknown?: never;
|
|
8016
|
+
}
|
|
8017
|
+
/**
|
|
8018
|
+
* @public
|
|
8019
|
+
*/
|
|
8020
|
+
interface $UnknownMember {
|
|
8021
|
+
metadataKey?: never;
|
|
8022
|
+
$unknown: [string, any];
|
|
8023
|
+
}
|
|
8024
|
+
/**
|
|
8025
|
+
* @deprecated unused in schema-serde mode.
|
|
8026
|
+
*
|
|
8027
|
+
*/
|
|
8028
|
+
interface Visitor<T> {
|
|
8029
|
+
metadataKey: (value: string) => T;
|
|
8030
|
+
_: (name: string, value: any) => T;
|
|
8031
|
+
}
|
|
8032
|
+
}
|
|
8033
|
+
/**
|
|
8034
|
+
* <p>The right-hand side of a memory record metadata filter expression.</p>
|
|
8035
|
+
* @public
|
|
8036
|
+
*/
|
|
8037
|
+
export type MemoryRecordRightExpression = MemoryRecordRightExpression.MetadataValueMember | MemoryRecordRightExpression.$UnknownMember;
|
|
8038
|
+
/**
|
|
8039
|
+
* @public
|
|
8040
|
+
*/
|
|
8041
|
+
export declare namespace MemoryRecordRightExpression {
|
|
8042
|
+
/**
|
|
8043
|
+
* <p>The metadata value to compare against.</p>
|
|
8044
|
+
* @public
|
|
8045
|
+
*/
|
|
8046
|
+
interface MetadataValueMember {
|
|
8047
|
+
metadataValue: MemoryRecordMetadataValue;
|
|
8048
|
+
$unknown?: never;
|
|
8049
|
+
}
|
|
8050
|
+
/**
|
|
8051
|
+
* @public
|
|
8052
|
+
*/
|
|
8053
|
+
interface $UnknownMember {
|
|
8054
|
+
metadataValue?: never;
|
|
8055
|
+
$unknown: [string, any];
|
|
8056
|
+
}
|
|
8057
|
+
/**
|
|
8058
|
+
* @deprecated unused in schema-serde mode.
|
|
8059
|
+
*
|
|
8060
|
+
*/
|
|
8061
|
+
interface Visitor<T> {
|
|
8062
|
+
metadataValue: (value: MemoryRecordMetadataValue) => T;
|
|
8063
|
+
_: (name: string, value: any) => T;
|
|
8064
|
+
}
|
|
8065
|
+
}
|
|
8066
|
+
/**
|
|
8067
|
+
* <p>Filters to apply to metadata associated with a memory. Specify the metadata key and value in the <code>left</code> and <code>right</code> fields and use the <code>operator</code> field to define the relationship to match.</p>
|
|
8068
|
+
* @public
|
|
8069
|
+
*/
|
|
8070
|
+
export interface MemoryMetadataFilterExpression {
|
|
8071
|
+
/**
|
|
8072
|
+
* <p>The metadata key to evaluate.</p>
|
|
8073
|
+
* @public
|
|
8074
|
+
*/
|
|
8075
|
+
left: MemoryRecordLeftExpression | undefined;
|
|
8076
|
+
/**
|
|
8077
|
+
* <p>The relationship between the metadata key and value to match when applying the metadata filter.</p>
|
|
8078
|
+
* @public
|
|
8079
|
+
*/
|
|
8080
|
+
operator: MemoryRecordOperatorType | undefined;
|
|
8081
|
+
/**
|
|
8082
|
+
* <p>The value to compare against. Required for all operators except EXISTS and NOT_EXISTS.</p>
|
|
8083
|
+
* @public
|
|
8084
|
+
*/
|
|
8085
|
+
right?: MemoryRecordRightExpression | undefined;
|
|
8086
|
+
}
|
|
5717
8087
|
/**
|
|
5718
8088
|
* @public
|
|
5719
8089
|
*/
|
|
@@ -5748,6 +8118,11 @@ export interface ListMemoryRecordsInput {
|
|
|
5748
8118
|
* @public
|
|
5749
8119
|
*/
|
|
5750
8120
|
nextToken?: string | undefined;
|
|
8121
|
+
/**
|
|
8122
|
+
* <p>A list of metadata filter expressions to scope the returned memory records.</p>
|
|
8123
|
+
* @public
|
|
8124
|
+
*/
|
|
8125
|
+
metadataFilters?: MemoryMetadataFilterExpression[] | undefined;
|
|
5751
8126
|
}
|
|
5752
8127
|
/**
|
|
5753
8128
|
* <p>Contains summary information about a memory record.</p>
|
|
@@ -5788,7 +8163,7 @@ export interface MemoryRecordSummary {
|
|
|
5788
8163
|
* <p>A map of metadata key-value pairs associated with a memory record.</p>
|
|
5789
8164
|
* @public
|
|
5790
8165
|
*/
|
|
5791
|
-
metadata?: Record<string,
|
|
8166
|
+
metadata?: Record<string, MemoryRecordMetadataValue> | undefined;
|
|
5792
8167
|
}
|
|
5793
8168
|
/**
|
|
5794
8169
|
* @public
|
|
@@ -5882,27 +8257,6 @@ export interface ListSessionsOutput {
|
|
|
5882
8257
|
*/
|
|
5883
8258
|
nextToken?: string | undefined;
|
|
5884
8259
|
}
|
|
5885
|
-
/**
|
|
5886
|
-
* <p>Filters to apply to metadata associated with a memory. Specify the metadata key and value in the <code>left</code> and <code>right</code> fields and use the <code>operator</code> field to define the relationship to match.</p>
|
|
5887
|
-
* @public
|
|
5888
|
-
*/
|
|
5889
|
-
export interface MemoryMetadataFilterExpression {
|
|
5890
|
-
/**
|
|
5891
|
-
* <p>Left expression of the event metadata filter.</p>
|
|
5892
|
-
* @public
|
|
5893
|
-
*/
|
|
5894
|
-
left: LeftExpression | undefined;
|
|
5895
|
-
/**
|
|
5896
|
-
* <p>The relationship between the metadata key and value to match when applying the metadata filter.</p>
|
|
5897
|
-
* @public
|
|
5898
|
-
*/
|
|
5899
|
-
operator: OperatorType | undefined;
|
|
5900
|
-
/**
|
|
5901
|
-
* <p>Right expression of the <code>eventMetadata</code>filter.</p>
|
|
5902
|
-
* @public
|
|
5903
|
-
*/
|
|
5904
|
-
right?: RightExpression | undefined;
|
|
5905
|
-
}
|
|
5906
8260
|
/**
|
|
5907
8261
|
* <p>Contains search criteria for retrieving memory records.</p>
|
|
5908
8262
|
* @public
|
|
@@ -6056,148 +8410,3 @@ export interface CustomDescriptor {
|
|
|
6056
8410
|
*/
|
|
6057
8411
|
inlineContent?: string | undefined;
|
|
6058
8412
|
}
|
|
6059
|
-
/**
|
|
6060
|
-
* <p> The MCP server definition with a schema version and inline content. The <code>schemaVersion</code> identifies the version of the MCP server configuration schema.</p>
|
|
6061
|
-
* @public
|
|
6062
|
-
*/
|
|
6063
|
-
export interface ServerDefinition {
|
|
6064
|
-
/**
|
|
6065
|
-
* <p> The schema version of the MCP server configuration. The schema version identifies the format of the server definition content.</p>
|
|
6066
|
-
* @public
|
|
6067
|
-
*/
|
|
6068
|
-
schemaVersion?: string | undefined;
|
|
6069
|
-
/**
|
|
6070
|
-
* <p> The inline content of the server definition.</p>
|
|
6071
|
-
* @public
|
|
6072
|
-
*/
|
|
6073
|
-
inlineContent?: string | undefined;
|
|
6074
|
-
}
|
|
6075
|
-
/**
|
|
6076
|
-
* <p> The MCP tools definition with a protocol version and inline content. The <code>protocolVersion</code> identifies the MCP protocol version that the tools conform to. This differs from <code>schemaVersion</code> in the server definition, which identifies the server configuration schema format.</p>
|
|
6077
|
-
* @public
|
|
6078
|
-
*/
|
|
6079
|
-
export interface ToolsDefinition {
|
|
6080
|
-
/**
|
|
6081
|
-
* <p> The MCP protocol version that the tools conform to. This differs from the <code>schemaVersion</code> field in the server definition, which identifies the server configuration schema format.</p>
|
|
6082
|
-
* @public
|
|
6083
|
-
*/
|
|
6084
|
-
protocolVersion?: string | undefined;
|
|
6085
|
-
/**
|
|
6086
|
-
* <p> The inline content of the tools definition.</p>
|
|
6087
|
-
* @public
|
|
6088
|
-
*/
|
|
6089
|
-
inlineContent?: string | undefined;
|
|
6090
|
-
}
|
|
6091
|
-
/**
|
|
6092
|
-
* <p> The MCP (Model Context Protocol) descriptor configuration for a registry record. Contains the server definition and tools definition.</p>
|
|
6093
|
-
* @public
|
|
6094
|
-
*/
|
|
6095
|
-
export interface McpDescriptor {
|
|
6096
|
-
/**
|
|
6097
|
-
* <p> The MCP server definition that describes the server configuration.</p>
|
|
6098
|
-
* @public
|
|
6099
|
-
*/
|
|
6100
|
-
server: ServerDefinition | undefined;
|
|
6101
|
-
/**
|
|
6102
|
-
* <p> The MCP tools definition that describes the available tools.</p>
|
|
6103
|
-
* @public
|
|
6104
|
-
*/
|
|
6105
|
-
tools: ToolsDefinition | undefined;
|
|
6106
|
-
}
|
|
6107
|
-
/**
|
|
6108
|
-
* <p> Contains the descriptor configuration for a registry record. Only the field that matches the record's <code>descriptorType</code> is populated.</p>
|
|
6109
|
-
* @public
|
|
6110
|
-
*/
|
|
6111
|
-
export interface Descriptors {
|
|
6112
|
-
/**
|
|
6113
|
-
* <p> The MCP (Model Context Protocol) descriptor configuration. Populated when the record's <code>descriptorType</code> is <code>MCP</code>.</p>
|
|
6114
|
-
* @public
|
|
6115
|
-
*/
|
|
6116
|
-
mcp?: McpDescriptor | undefined;
|
|
6117
|
-
/**
|
|
6118
|
-
* <p> The A2A (Agent-to-Agent) descriptor configuration. Populated when the record's <code>descriptorType</code> is <code>A2A</code>.</p>
|
|
6119
|
-
* @public
|
|
6120
|
-
*/
|
|
6121
|
-
a2a?: A2aDescriptor | undefined;
|
|
6122
|
-
/**
|
|
6123
|
-
* <p> The custom descriptor configuration. Populated when the record's <code>descriptorType</code> is <code>CUSTOM</code>.</p>
|
|
6124
|
-
* @public
|
|
6125
|
-
*/
|
|
6126
|
-
custom?: CustomDescriptor | undefined;
|
|
6127
|
-
/**
|
|
6128
|
-
* <p> The agent skills descriptor configuration. Populated when the record's <code>descriptorType</code> is <code>AGENT_SKILLS</code>.</p>
|
|
6129
|
-
* @public
|
|
6130
|
-
*/
|
|
6131
|
-
agentSkills?: AgentSkillsDescriptor | undefined;
|
|
6132
|
-
}
|
|
6133
|
-
/**
|
|
6134
|
-
* <p> Summary information about a registry record.</p>
|
|
6135
|
-
* @public
|
|
6136
|
-
*/
|
|
6137
|
-
export interface RegistryRecordSummary {
|
|
6138
|
-
/**
|
|
6139
|
-
* <p> The Amazon Resource Name (ARN) of the registry that this record belongs to.</p>
|
|
6140
|
-
* @public
|
|
6141
|
-
*/
|
|
6142
|
-
registryArn: string | undefined;
|
|
6143
|
-
/**
|
|
6144
|
-
* <p> The Amazon Resource Name (ARN) of the registry record.</p>
|
|
6145
|
-
* @public
|
|
6146
|
-
*/
|
|
6147
|
-
recordArn: string | undefined;
|
|
6148
|
-
/**
|
|
6149
|
-
* <p> The unique identifier of the registry record.</p>
|
|
6150
|
-
* @public
|
|
6151
|
-
*/
|
|
6152
|
-
recordId: string | undefined;
|
|
6153
|
-
/**
|
|
6154
|
-
* <p> The name of the registry record.</p>
|
|
6155
|
-
* @public
|
|
6156
|
-
*/
|
|
6157
|
-
name: string | undefined;
|
|
6158
|
-
/**
|
|
6159
|
-
* <p> A description of the registry record.</p>
|
|
6160
|
-
* @public
|
|
6161
|
-
*/
|
|
6162
|
-
description?: string | undefined;
|
|
6163
|
-
/**
|
|
6164
|
-
* <p> The type of descriptor associated with this registry record.</p>
|
|
6165
|
-
* @public
|
|
6166
|
-
*/
|
|
6167
|
-
descriptorType: DescriptorType | undefined;
|
|
6168
|
-
/**
|
|
6169
|
-
* <p> The descriptor configurations for this registry record.</p>
|
|
6170
|
-
* @public
|
|
6171
|
-
*/
|
|
6172
|
-
descriptors: Descriptors | undefined;
|
|
6173
|
-
/**
|
|
6174
|
-
* <p> The version of the registry record.</p>
|
|
6175
|
-
* @public
|
|
6176
|
-
*/
|
|
6177
|
-
version: string | undefined;
|
|
6178
|
-
/**
|
|
6179
|
-
* <p> The current status of the registry record.</p>
|
|
6180
|
-
* @public
|
|
6181
|
-
*/
|
|
6182
|
-
status: RegistryRecordStatus | undefined;
|
|
6183
|
-
/**
|
|
6184
|
-
* <p> The date and time when the registry record was created.</p>
|
|
6185
|
-
* @public
|
|
6186
|
-
*/
|
|
6187
|
-
createdAt: Date | undefined;
|
|
6188
|
-
/**
|
|
6189
|
-
* <p> The date and time when the registry record was last updated.</p>
|
|
6190
|
-
* @public
|
|
6191
|
-
*/
|
|
6192
|
-
updatedAt: Date | undefined;
|
|
6193
|
-
}
|
|
6194
|
-
/**
|
|
6195
|
-
* @public
|
|
6196
|
-
*/
|
|
6197
|
-
export interface SearchRegistryRecordsResponse {
|
|
6198
|
-
/**
|
|
6199
|
-
* <p> The list of registry records that match the search query, ordered by relevance.</p>
|
|
6200
|
-
* @public
|
|
6201
|
-
*/
|
|
6202
|
-
registryRecords: RegistryRecordSummary[] | undefined;
|
|
6203
|
-
}
|