aws-sdk-bedrockagent 1.56.0 → 1.57.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.
@@ -386,7 +386,7 @@ module Aws::BedrockAgent
386
386
  #
387
387
  #
388
388
  #
389
- # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html
389
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html
390
390
  # @return [Hash<String,String>]
391
391
  #
392
392
  # @!attribute [rw] parent_action_signature
@@ -742,8 +742,8 @@ module Aws::BedrockAgent
742
742
  end
743
743
 
744
744
  # Defines an agent node in your flow. You specify the agent to invoke at
745
- # this point in the flow. For more information, see [Node types in
746
- # Amazon Bedrock works][1] in the Amazon Bedrock User Guide.
745
+ # this point in the flow. For more information, see [Node types in a
746
+ # flow][1] in the Amazon Bedrock User Guide.
747
747
  #
748
748
  #
749
749
  #
@@ -1470,8 +1470,8 @@ module Aws::BedrockAgent
1470
1470
 
1471
1471
  # Defines a collector node in your flow. This node takes an iteration of
1472
1472
  # inputs and consolidates them into an array in the output. For more
1473
- # information, see [Node types in Amazon Bedrock works][1] in the Amazon
1474
- # Bedrock User Guide.
1473
+ # information, see [Node types in a flow][1] in the Amazon Bedrock User
1474
+ # Guide.
1475
1475
  #
1476
1476
  #
1477
1477
  #
@@ -1485,8 +1485,7 @@ module Aws::BedrockAgent
1485
1485
 
1486
1486
  # Defines a condition node in your flow. You can specify conditions that
1487
1487
  # determine which node comes next in the flow. For more information, see
1488
- # [Node types in Amazon Bedrock works][1] in the Amazon Bedrock User
1489
- # Guide.
1488
+ # [Node types in a flow][1] in the Amazon Bedrock User Guide.
1490
1489
  #
1491
1490
  #
1492
1491
  #
@@ -1774,7 +1773,7 @@ module Aws::BedrockAgent
1774
1773
  #
1775
1774
  #
1776
1775
  #
1777
- # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html
1776
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html
1778
1777
  # @return [String]
1779
1778
  #
1780
1779
  # @!attribute [rw] parent_action_group_signature_params
@@ -1787,7 +1786,7 @@ module Aws::BedrockAgent
1787
1786
  #
1788
1787
  #
1789
1788
  #
1790
- # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html
1789
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html
1791
1790
  # @return [Hash<String,String>]
1792
1791
  #
1793
1792
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateAgentActionGroupRequest AWS API Documentation
@@ -2134,6 +2133,11 @@ module Aws::BedrockAgent
2134
2133
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
2135
2134
  # @return [String]
2136
2135
  #
2136
+ # @!attribute [rw] concurrency_configuration
2137
+ # The configuration that specifies how nodes in the flow are executed
2138
+ # in parallel.
2139
+ # @return [Types::FlowAliasConcurrencyConfiguration]
2140
+ #
2137
2141
  # @!attribute [rw] description
2138
2142
  # A description for the alias.
2139
2143
  # @return [String]
@@ -2163,6 +2167,7 @@ module Aws::BedrockAgent
2163
2167
  #
