@aws-sdk/client-bedrock-agent-runtime 3.699.0 → 3.703.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.
Files changed (33) hide show
  1. package/README.md +16 -0
  2. package/dist-cjs/index.js +552 -4
  3. package/dist-es/BedrockAgentRuntime.js +4 -0
  4. package/dist-es/commands/RerankCommand.js +23 -0
  5. package/dist-es/commands/RetrieveAndGenerateStreamCommand.js +27 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/models_0.js +191 -0
  8. package/dist-es/pagination/RerankPaginator.js +4 -0
  9. package/dist-es/pagination/index.js +1 -0
  10. package/dist-es/protocols/Aws_restJson1.js +237 -0
  11. package/dist-types/BedrockAgentRuntime.d.ts +14 -0
  12. package/dist-types/BedrockAgentRuntimeClient.d.ts +4 -2
  13. package/dist-types/commands/InvokeAgentCommand.d.ts +55 -2
  14. package/dist-types/commands/InvokeInlineAgentCommand.d.ts +51 -2
  15. package/dist-types/commands/RerankCommand.d.ts +143 -0
  16. package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +42 -2
  17. package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +371 -0
  18. package/dist-types/commands/RetrieveCommand.d.ts +46 -1
  19. package/dist-types/commands/index.d.ts +2 -0
  20. package/dist-types/models/models_0.d.ts +1093 -125
  21. package/dist-types/pagination/RerankPaginator.d.ts +7 -0
  22. package/dist-types/pagination/index.d.ts +1 -0
  23. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  24. package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +34 -0
  25. package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +12 -0
  26. package/dist-types/ts3.4/commands/RerankCommand.d.ts +41 -0
  27. package/dist-types/ts3.4/commands/RetrieveAndGenerateStreamCommand.d.ts +51 -0
  28. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  29. package/dist-types/ts3.4/models/models_0.d.ts +490 -0
  30. package/dist-types/ts3.4/pagination/RerankPaginator.d.ts +11 -0
  31. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  32. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  33. package/package.json +1 -1
@@ -6,7 +6,9 @@ import { InvokeAgentCommand } from "./commands/InvokeAgentCommand";
6
6
  import { InvokeFlowCommand } from "./commands/InvokeFlowCommand";
7
7
  import { InvokeInlineAgentCommand, } from "./commands/InvokeInlineAgentCommand";
8
8
  import { OptimizePromptCommand, } from "./commands/OptimizePromptCommand";
9
+ import { RerankCommand } from "./commands/RerankCommand";
9
10
  import { RetrieveAndGenerateCommand, } from "./commands/RetrieveAndGenerateCommand";
11
+ import { RetrieveAndGenerateStreamCommand, } from "./commands/RetrieveAndGenerateStreamCommand";
10
12
  import { RetrieveCommand } from "./commands/RetrieveCommand";
