aws-sdk-bedrockagent 1.56.0 → 1.58.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.
@@ -471,6 +471,13 @@ module Aws::BedrockAgent
471
471
  # The unique identifier of the agent.
472
472
  # @return [String]
473
473
  #
474
+ # @!attribute [rw] alias_invocation_state
475
+ # The invocation state for the agent alias. If the agent alias is
476
+ # running, the value is `ACCEPT_INVOCATIONS`. If the agent alias is
477
+ # paused, the value is `REJECT_INVOCATIONS`. Use the
478
+ # `UpdateAgentAlias` operation to change the invocation state.
479
+ # @return [String]
480
+ #
474
481
  # @!attribute [rw] client_token
475
482
  # A unique, case-sensitive identifier to ensure that the API request
476
483
  # completes no more than one time. If this token matches a previous
@@ -512,6 +519,7 @@ module Aws::BedrockAgent
512
519
  :agent_alias_name,
513
520
  :agent_alias_status,
514
521
  :agent_id,
522
+ :alias_invocation_state,
515
523
  :client_token,
516
524
  :created_at,
517
525
  :description,
@@ -583,6 +591,13 @@ module Aws::BedrockAgent
583
591
  # The status of the alias.
584
592
  # @return [String]
585
593
  #
594
+ # @!attribute [rw] alias_invocation_state
595
+ # The invocation state for the agent alias. If the agent alias is
596
+ # running, the value is `ACCEPT_INVOCATIONS`. If the agent alias is
597
+ # paused, the value is `REJECT_INVOCATIONS`. Use the
598
+ # `UpdateAgentAlias` operation to change the invocation state.
599
+ # @return [String]
600
+ #
586
601
  # @!attribute [rw] created_at
587
602
  # The time at which the alias of the agent was created.
588
603
  # @return [Time]
@@ -606,6 +621,7 @@ module Aws::BedrockAgent
606
621
  :agent_alias_id,
607
622
  :agent_alias_name,
608
623
  :agent_alias_status,
624
+ :alias_invocation_state,
609
625
  :created_at,
610
626
  :description,
611
627
  :routing_configuration,
@@ -742,8 +758,8 @@ module Aws::BedrockAgent
742
758
  end
743
759
 
744
760
  # 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.
761
+ # this point in the flow. For more information, see [Node types in a
762
+ # flow][1] in the Amazon Bedrock User Guide.
747
763
  #
748
764
  #
749
765
  #
@@ -1470,8 +1486,8 @@ module Aws::BedrockAgent
1470
1486
 
1471
1487
  # Defines a collector node in your flow. This node takes an iteration of
1472
1488
  # 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.
1489
+ # information, see [Node types in a flow][1] in the Amazon Bedrock User
1490
+ # Guide.
1475
1491
  #
1476
1492
  #
1477
1493
  #
@@ -1485,8 +1501,7 @@ module Aws::BedrockAgent
1485
1501
 
1486
1502
  # Defines a condition node in your flow. You can specify conditions that
1487
1503
  # 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.
1504
+ # [Node types in a flow][1] in the Amazon Bedrock User Guide.
1490
1505
  #
1491
1506
  #
1492
1507
  #
@@ -2134,6 +2149,11 @@ module Aws::BedrockAgent
2134
2149
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
2135
2150
  # @return [String]
2136
2151
  #
2152
+ # @!attribute [rw] concurrency_configuration
2153
+ # The configuration that specifies how nodes in the flow are executed
2154
+ # in parallel.
2155
+ # @return [Types::FlowAliasConcurrencyConfiguration]
2156
+ #
2137
2157
  # @!attribute [rw] description
2138
2158
  # A description for the alias.
2139
2159
  # @return [String]
@@ -2163,6 +2183,7 @@ module Aws::BedrockAgent
2163
2183
  #
