@aws-sdk/client-bedrock-agent-runtime 3.705.0 → 3.709.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 (25) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/index.js +115 -1
  3. package/dist-es/BedrockAgentRuntime.js +2 -0
  4. package/dist-es/commands/GenerateQueryCommand.js +23 -0
  5. package/dist-es/commands/index.js +1 -0
  6. package/dist-es/models/models_0.js +45 -0
  7. package/dist-es/protocols/Aws_restJson1.js +28 -0
  8. package/dist-types/BedrockAgentRuntime.d.ts +7 -0
  9. package/dist-types/BedrockAgentRuntimeClient.d.ts +3 -2
  10. package/dist-types/commands/GenerateQueryCommand.d.ts +115 -0
  11. package/dist-types/commands/InvokeAgentCommand.d.ts +51 -6
  12. package/dist-types/commands/InvokeInlineAgentCommand.d.ts +51 -6
  13. package/dist-types/commands/RetrieveAndGenerateCommand.d.ts +17 -2
  14. package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts +17 -2
  15. package/dist-types/commands/RetrieveCommand.d.ts +17 -2
  16. package/dist-types/commands/index.d.ts +1 -0
  17. package/dist-types/models/models_0.d.ts +267 -4
  18. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  19. package/dist-types/ts3.4/BedrockAgentRuntime.d.ts +17 -0
  20. package/dist-types/ts3.4/BedrockAgentRuntimeClient.d.ts +6 -0
  21. package/dist-types/ts3.4/commands/GenerateQueryCommand.d.ts +50 -0
  22. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  23. package/dist-types/ts3.4/models/models_0.d.ts +97 -1
  24. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  25. package/package.json +38 -38
