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