aws-sdk-bedrockagentruntime 1.50.0 → 1.52.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.
@@ -964,10 +964,10 @@ module Aws::BedrockAgentRuntime
964
964
 
965
965
  # <note> </note>
966
966
  #
967
- # Sends a prompt for the agent to process and respond to. Note the
967
+ # Sends a prompt for the agent to process and respond to. Note the
968
968
  # following fields for the request:
969
969
  #
970
- # * To continue the same conversation with an agent, use the same
970
+ # * To continue the same conversation with an agent, use the same
971
971
  # `sessionId` value in the request.
972
972
  #
973
973
  # * To activate trace enablement, turn `enableTrace` to `true`. Trace
@@ -982,13 +982,13 @@ module Aws::BedrockAgentRuntime
982
982
  # session or prompt or, if you configured an action group to return
983
983
  # control, results from invocation of the action group.
984
984
  #
985
- # The response contains both **chunk** and **trace** attributes.
985
+ # The response contains both **chunk** and **trace** attributes.
986
986
  #
987
- # The final response is returned in the `bytes` field of the `chunk`
987
+ # The final response is returned in the `bytes` field of the `chunk`
988
988
  # object. The `InvokeAgent` returns one chunk for the entire
989
989
  # interaction.
990
990
  #
991
- # * The `attribution` object contains citations for parts of the
991
+ # * The `attribution` object contains citations for parts of the
992
992
  # response.
993
993
  #
994
994
  # * If you set `enableTrace` to `true` in the request, you can trace the
@@ -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
@@ -2378,6 +2390,9 @@ module Aws::BedrockAgentRuntime
2378
2390
  # multiple collaborator agents to coordinate a final response. The
2379
2391
  # inline collaborator agent can also be the supervisor.
2380
2392
  #
2393
+ # @option params [String] :agent_name
2394
+ # The name for the agent.
2395
+ #
2381
2396
  # @option params [Types::InlineBedrockModelConfigurations] :bedrock_model_configurations
2382
2397
  # Model settings for the request.
2383
2398
  #
@@ -2392,6 +2407,9 @@ module Aws::BedrockAgentRuntime
2392
2407
  # @option params [Array<Types::Collaborator>] :collaborators
2393
2408
  # List of collaborator inline agents.
2394
2409
  #
2410
+ # @option params [Types::CustomOrchestration] :custom_orchestration
2411
+ # Contains details of the custom orchestration configured for the agent.
2412
+ #
2395
2413
  # @option params [String] :customer_encryption_key_arn
2396
2414
  # The Amazon Resource Name (ARN) of the Amazon Web Services KMS key to
2397
2415
  # use to encrypt your inline agent.
@@ -2399,7 +2417,6 @@ module Aws::BedrockAgentRuntime
2399
2417
  # @option params [Boolean] :enable_trace
2400
2418
  # Specifies whether to turn on the trace or not to track the agent's
2401
2419
  # reasoning process. For more information, see [Using trace][1].
2402
- # </p>
2403
2420
  #
2404
2421
  #
2405
2422
  #
@@ -2462,6 +2479,10 @@ module Aws::BedrockAgentRuntime
2462
2479
  # @option params [Array<Types::KnowledgeBase>] :knowledge_bases
2463
2480
  # Contains information of the knowledge bases to associate with.
2464
2481
  #
2482
+ # @option params [String] :orchestration_type
2483
+ # Specifies the type of orchestration strategy for the agent. This is
2484
+ # set to DEFAULT orchestration type, by default.
2485
+ #
2465
2486
  # @option params [Types::PromptOverrideConfiguration] :prompt_override_configuration
2466
2487
  # Configurations for advanced prompts used to override the default
2467
2488
  # prompts to enhance the accuracy of the inline agent.
@@ -2486,194 +2507,200 @@ module Aws::BedrockAgentRuntime
2486
2507
  #
2487
2508
  # @example EventStream Operation Example
