@aws-sdk/client-bedrock-agent-runtime 3.687.0 → 3.691.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/dist-cjs/index.js +195 -0
- package/dist-es/models/models_0.js +75 -0
- package/dist-es/protocols/Aws_restJson1.js +100 -0
- package/dist-types/commands/InvokeAgentCommand.d.ts +6 -6
- package/dist-types/commands/InvokeFlowCommand.d.ts +38 -0
- package/dist-types/models/models_0.d.ts +542 -284
- package/dist-types/ts3.4/models/models_0.d.ts +398 -230
- package/package.json +7 -7
|
@@ -34,17 +34,17 @@ export interface Parameter {
|
|
|
34
34
|
* <p>The name of the parameter.</p>
|
|
35
35
|
* @public
|
|
36
36
|
*/
|
|
37
|
-
name?: string;
|
|
37
|
+
name?: string | undefined;
|
|
38
38
|
/**
|
|
39
39
|
* <p>The type of the parameter.</p>
|
|
40
40
|
* @public
|
|
41
41
|
*/
|
|
42
|
-
type?: string;
|
|
42
|
+
type?: string | undefined;
|
|
43
43
|
/**
|
|
44
44
|
* <p>The value of the parameter.</p>
|
|
45
45
|
* @public
|
|
46
46
|
*/
|
|
47
|
-
value?: string;
|
|
47
|
+
value?: string | undefined;
|
|
48
48
|
}
|
|
49
49
|
/**
|
|
50
50
|
* <p>The parameters in the API request body.</p>
|
|
@@ -55,7 +55,7 @@ export interface RequestBody {
|
|
|
55
55
|
* <p>The content in the request body.</p>
|
|
56
56
|
* @public
|
|
57
57
|
*/
|
|
58
|
-
content?: Record<string, Parameter[]
|
|
58
|
+
content?: Record<string, Parameter[]> | undefined;
|
|
59
59
|
}
|
|
60
60
|
/**
|
|
61
61
|
* <p>Contains information about the action group being invoked. For more information about the possible structures, see the InvocationInput tab in <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/trace-orchestration.html">OrchestrationTrace</a> in the Amazon Bedrock User Guide.</p>
|
|
@@ -66,42 +66,42 @@ export interface ActionGroupInvocationInput {
|
|
|
66
66
|
* <p>The name of the action group.</p>
|
|
67
67
|
* @public
|
|
68
68
|
*/
|
|
69
|
-
actionGroupName?: string;
|
|
69
|
+
actionGroupName?: string | undefined;
|
|
70
70
|
/**
|
|
71
71
|
* <p>The API method being used, based off the action group.</p>
|
|
72
72
|
* @public
|
|
73
73
|
*/
|
|
74
|
-
verb?: string;
|
|
74
|
+
verb?: string | undefined;
|
|
75
75
|
/**
|
|
76
76
|
* <p>The path to the API to call, based off the action group.</p>
|
|
77
77
|
* @public
|
|
78
78
|
*/
|
|
79
|
-
apiPath?: string;
|
|
79
|
+
apiPath?: string | undefined;
|
|
80
80
|
/**
|
|
81
81
|
* <p>The parameters in the Lambda input event.</p>
|
|
82
82
|
* @public
|
|
83
83
|
*/
|
|
84
|
-
parameters?: Parameter[];
|
|
84
|
+
parameters?: Parameter[] | undefined;
|
|
85
85
|
/**
|
|
86
86
|
* <p>The parameters in the request body for the Lambda input event.</p>
|
|
87
87
|
* @public
|
|
88
88
|
*/
|
|
89
|
-
requestBody?: RequestBody;
|
|
89
|
+
requestBody?: RequestBody | undefined;
|
|
90
90
|
/**
|
|
91
91
|
* <p>The function in the action group to call.</p>
|
|
92
92
|
* @public
|
|
93
93
|
*/
|
|
94
|
-
function?: string;
|
|
94
|
+
function?: string | undefined;
|
|
95
95
|
/**
|
|
96
96
|
* <p>How fulfillment of the action is handled. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/action-handle.html">Handling fulfillment of the action</a>.</p>
|
|
97
97
|
* @public
|
|
98
98
|
*/
|
|
99
|
-
executionType?: ExecutionType;
|
|
99
|
+
executionType?: ExecutionType | undefined;
|
|
100
100
|
/**
|
|
101
101
|
* <p>The unique identifier of the invocation. Only returned if the <code>executionType</code> is <code>RETURN_CONTROL</code>.</p>
|
|
102
102
|
* @public
|
|
103
103
|
*/
|
|
104
|
-
invocationId?: string;
|
|
104
|
+
invocationId?: string | undefined;
|
|
105
105
|
}
|
|
106
106
|
/**
|
|
107
107
|
* <p>Contains the JSON-formatted string returned by the API invoked by the action group.</p>
|
|
@@ -112,7 +112,7 @@ export interface ActionGroupInvocationOutput {
|
|
|
112
112
|
* <p>The JSON-formatted string returned by the API invoked by the action group.</p>
|
|
113
113
|
* @public
|
|
114
114
|
*/
|
|
115
|
-
text?: string;
|
|
115
|
+
text?: string | undefined;
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
118
|
* @public
|
|
@@ -138,7 +138,7 @@ export declare class BadGatewayException extends __BaseException {
|
|
|
138
138
|
* <p>The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.</p>
|
|
139
139
|
* @public
|
|
140
140
|
*/
|
|
141
|
-
resourceName?: string;
|
|
141
|
+
resourceName?: string | undefined;
|
|
142
142
|
/**
|
|
143
143
|
* @internal
|
|
144
144
|
*/
|
|
@@ -167,7 +167,7 @@ export declare class DependencyFailedException extends __BaseException {
|
|
|
167
167
|
* <p>The name of the dependency that caused the issue, such as Amazon Bedrock, Lambda, or STS.</p>
|
|
168
168
|
* @public
|
|
169
169
|
*/
|
|
170
|
-
resourceName?: string;
|
|
170
|
+
resourceName?: string | undefined;
|
|
171
171
|
/**
|
|
172
172
|
* @internal
|
|
173
173
|
*/
|
|
@@ -187,14 +187,6 @@ export declare class InternalServerException extends __BaseException {
|
|
|
187
187
|
}
|
|
188
188
|
/**
|
|
189
189
|
* <p>Contains information about an input into the flow.</p>
|
|
190
|
-
* <p>This data type is used in the following API operations:</p>
|
|
191
|
-
* <ul>
|
|
192
|
-
* <li>
|
|
193
|
-
* <p>
|
|
194
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax">InvokeFlow request</a>
|
|
195
|
-
* </p>
|
|
196
|
-
* </li>
|
|
197
|
-
* </ul>
|
|
198
190
|
* @public
|
|
199
191
|
*/
|
|
200
192
|
export type FlowInputContent = FlowInputContent.DocumentMember | FlowInputContent.$UnknownMember;
|
|
@@ -225,14 +217,6 @@ export declare namespace FlowInputContent {
|
|
|
225
217
|
}
|
|
226
218
|
/**
|
|
227
219
|
* <p>Contains information about an input into the prompt flow and where to send it.</p>
|
|
228
|
-
* <p>This data type is used in the following API operations:</p>
|
|
229
|
-
* <ul>
|
|
230
|
-
* <li>
|
|
231
|
-
* <p>
|
|
232
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax">InvokeFlow request</a>
|
|
233
|
-
* </p>
|
|
234
|
-
* </li>
|
|
235
|
-
* </ul>
|
|
236
220
|
* @public
|
|
237
221
|
*/
|
|
238
222
|
export interface FlowInput {
|
|
@@ -271,6 +255,11 @@ export interface InvokeFlowRequest {
|
|
|
271
255
|
* @public
|
|
272
256
|
*/
|
|
273
257
|
inputs: FlowInput[] | undefined;
|
|
258
|
+
/**
|
|
259
|
+
* <p>Specifies whether to return the trace for the flow or not. Traces track inputs and outputs for nodes in the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
260
|
+
* @public
|
|
261
|
+
*/
|
|
262
|
+
enableTrace?: boolean | undefined;
|
|
274
263
|
}
|
|
275
264
|
/**
|
|
276
265
|
* @public
|
|
@@ -285,14 +274,6 @@ export declare const FlowCompletionReason: {
|
|
|
285
274
|
export type FlowCompletionReason = (typeof FlowCompletionReason)[keyof typeof FlowCompletionReason];
|
|
286
275
|
/**
|
|
287
276
|
* <p>Contains information about why a flow completed.</p>
|
|
288
|
-
* <p>This data type is used in the following API operations:</p>
|
|
289
|
-
* <ul>
|
|
290
|
-
* <li>
|
|
291
|
-
* <p>
|
|
292
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax">InvokeFlow response</a>
|
|
293
|
-
* </p>
|
|
294
|
-
* </li>
|
|
295
|
-
* </ul>
|
|
296
277
|
* @public
|
|
297
278
|
*/
|
|
298
279
|
export interface FlowCompletionEvent {
|
|
@@ -304,14 +285,6 @@ export interface FlowCompletionEvent {
|
|
|
304
285
|
}
|
|
305
286
|
/**
|
|
306
287
|
* <p>Contains information about the content in an output from prompt flow invocation.</p>
|
|
307
|
-
* <p>This data type is used in the following API operations:</p>
|
|
308
|
-
* <ul>
|
|
309
|
-
* <li>
|
|
310
|
-
* <p>
|
|
311
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_RequestSyntax">InvokeFlow request</a>
|
|
312
|
-
* </p>
|
|
313
|
-
* </li>
|
|
314
|
-
* </ul>
|
|
315
288
|
* @public
|
|
316
289
|
*/
|
|
317
290
|
export type FlowOutputContent = FlowOutputContent.DocumentMember | FlowOutputContent.$UnknownMember;
|
|
@@ -359,14 +332,6 @@ export declare const NodeType: {
|
|
|
359
332
|
export type NodeType = (typeof NodeType)[keyof typeof NodeType];
|
|
360
333
|
/**
|
|
361
334
|
* <p>Contains information about an output from prompt flow invoction.</p>
|
|
362
|
-
* <p>This data type is used in the following API operations:</p>
|
|
363
|
-
* <ul>
|
|
364
|
-
* <li>
|
|
365
|
-
* <p>
|
|
366
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax">InvokeFlow response</a>
|
|
367
|
-
* </p>
|
|
368
|
-
* </li>
|
|
369
|
-
* </ul>
|
|
370
335
|
* @public
|
|
371
336
|
*/
|
|
372
337
|
export interface FlowOutputEvent {
|
|
@@ -386,6 +351,239 @@ export interface FlowOutputEvent {
|
|
|
386
351
|
*/
|
|
387
352
|
content: FlowOutputContent | undefined;
|
|
388
353
|
}
|
|
354
|
+
/**
|
|
355
|
+
* <p>Contains information about a condition that was satisfied. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
356
|
+
* @public
|
|
357
|
+
*/
|
|
358
|
+
export interface FlowTraceCondition {
|
|
359
|
+
/**
|
|
360
|
+
* <p>The name of the condition.</p>
|
|
361
|
+
* @public
|
|
362
|
+
*/
|
|
363
|
+
conditionName: string | undefined;
|
|
364
|
+
}
|
|
365
|
+
/**
|
|
366
|
+
* <p>Contains information about an output from a condition node. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
367
|
+
* @public
|
|
368
|
+
*/
|
|
369
|
+
export interface FlowTraceConditionNodeResultEvent {
|
|
370
|
+
/**
|
|
371
|
+
* <p>The name of the condition node.</p>
|
|
372
|
+
* @public
|
|
373
|
+
*/
|
|
374
|
+
nodeName: string | undefined;
|
|
375
|
+
/**
|
|
376
|
+
* <p>The date and time that the trace was returned.</p>
|
|
377
|
+
* @public
|
|
378
|
+
*/
|
|
379
|
+
timestamp: Date | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* <p>An array of objects containing information about the conditions that were satisfied.</p>
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
satisfiedConditions: FlowTraceCondition[] | undefined;
|
|
385
|
+
}
|
|
386
|
+
/**
|
|
387
|
+
* <p>Contains the content of the node input. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
388
|
+
* @public
|
|
389
|
+
*/
|
|
390
|
+
export type FlowTraceNodeInputContent = FlowTraceNodeInputContent.DocumentMember | FlowTraceNodeInputContent.$UnknownMember;
|
|
391
|
+
/**
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
export declare namespace FlowTraceNodeInputContent {
|
|
395
|
+
/**
|
|
396
|
+
* <p>The content of the node input.</p>
|
|
397
|
+
* @public
|
|
398
|
+
*/
|
|
399
|
+
interface DocumentMember {
|
|
400
|
+
document: __DocumentType;
|
|
401
|
+
$unknown?: never;
|
|
402
|
+
}
|
|
403
|
+
/**
|
|
404
|
+
* @public
|
|
405
|
+
*/
|
|
406
|
+
interface $UnknownMember {
|
|
407
|
+
document?: never;
|
|
408
|
+
$unknown: [string, any];
|
|
409
|
+
}
|
|
410
|
+
interface Visitor<T> {
|
|
411
|
+
document: (value: __DocumentType) => T;
|
|
412
|
+
_: (name: string, value: any) => T;
|
|
413
|
+
}
|
|
414
|
+
const visit: <T>(value: FlowTraceNodeInputContent, visitor: Visitor<T>) => T;
|
|
415
|
+
}
|
|
416
|
+
/**
|
|
417
|
+
* <p>Contains information about a field in the input into a node. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
418
|
+
* @public
|
|
419
|
+
*/
|
|
420
|
+
export interface FlowTraceNodeInputField {
|
|
421
|
+
/**
|
|
422
|
+
* <p>The name of the node input.</p>
|
|
423
|
+
* @public
|
|
424
|
+
*/
|
|
425
|
+
nodeInputName: string | undefined;
|
|
426
|
+
/**
|
|
427
|
+
* <p>The content of the node input.</p>
|
|
428
|
+
* @public
|
|
429
|
+
*/
|
|
430
|
+
content: FlowTraceNodeInputContent | undefined;
|
|
431
|
+
}
|
|
432
|
+
/**
|
|
433
|
+
* <p>Contains information about the input into a node. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
434
|
+
* @public
|
|
435
|
+
*/
|
|
436
|
+
export interface FlowTraceNodeInputEvent {
|
|
437
|
+
/**
|
|
438
|
+
* <p>The name of the node that received the input.</p>
|
|
439
|
+
* @public
|
|
440
|
+
*/
|
|
441
|
+
nodeName: string | undefined;
|
|
442
|
+
/**
|
|
443
|
+
* <p>The date and time that the trace was returned.</p>
|
|
444
|
+
* @public
|
|
445
|
+
*/
|
|
446
|
+
timestamp: Date | undefined;
|
|
447
|
+
/**
|
|
448
|
+
* <p>An array of objects containing information about each field in the input.</p>
|
|
449
|
+
* @public
|
|
450
|
+
*/
|
|
451
|
+
fields: FlowTraceNodeInputField[] | undefined;
|
|
452
|
+
}
|
|
453
|
+
/**
|
|
454
|
+
* <p>Contains the content of the node output. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
455
|
+
* @public
|
|
456
|
+
*/
|
|
457
|
+
export type FlowTraceNodeOutputContent = FlowTraceNodeOutputContent.DocumentMember | FlowTraceNodeOutputContent.$UnknownMember;
|
|
458
|
+
/**
|
|
459
|
+
* @public
|
|
460
|
+
*/
|
|
461
|
+
export declare namespace FlowTraceNodeOutputContent {
|
|
462
|
+
/**
|
|
463
|
+
* <p>The content of the node output.</p>
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
466
|
+
interface DocumentMember {
|
|
467
|
+
document: __DocumentType;
|
|
468
|
+
$unknown?: never;
|
|
469
|
+
}
|
|
470
|
+
/**
|
|
471
|
+
* @public
|
|
472
|
+
*/
|
|
473
|
+
interface $UnknownMember {
|
|
474
|
+
document?: never;
|
|
475
|
+
$unknown: [string, any];
|
|
476
|
+
}
|
|
477
|
+
interface Visitor<T> {
|
|
478
|
+
document: (value: __DocumentType) => T;
|
|
479
|
+
_: (name: string, value: any) => T;
|
|
480
|
+
}
|
|
481
|
+
const visit: <T>(value: FlowTraceNodeOutputContent, visitor: Visitor<T>) => T;
|
|
482
|
+
}
|
|
483
|
+
/**
|
|
484
|
+
* <p>Contains information about a field in the output from a node. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
485
|
+
* @public
|
|
486
|
+
*/
|
|
487
|
+
export interface FlowTraceNodeOutputField {
|
|
488
|
+
/**
|
|
489
|
+
* <p>The name of the node output.</p>
|
|
490
|
+
* @public
|
|
491
|
+
*/
|
|
492
|
+
nodeOutputName: string | undefined;
|
|
493
|
+
/**
|
|
494
|
+
* <p>The content of the node output.</p>
|
|
495
|
+
* @public
|
|
496
|
+
*/
|
|
497
|
+
content: FlowTraceNodeOutputContent | undefined;
|
|
498
|
+
}
|
|
499
|
+
/**
|
|
500
|
+
* <p>Contains information about the output from a node. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
501
|
+
* @public
|
|
502
|
+
*/
|
|
503
|
+
export interface FlowTraceNodeOutputEvent {
|
|
504
|
+
/**
|
|
505
|
+
* <p>The name of the node that yielded the output.</p>
|
|
506
|
+
* @public
|
|
507
|
+
*/
|
|
508
|
+
nodeName: string | undefined;
|
|
509
|
+
/**
|
|
510
|
+
* <p>The date and time that the trace was returned.</p>
|
|
511
|
+
* @public
|
|
512
|
+
*/
|
|
513
|
+
timestamp: Date | undefined;
|
|
514
|
+
/**
|
|
515
|
+
* <p>An array of objects containing information about each field in the output.</p>
|
|
516
|
+
* @public
|
|
517
|
+
*/
|
|
518
|
+
fields: FlowTraceNodeOutputField[] | undefined;
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* <p>Contains information about an input or output for a node in the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
522
|
+
* @public
|
|
523
|
+
*/
|
|
524
|
+
export type FlowTrace = FlowTrace.ConditionNodeResultTraceMember | FlowTrace.NodeInputTraceMember | FlowTrace.NodeOutputTraceMember | FlowTrace.$UnknownMember;
|
|
525
|
+
/**
|
|
526
|
+
* @public
|
|
527
|
+
*/
|
|
528
|
+
export declare namespace FlowTrace {
|
|
529
|
+
/**
|
|
530
|
+
* <p>Contains information about the input into a node.</p>
|
|
531
|
+
* @public
|
|
532
|
+
*/
|
|
533
|
+
interface NodeInputTraceMember {
|
|
534
|
+
nodeInputTrace: FlowTraceNodeInputEvent;
|
|
535
|
+
nodeOutputTrace?: never;
|
|
536
|
+
conditionNodeResultTrace?: never;
|
|
537
|
+
$unknown?: never;
|
|
538
|
+
}
|
|
539
|
+
/**
|
|
540
|
+
* <p>Contains information about the output from a node.</p>
|
|
541
|
+
* @public
|
|
542
|
+
*/
|
|
543
|
+
interface NodeOutputTraceMember {
|
|
544
|
+
nodeInputTrace?: never;
|
|
545
|
+
nodeOutputTrace: FlowTraceNodeOutputEvent;
|
|
546
|
+
conditionNodeResultTrace?: never;
|
|
547
|
+
$unknown?: never;
|
|
548
|
+
}
|
|
549
|
+
/**
|
|
550
|
+
* <p>Contains information about an output from a condition node.</p>
|
|
551
|
+
* @public
|
|
552
|
+
*/
|
|
553
|
+
interface ConditionNodeResultTraceMember {
|
|
554
|
+
nodeInputTrace?: never;
|
|
555
|
+
nodeOutputTrace?: never;
|
|
556
|
+
conditionNodeResultTrace: FlowTraceConditionNodeResultEvent;
|
|
557
|
+
$unknown?: never;
|
|
558
|
+
}
|
|
559
|
+
/**
|
|
560
|
+
* @public
|
|
561
|
+
*/
|
|
562
|
+
interface $UnknownMember {
|
|
563
|
+
nodeInputTrace?: never;
|
|
564
|
+
nodeOutputTrace?: never;
|
|
565
|
+
conditionNodeResultTrace?: never;
|
|
566
|
+
$unknown: [string, any];
|
|
567
|
+
}
|
|
568
|
+
interface Visitor<T> {
|
|
569
|
+
nodeInputTrace: (value: FlowTraceNodeInputEvent) => T;
|
|
570
|
+
nodeOutputTrace: (value: FlowTraceNodeOutputEvent) => T;
|
|
571
|
+
conditionNodeResultTrace: (value: FlowTraceConditionNodeResultEvent) => T;
|
|
572
|
+
_: (name: string, value: any) => T;
|
|
573
|
+
}
|
|
574
|
+
const visit: <T>(value: FlowTrace, visitor: Visitor<T>) => T;
|
|
575
|
+
}
|
|
576
|
+
/**
|
|
577
|
+
* <p>Contains information about a trace, which tracks an input or output for a node in the flow. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/flows-trace.html">Track each step in your prompt flow by viewing its trace in Amazon Bedrock</a>.</p>
|
|
578
|
+
* @public
|
|
579
|
+
*/
|
|
580
|
+
export interface FlowTraceEvent {
|
|
581
|
+
/**
|
|
582
|
+
* <p>The trace object containing information about an input or output for a node in the flow.</p>
|
|
583
|
+
* @public
|
|
584
|
+
*/
|
|
585
|
+
trace: FlowTrace | undefined;
|
|
586
|
+
}
|
|
389
587
|
/**
|
|
390
588
|
* <p>The specified resource Amazon Resource Name (ARN) was not found. Check the Amazon Resource Name (ARN) and try your request again.</p>
|
|
391
589
|
* @public
|
|
@@ -436,17 +634,9 @@ export declare class ValidationException extends __BaseException {
|
|
|
436
634
|
}
|
|
437
635
|
/**
|
|
438
636
|
* <p>The output of the flow.</p>
|
|
439
|
-
* <p>This data type is used in the following API operations:</p>
|
|
440
|
-
* <ul>
|
|
441
|
-
* <li>
|
|
442
|
-
* <p>
|
|
443
|
-
* <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeFlow.html#API_agent_InvokeFlow_ResponseSyntax">InvokeFlow response</a>
|
|
444
|
-
* </p>
|
|
445
|
-
* </li>
|
|
446
|
-
* </ul>
|
|
447
637
|
* @public
|
|
448
638
|
*/
|
|
449
|
-
export type FlowResponseStream = FlowResponseStream.AccessDeniedExceptionMember | FlowResponseStream.BadGatewayExceptionMember | FlowResponseStream.ConflictExceptionMember | FlowResponseStream.DependencyFailedExceptionMember | FlowResponseStream.FlowCompletionEventMember | FlowResponseStream.FlowOutputEventMember | FlowResponseStream.InternalServerExceptionMember | FlowResponseStream.ResourceNotFoundExceptionMember | FlowResponseStream.ServiceQuotaExceededExceptionMember | FlowResponseStream.ThrottlingExceptionMember | FlowResponseStream.ValidationExceptionMember | FlowResponseStream.$UnknownMember;
|
|
639
|
+
export type FlowResponseStream = FlowResponseStream.AccessDeniedExceptionMember | FlowResponseStream.BadGatewayExceptionMember | FlowResponseStream.ConflictExceptionMember | FlowResponseStream.DependencyFailedExceptionMember | FlowResponseStream.FlowCompletionEventMember | FlowResponseStream.FlowOutputEventMember | FlowResponseStream.FlowTraceEventMember | FlowResponseStream.InternalServerExceptionMember | FlowResponseStream.ResourceNotFoundExceptionMember | FlowResponseStream.ServiceQuotaExceededExceptionMember | FlowResponseStream.ThrottlingExceptionMember | FlowResponseStream.ValidationExceptionMember | FlowResponseStream.$UnknownMember;
|
|
450
640
|
/**
|
|
451
641
|
* @public
|
|
452
642
|
*/
|
|
@@ -458,6 +648,7 @@ export declare namespace FlowResponseStream {
|
|
|
458
648
|
interface FlowOutputEventMember {
|
|
459
649
|
flowOutputEvent: FlowOutputEvent;
|
|
460
650
|
flowCompletionEvent?: never;
|
|
651
|
+
flowTraceEvent?: never;
|
|
461
652
|
internalServerException?: never;
|
|
462
653
|
validationException?: never;
|
|
463
654
|
resourceNotFoundException?: never;
|
|
@@ -476,6 +667,26 @@ export declare namespace FlowResponseStream {
|
|
|
476
667
|
interface FlowCompletionEventMember {
|
|
477
668
|
flowOutputEvent?: never;
|
|
478
669
|
flowCompletionEvent: FlowCompletionEvent;
|
|
670
|
+
flowTraceEvent?: never;
|
|
671
|
+
internalServerException?: never;
|
|
672
|
+
validationException?: never;
|
|
673
|
+
resourceNotFoundException?: never;
|
|
674
|
+
serviceQuotaExceededException?: never;
|
|
675
|
+
throttlingException?: never;
|
|
676
|
+
accessDeniedException?: never;
|
|
677
|
+
conflictException?: never;
|
|
678
|
+
dependencyFailedException?: never;
|
|
679
|
+
badGatewayException?: never;
|
|
680
|
+
$unknown?: never;
|
|
681
|
+
}
|
|
682
|
+
/**
|
|
683
|
+
* <p>Contains information about a trace, which tracks an input or output for a node in the flow.</p>
|
|
684
|
+
* @public
|
|
685
|
+
*/
|
|
686
|
+
interface FlowTraceEventMember {
|
|
687
|
+
flowOutputEvent?: never;
|
|
688
|
+
flowCompletionEvent?: never;
|
|
689
|
+
flowTraceEvent: FlowTraceEvent;
|
|
479
690
|
internalServerException?: never;
|
|
480
691
|
validationException?: never;
|
|
481
692
|
resourceNotFoundException?: never;
|
|
@@ -494,6 +705,7 @@ export declare namespace FlowResponseStream {
|
|
|
494
705
|
interface InternalServerExceptionMember {
|
|
495
706
|
flowOutputEvent?: never;
|
|
496
707
|
flowCompletionEvent?: never;
|
|
708
|
+
flowTraceEvent?: never;
|
|
497
709
|
internalServerException: InternalServerException;
|
|
498
710
|
validationException?: never;
|
|
499
711
|
resourceNotFoundException?: never;
|
|
@@ -512,6 +724,7 @@ export declare namespace FlowResponseStream {
|
|
|
512
724
|
interface ValidationExceptionMember {
|
|
513
725
|
flowOutputEvent?: never;
|
|
514
726
|
flowCompletionEvent?: never;
|
|
727
|
+
flowTraceEvent?: never;
|
|
515
728
|
internalServerException?: never;
|
|
516
729
|
validationException: ValidationException;
|
|
517
730
|
resourceNotFoundException?: never;
|
|
@@ -530,6 +743,7 @@ export declare namespace FlowResponseStream {
|
|
|
530
743
|
interface ResourceNotFoundExceptionMember {
|
|
531
744
|
flowOutputEvent?: never;
|
|
532
745
|
flowCompletionEvent?: never;
|
|
746
|
+
flowTraceEvent?: never;
|
|
533
747
|
internalServerException?: never;
|
|
534
748
|
validationException?: never;
|
|
535
749
|
resourceNotFoundException: ResourceNotFoundException;
|
|
@@ -548,6 +762,7 @@ export declare namespace FlowResponseStream {
|
|
|
548
762
|
interface ServiceQuotaExceededExceptionMember {
|
|
549
763
|
flowOutputEvent?: never;
|
|
550
764
|
flowCompletionEvent?: never;
|
|
765
|
+
flowTraceEvent?: never;
|
|
551
766
|
internalServerException?: never;
|
|
552
767
|
validationException?: never;
|
|
553
768
|
resourceNotFoundException?: never;
|
|
@@ -566,6 +781,7 @@ export declare namespace FlowResponseStream {
|
|
|
566
781
|
interface ThrottlingExceptionMember {
|
|
567
782
|
flowOutputEvent?: never;
|
|
568
783
|
flowCompletionEvent?: never;
|
|
784
|
+
flowTraceEvent?: never;
|
|
569
785
|
internalServerException?: never;
|
|
570
786
|
validationException?: never;
|
|
571
787
|
resourceNotFoundException?: never;
|
|
@@ -584,6 +800,7 @@ export declare namespace FlowResponseStream {
|
|
|
584
800
|
interface AccessDeniedExceptionMember {
|
|
585
801
|
flowOutputEvent?: never;
|
|
586
802
|
flowCompletionEvent?: never;
|
|
803
|
+
flowTraceEvent?: never;
|
|
587
804
|
internalServerException?: never;
|
|
588
805
|
validationException?: never;
|
|
589
806
|
resourceNotFoundException?: never;
|
|
@@ -602,6 +819,7 @@ export declare namespace FlowResponseStream {
|
|
|
602
819
|
interface ConflictExceptionMember {
|
|
603
820
|
flowOutputEvent?: never;
|
|
604
821
|
flowCompletionEvent?: never;
|
|
822
|
+
flowTraceEvent?: never;
|
|
605
823
|
internalServerException?: never;
|
|
606
824
|
validationException?: never;
|
|
607
825
|
resourceNotFoundException?: never;
|
|
@@ -620,6 +838,7 @@ export declare namespace FlowResponseStream {
|
|
|
620
838
|
interface DependencyFailedExceptionMember {
|
|
621
839
|
flowOutputEvent?: never;
|
|
622
840
|
flowCompletionEvent?: never;
|
|
841
|
+
flowTraceEvent?: never;
|
|
623
842
|
internalServerException?: never;
|
|
624
843
|
validationException?: never;
|
|
625
844
|
resourceNotFoundException?: never;
|
|
@@ -638,6 +857,7 @@ export declare namespace FlowResponseStream {
|
|
|
638
857
|
interface BadGatewayExceptionMember {
|
|
639
858
|
flowOutputEvent?: never;
|
|
640
859
|
flowCompletionEvent?: never;
|
|
860
|
+
flowTraceEvent?: never;
|
|
641
861
|
internalServerException?: never;
|
|
642
862
|
validationException?: never;
|
|
643
863
|
resourceNotFoundException?: never;
|
|
@@ -655,6 +875,7 @@ export declare namespace FlowResponseStream {
|
|
|
655
875
|
interface $UnknownMember {
|
|
656
876
|
flowOutputEvent?: never;
|
|
657
877
|
flowCompletionEvent?: never;
|
|
878
|
+
flowTraceEvent?: never;
|
|
658
879
|
internalServerException?: never;
|
|
659
880
|
validationException?: never;
|
|
660
881
|
resourceNotFoundException?: never;
|
|
@@ -669,6 +890,7 @@ export declare namespace FlowResponseStream {
|
|
|
669
890
|
interface Visitor<T> {
|
|
670
891
|
flowOutputEvent: (value: FlowOutputEvent) => T;
|
|
671
892
|
flowCompletionEvent: (value: FlowCompletionEvent) => T;
|
|
893
|
+
flowTraceEvent: (value: FlowTraceEvent) => T;
|
|
672
894
|
internalServerException: (value: InternalServerException) => T;
|
|
673
895
|
validationException: (value: ValidationException) => T;
|
|
674
896
|
resourceNotFoundException: (value: ResourceNotFoundException) => T;
|
|
@@ -745,12 +967,12 @@ export interface FileSource {
|
|
|
745
967
|
* <p>The s3 location of the files to attach.</p>
|
|
746
968
|
* @public
|
|
747
969
|
*/
|
|
748
|
-
s3Location?: S3ObjectFile;
|
|
970
|
+
s3Location?: S3ObjectFile | undefined;
|
|
749
971
|
/**
|
|
750
972
|
* <p>The data and the text of the attached files.</p>
|
|
751
973
|
* @public
|
|
752
974
|
*/
|
|
753
|
-
byteContent?: ByteContentFile;
|
|
975
|
+
byteContent?: ByteContentFile | undefined;
|
|
754
976
|
}
|
|
755
977
|
/**
|
|
756
978
|
* @public
|
|
@@ -849,7 +1071,7 @@ export interface ContentBody {
|
|
|
849
1071
|
* <p>The body of the API response.</p>
|
|
850
1072
|
* @public
|
|
851
1073
|
*/
|
|
852
|
-
body?: string;
|
|
1074
|
+
body?: string | undefined;
|
|
853
1075
|
}
|
|
854
1076
|
/**
|
|
855
1077
|
* @public
|
|
@@ -884,32 +1106,32 @@ export interface ApiResult {
|
|
|
884
1106
|
* <p>The HTTP method for the API operation.</p>
|
|
885
1107
|
* @public
|
|
886
1108
|
*/
|
|
887
|
-
httpMethod?: string;
|
|
1109
|
+
httpMethod?: string | undefined;
|
|
888
1110
|
/**
|
|
889
1111
|
* <p>The path to the API operation.</p>
|
|
890
1112
|
* @public
|
|
891
1113
|
*/
|
|
892
|
-
apiPath?: string;
|
|
1114
|
+
apiPath?: string | undefined;
|
|
893
1115
|
/**
|
|
894
1116
|
* <p>Controls the API operations or functions to invoke based on the user confirmation.</p>
|
|
895
1117
|
* @public
|
|
896
1118
|
*/
|
|
897
|
-
confirmationState?: ConfirmationState;
|
|
1119
|
+
confirmationState?: ConfirmationState | undefined;
|
|
898
1120
|
/**
|
|
899
1121
|
* <p>The response body from the API operation. The key of the object is the content type (currently, only <code>TEXT</code> is supported). The response may be returned directly or from the Lambda function.</p>
|
|
900
1122
|
* @public
|
|
901
1123
|
*/
|
|
902
|
-
responseBody?: Record<string, ContentBody
|
|
1124
|
+
responseBody?: Record<string, ContentBody> | undefined;
|
|
903
1125
|
/**
|
|
904
1126
|
* <p>http status code from API execution response (for example: 200, 400, 500).</p>
|
|
905
1127
|
* @public
|
|
906
1128
|
*/
|
|
907
|
-
httpStatusCode?: number;
|
|
1129
|
+
httpStatusCode?: number | undefined;
|
|
908
1130
|
/**
|
|
909
1131
|
* <p>Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt</p>
|
|
910
1132
|
* @public
|
|
911
1133
|
*/
|
|
912
|
-
responseState?: ResponseState;
|
|
1134
|
+
responseState?: ResponseState | undefined;
|
|
913
1135
|
}
|
|
914
1136
|
/**
|
|
915
1137
|
* <p>Contains information about the function that was called from the action group and the response that was returned.</p>
|
|
@@ -932,22 +1154,22 @@ export interface FunctionResult {
|
|
|
932
1154
|
* <p>Contains the user confirmation information about the function that was called.</p>
|
|
933
1155
|
* @public
|
|
934
1156
|
*/
|
|
935
|
-
confirmationState?: ConfirmationState;
|
|
1157
|
+
confirmationState?: ConfirmationState | undefined;
|
|
936
1158
|
/**
|
|
937
1159
|
* <p>The name of the function that was called.</p>
|
|
938
1160
|
* @public
|
|
939
1161
|
*/
|
|
940
|
-
function?: string;
|
|
1162
|
+
function?: string | undefined;
|
|
941
1163
|
/**
|
|
942
1164
|
* <p>The response from the function call using the parameters. The key of the object is the content type (currently, only <code>TEXT</code> is supported). The response may be returned directly or from the Lambda function.</p>
|
|
943
1165
|
* @public
|
|
944
1166
|
*/
|
|
945
|
-
responseBody?: Record<string, ContentBody
|
|
1167
|
+
responseBody?: Record<string, ContentBody> | undefined;
|
|
946
1168
|
/**
|
|
947
1169
|
* <p>Controls the final response state returned to end user when API/Function execution failed. When this state is FAILURE, the request would fail with dependency failure exception. When this state is REPROMPT, the API/function response will be sent to model for re-prompt</p>
|
|
948
1170
|
* @public
|
|
949
1171
|
*/
|
|
950
|
-
responseState?: ResponseState;
|
|
1172
|
+
responseState?: ResponseState | undefined;
|
|
951
1173
|
}
|
|
952
1174
|
/**
|
|
953
1175
|
* <p>A result from the invocation of an action. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
@@ -1019,12 +1241,12 @@ export interface Span {
|
|
|
1019
1241
|
* <p>Where the text with a citation starts in the generated output.</p>
|
|
1020
1242
|
* @public
|
|
1021
1243
|
*/
|
|
1022
|
-
start?: number;
|
|
1244
|
+
start?: number | undefined;
|
|
1023
1245
|
/**
|
|
1024
1246
|
* <p>Where the text with a citation ends in the generated output.</p>
|
|
1025
1247
|
* @public
|
|
1026
1248
|
*/
|
|
1027
|
-
end?: number;
|
|
1249
|
+
end?: number | undefined;
|
|
1028
1250
|
}
|
|
1029
1251
|
/**
|
|
1030
1252
|
* <p>Contains the part of the generated text that contains a citation, alongside where it begins and ends.</p>
|
|
@@ -1046,12 +1268,12 @@ export interface TextResponsePart {
|
|
|
1046
1268
|
* <p>The part of the generated text that contains a citation.</p>
|
|
1047
1269
|
* @public
|
|
1048
1270
|
*/
|
|
1049
|
-
text?: string;
|
|
1271
|
+
text?: string | undefined;
|
|
1050
1272
|
/**
|
|
1051
1273
|
* <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
|
|
1052
1274
|
* @public
|
|
1053
1275
|
*/
|
|
1054
|
-
span?: Span;
|
|
1276
|
+
span?: Span | undefined;
|
|
1055
1277
|
}
|
|
1056
1278
|
/**
|
|
1057
1279
|
* <p>Contains metadata about a part of the generated response that is accompanied by a citation.</p>
|
|
@@ -1073,7 +1295,7 @@ export interface GeneratedResponsePart {
|
|
|
1073
1295
|
* <p>Contains metadata about a textual part of the generated response that is accompanied by a citation.</p>
|
|
1074
1296
|
* @public
|
|
1075
1297
|
*/
|
|
1076
|
-
textResponsePart?: TextResponsePart;
|
|
1298
|
+
textResponsePart?: TextResponsePart | undefined;
|
|
1077
1299
|
}
|
|
1078
1300
|
/**
|
|
1079
1301
|
* <p>Contains the cited text from the data source.</p>
|
|
@@ -1110,7 +1332,7 @@ export interface RetrievalResultConfluenceLocation {
|
|
|
1110
1332
|
* <p>The Confluence host URL for the data source location.</p>
|
|
1111
1333
|
* @public
|
|
1112
1334
|
*/
|
|
1113
|
-
url?: string;
|
|
1335
|
+
url?: string | undefined;
|
|
1114
1336
|
}
|
|
1115
1337
|
/**
|
|
1116
1338
|
* <p>The S3 data source location.</p>
|
|
@@ -1136,7 +1358,7 @@ export interface RetrievalResultS3Location {
|
|
|
1136
1358
|
* <p>The S3 URI for the data source location.</p>
|
|
1137
1359
|
* @public
|
|
1138
1360
|
*/
|
|
1139
|
-
uri?: string;
|
|
1361
|
+
uri?: string | undefined;
|
|
1140
1362
|
}
|
|
1141
1363
|
/**
|
|
1142
1364
|
* <p>The Salesforce data source location.</p>
|
|
@@ -1147,7 +1369,7 @@ export interface RetrievalResultSalesforceLocation {
|
|
|
1147
1369
|
* <p>The Salesforce host URL for the data source location.</p>
|
|
1148
1370
|
* @public
|
|
1149
1371
|
*/
|
|
1150
|
-
url?: string;
|
|
1372
|
+
url?: string | undefined;
|
|
1151
1373
|
}
|
|
1152
1374
|
/**
|
|
1153
1375
|
* <p>The SharePoint data source location.</p>
|
|
@@ -1158,7 +1380,7 @@ export interface RetrievalResultSharePointLocation {
|
|
|
1158
1380
|
* <p>The SharePoint site URL for the data source location.</p>
|
|
1159
1381
|
* @public
|
|
1160
1382
|
*/
|
|
1161
|
-
url?: string;
|
|
1383
|
+
url?: string | undefined;
|
|
1162
1384
|
}
|
|
1163
1385
|
/**
|
|
1164
1386
|
* @public
|
|
@@ -1184,7 +1406,7 @@ export interface RetrievalResultWebLocation {
|
|
|
1184
1406
|
* <p>The web URL/URLs for the data source location.</p>
|
|
1185
1407
|
* @public
|
|
1186
1408
|
*/
|
|
1187
|
-
url?: string;
|
|
1409
|
+
url?: string | undefined;
|
|
1188
1410
|
}
|
|
1189
1411
|
/**
|
|
1190
1412
|
* <p>Contains information about the data source location.</p>
|
|
@@ -1215,27 +1437,27 @@ export interface RetrievalResultLocation {
|
|
|
1215
1437
|
* <p>The S3 data source location.</p>
|
|
1216
1438
|
* @public
|
|
1217
1439
|
*/
|
|
1218
|
-
s3Location?: RetrievalResultS3Location;
|
|
1440
|
+
s3Location?: RetrievalResultS3Location | undefined;
|
|
1219
1441
|
/**
|
|
1220
1442
|
* <p>The web URL/URLs data source location.</p>
|
|
1221
1443
|
* @public
|
|
1222
1444
|
*/
|
|
1223
|
-
webLocation?: RetrievalResultWebLocation;
|
|
1445
|
+
webLocation?: RetrievalResultWebLocation | undefined;
|
|
1224
1446
|
/**
|
|
1225
1447
|
* <p>The Confluence data source location.</p>
|
|
1226
1448
|
* @public
|
|
1227
1449
|
*/
|
|
1228
|
-
confluenceLocation?: RetrievalResultConfluenceLocation;
|
|
1450
|
+
confluenceLocation?: RetrievalResultConfluenceLocation | undefined;
|
|
1229
1451
|
/**
|
|
1230
1452
|
* <p>The Salesforce data source location.</p>
|
|
1231
1453
|
* @public
|
|
1232
1454
|
*/
|
|
1233
|
-
salesforceLocation?: RetrievalResultSalesforceLocation;
|
|
1455
|
+
salesforceLocation?: RetrievalResultSalesforceLocation | undefined;
|
|
1234
1456
|
/**
|
|
1235
1457
|
* <p>The SharePoint data source location.</p>
|
|
1236
1458
|
* @public
|
|
1237
1459
|
*/
|
|
1238
|
-
sharePointLocation?: RetrievalResultSharePointLocation;
|
|
1460
|
+
sharePointLocation?: RetrievalResultSharePointLocation | undefined;
|
|
1239
1461
|
}
|
|
1240
1462
|
/**
|
|
1241
1463
|
* <p>Contains metadata about a source cited for the generated response.</p>
|
|
@@ -1257,17 +1479,17 @@ export interface RetrievedReference {
|
|
|
1257
1479
|
* <p>Contains the cited text from the data source.</p>
|
|
1258
1480
|
* @public
|
|
1259
1481
|
*/
|
|
1260
|
-
content?: RetrievalResultContent;
|
|
1482
|
+
content?: RetrievalResultContent | undefined;
|
|
1261
1483
|
/**
|
|
1262
1484
|
* <p>Contains information about the location of the data source.</p>
|
|
1263
1485
|
* @public
|
|
1264
1486
|
*/
|
|
1265
|
-
location?: RetrievalResultLocation;
|
|
1487
|
+
location?: RetrievalResultLocation | undefined;
|
|
1266
1488
|
/**
|
|
1267
1489
|
* <p>Contains metadata attributes and their values for the file in the data source. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata">Metadata and filtering</a>.</p>
|
|
1268
1490
|
* @public
|
|
1269
1491
|
*/
|
|
1270
|
-
metadata?: Record<string, __DocumentType
|
|
1492
|
+
metadata?: Record<string, __DocumentType> | undefined;
|
|
1271
1493
|
}
|
|
1272
1494
|
/**
|
|
1273
1495
|
* <p>An object containing a segment of the generated response that is based on a source in the knowledge base, alongside information about the source.</p>
|
|
@@ -1289,12 +1511,12 @@ export interface Citation {
|
|
|
1289
1511
|
* <p>Contains the generated response and metadata </p>
|
|
1290
1512
|
* @public
|
|
1291
1513
|
*/
|
|
1292
|
-
generatedResponsePart?: GeneratedResponsePart;
|
|
1514
|
+
generatedResponsePart?: GeneratedResponsePart | undefined;
|
|
1293
1515
|
/**
|
|
1294
1516
|
* <p>Contains metadata about the sources cited for the generated response.</p>
|
|
1295
1517
|
* @public
|
|
1296
1518
|
*/
|
|
1297
|
-
retrievedReferences?: RetrievedReference[];
|
|
1519
|
+
retrievedReferences?: RetrievedReference[] | undefined;
|
|
1298
1520
|
}
|
|
1299
1521
|
/**
|
|
1300
1522
|
* <p>Contains citations for a part of an agent response.</p>
|
|
@@ -1305,7 +1527,7 @@ export interface Attribution {
|
|
|
1305
1527
|
* <p>A list of citations and related information for a part of an agent response.</p>
|
|
1306
1528
|
* @public
|
|
1307
1529
|
*/
|
|
1308
|
-
citations?: Citation[];
|
|
1530
|
+
citations?: Citation[] | undefined;
|
|
1309
1531
|
}
|
|
1310
1532
|
/**
|
|
1311
1533
|
* <p>Contains a part of an agent response and citations for it.</p>
|
|
@@ -1316,12 +1538,12 @@ export interface PayloadPart {
|
|
|
1316
1538
|
* <p>A part of the agent response in bytes.</p>
|
|
1317
1539
|
* @public
|
|
1318
1540
|
*/
|
|
1319
|
-
bytes?: Uint8Array;
|
|
1541
|
+
bytes?: Uint8Array | undefined;
|
|
1320
1542
|
/**
|
|
1321
1543
|
* <p>Contains citations for a part of an agent response.</p>
|
|
1322
1544
|
* @public
|
|
1323
1545
|
*/
|
|
1324
|
-
attribution?: Attribution;
|
|
1546
|
+
attribution?: Attribution | undefined;
|
|
1325
1547
|
}
|
|
1326
1548
|
/**
|
|
1327
1549
|
* <p>Contains details of the response from code interpreter.</p>
|
|
@@ -1332,17 +1554,17 @@ export interface OutputFile {
|
|
|
1332
1554
|
* <p>The name of the file containing response from code interpreter.</p>
|
|
1333
1555
|
* @public
|
|
1334
1556
|
*/
|
|
1335
|
-
name?: string;
|
|
1557
|
+
name?: string | undefined;
|
|
1336
1558
|
/**
|
|
1337
1559
|
* <p>The type of file that contains response from the code interpreter.</p>
|
|
1338
1560
|
* @public
|
|
1339
1561
|
*/
|
|
1340
|
-
type?: string;
|
|
1562
|
+
type?: string | undefined;
|
|
1341
1563
|
/**
|
|
1342
1564
|
* <p>The byte count of files that contains response from code interpreter.</p>
|
|
1343
1565
|
* @public
|
|
1344
1566
|
*/
|
|
1345
|
-
bytes?: Uint8Array;
|
|
1567
|
+
bytes?: Uint8Array | undefined;
|
|
1346
1568
|
}
|
|
1347
1569
|
/**
|
|
1348
1570
|
* <p>Contains intermediate response for code interpreter if any files have been generated.</p>
|
|
@@ -1353,7 +1575,7 @@ export interface FilePart {
|
|
|
1353
1575
|
* <p>Files containing intermediate response for the user.</p>
|
|
1354
1576
|
* @public
|
|
1355
1577
|
*/
|
|
1356
|
-
files?: OutputFile[];
|
|
1578
|
+
files?: OutputFile[] | undefined;
|
|
1357
1579
|
}
|
|
1358
1580
|
/**
|
|
1359
1581
|
* <p>Information about a parameter to provide to the API request.</p>
|
|
@@ -1372,17 +1594,17 @@ export interface ApiParameter {
|
|
|
1372
1594
|
* <p>The name of the parameter.</p>
|
|
1373
1595
|
* @public
|
|
1374
1596
|
*/
|
|
1375
|
-
name?: string;
|
|
1597
|
+
name?: string | undefined;
|
|
1376
1598
|
/**
|
|
1377
1599
|
* <p>The data type for the parameter.</p>
|
|
1378
1600
|
* @public
|
|
1379
1601
|
*/
|
|
1380
|
-
type?: string;
|
|
1602
|
+
type?: string | undefined;
|
|
1381
1603
|
/**
|
|
1382
1604
|
* <p>The value of the parameter.</p>
|
|
1383
1605
|
* @public
|
|
1384
1606
|
*/
|
|
1385
|
-
value?: string;
|
|
1607
|
+
value?: string | undefined;
|
|
1386
1608
|
}
|
|
1387
1609
|
/**
|
|
1388
1610
|
* <p>Contains the parameters in the request body.</p>
|
|
@@ -1393,7 +1615,7 @@ export interface PropertyParameters {
|
|
|
1393
1615
|
* <p>A list of parameters in the request body.</p>
|
|
1394
1616
|
* @public
|
|
1395
1617
|
*/
|
|
1396
|
-
properties?: Parameter[];
|
|
1618
|
+
properties?: Parameter[] | undefined;
|
|
1397
1619
|
}
|
|
1398
1620
|
/**
|
|
1399
1621
|
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
@@ -1412,7 +1634,7 @@ export interface ApiRequestBody {
|
|
|
1412
1634
|
* <p>The content of the request body. The key of the object in this field is a media type defining the format of the request body.</p>
|
|
1413
1635
|
* @public
|
|
1414
1636
|
*/
|
|
1415
|
-
content?: Record<string, PropertyParameters
|
|
1637
|
+
content?: Record<string, PropertyParameters> | undefined;
|
|
1416
1638
|
}
|
|
1417
1639
|
/**
|
|
1418
1640
|
* <p>Contains information about the API operation that the agent predicts should be called.</p>
|
|
@@ -1435,27 +1657,27 @@ export interface ApiInvocationInput {
|
|
|
1435
1657
|
* <p>The HTTP method of the API operation.</p>
|
|
1436
1658
|
* @public
|
|
1437
1659
|
*/
|
|
1438
|
-
httpMethod?: string;
|
|
1660
|
+
httpMethod?: string | undefined;
|
|
1439
1661
|
/**
|
|
1440
1662
|
* <p>The path to the API operation.</p>
|
|
1441
1663
|
* @public
|
|
1442
1664
|
*/
|
|
1443
|
-
apiPath?: string;
|
|
1665
|
+
apiPath?: string | undefined;
|
|
1444
1666
|
/**
|
|
1445
1667
|
* <p>The parameters to provide for the API request, as the agent elicited from the user.</p>
|
|
1446
1668
|
* @public
|
|
1447
1669
|
*/
|
|
1448
|
-
parameters?: ApiParameter[];
|
|
1670
|
+
parameters?: ApiParameter[] | undefined;
|
|
1449
1671
|
/**
|
|
1450
1672
|
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
1451
1673
|
* @public
|
|
1452
1674
|
*/
|
|
1453
|
-
requestBody?: ApiRequestBody;
|
|
1675
|
+
requestBody?: ApiRequestBody | undefined;
|
|
1454
1676
|
/**
|
|
1455
1677
|
* <p>Contains information about the API operation to invoke.</p>
|
|
1456
1678
|
* @public
|
|
1457
1679
|
*/
|
|
1458
|
-
actionInvocationType?: ActionInvocationType;
|
|
1680
|
+
actionInvocationType?: ActionInvocationType | undefined;
|
|
1459
1681
|
}
|
|
1460
1682
|
/**
|
|
1461
1683
|
* <p>Contains information about a parameter of the function.</p>
|
|
@@ -1473,17 +1695,17 @@ export interface FunctionParameter {
|
|
|
1473
1695
|
* <p>The name of the parameter.</p>
|
|
1474
1696
|
* @public
|
|
1475
1697
|
*/
|
|
1476
|
-
name?: string;
|
|
1698
|
+
name?: string | undefined;
|
|
1477
1699
|
/**
|
|
1478
1700
|
* <p>The data type of the parameter.</p>
|
|
1479
1701
|
* @public
|
|
1480
1702
|
*/
|
|
1481
|
-
type?: string;
|
|
1703
|
+
type?: string | undefined;
|
|
1482
1704
|
/**
|
|
1483
1705
|
* <p>The value of the parameter.</p>
|
|
1484
1706
|
* @public
|
|
1485
1707
|
*/
|
|
1486
|
-
value?: string;
|
|
1708
|
+
value?: string | undefined;
|
|
1487
1709
|
}
|
|
1488
1710
|
/**
|
|
1489
1711
|
* <p>Contains information about the function that the agent predicts should be called.</p>
|
|
@@ -1506,17 +1728,17 @@ export interface FunctionInvocationInput {
|
|
|
1506
1728
|
* <p>A list of parameters of the function.</p>
|
|
1507
1729
|
* @public
|
|
1508
1730
|
*/
|
|
1509
|
-
parameters?: FunctionParameter[];
|
|
1731
|
+
parameters?: FunctionParameter[] | undefined;
|
|
1510
1732
|
/**
|
|
1511
1733
|
* <p>The name of the function.</p>
|
|
1512
1734
|
* @public
|
|
1513
1735
|
*/
|
|
1514
|
-
function?: string;
|
|
1736
|
+
function?: string | undefined;
|
|
1515
1737
|
/**
|
|
1516
1738
|
* <p>Contains information about the function to invoke,</p>
|
|
1517
1739
|
* @public
|
|
1518
1740
|
*/
|
|
1519
|
-
actionInvocationType?: ActionInvocationType;
|
|
1741
|
+
actionInvocationType?: ActionInvocationType | undefined;
|
|
1520
1742
|
}
|
|
1521
1743
|
/**
|
|
1522
1744
|
* <p>Contains details about the API operation or function that the agent predicts should be called. </p>
|
|
@@ -1584,12 +1806,12 @@ export interface ReturnControlPayload {
|
|
|
1584
1806
|
* <p>A list of objects that contain information about the parameters and inputs that need to be sent into the API operation or function, based on what the agent determines from its session with the user.</p>
|
|
1585
1807
|
* @public
|
|
1586
1808
|
*/
|
|
1587
|
-
invocationInputs?: InvocationInputMember[];
|
|
1809
|
+
invocationInputs?: InvocationInputMember[] | undefined;
|
|
1588
1810
|
/**
|
|
1589
1811
|
* <p>The identifier of the action group invocation.</p>
|
|
1590
1812
|
* @public
|
|
1591
1813
|
*/
|
|
1592
|
-
invocationId?: string;
|
|
1814
|
+
invocationId?: string | undefined;
|
|
1593
1815
|
}
|
|
1594
1816
|
/**
|
|
1595
1817
|
* <p>Contains information about the failure of the interaction.</p>
|
|
@@ -1600,12 +1822,12 @@ export interface FailureTrace {
|
|
|
1600
1822
|
* <p>The unique identifier of the trace.</p>
|
|
1601
1823
|
* @public
|
|
1602
1824
|
*/
|
|
1603
|
-
traceId?: string;
|
|
1825
|
+
traceId?: string | undefined;
|
|
1604
1826
|
/**
|
|
1605
1827
|
* <p>The reason the interaction failed.</p>
|
|
1606
1828
|
* @public
|
|
1607
1829
|
*/
|
|
1608
|
-
failureReason?: string;
|
|
1830
|
+
failureReason?: string | undefined;
|
|
1609
1831
|
}
|
|
1610
1832
|
/**
|
|
1611
1833
|
* @public
|
|
@@ -1669,17 +1891,17 @@ export interface GuardrailContentFilter {
|
|
|
1669
1891
|
* <p>The type of content detected in the filter by the Guardrail.</p>
|
|
1670
1892
|
* @public
|
|
1671
1893
|
*/
|
|
1672
|
-
type?: GuardrailContentFilterType;
|
|
1894
|
+
type?: GuardrailContentFilterType | undefined;
|
|
1673
1895
|
/**
|
|
1674
1896
|
* <p>The confidence level regarding the content detected in the filter by the Guardrail.</p>
|
|
1675
1897
|
* @public
|
|
1676
1898
|
*/
|
|
1677
|
-
confidence?: GuardrailContentFilterConfidence;
|
|
1899
|
+
confidence?: GuardrailContentFilterConfidence | undefined;
|
|
1678
1900
|
/**
|
|
1679
1901
|
* <p>The action placed on the content by the Guardrail filter.</p>
|
|
1680
1902
|
* @public
|
|
1681
1903
|
*/
|
|
1682
|
-
action?: GuardrailContentPolicyAction;
|
|
1904
|
+
action?: GuardrailContentPolicyAction | undefined;
|
|
1683
1905
|
}
|
|
1684
1906
|
/**
|
|
1685
1907
|
* <p>The details of the policy assessment in the Guardrails filter.</p>
|
|
@@ -1690,7 +1912,7 @@ export interface GuardrailContentPolicyAssessment {
|
|
|
1690
1912
|
* <p>The filter details of the policy assessment used in the Guardrails filter.</p>
|
|
1691
1913
|
* @public
|
|
1692
1914
|
*/
|
|
1693
|
-
filters?: GuardrailContentFilter[];
|
|
1915
|
+
filters?: GuardrailContentFilter[] | undefined;
|
|
1694
1916
|
}
|
|
1695
1917
|
/**
|
|
1696
1918
|
* @public
|
|
@@ -1754,17 +1976,17 @@ export interface GuardrailPiiEntityFilter {
|
|
|
1754
1976
|
* <p>The type of PII the Guardrail filter has identified and removed.</p>
|
|
1755
1977
|
* @public
|
|
1756
1978
|
*/
|
|
1757
|
-
type?: GuardrailPiiEntityType;
|
|
1979
|
+
type?: GuardrailPiiEntityType | undefined;
|
|
1758
1980
|
/**
|
|
1759
1981
|
* <p>The match to settings in the Guardrail filter to identify and remove PII.</p>
|
|
1760
1982
|
* @public
|
|
1761
1983
|
*/
|
|
1762
|
-
match?: string;
|
|
1984
|
+
match?: string | undefined;
|
|
1763
1985
|
/**
|
|
1764
1986
|
* <p>The action of the Guardrail filter to identify and remove PII.</p>
|
|
1765
1987
|
* @public
|
|
1766
1988
|
*/
|
|
1767
|
-
action?: GuardrailSensitiveInformationPolicyAction;
|
|
1989
|
+
action?: GuardrailSensitiveInformationPolicyAction | undefined;
|
|
1768
1990
|
}
|
|
1769
1991
|
/**
|
|
1770
1992
|
* <p>The details for the regex filter used in the Guardrail.</p>
|
|
@@ -1775,22 +1997,22 @@ export interface GuardrailRegexFilter {
|
|
|
1775
1997
|
* <p>The name details for the regex filter used in the Guardrail.</p>
|
|
1776
1998
|
* @public
|
|
1777
1999
|
*/
|
|
1778
|
-
name?: string;
|
|
2000
|
+
name?: string | undefined;
|
|
1779
2001
|
/**
|
|
1780
2002
|
* <p>The regex details for the regex filter used in the Guardrail.</p>
|
|
1781
2003
|
* @public
|
|
1782
2004
|
*/
|
|
1783
|
-
regex?: string;
|
|
2005
|
+
regex?: string | undefined;
|
|
1784
2006
|
/**
|
|
1785
2007
|
* <p>The match details for the regex filter used in the Guardrail.</p>
|
|
1786
2008
|
* @public
|
|
1787
2009
|
*/
|
|
1788
|
-
match?: string;
|
|
2010
|
+
match?: string | undefined;
|
|
1789
2011
|
/**
|
|
1790
2012
|
* <p>The action details for the regex filter used in the Guardrail.</p>
|
|
1791
2013
|
* @public
|
|
1792
2014
|
*/
|
|
1793
|
-
action?: GuardrailSensitiveInformationPolicyAction;
|
|
2015
|
+
action?: GuardrailSensitiveInformationPolicyAction | undefined;
|
|
1794
2016
|
}
|
|
1795
2017
|
/**
|
|
1796
2018
|
* <p>The details of the sensitive policy assessment used in the Guardrail.</p>
|
|
@@ -1801,12 +2023,12 @@ export interface GuardrailSensitiveInformationPolicyAssessment {
|
|
|
1801
2023
|
* <p>The details of the PII entities used in the sensitive policy assessment for the Guardrail.</p>
|
|
1802
2024
|
* @public
|
|
1803
2025
|
*/
|
|
1804
|
-
piiEntities?: GuardrailPiiEntityFilter[];
|
|
2026
|
+
piiEntities?: GuardrailPiiEntityFilter[] | undefined;
|
|
1805
2027
|
/**
|
|
1806
2028
|
* <p>The details of the regexes used in the sensitive policy assessment for the Guardrail.</p>
|
|
1807
2029
|
* @public
|
|
1808
2030
|
*/
|
|
1809
|
-
regexes?: GuardrailRegexFilter[];
|
|
2031
|
+
regexes?: GuardrailRegexFilter[] | undefined;
|
|
1810
2032
|
}
|
|
1811
2033
|
/**
|
|
1812
2034
|
* @public
|
|
@@ -1839,17 +2061,17 @@ export interface GuardrailTopic {
|
|
|
1839
2061
|
* <p>The name details on a specific topic in the Guardrail.</p>
|
|
1840
2062
|
* @public
|
|
1841
2063
|
*/
|
|
1842
|
-
name?: string;
|
|
2064
|
+
name?: string | undefined;
|
|
1843
2065
|
/**
|
|
1844
2066
|
* <p>The type details on a specific topic in the Guardrail.</p>
|
|
1845
2067
|
* @public
|
|
1846
2068
|
*/
|
|
1847
|
-
type?: GuardrailTopicType;
|
|
2069
|
+
type?: GuardrailTopicType | undefined;
|
|
1848
2070
|
/**
|
|
1849
2071
|
* <p>The action details on a specific topic in the Guardrail.</p>
|
|
1850
2072
|
* @public
|
|
1851
2073
|
*/
|
|
1852
|
-
action?: GuardrailTopicPolicyAction;
|
|
2074
|
+
action?: GuardrailTopicPolicyAction | undefined;
|
|
1853
2075
|
}
|
|
1854
2076
|
/**
|
|
1855
2077
|
* <p>The details of the policy assessment used in the Guardrail.</p>
|
|
@@ -1860,7 +2082,7 @@ export interface GuardrailTopicPolicyAssessment {
|
|
|
1860
2082
|
* <p>The topic details of the policy assessment used in the Guardrail.</p>
|
|
1861
2083
|
* @public
|
|
1862
2084
|
*/
|
|
1863
|
-
topics?: GuardrailTopic[];
|
|
2085
|
+
topics?: GuardrailTopic[] | undefined;
|
|
1864
2086
|
}
|
|
1865
2087
|
/**
|
|
1866
2088
|
* @public
|
|
@@ -1882,12 +2104,12 @@ export interface GuardrailCustomWord {
|
|
|
1882
2104
|
* <p>The match details for the custom word filter in the Guardrail.</p>
|
|
1883
2105
|
* @public
|
|
1884
2106
|
*/
|
|
1885
|
-
match?: string;
|
|
2107
|
+
match?: string | undefined;
|
|
1886
2108
|
/**
|
|
1887
2109
|
* <p>The action details for the custom word filter in the Guardrail.</p>
|
|
1888
2110
|
* @public
|
|
1889
2111
|
*/
|
|
1890
|
-
action?: GuardrailWordPolicyAction;
|
|
2112
|
+
action?: GuardrailWordPolicyAction | undefined;
|
|
1891
2113
|
}
|
|
1892
2114
|
/**
|
|
1893
2115
|
* @public
|
|
@@ -1909,17 +2131,17 @@ export interface GuardrailManagedWord {
|
|
|
1909
2131
|
* <p>The match details for the managed word filter in the Guardrail.</p>
|
|
1910
2132
|
* @public
|
|
1911
2133
|
*/
|
|
1912
|
-
match?: string;
|
|
2134
|
+
match?: string | undefined;
|
|
1913
2135
|
/**
|
|
1914
2136
|
* <p>The type details for the managed word filter in the Guardrail.</p>
|
|
1915
2137
|
* @public
|
|
1916
2138
|
*/
|
|
1917
|
-
type?: GuardrailManagedWordType;
|
|
2139
|
+
type?: GuardrailManagedWordType | undefined;
|
|
1918
2140
|
/**
|
|
1919
2141
|
* <p>The action details for the managed word filter in the Guardrail.</p>
|
|
1920
2142
|
* @public
|
|
1921
2143
|
*/
|
|
1922
|
-
action?: GuardrailWordPolicyAction;
|
|
2144
|
+
action?: GuardrailWordPolicyAction | undefined;
|
|
1923
2145
|
}
|
|
1924
2146
|
/**
|
|
1925
2147
|
* <p>The assessment details for words defined in the Guardrail filter.</p>
|
|
@@ -1930,12 +2152,12 @@ export interface GuardrailWordPolicyAssessment {
|
|
|
1930
2152
|
* <p>The custom word details for words defined in the Guardrail filter.</p>
|
|
1931
2153
|
* @public
|
|
1932
2154
|
*/
|
|
1933
|
-
customWords?: GuardrailCustomWord[];
|
|
2155
|
+
customWords?: GuardrailCustomWord[] | undefined;
|
|
1934
2156
|
/**
|
|
1935
2157
|
* <p>The managed word lists for words defined in the Guardrail filter.</p>
|
|
1936
2158
|
* @public
|
|
1937
2159
|
*/
|
|
1938
|
-
managedWordLists?: GuardrailManagedWord[];
|
|
2160
|
+
managedWordLists?: GuardrailManagedWord[] | undefined;
|
|
1939
2161
|
}
|
|
1940
2162
|
/**
|
|
1941
2163
|
* <p>Assessment details of the content analyzed by Guardrails.</p>
|
|
@@ -1946,22 +2168,22 @@ export interface GuardrailAssessment {
|
|
|
1946
2168
|
* <p>Topic policy details of the Guardrail.</p>
|
|
1947
2169
|
* @public
|
|
1948
2170
|
*/
|
|
1949
|
-
topicPolicy?: GuardrailTopicPolicyAssessment;
|
|
2171
|
+
topicPolicy?: GuardrailTopicPolicyAssessment | undefined;
|
|
1950
2172
|
/**
|
|
1951
2173
|
* <p>Content policy details of the Guardrail.</p>
|
|
1952
2174
|
* @public
|
|
1953
2175
|
*/
|
|
1954
|
-
contentPolicy?: GuardrailContentPolicyAssessment;
|
|
2176
|
+
contentPolicy?: GuardrailContentPolicyAssessment | undefined;
|
|
1955
2177
|
/**
|
|
1956
2178
|
* <p>Word policy details of the Guardrail.</p>
|
|
1957
2179
|
* @public
|
|
1958
2180
|
*/
|
|
1959
|
-
wordPolicy?: GuardrailWordPolicyAssessment;
|
|
2181
|
+
wordPolicy?: GuardrailWordPolicyAssessment | undefined;
|
|
1960
2182
|
/**
|
|
1961
2183
|
* <p>Sensitive Information policy details of Guardrail.</p>
|
|
1962
2184
|
* @public
|
|
1963
2185
|
*/
|
|
1964
|
-
sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment;
|
|
2186
|
+
sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment | undefined;
|
|
1965
2187
|
}
|
|
1966
2188
|
/**
|
|
1967
2189
|
* <p>The trace details used in the Guardrail.</p>
|
|
@@ -1972,22 +2194,22 @@ export interface GuardrailTrace {
|
|
|
1972
2194
|
* <p>The trace action details used with the Guardrail.</p>
|
|
1973
2195
|
* @public
|
|
1974
2196
|
*/
|
|
1975
|
-
action?: GuardrailAction;
|
|
2197
|
+
action?: GuardrailAction | undefined;
|
|
1976
2198
|
/**
|
|
1977
2199
|
* <p>The details of the trace Id used in the Guardrail Trace.</p>
|
|
1978
2200
|
* @public
|
|
1979
2201
|
*/
|
|
1980
|
-
traceId?: string;
|
|
2202
|
+
traceId?: string | undefined;
|
|
1981
2203
|
/**
|
|
1982
2204
|
* <p>The details of the input assessments used in the Guardrail Trace.</p>
|
|
1983
2205
|
* @public
|
|
1984
2206
|
*/
|
|
1985
|
-
inputAssessments?: GuardrailAssessment[];
|
|
2207
|
+
inputAssessments?: GuardrailAssessment[] | undefined;
|
|
1986
2208
|
/**
|
|
1987
2209
|
* <p>The details of the output assessments used in the Guardrail Trace.</p>
|
|
1988
2210
|
* @public
|
|
1989
2211
|
*/
|
|
1990
|
-
outputAssessments?: GuardrailAssessment[];
|
|
2212
|
+
outputAssessments?: GuardrailAssessment[] | undefined;
|
|
1991
2213
|
}
|
|
1992
2214
|
/**
|
|
1993
2215
|
* <p>Contains information about the code interpreter being invoked.</p>
|
|
@@ -1998,12 +2220,12 @@ export interface CodeInterpreterInvocationInput {
|
|
|
1998
2220
|
* <p>The code for the code interpreter to use.</p>
|
|
1999
2221
|
* @public
|
|
2000
2222
|
*/
|
|
2001
|
-
code?: string;
|
|
2223
|
+
code?: string | undefined;
|
|
2002
2224
|
/**
|
|
2003
2225
|
* <p>Files that are uploaded for code interpreter to use.</p>
|
|
2004
2226
|
* @public
|
|
2005
2227
|
*/
|
|
2006
|
-
files?: string[];
|
|
2228
|
+
files?: string[] | undefined;
|
|
2007
2229
|
}
|
|
2008
2230
|
/**
|
|
2009
2231
|
* @public
|
|
@@ -2028,12 +2250,12 @@ export interface KnowledgeBaseLookupInput {
|
|
|
2028
2250
|
* <p>The query made to the knowledge base.</p>
|
|
2029
2251
|
* @public
|
|
2030
2252
|
*/
|
|
2031
|
-
text?: string;
|
|
2253
|
+
text?: string | undefined;
|
|
2032
2254
|
/**
|
|
2033
2255
|
* <p>The unique identifier of the knowledge base to look up.</p>
|
|
2034
2256
|
* @public
|
|
2035
2257
|
*/
|
|
2036
|
-
knowledgeBaseId?: string;
|
|
2258
|
+
knowledgeBaseId?: string | undefined;
|
|
2037
2259
|
}
|
|
2038
2260
|
/**
|
|
2039
2261
|
* <p>Contains information pertaining to the action group or knowledge base that is being invoked.</p>
|
|
@@ -2044,27 +2266,27 @@ export interface InvocationInput {
|
|
|
2044
2266
|
* <p>The unique identifier of the trace.</p>
|
|
2045
2267
|
* @public
|
|
2046
2268
|
*/
|
|
2047
|
-
traceId?: string;
|
|
2269
|
+
traceId?: string | undefined;
|
|
2048
2270
|
/**
|
|
2049
2271
|
* <p>Specifies whether the agent is invoking an action group or a knowledge base.</p>
|
|
2050
2272
|
* @public
|
|
2051
2273
|
*/
|
|
2052
|
-
invocationType?: InvocationType;
|
|
2274
|
+
invocationType?: InvocationType | undefined;
|
|
2053
2275
|
/**
|
|
2054
2276
|
* <p>Contains information about the action group to be invoked.</p>
|
|
2055
2277
|
* @public
|
|
2056
2278
|
*/
|
|
2057
|
-
actionGroupInvocationInput?: ActionGroupInvocationInput;
|
|
2279
|
+
actionGroupInvocationInput?: ActionGroupInvocationInput | undefined;
|
|
2058
2280
|
/**
|
|
2059
2281
|
* <p>Contains details about the knowledge base to look up and the query to be made.</p>
|
|
2060
2282
|
* @public
|
|
2061
2283
|
*/
|
|
2062
|
-
knowledgeBaseLookupInput?: KnowledgeBaseLookupInput;
|
|
2284
|
+
knowledgeBaseLookupInput?: KnowledgeBaseLookupInput | undefined;
|
|
2063
2285
|
/**
|
|
2064
2286
|
* <p>Contains information about the code interpreter to be invoked.</p>
|
|
2065
2287
|
* @public
|
|
2066
2288
|
*/
|
|
2067
|
-
codeInterpreterInvocationInput?: CodeInterpreterInvocationInput;
|
|
2289
|
+
codeInterpreterInvocationInput?: CodeInterpreterInvocationInput | undefined;
|
|
2068
2290
|
}
|
|
2069
2291
|
/**
|
|
2070
2292
|
* <p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
|
|
@@ -2075,27 +2297,27 @@ export interface InferenceConfiguration {
|
|
|
2075
2297
|
* <p>The likelihood of the model selecting higher-probability options while generating a response. A lower value makes the model more likely to choose higher-probability options, while a higher value makes the model more likely to choose lower-probability options.</p>
|
|
2076
2298
|
* @public
|
|
2077
2299
|
*/
|
|
2078
|
-
temperature?: number;
|
|
2300
|
+
temperature?: number | undefined;
|
|
2079
2301
|
/**
|
|
2080
2302
|
* <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>Top P</code> determines the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topP</code> to 0.8, the model only selects the next token from the top 80% of the probability distribution of next tokens.</p>
|
|
2081
2303
|
* @public
|
|
2082
2304
|
*/
|
|
2083
|
-
topP?: number;
|
|
2305
|
+
topP?: number | undefined;
|
|
2084
2306
|
/**
|
|
2085
2307
|
* <p>While generating a response, the model determines the probability of the following token at each point of generation. The value that you set for <code>topK</code> is the number of most-likely candidates from which the model chooses the next token in the sequence. For example, if you set <code>topK</code> to 50, the model selects the next token from among the top 50 most likely choices.</p>
|
|
2086
2308
|
* @public
|
|
2087
2309
|
*/
|
|
2088
|
-
topK?: number;
|
|
2310
|
+
topK?: number | undefined;
|
|
2089
2311
|
/**
|
|
2090
2312
|
* <p>The maximum number of tokens allowed in the generated response.</p>
|
|
2091
2313
|
* @public
|
|
2092
2314
|
*/
|
|
2093
|
-
maximumLength?: number;
|
|
2315
|
+
maximumLength?: number | undefined;
|
|
2094
2316
|
/**
|
|
2095
2317
|
* <p>A list of stop sequences. A stop sequence is a sequence of characters that causes the model to stop generating the response.</p>
|
|
2096
2318
|
* @public
|
|
2097
2319
|
*/
|
|
2098
|
-
stopSequences?: string[];
|
|
2320
|
+
stopSequences?: string[] | undefined;
|
|
2099
2321
|
}
|
|
2100
2322
|
/**
|
|
2101
2323
|
* @public
|
|
@@ -2143,37 +2365,37 @@ export interface ModelInvocationInput {
|
|
|
2143
2365
|
* <p>The unique identifier of the trace.</p>
|
|
2144
2366
|
* @public
|
|
2145
2367
|
*/
|
|
2146
|
-
traceId?: string;
|
|
2368
|
+
traceId?: string | undefined;
|
|
2147
2369
|
/**
|
|
2148
2370
|
* <p>The text that prompted the agent at this step.</p>
|
|
2149
2371
|
* @public
|
|
2150
2372
|
*/
|
|
2151
|
-
text?: string;
|
|
2373
|
+
text?: string | undefined;
|
|
2152
2374
|
/**
|
|
2153
2375
|
* <p>The step in the agent sequence.</p>
|
|
2154
2376
|
* @public
|
|
2155
2377
|
*/
|
|
2156
|
-
type?: PromptType;
|
|
2378
|
+
type?: PromptType | undefined;
|
|
2157
2379
|
/**
|
|
2158
|
-
* <p>
|
|
2380
|
+
* <p>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.</p>
|
|
2159
2381
|
* @public
|
|
2160
2382
|
*/
|
|
2161
|
-
|
|
2383
|
+
overrideLambda?: string | undefined;
|
|
2162
2384
|
/**
|
|
2163
|
-
* <p>
|
|
2385
|
+
* <p>Specifies whether the default prompt template was <code>OVERRIDDEN</code>. If it was, the <code>basePromptTemplate</code> that was set in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object when the agent was created or updated is used instead.</p>
|
|
2164
2386
|
* @public
|
|
2165
2387
|
*/
|
|
2166
|
-
|
|
2388
|
+
promptCreationMode?: CreationMode | undefined;
|
|
2167
2389
|
/**
|
|
2168
|
-
* <p>
|
|
2390
|
+
* <p>Specifications about the inference parameters that were provided alongside the prompt. These are specified in the <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html">PromptOverrideConfiguration</a> object that was set when the agent was created or updated. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html">Inference parameters for foundation models</a>.</p>
|
|
2169
2391
|
* @public
|
|
2170
2392
|
*/
|
|
2171
|
-
|
|
2393
|
+
inferenceConfiguration?: InferenceConfiguration | undefined;
|
|
2172
2394
|
/**
|
|
2173
2395
|
* <p>Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the <code>promptType</code>.</p>
|
|
2174
2396
|
* @public
|
|
2175
2397
|
*/
|
|
2176
|
-
parserMode?: CreationMode;
|
|
2398
|
+
parserMode?: CreationMode | undefined;
|
|
2177
2399
|
}
|
|
2178
2400
|
/**
|
|
2179
2401
|
* <p>Contains information of the usage of the foundation model.</p>
|
|
@@ -2184,12 +2406,12 @@ export interface Usage {
|
|
|
2184
2406
|
* <p>Contains information about the input tokens from the foundation model usage.</p>
|
|
2185
2407
|
* @public
|
|
2186
2408
|
*/
|
|
2187
|
-
inputTokens?: number;
|
|
2409
|
+
inputTokens?: number | undefined;
|
|
2188
2410
|
/**
|
|
2189
2411
|
* <p>Contains information about the output tokens from the foundation model usage.</p>
|
|
2190
2412
|
* @public
|
|
2191
2413
|
*/
|
|
2192
|
-
outputTokens?: number;
|
|
2414
|
+
outputTokens?: number | undefined;
|
|
2193
2415
|
}
|
|
2194
2416
|
/**
|
|
2195
2417
|
* <p>Provides details of the foundation model.</p>
|
|
@@ -2200,7 +2422,7 @@ export interface Metadata {
|
|
|
2200
2422
|
* <p>Contains details of the foundation model usage.</p>
|
|
2201
2423
|
* @public
|
|
2202
2424
|
*/
|
|
2203
|
-
usage?: Usage;
|
|
2425
|
+
usage?: Usage | undefined;
|
|
2204
2426
|
}
|
|
2205
2427
|
/**
|
|
2206
2428
|
* <p>Contains the raw output from the foundation model.</p>
|
|
@@ -2211,7 +2433,7 @@ export interface RawResponse {
|
|
|
2211
2433
|
* <p>The foundation model's raw output content.</p>
|
|
2212
2434
|
* @public
|
|
2213
2435
|
*/
|
|
2214
|
-
content?: string;
|
|
2436
|
+
content?: string | undefined;
|
|
2215
2437
|
}
|
|
2216
2438
|
/**
|
|
2217
2439
|
* <p>The foundation model output from the orchestration step.</p>
|
|
@@ -2222,17 +2444,17 @@ export interface OrchestrationModelInvocationOutput {
|
|
|
2222
2444
|
* <p>The unique identifier of the trace.</p>
|
|
2223
2445
|
* @public
|
|
2224
2446
|
*/
|
|
2225
|
-
traceId?: string;
|
|
2447
|
+
traceId?: string | undefined;
|
|
2226
2448
|
/**
|
|
2227
2449
|
* <p>Contains details of the raw response from the foundation model output.</p>
|
|
2228
2450
|
* @public
|
|
2229
2451
|
*/
|
|
2230
|
-
rawResponse?: RawResponse;
|
|
2452
|
+
rawResponse?: RawResponse | undefined;
|
|
2231
2453
|
/**
|
|
2232
2454
|
* <p>Contains information about the foundation model output from the orchestration step.</p>
|
|
2233
2455
|
* @public
|
|
2234
2456
|
*/
|
|
2235
|
-
metadata?: Metadata;
|
|
2457
|
+
metadata?: Metadata | undefined;
|
|
2236
2458
|
}
|
|
2237
2459
|
/**
|
|
2238
2460
|
* <p>Contains the JSON-formatted string returned by the API invoked by the code interpreter.</p>
|
|
@@ -2243,22 +2465,22 @@ export interface CodeInterpreterInvocationOutput {
|
|
|
2243
2465
|
* <p>Contains the successful output returned from code execution</p>
|
|
2244
2466
|
* @public
|
|
2245
2467
|
*/
|
|
2246
|
-
executionOutput?: string;
|
|
2468
|
+
executionOutput?: string | undefined;
|
|
2247
2469
|
/**
|
|
2248
2470
|
* <p>Contains the error returned from code execution.</p>
|
|
2249
2471
|
* @public
|
|
2250
2472
|
*/
|
|
2251
|
-
executionError?: string;
|
|
2473
|
+
executionError?: string | undefined;
|
|
2252
2474
|
/**
|
|
2253
2475
|
* <p>Contains output files, if generated by code execution.</p>
|
|
2254
2476
|
* @public
|
|
2255
2477
|
*/
|
|
2256
|
-
files?: string[];
|
|
2478
|
+
files?: string[] | undefined;
|
|
2257
2479
|
/**
|
|
2258
2480
|
* <p>Indicates if the execution of the code timed out.</p>
|
|
2259
2481
|
* @public
|
|
2260
2482
|
*/
|
|
2261
|
-
executionTimeout?: boolean;
|
|
2483
|
+
executionTimeout?: boolean | undefined;
|
|
2262
2484
|
}
|
|
2263
2485
|
/**
|
|
2264
2486
|
* <p>Contains details about the response to the user.</p>
|
|
@@ -2269,7 +2491,7 @@ export interface FinalResponse {
|
|
|
2269
2491
|
* <p>The text in the response to the user.</p>
|
|
2270
2492
|
* @public
|
|
2271
2493
|
*/
|
|
2272
|
-
text?: string;
|
|
2494
|
+
text?: string | undefined;
|
|
2273
2495
|
}
|
|
2274
2496
|
/**
|
|
2275
2497
|
* <p>Contains details about the results from looking up the knowledge base.</p>
|
|
@@ -2280,7 +2502,7 @@ export interface KnowledgeBaseLookupOutput {
|
|
|
2280
2502
|
* <p>Contains metadata about the sources cited for the generated response.</p>
|
|
2281
2503
|
* @public
|
|
2282
2504
|
*/
|
|
2283
|
-
retrievedReferences?: RetrievedReference[];
|
|
2505
|
+
retrievedReferences?: RetrievedReference[] | undefined;
|
|
2284
2506
|
}
|
|
2285
2507
|
/**
|
|
2286
2508
|
* @public
|
|
@@ -2304,12 +2526,12 @@ export interface RepromptResponse {
|
|
|
2304
2526
|
* <p>The text reprompting the input.</p>
|
|
2305
2527
|
* @public
|
|
2306
2528
|
*/
|
|
2307
|
-
text?: string;
|
|
2529
|
+
text?: string | undefined;
|
|
2308
2530
|
/**
|
|
2309
2531
|
* <p>Specifies what output is prompting the agent to reprompt the input.</p>
|
|
2310
2532
|
* @public
|
|
2311
2533
|
*/
|
|
2312
|
-
source?: Source;
|
|
2534
|
+
source?: Source | undefined;
|
|
2313
2535
|
}
|
|
2314
2536
|
/**
|
|
2315
2537
|
* @public
|
|
@@ -2335,7 +2557,7 @@ export interface Observation {
|
|
|
2335
2557
|
* <p>The unique identifier of the trace.</p>
|
|
2336
2558
|
* @public
|
|
2337
2559
|
*/
|
|
2338
|
-
traceId?: string;
|
|
2560
|
+
traceId?: string | undefined;
|
|
2339
2561
|
/**
|
|
2340
2562
|
* <p>Specifies what kind of information the agent returns in the observation. The following values are possible.</p>
|
|
2341
2563
|
* <ul>
|
|
@@ -2362,32 +2584,32 @@ export interface Observation {
|
|
|
2362
2584
|
* </ul>
|
|
2363
2585
|
* @public
|
|
2364
2586
|
*/
|
|
2365
|
-
type?: Type;
|
|
2587
|
+
type?: Type | undefined;
|
|
2366
2588
|
/**
|
|
2367
2589
|
* <p>Contains the JSON-formatted string returned by the API invoked by the action group.</p>
|
|
2368
2590
|
* @public
|
|
2369
2591
|
*/
|
|
2370
|
-
actionGroupInvocationOutput?: ActionGroupInvocationOutput;
|
|
2592
|
+
actionGroupInvocationOutput?: ActionGroupInvocationOutput | undefined;
|
|
2371
2593
|
/**
|
|
2372
2594
|
* <p>Contains details about the results from looking up the knowledge base.</p>
|
|
2373
2595
|
* @public
|
|
2374
2596
|
*/
|
|
2375
|
-
knowledgeBaseLookupOutput?: KnowledgeBaseLookupOutput;
|
|
2597
|
+
knowledgeBaseLookupOutput?: KnowledgeBaseLookupOutput | undefined;
|
|
2376
2598
|
/**
|
|
2377
2599
|
* <p>Contains details about the response to the user.</p>
|
|
2378
2600
|
* @public
|
|
2379
2601
|
*/
|
|
2380
|
-
finalResponse?: FinalResponse;
|
|
2602
|
+
finalResponse?: FinalResponse | undefined;
|
|
2381
2603
|
/**
|
|
2382
2604
|
* <p>Contains details about the response to reprompt the input.</p>
|
|
2383
2605
|
* @public
|
|
2384
2606
|
*/
|
|
2385
|
-
repromptResponse?: RepromptResponse;
|
|
2607
|
+
repromptResponse?: RepromptResponse | undefined;
|
|
2386
2608
|
/**
|
|
2387
2609
|
* <p>Contains the JSON-formatted string returned by the API invoked by the code interpreter.</p>
|
|
2388
2610
|
* @public
|
|
2389
2611
|
*/
|
|
2390
|
-
codeInterpreterInvocationOutput?: CodeInterpreterInvocationOutput;
|
|
2612
|
+
codeInterpreterInvocationOutput?: CodeInterpreterInvocationOutput | undefined;
|
|
2391
2613
|
}
|
|
2392
2614
|
/**
|
|
2393
2615
|
* <p>Contains the reasoning, based on the input, that the agent uses to justify carrying out an action group or getting information from a knowledge base.</p>
|
|
@@ -2398,12 +2620,12 @@ export interface Rationale {
|
|
|
2398
2620
|
* <p>The unique identifier of the trace step.</p>
|
|
2399
2621
|
* @public
|
|
2400
2622
|
*/
|
|
2401
|
-
traceId?: string;
|
|
2623
|
+
traceId?: string | undefined;
|
|
2402
2624
|
/**
|
|
2403
2625
|
* <p>The reasoning or thought process of the agent, based on the input.</p>
|
|
2404
2626
|
* @public
|
|
2405
2627
|
*/
|
|
2406
|
-
text?: string;
|
|
2628
|
+
text?: string | undefined;
|
|
2407
2629
|
}
|
|
2408
2630
|
/**
|
|
2409
2631
|
* <p>Details about the orchestration step, in which the agent determines the order in which actions are executed and which knowledge bases are retrieved.</p>
|
|
@@ -2515,7 +2737,7 @@ export interface PostProcessingParsedResponse {
|
|
|
2515
2737
|
* <p>The text returned by the parser.</p>
|
|
2516
2738
|
* @public
|
|
2517
2739
|
*/
|
|
2518
|
-
text?: string;
|
|
2740
|
+
text?: string | undefined;
|
|
2519
2741
|
}
|
|
2520
2742
|
/**
|
|
2521
2743
|
* <p>The foundation model output from the post-processing step.</p>
|
|
@@ -2526,26 +2748,26 @@ export interface PostProcessingModelInvocationOutput {
|
|
|
2526
2748
|
* <p>The unique identifier of the trace.</p>
|
|
2527
2749
|
* @public
|
|
2528
2750
|
*/
|
|
2529
|
-
traceId?: string;
|
|
2751
|
+
traceId?: string | undefined;
|
|
2530
2752
|
/**
|
|
2531
2753
|
* <p>Details about the response from the Lambda parsing of the output of the post-processing step.</p>
|
|
2532
2754
|
* @public
|
|
2533
2755
|
*/
|
|
2534
|
-
parsedResponse?: PostProcessingParsedResponse;
|
|
2756
|
+
parsedResponse?: PostProcessingParsedResponse | undefined;
|
|
2535
2757
|
/**
|
|
2536
2758
|
* <p>
|
|
2537
2759
|
* Details of the raw response from the foundation model output.
|
|
2538
2760
|
* </p>
|
|
2539
2761
|
* @public
|
|
2540
2762
|
*/
|
|
2541
|
-
rawResponse?: RawResponse;
|
|
2763
|
+
rawResponse?: RawResponse | undefined;
|
|
2542
2764
|
/**
|
|
2543
2765
|
* <p>
|
|
2544
2766
|
* Contains information about the foundation model output from the post-processing step.
|
|
2545
2767
|
* </p>
|
|
2546
2768
|
* @public
|
|
2547
2769
|
*/
|
|
2548
|
-
metadata?: Metadata;
|
|
2770
|
+
metadata?: Metadata | undefined;
|
|
2549
2771
|
}
|
|
2550
2772
|
/**
|
|
2551
2773
|
* <p>Details about the post-processing step, in which the agent shapes the response.</p>
|
|
@@ -2609,12 +2831,12 @@ export interface PreProcessingParsedResponse {
|
|
|
2609
2831
|
* <p>The text returned by the parsing of the pre-processing step, explaining the steps that the agent plans to take in orchestration, if the user input is valid.</p>
|
|
2610
2832
|
* @public
|
|
2611
2833
|
*/
|
|
2612
|
-
rationale?: string;
|
|
2834
|
+
rationale?: string | undefined;
|
|
2613
2835
|
/**
|
|
2614
2836
|
* <p>Whether the user input is valid or not. If <code>false</code>, the agent doesn't proceed to orchestration.</p>
|
|
2615
2837
|
* @public
|
|
2616
2838
|
*/
|
|
2617
|
-
isValid?: boolean;
|
|
2839
|
+
isValid?: boolean | undefined;
|
|
2618
2840
|
}
|
|
2619
2841
|
/**
|
|
2620
2842
|
* <p>The foundation model output from the pre-processing step.</p>
|
|
@@ -2625,26 +2847,26 @@ export interface PreProcessingModelInvocationOutput {
|
|
|
2625
2847
|
* <p>The unique identifier of the trace.</p>
|
|
2626
2848
|
* @public
|
|
2627
2849
|
*/
|
|
2628
|
-
traceId?: string;
|
|
2850
|
+
traceId?: string | undefined;
|
|
2629
2851
|
/**
|
|
2630
2852
|
* <p>Details about the response from the Lambda parsing of the output of the pre-processing step.</p>
|
|
2631
2853
|
* @public
|
|
2632
2854
|
*/
|
|
2633
|
-
parsedResponse?: PreProcessingParsedResponse;
|
|
2855
|
+
parsedResponse?: PreProcessingParsedResponse | undefined;
|
|
2634
2856
|
/**
|
|
2635
2857
|
* <p>
|
|
2636
2858
|
* Details of the raw response from the foundation model output.
|
|
2637
2859
|
* </p>
|
|
2638
2860
|
* @public
|
|
2639
2861
|
*/
|
|
2640
|
-
rawResponse?: RawResponse;
|
|
2862
|
+
rawResponse?: RawResponse | undefined;
|
|
2641
2863
|
/**
|
|
2642
2864
|
* <p>
|
|
2643
2865
|
* Contains information about the foundation model output from the pre-processing step.
|
|
2644
2866
|
* </p>
|
|
2645
2867
|
* @public
|
|
2646
2868
|
*/
|
|
2647
|
-
metadata?: Metadata;
|
|
2869
|
+
metadata?: Metadata | undefined;
|
|
2648
2870
|
}
|
|
2649
2871
|
/**
|
|
2650
2872
|
* <p>Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.</p>
|
|
@@ -2798,27 +3020,27 @@ export interface TracePart {
|
|
|
2798
3020
|
* <p>The unique identifier of the agent.</p>
|
|
2799
3021
|
* @public
|
|
2800
3022
|
*/
|
|
2801
|
-
agentId?: string;
|
|
3023
|
+
agentId?: string | undefined;
|
|
2802
3024
|
/**
|
|
2803
3025
|
* <p>The unique identifier of the alias of the agent.</p>
|
|
2804
3026
|
* @public
|
|
2805
3027
|
*/
|
|
2806
|
-
agentAliasId?: string;
|
|
3028
|
+
agentAliasId?: string | undefined;
|
|
2807
3029
|
/**
|
|
2808
3030
|
* <p>The unique identifier of the session with the agent.</p>
|
|
2809
3031
|
* @public
|
|
2810
3032
|
*/
|
|
2811
|
-
sessionId?: string;
|
|
3033
|
+
sessionId?: string | undefined;
|
|
2812
3034
|
/**
|
|
2813
3035
|
* <p>The version of the agent.</p>
|
|
2814
3036
|
* @public
|
|
2815
3037
|
*/
|
|
2816
|
-
agentVersion?: string;
|
|
3038
|
+
agentVersion?: string | undefined;
|
|
2817
3039
|
/**
|
|
2818
3040
|
* <p>Contains one part of the agent's reasoning process and results from calling API actions and querying knowledge bases. You can use the trace to understand how the agent arrived at the response it provided the customer. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-enablement">Trace enablement</a>.</p>
|
|
2819
3041
|
* @public
|
|
2820
3042
|
*/
|
|
2821
|
-
trace?: Trace;
|
|
3043
|
+
trace?: Trace | undefined;
|
|
2822
3044
|
}
|
|
2823
3045
|
/**
|
|
2824
3046
|
* <p>The response from invoking the agent and associated citations and trace information.</p>
|
|
@@ -3149,7 +3371,7 @@ export interface InvokeAgentResponse {
|
|
|
3149
3371
|
* <p>The unique identifier of the agent memory.</p>
|
|
3150
3372
|
* @public
|
|
3151
3373
|
*/
|
|
3152
|
-
memoryId?: string;
|
|
3374
|
+
memoryId?: string | undefined;
|
|
3153
3375
|
}
|
|
3154
3376
|
/**
|
|
3155
3377
|
* @public
|
|
@@ -3169,7 +3391,7 @@ export interface DeleteAgentMemoryRequest {
|
|
|
3169
3391
|
* <p>The unique identifier of the memory.</p>
|
|
3170
3392
|
* @public
|
|
3171
3393
|
*/
|
|
3172
|
-
memoryId?: string;
|
|
3394
|
+
memoryId?: string | undefined;
|
|
3173
3395
|
}
|
|
3174
3396
|
/**
|
|
3175
3397
|
* @public
|
|
@@ -3196,14 +3418,14 @@ export interface GetAgentMemoryRequest {
|
|
|
3196
3418
|
* in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
3197
3419
|
* @public
|
|
3198
3420
|
*/
|
|
3199
|
-
nextToken?: string;
|
|
3421
|
+
nextToken?: string | undefined;
|
|
3200
3422
|
/**
|
|
3201
3423
|
* <p>The maximum number of items to return in the response. If the total number of results is greater
|
|
3202
3424
|
* than this value, use the token returned in the response in the <code>nextToken</code> field when making another
|
|
3203
3425
|
* request to return the next batch of results.</p>
|
|
3204
3426
|
* @public
|
|
3205
3427
|
*/
|
|
3206
|
-
maxItems?: number;
|
|
3428
|
+
maxItems?: number | undefined;
|
|
3207
3429
|
/**
|
|
3208
3430
|
* <p>The unique identifier of the agent to which the alias belongs.</p>
|
|
3209
3431
|
* @public
|
|
@@ -3234,27 +3456,27 @@ export interface MemorySessionSummary {
|
|
|
3234
3456
|
* <p>The unique identifier of the memory where the session summary is stored.</p>
|
|
3235
3457
|
* @public
|
|
3236
3458
|
*/
|
|
3237
|
-
memoryId?: string;
|
|
3459
|
+
memoryId?: string | undefined;
|
|
3238
3460
|
/**
|
|
3239
3461
|
* <p>The identifier for this session.</p>
|
|
3240
3462
|
* @public
|
|
3241
3463
|
*/
|
|
3242
|
-
sessionId?: string;
|
|
3464
|
+
sessionId?: string | undefined;
|
|
3243
3465
|
/**
|
|
3244
3466
|
* <p>The start time for this session.</p>
|
|
3245
3467
|
* @public
|
|
3246
3468
|
*/
|
|
3247
|
-
sessionStartTime?: Date;
|
|
3469
|
+
sessionStartTime?: Date | undefined;
|
|
3248
3470
|
/**
|
|
3249
3471
|
* <p>The time when the memory duration for the session is set to end.</p>
|
|
3250
3472
|
* @public
|
|
3251
3473
|
*/
|
|
3252
|
-
sessionExpiryTime?: Date;
|
|
3474
|
+
sessionExpiryTime?: Date | undefined;
|
|
3253
3475
|
/**
|
|
3254
3476
|
* <p>The summarized text for this session.</p>
|
|
3255
3477
|
* @public
|
|
3256
3478
|
*/
|
|
3257
|
-
summaryText?: string;
|
|
3479
|
+
summaryText?: string | undefined;
|
|
3258
3480
|
}
|
|
3259
3481
|
/**
|
|
3260
3482
|
* <p>Contains sessions summaries.</p>
|
|
@@ -3295,12 +3517,12 @@ export interface GetAgentMemoryResponse {
|
|
|
3295
3517
|
* when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
3296
3518
|
* @public
|
|
3297
3519
|
*/
|
|
3298
|
-
nextToken?: string;
|
|
3520
|
+
nextToken?: string | undefined;
|
|
3299
3521
|
/**
|
|
3300
3522
|
* <p>Contains details of the sessions stored in the memory</p>
|
|
3301
3523
|
* @public
|
|
3302
3524
|
*/
|
|
3303
|
-
memoryContents?: Memory[];
|
|
3525
|
+
memoryContents?: Memory[] | undefined;
|
|
3304
3526
|
}
|
|
3305
3527
|
/**
|
|
3306
3528
|
* <p>Contains the query made to the knowledge base.</p>
|
|
@@ -3353,19 +3575,19 @@ export interface TextInferenceConfig {
|
|
|
3353
3575
|
* <p> Controls the random-ness of text generated by the language model, influencing how much the model sticks to the most predictable next words versus exploring more surprising options. A lower temperature value (e.g. 0.2 or 0.3) makes model outputs more deterministic or predictable, while a higher temperature (e.g. 0.8 or 0.9) makes the outputs more creative or unpredictable. </p>
|
|
3354
3576
|
* @public
|
|
3355
3577
|
*/
|
|
3356
|
-
temperature?: number;
|
|
3578
|
+
temperature?: number | undefined;
|
|
3357
3579
|
/**
|
|
3358
3580
|
* <p> A probability distribution threshold which controls what the model considers for the set of possible next tokens. The model will only consider the top p% of the probability distribution when generating the next token. </p>
|
|
3359
3581
|
* @public
|
|
3360
3582
|
*/
|
|
3361
|
-
topP?: number;
|
|
3583
|
+
topP?: number | undefined;
|
|
3362
3584
|
/**
|
|
3363
3585
|
* <p>The maximum number of tokens to generate in the output text. Do not use the minimum of 0
|
|
3364
3586
|
* or the maximum of 65536. The limit values described here are arbitary values, for actual
|
|
3365
3587
|
* values consult the limits defined by your specific model.</p>
|
|
3366
3588
|
* @public
|
|
3367
3589
|
*/
|
|
3368
|
-
maxTokens?: number;
|
|
3590
|
+
maxTokens?: number | undefined;
|
|
3369
3591
|
/**
|
|
3370
3592
|
* <p>A list of sequences of characters that, if generated, will cause the model to stop
|
|
3371
3593
|
* generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The
|
|
@@ -3373,7 +3595,7 @@ export interface TextInferenceConfig {
|
|
|
3373
3595
|
* by your specific model.</p>
|
|
3374
3596
|
* @public
|
|
3375
3597
|
*/
|
|
3376
|
-
stopSequences?: string[];
|
|
3598
|
+
stopSequences?: string[] | undefined;
|
|
3377
3599
|
}
|
|
3378
3600
|
/**
|
|
3379
3601
|
* <p> The configuration for inference settings when generating responses using RetrieveAndGenerate. </p>
|
|
@@ -3384,7 +3606,7 @@ export interface InferenceConfig {
|
|
|
3384
3606
|
* <p> Configuration settings specific to text generation while generating responses using RetrieveAndGenerate. </p>
|
|
3385
3607
|
* @public
|
|
3386
3608
|
*/
|
|
3387
|
-
textInferenceConfig?: TextInferenceConfig;
|
|
3609
|
+
textInferenceConfig?: TextInferenceConfig | undefined;
|
|
3388
3610
|
}
|
|
3389
3611
|
/**
|
|
3390
3612
|
* <p>Contains the template for the prompt that's sent to the model for response generation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html#kb-test-config-sysprompt">Knowledge base prompt templates</a>.</p>
|
|
@@ -3415,7 +3637,7 @@ export interface PromptTemplate {
|
|
|
3415
3637
|
* </ul>
|
|
3416
3638
|
* @public
|
|
3417
3639
|
*/
|
|
3418
|
-
textPromptTemplate?: string;
|
|
3640
|
+
textPromptTemplate?: string | undefined;
|
|
3419
3641
|
}
|
|
3420
3642
|
/**
|
|
3421
3643
|
* <p>Contains the generation configuration of the external source wrapper object.</p>
|
|
@@ -3426,22 +3648,22 @@ export interface ExternalSourcesGenerationConfiguration {
|
|
|
3426
3648
|
* <p>Contain the textPromptTemplate string for the external source wrapper object.</p>
|
|
3427
3649
|
* @public
|
|
3428
3650
|
*/
|
|
3429
|
-
promptTemplate?: PromptTemplate;
|
|
3651
|
+
promptTemplate?: PromptTemplate | undefined;
|
|
3430
3652
|
/**
|
|
3431
3653
|
* <p>The configuration details for the guardrail.</p>
|
|
3432
3654
|
* @public
|
|
3433
3655
|
*/
|
|
3434
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
3656
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
3435
3657
|
/**
|
|
3436
3658
|
* <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.</p>
|
|
3437
3659
|
* @public
|
|
3438
3660
|
*/
|
|
3439
|
-
inferenceConfig?: InferenceConfig;
|
|
3661
|
+
inferenceConfig?: InferenceConfig | undefined;
|
|
3440
3662
|
/**
|
|
3441
3663
|
* <p> Additional model parameters and their corresponding values not included in the textInferenceConfig structure for an external source. Takes in custom model parameters specific to the language model being used. </p>
|
|
3442
3664
|
* @public
|
|
3443
3665
|
*/
|
|
3444
|
-
additionalModelRequestFields?: Record<string, __DocumentType
|
|
3666
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
3445
3667
|
}
|
|
3446
3668
|
/**
|
|
3447
3669
|
* <p>This property contains the document to chat with, along with its attributes.</p>
|
|
@@ -3501,12 +3723,12 @@ export interface ExternalSource {
|
|
|
3501
3723
|
* <p>The S3 location of the external source wrapper object.</p>
|
|
3502
3724
|
* @public
|
|
3503
3725
|
*/
|
|
3504
|
-
s3Location?: S3ObjectDoc;
|
|
3726
|
+
s3Location?: S3ObjectDoc | undefined;
|
|
3505
3727
|
/**
|
|
3506
3728
|
* <p>The identifier, contentType, and data of the external source wrapper object.</p>
|
|
3507
3729
|
* @public
|
|
3508
3730
|
*/
|
|
3509
|
-
byteContent?: ByteContentDoc;
|
|
3731
|
+
byteContent?: ByteContentDoc | undefined;
|
|
3510
3732
|
}
|
|
3511
3733
|
/**
|
|
3512
3734
|
* <p>The configurations of the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
|
|
@@ -3527,7 +3749,7 @@ export interface ExternalSourcesRetrieveAndGenerateConfiguration {
|
|
|
3527
3749
|
* <p>The prompt used with the external source wrapper object with the <code>retrieveAndGenerate</code> function.</p>
|
|
3528
3750
|
* @public
|
|
3529
3751
|
*/
|
|
3530
|
-
generationConfiguration?: ExternalSourcesGenerationConfiguration;
|
|
3752
|
+
generationConfiguration?: ExternalSourcesGenerationConfiguration | undefined;
|
|
3531
3753
|
}
|
|
3532
3754
|
/**
|
|
3533
3755
|
* <p>Contains configurations for response generation based on the knowledge base query results.</p>
|
|
@@ -3543,25 +3765,25 @@ export interface ExternalSourcesRetrieveAndGenerateConfiguration {
|
|
|
3543
3765
|
*/
|
|
3544
3766
|
export interface GenerationConfiguration {
|
|
3545
3767
|
/**
|
|
3546
|
-
* <p>Contains the template for the prompt that's sent to the model for response generation.</p>
|
|
3768
|
+
* <p>Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the <code>$search_results$</code> variable. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Use placeholder variables</a> in the user guide.</p>
|
|
3547
3769
|
* @public
|
|
3548
3770
|
*/
|
|
3549
|
-
promptTemplate?: PromptTemplate;
|
|
3771
|
+
promptTemplate?: PromptTemplate | undefined;
|
|
3550
3772
|
/**
|
|
3551
3773
|
* <p>The configuration details for the guardrail.</p>
|
|
3552
3774
|
* @public
|
|
3553
3775
|
*/
|
|
3554
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
3776
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
3555
3777
|
/**
|
|
3556
3778
|
* <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>
|
|
3557
3779
|
* @public
|
|
3558
3780
|
*/
|
|
3559
|
-
inferenceConfig?: InferenceConfig;
|
|
3781
|
+
inferenceConfig?: InferenceConfig | undefined;
|
|
3560
3782
|
/**
|
|
3561
3783
|
* <p> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </p>
|
|
3562
3784
|
* @public
|
|
3563
3785
|
*/
|
|
3564
|
-
additionalModelRequestFields?: Record<string, __DocumentType
|
|
3786
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
3565
3787
|
}
|
|
3566
3788
|
/**
|
|
3567
3789
|
* @public
|
|
@@ -3592,26 +3814,26 @@ export interface QueryTransformationConfiguration {
|
|
|
3592
3814
|
*/
|
|
3593
3815
|
export interface OrchestrationConfiguration {
|
|
3594
3816
|
/**
|
|
3595
|
-
* <p>Contains the template for the prompt that's sent to the model
|
|
3817
|
+
* <p>Contains the template for the prompt that's sent to the model. Orchestration prompts must include the <code>$conversation_history$</code> and <code>$output_format_instructions$</code> variables. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Use placeholder variables</a> in the user guide.</p>
|
|
3596
3818
|
* @public
|
|
3597
3819
|
*/
|
|
3598
|
-
promptTemplate?: PromptTemplate;
|
|
3820
|
+
promptTemplate?: PromptTemplate | undefined;
|
|
3599
3821
|
/**
|
|
3600
3822
|
* <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>
|
|
3601
3823
|
* @public
|
|
3602
3824
|
*/
|
|
3603
|
-
inferenceConfig?: InferenceConfig;
|
|
3825
|
+
inferenceConfig?: InferenceConfig | undefined;
|
|
3604
3826
|
/**
|
|
3605
3827
|
* <p> Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used. </p>
|
|
3606
3828
|
* @public
|
|
3607
3829
|
*/
|
|
3608
|
-
additionalModelRequestFields?: Record<string, __DocumentType
|
|
3830
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
3609
3831
|
/**
|
|
3610
3832
|
* <p>To split up the prompt and retrieve multiple sources, set the transformation type to
|
|
3611
3833
|
* <code>QUERY_DECOMPOSITION</code>.</p>
|
|
3612
3834
|
* @public
|
|
3613
3835
|
*/
|
|
3614
|
-
queryTransformationConfiguration?: QueryTransformationConfiguration;
|
|
3836
|
+
queryTransformationConfiguration?: QueryTransformationConfiguration | undefined;
|
|
3615
3837
|
}
|
|
3616
3838
|
/**
|
|
3617
3839
|
* @public
|
|
@@ -3691,12 +3913,12 @@ export interface RetrieveAndGenerateResponse {
|
|
|
3691
3913
|
* <p>A list of segments of the generated response that are based on sources in the knowledge base, alongside information about the sources.</p>
|
|
3692
3914
|
* @public
|
|
3693
3915
|
*/
|
|
3694
|
-
citations?: Citation[];
|
|
3916
|
+
citations?: Citation[] | undefined;
|
|
3695
3917
|
/**
|
|
3696
3918
|
* <p>Specifies if there is a guardrail intervention in the response.</p>
|
|
3697
3919
|
* @public
|
|
3698
3920
|
*/
|
|
3699
|
-
guardrailAction?: GuadrailAction;
|
|
3921
|
+
guardrailAction?: GuadrailAction | undefined;
|
|
3700
3922
|
}
|
|
3701
3923
|
/**
|
|
3702
3924
|
* <p>Contains the query made to the knowledge base.</p>
|
|
@@ -3737,17 +3959,17 @@ export interface KnowledgeBaseRetrievalResult {
|
|
|
3737
3959
|
* <p>Contains information about the location of the data source.</p>
|
|
3738
3960
|
* @public
|
|
3739
3961
|
*/
|
|
3740
|
-
location?: RetrievalResultLocation;
|
|
3962
|
+
location?: RetrievalResultLocation | undefined;
|
|
3741
3963
|
/**
|
|
3742
3964
|
* <p>The level of relevance of the result to the query.</p>
|
|
3743
3965
|
* @public
|
|
3744
3966
|
*/
|
|
3745
|
-
score?: number;
|
|
3967
|
+
score?: number | undefined;
|
|
3746
3968
|
/**
|
|
3747
3969
|
* <p>Contains metadata attributes and their values for the file in the data source. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata">Metadata and filtering</a>.</p>
|
|
3748
3970
|
* @public
|
|
3749
3971
|
*/
|
|
3750
|
-
metadata?: Record<string, __DocumentType
|
|
3972
|
+
metadata?: Record<string, __DocumentType> | undefined;
|
|
3751
3973
|
}
|
|
3752
3974
|
/**
|
|
3753
3975
|
* @public
|
|
@@ -3762,7 +3984,7 @@ export interface RetrieveResponse {
|
|
|
3762
3984
|
* <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
|
|
3763
3985
|
* @public
|
|
3764
3986
|
*/
|
|
3765
|
-
nextToken?: string;
|
|
3987
|
+
nextToken?: string | undefined;
|
|
3766
3988
|
}
|
|
3767
3989
|
/**
|
|
3768
3990
|
* <p>Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>. See the examples below to see how to use these filters.</p>
|
|
@@ -4155,17 +4377,17 @@ export interface KnowledgeBaseVectorSearchConfiguration {
|
|
|
4155
4377
|
* <p>The number of source chunks to retrieve.</p>
|
|
4156
4378
|
* @public
|
|
4157
4379
|
*/
|
|
4158
|
-
numberOfResults?: number;
|
|
4380
|
+
numberOfResults?: number | undefined;
|
|
4159
4381
|
/**
|
|
4160
4382
|
* <p>By default, Amazon Bedrock decides a search strategy for you. If you're using an Amazon OpenSearch Serverless vector store that contains a filterable text field, you can specify whether to query the knowledge base with a <code>HYBRID</code> search using both vector embeddings and raw text, or <code>SEMANTIC</code> search using only vector embeddings. For other vector store configurations, only <code>SEMANTIC</code> search is available. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html">Test a knowledge base</a>.</p>
|
|
4161
4383
|
* @public
|
|
4162
4384
|
*/
|
|
4163
|
-
overrideSearchType?: SearchType;
|
|
4385
|
+
overrideSearchType?: SearchType | undefined;
|
|
4164
4386
|
/**
|
|
4165
4387
|
* <p>Specifies the filters to use on the metadata in the knowledge base data sources before returning results. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
4166
4388
|
* @public
|
|
4167
4389
|
*/
|
|
4168
|
-
filter?: RetrievalFilter;
|
|
4390
|
+
filter?: RetrievalFilter | undefined;
|
|
4169
4391
|
}
|
|
4170
4392
|
/**
|
|
4171
4393
|
* <p>Contains configurations for knowledge base query. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
@@ -4235,17 +4457,17 @@ export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
|
|
|
4235
4457
|
* <p>Contains configurations for how to retrieve and return the knowledge base query.</p>
|
|
4236
4458
|
* @public
|
|
4237
4459
|
*/
|
|
4238
|
-
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
|
|
4460
|
+
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
4239
4461
|
/**
|
|
4240
4462
|
* <p>Contains configurations for response generation based on the knowledge base query results.</p>
|
|
4241
4463
|
* @public
|
|
4242
4464
|
*/
|
|
4243
|
-
generationConfiguration?: GenerationConfiguration;
|
|
4465
|
+
generationConfiguration?: GenerationConfiguration | undefined;
|
|
4244
4466
|
/**
|
|
4245
4467
|
* <p>Settings for how the model processes the prompt prior to retrieval and generation.</p>
|
|
4246
4468
|
* @public
|
|
4247
4469
|
*/
|
|
4248
|
-
orchestrationConfiguration?: OrchestrationConfiguration;
|
|
4470
|
+
orchestrationConfiguration?: OrchestrationConfiguration | undefined;
|
|
4249
4471
|
}
|
|
4250
4472
|
/**
|
|
4251
4473
|
* @public
|
|
@@ -4265,12 +4487,12 @@ export interface RetrieveRequest {
|
|
|
4265
4487
|
* <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
4266
4488
|
* @public
|
|
4267
4489
|
*/
|
|
4268
|
-
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
|
|
4490
|
+
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
4269
4491
|
/**
|
|
4270
4492
|
* <p>If there are more results than can fit in the response, the response returns a <code>nextToken</code>. Use this token in the <code>nextToken</code> field of another request to retrieve the next batch of results.</p>
|
|
4271
4493
|
* @public
|
|
4272
4494
|
*/
|
|
4273
|
-
nextToken?: string;
|
|
4495
|
+
nextToken?: string | undefined;
|
|
4274
4496
|
}
|
|
4275
4497
|
/**
|
|
4276
4498
|
* <p>Contains details about the resource being queried.</p>
|
|
@@ -4294,12 +4516,12 @@ export interface RetrieveAndGenerateConfiguration {
|
|
|
4294
4516
|
* <p>Contains details about the knowledge base for retrieving information and generating responses.</p>
|
|
4295
4517
|
* @public
|
|
4296
4518
|
*/
|
|
4297
|
-
knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration;
|
|
4519
|
+
knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration | undefined;
|
|
4298
4520
|
/**
|
|
4299
4521
|
* <p>The configuration for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
|
|
4300
4522
|
* @public
|
|
4301
4523
|
*/
|
|
4302
|
-
externalSourcesConfiguration?: ExternalSourcesRetrieveAndGenerateConfiguration;
|
|
4524
|
+
externalSourcesConfiguration?: ExternalSourcesRetrieveAndGenerateConfiguration | undefined;
|
|
4303
4525
|
}
|
|
4304
4526
|
/**
|
|
4305
4527
|
* @public
|
|
@@ -4309,7 +4531,7 @@ export interface RetrieveAndGenerateRequest {
|
|
|
4309
4531
|
* <p>The unique identifier of the session. When you first make a <code>RetrieveAndGenerate</code> request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the <code>sessionId</code> yourself.</p>
|
|
4310
4532
|
* @public
|
|
4311
4533
|
*/
|
|
4312
|
-
sessionId?: string;
|
|
4534
|
+
sessionId?: string | undefined;
|
|
4313
4535
|
/**
|
|
4314
4536
|
* <p>Contains the query to be made to the knowledge base.</p>
|
|
4315
4537
|
* @public
|
|
@@ -4319,12 +4541,12 @@ export interface RetrieveAndGenerateRequest {
|
|
|
4319
4541
|
* <p>Contains configurations for the knowledge base query and retrieval process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html">Query configurations</a>.</p>
|
|
4320
4542
|
* @public
|
|
4321
4543
|
*/
|
|
4322
|
-
retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration;
|
|
4544
|
+
retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration | undefined;
|
|
4323
4545
|
/**
|
|
4324
4546
|
* <p>Contains details about the session with the knowledge base.</p>
|
|
4325
4547
|
* @public
|
|
4326
4548
|
*/
|
|
4327
|
-
sessionConfiguration?: RetrieveAndGenerateSessionConfiguration;
|
|
4549
|
+
sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
|
|
4328
4550
|
}
|
|
4329
4551
|
/**
|
|
4330
4552
|
* <p>Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html">Lambda function</a> for an action group or pass them when making an <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html">InvokeAgent</a> request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
@@ -4335,12 +4557,12 @@ export interface SessionState {
|
|
|
4335
4557
|
* <p>Contains attributes that persist across a session and the values of those attributes.</p>
|
|
4336
4558
|
* @public
|
|
4337
4559
|
*/
|
|
4338
|
-
sessionAttributes?: Record<string, string
|
|
4560
|
+
sessionAttributes?: Record<string, string> | undefined;
|
|
4339
4561
|
/**
|
|
4340
4562
|
* <p>Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html">Prompt template placeholder variables</a>.</p>
|
|
4341
4563
|
* @public
|
|
4342
4564
|
*/
|
|
4343
|
-
promptSessionAttributes?: Record<string, string
|
|
4565
|
+
promptSessionAttributes?: Record<string, string> | undefined;
|
|
4344
4566
|
/**
|
|
4345
4567
|
* <p>Contains information about the results from the action group invocation. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
4346
4568
|
* <note>
|
|
@@ -4348,22 +4570,22 @@ export interface SessionState {
|
|
|
4348
4570
|
* </note>
|
|
4349
4571
|
* @public
|
|
4350
4572
|
*/
|
|
4351
|
-
returnControlInvocationResults?: InvocationResultMember[];
|
|
4573
|
+
returnControlInvocationResults?: InvocationResultMember[] | undefined;
|
|
4352
4574
|
/**
|
|
4353
4575
|
* <p>The identifier of the invocation of an action. This value must match the <code>invocationId</code> returned in the <code>InvokeAgent</code> response for the action whose results are provided in the <code>returnControlInvocationResults</code> field. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html">Return control to the agent developer</a> and <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html">Control session context</a>.</p>
|
|
4354
4576
|
* @public
|
|
4355
4577
|
*/
|
|
4356
|
-
invocationId?: string;
|
|
4578
|
+
invocationId?: string | undefined;
|
|
4357
4579
|
/**
|
|
4358
4580
|
* <p>Contains information about the files used by code interpreter.</p>
|
|
4359
4581
|
* @public
|
|
4360
4582
|
*/
|
|
4361
|
-
files?: InputFile[];
|
|
4583
|
+
files?: InputFile[] | undefined;
|
|
4362
4584
|
/**
|
|
4363
4585
|
* <p>An array of configurations, each of which applies to a knowledge base attached to the agent.</p>
|
|
4364
4586
|
* @public
|
|
4365
4587
|
*/
|
|
4366
|
-
knowledgeBaseConfigurations?: KnowledgeBaseConfiguration[];
|
|
4588
|
+
knowledgeBaseConfigurations?: KnowledgeBaseConfiguration[] | undefined;
|
|
4367
4589
|
}
|
|
4368
4590
|
/**
|
|
4369
4591
|
* @public
|
|
@@ -4376,7 +4598,7 @@ export interface InvokeAgentRequest {
|
|
|
4376
4598
|
* </note>
|
|
4377
4599
|
* @public
|
|
4378
4600
|
*/
|
|
4379
|
-
sessionState?: SessionState;
|
|
4601
|
+
sessionState?: SessionState | undefined;
|
|
4380
4602
|
/**
|
|
4381
4603
|
* <p>The unique identifier of the agent to use.</p>
|
|
4382
4604
|
* @public
|
|
@@ -4396,12 +4618,12 @@ export interface InvokeAgentRequest {
|
|
|
4396
4618
|
* <p>Specifies whether to end the session with the agent or not.</p>
|
|
4397
4619
|
* @public
|
|
4398
4620
|
*/
|
|
4399
|
-
endSession?: boolean;
|
|
4621
|
+
endSession?: boolean | undefined;
|
|
4400
4622
|
/**
|
|
4401
4623
|
* <p>Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/agents-test.html#trace-events">Trace enablement</a>.</p>
|
|
4402
4624
|
* @public
|
|
4403
4625
|
*/
|
|
4404
|
-
enableTrace?: boolean;
|
|
4626
|
+
enableTrace?: boolean | undefined;
|
|
4405
4627
|
/**
|
|
4406
4628
|
* <p>The prompt text to send the agent.</p>
|
|
4407
4629
|
* <note>
|
|
@@ -4409,12 +4631,12 @@ export interface InvokeAgentRequest {
|
|
|
4409
4631
|
* </note>
|
|
4410
4632
|
* @public
|
|
4411
4633
|
*/
|
|
4412
|
-
inputText?: string;
|
|
4634
|
+
inputText?: string | undefined;
|
|
4413
4635
|
/**
|
|
4414
4636
|
* <p>The unique identifier of the agent memory.</p>
|
|
4415
4637
|
* @public
|
|
4416
4638
|
*/
|
|
4417
|
-
memoryId?: string;
|
|
4639
|
+
memoryId?: string | undefined;
|
|
4418
4640
|
}
|
|
4419
4641
|
/**
|
|
4420
4642
|
* @internal
|
|
@@ -4444,6 +4666,42 @@ export declare const FlowCompletionEventFilterSensitiveLog: (obj: FlowCompletion
|
|
|
4444
4666
|
* @internal
|
|
4445
4667
|
*/
|
|
4446
4668
|
export declare const FlowOutputEventFilterSensitiveLog: (obj: FlowOutputEvent) => any;
|
|
4669
|
+
/**
|
|
4670
|
+
* @internal
|
|
4671
|
+
*/
|
|
4672
|
+
export declare const FlowTraceConditionFilterSensitiveLog: (obj: FlowTraceCondition) => any;
|
|
4673
|
+
/**
|
|
4674
|
+
* @internal
|
|
4675
|
+
*/
|
|
4676
|
+
export declare const FlowTraceConditionNodeResultEventFilterSensitiveLog: (obj: FlowTraceConditionNodeResultEvent) => any;
|
|
4677
|
+
/**
|
|
4678
|
+
* @internal
|
|
4679
|
+
*/
|
|
4680
|
+
export declare const FlowTraceNodeInputContentFilterSensitiveLog: (obj: FlowTraceNodeInputContent) => any;
|
|
4681
|
+
/**
|
|
4682
|
+
* @internal
|
|
4683
|
+
*/
|
|
4684
|
+
export declare const FlowTraceNodeInputFieldFilterSensitiveLog: (obj: FlowTraceNodeInputField) => any;
|
|
4685
|
+
/**
|
|
4686
|
+
* @internal
|
|
4687
|
+
*/
|
|
4688
|
+
export declare const FlowTraceNodeInputEventFilterSensitiveLog: (obj: FlowTraceNodeInputEvent) => any;
|
|
4689
|
+
/**
|
|
4690
|
+
* @internal
|
|
4691
|
+
*/
|
|
4692
|
+
export declare const FlowTraceNodeOutputFieldFilterSensitiveLog: (obj: FlowTraceNodeOutputField) => any;
|
|
4693
|
+
/**
|
|
4694
|
+
* @internal
|
|
4695
|
+
*/
|
|
4696
|
+
export declare const FlowTraceNodeOutputEventFilterSensitiveLog: (obj: FlowTraceNodeOutputEvent) => any;
|
|
4697
|
+
/**
|
|
4698
|
+
* @internal
|
|
4699
|
+
*/
|
|
4700
|
+
export declare const FlowTraceFilterSensitiveLog: (obj: FlowTrace) => any;
|
|
4701
|
+
/**
|
|
4702
|
+
* @internal
|
|
4703
|
+
*/
|
|
4704
|
+
export declare const FlowTraceEventFilterSensitiveLog: (obj: FlowTraceEvent) => any;
|
|
4447
4705
|
/**
|
|
4448
4706
|
* @internal
|
|
4449
4707
|
*/
|