aws-sdk-bedrockagentruntime 1.50.0 → 1.51.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.
@@ -1072,203 +1072,209 @@ module Aws::BedrockAgentRuntime
1072
1072
  #
1073
1073
  # @example EventStream Operation Example
1074
1074
  #
1075
- # You can process the event once it arrives immediately, or wait until the
1076
- # full response is complete and iterate through the eventstream enumerator.
1077
- #
1078
- # To interact with event immediately, you need to register #invoke_agent
1079
- # with callbacks. Callbacks can be registered for specific events or for all
1080
- # events, including error events.
1081
- #
1082
- # Callbacks can be passed into the `:event_stream_handler` option or within a
1083
- # block statement attached to the #invoke_agent call directly. Hybrid
1084
- # pattern of both is also supported.
1085
- #
1086
- # `:event_stream_handler` option takes in either a Proc object or
1087
- # Aws::BedrockAgentRuntime::EventStreams::ResponseStream object.
1088
- #
1089
- # Usage pattern a): Callbacks with a block attached to #invoke_agent
1090
- # Example for registering callbacks for all event types and an error event
1091
- #
1092
- # client.invoke_agent( # params input# ) do |stream|
1093
- # stream.on_error_event do |event|
1094
- # # catch unmodeled error event in the stream
1095
- # raise event
1096
- # # => Aws::Errors::EventError
1097
- # # event.event_type => :error
1098
- # # event.error_code => String
1099
- # # event.error_message => String
1100
- # end
1101
- #
1102
- # stream.on_event do |event|
1103
- # # process all events arrive
1104
- # puts event.event_type
1105
- # ...
1106
- # end
1107
- #
1075
+ # # You can process the event once it arrives immediately, or wait until the
1076
+ # # full response is complete and iterate through the eventstream enumerator.
1077
+ #
1078
+ # # To interact with event immediately, you need to register invoke_agent
1079
+ # # with callbacks. Callbacks can be registered for specific events or for all
1080
+ # # events, including error events.
1081
+ #
1082
+ # # Callbacks can be passed into the `:event_stream_handler` option or within a
1083
+ # # block statement attached to the #invoke_agent call directly. Hybrid
1084
+ # # pattern of both is also supported.
1085
+ #
1086
+ # # `:event_stream_handler` option takes in either a Proc object or
1087
+ # # Aws::BedrockAgentRuntime::EventStreams::ResponseStream object.
1088
+ #
1089
+ # # Usage pattern a): Callbacks with a block attached to #invoke_agent
1090
+ # # Example for registering callbacks for all event types and an error event
1091
+ # client.invoke_agent(
1092
+ # # params input
1093
+ # ) do |stream|
1094
+ # stream.on_error_event do |event|
1095
+ # # catch unmodeled error event in the stream
1096
+ # raise event
1097
+ # # => Aws::Errors::EventError
1098
+ # # event.event_type => :error
1099
+ # # event.error_code => String
1100
+ # # event.error_message => String
1108
1101
  # end
1109
1102
  #
1110
- # Usage pattern b): Pass in `:event_stream_handler` for #invoke_agent
1111
- #
1112
- # 1) Create a Aws::BedrockAgentRuntime::EventStreams::ResponseStream object
1113
- # Example for registering callbacks with specific events
1114
- #
1115
- # handler = Aws::BedrockAgentRuntime::EventStreams::ResponseStream.new
1116
- # handler.on_access_denied_exception_event do |event|
1117
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
1118
- # end
1119
- # handler.on_bad_gateway_exception_event do |event|
1120
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
1121
- # end
1122
- # handler.on_chunk_event do |event|
1123
- # event # => Aws::BedrockAgentRuntime::Types::chunk
1124
- # end
1125
- # handler.on_conflict_exception_event do |event|
1126
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
1127
- # end
1128
- # handler.on_dependency_failed_exception_event do |event|
1129
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
1130
- # end
1131
- # handler.on_files_event do |event|
1132
- # event # => Aws::BedrockAgentRuntime::Types::files
1133
- # end
1134
- # handler.on_internal_server_exception_event do |event|
1135
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
1136
- # end
1137
- # handler.on_model_not_ready_exception_event do |event|
1138
- # event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
1139
- # end
1140
- # handler.on_resource_not_found_exception_event do |event|
1141
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
1142
- # end
1143
- # handler.on_return_control_event do |event|
1144
- # event # => Aws::BedrockAgentRuntime::Types::returnControl
1145
- # end
1146
- # handler.on_service_quota_exceeded_exception_event do |event|
1147
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
1148
- # end
1149
- # handler.on_throttling_exception_event do |event|
1150
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
1151
- # end
1152
- # handler.on_trace_event do |event|
1153
- # event # => Aws::BedrockAgentRuntime::Types::trace
1154
- # end
1155
- # handler.on_validation_exception_event do |event|
1156
- # event # => Aws::BedrockAgentRuntime::Types::validationException
1157
- # end
1158
- #
1159
- # client.invoke_agent( # params input #, event_stream_handler: handler)
1160
- #
1161
- # 2) Use a Ruby Proc object
1162
- # Example for registering callbacks with specific events
1163
- #
1164
- # handler = Proc.new do |stream|
1165
- # stream.on_access_denied_exception_event do |event|
1166
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
1167
- # end
1168
- # stream.on_bad_gateway_exception_event do |event|
1169
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
1170
- # end
1171
- # stream.on_chunk_event do |event|
1172
- # event # => Aws::BedrockAgentRuntime::Types::chunk
1173
- # end
1174
- # stream.on_conflict_exception_event do |event|
1175
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
1176
- # end
1177
- # stream.on_dependency_failed_exception_event do |event|
1178
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
1179
- # end
1180
- # stream.on_files_event do |event|
1181
- # event # => Aws::BedrockAgentRuntime::Types::files
1182
- # end
1183
- # stream.on_internal_server_exception_event do |event|
1184
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
1185
- # end
1186
- # stream.on_model_not_ready_exception_event do |event|
1187
- # event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
1188
- # end
1189
- # stream.on_resource_not_found_exception_event do |event|
1190
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
1191
- # end
1192
- # stream.on_return_control_event do |event|
1193
- # event # => Aws::BedrockAgentRuntime::Types::returnControl
1194
- # end
1195
- # stream.on_service_quota_exceeded_exception_event do |event|
1196
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
1197
- # end
1198
- # stream.on_throttling_exception_event do |event|
1199
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
1200
- # end
1201
- # stream.on_trace_event do |event|
1202
- # event # => Aws::BedrockAgentRuntime::Types::trace
1203
- # end
1204
- # stream.on_validation_exception_event do |event|
1205
- # event # => Aws::BedrockAgentRuntime::Types::validationException
1206
- # end
1103
+ # stream.on_event do |event|
1104
+ # # process all events arrive
1105
+ # puts event.event_type
1106
+ # # ...
1207
1107
  # end
1208
- #
1209
- # client.invoke_agent( # params input #, event_stream_handler: handler)
1210
- #
1211
- # Usage pattern c): Hybrid pattern of a) and b)
1212
- #
1213
- # handler = Aws::BedrockAgentRuntime::EventStreams::ResponseStream.new
1214
- # handler.on_access_denied_exception_event do |event|
1215
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
1216
- # end
1217
- # handler.on_bad_gateway_exception_event do |event|
1218
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
1219
- # end
1220
- # handler.on_chunk_event do |event|
1221
- # event # => Aws::BedrockAgentRuntime::Types::chunk
1222
- # end
1223
- # handler.on_conflict_exception_event do |event|
1224
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
1225
- # end
1226
- # handler.on_dependency_failed_exception_event do |event|
1227
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
1228
- # end
1229
- # handler.on_files_event do |event|
1230
- # event # => Aws::BedrockAgentRuntime::Types::files
1231
- # end
1232
- # handler.on_internal_server_exception_event do |event|
1233
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
1234
- # end
1235
- # handler.on_model_not_ready_exception_event do |event|
1236
- # event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
1237
- # end
1238
- # handler.on_resource_not_found_exception_event do |event|
1239
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
1240
- # end
1241
- # handler.on_return_control_event do |event|
1242
- # event # => Aws::BedrockAgentRuntime::Types::returnControl
1243
- # end
1244
- # handler.on_service_quota_exceeded_exception_event do |event|
1245
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
1246
- # end
1247
- # handler.on_throttling_exception_event do |event|
1248
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
1249
- # end
1250
- # handler.on_trace_event do |event|
1251
- # event # => Aws::BedrockAgentRuntime::Types::trace
1252
- # end
1253
- # handler.on_validation_exception_event do |event|
1254
- # event # => Aws::BedrockAgentRuntime::Types::validationException
1255
- # end
1256
- #
1257
- # client.invoke_agent( # params input #, event_stream_handler: handler) do |stream|
1258
- # stream.on_error_event do |event|
1259
- # # catch unmodeled error event in the stream
1260
- # raise event
1261
- # # => Aws::Errors::EventError
1262
- # # event.event_type => :error
1263
- # # event.error_code => String
1264
- # # event.error_message => String
1265
- # end
1108
+ # end
1109
+ #
1110
+ # # Usage pattern b): Pass in `:event_stream_handler` for #invoke_agent
1111
+ # # 1) Create a Aws::BedrockAgentRuntime::EventStreams::ResponseStream object
1112
+ # # Example for registering callbacks with specific events
1113
+ #
1114
+ # handler = Aws::BedrockAgentRuntime::EventStreams::ResponseStream.new
1115
+ # handler.on_access_denied_exception_event do |event|
1116
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
1117
+ # end
1118
+ # handler.on_bad_gateway_exception_event do |event|
1119
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
1120
+ # end
1121
+ # handler.on_chunk_event do |event|
1122
+ # event # => Aws::BedrockAgentRuntime::Types::chunk
1123
+ # end
1124
+ # handler.on_conflict_exception_event do |event|
1125
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
1126
+ # end
1127
+ # handler.on_dependency_failed_exception_event do |event|
1128
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
1129
+ # end
1130
+ # handler.on_files_event do |event|
1131
+ # event # => Aws::BedrockAgentRuntime::Types::files
1132
+ # end
1133
+ # handler.on_internal_server_exception_event do |event|
1134
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
1135
+ # end
1136
+ # handler.on_model_not_ready_exception_event do |event|
1137
+ # event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
1138
+ # end
1139
+ # handler.on_resource_not_found_exception_event do |event|
1140
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
1141
+ # end
1142
+ # handler.on_return_control_event do |event|
1143
+ # event # => Aws::BedrockAgentRuntime::Types::returnControl
1144
+ # end
1145
+ # handler.on_service_quota_exceeded_exception_event do |event|
1146
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
1147
+ # end
1148
+ # handler.on_throttling_exception_event do |event|
1149
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
1150
+ # end
1151
+ # handler.on_trace_event do |event|
1152
+ # event # => Aws::BedrockAgentRuntime::Types::trace
1153
+ # end
1154
+ # handler.on_validation_exception_event do |event|
1155
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
1156
+ # end
1157
+ #
1158
+ # client.invoke_agent(
1159
+ # # params inputs
1160
+ # event_stream_handler: handler
1161
+ # )
1162
+ #
1163
+ # # 2) Use a Ruby Proc object
1164
+ # # Example for registering callbacks with specific events
1165
+ # handler = Proc.new do |stream|
1166
+ # stream.on_access_denied_exception_event do |event|
1167
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
1266
1168
  # end