2488
2509
  #
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
- #
2510
+ # # You can process the event once it arrives immediately, or wait until the
2511
+ # # full response is complete and iterate through the eventstream enumerator.
2512
+ #
2513
+ # # To interact with event immediately, you need to register invoke_inline_agent
2514
+ # # with callbacks. Callbacks can be registered for specific events or for all
2515
+ # # events, including error events.
2516
+ #
2517
+ # # Callbacks can be passed into the `:event_stream_handler` option or within a
2518
+ # # block statement attached to the #invoke_inline_agent call directly. Hybrid
2519
+ # # pattern of both is also supported.
2520
+ #
2521
+ # # `:event_stream_handler` option takes in either a Proc object or
2522
+ # # Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream object.
2523
+ #
2524
+ # # Usage pattern a): Callbacks with a block attached to #invoke_inline_agent
2525
+ # # Example for registering callbacks for all event types and an error event
2526
+ # client.invoke_inline_agent(
2527
+ # # params input
2528
+ # ) do |stream|
2529
+ # stream.on_error_event do |event|
2530
+ # # catch unmodeled error event in the stream
2531
+ # raise event
2532
+ # # => Aws::Errors::EventError
2533
+ # # event.event_type => :error
2534
+ # # event.error_code => String
2535
+ # # event.error_message => String
2522
2536
  # end
2523
2537
  #
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
2538
+ # stream.on_event do |event|
2539
+ # # process all events arrive
2540
+ # puts event.event_type
2541
+ # # ...
2615
2542
  # 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
2543
+ # end
2544
+ #
2545
+ # # Usage pattern b): Pass in `:event_stream_handler` for #invoke_inline_agent
2546
+ # # 1) Create a Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream object
2547
+ # # Example for registering callbacks with specific events
2548
+ #
2549
+ # handler = Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream.new
2550
+ # handler.on_access_denied_exception_event do |event|
2551
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2552
+ # end
2553
+ # handler.on_bad_gateway_exception_event do |event|
2554
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2555
+ # end
2556
+ # handler.on_chunk_event do |event|
2557
+ # event # => Aws::BedrockAgentRuntime::Types::chunk
2558
+ # end
2559
+ # handler.on_conflict_exception_event do |event|
2560
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
2561
+ # end
2562
+ # handler.on_dependency_failed_exception_event do |event|
2563
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2564
+ # end
2565
+ # handler.on_files_event do |event|
2566
+ # event # => Aws::BedrockAgentRuntime::Types::files
2567
+ # end
2568
+ # handler.on_internal_server_exception_event do |event|
2569
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2570
+ # end
2571
+ # handler.on_resource_not_found_exception_event do |event|
2572
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2573
+ # end
2574
+ # handler.on_return_control_event do |event|
2575
+ # event # => Aws::BedrockAgentRuntime::Types::returnControl
2576
+ # end
2577
+ # handler.on_service_quota_exceeded_exception_event do |event|
2578
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2579
+ # end
2580
+ # handler.on_throttling_exception_event do |event|
2581
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2582
+ # end
2583
+ # handler.on_trace_event do |event|
2584
+ # event # => Aws::BedrockAgentRuntime::Types::trace
2585
+ # end
2586
+ # handler.on_validation_exception_event do |event|
2587
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
2588
+ # end
2589
+ #
2590
+ # client.invoke_inline_agent(
2591
+ # # params inputs
2592
+ # event_stream_handler: handler
2593
+ # )
2594
+ #
2595
+ # # 2) Use a Ruby Proc object
2596
+ # # Example for registering callbacks with specific events
2597
+ # handler = Proc.new do |stream|
2598
+ # stream.on_access_denied_exception_event do |event|
2599
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2671
2600
  # end
