@aws-sdk/client-bedrock-runtime 3.705.0 → 3.706.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.
@@ -412,6 +412,64 @@ export interface StartAsyncInvokeResponse {
412
412
  */
413
413
  invocationArn: string | undefined;
414
414
  }
415
+ /**
416
+ * @public
417
+ * @enum
418
+ */
419
+ export declare const GuardrailImageFormat: {
420
+ readonly JPEG: "jpeg";
421
+ readonly PNG: "png";
422
+ };
423
+ /**
424
+ * @public
425
+ */
426
+ export type GuardrailImageFormat = (typeof GuardrailImageFormat)[keyof typeof GuardrailImageFormat];
427
+ /**
428
+ * <p>The image source (image bytes) of the guardrail image source. Object used in independent api.</p>
429
+ * @public
430
+ */
431
+ export type GuardrailImageSource = GuardrailImageSource.BytesMember | GuardrailImageSource.$UnknownMember;
432
+ /**
433
+ * @public
434
+ */
435
+ export declare namespace GuardrailImageSource {
436
+ /**
437
+ * <p>The bytes details of the guardrail image source. Object used in independent api.</p>
438
+ * @public
439
+ */
440
+ interface BytesMember {
441
+ bytes: Uint8Array;
442
+ $unknown?: never;
443
+ }
444
+ /**
445
+ * @public
446
+ */
447
+ interface $UnknownMember {
448
+ bytes?: never;
449
+ $unknown: [string, any];
450
+ }
451
+ interface Visitor<T> {
452
+ bytes: (value: Uint8Array) => T;
453
+ _: (name: string, value: any) => T;
454
+ }
455
+ const visit: <T>(value: GuardrailImageSource, visitor: Visitor<T>) => T;
456
+ }
457
+ /**
458
+ * <p>Contain an image which user wants guarded. This block is accepted by the guardrails independent API.</p>
459
+ * @public
460
+ */
461
+ export interface GuardrailImageBlock {
462
+ /**
463
+ * <p>The format details for the file type of the image blocked by the guardrail.</p>
464
+ * @public
465
+ */
466
+ format: GuardrailImageFormat | undefined;
467
+ /**
468
+ * <p>The image source (image bytes) details of the image blocked by the guardrail.</p>
469
+ * @public
470
+ */
471
+ source: GuardrailImageSource | undefined;
472
+ }
415
473
  /**
416
474
  * @public
417
475
  * @enum
@@ -445,7 +503,7 @@ export interface GuardrailTextBlock {
445
503
  * <p>The content block to be evaluated by the guardrail.</p>
446
504
  * @public
447
505
  */
448
- export type GuardrailContentBlock = GuardrailContentBlock.TextMember | GuardrailContentBlock.$UnknownMember;
506
+ export type GuardrailContentBlock = GuardrailContentBlock.ImageMember | GuardrailContentBlock.TextMember | GuardrailContentBlock.$UnknownMember;
449
507
  /**
450
508
  * @public
451
509
  */