1169
+ # stream.on_bad_gateway_exception_event do |event|
1170
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
1171
+ # end
1172
+ # stream.on_chunk_event do |event|
1173
+ # event # => Aws::BedrockAgentRuntime::Types::chunk
1174
+ # end
1175
+ # stream.on_conflict_exception_event do |event|
1176
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
1177
+ # end
1178
+ # stream.on_dependency_failed_exception_event do |event|
1179
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
1180
+ # end
1181
+ # stream.on_files_event do |event|
1182
+ # event # => Aws::BedrockAgentRuntime::Types::files
1183
+ # end
1184
+ # stream.on_internal_server_exception_event do |event|
1185
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
1186
+ # end
1187
+ # stream.on_model_not_ready_exception_event do |event|
1188
+ # event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
1189
+ # end
1190
+ # stream.on_resource_not_found_exception_event do |event|
1191
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
1192
+ # end
1193
+ # stream.on_return_control_event do |event|
1194
+ # event # => Aws::BedrockAgentRuntime::Types::returnControl
1195
+ # end
1196
+ # stream.on_service_quota_exceeded_exception_event do |event|
1197
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
1198
+ # end
1199
+ # stream.on_throttling_exception_event do |event|
1200
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
1201
+ # end
1202
+ # stream.on_trace_event do |event|
1203
+ # event # => Aws::BedrockAgentRuntime::Types::trace
1204
+ # end
1205
+ # stream.on_validation_exception_event do |event|
1206
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
1207
+ # end
1208
+ # end
1209
+ #
1210
+ # client.invoke_agent(
1211
+ # # params inputs
1212
+ # event_stream_handler: handler
1213
+ # )
1214
+ #
1215
+ # # Usage pattern c): Hybrid pattern of a) and b)
1216
+ # handler = Aws::BedrockAgentRuntime::EventStreams::ResponseStream.new
1217
+ # handler.on_access_denied_exception_event do |event|
1218
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
1219
+ # end
1220
+ # handler.on_bad_gateway_exception_event do |event|
1221
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
1222
+ # end
1223
+ # handler.on_chunk_event do |event|
1224
+ # event # => Aws::BedrockAgentRuntime::Types::chunk
1225
+ # end
1226
+ # handler.on_conflict_exception_event do |event|
1227
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
1228
+ # end
1229
+ # handler.on_dependency_failed_exception_event do |event|
1230
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
1231
+ # end
1232
+ # handler.on_files_event do |event|
1233
+ # event # => Aws::BedrockAgentRuntime::Types::files
1234
+ # end
1235
+ # handler.on_internal_server_exception_event do |event|
1236
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
1237
+ # end
1238
+ # handler.on_model_not_ready_exception_event do |event|
1239
+ # event # => Aws::BedrockAgentRuntime::Types::modelNotReadyException
1240
+ # end
1241
+ # handler.on_resource_not_found_exception_event do |event|
1242
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
1243
+ # end
1244
+ # handler.on_return_control_event do |event|
1245
+ # event # => Aws::BedrockAgentRuntime::Types::returnControl
1246
+ # end
1247
+ # handler.on_service_quota_exceeded_exception_event do |event|
1248
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
1249
+ # end
1250
+ # handler.on_throttling_exception_event do |event|
1251
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
1252
+ # end
1253
+ # handler.on_trace_event do |event|
1254
+ # event # => Aws::BedrockAgentRuntime::Types::trace
1255
+ # end
1256
+ # handler.on_validation_exception_event do |event|
1257
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
1258
+ # end
1259
+ #
1260
+ # client.invoke_agent(
1261
+ # # params input
1262
+ # event_stream_handler: handler
1263
+ # ) do |stream|
1264
+ # stream.on_error_event do |event|
1265
+ # # catch unmodeled error event in the stream
1266
+ # raise event
1267
+ # # => Aws::Errors::EventError
1268
+ # # event.event_type => :error
1269
+ # # event.error_code => String
1270
+ # # event.error_message => String
1271
+ # end
1272
+ # end
1267
1273
  #
1268
- # You can also iterate through events after the response complete.
1269
- #
1270
- # Events are available at resp.completion # => Enumerator
1271
- # For parameter input example, please refer to following request syntax
1274
+ # # You can also iterate through events after the response complete.
1275
+ # # Events are available at
1276
+ # resp.completion # => Enumerator
1277
+ # # For parameter input example, please refer to following request syntax.
1272
1278
  #
1273
1279
  # @example Request syntax with placeholder values
1274
1280
  #
@@ -1493,18 +1499,18 @@ module Aws::BedrockAgentRuntime
1493
1499
  #
1494
1500
  # @example Response structure
1495
1501
  #
1496
- # All events are available at resp.completion:
1502
+ # # All events are available at resp.completion:
1497
1503
  # resp.completion #=> Enumerator
1498
1504
  # resp.completion.event_types #=> [:access_denied_exception, :bad_gateway_exception, :chunk, :conflict_exception, :dependency_failed_exception, :files, :internal_server_exception, :model_not_ready_exception, :resource_not_found_exception, :return_control, :service_quota_exceeded_exception, :throttling_exception, :trace, :validation_exception]
1499
1505
  #
1500
- # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
1506
+ # # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
1501
1507
  # event.message #=> String
1502
1508
  #
1503
- # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
1509
+ # # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
1504
1510
  # event.message #=> String
1505
1511
  # event.resource_name #=> String
1506
1512
  #
1507
- # For :chunk event available at #on_chunk_event callback and response eventstream enumerator:
1513
+ # # For :chunk event available at #on_chunk_event callback and response eventstream enumerator:
1508
1514
  # event.attribution.citations #=> Array
1509
1515
  # event.attribution.citations[0].generated_response_part.text_response_part.span.end #=> Integer
1510
1516
  # event.attribution.citations[0].generated_response_part.text_response_part.span.start #=> Integer
@@ -1529,30 +1535,30 @@ module Aws::BedrockAgentRuntime
1529
1535
  # event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
1530
1536
  # event.bytes #=> String
1531
1537
  #
1532
- # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
1538
+ # # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
1533
1539
  # event.message #=> String
1534
1540
  #
1535
- # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
1541
+ # # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
1536
1542
  # event.message #=> String
1537
1543
  # event.resource_name #=> String
1538
1544
  #
1539
- # For :files event available at #on_files_event callback and response eventstream enumerator:
1545
+ # # For :files event available at #on_files_event callback and response eventstream enumerator:
1540
1546
  # event.files #=> Array
1541
1547
  # event.files[0].bytes #=> String
1542
1548
  # event.files[0].name #=> String
1543
1549
  # event.files[0].type #=> String
1544
1550
  #
1545
- # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
1551
+ # # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
1546
1552
  # event.message #=> String
1547
1553
  # event.reason #=> String
1548
1554
  #
1549
- # For :model_not_ready_exception event available at #on_model_not_ready_exception_event callback and response eventstream enumerator:
1555
+ # # For :model_not_ready_exception event available at #on_model_not_ready_exception_event callback and response eventstream enumerator:
1550
1556
  # event.message #=> String
1551
1557
  #
1552
- # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
1558
+ # # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
1553
1559
  # event.message #=> String
1554
1560
  #
1555
- # For :return_control event available at #on_return_control_event callback and response eventstream enumerator:
1561
+ # # For :return_control event available at #on_return_control_event callback and response eventstream enumerator:
1556
1562
  # event.invocation_id #=> String
1557
1563
  # event.invocation_inputs #=> Array
1558
1564
  # event.invocation_inputs[0].api_invocation_input.action_group #=> String
@@ -1580,13 +1586,13 @@ module Aws::BedrockAgentRuntime
1580
1586
  # event.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
1581
1587
  # event.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
1582
1588
  #
1583
- # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
1589
+ # # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
1584
1590
  # event.message #=> String
1585
1591
  #
1586
- # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
1592
+ # # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
1587
1593
  # event.message #=> String
1588
1594
  #
1589
- # For :trace event available at #on_trace_event callback and response eventstream enumerator:
1595
+ # # For :trace event available at #on_trace_event callback and response eventstream enumerator:
1590
1596
  # event.agent_alias_id #=> String
1591
1597
  # event.agent_id #=> String
1592
1598
  # event.agent_version #=> String
@@ -1952,7 +1958,7 @@ module Aws::BedrockAgentRuntime
1952
1958
  # event.trace.routing_classifier_trace.observation.trace_id #=> String
1953
1959
  # event.trace.routing_classifier_trace.observation.type #=> String, one of "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
1954
1960
  #
1955
- # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
1961
+ # # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
1956
1962
  # event.message #=> String
1957
1963
  #
1958
1964
  # resp.content_type #=> String
@@ -2035,194 +2041,200 @@ module Aws::BedrockAgentRuntime
2035
2041
  #
2036
2042
  # @example EventStream Operation Example
2037
2043
  #
2038
- # You can process the event once it arrives immediately, or wait until the
2039
- # full response is complete and iterate through the eventstream enumerator.
2040
- #
2041
- # To interact with event immediately, you need to register #invoke_flow
2042
- # with callbacks. Callbacks can be registered for specific events or for all
2043
- # events, including error events.
2044
- #
2045
- # Callbacks can be passed into the `:event_stream_handler` option or within a
2046
- # block statement attached to the #invoke_flow call directly. Hybrid
2047
- # pattern of both is also supported.
2048
- #
2049
- # `:event_stream_handler` option takes in either a Proc object or
2050
- # Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream object.
2051
- #
2052
- # Usage pattern a): Callbacks with a block attached to #invoke_flow
2053
- # Example for registering callbacks for all event types and an error event
2054
- #
2055
- # client.invoke_flow( # params input# ) do |stream|
2056
- # stream.on_error_event do |event|
2057
- # # catch unmodeled error event in the stream
2058
- # raise event
2059
- # # => Aws::Errors::EventError
2060
- # # event.event_type => :error
2061
- # # event.error_code => String
2062
- # # event.error_message => String
2063
- # end
2064
- #
2065
- # stream.on_event do |event|
2066
- # # process all events arrive
2067
- # puts event.event_type
2068
- # ...
2069
- # end
2070
- #
2044
+ # # You can process the event once it arrives immediately, or wait until the
2045
+ # # full response is complete and iterate through the eventstream enumerator.
2046
+ #
2047
+ # # To interact with event immediately, you need to register invoke_flow
2048
+ # # with callbacks. Callbacks can be registered for specific events or for all
2049
+ # # events, including error events.
2050
+ #
2051
+ # # Callbacks can be passed into the `:event_stream_handler` option or within a
2052
+ # # block statement attached to the #invoke_flow call directly. Hybrid
2053
+ # # pattern of both is also supported.
2054
+ #
2055
+ # # `:event_stream_handler` option takes in either a Proc object or
2056
+ # # Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream object.
2057
+ #
2058
+ # # Usage pattern a): Callbacks with a block attached to #invoke_flow
2059
+ # # Example for registering callbacks for all event types and an error event
2060
+ # client.invoke_flow(
2061
+ # # params input
2062
+ # ) do |stream|
2063
+ # stream.on_error_event do |event|
2064
+ # # catch unmodeled error event in the stream
2065
+ # raise event
2066
+ # # => Aws::Errors::EventError
2067
+ # # event.event_type => :error
2068
+ # # event.error_code => String
2069
+ # # event.error_message => String
2071
2070
  # end