2601
+ # stream.on_bad_gateway_exception_event do |event|
2602
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2603
+ # end
2604
+ # stream.on_chunk_event do |event|
2605
+ # event # => Aws::BedrockAgentRuntime::Types::chunk
2606
+ # end
2607
+ # stream.on_conflict_exception_event do |event|
2608
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
2609
+ # end
2610
+ # stream.on_dependency_failed_exception_event do |event|
2611
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2612
+ # end
2613
+ # stream.on_files_event do |event|
2614
+ # event # => Aws::BedrockAgentRuntime::Types::files
2615
+ # end
2616
+ # stream.on_internal_server_exception_event do |event|
2617
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2618
+ # end
2619
+ # stream.on_resource_not_found_exception_event do |event|
2620
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2621
+ # end
2622
+ # stream.on_return_control_event do |event|
2623
+ # event # => Aws::BedrockAgentRuntime::Types::returnControl
2624
+ # end
2625
+ # stream.on_service_quota_exceeded_exception_event do |event|
2626
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2627
+ # end
2628
+ # stream.on_throttling_exception_event do |event|
2629
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2630
+ # end
2631
+ # stream.on_trace_event do |event|
2632
+ # event # => Aws::BedrockAgentRuntime::Types::trace
2633
+ # end
2634
+ # stream.on_validation_exception_event do |event|
2635
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
2636
+ # end
2637
+ # end
2638
+ #
2639
+ # client.invoke_inline_agent(
2640
+ # # params inputs
2641
+ # event_stream_handler: handler
2642
+ # )
2643
+ #
2644
+ # # Usage pattern c): Hybrid pattern of a) and b)
2645
+ # handler = Aws::BedrockAgentRuntime::EventStreams::InlineAgentResponseStream.new
2646
+ # handler.on_access_denied_exception_event do |event|
2647
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
2648
+ # end
2649
+ # handler.on_bad_gateway_exception_event do |event|
2650
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
2651
+ # end
2652
+ # handler.on_chunk_event do |event|
2653
+ # event # => Aws::BedrockAgentRuntime::Types::chunk
2654
+ # end
2655
+ # handler.on_conflict_exception_event do |event|
2656
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
2657
+ # end
2658
+ # handler.on_dependency_failed_exception_event do |event|
2659
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
2660
+ # end
2661
+ # handler.on_files_event do |event|
2662
+ # event # => Aws::BedrockAgentRuntime::Types::files
2663
+ # end
2664
+ # handler.on_internal_server_exception_event do |event|
2665
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
2666
+ # end
2667
+ # handler.on_resource_not_found_exception_event do |event|
2668
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
2669
+ # end
2670
+ # handler.on_return_control_event do |event|
2671
+ # event # => Aws::BedrockAgentRuntime::Types::returnControl
2672
+ # end
2673
+ # handler.on_service_quota_exceeded_exception_event do |event|
2674
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
2675
+ # end
2676
+ # handler.on_throttling_exception_event do |event|
2677
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
2678
+ # end
2679
+ # handler.on_trace_event do |event|
2680
+ # event # => Aws::BedrockAgentRuntime::Types::trace
2681
+ # end
2682
+ # handler.on_validation_exception_event do |event|
2683
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
2684
+ # end
2685
+ #
2686
+ # client.invoke_inline_agent(
2687
+ # # params input
2688
+ # event_stream_handler: handler
2689
+ # ) do |stream|
2690
+ # stream.on_error_event do |event|
2691
+ # # catch unmodeled error event in the stream
2692
+ # raise event
2693
+ # # => Aws::Errors::EventError
2694
+ # # event.event_type => :error
2695
+ # # event.error_code => String
2696
+ # # event.error_message => String
2697
+ # end
2698
+ # end
2672
2699
  #
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
2700
+ # # You can also iterate through events after the response complete.
2701
+ # # Events are available at
2702
+ # resp.completion # => Enumerator
2703
+ # # For parameter input example, please refer to following request syntax.
2677
2704
  #
2678
2705
  # @example Request syntax with placeholder values
2679
2706
  #
@@ -2716,6 +2743,7 @@ module Aws::BedrockAgentRuntime
2716
2743
  # },
2717
2744
  # ],
2718
2745
  # agent_collaboration: "SUPERVISOR", # accepts SUPERVISOR, SUPERVISOR_ROUTER, DISABLED
2746
+ # agent_name: "Name",
2719
2747
  # bedrock_model_configurations: {
2720
2748
  # performance_config: {
2721
2749
  # latency: "standard", # accepts standard, optimized
@@ -2927,6 +2955,11 @@ module Aws::BedrockAgentRuntime
2927
2955
  # },
2928
2956
  # },
2929
2957
  # ],
2958
+ # custom_orchestration: {
2959
+ # executor: {
2960
+ # lambda: "LambdaArn",
2961
+ # },
2962
+ # },
2930
2963
  # customer_encryption_key_arn: "KmsKeyArn",
2931
2964
  # enable_trace: false,
2932
2965
  # end_session: false,
@@ -3138,6 +3171,7 @@ module Aws::BedrockAgentRuntime
3138
3171
  # },
3139
3172
  # },
3140
3173
  # ],
3174
+ # orchestration_type: "DEFAULT", # accepts DEFAULT, CUSTOM_ORCHESTRATION
3141
3175
  # prompt_override_configuration: {
3142
3176
  # override_lambda: "LambdaResourceArn",
3143
3177
  # prompt_configurations: [ # required
@@ -3169,18 +3203,18 @@ module Aws::BedrockAgentRuntime
3169
3203
  #
3170
3204
  # @example Response structure
3171
3205
  #
3172
- # All events are available at resp.completion:
3206
+ # # All events are available at resp.completion:
3173
3207
  # resp.completion #=> Enumerator
3174
3208
  # 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
3209
  #
