aws-sdk-bedrockagentruntime 1.34.0 → 1.36.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 +1141 -11
- data/lib/aws-sdk-bedrockagentruntime/client_api.rb +319 -0
- data/lib/aws-sdk-bedrockagentruntime/event_streams.rb +89 -0
- data/lib/aws-sdk-bedrockagentruntime/types.rb +902 -7
- data/lib/aws-sdk-bedrockagentruntime.rb +1 -1
- data/sig/client.rbs +414 -4
- data/sig/types.rbs +283 -7
- metadata +2 -2
|
@@ -637,6 +637,9 @@ module Aws::BedrockAgentRuntime
|
|
|
637
637
|
#
|
|
638
638
|
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html
|
|
639
639
|
#
|
|
640
|
+
# @option params [String] :source_arn
|
|
641
|
+
# The ARN of the resource making the request.
|
|
642
|
+
#
|
|
640
643
|
# @option params [Types::StreamingConfigurations] :streaming_configurations
|
|
641
644
|
# Specifies the configurations for streaming.
|
|
642
645
|
#
|
|
@@ -849,6 +852,18 @@ module Aws::BedrockAgentRuntime
|
|
|
849
852
|
# memory_id: "MemoryId",
|
|
850
853
|
# session_id: "SessionId", # required
|
|
851
854
|
# session_state: {
|
|
855
|
+
# conversation_history: {
|
|
856
|
+
# messages: [
|
|
857
|
+
# {
|
|
858
|
+
# content: [ # required
|
|
859
|
+
# {
|
|
860
|
+
# text: "String",
|
|
861
|
+
# },
|
|
862
|
+
# ],
|
|
863
|
+
# role: "user", # required, accepts user, assistant
|
|
864
|
+
# },
|
|
865
|
+
# ],
|
|
866
|
+
# },
|
|
852
867
|
# files: [
|
|
853
868
|
# {
|
|
854
869
|
# name: "String", # required
|
|
@@ -938,8 +953,46 @@ module Aws::BedrockAgentRuntime
|
|
|
938
953
|
# },
|
|
939
954
|
# },
|
|
940
955
|
# },
|
|
956
|
+
# implicit_filter_configuration: {
|
|
957
|
+
# metadata_attributes: [ # required
|
|
958
|
+
# {
|
|
959
|
+
# description: "MetadataAttributeSchemaDescriptionString", # required
|
|
960
|
+
# key: "MetadataAttributeSchemaKeyString", # required
|
|
961
|
+
# type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
|
|
962
|
+
# },
|
|
963
|
+
# ],
|
|
964
|
+
# model_arn: "BedrockModelArn", # required
|
|
965
|
+
# },
|
|
941
966
|
# number_of_results: 1,
|
|
942
967
|
# override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
968
|
+
# reranking_configuration: {
|
|
969
|
+
# bedrock_reranking_configuration: {
|
|
970
|
+
# metadata_configuration: {
|
|
971
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
|
972
|
+
# selective_mode_configuration: {
|
|
973
|
+
# fields_to_exclude: [
|
|
974
|
+
# {
|
|
975
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
976
|
+
# },
|
|
977
|
+
# ],
|
|
978
|
+
# fields_to_include: [
|
|
979
|
+
# {
|
|
980
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
981
|
+
# },
|
|
982
|
+
# ],
|
|
983
|
+
# },
|
|
984
|
+
# },
|
|
985
|
+
# model_configuration: { # required
|
|
986
|
+
# additional_model_request_fields: {
|
|
987
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
988
|
+
# },
|
|
989
|
+
# },
|
|
990
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
|
991
|
+
# },
|
|
992
|
+
# number_of_reranked_results: 1,
|
|
993
|
+
# },
|
|
994
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
995
|
+
# },
|
|
943
996
|
# },
|
|
944
997
|
# },
|
|
945
998
|
# },
|
|
@@ -951,6 +1004,7 @@ module Aws::BedrockAgentRuntime
|
|
|
951
1004
|
# {
|
|
952
1005
|
# api_result: {
|
|
953
1006
|
# action_group: "String", # required
|
|
1007
|
+
# agent_id: "String",
|
|
954
1008
|
# api_path: "ApiPath",
|
|
955
1009
|
# confirmation_state: "CONFIRM", # accepts CONFIRM, DENY
|
|
956
1010
|
# http_method: "String",
|
|
@@ -964,6 +1018,7 @@ module Aws::BedrockAgentRuntime
|
|
|
964
1018
|
# },
|
|
965
1019
|
# function_result: {
|
|
966
1020
|
# action_group: "String", # required
|
|
1021
|
+
# agent_id: "String",
|
|
967
1022
|
# confirmation_state: "CONFIRM", # accepts CONFIRM, DENY
|
|
968
1023
|
# function: "String",
|
|
969
1024
|
# response_body: {
|
|
@@ -979,6 +1034,7 @@ module Aws::BedrockAgentRuntime
|
|
|
979
1034
|
# "String" => "String",
|
|
980
1035
|
# },
|
|
981
1036
|
# },
|
|
1037
|
+
# source_arn: "AWSResourceARN",
|
|
982
1038
|
# streaming_configurations: {
|
|
983
1039
|
# apply_guardrail_interval: 1,
|
|
984
1040
|
# stream_final_response: false,
|
|
@@ -1006,10 +1062,11 @@ module Aws::BedrockAgentRuntime
|
|
|
1006
1062
|
# event.attribution.citations[0].retrieved_references #=> Array
|
|
1007
1063
|
# event.attribution.citations[0].retrieved_references[0].content.text #=> String
|
|
1008
1064
|
# event.attribution.citations[0].retrieved_references[0].location.confluence_location.url #=> String
|
|
1065
|
+
# event.attribution.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
|
|
1009
1066
|
# event.attribution.citations[0].retrieved_references[0].location.s3_location.uri #=> String
|
|
1010
1067
|
# event.attribution.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
|
|
1011
1068
|
# event.attribution.citations[0].retrieved_references[0].location.share_point_location.url #=> String
|
|
1012
|
-
# event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT"
|
|
1069
|
+
# event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM"
|
|
1013
1070
|
# event.attribution.citations[0].retrieved_references[0].location.web_location.url #=> String
|
|
1014
1071
|
# event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
|
|
1015
1072
|
# event.bytes #=> String
|
|
@@ -1038,7 +1095,9 @@ module Aws::BedrockAgentRuntime
|
|
|
1038
1095
|
# event.invocation_inputs #=> Array
|
|
1039
1096
|
# event.invocation_inputs[0].api_invocation_input.action_group #=> String
|
|
1040
1097
|
# event.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
1098
|
+
# event.invocation_inputs[0].api_invocation_input.agent_id #=> String
|
|
1041
1099
|
# event.invocation_inputs[0].api_invocation_input.api_path #=> String
|
|
1100
|
+
# event.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
|
|
1042
1101
|
# event.invocation_inputs[0].api_invocation_input.http_method #=> String
|
|
1043
1102
|
# event.invocation_inputs[0].api_invocation_input.parameters #=> Array
|
|
1044
1103
|
# event.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
|
|
@@ -1051,6 +1110,8 @@ module Aws::BedrockAgentRuntime
|
|
|
1051
1110
|
# event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
|
|
1052
1111
|
# event.invocation_inputs[0].function_invocation_input.action_group #=> String
|
|
1053
1112
|
# event.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
1113
|
+
# event.invocation_inputs[0].function_invocation_input.agent_id #=> String
|
|
1114
|
+
# event.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
|
|
1054
1115
|
# event.invocation_inputs[0].function_invocation_input.function #=> String
|
|
1055
1116
|
# event.invocation_inputs[0].function_invocation_input.parameters #=> Array
|
|
1056
1117
|
# event.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
|
|
@@ -1067,6 +1128,9 @@ module Aws::BedrockAgentRuntime
|
|
|
1067
1128
|
# event.agent_alias_id #=> String
|
|
1068
1129
|
# event.agent_id #=> String
|
|
1069
1130
|
# event.agent_version #=> String
|
|
1131
|
+
# event.caller_chain #=> Array
|
|
1132
|
+
# event.caller_chain[0].agent_alias_arn #=> String
|
|
1133
|
+
# event.collaborator_name #=> String
|
|
1070
1134
|
# event.session_id #=> String
|
|
1071
1135
|
# event.trace.custom_orchestration_trace.event.text #=> String
|
|
1072
1136
|
# event.trace.custom_orchestration_trace.trace_id #=> String
|
|
@@ -1139,13 +1203,36 @@ module Aws::BedrockAgentRuntime
|
|
|
1139
1203
|
# event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].type #=> String
|
|
1140
1204
|
# event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].value #=> String
|
|
1141
1205
|
# event.trace.orchestration_trace.invocation_input.action_group_invocation_input.verb #=> String
|
|
1206
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_alias_arn #=> String
|
|
1207
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_name #=> String
|
|
1208
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.invocation_id #=> String
|
|
1209
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results #=> Array
|
|
1210
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.action_group #=> String
|
|
1211
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.agent_id #=> String
|
|
1212
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.api_path #=> String
|
|
1213
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
|
|
1214
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_method #=> String
|
|
1215
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_status_code #=> Integer
|
|
1216
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body #=> Hash
|
|
1217
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body["String"].body #=> String
|
|
1218
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_state #=> String, one of "FAILURE", "REPROMPT"
|
|
1219
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.action_group #=> String
|
|
1220
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.agent_id #=> String
|
|
1221
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
|
|
1222
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.function #=> String
|
|
1223
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body #=> Hash
|
|
1224
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body["String"].body #=> String
|
|
1225
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_state #=> String, one of "FAILURE", "REPROMPT"
|
|
1226
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.text #=> String
|
|
1227
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.type #=> String, one of "TEXT", "RETURN_CONTROL"
|
|
1142
1228
|
# event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.code #=> String
|
|
1143
1229
|
# event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.files #=> Array
|
|
1144
1230
|
# event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.files[0] #=> String
|
|
1145
|
-
# event.trace.orchestration_trace.invocation_input.invocation_type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ACTION_GROUP_CODE_INTERPRETER"
|
|
1231
|
+
# event.trace.orchestration_trace.invocation_input.invocation_type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ACTION_GROUP_CODE_INTERPRETER", "AGENT_COLLABORATOR"
|
|
1146
1232
|
# event.trace.orchestration_trace.invocation_input.knowledge_base_lookup_input.knowledge_base_id #=> String
|
|
1147
1233
|
# event.trace.orchestration_trace.invocation_input.knowledge_base_lookup_input.text #=> String
|
|
1148
1234
|
# event.trace.orchestration_trace.invocation_input.trace_id #=> String
|
|
1235
|
+
# event.trace.orchestration_trace.model_invocation_input.foundation_model #=> String
|
|
1149
1236
|
# event.trace.orchestration_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
|
|
1150
1237
|
# event.trace.orchestration_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
|
|
1151
1238
|
# event.trace.orchestration_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
|
|
@@ -1163,6 +1250,36 @@ module Aws::BedrockAgentRuntime
|
|
|
1163
1250
|
# event.trace.orchestration_trace.model_invocation_output.raw_response.content #=> String
|
|
1164
1251
|
# event.trace.orchestration_trace.model_invocation_output.trace_id #=> String
|
|
1165
1252
|
# event.trace.orchestration_trace.observation.action_group_invocation_output.text #=> String
|
|
1253
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.agent_collaborator_alias_arn #=> String
|
|
1254
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.agent_collaborator_name #=> String
|
|
1255
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_id #=> String
|
|
1256
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs #=> Array
|
|
1257
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_group #=> String
|
|
1258
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
1259
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.agent_id #=> String
|
|
1260
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.api_path #=> String
|
|
1261
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
|
|
1262
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.http_method #=> String
|
|
1263
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters #=> Array
|
|
1264
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
|
|
1265
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].type #=> String
|
|
1266
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].value #=> String
|
|
1267
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content #=> Hash
|
|
1268
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties #=> Array
|
|
1269
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].name #=> String
|
|
1270
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].type #=> String
|
|
1271
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
|
|
1272
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_group #=> String
|
|
1273
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
1274
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.agent_id #=> String
|
|
1275
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
|
|
1276
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.function #=> String
|
|
1277
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters #=> Array
|
|
1278
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
|
|
1279
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
|
|
1280
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
|
|
1281
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.text #=> String
|
|
1282
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.type #=> String, one of "TEXT", "RETURN_CONTROL"
|
|
1166
1283
|
# event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_error #=> String
|
|
1167
1284
|
# event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_output #=> String
|
|
1168
1285
|
# event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_timeout #=> Boolean
|
|
@@ -1172,18 +1289,20 @@ module Aws::BedrockAgentRuntime
|
|
|
1172
1289
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
|
|
1173
1290
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
|
|
1174
1291
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
1292
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
1175
1293
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
1176
1294
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
1177
1295
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
1178
|
-
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT"
|
|
1296
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM"
|
|
1179
1297
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
1180
1298
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
1181
1299
|
# event.trace.orchestration_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
1182
1300
|
# event.trace.orchestration_trace.observation.reprompt_response.text #=> String
|
|
1183
1301
|
# event.trace.orchestration_trace.observation.trace_id #=> String
|
|
1184
|
-
# event.trace.orchestration_trace.observation.type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
|
|
1302
|
+
# event.trace.orchestration_trace.observation.type #=> String, one of "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
|
|
1185
1303
|
# event.trace.orchestration_trace.rationale.text #=> String
|
|
1186
1304
|
# event.trace.orchestration_trace.rationale.trace_id #=> String
|
|
1305
|
+
# event.trace.post_processing_trace.model_invocation_input.foundation_model #=> String
|
|
1187
1306
|
# event.trace.post_processing_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
|
|
1188
1307
|
# event.trace.post_processing_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
|
|
1189
1308
|
# event.trace.post_processing_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
|
|
@@ -1201,6 +1320,7 @@ module Aws::BedrockAgentRuntime
|
|
|
1201
1320
|
# event.trace.post_processing_trace.model_invocation_output.parsed_response.text #=> String
|
|
1202
1321
|
# event.trace.post_processing_trace.model_invocation_output.raw_response.content #=> String
|
|
1203
1322
|
# event.trace.post_processing_trace.model_invocation_output.trace_id #=> String
|
|
1323
|
+
# event.trace.pre_processing_trace.model_invocation_input.foundation_model #=> String
|
|
1204
1324
|
# event.trace.pre_processing_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
|
|
1205
1325
|
# event.trace.pre_processing_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
|
|
1206
1326
|
# event.trace.pre_processing_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
|
|
@@ -1219,6 +1339,118 @@ module Aws::BedrockAgentRuntime
|
|
|
1219
1339
|
# event.trace.pre_processing_trace.model_invocation_output.parsed_response.rationale #=> String
|
|
1220
1340
|
# event.trace.pre_processing_trace.model_invocation_output.raw_response.content #=> String
|
|
1221
1341
|
# event.trace.pre_processing_trace.model_invocation_output.trace_id #=> String
|
|
1342
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.action_group_name #=> String
|
|
1343
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.api_path #=> String
|
|
1344
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.execution_type #=> String, one of "LAMBDA", "RETURN_CONTROL"
|
|
1345
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.function #=> String
|
|
1346
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.invocation_id #=> String
|
|
1347
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters #=> Array
|
|
1348
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].name #=> String
|
|
1349
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].type #=> String
|
|
1350
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].value #=> String
|
|
1351
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content #=> Hash
|
|
1352
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"] #=> Array
|
|
1353
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].name #=> String
|
|
1354
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].type #=> String
|
|
1355
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].value #=> String
|
|
1356
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.verb #=> String
|
|
1357
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_alias_arn #=> String
|
|
1358
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_name #=> String
|
|
1359
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.invocation_id #=> String
|
|
1360
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results #=> Array
|
|
1361
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.action_group #=> String
|
|
1362
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.agent_id #=> String
|
|
1363
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.api_path #=> String
|
|
1364
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
|
|
1365
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_method #=> String
|
|
1366
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_status_code #=> Integer
|
|
1367
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body #=> Hash
|
|
1368
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body["String"].body #=> String
|
|
1369
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_state #=> String, one of "FAILURE", "REPROMPT"
|
|
1370
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.action_group #=> String
|
|
1371
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.agent_id #=> String
|
|
1372
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
|
|
1373
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.function #=> String
|
|
1374
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body #=> Hash
|
|
1375
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body["String"].body #=> String
|
|
1376
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_state #=> String, one of "FAILURE", "REPROMPT"
|
|
1377
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.text #=> String
|
|
1378
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.type #=> String, one of "TEXT", "RETURN_CONTROL"
|
|
1379
|
+
# event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.code #=> String
|
|
1380
|
+
# event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.files #=> Array
|
|
1381
|
+
# event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.files[0] #=> String
|
|
1382
|
+
# event.trace.routing_classifier_trace.invocation_input.invocation_type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ACTION_GROUP_CODE_INTERPRETER", "AGENT_COLLABORATOR"
|
|
1383
|
+
# event.trace.routing_classifier_trace.invocation_input.knowledge_base_lookup_input.knowledge_base_id #=> String
|
|
1384
|
+
# event.trace.routing_classifier_trace.invocation_input.knowledge_base_lookup_input.text #=> String
|
|
1385
|
+
# event.trace.routing_classifier_trace.invocation_input.trace_id #=> String
|
|
1386
|
+
# event.trace.routing_classifier_trace.model_invocation_input.foundation_model #=> String
|
|
1387
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
|
|
1388
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
|
|
1389
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
|
|
1390
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.temperature #=> Float
|
|
1391
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.top_k #=> Integer
|
|
1392
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.top_p #=> Float
|
|
1393
|
+
# event.trace.routing_classifier_trace.model_invocation_input.override_lambda #=> String
|
|
1394
|
+
# event.trace.routing_classifier_trace.model_invocation_input.parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
|
1395
|
+
# event.trace.routing_classifier_trace.model_invocation_input.prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
|
1396
|
+
# event.trace.routing_classifier_trace.model_invocation_input.text #=> String
|
|
1397
|
+
# event.trace.routing_classifier_trace.model_invocation_input.trace_id #=> String
|
|
1398
|
+
# event.trace.routing_classifier_trace.model_invocation_input.type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION", "POST_PROCESSING", "ROUTING_CLASSIFIER"
|
|
1399
|
+
# event.trace.routing_classifier_trace.model_invocation_output.metadata.usage.input_tokens #=> Integer
|
|
1400
|
+
# event.trace.routing_classifier_trace.model_invocation_output.metadata.usage.output_tokens #=> Integer
|
|
1401
|
+
# event.trace.routing_classifier_trace.model_invocation_output.raw_response.content #=> String
|
|
1402
|
+
# event.trace.routing_classifier_trace.model_invocation_output.trace_id #=> String
|
|
1403
|
+
# event.trace.routing_classifier_trace.observation.action_group_invocation_output.text #=> String
|
|
1404
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.agent_collaborator_alias_arn #=> String
|
|
1405
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.agent_collaborator_name #=> String
|
|
1406
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_id #=> String
|
|
1407
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs #=> Array
|
|
1408
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_group #=> String
|
|
1409
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
1410
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.agent_id #=> String
|
|
1411
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.api_path #=> String
|
|
1412
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
|
|
1413
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.http_method #=> String
|
|
1414
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters #=> Array
|
|
1415
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
|
|
1416
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].type #=> String
|
|
1417
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].value #=> String
|
|
1418
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content #=> Hash
|
|
1419
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties #=> Array
|
|
1420
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].name #=> String
|
|
1421
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].type #=> String
|
|
1422
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
|
|
1423
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_group #=> String
|
|
1424
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
1425
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.agent_id #=> String
|
|
1426
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
|
|
1427
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.function #=> String
|
|
1428
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters #=> Array
|
|
1429
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
|
|
1430
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
|
|
1431
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
|
|
1432
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.text #=> String
|
|
1433
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.type #=> String, one of "TEXT", "RETURN_CONTROL"
|
|
1434
|
+
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_error #=> String
|
|
1435
|
+
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_output #=> String
|
|
1436
|
+
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_timeout #=> Boolean
|
|
1437
|
+
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.files #=> Array
|
|
1438
|
+
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.files[0] #=> String
|
|
1439
|
+
# event.trace.routing_classifier_trace.observation.final_response.text #=> String
|
|
1440
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
|
|
1441
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
|
|
1442
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
1443
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
1444
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
1445
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
1446
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
1447
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM"
|
|
1448
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
1449
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
1450
|
+
# event.trace.routing_classifier_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
1451
|
+
# event.trace.routing_classifier_trace.observation.reprompt_response.text #=> String
|
|
1452
|
+
# event.trace.routing_classifier_trace.observation.trace_id #=> String
|
|
1453
|
+
# event.trace.routing_classifier_trace.observation.type #=> String, one of "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
|
|
1222
1454
|
#
|
|
1223
1455
|
# For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
|
|
1224
1456
|
# event.message #=> String
|
|
@@ -1955,6 +2187,7 @@ module Aws::BedrockAgentRuntime
|
|
|
1955
2187
|
# {
|
|
1956
2188
|
# api_result: {
|
|
1957
2189
|
# action_group: "String", # required
|
|
2190
|
+
# agent_id: "String",
|
|
1958
2191
|
# api_path: "ApiPath",
|
|
1959
2192
|
# confirmation_state: "CONFIRM", # accepts CONFIRM, DENY
|
|
1960
2193
|
# http_method: "String",
|
|
@@ -1968,6 +2201,7 @@ module Aws::BedrockAgentRuntime
|
|
|
1968
2201
|
# },
|
|
1969
2202
|
# function_result: {
|
|
1970
2203
|
# action_group: "String", # required
|
|
2204
|
+
# agent_id: "String",
|
|
1971
2205
|
# confirmation_state: "CONFIRM", # accepts CONFIRM, DENY
|
|
1972
2206
|
# function: "String",
|
|
1973
2207
|
# response_body: {
|
|
@@ -2058,8 +2292,46 @@ module Aws::BedrockAgentRuntime
|
|
|
2058
2292
|
# },
|
|
2059
2293
|
# },
|
|
2060
2294
|
# },
|
|
2295
|
+
# implicit_filter_configuration: {
|
|
2296
|
+
# metadata_attributes: [ # required
|
|
2297
|
+
# {
|
|
2298
|
+
# description: "MetadataAttributeSchemaDescriptionString", # required
|
|
2299
|
+
# key: "MetadataAttributeSchemaKeyString", # required
|
|
2300
|
+
# type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
|
|
2301
|
+
# },
|
|
2302
|
+
# ],
|
|
2303
|
+
# model_arn: "BedrockModelArn", # required
|
|
2304
|
+
# },
|
|
2061
2305
|
# number_of_results: 1,
|
|
2062
2306
|
# override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
2307
|
+
# reranking_configuration: {
|
|
2308
|
+
# bedrock_reranking_configuration: {
|
|
2309
|
+
# metadata_configuration: {
|
|
2310
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
|
2311
|
+
# selective_mode_configuration: {
|
|
2312
|
+
# fields_to_exclude: [
|
|
2313
|
+
# {
|
|
2314
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
2315
|
+
# },
|
|
2316
|
+
# ],
|
|
2317
|
+
# fields_to_include: [
|
|
2318
|
+
# {
|
|
2319
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
2320
|
+
# },
|
|
2321
|
+
# ],
|
|
2322
|
+
# },
|
|
2323
|
+
# },
|
|
2324
|
+
# model_configuration: { # required
|
|
2325
|
+
# additional_model_request_fields: {
|
|
2326
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
2327
|
+
# },
|
|
2328
|
+
# },
|
|
2329
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
|
2330
|
+
# },
|
|
2331
|
+
# number_of_reranked_results: 1,
|
|
2332
|
+
# },
|
|
2333
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
2334
|
+
# },
|
|
2063
2335
|
# },
|
|
2064
2336
|
# },
|
|
2065
2337
|
# },
|
|
@@ -2107,10 +2379,11 @@ module Aws::BedrockAgentRuntime
|
|
|
2107
2379
|
# event.attribution.citations[0].retrieved_references #=> Array
|
|
2108
2380
|
# event.attribution.citations[0].retrieved_references[0].content.text #=> String
|
|
2109
2381
|
# event.attribution.citations[0].retrieved_references[0].location.confluence_location.url #=> String
|
|
2382
|
+
# event.attribution.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
|
|
2110
2383
|
# event.attribution.citations[0].retrieved_references[0].location.s3_location.uri #=> String
|
|
2111
2384
|
# event.attribution.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
|
|
2112
2385
|
# event.attribution.citations[0].retrieved_references[0].location.share_point_location.url #=> String
|
|
2113
|
-
# event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT"
|
|
2386
|
+
# event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM"
|
|
2114
2387
|
# event.attribution.citations[0].retrieved_references[0].location.web_location.url #=> String
|
|
2115
2388
|
# event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
|
|
2116
2389
|
# event.bytes #=> String
|
|
@@ -2139,7 +2412,9 @@ module Aws::BedrockAgentRuntime
|
|
|
2139
2412
|
# event.invocation_inputs #=> Array
|
|
2140
2413
|
# event.invocation_inputs[0].api_invocation_input.action_group #=> String
|
|
2141
2414
|
# event.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
2415
|
+
# event.invocation_inputs[0].api_invocation_input.agent_id #=> String
|
|
2142
2416
|
# event.invocation_inputs[0].api_invocation_input.api_path #=> String
|
|
2417
|
+
# event.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
|
|
2143
2418
|
# event.invocation_inputs[0].api_invocation_input.http_method #=> String
|
|
2144
2419
|
# event.invocation_inputs[0].api_invocation_input.parameters #=> Array
|
|
2145
2420
|
# event.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
|
|
@@ -2152,6 +2427,8 @@ module Aws::BedrockAgentRuntime
|
|
|
2152
2427
|
# event.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
|
|
2153
2428
|
# event.invocation_inputs[0].function_invocation_input.action_group #=> String
|
|
2154
2429
|
# event.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
2430
|
+
# event.invocation_inputs[0].function_invocation_input.agent_id #=> String
|
|
2431
|
+
# event.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
|
|
2155
2432
|
# event.invocation_inputs[0].function_invocation_input.function #=> String
|
|
2156
2433
|
# event.invocation_inputs[0].function_invocation_input.parameters #=> Array
|
|
2157
2434
|
# event.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
|
|
@@ -2237,13 +2514,36 @@ module Aws::BedrockAgentRuntime
|
|
|
2237
2514
|
# event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].type #=> String
|
|
2238
2515
|
# event.trace.orchestration_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].value #=> String
|
|
2239
2516
|
# event.trace.orchestration_trace.invocation_input.action_group_invocation_input.verb #=> String
|
|
2517
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_alias_arn #=> String
|
|
2518
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_name #=> String
|
|
2519
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.invocation_id #=> String
|
|
2520
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results #=> Array
|
|
2521
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.action_group #=> String
|
|
2522
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.agent_id #=> String
|
|
2523
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.api_path #=> String
|
|
2524
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
|
|
2525
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_method #=> String
|
|
2526
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_status_code #=> Integer
|
|
2527
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body #=> Hash
|
|
2528
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body["String"].body #=> String
|
|
2529
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_state #=> String, one of "FAILURE", "REPROMPT"
|
|
2530
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.action_group #=> String
|
|
2531
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.agent_id #=> String
|
|
2532
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
|
|
2533
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.function #=> String
|
|
2534
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body #=> Hash
|
|
2535
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body["String"].body #=> String
|
|
2536
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_state #=> String, one of "FAILURE", "REPROMPT"
|
|
2537
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.text #=> String
|
|
2538
|
+
# event.trace.orchestration_trace.invocation_input.agent_collaborator_invocation_input.input.type #=> String, one of "TEXT", "RETURN_CONTROL"
|
|
2240
2539
|
# event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.code #=> String
|
|
2241
2540
|
# event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.files #=> Array
|
|
2242
2541
|
# event.trace.orchestration_trace.invocation_input.code_interpreter_invocation_input.files[0] #=> String
|
|
2243
|
-
# event.trace.orchestration_trace.invocation_input.invocation_type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ACTION_GROUP_CODE_INTERPRETER"
|
|
2542
|
+
# event.trace.orchestration_trace.invocation_input.invocation_type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ACTION_GROUP_CODE_INTERPRETER", "AGENT_COLLABORATOR"
|
|
2244
2543
|
# event.trace.orchestration_trace.invocation_input.knowledge_base_lookup_input.knowledge_base_id #=> String
|
|
2245
2544
|
# event.trace.orchestration_trace.invocation_input.knowledge_base_lookup_input.text #=> String
|
|
2246
2545
|
# event.trace.orchestration_trace.invocation_input.trace_id #=> String
|
|
2546
|
+
# event.trace.orchestration_trace.model_invocation_input.foundation_model #=> String
|
|
2247
2547
|
# event.trace.orchestration_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
|
|
2248
2548
|
# event.trace.orchestration_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
|
|
2249
2549
|
# event.trace.orchestration_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
|
|
@@ -2261,6 +2561,36 @@ module Aws::BedrockAgentRuntime
|
|
|
2261
2561
|
# event.trace.orchestration_trace.model_invocation_output.raw_response.content #=> String
|
|
2262
2562
|
# event.trace.orchestration_trace.model_invocation_output.trace_id #=> String
|
|
2263
2563
|
# event.trace.orchestration_trace.observation.action_group_invocation_output.text #=> String
|
|
2564
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.agent_collaborator_alias_arn #=> String
|
|
2565
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.agent_collaborator_name #=> String
|
|
2566
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_id #=> String
|
|
2567
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs #=> Array
|
|
2568
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_group #=> String
|
|
2569
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
2570
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.agent_id #=> String
|
|
2571
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.api_path #=> String
|
|
2572
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
|
|
2573
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.http_method #=> String
|
|
2574
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters #=> Array
|
|
2575
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
|
|
2576
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].type #=> String
|
|
2577
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].value #=> String
|
|
2578
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content #=> Hash
|
|
2579
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties #=> Array
|
|
2580
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].name #=> String
|
|
2581
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].type #=> String
|
|
2582
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
|
|
2583
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_group #=> String
|
|
2584
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
2585
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.agent_id #=> String
|
|
2586
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
|
|
2587
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.function #=> String
|
|
2588
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters #=> Array
|
|
2589
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
|
|
2590
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
|
|
2591
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
|
|
2592
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.text #=> String
|
|
2593
|
+
# event.trace.orchestration_trace.observation.agent_collaborator_invocation_output.output.type #=> String, one of "TEXT", "RETURN_CONTROL"
|
|
2264
2594
|
# event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_error #=> String
|
|
2265
2595
|
# event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_output #=> String
|
|
2266
2596
|
# event.trace.orchestration_trace.observation.code_interpreter_invocation_output.execution_timeout #=> Boolean
|
|
@@ -2270,18 +2600,20 @@ module Aws::BedrockAgentRuntime
|
|
|
2270
2600
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
|
|
2271
2601
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
|
|
2272
2602
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
2603
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
2273
2604
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
2274
2605
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
2275
2606
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
2276
|
-
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT"
|
|
2607
|
+
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM"
|
|
2277
2608
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
2278
2609
|
# event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
2279
2610
|
# event.trace.orchestration_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
2280
2611
|
# event.trace.orchestration_trace.observation.reprompt_response.text #=> String
|
|
2281
2612
|
# event.trace.orchestration_trace.observation.trace_id #=> String
|
|
2282
|
-
# event.trace.orchestration_trace.observation.type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
|
|
2613
|
+
# event.trace.orchestration_trace.observation.type #=> String, one of "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
|
|
2283
2614
|
# event.trace.orchestration_trace.rationale.text #=> String
|
|
2284
2615
|
# event.trace.orchestration_trace.rationale.trace_id #=> String
|
|
2616
|
+
# event.trace.post_processing_trace.model_invocation_input.foundation_model #=> String
|
|
2285
2617
|
# event.trace.post_processing_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
|
|
2286
2618
|
# event.trace.post_processing_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
|
|
2287
2619
|
# event.trace.post_processing_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
|
|
@@ -2299,6 +2631,7 @@ module Aws::BedrockAgentRuntime
|
|
|
2299
2631
|
# event.trace.post_processing_trace.model_invocation_output.parsed_response.text #=> String
|
|
2300
2632
|
# event.trace.post_processing_trace.model_invocation_output.raw_response.content #=> String
|
|
2301
2633
|
# event.trace.post_processing_trace.model_invocation_output.trace_id #=> String
|
|
2634
|
+
# event.trace.pre_processing_trace.model_invocation_input.foundation_model #=> String
|
|
2302
2635
|
# event.trace.pre_processing_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
|
|
2303
2636
|
# event.trace.pre_processing_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
|
|
2304
2637
|
# event.trace.pre_processing_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
|
|
@@ -2317,6 +2650,118 @@ module Aws::BedrockAgentRuntime
|
|
|
2317
2650
|
# event.trace.pre_processing_trace.model_invocation_output.parsed_response.rationale #=> String
|
|
2318
2651
|
# event.trace.pre_processing_trace.model_invocation_output.raw_response.content #=> String
|
|
2319
2652
|
# event.trace.pre_processing_trace.model_invocation_output.trace_id #=> String
|
|
2653
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.action_group_name #=> String
|
|
2654
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.api_path #=> String
|
|
2655
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.execution_type #=> String, one of "LAMBDA", "RETURN_CONTROL"
|
|
2656
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.function #=> String
|
|
2657
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.invocation_id #=> String
|
|
2658
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters #=> Array
|
|
2659
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].name #=> String
|
|
2660
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].type #=> String
|
|
2661
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.parameters[0].value #=> String
|
|
2662
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content #=> Hash
|
|
2663
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"] #=> Array
|
|
2664
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].name #=> String
|
|
2665
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].type #=> String
|
|
2666
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.request_body.content["String"][0].value #=> String
|
|
2667
|
+
# event.trace.routing_classifier_trace.invocation_input.action_group_invocation_input.verb #=> String
|
|
2668
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_alias_arn #=> String
|
|
2669
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.agent_collaborator_name #=> String
|
|
2670
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.invocation_id #=> String
|
|
2671
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results #=> Array
|
|
2672
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.action_group #=> String
|
|
2673
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.agent_id #=> String
|
|
2674
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.api_path #=> String
|
|
2675
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
|
|
2676
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_method #=> String
|
|
2677
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.http_status_code #=> Integer
|
|
2678
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body #=> Hash
|
|
2679
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_body["String"].body #=> String
|
|
2680
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].api_result.response_state #=> String, one of "FAILURE", "REPROMPT"
|
|
2681
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.action_group #=> String
|
|
2682
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.agent_id #=> String
|
|
2683
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.confirmation_state #=> String, one of "CONFIRM", "DENY"
|
|
2684
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.function #=> String
|
|
2685
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body #=> Hash
|
|
2686
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_body["String"].body #=> String
|
|
2687
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.return_control_results.return_control_invocation_results[0].function_result.response_state #=> String, one of "FAILURE", "REPROMPT"
|
|
2688
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.text #=> String
|
|
2689
|
+
# event.trace.routing_classifier_trace.invocation_input.agent_collaborator_invocation_input.input.type #=> String, one of "TEXT", "RETURN_CONTROL"
|
|
2690
|
+
# event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.code #=> String
|
|
2691
|
+
# event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.files #=> Array
|
|
2692
|
+
# event.trace.routing_classifier_trace.invocation_input.code_interpreter_invocation_input.files[0] #=> String
|
|
2693
|
+
# event.trace.routing_classifier_trace.invocation_input.invocation_type #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "FINISH", "ACTION_GROUP_CODE_INTERPRETER", "AGENT_COLLABORATOR"
|
|
2694
|
+
# event.trace.routing_classifier_trace.invocation_input.knowledge_base_lookup_input.knowledge_base_id #=> String
|
|
2695
|
+
# event.trace.routing_classifier_trace.invocation_input.knowledge_base_lookup_input.text #=> String
|
|
2696
|
+
# event.trace.routing_classifier_trace.invocation_input.trace_id #=> String
|
|
2697
|
+
# event.trace.routing_classifier_trace.model_invocation_input.foundation_model #=> String
|
|
2698
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.maximum_length #=> Integer
|
|
2699
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.stop_sequences #=> Array
|
|
2700
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.stop_sequences[0] #=> String
|
|
2701
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.temperature #=> Float
|
|
2702
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.top_k #=> Integer
|
|
2703
|
+
# event.trace.routing_classifier_trace.model_invocation_input.inference_configuration.top_p #=> Float
|
|
2704
|
+
# event.trace.routing_classifier_trace.model_invocation_input.override_lambda #=> String
|
|
2705
|
+
# event.trace.routing_classifier_trace.model_invocation_input.parser_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
|
2706
|
+
# event.trace.routing_classifier_trace.model_invocation_input.prompt_creation_mode #=> String, one of "DEFAULT", "OVERRIDDEN"
|
|
2707
|
+
# event.trace.routing_classifier_trace.model_invocation_input.text #=> String
|
|
2708
|
+
# event.trace.routing_classifier_trace.model_invocation_input.trace_id #=> String
|
|
2709
|
+
# event.trace.routing_classifier_trace.model_invocation_input.type #=> String, one of "PRE_PROCESSING", "ORCHESTRATION", "KNOWLEDGE_BASE_RESPONSE_GENERATION", "POST_PROCESSING", "ROUTING_CLASSIFIER"
|
|
2710
|
+
# event.trace.routing_classifier_trace.model_invocation_output.metadata.usage.input_tokens #=> Integer
|
|
2711
|
+
# event.trace.routing_classifier_trace.model_invocation_output.metadata.usage.output_tokens #=> Integer
|
|
2712
|
+
# event.trace.routing_classifier_trace.model_invocation_output.raw_response.content #=> String
|
|
2713
|
+
# event.trace.routing_classifier_trace.model_invocation_output.trace_id #=> String
|
|
2714
|
+
# event.trace.routing_classifier_trace.observation.action_group_invocation_output.text #=> String
|
|
2715
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.agent_collaborator_alias_arn #=> String
|
|
2716
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.agent_collaborator_name #=> String
|
|
2717
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_id #=> String
|
|
2718
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs #=> Array
|
|
2719
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_group #=> String
|
|
2720
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
2721
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.agent_id #=> String
|
|
2722
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.api_path #=> String
|
|
2723
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.collaborator_name #=> String
|
|
2724
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.http_method #=> String
|
|
2725
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters #=> Array
|
|
2726
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].name #=> String
|
|
2727
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].type #=> String
|
|
2728
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.parameters[0].value #=> String
|
|
2729
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content #=> Hash
|
|
2730
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties #=> Array
|
|
2731
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].name #=> String
|
|
2732
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].type #=> String
|
|
2733
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].api_invocation_input.request_body.content["String"].properties[0].value #=> String
|
|
2734
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_group #=> String
|
|
2735
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.action_invocation_type #=> String, one of "RESULT", "USER_CONFIRMATION", "USER_CONFIRMATION_AND_RESULT"
|
|
2736
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.agent_id #=> String
|
|
2737
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.collaborator_name #=> String
|
|
2738
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.function #=> String
|
|
2739
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters #=> Array
|
|
2740
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].name #=> String
|
|
2741
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].type #=> String
|
|
2742
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.return_control_payload.invocation_inputs[0].function_invocation_input.parameters[0].value #=> String
|
|
2743
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.text #=> String
|
|
2744
|
+
# event.trace.routing_classifier_trace.observation.agent_collaborator_invocation_output.output.type #=> String, one of "TEXT", "RETURN_CONTROL"
|
|
2745
|
+
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_error #=> String
|
|
2746
|
+
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_output #=> String
|
|
2747
|
+
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.execution_timeout #=> Boolean
|
|
2748
|
+
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.files #=> Array
|
|
2749
|
+
# event.trace.routing_classifier_trace.observation.code_interpreter_invocation_output.files[0] #=> String
|
|
2750
|
+
# event.trace.routing_classifier_trace.observation.final_response.text #=> String
|
|
2751
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references #=> Array
|
|
2752
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
|
|
2753
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.confluence_location.url #=> String
|
|
2754
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.custom_document_location.id #=> String
|
|
2755
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
|
|
2756
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.salesforce_location.url #=> String
|
|
2757
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.share_point_location.url #=> String
|
|
2758
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM"
|
|
2759
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.web_location.url #=> String
|
|
2760
|
+
# event.trace.routing_classifier_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
|
|
2761
|
+
# event.trace.routing_classifier_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
|
|
2762
|
+
# event.trace.routing_classifier_trace.observation.reprompt_response.text #=> String
|
|
2763
|
+
# event.trace.routing_classifier_trace.observation.trace_id #=> String
|
|
2764
|
+
# event.trace.routing_classifier_trace.observation.type #=> String, one of "ACTION_GROUP", "AGENT_COLLABORATOR", "KNOWLEDGE_BASE", "FINISH", "ASK_USER", "REPROMPT"
|
|
2320
2765
|
#
|
|
2321
2766
|
# For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
|
|
2322
2767
|
# event.message #=> String
|
|
@@ -2587,8 +3032,100 @@ module Aws::BedrockAgentRuntime
|
|
|
2587
3032
|
req.send_request(options, &block)
|
|
2588
3033
|
end
|
|
2589
3034
|
|
|
3035
|
+
# Reranks the relevance of sources based on queries. For more
|
|
3036
|
+
# information, see [Improve the relevance of query responses with a
|
|
3037
|
+
# reranker model][1].
|
|
3038
|
+
#
|
|
3039
|
+
#
|
|
3040
|
+
#
|
|
3041
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/rerank.html
|
|
3042
|
+
#
|
|
3043
|
+
# @option params [String] :next_token
|
|
3044
|
+
# If the total number of results was greater than could fit in a
|
|
3045
|
+
# response, a token is returned in the `nextToken` field. You can enter
|
|
3046
|
+
# that token in this field to return the next batch of results.
|
|
3047
|
+
#
|
|
3048
|
+
# @option params [required, Array<Types::RerankQuery>] :queries
|
|
3049
|
+
# An array of objects, each of which contains information about a query
|
|
3050
|
+
# to submit to the reranker model.
|
|
3051
|
+
#
|
|
3052
|
+
# @option params [required, Types::RerankingConfiguration] :reranking_configuration
|
|
3053
|
+
# Contains configurations for reranking.
|
|
3054
|
+
#
|
|
3055
|
+
# @option params [required, Array<Types::RerankSource>] :sources
|
|
3056
|
+
# An array of objects, each of which contains information about the
|
|
3057
|
+
# sources to rerank.
|
|
3058
|
+
#
|
|
3059
|
+
# @return [Types::RerankResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3060
|
+
#
|
|
3061
|
+
# * {Types::RerankResponse#next_token #next_token} => String
|
|
3062
|
+
# * {Types::RerankResponse#results #results} => Array<Types::RerankResult>
|
|
3063
|
+
#
|
|
3064
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
|
3065
|
+
#
|
|
3066
|
+
# @example Request syntax with placeholder values
|
|
3067
|
+
#
|
|
3068
|
+
# resp = client.rerank({
|
|
3069
|
+
# next_token: "NextToken",
|
|
3070
|
+
# queries: [ # required
|
|
3071
|
+
# {
|
|
3072
|
+
# text_query: { # required
|
|
3073
|
+
# text: "RerankTextDocumentTextString",
|
|
3074
|
+
# },
|
|
3075
|
+
# type: "TEXT", # required, accepts TEXT
|
|
3076
|
+
# },
|
|
3077
|
+
# ],
|
|
3078
|
+
# reranking_configuration: { # required
|
|
3079
|
+
# bedrock_reranking_configuration: { # required
|
|
3080
|
+
# model_configuration: { # required
|
|
3081
|
+
# additional_model_request_fields: {
|
|
3082
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
3083
|
+
# },
|
|
3084
|
+
# },
|
|
3085
|
+
# model_arn: "BedrockModelArn", # required
|
|
3086
|
+
# },
|
|
3087
|
+
# number_of_results: 1,
|
|
3088
|
+
# },
|
|
3089
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
3090
|
+
# },
|
|
3091
|
+
# sources: [ # required
|
|
3092
|
+
# {
|
|
3093
|
+
# inline_document_source: { # required
|
|
3094
|
+
# json_document: {
|
|
3095
|
+
# },
|
|
3096
|
+
# text_document: {
|
|
3097
|
+
# text: "RerankTextDocumentTextString",
|
|
3098
|
+
# },
|
|
3099
|
+
# type: "TEXT", # required, accepts TEXT, JSON
|
|
3100
|
+
# },
|
|
3101
|
+
# type: "INLINE", # required, accepts INLINE
|
|
3102
|
+
# },
|
|
3103
|
+
# ],
|
|
3104
|
+
# })
|
|
3105
|
+
#
|
|
3106
|
+
# @example Response structure
|
|
3107
|
+
#
|
|
3108
|
+
# resp.next_token #=> String
|
|
3109
|
+
# resp.results #=> Array
|
|
3110
|
+
# resp.results[0].document.text_document.text #=> String
|
|
3111
|
+
# resp.results[0].document.type #=> String, one of "TEXT", "JSON"
|
|
3112
|
+
# resp.results[0].index #=> Integer
|
|
3113
|
+
# resp.results[0].relevance_score #=> Float
|
|
3114
|
+
#
|
|
3115
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Rerank AWS API Documentation
|
|
3116
|
+
#
|
|
3117
|
+
# @overload rerank(params = {})
|
|
3118
|
+
# @param [Hash] params ({})
|
|
3119
|
+
def rerank(params = {}, options = {})
|
|
3120
|
+
req = build_request(:rerank, params)
|
|
3121
|
+
req.send_request(options)
|
|
3122
|
+
end
|
|
3123
|
+
|
|
2590
3124
|
# Queries a knowledge base and retrieves information from it.
|
|
2591
3125
|
#
|
|
3126
|
+
# @option params [Types::GuardrailConfiguration] :guardrail_configuration
|
|
3127
|
+
# Guardrail settings.
|
|
3128
|
+
#
|
|
2592
3129
|
# @option params [required, String] :knowledge_base_id
|
|
2593
3130
|
# The unique identifier of the knowledge base to query.
|
|
2594
3131
|
#
|
|
@@ -2610,6 +3147,7 @@ module Aws::BedrockAgentRuntime
|
|
|
2610
3147
|
#
|
|
2611
3148
|
# @return [Types::RetrieveResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
2612
3149
|
#
|
|
3150
|
+
# * {Types::RetrieveResponse#guardrail_action #guardrail_action} => String
|
|
2613
3151
|
# * {Types::RetrieveResponse#next_token #next_token} => String
|
|
2614
3152
|
# * {Types::RetrieveResponse#retrieval_results #retrieval_results} => Array<Types::KnowledgeBaseRetrievalResult>
|
|
2615
3153
|
#
|
|
@@ -2618,6 +3156,10 @@ module Aws::BedrockAgentRuntime
|
|
|
2618
3156
|
# @example Request syntax with placeholder values
|
|
2619
3157
|
#
|
|
2620
3158
|
# resp = client.retrieve({
|
|
3159
|
+
# guardrail_configuration: {
|
|
3160
|
+
# guardrail_id: "GuardrailConfigurationGuardrailIdString", # required
|
|
3161
|
+
# guardrail_version: "GuardrailConfigurationGuardrailVersionString", # required
|
|
3162
|
+
# },
|
|
2621
3163
|
# knowledge_base_id: "KnowledgeBaseId", # required
|
|
2622
3164
|
# next_token: "NextToken",
|
|
2623
3165
|
# retrieval_configuration: {
|
|
@@ -2689,8 +3231,46 @@ module Aws::BedrockAgentRuntime
|
|
|
2689
3231
|
# },
|
|
2690
3232
|
# },
|
|
2691
3233
|
# },
|
|
3234
|
+
# implicit_filter_configuration: {
|
|
3235
|
+
# metadata_attributes: [ # required
|
|
3236
|
+
# {
|
|
3237
|
+
# description: "MetadataAttributeSchemaDescriptionString", # required
|
|
3238
|
+
# key: "MetadataAttributeSchemaKeyString", # required
|
|
3239
|
+
# type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
|
|
3240
|
+
# },
|
|
3241
|
+
# ],
|
|
3242
|
+
# model_arn: "BedrockModelArn", # required
|
|
3243
|
+
# },
|
|
2692
3244
|
# number_of_results: 1,
|
|
2693
3245
|
# override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
3246
|
+
# reranking_configuration: {
|
|
3247
|
+
# bedrock_reranking_configuration: {
|
|
3248
|
+
# metadata_configuration: {
|
|
3249
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
|
3250
|
+
# selective_mode_configuration: {
|
|
3251
|
+
# fields_to_exclude: [
|
|
3252
|
+
# {
|
|
3253
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
3254
|
+
# },
|
|
3255
|
+
# ],
|
|
3256
|
+
# fields_to_include: [
|
|
3257
|
+
# {
|
|
3258
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
3259
|
+
# },
|
|
3260
|
+
# ],
|
|
3261
|
+
# },
|
|
3262
|
+
# },
|
|
3263
|
+
# model_configuration: { # required
|
|
3264
|
+
# additional_model_request_fields: {
|
|
3265
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
3266
|
+
# },
|
|
3267
|
+
# },
|
|
3268
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
|
3269
|
+
# },
|
|
3270
|
+
# number_of_reranked_results: 1,
|
|
3271
|
+
# },
|
|
3272
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
3273
|
+
# },
|
|
2694
3274
|
# },
|
|
2695
3275
|
# },
|
|
2696
3276
|
# retrieval_query: { # required
|
|
@@ -2700,14 +3280,16 @@ module Aws::BedrockAgentRuntime
|
|
|
2700
3280
|
#
|
|
2701
3281
|
# @example Response structure
|
|
2702
3282
|
#
|
|
3283
|
+
# resp.guardrail_action #=> String, one of "INTERVENED", "NONE"
|
|
2703
3284
|
# resp.next_token #=> String
|
|
2704
3285
|
# resp.retrieval_results #=> Array
|
|
2705
3286
|
# resp.retrieval_results[0].content.text #=> String
|
|
2706
3287
|
# resp.retrieval_results[0].location.confluence_location.url #=> String
|
|
3288
|
+
# resp.retrieval_results[0].location.custom_document_location.id #=> String
|
|
2707
3289
|
# resp.retrieval_results[0].location.s3_location.uri #=> String
|
|
2708
3290
|
# resp.retrieval_results[0].location.salesforce_location.url #=> String
|
|
2709
3291
|
# resp.retrieval_results[0].location.share_point_location.url #=> String
|
|
2710
|
-
# resp.retrieval_results[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT"
|
|
3292
|
+
# resp.retrieval_results[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM"
|
|
2711
3293
|
# resp.retrieval_results[0].location.web_location.url #=> String
|
|
2712
3294
|
# resp.retrieval_results[0].metadata #=> Hash
|
|
2713
3295
|
# resp.retrieval_results[0].score #=> Float
|
|
@@ -2916,8 +3498,46 @@ module Aws::BedrockAgentRuntime
|
|
|
2916
3498
|
# },
|
|
2917
3499
|
# },
|
|
2918
3500
|
# },
|
|
3501
|
+
# implicit_filter_configuration: {
|
|
3502
|
+
# metadata_attributes: [ # required
|
|
3503
|
+
# {
|
|
3504
|
+
# description: "MetadataAttributeSchemaDescriptionString", # required
|
|
3505
|
+
# key: "MetadataAttributeSchemaKeyString", # required
|
|
3506
|
+
# type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
|
|
3507
|
+
# },
|
|
3508
|
+
# ],
|
|
3509
|
+
# model_arn: "BedrockModelArn", # required
|
|
3510
|
+
# },
|
|
2919
3511
|
# number_of_results: 1,
|
|
2920
3512
|
# override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
3513
|
+
# reranking_configuration: {
|
|
3514
|
+
# bedrock_reranking_configuration: {
|
|
3515
|
+
# metadata_configuration: {
|
|
3516
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
|
3517
|
+
# selective_mode_configuration: {
|
|
3518
|
+
# fields_to_exclude: [
|
|
3519
|
+
# {
|
|
3520
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
3521
|
+
# },
|
|
3522
|
+
# ],
|
|
3523
|
+
# fields_to_include: [
|
|
3524
|
+
# {
|
|
3525
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
3526
|
+
# },
|
|
3527
|
+
# ],
|
|
3528
|
+
# },
|
|
3529
|
+
# },
|
|
3530
|
+
# model_configuration: { # required
|
|
3531
|
+
# additional_model_request_fields: {
|
|
3532
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
3533
|
+
# },
|
|
3534
|
+
# },
|
|
3535
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
|
3536
|
+
# },
|
|
3537
|
+
# number_of_reranked_results: 1,
|
|
3538
|
+
# },
|
|
3539
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
3540
|
+
# },
|
|
2921
3541
|
# },
|
|
2922
3542
|
# },
|
|
2923
3543
|
# },
|
|
@@ -2938,10 +3558,11 @@ module Aws::BedrockAgentRuntime
|
|
|
2938
3558
|
# resp.citations[0].retrieved_references #=> Array
|
|
2939
3559
|
# resp.citations[0].retrieved_references[0].content.text #=> String
|
|
2940
3560
|
# resp.citations[0].retrieved_references[0].location.confluence_location.url #=> String
|
|
3561
|
+
# resp.citations[0].retrieved_references[0].location.custom_document_location.id #=> String
|
|
2941
3562
|
# resp.citations[0].retrieved_references[0].location.s3_location.uri #=> String
|
|
2942
3563
|
# resp.citations[0].retrieved_references[0].location.salesforce_location.url #=> String
|
|
2943
3564
|
# resp.citations[0].retrieved_references[0].location.share_point_location.url #=> String
|
|
2944
|
-
# resp.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT"
|
|
3565
|
+
# resp.citations[0].retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM"
|
|
2945
3566
|
# resp.citations[0].retrieved_references[0].location.web_location.url #=> String
|
|
2946
3567
|
# resp.citations[0].retrieved_references[0].metadata #=> Hash
|
|
2947
3568
|
# resp.guardrail_action #=> String, one of "INTERVENED", "NONE"
|
|
@@ -2957,6 +3578,515 @@ module Aws::BedrockAgentRuntime
|
|
|
2957
3578
|
req.send_request(options)
|
|
2958
3579
|
end
|
|
2959
3580
|
|
|
3581
|
+
# Queries a knowledge base and generates responses based on the
|
|
3582
|
+
# retrieved results, with output in streaming format.
|
|
3583
|
+
#
|
|
3584
|
+
# <note markdown="1"> The CLI doesn't support streaming operations in Amazon Bedrock,
|
|
3585
|
+
# including `InvokeModelWithResponseStream`.
|
|
3586
|
+
#
|
|
3587
|
+
# </note>
|
|
3588
|
+
#
|
|
3589
|
+
# @option params [required, Types::RetrieveAndGenerateInput] :input
|
|
3590
|
+
# Contains the query to be made to the knowledge base.
|
|
3591
|
+
#
|
|
3592
|
+
# @option params [Types::RetrieveAndGenerateConfiguration] :retrieve_and_generate_configuration
|
|
3593
|
+
# Contains configurations for the knowledge base query and retrieval
|
|
3594
|
+
# process. For more information, see [Query configurations][1].
|
|
3595
|
+
#
|
|
3596
|
+
#
|
|
3597
|
+
#
|
|
3598
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
|
|
3599
|
+
#
|
|
3600
|
+
# @option params [Types::RetrieveAndGenerateSessionConfiguration] :session_configuration
|
|
3601
|
+
# Contains details about the session with the knowledge base.
|
|
3602
|
+
#
|
|
3603
|
+
# @option params [String] :session_id
|
|
3604
|
+
# The unique identifier of the session. When you first make a
|
|
3605
|
+
# `RetrieveAndGenerate` request, Amazon Bedrock automatically generates
|
|
3606
|
+
# this value. You must reuse this value for all subsequent requests in
|
|
3607
|
+
# the same conversational session. This value allows Amazon Bedrock to
|
|
3608
|
+
# maintain context and knowledge from previous interactions. You can't
|
|
3609
|
+
# explicitly set the `sessionId` yourself.
|
|
3610
|
+
#
|
|
3611
|
+
# @return [Types::RetrieveAndGenerateStreamResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
|
3612
|
+
#
|
|
3613
|
+
# * {Types::RetrieveAndGenerateStreamResponse#session_id #session_id} => String
|
|
3614
|
+
# * {Types::RetrieveAndGenerateStreamResponse#stream #stream} => Types::RetrieveAndGenerateStreamResponseOutput
|
|
3615
|
+
#
|
|
3616
|
+
# @example EventStream Operation Example
|
|
3617
|
+
#
|
|
3618
|
+
# You can process the event once it arrives immediately, or wait until the
|
|
3619
|
+
# full response is complete and iterate through the eventstream enumerator.
|
|
3620
|
+
#
|
|
3621
|
+
# To interact with event immediately, you need to register #retrieve_and_generate_stream
|
|
3622
|
+
# with callbacks. Callbacks can be registered for specific events or for all
|
|
3623
|
+
# events, including error events.
|
|
3624
|
+
#
|
|
3625
|
+
# Callbacks can be passed into the `:event_stream_handler` option or within a
|
|
3626
|
+
# block statement attached to the #retrieve_and_generate_stream call directly. Hybrid
|
|
3627
|
+
# pattern of both is also supported.
|
|
3628
|
+
#
|
|
3629
|
+
# `:event_stream_handler` option takes in either a Proc object or
|
|
3630
|
+
# Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput object.
|
|
3631
|
+
#
|
|
3632
|
+
# Usage pattern a): Callbacks with a block attached to #retrieve_and_generate_stream
|
|
3633
|
+
# Example for registering callbacks for all event types and an error event
|
|
3634
|
+
#
|
|
3635
|
+
# client.retrieve_and_generate_stream( # params input# ) do |stream|
|
|
3636
|
+
# stream.on_error_event do |event|
|
|
3637
|
+
# # catch unmodeled error event in the stream
|
|
3638
|
+
# raise event
|
|
3639
|
+
# # => Aws::Errors::EventError
|
|
3640
|
+
# # event.event_type => :error
|
|
3641
|
+
# # event.error_code => String
|
|
3642
|
+
# # event.error_message => String
|
|
3643
|
+
# end
|
|
3644
|
+
#
|
|
3645
|
+
# stream.on_event do |event|
|
|
3646
|
+
# # process all events arrive
|
|
3647
|
+
# puts event.event_type
|
|
3648
|
+
# ...
|
|
3649
|
+
# end
|
|
3650
|
+
#
|
|
3651
|
+
# end
|
|
3652
|
+
#
|
|
3653
|
+
# Usage pattern b): Pass in `:event_stream_handler` for #retrieve_and_generate_stream
|
|
3654
|
+
#
|
|
3655
|
+
# 1) Create a Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput object
|
|
3656
|
+
# Example for registering callbacks with specific events
|
|
3657
|
+
#
|
|
3658
|
+
# handler = Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput.new
|
|
3659
|
+
# handler.on_access_denied_exception_event do |event|
|
|
3660
|
+
# event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
|
|
3661
|
+
# end
|
|
3662
|
+
# handler.on_bad_gateway_exception_event do |event|
|
|
3663
|
+
# event # => Aws::BedrockAgentRuntime::Types::badGatewayException
|
|
3664
|
+
# end
|
|
3665
|
+
# handler.on_citation_event do |event|
|
|
3666
|
+
# event # => Aws::BedrockAgentRuntime::Types::citation
|
|
3667
|
+
# end
|
|
3668
|
+
# handler.on_conflict_exception_event do |event|
|
|
3669
|
+
# event # => Aws::BedrockAgentRuntime::Types::conflictException
|
|
3670
|
+
# end
|
|
3671
|
+
# handler.on_dependency_failed_exception_event do |event|
|
|
3672
|
+
# event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
|
|
3673
|
+
# end
|
|
3674
|
+
# handler.on_guardrail_event do |event|
|
|
3675
|
+
# event # => Aws::BedrockAgentRuntime::Types::guardrail
|
|
3676
|
+
# end
|
|
3677
|
+
# handler.on_internal_server_exception_event do |event|
|
|
3678
|
+
# event # => Aws::BedrockAgentRuntime::Types::internalServerException
|
|
3679
|
+
# end
|
|
3680
|
+
# handler.on_output_event do |event|
|
|
3681
|
+
# event # => Aws::BedrockAgentRuntime::Types::output
|
|
3682
|
+
# end
|
|
3683
|
+
# handler.on_resource_not_found_exception_event do |event|
|
|
3684
|
+
# event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
|
|
3685
|
+
# end
|
|
3686
|
+
# handler.on_service_quota_exceeded_exception_event do |event|
|
|
3687
|
+
# event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
|
|
3688
|
+
# end
|
|
3689
|
+
# handler.on_throttling_exception_event do |event|
|
|
3690
|
+
# event # => Aws::BedrockAgentRuntime::Types::throttlingException
|
|
3691
|
+
# end
|
|
3692
|
+
# handler.on_validation_exception_event do |event|
|
|
3693
|
+
# event # => Aws::BedrockAgentRuntime::Types::validationException
|
|
3694
|
+
# end
|
|
3695
|
+
#
|
|
3696
|
+
# client.retrieve_and_generate_stream( # params input #, event_stream_handler: handler)
|
|
3697
|
+
#
|
|
3698
|
+
# 2) Use a Ruby Proc object
|
|
3699
|
+
# Example for registering callbacks with specific events
|
|
3700
|
+
#
|
|
3701
|
+
# handler = Proc.new do |stream|
|
|
3702
|
+
# stream.on_access_denied_exception_event do |event|
|
|
3703
|
+
# event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
|
|
3704
|
+
# end
|
|
3705
|
+
# stream.on_bad_gateway_exception_event do |event|
|
|
3706
|
+
# event # => Aws::BedrockAgentRuntime::Types::badGatewayException
|
|
3707
|
+
# end
|
|
3708
|
+
# stream.on_citation_event do |event|
|
|
3709
|
+
# event # => Aws::BedrockAgentRuntime::Types::citation
|
|
3710
|
+
# end
|
|
3711
|
+
# stream.on_conflict_exception_event do |event|
|
|
3712
|
+
# event # => Aws::BedrockAgentRuntime::Types::conflictException
|
|
3713
|
+
# end
|
|
3714
|
+
# stream.on_dependency_failed_exception_event do |event|
|
|
3715
|
+
# event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
|
|
3716
|
+
# end
|
|
3717
|
+
# stream.on_guardrail_event do |event|
|
|
3718
|
+
# event # => Aws::BedrockAgentRuntime::Types::guardrail
|
|
3719
|
+
# end
|
|
3720
|
+
# stream.on_internal_server_exception_event do |event|
|
|
3721
|
+
# event # => Aws::BedrockAgentRuntime::Types::internalServerException
|
|
3722
|
+
# end
|
|
3723
|
+
# stream.on_output_event do |event|
|
|
3724
|
+
# event # => Aws::BedrockAgentRuntime::Types::output
|
|
3725
|
+
# end
|
|
3726
|
+
# stream.on_resource_not_found_exception_event do |event|
|
|
3727
|
+
# event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
|
|
3728
|
+
# end
|
|
3729
|
+
# stream.on_service_quota_exceeded_exception_event do |event|
|
|
3730
|
+
# event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
|
|
3731
|
+
# end
|
|
3732
|
+
# stream.on_throttling_exception_event do |event|
|
|
3733
|
+
# event # => Aws::BedrockAgentRuntime::Types::throttlingException
|
|
3734
|
+
# end
|
|
3735
|
+
# stream.on_validation_exception_event do |event|
|
|
3736
|
+
# event # => Aws::BedrockAgentRuntime::Types::validationException
|
|
3737
|
+
# end
|
|
3738
|
+
# end
|
|
3739
|
+
#
|
|
3740
|
+
# client.retrieve_and_generate_stream( # params input #, event_stream_handler: handler)
|
|
3741
|
+
#
|
|
3742
|
+
# Usage pattern c): Hybrid pattern of a) and b)
|
|
3743
|
+
#
|
|
3744
|
+
# handler = Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput.new
|
|
3745
|
+
# handler.on_access_denied_exception_event do |event|
|
|
3746
|
+
# event # => Aws::BedrockAgentRuntime::Types::accessDeniedException
|
|
3747
|
+
# end
|
|
3748
|
+
# handler.on_bad_gateway_exception_event do |event|
|
|
3749
|
+
# event # => Aws::BedrockAgentRuntime::Types::badGatewayException
|
|
3750
|
+
# end
|
|
3751
|
+
# handler.on_citation_event do |event|
|
|
3752
|
+
# event # => Aws::BedrockAgentRuntime::Types::citation
|
|
3753
|
+
# end
|
|
3754
|
+
# handler.on_conflict_exception_event do |event|
|
|
3755
|
+
# event # => Aws::BedrockAgentRuntime::Types::conflictException
|
|
3756
|
+
# end
|
|
3757
|
+
# handler.on_dependency_failed_exception_event do |event|
|
|
3758
|
+
# event # => Aws::BedrockAgentRuntime::Types::dependencyFailedException
|
|
3759
|
+
# end
|
|
3760
|
+
# handler.on_guardrail_event do |event|
|
|
3761
|
+
# event # => Aws::BedrockAgentRuntime::Types::guardrail
|
|
3762
|
+
# end
|
|
3763
|
+
# handler.on_internal_server_exception_event do |event|
|
|
3764
|
+
# event # => Aws::BedrockAgentRuntime::Types::internalServerException
|
|
3765
|
+
# end
|
|
3766
|
+
# handler.on_output_event do |event|
|
|
3767
|
+
# event # => Aws::BedrockAgentRuntime::Types::output
|
|
3768
|
+
# end
|
|
3769
|
+
# handler.on_resource_not_found_exception_event do |event|
|
|
3770
|
+
# event # => Aws::BedrockAgentRuntime::Types::resourceNotFoundException
|
|
3771
|
+
# end
|
|
3772
|
+
# handler.on_service_quota_exceeded_exception_event do |event|
|
|
3773
|
+
# event # => Aws::BedrockAgentRuntime::Types::serviceQuotaExceededException
|
|
3774
|
+
# end
|
|
3775
|
+
# handler.on_throttling_exception_event do |event|
|
|
3776
|
+
# event # => Aws::BedrockAgentRuntime::Types::throttlingException
|
|
3777
|
+
# end
|
|
3778
|
+
# handler.on_validation_exception_event do |event|
|
|
3779
|
+
# event # => Aws::BedrockAgentRuntime::Types::validationException
|
|
3780
|
+
# end
|
|
3781
|
+
#
|
|
3782
|
+
# client.retrieve_and_generate_stream( # params input #, event_stream_handler: handler) do |stream|
|
|
3783
|
+
# stream.on_error_event do |event|
|
|
3784
|
+
# # catch unmodeled error event in the stream
|
|
3785
|
+
# raise event
|
|
3786
|
+
# # => Aws::Errors::EventError
|
|
3787
|
+
# # event.event_type => :error
|
|
3788
|
+
# # event.error_code => String
|
|
3789
|
+
# # event.error_message => String
|
|
3790
|
+
# end
|
|
3791
|
+
# end
|
|
3792
|
+
#
|
|
3793
|
+
# You can also iterate through events after the response complete.
|
|
3794
|
+
#
|
|
3795
|
+
# Events are available at resp.stream # => Enumerator
|
|
3796
|
+
# For parameter input example, please refer to following request syntax
|
|
3797
|
+
#
|
|
3798
|
+
# @example Request syntax with placeholder values
|
|
3799
|
+
#
|
|
3800
|
+
# resp = client.retrieve_and_generate_stream({
|
|
3801
|
+
# input: { # required
|
|
3802
|
+
# text: "RetrieveAndGenerateInputTextString", # required
|
|
3803
|
+
# },
|
|
3804
|
+
# retrieve_and_generate_configuration: {
|
|
3805
|
+
# external_sources_configuration: {
|
|
3806
|
+
# generation_configuration: {
|
|
3807
|
+
# additional_model_request_fields: {
|
|
3808
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
3809
|
+
# },
|
|
3810
|
+
# },
|
|
3811
|
+
# guardrail_configuration: {
|
|
3812
|
+
# guardrail_id: "GuardrailConfigurationGuardrailIdString", # required
|
|
3813
|
+
# guardrail_version: "GuardrailConfigurationGuardrailVersionString", # required
|
|
3814
|
+
# },
|
|
3815
|
+
# inference_config: {
|
|
3816
|
+
# text_inference_config: {
|
|
3817
|
+
# max_tokens: 1,
|
|
3818
|
+
# stop_sequences: ["RAGStopSequencesMemberString"],
|
|
3819
|
+
# temperature: 1.0,
|
|
3820
|
+
# top_p: 1.0,
|
|
3821
|
+
# },
|
|
3822
|
+
# },
|
|
3823
|
+
# prompt_template: {
|
|
3824
|
+
# text_prompt_template: "TextPromptTemplate",
|
|
3825
|
+
# },
|
|
3826
|
+
# },
|
|
3827
|
+
# model_arn: "BedrockModelArn", # required
|
|
3828
|
+
# sources: [ # required
|
|
3829
|
+
# {
|
|
3830
|
+
# byte_content: {
|
|
3831
|
+
# content_type: "ContentType", # required
|
|
3832
|
+
# data: "data", # required
|
|
3833
|
+
# identifier: "Identifier", # required
|
|
3834
|
+
# },
|
|
3835
|
+
# s3_location: {
|
|
3836
|
+
# uri: "S3Uri", # required
|
|
3837
|
+
# },
|
|
3838
|
+
# source_type: "S3", # required, accepts S3, BYTE_CONTENT
|
|
3839
|
+
# },
|
|
3840
|
+
# ],
|
|
3841
|
+
# },
|
|
3842
|
+
# knowledge_base_configuration: {
|
|
3843
|
+
# generation_configuration: {
|
|
3844
|
+
# additional_model_request_fields: {
|
|
3845
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
3846
|
+
# },
|
|
3847
|
+
# },
|
|
3848
|
+
# guardrail_configuration: {
|
|
3849
|
+
# guardrail_id: "GuardrailConfigurationGuardrailIdString", # required
|
|
3850
|
+
# guardrail_version: "GuardrailConfigurationGuardrailVersionString", # required
|
|
3851
|
+
# },
|
|
3852
|
+
# inference_config: {
|
|
3853
|
+
# text_inference_config: {
|
|
3854
|
+
# max_tokens: 1,
|
|
3855
|
+
# stop_sequences: ["RAGStopSequencesMemberString"],
|
|
3856
|
+
# temperature: 1.0,
|
|
3857
|
+
# top_p: 1.0,
|
|
3858
|
+
# },
|
|
3859
|
+
# },
|
|
3860
|
+
# prompt_template: {
|
|
3861
|
+
# text_prompt_template: "TextPromptTemplate",
|
|
3862
|
+
# },
|
|
3863
|
+
# },
|
|
3864
|
+
# knowledge_base_id: "KnowledgeBaseId", # required
|
|
3865
|
+
# model_arn: "BedrockModelArn", # required
|
|
3866
|
+
# orchestration_configuration: {
|
|
3867
|
+
# additional_model_request_fields: {
|
|
3868
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
3869
|
+
# },
|
|
3870
|
+
# },
|
|
3871
|
+
# inference_config: {
|
|
3872
|
+
# text_inference_config: {
|
|
3873
|
+
# max_tokens: 1,
|
|
3874
|
+
# stop_sequences: ["RAGStopSequencesMemberString"],
|
|
3875
|
+
# temperature: 1.0,
|
|
3876
|
+
# top_p: 1.0,
|
|
3877
|
+
# },
|
|
3878
|
+
# },
|
|
3879
|
+
# prompt_template: {
|
|
3880
|
+
# text_prompt_template: "TextPromptTemplate",
|
|
3881
|
+
# },
|
|
3882
|
+
# query_transformation_configuration: {
|
|
3883
|
+
# type: "QUERY_DECOMPOSITION", # required, accepts QUERY_DECOMPOSITION
|
|
3884
|
+
# },
|
|
3885
|
+
# },
|
|
3886
|
+
# retrieval_configuration: {
|
|
3887
|
+
# vector_search_configuration: { # required
|
|
3888
|
+
# filter: {
|
|
3889
|
+
# and_all: [
|
|
3890
|
+
# {
|
|
3891
|
+
# # recursive RetrievalFilter
|
|
3892
|
+
# },
|
|
3893
|
+
# ],
|
|
3894
|
+
# equals: {
|
|
3895
|
+
# key: "FilterKey", # required
|
|
3896
|
+
# value: { # required
|
|
3897
|
+
# },
|
|
3898
|
+
# },
|
|
3899
|
+
# greater_than: {
|
|
3900
|
+
# key: "FilterKey", # required
|
|
3901
|
+
# value: { # required
|
|
3902
|
+
# },
|
|
3903
|
+
# },
|
|
3904
|
+
# greater_than_or_equals: {
|
|
3905
|
+
# key: "FilterKey", # required
|
|
3906
|
+
# value: { # required
|
|
3907
|
+
# },
|
|
3908
|
+
# },
|
|
3909
|
+
# in: {
|
|
3910
|
+
# key: "FilterKey", # required
|
|
3911
|
+
# value: { # required
|
|
3912
|
+
# },
|
|
3913
|
+
# },
|
|
3914
|
+
# less_than: {
|
|
3915
|
+
# key: "FilterKey", # required
|
|
3916
|
+
# value: { # required
|
|
3917
|
+
# },
|
|
3918
|
+
# },
|
|
3919
|
+
# less_than_or_equals: {
|
|
3920
|
+
# key: "FilterKey", # required
|
|
3921
|
+
# value: { # required
|
|
3922
|
+
# },
|
|
3923
|
+
# },
|
|
3924
|
+
# list_contains: {
|
|
3925
|
+
# key: "FilterKey", # required
|
|
3926
|
+
# value: { # required
|
|
3927
|
+
# },
|
|
3928
|
+
# },
|
|
3929
|
+
# not_equals: {
|
|
3930
|
+
# key: "FilterKey", # required
|
|
3931
|
+
# value: { # required
|
|
3932
|
+
# },
|
|
3933
|
+
# },
|
|
3934
|
+
# not_in: {
|
|
3935
|
+
# key: "FilterKey", # required
|
|
3936
|
+
# value: { # required
|
|
3937
|
+
# },
|
|
3938
|
+
# },
|
|
3939
|
+
# or_all: [
|
|
3940
|
+
# {
|
|
3941
|
+
# # recursive RetrievalFilter
|
|
3942
|
+
# },
|
|
3943
|
+
# ],
|
|
3944
|
+
# starts_with: {
|
|
3945
|
+
# key: "FilterKey", # required
|
|
3946
|
+
# value: { # required
|
|
3947
|
+
# },
|
|
3948
|
+
# },
|
|
3949
|
+
# string_contains: {
|
|
3950
|
+
# key: "FilterKey", # required
|
|
3951
|
+
# value: { # required
|
|
3952
|
+
# },
|
|
3953
|
+
# },
|
|
3954
|
+
# },
|
|
3955
|
+
# implicit_filter_configuration: {
|
|
3956
|
+
# metadata_attributes: [ # required
|
|
3957
|
+
# {
|
|
3958
|
+
# description: "MetadataAttributeSchemaDescriptionString", # required
|
|
3959
|
+
# key: "MetadataAttributeSchemaKeyString", # required
|
|
3960
|
+
# type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
|
|
3961
|
+
# },
|
|
3962
|
+
# ],
|
|
3963
|
+
# model_arn: "BedrockModelArn", # required
|
|
3964
|
+
# },
|
|
3965
|
+
# number_of_results: 1,
|
|
3966
|
+
# override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
|
|
3967
|
+
# reranking_configuration: {
|
|
3968
|
+
# bedrock_reranking_configuration: {
|
|
3969
|
+
# metadata_configuration: {
|
|
3970
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
|
3971
|
+
# selective_mode_configuration: {
|
|
3972
|
+
# fields_to_exclude: [
|
|
3973
|
+
# {
|
|
3974
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
3975
|
+
# },
|
|
3976
|
+
# ],
|
|
3977
|
+
# fields_to_include: [
|
|
3978
|
+
# {
|
|
3979
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
|
3980
|
+
# },
|
|
3981
|
+
# ],
|
|
3982
|
+
# },
|
|
3983
|
+
# },
|
|
3984
|
+
# model_configuration: { # required
|
|
3985
|
+
# additional_model_request_fields: {
|
|
3986
|
+
# "AdditionalModelRequestFieldsKey" => {
|
|
3987
|
+
# },
|
|
3988
|
+
# },
|
|
3989
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
|
3990
|
+
# },
|
|
3991
|
+
# number_of_reranked_results: 1,
|
|
3992
|
+
# },
|
|
3993
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
|
3994
|
+
# },
|
|
3995
|
+
# },
|
|
3996
|
+
# },
|
|
3997
|
+
# },
|
|
3998
|
+
# type: "KNOWLEDGE_BASE", # required, accepts KNOWLEDGE_BASE, EXTERNAL_SOURCES
|
|
3999
|
+
# },
|
|
4000
|
+
# session_configuration: {
|
|
4001
|
+
# kms_key_arn: "KmsKeyArn", # required
|
|
4002
|
+
# },
|
|
4003
|
+
# session_id: "SessionId",
|
|
4004
|
+
# })
|
|
4005
|
+
#
|
|
4006
|
+
# @example Response structure
|
|
4007
|
+
#
|
|
4008
|
+
# resp.session_id #=> String
|
|
4009
|
+
# All events are available at resp.stream:
|
|
4010
|
+
# resp.stream #=> Enumerator
|
|
4011
|
+
# 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]
|
|
4012
|
+
#
|
|
4013
|
+
# For :access_denied_exception event available at #on_access_denied_exception_event callback and response eventstream enumerator:
|
|
4014
|
+
# event.message #=> String
|
|
4015
|
+
#
|
|
4016
|
+
# For :bad_gateway_exception event available at #on_bad_gateway_exception_event callback and response eventstream enumerator:
|
|
4017
|
+
# event.message #=> String
|
|
4018
|
+
# event.resource_name #=> String
|
|
4019
|
+
#
|
|
4020
|
+
# For :citation event available at #on_citation_event callback and response eventstream enumerator:
|
|
4021
|
+
# event.citation.generated_response_part.text_response_part.span.end #=> Integer
|
|
4022
|
+
# event.citation.generated_response_part.text_response_part.span.start #=> Integer
|
|
4023
|
+
# event.citation.generated_response_part.text_response_part.text #=> String
|
|
4024
|
+
# event.citation.retrieved_references #=> Array
|
|
4025
|
+
# event.citation.retrieved_references[0].content.text #=> String
|
|
4026
|
+
# event.citation.retrieved_references[0].location.confluence_location.url #=> String
|
|
4027
|
+
# event.citation.retrieved_references[0].location.custom_document_location.id #=> String
|
|
4028
|
+
# event.citation.retrieved_references[0].location.s3_location.uri #=> String
|
|
4029
|
+
# event.citation.retrieved_references[0].location.salesforce_location.url #=> String
|
|
4030
|
+
# event.citation.retrieved_references[0].location.share_point_location.url #=> String
|
|
4031
|
+
# event.citation.retrieved_references[0].location.type #=> String, one of "S3", "WEB", "CONFLUENCE", "SALESFORCE", "SHAREPOINT", "CUSTOM"
|
|
4032
|
+
# event.citation.retrieved_references[0].location.web_location.url #=> String
|
|
4033
|
+
# event.citation.retrieved_references[0].metadata #=> Hash
|
|
4034
|
+
#
|
|
4035
|
+
# For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
|
|
4036
|
+
# event.message #=> String
|
|
4037
|
+
#
|
|
4038
|
+
# For :dependency_failed_exception event available at #on_dependency_failed_exception_event callback and response eventstream enumerator:
|
|
4039
|
+
# event.message #=> String
|
|
4040
|
+
# event.resource_name #=> String
|
|
4041
|
+
#
|
|
4042
|
+
# For :guardrail event available at #on_guardrail_event callback and response eventstream enumerator:
|
|
4043
|
+
# event.action #=> String, one of "INTERVENED", "NONE"
|
|
4044
|
+
#
|
|
4045
|
+
# For :internal_server_exception event available at #on_internal_server_exception_event callback and response eventstream enumerator:
|
|
4046
|
+
# event.message #=> String
|
|
4047
|
+
#
|
|
4048
|
+
# For :output event available at #on_output_event callback and response eventstream enumerator:
|
|
4049
|
+
# event.text #=> String
|
|
4050
|
+
#
|
|
4051
|
+
# For :resource_not_found_exception event available at #on_resource_not_found_exception_event callback and response eventstream enumerator:
|
|
4052
|
+
# event.message #=> String
|
|
4053
|
+
#
|
|
4054
|
+
# For :service_quota_exceeded_exception event available at #on_service_quota_exceeded_exception_event callback and response eventstream enumerator:
|
|
4055
|
+
# event.message #=> String
|
|
4056
|
+
#
|
|
4057
|
+
# For :throttling_exception event available at #on_throttling_exception_event callback and response eventstream enumerator:
|
|
4058
|
+
# event.message #=> String
|
|
4059
|
+
#
|
|
4060
|
+
# For :validation_exception event available at #on_validation_exception_event callback and response eventstream enumerator:
|
|
4061
|
+
# event.message #=> String
|
|
4062
|
+
#
|
|
4063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStream AWS API Documentation
|
|
4064
|
+
#
|
|
4065
|
+
# @overload retrieve_and_generate_stream(params = {})
|
|
4066
|
+
# @param [Hash] params ({})
|
|
4067
|
+
def retrieve_and_generate_stream(params = {}, options = {}, &block)
|
|
4068
|
+
params = params.dup
|
|
4069
|
+
event_stream_handler = case handler = params.delete(:event_stream_handler)
|
|
4070
|
+
when EventStreams::RetrieveAndGenerateStreamResponseOutput then handler
|
|
4071
|
+
when Proc then EventStreams::RetrieveAndGenerateStreamResponseOutput.new.tap(&handler)
|
|
4072
|
+
when nil then EventStreams::RetrieveAndGenerateStreamResponseOutput.new
|
|
4073
|
+
else
|
|
4074
|
+
msg = "expected :event_stream_handler to be a block or "\
|
|
4075
|
+
"instance of Aws::BedrockAgentRuntime::EventStreams::RetrieveAndGenerateStreamResponseOutput"\
|
|
4076
|
+
", got `#{handler.inspect}` instead"
|
|
4077
|
+
raise ArgumentError, msg
|
|
4078
|
+
end
|
|
4079
|
+
|
|
4080
|
+
yield(event_stream_handler) if block_given?
|
|
4081
|
+
|
|
4082
|
+
req = build_request(:retrieve_and_generate_stream, params)
|
|
4083
|
+
|
|
4084
|
+
req.context[:event_stream_handler] = event_stream_handler
|
|
4085
|
+
req.handlers.add(Aws::Binary::DecodeHandler, priority: 95)
|
|
4086
|
+
|
|
4087
|
+
req.send_request(options, &block)
|
|
4088
|
+
end
|
|
4089
|
+
|
|
2960
4090
|
# @!endgroup
|
|
2961
4091
|
|
|
2962
4092
|
# @param params ({})
|
|
@@ -2975,7 +4105,7 @@ module Aws::BedrockAgentRuntime
|
|
|
2975
4105
|
tracer: tracer
|
|
2976
4106
|
)
|
|
2977
4107
|
context[:gem_name] = 'aws-sdk-bedrockagentruntime'
|
|
2978
|
-
context[:gem_version] = '1.
|
|
4108
|
+
context[:gem_version] = '1.36.0'
|
|
2979
4109
|
Seahorse::Client::Request.new(handlers, context)
|
|
2980
4110
|
end
|
|
2981
4111
|
|