2072
2071
  #
2073
- # Usage pattern b): Pass in `:event_stream_handler` for #invoke_flow
2074
- #
2075
- # 1) Create a Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream object
2076
- # Example for registering callbacks with specific events
2077
- #
2078
- # handler = Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream.new
2079
- # handler.on_access_denied_exception_event do |event|
2080
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2081
- # end
2082
- # handler.on_bad_gateway_exception_event do |event|
2083
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2084
- # end
2085
- # handler.on_conflict_exception_event do |event|
2086
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
2087
- # end
2088
- # handler.on_dependency_failed_exception_event do |event|
2089
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2090
- # end
2091
- # handler.on_flow_completion_event_event do |event|
2092
- # event # => Aws::BedrockAgentRuntime::Types::flowCompletionEvent
2093
- # end
2094
- # handler.on_flow_multi_turn_input_request_event_event do |event|
2095
- # event # => Aws::BedrockAgentRuntime::Types::flowMultiTurnInputRequestEvent
2096
- # end
2097
- # handler.on_flow_output_event_event do |event|
2098
- # event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
2099
- # end
2100
- # handler.on_flow_trace_event_event do |event|
2101
- # event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
2102
- # end
2103
- # handler.on_internal_server_exception_event do |event|
2104
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2105
- # end
2106
- # handler.on_resource_not_found_exception_event do |event|
2107
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2108
- # end
2109
- # handler.on_service_quota_exceeded_exception_event do |event|
2110
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2111
- # end
2112
- # handler.on_throttling_exception_event do |event|
2113
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2114
- # end
2115
- # handler.on_validation_exception_event do |event|
2116
- # event # => Aws::BedrockAgentRuntime::Types::validationException
2117
- # end
2118
- #
2119
- # client.invoke_flow( # params input #, event_stream_handler: handler)
2120
- #
2121
- # 2) Use a Ruby Proc object
2122
- # Example for registering callbacks with specific events
2123
- #
2124
- # handler = Proc.new do |stream|
2125
- # stream.on_access_denied_exception_event do |event|
2126
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2127
- # end
2128
- # stream.on_bad_gateway_exception_event do |event|
2129
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2130
- # end
2131
- # stream.on_conflict_exception_event do |event|
2132
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
2133
- # end
2134
- # stream.on_dependency_failed_exception_event do |event|
2135
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2136
- # end
2137
- # stream.on_flow_completion_event_event do |event|
2138
- # event # => Aws::BedrockAgentRuntime::Types::flowCompletionEvent
2139
- # end
2140
- # stream.on_flow_multi_turn_input_request_event_event do |event|
2141
- # event # => Aws::BedrockAgentRuntime::Types::flowMultiTurnInputRequestEvent
2142
- # end
2143
- # stream.on_flow_output_event_event do |event|
2144
- # event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
2145
- # end
2146
- # stream.on_flow_trace_event_event do |event|
2147
- # event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
2148
- # end
2149
- # stream.on_internal_server_exception_event do |event|
2150
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2151
- # end
2152
- # stream.on_resource_not_found_exception_event do |event|
2153
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2154
- # end
2155
- # stream.on_service_quota_exceeded_exception_event do |event|
2156
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2157
- # end
2158
- # stream.on_throttling_exception_event do |event|
2159
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2160
- # end
2161
- # stream.on_validation_exception_event do |event|
2162
- # event # => Aws::BedrockAgentRuntime::Types::validationException
2163
- # end
2072
+ # stream.on_event do |event|
2073
+ # # process all events arrive
2074
+ # puts event.event_type
2075
+ # # ...
2164
2076
  # end
2165
- #
2166
- # client.invoke_flow( # params input #, event_stream_handler: handler)
2167
- #
2168
- # Usage pattern c): Hybrid pattern of a) and b)
2169
- #
2170
- # handler = Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream.new
2171
- # handler.on_access_denied_exception_event do |event|
2172
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2173
- # end
2174
- # handler.on_bad_gateway_exception_event do |event|
2175
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2176
- # end
2177
- # handler.on_conflict_exception_event do |event|
2178
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
2179
- # end
2180
- # handler.on_dependency_failed_exception_event do |event|
2181
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2182
- # end
2183
- # handler.on_flow_completion_event_event do |event|
2184
- # event # => Aws::BedrockAgentRuntime::Types::flowCompletionEvent
2185
- # end
2186
- # handler.on_flow_multi_turn_input_request_event_event do |event|
2187
- # event # => Aws::BedrockAgentRuntime::Types::flowMultiTurnInputRequestEvent
2188
- # end
2189
- # handler.on_flow_output_event_event do |event|
2190
- # event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
2191
- # end
2192
- # handler.on_flow_trace_event_event do |event|
2193
- # event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
2194
- # end
2195
- # handler.on_internal_server_exception_event do |event|
2196
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2197
- # end
2198
- # handler.on_resource_not_found_exception_event do |event|
2199
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2200
- # end
2201
- # handler.on_service_quota_exceeded_exception_event do |event|
2202
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2203
- # end
2204
- # handler.on_throttling_exception_event do |event|
2205
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2206
- # end
2207
- # handler.on_validation_exception_event do |event|
2208
- # event # => Aws::BedrockAgentRuntime::Types::validationException
2209
- # end
2210
- #
2211
- # client.invoke_flow( # params input #, event_stream_handler: handler) do |stream|
2212
- # stream.on_error_event do |event|
2213
- # # catch unmodeled error event in the stream
2214
- # raise event
2215
- # # => Aws::Errors::EventError
2216
- # # event.event_type => :error
2217
- # # event.error_code => String
2218
- # # event.error_message => String
2219
- # end
2077
+ # end
2078
+ #
2079
+ # # Usage pattern b): Pass in `:event_stream_handler` for #invoke_flow
2080
+ # # 1) Create a Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream object
2081
+ # # Example for registering callbacks with specific events
2082
+ #
2083
+ # handler = Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream.new
2084
+ # handler.on_access_denied_exception_event do |event|
2085
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2086
+ # end
2087
+ # handler.on_bad_gateway_exception_event do |event|
2088
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2089
+ # end
2090
+ # handler.on_conflict_exception_event do |event|
2091
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
2092
+ # end
2093
+ # handler.on_dependency_failed_exception_event do |event|
2094
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2095
+ # end
2096
+ # handler.on_flow_completion_event_event do |event|
2097
+ # event # => Aws::BedrockAgentRuntime::Types::flowCompletionEvent
2098
+ # end
2099
+ # handler.on_flow_multi_turn_input_request_event_event do |event|
2100
+ # event # => Aws::BedrockAgentRuntime::Types::flowMultiTurnInputRequestEvent
2101
+ # end
2102
+ # handler.on_flow_output_event_event do |event|
2103
+ # event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
2104
+ # end
2105
+ # handler.on_flow_trace_event_event do |event|
2106
+ # event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
2107
+ # end
2108
+ # handler.on_internal_server_exception_event do |event|
2109
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2110
+ # end
2111
+ # handler.on_resource_not_found_exception_event do |event|
2112
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2113
+ # end
2114
+ # handler.on_service_quota_exceeded_exception_event do |event|
2115
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2116
+ # end
2117
+ # handler.on_throttling_exception_event do |event|
2118
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2119
+ # end
2120
+ # handler.on_validation_exception_event do |event|
2121
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
2122
+ # end
2123
+ #
2124
+ # client.invoke_flow(
2125
+ # # params inputs
2126
+ # event_stream_handler: handler
2127
+ # )
2128
+ #
2129
+ # # 2) Use a Ruby Proc object
2130
+ # # Example for registering callbacks with specific events
2131
+ # handler = Proc.new do |stream|
2132
+ # stream.on_access_denied_exception_event do |event|
2133
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2220
2134
  # end
2135
+ # stream.on_bad_gateway_exception_event do |event|
2136
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2137
+ # end
2138
+ # stream.on_conflict_exception_event do |event|
2139
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
2140
+ # end
2141
+ # stream.on_dependency_failed_exception_event do |event|
2142
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2143
+ # end
2144
+ # stream.on_flow_completion_event_event do |event|
2145
+ # event # => Aws::BedrockAgentRuntime::Types::flowCompletionEvent
2146
+ # end
2147
+ # stream.on_flow_multi_turn_input_request_event_event do |event|
2148
+ # event # => Aws::BedrockAgentRuntime::Types::flowMultiTurnInputRequestEvent
2149
+ # end
2150
+ # stream.on_flow_output_event_event do |event|
2151
+ # event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
2152
+ # end
2153
+ # stream.on_flow_trace_event_event do |event|
2154
+ # event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
2155
+ # end
2156
+ # stream.on_internal_server_exception_event do |event|
2157
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2158
+ # end
2159
+ # stream.on_resource_not_found_exception_event do |event|
2160
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2161
+ # end
2162
+ # stream.on_service_quota_exceeded_exception_event do |event|
2163
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2164
+ # end
2165
+ # stream.on_throttling_exception_event do |event|
2166
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2167
+ # end
2168
+ # stream.on_validation_exception_event do |event|
2169
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
2170
+ # end
2171
+ # end
2172
+ #
2173
+ # client.invoke_flow(
2174
+ # # params inputs
2175
+ # event_stream_handler: handler
2176
+ # )
2177
+ #
2178
+ # # Usage pattern c): Hybrid pattern of a) and b)
2179
+ # handler = Aws::BedrockAgentRuntime::EventStreams::FlowResponseStream.new
2180
+ # handler.on_access_denied_exception_event do |event|
2181
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2182
+ # end
2183
+ # handler.on_bad_gateway_exception_event do |event|
2184
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2185
+ # end
2186
+ # handler.on_conflict_exception_event do |event|
2187
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
2188
+ # end
2189
+ # handler.on_dependency_failed_exception_event do |event|
2190
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2191
+ # end
2192
+ # handler.on_flow_completion_event_event do |event|
2193
+ # event # => Aws::BedrockAgentRuntime::Types::flowCompletionEvent
2194
+ # end
2195
+ # handler.on_flow_multi_turn_input_request_event_event do |event|
2196
+ # event # => Aws::BedrockAgentRuntime::Types::flowMultiTurnInputRequestEvent
2197
+ # end
2198
+ # handler.on_flow_output_event_event do |event|
2199
+ # event # => Aws::BedrockAgentRuntime::Types::flowOutputEvent
2200
+ # end
2201
+ # handler.on_flow_trace_event_event do |event|
2202
+ # event # => Aws::BedrockAgentRuntime::Types::flowTraceEvent
2203
+ # end
2204
+ # handler.on_internal_server_exception_event do |event|
2205
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2206
+ # end
2207
+ # handler.on_resource_not_found_exception_event do |event|
2208
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2209
+ # end
2210
+ # handler.on_service_quota_exceeded_exception_event do |event|
2211
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2212
+ # end
2213
+ # handler.on_throttling_exception_event do |event|
2214
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2215
+ # end
2216
+ # handler.on_validation_exception_event do |event|
2217
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
2218
+ # end
2219
+ #
2220
+ # client.invoke_flow(
2221
+ # # params input
2222
+ # event_stream_handler: handler
2223
+ # ) do |stream|
2224
+ # stream.on_error_event do |event|
2225
+ # # catch unmodeled error event in the stream
2226
+ # raise event
2227
+ # # => Aws::Errors::EventError
2228
+ # # event.event_type => :error
2229
+ # # event.error_code => String
2230
+ # # event.error_message => String
2231
+ # end
2232
+ # end
2221
2233
  #
