@aws-sdk/client-bedrock-agent-runtime 3.1069.0 → 3.1071.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -0
- package/dist-cjs/index.js +93 -8
- package/dist-cjs/models/errors.js +42 -42
- package/dist-cjs/runtimeConfig.js +5 -2
- package/dist-cjs/schemas/schemas_0.js +567 -139
- package/dist-es/BedrockAgentRuntime.js +4 -0
- package/dist-es/commands/AgenticRetrieveStreamCommand.js +20 -0
- package/dist-es/commands/GetDocumentContentCommand.js +16 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/enums.js +50 -7
- package/dist-es/models/errors.js +42 -42
- package/dist-es/runtimeConfig.js +5 -2
- package/dist-es/schemas/schemas_0.js +521 -139
- package/dist-types/BedrockAgentRuntime.d.ts +14 -0
- package/dist-types/BedrockAgentRuntimeClient.d.ts +4 -2
- package/dist-types/commands/AgenticRetrieveStreamCommand.d.ts +338 -0
- package/dist-types/commands/GetDocumentContentCommand.d.ts +99 -0
- package/dist-types/commands/GetInvocationStepCommand.d.ts +1 -1
- package/dist-types/commands/InvokeAgentCommand.d.ts +55 -4
- package/dist-types/commands/InvokeFlowCommand.d.ts +14 -2
- package/dist-types/commands/InvokeInlineAgentCommand.d.ts +78 -8
- package/dist-types/commands/ListFlowExecutionEventsCommand.d.ts +14 -2
- package/dist-types/commands/ListInvocationStepsCommand.d.ts +1 -1
- package/dist-types/commands/ListInvocationsCommand.d.ts +1 -1
- package/dist-types/commands/ListSessionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/PutInvocationStepCommand.d.ts +1 -1
- package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +45 -3
- package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +52 -4
- package/dist-types/commands/RetrieveCommand.d.ts +45 -2
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSessionCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/enums.d.ts +163 -16
- package/dist-types/models/errors.d.ts +45 -45
- package/dist-types/models/models_0.d.ts +4105 -4355
- package/dist-types/models/models_1.d.ts +1396 -2
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/schemas/schemas_0.d.ts +48 -0
- package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +34 -0
- package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/AgenticRetrieveStreamCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetDocumentContentCommand.d.ts +53 -0
- package/dist-types/ts3.4/commands/GetInvocationStepCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/InvokeAgentCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListInvocationStepsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListInvocationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSessionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutInvocationStepCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RetrieveAndGenerateCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSessionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/enums.d.ts +74 -11
- package/dist-types/ts3.4/models/errors.d.ts +28 -28
- package/dist-types/ts3.4/models/models_0.d.ts +448 -541
- package/dist-types/ts3.4/models/models_1.d.ts +602 -3
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +48 -0
- package/package.json +3 -3
|
@@ -504,7 +504,7 @@ declare const InvokeFlowCommand_base: {
|
|
|
504
504
|
* // ],
|
|
505
505
|
* // },
|
|
506
506
|
* // location: { // RetrievalResultLocation
|
|
507
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
|
|
507
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
|
|
508
508
|
* // s3Location: { // RetrievalResultS3Location
|
|
509
509
|
* // uri: "STRING_VALUE",
|
|
510
510
|
* // },
|
|
@@ -529,6 +529,12 @@ declare const InvokeFlowCommand_base: {
|
|
|
529
529
|
* // sqlLocation: { // RetrievalResultSqlLocation
|
|
530
530
|
* // query: "STRING_VALUE",
|
|
531
531
|
* // },
|
|
532
|
+
* // oneDriveLocation: { // RetrievalResultOneDriveLocation
|
|
533
|
+
* // url: "STRING_VALUE",
|
|
534
|
+
* // },
|
|
535
|
+
* // googleDriveLocation: { // RetrievalResultGoogleDriveLocation
|
|
536
|
+
* // url: "STRING_VALUE",
|
|
537
|
+
* // },
|
|
532
538
|
* // },
|
|
533
539
|
* // metadata: { // RetrievalResultMetadata
|
|
534
540
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -800,7 +806,7 @@ declare const InvokeFlowCommand_base: {
|
|
|
800
806
|
* // ],
|
|
801
807
|
* // },
|
|
802
808
|
* // location: {
|
|
803
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
|
|
809
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
|
|
804
810
|
* // s3Location: {
|
|
805
811
|
* // uri: "STRING_VALUE",
|
|
806
812
|
* // },
|
|
@@ -825,6 +831,12 @@ declare const InvokeFlowCommand_base: {
|
|
|
825
831
|
* // sqlLocation: {
|
|
826
832
|
* // query: "STRING_VALUE",
|
|
827
833
|
* // },
|
|
834
|
+
* // oneDriveLocation: {
|
|
835
|
+
* // url: "STRING_VALUE",
|
|
836
|
+
* // },
|
|
837
|
+
* // googleDriveLocation: {
|
|
838
|
+
* // url: "STRING_VALUE",
|
|
839
|
+
* // },
|
|
828
840
|
* // },
|
|
829
841
|
* // metadata: {
|
|
830
842
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -179,6 +179,38 @@ declare const InvokeInlineAgentCommand_base: {
|
|
|
179
179
|
* modelArn: "STRING_VALUE", // required
|
|
180
180
|
* },
|
|
181
181
|
* },
|
|
182
|
+
* managedSearchConfiguration: { // ManagedSearchConfiguration
|
|
183
|
+
* numberOfResults: Number("int"),
|
|
184
|
+
* filter: "<RetrievalFilter>",
|
|
185
|
+
* rerankingModelType: "CUSTOM" || "MANAGED" || "NONE",
|
|
186
|
+
* rerankingConfiguration: { // ManagedSearchRerankingConfiguration
|
|
187
|
+
* type: "BEDROCK_RERANKING_MODEL", // required
|
|
188
|
+
* bedrockRerankingConfiguration: { // ManagedSearchBedrockRerankingConfiguration
|
|
189
|
+
* modelConfiguration: { // ManagedSearchBedrockRerankingModelConfiguration
|
|
190
|
+
* modelArn: "STRING_VALUE", // required
|
|
191
|
+
* additionalModelRequestFields: {
|
|
192
|
+
* "<keys>": "DOCUMENT_VALUE",
|
|
193
|
+
* },
|
|
194
|
+
* },
|
|
195
|
+
* numberOfRerankedResults: Number("int"),
|
|
196
|
+
* metadataConfiguration: {
|
|
197
|
+
* selectionMode: "SELECTIVE" || "ALL", // required
|
|
198
|
+
* selectiveModeConfiguration: {// Union: only one key present
|
|
199
|
+
* fieldsToInclude: [
|
|
200
|
+
* {
|
|
201
|
+
* fieldName: "STRING_VALUE", // required
|
|
202
|
+
* },
|
|
203
|
+
* ],
|
|
204
|
+
* fieldsToExclude: [
|
|
205
|
+
* {
|
|
206
|
+
* fieldName: "STRING_VALUE", // required
|
|
207
|
+
* },
|
|
208
|
+
* ],
|
|
209
|
+
* },
|
|
210
|
+
* },
|
|
211
|
+
* },
|
|
212
|
+
* },
|
|
213
|
+
* },
|
|
182
214
|
* },
|
|
183
215
|
* },
|
|
184
216
|
* ],
|
|
@@ -384,11 +416,7 @@ declare const InvokeInlineAgentCommand_base: {
|
|
|
384
416
|
* fieldName: "STRING_VALUE", // required
|
|
385
417
|
* },
|
|
386
418
|
* ],
|
|
387
|
-
* fieldsToExclude:
|
|
388
|
-
* {
|
|
389
|
-
* fieldName: "STRING_VALUE", // required
|
|
390
|
-
* },
|
|
391
|
-
* ],
|
|
419
|
+
* fieldsToExclude: "<FieldsForReranking>",
|
|
392
420
|
* },
|
|
393
421
|
* },
|
|
394
422
|
* },
|
|
@@ -404,6 +432,30 @@ declare const InvokeInlineAgentCommand_base: {
|
|
|
404
432
|
* modelArn: "STRING_VALUE", // required
|
|
405
433
|
* },
|
|
406
434
|
* },
|
|
435
|
+
* managedSearchConfiguration: {
|
|
436
|
+
* numberOfResults: Number("int"),
|
|
437
|
+
* filter: "<RetrievalFilter>",
|
|
438
|
+
* rerankingModelType: "CUSTOM" || "MANAGED" || "NONE",
|
|
439
|
+
* rerankingConfiguration: {
|
|
440
|
+
* type: "BEDROCK_RERANKING_MODEL", // required
|
|
441
|
+
* bedrockRerankingConfiguration: {
|
|
442
|
+
* modelConfiguration: {
|
|
443
|
+
* modelArn: "STRING_VALUE", // required
|
|
444
|
+
* additionalModelRequestFields: {
|
|
445
|
+
* "<keys>": "DOCUMENT_VALUE",
|
|
446
|
+
* },
|
|
447
|
+
* },
|
|
448
|
+
* numberOfRerankedResults: Number("int"),
|
|
449
|
+
* metadataConfiguration: {
|
|
450
|
+
* selectionMode: "SELECTIVE" || "ALL", // required
|
|
451
|
+
* selectiveModeConfiguration: {// Union: only one key present
|
|
452
|
+
* fieldsToInclude: "<FieldsForReranking>",
|
|
453
|
+
* fieldsToExclude: "<FieldsForReranking>",
|
|
454
|
+
* },
|
|
455
|
+
* },
|
|
456
|
+
* },
|
|
457
|
+
* },
|
|
458
|
+
* },
|
|
407
459
|
* },
|
|
408
460
|
* },
|
|
409
461
|
* ],
|
|
@@ -499,7 +551,7 @@ declare const InvokeInlineAgentCommand_base: {
|
|
|
499
551
|
* // ],
|
|
500
552
|
* // },
|
|
501
553
|
* // location: { // RetrievalResultLocation
|
|
502
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
|
|
554
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
|
|
503
555
|
* // s3Location: { // RetrievalResultS3Location
|
|
504
556
|
* // uri: "STRING_VALUE",
|
|
505
557
|
* // },
|
|
@@ -524,6 +576,12 @@ declare const InvokeInlineAgentCommand_base: {
|
|
|
524
576
|
* // sqlLocation: { // RetrievalResultSqlLocation
|
|
525
577
|
* // query: "STRING_VALUE",
|
|
526
578
|
* // },
|
|
579
|
+
* // oneDriveLocation: { // RetrievalResultOneDriveLocation
|
|
580
|
+
* // url: "STRING_VALUE",
|
|
581
|
+
* // },
|
|
582
|
+
* // googleDriveLocation: { // RetrievalResultGoogleDriveLocation
|
|
583
|
+
* // url: "STRING_VALUE",
|
|
584
|
+
* // },
|
|
527
585
|
* // },
|
|
528
586
|
* // metadata: { // RetrievalResultMetadata
|
|
529
587
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -895,7 +953,7 @@ declare const InvokeInlineAgentCommand_base: {
|
|
|
895
953
|
* // ],
|
|
896
954
|
* // },
|
|
897
955
|
* // location: {
|
|
898
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
|
|
956
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
|
|
899
957
|
* // s3Location: {
|
|
900
958
|
* // uri: "STRING_VALUE",
|
|
901
959
|
* // },
|
|
@@ -920,6 +978,12 @@ declare const InvokeInlineAgentCommand_base: {
|
|
|
920
978
|
* // sqlLocation: {
|
|
921
979
|
* // query: "STRING_VALUE",
|
|
922
980
|
* // },
|
|
981
|
+
* // oneDriveLocation: {
|
|
982
|
+
* // url: "STRING_VALUE",
|
|
983
|
+
* // },
|
|
984
|
+
* // googleDriveLocation: {
|
|
985
|
+
* // url: "STRING_VALUE",
|
|
986
|
+
* // },
|
|
923
987
|
* // },
|
|
924
988
|
* // metadata: {
|
|
925
989
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -1191,7 +1255,7 @@ declare const InvokeInlineAgentCommand_base: {
|
|
|
1191
1255
|
* // ],
|
|
1192
1256
|
* // },
|
|
1193
1257
|
* // location: {
|
|
1194
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
|
|
1258
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
|
|
1195
1259
|
* // s3Location: {
|
|
1196
1260
|
* // uri: "STRING_VALUE",
|
|
1197
1261
|
* // },
|
|
@@ -1216,6 +1280,12 @@ declare const InvokeInlineAgentCommand_base: {
|
|
|
1216
1280
|
* // sqlLocation: {
|
|
1217
1281
|
* // query: "STRING_VALUE",
|
|
1218
1282
|
* // },
|
|
1283
|
+
* // oneDriveLocation: {
|
|
1284
|
+
* // url: "STRING_VALUE",
|
|
1285
|
+
* // },
|
|
1286
|
+
* // googleDriveLocation: {
|
|
1287
|
+
* // url: "STRING_VALUE",
|
|
1288
|
+
* // },
|
|
1219
1289
|
* // },
|
|
1220
1290
|
* // metadata: {
|
|
1221
1291
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -515,7 +515,7 @@ declare const ListFlowExecutionEventsCommand_base: {
|
|
|
515
515
|
* // ],
|
|
516
516
|
* // },
|
|
517
517
|
* // location: { // RetrievalResultLocation
|
|
518
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
|
|
518
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
|
|
519
519
|
* // s3Location: { // RetrievalResultS3Location
|
|
520
520
|
* // uri: "STRING_VALUE",
|
|
521
521
|
* // },
|
|
@@ -540,6 +540,12 @@ declare const ListFlowExecutionEventsCommand_base: {
|
|
|
540
540
|
* // sqlLocation: { // RetrievalResultSqlLocation
|
|
541
541
|
* // query: "STRING_VALUE",
|
|
542
542
|
* // },
|
|
543
|
+
* // oneDriveLocation: { // RetrievalResultOneDriveLocation
|
|
544
|
+
* // url: "STRING_VALUE",
|
|
545
|
+
* // },
|
|
546
|
+
* // googleDriveLocation: { // RetrievalResultGoogleDriveLocation
|
|
547
|
+
* // url: "STRING_VALUE",
|
|
548
|
+
* // },
|
|
543
549
|
* // },
|
|
544
550
|
* // metadata: { // RetrievalResultMetadata
|
|
545
551
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -811,7 +817,7 @@ declare const ListFlowExecutionEventsCommand_base: {
|
|
|
811
817
|
* // ],
|
|
812
818
|
* // },
|
|
813
819
|
* // location: {
|
|
814
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
|
|
820
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
|
|
815
821
|
* // s3Location: {
|
|
816
822
|
* // uri: "STRING_VALUE",
|
|
817
823
|
* // },
|
|
@@ -836,6 +842,12 @@ declare const ListFlowExecutionEventsCommand_base: {
|
|
|
836
842
|
* // sqlLocation: {
|
|
837
843
|
* // query: "STRING_VALUE",
|
|
838
844
|
* // },
|
|
845
|
+
* // oneDriveLocation: {
|
|
846
|
+
* // url: "STRING_VALUE",
|
|
847
|
+
* // },
|
|
848
|
+
* // googleDriveLocation: {
|
|
849
|
+
* // url: "STRING_VALUE",
|
|
850
|
+
* // },
|
|
839
851
|
* // },
|
|
840
852
|
* // metadata: {
|
|
841
853
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import type { ListInvocationStepsRequest, ListInvocationStepsResponse } from "../models/
|
|
4
|
+
import type { ListInvocationStepsRequest, ListInvocationStepsResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import type { ListInvocationsRequest, ListInvocationsResponse } from "../models/
|
|
4
|
+
import type { ListInvocationsRequest, ListInvocationsResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import type { ListSessionsRequest, ListSessionsResponse } from "../models/
|
|
4
|
+
import type { ListSessionsRequest, ListSessionsResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import type { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/
|
|
4
|
+
import type { ListTagsForResourceRequest, ListTagsForResourceResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import type { PutInvocationStepRequest, PutInvocationStepResponse } from "../models/
|
|
4
|
+
import type { PutInvocationStepRequest, PutInvocationStepResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import type {
|
|
4
|
+
import type { RetrieveAndGenerateResponse } from "../models/models_0";
|
|
5
|
+
import type { RetrieveAndGenerateRequest } from "../models/models_1";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -29,7 +30,7 @@ declare const RetrieveAndGenerateCommand_base: {
|
|
|
29
30
|
};
|
|
30
31
|
};
|
|
31
32
|
/**
|
|
32
|
-
* <p>Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>. The response only cites sources that are relevant to the query.</p>
|
|
33
|
+
* <p>Queries a knowledge base and generates responses based on the retrieved results and using the specified foundation model or <a href="https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html">inference profile</a>. The response only cites sources that are relevant to the query.</p> <note> <p>This API cannot be used with managed knowledge bases. Use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_AgenticRetrieveStream.html">AgenticRetrieveStream</a> or <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html">Retrieve</a> with managed knowledge bases.</p> </note>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -142,6 +143,38 @@ declare const RetrieveAndGenerateCommand_base: {
|
|
|
142
143
|
* modelArn: "STRING_VALUE", // required
|
|
143
144
|
* },
|
|
144
145
|
* },
|
|
146
|
+
* managedSearchConfiguration: { // ManagedSearchConfiguration
|
|
147
|
+
* numberOfResults: Number("int"),
|
|
148
|
+
* filter: "<RetrievalFilter>",
|
|
149
|
+
* rerankingModelType: "CUSTOM" || "MANAGED" || "NONE",
|
|
150
|
+
* rerankingConfiguration: { // ManagedSearchRerankingConfiguration
|
|
151
|
+
* type: "BEDROCK_RERANKING_MODEL", // required
|
|
152
|
+
* bedrockRerankingConfiguration: { // ManagedSearchBedrockRerankingConfiguration
|
|
153
|
+
* modelConfiguration: { // ManagedSearchBedrockRerankingModelConfiguration
|
|
154
|
+
* modelArn: "STRING_VALUE", // required
|
|
155
|
+
* additionalModelRequestFields: {
|
|
156
|
+
* "<keys>": "DOCUMENT_VALUE",
|
|
157
|
+
* },
|
|
158
|
+
* },
|
|
159
|
+
* numberOfRerankedResults: Number("int"),
|
|
160
|
+
* metadataConfiguration: {
|
|
161
|
+
* selectionMode: "SELECTIVE" || "ALL", // required
|
|
162
|
+
* selectiveModeConfiguration: {// Union: only one key present
|
|
163
|
+
* fieldsToInclude: [
|
|
164
|
+
* {
|
|
165
|
+
* fieldName: "STRING_VALUE", // required
|
|
166
|
+
* },
|
|
167
|
+
* ],
|
|
168
|
+
* fieldsToExclude: [
|
|
169
|
+
* {
|
|
170
|
+
* fieldName: "STRING_VALUE", // required
|
|
171
|
+
* },
|
|
172
|
+
* ],
|
|
173
|
+
* },
|
|
174
|
+
* },
|
|
175
|
+
* },
|
|
176
|
+
* },
|
|
177
|
+
* },
|
|
145
178
|
* },
|
|
146
179
|
* generationConfiguration: { // GenerationConfiguration
|
|
147
180
|
* promptTemplate: { // PromptTemplate
|
|
@@ -238,6 +271,9 @@ declare const RetrieveAndGenerateCommand_base: {
|
|
|
238
271
|
* sessionConfiguration: { // RetrieveAndGenerateSessionConfiguration
|
|
239
272
|
* kmsKeyArn: "STRING_VALUE", // required
|
|
240
273
|
* },
|
|
274
|
+
* userContext: { // UserContext
|
|
275
|
+
* userId: "STRING_VALUE", // required
|
|
276
|
+
* },
|
|
241
277
|
* };
|
|
242
278
|
* const command = new RetrieveAndGenerateCommand(input);
|
|
243
279
|
* const response = await client.send(command);
|
|
@@ -280,7 +316,7 @@ declare const RetrieveAndGenerateCommand_base: {
|
|
|
280
316
|
* // ],
|
|
281
317
|
* // },
|
|
282
318
|
* // location: { // RetrievalResultLocation
|
|
283
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
|
|
319
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
|
|
284
320
|
* // s3Location: { // RetrievalResultS3Location
|
|
285
321
|
* // uri: "STRING_VALUE",
|
|
286
322
|
* // },
|
|
@@ -305,6 +341,12 @@ declare const RetrieveAndGenerateCommand_base: {
|
|
|
305
341
|
* // sqlLocation: { // RetrievalResultSqlLocation
|
|
306
342
|
* // query: "STRING_VALUE",
|
|
307
343
|
* // },
|
|
344
|
+
* // oneDriveLocation: { // RetrievalResultOneDriveLocation
|
|
345
|
+
* // url: "STRING_VALUE",
|
|
346
|
+
* // },
|
|
347
|
+
* // googleDriveLocation: { // RetrievalResultGoogleDriveLocation
|
|
348
|
+
* // url: "STRING_VALUE",
|
|
349
|
+
* // },
|
|
308
350
|
* // },
|
|
309
351
|
* // metadata: { // RetrievalResultMetadata
|
|
310
352
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import type {
|
|
4
|
+
import type { RetrieveAndGenerateStreamResponse } from "../models/models_0";
|
|
5
|
+
import type { RetrieveAndGenerateStreamRequest } from "../models/models_1";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -29,7 +30,7 @@ declare const RetrieveAndGenerateStreamCommand_base: {
|
|
|
29
30
|
};
|
|
30
31
|
};
|
|
31
32
|
/**
|
|
32
|
-
* <p>Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.</p> <note> <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeModelWithResponseStream</code>.</p> </note> <p>This operation requires permission for the <code> bedrock:RetrieveAndGenerate</code> action.</p>
|
|
33
|
+
* <p>Queries a knowledge base and generates responses based on the retrieved results, with output in streaming format.</p> <note> <p>This API cannot be used with managed knowledge bases. Use <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_AgenticRetrieveStream.html">AgenticRetrieveStream</a> or <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html">Retrieve</a> with managed knowledge bases.</p> </note> <note> <p>The CLI doesn't support streaming operations in Amazon Bedrock, including <code>InvokeModelWithResponseStream</code>.</p> </note> <p>This operation requires permission for the <code> bedrock:RetrieveAndGenerate</code> action.</p>
|
|
33
34
|
* @example
|
|
34
35
|
* Use a bare-bones client and the command you need to make an API call.
|
|
35
36
|
* ```javascript
|
|
@@ -142,6 +143,38 @@ declare const RetrieveAndGenerateStreamCommand_base: {
|
|
|
142
143
|
* modelArn: "STRING_VALUE", // required
|
|
143
144
|
* },
|
|
144
145
|
* },
|
|
146
|
+
* managedSearchConfiguration: { // ManagedSearchConfiguration
|
|
147
|
+
* numberOfResults: Number("int"),
|
|
148
|
+
* filter: "<RetrievalFilter>",
|
|
149
|
+
* rerankingModelType: "CUSTOM" || "MANAGED" || "NONE",
|
|
150
|
+
* rerankingConfiguration: { // ManagedSearchRerankingConfiguration
|
|
151
|
+
* type: "BEDROCK_RERANKING_MODEL", // required
|
|
152
|
+
* bedrockRerankingConfiguration: { // ManagedSearchBedrockRerankingConfiguration
|
|
153
|
+
* modelConfiguration: { // ManagedSearchBedrockRerankingModelConfiguration
|
|
154
|
+
* modelArn: "STRING_VALUE", // required
|
|
155
|
+
* additionalModelRequestFields: {
|
|
156
|
+
* "<keys>": "DOCUMENT_VALUE",
|
|
157
|
+
* },
|
|
158
|
+
* },
|
|
159
|
+
* numberOfRerankedResults: Number("int"),
|
|
160
|
+
* metadataConfiguration: {
|
|
161
|
+
* selectionMode: "SELECTIVE" || "ALL", // required
|
|
162
|
+
* selectiveModeConfiguration: {// Union: only one key present
|
|
163
|
+
* fieldsToInclude: [
|
|
164
|
+
* {
|
|
165
|
+
* fieldName: "STRING_VALUE", // required
|
|
166
|
+
* },
|
|
167
|
+
* ],
|
|
168
|
+
* fieldsToExclude: [
|
|
169
|
+
* {
|
|
170
|
+
* fieldName: "STRING_VALUE", // required
|
|
171
|
+
* },
|
|
172
|
+
* ],
|
|
173
|
+
* },
|
|
174
|
+
* },
|
|
175
|
+
* },
|
|
176
|
+
* },
|
|
177
|
+
* },
|
|
145
178
|
* },
|
|
146
179
|
* generationConfiguration: { // GenerationConfiguration
|
|
147
180
|
* promptTemplate: { // PromptTemplate
|
|
@@ -238,6 +271,9 @@ declare const RetrieveAndGenerateStreamCommand_base: {
|
|
|
238
271
|
* sessionConfiguration: { // RetrieveAndGenerateSessionConfiguration
|
|
239
272
|
* kmsKeyArn: "STRING_VALUE", // required
|
|
240
273
|
* },
|
|
274
|
+
* userContext: { // UserContext
|
|
275
|
+
* userId: "STRING_VALUE", // required
|
|
276
|
+
* },
|
|
241
277
|
* };
|
|
242
278
|
* const command = new RetrieveAndGenerateStreamCommand(input);
|
|
243
279
|
* const response = await client.send(command);
|
|
@@ -280,7 +316,7 @@ declare const RetrieveAndGenerateStreamCommand_base: {
|
|
|
280
316
|
* // ],
|
|
281
317
|
* // },
|
|
282
318
|
* // location: { // RetrievalResultLocation
|
|
283
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
|
|
319
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
|
|
284
320
|
* // s3Location: { // RetrievalResultS3Location
|
|
285
321
|
* // uri: "STRING_VALUE",
|
|
286
322
|
* // },
|
|
@@ -305,6 +341,12 @@ declare const RetrieveAndGenerateStreamCommand_base: {
|
|
|
305
341
|
* // sqlLocation: { // RetrievalResultSqlLocation
|
|
306
342
|
* // query: "STRING_VALUE",
|
|
307
343
|
* // },
|
|
344
|
+
* // oneDriveLocation: { // RetrievalResultOneDriveLocation
|
|
345
|
+
* // url: "STRING_VALUE",
|
|
346
|
+
* // },
|
|
347
|
+
* // googleDriveLocation: { // RetrievalResultGoogleDriveLocation
|
|
348
|
+
* // url: "STRING_VALUE",
|
|
349
|
+
* // },
|
|
308
350
|
* // },
|
|
309
351
|
* // metadata: { // RetrievalResultMetadata
|
|
310
352
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -344,7 +386,7 @@ declare const RetrieveAndGenerateStreamCommand_base: {
|
|
|
344
386
|
* // ],
|
|
345
387
|
* // },
|
|
346
388
|
* // location: {
|
|
347
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
|
|
389
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
|
|
348
390
|
* // s3Location: {
|
|
349
391
|
* // uri: "STRING_VALUE",
|
|
350
392
|
* // },
|
|
@@ -369,6 +411,12 @@ declare const RetrieveAndGenerateStreamCommand_base: {
|
|
|
369
411
|
* // sqlLocation: {
|
|
370
412
|
* // query: "STRING_VALUE",
|
|
371
413
|
* // },
|
|
414
|
+
* // oneDriveLocation: {
|
|
415
|
+
* // url: "STRING_VALUE",
|
|
416
|
+
* // },
|
|
417
|
+
* // googleDriveLocation: {
|
|
418
|
+
* // url: "STRING_VALUE",
|
|
419
|
+
* // },
|
|
372
420
|
* // },
|
|
373
421
|
* // metadata: {
|
|
374
422
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import type {
|
|
4
|
+
import type { RetrieveResponse } from "../models/models_0";
|
|
5
|
+
import type { RetrieveRequest } from "../models/models_1";
|
|
5
6
|
/**
|
|
6
7
|
* @public
|
|
7
8
|
*/
|
|
@@ -142,12 +143,47 @@ declare const RetrieveCommand_base: {
|
|
|
142
143
|
* modelArn: "STRING_VALUE", // required
|
|
143
144
|
* },
|
|
144
145
|
* },
|
|
146
|
+
* managedSearchConfiguration: { // ManagedSearchConfiguration
|
|
147
|
+
* numberOfResults: Number("int"),
|
|
148
|
+
* filter: "<RetrievalFilter>",
|
|
149
|
+
* rerankingModelType: "CUSTOM" || "MANAGED" || "NONE",
|
|
150
|
+
* rerankingConfiguration: { // ManagedSearchRerankingConfiguration
|
|
151
|
+
* type: "BEDROCK_RERANKING_MODEL", // required
|
|
152
|
+
* bedrockRerankingConfiguration: { // ManagedSearchBedrockRerankingConfiguration
|
|
153
|
+
* modelConfiguration: { // ManagedSearchBedrockRerankingModelConfiguration
|
|
154
|
+
* modelArn: "STRING_VALUE", // required
|
|
155
|
+
* additionalModelRequestFields: {
|
|
156
|
+
* "<keys>": "DOCUMENT_VALUE",
|
|
157
|
+
* },
|
|
158
|
+
* },
|
|
159
|
+
* numberOfRerankedResults: Number("int"),
|
|
160
|
+
* metadataConfiguration: {
|
|
161
|
+
* selectionMode: "SELECTIVE" || "ALL", // required
|
|
162
|
+
* selectiveModeConfiguration: {// Union: only one key present
|
|
163
|
+
* fieldsToInclude: [
|
|
164
|
+
* {
|
|
165
|
+
* fieldName: "STRING_VALUE", // required
|
|
166
|
+
* },
|
|
167
|
+
* ],
|
|
168
|
+
* fieldsToExclude: [
|
|
169
|
+
* {
|
|
170
|
+
* fieldName: "STRING_VALUE", // required
|
|
171
|
+
* },
|
|
172
|
+
* ],
|
|
173
|
+
* },
|
|
174
|
+
* },
|
|
175
|
+
* },
|
|
176
|
+
* },
|
|
177
|
+
* },
|
|
145
178
|
* },
|
|
146
179
|
* guardrailConfiguration: { // GuardrailConfiguration
|
|
147
180
|
* guardrailId: "STRING_VALUE", // required
|
|
148
181
|
* guardrailVersion: "STRING_VALUE", // required
|
|
149
182
|
* },
|
|
150
183
|
* nextToken: "STRING_VALUE",
|
|
184
|
+
* userContext: { // UserContext
|
|
185
|
+
* userId: "STRING_VALUE", // required
|
|
186
|
+
* },
|
|
151
187
|
* };
|
|
152
188
|
* const command = new RetrieveCommand(input);
|
|
153
189
|
* const response = await client.send(command);
|
|
@@ -175,7 +211,7 @@ declare const RetrieveCommand_base: {
|
|
|
175
211
|
* // ],
|
|
176
212
|
* // },
|
|
177
213
|
* // location: { // RetrievalResultLocation
|
|
178
|
-
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
|
|
214
|
+
* // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL" || "ONEDRIVE" || "GOOGLEDRIVE", // required
|
|
179
215
|
* // s3Location: { // RetrievalResultS3Location
|
|
180
216
|
* // uri: "STRING_VALUE",
|
|
181
217
|
* // },
|
|
@@ -200,11 +236,18 @@ declare const RetrieveCommand_base: {
|
|
|
200
236
|
* // sqlLocation: { // RetrievalResultSqlLocation
|
|
201
237
|
* // query: "STRING_VALUE",
|
|
202
238
|
* // },
|
|
239
|
+
* // oneDriveLocation: { // RetrievalResultOneDriveLocation
|
|
240
|
+
* // url: "STRING_VALUE",
|
|
241
|
+
* // },
|
|
242
|
+
* // googleDriveLocation: { // RetrievalResultGoogleDriveLocation
|
|
243
|
+
* // url: "STRING_VALUE",
|
|
244
|
+
* // },
|
|
203
245
|
* // },
|
|
204
246
|
* // score: Number("double"),
|
|
205
247
|
* // metadata: { // RetrievalResultMetadata
|
|
206
248
|
* // "<keys>": "DOCUMENT_VALUE",
|
|
207
249
|
* // },
|
|
250
|
+
* // documentId: "STRING_VALUE",
|
|
208
251
|
* // },
|
|
209
252
|
* // ],
|
|
210
253
|
* // guardrailAction: "INTERVENED" || "NONE",
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import type { TagResourceRequest, TagResourceResponse } from "../models/
|
|
4
|
+
import type { TagResourceRequest, TagResourceResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import type { UntagResourceRequest, UntagResourceResponse } from "../models/
|
|
4
|
+
import type { UntagResourceRequest, UntagResourceResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Command as $Command } from "@smithy/core/client";
|
|
2
2
|
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
3
|
import type { BedrockAgentRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../BedrockAgentRuntimeClient";
|
|
4
|
-
import type { UpdateSessionRequest, UpdateSessionResponse } from "../models/
|
|
4
|
+
import type { UpdateSessionRequest, UpdateSessionResponse } from "../models/models_1";
|
|
5
5
|
/**
|
|
6
6
|
* @public
|
|
7
7
|
*/
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
export * from "./AgenticRetrieveStreamCommand";
|
|
1
2
|
export * from "./CreateInvocationCommand";
|
|
2
3
|
export * from "./CreateSessionCommand";
|
|
3
4
|
export * from "./DeleteAgentMemoryCommand";
|
|
@@ -5,6 +6,7 @@ export * from "./DeleteSessionCommand";
|
|
|
5
6
|
export * from "./EndSessionCommand";
|
|
6
7
|
export * from "./GenerateQueryCommand";
|
|
7
8
|
export * from "./GetAgentMemoryCommand";
|
|
9
|
+
export * from "./GetDocumentContentCommand";
|
|
8
10
|
export * from "./GetExecutionFlowSnapshotCommand";
|
|
9
11
|
export * from "./GetFlowExecutionCommand";
|
|
10
12
|
export * from "./GetInvocationStepCommand";
|