3176
- # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
3210
+ # # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
3177
3211
  # event.message #=> String
3178
3212
  #
3179
- # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
3213
+ # # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
3180
3214
  # event.message #=> String
3181
3215
  # event.resource_name #=> String
3182
3216
  #
3183
- # For :chunk event available at #on_chunk_event callback and response eventstream enumerator:
3217
+ # # For :chunk event available at #on_chunk_event callback and response eventstream enumerator:
3184
3218
  # event.attribution.citations #=> Array
3185
3219
  # event.attribution.citations[0].generated_response_part.text_response_part.span.end #=> Integer
3186
3220
  # event.attribution.citations[0].generated_response_part.text_response_part.span.start #=> Integer
@@ -3205,27 +3239,27 @@ module Aws::BedrockAgentRuntime
3205
3239
  # event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
3206
3240
  # event.bytes #=> String
3207
3241
  #
3208
- # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
3242
+ # # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
3209
3243
  # event.message #=> String
3210
3244
  #
3211
- # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
3245
+ # # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
3212
3246
  # event.message #=> String
3213
3247
  # event.resource_name #=> String
3214
3248
  #
3215
- # For :files event available at #on_files_event callback and response eventstream enumerator:
3249
+ # # For :files event available at #on_files_event callback and response eventstream enumerator:
3216
3250
  # event.files #=> Array
3217
3251
  # event.files[0].bytes #=> String
3218
3252
  # event.files[0].name #=> String
3219
3253
  # event.files[0].type #=> String
3220
3254
  #
3221
- # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
3255
+ # # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
3222
3256
  # event.message #=> String
3223
3257
  # event.reason #=> String
3224
3258
  #
3225
- # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
3259
+ # # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
3226
3260
  # event.message #=> String
3227
3261
  #
3228
- # For :return_control event available at #on_return_control_event callback and response eventstream enumerator:
3262
+ # # For :return_control event available at #on_return_control_event callback and response eventstream enumerator:
3229
3263
  # event.invocation_id #=> String
3230
3264
  # event.invocation_inputs #=> Array
3231
3265
  # event.invocation_inputs[0].api_invocation_input.action_group #=> String
@@ -3253,13 +3287,17 @@ module Aws::BedrockAgentRuntime
3253
3287
  # event.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
3254
3288
  # event.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
3255
3289
  #
3256
- # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
3290
+ # # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
3257
3291
  # event.message #=> String
3258
3292
  #
3259
- # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
3293
+ # # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
3260
3294
  # event.message #=> String
3261
3295
  #
3262
- # For :trace event available at #on_trace_event callback and response eventstream enumerator:
3296
+ # # For :trace event available at #on_trace_event callback and response eventstream enumerator:
3297
+ # event.caller_chain #=> Array
3298
+ # event.caller_chain[0].agent_alias_arn #=> String
3299
+ # event.collaborator_name #=> String
3300
+ # event.event_time #=> Time
3263
3301
  # event.session_id #=> String
3264
3302
  # event.trace.custom_orchestration_trace.event.text #=> String
3265
3303
  # event.trace.custom_orchestration_trace.trace_id #=> String
@@ -3618,7 +3656,7 @@ module Aws::BedrockAgentRuntime
3618
3656
  # event.trace.routing_classifier_trace.observation.trace_id #=> String
3619
3657
  # event.trace.routing_classifier_trace.observation.type #=> String, one of "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
3620
3658
  #
3621
- # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
3659
+ # # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
3622
3660
  # event.message #=> String
3623
3661
  #
3624
3662
  # resp.content_type #=> String
@@ -3876,149 +3914,155 @@ module Aws::BedrockAgentRuntime
3876
3914
  #
3877
3915
  # @example EventStream Operation Example
3878
3916
  #
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
- #
3917
+ # # You can process the event once it arrives immediately, or wait until the
3918
+ # # full response is complete and iterate through the eventstream enumerator.
3919
+ #
3920
+ # # To interact with event immediately, you need to register optimize_prompt
3921
+ # # with callbacks. Callbacks can be registered for specific events or for all
3922
+ # # events, including error events.
3923
+ #
3924
+ # # Callbacks can be passed into the `:event_stream_handler` option or within a
3925
+ # # block statement attached to the #optimize_prompt call directly. Hybrid
3926
+ # # pattern of both is also supported.
3927
+ #
3928
+ # # `:event_stream_handler` option takes in either a Proc object or
3929
+ # # Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream object.
3930
+ #
3931
+ # # Usage pattern a): Callbacks with a block attached to #optimize_prompt
3932
+ # # Example for registering callbacks for all event types and an error event
3933
+ # client.optimize_prompt(
3934
+ # # params input
3935
+ # ) do |stream|
3936
+ # stream.on_error_event do |event|
3937
+ # # catch unmodeled error event in the stream
3938
+ # raise event
3939
+ # # => Aws::Errors::EventError
3940
+ # # event.event_type => :error
3941
+ # # event.error_code => String
3942
+ # # event.error_message => String
3912
3943
  # end
