@aws-sdk/client-bedrock-agent-runtime 3.688.0 → 3.692.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-types/models/models_0.d.ts +231 -231
- package/dist-types/ts3.4/models/models_0.d.ts +241 -231
- package/package.json +38 -38
|
@@ -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
|
*/
|
|
@@ -259,7 +259,7 @@ export interface InvokeFlowRequest {
|
|
|
259
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
260
|
* @public
|
|
261
261
|
*/
|
|
262
|
-
enableTrace?: boolean;
|
|
262
|
+
enableTrace?: boolean | undefined;
|
|
263
263
|
}
|
|
264
264
|
/**
|
|
265
265
|
* @public
|
|
@@ -967,12 +967,12 @@ export interface FileSource {
|
|
|
967
967
|
* <p>The s3 location of the files to attach.</p>
|
|
968
968
|
* @public
|
|
969
969
|
*/
|
|
970
|
-
s3Location?: S3ObjectFile;
|
|
970
|
+
s3Location?: S3ObjectFile | undefined;
|
|
971
971
|
/**
|
|
972
972
|
* <p>The data and the text of the attached files.</p>
|
|
973
973
|
* @public
|
|
974
974
|
*/
|
|
975
|
-
byteContent?: ByteContentFile;
|
|
975
|
+
byteContent?: ByteContentFile | undefined;
|
|
976
976
|
}
|
|
977
977
|
/**
|
|
978
978
|
* @public
|
|
@@ -1071,7 +1071,7 @@ export interface ContentBody {
|
|
|
1071
1071
|
* <p>The body of the API response.</p>
|
|
1072
1072
|
* @public
|
|
1073
1073
|
*/
|
|
1074
|
-
body?: string;
|
|
1074
|
+
body?: string | undefined;
|
|
1075
1075
|
}
|
|
1076
1076
|
/**
|
|
1077
1077
|
* @public
|
|
@@ -1106,32 +1106,32 @@ export interface ApiResult {
|
|
|
1106
1106
|
* <p>The HTTP method for the API operation.</p>
|
|
1107
1107
|
* @public
|
|
1108
1108
|
*/
|
|
1109
|
-
httpMethod?: string;
|
|
1109
|
+
httpMethod?: string | undefined;
|
|
1110
1110
|
/**
|
|
1111
1111
|
* <p>The path to the API operation.</p>
|
|
1112
1112
|
* @public
|
|
1113
1113
|
*/
|
|
1114
|
-
apiPath?: string;
|
|
1114
|
+
apiPath?: string | undefined;
|
|
1115
1115
|
/**
|
|
1116
1116
|
* <p>Controls the API operations or functions to invoke based on the user confirmation.</p>
|
|
1117
1117
|
* @public
|
|
1118
1118
|
*/
|
|
1119
|
-
confirmationState?: ConfirmationState;
|
|
1119
|
+
confirmationState?: ConfirmationState | undefined;
|
|
1120
1120
|
/**
|
|
1121
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>
|
|
1122
1122
|
* @public
|
|
1123
1123
|
*/
|
|
1124
|
-
responseBody?: Record<string, ContentBody
|
|
1124
|
+
responseBody?: Record<string, ContentBody> | undefined;
|
|
1125
1125
|
/**
|
|
1126
1126
|
* <p>http status code from API execution response (for example: 200, 400, 500).</p>
|
|
1127
1127
|
* @public
|
|
1128
1128
|
*/
|
|
1129
|
-
httpStatusCode?: number;
|
|
1129
|
+
httpStatusCode?: number | undefined;
|
|
1130
1130
|
/**
|
|
1131
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>
|
|
1132
1132
|
* @public
|
|
1133
1133
|
*/
|
|
1134
|
-
responseState?: ResponseState;
|
|
1134
|
+
responseState?: ResponseState | undefined;
|
|
1135
1135
|
}
|
|
1136
1136
|
/**
|
|
1137
1137
|
* <p>Contains information about the function that was called from the action group and the response that was returned.</p>
|
|
@@ -1154,22 +1154,22 @@ export interface FunctionResult {
|
|
|
1154
1154
|
* <p>Contains the user confirmation information about the function that was called.</p>
|
|
1155
1155
|
* @public
|
|
1156
1156
|
*/
|
|
1157
|
-
confirmationState?: ConfirmationState;
|
|
1157
|
+
confirmationState?: ConfirmationState | undefined;
|
|
1158
1158
|
/**
|
|
1159
1159
|
* <p>The name of the function that was called.</p>
|
|
1160
1160
|
* @public
|
|
1161
1161
|
*/
|
|
1162
|
-
function?: string;
|
|
1162
|
+
function?: string | undefined;
|
|
1163
1163
|
/**
|
|
1164
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>
|
|
1165
1165
|
* @public
|
|
1166
1166
|
*/
|
|
1167
|
-
responseBody?: Record<string, ContentBody
|
|
1167
|
+
responseBody?: Record<string, ContentBody> | undefined;
|
|
1168
1168
|
/**
|
|
1169
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>
|
|
1170
1170
|
* @public
|
|
1171
1171
|
*/
|
|
1172
|
-
responseState?: ResponseState;
|
|
1172
|
+
responseState?: ResponseState | undefined;
|
|
1173
1173
|
}
|
|
1174
1174
|
/**
|
|
1175
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>
|
|
@@ -1241,12 +1241,12 @@ export interface Span {
|
|
|
1241
1241
|
* <p>Where the text with a citation starts in the generated output.</p>
|
|
1242
1242
|
* @public
|
|
1243
1243
|
*/
|
|
1244
|
-
start?: number;
|
|
1244
|
+
start?: number | undefined;
|
|
1245
1245
|
/**
|
|
1246
1246
|
* <p>Where the text with a citation ends in the generated output.</p>
|
|
1247
1247
|
* @public
|
|
1248
1248
|
*/
|
|
1249
|
-
end?: number;
|
|
1249
|
+
end?: number | undefined;
|
|
1250
1250
|
}
|
|
1251
1251
|
/**
|
|
1252
1252
|
* <p>Contains the part of the generated text that contains a citation, alongside where it begins and ends.</p>
|
|
@@ -1268,12 +1268,12 @@ export interface TextResponsePart {
|
|
|
1268
1268
|
* <p>The part of the generated text that contains a citation.</p>
|
|
1269
1269
|
* @public
|
|
1270
1270
|
*/
|
|
1271
|
-
text?: string;
|
|
1271
|
+
text?: string | undefined;
|
|
1272
1272
|
/**
|
|
1273
1273
|
* <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
|
|
1274
1274
|
* @public
|
|
1275
1275
|
*/
|
|
1276
|
-
span?: Span;
|
|
1276
|
+
span?: Span | undefined;
|
|
1277
1277
|
}
|
|
1278
1278
|
/**
|
|
1279
1279
|
* <p>Contains metadata about a part of the generated response that is accompanied by a citation.</p>
|
|
@@ -1295,7 +1295,7 @@ export interface GeneratedResponsePart {
|
|
|
1295
1295
|
* <p>Contains metadata about a textual part of the generated response that is accompanied by a citation.</p>
|
|
1296
1296
|
* @public
|
|
1297
1297
|
*/
|
|
1298
|
-
textResponsePart?: TextResponsePart;
|
|
1298
|
+
textResponsePart?: TextResponsePart | undefined;
|
|
1299
1299
|
}
|
|
1300
1300
|
/**
|
|
1301
1301
|
* <p>Contains the cited text from the data source.</p>
|
|
@@ -1332,7 +1332,7 @@ export interface RetrievalResultConfluenceLocation {
|
|
|
1332
1332
|
* <p>The Confluence host URL for the data source location.</p>
|
|
1333
1333
|
* @public
|
|
1334
1334
|
*/
|
|
1335
|
-
url?: string;
|
|
1335
|
+
url?: string | undefined;
|
|
1336
1336
|
}
|
|
1337
1337
|
/**
|
|
1338
1338
|
* <p>The S3 data source location.</p>
|
|
@@ -1358,7 +1358,7 @@ export interface RetrievalResultS3Location {
|
|
|
1358
1358
|
* <p>The S3 URI for the data source location.</p>
|
|
1359
1359
|
* @public
|
|
1360
1360
|
*/
|
|
1361
|
-
uri?: string;
|
|
1361
|
+
uri?: string | undefined;
|
|
1362
1362
|
}
|
|
1363
1363
|
/**
|
|
1364
1364
|
* <p>The Salesforce data source location.</p>
|
|
@@ -1369,7 +1369,7 @@ export interface RetrievalResultSalesforceLocation {
|
|
|
1369
1369
|
* <p>The Salesforce host URL for the data source location.</p>
|
|
1370
1370
|
* @public
|
|
1371
1371
|
*/
|
|
1372
|
-
url?: string;
|
|
1372
|
+
url?: string | undefined;
|
|
1373
1373
|
}
|
|
1374
1374
|
/**
|
|
1375
1375
|
* <p>The SharePoint data source location.</p>
|
|
@@ -1380,7 +1380,7 @@ export interface RetrievalResultSharePointLocation {
|
|
|
1380
1380
|
* <p>The SharePoint site URL for the data source location.</p>
|
|
1381
1381
|
* @public
|
|
1382
1382
|
*/
|
|
1383
|
-
url?: string;
|
|
1383
|
+
url?: string | undefined;
|
|
1384
1384
|
}
|
|
1385
1385
|
/**
|
|
1386
1386
|
* @public
|
|
@@ -1406,7 +1406,7 @@ export interface RetrievalResultWebLocation {
|
|
|
1406
1406
|
* <p>The web URL/URLs for the data source location.</p>
|
|
1407
1407
|
* @public
|
|
1408
1408
|
*/
|
|
1409
|
-
url?: string;
|
|
1409
|
+
url?: string | undefined;
|
|
1410
1410
|
}
|
|
1411
1411
|
/**
|
|
1412
1412
|
* <p>Contains information about the data source location.</p>
|
|
@@ -1437,27 +1437,27 @@ export interface RetrievalResultLocation {
|
|
|
1437
1437
|
* <p>The S3 data source location.</p>
|
|
1438
1438
|
* @public
|
|
1439
1439
|
*/
|
|
1440
|
-
s3Location?: RetrievalResultS3Location;
|
|
1440
|
+
s3Location?: RetrievalResultS3Location | undefined;
|
|
1441
1441
|
/**
|
|
1442
1442
|
* <p>The web URL/URLs data source location.</p>
|
|
1443
1443
|
* @public
|
|
1444
1444
|
*/
|
|
1445
|
-
webLocation?: RetrievalResultWebLocation;
|
|
1445
|
+
webLocation?: RetrievalResultWebLocation | undefined;
|
|
1446
1446
|
/**
|
|
1447
1447
|
* <p>The Confluence data source location.</p>
|
|
1448
1448
|
* @public
|
|
1449
1449
|
*/
|
|
1450
|
-
confluenceLocation?: RetrievalResultConfluenceLocation;
|
|
1450
|
+
confluenceLocation?: RetrievalResultConfluenceLocation | undefined;
|
|
1451
1451
|
/**
|
|
1452
1452
|
* <p>The Salesforce data source location.</p>
|
|
1453
1453
|
* @public
|
|
1454
1454
|
*/
|
|
1455
|
-
salesforceLocation?: RetrievalResultSalesforceLocation;
|
|
1455
|
+
salesforceLocation?: RetrievalResultSalesforceLocation | undefined;
|
|
1456
1456
|
/**
|
|
1457
1457
|
* <p>The SharePoint data source location.</p>
|
|
1458
1458
|
* @public
|
|
1459
1459
|
*/
|
|
1460
|
-
sharePointLocation?: RetrievalResultSharePointLocation;
|
|
1460
|
+
sharePointLocation?: RetrievalResultSharePointLocation | undefined;
|
|
1461
1461
|
}
|
|
1462
1462
|
/**
|
|
1463
1463
|
* <p>Contains metadata about a source cited for the generated response.</p>
|
|
@@ -1479,17 +1479,17 @@ export interface RetrievedReference {
|
|
|
1479
1479
|
* <p>Contains the cited text from the data source.</p>
|
|
1480
1480
|
* @public
|
|
1481
1481
|
*/
|
|
1482
|
-
content?: RetrievalResultContent;
|
|
1482
|
+
content?: RetrievalResultContent | undefined;
|
|
1483
1483
|
/**
|
|
1484
1484
|
* <p>Contains information about the location of the data source.</p>
|
|
1485
1485
|
* @public
|
|
1486
1486
|
*/
|
|
1487
|
-
location?: RetrievalResultLocation;
|
|
1487
|
+
location?: RetrievalResultLocation | undefined;
|
|
1488
1488
|
/**
|
|
1489
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>
|
|
1490
1490
|
* @public
|
|
1491
1491
|
*/
|
|
1492
|
-
metadata?: Record<string, __DocumentType
|
|
1492
|
+
metadata?: Record<string, __DocumentType> | undefined;
|
|
1493
1493
|
}
|
|
1494
1494
|
/**
|
|
1495
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>
|
|
@@ -1511,12 +1511,12 @@ export interface Citation {
|
|
|
1511
1511
|
* <p>Contains the generated response and metadata </p>
|
|
1512
1512
|
* @public
|
|
1513
1513
|
*/
|
|
1514
|
-
generatedResponsePart?: GeneratedResponsePart;
|
|
1514
|
+
generatedResponsePart?: GeneratedResponsePart | undefined;
|
|
1515
1515
|
/**
|
|
1516
1516
|
* <p>Contains metadata about the sources cited for the generated response.</p>
|
|
1517
1517
|
* @public
|
|
1518
1518
|
*/
|
|
1519
|
-
retrievedReferences?: RetrievedReference[];
|
|
1519
|
+
retrievedReferences?: RetrievedReference[] | undefined;
|
|
1520
1520
|
}
|
|
1521
1521
|
/**
|
|
1522
1522
|
* <p>Contains citations for a part of an agent response.</p>
|
|
@@ -1527,7 +1527,7 @@ export interface Attribution {
|
|
|
1527
1527
|
* <p>A list of citations and related information for a part of an agent response.</p>
|
|
1528
1528
|
* @public
|
|
1529
1529
|
*/
|
|
1530
|
-
citations?: Citation[];
|
|
1530
|
+
citations?: Citation[] | undefined;
|
|
1531
1531
|
}
|
|
1532
1532
|
/**
|
|
1533
1533
|
* <p>Contains a part of an agent response and citations for it.</p>
|
|
@@ -1538,12 +1538,12 @@ export interface PayloadPart {
|
|
|
1538
1538
|
* <p>A part of the agent response in bytes.</p>
|
|
1539
1539
|
* @public
|
|
1540
1540
|
*/
|
|
1541
|
-
bytes?: Uint8Array;
|
|
1541
|
+
bytes?: Uint8Array | undefined;
|
|
1542
1542
|
/**
|
|
1543
1543
|
* <p>Contains citations for a part of an agent response.</p>
|
|
1544
1544
|
* @public
|
|
1545
1545
|
*/
|
|
1546
|
-
attribution?: Attribution;
|
|
1546
|
+
attribution?: Attribution | undefined;
|
|
1547
1547
|
}
|
|
1548
1548
|
/**
|
|
1549
1549
|
* <p>Contains details of the response from code interpreter.</p>
|
|
@@ -1554,17 +1554,17 @@ export interface OutputFile {
|
|
|
1554
1554
|
* <p>The name of the file containing response from code interpreter.</p>
|
|
1555
1555
|
* @public
|
|
1556
1556
|
*/
|
|
1557
|
-
name?: string;
|
|
1557
|
+
name?: string | undefined;
|
|
1558
1558
|
/**
|
|
1559
1559
|
* <p>The type of file that contains response from the code interpreter.</p>
|
|
1560
1560
|
* @public
|
|
1561
1561
|
*/
|
|
1562
|
-
type?: string;
|
|
1562
|
+
type?: string | undefined;
|
|
1563
1563
|
/**
|
|
1564
1564
|
* <p>The byte count of files that contains response from code interpreter.</p>
|
|
1565
1565
|
* @public
|
|
1566
1566
|
*/
|
|
1567
|
-
bytes?: Uint8Array;
|
|
1567
|
+
bytes?: Uint8Array | undefined;
|
|
1568
1568
|
}
|
|
1569
1569
|
/**
|
|
1570
1570
|
* <p>Contains intermediate response for code interpreter if any files have been generated.</p>
|
|
@@ -1575,7 +1575,7 @@ export interface FilePart {
|
|
|
1575
1575
|
* <p>Files containing intermediate response for the user.</p>
|
|
1576
1576
|
* @public
|
|
1577
1577
|
*/
|
|
1578
|
-
files?: OutputFile[];
|
|
1578
|
+
files?: OutputFile[] | undefined;
|
|
1579
1579
|
}
|
|
1580
1580
|
/**
|
|
1581
1581
|
* <p>Information about a parameter to provide to the API request.</p>
|
|
@@ -1594,17 +1594,17 @@ export interface ApiParameter {
|
|
|
1594
1594
|
* <p>The name of the parameter.</p>
|
|
1595
1595
|
* @public
|
|
1596
1596
|
*/
|
|
1597
|
-
name?: string;
|
|
1597
|
+
name?: string | undefined;
|
|
1598
1598
|
/**
|
|
1599
1599
|
* <p>The data type for the parameter.</p>
|
|
1600
1600
|
* @public
|
|
1601
1601
|
*/
|
|
1602
|
-
type?: string;
|
|
1602
|
+
type?: string | undefined;
|
|
1603
1603
|
/**
|
|
1604
1604
|
* <p>The value of the parameter.</p>
|
|
1605
1605
|
* @public
|
|
1606
1606
|
*/
|
|
1607
|
-
value?: string;
|
|
1607
|
+
value?: string | undefined;
|
|
1608
1608
|
}
|
|
1609
1609
|
/**
|
|
1610
1610
|
* <p>Contains the parameters in the request body.</p>
|
|
@@ -1615,7 +1615,7 @@ export interface PropertyParameters {
|
|
|
1615
1615
|
* <p>A list of parameters in the request body.</p>
|
|
1616
1616
|
* @public
|
|
1617
1617
|
*/
|
|
1618
|
-
properties?: Parameter[];
|
|
1618
|
+
properties?: Parameter[] | undefined;
|
|
1619
1619
|
}
|
|
1620
1620
|
/**
|
|
1621
1621
|
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
@@ -1634,7 +1634,7 @@ export interface ApiRequestBody {
|
|
|
1634
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>
|
|
1635
1635
|
* @public
|
|
1636
1636
|
*/
|
|
1637
|
-
content?: Record<string, PropertyParameters
|
|
1637
|
+
content?: Record<string, PropertyParameters> | undefined;
|
|
1638
1638
|
}
|
|
1639
1639
|
/**
|
|
1640
1640
|
* <p>Contains information about the API operation that the agent predicts should be called.</p>
|
|
@@ -1657,27 +1657,27 @@ export interface ApiInvocationInput {
|
|
|
1657
1657
|
* <p>The HTTP method of the API operation.</p>
|
|
1658
1658
|
* @public
|
|
1659
1659
|
*/
|
|
1660
|
-
httpMethod?: string;
|
|
1660
|
+
httpMethod?: string | undefined;
|
|
1661
1661
|
/**
|
|
1662
1662
|
* <p>The path to the API operation.</p>
|
|
1663
1663
|
* @public
|
|
1664
1664
|
*/
|
|
1665
|
-
apiPath?: string;
|
|
1665
|
+
apiPath?: string | undefined;
|
|
1666
1666
|
/**
|
|
1667
1667
|
* <p>The parameters to provide for the API request, as the agent elicited from the user.</p>
|
|
1668
1668
|
* @public
|
|
1669
1669
|
*/
|
|
1670
|
-
parameters?: ApiParameter[];
|
|
1670
|
+
parameters?: ApiParameter[] | undefined;
|
|
1671
1671
|
/**
|
|
1672
1672
|
* <p>The request body to provide for the API request, as the agent elicited from the user.</p>
|
|
1673
1673
|
* @public
|
|
1674
1674
|
*/
|
|
1675
|
-
requestBody?: ApiRequestBody;
|
|
1675
|
+
requestBody?: ApiRequestBody | undefined;
|
|
1676
1676
|
/**
|
|
1677
1677
|
* <p>Contains information about the API operation to invoke.</p>
|
|
1678
1678
|
* @public
|
|
1679
1679
|
*/
|
|
1680
|
-
actionInvocationType?: ActionInvocationType;
|
|
1680
|
+
actionInvocationType?: ActionInvocationType | undefined;
|
|
1681
1681
|
}
|
|
1682
1682
|
/**
|
|
1683
1683
|
* <p>Contains information about a parameter of the function.</p>
|
|
@@ -1695,17 +1695,17 @@ export interface FunctionParameter {
|
|
|
1695
1695
|
* <p>The name of the parameter.</p>
|
|
1696
1696
|
* @public
|
|
1697
1697
|
*/
|
|
1698
|
-
name?: string;
|
|
1698
|
+
name?: string | undefined;
|
|
1699
1699
|
/**
|
|
1700
1700
|
* <p>The data type of the parameter.</p>
|
|
1701
1701
|
* @public
|
|
1702
1702
|
*/
|
|
1703
|
-
type?: string;
|
|
1703
|
+
type?: string | undefined;
|
|
1704
1704
|
/**
|
|
1705
1705
|
* <p>The value of the parameter.</p>
|
|
1706
1706
|
* @public
|
|
1707
1707
|
*/
|
|
1708
|
-
value?: string;
|
|
1708
|
+
value?: string | undefined;
|
|
1709
1709
|
}
|
|
1710
1710
|
/**
|
|
1711
1711
|
* <p>Contains information about the function that the agent predicts should be called.</p>
|
|
@@ -1728,17 +1728,17 @@ export interface FunctionInvocationInput {
|
|
|
1728
1728
|
* <p>A list of parameters of the function.</p>
|
|
1729
1729
|
* @public
|
|
1730
1730
|
*/
|
|
1731
|
-
parameters?: FunctionParameter[];
|
|
1731
|
+
parameters?: FunctionParameter[] | undefined;
|
|
1732
1732
|
/**
|
|
1733
1733
|
* <p>The name of the function.</p>
|
|
1734
1734
|
* @public
|
|
1735
1735
|
*/
|
|
1736
|
-
function?: string;
|
|
1736
|
+
function?: string | undefined;
|
|
1737
1737
|
/**
|
|
1738
1738
|
* <p>Contains information about the function to invoke,</p>
|
|
1739
1739
|
* @public
|
|
1740
1740
|
*/
|
|
1741
|
-
actionInvocationType?: ActionInvocationType;
|
|
1741
|
+
actionInvocationType?: ActionInvocationType | undefined;
|
|
1742
1742
|
}
|
|
1743
1743
|
/**
|
|
1744
1744
|
* <p>Contains details about the API operation or function that the agent predicts should be called. </p>
|
|
@@ -1806,12 +1806,12 @@ export interface ReturnControlPayload {
|
|
|
1806
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>
|
|
1807
1807
|
* @public
|
|
1808
1808
|
*/
|
|
1809
|
-
invocationInputs?: InvocationInputMember[];
|
|
1809
|
+
invocationInputs?: InvocationInputMember[] | undefined;
|
|
1810
1810
|
/**
|
|
1811
1811
|
* <p>The identifier of the action group invocation.</p>
|
|
1812
1812
|
* @public
|
|
1813
1813
|
*/
|
|
1814
|
-
invocationId?: string;
|
|
1814
|
+
invocationId?: string | undefined;
|
|
1815
1815
|
}
|
|
1816
1816
|
/**
|
|
1817
1817
|
* <p>Contains information about the failure of the interaction.</p>
|
|
@@ -1822,12 +1822,12 @@ export interface FailureTrace {
|
|
|
1822
1822
|
* <p>The unique identifier of the trace.</p>
|
|
1823
1823
|
* @public
|
|
1824
1824
|
*/
|
|
1825
|
-
traceId?: string;
|
|
1825
|
+
traceId?: string | undefined;
|
|
1826
1826
|
/**
|
|
1827
1827
|
* <p>The reason the interaction failed.</p>
|
|
1828
1828
|
* @public
|
|
1829
1829
|
*/
|
|
1830
|
-
failureReason?: string;
|
|
1830
|
+
failureReason?: string | undefined;
|
|
1831
1831
|
}
|
|
1832
1832
|
/**
|
|
1833
1833
|
* @public
|
|
@@ -1891,17 +1891,17 @@ export interface GuardrailContentFilter {
|
|
|
1891
1891
|
* <p>The type of content detected in the filter by the Guardrail.</p>
|
|
1892
1892
|
* @public
|
|
1893
1893
|
*/
|
|
1894
|
-
type?: GuardrailContentFilterType;
|
|
1894
|
+
type?: GuardrailContentFilterType | undefined;
|
|
1895
1895
|
/**
|
|
1896
1896
|
* <p>The confidence level regarding the content detected in the filter by the Guardrail.</p>
|
|
1897
1897
|
* @public
|
|
1898
1898
|
*/
|
|
1899
|
-
confidence?: GuardrailContentFilterConfidence;
|
|
1899
|
+
confidence?: GuardrailContentFilterConfidence | undefined;
|
|
1900
1900
|
/**
|
|
1901
1901
|
* <p>The action placed on the content by the Guardrail filter.</p>
|
|
1902
1902
|
* @public
|
|
1903
1903
|
*/
|
|
1904
|
-
action?: GuardrailContentPolicyAction;
|
|
1904
|
+
action?: GuardrailContentPolicyAction | undefined;
|
|
1905
1905
|
}
|
|
1906
1906
|
/**
|
|
1907
1907
|
* <p>The details of the policy assessment in the Guardrails filter.</p>
|
|
@@ -1912,7 +1912,7 @@ export interface GuardrailContentPolicyAssessment {
|
|
|
1912
1912
|
* <p>The filter details of the policy assessment used in the Guardrails filter.</p>
|
|
1913
1913
|
* @public
|
|
1914
1914
|
*/
|
|
1915
|
-
filters?: GuardrailContentFilter[];
|
|
1915
|
+
filters?: GuardrailContentFilter[] | undefined;
|
|
1916
1916
|
}
|
|
1917
1917
|
/**
|
|
1918
1918
|
* @public
|
|
@@ -1976,17 +1976,17 @@ export interface GuardrailPiiEntityFilter {
|
|
|
1976
1976
|
* <p>The type of PII the Guardrail filter has identified and removed.</p>
|
|
1977
1977
|
* @public
|
|
1978
1978
|
*/
|
|
1979
|
-
type?: GuardrailPiiEntityType;
|
|
1979
|
+
type?: GuardrailPiiEntityType | undefined;
|
|
1980
1980
|
/**
|
|
1981
1981
|
* <p>The match to settings in the Guardrail filter to identify and remove PII.</p>
|
|
1982
1982
|
* @public
|
|
1983
1983
|
*/
|
|
1984
|
-
match?: string;
|
|
1984
|
+
match?: string | undefined;
|
|
1985
1985
|
/**
|
|
1986
1986
|
* <p>The action of the Guardrail filter to identify and remove PII.</p>
|
|
1987
1987
|
* @public
|
|
1988
1988
|
*/
|
|
1989
|
-
action?: GuardrailSensitiveInformationPolicyAction;
|
|
1989
|
+
action?: GuardrailSensitiveInformationPolicyAction | undefined;
|
|
1990
1990
|
}
|
|
1991
1991
|
/**
|
|
1992
1992
|
* <p>The details for the regex filter used in the Guardrail.</p>
|
|
@@ -1997,22 +1997,22 @@ export interface GuardrailRegexFilter {
|
|
|
1997
1997
|
* <p>The name details for the regex filter used in the Guardrail.</p>
|
|
1998
1998
|
* @public
|
|
1999
1999
|
*/
|
|
2000
|
-
name?: string;
|
|
2000
|
+
name?: string | undefined;
|
|
2001
2001
|
/**
|
|
2002
2002
|
* <p>The regex details for the regex filter used in the Guardrail.</p>
|
|
2003
2003
|
* @public
|
|
2004
2004
|
*/
|
|
2005
|
-
regex?: string;
|
|
2005
|
+
regex?: string | undefined;
|
|
2006
2006
|
/**
|
|
2007
2007
|
* <p>The match details for the regex filter used in the Guardrail.</p>
|
|
2008
2008
|
* @public
|
|
2009
2009
|
*/
|
|
2010
|
-
match?: string;
|
|
2010
|
+
match?: string | undefined;
|
|
2011
2011
|
/**
|
|
2012
2012
|
* <p>The action details for the regex filter used in the Guardrail.</p>
|
|
2013
2013
|
* @public
|
|
2014
2014
|
*/
|
|
2015
|
-
action?: GuardrailSensitiveInformationPolicyAction;
|
|
2015
|
+
action?: GuardrailSensitiveInformationPolicyAction | undefined;
|
|
2016
2016
|
}
|
|
2017
2017
|
/**
|
|
2018
2018
|
* <p>The details of the sensitive policy assessment used in the Guardrail.</p>
|
|
@@ -2023,12 +2023,12 @@ export interface GuardrailSensitiveInformationPolicyAssessment {
|
|
|
2023
2023
|
* <p>The details of the PII entities used in the sensitive policy assessment for the Guardrail.</p>
|
|
2024
2024
|
* @public
|
|
2025
2025
|
*/
|
|
2026
|
-
piiEntities?: GuardrailPiiEntityFilter[];
|
|
2026
|
+
piiEntities?: GuardrailPiiEntityFilter[] | undefined;
|
|
2027
2027
|
/**
|
|
2028
2028
|
* <p>The details of the regexes used in the sensitive policy assessment for the Guardrail.</p>
|
|
2029
2029
|
* @public
|
|
2030
2030
|
*/
|
|
2031
|
-
regexes?: GuardrailRegexFilter[];
|
|
2031
|
+
regexes?: GuardrailRegexFilter[] | undefined;
|
|
2032
2032
|
}
|
|
2033
2033
|
/**
|
|
2034
2034
|
* @public
|
|
@@ -2061,17 +2061,17 @@ export interface GuardrailTopic {
|
|
|
2061
2061
|
* <p>The name details on a specific topic in the Guardrail.</p>
|
|
2062
2062
|
* @public
|
|
2063
2063
|
*/
|
|
2064
|
-
name?: string;
|
|
2064
|
+
name?: string | undefined;
|
|
2065
2065
|
/**
|
|
2066
2066
|
* <p>The type details on a specific topic in the Guardrail.</p>
|
|
2067
2067
|
* @public
|
|
2068
2068
|
*/
|
|
2069
|
-
type?: GuardrailTopicType;
|
|
2069
|
+
type?: GuardrailTopicType | undefined;
|
|
2070
2070
|
/**
|
|
2071
2071
|
* <p>The action details on a specific topic in the Guardrail.</p>
|
|
2072
2072
|
* @public
|
|
2073
2073
|
*/
|
|
2074
|
-
action?: GuardrailTopicPolicyAction;
|
|
2074
|
+
action?: GuardrailTopicPolicyAction | undefined;
|
|
2075
2075
|
}
|
|
2076
2076
|
/**
|
|
2077
2077
|
* <p>The details of the policy assessment used in the Guardrail.</p>
|
|
@@ -2082,7 +2082,7 @@ export interface GuardrailTopicPolicyAssessment {
|
|
|
2082
2082
|
* <p>The topic details of the policy assessment used in the Guardrail.</p>
|
|
2083
2083
|
* @public
|
|
2084
2084
|
*/
|
|
2085
|
-
topics?: GuardrailTopic[];
|
|
2085
|
+
topics?: GuardrailTopic[] | undefined;
|
|
2086
2086
|
}
|
|
2087
2087
|
/**
|
|
2088
2088
|
* @public
|
|
@@ -2104,12 +2104,12 @@ export interface GuardrailCustomWord {
|
|
|
2104
2104
|
* <p>The match details for the custom word filter in the Guardrail.</p>
|
|
2105
2105
|
* @public
|
|
2106
2106
|
*/
|
|
2107
|
-
match?: string;
|
|
2107
|
+
match?: string | undefined;
|
|
2108
2108
|
/**
|
|
2109
2109
|
* <p>The action details for the custom word filter in the Guardrail.</p>
|
|
2110
2110
|
* @public
|
|
2111
2111
|
*/
|
|
2112
|
-
action?: GuardrailWordPolicyAction;
|
|
2112
|
+
action?: GuardrailWordPolicyAction | undefined;
|
|
2113
2113
|
}
|
|
2114
2114
|
/**
|
|
2115
2115
|
* @public
|
|
@@ -2131,17 +2131,17 @@ export interface GuardrailManagedWord {
|
|
|
2131
2131
|
* <p>The match details for the managed word filter in the Guardrail.</p>
|
|
2132
2132
|
* @public
|
|
2133
2133
|
*/
|
|
2134
|
-
match?: string;
|
|
2134
|
+
match?: string | undefined;
|
|
2135
2135
|
/**
|
|
2136
2136
|
* <p>The type details for the managed word filter in the Guardrail.</p>
|
|
2137
2137
|
* @public
|
|
2138
2138
|
*/
|
|
2139
|
-
type?: GuardrailManagedWordType;
|
|
2139
|
+
type?: GuardrailManagedWordType | undefined;
|
|
2140
2140
|
/**
|
|
2141
2141
|
* <p>The action details for the managed word filter in the Guardrail.</p>
|
|
2142
2142
|
* @public
|
|
2143
2143
|
*/
|
|
2144
|
-
action?: GuardrailWordPolicyAction;
|
|
2144
|
+
action?: GuardrailWordPolicyAction | undefined;
|
|
2145
2145
|
}
|
|
2146
2146
|
/**
|
|
2147
2147
|
* <p>The assessment details for words defined in the Guardrail filter.</p>
|
|
@@ -2152,12 +2152,12 @@ export interface GuardrailWordPolicyAssessment {
|
|
|
2152
2152
|
* <p>The custom word details for words defined in the Guardrail filter.</p>
|
|
2153
2153
|
* @public
|
|
2154
2154
|
*/
|
|
2155
|
-
customWords?: GuardrailCustomWord[];
|
|
2155
|
+
customWords?: GuardrailCustomWord[] | undefined;
|
|
2156
2156
|
/**
|
|
2157
2157
|
* <p>The managed word lists for words defined in the Guardrail filter.</p>
|
|
2158
2158
|
* @public
|
|
2159
2159
|
*/
|
|
2160
|
-
managedWordLists?: GuardrailManagedWord[];
|
|
2160
|
+
managedWordLists?: GuardrailManagedWord[] | undefined;
|
|
2161
2161
|
}
|
|
2162
2162
|
/**
|
|
2163
2163
|
* <p>Assessment details of the content analyzed by Guardrails.</p>
|
|
@@ -2168,22 +2168,22 @@ export interface GuardrailAssessment {
|
|
|
2168
2168
|
* <p>Topic policy details of the Guardrail.</p>
|
|
2169
2169
|
* @public
|
|
2170
2170
|
*/
|
|
2171
|
-
topicPolicy?: GuardrailTopicPolicyAssessment;
|
|
2171
|
+
topicPolicy?: GuardrailTopicPolicyAssessment | undefined;
|
|
2172
2172
|
/**
|
|
2173
2173
|
* <p>Content policy details of the Guardrail.</p>
|
|
2174
2174
|
* @public
|
|
2175
2175
|
*/
|
|
2176
|
-
contentPolicy?: GuardrailContentPolicyAssessment;
|
|
2176
|
+
contentPolicy?: GuardrailContentPolicyAssessment | undefined;
|
|
2177
2177
|
/**
|
|
2178
2178
|
* <p>Word policy details of the Guardrail.</p>
|
|
2179
2179
|
* @public
|
|
2180
2180
|
*/
|
|
2181
|
-
wordPolicy?: GuardrailWordPolicyAssessment;
|
|
2181
|
+
wordPolicy?: GuardrailWordPolicyAssessment | undefined;
|
|
2182
2182
|
/**
|
|
2183
2183
|
* <p>Sensitive Information policy details of Guardrail.</p>
|
|
2184
2184
|
* @public
|
|
2185
2185
|
*/
|
|
2186
|
-
sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment;
|
|
2186
|
+
sensitiveInformationPolicy?: GuardrailSensitiveInformationPolicyAssessment | undefined;
|
|
2187
2187
|
}
|
|
2188
2188
|
/**
|
|
2189
2189
|
* <p>The trace details used in the Guardrail.</p>
|
|
@@ -2194,22 +2194,22 @@ export interface GuardrailTrace {
|
|
|
2194
2194
|
* <p>The trace action details used with the Guardrail.</p>
|
|
2195
2195
|
* @public
|
|
2196
2196
|
*/
|
|
2197
|
-
action?: GuardrailAction;
|
|
2197
|
+
action?: GuardrailAction | undefined;
|
|
2198
2198
|
/**
|
|
2199
2199
|
* <p>The details of the trace Id used in the Guardrail Trace.</p>
|
|
2200
2200
|
* @public
|
|
2201
2201
|
*/
|
|
2202
|
-
traceId?: string;
|
|
2202
|
+
traceId?: string | undefined;
|
|
2203
2203
|
/**
|
|
2204
2204
|
* <p>The details of the input assessments used in the Guardrail Trace.</p>
|
|
2205
2205
|
* @public
|
|
2206
2206
|
*/
|
|
2207
|
-
inputAssessments?: GuardrailAssessment[];
|
|
2207
|
+
inputAssessments?: GuardrailAssessment[] | undefined;
|
|
2208
2208
|
/**
|
|
2209
2209
|
* <p>The details of the output assessments used in the Guardrail Trace.</p>
|
|
2210
2210
|
* @public
|
|
2211
2211
|
*/
|
|
2212
|
-
outputAssessments?: GuardrailAssessment[];
|
|
2212
|
+
outputAssessments?: GuardrailAssessment[] | undefined;
|
|
2213
2213
|
}
|
|
2214
2214
|
/**
|
|
2215
2215
|
* <p>Contains information about the code interpreter being invoked.</p>
|
|
@@ -2220,12 +2220,12 @@ export interface CodeInterpreterInvocationInput {
|
|
|
2220
2220
|
* <p>The code for the code interpreter to use.</p>
|
|
2221
2221
|
* @public
|
|
2222
2222
|
*/
|
|
2223
|
-
code?: string;
|
|
2223
|
+
code?: string | undefined;
|
|
2224
2224
|
/**
|
|
2225
2225
|
* <p>Files that are uploaded for code interpreter to use.</p>
|
|
2226
2226
|
* @public
|
|
2227
2227
|
*/
|
|
2228
|
-
files?: string[];
|
|
2228
|
+
files?: string[] | undefined;
|
|
2229
2229
|
}
|
|
2230
2230
|
/**
|
|
2231
2231
|
* @public
|
|
@@ -2250,12 +2250,12 @@ export interface KnowledgeBaseLookupInput {
|
|
|
2250
2250
|
* <p>The query made to the knowledge base.</p>
|
|
2251
2251
|
* @public
|
|
2252
2252
|
*/
|
|
2253
|
-
text?: string;
|
|
2253
|
+
text?: string | undefined;
|
|
2254
2254
|
/**
|
|
2255
2255
|
* <p>The unique identifier of the knowledge base to look up.</p>
|
|
2256
2256
|
* @public
|
|
2257
2257
|
*/
|
|
2258
|
-
knowledgeBaseId?: string;
|
|
2258
|
+
knowledgeBaseId?: string | undefined;
|
|
2259
2259
|
}
|
|
2260
2260
|
/**
|
|
2261
2261
|
* <p>Contains information pertaining to the action group or knowledge base that is being invoked.</p>
|
|
@@ -2266,27 +2266,27 @@ export interface InvocationInput {
|
|
|
2266
2266
|
* <p>The unique identifier of the trace.</p>
|
|
2267
2267
|
* @public
|
|
2268
2268
|
*/
|
|
2269
|
-
traceId?: string;
|
|
2269
|
+
traceId?: string | undefined;
|
|
2270
2270
|
/**
|
|
2271
2271
|
* <p>Specifies whether the agent is invoking an action group or a knowledge base.</p>
|
|
2272
2272
|
* @public
|
|
2273
2273
|
*/
|
|
2274
|
-
invocationType?: InvocationType;
|
|
2274
|
+
invocationType?: InvocationType | undefined;
|
|
2275
2275
|
/**
|
|
2276
2276
|
* <p>Contains information about the action group to be invoked.</p>
|
|
2277
2277
|
* @public
|
|
2278
2278
|
*/
|
|
2279
|
-
actionGroupInvocationInput?: ActionGroupInvocationInput;
|
|
2279
|
+
actionGroupInvocationInput?: ActionGroupInvocationInput | undefined;
|
|
2280
2280
|
/**
|
|
2281
2281
|
* <p>Contains details about the knowledge base to look up and the query to be made.</p>
|
|
2282
2282
|
* @public
|
|
2283
2283
|
*/
|
|
2284
|
-
knowledgeBaseLookupInput?: KnowledgeBaseLookupInput;
|
|
2284
|
+
knowledgeBaseLookupInput?: KnowledgeBaseLookupInput | undefined;
|
|
2285
2285
|
/**
|
|
2286
2286
|
* <p>Contains information about the code interpreter to be invoked.</p>
|
|
2287
2287
|
* @public
|
|
2288
2288
|
*/
|
|
2289
|
-
codeInterpreterInvocationInput?: CodeInterpreterInvocationInput;
|
|
2289
|
+
codeInterpreterInvocationInput?: CodeInterpreterInvocationInput | undefined;
|
|
2290
2290
|
}
|
|
2291
2291
|
/**
|
|
2292
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>
|
|
@@ -2297,27 +2297,27 @@ export interface InferenceConfiguration {
|
|
|
2297
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>
|
|
2298
2298
|
* @public
|
|
2299
2299
|
*/
|
|
2300
|
-
temperature?: number;
|
|
2300
|
+
temperature?: number | undefined;
|
|
2301
2301
|
/**
|
|
2302
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>
|
|
2303
2303
|
* @public
|
|
2304
2304
|
*/
|
|
2305
|
-
topP?: number;
|
|
2305
|
+
topP?: number | undefined;
|
|
2306
2306
|
/**
|
|
2307
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>
|
|
2308
2308
|
* @public
|
|
2309
2309
|
*/
|
|
2310
|
-
topK?: number;
|
|
2310
|
+
topK?: number | undefined;
|
|
2311
2311
|
/**
|
|
2312
2312
|
* <p>The maximum number of tokens allowed in the generated response.</p>
|
|
2313
2313
|
* @public
|
|
2314
2314
|
*/
|
|
2315
|
-
maximumLength?: number;
|
|
2315
|
+
maximumLength?: number | undefined;
|
|
2316
2316
|
/**
|
|
2317
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>
|
|
2318
2318
|
* @public
|
|
2319
2319
|
*/
|
|
2320
|
-
stopSequences?: string[];
|
|
2320
|
+
stopSequences?: string[] | undefined;
|
|
2321
2321
|
}
|
|
2322
2322
|
/**
|
|
2323
2323
|
* @public
|
|
@@ -2365,37 +2365,37 @@ export interface ModelInvocationInput {
|
|
|
2365
2365
|
* <p>The unique identifier of the trace.</p>
|
|
2366
2366
|
* @public
|
|
2367
2367
|
*/
|
|
2368
|
-
traceId?: string;
|
|
2368
|
+
traceId?: string | undefined;
|
|
2369
2369
|
/**
|
|
2370
2370
|
* <p>The text that prompted the agent at this step.</p>
|
|
2371
2371
|
* @public
|
|
2372
2372
|
*/
|
|
2373
|
-
text?: string;
|
|
2373
|
+
text?: string | undefined;
|
|
2374
2374
|
/**
|
|
2375
2375
|
* <p>The step in the agent sequence.</p>
|
|
2376
2376
|
* @public
|
|
2377
2377
|
*/
|
|
2378
|
-
type?: PromptType;
|
|
2378
|
+
type?: PromptType | undefined;
|
|
2379
2379
|
/**
|
|
2380
2380
|
* <p>The ARN of the Lambda function to use when parsing the raw foundation model output in parts of the agent sequence.</p>
|
|
2381
2381
|
* @public
|
|
2382
2382
|
*/
|
|
2383
|
-
overrideLambda?: string;
|
|
2383
|
+
overrideLambda?: string | undefined;
|
|
2384
2384
|
/**
|
|
2385
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>
|
|
2386
2386
|
* @public
|
|
2387
2387
|
*/
|
|
2388
|
-
promptCreationMode?: CreationMode;
|
|
2388
|
+
promptCreationMode?: CreationMode | undefined;
|
|
2389
2389
|
/**
|
|
2390
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>
|
|
2391
2391
|
* @public
|
|
2392
2392
|
*/
|
|
2393
|
-
inferenceConfiguration?: InferenceConfiguration;
|
|
2393
|
+
inferenceConfiguration?: InferenceConfiguration | undefined;
|
|
2394
2394
|
/**
|
|
2395
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>
|
|
2396
2396
|
* @public
|
|
2397
2397
|
*/
|
|
2398
|
-
parserMode?: CreationMode;
|
|
2398
|
+
parserMode?: CreationMode | undefined;
|
|
2399
2399
|
}
|
|
2400
2400
|
/**
|
|
2401
2401
|
* <p>Contains information of the usage of the foundation model.</p>
|
|
@@ -2406,12 +2406,12 @@ export interface Usage {
|
|
|
2406
2406
|
* <p>Contains information about the input tokens from the foundation model usage.</p>
|
|
2407
2407
|
* @public
|
|
2408
2408
|
*/
|
|
2409
|
-
inputTokens?: number;
|
|
2409
|
+
inputTokens?: number | undefined;
|
|
2410
2410
|
/**
|
|
2411
2411
|
* <p>Contains information about the output tokens from the foundation model usage.</p>
|
|
2412
2412
|
* @public
|
|
2413
2413
|
*/
|
|
2414
|
-
outputTokens?: number;
|
|
2414
|
+
outputTokens?: number | undefined;
|
|
2415
2415
|
}
|
|
2416
2416
|
/**
|
|
2417
2417
|
* <p>Provides details of the foundation model.</p>
|
|
@@ -2422,7 +2422,7 @@ export interface Metadata {
|
|
|
2422
2422
|
* <p>Contains details of the foundation model usage.</p>
|
|
2423
2423
|
* @public
|
|
2424
2424
|
*/
|
|
2425
|
-
usage?: Usage;
|
|
2425
|
+
usage?: Usage | undefined;
|
|
2426
2426
|
}
|
|
2427
2427
|
/**
|
|
2428
2428
|
* <p>Contains the raw output from the foundation model.</p>
|
|
@@ -2433,7 +2433,7 @@ export interface RawResponse {
|
|
|
2433
2433
|
* <p>The foundation model's raw output content.</p>
|
|
2434
2434
|
* @public
|
|
2435
2435
|
*/
|
|
2436
|
-
content?: string;
|
|
2436
|
+
content?: string | undefined;
|
|
2437
2437
|
}
|
|
2438
2438
|
/**
|
|
2439
2439
|
* <p>The foundation model output from the orchestration step.</p>
|
|
@@ -2444,17 +2444,17 @@ export interface OrchestrationModelInvocationOutput {
|
|
|
2444
2444
|
* <p>The unique identifier of the trace.</p>
|
|
2445
2445
|
* @public
|
|
2446
2446
|
*/
|
|
2447
|
-
traceId?: string;
|
|
2447
|
+
traceId?: string | undefined;
|
|
2448
2448
|
/**
|
|
2449
2449
|
* <p>Contains details of the raw response from the foundation model output.</p>
|
|
2450
2450
|
* @public
|
|
2451
2451
|
*/
|
|
2452
|
-
rawResponse?: RawResponse;
|
|
2452
|
+
rawResponse?: RawResponse | undefined;
|
|
2453
2453
|
/**
|
|
2454
2454
|
* <p>Contains information about the foundation model output from the orchestration step.</p>
|
|
2455
2455
|
* @public
|
|
2456
2456
|
*/
|
|
2457
|
-
metadata?: Metadata;
|
|
2457
|
+
metadata?: Metadata | undefined;
|
|
2458
2458
|
}
|
|
2459
2459
|
/**
|
|
2460
2460
|
* <p>Contains the JSON-formatted string returned by the API invoked by the code interpreter.</p>
|
|
@@ -2465,22 +2465,22 @@ export interface CodeInterpreterInvocationOutput {
|
|
|
2465
2465
|
* <p>Contains the successful output returned from code execution</p>
|
|
2466
2466
|
* @public
|
|
2467
2467
|
*/
|
|
2468
|
-
executionOutput?: string;
|
|
2468
|
+
executionOutput?: string | undefined;
|
|
2469
2469
|
/**
|
|
2470
2470
|
* <p>Contains the error returned from code execution.</p>
|
|
2471
2471
|
* @public
|
|
2472
2472
|
*/
|
|
2473
|
-
executionError?: string;
|
|
2473
|
+
executionError?: string | undefined;
|
|
2474
2474
|
/**
|
|
2475
2475
|
* <p>Contains output files, if generated by code execution.</p>
|
|
2476
2476
|
* @public
|
|
2477
2477
|
*/
|
|
2478
|
-
files?: string[];
|
|
2478
|
+
files?: string[] | undefined;
|
|
2479
2479
|
/**
|
|
2480
2480
|
* <p>Indicates if the execution of the code timed out.</p>
|
|
2481
2481
|
* @public
|
|
2482
2482
|
*/
|
|
2483
|
-
executionTimeout?: boolean;
|
|
2483
|
+
executionTimeout?: boolean | undefined;
|
|
2484
2484
|
}
|
|
2485
2485
|
/**
|
|
2486
2486
|
* <p>Contains details about the response to the user.</p>
|
|
@@ -2491,7 +2491,7 @@ export interface FinalResponse {
|
|
|
2491
2491
|
* <p>The text in the response to the user.</p>
|
|
2492
2492
|
* @public
|
|
2493
2493
|
*/
|
|
2494
|
-
text?: string;
|
|
2494
|
+
text?: string | undefined;
|
|
2495
2495
|
}
|
|
2496
2496
|
/**
|
|
2497
2497
|
* <p>Contains details about the results from looking up the knowledge base.</p>
|
|
@@ -2502,7 +2502,7 @@ export interface KnowledgeBaseLookupOutput {
|
|
|
2502
2502
|
* <p>Contains metadata about the sources cited for the generated response.</p>
|
|
2503
2503
|
* @public
|
|
2504
2504
|
*/
|
|
2505
|
-
retrievedReferences?: RetrievedReference[];
|
|
2505
|
+
retrievedReferences?: RetrievedReference[] | undefined;
|
|
2506
2506
|
}
|
|
2507
2507
|
/**
|
|
2508
2508
|
* @public
|
|
@@ -2526,12 +2526,12 @@ export interface RepromptResponse {
|
|
|
2526
2526
|
* <p>The text reprompting the input.</p>
|
|
2527
2527
|
* @public
|
|
2528
2528
|
*/
|
|
2529
|
-
text?: string;
|
|
2529
|
+
text?: string | undefined;
|
|
2530
2530
|
/**
|
|
2531
2531
|
* <p>Specifies what output is prompting the agent to reprompt the input.</p>
|
|
2532
2532
|
* @public
|
|
2533
2533
|
*/
|
|
2534
|
-
source?: Source;
|
|
2534
|
+
source?: Source | undefined;
|
|
2535
2535
|
}
|
|
2536
2536
|
/**
|
|
2537
2537
|
* @public
|
|
@@ -2557,7 +2557,7 @@ export interface Observation {
|
|
|
2557
2557
|
* <p>The unique identifier of the trace.</p>
|
|
2558
2558
|
* @public
|
|
2559
2559
|
*/
|
|
2560
|
-
traceId?: string;
|
|
2560
|
+
traceId?: string | undefined;
|
|
2561
2561
|
/**
|
|
2562
2562
|
* <p>Specifies what kind of information the agent returns in the observation. The following values are possible.</p>
|
|
2563
2563
|
* <ul>
|
|
@@ -2584,32 +2584,32 @@ export interface Observation {
|
|
|
2584
2584
|
* </ul>
|
|
2585
2585
|
* @public
|
|
2586
2586
|
*/
|
|
2587
|
-
type?: Type;
|
|
2587
|
+
type?: Type | undefined;
|
|
2588
2588
|
/**
|
|
2589
2589
|
* <p>Contains the JSON-formatted string returned by the API invoked by the action group.</p>
|
|
2590
2590
|
* @public
|
|
2591
2591
|
*/
|
|
2592
|
-
actionGroupInvocationOutput?: ActionGroupInvocationOutput;
|
|
2592
|
+
actionGroupInvocationOutput?: ActionGroupInvocationOutput | undefined;
|
|
2593
2593
|
/**
|
|
2594
2594
|
* <p>Contains details about the results from looking up the knowledge base.</p>
|
|
2595
2595
|
* @public
|
|
2596
2596
|
*/
|
|
2597
|
-
knowledgeBaseLookupOutput?: KnowledgeBaseLookupOutput;
|
|
2597
|
+
knowledgeBaseLookupOutput?: KnowledgeBaseLookupOutput | undefined;
|
|
2598
2598
|
/**
|
|
2599
2599
|
* <p>Contains details about the response to the user.</p>
|
|
2600
2600
|
* @public
|
|
2601
2601
|
*/
|
|
2602
|
-
finalResponse?: FinalResponse;
|
|
2602
|
+
finalResponse?: FinalResponse | undefined;
|
|
2603
2603
|
/**
|
|
2604
2604
|
* <p>Contains details about the response to reprompt the input.</p>
|
|
2605
2605
|
* @public
|
|
2606
2606
|
*/
|
|
2607
|
-
repromptResponse?: RepromptResponse;
|
|
2607
|
+
repromptResponse?: RepromptResponse | undefined;
|
|
2608
2608
|
/**
|
|
2609
2609
|
* <p>Contains the JSON-formatted string returned by the API invoked by the code interpreter.</p>
|
|
2610
2610
|
* @public
|
|
2611
2611
|
*/
|
|
2612
|
-
codeInterpreterInvocationOutput?: CodeInterpreterInvocationOutput;
|
|
2612
|
+
codeInterpreterInvocationOutput?: CodeInterpreterInvocationOutput | undefined;
|
|
2613
2613
|
}
|
|
2614
2614
|
/**
|
|
2615
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>
|
|
@@ -2620,12 +2620,12 @@ export interface Rationale {
|
|
|
2620
2620
|
* <p>The unique identifier of the trace step.</p>
|
|
2621
2621
|
* @public
|
|
2622
2622
|
*/
|
|
2623
|
-
traceId?: string;
|
|
2623
|
+
traceId?: string | undefined;
|
|
2624
2624
|
/**
|
|
2625
2625
|
* <p>The reasoning or thought process of the agent, based on the input.</p>
|
|
2626
2626
|
* @public
|
|
2627
2627
|
*/
|
|
2628
|
-
text?: string;
|
|
2628
|
+
text?: string | undefined;
|
|
2629
2629
|
}
|
|
2630
2630
|
/**
|
|
2631
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>
|
|
@@ -2737,7 +2737,7 @@ export interface PostProcessingParsedResponse {
|
|
|
2737
2737
|
* <p>The text returned by the parser.</p>
|
|
2738
2738
|
* @public
|
|
2739
2739
|
*/
|
|
2740
|
-
text?: string;
|
|
2740
|
+
text?: string | undefined;
|
|
2741
2741
|
}
|
|
2742
2742
|
/**
|
|
2743
2743
|
* <p>The foundation model output from the post-processing step.</p>
|
|
@@ -2748,26 +2748,26 @@ export interface PostProcessingModelInvocationOutput {
|
|
|
2748
2748
|
* <p>The unique identifier of the trace.</p>
|
|
2749
2749
|
* @public
|
|
2750
2750
|
*/
|
|
2751
|
-
traceId?: string;
|
|
2751
|
+
traceId?: string | undefined;
|
|
2752
2752
|
/**
|
|
2753
2753
|
* <p>Details about the response from the Lambda parsing of the output of the post-processing step.</p>
|
|
2754
2754
|
* @public
|
|
2755
2755
|
*/
|
|
2756
|
-
parsedResponse?: PostProcessingParsedResponse;
|
|
2756
|
+
parsedResponse?: PostProcessingParsedResponse | undefined;
|
|
2757
2757
|
/**
|
|
2758
2758
|
* <p>
|
|
2759
2759
|
* Details of the raw response from the foundation model output.
|
|
2760
2760
|
* </p>
|
|
2761
2761
|
* @public
|
|
2762
2762
|
*/
|
|
2763
|
-
rawResponse?: RawResponse;
|
|
2763
|
+
rawResponse?: RawResponse | undefined;
|
|
2764
2764
|
/**
|
|
2765
2765
|
* <p>
|
|
2766
2766
|
* Contains information about the foundation model output from the post-processing step.
|
|
2767
2767
|
* </p>
|
|
2768
2768
|
* @public
|
|
2769
2769
|
*/
|
|
2770
|
-
metadata?: Metadata;
|
|
2770
|
+
metadata?: Metadata | undefined;
|
|
2771
2771
|
}
|
|
2772
2772
|
/**
|
|
2773
2773
|
* <p>Details about the post-processing step, in which the agent shapes the response.</p>
|
|
@@ -2831,12 +2831,12 @@ export interface PreProcessingParsedResponse {
|
|
|
2831
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>
|
|
2832
2832
|
* @public
|
|
2833
2833
|
*/
|
|
2834
|
-
rationale?: string;
|
|
2834
|
+
rationale?: string | undefined;
|
|
2835
2835
|
/**
|
|
2836
2836
|
* <p>Whether the user input is valid or not. If <code>false</code>, the agent doesn't proceed to orchestration.</p>
|
|
2837
2837
|
* @public
|
|
2838
2838
|
*/
|
|
2839
|
-
isValid?: boolean;
|
|
2839
|
+
isValid?: boolean | undefined;
|
|
2840
2840
|
}
|
|
2841
2841
|
/**
|
|
2842
2842
|
* <p>The foundation model output from the pre-processing step.</p>
|
|
@@ -2847,26 +2847,26 @@ export interface PreProcessingModelInvocationOutput {
|
|
|
2847
2847
|
* <p>The unique identifier of the trace.</p>
|
|
2848
2848
|
* @public
|
|
2849
2849
|
*/
|
|
2850
|
-
traceId?: string;
|
|
2850
|
+
traceId?: string | undefined;
|
|
2851
2851
|
/**
|
|
2852
2852
|
* <p>Details about the response from the Lambda parsing of the output of the pre-processing step.</p>
|
|
2853
2853
|
* @public
|
|
2854
2854
|
*/
|
|
2855
|
-
parsedResponse?: PreProcessingParsedResponse;
|
|
2855
|
+
parsedResponse?: PreProcessingParsedResponse | undefined;
|
|
2856
2856
|
/**
|
|
2857
2857
|
* <p>
|
|
2858
2858
|
* Details of the raw response from the foundation model output.
|
|
2859
2859
|
* </p>
|
|
2860
2860
|
* @public
|
|
2861
2861
|
*/
|
|
2862
|
-
rawResponse?: RawResponse;
|
|
2862
|
+
rawResponse?: RawResponse | undefined;
|
|
2863
2863
|
/**
|
|
2864
2864
|
* <p>
|
|
2865
2865
|
* Contains information about the foundation model output from the pre-processing step.
|
|
2866
2866
|
* </p>
|
|
2867
2867
|
* @public
|
|
2868
2868
|
*/
|
|
2869
|
-
metadata?: Metadata;
|
|
2869
|
+
metadata?: Metadata | undefined;
|
|
2870
2870
|
}
|
|
2871
2871
|
/**
|
|
2872
2872
|
* <p>Details about the pre-processing step, in which the agent contextualizes and categorizes user inputs.</p>
|
|
@@ -3020,27 +3020,27 @@ export interface TracePart {
|
|
|
3020
3020
|
* <p>The unique identifier of the agent.</p>
|
|
3021
3021
|
* @public
|
|
3022
3022
|
*/
|
|
3023
|
-
agentId?: string;
|
|
3023
|
+
agentId?: string | undefined;
|
|
3024
3024
|
/**
|
|
3025
3025
|
* <p>The unique identifier of the alias of the agent.</p>
|
|
3026
3026
|
* @public
|
|
3027
3027
|
*/
|
|
3028
|
-
agentAliasId?: string;
|
|
3028
|
+
agentAliasId?: string | undefined;
|
|
3029
3029
|
/**
|
|
3030
3030
|
* <p>The unique identifier of the session with the agent.</p>
|
|
3031
3031
|
* @public
|
|
3032
3032
|
*/
|
|
3033
|
-
sessionId?: string;
|
|
3033
|
+
sessionId?: string | undefined;
|
|
3034
3034
|
/**
|
|
3035
3035
|
* <p>The version of the agent.</p>
|
|
3036
3036
|
* @public
|
|
3037
3037
|
*/
|
|
3038
|
-
agentVersion?: string;
|
|
3038
|
+
agentVersion?: string | undefined;
|
|
3039
3039
|
/**
|
|
3040
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>
|
|
3041
3041
|
* @public
|
|
3042
3042
|
*/
|
|
3043
|
-
trace?: Trace;
|
|
3043
|
+
trace?: Trace | undefined;
|
|
3044
3044
|
}
|
|
3045
3045
|
/**
|
|
3046
3046
|
* <p>The response from invoking the agent and associated citations and trace information.</p>
|
|
@@ -3371,7 +3371,7 @@ export interface InvokeAgentResponse {
|
|
|
3371
3371
|
* <p>The unique identifier of the agent memory.</p>
|
|
3372
3372
|
* @public
|
|
3373
3373
|
*/
|
|
3374
|
-
memoryId?: string;
|
|
3374
|
+
memoryId?: string | undefined;
|
|
3375
3375
|
}
|
|
3376
3376
|
/**
|
|
3377
3377
|
* @public
|
|
@@ -3391,7 +3391,7 @@ export interface DeleteAgentMemoryRequest {
|
|
|
3391
3391
|
* <p>The unique identifier of the memory.</p>
|
|
3392
3392
|
* @public
|
|
3393
3393
|
*/
|
|
3394
|
-
memoryId?: string;
|
|
3394
|
+
memoryId?: string | undefined;
|
|
3395
3395
|
}
|
|
3396
3396
|
/**
|
|
3397
3397
|
* @public
|
|
@@ -3418,14 +3418,14 @@ export interface GetAgentMemoryRequest {
|
|
|
3418
3418
|
* in the <code>nextToken</code> field in the response in this field to return the next batch of results.</p>
|
|
3419
3419
|
* @public
|
|
3420
3420
|
*/
|
|
3421
|
-
nextToken?: string;
|
|
3421
|
+
nextToken?: string | undefined;
|
|
3422
3422
|
/**
|
|
3423
3423
|
* <p>The maximum number of items to return in the response. If the total number of results is greater
|
|
3424
3424
|
* than this value, use the token returned in the response in the <code>nextToken</code> field when making another
|
|
3425
3425
|
* request to return the next batch of results.</p>
|
|
3426
3426
|
* @public
|
|
3427
3427
|
*/
|
|
3428
|
-
maxItems?: number;
|
|
3428
|
+
maxItems?: number | undefined;
|
|
3429
3429
|
/**
|
|
3430
3430
|
* <p>The unique identifier of the agent to which the alias belongs.</p>
|
|
3431
3431
|
* @public
|
|
@@ -3456,27 +3456,27 @@ export interface MemorySessionSummary {
|
|
|
3456
3456
|
* <p>The unique identifier of the memory where the session summary is stored.</p>
|
|
3457
3457
|
* @public
|
|
3458
3458
|
*/
|
|
3459
|
-
memoryId?: string;
|
|
3459
|
+
memoryId?: string | undefined;
|
|
3460
3460
|
/**
|
|
3461
3461
|
* <p>The identifier for this session.</p>
|
|
3462
3462
|
* @public
|
|
3463
3463
|
*/
|
|
3464
|
-
sessionId?: string;
|
|
3464
|
+
sessionId?: string | undefined;
|
|
3465
3465
|
/**
|
|
3466
3466
|
* <p>The start time for this session.</p>
|
|
3467
3467
|
* @public
|
|
3468
3468
|
*/
|
|
3469
|
-
sessionStartTime?: Date;
|
|
3469
|
+
sessionStartTime?: Date | undefined;
|
|
3470
3470
|
/**
|
|
3471
3471
|
* <p>The time when the memory duration for the session is set to end.</p>
|
|
3472
3472
|
* @public
|
|
3473
3473
|
*/
|
|
3474
|
-
sessionExpiryTime?: Date;
|
|
3474
|
+
sessionExpiryTime?: Date | undefined;
|
|
3475
3475
|
/**
|
|
3476
3476
|
* <p>The summarized text for this session.</p>
|
|
3477
3477
|
* @public
|
|
3478
3478
|
*/
|
|
3479
|
-
summaryText?: string;
|
|
3479
|
+
summaryText?: string | undefined;
|
|
3480
3480
|
}
|
|
3481
3481
|
/**
|
|
3482
3482
|
* <p>Contains sessions summaries.</p>
|
|
@@ -3517,12 +3517,12 @@ export interface GetAgentMemoryResponse {
|
|
|
3517
3517
|
* when making another request in the <code>nextToken</code> field to return the next batch of results.</p>
|
|
3518
3518
|
* @public
|
|
3519
3519
|
*/
|
|
3520
|
-
nextToken?: string;
|
|
3520
|
+
nextToken?: string | undefined;
|
|
3521
3521
|
/**
|
|
3522
3522
|
* <p>Contains details of the sessions stored in the memory</p>
|
|
3523
3523
|
* @public
|
|
3524
3524
|
*/
|
|
3525
|
-
memoryContents?: Memory[];
|
|
3525
|
+
memoryContents?: Memory[] | undefined;
|
|
3526
3526
|
}
|
|
3527
3527
|
/**
|
|
3528
3528
|
* <p>Contains the query made to the knowledge base.</p>
|
|
@@ -3575,19 +3575,19 @@ export interface TextInferenceConfig {
|
|
|
3575
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>
|
|
3576
3576
|
* @public
|
|
3577
3577
|
*/
|
|
3578
|
-
temperature?: number;
|
|
3578
|
+
temperature?: number | undefined;
|
|
3579
3579
|
/**
|
|
3580
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>
|
|
3581
3581
|
* @public
|
|
3582
3582
|
*/
|
|
3583
|
-
topP?: number;
|
|
3583
|
+
topP?: number | undefined;
|
|
3584
3584
|
/**
|
|
3585
3585
|
* <p>The maximum number of tokens to generate in the output text. Do not use the minimum of 0
|
|
3586
3586
|
* or the maximum of 65536. The limit values described here are arbitary values, for actual
|
|
3587
3587
|
* values consult the limits defined by your specific model.</p>
|
|
3588
3588
|
* @public
|
|
3589
3589
|
*/
|
|
3590
|
-
maxTokens?: number;
|
|
3590
|
+
maxTokens?: number | undefined;
|
|
3591
3591
|
/**
|
|
3592
3592
|
* <p>A list of sequences of characters that, if generated, will cause the model to stop
|
|
3593
3593
|
* generating further tokens. Do not use a minimum length of 1 or a maximum length of 1000. The
|
|
@@ -3595,7 +3595,7 @@ export interface TextInferenceConfig {
|
|
|
3595
3595
|
* by your specific model.</p>
|
|
3596
3596
|
* @public
|
|
3597
3597
|
*/
|
|
3598
|
-
stopSequences?: string[];
|
|
3598
|
+
stopSequences?: string[] | undefined;
|
|
3599
3599
|
}
|
|
3600
3600
|
/**
|
|
3601
3601
|
* <p> The configuration for inference settings when generating responses using RetrieveAndGenerate. </p>
|
|
@@ -3606,7 +3606,7 @@ export interface InferenceConfig {
|
|
|
3606
3606
|
* <p> Configuration settings specific to text generation while generating responses using RetrieveAndGenerate. </p>
|
|
3607
3607
|
* @public
|
|
3608
3608
|
*/
|
|
3609
|
-
textInferenceConfig?: TextInferenceConfig;
|
|
3609
|
+
textInferenceConfig?: TextInferenceConfig | undefined;
|
|
3610
3610
|
}
|
|
3611
3611
|
/**
|
|
3612
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>
|
|
@@ -3637,7 +3637,7 @@ export interface PromptTemplate {
|
|
|
3637
3637
|
* </ul>
|
|
3638
3638
|
* @public
|
|
3639
3639
|
*/
|
|
3640
|
-
textPromptTemplate?: string;
|
|
3640
|
+
textPromptTemplate?: string | undefined;
|
|
3641
3641
|
}
|
|
3642
3642
|
/**
|
|
3643
3643
|
* <p>Contains the generation configuration of the external source wrapper object.</p>
|
|
@@ -3648,22 +3648,22 @@ export interface ExternalSourcesGenerationConfiguration {
|
|
|
3648
3648
|
* <p>Contain the textPromptTemplate string for the external source wrapper object.</p>
|
|
3649
3649
|
* @public
|
|
3650
3650
|
*/
|
|
3651
|
-
promptTemplate?: PromptTemplate;
|
|
3651
|
+
promptTemplate?: PromptTemplate | undefined;
|
|
3652
3652
|
/**
|
|
3653
3653
|
* <p>The configuration details for the guardrail.</p>
|
|
3654
3654
|
* @public
|
|
3655
3655
|
*/
|
|
3656
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
3656
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
3657
3657
|
/**
|
|
3658
3658
|
* <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.</p>
|
|
3659
3659
|
* @public
|
|
3660
3660
|
*/
|
|
3661
|
-
inferenceConfig?: InferenceConfig;
|
|
3661
|
+
inferenceConfig?: InferenceConfig | undefined;
|
|
3662
3662
|
/**
|
|
3663
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>
|
|
3664
3664
|
* @public
|
|
3665
3665
|
*/
|
|
3666
|
-
additionalModelRequestFields?: Record<string, __DocumentType
|
|
3666
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
3667
3667
|
}
|
|
3668
3668
|
/**
|
|
3669
3669
|
* <p>This property contains the document to chat with, along with its attributes.</p>
|
|
@@ -3723,12 +3723,12 @@ export interface ExternalSource {
|
|
|
3723
3723
|
* <p>The S3 location of the external source wrapper object.</p>
|
|
3724
3724
|
* @public
|
|
3725
3725
|
*/
|
|
3726
|
-
s3Location?: S3ObjectDoc;
|
|
3726
|
+
s3Location?: S3ObjectDoc | undefined;
|
|
3727
3727
|
/**
|
|
3728
3728
|
* <p>The identifier, contentType, and data of the external source wrapper object.</p>
|
|
3729
3729
|
* @public
|
|
3730
3730
|
*/
|
|
3731
|
-
byteContent?: ByteContentDoc;
|
|
3731
|
+
byteContent?: ByteContentDoc | undefined;
|
|
3732
3732
|
}
|
|
3733
3733
|
/**
|
|
3734
3734
|
* <p>The configurations of the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
|
|
@@ -3749,7 +3749,7 @@ export interface ExternalSourcesRetrieveAndGenerateConfiguration {
|
|
|
3749
3749
|
* <p>The prompt used with the external source wrapper object with the <code>retrieveAndGenerate</code> function.</p>
|
|
3750
3750
|
* @public
|
|
3751
3751
|
*/
|
|
3752
|
-
generationConfiguration?: ExternalSourcesGenerationConfiguration;
|
|
3752
|
+
generationConfiguration?: ExternalSourcesGenerationConfiguration | undefined;
|
|
3753
3753
|
}
|
|
3754
3754
|
/**
|
|
3755
3755
|
* <p>Contains configurations for response generation based on the knowledge base query results.</p>
|
|
@@ -3768,22 +3768,22 @@ export interface GenerationConfiguration {
|
|
|
3768
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>
|
|
3769
3769
|
* @public
|
|
3770
3770
|
*/
|
|
3771
|
-
promptTemplate?: PromptTemplate;
|
|
3771
|
+
promptTemplate?: PromptTemplate | undefined;
|
|
3772
3772
|
/**
|
|
3773
3773
|
* <p>The configuration details for the guardrail.</p>
|
|
3774
3774
|
* @public
|
|
3775
3775
|
*/
|
|
3776
|
-
guardrailConfiguration?: GuardrailConfiguration;
|
|
3776
|
+
guardrailConfiguration?: GuardrailConfiguration | undefined;
|
|
3777
3777
|
/**
|
|
3778
3778
|
* <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>
|
|
3779
3779
|
* @public
|
|
3780
3780
|
*/
|
|
3781
|
-
inferenceConfig?: InferenceConfig;
|
|
3781
|
+
inferenceConfig?: InferenceConfig | undefined;
|
|
3782
3782
|
/**
|
|
3783
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>
|
|
3784
3784
|
* @public
|
|
3785
3785
|
*/
|
|
3786
|
-
additionalModelRequestFields?: Record<string, __DocumentType
|
|
3786
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
3787
3787
|
}
|
|
3788
3788
|
/**
|
|
3789
3789
|
* @public
|
|
@@ -3817,23 +3817,23 @@ export interface OrchestrationConfiguration {
|
|
|
3817
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>
|
|
3818
3818
|
* @public
|
|
3819
3819
|
*/
|
|
3820
|
-
promptTemplate?: PromptTemplate;
|
|
3820
|
+
promptTemplate?: PromptTemplate | undefined;
|
|
3821
3821
|
/**
|
|
3822
3822
|
* <p> Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source. </p>
|
|
3823
3823
|
* @public
|
|
3824
3824
|
*/
|
|
3825
|
-
inferenceConfig?: InferenceConfig;
|
|
3825
|
+
inferenceConfig?: InferenceConfig | undefined;
|
|
3826
3826
|
/**
|
|
3827
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>
|
|
3828
3828
|
* @public
|
|
3829
3829
|
*/
|
|
3830
|
-
additionalModelRequestFields?: Record<string, __DocumentType
|
|
3830
|
+
additionalModelRequestFields?: Record<string, __DocumentType> | undefined;
|
|
3831
3831
|
/**
|
|
3832
3832
|
* <p>To split up the prompt and retrieve multiple sources, set the transformation type to
|
|
3833
3833
|
* <code>QUERY_DECOMPOSITION</code>.</p>
|
|
3834
3834
|
* @public
|
|
3835
3835
|
*/
|
|
3836
|
-
queryTransformationConfiguration?: QueryTransformationConfiguration;
|
|
3836
|
+
queryTransformationConfiguration?: QueryTransformationConfiguration | undefined;
|
|
3837
3837
|
}
|
|
3838
3838
|
/**
|
|
3839
3839
|
* @public
|
|
@@ -3913,12 +3913,12 @@ export interface RetrieveAndGenerateResponse {
|
|
|
3913
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>
|
|
3914
3914
|
* @public
|
|
3915
3915
|
*/
|
|
3916
|
-
citations?: Citation[];
|
|
3916
|
+
citations?: Citation[] | undefined;
|
|
3917
3917
|
/**
|
|
3918
3918
|
* <p>Specifies if there is a guardrail intervention in the response.</p>
|
|
3919
3919
|
* @public
|
|
3920
3920
|
*/
|
|
3921
|
-
guardrailAction?: GuadrailAction;
|
|
3921
|
+
guardrailAction?: GuadrailAction | undefined;
|
|
3922
3922
|
}
|
|
3923
3923
|
/**
|
|
3924
3924
|
* <p>Contains the query made to the knowledge base.</p>
|
|
@@ -3959,17 +3959,17 @@ export interface KnowledgeBaseRetrievalResult {
|
|
|
3959
3959
|
* <p>Contains information about the location of the data source.</p>
|
|
3960
3960
|
* @public
|
|
3961
3961
|
*/
|
|
3962
|
-
location?: RetrievalResultLocation;
|
|
3962
|
+
location?: RetrievalResultLocation | undefined;
|
|
3963
3963
|
/**
|
|
3964
3964
|
* <p>The level of relevance of the result to the query.</p>
|
|
3965
3965
|
* @public
|
|
3966
3966
|
*/
|
|
3967
|
-
score?: number;
|
|
3967
|
+
score?: number | undefined;
|
|
3968
3968
|
/**
|
|
3969
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>
|
|
3970
3970
|
* @public
|
|
3971
3971
|
*/
|
|
3972
|
-
metadata?: Record<string, __DocumentType
|
|
3972
|
+
metadata?: Record<string, __DocumentType> | undefined;
|
|
3973
3973
|
}
|
|
3974
3974
|
/**
|
|
3975
3975
|
* @public
|
|
@@ -3984,7 +3984,7 @@ export interface RetrieveResponse {
|
|
|
3984
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>
|
|
3985
3985
|
* @public
|
|
3986
3986
|
*/
|
|
3987
|
-
nextToken?: string;
|
|
3987
|
+
nextToken?: string | undefined;
|
|
3988
3988
|
}
|
|
3989
3989
|
/**
|
|
3990
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>
|
|
@@ -4377,17 +4377,17 @@ export interface KnowledgeBaseVectorSearchConfiguration {
|
|
|
4377
4377
|
* <p>The number of source chunks to retrieve.</p>
|
|
4378
4378
|
* @public
|
|
4379
4379
|
*/
|
|
4380
|
-
numberOfResults?: number;
|
|
4380
|
+
numberOfResults?: number | undefined;
|
|
4381
4381
|
/**
|
|
4382
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>
|
|
4383
4383
|
* @public
|
|
4384
4384
|
*/
|
|
4385
|
-
overrideSearchType?: SearchType;
|
|
4385
|
+
overrideSearchType?: SearchType | undefined;
|
|
4386
4386
|
/**
|
|
4387
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>
|
|
4388
4388
|
* @public
|
|
4389
4389
|
*/
|
|
4390
|
-
filter?: RetrievalFilter;
|
|
4390
|
+
filter?: RetrievalFilter | undefined;
|
|
4391
4391
|
}
|
|
4392
4392
|
/**
|
|
4393
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>
|
|
@@ -4457,17 +4457,17 @@ export interface KnowledgeBaseRetrieveAndGenerateConfiguration {
|
|
|
4457
4457
|
* <p>Contains configurations for how to retrieve and return the knowledge base query.</p>
|
|
4458
4458
|
* @public
|
|
4459
4459
|
*/
|
|
4460
|
-
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
|
|
4460
|
+
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
4461
4461
|
/**
|
|
4462
4462
|
* <p>Contains configurations for response generation based on the knowledge base query results.</p>
|
|
4463
4463
|
* @public
|
|
4464
4464
|
*/
|
|
4465
|
-
generationConfiguration?: GenerationConfiguration;
|
|
4465
|
+
generationConfiguration?: GenerationConfiguration | undefined;
|
|
4466
4466
|
/**
|
|
4467
4467
|
* <p>Settings for how the model processes the prompt prior to retrieval and generation.</p>
|
|
4468
4468
|
* @public
|
|
4469
4469
|
*/
|
|
4470
|
-
orchestrationConfiguration?: OrchestrationConfiguration;
|
|
4470
|
+
orchestrationConfiguration?: OrchestrationConfiguration | undefined;
|
|
4471
4471
|
}
|
|
4472
4472
|
/**
|
|
4473
4473
|
* @public
|
|
@@ -4487,12 +4487,12 @@ export interface RetrieveRequest {
|
|
|
4487
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>
|
|
4488
4488
|
* @public
|
|
4489
4489
|
*/
|
|
4490
|
-
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration;
|
|
4490
|
+
retrievalConfiguration?: KnowledgeBaseRetrievalConfiguration | undefined;
|
|
4491
4491
|
/**
|
|
4492
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>
|
|
4493
4493
|
* @public
|
|
4494
4494
|
*/
|
|
4495
|
-
nextToken?: string;
|
|
4495
|
+
nextToken?: string | undefined;
|
|
4496
4496
|
}
|
|
4497
4497
|
/**
|
|
4498
4498
|
* <p>Contains details about the resource being queried.</p>
|
|
@@ -4516,12 +4516,12 @@ export interface RetrieveAndGenerateConfiguration {
|
|
|
4516
4516
|
* <p>Contains details about the knowledge base for retrieving information and generating responses.</p>
|
|
4517
4517
|
* @public
|
|
4518
4518
|
*/
|
|
4519
|
-
knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration;
|
|
4519
|
+
knowledgeBaseConfiguration?: KnowledgeBaseRetrieveAndGenerateConfiguration | undefined;
|
|
4520
4520
|
/**
|
|
4521
4521
|
* <p>The configuration for the external source wrapper object in the <code>retrieveAndGenerate</code> function.</p>
|
|
4522
4522
|
* @public
|
|
4523
4523
|
*/
|
|
4524
|
-
externalSourcesConfiguration?: ExternalSourcesRetrieveAndGenerateConfiguration;
|
|
4524
|
+
externalSourcesConfiguration?: ExternalSourcesRetrieveAndGenerateConfiguration | undefined;
|
|
4525
4525
|
}
|
|
4526
4526
|
/**
|
|
4527
4527
|
* @public
|
|
@@ -4531,7 +4531,7 @@ export interface RetrieveAndGenerateRequest {
|
|
|
4531
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>
|
|
4532
4532
|
* @public
|
|
4533
4533
|
*/
|
|
4534
|
-
sessionId?: string;
|
|
4534
|
+
sessionId?: string | undefined;
|
|
4535
4535
|
/**
|
|
4536
4536
|
* <p>Contains the query to be made to the knowledge base.</p>
|
|
4537
4537
|
* @public
|
|
@@ -4541,12 +4541,12 @@ export interface RetrieveAndGenerateRequest {
|
|
|
4541
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>
|
|
4542
4542
|
* @public
|
|
4543
4543
|
*/
|
|
4544
|
-
retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration;
|
|
4544
|
+
retrieveAndGenerateConfiguration?: RetrieveAndGenerateConfiguration | undefined;
|
|
4545
4545
|
/**
|
|
4546
4546
|
* <p>Contains details about the session with the knowledge base.</p>
|
|
4547
4547
|
* @public
|
|
4548
4548
|
*/
|
|
4549
|
-
sessionConfiguration?: RetrieveAndGenerateSessionConfiguration;
|
|
4549
|
+
sessionConfiguration?: RetrieveAndGenerateSessionConfiguration | undefined;
|
|
4550
4550
|
}
|
|
4551
4551
|
/**
|
|
4552
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>
|
|
@@ -4557,12 +4557,12 @@ export interface SessionState {
|
|
|
4557
4557
|
* <p>Contains attributes that persist across a session and the values of those attributes.</p>
|
|
4558
4558
|
* @public
|
|
4559
4559
|
*/
|
|
4560
|
-
sessionAttributes?: Record<string, string
|
|
4560
|
+
sessionAttributes?: Record<string, string> | undefined;
|
|
4561
4561
|
/**
|
|
4562
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>
|
|
4563
4563
|
* @public
|
|
4564
4564
|
*/
|
|
4565
|
-
promptSessionAttributes?: Record<string, string
|
|
4565
|
+
promptSessionAttributes?: Record<string, string> | undefined;
|
|
4566
4566
|
/**
|
|
4567
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>
|
|
4568
4568
|
* <note>
|
|
@@ -4570,22 +4570,22 @@ export interface SessionState {
|
|
|
4570
4570
|
* </note>
|
|
4571
4571
|
* @public
|
|
4572
4572
|
*/
|
|
4573
|
-
returnControlInvocationResults?: InvocationResultMember[];
|
|
4573
|
+
returnControlInvocationResults?: InvocationResultMember[] | undefined;
|
|
4574
4574
|
/**
|
|
4575
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>
|
|
4576
4576
|
* @public
|
|
4577
4577
|
*/
|
|
4578
|
-
invocationId?: string;
|
|
4578
|
+
invocationId?: string | undefined;
|
|
4579
4579
|
/**
|
|
4580
4580
|
* <p>Contains information about the files used by code interpreter.</p>
|
|
4581
4581
|
* @public
|
|
4582
4582
|
*/
|
|
4583
|
-
files?: InputFile[];
|
|
4583
|
+
files?: InputFile[] | undefined;
|
|
4584
4584
|
/**
|
|
4585
4585
|
* <p>An array of configurations, each of which applies to a knowledge base attached to the agent.</p>
|
|
4586
4586
|
* @public
|
|
4587
4587
|
*/
|
|
4588
|
-
knowledgeBaseConfigurations?: KnowledgeBaseConfiguration[];
|
|
4588
|
+
knowledgeBaseConfigurations?: KnowledgeBaseConfiguration[] | undefined;
|
|
4589
4589
|
}
|
|
4590
4590
|
/**
|
|
4591
4591
|
* @public
|
|
@@ -4598,7 +4598,7 @@ export interface InvokeAgentRequest {
|
|
|
4598
4598
|
* </note>
|
|
4599
4599
|
* @public
|
|
4600
4600
|
*/
|
|
4601
|
-
sessionState?: SessionState;
|
|
4601
|
+
sessionState?: SessionState | undefined;
|
|
4602
4602
|
/**
|
|
4603
4603
|
* <p>The unique identifier of the agent to use.</p>
|
|
4604
4604
|
* @public
|
|
@@ -4618,12 +4618,12 @@ export interface InvokeAgentRequest {
|
|
|
4618
4618
|
* <p>Specifies whether to end the session with the agent or not.</p>
|
|
4619
4619
|
* @public
|
|
4620
4620
|
*/
|
|
4621
|
-
endSession?: boolean;
|
|
4621
|
+
endSession?: boolean | undefined;
|
|
4622
4622
|
/**
|
|
4623
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>
|
|
4624
4624
|
* @public
|
|
4625
4625
|
*/
|
|
4626
|
-
enableTrace?: boolean;
|
|
4626
|
+
enableTrace?: boolean | undefined;
|
|
4627
4627
|
/**
|
|
4628
4628
|
* <p>The prompt text to send the agent.</p>
|
|
4629
4629
|
* <note>
|
|
@@ -4631,12 +4631,12 @@ export interface InvokeAgentRequest {
|
|
|
4631
4631
|
* </note>
|
|
4632
4632
|
* @public
|
|
4633
4633
|
*/
|
|
4634
|
-
inputText?: string;
|
|
4634
|
+
inputText?: string | undefined;
|
|
4635
4635
|
/**
|
|
4636
4636
|
* <p>The unique identifier of the agent memory.</p>
|
|
4637
4637
|
* @public
|
|
4638
4638
|
*/
|
|
4639
|
-
memoryId?: string;
|
|
4639
|
+
memoryId?: string | undefined;
|
|
4640
4640
|
}
|
|
4641
4641
|
/**
|
|
4642
4642
|
* @internal
|