2222
- # You can also iterate through events after the response complete.
2223
- #
2224
- # Events are available at resp.response_stream # => Enumerator
2225
- # For parameter input example, please refer to following request syntax
2234
+ # # You can also iterate through events after the response complete.
2235
+ # # Events are available at
2236
+ # resp.response_stream # => Enumerator
2237
+ # # For parameter input example, please refer to following request syntax.
2226
2238
  #
2227
2239
  # @example Request syntax with placeholder values
2228
2240
  #
@@ -2252,36 +2264,36 @@ module Aws::BedrockAgentRuntime
2252
2264
  # @example Response structure
2253
2265
  #
2254
2266
  # resp.execution_id #=> String
2255
- # All events are available at resp.response_stream:
2267
+ # # All events are available at resp.response_stream:
2256
2268
  # resp.response_stream #=> Enumerator
2257
2269
  # resp.response_stream.event_types #=> [:access_denied_exception, :bad_gateway_exception, :conflict_exception, :dependency_failed_exception, :flow_completion_event, :flow_multi_turn_input_request_event, :flow_output_event, :flow_trace_event, :internal_server_exception, :resource_not_found_exception, :service_quota_exceeded_exception, :throttling_exception, :validation_exception]
2258
2270
  #
2259
- # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
2271
+ # # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
2260
2272
  # event.message #=> String
2261
2273
  #
2262
- # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
2274
+ # # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
2263
2275
  # event.message #=> String
2264
2276
  # event.resource_name #=> String
2265
2277
  #
2266
- # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
2278
+ # # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
2267
2279
  # event.message #=> String
2268
2280
  #
2269
- # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
2281
+ # # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
2270
2282
  # event.message #=> String
2271
2283
  # event.resource_name #=> String
2272
2284
  #
2273
- # For :flow_completion_event event available at #on_flow_completion_event_event callback and response eventstream enumerator:
2285
+ # # For :flow_completion_event event available at #on_flow_completion_event_event callback and response eventstream enumerator:
2274
2286
  # event.completion_reason #=> String, one of "SUCCESS", "INPUT_REQUIRED"
2275
2287
  #
2276
- # For :flow_multi_turn_input_request_event event available at #on_flow_multi_turn_input_request_event_event callback and response eventstream enumerator:
2288
+ # # For :flow_multi_turn_input_request_event event available at #on_flow_multi_turn_input_request_event_event callback and response eventstream enumerator:
2277
2289
  # event.node_name #=> String
2278
2290
  # event.node_type #=> String, one of "FlowInputNode", "FlowOutputNode", "LambdaFunctionNode", "KnowledgeBaseNode", "PromptNode", "ConditionNode", "LexNode"
2279
2291
  #
2280
- # For :flow_output_event event available at #on_flow_output_event_event callback and response eventstream enumerator:
2292
+ # # For :flow_output_event event available at #on_flow_output_event_event callback and response eventstream enumerator:
2281
2293
  # event.node_name #=> String
2282
2294
  # event.node_type #=> String, one of "FlowInputNode", "FlowOutputNode", "LambdaFunctionNode", "KnowledgeBaseNode", "PromptNode", "ConditionNode", "LexNode"
2283
2295
  #
2284
- # For :flow_trace_event event available at #on_flow_trace_event_event callback and response eventstream enumerator:
2296
+ # # For :flow_trace_event event available at #on_flow_trace_event_event callback and response eventstream enumerator:
2285
2297
  # event.trace.condition_node_result_trace.node_name #=> String
2286
2298
  # event.trace.condition_node_result_trace.satisfied_conditions #=> Array
2287
2299
  # event.trace.condition_node_result_trace.satisfied_conditions[0].condition_name #=> String
@@ -2300,20 +2312,20 @@ module Aws::BedrockAgentRuntime
2300
2312
  # event.trace.node_output_trace.node_name #=> String
2301
2313
  # event.trace.node_output_trace.timestamp #=> Time
2302
2314
  #
2303
- # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
2315
+ # # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
2304
2316
  # event.message #=> String
2305
2317
  # event.reason #=> String
2306
2318
  #
2307
- # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
2319
+ # # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
2308
2320
  # event.message #=> String
2309
2321
  #
2310
- # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
2322
+ # # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
2311
2323
  # event.message #=> String
2312
2324
  #
2313
- # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
2325
+ # # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
2314
2326
  # event.message #=> String
2315
2327
  #
2316
- # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
2328
+ # # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
2317
2329
  # event.message #=> String
2318
2330
  #
2319
2331
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/InvokeFlow AWS API Documentation
@@ -2486,194 +2498,200 @@ module Aws::BedrockAgentRuntime
2486
2498
  #
2487
2499
  # @example EventStream Operation Example
2488
2500
  #
2489
- # You can process the event once it arrives immediately, or wait until the
2490
- # full response is complete and iterate through the eventstream enumerator.
2491
- #
2492
- # To interact with event immediately, you need to register #invoke_inline_agent
2493
- # with callbacks. Callbacks can be registered for specific events or for all
2494
- # events, including error events.
2495
- #
2496
- # Callbacks can be passed into the `:event_stream_handler` option or within a
2497
- # block statement attached to the #invoke_inline_agent call directly. Hybrid
2498
- # pattern of both is also supported.
2499
- #
2500
- # `:event_stream_handler` option takes in either a Proc object or
2501
- # Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream object.
2502
- #
2503
- # Usage pattern a): Callbacks with a block attached to #invoke_inline_agent
2504
- # Example for registering callbacks for all event types and an error event
2505
- #
2506
- # client.invoke_inline_agent( # params input# ) do |stream|
2507
- # stream.on_error_event do |event|
2508
- # # catch unmodeled error event in the stream
2509
- # raise event
2510
- # # => Aws::Errors::EventError
2511
- # # event.event_type => :error
2512
- # # event.error_code => String
2513
- # # event.error_message => String
2514
- # end
2515
- #
2516
- # stream.on_event do |event|
2517
- # # process all events arrive
2518
- # puts event.event_type
2519
- # ...
2520
- # end
2521
- #
2501
+ # # You can process the event once it arrives immediately, or wait until the
2502
+ # # full response is complete and iterate through the eventstream enumerator.
2503
+ #
2504
+ # # To interact with event immediately, you need to register invoke_inline_agent
2505
+ # # with callbacks. Callbacks can be registered for specific events or for all
2506
+ # # events, including error events.
2507
+ #
2508
+ # # Callbacks can be passed into the `:event_stream_handler` option or within a
2509
+ # # block statement attached to the #invoke_inline_agent call directly. Hybrid
2510
+ # # pattern of both is also supported.
2511
+ #
2512
+ # # `:event_stream_handler` option takes in either a Proc object or
2513
+ # # Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream object.
2514
+ #
2515
+ # # Usage pattern a): Callbacks with a block attached to #invoke_inline_agent
2516
+ # # Example for registering callbacks for all event types and an error event
2517
+ # client.invoke_inline_agent(
2518
+ # # params input
2519
+ # ) do |stream|
2520
+ # stream.on_error_event do |event|
2521
+ # # catch unmodeled error event in the stream
2522
+ # raise event
2523
+ # # => Aws::Errors::EventError
2524
+ # # event.event_type => :error
2525
+ # # event.error_code => String
2526
+ # # event.error_message => String
2522
2527
  # end
2523
2528
  #
2524
- # Usage pattern b): Pass in `:event_stream_handler` for #invoke_inline_agent
2525
- #
2526
- # 1) Create a Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream object
2527
- # Example for registering callbacks with specific events
2528
- #
2529
- # handler = Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream.new
2530
- # handler.on_access_denied_exception_event do |event|
2531
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2532
- # end
2533
- # handler.on_bad_gateway_exception_event do |event|
2534
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2535
- # end
2536
- # handler.on_chunk_event do |event|
2537
- # event # => Aws::BedrockAgentRuntime::Types::chunk
2538
- # end
2539
- # handler.on_conflict_exception_event do |event|
2540
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
2541
- # end
2542
- # handler.on_dependency_failed_exception_event do |event|
2543
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2544
- # end
2545
- # handler.on_files_event do |event|
2546
- # event # => Aws::BedrockAgentRuntime::Types::files
2547
- # end
2548
- # handler.on_internal_server_exception_event do |event|
2549
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2550
- # end
2551
- # handler.on_resource_not_found_exception_event do |event|
2552
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2553
- # end
2554
- # handler.on_return_control_event do |event|
2555
- # event # => Aws::BedrockAgentRuntime::Types::returnControl
2556
- # end
2557
- # handler.on_service_quota_exceeded_exception_event do |event|
2558
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2559
- # end
2560
- # handler.on_throttling_exception_event do |event|
2561
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2562
- # end
2563
- # handler.on_trace_event do |event|
2564
- # event # => Aws::BedrockAgentRuntime::Types::trace
2565
- # end
2566
- # handler.on_validation_exception_event do |event|
2567
- # event # => Aws::BedrockAgentRuntime::Types::validationException
2568
- # end
2569
- #
2570
- # client.invoke_inline_agent( # params input #, event_stream_handler: handler)
2571
- #
2572
- # 2) Use a Ruby Proc object
2573
- # Example for registering callbacks with specific events
2574
- #
2575
- # handler = Proc.new do |stream|
2576
- # stream.on_access_denied_exception_event do |event|
2577
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2578
- # end
2579
- # stream.on_bad_gateway_exception_event do |event|
2580
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2581
- # end
2582
- # stream.on_chunk_event do |event|
2583
- # event # => Aws::BedrockAgentRuntime::Types::chunk
2584
- # end
2585
- # stream.on_conflict_exception_event do |event|
2586
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
2587
- # end
2588
- # stream.on_dependency_failed_exception_event do |event|
2589
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2590
- # end
2591
- # stream.on_files_event do |event|
2592
- # event # => Aws::BedrockAgentRuntime::Types::files
2593
- # end
2594
- # stream.on_internal_server_exception_event do |event|
2595
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2596
- # end
2597
- # stream.on_resource_not_found_exception_event do |event|
2598
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2599
- # end
2600
- # stream.on_return_control_event do |event|
2601
- # event # => Aws::BedrockAgentRuntime::Types::returnControl
2602
- # end
2603
- # stream.on_service_quota_exceeded_exception_event do |event|
2604
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2605
- # end
2606
- # stream.on_throttling_exception_event do |event|
2607
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2608
- # end
2609
- # stream.on_trace_event do |event|
2610
- # event # => Aws::BedrockAgentRuntime::Types::trace
2611
- # end
2612
- # stream.on_validation_exception_event do |event|
2613
- # event # => Aws::BedrockAgentRuntime::Types::validationException
2614
- # end
2529
+ # stream.on_event do |event|
2530
+ # # process all events arrive
2531
+ # puts event.event_type
2532
+ # # ...
2615
2533
  # end
