aws-sdk-bedrockruntime 1.44.0 → 1.46.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.
@@ -818,6 +818,10 @@ module Aws::BedrockRuntime
818
818
  # format: "png", # required, accepts png, jpeg, gif, webp
819
819
  # source: { # required
820
820
  # bytes: "data",
821
+ # s3_location: {
822
+ # uri: "S3Uri", # required
823
+ # bucket_owner: "AccountId",
824
+ # },
821
825
  # },
822
826
  # },
823
827
  # document: {
@@ -825,6 +829,10 @@ module Aws::BedrockRuntime
825
829
  # name: "DocumentBlockNameString", # required
826
830
  # source: { # required
827
831
  # bytes: "data",
832
+ # s3_location: {
833
+ # uri: "S3Uri", # required
834
+ # bucket_owner: "AccountId",
835
+ # },
828
836
  # },
829
837
  # },
830
838
  # video: {
@@ -854,6 +862,10 @@ module Aws::BedrockRuntime
854
862
  # format: "png", # required, accepts png, jpeg, gif, webp
855
863
  # source: { # required
856
864
  # bytes: "data",
865
+ # s3_location: {
866
+ # uri: "S3Uri", # required
867
+ # bucket_owner: "AccountId",
868
+ # },
857
869
  # },
858
870
  # },
859
871
  # document: {
@@ -861,6 +873,10 @@ module Aws::BedrockRuntime
861
873
  # name: "DocumentBlockNameString", # required
862
874
  # source: { # required
863
875
  # bytes: "data",
876
+ # s3_location: {
877
+ # uri: "S3Uri", # required
878
+ # bucket_owner: "AccountId",
879
+ # },
864
880
  # },
865
881
  # },
866
882
  # video: {
@@ -983,9 +999,13 @@ module Aws::BedrockRuntime
983
999
  # resp.output.message.content[0].text #=> String
984
1000
  # resp.output.message.content[0].image.format #=> String, one of "png", "jpeg", "gif", "webp"
985
1001
  # resp.output.message.content[0].image.source.bytes #=> String
1002
+ # resp.output.message.content[0].image.source.s3_location.uri #=> String
1003
+ # resp.output.message.content[0].image.source.s3_location.bucket_owner #=> String
986
1004
  # resp.output.message.content[0].document.format #=> String, one of "pdf", "csv", "doc", "docx", "xls", "xlsx", "html", "txt", "md"
987
1005
  # resp.output.message.content[0].document.name #=> String
988
1006
  # resp.output.message.content[0].document.source.bytes #=> String
1007
+ # resp.output.message.content[0].document.source.s3_location.uri #=> String
1008
+ # resp.output.message.content[0].document.source.s3_location.bucket_owner #=> String
989
1009
  # resp.output.message.content[0].video.format #=> String, one of "mkv", "mov", "mp4", "webm", "flv", "mpeg", "mpg", "wmv", "three_gp"
990
1010
  # resp.output.message.content[0].video.source.bytes #=> String
991
1011
  # resp.output.message.content[0].video.source.s3_location.uri #=> String
@@ -997,9 +1017,13 @@ module Aws::BedrockRuntime
997
1017
  # resp.output.message.content[0].tool_result.content[0].text #=> String
998
1018
  # resp.output.message.content[0].tool_result.content[0].image.format #=> String, one of "png", "jpeg", "gif", "webp"
999
1019
  # resp.output.message.content[0].tool_result.content[0].image.source.bytes #=> String
1020
+ # resp.output.message.content[0].tool_result.content[0].image.source.s3_location.uri #=> String
1021
+ # resp.output.message.content[0].tool_result.content[0].image.source.s3_location.bucket_owner #=> String
1000
1022
  # resp.output.message.content[0].tool_result.content[0].document.format #=> String, one of "pdf", "csv", "doc", "docx", "xls", "xlsx", "html", "txt", "md"
1001
1023
  # resp.output.message.content[0].tool_result.content[0].document.name #=> String
1002
1024
  # resp.output.message.content[0].tool_result.content[0].document.source.bytes #=> String
1025
+ # resp.output.message.content[0].tool_result.content[0].document.source.s3_location.uri #=> String
1026
+ # resp.output.message.content[0].tool_result.content[0].document.source.s3_location.bucket_owner #=> String
1003
1027
  # resp.output.message.content[0].tool_result.content[0].video.format #=> String, one of "mkv", "mov", "mp4", "webm", "flv", "mpeg", "mpg", "wmv", "three_gp"
1004
1028
  # resp.output.message.content[0].tool_result.content[0].video.source.bytes #=> String
1005
1029
  # resp.output.message.content[0].tool_result.content[0].video.source.s3_location.uri #=> String
@@ -1326,176 +1350,182 @@ module Aws::BedrockRuntime
1326
1350
  #
1327
1351
  # @example EventStream Operation Example
1328
1352
  #