3913
3944
  #
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
3945
+ # stream.on_event do |event|
3946
+ # # process all events arrive
3947
+ # puts event.event_type
3948
+ # # ...
3975
3949
  # 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
3950
+ # end
3951
+ #
3952
+ # # Usage pattern b): Pass in `:event_stream_handler` for #optimize_prompt
3953
+ # # 1) Create a Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream object
3954
+ # # Example for registering callbacks with specific events
3955
+ #
3956
+ # handler = Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream.new
3957
+ # handler.on_access_denied_exception_event do |event|
3958
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
3959
+ # end
3960
+ # handler.on_analyze_prompt_event_event do |event|
3961
+ # event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
3962
+ # end
3963
+ # handler.on_bad_gateway_exception_event do |event|
3964
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
3965
+ # end
3966
+ # handler.on_dependency_failed_exception_event do |event|
3967
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
3968
+ # end
3969
+ # handler.on_internal_server_exception_event do |event|
3970
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
3971
+ # end
3972
+ # handler.on_optimized_prompt_event_event do |event|
3973
+ # event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
3974
+ # end
3975
+ # handler.on_throttling_exception_event do |event|
3976
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
3977
+ # end
3978
+ # handler.on_validation_exception_event do |event|
3979
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
3980
+ # end
3981
+ #
3982
+ # client.optimize_prompt(
3983
+ # # params inputs
3984
+ # event_stream_handler: handler
3985
+ # )
3986
+ #
3987
+ # # 2) Use a Ruby Proc object
3988
+ # # Example for registering callbacks with specific events
3989
+ # handler = Proc.new do |stream|
3990
+ # stream.on_access_denied_exception_event do |event|
3991
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4016
3992
  # end
3993
+ # stream.on_analyze_prompt_event_event do |event|
3994
+ # event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
3995
+ # end
3996
+ # stream.on_bad_gateway_exception_event do |event|
3997
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
3998
+ # end
3999
+ # stream.on_dependency_failed_exception_event do |event|
4000
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4001
+ # end
4002
+ # stream.on_internal_server_exception_event do |event|
4003
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4004
+ # end
4005
+ # stream.on_optimized_prompt_event_event do |event|
4006
+ # event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
4007
+ # end
4008
+ # stream.on_throttling_exception_event do |event|
4009
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4010
+ # end
4011
+ # stream.on_validation_exception_event do |event|
4012
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
4013
+ # end
4014
+ # end
4015
+ #
4016
+ # client.optimize_prompt(
4017
+ # # params inputs
4018
+ # event_stream_handler: handler
4019
+ # )
4020
+ #
4021
+ # # Usage pattern c): Hybrid pattern of a) and b)
4022
+ # handler = Aws::BedrockAgentRuntime::EventStreams::OptimizedPromptStream.new
4023
+ # handler.on_access_denied_exception_event do |event|
4024
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4025
+ # end
4026
+ # handler.on_analyze_prompt_event_event do |event|
4027
+ # event # => Aws::BedrockAgentRuntime::Types::analyzePromptEvent
4028
+ # end
4029
+ # handler.on_bad_gateway_exception_event do |event|
4030
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
4031
+ # end
4032
+ # handler.on_dependency_failed_exception_event do |event|
4033
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4034
+ # end
4035
+ # handler.on_internal_server_exception_event do |event|
4036
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4037
+ # end
4038
+ # handler.on_optimized_prompt_event_event do |event|
4039
+ # event # => Aws::BedrockAgentRuntime::Types::optimizedPromptEvent
4040
+ # end
4041
+ # handler.on_throttling_exception_event do |event|
4042
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4043
+ # end
4044
+ # handler.on_validation_exception_event do |event|
4045
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
4046
+ # end
4047
+ #
4048
+ # client.optimize_prompt(
4049
+ # # params input
4050
+ # event_stream_handler: handler
4051
+ # ) do |stream|
4052
+ # stream.on_error_event do |event|
4053
+ # # catch unmodeled error event in the stream
4054
+ # raise event
4055
+ # # => Aws::Errors::EventError
4056
+ # # event.event_type => :error
4057
+ # # event.error_code => String
4058
+ # # event.error_message => String
4059
+ # end
4060
+ # end
4017
4061
  #
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
4062
+ # # You can also iterate through events after the response complete.
4063
+ # # Events are available at
4064
+ # resp.optimized_prompt # => Enumerator
4065
+ # # For parameter input example, please refer to following request syntax.
4022
4066
  #