11
13
  const commands = {
12
14
  DeleteAgentMemoryCommand,
@@ -15,8 +17,10 @@ const commands = {
15
17
  InvokeFlowCommand,
16
18
  InvokeInlineAgentCommand,
17
19
  OptimizePromptCommand,
20
+ RerankCommand,
18
21
  RetrieveCommand,
19
22
  RetrieveAndGenerateCommand,
23
+ RetrieveAndGenerateStreamCommand,
20
24
  };
21
25
  export class BedrockAgentRuntime extends BedrockAgentRuntimeClient {
22
26
  }
@@ -0,0 +1,23 @@
1
+ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
2
+ import { getSerdePlugin } from "@smithy/middleware-serde";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { commonParams } from "../endpoint/EndpointParameters";
5
+ import { RerankRequestFilterSensitiveLog, RerankResponseFilterSensitiveLog, } from "../models/models_0";
6
+ import { de_RerankCommand, se_RerankCommand } from "../protocols/Aws_restJson1";
7
+ export { $Command };
8
+ export class RerankCommand extends $Command
9
+ .classBuilder()
10
+ .ep(commonParams)
11
+ .m(function (Command, cs, config, o) {
12
+ return [
13
+ getSerdePlugin(config, this.serialize, this.deserialize),
14
+ getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
15
+ ];
16
+ })
17
+ .s("AmazonBedrockAgentRunTimeService", "Rerank", {})
18
+ .n("BedrockAgentRuntimeClient", "RerankCommand")
19
+ .f(RerankRequestFilterSensitiveLog, RerankResponseFilterSensitiveLog)
20
+ .ser(se_RerankCommand)
21
+ .de(de_RerankCommand)
22
+ .build() {
23
+ }
@@ -0,0 +1,27 @@
1
+ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
2
+ import { getSerdePlugin } from "@smithy/middleware-serde";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { commonParams } from "../endpoint/EndpointParameters";
5
+ import { RetrieveAndGenerateStreamRequestFilterSensitiveLog, RetrieveAndGenerateStreamResponseFilterSensitiveLog, } from "../models/models_0";
6
+ import { de_RetrieveAndGenerateStreamCommand, se_RetrieveAndGenerateStreamCommand } from "../protocols/Aws_restJson1";
7
+ export { $Command };
8
+ export class RetrieveAndGenerateStreamCommand extends $Command
9
+ .classBuilder()
10
+ .ep(commonParams)
11
+ .m(function (Command, cs, config, o) {
12
+ return [
13
+ getSerdePlugin(config, this.serialize, this.deserialize),
14
+ getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
15
+ ];
16
+ })
17
+ .s("AmazonBedrockAgentRunTimeService", "RetrieveAndGenerateStream", {
18
+ eventStream: {
19
+ output: true,
20
+ },
21
+ })
22
+ .n("BedrockAgentRuntimeClient", "RetrieveAndGenerateStreamCommand")
23
+ .f(RetrieveAndGenerateStreamRequestFilterSensitiveLog, RetrieveAndGenerateStreamResponseFilterSensitiveLog)
24
+ .ser(se_RetrieveAndGenerateStreamCommand)
25
+ .de(de_RetrieveAndGenerateStreamCommand)
26
+ .build() {
27
+ }
@@ -4,5 +4,7 @@ export * from "./InvokeAgentCommand";
4
4
  export * from "./InvokeFlowCommand";
5
5
  export * from "./InvokeInlineAgentCommand";
6
6
  export * from "./OptimizePromptCommand";
7
+ export * from "./RerankCommand";
7
8
  export * from "./RetrieveAndGenerateCommand";
9
+ export * from "./RetrieveAndGenerateStreamCommand";
8
10
  export * from "./RetrieveCommand";
@@ -259,10 +259,33 @@ export const FileUseCase = {
259
259
  CHAT: "CHAT",
260
260
  CODE_INTERPRETER: "CODE_INTERPRETER",
261
261
  };
262
+ export const AttributeType = {
263
+ BOOLEAN: "BOOLEAN",
264
+ NUMBER: "NUMBER",
265
+ STRING: "STRING",
266
+ STRING_LIST: "STRING_LIST",
267
+ };
262
268
  export const SearchType = {
263
269
  HYBRID: "HYBRID",
264
270
  SEMANTIC: "SEMANTIC",
265
271
  };
272
+ export const RerankingMetadataSelectionMode = {
273
+ ALL: "ALL",
274
+ SELECTIVE: "SELECTIVE",
275
+ };
276
+ export var RerankingMetadataSelectiveModeConfiguration;
277
+ (function (RerankingMetadataSelectiveModeConfiguration) {
278
+ RerankingMetadataSelectiveModeConfiguration.visit = (value, visitor) => {
279
+ if (value.fieldsToInclude !== undefined)
280
+ return visitor.fieldsToInclude(value.fieldsToInclude);
281
+ if (value.fieldsToExclude !== undefined)
282
+ return visitor.fieldsToExclude(value.fieldsToExclude);
283
+ return visitor._(value.$unknown[0], value.$unknown[1]);
284
+ };
285
+ })(RerankingMetadataSelectiveModeConfiguration || (RerankingMetadataSelectiveModeConfiguration = {}));
286
+ export const VectorSearchRerankingConfigurationType = {
287
+ BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL",
288
+ };
266
289
  export const ConfirmationState = {
267
290
  CONFIRM: "CONFIRM",
268
291
  DENY: "DENY",
@@ -283,6 +306,7 @@ export var InvocationResultMember;
283
306
  })(InvocationResultMember || (InvocationResultMember = {}));