1329
- # You can process the event once it arrives immediately, or wait until the
1330
- # full response is complete and iterate through the eventstream enumerator.
1331
- #
1332
- # To interact with event immediately, you need to register #converse_stream
1333
- # with callbacks. Callbacks can be registered for specific events or for all
1334
- # events, including error events.
1335
- #
1336
- # Callbacks can be passed into the `:event_stream_handler` option or within a
1337
- # block statement attached to the #converse_stream call directly. Hybrid
1338
- # pattern of both is also supported.
1339
- #
1340
- # `:event_stream_handler` option takes in either a Proc object or
1341
- # Aws::BedrockRuntime::EventStreams::ConverseStreamOutput object.
1342
- #
1343
- # Usage pattern a): Callbacks with a block attached to #converse_stream
1344
- # Example for registering callbacks for all event types and an error event
1345
- #
1346
- # client.converse_stream( # params input# ) do |stream|
1347
- # stream.on_error_event do |event|
1348
- # # catch unmodeled error event in the stream
1349
- # raise event
1350
- # # => Aws::Errors::EventError
1351
- # # event.event_type => :error
1352
- # # event.error_code => String
1353
- # # event.error_message => String
1354
- # end
1355
- #
1356
- # stream.on_event do |event|
1357
- # # process all events arrive
1358
- # puts event.event_type
1359
- # ...
1360
- # end
1361
- #
1353
+ # # You can process the event once it arrives immediately, or wait until the
1354
+ # # full response is complete and iterate through the eventstream enumerator.
1355
+ #
1356
+ # # To interact with event immediately, you need to register converse_stream
1357
+ # # with callbacks. Callbacks can be registered for specific events or for all
1358
+ # # events, including error events.
1359
+ #
1360
+ # # Callbacks can be passed into the `:event_stream_handler` option or within a
1361
+ # # block statement attached to the #converse_stream call directly. Hybrid
1362
+ # # pattern of both is also supported.
1363
+ #
1364
+ # # `:event_stream_handler` option takes in either a Proc object or
1365
+ # # Aws::BedrockRuntime::EventStreams::ConverseStreamOutput object.
1366
+ #
1367
+ # # Usage pattern a): Callbacks with a block attached to #converse_stream
1368
+ # # Example for registering callbacks for all event types and an error event
1369
+ # client.converse_stream(
1370
+ # # params input
1371
+ # ) do |stream|
1372
+ # stream.on_error_event do |event|
1373
+ # # catch unmodeled error event in the stream
1374
+ # raise event
1375
+ # # => Aws::Errors::EventError
1376
+ # # event.event_type => :error
1377
+ # # event.error_code => String
1378
+ # # event.error_message => String
1362
1379
  # end
1363
1380
  #
1364
- # Usage pattern b): Pass in `:event_stream_handler` for #converse_stream
1365
- #
1366
- # 1) Create a Aws::BedrockRuntime::EventStreams::ConverseStreamOutput object
1367
- # Example for registering callbacks with specific events
1368
- #
1369
- # handler = Aws::BedrockRuntime::EventStreams::ConverseStreamOutput.new
1370
- # handler.on_message_start_event do |event|
1371
- # event # => Aws::BedrockRuntime::Types::messageStart
1372
- # end
1373
- # handler.on_content_block_start_event do |event|
1374
- # event # => Aws::BedrockRuntime::Types::contentBlockStart
1375
- # end
1376
- # handler.on_content_block_delta_event do |event|
1377
- # event # => Aws::BedrockRuntime::Types::contentBlockDelta
1378
- # end
1379
- # handler.on_content_block_stop_event do |event|
1380
- # event # => Aws::BedrockRuntime::Types::contentBlockStop
1381
- # end
1382
- # handler.on_message_stop_event do |event|
1383
- # event # => Aws::BedrockRuntime::Types::messageStop
1384
- # end
1385
- # handler.on_metadata_event do |event|
1386
- # event # => Aws::BedrockRuntime::Types::metadata
1387
- # end
1388
- # handler.on_internal_server_exception_event do |event|
1389
- # event # => Aws::BedrockRuntime::Types::internalServerException
1390
- # end
1391
- # handler.on_model_stream_error_exception_event do |event|
1392
- # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
1393
- # end
1394
- # handler.on_validation_exception_event do |event|
1395
- # event # => Aws::BedrockRuntime::Types::validationException
1396
- # end
1397
- # handler.on_throttling_exception_event do |event|
1398
- # event # => Aws::BedrockRuntime::Types::throttlingException
1399
- # end
1400
- # handler.on_service_unavailable_exception_event do |event|
1401
- # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
1402
- # end
1403
- #
1404
- # client.converse_stream( # params input #, event_stream_handler: handler)
1405
- #
1406
- # 2) Use a Ruby Proc object
1407
- # Example for registering callbacks with specific events
1408
- #
1409
- # handler = Proc.new do |stream|
1410
- # stream.on_message_start_event do |event|
1411
- # event # => Aws::BedrockRuntime::Types::messageStart
1412
- # end
1413
- # stream.on_content_block_start_event do |event|
1414
- # event # => Aws::BedrockRuntime::Types::contentBlockStart
1415
- # end
1416
- # stream.on_content_block_delta_event do |event|
1417
- # event # => Aws::BedrockRuntime::Types::contentBlockDelta
1418
- # end
1419
- # stream.on_content_block_stop_event do |event|
1420
- # event # => Aws::BedrockRuntime::Types::contentBlockStop
1421
- # end
1422
- # stream.on_message_stop_event do |event|
1423
- # event # => Aws::BedrockRuntime::Types::messageStop
1424
- # end
1425
- # stream.on_metadata_event do |event|
1426
- # event # => Aws::BedrockRuntime::Types::metadata
1427
- # end
1428
- # stream.on_internal_server_exception_event do |event|
1429
- # event # => Aws::BedrockRuntime::Types::internalServerException
1430
- # end
1431
- # stream.on_model_stream_error_exception_event do |event|
1432
- # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
1433
- # end
1434
- # stream.on_validation_exception_event do |event|
1435
- # event # => Aws::BedrockRuntime::Types::validationException
1436
- # end
1437
- # stream.on_throttling_exception_event do |event|
1438
- # event # => Aws::BedrockRuntime::Types::throttlingException
1439
- # end
1440
- # stream.on_service_unavailable_exception_event do |event|
1441
- # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
1442
- # end
1381
+ # stream.on_event do |event|
1382
+ # # process all events arrive
1383
+ # puts event.event_type
1384
+ # # ...
1443
1385
  # end