2616
- #
2617
- # client.invoke_inline_agent( # params input #, event_stream_handler: handler)
2618
- #
2619
- # Usage pattern c): Hybrid pattern of a) and b)
2620
- #
2621
- # handler = Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream.new
2622
- # handler.on_access_denied_exception_event do |event|
2623
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2624
- # end
2625
- # handler.on_bad_gateway_exception_event do |event|
2626
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2627
- # end
2628
- # handler.on_chunk_event do |event|
2629
- # event # => Aws::BedrockAgentRuntime::Types::chunk
2630
- # end
2631
- # handler.on_conflict_exception_event do |event|
2632
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
2633
- # end
2634
- # handler.on_dependency_failed_exception_event do |event|
2635
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2636
- # end
2637
- # handler.on_files_event do |event|
2638
- # event # => Aws::BedrockAgentRuntime::Types::files
2639
- # end
2640
- # handler.on_internal_server_exception_event do |event|
2641
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2642
- # end
2643
- # handler.on_resource_not_found_exception_event do |event|
2644
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2645
- # end
2646
- # handler.on_return_control_event do |event|
2647
- # event # => Aws::BedrockAgentRuntime::Types::returnControl
2648
- # end
2649
- # handler.on_service_quota_exceeded_exception_event do |event|
2650
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2651
- # end
2652
- # handler.on_throttling_exception_event do |event|
2653
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2654
- # end
2655
- # handler.on_trace_event do |event|
2656
- # event # => Aws::BedrockAgentRuntime::Types::trace
2657
- # end
2658
- # handler.on_validation_exception_event do |event|
2659
- # event # => Aws::BedrockAgentRuntime::Types::validationException
2660
- # end
2661
- #
2662
- # client.invoke_inline_agent( # params input #, event_stream_handler: handler) do |stream|
2663
- # stream.on_error_event do |event|
2664
- # # catch unmodeled error event in the stream
2665
- # raise event
2666
- # # => Aws::Errors::EventError
2667
- # # event.event_type => :error
2668
- # # event.error_code => String
2669
- # # event.error_message => String
2670
- # end
2534
+ # end
2535
+ #
2536
+ # # Usage pattern b): Pass in `:event_stream_handler` for #invoke_inline_agent
2537
+ # # 1) Create a Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream object
2538
+ # # Example for registering callbacks with specific events
2539
+ #
2540
+ # handler = Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream.new
2541
+ # handler.on_access_denied_exception_event do |event|
2542
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2543
+ # end
2544
+ # handler.on_bad_gateway_exception_event do |event|
2545
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2546
+ # end
2547
+ # handler.on_chunk_event do |event|
2548
+ # event # => Aws::BedrockAgentRuntime::Types::chunk
2549
+ # end
2550
+ # handler.on_conflict_exception_event do |event|
2551
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
2552
+ # end
2553
+ # handler.on_dependency_failed_exception_event do |event|
2554
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2555
+ # end
2556
+ # handler.on_files_event do |event|
2557
+ # event # => Aws::BedrockAgentRuntime::Types::files
2558
+ # end
2559
+ # handler.on_internal_server_exception_event do |event|
2560
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2561
+ # end
2562
+ # handler.on_resource_not_found_exception_event do |event|
2563
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2564
+ # end
2565
+ # handler.on_return_control_event do |event|
2566
+ # event # => Aws::BedrockAgentRuntime::Types::returnControl
2567
+ # end
2568
+ # handler.on_service_quota_exceeded_exception_event do |event|
2569
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2570
+ # end
2571
+ # handler.on_throttling_exception_event do |event|
2572
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2573
+ # end
2574
+ # handler.on_trace_event do |event|
2575
+ # event # => Aws::BedrockAgentRuntime::Types::trace
2576
+ # end
2577
+ # handler.on_validation_exception_event do |event|
2578
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
2579
+ # end
2580
+ #
2581
+ # client.invoke_inline_agent(
2582
+ # # params inputs
2583
+ # event_stream_handler: handler
2584
+ # )
2585
+ #
2586
+ # # 2) Use a Ruby Proc object
2587
+ # # Example for registering callbacks with specific events
2588
+ # handler = Proc.new do |stream|
2589
+ # stream.on_access_denied_exception_event do |event|
2590
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2671
2591
  # end
2592
+ # stream.on_bad_gateway_exception_event do |event|
2593
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2594
+ # end
2595
+ # stream.on_chunk_event do |event|
2596
+ # event # => Aws::BedrockAgentRuntime::Types::chunk
2597
+ # end
2598
+ # stream.on_conflict_exception_event do |event|
2599
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
2600
+ # end
2601
+ # stream.on_dependency_failed_exception_event do |event|
2602
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2603
+ # end
2604
+ # stream.on_files_event do |event|
2605
+ # event # => Aws::BedrockAgentRuntime::Types::files
2606
+ # end
2607
+ # stream.on_internal_server_exception_event do |event|
2608
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2609
+ # end
2610
+ # stream.on_resource_not_found_exception_event do |event|
2611
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2612
+ # end
2613
+ # stream.on_return_control_event do |event|
2614
+ # event # => Aws::BedrockAgentRuntime::Types::returnControl
2615
+ # end
2616
+ # stream.on_service_quota_exceeded_exception_event do |event|
2617
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2618
+ # end
2619
+ # stream.on_throttling_exception_event do |event|
2620
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2621
+ # end
2622
+ # stream.on_trace_event do |event|
2623
+ # event # => Aws::BedrockAgentRuntime::Types::trace
2624
+ # end
2625
+ # stream.on_validation_exception_event do |event|
2626
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
2627
+ # end
2628
+ # end
2629
+ #
2630
+ # client.invoke_inline_agent(
2631
+ # # params inputs
2632
+ # event_stream_handler: handler
2633
+ # )
2634
+ #
2635
+ # # Usage pattern c): Hybrid pattern of a) and b)
2636
+ # handler = Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream.new
2637
+ # handler.on_access_denied_exception_event do |event|
2638
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2639
+ # end
2640
+ # handler.on_bad_gateway_exception_event do |event|
2641
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2642
+ # end
2643
+ # handler.on_chunk_event do |event|
2644
+ # event # => Aws::BedrockAgentRuntime::Types::chunk
2645
+ # end
2646
+ # handler.on_conflict_exception_event do |event|
2647
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
2648
+ # end
2649
+ # handler.on_dependency_failed_exception_event do |event|
2650
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2651
+ # end
2652
+ # handler.on_files_event do |event|
2653
+ # event # => Aws::BedrockAgentRuntime::Types::files
2654
+ # end
2655
+ # handler.on_internal_server_exception_event do |event|
2656
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2657
+ # end
2658
+ # handler.on_resource_not_found_exception_event do |event|
2659
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2660
+ # end
2661
+ # handler.on_return_control_event do |event|
2662
+ # event # => Aws::BedrockAgentRuntime::Types::returnControl
2663
+ # end
2664
+ # handler.on_service_quota_exceeded_exception_event do |event|
2665
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2666
+ # end
2667
+ # handler.on_throttling_exception_event do |event|
2668
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2669
+ # end
2670
+ # handler.on_trace_event do |event|
2671
+ # event # => Aws::BedrockAgentRuntime::Types::trace
2672
+ # end
2673
+ # handler.on_validation_exception_event do |event|
2674
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
2675
+ # end
2676
+ #
2677
+ # client.invoke_inline_agent(
2678
+ # # params input
2679
+ # event_stream_handler: handler
2680
+ # ) do |stream|
2681
+ # stream.on_error_event do |event|
2682
+ # # catch unmodeled error event in the stream
2683
+ # raise event
2684
+ # # => Aws::Errors::EventError
2685
+ # # event.event_type => :error
2686
+ # # event.error_code => String
2687
+ # # event.error_message => String
2688
+ # end
2689
+ # end
2672
2690
  #
2673
- # You can also iterate through events after the response complete.
2674
- #
2675
- # Events are available at resp.completion # => Enumerator
2676
- # For parameter input example, please refer to following request syntax
2691
+ # # You can also iterate through events after the response complete.
2692
+ # # Events are available at
2693
+ # resp.completion # => Enumerator
2694
+ # # For parameter input example, please refer to following request syntax.
2677
2695
  #
2678
2696
  # @example Request syntax with placeholder values
2679
2697
  #
@@ -3169,18 +3187,18 @@ module Aws::BedrockAgentRuntime
3169
3187
  #
3170
3188
  # @example Response structure
3171
3189
  #
3172
- # All events are available at resp.completion:
3190
+ # # All events are available at resp.completion:
3173
3191
  # resp.completion #=> Enumerator
3174
3192
  # resp.completion.event_types #=> [:access_denied_exception, :bad_gateway_exception, :chunk, :conflict_exception, :dependency_failed_exception, :files, :internal_server_exception, :resource_not_found_exception, :return_control, :service_quota_exceeded_exception, :throttling_exception, :trace, :validation_exception]
3175
3193
  #
3176
- # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
3194
+ # # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
3177
3195
  # event.message #=> String
3178
3196
  #
3179
- # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
3197
+ # # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
3180
3198
  # event.message #=> String
3181
3199
  # event.resource_name #=> String
3182
3200
  #
3183
- # For :chunk event available at #on_chunk_event callback and response eventstream enumerator:
3201
+ # # For :chunk event available at #on_chunk_event callback and response eventstream enumerator:
3184
3202
  # event.attribution.citations #=> Array
3185
3203
  # event.attribution.citations[0].generated_response_part.text_response_part.span.end #=> Integer