284
307
  export const RetrievalResultLocationType = {
285
308
  CONFLUENCE: "CONFLUENCE",
309
+ CUSTOM: "CUSTOM",
286
310
  S3: "S3",
287
311
  SALESFORCE: "SALESFORCE",
288
312
  SHAREPOINT: "SHAREPOINT",
@@ -446,6 +470,8 @@ export var Trace;
446
470
  return visitor.postProcessingTrace(value.postProcessingTrace);
447
471
  if (value.failureTrace !== undefined)
448
472
  return visitor.failureTrace(value.failureTrace);
473
+ if (value.customOrchestrationTrace !== undefined)
474
+ return visitor.customOrchestrationTrace(value.customOrchestrationTrace);
449
475
  return visitor._(value.$unknown[0], value.$unknown[1]);
450
476
  };
451
477
  })(Trace || (Trace = {}));
@@ -566,6 +592,19 @@ export var OptimizedPromptStream;
566
592
  return visitor._(value.$unknown[0], value.$unknown[1]);
567
593
  };
568
594
  })(OptimizedPromptStream || (OptimizedPromptStream = {}));
595
+ export const RerankQueryContentType = {
596
+ TEXT: "TEXT",
597
+ };
598
+ export const RerankingConfigurationType = {
599
+ BEDROCK_RERANKING_MODEL: "BEDROCK_RERANKING_MODEL",
600
+ };
601
+ export const RerankDocumentType = {
602
+ JSON: "JSON",
603
+ TEXT: "TEXT",
604
+ };
605
+ export const RerankSourceType = {
606
+ INLINE: "INLINE",
607
+ };
569
608
  export const ExternalSourceType = {
570
609
  BYTE_CONTENT: "BYTE_CONTENT",
571
610
  S3: "S3",
@@ -581,6 +620,36 @@ export const GuadrailAction = {
581
620
  INTERVENED: "INTERVENED",
582
621
  NONE: "NONE",
583
622
  };
623
+ export var RetrieveAndGenerateStreamResponseOutput;
624
+ (function (RetrieveAndGenerateStreamResponseOutput) {
625
+ RetrieveAndGenerateStreamResponseOutput.visit = (value, visitor) => {
626
+ if (value.output !== undefined)
627
+ return visitor.output(value.output);
628
+ if (value.citation !== undefined)
629
+ return visitor.citation(value.citation);
630
+ if (value.guardrail !== undefined)
631
+ return visitor.guardrail(value.guardrail);
632
+ if (value.internalServerException !== undefined)
633
+ return visitor.internalServerException(value.internalServerException);
634
+ if (value.validationException !== undefined)
635
+ return visitor.validationException(value.validationException);
636
+ if (value.resourceNotFoundException !== undefined)
637
+ return visitor.resourceNotFoundException(value.resourceNotFoundException);
638
+ if (value.serviceQuotaExceededException !== undefined)
639
+ return visitor.serviceQuotaExceededException(value.serviceQuotaExceededException);
640
+ if (value.throttlingException !== undefined)
641
+ return visitor.throttlingException(value.throttlingException);
642
+ if (value.accessDeniedException !== undefined)
643
+ return visitor.accessDeniedException(value.accessDeniedException);
644
+ if (value.conflictException !== undefined)
645
+ return visitor.conflictException(value.conflictException);
646
+ if (value.dependencyFailedException !== undefined)
647
+ return visitor.dependencyFailedException(value.dependencyFailedException);
648
+ if (value.badGatewayException !== undefined)
649
+ return visitor.badGatewayException(value.badGatewayException);
650
+ return visitor._(value.$unknown[0], value.$unknown[1]);
651
+ };
652
+ })(RetrieveAndGenerateStreamResponseOutput || (RetrieveAndGenerateStreamResponseOutput = {}));
584
653
  export var RetrievalFilter;
585
654
  (function (RetrievalFilter) {
586
655
  RetrievalFilter.visit = (value, visitor) => {
@@ -758,6 +827,39 @@ export const InputFileFilterSensitiveLog = (obj) => ({
758
827
  ...obj,
759
828
  ...(obj.source && { source: FileSourceFilterSensitiveLog(obj.source) }),
760
829
  });
830
+ export const MetadataAttributeSchemaFilterSensitiveLog = (obj) => ({
831
+ ...obj,
832
+ });
833
+ export const ImplicitFilterConfigurationFilterSensitiveLog = (obj) => ({
834
+ ...obj,
835
+ ...(obj.metadataAttributes && { metadataAttributes: SENSITIVE_STRING }),
836
+ });
837
+ export const RerankingMetadataSelectiveModeConfigurationFilterSensitiveLog = (obj) => {
838
+ if (obj.fieldsToInclude !== undefined)
839
+ return { fieldsToInclude: SENSITIVE_STRING };
840
+ if (obj.fieldsToExclude !== undefined)
841
+ return { fieldsToExclude: SENSITIVE_STRING };
842
+ if (obj.$unknown !== undefined)
843
+ return { [obj.$unknown[0]]: "UNKNOWN" };
844
+ };
845
+ export const MetadataConfigurationForRerankingFilterSensitiveLog = (obj) => ({
846
+ ...obj,
847
+ ...(obj.selectiveModeConfiguration && {
848
+ selectiveModeConfiguration: RerankingMetadataSelectiveModeConfigurationFilterSensitiveLog(obj.selectiveModeConfiguration),
849
+ }),
850
+ });
851
+ export const VectorSearchBedrockRerankingConfigurationFilterSensitiveLog = (obj) => ({
852
+ ...obj,
853
+ ...(obj.metadataConfiguration && {
854
+ metadataConfiguration: MetadataConfigurationForRerankingFilterSensitiveLog(obj.metadataConfiguration),
855
+ }),
856
+ });
857
+ export const VectorSearchRerankingConfigurationFilterSensitiveLog = (obj) => ({
858
+ ...obj,
859
+ ...(obj.bedrockRerankingConfiguration && {
860
+ bedrockRerankingConfiguration: VectorSearchBedrockRerankingConfigurationFilterSensitiveLog(obj.bedrockRerankingConfiguration),
861
+ }),
862
+ });
761
863
  export const ApiResultFilterSensitiveLog = (obj) => ({
762
864
  ...obj,
763
865
  ...(obj.apiPath && { apiPath: SENSITIVE_STRING }),
@@ -833,6 +935,13 @@ export const ReturnControlPayloadFilterSensitiveLog = (obj) => ({
833
935
  invocationInputs: obj.invocationInputs.map((item) => InvocationInputMemberFilterSensitiveLog(item)),
834
936
  }),
835
937
  });
938
+ export const CustomOrchestrationTraceEventFilterSensitiveLog = (obj) => ({
939
+ ...obj,
940
+ });
941
+ export const CustomOrchestrationTraceFilterSensitiveLog = (obj) => ({
942
+ ...obj,
943
+ ...(obj.event && { event: SENSITIVE_STRING }),
944
+ });
836
945
  export const FailureTraceFilterSensitiveLog = (obj) => ({
837
946
  ...obj,
838
947
  ...(obj.failureReason && { failureReason: SENSITIVE_STRING }),
@@ -1008,6 +1117,8 @@ export const TraceFilterSensitiveLog = (obj) => {
1008
1117
  return { postProcessingTrace: SENSITIVE_STRING };
1009
1118
  if (obj.failureTrace !== undefined)
1010
1119
  return { failureTrace: SENSITIVE_STRING };
1120
+ if (obj.customOrchestrationTrace !== undefined)
1121
+ return { customOrchestrationTrace: SENSITIVE_STRING };
1011
1122
  if (obj.$unknown !== undefined)
1012
1123
  return { [obj.$unknown[0]]: "UNKNOWN" };
1013
1124
  };
@@ -1169,6 +1280,34 @@ export const OptimizePromptResponseFilterSensitiveLog = (obj) => ({
1169
1280
  ...obj,
1170
1281
  ...(obj.optimizedPrompt && { optimizedPrompt: "STREAMING_CONTENT" }),
1171
1282
  });
1283
+ export const RerankTextDocumentFilterSensitiveLog = (obj) => ({
1284
+ ...obj,
1285
+ });
1286
+ export const RerankQueryFilterSensitiveLog = (obj) => ({
1287
+ ...obj,
1288
+ ...(obj.textQuery && { textQuery: SENSITIVE_STRING }),
1289
+ });
1290
+ export const RerankDocumentFilterSensitiveLog = (obj) => ({
1291
+ ...obj,
1292
+ ...(obj.textDocument && { textDocument: SENSITIVE_STRING }),
1293
+ });
1294
+ export const RerankSourceFilterSensitiveLog = (obj) => ({
1295
+ ...obj,
1296
+ ...(obj.inlineDocumentSource && { inlineDocumentSource: SENSITIVE_STRING }),
1297
+ });
1298
+ export const RerankRequestFilterSensitiveLog = (obj) => ({
1299
+ ...obj,
1300
+ ...(obj.queries && { queries: SENSITIVE_STRING }),
1301
+ ...(obj.sources && { sources: SENSITIVE_STRING }),
1302
+ });
1303
+ export const RerankResultFilterSensitiveLog = (obj) => ({
1304
+ ...obj,
1305
+ ...(obj.document && { document: SENSITIVE_STRING }),
1306
+ });
1307
+ export const RerankResponseFilterSensitiveLog = (obj) => ({
1308
+ ...obj,
1309
+ ...(obj.results && { results: obj.results.map((item) => RerankResultFilterSensitiveLog(item)) }),
1310
+ });
1172
1311
  export const RetrieveAndGenerateInputFilterSensitiveLog = (obj) => ({
1173
1312
  ...obj,
1174
1313
  });
@@ -1212,6 +1351,45 @@ export const RetrieveAndGenerateResponseFilterSensitiveLog = (obj) => ({
1212
1351
  ...(obj.output && { output: SENSITIVE_STRING }),
1213
1352
  ...(obj.citations && { citations: obj.citations.map((item) => CitationFilterSensitiveLog(item)) }),
1214
1353
  });
1354
+ export const CitationEventFilterSensitiveLog = (obj) => ({
1355
+ ...obj,
1356
+ ...(obj.citation && { citation: CitationFilterSensitiveLog(obj.citation) }),
1357
+ });
1358
+ export const RetrieveAndGenerateOutputEventFilterSensitiveLog = (obj) => ({
1359
+ ...obj,
1360
+ });
1361
+ export const RetrieveAndGenerateStreamResponseOutputFilterSensitiveLog = (obj) => {
1362
+ if (obj.output !== undefined)
1363
+ return { output: SENSITIVE_STRING };
1364
+ if (obj.citation !== undefined)
1365
+ return { citation: CitationEventFilterSensitiveLog(obj.citation) };
1366
+ if (obj.guardrail !== undefined)
1367
+ return { guardrail: obj.guardrail };
1368
+ if (obj.internalServerException !== undefined)
1369
+ return { internalServerException: obj.internalServerException };
1370
+ if (obj.validationException !== undefined)
1371
+ return { validationException: obj.validationException };
1372
+ if (obj.resourceNotFoundException !== undefined)
1373
+ return { resourceNotFoundException: obj.resourceNotFoundException };
1374
+ if (obj.serviceQuotaExceededException !== undefined)
1375
+ return { serviceQuotaExceededException: obj.serviceQuotaExceededException };
1376
+ if (obj.throttlingException !== undefined)
1377
+ return { throttlingException: obj.throttlingException };
1378
+ if (obj.accessDeniedException !== undefined)
1379
+ return { accessDeniedException: obj.accessDeniedException };
1380
+ if (obj.conflictException !== undefined)
1381
+ return { conflictException: obj.conflictException };
1382
+ if (obj.dependencyFailedException !== undefined)
1383
+ return { dependencyFailedException: obj.dependencyFailedException };
1384
+ if (obj.badGatewayException !== undefined)
1385
+ return { badGatewayException: obj.badGatewayException };
1386
+ if (obj.$unknown !== undefined)
1387
+ return { [obj.$unknown[0]]: "UNKNOWN" };
1388
+ };
1389
+ export const RetrieveAndGenerateStreamResponseFilterSensitiveLog = (obj) => ({
1390
+ ...obj,
1391
+ ...(obj.stream && { stream: "STREAMING_CONTENT" }),
1392
+ });
1215
1393
  export const KnowledgeBaseQueryFilterSensitiveLog = (obj) => ({
1216
1394
  ...obj,
1217
1395
  });
@@ -1258,6 +1436,12 @@ export const RetrievalFilterFilterSensitiveLog = (obj) => {
1258
1436
  export const KnowledgeBaseVectorSearchConfigurationFilterSensitiveLog = (obj) => ({
1259
1437
  ...obj,
1260
1438
  ...(obj.filter && { filter: SENSITIVE_STRING }),
1439
+ ...(obj.rerankingConfiguration && {
1440
+ rerankingConfiguration: VectorSearchRerankingConfigurationFilterSensitiveLog(obj.rerankingConfiguration),
1441
+ }),
1442
+ ...(obj.implicitFilterConfiguration && {
1443
+ implicitFilterConfiguration: ImplicitFilterConfigurationFilterSensitiveLog(obj.implicitFilterConfiguration),
1444
+ }),
1261
1445
  });
1262
1446
  export const KnowledgeBaseRetrievalConfigurationFilterSensitiveLog = (obj) => ({
1263
1447
  ...obj,
@@ -1324,6 +1508,13 @@ export const RetrieveAndGenerateRequestFilterSensitiveLog = (obj) => ({
1324
1508
  retrieveAndGenerateConfiguration: RetrieveAndGenerateConfigurationFilterSensitiveLog(obj.retrieveAndGenerateConfiguration),
1325
1509
  }),
1326
1510
  });
1511
+ export const RetrieveAndGenerateStreamRequestFilterSensitiveLog = (obj) => ({
1512
+ ...obj,
1513
+ ...(obj.input && { input: SENSITIVE_STRING }),
1514
+ ...(obj.retrieveAndGenerateConfiguration && {
1515
+ retrieveAndGenerateConfiguration: RetrieveAndGenerateConfigurationFilterSensitiveLog(obj.retrieveAndGenerateConfiguration),
1516
+ }),
1517
+ });
1327
1518
  export const SessionStateFilterSensitiveLog = (obj) => ({
1328
1519
  ...obj,
1329
1520
  ...(obj.returnControlInvocationResults && {
@@ -0,0 +1,4 @@
1
+ import { createPaginator } from "@smithy/core";
2
+ import { BedrockAgentRuntimeClient } from "../BedrockAgentRuntimeClient";
3
+ import { RerankCommand } from "../commands/RerankCommand";
4
+ export const paginateRerank = createPaginator(BedrockAgentRuntimeClient, RerankCommand, "nextToken", "nextToken", "");
@@ -1,3 +1,4 @@
1
1
  export * from "./GetAgentMemoryPaginator";
2
2
  export * from "./Interfaces";
3
+ export * from "./RerankPaginator";
3
4
  export * from "./RetrievePaginator";