1444
- #
1445
- # client.converse_stream( # params input #, event_stream_handler: handler)
1446
- #
1447
- # Usage pattern c): Hybrid pattern of a) and b)
1448
- #
1449
- # handler = Aws::BedrockRuntime::EventStreams::ConverseStreamOutput.new
1450
- # handler.on_message_start_event do |event|
1451
- # event # => Aws::BedrockRuntime::Types::messageStart
1452
- # end
1453
- # handler.on_content_block_start_event do |event|
1454
- # event # => Aws::BedrockRuntime::Types::contentBlockStart
1455
- # end
1456
- # handler.on_content_block_delta_event do |event|
1457
- # event # => Aws::BedrockRuntime::Types::contentBlockDelta
1458
- # end
1459
- # handler.on_content_block_stop_event do |event|
1460
- # event # => Aws::BedrockRuntime::Types::contentBlockStop
1461
- # end
1462
- # handler.on_message_stop_event do |event|
1463
- # event # => Aws::BedrockRuntime::Types::messageStop
1464
- # end
1465
- # handler.on_metadata_event do |event|
1466
- # event # => Aws::BedrockRuntime::Types::metadata
1467
- # end
1468
- # handler.on_internal_server_exception_event do |event|
1469
- # event # => Aws::BedrockRuntime::Types::internalServerException
1470
- # end
1471
- # handler.on_model_stream_error_exception_event do |event|
1472
- # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
1473
- # end
1474
- # handler.on_validation_exception_event do |event|
1475
- # event # => Aws::BedrockRuntime::Types::validationException
1476
- # end
1477
- # handler.on_throttling_exception_event do |event|
1478
- # event # => Aws::BedrockRuntime::Types::throttlingException
1479
- # end
1480
- # handler.on_service_unavailable_exception_event do |event|
1481
- # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
1482
- # end
1483
- #
1484
- # client.converse_stream( # params input #, event_stream_handler: handler) do |stream|
1485
- # stream.on_error_event do |event|
1486
- # # catch unmodeled error event in the stream
1487
- # raise event
1488
- # # => Aws::Errors::EventError
1489
- # # event.event_type => :error
1490
- # # event.error_code => String
1491
- # # event.error_message => String
1492
- # end
1386
+ # end
1387
+ #
1388
+ # # Usage pattern b): Pass in `:event_stream_handler` for #converse_stream
1389
+ # # 1) Create a Aws::BedrockRuntime::EventStreams::ConverseStreamOutput object
1390
+ # # Example for registering callbacks with specific events
1391
+ #
1392
+ # handler = Aws::BedrockRuntime::EventStreams::ConverseStreamOutput.new
1393
+ # handler.on_message_start_event do |event|
1394
+ # event # => Aws::BedrockRuntime::Types::messageStart
1395
+ # end
1396
+ # handler.on_content_block_start_event do |event|
1397
+ # event # => Aws::BedrockRuntime::Types::contentBlockStart
1398
+ # end
1399
+ # handler.on_content_block_delta_event do |event|
1400
+ # event # => Aws::BedrockRuntime::Types::contentBlockDelta
1401
+ # end
1402
+ # handler.on_content_block_stop_event do |event|
1403
+ # event # => Aws::BedrockRuntime::Types::contentBlockStop
1404
+ # end
1405
+ # handler.on_message_stop_event do |event|
1406
+ # event # => Aws::BedrockRuntime::Types::messageStop
1407
+ # end
1408
+ # handler.on_metadata_event do |event|
1409
+ # event # => Aws::BedrockRuntime::Types::metadata
1410
+ # end
1411
+ # handler.on_internal_server_exception_event do |event|
1412
+ # event # => Aws::BedrockRuntime::Types::internalServerException
1413
+ # end
1414
+ # handler.on_model_stream_error_exception_event do |event|
1415
+ # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
1416
+ # end
1417
+ # handler.on_validation_exception_event do |event|
1418
+ # event # => Aws::BedrockRuntime::Types::validationException
1419
+ # end
1420
+ # handler.on_throttling_exception_event do |event|
1421
+ # event # => Aws::BedrockRuntime::Types::throttlingException
1422
+ # end
1423
+ # handler.on_service_unavailable_exception_event do |event|
1424
+ # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
1425
+ # end
1426
+ #
1427
+ # client.converse_stream(
1428
+ # # params inputs
1429
+ # event_stream_handler: handler
1430
+ # )
1431
+ #
1432
+ # # 2) Use a Ruby Proc object
1433
+ # # Example for registering callbacks with specific events
1434
+ # handler = Proc.new do |stream|
1435
+ # stream.on_message_start_event do |event|
1436
+ # event # => Aws::BedrockRuntime::Types::messageStart
1493
1437
  # end
