aws-sdk-bedrockagentruntime 1.34.0 → 1.36.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -240,6 +240,104 @@ module Aws::BedrockAgentRuntime
240
240
  include Aws::Structure
241
241
  end
242
242
 
243
+ # Input for an agent collaborator. The input can be text or an action
244
+ # invocation result.
245
+ #
246
+ # @!attribute [rw] return_control_results
247
+ # An action invocation result.
248
+ # @return [Types::ReturnControlResults]
249
+ #
250
+ # @!attribute [rw] text
251
+ # Input text.
252
+ # @return [String]
253
+ #
254
+ # @!attribute [rw] type
255
+ # The input type.
256
+ # @return [String]
257
+ #
258
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInputPayload AWS API Documentation
259
+ #
260
+ class AgentCollaboratorInputPayload < Struct.new(
261
+ :return_control_results,
262
+ :text,
263
+ :type)
264
+ SENSITIVE = [:text]
265
+ include Aws::Structure
266
+ end
267
+
268
+ # An agent collaborator invocation input.
269
+ #
270
+ # @!attribute [rw] agent_collaborator_alias_arn
271
+ # The collaborator's alias ARN.
272
+ # @return [String]
273
+ #
274
+ # @!attribute [rw] agent_collaborator_name
275
+ # The collaborator's name.
276
+ # @return [String]
277
+ #
278
+ # @!attribute [rw] input
279
+ # Text or action invocation result input for the collaborator.
280
+ # @return [Types::AgentCollaboratorInputPayload]
281
+ #
282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInvocationInput AWS API Documentation
283
+ #
284
+ class AgentCollaboratorInvocationInput < Struct.new(
285
+ :agent_collaborator_alias_arn,
286
+ :agent_collaborator_name,
287
+ :input)
288
+ SENSITIVE = []
289
+ include Aws::Structure
290
+ end
291
+
292
+ # Output from an agent collaborator.
293
+ #
294
+ # @!attribute [rw] agent_collaborator_alias_arn
295
+ # The output's agent collaborator alias ARN.
296
+ # @return [String]
297
+ #
298
+ # @!attribute [rw] agent_collaborator_name
299
+ # The output's agent collaborator name.
300
+ # @return [String]
301
+ #
302
+ # @!attribute [rw] output
303
+ # The output's output.
304
+ # @return [Types::AgentCollaboratorOutputPayload]
305
+ #
306
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgentCollaboratorInvocationOutput AWS API Documentation
307
+ #
308
+ class AgentCollaboratorInvocationOutput < Struct.new(
309
+ :agent_collaborator_alias_arn,
310
+ :agent_collaborator_name,
311
+ :output)
312
+ SENSITIVE = []
313
+ include Aws::Structure
314
+ end
315
+
316
+ # Output from an agent collaborator. The output can be text or an action
317
+ # invocation result.
318
+ #
319
+ # @!attribute [rw] return_control_payload
320
+ # An action invocation result.
321
+ # @return [Types::ReturnControlPayload]
322
+ #
323
+ # @!attribute [rw] text
324
+ # Text output.
325
+ # @return [String]
326
+ #
327
+ # @!attribute [rw] type
328
+ # The type of output.
329
+ # @return [String]
330
+ #
331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/AgentCollaboratorOutputPayload AWS API Documentation
332
+ #
333
+ class AgentCollaboratorOutputPayload < Struct.new(
334
+ :return_control_payload,
335
+ :text,
336
+ :type)
337
+ SENSITIVE = [:return_control_payload, :text]
338
+ include Aws::Structure
339
+ end
340
+
243
341
  # An event in which the prompt was analyzed in preparation for
244
342
  # optimization.
245
343
  #
@@ -277,10 +375,18 @@ module Aws::BedrockAgentRuntime
277
375
  # Contains information about the API operation to invoke.
278
376
  # @return [String]
279
377
  #
378
+ # @!attribute [rw] agent_id
379
+ # The agent's ID.
380
+ # @return [String]
381
+ #
280
382
  # @!attribute [rw] api_path
281
383
  # The path to the API operation.
282
384
  # @return [String]
283
385
  #
386
+ # @!attribute [rw] collaborator_name
387
+ # The agent collaborator's name.
388
+ # @return [String]
389
+ #
284
390
  # @!attribute [rw] http_method
285
391
  # The HTTP method of the API operation.
286
392
  # @return [String]
@@ -300,11 +406,13 @@ module Aws::BedrockAgentRuntime
300
406
  class ApiInvocationInput < Struct.new(
301
407
  :action_group,
302
408
  :action_invocation_type,
409
+ :agent_id,
303
410
  :api_path,
411
+ :collaborator_name,
304
412
  :http_method,
305
413
  :parameters,
306
414
  :request_body)
307
- SENSITIVE = [:api_path]
415
+ SENSITIVE = [:api_path, :collaborator_name]
308
416
  include Aws::Structure
309
417
  end
310
418
 
@@ -386,6 +494,10 @@ module Aws::BedrockAgentRuntime
386
494
  # The action group that the API operation belongs to.
387
495
  # @return [String]
388
496
  #
497
+ # @!attribute [rw] agent_id
498
+ # The agent's ID.
499
+ # @return [String]
500
+ #
389
501
  # @!attribute [rw] api_path
390
502
  # The path to the API operation.
391
503
  # @return [String]
@@ -422,6 +534,7 @@ module Aws::BedrockAgentRuntime
422
534
  #