4023
4067
  # @example Request syntax with placeholder values
4024
4068
  #
@@ -4033,35 +4077,35 @@ module Aws::BedrockAgentRuntime
4033
4077
  #
4034
4078
  # @example Response structure
4035
4079
  #
4036
- # All events are available at resp.optimized_prompt:
4080
+ # # All events are available at resp.optimized_prompt:
4037
4081
  # resp.optimized_prompt #=> Enumerator
4038
4082
  # 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
4083
  #
4040
- # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
4084
+ # # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
4041
4085
  # event.message #=> String
4042
4086
  #
4043
- # For :analyze_prompt_event event available at #on_analyze_prompt_event_event callback and response eventstream enumerator:
4087
+ # # For :analyze_prompt_event event available at #on_analyze_prompt_event_event callback and response eventstream enumerator:
4044
4088
  # event.message #=> String
4045
4089
  #
4046
- # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
4090
+ # # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
4047
4091
  # event.message #=> String
4048
4092
  # event.resource_name #=> String
4049
4093
  #
4050
- # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
4094
+ # # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
4051
4095
  # event.message #=> String
4052
4096
  # event.resource_name #=> String
4053
4097
  #
4054
- # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
4098
+ # # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
4055
4099
  # event.message #=> String
4056
4100
  # event.reason #=> String
4057
4101
  #
4058
- # For :optimized_prompt_event event available at #on_optimized_prompt_event_event callback and response eventstream enumerator:
4102
+ # # For :optimized_prompt_event event available at #on_optimized_prompt_event_event callback and response eventstream enumerator:
4059
4103
  # event.optimized_prompt.text_prompt.text #=> String
4060
4104
  #
4061
- # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
4105
+ # # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
4062
4106
  # event.message #=> String
4063
4107
  #
4064
- # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
4108
+ # # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
4065
4109
  # event.message #=> String
4066
4110
  #
4067
4111
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/OptimizePrompt AWS API Documentation
@@ -4786,185 +4830,191 @@ module Aws::BedrockAgentRuntime
4786
4830
  #
4787
4831
  # @example EventStream Operation Example
4788
4832
  #
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
- #
4833
+ # # You can process the event once it arrives immediately, or wait until the
4834
+ # # full response is complete and iterate through the eventstream enumerator.
4835
+ #
4836
+ # # To interact with event immediately, you need to register retrieve_and_generate_stream
4837
+ # # with callbacks. Callbacks can be registered for specific events or for all
4838
+ # # events, including error events.
4839
+ #
4840
+ # # Callbacks can be passed into the `:event_stream_handler` option or within a
4841
+ # # block statement attached to the #retrieve_and_generate_stream call directly. Hybrid
4842
+ # # pattern of both is also supported.
4843
+ #
4844
+ # # `:event_stream_handler` option takes in either a Proc object or
4845
+ # # Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput object.
4846
+ #
4847
+ # # Usage pattern a): Callbacks with a block attached to #retrieve_and_generate_stream
4848
+ # # Example for registering callbacks for all event types and an error event
4849
+ # client.retrieve_and_generate_stream(
4850
+ # # params input
4851
+ # ) do |stream|
4852
+ # stream.on_error_event do |event|
4853
+ # # catch unmodeled error event in the stream
4854
+ # raise event
4855
+ # # => Aws::Errors::EventError
4856
+ # # event.event_type => :error
4857
+ # # event.error_code => String
4858
+ # # event.error_message => String
4822
4859
  # end
4823
4860
  #
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
4861
+ # stream.on_event do |event|
4862
+ # # process all events arrive
4863
+ # puts event.event_type
4864
+ # # ...
4909
4865
  # 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