1438
+ # stream.on_content_block_start_event do |event|
1439
+ # event # => Aws::BedrockRuntime::Types::contentBlockStart
1440
+ # end
1441
+ # stream.on_content_block_delta_event do |event|
1442
+ # event # => Aws::BedrockRuntime::Types::contentBlockDelta
1443
+ # end
1444
+ # stream.on_content_block_stop_event do |event|
1445
+ # event # => Aws::BedrockRuntime::Types::contentBlockStop
1446
+ # end
1447
+ # stream.on_message_stop_event do |event|
1448
+ # event # => Aws::BedrockRuntime::Types::messageStop
1449
+ # end
1450
+ # stream.on_metadata_event do |event|
1451
+ # event # => Aws::BedrockRuntime::Types::metadata
1452
+ # end
1453
+ # stream.on_internal_server_exception_event do |event|
1454
+ # event # => Aws::BedrockRuntime::Types::internalServerException
1455
+ # end
1456
+ # stream.on_model_stream_error_exception_event do |event|
1457
+ # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
1458
+ # end
1459
+ # stream.on_validation_exception_event do |event|
1460
+ # event # => Aws::BedrockRuntime::Types::validationException
1461
+ # end
1462
+ # stream.on_throttling_exception_event do |event|
1463
+ # event # => Aws::BedrockRuntime::Types::throttlingException
1464
+ # end
1465
+ # stream.on_service_unavailable_exception_event do |event|
1466
+ # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
1467
+ # end
1468
+ # end
1469
+ #
1470
+ # client.converse_stream(
1471
+ # # params inputs
1472
+ # event_stream_handler: handler
1473
+ # )
1474
+ #
1475
+ # # Usage pattern c): Hybrid pattern of a) and b)
1476
+ # handler = Aws::BedrockRuntime::EventStreams::ConverseStreamOutput.new
1477
+ # handler.on_message_start_event do |event|
1478
+ # event # => Aws::BedrockRuntime::Types::messageStart
1479
+ # end
1480
+ # handler.on_content_block_start_event do |event|
1481
+ # event # => Aws::BedrockRuntime::Types::contentBlockStart
1482
+ # end
1483
+ # handler.on_content_block_delta_event do |event|
1484
+ # event # => Aws::BedrockRuntime::Types::contentBlockDelta
1485
+ # end
1486
+ # handler.on_content_block_stop_event do |event|
1487
+ # event # => Aws::BedrockRuntime::Types::contentBlockStop
1488
+ # end
1489
+ # handler.on_message_stop_event do |event|
1490
+ # event # => Aws::BedrockRuntime::Types::messageStop
1491
+ # end
1492
+ # handler.on_metadata_event do |event|
1493
+ # event # => Aws::BedrockRuntime::Types::metadata
1494
+ # end
1495
+ # handler.on_internal_server_exception_event do |event|
1496
+ # event # => Aws::BedrockRuntime::Types::internalServerException
1497
+ # end
1498
+ # handler.on_model_stream_error_exception_event do |event|
1499
+ # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
1500
+ # end
1501
+ # handler.on_validation_exception_event do |event|
1502
+ # event # => Aws::BedrockRuntime::Types::validationException
1503
+ # end
1504
+ # handler.on_throttling_exception_event do |event|
1505
+ # event # => Aws::BedrockRuntime::Types::throttlingException
1506
+ # end
1507
+ # handler.on_service_unavailable_exception_event do |event|
1508
+ # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
1509
+ # end
1510
+ #
1511
+ # client.converse_stream(
1512
+ # # params input
1513
+ # event_stream_handler: handler
1514
+ # ) do |stream|
1515
+ # stream.on_error_event do |event|
1516
+ # # catch unmodeled error event in the stream
1517
+ # raise event
1518
+ # # => Aws::Errors::EventError
1519
+ # # event.event_type => :error
1520
+ # # event.error_code => String
1521
+ # # event.error_message => String
1522
+ # end
1523
+ # end
1494
1524
  #
1495
- # You can also iterate through events after the response complete.
1496
- #
1497
- # Events are available at resp.stream # => Enumerator
1498
- # For parameter input example, please refer to following request syntax
1525
+ # # You can also iterate through events after the response complete.
1526
+ # # Events are available at
1527
+ # resp.stream # => Enumerator
1528
+ # # For parameter input example, please refer to following request syntax.
1499
1529
  #
1500
1530
  # @example Request syntax with placeholder values
1501
1531
  #
@@ -1511,6 +1541,10 @@ module Aws::BedrockRuntime
1511
1541
  # format: "png", # required, accepts png, jpeg, gif, webp
1512
1542
  # source: { # required
1513
1543
  # bytes: "data",
1544
+ # s3_location: {
1545
+ # uri: "S3Uri", # required
1546
+ # bucket_owner: "AccountId",
1547
+ # },
1514
1548
  # },