2164
2168
  class CreateFlowAliasRequest < Struct.new(
2165
2169
  :client_token,
2170
+ :concurrency_configuration,
2166
2171
  :description,
2167
2172
  :flow_identifier,
2168
2173
  :name,
@@ -2176,6 +2181,11 @@ module Aws::BedrockAgent
2176
2181
  # The Amazon Resource Name (ARN) of the alias.
2177
2182
  # @return [String]
2178
2183
  #
2184
+ # @!attribute [rw] concurrency_configuration
2185
+ # The configuration that specifies how nodes in the flow are executed
2186
+ # in parallel.
2187
+ # @return [Types::FlowAliasConcurrencyConfiguration]
2188
+ #
2179
2189
  # @!attribute [rw] created_at
2180
2190
  # The time at which the alias was created.
2181
2191
  # @return [Time]
@@ -2208,6 +2218,7 @@ module Aws::BedrockAgent
2208
2218
  #
2209
2219
  class CreateFlowAliasResponse < Struct.new(
2210
2220
  :arn,
2221
+ :concurrency_configuration,
2211
2222
  :created_at,
2212
2223
  :description,
2213
2224
  :flow_id,
@@ -3709,6 +3720,22 @@ module Aws::BedrockAgent
3709
3720
  include Aws::Structure
3710
3721
  end
3711
3722
 
3723
+ # Specifies a metadata field to include or exclude during the reranking
3724
+ # process.
3725
+ #
3726
+ # @!attribute [rw] field_name
3727
+ # The name of the metadata field to include or exclude during
3728
+ # reranking.
3729
+ # @return [String]
3730
+ #
3731
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FieldForReranking AWS API Documentation
3732
+ #
3733
+ class FieldForReranking < Struct.new(
3734
+ :field_name)
3735
+ SENSITIVE = []
3736
+ include Aws::Structure
3737
+ end
3738
+
3712
3739
  # Configurations for when you choose fixed-size chunking. If you set the
3713
3740
  # `chunkingStrategy` as `NONE`, exclude this field.
3714
3741
  #
@@ -3729,6 +3756,34 @@ module Aws::BedrockAgent
3729
3756
  include Aws::Structure
3730
3757
  end
3731
3758
 
3759
+ # Determines how multiple nodes in a flow can run in parallel. Running
3760
+ # nodes concurrently can improve your flow's performance.
3761
+ #
3762
+ # @!attribute [rw] max_concurrency
3763
+ # The maximum number of nodes that can be executed concurrently in the
3764
+ # flow.
3765
+ # @return [Integer]
3766
+ #
3767
+ # @!attribute [rw] type
3768
+ # The type of concurrency to use for parallel node execution. Specify
3769
+ # one of the following options:
3770
+ #
3771
+ # * `Automatic` - Amazon Bedrock determines which nodes can be
3772
+ # executed in parallel based on the flow definition and its
3773
+ # dependencies.
3774
+ #
3775
+ # * `Manual` - You specify which nodes can be executed in parallel.
3776
+ # @return [String]
3777
+ #
3778
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowAliasConcurrencyConfiguration AWS API Documentation
3779
+ #
3780
+ class FlowAliasConcurrencyConfiguration < Struct.new(
3781
+ :max_concurrency,
3782
+ :type)
3783
+ SENSITIVE = []
3784
+ include Aws::Structure
3785
+ end
3786
+
3732
3787
  # Contains information about a version that the alias maps to.
3733
3788
  #
3734
3789
  # @!attribute [rw] flow_version
@@ -3759,6 +3814,11 @@ module Aws::BedrockAgent
3759
3814
  # The Amazon Resource Name (ARN) of the alias.
3760
3815
  # @return [String]
3761
3816
  #
3817
+ # @!attribute [rw] concurrency_configuration
3818
+ # The configuration that specifies how nodes in the flow are executed
3819
+ # concurrently.
3820
+ # @return [Types::FlowAliasConcurrencyConfiguration]
3821
+ #
3762
3822
  # @!attribute [rw] created_at
3763
3823
  # The time at which the alias was created.
3764
3824
  # @return [Time]
@@ -3792,6 +3852,7 @@ module Aws::BedrockAgent
3792
3852
  #
3793
3853
  class FlowAliasSummary < Struct.new(
3794
3854
  :arn,
3855
+ :concurrency_configuration,
3795
3856
  :created_at,
3796
3857
  :description,
3797
3858
  :flow_id,
@@ -3994,8 +4055,7 @@ module Aws::BedrockAgent
3994
4055
  end
3995
4056
 
3996
4057
  # Contains configurations for a node in your flow. For more information,
3997
- # see [Node types in Amazon Bedrock works][1] in the Amazon Bedrock User
3998
- # Guide.
4058
+ # see [Node types in a flow][1] in the Amazon Bedrock User Guide.
3999
4059
  #
4000
4060
  #
4001
4061
  #
@@ -4061,6 +4121,19 @@ module Aws::BedrockAgent
4061
4121
  # intent as the output.
4062
4122
  # @return [Types::LexFlowNodeConfiguration]
4063
4123
  #
4124
+ # @!attribute [rw] loop
4125
+ # Contains configurations for a DoWhile loop in your flow.
4126
+ # @return [Types::LoopFlowNodeConfiguration]
4127
+ #
4128
+ # @!attribute [rw] loop_controller
4129
+ # Contains controller node configurations for a DoWhile loop in your
4130
+ # flow.
4131
+ # @return [Types::LoopControllerFlowNodeConfiguration]
4132
+ #
4133
+ # @!attribute [rw] loop_input
4134
+ # Contains input node configurations for a DoWhile loop in your flow.
4135
+ # @return [Types::LoopInputFlowNodeConfiguration]
4136
+ #
4064
4137
  # @!attribute [rw] output
4065
4138
  # Contains configurations for an output flow node in your flow. The
4066
4139
  # last node in the flow. `outputs` can't be specified for this node.
@@ -4094,6 +4167,9 @@ module Aws::BedrockAgent
4094
4167
  :knowledge_base,
4095
4168
  :lambda_function,
4096
4169
  :lex,
4170
+ :loop,
4171
+ :loop_controller,
4172
+ :loop_input,
4097
4173
  :output,
4098
4174
  :prompt,
4099
4175
  :retrieval,
@@ -4112,6 +4188,9 @@ module Aws::BedrockAgent
4112
4188
  class KnowledgeBase < FlowNodeConfiguration; end
4113
4189
  class LambdaFunction < FlowNodeConfiguration; end
4114
4190
  class Lex < FlowNodeConfiguration; end
4191
+ class Loop < FlowNodeConfiguration; end
4192
+ class LoopController < FlowNodeConfiguration; end
4193
+ class LoopInput < FlowNodeConfiguration; end
4115
4194
  class Output < FlowNodeConfiguration; end
4116
4195
  class Prompt < FlowNodeConfiguration; end
4117
4196
  class Retrieval < FlowNodeConfiguration; end
@@ -4119,7 +4198,24 @@ module Aws::BedrockAgent
4119
4198
  class Unknown < FlowNodeConfiguration; end
4120
4199
  end
4121
4200
 
4122
- # Contains configurations for an input to a node.
4201
+ # Contains configurations for an input in an Amazon Bedrock Flows node.
4202
+ #
4203
+ # @!attribute [rw] category
4204
+ # Specifies how input data flows between iterations in a DoWhile loop.
4205
+ #
4206
+ # * `LoopCondition` - Controls whether the loop continues by
4207
+ # evaluating condition expressions against the input data. Use this
4208
+ # category to define the condition that determines if the loop
4209
+ # should continue.
4210
+ #
4211
+ # * `ReturnValueToLoopStart` - Defines data to pass back to the start
4212
+ # of the loop's next iteration. Use this category for variables
4213
+ # that you want to update for each loop iteration.
4214
+ #
4215
+ # * `ExitLoop` - Defines the value that's available once the loop
4216
+ # ends. Use this category to expose loop results to nodes outside
4217
+ # the loop.
4218
+ # @return [String]
4123
4219
  #
4124
4220
  # @!attribute [rw] expression
4125
4221
  # An expression that formats the input for the node. For an
@@ -4132,17 +4228,18 @@ module Aws::BedrockAgent
4132
4228
  # @return [String]
4133
4229
  #
4134
4230
  # @!attribute [rw] name
4135
- # A name for the input that you can reference.
4231
+ # Specifies a name for the input that you can reference.
4136
4232
  # @return [String]
4137
4233
  #
4138
4234
  # @!attribute [rw] type
4139
- # The data type of the input. If the input doesn't match this type at
4140
- # runtime, a validation error will be thrown.
4235
+ # Specifies the data type of the input. If the input doesn't match
4236
+ # this type at runtime, a validation error will be thrown.
4141
4237
  # @return [String]
4142
4238
  #
4143
4239
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowNodeInput AWS API Documentation
4144
4240
  #
4145
4241
  class FlowNodeInput < Struct.new(
4242
+ :category,
4146
4243
  :expression,
4147
4244
  :name,
4148
4245
  :type)
@@ -4301,6 +4398,16 @@ module Aws::BedrockAgent
4301
4398
  # Details about incompatible data types in a connection.
4302
4399
  # @return [Types::IncompatibleConnectionDataTypeFlowValidationDetails]
4303
4400
  #
4401
+ # @!attribute [rw] invalid_loop_boundary
4402
+ # Details about a flow that includes connections that violate loop
4403
+ # boundary rules.
4404
+ # @return [Types::InvalidLoopBoundaryFlowValidationDetails]
4405
+ #
4406
+ # @!attribute [rw] loop_incompatible_node_type
4407
+ # Details about a flow that includes incompatible node types in a
4408
+ # DoWhile loop.
4409
+ # @return [Types::LoopIncompatibleNodeTypeFlowValidationDetails]
4410
+ #
4304
4411
  # @!attribute [rw] malformed_condition_expression
4305
4412
  # Details about a malformed condition expression in a node.
4306
4413
  # @return [Types::MalformedConditionExpressionFlowValidationDetails]
@@ -4329,6 +4436,16 @@ module Aws::BedrockAgent
4329
4436
  # Details about missing ending nodes in the flow.
4330
4437
  # @return [Types::MissingEndingNodesFlowValidationDetails]
4331
4438
  #
4439
+ # @!attribute [rw] missing_loop_controller_node
4440
+ # Details about a flow that's missing a required `LoopController`
4441
+ # node in a DoWhile loop.
4442
+ # @return [Types::MissingLoopControllerNodeFlowValidationDetails]
4443
+ #
4444
+ # @!attribute [rw] missing_loop_input_node
4445
+ # Details about a flow that's missing a required `LoopInput` node in
4446
+ # a DoWhile loop.
4447
+ # @return [Types::MissingLoopInputNodeFlowValidationDetails]
4448
+ #
4332
4449
  # @!attribute [rw] missing_node_configuration
4333
4450
  # Details about missing configuration for a node.
4334
4451
  # @return [Types::MissingNodeConfigurationFlowValidationDetails]
@@ -4345,6 +4462,16 @@ module Aws::BedrockAgent
4345
4462
  # Details about missing starting nodes in the flow.
4346
4463
  # @return [Types::MissingStartingNodesFlowValidationDetails]
4347
4464
  #
4465
+ # @!attribute [rw] multiple_loop_controller_nodes
4466
+ # Details about a flow that contains multiple `LoopController` nodes
4467
+ # in a DoWhile loop.
4468
+ # @return [Types::MultipleLoopControllerNodesFlowValidationDetails]
4469
+ #
4470
+ # @!attribute [rw] multiple_loop_input_nodes
4471
+ # Details about a flow that contains multiple `LoopInput` nodes in a
4472
+ # DoWhile loop.
4473
+ # @return [Types::MultipleLoopInputNodesFlowValidationDetails]
4474
+ #
4348
4475
  # @!attribute [rw] multiple_node_input_connections
4349
4476
  # Details about multiple connections to a single node input.
4350
4477
  # @return [Types::MultipleNodeInputConnectionsFlowValidationDetails]
@@ -4400,6 +4527,8 @@ module Aws::BedrockAgent
4400
4527
  :duplicate_condition_expression,
4401
4528
  :duplicate_connections,
4402
4529
  :incompatible_connection_data_type,
4530
+ :invalid_loop_boundary,
4531
+ :loop_incompatible_node_type,
4403
4532
  :malformed_condition_expression,
4404
4533
  :malformed_node_input_expression,
4405
4534
  :mismatched_node_input_type,
@@ -4407,10 +4536,14 @@ module Aws::BedrockAgent
4407
4536
  :missing_connection_configuration,
4408
4537
  :missing_default_condition,
4409
4538
  :missing_ending_nodes,
4539
+ :missing_loop_controller_node,
4540
+ :missing_loop_input_node,
4410
4541
  :missing_node_configuration,
4411
4542
  :missing_node_input,
4412
4543
  :missing_node_output,
4413
4544
  :missing_starting_nodes,
4545
+ :multiple_loop_controller_nodes,
4546
+ :multiple_loop_input_nodes,
4414
4547
  :multiple_node_input_connections,
4415
4548
  :unfulfilled_node_input,
4416
4549
  :unknown_connection_condition,
@@ -4432,6 +4565,8 @@ module Aws::BedrockAgent
4432
4565
  class DuplicateConditionExpression < FlowValidationDetails; end
4433
4566
  class DuplicateConnections < FlowValidationDetails; end
4434
4567
  class IncompatibleConnectionDataType < FlowValidationDetails; end
4568
+ class InvalidLoopBoundary < FlowValidationDetails; end
4569
+ class LoopIncompatibleNodeType < FlowValidationDetails; end
4435
4570
  class MalformedConditionExpression < FlowValidationDetails; end
4436
4571
  class MalformedNodeInputExpression < FlowValidationDetails; end
4437
4572
  class MismatchedNodeInputType < FlowValidationDetails; end
@@ -4439,10 +4574,14 @@ module Aws::BedrockAgent
4439
4574
  class MissingConnectionConfiguration < FlowValidationDetails; end
4440
4575
  class MissingDefaultCondition < FlowValidationDetails; end
4441
4576
  class MissingEndingNodes < FlowValidationDetails; end
4577
+ class MissingLoopControllerNode < FlowValidationDetails; end
4578
+ class MissingLoopInputNode < FlowValidationDetails; end
4442
4579
  class MissingNodeConfiguration < FlowValidationDetails; end
4443
4580
  class MissingNodeInput < FlowValidationDetails; end
4444
4581
  class MissingNodeOutput < FlowValidationDetails; end
4445
4582
  class MissingStartingNodes < FlowValidationDetails; end
4583
+ class MultipleLoopControllerNodes < FlowValidationDetails; end
4584
+ class MultipleLoopInputNodes < FlowValidationDetails; end
4446
4585
  class MultipleNodeInputConnections < FlowValidationDetails; end
4447
4586
  class UnfulfilledNodeInput < FlowValidationDetails; end
4448
4587
  class UnknownConnectionCondition < FlowValidationDetails; end
@@ -4840,6 +4979,11 @@ module Aws::BedrockAgent
4840
4979
  # The Amazon Resource Name (ARN) of the flow.
4841
4980
  # @return [String]
4842
4981
  #
4982
+ # @!attribute [rw] concurrency_configuration
4983
+ # The configuration that specifies how nodes in the flow are executed
4984
+ # in parallel.
4985
+ # @return [Types::FlowAliasConcurrencyConfiguration]
4986
+ #
4843
4987
  # @!attribute [rw] created_at
4844
4988
  # The time at which the flow was created.
4845
4989
  # @return [Time]
@@ -4872,6 +5016,7 @@ module Aws::BedrockAgent
4872
5016
  #
4873
5017
  class GetFlowAliasResponse < Struct.new(
4874
5018
  :arn,
5019
+ :concurrency_configuration,
4875
5020
  :created_at,
4876
5021
  :description,
4877
5022
  :flow_id,
@@ -5753,6 +5898,33 @@ module Aws::BedrockAgent
5753
5898
  include Aws::Structure
5754
5899
  end
5755
5900
 
5901
+ # Details about a flow that contains connections that violate loop
5902
+ # boundary rules.
5903
+ #
5904
+ # @!attribute [rw] connection
5905
+ # The name of the connection that violates loop boundary rules.
5906
+ # @return [String]
5907
+ #
5908
+ # @!attribute [rw] source
5909
+ # The source node of the connection that violates DoWhile loop
5910
+ # boundary rules.
5911
+ # @return [String]
5912
+ #
5913
+ # @!attribute [rw] target
5914
+ # The target node of the connection that violates DoWhile loop
5915
+ # boundary rules.
5916
+ # @return [String]
5917
+ #
5918
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/InvalidLoopBoundaryFlowValidationDetails AWS API Documentation
5919
+ #
5920
+ class InvalidLoopBoundaryFlowValidationDetails < Struct.new(
5921
+ :connection,
5922
+ :source,
5923
+ :target)
5924
+ SENSITIVE = []
5925
+ include Aws::Structure
5926
+ end
5927
+
5756
5928
  # Contains configurations for an iterator node in a flow. Takes an input
5757
5929
  # that is an array and iteratively sends each item of the array as an
5758
5930
  # output to the following node. The size of the array is also returned
@@ -5985,8 +6157,8 @@ module Aws::BedrockAgent
5985
6157
  # Contains configurations for a knowledge base node in a flow. This node
5986
6158
  # takes a query as the input and returns, as the output, the retrieved
5987
6159
  # responses directly (as an array) or a response generated based on the
5988
- # retrieved responses. For more information, see [Node types in Amazon
5989
- # Bedrock works][1] in the Amazon Bedrock User Guide.
6160
+ # retrieved responses. For more information, see [Node types in a
6161
+ # flow][1] in the Amazon Bedrock User Guide.
5990
6162
  #
5991
6163
  #
5992
6164
  #
@@ -5997,6 +6169,10 @@ module Aws::BedrockAgent
5997
6169
  # response generation for the knowledge base in this configuration.
5998
6170
  # @return [Types::GuardrailConfiguration]
5999
6171
  #
6172
+ # @!attribute [rw] inference_configuration
6173
+ # Contains inference configurations for the prompt.
6174
+ # @return [Types::PromptInferenceConfiguration]
6175
+ #
6000
6176
  # @!attribute [rw] knowledge_base_id
6001
6177
  # The unique identifier of the knowledge base to query.
6002
6178
  # @return [String]
@@ -6011,16 +6187,89 @@ module Aws::BedrockAgent
6011
6187
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html
6012
6188
  # @return [String]
6013
6189
  #
6190
+ # @!attribute [rw] number_of_results
6191
+ # The number of results to retrieve from the knowledge base.
6192
+ # @return [Integer]
6193
+ #
6194
+ # @!attribute [rw] orchestration_configuration
6195
+ # The configuration for orchestrating the retrieval and generation
6196
+ # process in the knowledge base node.
6197
+ # @return [Types::KnowledgeBaseOrchestrationConfiguration]
6198
+ #
6199
+ # @!attribute [rw] prompt_template
6200
+ # A custom prompt template to use with the knowledge base for
6201
+ # generating responses.
6202
+ # @return [Types::KnowledgeBasePromptTemplate]
6203
+ #
6204
+ # @!attribute [rw] reranking_configuration
6205
+ # The configuration for reranking the retrieved results from the
6206
+ # knowledge base to improve relevance.
6207
+ # @return [Types::VectorSearchRerankingConfiguration]
6208
+ #
6014
6209
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseFlowNodeConfiguration AWS API Documentation
6015
6210
  #
6016
6211
  class KnowledgeBaseFlowNodeConfiguration < Struct.new(
6017
6212
  :guardrail_configuration,
6213
+ :inference_configuration,
6018
6214
  :knowledge_base_id,
6019
- :model_id)
6215
+ :model_id,
6216
+ :number_of_results,
6217
+ :orchestration_configuration,
6218
+ :prompt_template,
6219
+ :reranking_configuration)
6220
+ SENSITIVE = []
6221
+ include Aws::Structure
6222
+ end
6223
+
6224
+ # Configures how the knowledge base orchestrates the retrieval and
6225
+ # generation process, allowing for customization of prompts, inference
6226
+ # parameters, and performance settings.
6227
+ #
6228
+ # @!attribute [rw] additional_model_request_fields
6229
+ # The additional model-specific request parameters as key-value pairs
6230
+ # to be included in the request to the foundation model.
6231
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
6232
+ #
6233
+ # @!attribute [rw] inference_config
6234
+ # Contains inference configurations for the prompt.
6235
+ # @return [Types::PromptInferenceConfiguration]
6236
+ #
6237
+ # @!attribute [rw] performance_config
6238
+ # The performance configuration options for the knowledge base
6239
+ # retrieval and generation process.
6240
+ # @return [Types::PerformanceConfiguration]
6241
+ #
6242
+ # @!attribute [rw] prompt_template
6243
+ # A custom prompt template for orchestrating the retrieval and
6244
+ # generation process.
6245
+ # @return [Types::KnowledgeBasePromptTemplate]
6246
+ #
6247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseOrchestrationConfiguration AWS API Documentation
6248
+ #
6249
+ class KnowledgeBaseOrchestrationConfiguration < Struct.new(
6250
+ :additional_model_request_fields,
6251
+ :inference_config,
6252
+ :performance_config,
6253
+ :prompt_template)
6020
6254
  SENSITIVE = []
6021
6255
  include Aws::Structure
6022
6256
  end
6023
6257
 
6258
+ # Defines a custom prompt template for orchestrating the retrieval and
6259
+ # generation process.
6260
+ #
6261
+ # @!attribute [rw] text_prompt_template
6262
+ # The text of the prompt template.
6263
+ # @return [String]
6264
+ #
6265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBasePromptTemplate AWS API Documentation
6266
+ #
6267
+ class KnowledgeBasePromptTemplate < Struct.new(
6268
+ :text_prompt_template)
6269
+ SENSITIVE = [:text_prompt_template]
6270
+ include Aws::Structure
6271
+ end
6272
+
6024
6273
  # Contains details about a knowledge base.
6025
6274
  #
6026
6275
  # @!attribute [rw] description
@@ -6058,8 +6307,8 @@ module Aws::BedrockAgent
6058
6307
  # Contains configurations for a Lambda function node in the flow. You
6059
6308
  # specify the Lambda function to invoke and the inputs into the
6060
6309
  # function. The output is the response that is defined in the Lambda
6061
- # function. For more information, see [Node types in Amazon Bedrock
6062
- # works][1] in the Amazon Bedrock User Guide.
6310
+ # function. For more information, see [Node types in a flow][1] in the
6311
+ # Amazon Bedrock User Guide.
6063
6312
  #
6064
6313
  #
6065
6314
  #
@@ -6080,8 +6329,8 @@ module Aws::BedrockAgent
6080
6329
  # Contains configurations for a Lex node in the flow. You specify a
6081
6330
  # Amazon Lex bot to invoke. This node takes an utterance as the input
6082
6331
  # and returns as the output the intent identified by the Amazon Lex bot.
6083
- # For more information, see [Node types in Amazon Bedrock works][1] in
6084
- # the Amazon Bedrock User Guide.
6332
+ # For more information, see [Node types in a flow][1] in the Amazon
6333
+ # Bedrock User Guide.
6085
6334
  #
6086
6335
  #
6087
6336
  #
@@ -6835,6 +7084,98 @@ module Aws::BedrockAgent
6835
7084
  include Aws::Structure
6836
7085
  end
6837
7086
 
7087
+ # Contains configurations for the controller node of a DoWhile loop in
7088
+ # the flow.
7089
+ #
7090
+ # @!attribute [rw] continue_condition
7091
+ # Specifies the condition that determines when the flow exits the
7092
+ # DoWhile loop. The loop executes until this condition evaluates to
7093
+ # true.
7094
+ # @return [Types::FlowCondition]
7095
+ #
7096
+ # @!attribute [rw] max_iterations
7097
+ # Specifies the maximum number of times the DoWhile loop can iterate
7098
+ # before the flow exits the loop.
7099
+ # @return [Integer]
7100
+ #
7101
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/LoopControllerFlowNodeConfiguration AWS API Documentation
7102
+ #
7103
+ class LoopControllerFlowNodeConfiguration < Struct.new(
7104
+ :continue_condition,
7105
+ :max_iterations)
7106
+ SENSITIVE = []
7107
+ include Aws::Structure
7108
+ end
7109
+
7110
+ # Contains configurations for the nodes of a DoWhile loop in your flow.
7111
+ #
7112
+ # A DoWhile loop is made up of the following nodes:
7113
+ #
7114
+ # * `Loop` - The container node that holds the loop's flow definition.
7115
+ # This node encompasses the entire loop structure.
7116
+ #
7117
+ # * `LoopInput` - The entry point node for the loop. This node receives
7118
+ # inputs from nodes outside the loop and from previous loop
7119
+ # iterations.
7120
+ #
7121
+ # * Body nodes - These can be
7122
+ #
7123
+ # * `LoopController` - The node that evaluates whether the loop should
7124
+ # continue or exit based on a condition.
7125
+ #
7126
+ # These nodes work together to create a loop that runs at least once and
7127
+ # continues until a specified condition is met or a maximum number of
7128
+ # iterations is reached.
7129
+ #
7130
+ # @!attribute [rw] definition
7131
+ # The definition of the DoWhile loop nodes and connections between
7132
+ # nodes in the flow.
7133
+ # @return [Types::FlowDefinition]
7134
+ #
7135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/LoopFlowNodeConfiguration AWS API Documentation
7136
+ #
7137
+ class LoopFlowNodeConfiguration < Struct.new(
7138
+ :definition)
7139
+ SENSITIVE = [:definition]
7140
+ include Aws::Structure
7141
+ end
7142
+
7143
+ # Details about a flow that contains an incompatible node in a DoWhile
7144
+ # loop.
7145
+ #
7146
+ # @!attribute [rw] incompatible_node_name
7147
+ # The node that's incompatible in the DoWhile loop.
7148
+ # @return [String]
7149
+ #
7150
+ # @!attribute [rw] incompatible_node_type
7151
+ # The node type of the incompatible node in the DoWhile loop. Some
7152
+ # node types, like a condition node, aren't allowed in a DoWhile
7153
+ # loop.
7154
+ # @return [String]
7155
+ #
7156
+ # @!attribute [rw] node
7157
+ # The `Loop` container node that contains an incompatible node.
7158
+ # @return [String]
7159
+ #
7160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/LoopIncompatibleNodeTypeFlowValidationDetails AWS API Documentation
7161
+ #
7162
+ class LoopIncompatibleNodeTypeFlowValidationDetails < Struct.new(
7163
+ :incompatible_node_name,
7164
+ :incompatible_node_type,
7165
+ :node)
7166
+ SENSITIVE = []
7167
+ include Aws::Structure
7168
+ end
7169
+
7170
+ # Contains configurations for the input node of a DoWhile loop in the
7171
+ # flow.
7172
+ #
7173
+ # @api private
7174
+ #
7175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/LoopInputFlowNodeConfiguration AWS API Documentation
7176
+ #
7177
+ class LoopInputFlowNodeConfiguration < Aws::EmptyStructure; end
7178
+
6838
7179
  # Details about a malformed condition expression in a node.
6839
7180
  #
6840
7181
  # @!attribute [rw] cause
@@ -6988,6 +7329,27 @@ module Aws::BedrockAgent
6988
7329
  include Aws::Structure
6989
7330
  end
6990
7331
 
7332
+ # Specifies how metadata fields should be handled during the reranking
7333
+ # process.
7334
+ #
7335
+ # @!attribute [rw] selection_mode
7336
+ # The mode for selecting metadata fields for reranking.
7337
+ # @return [String]
7338
+ #
7339
+ # @!attribute [rw] selective_mode_configuration
7340
+ # The configuration for selective metadata field inclusion or
7341
+ # exclusion during reranking.
7342
+ # @return [Types::RerankingMetadataSelectiveModeConfiguration]
7343
+ #
7344
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MetadataConfigurationForReranking AWS API Documentation
7345
+ #
7346
+ class MetadataConfigurationForReranking < Struct.new(
7347
+ :selection_mode,
7348
+ :selective_mode_configuration)
7349
+ SENSITIVE = []
7350
+ include Aws::Structure
7351
+ end
7352
+
6991
7353
  # Details about mismatched input data types in a node.
6992
7354
  #
6993
7355
  # @!attribute [rw] expected_type
@@ -7073,10 +7435,42 @@ module Aws::BedrockAgent
7073
7435
  #
7074
7436
  class MissingEndingNodesFlowValidationDetails < Aws::EmptyStructure; end
7075
7437
 
7076
- # Details about a node missing required configuration.
7438
+ # Details about a flow that's missing a required `LoopController` node
7439
+ # in a DoWhile loop.
7440
+ #
7441
+ # @!attribute [rw] loop_node
7442
+ # The DoWhile loop in a flow that's missing a required
7443
+ # `LoopController` node.
7444
+ # @return [String]
7445
+ #
7446
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MissingLoopControllerNodeFlowValidationDetails AWS API Documentation
7447
+ #
7448
+ class MissingLoopControllerNodeFlowValidationDetails < Struct.new(
7449
+ :loop_node)
7450
+ SENSITIVE = []
7451
+ include Aws::Structure
7452
+ end
7453
+
7454
+ # Details about a flow that's missing a required `LoopInput` node in a
7455
+ # DoWhile loop.
7456
+ #
7457
+ # @!attribute [rw] loop_node
7458
+ # The DoWhile loop in a flow that's missing a required `LoopInput`
7459
+ # node.
7460
+ # @return [String]
7461
+ #
7462
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MissingLoopInputNodeFlowValidationDetails AWS API Documentation
7463
+ #
7464
+ class MissingLoopInputNodeFlowValidationDetails < Struct.new(
7465
+ :loop_node)
7466
+ SENSITIVE = []
7467
+ include Aws::Structure
7468
+ end
7469
+
7470
+ # Details about a node missing a required configuration.
7077
7471
  #
7078
7472
  # @!attribute [rw] node
7079
- # The name of the node missing configuration.
7473
+ # The name of the node missing a required configuration.
7080
7474
  # @return [String]
7081
7475
  #
7082
7476
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MissingNodeConfigurationFlowValidationDetails AWS API Documentation
@@ -7218,6 +7612,37 @@ module Aws::BedrockAgent
7218
7612
  include Aws::Structure
7219
7613
  end
7220
7614
 
7615
+ # Details about a flow that contains multiple `LoopController` nodes in
7616
+ # a DoWhile loop.
7617
+ #
7618
+ # @!attribute [rw] loop_node
7619
+ # The DoWhile loop in a flow that contains multiple `LoopController`
7620
+ # nodes.
7621
+ # @return [String]
7622
+ #
7623
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MultipleLoopControllerNodesFlowValidationDetails AWS API Documentation
7624
+ #
7625
+ class MultipleLoopControllerNodesFlowValidationDetails < Struct.new(
7626
+ :loop_node)
7627
+ SENSITIVE = []
7628
+ include Aws::Structure
7629
+ end
7630
+
7631
+ # Details about a flow that contains multiple `LoopInput` nodes in a
7632
+ # DoWhile loop.
7633
+ #
7634
+ # @!attribute [rw] loop_node
7635
+ # The DoWhile loop in a flow that contains multiple `LoopInput` nodes.
7636
+ # @return [String]
7637
+ #
7638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MultipleLoopInputNodesFlowValidationDetails AWS API Documentation
7639
+ #
7640
+ class MultipleLoopInputNodesFlowValidationDetails < Struct.new(
7641
+ :loop_node)
7642
+ SENSITIVE = []
7643
+ include Aws::Structure
7644
+ end
7645
+
7221
7646
  # Details about multiple connections to a single node input.
7222
7647
  #
7223
7648
  # @!attribute [rw] input
@@ -7602,6 +8027,21 @@ module Aws::BedrockAgent
7602
8027
  include Aws::Structure
7603
8028
  end
7604
8029
 
8030
+ # The performance-related configuration options for the knowledge base
8031
+ # retrieval and generation process.
8032
+ #
8033
+ # @!attribute [rw] latency
8034
+ # The latency optimization setting.
8035
+ # @return [String]
8036
+ #
8037
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PerformanceConfiguration AWS API Documentation
8038
+ #
8039
+ class PerformanceConfiguration < Struct.new(
8040
+ :latency)
8041
+ SENSITIVE = []
8042
+ include Aws::Structure
8043
+ end
8044
+
7605
8045
  # Contains details about the storage configuration of the knowledge base
7606
8046
  # in Pinecone. For more information, see [Create a vector index in
7607
8047
  # Pinecone][1].
@@ -7828,7 +8268,7 @@ module Aws::BedrockAgent
7828
8268
  # skips that step. The default state for each `promptType` is as
7829
8269
  # follows.
7830
8270
  #
7831
- # * `PRE_PROCESSING` – `DISABLED`
8271
+ # * `PRE_PROCESSING` – `ENABLED`
7832
8272
  #
7833
8273
  # * `ORCHESTRATION` – `ENABLED`
7834
8274
  #
@@ -7861,8 +8301,8 @@ module Aws::BedrockAgent
7861
8301
  # prompt from Prompt management or you can define one in this node. If
7862
8302
  # the prompt contains variables, the inputs into this node will fill in
7863
8303
  # the variables. The output from this node is the response generated by
7864
- # the model. For more information, see [Node types in Amazon Bedrock
7865
- # works][1] in the Amazon Bedrock User Guide.
8304
+ # the model. For more information, see [Node types in a flow][1] in the
8305
+ # Amazon Bedrock User Guide.
7866
8306
  #
7867
8307
  #
7868
8308
  #
@@ -8768,6 +9208,36 @@ module Aws::BedrockAgent
8768
9208
  include Aws::Structure
8769
9209
  end
8770
9210
 
9211
+ # Configures the metadata fields to include or exclude during the
9212
+ # reranking process when using selective mode.
9213
+ #
9214
+ # @note RerankingMetadataSelectiveModeConfiguration is a union - when making an API calls you must set exactly one of the members.
9215
+ #
9216
+ # @note RerankingMetadataSelectiveModeConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RerankingMetadataSelectiveModeConfiguration corresponding to the set member.
9217
+ #
9218
+ # @!attribute [rw] fields_to_exclude
9219
+ # Specifies the metadata fields to exclude from the reranking process.
9220
+ # @return [Array<Types::FieldForReranking>]
9221
+ #
9222
+ # @!attribute [rw] fields_to_include
9223
+ # Specifies the metadata fields to include in the reranking process.
9224
+ # @return [Array<Types::FieldForReranking>]
9225
+ #
9226
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RerankingMetadataSelectiveModeConfiguration AWS API Documentation
9227
+ #
9228
+ class RerankingMetadataSelectiveModeConfiguration < Struct.new(
9229
+ :fields_to_exclude,
9230
+ :fields_to_include,
9231
+ :unknown)
9232
+ SENSITIVE = [:fields_to_exclude, :fields_to_include]
9233
+ include Aws::Structure
9234
+ include Aws::Structure::Union
9235
+
9236
+ class FieldsToExclude < RerankingMetadataSelectiveModeConfiguration; end
9237
+ class FieldsToInclude < RerankingMetadataSelectiveModeConfiguration; end
9238
+ class Unknown < RerankingMetadataSelectiveModeConfiguration; end
9239
+ end
9240
+
8771
9241
  # The specified resource Amazon Resource Name (ARN) was not found. Check
8772
9242
  # the Amazon Resource Name (ARN) and try your request again.
8773
9243
  #
@@ -10082,7 +10552,7 @@ module Aws::BedrockAgent
10082
10552
  #
10083
10553
  #
10084
10554
  #
10085
- # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html
10555
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html
10086
10556
  # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Observation.html
10087
10557
  # @return [String]
10088
10558
  #
@@ -10096,7 +10566,7 @@ module Aws::BedrockAgent
10096
10566
  #
10097
10567
  #
10098
10568
  #
10099
- # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agents-computer-use.html
10569
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/agent-computer-use.html
10100
10570
  # @return [Hash<String,String>]
10101
10571
  #
10102
10572
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateAgentActionGroupRequest AWS API Documentation
@@ -10488,6 +10958,11 @@ module Aws::BedrockAgent
10488
10958
  # The unique identifier of the alias.
10489
10959
  # @return [String]
10490
10960
  #
10961
+ # @!attribute [rw] concurrency_configuration
10962
+ # The configuration that specifies how nodes in the flow are executed
10963
+ # in parallel.
10964
+ # @return [Types::FlowAliasConcurrencyConfiguration]
10965
+ #
10491
10966
  # @!attribute [rw] description
10492
10967
  # A description for the alias.
10493
10968
  # @return [String]
@@ -10508,6 +10983,7 @@ module Aws::BedrockAgent
10508
10983
  #
10509
10984
  class UpdateFlowAliasRequest < Struct.new(
10510
10985
  :alias_identifier,
10986
+ :concurrency_configuration,
10511
10987
  :description,
10512
10988
  :flow_identifier,
10513
10989
  :name,
@@ -10520,6 +10996,11 @@ module Aws::BedrockAgent
10520
10996
  # The Amazon Resource Name (ARN) of the flow.
10521
10997
  # @return [String]
10522
10998
  #
10999
+ # @!attribute [rw] concurrency_configuration
11000
+ # The configuration that specifies how nodes in the flow are executed
11001
+ # in parallel.
11002
+ # @return [Types::FlowAliasConcurrencyConfiguration]
11003
+ #
10523
11004
  # @!attribute [rw] created_at
10524
11005
  # The time at which the flow was created.
10525
11006
  # @return [Time]
@@ -10552,6 +11033,7 @@ module Aws::BedrockAgent
10552
11033
  #
10553
11034
  class UpdateFlowAliasResponse < Struct.new(
10554
11035
  :arn,
11036
+ :concurrency_configuration,
10555
11037
  :created_at,
10556
11038
  :description,
10557
11039
  :flow_id,
@@ -10991,6 +11473,76 @@ module Aws::BedrockAgent
10991
11473
  include Aws::Structure
10992
11474
  end
10993
11475
 
11476
+ # Configures the Amazon Bedrock reranker model to improve the relevance
11477
+ # of retrieved results.
11478
+ #
11479
+ # @!attribute [rw] metadata_configuration
11480
+ # Specifies how metadata fields should be handled during the reranking
11481
+ # process.
11482
+ # @return [Types::MetadataConfigurationForReranking]
11483
+ #
11484
+ # @!attribute [rw] model_configuration
11485
+ # Specifies the configuration for the Amazon Bedrock reranker model.
11486
+ # @return [Types::VectorSearchBedrockRerankingModelConfiguration]
11487
+ #
11488
+ # @!attribute [rw] number_of_reranked_results
11489
+ # Specifies the number of results to return after reranking.
11490
+ # @return [Integer]
11491
+ #
11492
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorSearchBedrockRerankingConfiguration AWS API Documentation
11493
+ #
11494
+ class VectorSearchBedrockRerankingConfiguration < Struct.new(
11495
+ :metadata_configuration,
11496
+ :model_configuration,
11497
+ :number_of_reranked_results)
11498
+ SENSITIVE = []
11499
+ include Aws::Structure
11500
+ end
11501
+
11502
+ # Configures the Amazon Bedrock model used for reranking retrieved
11503
+ # results.
11504
+ #
11505
+ # @!attribute [rw] additional_model_request_fields
11506
+ # Specifies additional model-specific request parameters as key-value
11507
+ # pairs that are included in the request to the Amazon Bedrock
11508
+ # reranker model.
11509
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
11510
+ #
11511
+ # @!attribute [rw] model_arn
11512
+ # The Amazon Resource Name (ARN) of the Amazon Bedrock reranker model.
11513
+ # @return [String]
11514
+ #
11515
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorSearchBedrockRerankingModelConfiguration AWS API Documentation
11516
+ #
11517
+ class VectorSearchBedrockRerankingModelConfiguration < Struct.new(
11518
+ :additional_model_request_fields,
11519
+ :model_arn)
11520
+ SENSITIVE = []
11521
+ include Aws::Structure
11522
+ end
11523
+
11524
+ # Specifies how retrieved results from a knowledge base are reranked to
11525
+ # improve relevance.
11526
+ #
11527
+ # @!attribute [rw] bedrock_reranking_configuration
11528
+ # Specifies the configuration for using an Amazon Bedrock reranker
11529
+ # model to rerank retrieved results.
11530
+ # @return [Types::VectorSearchBedrockRerankingConfiguration]
11531
+ #
11532
+ # @!attribute [rw] type
11533
+ # Specifies the type of reranking model to use. Currently, the only
11534
+ # supported value is `BEDROCK_RERANKING_MODEL`.
11535
+ # @return [String]
11536
+ #
11537
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorSearchRerankingConfiguration AWS API Documentation
11538
+ #
11539
+ class VectorSearchRerankingConfiguration < Struct.new(
11540
+ :bedrock_reranking_configuration,
11541
+ :type)
11542
+ SENSITIVE = []
11543
+ include Aws::Structure
11544
+ end
11545
+
10994
11546
  # The configuration of web URLs that you want to crawl. You should be
10995
11547
  # authorized to crawl the URLs.
10996
11548
  #