4866
+ # end
4867
+ #
4868
+ # # Usage pattern b): Pass in `:event_stream_handler` for #retrieve_and_generate_stream
4869
+ # # 1) Create a Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput object
4870
+ # # Example for registering callbacks with specific events
4871
+ #
4872
+ # handler = Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput.new
4873
+ # handler.on_access_denied_exception_event do |event|
4874
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4875
+ # end
4876
+ # handler.on_bad_gateway_exception_event do |event|
4877
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
4878
+ # end
4879
+ # handler.on_citation_event do |event|
4880
+ # event # => Aws::BedrockAgentRuntime::Types::citation
4881
+ # end
4882
+ # handler.on_conflict_exception_event do |event|
4883
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
4884
+ # end
4885
+ # handler.on_dependency_failed_exception_event do |event|
4886
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4887
+ # end
4888
+ # handler.on_guardrail_event do |event|
4889
+ # event # => Aws::BedrockAgentRuntime::Types::guardrail
4890
+ # end
4891
+ # handler.on_internal_server_exception_event do |event|
4892
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4893
+ # end
4894
+ # handler.on_output_event do |event|
4895
+ # event # => Aws::BedrockAgentRuntime::Types::output
4896
+ # end
4897
+ # handler.on_resource_not_found_exception_event do |event|
4898
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
4899
+ # end
4900
+ # handler.on_service_quota_exceeded_exception_event do |event|
4901
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
4902
+ # end
4903
+ # handler.on_throttling_exception_event do |event|
4904
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4905
+ # end
4906
+ # handler.on_validation_exception_event do |event|
4907
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
4908
+ # end
4909
+ #
4910
+ # client.retrieve_and_generate_stream(
4911
+ # # params inputs
4912
+ # event_stream_handler: handler
4913
+ # )
4914
+ #
4915
+ # # 2) Use a Ruby Proc object
4916
+ # # Example for registering callbacks with specific events
4917
+ # handler = Proc.new do |stream|
4918
+ # stream.on_access_denied_exception_event do |event|
4919
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4962
4920
  # end
4921
+ # stream.on_bad_gateway_exception_event do |event|
4922
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
4923
+ # end
4924
+ # stream.on_citation_event do |event|
4925
+ # event # => Aws::BedrockAgentRuntime::Types::citation
4926
+ # end
4927
+ # stream.on_conflict_exception_event do |event|
4928
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
4929
+ # end
4930
+ # stream.on_dependency_failed_exception_event do |event|
4931
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4932
+ # end
4933
+ # stream.on_guardrail_event do |event|
4934
+ # event # => Aws::BedrockAgentRuntime::Types::guardrail
4935
+ # end
4936
+ # stream.on_internal_server_exception_event do |event|
4937
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4938
+ # end
4939
+ # stream.on_output_event do |event|
4940
+ # event # => Aws::BedrockAgentRuntime::Types::output
4941
+ # end
4942
+ # stream.on_resource_not_found_exception_event do |event|
4943
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
4944
+ # end
4945
+ # stream.on_service_quota_exceeded_exception_event do |event|
4946
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
4947
+ # end
4948
+ # stream.on_throttling_exception_event do |event|
4949
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4950
+ # end
4951
+ # stream.on_validation_exception_event do |event|
4952
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
4953
+ # end
4954
+ # end
4955
+ #
4956
+ # client.retrieve_and_generate_stream(
4957
+ # # params inputs
4958
+ # event_stream_handler: handler
4959
+ # )
4960
+ #
4961
+ # # Usage pattern c): Hybrid pattern of a) and b)
4962
+ # handler = Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput.new
4963
+ # handler.on_access_denied_exception_event do |event|
4964
+ # event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
4965
+ # end
4966
+ # handler.on_bad_gateway_exception_event do |event|
4967
+ # event # => Aws::BedrockAgentRuntime::Types::badGatewayException
4968
+ # end
4969
+ # handler.on_citation_event do |event|
4970
+ # event # => Aws::BedrockAgentRuntime::Types::citation
4971
+ # end
4972
+ # handler.on_conflict_exception_event do |event|
4973
+ # event # => Aws::BedrockAgentRuntime::Types::conflictException
4974
+ # end
4975
+ # handler.on_dependency_failed_exception_event do |event|
4976
+ # event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
4977
+ # end
4978
+ # handler.on_guardrail_event do |event|
4979
+ # event # => Aws::BedrockAgentRuntime::Types::guardrail
4980
+ # end
4981
+ # handler.on_internal_server_exception_event do |event|
4982
+ # event # => Aws::BedrockAgentRuntime::Types::internalServerException
4983
+ # end
4984
+ # handler.on_output_event do |event|
4985
+ # event # => Aws::BedrockAgentRuntime::Types::output
4986
+ # end
4987
+ # handler.on_resource_not_found_exception_event do |event|
4988
+ # event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
4989
+ # end
4990
+ # handler.on_service_quota_exceeded_exception_event do |event|
4991
+ # event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
4992
+ # end
4993
+ # handler.on_throttling_exception_event do |event|
4994
+ # event # => Aws::BedrockAgentRuntime::Types::throttlingException
4995
+ # end
4996
+ # handler.on_validation_exception_event do |event|
4997
+ # event # => Aws::BedrockAgentRuntime::Types::validationException
4998
+ # end
4999
+ #
5000
+ # client.retrieve_and_generate_stream(
5001
+ # # params input
5002
+ # event_stream_handler: handler
5003
+ # ) do |stream|
5004
+ # stream.on_error_event do |event|
5005
+ # # catch unmodeled error event in the stream
5006
+ # raise event
5007
+ # # => Aws::Errors::EventError
5008
+ # # event.event_type => :error
5009
+ # # event.error_code => String
5010
+ # # event.error_message => String
5011
+ # end
5012
+ # end
4963
5013
  #
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
5014
+ # # You can also iterate through events after the response complete.
5015
+ # # Events are available at
5016
+ # resp.stream # => Enumerator
5017
+ # # For parameter input example, please refer to following request syntax.
4968
5018
  #