423
535
  class ApiResult < Struct.new(
424
536
  :action_group,
537
+ :agent_id,
425
538
  :api_path,
426
539
  :confirmation_state,
427
540
  :http_method,
@@ -468,6 +581,45 @@ module Aws::BedrockAgentRuntime
468
581
  include Aws::Structure
469
582
  end
470
583
 
584
+ # Contains configurations for an Amazon Bedrock reranker model.
585
+ #
586
+ # @!attribute [rw] model_configuration
587
+ # Contains configurations for a reranker model.
588
+ # @return [Types::BedrockRerankingModelConfiguration]
589
+ #
590
+ # @!attribute [rw] number_of_results
591
+ # The number of results to return after reranking.
592
+ # @return [Integer]
593
+ #
594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/BedrockRerankingConfiguration AWS API Documentation
595
+ #
596
+ class BedrockRerankingConfiguration < Struct.new(
597
+ :model_configuration,
598
+ :number_of_results)
599
+ SENSITIVE = []
600
+ include Aws::Structure
601
+ end
602
+
603
+ # Contains configurations for a reranker model.
604
+ #
605
+ # @!attribute [rw] additional_model_request_fields
606
+ # A JSON object whose keys are request fields for the model and whose
607
+ # values are values for those fields.
608
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
609
+ #
610
+ # @!attribute [rw] model_arn
611
+ # The ARN of the reranker model.
612
+ # @return [String]
613
+ #
614
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/BedrockRerankingModelConfiguration AWS API Documentation
615
+ #
616
+ class BedrockRerankingModelConfiguration < Struct.new(
617
+ :additional_model_request_fields,
618
+ :model_arn)
619
+ SENSITIVE = []
620
+ include Aws::Structure
621
+ end
622
+
471
623
  # This property contains the document to chat with, along with its
472
624
  # attributes.
473
625
  #
@@ -514,6 +666,27 @@ module Aws::BedrockAgentRuntime
514
666
  include Aws::Structure
515
667
  end
516
668
 
669
+ # Details about a caller.
670
+ #
671
+ # @note Caller is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of Caller corresponding to the set member.
672
+ #
673
+ # @!attribute [rw] agent_alias_arn
674
+ # The caller's agent alias ARN.
675
+ # @return [String]
676
+ #
677
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Caller AWS API Documentation
678
+ #
679
+ class Caller < Struct.new(
680
+ :agent_alias_arn,
681
+ :unknown)
682
+ SENSITIVE = []
683
+ include Aws::Structure
684
+ include Aws::Structure::Union
685
+
686
+ class AgentAliasArn < Caller; end
687
+ class Unknown < Caller; end
688
+ end
689
+
517
690
  # An object containing a segment of the generated response that is based
518
691
  # on a source in the knowledge base, alongside information about the
519
692
  # source.
@@ -547,6 +720,21 @@ module Aws::BedrockAgentRuntime
547
720
  include Aws::Structure
548
721
  end
549
722
 
723
+ # A citation event.
724
+ #
725
+ # @!attribute [rw] citation
726
+ # The citation.
727
+ # @return [Types::Citation]
728
+ #
729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/CitationEvent AWS API Documentation
730
+ #
731
+ class CitationEvent < Struct.new(
732
+ :citation,
733
+ :event_type)
734
+ SENSITIVE = []
735
+ include Aws::Structure
736
+ end
737
+
550
738
  # Contains information about the code interpreter being invoked.
551
739
  #
552
740
  # @!attribute [rw] code
@@ -611,6 +799,27 @@ module Aws::BedrockAgentRuntime
611
799
  include Aws::Structure
612
800
  end
613
801
 
802
+ # A content block.
803
+ #
804
+ # @note ContentBlock is a union - when making an API calls you must set exactly one of the members.
805
+ #
806
+ # @!attribute [rw] text
807
+ # The block's text.
808
+ # @return [String]
809
+ #
810
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ContentBlock AWS API Documentation
811
+ #
812
+ class ContentBlock < Struct.new(
813
+ :text,
814
+ :unknown)
815
+ SENSITIVE = []
816
+ include Aws::Structure
817
+ include Aws::Structure::Union
818
+
819
+ class Text < ContentBlock; end
820
+ class Unknown < ContentBlock; end
821
+ end
822
+
614
823
  # Contains the body of the API response.
615
824
  #
616
825
  # This data type is used in the following API operations:
@@ -636,10 +845,24 @@ module Aws::BedrockAgentRuntime
636
845
  include Aws::Structure
637
846
  end
638
847
 
848
+ # A conversation history.
849
+ #
850
+ # @!attribute [rw] messages
851
+ # The conversation's messages.
852
+ # @return [Array<Types::Message>]
853
+ #
854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ConversationHistory AWS API Documentation
855
+ #
856
+ class ConversationHistory < Struct.new(
857
+ :messages)
858
+ SENSITIVE = []
859
+ include Aws::Structure
860
+ end
861
+
639
862
  # The trace behavior for the custom orchestration.
640
863
  #
641
864
  # @!attribute [rw] event
642
- # The trace event details used with the custom orchestration.
865
+ # The event details used with the custom orchestration.
643
866
  # @return [Types::CustomOrchestrationTraceEvent]
644
867
  #
645
868
  # @!attribute [rw] trace_id
@@ -655,7 +878,9 @@ module Aws::BedrockAgentRuntime
655
878
  include Aws::Structure
656
879
  end
657
880
 
658
- # The event in the custom orchestration sequence.
881
+ # The event in the custom orchestration sequence. Events are the
882
+ # responses which the custom orchestration Lambda function sends as
883
+ # response to the agent.
659
884
  #
660
885
  # @!attribute [rw] text
661
886
  # The text that prompted the event at this step.
@@ -824,6 +1049,22 @@ module Aws::BedrockAgentRuntime
824
1049
  include Aws::Structure
825
1050
  end
826
1051
 
1052
+ # Contains information for a metadata field to include in or exclude
1053
+ # from consideration when reranking.
1054
+ #
1055
+ # @!attribute [rw] field_name
1056
+ # The name of a metadata field to include in or exclude from
1057
+ # consideration when reranking.
1058
+ # @return [String]
1059
+ #
1060
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FieldForReranking AWS API Documentation
1061
+ #
1062
+ class FieldForReranking < Struct.new(
1063
+ :field_name)
1064
+ SENSITIVE = []
1065
+ include Aws::Structure
1066
+ end
1067
+
827
1068
  # Contains intermediate response for code interpreter if any files have
828
1069
  # been generated.
829
1070
  #
@@ -1350,6 +1591,14 @@ module Aws::BedrockAgentRuntime
1350
1591
  # Contains information about the function to invoke,
1351
1592
  # @return [String]
1352
1593
  #
1594
+ # @!attribute [rw] agent_id
1595
+ # The agent's ID.
1596
+ # @return [String]
1597
+ #
1598
+ # @!attribute [rw] collaborator_name
1599
+ # The collaborator's name.
1600
+ # @return [String]
1601
+ #
1353
1602
  # @!attribute [rw] function
1354
1603
  # The name of the function.
1355
1604
  # @return [String]
@@ -1363,9 +1612,11 @@ module Aws::BedrockAgentRuntime
1363
1612
  class FunctionInvocationInput < Struct.new(
1364
1613
  :action_group,
1365
1614
  :action_invocation_type,
1615
+ :agent_id,
1616
+ :collaborator_name,
1366
1617
  :function,
1367
1618
  :parameters)
1368
- SENSITIVE = []
1619
+ SENSITIVE = [:collaborator_name]
1369
1620
  include Aws::Structure
1370
1621
  end
1371
1622
 
@@ -1421,6 +1672,10 @@ module Aws::BedrockAgentRuntime
1421
1672
  # The action group that the function belongs to.
1422
1673
  # @return [String]
1423
1674
  #
1675
+ # @!attribute [rw] agent_id
1676
+ # The agent's ID.
1677
+ # @return [String]
1678
+ #
1424
1679
  # @!attribute [rw] confirmation_state
1425
1680
  # Contains the user confirmation information about the function that
1426
1681
  # was called.
@@ -1449,6 +1704,7 @@ module Aws::BedrockAgentRuntime
1449
1704
  #
1450
1705
  class FunctionResult < Struct.new(
1451
1706
  :action_group,
1707
+ :agent_id,
1452
1708
  :confirmation_state,
1453
1709
  :function,
1454
1710
  :response_body,
@@ -1746,6 +2002,21 @@ module Aws::BedrockAgentRuntime
1746
2002
  include Aws::Structure
1747
2003
  end
1748
2004
 
2005
+ # A guardrail event.
2006
+ #
2007
+ # @!attribute [rw] action
2008
+ # The guardrail action.
2009
+ # @return [String]
2010
+ #
2011
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/GuardrailEvent AWS API Documentation
2012
+ #
2013
+ class GuardrailEvent < Struct.new(
2014
+ :action,
2015
+ :event_type)
2016
+ SENSITIVE = []
2017
+ include Aws::Structure
2018
+ end
2019
+
1749
2020
  # The managed word details for the filter in the Guardrail.
1750
2021
  #
1751
2022
  # @!attribute [rw] action
@@ -1932,6 +2203,26 @@ module Aws::BedrockAgentRuntime
1932
2203
  include Aws::Structure
1933
2204
  end
1934
2205
 
2206
+ # Settings for implicit filtering, where a model generates a metadata
2207
+ # filter based on the prompt.
2208
+ #
2209
+ # @!attribute [rw] metadata_attributes
2210
+ # Metadata that can be used in a filter.
2211
+ # @return [Array<Types::MetadataAttributeSchema>]
2212
+ #
2213
+ # @!attribute [rw] model_arn
2214
+ # The model that generates the filter.
2215
+ # @return [String]
2216
+ #
2217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ImplicitFilterConfiguration AWS API Documentation
2218
+ #
2219
+ class ImplicitFilterConfiguration < Struct.new(
2220
+ :metadata_attributes,
2221
+ :model_arn)
2222
+ SENSITIVE = [:metadata_attributes]
2223
+ include Aws::Structure
2224
+ end
2225
+
1935
2226
  # The configuration for inference settings when generating responses
1936
2227
  # using RetrieveAndGenerate.
1937
2228
  #
@@ -2238,6 +2529,10 @@ module Aws::BedrockAgentRuntime
2238
2529
  # Contains information about the action group to be invoked.
2239
2530
  # @return [Types::ActionGroupInvocationInput]
2240
2531
  #
2532
+ # @!attribute [rw] agent_collaborator_invocation_input
2533
+ # The collaborator's invocation input.
2534
+ # @return [Types::AgentCollaboratorInvocationInput]
2535
+ #
2241
2536
  # @!attribute [rw] code_interpreter_invocation_input
2242
2537
  # Contains information about the code interpreter to be invoked.
2243
2538
  # @return [Types::CodeInterpreterInvocationInput]
@@ -2260,6 +2555,7 @@ module Aws::BedrockAgentRuntime
2260
2555
  #
2261
2556
  class InvocationInput < Struct.new(
2262
2557
  :action_group_invocation_input,
2558
+ :agent_collaborator_invocation_input,
2263
2559
  :code_interpreter_invocation_input,
2264
2560
  :invocation_type,
2265
2561
  :knowledge_base_lookup_input,
@@ -2326,6 +2622,8 @@ module Aws::BedrockAgentRuntime
2326
2622
  #
2327
2623
  # @note InvocationResultMember is a union - when making an API calls you must set exactly one of the members.
2328
2624
  #
2625
+ # @note InvocationResultMember is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of InvocationResultMember corresponding to the set member.
2626
+ #
2329
2627
  # @!attribute [rw] api_result
2330
2628
  # The result from the API response from the action group invocation.
2331
2629
  # @return [Types::ApiResult]
@@ -2402,6 +2700,10 @@ module Aws::BedrockAgentRuntime
2402
2700
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html
2403
2701
  # @return [Types::SessionState]
2404
2702
  #
2703
+ # @!attribute [rw] source_arn
2704
+ # The ARN of the resource making the request.
2705
+ # @return [String]
2706
+ #
2405
2707
  # @!attribute [rw] streaming_configurations
2406
2708
  # Specifies the configurations for streaming.
2407
2709
  # @return [Types::StreamingConfigurations]
@@ -2417,6 +2719,7 @@ module Aws::BedrockAgentRuntime
2417
2719
  :memory_id,
2418
2720
  :session_id,
2419
2721
  :session_state,
2722
+ :source_arn,
2420
2723
  :streaming_configurations)
2421
2724
  SENSITIVE = [:input_text]
2422
2725
  include Aws::Structure
@@ -2914,6 +3217,10 @@ module Aws::BedrockAgentRuntime
2914
3217
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
2915
3218
  # @return [Types::RetrievalFilter]
2916
3219
  #
3220
+ # @!attribute [rw] implicit_filter_configuration
3221
+ # Settings for implicit filtering.
3222
+ # @return [Types::ImplicitFilterConfiguration]
3223
+ #
2917
3224
  # @!attribute [rw] number_of_results
2918
3225
  # The number of source chunks to retrieve.
2919
3226
  # @return [Integer]
@@ -2933,12 +3240,24 @@ module Aws::BedrockAgentRuntime
2933
3240
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-test.html
2934
3241
  # @return [String]
2935
3242
  #
3243
+ # @!attribute [rw] reranking_configuration
3244
+ # Contains configurations for reranking the retrieved results. For
3245
+ # more information, see [Improve the relevance of query responses with
3246
+ # a reranker model][1].
3247
+ #
3248
+ #
3249
+ #
3250
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/rerank.html
3251
+ # @return [Types::VectorSearchRerankingConfiguration]
3252
+ #
2936
3253
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/KnowledgeBaseVectorSearchConfiguration AWS API Documentation
2937
3254
  #
2938
3255
  class KnowledgeBaseVectorSearchConfiguration < Struct.new(
2939
3256
  :filter,
3257
+ :implicit_filter_configuration,
2940
3258
  :number_of_results,
2941
- :override_search_type)
3259
+ :override_search_type,
3260
+ :reranking_configuration)
2942
3261
  SENSITIVE = [:filter]
2943
3262
  include Aws::Structure
2944
3263
  end
@@ -2999,6 +3318,25 @@ module Aws::BedrockAgentRuntime
2999
3318
  include Aws::Structure
3000
3319
  end
3001
3320
 
3321
+ # Details about a message.
3322
+ #
3323
+ # @!attribute [rw] content
3324
+ # The message's content.
3325
+ # @return [Array<Types::ContentBlock>]
3326
+ #
3327
+ # @!attribute [rw] role
3328
+ # The message's role.
3329
+ # @return [String]
3330
+ #
3331
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Message AWS API Documentation
3332
+ #
3333
+ class Message < Struct.new(
3334
+ :content,
3335
+ :role)
3336
+ SENSITIVE = [:content]
3337
+ include Aws::Structure
3338
+ end
3339
+
3002
3340
  # Provides details of the foundation model.
3003
3341
  #
3004
3342
  # @!attribute [rw] usage
@@ -3013,6 +3351,52 @@ module Aws::BedrockAgentRuntime
3013
3351
  include Aws::Structure
3014
3352
  end
3015
3353
 
3354
+ # Details about a metadata attribute.
3355
+ #
3356
+ # @!attribute [rw] description
3357
+ # The attribute's description.
3358
+ # @return [String]
3359
+ #
3360
+ # @!attribute [rw] key
3361
+ # The attribute's key.
3362
+ # @return [String]
3363
+ #
3364
+ # @!attribute [rw] type
3365
+ # The attribute's type.
3366
+ # @return [String]
3367
+ #
3368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/MetadataAttributeSchema AWS API Documentation
3369
+ #
3370
+ class MetadataAttributeSchema < Struct.new(
3371
+ :description,
3372
+ :key,
3373
+ :type)
3374
+ SENSITIVE = []
3375
+ include Aws::Structure
3376
+ end
3377
+
3378
+ # Contains configurations for the metadata to use in reranking.
3379
+ #
3380
+ # @!attribute [rw] selection_mode
3381
+ # Specifies whether to consider all metadata when reranking, or only
3382
+ # the metadata that you select. If you specify `SELECTIVE`, include
3383
+ # the `selectiveModeConfiguration` field.
3384
+ # @return [String]
3385
+ #
3386
+ # @!attribute [rw] selective_mode_configuration
3387
+ # Contains configurations for the metadata fields to include or
3388
+ # exclude when considering reranking.
3389
+ # @return [Types::RerankingMetadataSelectiveModeConfiguration]
3390
+ #
3391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/MetadataConfigurationForReranking AWS API Documentation
3392
+ #
3393
+ class MetadataConfigurationForReranking < Struct.new(
3394
+ :selection_mode,
3395
+ :selective_mode_configuration)
3396
+ SENSITIVE = []
3397
+ include Aws::Structure
3398
+ end
3399
+
3016
3400
  # The input for the pre-processing step.
3017
3401
  #
3018
3402
  # * The `type` matches the agent step.
@@ -3027,6 +3411,10 @@ module Aws::BedrockAgentRuntime
3027
3411
  #
3028
3412
  # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptOverrideConfiguration.html
3029
3413
  #
3414
+ # @!attribute [rw] foundation_model
3415
+ # The identifier of a foundation model.
3416
+ # @return [String]
3417
+ #
3030
3418
  # @!attribute [rw] inference_configuration
3031
3419
  # Specifications about the inference parameters that were provided
3032
3420
  # alongside the prompt. These are specified in the
@@ -3077,6 +3465,7 @@ module Aws::BedrockAgentRuntime
3077
3465
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ModelInvocationInput AWS API Documentation
3078
3466
  #
3079
3467
  class ModelInvocationInput < Struct.new(
3468
+ :foundation_model,
3080
3469
  :inference_configuration,
3081
3470
  :override_lambda,
3082
3471
  :parser_mode,
@@ -3096,6 +3485,10 @@ module Aws::BedrockAgentRuntime
3096
3485
  # the action group.
3097
3486
  # @return [Types::ActionGroupInvocationOutput]
3098
3487
  #
3488
+ # @!attribute [rw] agent_collaborator_invocation_output
3489
+ # A collaborator's invocation output.
3490
+ # @return [Types::AgentCollaboratorInvocationOutput]
3491
+ #
3099
3492
  # @!attribute [rw] code_interpreter_invocation_output
3100
3493
  # Contains the JSON-formatted string returned by the API invoked by
3101
3494
  # the code interpreter.
@@ -3140,6 +3533,7 @@ module Aws::BedrockAgentRuntime
3140
3533
  #
3141
3534
  class Observation < Struct.new(
3142
3535
  :action_group_invocation_output,
3536
+ :agent_collaborator_invocation_output,
3143
3537
  :code_interpreter_invocation_output,
3144
3538
  :final_response,
3145
3539
  :knowledge_base_lookup_output,
@@ -3885,6 +4279,213 @@ module Aws::BedrockAgentRuntime
3885
4279
  include Aws::Structure
3886
4280
  end
3887
4281
 
4282
+ # Contains information about a document to rerank. Choose the `type` to
4283
+ # define and include the field that corresponds to the type.
4284
+ #
4285
+ # @!attribute [rw] json_document
4286
+ # Contains a JSON document to rerank.
4287
+ # @return [Hash,Array,String,Numeric,Boolean]
4288
+ #
4289
+ # @!attribute [rw] text_document
4290
+ # Contains information about a text document to rerank.
4291
+ # @return [Types::RerankTextDocument]
4292
+ #
4293
+ # @!attribute [rw] type
4294
+ # The type of document to rerank.
4295
+ # @return [String]
4296
+ #
4297
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RerankDocument AWS API Documentation
4298
+ #
4299
+ class RerankDocument < Struct.new(
4300
+ :json_document,
4301
+ :text_document,
4302
+ :type)
4303
+ SENSITIVE = [:text_document]
4304
+ include Aws::Structure
4305
+ end
4306
+
4307
+ # Contains information about a query to submit to the reranker model.
4308
+ #
4309
+ # @!attribute [rw] text_query
4310
+ # Contains information about a text query.
4311
+ # @return [Types::RerankTextDocument]
4312
+ #
4313
+ # @!attribute [rw] type
4314
+ # The type of the query.
4315
+ # @return [String]
4316
+ #
4317
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RerankQuery AWS API Documentation
4318
+ #
4319
+ class RerankQuery < Struct.new(
4320
+ :text_query,
4321
+ :type)
4322
+ SENSITIVE = [:text_query]
4323
+ include Aws::Structure
4324
+ end
4325
+
4326
+ # @!attribute [rw] next_token
4327
+ # If the total number of results was greater than could fit in a
4328
+ # response, a token is returned in the `nextToken` field. You can
4329
+ # enter that token in this field to return the next batch of results.
4330
+ # @return [String]
4331
+ #
4332
+ # @!attribute [rw] queries
4333
+ # An array of objects, each of which contains information about a
4334
+ # query to submit to the reranker model.
4335
+ # @return [Array<Types::RerankQuery>]
4336
+ #
4337
+ # @!attribute [rw] reranking_configuration
4338
+ # Contains configurations for reranking.
4339
+ # @return [Types::RerankingConfiguration]
4340
+ #
4341
+ # @!attribute [rw] sources
4342
+ # An array of objects, each of which contains information about the
4343
+ # sources to rerank.
4344
+ # @return [Array<Types::RerankSource>]
4345
+ #
4346
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RerankRequest AWS API Documentation
4347
+ #
4348
+ class RerankRequest < Struct.new(
4349
+ :next_token,
4350
+ :queries,
4351
+ :reranking_configuration,
4352
+ :sources)
4353
+ SENSITIVE = [:queries, :sources]
4354
+ include Aws::Structure
4355
+ end
4356
+
4357
+ # @!attribute [rw] next_token
4358
+ # If the total number of results is greater than can fit in the
4359
+ # response, use this token in the `nextToken` field when making
4360
+ # another request to return the next batch of results.
4361
+ # @return [String]
4362
+ #
4363
+ # @!attribute [rw] results
4364
+ # An array of objects, each of which contains information about the
4365
+ # results of reranking.
4366
+ # @return [Array<Types::RerankResult>]
4367
+ #
4368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RerankResponse AWS API Documentation
4369
+ #
4370
+ class RerankResponse < Struct.new(
4371
+ :next_token,
4372
+ :results)
4373
+ SENSITIVE = []
4374
+ include Aws::Structure
4375
+ end
4376
+
4377
+ # Contains information about a document that was reranked.
4378
+ #
4379
+ # @!attribute [rw] document
4380
+ # Contains information about the document.
4381
+ # @return [Types::RerankDocument]
4382
+ #
4383
+ # @!attribute [rw] index
4384
+ # The ranking of the document. The lower a number, the higher the
4385
+ # document is ranked.
4386
+ # @return [Integer]
4387
+ #
4388
+ # @!attribute [rw] relevance_score
4389
+ # The relevance score of the document.
4390
+ # @return [Float]
4391
+ #
4392
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RerankResult AWS API Documentation
4393
+ #
4394
+ class RerankResult < Struct.new(
4395
+ :document,
4396
+ :index,
4397
+ :relevance_score)
4398
+ SENSITIVE = [:document]
4399
+ include Aws::Structure
4400
+ end
4401
+
4402
+ # Contains information about a source for reranking.
4403
+ #
4404
+ # @!attribute [rw] inline_document_source
4405
+ # Contains an inline definition of a source for reranking.
4406
+ # @return [Types::RerankDocument]
4407
+ #
4408
+ # @!attribute [rw] type
4409
+ # The type of the source.
4410
+ # @return [String]
4411
+ #
4412
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RerankSource AWS API Documentation
4413
+ #
4414
+ class RerankSource < Struct.new(
4415
+ :inline_document_source,
4416
+ :type)
4417
+ SENSITIVE = [:inline_document_source]
4418
+ include Aws::Structure
4419
+ end
4420
+
4421
+ # Contains information about a text document to rerank.
4422
+ #
4423
+ # @!attribute [rw] text
4424
+ # The text of the document.
4425
+ # @return [String]
4426
+ #
4427
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RerankTextDocument AWS API Documentation
4428
+ #
4429
+ class RerankTextDocument < Struct.new(
4430
+ :text)
4431
+ SENSITIVE = []
4432
+ include Aws::Structure
4433
+ end
4434
+
4435
+ # Contains configurations for reranking.
4436
+ #
4437
+ # @!attribute [rw] bedrock_reranking_configuration
4438
+ # Contains configurations for an Amazon Bedrock reranker.
4439
+ # @return [Types::BedrockRerankingConfiguration]
4440
+ #
4441
+ # @!attribute [rw] type
4442
+ # The type of reranker that the configurations apply to.
4443
+ # @return [String]
4444
+ #
4445
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RerankingConfiguration AWS API Documentation
4446
+ #
4447
+ class RerankingConfiguration < Struct.new(
4448
+ :bedrock_reranking_configuration,
4449
+ :type)
4450
+ SENSITIVE = []
4451
+ include Aws::Structure
4452
+ end
4453
+
4454
+ # Contains configurations for the metadata fields to include or exclude
4455
+ # when considering reranking. If you include the `fieldsToExclude`
4456
+ # field, the reranker ignores all the metadata fields that you specify.
4457
+ # If you include the `fieldsToInclude` field, the reranker uses only the
4458
+ # metadata fields that you specify and ignores all others. You can
4459
+ # include only one of these fields.
4460
+ #
4461
+ # @note RerankingMetadataSelectiveModeConfiguration is a union - when making an API calls you must set exactly one of the members.
4462
+ #
4463
+ # @!attribute [rw] fields_to_exclude
4464
+ # An array of objects, each of which specifies a metadata field to
4465
+ # exclude from consideration when reranking.
4466
+ # @return [Array<Types::FieldForReranking>]
4467
+ #
4468
+ # @!attribute [rw] fields_to_include
4469
+ # An array of objects, each of which specifies a metadata field to
4470
+ # include in consideration when reranking. The remaining metadata
4471
+ # fields are ignored.
4472
+ # @return [Array<Types::FieldForReranking>]
4473
+ #
4474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RerankingMetadataSelectiveModeConfiguration AWS API Documentation
4475
+ #
4476
+ class RerankingMetadataSelectiveModeConfiguration < Struct.new(
4477
+ :fields_to_exclude,
4478
+ :fields_to_include,
4479
+ :unknown)
4480
+ SENSITIVE = [:fields_to_exclude, :fields_to_include]
4481
+ include Aws::Structure
4482
+ include Aws::Structure::Union
4483
+
4484
+ class FieldsToExclude < RerankingMetadataSelectiveModeConfiguration; end
4485
+ class FieldsToInclude < RerankingMetadataSelectiveModeConfiguration; end
4486
+ class Unknown < RerankingMetadataSelectiveModeConfiguration; end
4487
+ end
4488
+
3888
4489
  # The specified resource Amazon Resource Name (ARN) was not found. Check
3889
4490
  # the Amazon Resource Name (ARN) and try your request again.
3890
4491
  #
@@ -4140,6 +4741,21 @@ module Aws::BedrockAgentRuntime
4140
4741
  include Aws::Structure
4141
4742
  end
4142
4743
 
4744
+ # Contains information about the location of a document in a custom data
4745
+ # source.
4746
+ #
4747
+ # @!attribute [rw] id
4748
+ # The ID of the document.
4749
+ # @return [String]
4750
+ #
4751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalResultCustomDocumentLocation AWS API Documentation
4752
+ #
4753
+ class RetrievalResultCustomDocumentLocation < Struct.new(
4754
+ :id)
4755
+ SENSITIVE = []
4756
+ include Aws::Structure
4757
+ end
4758
+
4143
4759
  # Contains information about the data source location.
4144
4760
  #
4145
4761
  # This data type is used in the following API operations:
@@ -4160,6 +4776,10 @@ module Aws::BedrockAgentRuntime
4160
4776
  # The Confluence data source location.
4161
4777
  # @return [Types::RetrievalResultConfluenceLocation]
4162
4778
  #
4779
+ # @!attribute [rw] custom_document_location
4780
+ # Specifies the location of a document in a custom data source.
4781
+ # @return [Types::RetrievalResultCustomDocumentLocation]
4782
+ #
4163
4783
  # @!attribute [rw] s3_location
4164
4784
  # The S3 data source location.
4165
4785
  # @return [Types::RetrievalResultS3Location]
@@ -4184,6 +4804,7 @@ module Aws::BedrockAgentRuntime
4184
4804
  #
4185
4805
  class RetrievalResultLocation < Struct.new(
4186
4806
  :confluence_location,
4807
+ :custom_document_location,
4187
4808
  :s3_location,
4188
4809
  :salesforce_location,
4189
4810
  :share_point_location,
@@ -4352,6 +4973,21 @@ module Aws::BedrockAgentRuntime
4352
4973
  include Aws::Structure
4353
4974
  end
4354
4975
 
4976
+ # A retrieve and generate output event.
4977
+ #
4978
+ # @!attribute [rw] text
4979
+ # A text response.
4980
+ # @return [String]
4981
+ #
4982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateOutputEvent AWS API Documentation
4983
+ #
4984
+ class RetrieveAndGenerateOutputEvent < Struct.new(
4985
+ :text,
4986
+ :event_type)
4987
+ SENSITIVE = []
4988
+ include Aws::Structure
4989
+ end
4990
+
4355
4991
  # @!attribute [rw] input
4356
4992
  # Contains the query to be made to the knowledge base.
4357
4993
  # @return [Types::RetrieveAndGenerateInput]
@@ -4448,6 +5084,64 @@ module Aws::BedrockAgentRuntime
4448
5084
  include Aws::Structure
4449
5085
  end
4450
5086
 
5087
+ # @!attribute [rw] input
5088
+ # Contains the query to be made to the knowledge base.
5089
+ # @return [Types::RetrieveAndGenerateInput]
5090
+ #
5091
+ # @!attribute [rw] retrieve_and_generate_configuration
5092
+ # Contains configurations for the knowledge base query and retrieval
5093
+ # process. For more information, see [Query configurations][1].
5094
+ #
5095
+ #
5096
+ #
5097
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
5098
+ # @return [Types::RetrieveAndGenerateConfiguration]
5099
+ #
5100
+ # @!attribute [rw] session_configuration
5101
+ # Contains details about the session with the knowledge base.
5102
+ # @return [Types::RetrieveAndGenerateSessionConfiguration]
5103
+ #
5104
+ # @!attribute [rw] session_id
5105
+ # The unique identifier of the session. When you first make a
5106
+ # `RetrieveAndGenerate` request, Amazon Bedrock automatically
5107
+ # generates this value. You must reuse this value for all subsequent
5108
+ # requests in the same conversational session. This value allows
5109
+ # Amazon Bedrock to maintain context and knowledge from previous
5110
+ # interactions. You can't explicitly set the `sessionId` yourself.
5111
+ # @return [String]
5112
+ #
5113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStreamRequest AWS API Documentation
5114
+ #
5115
+ class RetrieveAndGenerateStreamRequest < Struct.new(
5116
+ :input,
5117
+ :retrieve_and_generate_configuration,
5118
+ :session_configuration,
5119
+ :session_id)
5120
+ SENSITIVE = [:input]
5121
+ include Aws::Structure
5122
+ end
5123
+
5124
+ # @!attribute [rw] session_id
5125
+ # The session ID.
5126
+ # @return [String]
5127
+ #
5128
+ # @!attribute [rw] stream
5129
+ # A stream of events from the model.
5130
+ # @return [Types::RetrieveAndGenerateStreamResponseOutput]
5131
+ #
5132
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStreamResponse AWS API Documentation
5133
+ #
5134
+ class RetrieveAndGenerateStreamResponse < Struct.new(
5135
+ :session_id,
5136
+ :stream)
5137
+ SENSITIVE = []
5138
+ include Aws::Structure
5139
+ end
5140
+
5141
+ # @!attribute [rw] guardrail_configuration
5142
+ # Guardrail settings.
5143
+ # @return [Types::GuardrailConfiguration]
5144
+ #
4451
5145
  # @!attribute [rw] knowledge_base_id
4452
5146
  # The unique identifier of the knowledge base to query.
4453
5147
  # @return [String]
@@ -4474,6 +5168,7 @@ module Aws::BedrockAgentRuntime
4474
5168
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveRequest AWS API Documentation
4475
5169
  #
4476
5170
  class RetrieveRequest < Struct.new(
5171
+ :guardrail_configuration,
4477
5172
  :knowledge_base_id,
4478
5173
  :next_token,
4479
5174
  :retrieval_configuration,
@@ -4482,6 +5177,10 @@ module Aws::BedrockAgentRuntime
4482
5177
  include Aws::Structure
4483
5178
  end
4484
5179
 
5180
+ # @!attribute [rw] guardrail_action
5181
+ # Specifies if there is a guardrail intervention in the response.
5182
+ # @return [String]
5183
+ #
4485
5184
  # @!attribute [rw] next_token
4486
5185
  # If there are more results than can fit in the response, the response
4487
5186
  # returns a `nextToken`. Use this token in the `nextToken` field of
@@ -4495,6 +5194,7 @@ module Aws::BedrockAgentRuntime
4495
5194
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveResponse AWS API Documentation
4496
5195
  #
4497
5196
  class RetrieveResponse < Struct.new(
5197
+ :guardrail_action,
4498
5198
  :next_token,
4499
5199
  :retrieval_results)
4500
5200
  SENSITIVE = [:retrieval_results]
@@ -4575,6 +5275,88 @@ module Aws::BedrockAgentRuntime
4575
5275
  include Aws::Structure
4576
5276
  end
4577
5277
 
5278
+ # An action invocation result.
5279
+ #
5280
+ # @!attribute [rw] invocation_id
5281
+ # The action's invocation ID.
5282
+ # @return [String]
5283
+ #
5284
+ # @!attribute [rw] return_control_invocation_results
5285
+ # The action invocation result.
5286
+ # @return [Array<Types::InvocationResultMember>]
5287
+ #
5288
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/ReturnControlResults AWS API Documentation
5289
+ #
5290
+ class ReturnControlResults < Struct.new(
5291
+ :invocation_id,
5292
+ :return_control_invocation_results)
5293
+ SENSITIVE = []
5294
+ include Aws::Structure
5295
+ end
5296
+
5297
+ # Invocation output from a routing classifier model.
5298
+ #
5299
+ # @!attribute [rw] metadata
5300
+ # The invocation's metadata.
5301
+ # @return [Types::Metadata]
5302
+ #
5303
+ # @!attribute [rw] raw_response
5304
+ # The invocation's raw response.
5305
+ # @return [Types::RawResponse]
5306
+ #
5307
+ # @!attribute [rw] trace_id
5308
+ # The invocation's trace ID.
5309
+ # @return [String]
5310
+ #
5311
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RoutingClassifierModelInvocationOutput AWS API Documentation
5312
+ #
5313
+ class RoutingClassifierModelInvocationOutput < Struct.new(
5314
+ :metadata,
5315
+ :raw_response,
5316
+ :trace_id)
5317
+ SENSITIVE = [:metadata, :raw_response]
5318
+ include Aws::Structure
5319
+ end
5320
+
5321
+ # A trace for a routing classifier.
5322
+ #
5323
+ # @note RoutingClassifierTrace is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RoutingClassifierTrace corresponding to the set member.
5324
+ #
5325
+ # @!attribute [rw] invocation_input
5326
+ # The classifier's invocation input.
5327
+ # @return [Types::InvocationInput]
5328
+ #
5329
+ # @!attribute [rw] model_invocation_input
5330
+ # The classifier's model invocation input.
5331
+ # @return [Types::ModelInvocationInput]
5332
+ #
5333
+ # @!attribute [rw] model_invocation_output
5334
+ # The classifier's model invocation output.
5335
+ # @return [Types::RoutingClassifierModelInvocationOutput]
5336
+ #
5337
+ # @!attribute [rw] observation
5338
+ # The classifier's observation.
5339
+ # @return [Types::Observation]
5340
+ #
5341
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RoutingClassifierTrace AWS API Documentation
5342
+ #
5343
+ class RoutingClassifierTrace < Struct.new(
5344
+ :invocation_input,
5345
+ :model_invocation_input,
5346
+ :model_invocation_output,
5347
+ :observation,
5348
+ :unknown)
5349
+ SENSITIVE = [:invocation_input, :model_invocation_input, :model_invocation_output, :observation]
5350
+ include Aws::Structure
5351
+ include Aws::Structure::Union
5352
+
5353
+ class InvocationInput < RoutingClassifierTrace; end
5354
+ class ModelInvocationInput < RoutingClassifierTrace; end
5355
+ class ModelInvocationOutput < RoutingClassifierTrace; end
5356
+ class Observation < RoutingClassifierTrace; end
5357
+ class Unknown < RoutingClassifierTrace; end
5358
+ end
5359
+
4578
5360
  # The identifier information for an Amazon S3 bucket.
4579
5361
  #
4580
5362
  # @!attribute [rw] s3_bucket_name
@@ -4651,6 +5433,10 @@ module Aws::BedrockAgentRuntime
4651
5433
  # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_InvokeAgent.html
4652
5434
  # [3]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html
4653
5435
  #
5436
+ # @!attribute [rw] conversation_history
5437
+ # The state's conversation history.
5438
+ # @return [Types::ConversationHistory]
5439
+ #
4654
5440
  # @!attribute [rw] files
4655
5441
  # Contains information about the files used by code interpreter.
4656
5442
  # @return [Array<Types::InputFile>]
@@ -4709,6 +5495,7 @@ module Aws::BedrockAgentRuntime
4709
5495
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/SessionState AWS API Documentation
4710
5496
  #
4711
5497
  class SessionState < Struct.new(
5498
+ :conversation_history,
4712
5499
  :files,
4713
5500
  :invocation_id,
4714
5501
  :knowledge_base_configurations,
@@ -4926,6 +5713,10 @@ module Aws::BedrockAgentRuntime
4926
5713
  # contextualizes and categorizes user inputs.
4927
5714
  # @return [Types::PreProcessingTrace]
4928
5715
  #
5716
+ # @!attribute [rw] routing_classifier_trace
5717
+ # A routing classifier's trace.
5718
+ # @return [Types::RoutingClassifierTrace]
5719
+ #
4929
5720
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Trace AWS API Documentation
4930
5721
  #
4931
5722
  class Trace < Struct.new(
@@ -4935,8 +5726,9 @@ module Aws::BedrockAgentRuntime
4935
5726
  :orchestration_trace,
4936
5727
  :post_processing_trace,
4937
5728
  :pre_processing_trace,
5729
+ :routing_classifier_trace,
4938
5730
  :unknown)
4939
- SENSITIVE = [:custom_orchestration_trace, :failure_trace, :guardrail_trace, :orchestration_trace, :post_processing_trace, :pre_processing_trace]
5731
+ SENSITIVE = [:custom_orchestration_trace, :failure_trace, :guardrail_trace, :orchestration_trace, :post_processing_trace, :pre_processing_trace, :routing_classifier_trace]
4940
5732
  include Aws::Structure
4941
5733
  include Aws::Structure::Union
4942
5734
 
@@ -4946,6 +5738,7 @@ module Aws::BedrockAgentRuntime
4946
5738
  class OrchestrationTrace < Trace; end
4947
5739
  class PostProcessingTrace < Trace; end
4948
5740
  class PreProcessingTrace < Trace; end
5741
+ class RoutingClassifierTrace < Trace; end
4949
5742
  class Unknown < Trace; end
4950
5743
  end
4951
5744
 
@@ -4971,6 +5764,14 @@ module Aws::BedrockAgentRuntime
4971
5764
  # The version of the agent.
4972
5765
  # @return [String]
4973
5766
  #
5767
+ # @!attribute [rw] caller_chain
5768
+ # The part's caller chain.
5769
+ # @return [Array<Types::Caller>]
5770
+ #
5771
+ # @!attribute [rw] collaborator_name
5772
+ # The part's collaborator name.
5773
+ # @return [String]
5774
+ #
4974
5775
  # @!attribute [rw] session_id
4975
5776
  # The unique identifier of the session with the agent.
4976
5777
  # @return [String]
@@ -4993,10 +5794,12 @@ module Aws::BedrockAgentRuntime
4993
5794
  :agent_alias_id,
4994
5795
  :agent_id,
4995
5796
  :agent_version,
5797
+ :caller_chain,
5798
+ :collaborator_name,
4996
5799
  :session_id,
4997
5800
  :trace,
4998
5801
  :event_type)
4999
- SENSITIVE = [:trace]
5802
+ SENSITIVE = [:collaborator_name, :trace]
5000
5803
  include Aws::Structure
5001
5804
  end
5002
5805
 
@@ -5036,6 +5839,70 @@ module Aws::BedrockAgentRuntime
5036
5839
  include Aws::Structure
5037
5840
  end
5038
5841
 
5842
+ # Contains configurations for reranking with an Amazon Bedrock reranker
5843
+ # model.
5844
+ #
5845
+ # @!attribute [rw] metadata_configuration
5846
+ # Contains configurations for the metadata to use in reranking.
5847
+ # @return [Types::MetadataConfigurationForReranking]
5848
+ #
5849
+ # @!attribute [rw] model_configuration
5850
+ # Contains configurations for the reranker model.
5851
+ # @return [Types::VectorSearchBedrockRerankingModelConfiguration]
5852
+ #
5853
+ # @!attribute [rw] number_of_reranked_results
5854
+ # The number of results to return after reranking.
5855
+ # @return [Integer]
5856
+ #
5857
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/VectorSearchBedrockRerankingConfiguration AWS API Documentation
5858
+ #
5859
+ class VectorSearchBedrockRerankingConfiguration < Struct.new(
5860
+ :metadata_configuration,
5861
+ :model_configuration,
5862
+ :number_of_reranked_results)
5863
+ SENSITIVE = []
5864
+ include Aws::Structure
5865
+ end
5866
+
5867
+ # Contains configurations for an Amazon Bedrock reranker model.
5868
+ #
5869
+ # @!attribute [rw] additional_model_request_fields
5870
+ # A JSON object whose keys are request fields for the model and whose
5871
+ # values are values for those fields.
5872
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
5873
+ #
5874
+ # @!attribute [rw] model_arn
5875
+ # The ARN of the reranker model to use.
5876
+ # @return [String]
5877
+ #
5878
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/VectorSearchBedrockRerankingModelConfiguration AWS API Documentation
5879
+ #
5880
+ class VectorSearchBedrockRerankingModelConfiguration < Struct.new(
5881
+ :additional_model_request_fields,
5882
+ :model_arn)
5883
+ SENSITIVE = []
5884
+ include Aws::Structure
5885
+ end
5886
+
5887
+ # Contains configurations for reranking the retrieved results.
5888
+ #
5889
+ # @!attribute [rw] bedrock_reranking_configuration
5890
+ # Contains configurations for an Amazon Bedrock reranker model.
5891
+ # @return [Types::VectorSearchBedrockRerankingConfiguration]
5892
+ #
5893
+ # @!attribute [rw] type
5894
+ # The type of reranker model.
5895
+ # @return [String]
5896
+ #
5897
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/VectorSearchRerankingConfiguration AWS API Documentation
5898
+ #
5899
+ class VectorSearchRerankingConfiguration < Struct.new(
5900
+ :bedrock_reranking_configuration,
5901
+ :type)
5902
+ SENSITIVE = []
5903
+ include Aws::Structure
5904
+ end
5905
+
5039
5906
  # The output of the flow.
5040
5907
  #
5041
5908
  # EventStream is an Enumerator of Events.
@@ -5148,6 +6015,34 @@ module Aws::BedrockAgentRuntime
5148
6015
 
5149
6016
  end
5150
6017
 
6018
+ # A retrieve and generate stream response output.
6019
+ #
6020
+ # EventStream is an Enumerator of Events.
6021
+ # #event_types #=> Array, returns all modeled event types in the stream
6022
+ #
6023
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrieveAndGenerateStreamResponseOutput AWS API Documentation
6024
+ #
6025
+ class RetrieveAndGenerateStreamResponseOutput < Enumerator
6026
+
6027
+ def event_types
6028
+ [
6029
+ :access_denied_exception,
6030
+ :bad_gateway_exception,
6031
+ :citation,
6032
+ :conflict_exception,
6033
+ :dependency_failed_exception,
6034
+ :guardrail,
6035
+ :internal_server_exception,
6036
+ :output,
6037
+ :resource_not_found_exception,
6038
+ :service_quota_exceeded_exception,
6039
+ :throttling_exception,
6040
+ :validation_exception
6041
+ ]
6042
+ end
6043
+
6044
+ end
6045
+
5151
6046
  end
5152
6047
  end
5153
6048