2164
2184
  class CreateFlowAliasRequest < Struct.new(
2165
2185
  :client_token,
2186
+ :concurrency_configuration,
2166
2187
  :description,
2167
2188
  :flow_identifier,
2168
2189
  :name,
@@ -2176,6 +2197,11 @@ module Aws::BedrockAgent
2176
2197
  # The Amazon Resource Name (ARN) of the alias.
2177
2198
  # @return [String]
2178
2199
  #
2200
+ # @!attribute [rw] concurrency_configuration
2201
+ # The configuration that specifies how nodes in the flow are executed
2202
+ # in parallel.
2203
+ # @return [Types::FlowAliasConcurrencyConfiguration]
2204
+ #
2179
2205
  # @!attribute [rw] created_at
2180
2206
  # The time at which the alias was created.
2181
2207
  # @return [Time]
@@ -2208,6 +2234,7 @@ module Aws::BedrockAgent
2208
2234
  #
2209
2235
  class CreateFlowAliasResponse < Struct.new(
2210
2236
  :arn,
2237
+ :concurrency_configuration,
2211
2238
  :created_at,
2212
2239
  :description,
2213
2240
  :flow_id,
@@ -3709,6 +3736,22 @@ module Aws::BedrockAgent
3709
3736
  include Aws::Structure
3710
3737
  end
3711
3738
 
3739
+ # Specifies a metadata field to include or exclude during the reranking
3740
+ # process.
3741
+ #
3742
+ # @!attribute [rw] field_name
3743
+ # The name of the metadata field to include or exclude during
3744
+ # reranking.
3745
+ # @return [String]
3746
+ #
3747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FieldForReranking AWS API Documentation
3748
+ #
3749
+ class FieldForReranking < Struct.new(
3750
+ :field_name)
3751
+ SENSITIVE = []
3752
+ include Aws::Structure
3753
+ end
3754
+
3712
3755
  # Configurations for when you choose fixed-size chunking. If you set the
3713
3756
  # `chunkingStrategy` as `NONE`, exclude this field.
3714
3757
  #
@@ -3729,6 +3772,34 @@ module Aws::BedrockAgent
3729
3772
  include Aws::Structure
3730
3773
  end
3731
3774
 
3775
+ # Determines how multiple nodes in a flow can run in parallel. Running
3776
+ # nodes concurrently can improve your flow's performance.
3777
+ #
3778
+ # @!attribute [rw] max_concurrency
3779
+ # The maximum number of nodes that can be executed concurrently in the
3780
+ # flow.
3781
+ # @return [Integer]
3782
+ #
3783
+ # @!attribute [rw] type
3784
+ # The type of concurrency to use for parallel node execution. Specify
3785
+ # one of the following options:
3786
+ #
3787
+ # * `Automatic` - Amazon Bedrock determines which nodes can be
3788
+ # executed in parallel based on the flow definition and its
3789
+ # dependencies.
3790
+ #
3791
+ # * `Manual` - You specify which nodes can be executed in parallel.
3792
+ # @return [String]
3793
+ #
3794
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowAliasConcurrencyConfiguration AWS API Documentation
3795
+ #
3796
+ class FlowAliasConcurrencyConfiguration < Struct.new(
3797
+ :max_concurrency,
3798
+ :type)
3799
+ SENSITIVE = []
3800
+ include Aws::Structure
3801
+ end
3802
+
3732
3803
  # Contains information about a version that the alias maps to.
3733
3804
  #
3734
3805
  # @!attribute [rw] flow_version
@@ -3759,6 +3830,11 @@ module Aws::BedrockAgent
3759
3830
  # The Amazon Resource Name (ARN) of the alias.
3760
3831
  # @return [String]
3761
3832
  #
3833
+ # @!attribute [rw] concurrency_configuration
3834
+ # The configuration that specifies how nodes in the flow are executed
3835
+ # concurrently.
3836
+ # @return [Types::FlowAliasConcurrencyConfiguration]
3837
+ #
3762
3838
  # @!attribute [rw] created_at
3763
3839
  # The time at which the alias was created.
3764
3840
  # @return [Time]
@@ -3792,6 +3868,7 @@ module Aws::BedrockAgent
3792
3868
  #
3793
3869
  class FlowAliasSummary < Struct.new(
3794
3870
  :arn,
3871
+ :concurrency_configuration,
3795
3872
  :created_at,
3796
3873
  :description,
3797
3874
  :flow_id,
@@ -3994,8 +4071,7 @@ module Aws::BedrockAgent
3994
4071
  end
3995
4072
 
3996
4073
  # 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.
4074
+ # see [Node types in a flow][1] in the Amazon Bedrock User Guide.
3999
4075
  #
4000
4076
  #
4001
4077
  #
@@ -4061,6 +4137,19 @@ module Aws::BedrockAgent
4061
4137
  # intent as the output.
4062
4138
  # @return [Types::LexFlowNodeConfiguration]
4063
4139
  #
4140
+ # @!attribute [rw] loop
4141
+ # Contains configurations for a DoWhile loop in your flow.
4142
+ # @return [Types::LoopFlowNodeConfiguration]
4143
+ #
4144
+ # @!attribute [rw] loop_controller
4145
+ # Contains controller node configurations for a DoWhile loop in your
4146
+ # flow.
4147
+ # @return [Types::LoopControllerFlowNodeConfiguration]
4148
+ #
4149
+ # @!attribute [rw] loop_input
4150
+ # Contains input node configurations for a DoWhile loop in your flow.
4151
+ # @return [Types::LoopInputFlowNodeConfiguration]
4152
+ #
4064
4153
  # @!attribute [rw] output
4065
4154
  # Contains configurations for an output flow node in your flow. The
4066
4155
  # last node in the flow. `outputs` can't be specified for this node.
@@ -4094,6 +4183,9 @@ module Aws::BedrockAgent
4094
4183
  :knowledge_base,
4095
4184
  :lambda_function,
4096
4185
  :lex,
4186
+ :loop,
4187
+ :loop_controller,
4188
+ :loop_input,
4097
4189
  :output,
4098
4190
  :prompt,
4099
4191
  :retrieval,
@@ -4112,6 +4204,9 @@ module Aws::BedrockAgent
4112
4204
  class KnowledgeBase < FlowNodeConfiguration; end
4113
4205
  class LambdaFunction < FlowNodeConfiguration; end
4114
4206
  class Lex < FlowNodeConfiguration; end
4207
+ class Loop < FlowNodeConfiguration; end
4208
+ class LoopController < FlowNodeConfiguration; end
4209
+ class LoopInput < FlowNodeConfiguration; end
4115
4210
  class Output < FlowNodeConfiguration; end
4116
4211
  class Prompt < FlowNodeConfiguration; end
4117
4212
  class Retrieval < FlowNodeConfiguration; end
@@ -4119,7 +4214,24 @@ module Aws::BedrockAgent
4119
4214
  class Unknown < FlowNodeConfiguration; end
4120
4215
  end
4121
4216
 
4122
- # Contains configurations for an input to a node.
4217
+ # Contains configurations for an input in an Amazon Bedrock Flows node.
4218
+ #
4219
+ # @!attribute [rw] category
4220
+ # Specifies how input data flows between iterations in a DoWhile loop.
4221
+ #
4222
+ # * `LoopCondition` - Controls whether the loop continues by
4223
+ # evaluating condition expressions against the input data. Use this
4224
+ # category to define the condition that determines if the loop
4225
+ # should continue.
4226
+ #
4227
+ # * `ReturnValueToLoopStart` - Defines data to pass back to the start
4228
+ # of the loop's next iteration. Use this category for variables
4229
+ # that you want to update for each loop iteration.
4230
+ #
4231
+ # * `ExitLoop` - Defines the value that's available once the loop
4232
+ # ends. Use this category to expose loop results to nodes outside
4233
+ # the loop.
4234
+ # @return [String]
4123
4235
  #
4124
4236
  # @!attribute [rw] expression
4125
4237
  # An expression that formats the input for the node. For an
@@ -4132,17 +4244,18 @@ module Aws::BedrockAgent
4132
4244
  # @return [String]
4133
4245
  #
4134
4246
  # @!attribute [rw] name
4135
- # A name for the input that you can reference.
4247
+ # Specifies a name for the input that you can reference.
4136
4248
  # @return [String]
4137
4249
  #
4138
4250
  # @!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.
4251
+ # Specifies the data type of the input. If the input doesn't match
4252
+ # this type at runtime, a validation error will be thrown.
4141
4253
  # @return [String]
4142
4254
  #
4143
4255
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowNodeInput AWS API Documentation
4144
4256
  #
4145
4257
  class FlowNodeInput < Struct.new(
4258
+ :category,
4146
4259
  :expression,
4147
4260
  :name,
4148
4261
  :type)
@@ -4301,6 +4414,16 @@ module Aws::BedrockAgent
4301
4414
  # Details about incompatible data types in a connection.
4302
4415
  # @return [Types::IncompatibleConnectionDataTypeFlowValidationDetails]
4303
4416
  #
4417
+ # @!attribute [rw] invalid_loop_boundary
4418
+ # Details about a flow that includes connections that violate loop
4419
+ # boundary rules.
4420
+ # @return [Types::InvalidLoopBoundaryFlowValidationDetails]
4421
+ #
4422
+ # @!attribute [rw] loop_incompatible_node_type
4423
+ # Details about a flow that includes incompatible node types in a
4424
+ # DoWhile loop.
4425
+ # @return [Types::LoopIncompatibleNodeTypeFlowValidationDetails]
4426
+ #
4304
4427
  # @!attribute [rw] malformed_condition_expression
4305
4428
  # Details about a malformed condition expression in a node.
4306
4429
  # @return [Types::MalformedConditionExpressionFlowValidationDetails]
@@ -4329,6 +4452,16 @@ module Aws::BedrockAgent
4329
4452
  # Details about missing ending nodes in the flow.
4330
4453
  # @return [Types::MissingEndingNodesFlowValidationDetails]
4331
4454
  #
4455
+ # @!attribute [rw] missing_loop_controller_node
4456
+ # Details about a flow that's missing a required `LoopController`
4457
+ # node in a DoWhile loop.
4458
+ # @return [Types::MissingLoopControllerNodeFlowValidationDetails]
4459
+ #
4460
+ # @!attribute [rw] missing_loop_input_node
4461
+ # Details about a flow that's missing a required `LoopInput` node in
4462
+ # a DoWhile loop.
4463
+ # @return [Types::MissingLoopInputNodeFlowValidationDetails]
4464
+ #
4332
4465
  # @!attribute [rw] missing_node_configuration
4333
4466
  # Details about missing configuration for a node.
4334
4467
  # @return [Types::MissingNodeConfigurationFlowValidationDetails]
@@ -4345,6 +4478,16 @@ module Aws::BedrockAgent
4345
4478
  # Details about missing starting nodes in the flow.
4346
4479
  # @return [Types::MissingStartingNodesFlowValidationDetails]
4347
4480
  #
4481
+ # @!attribute [rw] multiple_loop_controller_nodes
4482
+ # Details about a flow that contains multiple `LoopController` nodes
4483
+ # in a DoWhile loop.
4484
+ # @return [Types::MultipleLoopControllerNodesFlowValidationDetails]
4485
+ #
4486
+ # @!attribute [rw] multiple_loop_input_nodes
4487
+ # Details about a flow that contains multiple `LoopInput` nodes in a
4488
+ # DoWhile loop.
4489
+ # @return [Types::MultipleLoopInputNodesFlowValidationDetails]
4490
+ #
4348
4491
  # @!attribute [rw] multiple_node_input_connections
4349
4492
  # Details about multiple connections to a single node input.
4350
4493
  # @return [Types::MultipleNodeInputConnectionsFlowValidationDetails]
@@ -4400,6 +4543,8 @@ module Aws::BedrockAgent
4400
4543
  :duplicate_condition_expression,
4401
4544
  :duplicate_connections,
4402
4545
  :incompatible_connection_data_type,
4546
+ :invalid_loop_boundary,
4547
+ :loop_incompatible_node_type,
4403
4548
  :malformed_condition_expression,
4404
4549
  :malformed_node_input_expression,
4405
4550
  :mismatched_node_input_type,
@@ -4407,10 +4552,14 @@ module Aws::BedrockAgent
4407
4552
  :missing_connection_configuration,
4408
4553
  :missing_default_condition,
4409
4554
  :missing_ending_nodes,
4555
+ :missing_loop_controller_node,
4556
+ :missing_loop_input_node,
4410
4557
  :missing_node_configuration,
4411
4558
  :missing_node_input,
4412
4559
  :missing_node_output,
4413
4560
  :missing_starting_nodes,
4561
+ :multiple_loop_controller_nodes,
4562
+ :multiple_loop_input_nodes,
4414
4563
  :multiple_node_input_connections,
4415
4564
  :unfulfilled_node_input,
4416
4565
  :unknown_connection_condition,
@@ -4432,6 +4581,8 @@ module Aws::BedrockAgent
4432
4581
  class DuplicateConditionExpression < FlowValidationDetails; end
4433
4582
  class DuplicateConnections < FlowValidationDetails; end
4434
4583
  class IncompatibleConnectionDataType < FlowValidationDetails; end
4584
+ class InvalidLoopBoundary < FlowValidationDetails; end
4585
+ class LoopIncompatibleNodeType < FlowValidationDetails; end
4435
4586
  class MalformedConditionExpression < FlowValidationDetails; end
4436
4587
  class MalformedNodeInputExpression < FlowValidationDetails; end
4437
4588
  class MismatchedNodeInputType < FlowValidationDetails; end
@@ -4439,10 +4590,14 @@ module Aws::BedrockAgent
4439
4590
  class MissingConnectionConfiguration < FlowValidationDetails; end
4440
4591
  class MissingDefaultCondition < FlowValidationDetails; end
4441
4592
  class MissingEndingNodes < FlowValidationDetails; end
4593
+ class MissingLoopControllerNode < FlowValidationDetails; end
4594
+ class MissingLoopInputNode < FlowValidationDetails; end
4442
4595
  class MissingNodeConfiguration < FlowValidationDetails; end
4443
4596
  class MissingNodeInput < FlowValidationDetails; end
4444
4597
  class MissingNodeOutput < FlowValidationDetails; end
4445
4598
  class MissingStartingNodes < FlowValidationDetails; end
4599
+ class MultipleLoopControllerNodes < FlowValidationDetails; end
4600
+ class MultipleLoopInputNodes < FlowValidationDetails; end
4446
4601
  class MultipleNodeInputConnections < FlowValidationDetails; end
4447
4602
  class UnfulfilledNodeInput < FlowValidationDetails; end
4448
4603
  class UnknownConnectionCondition < FlowValidationDetails; end
@@ -4840,6 +4995,11 @@ module Aws::BedrockAgent
4840
4995
  # The Amazon Resource Name (ARN) of the flow.
4841
4996
  # @return [String]
4842
4997
  #
4998
+ # @!attribute [rw] concurrency_configuration
4999
+ # The configuration that specifies how nodes in the flow are executed
5000
+ # in parallel.
5001
+ # @return [Types::FlowAliasConcurrencyConfiguration]
5002
+ #
4843
5003
  # @!attribute [rw] created_at
4844
5004
  # The time at which the flow was created.
4845
5005
  # @return [Time]
@@ -4872,6 +5032,7 @@ module Aws::BedrockAgent
4872
5032
  #
4873
5033
  class GetFlowAliasResponse < Struct.new(
4874
5034
  :arn,
5035
+ :concurrency_configuration,
4875
5036
  :created_at,
4876
5037
  :description,
4877
5038
  :flow_id,
@@ -5753,6 +5914,33 @@ module Aws::BedrockAgent
5753
5914
  include Aws::Structure
5754
5915
  end
5755
5916
 
5917
+ # Details about a flow that contains connections that violate loop
5918
+ # boundary rules.
5919
+ #
5920
+ # @!attribute [rw] connection
5921
+ # The name of the connection that violates loop boundary rules.
5922
+ # @return [String]
5923
+ #
5924
+ # @!attribute [rw] source
5925
+ # The source node of the connection that violates DoWhile loop
5926
+ # boundary rules.
5927
+ # @return [String]
5928
+ #
5929
+ # @!attribute [rw] target
5930
+ # The target node of the connection that violates DoWhile loop
5931
+ # boundary rules.
5932
+ # @return [String]
5933
+ #
5934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/InvalidLoopBoundaryFlowValidationDetails AWS API Documentation
5935
+ #
5936
+ class InvalidLoopBoundaryFlowValidationDetails < Struct.new(
5937
+ :connection,
5938
+ :source,
5939
+ :target)
5940
+ SENSITIVE = []
5941
+ include Aws::Structure
5942
+ end
5943
+
5756
5944
  # Contains configurations for an iterator node in a flow. Takes an input
5757
5945
  # that is an array and iteratively sends each item of the array as an
5758
5946
  # output to the following node. The size of the array is also returned
@@ -5985,8 +6173,8 @@ module Aws::BedrockAgent
5985
6173
  # Contains configurations for a knowledge base node in a flow. This node
5986
6174
  # takes a query as the input and returns, as the output, the retrieved
5987
6175
  # 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.
6176
+ # retrieved responses. For more information, see [Node types in a
6177
+ # flow][1] in the Amazon Bedrock User Guide.
5990
6178
  #
5991
6179
  #
5992
6180
  #
@@ -5997,6 +6185,10 @@ module Aws::BedrockAgent
5997
6185
  # response generation for the knowledge base in this configuration.
5998
6186
  # @return [Types::GuardrailConfiguration]
5999
6187
  #
6188
+ # @!attribute [rw] inference_configuration
6189
+ # Contains inference configurations for the prompt.
6190
+ # @return [Types::PromptInferenceConfiguration]
6191
+ #
6000
6192
  # @!attribute [rw] knowledge_base_id
6001
6193
  # The unique identifier of the knowledge base to query.
6002
6194
  # @return [String]
@@ -6011,16 +6203,89 @@ module Aws::BedrockAgent
6011
6203
  # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html
6012
6204
  # @return [String]
6013
6205
  #
6206
+ # @!attribute [rw] number_of_results
6207
+ # The number of results to retrieve from the knowledge base.
6208
+ # @return [Integer]
6209
+ #
6210
+ # @!attribute [rw] orchestration_configuration
6211
+ # The configuration for orchestrating the retrieval and generation
6212
+ # process in the knowledge base node.
6213
+ # @return [Types::KnowledgeBaseOrchestrationConfiguration]
6214
+ #
6215
+ # @!attribute [rw] prompt_template
6216
+ # A custom prompt template to use with the knowledge base for
6217
+ # generating responses.
6218
+ # @return [Types::KnowledgeBasePromptTemplate]
6219
+ #
6220
+ # @!attribute [rw] reranking_configuration
6221
+ # The configuration for reranking the retrieved results from the
6222
+ # knowledge base to improve relevance.
6223
+ # @return [Types::VectorSearchRerankingConfiguration]
6224
+ #
6014
6225
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseFlowNodeConfiguration AWS API Documentation
6015
6226
  #
6016
6227
  class KnowledgeBaseFlowNodeConfiguration < Struct.new(
6017
6228
  :guardrail_configuration,
6229
+ :inference_configuration,
6018
6230
  :knowledge_base_id,
6019
- :model_id)
6231
+ :model_id,
6232
+ :number_of_results,
6233
+ :orchestration_configuration,
6234
+ :prompt_template,
6235
+ :reranking_configuration)
6020
6236
  SENSITIVE = []
6021
6237
  include Aws::Structure
6022
6238
  end
6023
6239
 
6240
+ # Configures how the knowledge base orchestrates the retrieval and
6241
+ # generation process, allowing for customization of prompts, inference
6242
+ # parameters, and performance settings.
6243
+ #
6244
+ # @!attribute [rw] additional_model_request_fields
6245
+ # The additional model-specific request parameters as key-value pairs
6246
+ # to be included in the request to the foundation model.
6247
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
6248
+ #
6249
+ # @!attribute [rw] inference_config
6250
+ # Contains inference configurations for the prompt.
6251
+ # @return [Types::PromptInferenceConfiguration]
6252
+ #
6253
+ # @!attribute [rw] performance_config
6254
+ # The performance configuration options for the knowledge base
6255
+ # retrieval and generation process.
6256
+ # @return [Types::PerformanceConfiguration]
6257
+ #
6258
+ # @!attribute [rw] prompt_template
6259
+ # A custom prompt template for orchestrating the retrieval and
6260
+ # generation process.
6261
+ # @return [Types::KnowledgeBasePromptTemplate]
6262
+ #
6263
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseOrchestrationConfiguration AWS API Documentation
6264
+ #
6265
+ class KnowledgeBaseOrchestrationConfiguration < Struct.new(
6266
+ :additional_model_request_fields,
6267
+ :inference_config,
6268
+ :performance_config,
6269
+ :prompt_template)
6270
+ SENSITIVE = []
6271
+ include Aws::Structure
6272
+ end
6273
+
6274
+ # Defines a custom prompt template for orchestrating the retrieval and
6275
+ # generation process.
6276
+ #
6277
+ # @!attribute [rw] text_prompt_template
6278
+ # The text of the prompt template.
6279
+ # @return [String]
6280
+ #
6281
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBasePromptTemplate AWS API Documentation
6282
+ #
6283
+ class KnowledgeBasePromptTemplate < Struct.new(
6284
+ :text_prompt_template)
6285
+ SENSITIVE = [:text_prompt_template]
6286
+ include Aws::Structure
6287
+ end
6288
+
6024
6289
  # Contains details about a knowledge base.
6025
6290
  #
6026
6291
  # @!attribute [rw] description
@@ -6058,8 +6323,8 @@ module Aws::BedrockAgent
6058
6323
  # Contains configurations for a Lambda function node in the flow. You
6059
6324
  # specify the Lambda function to invoke and the inputs into the
6060
6325
  # 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.
6326
+ # function. For more information, see [Node types in a flow][1] in the
6327
+ # Amazon Bedrock User Guide.
6063
6328
  #
6064
6329
  #
6065
6330
  #
@@ -6080,8 +6345,8 @@ module Aws::BedrockAgent
6080
6345
  # Contains configurations for a Lex node in the flow. You specify a
6081
6346
  # Amazon Lex bot to invoke. This node takes an utterance as the input
6082
6347
  # 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.
6348
+ # For more information, see [Node types in a flow][1] in the Amazon
6349
+ # Bedrock User Guide.
6085
6350
  #
6086
6351
  #
6087
6352
  #
@@ -6835,6 +7100,106 @@ module Aws::BedrockAgent
6835
7100
  include Aws::Structure
6836
7101
  end
6837
7102
 
7103
+ # Contains configurations for the controller node of a DoWhile loop in
7104
+ # the flow.
7105
+ #
7106
+ # @!attribute [rw] continue_condition
7107
+ # Specifies the condition that determines when the flow exits the
7108
+ # DoWhile loop. The loop executes until this condition evaluates to
7109
+ # true.
7110
+ # @return [Types::FlowCondition]
7111
+ #
7112
+ # @!attribute [rw] max_iterations
7113
+ # Specifies the maximum number of times the DoWhile loop can iterate
7114
+ # before the flow exits the loop.
7115
+ # @return [Integer]
7116
+ #
7117
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/LoopControllerFlowNodeConfiguration AWS API Documentation
7118
+ #
7119
+ class LoopControllerFlowNodeConfiguration < Struct.new(
7120
+ :continue_condition,
7121
+ :max_iterations)
7122
+ SENSITIVE = []
7123
+ include Aws::Structure
7124
+ end
7125
+
7126
+ # Contains configurations for the nodes of a DoWhile loop in your flow.
7127
+ #
7128
+ # A DoWhile loop is made up of the following nodes:
7129
+ #
7130
+ # * `Loop` - The container node that holds the loop's flow definition.
7131
+ # This node encompasses the entire loop structure.
7132
+ #
7133
+ # * `LoopInput` - The entry point node for the loop. This node receives
7134
+ # inputs from nodes outside the loop and from previous loop
7135
+ # iterations.
7136
+ #
7137
+ # * Body nodes - The processing nodes that execute within each loop
7138
+ # iteration. These can be nodes for handling data in your flow, such
7139
+ # as a prompt or Lambda function nodes. Some node types aren't
7140
+ # supported inside a DoWhile loop body. For more information, see
7141
+ # [LoopIncompatibleNodeTypeFlowValidationDetails][1].
7142
+ #
7143
+ # * `LoopController` - The node that evaluates whether the loop should
7144
+ # continue or exit based on a condition.
7145
+ #
7146
+ # These nodes work together to create a loop that runs at least once and
7147
+ # continues until a specified condition is met or a maximum number of
7148
+ # iterations is reached.
7149
+ #
7150
+ #
7151
+ #
7152
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_LoopIncompatibleNodeTypeFlowValidationDetails.html
7153
+ #
7154
+ # @!attribute [rw] definition
7155
+ # The definition of the DoWhile loop nodes and connections between
7156
+ # nodes in the flow.
7157
+ # @return [Types::FlowDefinition]
7158
+ #
7159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/LoopFlowNodeConfiguration AWS API Documentation
7160
+ #
7161
+ class LoopFlowNodeConfiguration < Struct.new(
7162
+ :definition)
7163
+ SENSITIVE = [:definition]
7164
+ include Aws::Structure
7165
+ end
7166
+
7167
+ # Details about a flow that contains an incompatible node in a DoWhile
7168
+ # loop.
7169
+ #
7170
+ # @!attribute [rw] incompatible_node_name
7171
+ # The node that's incompatible in the DoWhile loop.
7172
+ # @return [String]
7173
+ #
7174
+ # @!attribute [rw] incompatible_node_type
7175
+ # The node type of the incompatible node in the DoWhile loop. Some
7176
+ # node types, like a condition node, aren't allowed in a DoWhile
7177
+ # loop.
7178
+ # @return [String]
7179
+ #
7180
+ # @!attribute [rw] node
7181
+ # The `Loop` container node that contains an incompatible node.
7182
+ # @return [String]
7183
+ #
7184
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/LoopIncompatibleNodeTypeFlowValidationDetails AWS API Documentation
7185
+ #
7186
+ class LoopIncompatibleNodeTypeFlowValidationDetails < Struct.new(
7187
+ :incompatible_node_name,
7188
+ :incompatible_node_type,
7189
+ :node)
7190
+ SENSITIVE = []
7191
+ include Aws::Structure
7192
+ end
7193
+
7194
+ # Contains configurations for the input node of a DoWhile loop in the
7195
+ # flow.
7196
+ #
7197
+ # @api private
7198
+ #
7199
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/LoopInputFlowNodeConfiguration AWS API Documentation
7200
+ #
7201
+ class LoopInputFlowNodeConfiguration < Aws::EmptyStructure; end
7202
+
6838
7203
  # Details about a malformed condition expression in a node.
6839
7204
  #
6840
7205
  # @!attribute [rw] cause
@@ -6988,6 +7353,27 @@ module Aws::BedrockAgent
6988
7353
  include Aws::Structure
6989
7354
  end
6990
7355
 
7356
+ # Specifies how metadata fields should be handled during the reranking
7357
+ # process.
7358
+ #
7359
+ # @!attribute [rw] selection_mode
7360
+ # The mode for selecting metadata fields for reranking.
7361
+ # @return [String]
7362
+ #
7363
+ # @!attribute [rw] selective_mode_configuration
7364
+ # The configuration for selective metadata field inclusion or
7365
+ # exclusion during reranking.
7366
+ # @return [Types::RerankingMetadataSelectiveModeConfiguration]
7367
+ #
7368
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MetadataConfigurationForReranking AWS API Documentation
7369
+ #
7370
+ class MetadataConfigurationForReranking < Struct.new(
7371
+ :selection_mode,
7372
+ :selective_mode_configuration)
7373
+ SENSITIVE = []
7374
+ include Aws::Structure
7375
+ end
7376
+
6991
7377
  # Details about mismatched input data types in a node.
6992
7378
  #
6993
7379
  # @!attribute [rw] expected_type
@@ -7073,10 +7459,42 @@ module Aws::BedrockAgent
7073
7459
  #
7074
7460
  class MissingEndingNodesFlowValidationDetails < Aws::EmptyStructure; end
7075
7461
 
7076
- # Details about a node missing required configuration.
7462
+ # Details about a flow that's missing a required `LoopController` node
7463
+ # in a DoWhile loop.
7464
+ #
7465
+ # @!attribute [rw] loop_node
7466
+ # The DoWhile loop in a flow that's missing a required
7467
+ # `LoopController` node.
7468
+ # @return [String]
7469
+ #
7470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MissingLoopControllerNodeFlowValidationDetails AWS API Documentation
7471
+ #
7472
+ class MissingLoopControllerNodeFlowValidationDetails < Struct.new(
7473
+ :loop_node)
7474
+ SENSITIVE = []
7475
+ include Aws::Structure
7476
+ end
7477
+
7478
+ # Details about a flow that's missing a required `LoopInput` node in a
7479
+ # DoWhile loop.
7480
+ #
7481
+ # @!attribute [rw] loop_node
7482
+ # The DoWhile loop in a flow that's missing a required `LoopInput`
7483
+ # node.
7484
+ # @return [String]
7485
+ #
7486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MissingLoopInputNodeFlowValidationDetails AWS API Documentation
7487
+ #
7488
+ class MissingLoopInputNodeFlowValidationDetails < Struct.new(
7489
+ :loop_node)
7490
+ SENSITIVE = []
7491
+ include Aws::Structure
7492
+ end
7493
+
7494
+ # Details about a node missing a required configuration.
7077
7495
  #
7078
7496
  # @!attribute [rw] node
7079
- # The name of the node missing configuration.
7497
+ # The name of the node missing a required configuration.
7080
7498
  # @return [String]
7081
7499
  #
7082
7500
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MissingNodeConfigurationFlowValidationDetails AWS API Documentation
@@ -7218,6 +7636,37 @@ module Aws::BedrockAgent
7218
7636
  include Aws::Structure
7219
7637
  end
7220
7638
 
7639
+ # Details about a flow that contains multiple `LoopController` nodes in
7640
+ # a DoWhile loop.
7641
+ #
7642
+ # @!attribute [rw] loop_node
7643
+ # The DoWhile loop in a flow that contains multiple `LoopController`
7644
+ # nodes.
7645
+ # @return [String]
7646
+ #
7647
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MultipleLoopControllerNodesFlowValidationDetails AWS API Documentation
7648
+ #
7649
+ class MultipleLoopControllerNodesFlowValidationDetails < Struct.new(
7650
+ :loop_node)
7651
+ SENSITIVE = []
7652
+ include Aws::Structure
7653
+ end
7654
+
7655
+ # Details about a flow that contains multiple `LoopInput` nodes in a
7656
+ # DoWhile loop.
7657
+ #
7658
+ # @!attribute [rw] loop_node
7659
+ # The DoWhile loop in a flow that contains multiple `LoopInput` nodes.
7660
+ # @return [String]
7661
+ #
7662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MultipleLoopInputNodesFlowValidationDetails AWS API Documentation
7663
+ #
7664
+ class MultipleLoopInputNodesFlowValidationDetails < Struct.new(
7665
+ :loop_node)
7666
+ SENSITIVE = []
7667
+ include Aws::Structure
7668
+ end
7669
+
7221
7670
  # Details about multiple connections to a single node input.
7222
7671
  #
7223
7672
  # @!attribute [rw] input
@@ -7602,6 +8051,21 @@ module Aws::BedrockAgent
7602
8051
  include Aws::Structure
7603
8052
  end
7604
8053
 
8054
+ # The performance-related configuration options for the knowledge base
8055
+ # retrieval and generation process.
8056
+ #
8057
+ # @!attribute [rw] latency
8058
+ # The latency optimization setting.
8059
+ # @return [String]
8060
+ #
8061
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PerformanceConfiguration AWS API Documentation
8062
+ #
8063
+ class PerformanceConfiguration < Struct.new(
8064
+ :latency)
8065
+ SENSITIVE = []
8066
+ include Aws::Structure
8067
+ end
8068
+
7605
8069
  # Contains details about the storage configuration of the knowledge base
7606
8070
  # in Pinecone. For more information, see [Create a vector index in
7607
8071
  # Pinecone][1].
@@ -7861,8 +8325,8 @@ module Aws::BedrockAgent
7861
8325
  # prompt from Prompt management or you can define one in this node. If
7862
8326
  # the prompt contains variables, the inputs into this node will fill in
7863
8327
  # 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.
8328
+ # the model. For more information, see [Node types in a flow][1] in the
8329
+ # Amazon Bedrock User Guide.
7866
8330
  #
7867
8331
  #
7868
8332
  #
@@ -8768,6 +9232,36 @@ module Aws::BedrockAgent
8768
9232
  include Aws::Structure
8769
9233
  end
8770
9234
 
9235
+ # Configures the metadata fields to include or exclude during the
9236
+ # reranking process when using selective mode.
9237
+ #
9238
+ # @note RerankingMetadataSelectiveModeConfiguration is a union - when making an API calls you must set exactly one of the members.
9239
+ #
9240
+ # @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.
9241
+ #
9242
+ # @!attribute [rw] fields_to_exclude
9243
+ # Specifies the metadata fields to exclude from the reranking process.
9244
+ # @return [Array<Types::FieldForReranking>]
9245
+ #
9246
+ # @!attribute [rw] fields_to_include
9247
+ # Specifies the metadata fields to include in the reranking process.
9248
+ # @return [Array<Types::FieldForReranking>]
9249
+ #
9250
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RerankingMetadataSelectiveModeConfiguration AWS API Documentation
9251
+ #
9252
+ class RerankingMetadataSelectiveModeConfiguration < Struct.new(
9253
+ :fields_to_exclude,
9254
+ :fields_to_include,
9255
+ :unknown)
9256
+ SENSITIVE = [:fields_to_exclude, :fields_to_include]
9257
+ include Aws::Structure
9258
+ include Aws::Structure::Union
9259
+
9260
+ class FieldsToExclude < RerankingMetadataSelectiveModeConfiguration; end
9261
+ class FieldsToInclude < RerankingMetadataSelectiveModeConfiguration; end
9262
+ class Unknown < RerankingMetadataSelectiveModeConfiguration; end
9263
+ end
9264
+
8771
9265
  # The specified resource Amazon Resource Name (ARN) was not found. Check
8772
9266
  # the Amazon Resource Name (ARN) and try your request again.
8773
9267
  #
@@ -10141,6 +10635,14 @@ module Aws::BedrockAgent
10141
10635
  # The unique identifier of the agent.
10142
10636
  # @return [String]
10143
10637
  #
10638
+ # @!attribute [rw] alias_invocation_state
10639
+ # The invocation state for the agent alias. To pause the agent alias,
10640
+ # set the value to `REJECT_INVOCATIONS`. To start the agent alias
10641
+ # running again, set the value to `ACCEPT_INVOCATIONS`. Use the
10642
+ # `GetAgentAlias`, or `ListAgentAliases`, operation to get the
10643
+ # invocation state of an agent alias.
10644
+ # @return [String]
10645
+ #
10144
10646
  # @!attribute [rw] description
10145
10647
  # Specifies a new description for the alias.
10146
10648
  # @return [String]
@@ -10155,6 +10657,7 @@ module Aws::BedrockAgent
10155
10657
  :agent_alias_id,
10156
10658
  :agent_alias_name,
10157
10659
  :agent_id,
10660
+ :alias_invocation_state,
10158
10661
  :description,
10159
10662
  :routing_configuration)
10160
10663
  SENSITIVE = []
@@ -10488,6 +10991,11 @@ module Aws::BedrockAgent
10488
10991
  # The unique identifier of the alias.
10489
10992
  # @return [String]
10490
10993
  #
10994
+ # @!attribute [rw] concurrency_configuration
10995
+ # The configuration that specifies how nodes in the flow are executed
10996
+ # in parallel.
10997
+ # @return [Types::FlowAliasConcurrencyConfiguration]
10998
+ #
10491
10999
  # @!attribute [rw] description
10492
11000
  # A description for the alias.
10493
11001
  # @return [String]
@@ -10508,6 +11016,7 @@ module Aws::BedrockAgent
10508
11016
  #
10509
11017
  class UpdateFlowAliasRequest < Struct.new(
10510
11018
  :alias_identifier,
11019
+ :concurrency_configuration,
10511
11020
  :description,
10512
11021
  :flow_identifier,
10513
11022
  :name,
@@ -10520,6 +11029,11 @@ module Aws::BedrockAgent
10520
11029
  # The Amazon Resource Name (ARN) of the flow.
10521
11030
  # @return [String]
10522
11031
  #
11032
+ # @!attribute [rw] concurrency_configuration
11033
+ # The configuration that specifies how nodes in the flow are executed
11034
+ # in parallel.
11035
+ # @return [Types::FlowAliasConcurrencyConfiguration]
11036
+ #
10523
11037
  # @!attribute [rw] created_at
10524
11038
  # The time at which the flow was created.
10525
11039
  # @return [Time]
@@ -10552,6 +11066,7 @@ module Aws::BedrockAgent
10552
11066
  #
10553
11067
  class UpdateFlowAliasResponse < Struct.new(
10554
11068
  :arn,
11069
+ :concurrency_configuration,
10555
11070
  :created_at,
10556
11071
  :description,
10557
11072
  :flow_id,
@@ -10991,6 +11506,76 @@ module Aws::BedrockAgent
10991
11506
  include Aws::Structure
10992
11507
  end
10993
11508
 
11509
+ # Configures the Amazon Bedrock reranker model to improve the relevance
11510
+ # of retrieved results.
11511
+ #
11512
+ # @!attribute [rw] metadata_configuration
11513
+ # Specifies how metadata fields should be handled during the reranking
11514
+ # process.
11515
+ # @return [Types::MetadataConfigurationForReranking]
11516
+ #
11517
+ # @!attribute [rw] model_configuration
11518
+ # Specifies the configuration for the Amazon Bedrock reranker model.
11519
+ # @return [Types::VectorSearchBedrockRerankingModelConfiguration]
11520
+ #
11521
+ # @!attribute [rw] number_of_reranked_results
11522
+ # Specifies the number of results to return after reranking.
11523
+ # @return [Integer]
11524
+ #
11525
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorSearchBedrockRerankingConfiguration AWS API Documentation
11526
+ #
11527
+ class VectorSearchBedrockRerankingConfiguration < Struct.new(
11528
+ :metadata_configuration,
11529
+ :model_configuration,
11530
+ :number_of_reranked_results)
11531
+ SENSITIVE = []
11532
+ include Aws::Structure
11533
+ end
11534
+
11535
+ # Configures the Amazon Bedrock model used for reranking retrieved
11536
+ # results.
11537
+ #
11538
+ # @!attribute [rw] additional_model_request_fields
11539
+ # Specifies additional model-specific request parameters as key-value
11540
+ # pairs that are included in the request to the Amazon Bedrock
11541
+ # reranker model.
11542
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
11543
+ #
11544
+ # @!attribute [rw] model_arn
11545
+ # The Amazon Resource Name (ARN) of the Amazon Bedrock reranker model.
11546
+ # @return [String]
11547
+ #
11548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorSearchBedrockRerankingModelConfiguration AWS API Documentation
11549
+ #
11550
+ class VectorSearchBedrockRerankingModelConfiguration < Struct.new(
11551
+ :additional_model_request_fields,
11552
+ :model_arn)
11553
+ SENSITIVE = []
11554
+ include Aws::Structure
11555
+ end
11556
+
11557
+ # Specifies how retrieved results from a knowledge base are reranked to
11558
+ # improve relevance.
11559
+ #
11560
+ # @!attribute [rw] bedrock_reranking_configuration
11561
+ # Specifies the configuration for using an Amazon Bedrock reranker
11562
+ # model to rerank retrieved results.
11563
+ # @return [Types::VectorSearchBedrockRerankingConfiguration]
11564
+ #
11565
+ # @!attribute [rw] type
11566
+ # Specifies the type of reranking model to use. Currently, the only
11567
+ # supported value is `BEDROCK_RERANKING_MODEL`.
11568
+ # @return [String]
11569
+ #
11570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorSearchRerankingConfiguration AWS API Documentation
11571
+ #
11572
+ class VectorSearchRerankingConfiguration < Struct.new(
11573
+ :bedrock_reranking_configuration,
11574
+ :type)
11575
+ SENSITIVE = []
11576
+ include Aws::Structure
11577
+ end
11578
+
10994
11579
  # The configuration of web URLs that you want to crawl. You should be
10995
11580
  # authorized to crawl the URLs.
10996
11581
  #