4969
5019
  # @example Request syntax with placeholder values
4970
5020
  #
@@ -5186,18 +5236,18 @@ module Aws::BedrockAgentRuntime
5186
5236
  # @example Response structure
5187
5237
  #
5188
5238
  # resp.session_id #=> String
5189
- # All events are available at resp.stream:
5239
+ # # All events are available at resp.stream:
5190
5240
  # resp.stream #=> Enumerator
5191
5241
  # 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
5242
  #
5193
- # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
5243
+ # # For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
5194
5244
  # event.message #=> String
5195
5245
  #
5196
- # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
5246
+ # # For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
5197
5247
  # event.message #=> String
5198
5248
  # event.resource_name #=> String
5199
5249
  #
5200
- # For :citation event available at #on_citation_event callback and response eventstream enumerator:
5250
+ # # For :citation event available at #on_citation_event callback and response eventstream enumerator:
5201
5251
  # event.citation.generated_response_part.text_response_part.span.end #=> Integer
5202
5252
  # event.citation.generated_response_part.text_response_part.span.start #=> Integer
5203
5253
  # event.citation.generated_response_part.text_response_part.text #=> String
@@ -5241,33 +5291,33 @@ module Aws::BedrockAgentRuntime
5241
5291
  # event.retrieved_references[0].location.web_location.url #=> String
5242
5292
  # event.retrieved_references[0].metadata #=> Hash
5243
5293
  #
5244
- # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
5294
+ # # For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
5245
5295
  # event.message #=> String
5246
5296
  #
5247
- # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
5297
+ # # For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
5248
5298
  # event.message #=> String
5249
5299
  # event.resource_name #=> String
5250
5300
  #
5251
- # For :guardrail event available at #on_guardrail_event callback and response eventstream enumerator:
5301
+ # # For :guardrail event available at #on_guardrail_event callback and response eventstream enumerator:
5252
5302
  # event.action #=> String, one of "INTERVENED", "NONE"
5253
5303
  #
5254
- # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
5304
+ # # For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
5255
5305
  # event.message #=> String
5256
5306
  # event.reason #=> String
5257
5307
  #
5258
- # For :output event available at #on_output_event callback and response eventstream enumerator:
5308
+ # # For :output event available at #on_output_event callback and response eventstream enumerator:
5259
5309
  # event.text #=> String
5260
5310
  #
5261
- # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
5311
+ # # For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
5262
5312
  # event.message #=> String
5263
5313
  #
5264
- # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
5314
+ # # For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
5265
5315
  # event.message #=> String
5266
5316
  #
5267
- # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
5317
+ # # For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
5268
5318
  # event.message #=> String
5269
5319
  #
5270
- # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
5320
+ # # For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
5271
5321
  # event.message #=> String
5272
5322
  #
5273
5323
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream AWS API Documentation
@@ -5427,7 +5477,7 @@ module Aws::BedrockAgentRuntime
5427
5477
  tracer: tracer
5428
5478
  )
5429
5479
  context[:gem_name] = 'aws-sdk-bedrockagentruntime'
5430
- context[:gem_version] = '1.50.0'
5480
+ context[:gem_version] = '1.52.0'
5431
5481
  Seahorse::Client::Request.new(handlers, context)
5432
5482
  end
5433
5483