@@ -456,6 +514,16 @@ export declare namespace GuardrailContentBlock {
456
514
  */
457
515
  interface TextMember {
458
516
  text: GuardrailTextBlock;
517
+ image?: never;
518
+ $unknown?: never;
519
+ }
520
+ /**
521
+ * <p>Image within guardrail content block to be evaluated by the guardrail.</p>
522
+ * @public
523
+ */
524
+ interface ImageMember {
525
+ text?: never;
526
+ image: GuardrailImageBlock;
459
527
  $unknown?: never;
460
528
  }
461
529
  /**
@@ -463,10 +531,12 @@ export declare namespace GuardrailContentBlock {
463
531
  */
464
532
  interface $UnknownMember {
465
533
  text?: never;
534
+ image?: never;
466
535
  $unknown: [string, any];
467
536
  }
468
537
  interface Visitor<T> {
469
538
  text: (value: GuardrailTextBlock) => T;
539
+ image: (value: GuardrailImageBlock) => T;
470
540
  _: (name: string, value: any) => T;
471
541
  }
472
542
  const visit: <T>(value: GuardrailContentBlock, visitor: Visitor<T>) => T;
@@ -673,6 +743,22 @@ export interface GuardrailContextualGroundingPolicyAssessment {
673
743
  */
674
744
  filters?: GuardrailContextualGroundingFilter[] | undefined;
675
745
  }
746
+ /**
747
+ * <p>The details of the guardrail image coverage.</p>
748
+ * @public
749
+ */
750
+ export interface GuardrailImageCoverage {
751
+ /**
752
+ * <p>The count (integer) of images guardrails guarded.</p>
753
+ * @public
754
+ */
755
+ guarded?: number | undefined;
756
+ /**
757
+ * <p>Represents the total number of images (integer) that were in the request (guarded and unguarded).</p>
758
+ * @public
759
+ */
760
+ total?: number | undefined;
761
+ }
676
762
  /**
677
763
  * <p>The guardrail coverage for the text characters.</p>
678
764
  * @public
@@ -699,6 +785,11 @@ export interface GuardrailCoverage {
699
785
  * @public
700
786
  */
701
787
  textCharacters?: GuardrailTextCharactersCoverage | undefined;
788
+ /**
789
+ * <p>The guardrail coverage for images (the number of images that guardrails guarded).</p>
790
+ * @public
791
+ */
792
+ images?: GuardrailImageCoverage | undefined;
702
793
  }
703
794
  /**
704
795
  * <p>The details on the use of the guardrail.</p>
@@ -1246,6 +1337,64 @@ export interface DocumentBlock {
1246
1337
  */
1247
1338
  source: DocumentSource | undefined;
1248
1339
  }
1340
+ /**
1341
+ * @public
1342
+ * @enum
1343
+ */
1344
+ export declare const GuardrailConverseImageFormat: {
1345
+ readonly JPEG: "jpeg";
1346
+ readonly PNG: "png";
1347
+ };
1348
+ /**
1349
+ * @public
1350
+ */
1351
+ export type GuardrailConverseImageFormat = (typeof GuardrailConverseImageFormat)[keyof typeof GuardrailConverseImageFormat];
1352
+ /**
1353
+ * <p>The image source (image bytes) of the guardrail converse image source.</p>
1354
+ * @public
1355
+ */
1356
+ export type GuardrailConverseImageSource = GuardrailConverseImageSource.BytesMember | GuardrailConverseImageSource.$UnknownMember;
1357
+ /**
1358
+ * @public
1359
+ */
1360
+ export declare namespace GuardrailConverseImageSource {
1361
+ /**
1362
+ * <p>The raw image bytes for the image.</p>
1363
+ * @public
1364
+ */
1365
+ interface BytesMember {
1366
+ bytes: Uint8Array;
1367
+ $unknown?: never;
1368
+ }
1369
+ /**
1370
+ * @public
1371
+ */
1372
+ interface $UnknownMember {
1373
+ bytes?: never;
1374
+ $unknown: [string, any];
1375
+ }
1376
+ interface Visitor<T> {
1377
+ bytes: (value: Uint8Array) => T;
1378
+ _: (name: string, value: any) => T;
1379
+ }
1380
+ const visit: <T>(value: GuardrailConverseImageSource, visitor: Visitor<T>) => T;
1381
+ }
1382
+ /**
1383
+ * <p>An image block that contains images that you want to assess with a guardrail.</p>
1384
+ * @public
1385
+ */
1386
+ export interface GuardrailConverseImageBlock {
1387
+ /**
1388
+ * <p>The format details for the image type of the guardrail converse image block.</p>
1389
+ * @public
1390
+ */
1391
+ format: GuardrailConverseImageFormat | undefined;
1392
+ /**
1393
+ * <p>The image source (image bytes) of the guardrail converse image block.</p>
1394
+ * @public
1395
+ */
1396
+ source: GuardrailConverseImageSource | undefined;
1397
+ }
1249
1398
  /**
1250
1399
  * @public
1251
1400
  * @enum
@@ -1281,7 +1430,7 @@ export interface GuardrailConverseTextBlock {
1281
1430
  * </p>
1282
1431
  * @public
1283
1432
  */