1515
1549
  # },
1516
1550
  # document: {
@@ -1518,6 +1552,10 @@ module Aws::BedrockRuntime
1518
1552
  # name: "DocumentBlockNameString", # required
1519
1553
  # source: { # required
1520
1554
  # bytes: "data",
1555
+ # s3_location: {
1556
+ # uri: "S3Uri", # required
1557
+ # bucket_owner: "AccountId",
1558
+ # },
1521
1559
  # },
1522
1560
  # },
1523
1561
  # video: {
@@ -1547,6 +1585,10 @@ module Aws::BedrockRuntime
1547
1585
  # format: "png", # required, accepts png, jpeg, gif, webp
1548
1586
  # source: { # required
1549
1587
  # bytes: "data",
1588
+ # s3_location: {
1589
+ # uri: "S3Uri", # required
1590
+ # bucket_owner: "AccountId",
1591
+ # },
1550
1592
  # },
1551
1593
  # },
1552
1594
  # document: {
@@ -1554,6 +1596,10 @@ module Aws::BedrockRuntime
1554
1596
  # name: "DocumentBlockNameString", # required
1555
1597
  # source: { # required
1556
1598
  # bytes: "data",
1599
+ # s3_location: {
1600
+ # uri: "S3Uri", # required
1601
+ # bucket_owner: "AccountId",
1602
+ # },
1557
1603
  # },
1558
1604
  # },
1559
1605
  # video: {
@@ -1672,19 +1718,19 @@ module Aws::BedrockRuntime
1672
1718
  #
1673
1719
  # @example Response structure
1674
1720
  #
1675
- # All events are available at resp.stream:
1721
+ # # All events are available at resp.stream:
1676
1722
  # resp.stream #=> Enumerator
1677
1723
  # resp.stream.event_types #=> [:message_start, :content_block_start, :content_block_delta, :content_block_stop, :message_stop, :metadata, :internal_server_exception, :model_stream_error_exception, :validation_exception, :throttling_exception, :service_unavailable_exception]
1678
1724
  #
1679
- # For :message_start event available at #on_message_start_event callback and response eventstream enumerator:
1725
+ # # For :message_start event available at #on_message_start_event callback and response eventstream enumerator:
1680
1726
  # event.role #=> String, one of "user", "assistant"
1681
1727
  #
1682
- # For :content_block_start event available at #on_content_block_start_event callback and response eventstream enumerator:
1728
+ # # For :content_block_start event available at #on_content_block_start_event callback and response eventstream enumerator:
1683
1729
  # event.start.tool_use.tool_use_id #=> String
1684
1730
  # event.start.tool_use.name #=> String
1685
1731
  # event.content_block_index #=> Integer
1686
1732
  #
1687
- # For :content_block_delta event available at #on_content_block_delta_event callback and response eventstream enumerator:
1733
+ # # For :content_block_delta event available at #on_content_block_delta_event callback and response eventstream enumerator:
1688
1734
  # event.delta.text #=> String
1689
1735
  # event.delta.tool_use.input #=> String
1690
1736
  # event.delta.reasoning_content.text #=> String
@@ -1692,13 +1738,13 @@ module Aws::BedrockRuntime
1692
1738
  # event.delta.reasoning_content.signature #=> String
1693
1739
  # event.content_block_index #=> Integer
1694
1740
  #
1695
- # For :content_block_stop event available at #on_content_block_stop_event callback and response eventstream enumerator:
1741
+ # # For :content_block_stop event available at #on_content_block_stop_event callback and response eventstream enumerator:
1696
1742
  # event.content_block_index #=> Integer
1697
1743
  #
1698
- # For :message_stop event available at #on_message_stop_event callback and response eventstream enumerator:
1744
+ # # For :message_stop event available at #on_message_stop_event callback and response eventstream enumerator:
1699
1745
  # event.stop_reason #=> String, one of "end_turn", "tool_use", "max_tokens", "stop_sequence", "guardrail_intervened", "content_filtered"
1700
1746
  #
1701
- # For :metadata event available at #on_metadata_event callback and response eventstream enumerator:
1747
+ # # For :metadata event available at #on_metadata_event callback and response eventstream enumerator:
1702
1748
  # event.usage.input_tokens #=> Integer
1703
1749
  # event.usage.output_tokens #=> Integer
1704
1750
  # event.usage.total_tokens #=> Integer
@@ -1812,21 +1858,21 @@ module Aws::BedrockRuntime
1812
1858
  # event.trace.prompt_router.invoked_model_id #=> String
1813
1859
  # event.performance_config.latency #=> String, one of "standard", "optimized"
1814
1860
  #
1815
- # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
1861
+ # # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
1816
1862
  # event.message #=> String
1817
1863
  #
1818
- # For :model_stream_error_exception event available at #on_model_stream_error_exception_event callback and response eventstream enumerator:
1864
+ # # For :model_stream_error_exception event available at #on_model_stream_error_exception_event callback and response eventstream enumerator:
1819
1865
  # event.message #=> String
1820
1866
  # event.original_status_code #=> Integer
1821
1867
  # event.original_message #=> String
1822
1868
  #
1823
- # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
1869
+ # # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
1824
1870
  # event.message #=> String