3186
3204
  # event.attribution.citations[0].generated_response_part.text_response_part.span.start #=> Integer
@@ -3205,27 +3223,27 @@ module Aws::BedrockAgentRuntime
3205
3223
  # event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
3206
3224
  # event.bytes #=> String
3207
3225
  #
3208
- # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
3226
+ # # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
3209
3227
  # event.message #=> String
3210
3228
  #
3211
- # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
3229
+ # # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
3212
3230
  # event.message #=> String
3213
3231
  # event.resource_name #=> String
3214
3232
  #
3215
- # For :files event available at #on_files_event callback and response eventstream enumerator:
3233
+ # # For :files event available at #on_files_event callback and response eventstream enumerator:
3216
3234
  # event.files #=> Array
3217
3235
  # event.files[0].bytes #=> String
3218
3236
  # event.files[0].name #=> String
3219
3237
  # event.files[0].type #=> String
3220
3238
  #
3221
- # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
3239
+ # # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
3222
3240
  # event.message #=> String
3223
3241
  # event.reason #=> String
3224
3242
  #
3225
- # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
3243
+ # # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
3226
3244
  # event.message #=> String
3227
3245
  #
3228
- # For :return_control event available at #on_return_control_event callback and response eventstream enumerator:
3246
+ # # For :return_control event available at #on_return_control_event callback and response eventstream enumerator:
3229
3247
  # event.invocation_id #=> String
3230
3248
  # event.invocation_inputs #=> Array
3231
3249
  # event.invocation_inputs[0].api_invocation_input.action_group #=> String
@@ -3253,13 +3271,13 @@ module Aws::BedrockAgentRuntime
3253
3271
  # event.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
3254
3272
  # event.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
3255
3273
  #
3256
- # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
3274
+ # # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
3257
3275
  # event.message #=> String
3258
3276
  #
3259
- # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
3277
+ # # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
3260
3278
  # event.message #=> String
3261
3279
  #
3262
- # For :trace event available at #on_trace_event callback and response eventstream enumerator:
3280
+ # # For :trace event available at #on_trace_event callback and response eventstream enumerator:
3263
3281
  # event.session_id #=> String
3264
3282
  # event.trace.custom_orchestration_trace.event.text #=> String
3265
3283
  # event.trace.custom_orchestration_trace.trace_id #=> String
@@ -3618,7 +3636,7 @@ module Aws::BedrockAgentRuntime
3618
3636
  # event.trace.routing_classifier_trace.observation.trace_id #=> String
3619
3637
  # event.trace.routing_classifier_trace.observation.type #=> String, one of "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
3620
3638
  #
3621
- # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
3639
+ # # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
3622
3640
  # event.message #=> String
3623
3641
  #
3624
3642
  # resp.content_type #=> String
@@ -3876,149 +3894,155 @@ module Aws::BedrockAgentRuntime
3876
3894
  #
3877
3895
  # @example EventStream Operation Example
3878
3896
  #
3879
- # You can process the event once it arrives immediately, or wait until the
3880
- # full response is complete and iterate through the eventstream enumerator.
3881
- #
3882
- # To interact with event immediately, you need to register #optimize_prompt
3883
- # with callbacks. Callbacks can be registered for specific events or for all
3884
- # events, including error events.
3885
- #
3886
- # Callbacks can be passed into the `:event_stream_handler` option or within a
3887
- # block statement attached to the #optimize_prompt call directly. Hybrid
3888
- # pattern of both is also supported.
3889
- #
3890
- # `:event_stream_handler` option takes in either a Proc object or
3891
- # Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream object.
3892
- #
3893
- # Usage pattern a): Callbacks with a block attached to #optimize_prompt
3894
- # Example for registering callbacks for all event types and an error event
3895
- #
3896
- # client.optimize_prompt( # params input# ) do |stream|
3897
- # stream.on_error_event do |event|
3898
- # # catch unmodeled error event in the stream
3899
- # raise event
3900
- # # => Aws::Errors::EventError
3901
- # # event.event_type => :error
3902
- # # event.error_code => String
3903
- # # event.error_message => String
3904
- # end
3905
- #
3906
- # stream.on_event do |event|
3907
- # # process all events arrive
3908
- # puts event.event_type
3909
- # ...
3910
- # end
3911
- #
3897
+ # # You can process the event once it arrives immediately, or wait until the
3898
+ # # full response is complete and iterate through the eventstream enumerator.
3899
+ #
3900
+ # # To interact with event immediately, you need to register optimize_prompt
3901
+ # # with callbacks. Callbacks can be registered for specific events or for all
3902
+ # # events, including error events.
3903
+ #
3904
+ # # Callbacks can be passed into the `:event_stream_handler` option or within a
3905
+ # # block statement attached to the #optimize_prompt call directly. Hybrid
3906
+ # # pattern of both is also supported.
3907
+ #
3908
+ # # `:event_stream_handler` option takes in either a Proc object or
3909
+ # # Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream object.
3910
+ #
3911
+ # # Usage pattern a): Callbacks with a block attached to #optimize_prompt
3912
+ # # Example for registering callbacks for all event types and an error event
3913
+ # client.optimize_prompt(
3914
+ # # params input
3915
+ # ) do |stream|
3916
+ # stream.on_error_event do |event|
3917
+ # # catch unmodeled error event in the stream
3918
+ # raise event
3919
+ # # => Aws::Errors::EventError
3920
+ # # event.event_type => :error
3921
+ # # event.error_code => String
3922
+ # # event.error_message => String
3912
3923
  # end
3913
3924
  #
3914
- # Usage pattern b): Pass in `:event_stream_handler` for #optimize_prompt
3915
- #
3916
- # 1) Create a Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream object
3917
- # Example for registering callbacks with specific events
3918
- #
3919
- # handler = Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream.new
3920
- # handler.on_access_denied_exception_event do |event|
3921
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
3922
- # end
3923
- # handler.on_analyze_prompt_event_event do |event|
3924
- # event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
3925
- # end
3926
- # handler.on_bad_gateway_exception_event do |event|
3927
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
3928
- # end
3929
- # handler.on_dependency_failed_exception_event do |event|
3930
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
3931
- # end
3932
- # handler.on_internal_server_exception_event do |event|
3933
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
3934
- # end
3935
- # handler.on_optimized_prompt_event_event do |event|
3936
- # event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
3937
- # end
3938
- # handler.on_throttling_exception_event do |event|
3939
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
3940
- # end
3941
- # handler.on_validation_exception_event do |event|
3942
- # event # => Aws::BedrockAgentRuntime::Types::validationException
3943
- # end
3944
- #
3945
- # client.optimize_prompt( # params input #, event_stream_handler: handler)
3946
- #
3947
- # 2) Use a Ruby Proc object
3948
- # Example for registering callbacks with specific events
3949
- #
3950
- # handler = Proc.new do |stream|
3951
- # stream.on_access_denied_exception_event do |event|
3952
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
3953
- # end
3954
- # stream.on_analyze_prompt_event_event do |event|
3955
- # event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
3956
- # end
3957
- # stream.on_bad_gateway_exception_event do |event|
3958
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
3959
- # end
3960
- # stream.on_dependency_failed_exception_event do |event|
3961
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
3962
- # end
3963
- # stream.on_internal_server_exception_event do |event|
3964
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
3965
- # end
3966
- # stream.on_optimized_prompt_event_event do |event|
3967
- # event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
3968
- # end
3969
- # stream.on_throttling_exception_event do |event|
3970
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
3971
- # end
3972
- # stream.on_validation_exception_event do |event|
3973
- # event # => Aws::BedrockAgentRuntime::Types::validationException
3974
- # end
3925
+ # stream.on_event do |event|
3926
+ # # process all events arrive
3927
+ # puts event.event_type
3928
+ # # ...
3975
3929
  # end
3976
- #
3977
- # client.optimize_prompt( # params input #, event_stream_handler: handler)
3978
- #
3979
- # Usage pattern c): Hybrid pattern of a) and b)
3980
- #
3981
- # handler = Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream.new
3982
- # handler.on_access_denied_exception_event do |event|
3983
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
3984
- # end
3985
- # handler.on_analyze_prompt_event_event do |event|
3986
- # event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
3987
- # end
3988
- # handler.on_bad_gateway_exception_event do |event|
3989
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
3990
- # end
3991
- # handler.on_dependency_failed_exception_event do |event|
3992
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
3993
- # end
3994
- # handler.on_internal_server_exception_event do |event|
3995
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
3996
- # end
3997
- # handler.on_optimized_prompt_event_event do |event|
3998
- # event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
3999
- # end
4000
- # handler.on_throttling_exception_event do |event|
4001
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4002
- # end
4003
- # handler.on_validation_exception_event do |event|
4004
- # event # => Aws::BedrockAgentRuntime::Types::validationException
4005
- # end
4006
- #
4007
- # client.optimize_prompt( # params input #, event_stream_handler: handler) do |stream|
4008
- # stream.on_error_event do |event|
4009
- # # catch unmodeled error event in the stream
4010
- # raise event
4011
- # # => Aws::Errors::EventError
4012
- # # event.event_type => :error
4013
- # # event.error_code => String
4014
- # # event.error_message => String
4015
- # end
3930
+ # end
3931
+ #
3932
+ # # Usage pattern b): Pass in `:event_stream_handler` for #optimize_prompt
3933
+ # # 1) Create a Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream object
3934
+ # # Example for registering callbacks with specific events
3935
+ #
3936
+ # handler = Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream.new
3937
+ # handler.on_access_denied_exception_event do |event|
3938
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
3939
+ # end
3940
+ # handler.on_analyze_prompt_event_event do |event|
3941
+ # event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
3942
+ # end
3943
+ # handler.on_bad_gateway_exception_event do |event|
3944
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
3945
+ # end
3946
+ # handler.on_dependency_failed_exception_event do |event|
3947
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
3948
+ # end
3949
+ # handler.on_internal_server_exception_event do |event|
3950
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
3951
+ # end
3952
+ # handler.on_optimized_prompt_event_event do |event|
3953
+ # event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
3954
+ # end
3955
+ # handler.on_throttling_exception_event do |event|
3956
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
3957
+ # end
3958
+ # handler.on_validation_exception_event do |event|
3959
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
3960
+ # end
3961
+ #
3962
+ # client.optimize_prompt(
3963
+ # # params inputs
3964
+ # event_stream_handler: handler
3965
+ # )
3966
+ #
3967
+ # # 2) Use a Ruby Proc object
3968
+ # # Example for registering callbacks with specific events
3969
+ # handler = Proc.new do |stream|
3970
+ # stream.on_access_denied_exception_event do |event|
3971
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4016
3972
  # end