1284
- export type GuardrailConverseContentBlock = GuardrailConverseContentBlock.TextMember | GuardrailConverseContentBlock.$UnknownMember;
1433
+ export type GuardrailConverseContentBlock = GuardrailConverseContentBlock.ImageMember | GuardrailConverseContentBlock.TextMember | GuardrailConverseContentBlock.$UnknownMember;
1285
1434
  /**
1286
1435
  * @public
1287
1436
  */
@@ -1292,6 +1441,16 @@ export declare namespace GuardrailConverseContentBlock {
1292
1441
  */
1293
1442
  interface TextMember {
1294
1443
  text: GuardrailConverseTextBlock;
1444
+ image?: never;
1445
+ $unknown?: never;
1446
+ }
1447
+ /**
1448
+ * <p>Image within converse content block to be evaluated by the guardrail.</p>
1449
+ * @public
1450
+ */
1451
+ interface ImageMember {
1452
+ text?: never;
1453
+ image: GuardrailConverseImageBlock;
1295
1454
  $unknown?: never;
1296
1455
  }
1297
1456
  /**
@@ -1299,10 +1458,12 @@ export declare namespace GuardrailConverseContentBlock {
1299
1458
  */
1300
1459
  interface $UnknownMember {
1301
1460
  text?: never;
1461
+ image?: never;
1302
1462
  $unknown: [string, any];
1303
1463
  }
1304
1464
  interface Visitor<T> {
1305
1465
  text: (value: GuardrailConverseTextBlock) => T;
1466
+ image: (value: GuardrailConverseImageBlock) => T;
1306
1467
  _: (name: string, value: any) => T;
1307
1468
  }
1308
1469
  const visit: <T>(value: GuardrailConverseContentBlock, visitor: Visitor<T>) => T;
@@ -2251,6 +2412,17 @@ export interface GuardrailTraceAssessment {
2251
2412
  */
2252
2413
  outputAssessments?: Record<string, GuardrailAssessment[]> | undefined;
2253
2414
  }
2415
+ /**
2416
+ * <p>A prompt router trace.</p>
2417
+ * @public
2418
+ */
2419
+ export interface PromptRouterTrace {
2420
+ /**
2421
+ * <p>The ID of the invoked model.</p>
2422
+ * @public
2423
+ */
2424
+ invokedModelId?: string | undefined;
2425
+ }
2254
2426
  /**
2255
2427
  * <p>The trace object in a response from <a href="https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html">Converse</a>. Currently, you can only trace guardrails.</p>
2256
2428
  * @public
@@ -2261,6 +2433,11 @@ export interface ConverseTrace {
2261
2433
  * @public
2262
2434
  */
2263
2435
  guardrail?: GuardrailTraceAssessment | undefined;
2436
+ /**
2437
+ * <p>The request's prompt router.</p>
2438
+ * @public
2439
+ */
2440
+ promptRouter?: PromptRouterTrace | undefined;
2264
2441
  }
2265
2442
  /**
2266
2443
  * <p>The tokens used in a message API inference call. </p>
@@ -2702,6 +2879,11 @@ export interface ConverseStreamTrace {
2702
2879
  * @public
2703
2880
  */
2704
2881
  guardrail?: GuardrailTraceAssessment | undefined;
2882
+ /**
2883
+ * <p>The request's prompt router.</p>
2884
+ * @public
2885
+ */
2886
+ promptRouter?: PromptRouterTrace | undefined;
2705
2887
  }
2706
2888
  /**
2707
2889
  * <p>A conversation stream metadata event.</p>
@@ -3370,10 +3552,58 @@ export declare const ListAsyncInvokesResponseFilterSensitiveLog: (obj: ListAsync
3370
3552
  * @internal
3371
3553
  */
3372
3554
  export declare const StartAsyncInvokeRequestFilterSensitiveLog: (obj: StartAsyncInvokeRequest) => any;