1825
1871
  #
1826
- # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
1872
+ # # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
1827
1873
  # event.message #=> String
1828
1874
  #
1829
- # For :service_unavailable_exception event available at #on_service_unavailable_exception_event callback and response eventstream enumerator:
1875
+ # # For :service_unavailable_exception event available at #on_service_unavailable_exception_event callback and response eventstream enumerator:
1830
1876
  # event.message #=> String
1831
1877
  #
1832
1878
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-runtime-2023-09-30/ConverseStream AWS API Documentation
@@ -2175,140 +2221,146 @@ module Aws::BedrockRuntime
2175
2221
  #
2176
2222
  # @example EventStream Operation Example
2177
2223
  #
2178
- # You can process the event once it arrives immediately, or wait until the
2179
- # full response is complete and iterate through the eventstream enumerator.
2180
- #
2181
- # To interact with event immediately, you need to register #invoke_model_with_response_stream
2182
- # with callbacks. Callbacks can be registered for specific events or for all
2183
- # events, including error events.
2184
- #
2185
- # Callbacks can be passed into the `:event_stream_handler` option or within a
2186
- # block statement attached to the #invoke_model_with_response_stream call directly. Hybrid
2187
- # pattern of both is also supported.
2188
- #
2189
- # `:event_stream_handler` option takes in either a Proc object or
2190
- # Aws::BedrockRuntime::EventStreams::ResponseStream object.
2191
- #
2192
- # Usage pattern a): Callbacks with a block attached to #invoke_model_with_response_stream
2193
- # Example for registering callbacks for all event types and an error event
2194
- #
2195
- # client.invoke_model_with_response_stream( # params input# ) do |stream|
2196
- # stream.on_error_event do |event|
2197
- # # catch unmodeled error event in the stream
2198
- # raise event
2199
- # # => Aws::Errors::EventError
2200
- # # event.event_type => :error
2201
- # # event.error_code => String
2202
- # # event.error_message => String
2203
- # end
2204
- #
2205
- # stream.on_event do |event|
2206
- # # process all events arrive
2207
- # puts event.event_type
2208
- # ...
2209
- # end
2210
- #
2224
+ # # You can process the event once it arrives immediately, or wait until the
2225
+ # # full response is complete and iterate through the eventstream enumerator.
2226
+ #
2227
+ # # To interact with event immediately, you need to register invoke_model_with_response_stream
2228
+ # # with callbacks. Callbacks can be registered for specific events or for all
2229
+ # # events, including error events.
2230
+ #
2231
+ # # Callbacks can be passed into the `:event_stream_handler` option or within a
2232
+ # # block statement attached to the #invoke_model_with_response_stream call directly. Hybrid
2233
+ # # pattern of both is also supported.
2234
+ #
2235
+ # # `:event_stream_handler` option takes in either a Proc object or
2236
+ # # Aws::BedrockRuntime::EventStreams::ResponseStream object.
2237
+ #
2238
+ # # Usage pattern a): Callbacks with a block attached to #invoke_model_with_response_stream
2239
+ # # Example for registering callbacks for all event types and an error event
2240
+ # client.invoke_model_with_response_stream(
2241
+ # # params input
2242
+ # ) do |stream|
2243
+ # stream.on_error_event do |event|
2244
+ # # catch unmodeled error event in the stream
2245
+ # raise event
2246
+ # # => Aws::Errors::EventError
2247
+ # # event.event_type => :error
2248
+ # # event.error_code => String
2249
+ # # event.error_message => String
2211
2250
  # end
2212
2251
  #
2213
- # Usage pattern b): Pass in `:event_stream_handler` for #invoke_model_with_response_stream
2214
- #
2215
- # 1) Create a Aws::BedrockRuntime::EventStreams::ResponseStream object
2216
- # Example for registering callbacks with specific events
2217
- #
2218
- # handler = Aws::BedrockRuntime::EventStreams::ResponseStream.new
2219
- # handler.on_chunk_event do |event|
2220
- # event # => Aws::BedrockRuntime::Types::chunk
2221
- # end
2222
- # handler.on_internal_server_exception_event do |event|
2223
- # event # => Aws::BedrockRuntime::Types::internalServerException
2224
- # end
2225
- # handler.on_model_stream_error_exception_event do |event|
2226
- # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
2227
- # end
2228
- # handler.on_validation_exception_event do |event|
2229
- # event # => Aws::BedrockRuntime::Types::validationException
2230
- # end
2231
- # handler.on_throttling_exception_event do |event|
2232
- # event # => Aws::BedrockRuntime::Types::throttlingException
2233
- # end
2234
- # handler.on_model_timeout_exception_event do |event|
2235
- # event # => Aws::BedrockRuntime::Types::modelTimeoutException
2236
- # end
2237
- # handler.on_service_unavailable_exception_event do |event|
2238
- # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
2239
- # end
2240
- #
2241
- # client.invoke_model_with_response_stream( # params input #, event_stream_handler: handler)
2242
- #
2243
- # 2) Use a Ruby Proc object
2244
- # Example for registering callbacks with specific events
2245
- #
2246
- # handler = Proc.new do |stream|
2247
- # stream.on_chunk_event do |event|
2248
- # event # => Aws::BedrockRuntime::Types::chunk
2249
- # end
2250
- # stream.on_internal_server_exception_event do |event|
2251
- # event # => Aws::BedrockRuntime::Types::internalServerException
2252
- # end
2253
- # stream.on_model_stream_error_exception_event do |event|
2254
- # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
2255
- # end
2256
- # stream.on_validation_exception_event do |event|
2257
- # event # => Aws::BedrockRuntime::Types::validationException
2258
- # end
2259
- # stream.on_throttling_exception_event do |event|
2260
- # event # => Aws::BedrockRuntime::Types::throttlingException
2261
- # end
2262
- # stream.on_model_timeout_exception_event do |event|
2263
- # event # => Aws::BedrockRuntime::Types::modelTimeoutException
2264
- # end
2265
- # stream.on_service_unavailable_exception_event do |event|
2266
- # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
2267
- # end
2252
+ # stream.on_event do |event|
2253
+ # # process all events arrive
2254
+ # puts event.event_type
2255
+ # # ...
2268
2256
  # end