3973
+ # stream.on_analyze_prompt_event_event do |event|
3974
+ # event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
3975
+ # end
3976
+ # stream.on_bad_gateway_exception_event do |event|
3977
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
3978
+ # end
3979
+ # stream.on_dependency_failed_exception_event do |event|
3980
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
3981
+ # end
3982
+ # stream.on_internal_server_exception_event do |event|
3983
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
3984
+ # end
3985
+ # stream.on_optimized_prompt_event_event do |event|
3986
+ # event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
3987
+ # end
3988
+ # stream.on_throttling_exception_event do |event|
3989
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
3990
+ # end
3991
+ # stream.on_validation_exception_event do |event|
3992
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
3993
+ # end
3994
+ # end
3995
+ #
3996
+ # client.optimize_prompt(
3997
+ # # params inputs
3998
+ # event_stream_handler: handler
3999
+ # )
4000
+ #
4001
+ # # Usage pattern c): Hybrid pattern of a) and b)
4002
+ # handler = Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream.new
4003
+ # handler.on_access_denied_exception_event do |event|
4004
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4005
+ # end
4006
+ # handler.on_analyze_prompt_event_event do |event|
4007
+ # event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
4008
+ # end
4009
+ # handler.on_bad_gateway_exception_event do |event|
4010
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
4011
+ # end
4012
+ # handler.on_dependency_failed_exception_event do |event|
4013
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4014
+ # end
4015
+ # handler.on_internal_server_exception_event do |event|
4016
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4017
+ # end
4018
+ # handler.on_optimized_prompt_event_event do |event|
4019
+ # event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
4020
+ # end
4021
+ # handler.on_throttling_exception_event do |event|
4022
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4023
+ # end
4024
+ # handler.on_validation_exception_event do |event|
4025
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
4026
+ # end
4027
+ #
4028
+ # client.optimize_prompt(
4029
+ # # params input
4030
+ # event_stream_handler: handler
4031
+ # ) do |stream|
4032
+ # stream.on_error_event do |event|
4033
+ # # catch unmodeled error event in the stream
4034
+ # raise event
4035
+ # # => Aws::Errors::EventError
4036
+ # # event.event_type => :error
4037
+ # # event.error_code => String
4038
+ # # event.error_message => String
4039
+ # end
4040
+ # end
4017
4041
  #
4018
- # You can also iterate through events after the response complete.
4019
- #
4020
- # Events are available at resp.optimized_prompt # => Enumerator
4021
- # For parameter input example, please refer to following request syntax
4042
+ # # You can also iterate through events after the response complete.
4043
+ # # Events are available at
4044
+ # resp.optimized_prompt # => Enumerator
4045
+ # # For parameter input example, please refer to following request syntax.
4022
4046
  #
4023
4047
  # @example Request syntax with placeholder values
4024
4048
  #
@@ -4033,35 +4057,35 @@ module Aws::BedrockAgentRuntime
4033
4057
  #
4034
4058
  # @example Response structure
4035
4059
  #
4036
- # All events are available at resp.optimized_prompt:
4060
+ # # All events are available at resp.optimized_prompt:
4037
4061
  # resp.optimized_prompt #=> Enumerator
4038
4062
  # resp.optimized_prompt.event_types #=> [:access_denied_exception, :analyze_prompt_event, :bad_gateway_exception, :dependency_failed_exception, :internal_server_exception, :optimized_prompt_event, :throttling_exception, :validation_exception]
4039
4063
  #
4040
- # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
4064
+ # # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
4041
4065
  # event.message #=> String
4042
4066
  #
4043
- # For :analyze_prompt_event event available at #on_analyze_prompt_event_event callback and response eventstream enumerator:
4067
+ # # For :analyze_prompt_event event available at #on_analyze_prompt_event_event callback and response eventstream enumerator:
4044
4068
  # event.message #=> String
4045
4069
  #
4046
- # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
4070
+ # # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
4047
4071
  # event.message #=> String
4048
4072
  # event.resource_name #=> String
4049
4073
  #
4050
- # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
4074
+ # # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
4051
4075
  # event.message #=> String
4052
4076
  # event.resource_name #=> String
4053
4077
  #
4054
- # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
4078
+ # # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
4055
4079
  # event.message #=> String
4056
4080
  # event.reason #=> String
4057
4081
  #
4058
- # For :optimized_prompt_event event available at #on_optimized_prompt_event_event callback and response eventstream enumerator:
4082
+ # # For :optimized_prompt_event event available at #on_optimized_prompt_event_event callback and response eventstream enumerator:
4059
4083
  # event.optimized_prompt.text_prompt.text #=> String
4060
4084
  #
4061
- # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
4085
+ # # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
4062
4086
  # event.message #=> String
4063
4087
  #
4064
- # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
4088
+ # # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
4065
4089
  # event.message #=> String
4066
4090
  #
4067
4091
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OptimizePrompt AWS API Documentation
@@ -4786,185 +4810,191 @@ module Aws::BedrockAgentRuntime
4786
4810
  #
4787
4811
  # @example EventStream Operation Example
4788
4812
  #
4789
- # You can process the event once it arrives immediately, or wait until the
4790
- # full response is complete and iterate through the eventstream enumerator.
4791
- #
4792
- # To interact with event immediately, you need to register #retrieve_and_generate_stream
4793
- # with callbacks. Callbacks can be registered for specific events or for all
4794
- # events, including error events.
4795
- #
4796
- # Callbacks can be passed into the `:event_stream_handler` option or within a
4797
- # block statement attached to the #retrieve_and_generate_stream call directly. Hybrid
4798
- # pattern of both is also supported.
4799
- #
4800
- # `:event_stream_handler` option takes in either a Proc object or
4801
- # Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput object.
4802
- #
4803
- # Usage pattern a): Callbacks with a block attached to #retrieve_and_generate_stream
4804
- # Example for registering callbacks for all event types and an error event
4805
- #
4806
- # client.retrieve_and_generate_stream( # params input# ) do |stream|
4807
- # stream.on_error_event do |event|
4808
- # # catch unmodeled error event in the stream
4809
- # raise event
4810
- # # => Aws::Errors::EventError
4811
- # # event.event_type => :error
4812
- # # event.error_code => String
4813
- # # event.error_message => String
4814
- # end
4815
- #
4816
- # stream.on_event do |event|
4817
- # # process all events arrive
4818
- # puts event.event_type
4819
- # ...
4820
- # end
4821
- #
4813
+ # # You can process the event once it arrives immediately, or wait until the
4814
+ # # full response is complete and iterate through the eventstream enumerator.
4815
+ #
4816
+ # # To interact with event immediately, you need to register retrieve_and_generate_stream
4817
+ # # with callbacks. Callbacks can be registered for specific events or for all
4818
+ # # events, including error events.
4819
+ #
4820
+ # # Callbacks can be passed into the `:event_stream_handler` option or within a
4821
+ # # block statement attached to the #retrieve_and_generate_stream call directly. Hybrid
4822
+ # # pattern of both is also supported.
4823
+ #
4824
+ # # `:event_stream_handler` option takes in either a Proc object or
4825
+ # # Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput object.
4826
+ #
4827
+ # # Usage pattern a): Callbacks with a block attached to #retrieve_and_generate_stream
4828
+ # # Example for registering callbacks for all event types and an error event
4829
+ # client.retrieve_and_generate_stream(
4830
+ # # params input
4831
+ # ) do |stream|
4832
+ # stream.on_error_event do |event|
4833
+ # # catch unmodeled error event in the stream
4834
+ # raise event
4835
+ # # => Aws::Errors::EventError
4836
+ # # event.event_type => :error
4837
+ # # event.error_code => String
4838
+ # # event.error_message => String
4822
4839
  # end
4823
4840
  #
4824
- # Usage pattern b): Pass in `:event_stream_handler` for #retrieve_and_generate_stream
4825
- #
4826
- # 1) Create a Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput object
4827
- # Example for registering callbacks with specific events
4828
- #
4829
- # handler = Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput.new
4830
- # handler.on_access_denied_exception_event do |event|
4831
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4832
- # end
4833
- # handler.on_bad_gateway_exception_event do |event|
4834
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
4835
- # end
4836
- # handler.on_citation_event do |event|
4837
- # event # => Aws::BedrockAgentRuntime::Types::citation
4838
- # end
4839
- # handler.on_conflict_exception_event do |event|
4840
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
4841
- # end
4842
- # handler.on_dependency_failed_exception_event do |event|
4843
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4844
- # end
4845
- # handler.on_guardrail_event do |event|
4846
- # event # => Aws::BedrockAgentRuntime::Types::guardrail
4847
- # end
4848
- # handler.on_internal_server_exception_event do |event|
4849
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4850
- # end
4851
- # handler.on_output_event do |event|
4852
- # event # => Aws::BedrockAgentRuntime::Types::output
4853
- # end
4854
- # handler.on_resource_not_found_exception_event do |event|
4855
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
4856
- # end
4857
- # handler.on_service_quota_exceeded_exception_event do |event|
4858
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
4859
- # end
4860
- # handler.on_throttling_exception_event do |event|
4861
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4862
- # end
4863
- # handler.on_validation_exception_event do |event|
4864
- # event # => Aws::BedrockAgentRuntime::Types::validationException
4865
- # end
4866
- #
4867
- # client.retrieve_and_generate_stream( # params input #, event_stream_handler: handler)
4868
- #
4869
- # 2) Use a Ruby Proc object
4870
- # Example for registering callbacks with specific events
4871
- #
4872
- # handler = Proc.new do |stream|
4873
- # stream.on_access_denied_exception_event do |event|
4874
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4875
- # end
4876
- # stream.on_bad_gateway_exception_event do |event|
4877
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
4878
- # end
4879
- # stream.on_citation_event do |event|
4880
- # event # => Aws::BedrockAgentRuntime::Types::citation
4881
- # end
4882
- # stream.on_conflict_exception_event do |event|
4883
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
4884
- # end
4885
- # stream.on_dependency_failed_exception_event do |event|
4886
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4887
- # end
4888
- # stream.on_guardrail_event do |event|
4889
- # event # => Aws::BedrockAgentRuntime::Types::guardrail
4890
- # end
4891
- # stream.on_internal_server_exception_event do |event|
4892
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4893
- # end
4894
- # stream.on_output_event do |event|
4895
- # event # => Aws::BedrockAgentRuntime::Types::output
4896
- # end
4897
- # stream.on_resource_not_found_exception_event do |event|
4898
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
4899
- # end
4900
- # stream.on_service_quota_exceeded_exception_event do |event|
4901
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
4902
- # end
4903
- # stream.on_throttling_exception_event do |event|
4904
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4905
- # end
4906
- # stream.on_validation_exception_event do |event|
4907
- # event # => Aws::BedrockAgentRuntime::Types::validationException
4908
- # end
4841
+ # stream.on_event do |event|
4842
+ # # process all events arrive
4843
+ # puts event.event_type
4844
+ # # ...
4909
4845
  # end