3555
+ /**
3556
+ * @internal
3557
+ */
3558
+ export declare const GuardrailImageSourceFilterSensitiveLog: (obj: GuardrailImageSource) => any;
3559
+ /**
3560
+ * @internal
3561
+ */
3562
+ export declare const GuardrailImageBlockFilterSensitiveLog: (obj: GuardrailImageBlock) => any;
3563
+ /**
3564
+ * @internal
3565
+ */
3566
+ export declare const GuardrailContentBlockFilterSensitiveLog: (obj: GuardrailContentBlock) => any;
3567
+ /**
3568
+ * @internal
3569
+ */
3570
+ export declare const ApplyGuardrailRequestFilterSensitiveLog: (obj: ApplyGuardrailRequest) => any;
3571
+ /**
3572
+ * @internal
3573
+ */
3574
+ export declare const GuardrailConverseImageSourceFilterSensitiveLog: (obj: GuardrailConverseImageSource) => any;
3575
+ /**
3576
+ * @internal
3577
+ */
3578
+ export declare const GuardrailConverseImageBlockFilterSensitiveLog: (obj: GuardrailConverseImageBlock) => any;
3579
+ /**
3580
+ * @internal
3581
+ */
3582
+ export declare const GuardrailConverseContentBlockFilterSensitiveLog: (obj: GuardrailConverseContentBlock) => any;
3583
+ /**
3584
+ * @internal
3585
+ */
3586
+ export declare const ContentBlockFilterSensitiveLog: (obj: ContentBlock) => any;
3587
+ /**
3588
+ * @internal
3589
+ */
3590
+ export declare const MessageFilterSensitiveLog: (obj: Message) => any;
3591
+ /**
3592
+ * @internal
3593
+ */
3594
+ export declare const SystemContentBlockFilterSensitiveLog: (obj: SystemContentBlock) => any;
3373
3595
  /**
3374
3596
  * @internal
3375
3597
  */
3376
3598
  export declare const ConverseRequestFilterSensitiveLog: (obj: ConverseRequest) => any;
3599
+ /**
3600
+ * @internal
3601
+ */
3602
+ export declare const ConverseOutputFilterSensitiveLog: (obj: ConverseOutput) => any;
3603
+ /**
3604
+ * @internal
3605
+ */
3606
+ export declare const ConverseResponseFilterSensitiveLog: (obj: ConverseResponse) => any;
3377
3607
  /**
3378
3608
  * @internal
3379
3609
  */