2269
- #
2270
- # client.invoke_model_with_response_stream( # params input #, event_stream_handler: handler)
2271
- #
2272
- # Usage pattern c): Hybrid pattern of a) and b)
2273
- #
2274
- # handler = Aws::BedrockRuntime::EventStreams::ResponseStream.new
2275
- # handler.on_chunk_event do |event|
2276
- # event # => Aws::BedrockRuntime::Types::chunk
2277
- # end
2278
- # handler.on_internal_server_exception_event do |event|
2279
- # event # => Aws::BedrockRuntime::Types::internalServerException
2280
- # end
2281
- # handler.on_model_stream_error_exception_event do |event|
2282
- # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
2283
- # end
2284
- # handler.on_validation_exception_event do |event|
2285
- # event # => Aws::BedrockRuntime::Types::validationException
2286
- # end
2287
- # handler.on_throttling_exception_event do |event|
2288
- # event # => Aws::BedrockRuntime::Types::throttlingException
2289
- # end
2290
- # handler.on_model_timeout_exception_event do |event|
2291
- # event # => Aws::BedrockRuntime::Types::modelTimeoutException
2292
- # end
2293
- # handler.on_service_unavailable_exception_event do |event|
2294
- # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
2295
- # end
2296
- #
2297
- # client.invoke_model_with_response_stream( # params input #, event_stream_handler: handler) do |stream|
2298
- # stream.on_error_event do |event|
2299
- # # catch unmodeled error event in the stream
2300
- # raise event
2301
- # # => Aws::Errors::EventError
2302
- # # event.event_type => :error
2303
- # # event.error_code => String
2304
- # # event.error_message => String
2305
- # end
2257
+ # end
2258
+ #
2259
+ # # Usage pattern b): Pass in `:event_stream_handler` for #invoke_model_with_response_stream
2260
+ # # 1) Create a Aws::BedrockRuntime::EventStreams::ResponseStream object
2261
+ # # Example for registering callbacks with specific events
2262
+ #
2263
+ # handler = Aws::BedrockRuntime::EventStreams::ResponseStream.new
2264
+ # handler.on_chunk_event do |event|
2265
+ # event # => Aws::BedrockRuntime::Types::chunk
2266
+ # end
2267
+ # handler.on_internal_server_exception_event do |event|
2268
+ # event # => Aws::BedrockRuntime::Types::internalServerException
2269
+ # end
2270
+ # handler.on_model_stream_error_exception_event do |event|
2271
+ # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
2272
+ # end
2273
+ # handler.on_validation_exception_event do |event|
2274
+ # event # => Aws::BedrockRuntime::Types::validationException
2275
+ # end
2276
+ # handler.on_throttling_exception_event do |event|
2277
+ # event # => Aws::BedrockRuntime::Types::throttlingException
2278
+ # end
2279
+ # handler.on_model_timeout_exception_event do |event|
2280
+ # event # => Aws::BedrockRuntime::Types::modelTimeoutException
2281
+ # end
2282
+ # handler.on_service_unavailable_exception_event do |event|
2283
+ # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
2284
+ # end
2285
+ #
2286
+ # client.invoke_model_with_response_stream(
2287
+ # # params inputs
2288
+ # event_stream_handler: handler
2289
+ # )
2290
+ #
2291
+ # # 2) Use a Ruby Proc object
2292
+ # # Example for registering callbacks with specific events
2293
+ # handler = Proc.new do |stream|
2294
+ # stream.on_chunk_event do |event|
2295
+ # event # => Aws::BedrockRuntime::Types::chunk
2306
2296
  # end