package/dist-types/commands/InvokeAgentCommand.d.ts CHANGED
@@ -268,10 +268,19 @@ declare const InvokeAgentCommand_base: {
268
268
  * // retrievedReferences: [ // RetrievedReferences
269
269
  * // { // RetrievedReference
270
270
  * // content: { // RetrievalResultContent
271
- * // text: "STRING_VALUE", // required
271
+ * // type: "TEXT" || "IMAGE" || "ROW",
272
+ * // text: "STRING_VALUE",
273
+ * // byteContent: "STRING_VALUE",
274
+ * // row: [ // RetrievalResultContentRow
275
+ * // { // RetrievalResultContentColumn
276
+ * // columnName: "STRING_VALUE",
277
+ * // columnValue: "STRING_VALUE",
278
+ * // type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING",
279
+ * // },
280
+ * // ],
272
281
  * // },
273
282
  * // location: { // RetrievalResultLocation
274
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
283
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
275
284
  * // s3Location: { // RetrievalResultS3Location
276
285
  * // uri: "STRING_VALUE",
277
286
  * // },
@@ -290,6 +299,12 @@ declare const InvokeAgentCommand_base: {
290
299
  * // customDocumentLocation: { // RetrievalResultCustomDocumentLocation
291
300
  * // id: "STRING_VALUE",
292
301
  * // },
302
+ * // kendraDocumentLocation: { // RetrievalResultKendraDocumentLocation
303
+ * // uri: "STRING_VALUE",
304
+ * // },
305
+ * // sqlLocation: { // RetrievalResultSqlLocation
306
+ * // query: "STRING_VALUE",
307
+ * // },
293
308
  * // },
294
309
  * // metadata: { // RetrievalResultMetadata
295
310
  * // "<keys>": "DOCUMENT_VALUE",
@@ -600,10 +615,19 @@ declare const InvokeAgentCommand_base: {
600
615
  * // retrievedReferences: [
601
616
  * // {
602
617
  * // content: {
603
- * // text: "STRING_VALUE", // required
618
+ * // type: "TEXT" || "IMAGE" || "ROW",
619
+ * // text: "STRING_VALUE",
620
+ * // byteContent: "STRING_VALUE",
621
+ * // row: [
622
+ * // {
623
+ * // columnName: "STRING_VALUE",
624
+ * // columnValue: "STRING_VALUE",
625
+ * // type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING",
626
+ * // },
627
+ * // ],
604
628
  * // },
605
629
  * // location: {
606
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
630
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
607
631
  * // s3Location: {
608
632
  * // uri: "STRING_VALUE",
609
633
  * // },
@@ -622,6 +646,12 @@ declare const InvokeAgentCommand_base: {
622
646
  * // customDocumentLocation: {
623
647
  * // id: "STRING_VALUE",
624
648
  * // },
649
+ * // kendraDocumentLocation: {
650
+ * // uri: "STRING_VALUE",
651
+ * // },
652
+ * // sqlLocation: {
653
+ * // query: "STRING_VALUE",
654
+ * // },
625
655
  * // },
626
656
  * // metadata: {
627
657
  * // "<keys>": "DOCUMENT_VALUE",
@@ -848,10 +878,19 @@ declare const InvokeAgentCommand_base: {
848
878
  * // retrievedReferences: [
849
879
  * // {
850
880
  * // content: {
851
- * // text: "STRING_VALUE", // required
881
+ * // type: "TEXT" || "IMAGE" || "ROW",
882
+ * // text: "STRING_VALUE",
883
+ * // byteContent: "STRING_VALUE",
884
+ * // row: [
885
+ * // {
886
+ * // columnName: "STRING_VALUE",
887
+ * // columnValue: "STRING_VALUE",
888
+ * // type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING",
889
+ * // },
890
+ * // ],
852
891
  * // },
853
892
  * // location: {
854
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
893
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
855
894
  * // s3Location: {
856
895
  * // uri: "STRING_VALUE",
857
896
  * // },
@@ -870,6 +909,12 @@ declare const InvokeAgentCommand_base: {
870
909
  * // customDocumentLocation: {
871
910
  * // id: "STRING_VALUE",
872
911
  * // },
912
+ * // kendraDocumentLocation: {
913
+ * // uri: "STRING_VALUE",
914
+ * // },
915
+ * // sqlLocation: {
916
+ * // query: "STRING_VALUE",
917
+ * // },
873
918
  * // },
874
919
  * // metadata: {
875
920
  * // "<keys>": "DOCUMENT_VALUE",
package/dist-types/commands/InvokeInlineAgentCommand.d.ts CHANGED
@@ -305,10 +305,19 @@ declare const InvokeInlineAgentCommand_base: {
305
305
  * // retrievedReferences: [ // RetrievedReferences
306
306
  * // { // RetrievedReference
307
307
  * // content: { // RetrievalResultContent
308
- * // text: "STRING_VALUE", // required
308
+ * // type: "TEXT" || "IMAGE" || "ROW",
309
+ * // text: "STRING_VALUE",
310
+ * // byteContent: "STRING_VALUE",
311
+ * // row: [ // RetrievalResultContentRow
312
+ * // { // RetrievalResultContentColumn
313
+ * // columnName: "STRING_VALUE",
314
+ * // columnValue: "STRING_VALUE",
315
+ * // type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING",
316
+ * // },
317
+ * // ],
309
318
  * // },
310
319
  * // location: { // RetrievalResultLocation
311
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
320
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
312
321
  * // s3Location: { // RetrievalResultS3Location
313
322
  * // uri: "STRING_VALUE",
314
323
  * // },
@@ -327,6 +336,12 @@ declare const InvokeInlineAgentCommand_base: {
327
336
  * // customDocumentLocation: { // RetrievalResultCustomDocumentLocation
328
337
  * // id: "STRING_VALUE",
329
338
  * // },
339
+ * // kendraDocumentLocation: { // RetrievalResultKendraDocumentLocation
340
+ * // uri: "STRING_VALUE",
341
+ * // },
342
+ * // sqlLocation: { // RetrievalResultSqlLocation
343
+ * // query: "STRING_VALUE",
344
+ * // },
330
345
  * // },
331
346
  * // metadata: { // RetrievalResultMetadata
332
347
  * // "<keys>": "DOCUMENT_VALUE",
@@ -637,10 +652,19 @@ declare const InvokeInlineAgentCommand_base: {
637
652
  * // retrievedReferences: [
638
653
  * // {
639
654
  * // content: {
640
- * // text: "STRING_VALUE", // required
655
+ * // type: "TEXT" || "IMAGE" || "ROW",
656
+ * // text: "STRING_VALUE",
657
+ * // byteContent: "STRING_VALUE",
658
+ * // row: [
659
+ * // {
660
+ * // columnName: "STRING_VALUE",
661
+ * // columnValue: "STRING_VALUE",
662
+ * // type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING",
663
+ * // },
664
+ * // ],
641
665
  * // },
642
666
  * // location: {
643
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
667
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
644
668
  * // s3Location: {
645
669
  * // uri: "STRING_VALUE",
646
670
  * // },
@@ -659,6 +683,12 @@ declare const InvokeInlineAgentCommand_base: {
659
683
  * // customDocumentLocation: {
660
684
  * // id: "STRING_VALUE",
661
685
  * // },
686
+ * // kendraDocumentLocation: {
687
+ * // uri: "STRING_VALUE",
688
+ * // },
689
+ * // sqlLocation: {
690
+ * // query: "STRING_VALUE",
691
+ * // },
662
692
  * // },
663
693
  * // metadata: {
664
694
  * // "<keys>": "DOCUMENT_VALUE",
@@ -885,10 +915,19 @@ declare const InvokeInlineAgentCommand_base: {
885
915
  * // retrievedReferences: [
886
916
  * // {
887
917
  * // content: {
888
- * // text: "STRING_VALUE", // required
918
+ * // type: "TEXT" || "IMAGE" || "ROW",
919
+ * // text: "STRING_VALUE",
920
+ * // byteContent: "STRING_VALUE",
921
+ * // row: [
922
+ * // {
923
+ * // columnName: "STRING_VALUE",
924
+ * // columnValue: "STRING_VALUE",
925
+ * // type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING",
926
+ * // },
927
+ * // ],
889
928
  * // },
890
929
  * // location: {
891
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
930
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
892
931
  * // s3Location: {
893
932
  * // uri: "STRING_VALUE",
894
933
  * // },
@@ -907,6 +946,12 @@ declare const InvokeInlineAgentCommand_base: {
907
946
  * // customDocumentLocation: {
908
947
  * // id: "STRING_VALUE",
909
948
  * // },
949
+ * // kendraDocumentLocation: {
950
+ * // uri: "STRING_VALUE",
951
+ * // },
952
+ * // sqlLocation: {
953
+ * // query: "STRING_VALUE",
954
+ * // },
910
955
  * // },
911
956
  * // metadata: {
912
957
  * // "<keys>": "DOCUMENT_VALUE",
package/dist-types/commands/RetrieveAndGenerateCommand.d.ts CHANGED
@@ -247,10 +247,19 @@ declare const RetrieveAndGenerateCommand_base: {
247
247
  * // retrievedReferences: [ // RetrievedReferences
248
248
  * // { // RetrievedReference
249
249
  * // content: { // RetrievalResultContent
250
- * // text: "STRING_VALUE", // required
250
+ * // type: "TEXT" || "IMAGE" || "ROW",
251
+ * // text: "STRING_VALUE",
252
+ * // byteContent: "STRING_VALUE",
253
+ * // row: [ // RetrievalResultContentRow
254
+ * // { // RetrievalResultContentColumn
255
+ * // columnName: "STRING_VALUE",
256
+ * // columnValue: "STRING_VALUE",
257
+ * // type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING",
258
+ * // },
259
+ * // ],
251
260
  * // },
252
261
  * // location: { // RetrievalResultLocation
253
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
262
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
254
263
  * // s3Location: { // RetrievalResultS3Location
255
264
  * // uri: "STRING_VALUE",
256
265
  * // },
@@ -269,6 +278,12 @@ declare const RetrieveAndGenerateCommand_base: {
269
278
  * // customDocumentLocation: { // RetrievalResultCustomDocumentLocation
270
279
  * // id: "STRING_VALUE",
271
280
  * // },
281
+ * // kendraDocumentLocation: { // RetrievalResultKendraDocumentLocation
282
+ * // uri: "STRING_VALUE",
283
+ * // },
284
+ * // sqlLocation: { // RetrievalResultSqlLocation
285
+ * // query: "STRING_VALUE",
286
+ * // },
272
287
  * // },
273
288
  * // metadata: { // RetrievalResultMetadata
274
289
  * // "<keys>": "DOCUMENT_VALUE",
package/dist-types/commands/RetrieveAndGenerateStreamCommand.d.ts CHANGED
@@ -250,10 +250,19 @@ declare const RetrieveAndGenerateStreamCommand_base: {
250
250
  * // retrievedReferences: [ // RetrievedReferences
251
251
  * // { // RetrievedReference
252
252
  * // content: { // RetrievalResultContent
253
- * // text: "STRING_VALUE", // required
253
+ * // type: "TEXT" || "IMAGE" || "ROW",
254
+ * // text: "STRING_VALUE",
255
+ * // byteContent: "STRING_VALUE",
256
+ * // row: [ // RetrievalResultContentRow
257
+ * // { // RetrievalResultContentColumn
258
+ * // columnName: "STRING_VALUE",
259
+ * // columnValue: "STRING_VALUE",
260
+ * // type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING",
261
+ * // },
262
+ * // ],
254
263
  * // },
255
264
  * // location: { // RetrievalResultLocation
256
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
265
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
257
266
  * // s3Location: { // RetrievalResultS3Location
258
267
  * // uri: "STRING_VALUE",
259
268
  * // },
@@ -272,6 +281,12 @@ declare const RetrieveAndGenerateStreamCommand_base: {
272
281
  * // customDocumentLocation: { // RetrievalResultCustomDocumentLocation
273
282
  * // id: "STRING_VALUE",
274
283
  * // },
284
+ * // kendraDocumentLocation: { // RetrievalResultKendraDocumentLocation
285
+ * // uri: "STRING_VALUE",
286
+ * // },
287
+ * // sqlLocation: { // RetrievalResultSqlLocation
288
+ * // query: "STRING_VALUE",
289
+ * // },
275
290
  * // },
276
291
  * // metadata: { // RetrievalResultMetadata
277
292
  * // "<keys>": "DOCUMENT_VALUE",
package/dist-types/commands/RetrieveCommand.d.ts CHANGED
@@ -146,10 +146,19 @@ declare const RetrieveCommand_base: {
146
146
  * // retrievalResults: [ // KnowledgeBaseRetrievalResults // required
147
147
  * // { // KnowledgeBaseRetrievalResult
148
148
  * // content: { // RetrievalResultContent
149
- * // text: "STRING_VALUE", // required
149
+ * // type: "TEXT" || "IMAGE" || "ROW",
150
+ * // text: "STRING_VALUE",
151
+ * // byteContent: "STRING_VALUE",
152
+ * // row: [ // RetrievalResultContentRow
153
+ * // { // RetrievalResultContentColumn
154
+ * // columnName: "STRING_VALUE",
155
+ * // columnValue: "STRING_VALUE",
156
+ * // type: "BLOB" || "BOOLEAN" || "DOUBLE" || "NULL" || "LONG" || "STRING",
157
+ * // },
158
+ * // ],
150
159
  * // },
151
160
  * // location: { // RetrievalResultLocation
152
- * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM", // required
161
+ * // type: "S3" || "WEB" || "CONFLUENCE" || "SALESFORCE" || "SHAREPOINT" || "CUSTOM" || "KENDRA" || "SQL", // required
153
162
  * // s3Location: { // RetrievalResultS3Location
154
163
  * // uri: "STRING_VALUE",
155
164
  * // },
@@ -168,6 +177,12 @@ declare const RetrieveCommand_base: {
168
177
  * // customDocumentLocation: { // RetrievalResultCustomDocumentLocation
169
178
  * // id: "STRING_VALUE",
170
179
  * // },
180
+ * // kendraDocumentLocation: { // RetrievalResultKendraDocumentLocation
181
+ * // uri: "STRING_VALUE",
182
+ * // },
183
+ * // sqlLocation: { // RetrievalResultSqlLocation
184
+ * // query: "STRING_VALUE",
185
+ * // },
171
186
  * // },
172
187
  * // score: Number("double"),
173
188
  * // metadata: { // RetrievalResultMetadata
package/dist-types/commands/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  export * from "./DeleteAgentMemoryCommand";
2
+ export * from "./GenerateQueryCommand";
2
3
  export * from "./GetAgentMemoryCommand";
3
4
  export * from "./InvokeAgentCommand";
4
5
  export * from "./InvokeFlowCommand";