@@ -150,6 +150,34 @@ export interface StartAsyncInvokeRequest {
150
150
  export interface StartAsyncInvokeResponse {
151
151
  invocationArn: string | undefined;
152
152
  }
153
+ export declare const GuardrailImageFormat: {
154
+ readonly JPEG: "jpeg";
155
+ readonly PNG: "png";
156
+ };
157
+ export type GuardrailImageFormat =
158
+ (typeof GuardrailImageFormat)[keyof typeof GuardrailImageFormat];
159
+ export type GuardrailImageSource =
160
+ | GuardrailImageSource.BytesMember
161
+ | GuardrailImageSource.$UnknownMember;
162
+ export declare namespace GuardrailImageSource {
163
+ interface BytesMember {
164
+ bytes: Uint8Array;
165
+ $unknown?: never;
166
+ }
167
+ interface $UnknownMember {
168
+ bytes?: never;
169
+ $unknown: [string, any];
170
+ }
171
+ interface Visitor<T> {
172
+ bytes: (value: Uint8Array) => T;
173
+ _: (name: string, value: any) => T;
174
+ }
175
+ const visit: <T>(value: GuardrailImageSource, visitor: Visitor<T>) => T;
176
+ }
177
+ export interface GuardrailImageBlock {
178
+ format: GuardrailImageFormat | undefined;
179
+ source: GuardrailImageSource | undefined;
180
+ }
153
181
  export declare const GuardrailContentQualifier: {
154
182
  readonly GROUNDING_SOURCE: "grounding_source";
155
183
  readonly GUARD_CONTENT: "guard_content";
@@ -162,19 +190,28 @@ export interface GuardrailTextBlock {
162
190
  qualifiers?: GuardrailContentQualifier[] | undefined;
163
191
  }
164
192
  export type GuardrailContentBlock =
193
+ | GuardrailContentBlock.ImageMember
165
194
  | GuardrailContentBlock.TextMember
166
195
  | GuardrailContentBlock.$UnknownMember;
167
196
  export declare namespace GuardrailContentBlock {
168
197
  interface TextMember {
169
198
  text: GuardrailTextBlock;
199
+ image?: never;
200
+ $unknown?: never;
201
+ }
202
+ interface ImageMember {
203
+ text?: never;
204
+ image: GuardrailImageBlock;
170
205
  $unknown?: never;
171
206
  }
172
207
  interface $UnknownMember {
173
208
  text?: never;
209
+ image?: never;
174
210
  $unknown: [string, any];
175
211
  }
176
212
  interface Visitor<T> {
177
213
  text: (value: GuardrailTextBlock) => T;
214
+ image: (value: GuardrailImageBlock) => T;
178
215
  _: (name: string, value: any) => T;
179
216
  }
180
217
  const visit: <T>(value: GuardrailContentBlock, visitor: Visitor<T>) => T;
@@ -258,12 +295,17 @@ export interface GuardrailContextualGroundingFilter {
258
295
  export interface GuardrailContextualGroundingPolicyAssessment {
259
296
  filters?: GuardrailContextualGroundingFilter[] | undefined;
260
297
  }
298
+ export interface GuardrailImageCoverage {
299
+ guarded?: number | undefined;
300
+ total?: number | undefined;
301
+ }
261
302
  export interface GuardrailTextCharactersCoverage {
262
303
  guarded?: number | undefined;
263
304
  total?: number | undefined;
264
305
  }
265
306
  export interface GuardrailCoverage {
266
307
  textCharacters?: GuardrailTextCharactersCoverage | undefined;
308
+ images?: GuardrailImageCoverage | undefined;
267
309
  }
268
310
  export interface GuardrailUsage {
269
311
  topicPolicyUnits: number | undefined;
@@ -450,6 +492,37 @@ export interface DocumentBlock {
450
492
  name: string | undefined;
451
493
  source: DocumentSource | undefined;
452
494
  }
495
+ export declare const GuardrailConverseImageFormat: {
496
+ readonly JPEG: "jpeg";
497
+ readonly PNG: "png";
498
+ };
499
+ export type GuardrailConverseImageFormat =
500
+ (typeof GuardrailConverseImageFormat)[keyof typeof GuardrailConverseImageFormat];
501
+ export type GuardrailConverseImageSource =
502
+ | GuardrailConverseImageSource.BytesMember
503
+ | GuardrailConverseImageSource.$UnknownMember;
504
+ export declare namespace GuardrailConverseImageSource {
505
+ interface BytesMember {
506
+ bytes: Uint8Array;
507
+ $unknown?: never;
508
+ }
509
+ interface $UnknownMember {
510
+ bytes?: never;
511
+ $unknown: [string, any];
512
+ }
513
+ interface Visitor<T> {
514
+ bytes: (value: Uint8Array) => T;
515
+ _: (name: string, value: any) => T;
516
+ }
517
+ const visit: <T>(
518
+ value: GuardrailConverseImageSource,
519
+ visitor: Visitor<T>
520
+ ) => T;
521
+ }
522
+ export interface GuardrailConverseImageBlock {
523
+ format: GuardrailConverseImageFormat | undefined;
524
+ source: GuardrailConverseImageSource | undefined;
525
+ }
453
526
  export declare const GuardrailConverseContentQualifier: {
454
527
  readonly GROUNDING_SOURCE: "grounding_source";
455
528
  readonly GUARD_CONTENT: "guard_content";
@@ -462,19 +535,28 @@ export interface GuardrailConverseTextBlock {
462
535
  qualifiers?: GuardrailConverseContentQualifier[] | undefined;
463
536
  }
464
537
  export type GuardrailConverseContentBlock =
538
+ | GuardrailConverseContentBlock.ImageMember
465
539
  | GuardrailConverseContentBlock.TextMember
466
540
  | GuardrailConverseContentBlock.$UnknownMember;
467
541
  export declare namespace GuardrailConverseContentBlock {
468
542
  interface TextMember {
469
543
  text: GuardrailConverseTextBlock;
544
+ image?: never;
545
+ $unknown?: never;
546
+ }
547
+ interface ImageMember {
548
+ text?: never;
549
+ image: GuardrailConverseImageBlock;
470
550
  $unknown?: never;
471
551
  }
472
552
  interface $UnknownMember {
473
553
  text?: never;
554
+ image?: never;
474
555
  $unknown: [string, any];
475
556
  }
476
557
  interface Visitor<T> {
477
558
  text: (value: GuardrailConverseTextBlock) => T;
559
+ image: (value: GuardrailConverseImageBlock) => T;
478
560
  _: (name: string, value: any) => T;
479
561
  }
480
562
  const visit: <T>(
@@ -938,8 +1020,12 @@ export interface GuardrailTraceAssessment {
938
1020
  inputAssessment?: Record<string, GuardrailAssessment> | undefined;
939
1021
  outputAssessments?: Record<string, GuardrailAssessment[]> | undefined;
940
1022
  }
1023
+ export interface PromptRouterTrace {
1024
+ invokedModelId?: string | undefined;
1025
+ }
941
1026
  export interface ConverseTrace {
942
1027
  guardrail?: GuardrailTraceAssessment | undefined;
1028
+ promptRouter?: PromptRouterTrace | undefined;
943
1029
  }
944
1030
  export interface TokenUsage {
945
1031
  inputTokens: number | undefined;
@@ -1079,6 +1165,7 @@ export interface ConverseStreamMetrics {
1079
1165
  }
1080
1166
  export interface ConverseStreamTrace {
1081
1167
  guardrail?: GuardrailTraceAssessment | undefined;
1168
+ promptRouter?: PromptRouterTrace | undefined;
1082
1169
  }
1083
1170
  export interface ConverseStreamMetadataEvent {
1084
1171
  usage: TokenUsage | undefined;
@@ -1448,9 +1535,41 @@ export declare const ListAsyncInvokesResponseFilterSensitiveLog: (
1448
1535
  export declare const StartAsyncInvokeRequestFilterSensitiveLog: (
1449
1536
  obj: StartAsyncInvokeRequest
1450
1537
  ) => any;
1538
+ export declare const GuardrailImageSourceFilterSensitiveLog: (
1539
+ obj: GuardrailImageSource
1540
+ ) => any;
1541
+ export declare const GuardrailImageBlockFilterSensitiveLog: (
1542
+ obj: GuardrailImageBlock
1543
+ ) => any;
1544
+ export declare const GuardrailContentBlockFilterSensitiveLog: (
1545
+ obj: GuardrailContentBlock
1546
+ ) => any;
1547
+ export declare const ApplyGuardrailRequestFilterSensitiveLog: (
1548
+ obj: ApplyGuardrailRequest
1549
+ ) => any;
1550
+ export declare const GuardrailConverseImageSourceFilterSensitiveLog: (
1551
+ obj: GuardrailConverseImageSource
1552
+ ) => any;
1553
+ export declare const GuardrailConverseImageBlockFilterSensitiveLog: (
1554
+ obj: GuardrailConverseImageBlock
1555
+ ) => any;
1556
+ export declare const GuardrailConverseContentBlockFilterSensitiveLog: (
1557
+ obj: GuardrailConverseContentBlock
1558
+ ) => any;
1559
+ export declare const ContentBlockFilterSensitiveLog: (obj: ContentBlock) => any;
1560
+ export declare const MessageFilterSensitiveLog: (obj: Message) => any;
1561
+ export declare const SystemContentBlockFilterSensitiveLog: (
1562
+ obj: SystemContentBlock
1563
+ ) => any;
1451
1564
  export declare const ConverseRequestFilterSensitiveLog: (
1452
1565
  obj: ConverseRequest
1453
1566
  ) => any;
1567
+ export declare const ConverseOutputFilterSensitiveLog: (
1568
+ obj: ConverseOutput
1569
+ ) => any;
1570
+ export declare const ConverseResponseFilterSensitiveLog: (
1571
+ obj: ConverseResponse
1572
+ ) => any;
1454
1573
  export declare const ConverseStreamRequestFilterSensitiveLog: (
1455
1574
  obj: ConverseStreamRequest
1456
1575
  ) => any;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-bedrock-runtime",
3
3
  "description": "AWS SDK for JavaScript Bedrock Runtime Client for Node.js, Browser and React Native",
4
- "version": "3.705.0",
4
+ "version": "3.706.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-bedrock-runtime",