2297
+ # stream.on_internal_server_exception_event do |event|
2298
+ # event # => Aws::BedrockRuntime::Types::internalServerException
2299
+ # end
2300
+ # stream.on_model_stream_error_exception_event do |event|
2301
+ # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
2302
+ # end
2303
+ # stream.on_validation_exception_event do |event|
2304
+ # event # => Aws::BedrockRuntime::Types::validationException
2305
+ # end
2306
+ # stream.on_throttling_exception_event do |event|
2307
+ # event # => Aws::BedrockRuntime::Types::throttlingException
2308
+ # end
2309
+ # stream.on_model_timeout_exception_event do |event|
2310
+ # event # => Aws::BedrockRuntime::Types::modelTimeoutException
2311
+ # end
2312
+ # stream.on_service_unavailable_exception_event do |event|
2313
+ # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
2314
+ # end
2315
+ # end
2316
+ #
2317
+ # client.invoke_model_with_response_stream(
2318
+ # # params inputs
2319
+ # event_stream_handler: handler
2320
+ # )
2321
+ #
2322
+ # # Usage pattern c): Hybrid pattern of a) and b)
2323
+ # handler = Aws::BedrockRuntime::EventStreams::ResponseStream.new
2324
+ # handler.on_chunk_event do |event|
2325
+ # event # => Aws::BedrockRuntime::Types::chunk
2326
+ # end
2327
+ # handler.on_internal_server_exception_event do |event|
2328
+ # event # => Aws::BedrockRuntime::Types::internalServerException
2329
+ # end
2330
+ # handler.on_model_stream_error_exception_event do |event|
2331
+ # event # => Aws::BedrockRuntime::Types::modelStreamErrorException
2332
+ # end
2333
+ # handler.on_validation_exception_event do |event|
2334
+ # event # => Aws::BedrockRuntime::Types::validationException
2335
+ # end
2336
+ # handler.on_throttling_exception_event do |event|
2337
+ # event # => Aws::BedrockRuntime::Types::throttlingException
2338
+ # end
2339
+ # handler.on_model_timeout_exception_event do |event|
2340
+ # event # => Aws::BedrockRuntime::Types::modelTimeoutException
2341
+ # end
2342
+ # handler.on_service_unavailable_exception_event do |event|
2343
+ # event # => Aws::BedrockRuntime::Types::serviceUnavailableException
2344
+ # end
2345
+ #
2346
+ # client.invoke_model_with_response_stream(
2347
+ # # params input
2348
+ # event_stream_handler: handler
2349
+ # ) do |stream|
2350
+ # stream.on_error_event do |event|
2351
+ # # catch unmodeled error event in the stream
2352
+ # raise event
2353
+ # # => Aws::Errors::EventError
2354
+ # # event.event_type => :error
2355
+ # # event.error_code => String
2356
+ # # event.error_message => String
2357
+ # end
2358
+ # end
2307
2359
  #
2308
- # You can also iterate through events after the response complete.
2309
- #
2310
- # Events are available at resp.body # => Enumerator
2311
- # For parameter input example, please refer to following request syntax
2360
+ # # You can also iterate through events after the response complete.
2361
+ # # Events are available at
2362
+ # resp.body # => Enumerator
2363
+ # # For parameter input example, please refer to following request syntax.
2312
2364
  #
2313
2365
  # @example Request syntax with placeholder values
2314
2366
  #
@@ -2325,31 +2377,31 @@ module Aws::BedrockRuntime
2325
2377
  #
2326
2378
  # @example Response structure
2327
2379
  #
2328
- # All events are available at resp.body:
2380
+ # # All events are available at resp.body:
2329
2381
  # resp.body #=> Enumerator
2330
2382
  # resp.body.event_types #=> [:chunk, :internal_server_exception, :model_stream_error_exception, :validation_exception, :throttling_exception, :model_timeout_exception, :service_unavailable_exception]
2331
2383
  #
2332
- # For :chunk event available at #on_chunk_event callback and response eventstream enumerator:
2384
+ # # For :chunk event available at #on_chunk_event callback and response eventstream enumerator:
2333
2385
  # event.bytes #=> String
2334
2386
  #
2335
- # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
2387
+ # # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
2336
2388
  # event.message #=> String
2337
2389
  #
2338
- # For :model_stream_error_exception event available at #on_model_stream_error_exception_event callback and response eventstream enumerator:
2390
+ # # For :model_stream_error_exception event available at #on_model_stream_error_exception_event callback and response eventstream enumerator:
2339
2391
  # event.message #=> String
2340
2392
  # event.original_status_code #=> Integer
2341
2393
  # event.original_message #=> String
2342
2394
  #
2343
- # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
2395
+ # # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
2344
2396
  # event.message #=> String
2345
2397
  #
2346
- # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
2398
+ # # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
2347
2399
  # event.message #=> String
2348
2400
  #
2349
- # For :model_timeout_exception event available at #on_model_timeout_exception_event callback and response eventstream enumerator:
2401
+ # # For :model_timeout_exception event available at #on_model_timeout_exception_event callback and response eventstream enumerator:
2350
2402
  # event.message #=> String
2351
2403
  #
2352
- # For :service_unavailable_exception event available at #on_service_unavailable_exception_event callback and response eventstream enumerator:
2404
+ # # For :service_unavailable_exception event available at #on_service_unavailable_exception_event callback and response eventstream enumerator:
2353
2405
  # event.message #=> String
2354
2406
  #
2355
2407
  # resp.content_type #=> String
@@ -2548,7 +2600,7 @@ module Aws::BedrockRuntime
2548
2600
  tracer: tracer
2549
2601
  )
2550
2602
  context[:gem_name] = 'aws-sdk-bedrockruntime'
2551
- context[:gem_version] = '1.44.0'
2603
+ context[:gem_version] = '1.46.0'
2552
2604
  Seahorse::Client::Request.new(handlers, context)
2553
2605
  end
2554
2606