4910
- #
4911
- # client.retrieve_and_generate_stream( # params input #, event_stream_handler: handler)
4912
- #
4913
- # Usage pattern c): Hybrid pattern of a) and b)
4914
- #
4915
- # handler = Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput.new
4916
- # handler.on_access_denied_exception_event do |event|
4917
- # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4918
- # end
4919
- # handler.on_bad_gateway_exception_event do |event|
4920
- # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
4921
- # end
4922
- # handler.on_citation_event do |event|
4923
- # event # => Aws::BedrockAgentRuntime::Types::citation
4924
- # end
4925
- # handler.on_conflict_exception_event do |event|
4926
- # event # => Aws::BedrockAgentRuntime::Types::conflictException
4927
- # end
4928
- # handler.on_dependency_failed_exception_event do |event|
4929
- # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4930
- # end
4931
- # handler.on_guardrail_event do |event|
4932
- # event # => Aws::BedrockAgentRuntime::Types::guardrail
4933
- # end
4934
- # handler.on_internal_server_exception_event do |event|
4935
- # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4936
- # end
4937
- # handler.on_output_event do |event|
4938
- # event # => Aws::BedrockAgentRuntime::Types::output
4939
- # end
4940
- # handler.on_resource_not_found_exception_event do |event|
4941
- # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
4942
- # end
4943
- # handler.on_service_quota_exceeded_exception_event do |event|
4944
- # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
4945
- # end
4946
- # handler.on_throttling_exception_event do |event|
4947
- # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4948
- # end
4949
- # handler.on_validation_exception_event do |event|
4950
- # event # => Aws::BedrockAgentRuntime::Types::validationException
4951
- # end
4952
- #
4953
- # client.retrieve_and_generate_stream( # params input #, event_stream_handler: handler) do |stream|
4954
- # stream.on_error_event do |event|
4955
- # # catch unmodeled error event in the stream
4956
- # raise event
4957
- # # => Aws::Errors::EventError
4958
- # # event.event_type => :error
4959
- # # event.error_code => String
4960
- # # event.error_message => String
4961
- # end
4846
+ # end
4847
+ #
4848
+ # # Usage pattern b): Pass in `:event_stream_handler` for #retrieve_and_generate_stream
4849
+ # # 1) Create a Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput object
4850
+ # # Example for registering callbacks with specific events
4851
+ #
4852
+ # handler = Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput.new
4853
+ # handler.on_access_denied_exception_event do |event|
4854
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4855
+ # end
4856
+ # handler.on_bad_gateway_exception_event do |event|
4857
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
4858
+ # end
4859
+ # handler.on_citation_event do |event|
4860
+ # event # => Aws::BedrockAgentRuntime::Types::citation
4861
+ # end
4862
+ # handler.on_conflict_exception_event do |event|
4863
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
4864
+ # end
4865
+ # handler.on_dependency_failed_exception_event do |event|
4866
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4867
+ # end
4868
+ # handler.on_guardrail_event do |event|
4869
+ # event # => Aws::BedrockAgentRuntime::Types::guardrail
4870
+ # end
4871
+ # handler.on_internal_server_exception_event do |event|
4872
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4873
+ # end
4874
+ # handler.on_output_event do |event|
4875
+ # event # => Aws::BedrockAgentRuntime::Types::output
4876
+ # end
4877
+ # handler.on_resource_not_found_exception_event do |event|
4878
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
4879
+ # end
4880
+ # handler.on_service_quota_exceeded_exception_event do |event|
4881
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
4882
+ # end
4883
+ # handler.on_throttling_exception_event do |event|
4884
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4885
+ # end
4886
+ # handler.on_validation_exception_event do |event|
4887
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
4888
+ # end
4889
+ #
4890
+ # client.retrieve_and_generate_stream(
4891
+ # # params inputs
4892
+ # event_stream_handler: handler
4893
+ # )
4894
+ #
4895
+ # # 2) Use a Ruby Proc object
4896
+ # # Example for registering callbacks with specific events
4897
+ # handler = Proc.new do |stream|
4898
+ # stream.on_access_denied_exception_event do |event|
4899
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4962
4900
  # end
4901
+ # stream.on_bad_gateway_exception_event do |event|
4902
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
4903
+ # end
4904
+ # stream.on_citation_event do |event|
4905
+ # event # => Aws::BedrockAgentRuntime::Types::citation
4906
+ # end
4907
+ # stream.on_conflict_exception_event do |event|
4908
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
4909
+ # end
4910
+ # stream.on_dependency_failed_exception_event do |event|
4911
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4912
+ # end
4913
+ # stream.on_guardrail_event do |event|
4914
+ # event # => Aws::BedrockAgentRuntime::Types::guardrail
4915
+ # end
4916
+ # stream.on_internal_server_exception_event do |event|
4917
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4918
+ # end
4919
+ # stream.on_output_event do |event|
4920
+ # event # => Aws::BedrockAgentRuntime::Types::output
4921
+ # end
4922
+ # stream.on_resource_not_found_exception_event do |event|
4923
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
4924
+ # end
4925
+ # stream.on_service_quota_exceeded_exception_event do |event|
4926
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
4927
+ # end
4928
+ # stream.on_throttling_exception_event do |event|
4929
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4930
+ # end
4931
+ # stream.on_validation_exception_event do |event|
4932
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
4933
+ # end
4934
+ # end
4935
+ #
4936
+ # client.retrieve_and_generate_stream(
4937
+ # # params inputs
4938
+ # event_stream_handler: handler
4939
+ # )
4940
+ #
4941
+ # # Usage pattern c): Hybrid pattern of a) and b)
4942
+ # handler = Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput.new
4943
+ # handler.on_access_denied_exception_event do |event|
4944
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4945
+ # end
4946
+ # handler.on_bad_gateway_exception_event do |event|
4947
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
4948
+ # end
4949
+ # handler.on_citation_event do |event|
4950
+ # event # => Aws::BedrockAgentRuntime::Types::citation
4951
+ # end
4952
+ # handler.on_conflict_exception_event do |event|
4953
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
4954
+ # end
4955
+ # handler.on_dependency_failed_exception_event do |event|
4956
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4957
+ # end
4958
+ # handler.on_guardrail_event do |event|
4959
+ # event # => Aws::BedrockAgentRuntime::Types::guardrail
4960
+ # end
4961
+ # handler.on_internal_server_exception_event do |event|
4962
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4963
+ # end
4964
+ # handler.on_output_event do |event|
4965
+ # event # => Aws::BedrockAgentRuntime::Types::output
4966
+ # end
4967
+ # handler.on_resource_not_found_exception_event do |event|
4968
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
4969
+ # end
4970
+ # handler.on_service_quota_exceeded_exception_event do |event|
4971
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
4972
+ # end
4973
+ # handler.on_throttling_exception_event do |event|
4974
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4975
+ # end
4976
+ # handler.on_validation_exception_event do |event|
4977
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
4978
+ # end
4979
+ #
4980
+ # client.retrieve_and_generate_stream(
4981
+ # # params input
4982
+ # event_stream_handler: handler
4983
+ # ) do |stream|
4984
+ # stream.on_error_event do |event|
4985
+ # # catch unmodeled error event in the stream
4986
+ # raise event
4987
+ # # => Aws::Errors::EventError
4988
+ # # event.event_type => :error
4989
+ # # event.error_code => String
4990
+ # # event.error_message => String
4991
+ # end
4992
+ # end
4963
4993
  #
4964
- # You can also iterate through events after the response complete.
4965
- #
4966
- # Events are available at resp.stream # => Enumerator
4967
- # For parameter input example, please refer to following request syntax
4994
+ # # You can also iterate through events after the response complete.
4995
+ # # Events are available at
4996
+ # resp.stream # => Enumerator
4997
+ # # For parameter input example, please refer to following request syntax.
4968
4998
  #
4969
4999
  # @example Request syntax with placeholder values
4970
5000
  #
@@ -5186,18 +5216,18 @@ module Aws::BedrockAgentRuntime
5186
5216
  # @example Response structure
5187
5217
  #
5188
5218
  # resp.session_id #=> String
5189
- # All events are available at resp.stream:
5219
+ # # All events are available at resp.stream:
5190
5220
  # resp.stream #=> Enumerator
5191
5221
  # resp.stream.event_types #=> [:access_denied_exception, :bad_gateway_exception, :citation, :conflict_exception, :dependency_failed_exception, :guardrail, :internal_server_exception, :output, :resource_not_found_exception, :service_quota_exceeded_exception, :throttling_exception, :validation_exception]
5192
5222
  #
5193
- # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
5223
+ # # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
5194
5224
  # event.message #=> String
5195
5225
  #
5196
- # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
5226
+ # # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
5197
5227
  # event.message #=> String
5198
5228
  # event.resource_name #=> String
5199
5229
  #
5200
- # For :citation event available at #on_citation_event callback and response eventstream enumerator:
5230
+ # # For :citation event available at #on_citation_event callback and response eventstream enumerator:
5201
5231
  # event.citation.generated_response_part.text_response_part.span.end #=> Integer
5202
5232
  # event.citation.generated_response_part.text_response_part.span.start #=> Integer
5203
5233
  # event.citation.generated_response_part.text_response_part.text #=> String
@@ -5241,33 +5271,33 @@ module Aws::BedrockAgentRuntime
5241
5271
  # event.retrieved_references[0].location.web_location.url #=> String
5242
5272
  # event.retrieved_references[0].metadata #=> Hash
5243
5273
  #
5244
- # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
5274
+ # # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
5245
5275
  # event.message #=> String
5246
5276
  #
5247
- # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
5277
+ # # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
5248
5278
  # event.message #=> String
5249
5279
  # event.resource_name #=> String
5250
5280
  #
5251
- # For :guardrail event available at #on_guardrail_event callback and response eventstream enumerator:
5281
+ # # For :guardrail event available at #on_guardrail_event callback and response eventstream enumerator:
5252
5282
  # event.action #=> String, one of "INTERVENED", "NONE"
5253
5283
  #
5254
- # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
5284
+ # # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
5255
5285
  # event.message #=> String
5256
5286
  # event.reason #=> String
5257
5287
  #
5258
- # For :output event available at #on_output_event callback and response eventstream enumerator:
5288
+ # # For :output event available at #on_output_event callback and response eventstream enumerator:
5259
5289
  # event.text #=> String
5260
5290
  #
5261
- # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
5291
+ # # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
5262
5292
  # event.message #=> String
5263
5293
  #
5264
- # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
5294
+ # # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
5265
5295
  # event.message #=> String
5266
5296
  #
5267
- # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
5297
+ # # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
5268
5298
  # event.message #=> String
5269
5299
  #
5270
- # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
5300
+ # # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
5271
5301
  # event.message #=> String
5272
5302
  #
5273
5303
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream AWS API Documentation
@@ -5427,7 +5457,7 @@ module Aws::BedrockAgentRuntime
5427
5457
  tracer: tracer
5428
5458
  )
5429
5459
  context[:gem_name] = 'aws-sdk-bedrockagentruntime'
5430
- context[:gem_version] = '1.50.0'
5460
+ context[:gem_version] = '1.51.0'
5431
5461
  Seahorse::Client::Request.new(handlers, context)
5432
5462
  end
5433
5463