aws-sdk-bedrockagent 1.17.0 → 1.18.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.
@@ -219,7 +219,7 @@ module Aws::BedrockAgent
219
219
  # @return [String]
220
220
  #
221
221
  # @!attribute [rw] guardrail_configuration
222
- # The guardrails configuration assigned to the agent.
222
+ # Details about the guardrail associated with the agent.
223
223
  # @return [Types::GuardrailConfiguration]
224
224
  #
225
225
  # @!attribute [rw] idle_session_ttl_in_seconds
@@ -236,6 +236,10 @@ module Aws::BedrockAgent
236
236
  # interact with users.
237
237
  # @return [String]
238
238
  #
239
+ # @!attribute [rw] memory_configuration
240
+ # Contains memory configuration for the agent.
241
+ # @return [Types::MemoryConfiguration]
242
+ #
239
243
  # @!attribute [rw] prepared_at
240
244
  # The time at which the agent was last prepared.
241
245
  # @return [Time]
@@ -277,6 +281,7 @@ module Aws::BedrockAgent
277
281
  :guardrail_configuration,
278
282
  :idle_session_ttl_in_seconds,
279
283
  :instruction,
284
+ :memory_configuration,
280
285
  :prepared_at,
281
286
  :prompt_override_configuration,
282
287
  :recommended_actions,
@@ -578,6 +583,26 @@ module Aws::BedrockAgent
578
583
  include Aws::Structure
579
584
  end
580
585
 
586
+ # Defines an agent node in your flow. You specify the agent to invoke at
587
+ # this point in the flow. For more information, see [Node types in
588
+ # Amazon Bedrock works][1] in the Amazon Bedrock User Guide.
589
+ #
590
+ #
591
+ #
592
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html
593
+ #
594
+ # @!attribute [rw] agent_alias_arn
595
+ # The Amazon Resource Name (ARN) of the alias of the agent to invoke.
596
+ # @return [String]
597
+ #
598
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/AgentFlowNodeConfiguration AWS API Documentation
599
+ #
600
+ class AgentFlowNodeConfiguration < Struct.new(
601
+ :agent_alias_arn)
602
+ SENSITIVE = []
603
+ include Aws::Structure
604
+ end
605
+
581
606
  # Contains details about a knowledge base that is associated with an
582
607
  # agent.
583
608
  #
@@ -689,7 +714,7 @@ module Aws::BedrockAgent
689
714
  # @return [String]
690
715
  #
691
716
  # @!attribute [rw] guardrail_configuration
692
- # The details of the guardrails configuration in the agent summary.
717
+ # Details about the guardrail associated with the agent.
693
718
  # @return [Types::GuardrailConfiguration]
694
719
  #
695
720
  # @!attribute [rw] latest_agent_version
@@ -760,7 +785,7 @@ module Aws::BedrockAgent
760
785
  # @return [String]
761
786
  #
762
787
  # @!attribute [rw] guardrail_configuration
763
- # The guardrails configuration assigned to the agent version.
788
+ # Details about the guardrail associated with the agent.
764
789
  # @return [Types::GuardrailConfiguration]
765
790
  #
766
791
  # @!attribute [rw] idle_session_ttl_in_seconds
@@ -776,6 +801,11 @@ module Aws::BedrockAgent
776
801
  # The instructions provided to the agent.
777
802
  # @return [String]
778
803
  #
804
+ # @!attribute [rw] memory_configuration
805
+ # Contains details of the memory configuration on the version of the
806
+ # agent.
807
+ # @return [Types::MemoryConfiguration]
808
+ #
779
809
  # @!attribute [rw] prompt_override_configuration
780
810
  # Contains configurations to override prompt templates in different
781
811
  # parts of an agent sequence. For more information, see [Advanced
@@ -815,6 +845,7 @@ module Aws::BedrockAgent
815
845
  :guardrail_configuration,
816
846
  :idle_session_ttl_in_seconds,
817
847
  :instruction,
848
+ :memory_configuration,
818
849
  :prompt_override_configuration,
819
850
  :recommended_actions,
820
851
  :updated_at,
@@ -846,8 +877,7 @@ module Aws::BedrockAgent
846
877
  # @return [String]
847
878
  #
848
879
  # @!attribute [rw] guardrail_configuration
849
- # The details of the guardrails configuration in the agent version
850
- # summary.
880
+ # Details about the guardrail associated with the agent.
851
881
  # @return [Types::GuardrailConfiguration]
852
882
  #
853
883
  # @!attribute [rw] updated_at
@@ -936,6 +966,26 @@ module Aws::BedrockAgent
936
966
  include Aws::Structure
937
967
  end
938
968
 
969
+ # Settings for a foundation model used to parse documents for a data
970
+ # source.
971
+ #
972
+ # @!attribute [rw] model_arn
973
+ # The model's ARN.
974
+ # @return [String]
975
+ #
976
+ # @!attribute [rw] parsing_prompt
977
+ # Instructions for interpreting the contents of a document.
978
+ # @return [Types::ParsingPrompt]
979
+ #
980
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/BedrockFoundationModelConfiguration AWS API Documentation
981
+ #
982
+ class BedrockFoundationModelConfiguration < Struct.new(
983
+ :model_arn,
984
+ :parsing_prompt)
985
+ SENSITIVE = []
986
+ include Aws::Structure
987
+ end
988
+
939
989
  # Details about how to chunk the documents in the data source. A *chunk*
940
990
  # refers to an excerpt from a data source that is returned when the
941
991
  # knowledge base that it belongs to is queried.
@@ -952,6 +1002,13 @@ module Aws::BedrockAgent
952
1002
  # of the approximate size that you set in the
953
1003
  # `fixedSizeChunkingConfiguration`.
954
1004
  #
1005
+ # * `HIERARCHICAL` – Split documents into layers of chunks where the
1006
+ # first layer contains large chunks, and the second layer contains
1007
+ # smaller chunks derived from the first layer.
1008
+ #
1009
+ # * `SEMANTIC` – Split documents into chunks based on groups of
1010
+ # similar content derived with natural language processing.
1011
+ #
955
1012
  # * `NONE` – Amazon Bedrock treats each file as one chunk. If you
956
1013
  # choose this option, you may want to pre-process your documents by
957
1014
  # splitting them into separate files.
@@ -962,15 +1019,68 @@ module Aws::BedrockAgent
962
1019
  # the `chunkingStrategy` as `NONE`, exclude this field.
963
1020
  # @return [Types::FixedSizeChunkingConfiguration]
964
1021
  #
1022
+ # @!attribute [rw] hierarchical_chunking_configuration
1023
+ # Settings for hierarchical document chunking for a data source.
1024
+ # Hierarchical chunking splits documents into layers of chunks where
1025
+ # the first layer contains large chunks, and the second layer contains
1026
+ # smaller chunks derived from the first layer.
1027
+ # @return [Types::HierarchicalChunkingConfiguration]
1028
+ #
1029
+ # @!attribute [rw] semantic_chunking_configuration
1030
+ # Settings for semantic document chunking for a data source. Semantic
1031
+ # chunking splits a document into into smaller documents based on
1032
+ # groups of similar content derived from the text with natural
1033
+ # language processing.
1034
+ # @return [Types::SemanticChunkingConfiguration]
1035
+ #
965
1036
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ChunkingConfiguration AWS API Documentation
966
1037
  #
967
1038
  class ChunkingConfiguration < Struct.new(
968
1039
  :chunking_strategy,
969
- :fixed_size_chunking_configuration)
1040
+ :fixed_size_chunking_configuration,
1041
+ :hierarchical_chunking_configuration,
1042
+ :semantic_chunking_configuration)
970
1043
  SENSITIVE = []
971
1044
  include Aws::Structure
972
1045
  end
973
1046
 
1047
+ # Defines a collector node in your flow. This node takes an iteration of
1048
+ # inputs and consolidates them into an array in the output. For more
1049
+ # information, see [Node types in Amazon Bedrock works][1] in the Amazon
1050
+ # Bedrock User Guide.
1051
+ #
1052
+ #
1053
+ #
1054
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html
1055
+ #
1056
+ # @api private
1057
+ #
1058
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CollectorFlowNodeConfiguration AWS API Documentation
1059
+ #
1060
+ class CollectorFlowNodeConfiguration < Aws::EmptyStructure; end
1061
+
1062
+ # Defines a condition node in your flow. You can specify conditions that
1063
+ # determine which node comes next in the flow. For more information, see
1064
+ # [Node types in Amazon Bedrock works][1] in the Amazon Bedrock User
1065
+ # Guide.
1066
+ #
1067
+ #
1068
+ #
1069
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html
1070
+ #
1071
+ # @!attribute [rw] conditions
1072
+ # An array of conditions. Each member contains the name of a condition
1073
+ # and an expression that defines the condition.
1074
+ # @return [Array<Types::FlowCondition>]
1075
+ #
1076
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ConditionFlowNodeConfiguration AWS API Documentation
1077
+ #
1078
+ class ConditionFlowNodeConfiguration < Struct.new(
1079
+ :conditions)
1080
+ SENSITIVE = [:conditions]
1081
+ include Aws::Structure
1082
+ end
1083
+
974
1084
  # There was a conflict performing an operation.
975
1085
  #
976
1086
  # @!attribute [rw] message
@@ -984,6 +1094,106 @@ module Aws::BedrockAgent
984
1094
  include Aws::Structure
985
1095
  end
986
1096
 
1097
+ # The configuration of the Confluence content. For example, configuring
1098
+ # specific types of Confluence content.
1099
+ #
1100
+ # @!attribute [rw] filter_configuration
1101
+ # The configuration of filtering the Confluence content. For example,
1102
+ # configuring regular expression patterns to include or exclude
1103
+ # certain content.
1104
+ # @return [Types::CrawlFilterConfiguration]
1105
+ #
1106
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ConfluenceCrawlerConfiguration AWS API Documentation
1107
+ #
1108
+ class ConfluenceCrawlerConfiguration < Struct.new(
1109
+ :filter_configuration)
1110
+ SENSITIVE = []
1111
+ include Aws::Structure
1112
+ end
1113
+
1114
+ # The configuration information to connect to Confluence as your data
1115
+ # source.
1116
+ #
1117
+ # @!attribute [rw] crawler_configuration
1118
+ # The configuration of the Confluence content. For example,
1119
+ # configuring specific types of Confluence content.
1120
+ # @return [Types::ConfluenceCrawlerConfiguration]
1121
+ #
1122
+ # @!attribute [rw] source_configuration
1123
+ # The endpoint information to connect to your Confluence data source.
1124
+ # @return [Types::ConfluenceSourceConfiguration]
1125
+ #
1126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ConfluenceDataSourceConfiguration AWS API Documentation
1127
+ #
1128
+ class ConfluenceDataSourceConfiguration < Struct.new(
1129
+ :crawler_configuration,
1130
+ :source_configuration)
1131
+ SENSITIVE = []
1132
+ include Aws::Structure
1133
+ end
1134
+
1135
+ # The endpoint information to connect to your Confluence data source.
1136
+ #
1137
+ # @!attribute [rw] auth_type
1138
+ # The supported authentication type to authenticate and connect to
1139
+ # your Confluence instance.
1140
+ # @return [String]
1141
+ #
1142
+ # @!attribute [rw] credentials_secret_arn
1143
+ # The Amazon Resource Name of an Secrets Manager secret that stores
1144
+ # your authentication credentials for your SharePoint site/sites. For
1145
+ # more information on the key-value pairs that must be included in
1146
+ # your secret, depending on your authentication type, see [Confluence
1147
+ # connection configuration][1].
1148
+ #
1149
+ #
1150
+ #
1151
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/confluence-data-source-connector.html#configuration-confluence-connector
1152
+ # @return [String]
1153
+ #
1154
+ # @!attribute [rw] host_type
1155
+ # The supported host type, whether online/cloud or server/on-premises.
1156
+ # @return [String]
1157
+ #
1158
+ # @!attribute [rw] host_url
1159
+ # The Confluence host URL or instance URL.
1160
+ # @return [String]
1161
+ #
1162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ConfluenceSourceConfiguration AWS API Documentation
1163
+ #
1164
+ class ConfluenceSourceConfiguration < Struct.new(
1165
+ :auth_type,
1166
+ :credentials_secret_arn,
1167
+ :host_type,
1168
+ :host_url)
1169
+ SENSITIVE = []
1170
+ include Aws::Structure
1171
+ end
1172
+
1173
+ # The configuration of filtering the data source content. For example,
1174
+ # configuring regular expression patterns to include or exclude certain
1175
+ # content.
1176
+ #
1177
+ # @!attribute [rw] pattern_object_filter
1178
+ # The configuration of filtering certain objects or content types of
1179
+ # the data source.
1180
+ # @return [Types::PatternObjectFilterConfiguration]
1181
+ #
1182
+ # @!attribute [rw] type
1183
+ # The type of filtering that you want to apply to certain objects or
1184
+ # content of the data source. For example, the `PATTERN` type is
1185
+ # regular expression patterns you can apply to filter your content.
1186
+ # @return [String]
1187
+ #
1188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CrawlFilterConfiguration AWS API Documentation
1189
+ #
1190
+ class CrawlFilterConfiguration < Struct.new(
1191
+ :pattern_object_filter,
1192
+ :type)
1193
+ SENSITIVE = []
1194
+ include Aws::Structure
1195
+ end
1196
+
987
1197
  # @!attribute [rw] action_group_executor
988
1198
  # The Amazon Resource Name (ARN) of the Lambda function containing the
989
1199
  # business logic that is carried out upon invoking the action or the
@@ -1053,6 +1263,12 @@ module Aws::BedrockAgent
1053
1263
  # `AMAZON.UserInput`. You must leave the `description`, `apiSchema`,
1054
1264
  # and `actionGroupExecutor` fields blank for this action group.
1055
1265
  #
1266
+ # To allow your agent to generate, run, and troubleshoot code when
1267
+ # trying to complete a task, set this field to
1268
+ # `AMAZON.CodeInterpreter`. You must leave the `description`,
1269
+ # `apiSchema`, and `actionGroupExecutor` fields blank for this action
1270
+ # group.
1271
+ #
1056
1272
  # During orchestration, if your agent determines that it needs to
1057
1273
  # invoke an API in an action group, but doesn't have enough
1058
1274
  # information to complete the API request, it will invoke this action
@@ -1208,6 +1424,10 @@ module Aws::BedrockAgent
1208
1424
  # interact with users.
1209
1425
  # @return [String]
1210
1426
  #
1427
+ # @!attribute [rw] memory_configuration
1428
+ # Contains the details of the memory configured for the agent.
1429
+ # @return [Types::MemoryConfiguration]
1430
+ #
1211
1431
  # @!attribute [rw] prompt_override_configuration
1212
1432
  # Contains configurations to override prompts in different parts of an
1213
1433
  # agent sequence. For more information, see [Advanced prompts][1].
@@ -1233,6 +1453,7 @@ module Aws::BedrockAgent
1233
1453
  :guardrail_configuration,
1234
1454
  :idle_session_ttl_in_seconds,
1235
1455
  :instruction,
1456
+ :memory_configuration,
1236
1457
  :prompt_override_configuration,
1237
1458
  :tags)
1238
1459
  SENSITIVE = [:instruction, :prompt_override_configuration]
@@ -1266,11 +1487,22 @@ module Aws::BedrockAgent
1266
1487
  # @return [String]
1267
1488
  #
1268
1489
  # @!attribute [rw] data_deletion_policy
1269
- # The data deletion policy assigned to the data source.
1490
+ # The data deletion policy for the data source.
1491
+ #
1492
+ # You can set the data deletion policy to:
1493
+ #
1494
+ # * DELETE: Deletes all underlying data belonging to the data source
1495
+ # from the vector store upon deletion of a knowledge base or data
1496
+ # source resource. Note that the vector store itself is not deleted,
1497
+ # only the underlying data. This flag is ignored if an Amazon Web
1498
+ # Services account is deleted.
1499
+ #
1500
+ # * RETAIN: Retains all underlying data in your vector store upon
1501
+ # deletion of a knowledge base or data source resource.
1270
1502
  # @return [String]
1271
1503
  #
1272
1504
  # @!attribute [rw] data_source_configuration
1273
- # Contains metadata about where the data source is stored.
1505
+ # The connection configuration for the data source.
1274
1506
  # @return [Types::DataSourceConfiguration]
1275
1507
  #
1276
1508
  # @!attribute [rw] description
@@ -1338,479 +1570,1835 @@ module Aws::BedrockAgent
1338
1570
  # @return [String]
1339
1571
  #
1340
1572
  # @!attribute [rw] description
1341
- # A description of the knowledge base.
1573
+ # A description for the alias.
1342
1574
  # @return [String]
1343
1575
  #
1344
- # @!attribute [rw] knowledge_base_configuration
1345
- # Contains details about the embeddings model used for the knowledge
1346
- # base.
1347
- # @return [Types::KnowledgeBaseConfiguration]
1348
- #
1349
- # @!attribute [rw] name
1350
- # A name for the knowledge base.
1576
+ # @!attribute [rw] flow_identifier
1577
+ # The unique identifier of the flow for which to create an alias.
1351
1578
  # @return [String]
1352
1579
  #
1353
- # @!attribute [rw] role_arn
1354
- # The Amazon Resource Name (ARN) of the IAM role with permissions to
1355
- # invoke API operations on the knowledge base.
1580
+ # @!attribute [rw] name
1581
+ # A name for the alias.
1356
1582
  # @return [String]
1357
1583
  #
1358
- # @!attribute [rw] storage_configuration
1359
- # Contains details about the configuration of the vector database used
1360
- # for the knowledge base.
1361
- # @return [Types::StorageConfiguration]
1584
+ # @!attribute [rw] routing_configuration
1585
+ # Contains information about the version to which to map the alias.
1586
+ # @return [Array<Types::FlowAliasRoutingConfigurationListItem>]
1362
1587
  #
1363
1588
  # @!attribute [rw] tags
1364
- # Specify the key-value pairs for the tags that you want to attach to
1365
- # your knowledge base in this object.
1589
+ # Any tags that you want to attach to the alias of the flow. For more
1590
+ # information, see [Tagging resources in Amazon Bedrock][1].
1591
+ #
1592
+ #
1593
+ #
1594
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
1366
1595
  # @return [Hash<String,String>]
1367
1596
  #
1368
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBaseRequest AWS API Documentation
1597
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateFlowAliasRequest AWS API Documentation
1369
1598
  #
1370
- class CreateKnowledgeBaseRequest < Struct.new(
1599
+ class CreateFlowAliasRequest < Struct.new(
1371
1600
  :client_token,
1372
1601
  :description,
1373
- :knowledge_base_configuration,
1602
+ :flow_identifier,
1374
1603
  :name,
1375
- :role_arn,
1376
- :storage_configuration,
1604
+ :routing_configuration,
1377
1605
  :tags)
1378
1606
  SENSITIVE = []
1379
1607
  include Aws::Structure
1380
1608
  end
1381
1609
 
1382
- # @!attribute [rw] knowledge_base
1383
- # Contains details about the knowledge base.
1384
- # @return [Types::KnowledgeBase]
1385
- #
1386
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBaseResponse AWS API Documentation
1387
- #
1388
- class CreateKnowledgeBaseResponse < Struct.new(
1389
- :knowledge_base)
1390
- SENSITIVE = []
1391
- include Aws::Structure
1392
- end
1393
-
1394
- # Contains details about a data source.
1610
+ # @!attribute [rw] arn
1611
+ # The Amazon Resource Name (ARN) of the alias.
1612
+ # @return [String]
1395
1613
  #
1396
1614
  # @!attribute [rw] created_at
1397
- # The time at which the data source was created.
1615
+ # The time at which the alias was created.
1398
1616
  # @return [Time]
1399
1617
  #
1400
- # @!attribute [rw] data_deletion_policy
1401
- # The data deletion policy for a data source.
1402
- # @return [String]
1403
- #
1404
- # @!attribute [rw] data_source_configuration
1405
- # Contains details about how the data source is stored.
1406
- # @return [Types::DataSourceConfiguration]
1407
- #
1408
- # @!attribute [rw] data_source_id
1409
- # The unique identifier of the data source.
1410
- # @return [String]
1411
- #
1412
1618
  # @!attribute [rw] description
1413
- # The description of the data source.
1619
+ # The description of the alias.
1414
1620
  # @return [String]
1415
1621
  #
1416
- # @!attribute [rw] failure_reasons
1417
- # The detailed reasons on the failure to delete a data source.
1418
- # @return [Array<String>]
1622
+ # @!attribute [rw] flow_id
1623
+ # The unique identifier of the flow that the alias belongs to.
1624
+ # @return [String]
1419
1625
  #
1420
- # @!attribute [rw] knowledge_base_id
1421
- # The unique identifier of the knowledge base to which the data source
1422
- # belongs.
1626
+ # @!attribute [rw] id
1627
+ # The unique identifier of the alias.
1423
1628
  # @return [String]
1424
1629
  #
1425
1630
  # @!attribute [rw] name
1426
- # The name of the data source.
1631
+ # The name of the alias.
1427
1632
  # @return [String]
1428
1633
  #
1429
- # @!attribute [rw] server_side_encryption_configuration
1430
- # Contains details about the configuration of the server-side
1431
- # encryption.
1432
- # @return [Types::ServerSideEncryptionConfiguration]
1433
- #
1434
- # @!attribute [rw] status
1435
- # The status of the data source. The following statuses are possible:
1436
- #
1437
- # * Available – The data source has been created and is ready for
1438
- # ingestion into the knowledge base.
1439
- #
1440
- # * Deleting – The data source is being deleted.
1441
- # @return [String]
1634
+ # @!attribute [rw] routing_configuration
1635
+ # Contains information about the version that the alias is mapped to.
1636
+ # @return [Array<Types::FlowAliasRoutingConfigurationListItem>]
1442
1637
  #
1443
1638
  # @!attribute [rw] updated_at
1444
- # The time at which the data source was last updated.
1639
+ # The time at which the alias of the flow was last updated.
1445
1640
  # @return [Time]
1446
1641
  #
1447
- # @!attribute [rw] vector_ingestion_configuration
1448
- # Contains details about how to ingest the documents in the data
1449
- # source.
1450
- # @return [Types::VectorIngestionConfiguration]
1642
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateFlowAliasResponse AWS API Documentation
1451
1643
  #
1452
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSource AWS API Documentation
1453
- #
1454
- class DataSource < Struct.new(
1644
+ class CreateFlowAliasResponse < Struct.new(
1645
+ :arn,
1455
1646
  :created_at,
1456
- :data_deletion_policy,
1457
- :data_source_configuration,
1458
- :data_source_id,
1459
1647
  :description,
1460
- :failure_reasons,
1461
- :knowledge_base_id,
1648
+ :flow_id,
1649
+ :id,
1462
1650
  :name,
1463
- :server_side_encryption_configuration,
1464
- :status,
1465
- :updated_at,
1466
- :vector_ingestion_configuration)
1651
+ :routing_configuration,
1652
+ :updated_at)
1467
1653
  SENSITIVE = []
1468
1654
  include Aws::Structure
1469
1655
  end
1470
1656
 
1471
- # Contains details about how a data source is stored.
1657
+ # @!attribute [rw] client_token
1658
+ # A unique, case-sensitive identifier to ensure that the API request
1659
+ # completes no more than one time. If this token matches a previous
1660
+ # request, Amazon Bedrock ignores the request, but does not return an
1661
+ # error. For more information, see [Ensuring idempotency][1].
1472
1662
  #
1473
- # @!attribute [rw] s3_configuration
1474
- # Contains details about the configuration of the S3 object containing
1475
- # the data source.
1476
- # @return [Types::S3DataSourceConfiguration]
1663
+ # **A suitable default value is auto-generated.** You should normally
1664
+ # not need to pass this option.
1477
1665
  #
1478
- # @!attribute [rw] type
1479
- # The type of storage for the data source.
1480
- # @return [String]
1481
1666
  #
1482
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSourceConfiguration AWS API Documentation
1483
1667
  #
1484
- class DataSourceConfiguration < Struct.new(
1485
- :s3_configuration,
1486
- :type)
1487
- SENSITIVE = []
1488
- include Aws::Structure
1489
- end
1490
-
1491
- # Contains details about a data source.
1668
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
1669
+ # @return [String]
1492
1670
  #
1493
- # @!attribute [rw] data_source_id
1494
- # The unique identifier of the data source.
1671
+ # @!attribute [rw] customer_encryption_key_arn
1672
+ # The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
1495
1673
  # @return [String]
1496
1674
  #
1675
+ # @!attribute [rw] definition
1676
+ # A definition of the nodes and connections between nodes in the flow.
1677
+ # @return [Types::FlowDefinition]
1678
+ #
1497
1679
  # @!attribute [rw] description
1498
- # The description of the data source.
1680
+ # A description for the flow.
1499
1681
  # @return [String]
1500
1682
  #
1501
- # @!attribute [rw] knowledge_base_id
1502
- # The unique identifier of the knowledge base to which the data source
1503
- # belongs.
1683
+ # @!attribute [rw] execution_role_arn
1684
+ # The Amazon Resource Name (ARN) of the service role with permissions
1685
+ # to create and manage a flow. For more information, see [Create a
1686
+ # service role for flows in Amazon Bedrock][1] in the Amazon Bedrock
1687
+ # User Guide.
1688
+ #
1689
+ #
1690
+ #
1691
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html
1504
1692
  # @return [String]
1505
1693
  #
1506
1694
  # @!attribute [rw] name
1507
- # The name of the data source.
1695
+ # A name for the flow.
1508
1696
  # @return [String]
1509
1697
  #
1510
- # @!attribute [rw] status
1511
- # The status of the data source.
1512
- # @return [String]
1698
+ # @!attribute [rw] tags
1699
+ # Any tags that you want to attach to the flow. For more information,
1700
+ # see [Tagging resources in Amazon Bedrock][1].
1513
1701
  #
1514
- # @!attribute [rw] updated_at
1515
- # The time at which the data source was last updated.
1516
- # @return [Time]
1517
1702
  #
1518
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSourceSummary AWS API Documentation
1519
1703
  #
1520
- class DataSourceSummary < Struct.new(
1521
- :data_source_id,
1704
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
1705
+ # @return [Hash<String,String>]
1706
+ #
1707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateFlowRequest AWS API Documentation
1708
+ #
1709
+ class CreateFlowRequest < Struct.new(
1710
+ :client_token,
1711
+ :customer_encryption_key_arn,
1712
+ :definition,
1522
1713
  :description,
1523
- :knowledge_base_id,
1714
+ :execution_role_arn,
1524
1715
  :name,
1525
- :status,
1526
- :updated_at)
1716
+ :tags)
1527
1717
  SENSITIVE = []
1528
1718
  include Aws::Structure
1529
1719
  end
1530
1720
 
1531
- # @!attribute [rw] action_group_id
1532
- # The unique identifier of the action group to delete.
1721
+ # @!attribute [rw] arn
1722
+ # The Amazon Resource Name (ARN) of the flow.
1533
1723
  # @return [String]
1534
1724
  #
1535
- # @!attribute [rw] agent_id
1536
- # The unique identifier of the agent that the action group belongs to.
1725
+ # @!attribute [rw] created_at
1726
+ # The time at which the flow was created.
1727
+ # @return [Time]
1728
+ #
1729
+ # @!attribute [rw] customer_encryption_key_arn
1730
+ # The Amazon Resource Name (ARN) of the KMS key that you encrypted the
1731
+ # flow with.
1732
+ # @return [String]
1733
+ #
1734
+ # @!attribute [rw] definition
1735
+ # A definition of the nodes and connections between nodes in the flow.
1736
+ # @return [Types::FlowDefinition]
1737
+ #
1738
+ # @!attribute [rw] description
1739
+ # The description of the flow.
1740
+ # @return [String]
1741
+ #
1742
+ # @!attribute [rw] execution_role_arn
1743
+ # The Amazon Resource Name (ARN) of the service role with permissions
1744
+ # to create a flow. For more information, see [Create a service role
1745
+ # for flows in Amazon Bedrock][1] in the Amazon Bedrock User Guide.
1746
+ #
1747
+ #
1748
+ #
1749
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html
1750
+ # @return [String]
1751
+ #
1752
+ # @!attribute [rw] id
1753
+ # The unique identifier of the flow.
1754
+ # @return [String]
1755
+ #
1756
+ # @!attribute [rw] name
1757
+ # The name of the flow.
1758
+ # @return [String]
1759
+ #
1760
+ # @!attribute [rw] status
1761
+ # The status of the flow. When you submit this request, the status
1762
+ # will be `NotPrepared`. If creation fails, the status becomes
1763
+ # `Failed`.
1764
+ # @return [String]
1765
+ #
1766
+ # @!attribute [rw] updated_at
1767
+ # The time at which the flow was last updated.
1768
+ # @return [Time]
1769
+ #
1770
+ # @!attribute [rw] version
1771
+ # The version of the flow. When you create a flow, the version created
1772
+ # is the `DRAFT` version.
1773
+ # @return [String]
1774
+ #
1775
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateFlowResponse AWS API Documentation
1776
+ #
1777
+ class CreateFlowResponse < Struct.new(
1778
+ :arn,
1779
+ :created_at,
1780
+ :customer_encryption_key_arn,
1781
+ :definition,
1782
+ :description,
1783
+ :execution_role_arn,
1784
+ :id,
1785
+ :name,
1786
+ :status,
1787
+ :updated_at,
1788
+ :version)
1789
+ SENSITIVE = []
1790
+ include Aws::Structure
1791
+ end
1792
+
1793
+ # @!attribute [rw] client_token
1794
+ # A unique, case-sensitive identifier to ensure that the API request
1795
+ # completes no more than one time. If this token matches a previous
1796
+ # request, Amazon Bedrock ignores the request, but does not return an
1797
+ # error. For more information, see [Ensuring idempotency][1].
1798
+ #
1799
+ # **A suitable default value is auto-generated.** You should normally
1800
+ # not need to pass this option.
1801
+ #
1802
+ #
1803
+ #
1804
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
1805
+ # @return [String]
1806
+ #
1807
+ # @!attribute [rw] description
1808
+ # A description of the version of the flow.
1809
+ # @return [String]
1810
+ #
1811
+ # @!attribute [rw] flow_identifier
1812
+ # The unique identifier of the flow that you want to create a version
1813
+ # of.
1814
+ # @return [String]
1815
+ #
1816
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateFlowVersionRequest AWS API Documentation
1817
+ #
1818
+ class CreateFlowVersionRequest < Struct.new(
1819
+ :client_token,
1820
+ :description,
1821
+ :flow_identifier)
1822
+ SENSITIVE = []
1823
+ include Aws::Structure
1824
+ end
1825
+
1826
+ # @!attribute [rw] arn
1827
+ # The Amazon Resource Name (ARN) of the flow.
1828
+ # @return [String]
1829
+ #
1830
+ # @!attribute [rw] created_at
1831
+ # The time at which the flow was created.
1832
+ # @return [Time]
1833
+ #
1834
+ # @!attribute [rw] customer_encryption_key_arn
1835
+ # The KMS key that the flow is encrypted with.
1836
+ # @return [String]
1837
+ #
1838
+ # @!attribute [rw] definition
1839
+ # A definition of the nodes and connections in the flow.
1840
+ # @return [Types::FlowDefinition]
1841
+ #
1842
+ # @!attribute [rw] description
1843
+ # The description of the flow version.
1844
+ # @return [String]
1845
+ #
1846
+ # @!attribute [rw] execution_role_arn
1847
+ # The Amazon Resource Name (ARN) of the service role with permissions
1848
+ # to create a flow. For more information, see [Create a service role
1849
+ # for flows in Amazon Bedrock][1] in the Amazon Bedrock User Guide.
1850
+ #
1851
+ #
1852
+ #
1853
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html
1854
+ # @return [String]
1855
+ #
1856
+ # @!attribute [rw] id
1857
+ # The unique identifier of the flow.
1858
+ # @return [String]
1859
+ #
1860
+ # @!attribute [rw] name
1861
+ # The name of the flow version.
1862
+ # @return [String]
1863
+ #
1864
+ # @!attribute [rw] status
1865
+ # The status of the flow.
1866
+ # @return [String]
1867
+ #
1868
+ # @!attribute [rw] version
1869
+ # The version of the flow that was created. Versions are numbered
1870
+ # incrementally, starting from 1.
1871
+ # @return [String]
1872
+ #
1873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateFlowVersionResponse AWS API Documentation
1874
+ #
1875
+ class CreateFlowVersionResponse < Struct.new(
1876
+ :arn,
1877
+ :created_at,
1878
+ :customer_encryption_key_arn,
1879
+ :definition,
1880
+ :description,
1881
+ :execution_role_arn,
1882
+ :id,
1883
+ :name,
1884
+ :status,
1885
+ :version)
1886
+ SENSITIVE = []
1887
+ include Aws::Structure
1888
+ end
1889
+
1890
+ # @!attribute [rw] client_token
1891
+ # A unique, case-sensitive identifier to ensure that the API request
1892
+ # completes no more than one time. If this token matches a previous
1893
+ # request, Amazon Bedrock ignores the request, but does not return an
1894
+ # error. For more information, see [Ensuring idempotency][1].
1895
+ #
1896
+ # **A suitable default value is auto-generated.** You should normally
1897
+ # not need to pass this option.
1898
+ #
1899
+ #
1900
+ #
1901
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
1902
+ # @return [String]
1903
+ #
1904
+ # @!attribute [rw] description
1905
+ # A description of the knowledge base.
1906
+ # @return [String]
1907
+ #
1908
+ # @!attribute [rw] knowledge_base_configuration
1909
+ # Contains details about the embeddings model used for the knowledge
1910
+ # base.
1911
+ # @return [Types::KnowledgeBaseConfiguration]
1912
+ #
1913
+ # @!attribute [rw] name
1914
+ # A name for the knowledge base.
1915
+ # @return [String]
1916
+ #
1917
+ # @!attribute [rw] role_arn
1918
+ # The Amazon Resource Name (ARN) of the IAM role with permissions to
1919
+ # invoke API operations on the knowledge base.
1920
+ # @return [String]
1921
+ #
1922
+ # @!attribute [rw] storage_configuration
1923
+ # Contains details about the configuration of the vector database used
1924
+ # for the knowledge base.
1925
+ # @return [Types::StorageConfiguration]
1926
+ #
1927
+ # @!attribute [rw] tags
1928
+ # Specify the key-value pairs for the tags that you want to attach to
1929
+ # your knowledge base in this object.
1930
+ # @return [Hash<String,String>]
1931
+ #
1932
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBaseRequest AWS API Documentation
1933
+ #
1934
+ class CreateKnowledgeBaseRequest < Struct.new(
1935
+ :client_token,
1936
+ :description,
1937
+ :knowledge_base_configuration,
1938
+ :name,
1939
+ :role_arn,
1940
+ :storage_configuration,
1941
+ :tags)
1942
+ SENSITIVE = []
1943
+ include Aws::Structure
1944
+ end
1945
+
1946
+ # @!attribute [rw] knowledge_base
1947
+ # Contains details about the knowledge base.
1948
+ # @return [Types::KnowledgeBase]
1949
+ #
1950
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreateKnowledgeBaseResponse AWS API Documentation
1951
+ #
1952
+ class CreateKnowledgeBaseResponse < Struct.new(
1953
+ :knowledge_base)
1954
+ SENSITIVE = []
1955
+ include Aws::Structure
1956
+ end
1957
+
1958
+ # @!attribute [rw] client_token
1959
+ # A unique, case-sensitive identifier to ensure that the API request
1960
+ # completes no more than one time. If this token matches a previous
1961
+ # request, Amazon Bedrock ignores the request, but does not return an
1962
+ # error. For more information, see [Ensuring idempotency][1].
1963
+ #
1964
+ # **A suitable default value is auto-generated.** You should normally
1965
+ # not need to pass this option.
1966
+ #
1967
+ #
1968
+ #
1969
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
1970
+ # @return [String]
1971
+ #
1972
+ # @!attribute [rw] customer_encryption_key_arn
1973
+ # The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
1974
+ # @return [String]
1975
+ #
1976
+ # @!attribute [rw] default_variant
1977
+ # The name of the default variant for the prompt. This value must
1978
+ # match the `name` field in the relevant [PromptVariant][1] object.
1979
+ #
1980
+ #
1981
+ #
1982
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html
1983
+ # @return [String]
1984
+ #
1985
+ # @!attribute [rw] description
1986
+ # A description for the prompt.
1987
+ # @return [String]
1988
+ #
1989
+ # @!attribute [rw] name
1990
+ # A name for the prompt.
1991
+ # @return [String]
1992
+ #
1993
+ # @!attribute [rw] tags
1994
+ # Any tags that you want to attach to the prompt. For more
1995
+ # information, see [Tagging resources in Amazon Bedrock][1].
1996
+ #
1997
+ #
1998
+ #
1999
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
2000
+ # @return [Hash<String,String>]
2001
+ #
2002
+ # @!attribute [rw] variants
2003
+ # A list of objects, each containing details about a variant of the
2004
+ # prompt.
2005
+ # @return [Array<Types::PromptVariant>]
2006
+ #
2007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreatePromptRequest AWS API Documentation
2008
+ #
2009
+ class CreatePromptRequest < Struct.new(
2010
+ :client_token,
2011
+ :customer_encryption_key_arn,
2012
+ :default_variant,
2013
+ :description,
2014
+ :name,
2015
+ :tags,
2016
+ :variants)
2017
+ SENSITIVE = [:variants]
2018
+ include Aws::Structure
2019
+ end
2020
+
2021
+ # @!attribute [rw] arn
2022
+ # The Amazon Resource Name (ARN) of the prompt.
2023
+ # @return [String]
2024
+ #
2025
+ # @!attribute [rw] created_at
2026
+ # The time at which the prompt was created.
2027
+ # @return [Time]
2028
+ #
2029
+ # @!attribute [rw] customer_encryption_key_arn
2030
+ # The Amazon Resource Name (ARN) of the KMS key that you encrypted the
2031
+ # prompt with.
2032
+ # @return [String]
2033
+ #
2034
+ # @!attribute [rw] default_variant
2035
+ # The name of the default variant for your prompt.
2036
+ # @return [String]
2037
+ #
2038
+ # @!attribute [rw] description
2039
+ # The description of the prompt.
2040
+ # @return [String]
2041
+ #
2042
+ # @!attribute [rw] id
2043
+ # The unique identifier of the prompt.
2044
+ # @return [String]
2045
+ #
2046
+ # @!attribute [rw] name
2047
+ # The name of the prompt.
2048
+ # @return [String]
2049
+ #
2050
+ # @!attribute [rw] updated_at
2051
+ # The time at which the prompt was last updated.
2052
+ # @return [Time]
2053
+ #
2054
+ # @!attribute [rw] variants
2055
+ # A list of objects, each containing details about a variant of the
2056
+ # prompt.
2057
+ # @return [Array<Types::PromptVariant>]
2058
+ #
2059
+ # @!attribute [rw] version
2060
+ # The version of the prompt. When you create a prompt, the version
2061
+ # created is the `DRAFT` version.
2062
+ # @return [String]
2063
+ #
2064
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreatePromptResponse AWS API Documentation
2065
+ #
2066
+ class CreatePromptResponse < Struct.new(
2067
+ :arn,
2068
+ :created_at,
2069
+ :customer_encryption_key_arn,
2070
+ :default_variant,
2071
+ :description,
2072
+ :id,
2073
+ :name,
2074
+ :updated_at,
2075
+ :variants,
2076
+ :version)
2077
+ SENSITIVE = [:variants]
2078
+ include Aws::Structure
2079
+ end
2080
+
2081
+ # @!attribute [rw] client_token
2082
+ # A unique, case-sensitive identifier to ensure that the API request
2083
+ # completes no more than one time. If this token matches a previous
2084
+ # request, Amazon Bedrock ignores the request, but does not return an
2085
+ # error. For more information, see [Ensuring idempotency][1].
2086
+ #
2087
+ # **A suitable default value is auto-generated.** You should normally
2088
+ # not need to pass this option.
2089
+ #
2090
+ #
2091
+ #
2092
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
2093
+ # @return [String]
2094
+ #
2095
+ # @!attribute [rw] description
2096
+ # A description for the version of the prompt.
2097
+ # @return [String]
2098
+ #
2099
+ # @!attribute [rw] prompt_identifier
2100
+ # The unique identifier of the prompt that you want to create a
2101
+ # version of.
2102
+ # @return [String]
2103
+ #
2104
+ # @!attribute [rw] tags
2105
+ # Any tags that you want to attach to the version of the prompt. For
2106
+ # more information, see [Tagging resources in Amazon Bedrock][1].
2107
+ #
2108
+ #
2109
+ #
2110
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
2111
+ # @return [Hash<String,String>]
2112
+ #
2113
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreatePromptVersionRequest AWS API Documentation
2114
+ #
2115
+ class CreatePromptVersionRequest < Struct.new(
2116
+ :client_token,
2117
+ :description,
2118
+ :prompt_identifier,
2119
+ :tags)
2120
+ SENSITIVE = []
2121
+ include Aws::Structure
2122
+ end
2123
+
2124
+ # @!attribute [rw] arn
2125
+ # The Amazon Resource Name (ARN) of the version of the prompt.
2126
+ # @return [String]
2127
+ #
2128
+ # @!attribute [rw] created_at
2129
+ # The time at which the prompt was created.
2130
+ # @return [Time]
2131
+ #
2132
+ # @!attribute [rw] customer_encryption_key_arn
2133
+ # The Amazon Resource Name (ARN) of the KMS key to encrypt the version
2134
+ # of the prompt.
2135
+ # @return [String]
2136
+ #
2137
+ # @!attribute [rw] default_variant
2138
+ # The name of the default variant for the prompt. This value must
2139
+ # match the `name` field in the relevant [PromptVariant][1] object.
2140
+ #
2141
+ #
2142
+ #
2143
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html
2144
+ # @return [String]
2145
+ #
2146
+ # @!attribute [rw] description
2147
+ # A description for the prompt version.
2148
+ # @return [String]
2149
+ #
2150
+ # @!attribute [rw] id
2151
+ # The unique identifier of the prompt.
2152
+ # @return [String]
2153
+ #
2154
+ # @!attribute [rw] name
2155
+ # The name of the prompt version.
2156
+ # @return [String]
2157
+ #
2158
+ # @!attribute [rw] updated_at
2159
+ # The time at which the prompt was last updated.
2160
+ # @return [Time]
2161
+ #
2162
+ # @!attribute [rw] variants
2163
+ # A list of objects, each containing details about a variant of the
2164
+ # prompt.
2165
+ # @return [Array<Types::PromptVariant>]
2166
+ #
2167
+ # @!attribute [rw] version
2168
+ # The version of the prompt that was created. Versions are numbered
2169
+ # incrementally, starting from 1.
2170
+ # @return [String]
2171
+ #
2172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CreatePromptVersionResponse AWS API Documentation
2173
+ #
2174
+ class CreatePromptVersionResponse < Struct.new(
2175
+ :arn,
2176
+ :created_at,
2177
+ :customer_encryption_key_arn,
2178
+ :default_variant,
2179
+ :description,
2180
+ :id,
2181
+ :name,
2182
+ :updated_at,
2183
+ :variants,
2184
+ :version)
2185
+ SENSITIVE = [:variants]
2186
+ include Aws::Structure
2187
+ end
2188
+
2189
+ # Settings for customizing steps in the data source content ingestion
2190
+ # pipeline.
2191
+ #
2192
+ # You can configure the data source to process documents with a Lambda
2193
+ # function after they are parsed and converted into chunks. When you add
2194
+ # a post-chunking transformation, the service stores chunked documents
2195
+ # in an S3 bucket and invokes a Lambda function to process them.
2196
+ #
2197
+ # To process chunked documents with a Lambda function, define an S3
2198
+ # bucket path for input and output objects, and a transformation that
2199
+ # specifies the Lambda function to invoke. You can use the Lambda
2200
+ # function to customize how chunks are split, and the metadata for each
2201
+ # chunk.
2202
+ #
2203
+ # @!attribute [rw] intermediate_storage
2204
+ # An S3 bucket path for input and output objects.
2205
+ # @return [Types::IntermediateStorage]
2206
+ #
2207
+ # @!attribute [rw] transformations
2208
+ # A Lambda function that processes documents.
2209
+ # @return [Array<Types::Transformation>]
2210
+ #
2211
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CustomTransformationConfiguration AWS API Documentation
2212
+ #
2213
+ class CustomTransformationConfiguration < Struct.new(
2214
+ :intermediate_storage,
2215
+ :transformations)
2216
+ SENSITIVE = []
2217
+ include Aws::Structure
2218
+ end
2219
+
2220
+ # Contains details about a data source.
2221
+ #
2222
+ # @!attribute [rw] created_at
2223
+ # The time at which the data source was created.
2224
+ # @return [Time]
2225
+ #
2226
+ # @!attribute [rw] data_deletion_policy
2227
+ # The data deletion policy for the data source.
2228
+ # @return [String]
2229
+ #
2230
+ # @!attribute [rw] data_source_configuration
2231
+ # The connection configuration for the data source.
2232
+ # @return [Types::DataSourceConfiguration]
2233
+ #
2234
+ # @!attribute [rw] data_source_id
2235
+ # The unique identifier of the data source.
2236
+ # @return [String]
2237
+ #
2238
+ # @!attribute [rw] description
2239
+ # The description of the data source.
2240
+ # @return [String]
2241
+ #
2242
+ # @!attribute [rw] failure_reasons
2243
+ # The detailed reasons on the failure to delete a data source.
2244
+ # @return [Array<String>]
2245
+ #
2246
+ # @!attribute [rw] knowledge_base_id
2247
+ # The unique identifier of the knowledge base to which the data source
2248
+ # belongs.
2249
+ # @return [String]
2250
+ #
2251
+ # @!attribute [rw] name
2252
+ # The name of the data source.
2253
+ # @return [String]
2254
+ #
2255
+ # @!attribute [rw] server_side_encryption_configuration
2256
+ # Contains details about the configuration of the server-side
2257
+ # encryption.
2258
+ # @return [Types::ServerSideEncryptionConfiguration]
2259
+ #
2260
+ # @!attribute [rw] status
2261
+ # The status of the data source. The following statuses are possible:
2262
+ #
2263
+ # * Available – The data source has been created and is ready for
2264
+ # ingestion into the knowledge base.
2265
+ #
2266
+ # * Deleting – The data source is being deleted.
2267
+ # @return [String]
2268
+ #
2269
+ # @!attribute [rw] updated_at
2270
+ # The time at which the data source was last updated.
2271
+ # @return [Time]
2272
+ #
2273
+ # @!attribute [rw] vector_ingestion_configuration
2274
+ # Contains details about how to ingest the documents in the data
2275
+ # source.
2276
+ # @return [Types::VectorIngestionConfiguration]
2277
+ #
2278
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSource AWS API Documentation
2279
+ #
2280
+ class DataSource < Struct.new(
2281
+ :created_at,
2282
+ :data_deletion_policy,
2283
+ :data_source_configuration,
2284
+ :data_source_id,
2285
+ :description,
2286
+ :failure_reasons,
2287
+ :knowledge_base_id,
2288
+ :name,
2289
+ :server_side_encryption_configuration,
2290
+ :status,
2291
+ :updated_at,
2292
+ :vector_ingestion_configuration)
2293
+ SENSITIVE = []
2294
+ include Aws::Structure
2295
+ end
2296
+
2297
+ # The connection configuration for the data source.
2298
+ #
2299
+ # @!attribute [rw] confluence_configuration
2300
+ # The configuration information to connect to Confluence as your data
2301
+ # source.
2302
+ #
2303
+ # <note markdown="1"> Confluence data source connector is in preview release and is
2304
+ # subject to change.
2305
+ #
2306
+ # </note>
2307
+ # @return [Types::ConfluenceDataSourceConfiguration]
2308
+ #
2309
+ # @!attribute [rw] s3_configuration
2310
+ # The configuration information to connect to Amazon S3 as your data
2311
+ # source.
2312
+ # @return [Types::S3DataSourceConfiguration]
2313
+ #
2314
+ # @!attribute [rw] salesforce_configuration
2315
+ # The configuration information to connect to Salesforce as your data
2316
+ # source.
2317
+ #
2318
+ # <note markdown="1"> Salesforce data source connector is in preview release and is
2319
+ # subject to change.
2320
+ #
2321
+ # </note>
2322
+ # @return [Types::SalesforceDataSourceConfiguration]
2323
+ #
2324
+ # @!attribute [rw] share_point_configuration
2325
+ # The configuration information to connect to SharePoint as your data
2326
+ # source.
2327
+ #
2328
+ # <note markdown="1"> SharePoint data source connector is in preview release and is
2329
+ # subject to change.
2330
+ #
2331
+ # </note>
2332
+ # @return [Types::SharePointDataSourceConfiguration]
2333
+ #
2334
+ # @!attribute [rw] type
2335
+ # The type of data source.
2336
+ # @return [String]
2337
+ #
2338
+ # @!attribute [rw] web_configuration
2339
+ # The configuration of web URLs to crawl for your data source. You
2340
+ # should be authorized to crawl the URLs.
2341
+ #
2342
+ # <note markdown="1"> Crawling web URLs as your data source is in preview release and is
2343
+ # subject to change.
2344
+ #
2345
+ # </note>
2346
+ # @return [Types::WebDataSourceConfiguration]
2347
+ #
2348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSourceConfiguration AWS API Documentation
2349
+ #
2350
+ class DataSourceConfiguration < Struct.new(
2351
+ :confluence_configuration,
2352
+ :s3_configuration,
2353
+ :salesforce_configuration,
2354
+ :share_point_configuration,
2355
+ :type,
2356
+ :web_configuration)
2357
+ SENSITIVE = []
2358
+ include Aws::Structure
2359
+ end
2360
+
2361
+ # Contains details about a data source.
2362
+ #
2363
+ # @!attribute [rw] data_source_id
2364
+ # The unique identifier of the data source.
2365
+ # @return [String]
2366
+ #
2367
+ # @!attribute [rw] description
2368
+ # The description of the data source.
2369
+ # @return [String]
2370
+ #
2371
+ # @!attribute [rw] knowledge_base_id
2372
+ # The unique identifier of the knowledge base to which the data source
2373
+ # belongs.
2374
+ # @return [String]
2375
+ #
2376
+ # @!attribute [rw] name
2377
+ # The name of the data source.
2378
+ # @return [String]
2379
+ #
2380
+ # @!attribute [rw] status
2381
+ # The status of the data source.
2382
+ # @return [String]
2383
+ #
2384
+ # @!attribute [rw] updated_at
2385
+ # The time at which the data source was last updated.
2386
+ # @return [Time]
2387
+ #
2388
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DataSourceSummary AWS API Documentation
2389
+ #
2390
+ class DataSourceSummary < Struct.new(
2391
+ :data_source_id,
2392
+ :description,
2393
+ :knowledge_base_id,
2394
+ :name,
2395
+ :status,
2396
+ :updated_at)
2397
+ SENSITIVE = []
2398
+ include Aws::Structure
2399
+ end
2400
+
2401
+ # @!attribute [rw] action_group_id
2402
+ # The unique identifier of the action group to delete.
2403
+ # @return [String]
2404
+ #
2405
+ # @!attribute [rw] agent_id
2406
+ # The unique identifier of the agent that the action group belongs to.
2407
+ # @return [String]
2408
+ #
2409
+ # @!attribute [rw] agent_version
2410
+ # The version of the agent that the action group belongs to.
2411
+ # @return [String]
2412
+ #
2413
+ # @!attribute [rw] skip_resource_in_use_check
2414
+ # By default, this value is `false` and deletion is stopped if the
2415
+ # resource is in use. If you set it to `true`, the resource will be
2416
+ # deleted even if the resource is in use.
2417
+ # @return [Boolean]
2418
+ #
2419
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentActionGroupRequest AWS API Documentation
2420
+ #
2421
+ class DeleteAgentActionGroupRequest < Struct.new(
2422
+ :action_group_id,
2423
+ :agent_id,
2424
+ :agent_version,
2425
+ :skip_resource_in_use_check)
2426
+ SENSITIVE = []
2427
+ include Aws::Structure
2428
+ end
2429
+
2430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentActionGroupResponse AWS API Documentation
2431
+ #
2432
+ class DeleteAgentActionGroupResponse < Aws::EmptyStructure; end
2433
+
2434
+ # @!attribute [rw] agent_alias_id
2435
+ # The unique identifier of the alias to delete.
2436
+ # @return [String]
2437
+ #
2438
+ # @!attribute [rw] agent_id
2439
+ # The unique identifier of the agent that the alias belongs to.
2440
+ # @return [String]
2441
+ #
2442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAliasRequest AWS API Documentation
2443
+ #
2444
+ class DeleteAgentAliasRequest < Struct.new(
2445
+ :agent_alias_id,
2446
+ :agent_id)
2447
+ SENSITIVE = []
2448
+ include Aws::Structure
2449
+ end
2450
+
2451
+ # @!attribute [rw] agent_alias_id
2452
+ # The unique identifier of the alias that was deleted.
2453
+ # @return [String]
2454
+ #
2455
+ # @!attribute [rw] agent_alias_status
2456
+ # The status of the alias.
2457
+ # @return [String]
2458
+ #
2459
+ # @!attribute [rw] agent_id
2460
+ # The unique identifier of the agent that the alias belongs to.
2461
+ # @return [String]
2462
+ #
2463
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAliasResponse AWS API Documentation
2464
+ #
2465
+ class DeleteAgentAliasResponse < Struct.new(
2466
+ :agent_alias_id,
2467
+ :agent_alias_status,
2468
+ :agent_id)
2469
+ SENSITIVE = []
2470
+ include Aws::Structure
2471
+ end
2472
+
2473
+ # @!attribute [rw] agent_id
2474
+ # The unique identifier of the agent to delete.
2475
+ # @return [String]
2476
+ #
2477
+ # @!attribute [rw] skip_resource_in_use_check
2478
+ # By default, this value is `false` and deletion is stopped if the
2479
+ # resource is in use. If you set it to `true`, the resource will be
2480
+ # deleted even if the resource is in use.
2481
+ # @return [Boolean]
2482
+ #
2483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentRequest AWS API Documentation
2484
+ #
2485
+ class DeleteAgentRequest < Struct.new(
2486
+ :agent_id,
2487
+ :skip_resource_in_use_check)
2488
+ SENSITIVE = []
2489
+ include Aws::Structure
2490
+ end
2491
+
2492
+ # @!attribute [rw] agent_id
2493
+ # The unique identifier of the agent that was deleted.
2494
+ # @return [String]
2495
+ #
2496
+ # @!attribute [rw] agent_status
2497
+ # The status of the agent.
2498
+ # @return [String]
2499
+ #
2500
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentResponse AWS API Documentation
2501
+ #
2502
+ class DeleteAgentResponse < Struct.new(
2503
+ :agent_id,
2504
+ :agent_status)
2505
+ SENSITIVE = []
2506
+ include Aws::Structure
2507
+ end
2508
+
2509
+ # @!attribute [rw] agent_id
2510
+ # The unique identifier of the agent that the version belongs to.
2511
+ # @return [String]
2512
+ #
2513
+ # @!attribute [rw] agent_version
2514
+ # The version of the agent to delete.
2515
+ # @return [String]
2516
+ #
2517
+ # @!attribute [rw] skip_resource_in_use_check
2518
+ # By default, this value is `false` and deletion is stopped if the
2519
+ # resource is in use. If you set it to `true`, the resource will be
2520
+ # deleted even if the resource is in use.
2521
+ # @return [Boolean]
2522
+ #
2523
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersionRequest AWS API Documentation
2524
+ #
2525
+ class DeleteAgentVersionRequest < Struct.new(
2526
+ :agent_id,
2527
+ :agent_version,
2528
+ :skip_resource_in_use_check)
2529
+ SENSITIVE = []
2530
+ include Aws::Structure
2531
+ end
2532
+
2533
+ # @!attribute [rw] agent_id
2534
+ # The unique identifier of the agent that the version belongs to.
2535
+ # @return [String]
2536
+ #
2537
+ # @!attribute [rw] agent_status
2538
+ # The status of the agent version.
1537
2539
  # @return [String]
1538
2540
  #
1539
2541
  # @!attribute [rw] agent_version
1540
- # The version of the agent that the action group belongs to.
2542
+ # The version that was deleted.
2543
+ # @return [String]
2544
+ #
2545
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersionResponse AWS API Documentation
2546
+ #
2547
+ class DeleteAgentVersionResponse < Struct.new(
2548
+ :agent_id,
2549
+ :agent_status,
2550
+ :agent_version)
2551
+ SENSITIVE = []
2552
+ include Aws::Structure
2553
+ end
2554
+
2555
+ # @!attribute [rw] data_source_id
2556
+ # The unique identifier of the data source to delete.
2557
+ # @return [String]
2558
+ #
2559
+ # @!attribute [rw] knowledge_base_id
2560
+ # The unique identifier of the knowledge base from which to delete the
2561
+ # data source.
2562
+ # @return [String]
2563
+ #
2564
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSourceRequest AWS API Documentation
2565
+ #
2566
+ class DeleteDataSourceRequest < Struct.new(
2567
+ :data_source_id,
2568
+ :knowledge_base_id)
2569
+ SENSITIVE = []
2570
+ include Aws::Structure
2571
+ end
2572
+
2573
+ # @!attribute [rw] data_source_id
2574
+ # The unique identifier of the data source that was deleted.
2575
+ # @return [String]
2576
+ #
2577
+ # @!attribute [rw] knowledge_base_id
2578
+ # The unique identifier of the knowledge base to which the data source
2579
+ # that was deleted belonged.
2580
+ # @return [String]
2581
+ #
2582
+ # @!attribute [rw] status
2583
+ # The status of the data source.
2584
+ # @return [String]
2585
+ #
2586
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSourceResponse AWS API Documentation
2587
+ #
2588
+ class DeleteDataSourceResponse < Struct.new(
2589
+ :data_source_id,
2590
+ :knowledge_base_id,
2591
+ :status)
2592
+ SENSITIVE = []
2593
+ include Aws::Structure
2594
+ end
2595
+
2596
+ # @!attribute [rw] alias_identifier
2597
+ # The unique identifier of the alias to be deleted.
2598
+ # @return [String]
2599
+ #
2600
+ # @!attribute [rw] flow_identifier
2601
+ # The unique identifier of the flow that the alias belongs to.
2602
+ # @return [String]
2603
+ #
2604
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteFlowAliasRequest AWS API Documentation
2605
+ #
2606
+ class DeleteFlowAliasRequest < Struct.new(
2607
+ :alias_identifier,
2608
+ :flow_identifier)
2609
+ SENSITIVE = []
2610
+ include Aws::Structure
2611
+ end
2612
+
2613
+ # @!attribute [rw] flow_id
2614
+ # The unique identifier of the flow that the alias belongs to.
2615
+ # @return [String]
2616
+ #
2617
+ # @!attribute [rw] id
2618
+ # The unique identifier of the flow.
2619
+ # @return [String]
2620
+ #
2621
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteFlowAliasResponse AWS API Documentation
2622
+ #
2623
+ class DeleteFlowAliasResponse < Struct.new(
2624
+ :flow_id,
2625
+ :id)
2626
+ SENSITIVE = []
2627
+ include Aws::Structure
2628
+ end
2629
+
2630
+ # @!attribute [rw] flow_identifier
2631
+ # The unique identifier of the flow.
2632
+ # @return [String]
2633
+ #
2634
+ # @!attribute [rw] skip_resource_in_use_check
2635
+ # By default, this value is `false` and deletion is stopped if the
2636
+ # resource is in use. If you set it to `true`, the resource will be
2637
+ # deleted even if the resource is in use.
2638
+ # @return [Boolean]
2639
+ #
2640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteFlowRequest AWS API Documentation
2641
+ #
2642
+ class DeleteFlowRequest < Struct.new(
2643
+ :flow_identifier,
2644
+ :skip_resource_in_use_check)
2645
+ SENSITIVE = []
2646
+ include Aws::Structure
2647
+ end
2648
+
2649
+ # @!attribute [rw] id
2650
+ # The unique identifier of the flow.
2651
+ # @return [String]
2652
+ #
2653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteFlowResponse AWS API Documentation
2654
+ #
2655
+ class DeleteFlowResponse < Struct.new(
2656
+ :id)
2657
+ SENSITIVE = []
2658
+ include Aws::Structure
2659
+ end
2660
+
2661
+ # @!attribute [rw] flow_identifier
2662
+ # The unique identifier of the flow whose version that you want to
2663
+ # delete
2664
+ # @return [String]
2665
+ #
2666
+ # @!attribute [rw] flow_version
2667
+ # The version of the flow that you want to delete.
2668
+ # @return [String]
2669
+ #
2670
+ # @!attribute [rw] skip_resource_in_use_check
2671
+ # By default, this value is `false` and deletion is stopped if the
2672
+ # resource is in use. If you set it to `true`, the resource will be
2673
+ # deleted even if the resource is in use.
2674
+ # @return [Boolean]
2675
+ #
2676
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteFlowVersionRequest AWS API Documentation
2677
+ #
2678
+ class DeleteFlowVersionRequest < Struct.new(
2679
+ :flow_identifier,
2680
+ :flow_version,
2681
+ :skip_resource_in_use_check)
2682
+ SENSITIVE = []
2683
+ include Aws::Structure
2684
+ end
2685
+
2686
+ # @!attribute [rw] id
2687
+ # The unique identifier of the flow.
2688
+ # @return [String]
2689
+ #
2690
+ # @!attribute [rw] version
2691
+ # The version of the flow being deleted.
2692
+ # @return [String]
2693
+ #
2694
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteFlowVersionResponse AWS API Documentation
2695
+ #
2696
+ class DeleteFlowVersionResponse < Struct.new(
2697
+ :id,
2698
+ :version)
2699
+ SENSITIVE = []
2700
+ include Aws::Structure
2701
+ end
2702
+
2703
+ # @!attribute [rw] knowledge_base_id
2704
+ # The unique identifier of the knowledge base to delete.
2705
+ # @return [String]
2706
+ #
2707
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBaseRequest AWS API Documentation
2708
+ #
2709
+ class DeleteKnowledgeBaseRequest < Struct.new(
2710
+ :knowledge_base_id)
2711
+ SENSITIVE = []
2712
+ include Aws::Structure
2713
+ end
2714
+
2715
+ # @!attribute [rw] knowledge_base_id
2716
+ # The unique identifier of the knowledge base that was deleted.
2717
+ # @return [String]
2718
+ #
2719
+ # @!attribute [rw] status
2720
+ # The status of the knowledge base and whether it has been
2721
+ # successfully deleted.
2722
+ # @return [String]
2723
+ #
2724
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBaseResponse AWS API Documentation
2725
+ #
2726
+ class DeleteKnowledgeBaseResponse < Struct.new(
2727
+ :knowledge_base_id,
2728
+ :status)
2729
+ SENSITIVE = []
2730
+ include Aws::Structure
2731
+ end
2732
+
2733
+ # @!attribute [rw] prompt_identifier
2734
+ # The unique identifier of the prompt.
2735
+ # @return [String]
2736
+ #
2737
+ # @!attribute [rw] prompt_version
2738
+ # The version of the prompt to delete.
2739
+ # @return [String]
2740
+ #
2741
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeletePromptRequest AWS API Documentation
2742
+ #
2743
+ class DeletePromptRequest < Struct.new(
2744
+ :prompt_identifier,
2745
+ :prompt_version)
2746
+ SENSITIVE = []
2747
+ include Aws::Structure
2748
+ end
2749
+
2750
+ # @!attribute [rw] id
2751
+ # The unique identifier of the prompt that was deleted.
2752
+ # @return [String]
2753
+ #
2754
+ # @!attribute [rw] version
2755
+ # The version of the prompt that was deleted.
2756
+ # @return [String]
2757
+ #
2758
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeletePromptResponse AWS API Documentation
2759
+ #
2760
+ class DeletePromptResponse < Struct.new(
2761
+ :id,
2762
+ :version)
2763
+ SENSITIVE = []
2764
+ include Aws::Structure
2765
+ end
2766
+
2767
+ # @!attribute [rw] agent_id
2768
+ # The unique identifier of the agent from which to disassociate the
2769
+ # knowledge base.
2770
+ # @return [String]
2771
+ #
2772
+ # @!attribute [rw] agent_version
2773
+ # The version of the agent from which to disassociate the knowledge
2774
+ # base.
2775
+ # @return [String]
2776
+ #
2777
+ # @!attribute [rw] knowledge_base_id
2778
+ # The unique identifier of the knowledge base to disassociate.
2779
+ # @return [String]
2780
+ #
2781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBaseRequest AWS API Documentation
2782
+ #
2783
+ class DisassociateAgentKnowledgeBaseRequest < Struct.new(
2784
+ :agent_id,
2785
+ :agent_version,
2786
+ :knowledge_base_id)
2787
+ SENSITIVE = []
2788
+ include Aws::Structure
2789
+ end
2790
+
2791
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBaseResponse AWS API Documentation
2792
+ #
2793
+ class DisassociateAgentKnowledgeBaseResponse < Aws::EmptyStructure; end
2794
+
2795
+ # The configuration details for the embeddings model.
2796
+ #
2797
+ # @!attribute [rw] bedrock_embedding_model_configuration
2798
+ # The vector configuration details on the Bedrock embeddings model.
2799
+ # @return [Types::BedrockEmbeddingModelConfiguration]
2800
+ #
2801
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/EmbeddingModelConfiguration AWS API Documentation
2802
+ #
2803
+ class EmbeddingModelConfiguration < Struct.new(
2804
+ :bedrock_embedding_model_configuration)
2805
+ SENSITIVE = []
2806
+ include Aws::Structure
2807
+ end
2808
+
2809
+ # Configurations for when you choose fixed-size chunking. If you set the
2810
+ # `chunkingStrategy` as `NONE`, exclude this field.
2811
+ #
2812
+ # @!attribute [rw] max_tokens
2813
+ # The maximum number of tokens to include in a chunk.
2814
+ # @return [Integer]
2815
+ #
2816
+ # @!attribute [rw] overlap_percentage
2817
+ # The percentage of overlap between adjacent chunks of a data source.
2818
+ # @return [Integer]
2819
+ #
2820
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FixedSizeChunkingConfiguration AWS API Documentation
2821
+ #
2822
+ class FixedSizeChunkingConfiguration < Struct.new(
2823
+ :max_tokens,
2824
+ :overlap_percentage)
2825
+ SENSITIVE = []
2826
+ include Aws::Structure
2827
+ end
2828
+
2829
+ # Contains information about a version that the alias maps to.
2830
+ #
2831
+ # @!attribute [rw] flow_version
2832
+ # The version that the alias maps to.
2833
+ # @return [String]
2834
+ #
2835
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowAliasRoutingConfigurationListItem AWS API Documentation
2836
+ #
2837
+ class FlowAliasRoutingConfigurationListItem < Struct.new(
2838
+ :flow_version)
2839
+ SENSITIVE = []
2840
+ include Aws::Structure
2841
+ end
2842
+
2843
+ # Contains information about an alias of a flow.
2844
+ #
2845
+ # This data type is used in the following API operations:
2846
+ #
2847
+ # * [ListFlowAliases response][1]
2848
+ #
2849
+ # ^
2850
+ #
2851
+ #
2852
+ #
2853
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListFlowAliases.html#API_agent_ListFlowAliases_ResponseSyntax
2854
+ #
2855
+ # @!attribute [rw] arn
2856
+ # The Amazon Resource Name (ARN) of the flow alias.
2857
+ # @return [String]
2858
+ #
2859
+ # @!attribute [rw] created_at
2860
+ # The time at which the alias was created.
2861
+ # @return [Time]
2862
+ #
2863
+ # @!attribute [rw] description
2864
+ # A description of the alias.
1541
2865
  # @return [String]
1542
2866
  #
1543
- # @!attribute [rw] skip_resource_in_use_check
1544
- # By default, this value is `false` and deletion is stopped if the
1545
- # resource is in use. If you set it to `true`, the resource will be
1546
- # deleted even if the resource is in use.
1547
- # @return [Boolean]
2867
+ # @!attribute [rw] flow_id
2868
+ # The unique identifier of the flow.
2869
+ # @return [String]
1548
2870
  #
1549
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentActionGroupRequest AWS API Documentation
2871
+ # @!attribute [rw] id
2872
+ # The unique identifier of the alias of the flow.
2873
+ # @return [String]
1550
2874
  #
1551
- class DeleteAgentActionGroupRequest < Struct.new(
1552
- :action_group_id,
1553
- :agent_id,
1554
- :agent_version,
1555
- :skip_resource_in_use_check)
2875
+ # @!attribute [rw] name
2876
+ # The name of the alias.
2877
+ # @return [String]
2878
+ #
2879
+ # @!attribute [rw] routing_configuration
2880
+ # A list of configurations about the versions that the alias maps to.
2881
+ # Currently, you can only specify one.
2882
+ # @return [Array<Types::FlowAliasRoutingConfigurationListItem>]
2883
+ #
2884
+ # @!attribute [rw] updated_at
2885
+ # The time at which the alias was last updated.
2886
+ # @return [Time]
2887
+ #
2888
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowAliasSummary AWS API Documentation
2889
+ #
2890
+ class FlowAliasSummary < Struct.new(
2891
+ :arn,
2892
+ :created_at,
2893
+ :description,
2894
+ :flow_id,
2895
+ :id,
2896
+ :name,
2897
+ :routing_configuration,
2898
+ :updated_at)
1556
2899
  SENSITIVE = []
1557
2900
  include Aws::Structure
1558
2901
  end
1559
2902
 
1560
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentActionGroupResponse AWS API Documentation
2903
+ # Defines a condition in the condition node.
1561
2904
  #
1562
- class DeleteAgentActionGroupResponse < Aws::EmptyStructure; end
1563
-
1564
- # @!attribute [rw] agent_alias_id
1565
- # The unique identifier of the alias to delete.
2905
+ # @!attribute [rw] expression
2906
+ # Defines the condition. You must refer to at least one of the inputs
2907
+ # in the condition. For more information, expand the Condition node
2908
+ # section in [Node types in prompt flows][1].
2909
+ #
2910
+ #
2911
+ #
2912
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-how-it-works.html#flows-nodes
1566
2913
  # @return [String]
1567
2914
  #
1568
- # @!attribute [rw] agent_id
1569
- # The unique identifier of the agent that the alias belongs to.
2915
+ # @!attribute [rw] name
2916
+ # A name for the condition that you can reference.
1570
2917
  # @return [String]
1571
2918
  #
1572
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAliasRequest AWS API Documentation
2919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowCondition AWS API Documentation
1573
2920
  #
1574
- class DeleteAgentAliasRequest < Struct.new(
1575
- :agent_alias_id,
1576
- :agent_id)
2921
+ class FlowCondition < Struct.new(
2922
+ :expression,
2923
+ :name)
2924
+ SENSITIVE = [:expression]
2925
+ include Aws::Structure
2926
+ end
2927
+
2928
+ # The configuration of a connection between a condition node and another
2929
+ # node.
2930
+ #
2931
+ # @!attribute [rw] condition
2932
+ # The condition that triggers this connection. For more information
2933
+ # about how to write conditions, see the **Condition** node type in
2934
+ # the [Node types][1] topic in the Amazon Bedrock User Guide.
2935
+ #
2936
+ #
2937
+ #
2938
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/node-types.html
2939
+ # @return [String]
2940
+ #
2941
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowConditionalConnectionConfiguration AWS API Documentation
2942
+ #
2943
+ class FlowConditionalConnectionConfiguration < Struct.new(
2944
+ :condition)
1577
2945
  SENSITIVE = []
1578
2946
  include Aws::Structure
1579
2947
  end
1580
2948
 
1581
- # @!attribute [rw] agent_alias_id
1582
- # The unique identifier of the alias that was deleted.
2949
+ # Contains information about a connection between two nodes in the flow.
2950
+ #
2951
+ # @!attribute [rw] configuration
2952
+ # The configuration of the connection.
2953
+ # @return [Types::FlowConnectionConfiguration]
2954
+ #
2955
+ # @!attribute [rw] name
2956
+ # A name for the connection that you can reference.
1583
2957
  # @return [String]
1584
2958
  #
1585
- # @!attribute [rw] agent_alias_status
1586
- # The status of the alias.
2959
+ # @!attribute [rw] source
2960
+ # The node that the connection starts at.
1587
2961
  # @return [String]
1588
2962
  #
1589
- # @!attribute [rw] agent_id
1590
- # The unique identifier of the agent that the alias belongs to.
2963
+ # @!attribute [rw] target
2964
+ # The node that the connection ends at.
1591
2965
  # @return [String]
1592
2966
  #
1593
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentAliasResponse AWS API Documentation
2967
+ # @!attribute [rw] type
2968
+ # Whether the source node that the connection begins from is a
2969
+ # condition node (`Conditional`) or not (`Data`).
2970
+ # @return [String]
1594
2971
  #
1595
- class DeleteAgentAliasResponse < Struct.new(
1596
- :agent_alias_id,
1597
- :agent_alias_status,
1598
- :agent_id)
2972
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowConnection AWS API Documentation
2973
+ #
2974
+ class FlowConnection < Struct.new(
2975
+ :configuration,
2976
+ :name,
2977
+ :source,
2978
+ :target,
2979
+ :type)
1599
2980
  SENSITIVE = []
1600
2981
  include Aws::Structure
1601
2982
  end
1602
2983
 
1603
- # @!attribute [rw] agent_id
1604
- # The unique identifier of the agent to delete.
1605
- # @return [String]
2984
+ # The configuration of the connection.
1606
2985
  #
1607
- # @!attribute [rw] skip_resource_in_use_check
1608
- # By default, this value is `false` and deletion is stopped if the
1609
- # resource is in use. If you set it to `true`, the resource will be
1610
- # deleted even if the resource is in use.
1611
- # @return [Boolean]
2986
+ # @note FlowConnectionConfiguration is a union - when making an API calls you must set exactly one of the members.
1612
2987
  #
1613
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentRequest AWS API Documentation
2988
+ # @note FlowConnectionConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FlowConnectionConfiguration corresponding to the set member.
1614
2989
  #
1615
- class DeleteAgentRequest < Struct.new(
1616
- :agent_id,
1617
- :skip_resource_in_use_check)
2990
+ # @!attribute [rw] conditional
2991
+ # The configuration of a connection originating from a Condition node.
2992
+ # @return [Types::FlowConditionalConnectionConfiguration]
2993
+ #
2994
+ # @!attribute [rw] data
2995
+ # The configuration of a connection originating from a node that
2996
+ # isn't a Condition node.
2997
+ # @return [Types::FlowDataConnectionConfiguration]
2998
+ #
2999
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowConnectionConfiguration AWS API Documentation
3000
+ #
3001
+ class FlowConnectionConfiguration < Struct.new(
3002
+ :conditional,
3003
+ :data,
3004
+ :unknown)
1618
3005
  SENSITIVE = []
1619
3006
  include Aws::Structure
3007
+ include Aws::Structure::Union
3008
+
3009
+ class Conditional < FlowConnectionConfiguration; end
3010
+ class Data < FlowConnectionConfiguration; end
3011
+ class Unknown < FlowConnectionConfiguration; end
1620
3012
  end
1621
3013
 
1622
- # @!attribute [rw] agent_id
1623
- # The unique identifier of the agent that was deleted.
3014
+ # The configuration of a connection originating from a node that isn't
3015
+ # a Condition node.
3016
+ #
3017
+ # @!attribute [rw] source_output
3018
+ # The name of the output in the source node that the connection begins
3019
+ # from.
1624
3020
  # @return [String]
1625
3021
  #
1626
- # @!attribute [rw] agent_status
1627
- # The status of the agent.
3022
+ # @!attribute [rw] target_input
3023
+ # The name of the input in the target node that the connection ends
3024
+ # at.
1628
3025
  # @return [String]
1629
3026
  #
1630
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentResponse AWS API Documentation
3027
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowDataConnectionConfiguration AWS API Documentation
1631
3028
  #
1632
- class DeleteAgentResponse < Struct.new(
1633
- :agent_id,
1634
- :agent_status)
3029
+ class FlowDataConnectionConfiguration < Struct.new(
3030
+ :source_output,
3031
+ :target_input)
1635
3032
  SENSITIVE = []
1636
3033
  include Aws::Structure
1637
3034
  end
1638
3035
 
1639
- # @!attribute [rw] agent_id
1640
- # The unique identifier of the agent that the version belongs to.
1641
- # @return [String]
3036
+ # The definition of the nodes and connections between nodes in the flow.
1642
3037
  #
1643
- # @!attribute [rw] agent_version
1644
- # The version of the agent to delete.
1645
- # @return [String]
3038
+ # @!attribute [rw] connections
3039
+ # An array of connection definitions in the flow.
3040
+ # @return [Array<Types::FlowConnection>]
1646
3041
  #
1647
- # @!attribute [rw] skip_resource_in_use_check
1648
- # By default, this value is `false` and deletion is stopped if the
1649
- # resource is in use. If you set it to `true`, the resource will be
1650
- # deleted even if the resource is in use.
1651
- # @return [Boolean]
3042
+ # @!attribute [rw] nodes
3043
+ # An array of node definitions in the flow.
3044
+ # @return [Array<Types::FlowNode>]
1652
3045
  #
1653
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersionRequest AWS API Documentation
3046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowDefinition AWS API Documentation
1654
3047
  #
1655
- class DeleteAgentVersionRequest < Struct.new(
1656
- :agent_id,
1657
- :agent_version,
1658
- :skip_resource_in_use_check)
1659
- SENSITIVE = []
3048
+ class FlowDefinition < Struct.new(
3049
+ :connections,
3050
+ :nodes)
3051
+ SENSITIVE = [:nodes]
1660
3052
  include Aws::Structure
1661
3053
  end
1662
3054
 
1663
- # @!attribute [rw] agent_id
1664
- # The unique identifier of the agent that the version belongs to.
1665
- # @return [String]
3055
+ # Contains configurations about a node in the flow.
1666
3056
  #
1667
- # @!attribute [rw] agent_status
1668
- # The status of the agent version.
3057
+ # @!attribute [rw] configuration
3058
+ # Contains configurations for the node.
3059
+ # @return [Types::FlowNodeConfiguration]
3060
+ #
3061
+ # @!attribute [rw] inputs
3062
+ # An array of objects, each of which contains information about an
3063
+ # input into the node.
3064
+ # @return [Array<Types::FlowNodeInput>]
3065
+ #
3066
+ # @!attribute [rw] name
3067
+ # A name for the node.
1669
3068
  # @return [String]
1670
3069
  #
1671
- # @!attribute [rw] agent_version
1672
- # The version that was deleted.
3070
+ # @!attribute [rw] outputs
3071
+ # A list of objects, each of which contains information about an
3072
+ # output from the node.
3073
+ # @return [Array<Types::FlowNodeOutput>]
3074
+ #
3075
+ # @!attribute [rw] type
3076
+ # The type of node. This value must match the name of the key that you
3077
+ # provide in the configuration you provide in the
3078
+ # `FlowNodeConfiguration` field.
1673
3079
  # @return [String]
1674
3080
  #
1675
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteAgentVersionResponse AWS API Documentation
3081
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowNode AWS API Documentation
1676
3082
  #
1677
- class DeleteAgentVersionResponse < Struct.new(
1678
- :agent_id,
1679
- :agent_status,
1680
- :agent_version)
3083
+ class FlowNode < Struct.new(
3084
+ :configuration,
3085
+ :inputs,
3086
+ :name,
3087
+ :outputs,
3088
+ :type)
1681
3089
  SENSITIVE = []
1682
3090
  include Aws::Structure
1683
3091
  end
1684
3092
 
1685
- # @!attribute [rw] data_source_id
1686
- # The unique identifier of the data source to delete.
1687
- # @return [String]
3093
+ # Contains configurations for a node in your flow. For more information,
3094
+ # see [Node types in Amazon Bedrock works][1] in the Amazon Bedrock User
3095
+ # Guide.
1688
3096
  #
1689
- # @!attribute [rw] knowledge_base_id
1690
- # The unique identifier of the knowledge base from which to delete the
1691
- # data source.
1692
- # @return [String]
1693
3097
  #
1694
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSourceRequest AWS API Documentation
1695
3098
  #
1696
- class DeleteDataSourceRequest < Struct.new(
1697
- :data_source_id,
1698
- :knowledge_base_id)
3099
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html
3100
+ #
3101
+ # @note FlowNodeConfiguration is a union - when making an API calls you must set exactly one of the members.
3102
+ #
3103
+ # @note FlowNodeConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of FlowNodeConfiguration corresponding to the set member.
3104
+ #
3105
+ # @!attribute [rw] agent
3106
+ # Contains configurations for an agent node in your flow. Invokes an
3107
+ # alias of an agent and returns the response.
3108
+ # @return [Types::AgentFlowNodeConfiguration]
3109
+ #
3110
+ # @!attribute [rw] collector
3111
+ # Contains configurations for a collector node in your flow. Collects
3112
+ # an iteration of inputs and consolidates them into an array of
3113
+ # outputs.
3114
+ # @return [Types::CollectorFlowNodeConfiguration]
3115
+ #
3116
+ # @!attribute [rw] condition
3117
+ # Contains configurations for a Condition node in your flow. Defines
3118
+ # conditions that lead to different branches of the flow.
3119
+ # @return [Types::ConditionFlowNodeConfiguration]
3120
+ #
3121
+ # @!attribute [rw] input
3122
+ # Contains configurations for an input flow node in your flow. The
3123
+ # first node in the flow. `inputs` can't be specified for this node.
3124
+ # @return [Types::InputFlowNodeConfiguration]
3125
+ #
3126
+ # @!attribute [rw] iterator
3127
+ # Contains configurations for an iterator node in your flow. Takes an
3128
+ # input that is an array and iteratively sends each item of the array
3129
+ # as an output to the following node. The size of the array is also
3130
+ # returned in the output.
3131
+ #
3132
+ # The output flow node at the end of the flow iteration will return a
3133
+ # response for each member of the array. To return only one response,
3134
+ # you can include a collector node downstream from the iterator node.
3135
+ # @return [Types::IteratorFlowNodeConfiguration]
3136
+ #
3137
+ # @!attribute [rw] knowledge_base
3138
+ # Contains configurations for a knowledge base node in your flow.
3139
+ # Queries a knowledge base and returns the retrieved results or
3140
+ # generated response.
3141
+ # @return [Types::KnowledgeBaseFlowNodeConfiguration]
3142
+ #
3143
+ # @!attribute [rw] lambda_function
3144
+ # Contains configurations for a Lambda function node in your flow.
3145
+ # Invokes an Lambda function.
3146
+ # @return [Types::LambdaFunctionFlowNodeConfiguration]
3147
+ #
3148
+ # @!attribute [rw] lex
3149
+ # Contains configurations for a Lex node in your flow. Invokes an
3150
+ # Amazon Lex bot to identify the intent of the input and return the
3151
+ # intent as the output.
3152
+ # @return [Types::LexFlowNodeConfiguration]
3153
+ #
3154
+ # @!attribute [rw] output
3155
+ # Contains configurations for an output flow node in your flow. The
3156
+ # last node in the flow. `outputs` can't be specified for this node.
3157
+ # @return [Types::OutputFlowNodeConfiguration]
3158
+ #
3159
+ # @!attribute [rw] prompt
3160
+ # Contains configurations for a prompt node in your flow. Runs a
3161
+ # prompt and generates the model response as the output. You can use a
3162
+ # prompt from Prompt management or you can configure one in this node.
3163
+ # @return [Types::PromptFlowNodeConfiguration]
3164
+ #
3165
+ # @!attribute [rw] retrieval
3166
+ # Contains configurations for a Retrieval node in your flow. Retrieves
3167
+ # data from an Amazon S3 location and returns it as the output.
3168
+ # @return [Types::RetrievalFlowNodeConfiguration]
3169
+ #
3170
+ # @!attribute [rw] storage
3171
+ # Contains configurations for a Storage node in your flow. Stores an
3172
+ # input in an Amazon S3 location.
3173
+ # @return [Types::StorageFlowNodeConfiguration]
3174
+ #
3175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowNodeConfiguration AWS API Documentation
3176
+ #
3177
+ class FlowNodeConfiguration < Struct.new(
3178
+ :agent,
3179
+ :collector,
3180
+ :condition,
3181
+ :input,
3182
+ :iterator,
3183
+ :knowledge_base,
3184
+ :lambda_function,
3185
+ :lex,
3186
+ :output,
3187
+ :prompt,
3188
+ :retrieval,
3189
+ :storage,
3190
+ :unknown)
1699
3191
  SENSITIVE = []
1700
3192
  include Aws::Structure
3193
+ include Aws::Structure::Union
3194
+
3195
+ class Agent < FlowNodeConfiguration; end
3196
+ class Collector < FlowNodeConfiguration; end
3197
+ class Condition < FlowNodeConfiguration; end
3198
+ class Input < FlowNodeConfiguration; end
3199
+ class Iterator < FlowNodeConfiguration; end
3200
+ class KnowledgeBase < FlowNodeConfiguration; end
3201
+ class LambdaFunction < FlowNodeConfiguration; end
3202
+ class Lex < FlowNodeConfiguration; end
3203
+ class Output < FlowNodeConfiguration; end
3204
+ class Prompt < FlowNodeConfiguration; end
3205
+ class Retrieval < FlowNodeConfiguration; end
3206
+ class Storage < FlowNodeConfiguration; end
3207
+ class Unknown < FlowNodeConfiguration; end
1701
3208
  end
1702
3209
 
1703
- # @!attribute [rw] data_source_id
1704
- # The unique identifier of the data source that was deleted.
3210
+ # Contains configurations for an input to a node.
3211
+ #
3212
+ # @!attribute [rw] expression
3213
+ # An expression that formats the input for the node. For an
3214
+ # explanation of how to create expressions, see [Expressions in Prompt
3215
+ # flows in Amazon Bedrock][1].
3216
+ #
3217
+ #
3218
+ #
3219
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-expressions.html
1705
3220
  # @return [String]
1706
3221
  #
1707
- # @!attribute [rw] knowledge_base_id
1708
- # The unique identifier of the knowledge base to which the data source
1709
- # that was deleted belonged.
3222
+ # @!attribute [rw] name
3223
+ # A name for the input that you can reference.
1710
3224
  # @return [String]
1711
3225
  #
1712
- # @!attribute [rw] status
1713
- # The status of the data source.
3226
+ # @!attribute [rw] type
3227
+ # The data type of the input. If the input doesn't match this type at
3228
+ # runtime, a validation error will be thrown.
1714
3229
  # @return [String]
1715
3230
  #
1716
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteDataSourceResponse AWS API Documentation
3231
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowNodeInput AWS API Documentation
1717
3232
  #
1718
- class DeleteDataSourceResponse < Struct.new(
1719
- :data_source_id,
1720
- :knowledge_base_id,
1721
- :status)
1722
- SENSITIVE = []
3233
+ class FlowNodeInput < Struct.new(
3234
+ :expression,
3235
+ :name,
3236
+ :type)
3237
+ SENSITIVE = [:expression]
1723
3238
  include Aws::Structure
1724
3239
  end
1725
3240
 
1726
- # @!attribute [rw] knowledge_base_id
1727
- # The unique identifier of the knowledge base to delete.
3241
+ # Contains configurations for an output from a node.
3242
+ #
3243
+ # @!attribute [rw] name
3244
+ # A name for the output that you can reference.
1728
3245
  # @return [String]
1729
3246
  #
1730
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBaseRequest AWS API Documentation
3247
+ # @!attribute [rw] type
3248
+ # The data type of the output. If the output doesn't match this type
3249
+ # at runtime, a validation error will be thrown.
3250
+ # @return [String]
1731
3251
  #
1732
- class DeleteKnowledgeBaseRequest < Struct.new(
1733
- :knowledge_base_id)
3252
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowNodeOutput AWS API Documentation
3253
+ #
3254
+ class FlowNodeOutput < Struct.new(
3255
+ :name,
3256
+ :type)
1734
3257
  SENSITIVE = []
1735
3258
  include Aws::Structure
1736
3259
  end
1737
3260
 
1738
- # @!attribute [rw] knowledge_base_id
1739
- # The unique identifier of the knowledge base that was deleted.
3261
+ # Contains the definition of a flow.
3262
+ #
3263
+ # @!attribute [rw] arn
3264
+ # The Amazon Resource Name (ARN) of the flow.
1740
3265
  # @return [String]
1741
3266
  #
1742
- # @!attribute [rw] status
1743
- # The status of the knowledge base and whether it has been
1744
- # successfully deleted.
3267
+ # @!attribute [rw] created_at
3268
+ # The time at which the flow was created.
3269
+ # @return [Time]
3270
+ #
3271
+ # @!attribute [rw] description
3272
+ # A description of the flow.
1745
3273
  # @return [String]
1746
3274
  #
1747
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBaseResponse AWS API Documentation
3275
+ # @!attribute [rw] id
3276
+ # The unique identifier of the flow.
3277
+ # @return [String]
1748
3278
  #
1749
- class DeleteKnowledgeBaseResponse < Struct.new(
1750
- :knowledge_base_id,
1751
- :status)
1752
- SENSITIVE = []
1753
- include Aws::Structure
1754
- end
1755
-
1756
- # @!attribute [rw] agent_id
1757
- # The unique identifier of the agent from which to disassociate the
1758
- # knowledge base.
3279
+ # @!attribute [rw] name
3280
+ # The name of the flow.
1759
3281
  # @return [String]
1760
3282
  #
1761
- # @!attribute [rw] agent_version
1762
- # The version of the agent from which to disassociate the knowledge
1763
- # base.
3283
+ # @!attribute [rw] status
3284
+ # The status of the flow. The following statuses are possible:
3285
+ #
3286
+ # * NotPrepared – The flow has been created or updated, but hasn't
3287
+ # been prepared. If you just created the flow, you can't test it.
3288
+ # If you updated the flow, the `DRAFT` version won't contain the
3289
+ # latest changes for testing. Send a [PrepareFlow][1] request to
3290
+ # package the latest changes into the `DRAFT` version.
3291
+ #
3292
+ # * Preparing – The flow is being prepared so that the `DRAFT` version
3293
+ # contains the latest changes for testing.
3294
+ #
3295
+ # * Prepared – The flow is prepared and the `DRAFT` version contains
3296
+ # the latest changes for testing.
3297
+ #
3298
+ # * Failed – The last API operation that you invoked on the flow
3299
+ # failed. Send a [GetFlow][2] request and check the error message in
3300
+ # the `validations` field.
3301
+ #
3302
+ #
3303
+ #
3304
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html
3305
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html
1764
3306
  # @return [String]
1765
3307
  #
1766
- # @!attribute [rw] knowledge_base_id
1767
- # The unique identifier of the knowledge base to disassociate.
3308
+ # @!attribute [rw] updated_at
3309
+ # The time at which the flow was last updated.
3310
+ # @return [Time]
3311
+ #
3312
+ # @!attribute [rw] version
3313
+ # The latest version of the flow.
1768
3314
  # @return [String]
1769
3315
  #
1770
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBaseRequest AWS API Documentation
3316
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowSummary AWS API Documentation
1771
3317
  #
1772
- class DisassociateAgentKnowledgeBaseRequest < Struct.new(
1773
- :agent_id,
1774
- :agent_version,
1775
- :knowledge_base_id)
3318
+ class FlowSummary < Struct.new(
3319
+ :arn,
3320
+ :created_at,
3321
+ :description,
3322
+ :id,
3323
+ :name,
3324
+ :status,
3325
+ :updated_at,
3326
+ :version)
1776
3327
  SENSITIVE = []
1777
3328
  include Aws::Structure
1778
3329
  end
1779
3330
 
1780
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DisassociateAgentKnowledgeBaseResponse AWS API Documentation
3331
+ # Contains information about validation of the flow.
1781
3332
  #
1782
- class DisassociateAgentKnowledgeBaseResponse < Aws::EmptyStructure; end
1783
-
1784
- # The configuration details for the embeddings model.
3333
+ # This data type is used in the following API operations:
1785
3334
  #
1786
- # @!attribute [rw] bedrock_embedding_model_configuration
1787
- # The vector configuration details on the Bedrock embeddings model.
1788
- # @return [Types::BedrockEmbeddingModelConfiguration]
3335
+ # * [GetFlow response][1]
3336
+ #
3337
+ # * [GetFlowVersion response][2]
3338
+ #
3339
+ #
3340
+ #
3341
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html#API_agent_GetFlow_ResponseSyntax
3342
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlowVersion.html#API_agent_GetFlowVersion_ResponseSyntax
3343
+ #
3344
+ # @!attribute [rw] message
3345
+ # A message describing the validation error.
3346
+ # @return [String]
1789
3347
  #
1790
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/EmbeddingModelConfiguration AWS API Documentation
3348
+ # @!attribute [rw] severity
3349
+ # The severity of the issue described in the message.
3350
+ # @return [String]
1791
3351
  #
1792
- class EmbeddingModelConfiguration < Struct.new(
1793
- :bedrock_embedding_model_configuration)
3352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowValidation AWS API Documentation
3353
+ #
3354
+ class FlowValidation < Struct.new(
3355
+ :message,
3356
+ :severity)
1794
3357
  SENSITIVE = []
1795
3358
  include Aws::Structure
1796
3359
  end
1797
3360
 
1798
- # Configurations for when you choose fixed-size chunking. If you set the
1799
- # `chunkingStrategy` as `NONE`, exclude this field.
3361
+ # Contains information about the flow version.
1800
3362
  #
1801
- # @!attribute [rw] max_tokens
1802
- # The maximum number of tokens to include in a chunk.
1803
- # @return [Integer]
3363
+ # This data type is used in the following API operations:
1804
3364
  #
1805
- # @!attribute [rw] overlap_percentage
1806
- # The percentage of overlap between adjacent chunks of a data source.
1807
- # @return [Integer]
3365
+ # * [ListFlowVersions response][1]
1808
3366
  #
1809
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FixedSizeChunkingConfiguration AWS API Documentation
3367
+ # ^
1810
3368
  #
1811
- class FixedSizeChunkingConfiguration < Struct.new(
1812
- :max_tokens,
1813
- :overlap_percentage)
3369
+ #
3370
+ #
3371
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListFlowVersions.html#API_agent_ListFlowVersions_ResponseSyntax
3372
+ #
3373
+ # @!attribute [rw] arn
3374
+ # The Amazon Resource Name (ARN) of the flow that the version belongs
3375
+ # to.
3376
+ # @return [String]
3377
+ #
3378
+ # @!attribute [rw] created_at
3379
+ # The time at the flow version was created.
3380
+ # @return [Time]
3381
+ #
3382
+ # @!attribute [rw] id
3383
+ # The unique identifier of the flow.
3384
+ # @return [String]
3385
+ #
3386
+ # @!attribute [rw] status
3387
+ # The status of the flow.
3388
+ # @return [String]
3389
+ #
3390
+ # @!attribute [rw] version
3391
+ # The version of the flow.
3392
+ # @return [String]
3393
+ #
3394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/FlowVersionSummary AWS API Documentation
3395
+ #
3396
+ class FlowVersionSummary < Struct.new(
3397
+ :arn,
3398
+ :created_at,
3399
+ :id,
3400
+ :status,
3401
+ :version)
1814
3402
  SENSITIVE = []
1815
3403
  include Aws::Structure
1816
3404
  end
@@ -2091,6 +3679,262 @@ module Aws::BedrockAgent
2091
3679
  include Aws::Structure
2092
3680
  end
2093
3681
 
3682
+ # @!attribute [rw] alias_identifier
3683
+ # The unique identifier of the alias for which to retrieve
3684
+ # information.
3685
+ # @return [String]
3686
+ #
3687
+ # @!attribute [rw] flow_identifier
3688
+ # The unique identifier of the flow that the alias belongs to.
3689
+ # @return [String]
3690
+ #
3691
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetFlowAliasRequest AWS API Documentation
3692
+ #
3693
+ class GetFlowAliasRequest < Struct.new(
3694
+ :alias_identifier,
3695
+ :flow_identifier)
3696
+ SENSITIVE = []
3697
+ include Aws::Structure
3698
+ end
3699
+
3700
+ # @!attribute [rw] arn
3701
+ # The Amazon Resource Name (ARN) of the flow.
3702
+ # @return [String]
3703
+ #
3704
+ # @!attribute [rw] created_at
3705
+ # The time at which the flow was created.
3706
+ # @return [Time]
3707
+ #
3708
+ # @!attribute [rw] description
3709
+ # The description of the flow.
3710
+ # @return [String]
3711
+ #
3712
+ # @!attribute [rw] flow_id
3713
+ # The unique identifier of the flow that the alias belongs to.
3714
+ # @return [String]
3715
+ #
3716
+ # @!attribute [rw] id
3717
+ # The unique identifier of the alias of the flow.
3718
+ # @return [String]
3719
+ #
3720
+ # @!attribute [rw] name
3721
+ # The name of the flow alias.
3722
+ # @return [String]
3723
+ #
3724
+ # @!attribute [rw] routing_configuration
3725
+ # Contains information about the version that the alias is mapped to.
3726
+ # @return [Array<Types::FlowAliasRoutingConfigurationListItem>]
3727
+ #
3728
+ # @!attribute [rw] updated_at
3729
+ # The time at which the flow alias was last updated.
3730
+ # @return [Time]
3731
+ #
3732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetFlowAliasResponse AWS API Documentation
3733
+ #
3734
+ class GetFlowAliasResponse < Struct.new(
3735
+ :arn,
3736
+ :created_at,
3737
+ :description,
3738
+ :flow_id,
3739
+ :id,
3740
+ :name,
3741
+ :routing_configuration,
3742
+ :updated_at)
3743
+ SENSITIVE = []
3744
+ include Aws::Structure
3745
+ end
3746
+
3747
+ # @!attribute [rw] flow_identifier
3748
+ # The unique identifier of the flow.
3749
+ # @return [String]
3750
+ #
3751
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetFlowRequest AWS API Documentation
3752
+ #
3753
+ class GetFlowRequest < Struct.new(
3754
+ :flow_identifier)
3755
+ SENSITIVE = []
3756
+ include Aws::Structure
3757
+ end
3758
+
3759
+ # @!attribute [rw] arn
3760
+ # The Amazon Resource Name (ARN) of the flow.
3761
+ # @return [String]
3762
+ #
3763
+ # @!attribute [rw] created_at
3764
+ # The time at which the flow was created.
3765
+ # @return [Time]
3766
+ #
3767
+ # @!attribute [rw] customer_encryption_key_arn
3768
+ # The Amazon Resource Name (ARN) of the KMS key that the flow is
3769
+ # encrypted with.
3770
+ # @return [String]
3771
+ #
3772
+ # @!attribute [rw] definition
3773
+ # The definition of the nodes and connections between the nodes in the
3774
+ # flow.
3775
+ # @return [Types::FlowDefinition]
3776
+ #
3777
+ # @!attribute [rw] description
3778
+ # The description of the flow.
3779
+ # @return [String]
3780
+ #
3781
+ # @!attribute [rw] execution_role_arn
3782
+ # The Amazon Resource Name (ARN) of the service role with permissions
3783
+ # to create a flow. For more information, see [Create a service row
3784
+ # for flows][1] in the Amazon Bedrock User Guide.
3785
+ #
3786
+ #
3787
+ #
3788
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html
3789
+ # @return [String]
3790
+ #
3791
+ # @!attribute [rw] id
3792
+ # The unique identifier of the flow.
3793
+ # @return [String]
3794
+ #
3795
+ # @!attribute [rw] name
3796
+ # The name of the flow.
3797
+ # @return [String]
3798
+ #
3799
+ # @!attribute [rw] status
3800
+ # The status of the flow. The following statuses are possible:
3801
+ #
3802
+ # * NotPrepared – The flow has been created or updated, but hasn't
3803
+ # been prepared. If you just created the flow, you can't test it.
3804
+ # If you updated the flow, the `DRAFT` version won't contain the
3805
+ # latest changes for testing. Send a [PrepareFlow][1] request to
3806
+ # package the latest changes into the `DRAFT` version.
3807
+ #
3808
+ # * Preparing – The flow is being prepared so that the `DRAFT` version
3809
+ # contains the latest changes for testing.
3810
+ #
3811
+ # * Prepared – The flow is prepared and the `DRAFT` version contains
3812
+ # the latest changes for testing.
3813
+ #
3814
+ # * Failed – The last API operation that you invoked on the flow
3815
+ # failed. Send a [GetFlow][2] request and check the error message in
3816
+ # the `validations` field.
3817
+ #
3818
+ #
3819
+ #
3820
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PrepareFlow.html
3821
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_GetFlow.html
3822
+ # @return [String]
3823
+ #
3824
+ # @!attribute [rw] updated_at
3825
+ # The time at which the flow was last updated.
3826
+ # @return [Time]
3827
+ #
3828
+ # @!attribute [rw] validations
3829
+ # A list of validation error messages related to the last failed
3830
+ # operation on the flow.
3831
+ # @return [Array<Types::FlowValidation>]
3832
+ #
3833
+ # @!attribute [rw] version
3834
+ # The version of the flow for which information was retrieved.
3835
+ # @return [String]
3836
+ #
3837
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetFlowResponse AWS API Documentation
3838
+ #
3839
+ class GetFlowResponse < Struct.new(
3840
+ :arn,
3841
+ :created_at,
3842
+ :customer_encryption_key_arn,
3843
+ :definition,
3844
+ :description,
3845
+ :execution_role_arn,
3846
+ :id,
3847
+ :name,
3848
+ :status,
3849
+ :updated_at,
3850
+ :validations,
3851
+ :version)
3852
+ SENSITIVE = []
3853
+ include Aws::Structure
3854
+ end
3855
+
3856
+ # @!attribute [rw] flow_identifier
3857
+ # The unique identifier of the flow for which to get information.
3858
+ # @return [String]
3859
+ #
3860
+ # @!attribute [rw] flow_version
3861
+ # The version of the flow for which to get information.
3862
+ # @return [String]
3863
+ #
3864
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetFlowVersionRequest AWS API Documentation
3865
+ #
3866
+ class GetFlowVersionRequest < Struct.new(
3867
+ :flow_identifier,
3868
+ :flow_version)
3869
+ SENSITIVE = []
3870
+ include Aws::Structure
3871
+ end
3872
+
3873
+ # @!attribute [rw] arn
3874
+ # The Amazon Resource Name (ARN) of the flow.
3875
+ # @return [String]
3876
+ #
3877
+ # @!attribute [rw] created_at
3878
+ # The time at which the flow was created.
3879
+ # @return [Time]
3880
+ #
3881
+ # @!attribute [rw] customer_encryption_key_arn
3882
+ # The Amazon Resource Name (ARN) of the KMS key that the version of
3883
+ # the flow is encrypted with.
3884
+ # @return [String]
3885
+ #
3886
+ # @!attribute [rw] definition
3887
+ # The definition of the nodes and connections between nodes in the
3888
+ # flow.
3889
+ # @return [Types::FlowDefinition]
3890
+ #
3891
+ # @!attribute [rw] description
3892
+ # The description of the flow.
3893
+ # @return [String]
3894
+ #
3895
+ # @!attribute [rw] execution_role_arn
3896
+ # The Amazon Resource Name (ARN) of the service role with permissions
3897
+ # to create a flow. For more information, see [Create a service role
3898
+ # for flows in Amazon Bedrock][1] in the Amazon Bedrock User Guide.
3899
+ #
3900
+ #
3901
+ #
3902
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html
3903
+ # @return [String]
3904
+ #
3905
+ # @!attribute [rw] id
3906
+ # The unique identifier of the flow.
3907
+ # @return [String]
3908
+ #
3909
+ # @!attribute [rw] name
3910
+ # The name of the flow version.
3911
+ # @return [String]
3912
+ #
3913
+ # @!attribute [rw] status
3914
+ # The status of the flow.
3915
+ # @return [String]
3916
+ #
3917
+ # @!attribute [rw] version
3918
+ # The version of the flow for which information was retrieved.
3919
+ # @return [String]
3920
+ #
3921
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetFlowVersionResponse AWS API Documentation
3922
+ #
3923
+ class GetFlowVersionResponse < Struct.new(
3924
+ :arn,
3925
+ :created_at,
3926
+ :customer_encryption_key_arn,
3927
+ :definition,
3928
+ :description,
3929
+ :execution_role_arn,
3930
+ :id,
3931
+ :name,
3932
+ :status,
3933
+ :version)
3934
+ SENSITIVE = []
3935
+ include Aws::Structure
3936
+ end
3937
+
2094
3938
  # @!attribute [rw] data_source_id
2095
3939
  # The unique identifier of the data source in the ingestion job.
2096
3940
  # @return [String]
@@ -2118,54 +3962,178 @@ module Aws::BedrockAgent
2118
3962
  # Contains details about the ingestion job.
2119
3963
  # @return [Types::IngestionJob]
2120
3964
  #
2121
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJobResponse AWS API Documentation
3965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetIngestionJobResponse AWS API Documentation
3966
+ #
3967
+ class GetIngestionJobResponse < Struct.new(
3968
+ :ingestion_job)
3969
+ SENSITIVE = []
3970
+ include Aws::Structure
3971
+ end
3972
+
3973
+ # @!attribute [rw] knowledge_base_id
3974
+ # The unique identifier of the knowledge base for which to get
3975
+ # information.
3976
+ # @return [String]
3977
+ #
3978
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseRequest AWS API Documentation
3979
+ #
3980
+ class GetKnowledgeBaseRequest < Struct.new(
3981
+ :knowledge_base_id)
3982
+ SENSITIVE = []
3983
+ include Aws::Structure
3984
+ end
3985
+
3986
+ # @!attribute [rw] knowledge_base
3987
+ # Contains details about the knowledge base.
3988
+ # @return [Types::KnowledgeBase]
3989
+ #
3990
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseResponse AWS API Documentation
3991
+ #
3992
+ class GetKnowledgeBaseResponse < Struct.new(
3993
+ :knowledge_base)
3994
+ SENSITIVE = []
3995
+ include Aws::Structure
3996
+ end
3997
+
3998
+ # @!attribute [rw] prompt_identifier
3999
+ # The unique identifier of the prompt.
4000
+ # @return [String]
4001
+ #
4002
+ # @!attribute [rw] prompt_version
4003
+ # The version of the prompt about which you want to retrieve
4004
+ # information.
4005
+ # @return [String]
4006
+ #
4007
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetPromptRequest AWS API Documentation
4008
+ #
4009
+ class GetPromptRequest < Struct.new(
4010
+ :prompt_identifier,
4011
+ :prompt_version)
4012
+ SENSITIVE = []
4013
+ include Aws::Structure
4014
+ end
4015
+
4016
+ # @!attribute [rw] arn
4017
+ # The Amazon Resource Name (ARN) of the prompt.
4018
+ # @return [String]
4019
+ #
4020
+ # @!attribute [rw] created_at
4021
+ # The time at which the prompt was created.
4022
+ # @return [Time]
4023
+ #
4024
+ # @!attribute [rw] customer_encryption_key_arn
4025
+ # The Amazon Resource Name (ARN) of the KMS key that the prompt is
4026
+ # encrypted with.
4027
+ # @return [String]
4028
+ #
4029
+ # @!attribute [rw] default_variant
4030
+ # The name of the default variant for the prompt. This value must
4031
+ # match the `name` field in the relevant [PromptVariant][1] object.
4032
+ #
4033
+ #
4034
+ #
4035
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html
4036
+ # @return [String]
4037
+ #
4038
+ # @!attribute [rw] description
4039
+ # The descriptino of the prompt.
4040
+ # @return [String]
4041
+ #
4042
+ # @!attribute [rw] id
4043
+ # The unique identifier of the prompt.
4044
+ # @return [String]
4045
+ #
4046
+ # @!attribute [rw] name
4047
+ # The name of the prompt.
4048
+ # @return [String]
4049
+ #
4050
+ # @!attribute [rw] updated_at
4051
+ # The time at which the prompt was last updated.
4052
+ # @return [Time]
4053
+ #
4054
+ # @!attribute [rw] variants
4055
+ # A list of objects, each containing details about a variant of the
4056
+ # prompt.
4057
+ # @return [Array<Types::PromptVariant>]
4058
+ #
4059
+ # @!attribute [rw] version
4060
+ # The version of the prompt.
4061
+ # @return [String]
4062
+ #
4063
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetPromptResponse AWS API Documentation
2122
4064
  #
2123
- class GetIngestionJobResponse < Struct.new(
2124
- :ingestion_job)
2125
- SENSITIVE = []
4065
+ class GetPromptResponse < Struct.new(
4066
+ :arn,
4067
+ :created_at,
4068
+ :customer_encryption_key_arn,
4069
+ :default_variant,
4070
+ :description,
4071
+ :id,
4072
+ :name,
4073
+ :updated_at,
4074
+ :variants,
4075
+ :version)
4076
+ SENSITIVE = [:variants]
2126
4077
  include Aws::Structure
2127
4078
  end
2128
4079
 
2129
- # @!attribute [rw] knowledge_base_id
2130
- # The unique identifier of the knowledge base for which to get
2131
- # information.
4080
+ # Details about the guardrail associated with an agent.
4081
+ #
4082
+ # @!attribute [rw] guardrail_identifier
4083
+ # The unique identifier of the guardrail.
2132
4084
  # @return [String]
2133
4085
  #
2134
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseRequest AWS API Documentation
4086
+ # @!attribute [rw] guardrail_version
4087
+ # The version of the guardrail.
4088
+ # @return [String]
2135
4089
  #
2136
- class GetKnowledgeBaseRequest < Struct.new(
2137
- :knowledge_base_id)
4090
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GuardrailConfiguration AWS API Documentation
4091
+ #
4092
+ class GuardrailConfiguration < Struct.new(
4093
+ :guardrail_identifier,
4094
+ :guardrail_version)
2138
4095
  SENSITIVE = []
2139
4096
  include Aws::Structure
2140
4097
  end
2141
4098
 
2142
- # @!attribute [rw] knowledge_base
2143
- # Contains details about the knowledge base.
2144
- # @return [Types::KnowledgeBase]
4099
+ # Settings for hierarchical document chunking for a data source.
4100
+ # Hierarchical chunking splits documents into layers of chunks where the
4101
+ # first layer contains large chunks, and the second layer contains
4102
+ # smaller chunks derived from the first layer.
2145
4103
  #
2146
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseResponse AWS API Documentation
4104
+ # You configure the number of tokens to overlap, or repeat across
4105
+ # adjacent chunks. For example, if you set overlap tokens to 60, the
4106
+ # last 60 tokens in the first chunk are also included at the beginning
4107
+ # of the second chunk. For each layer, you must also configure the
4108
+ # maximum number of tokens in a chunk.
2147
4109
  #
2148
- class GetKnowledgeBaseResponse < Struct.new(
2149
- :knowledge_base)
4110
+ # @!attribute [rw] level_configurations
4111
+ # Token settings for each layer.
4112
+ # @return [Array<Types::HierarchicalChunkingLevelConfiguration>]
4113
+ #
4114
+ # @!attribute [rw] overlap_tokens
4115
+ # The number of tokens to repeat across chunks in the same layer.
4116
+ # @return [Integer]
4117
+ #
4118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/HierarchicalChunkingConfiguration AWS API Documentation
4119
+ #
4120
+ class HierarchicalChunkingConfiguration < Struct.new(
4121
+ :level_configurations,
4122
+ :overlap_tokens)
2150
4123
  SENSITIVE = []
2151
4124
  include Aws::Structure
2152
4125
  end
2153
4126
 
2154
- # The details of the guardrails configuration.
2155
- #
2156
- # @!attribute [rw] guardrail_identifier
2157
- # The guardrails identifier assigned to the guardrails configuration.
2158
- # @return [String]
4127
+ # Token settings for a layer in a hierarchical chunking configuration.
2159
4128
  #
2160
- # @!attribute [rw] guardrail_version
2161
- # The guardrails version assigned to the guardrails configuration.
2162
- # @return [String]
4129
+ # @!attribute [rw] max_tokens
4130
+ # The maximum number of tokens that a chunk can contain in this layer.
4131
+ # @return [Integer]
2163
4132
  #
2164
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GuardrailConfiguration AWS API Documentation
4133
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/HierarchicalChunkingLevelConfiguration AWS API Documentation
2165
4134
  #
2166
- class GuardrailConfiguration < Struct.new(
2167
- :guardrail_identifier,
2168
- :guardrail_version)
4135
+ class HierarchicalChunkingLevelConfiguration < Struct.new(
4136
+ :max_tokens)
2169
4137
  SENSITIVE = []
2170
4138
  include Aws::Structure
2171
4139
  end
@@ -2436,6 +4404,31 @@ module Aws::BedrockAgent
2436
4404
  include Aws::Structure
2437
4405
  end
2438
4406
 
4407
+ # Contains configurations for the input flow node for a flow. This node
4408
+ # takes the input from flow invocation and passes it to the next node in
4409
+ # the data type that you specify.
4410
+ #
4411
+ # @api private
4412
+ #
4413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/InputFlowNodeConfiguration AWS API Documentation
4414
+ #
4415
+ class InputFlowNodeConfiguration < Aws::EmptyStructure; end
4416
+
4417
+ # A location for storing content from data sources temporarily as it is
4418
+ # processed by custom components in the ingestion pipeline.
4419
+ #
4420
+ # @!attribute [rw] s3_location
4421
+ # An S3 bucket path.
4422
+ # @return [Types::S3Location]
4423
+ #
4424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IntermediateStorage AWS API Documentation
4425
+ #
4426
+ class IntermediateStorage < Struct.new(
4427
+ :s3_location)
4428
+ SENSITIVE = []
4429
+ include Aws::Structure
4430
+ end
4431
+
2439
4432
  # An internal server error occurred. Retry your request.
2440
4433
  #
2441
4434
  # @!attribute [rw] message
@@ -2449,6 +4442,21 @@ module Aws::BedrockAgent
2449
4442
  include Aws::Structure
2450
4443
  end
2451
4444
 
4445
+ # Contains configurations for an iterator node in a flow. Takes an input
4446
+ # that is an array and iteratively sends each item of the array as an
4447
+ # output to the following node. The size of the array is also returned
4448
+ # in the output.
4449
+ #
4450
+ # The output flow node at the end of the flow iteration will return a
4451
+ # response for each member of the array. To return only one response,
4452
+ # you can include a collector node downstream from the iterator node.
4453
+ #
4454
+ # @api private
4455
+ #
4456
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IteratorFlowNodeConfiguration AWS API Documentation
4457
+ #
4458
+ class IteratorFlowNodeConfiguration < Aws::EmptyStructure; end
4459
+
2452
4460
  # Contains information about a knowledge base.
2453
4461
  #
2454
4462
  # @!attribute [rw] created_at
@@ -2550,6 +4558,35 @@ module Aws::BedrockAgent
2550
4558
  include Aws::Structure
2551
4559
  end
2552
4560
 
4561
+ # Contains configurations for a knowledge base node in a flow. This node
4562
+ # takes a query as the input and returns, as the output, the retrieved
4563
+ # responses directly (as an array) or a response generated based on the
4564
+ # retrieved responses. For more information, see [Node types in Amazon
4565
+ # Bedrock works][1] in the Amazon Bedrock User Guide.
4566
+ #
4567
+ #
4568
+ #
4569
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html
4570
+ #
4571
+ # @!attribute [rw] knowledge_base_id
4572
+ # The unique identifier of the knowledge base to query.
4573
+ # @return [String]
4574
+ #
4575
+ # @!attribute [rw] model_id
4576
+ # The unique identifier of the model to use to generate a response
4577
+ # from the query results. Omit this field if you want to return the
4578
+ # retrieved results as an array.
4579
+ # @return [String]
4580
+ #
4581
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseFlowNodeConfiguration AWS API Documentation
4582
+ #
4583
+ class KnowledgeBaseFlowNodeConfiguration < Struct.new(
4584
+ :knowledge_base_id,
4585
+ :model_id)
4586
+ SENSITIVE = []
4587
+ include Aws::Structure
4588
+ end
4589
+
2553
4590
  # Contains details about a knowledge base.
2554
4591
  #
2555
4592
  # @!attribute [rw] description
@@ -2584,6 +4621,56 @@ module Aws::BedrockAgent
2584
4621
  include Aws::Structure
2585
4622
  end
2586
4623
 
4624
+ # Contains configurations for a Lambda function node in the flow. You
4625
+ # specify the Lambda function to invoke and the inputs into the
4626
+ # function. The output is the response that is defined in the Lambda
4627
+ # function. For more information, see [Node types in Amazon Bedrock
4628
+ # works][1] in the Amazon Bedrock User Guide.
4629
+ #
4630
+ #
4631
+ #
4632
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html
4633
+ #
4634
+ # @!attribute [rw] lambda_arn
4635
+ # The Amazon Resource Name (ARN) of the Lambda function to invoke.
4636
+ # @return [String]
4637
+ #
4638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/LambdaFunctionFlowNodeConfiguration AWS API Documentation
4639
+ #
4640
+ class LambdaFunctionFlowNodeConfiguration < Struct.new(
4641
+ :lambda_arn)
4642
+ SENSITIVE = []
4643
+ include Aws::Structure
4644
+ end
4645
+
4646
+ # Contains configurations for a Lex node in the flow. You specify a
4647
+ # Amazon Lex bot to invoke. This node takes an utterance as the input
4648
+ # and returns as the output the intent identified by the Amazon Lex bot.
4649
+ # For more information, see [Node types in Amazon Bedrock works][1] in
4650
+ # the Amazon Bedrock User Guide.
4651
+ #
4652
+ #
4653
+ #
4654
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html
4655
+ #
4656
+ # @!attribute [rw] bot_alias_arn
4657
+ # The Amazon Resource Name (ARN) of the Amazon Lex bot alias to
4658
+ # invoke.
4659
+ # @return [String]
4660
+ #
4661
+ # @!attribute [rw] locale_id
4662
+ # The Region to invoke the Amazon Lex bot in.
4663
+ # @return [String]
4664
+ #
4665
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/LexFlowNodeConfiguration AWS API Documentation
4666
+ #
4667
+ class LexFlowNodeConfiguration < Struct.new(
4668
+ :bot_alias_arn,
4669
+ :locale_id)
4670
+ SENSITIVE = []
4671
+ include Aws::Structure
4672
+ end
4673
+
2587
4674
  # @!attribute [rw] agent_id
2588
4675
  # The unique identifier of the agent.
2589
4676
  # @return [String]
@@ -2886,6 +4973,147 @@ module Aws::BedrockAgent
2886
4973
  include Aws::Structure
2887
4974
  end
2888
4975
 
4976
+ # @!attribute [rw] flow_identifier
4977
+ # The unique identifier of the flow for which aliases are being
4978
+ # returned.
4979
+ # @return [String]
4980
+ #
4981
+ # @!attribute [rw] max_results
4982
+ # The maximum number of results to return in the response. If the
4983
+ # total number of results is greater than this value, use the token
4984
+ # returned in the response in the `nextToken` field when making
4985
+ # another request to return the next batch of results.
4986
+ # @return [Integer]
4987
+ #
4988
+ # @!attribute [rw] next_token
4989
+ # If the total number of results is greater than the `maxResults`
4990
+ # value provided in the request, enter the token returned in the
4991
+ # `nextToken` field in the response in this field to return the next
4992
+ # batch of results.
4993
+ # @return [String]
4994
+ #
4995
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListFlowAliasesRequest AWS API Documentation
4996
+ #
4997
+ class ListFlowAliasesRequest < Struct.new(
4998
+ :flow_identifier,
4999
+ :max_results,
5000
+ :next_token)
5001
+ SENSITIVE = []
5002
+ include Aws::Structure
5003
+ end
5004
+
5005
+ # @!attribute [rw] flow_alias_summaries
5006
+ # A list, each member of which contains information about a flow
5007
+ # alias.
5008
+ # @return [Array<Types::FlowAliasSummary>]
5009
+ #
5010
+ # @!attribute [rw] next_token
5011
+ # If the total number of results is greater than the `maxResults`
5012
+ # value provided in the request, use this token when making another
5013
+ # request in the `nextToken` field to return the next batch of
5014
+ # results.
5015
+ # @return [String]
5016
+ #
5017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListFlowAliasesResponse AWS API Documentation
5018
+ #
5019
+ class ListFlowAliasesResponse < Struct.new(
5020
+ :flow_alias_summaries,
5021
+ :next_token)
5022
+ SENSITIVE = []
5023
+ include Aws::Structure
5024
+ end
5025
+
5026
+ # @!attribute [rw] flow_identifier
5027
+ # The unique identifier of the flow.
5028
+ # @return [String]
5029
+ #
5030
+ # @!attribute [rw] max_results
5031
+ # The maximum number of results to return in the response. If the
5032
+ # total number of results is greater than this value, use the token
5033
+ # returned in the response in the `nextToken` field when making
5034
+ # another request to return the next batch of results.
5035
+ # @return [Integer]
5036
+ #
5037
+ # @!attribute [rw] next_token
5038
+ # If the total number of results is greater than the `maxResults`
5039
+ # value provided in the request, enter the token returned in the
5040
+ # `nextToken` field in the response in this field to return the next
5041
+ # batch of results.
5042
+ # @return [String]
5043
+ #
5044
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListFlowVersionsRequest AWS API Documentation
5045
+ #
5046
+ class ListFlowVersionsRequest < Struct.new(
5047
+ :flow_identifier,
5048
+ :max_results,
5049
+ :next_token)
5050
+ SENSITIVE = []
5051
+ include Aws::Structure
5052
+ end
5053
+
5054
+ # @!attribute [rw] flow_version_summaries
5055
+ # A list, each member of which contains information about a flow.
5056
+ # @return [Array<Types::FlowVersionSummary>]
5057
+ #
5058
+ # @!attribute [rw] next_token
5059
+ # If the total number of results is greater than the `maxResults`
5060
+ # value provided in the request, use this token when making another
5061
+ # request in the `nextToken` field to return the next batch of
5062
+ # results.
5063
+ # @return [String]
5064
+ #
5065
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListFlowVersionsResponse AWS API Documentation
5066
+ #
5067
+ class ListFlowVersionsResponse < Struct.new(
5068
+ :flow_version_summaries,
5069
+ :next_token)
5070
+ SENSITIVE = []
5071
+ include Aws::Structure
5072
+ end
5073
+
5074
+ # @!attribute [rw] max_results
5075
+ # The maximum number of results to return in the response. If the
5076
+ # total number of results is greater than this value, use the token
5077
+ # returned in the response in the `nextToken` field when making
5078
+ # another request to return the next batch of results.
5079
+ # @return [Integer]
5080
+ #
5081
+ # @!attribute [rw] next_token
5082
+ # If the total number of results is greater than the `maxResults`
5083
+ # value provided in the request, enter the token returned in the
5084
+ # `nextToken` field in the response in this field to return the next
5085
+ # batch of results.
5086
+ # @return [String]
5087
+ #
5088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListFlowsRequest AWS API Documentation
5089
+ #
5090
+ class ListFlowsRequest < Struct.new(
5091
+ :max_results,
5092
+ :next_token)
5093
+ SENSITIVE = []
5094
+ include Aws::Structure
5095
+ end
5096
+
5097
+ # @!attribute [rw] flow_summaries
5098
+ # A list, each member of which contains information about a flow.
5099
+ # @return [Array<Types::FlowSummary>]
5100
+ #
5101
+ # @!attribute [rw] next_token
5102
+ # If the total number of results is greater than the `maxResults`
5103
+ # value provided in the request, use this token when making another
5104
+ # request in the `nextToken` field to return the next batch of
5105
+ # results.
5106
+ # @return [String]
5107
+ #
5108
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListFlowsResponse AWS API Documentation
5109
+ #
5110
+ class ListFlowsResponse < Struct.new(
5111
+ :flow_summaries,
5112
+ :next_token)
5113
+ SENSITIVE = []
5114
+ include Aws::Structure
5115
+ end
5116
+
2889
5117
  # @!attribute [rw] data_source_id
2890
5118
  # The unique identifier of the data source for which to return
2891
5119
  # ingestion jobs.
@@ -2975,11 +5203,55 @@ module Aws::BedrockAgent
2975
5203
  include Aws::Structure
2976
5204
  end
2977
5205
 
2978
- # @!attribute [rw] knowledge_base_summaries
2979
- # A list of objects, each of which contains information about a
2980
- # knowledge base.
2981
- # @return [Array<Types::KnowledgeBaseSummary>]
2982
- #
5206
+ # @!attribute [rw] knowledge_base_summaries
5207
+ # A list of objects, each of which contains information about a
5208
+ # knowledge base.
5209
+ # @return [Array<Types::KnowledgeBaseSummary>]
5210
+ #
5211
+ # @!attribute [rw] next_token
5212
+ # If the total number of results is greater than the `maxResults`
5213
+ # value provided in the request, use this token when making another
5214
+ # request in the `nextToken` field to return the next batch of
5215
+ # results.
5216
+ # @return [String]
5217
+ #
5218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBasesResponse AWS API Documentation
5219
+ #
5220
+ class ListKnowledgeBasesResponse < Struct.new(
5221
+ :knowledge_base_summaries,
5222
+ :next_token)
5223
+ SENSITIVE = []
5224
+ include Aws::Structure
5225
+ end
5226
+
5227
+ # @!attribute [rw] max_results
5228
+ # The maximum number of results to return in the response. If the
5229
+ # total number of results is greater than this value, use the token
5230
+ # returned in the response in the `nextToken` field when making
5231
+ # another request to return the next batch of results.
5232
+ # @return [Integer]
5233
+ #
5234
+ # @!attribute [rw] next_token
5235
+ # If the total number of results is greater than the `maxResults`
5236
+ # value provided in the request, enter the token returned in the
5237
+ # `nextToken` field in the response in this field to return the next
5238
+ # batch of results.
5239
+ # @return [String]
5240
+ #
5241
+ # @!attribute [rw] prompt_identifier
5242
+ # The unique identifier of the prompt.
5243
+ # @return [String]
5244
+ #
5245
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListPromptsRequest AWS API Documentation
5246
+ #
5247
+ class ListPromptsRequest < Struct.new(
5248
+ :max_results,
5249
+ :next_token,
5250
+ :prompt_identifier)
5251
+ SENSITIVE = []
5252
+ include Aws::Structure
5253
+ end
5254
+
2983
5255
  # @!attribute [rw] next_token
2984
5256
  # If the total number of results is greater than the `maxResults`
2985
5257
  # value provided in the request, use this token when making another
@@ -2987,11 +5259,16 @@ module Aws::BedrockAgent
2987
5259
  # results.
2988
5260
  # @return [String]
2989
5261
  #
2990
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBasesResponse AWS API Documentation
5262
+ # @!attribute [rw] prompt_summaries
5263
+ # A list, each member of which contains information about a prompt
5264
+ # using Prompt management.
5265
+ # @return [Array<Types::PromptSummary>]
2991
5266
  #
2992
- class ListKnowledgeBasesResponse < Struct.new(
2993
- :knowledge_base_summaries,
2994
- :next_token)
5267
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListPromptsResponse AWS API Documentation
5268
+ #
5269
+ class ListPromptsResponse < Struct.new(
5270
+ :next_token,
5271
+ :prompt_summaries)
2995
5272
  SENSITIVE = []
2996
5273
  include Aws::Structure
2997
5274
  end
@@ -3021,6 +5298,26 @@ module Aws::BedrockAgent
3021
5298
  include Aws::Structure
3022
5299
  end
3023
5300
 
5301
+ # Details of the memory configuration.
5302
+ #
5303
+ # @!attribute [rw] enabled_memory_types
5304
+ # The type of memory that is stored.
5305
+ # @return [Array<String>]
5306
+ #
5307
+ # @!attribute [rw] storage_days
5308
+ # The number of days the agent is configured to retain the
5309
+ # conversational context.
5310
+ # @return [Integer]
5311
+ #
5312
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MemoryConfiguration AWS API Documentation
5313
+ #
5314
+ class MemoryConfiguration < Struct.new(
5315
+ :enabled_memory_types,
5316
+ :storage_days)
5317
+ SENSITIVE = []
5318
+ include Aws::Structure
5319
+ end
5320
+
3024
5321
  # Contains details about the storage configuration of the knowledge base
3025
5322
  # in MongoDB Atlas.
3026
5323
  #
@@ -3162,6 +5459,17 @@ module Aws::BedrockAgent
3162
5459
  include Aws::Structure
3163
5460
  end
3164
5461
 
5462
+ # Contains configurations for an output flow node in the flow. You
5463
+ # specify the data type expected for the input into the node in the
5464
+ # `type` field and how to return the final output in the `expression`
5465
+ # field.
5466
+ #
5467
+ # @api private
5468
+ #
5469
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/OutputFlowNodeConfiguration AWS API Documentation
5470
+ #
5471
+ class OutputFlowNodeConfiguration < Aws::EmptyStructure; end
5472
+
3165
5473
  # Contains details about a parameter in a function for an action group.
3166
5474
  #
3167
5475
  # This data type is used in the following API operations:
@@ -3208,6 +5516,107 @@ module Aws::BedrockAgent
3208
5516
  include Aws::Structure
3209
5517
  end
3210
5518
 
5519
+ # Settings for parsing document contents. By default, the service
5520
+ # converts the contents of each document into text before splitting it
5521
+ # into chunks. To improve processing of PDF files with tables and
5522
+ # images, you can configure the data source to convert the pages of text
5523
+ # into images and use a model to describe the contents of each page.
5524
+ #
5525
+ # To use a model to parse PDF documents, set the parsing strategy to
5526
+ # `BEDROCK_FOUNDATION_MODEL` and specify the model to use by ARN. You
5527
+ # can also override the default parsing prompt with instructions for how
5528
+ # to interpret images and tables in your documents. The following models
5529
+ # are supported.
5530
+ #
5531
+ # * Anthropic Claude 3 Sonnet -
5532
+ # `anthropic.claude-3-sonnet-20240229-v1:0`
5533
+ #
5534
+ # * Anthropic Claude 3 Haiku - `anthropic.claude-3-haiku-20240307-v1:0`
5535
+ #
5536
+ # You can get the ARN of a model with the action. Standard model usage
5537
+ # charges apply for the foundation model parsing strategy.
5538
+ #
5539
+ # @!attribute [rw] bedrock_foundation_model_configuration
5540
+ # Settings for a foundation model used to parse documents for a data
5541
+ # source.
5542
+ # @return [Types::BedrockFoundationModelConfiguration]
5543
+ #
5544
+ # @!attribute [rw] parsing_strategy
5545
+ # The parsing strategy for the data source.
5546
+ # @return [String]
5547
+ #
5548
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ParsingConfiguration AWS API Documentation
5549
+ #
5550
+ class ParsingConfiguration < Struct.new(
5551
+ :bedrock_foundation_model_configuration,
5552
+ :parsing_strategy)
5553
+ SENSITIVE = []
5554
+ include Aws::Structure
5555
+ end
5556
+
5557
+ # Instructions for interpreting the contents of a document.
5558
+ #
5559
+ # @!attribute [rw] parsing_prompt_text
5560
+ # Instructions for interpreting the contents of a document.
5561
+ # @return [String]
5562
+ #
5563
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ParsingPrompt AWS API Documentation
5564
+ #
5565
+ class ParsingPrompt < Struct.new(
5566
+ :parsing_prompt_text)
5567
+ SENSITIVE = []
5568
+ include Aws::Structure
5569
+ end
5570
+
5571
+ # The specific filters applied to your data source content. You can
5572
+ # filter out or include certain content.
5573
+ #
5574
+ # @!attribute [rw] exclusion_filters
5575
+ # A list of one or more exclusion regular expression patterns to
5576
+ # exclude certain object types that adhere to the pattern. If you
5577
+ # specify an inclusion and exclusion filter/pattern and both match a
5578
+ # document, the exclusion filter takes precedence and the document
5579
+ # isn’t crawled.
5580
+ # @return [Array<String>]
5581
+ #
5582
+ # @!attribute [rw] inclusion_filters
5583
+ # A list of one or more inclusion regular expression patterns to
5584
+ # include certain object types that adhere to the pattern. If you
5585
+ # specify an inclusion and exclusion filter/pattern and both match a
5586
+ # document, the exclusion filter takes precedence and the document
5587
+ # isn’t crawled.
5588
+ # @return [Array<String>]
5589
+ #
5590
+ # @!attribute [rw] object_type
5591
+ # The supported object type or content type of the data source.
5592
+ # @return [String]
5593
+ #
5594
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PatternObjectFilter AWS API Documentation
5595
+ #
5596
+ class PatternObjectFilter < Struct.new(
5597
+ :exclusion_filters,
5598
+ :inclusion_filters,
5599
+ :object_type)
5600
+ SENSITIVE = [:exclusion_filters, :inclusion_filters, :object_type]
5601
+ include Aws::Structure
5602
+ end
5603
+
5604
+ # The configuration of filtering certain objects or content types of the
5605
+ # data source.
5606
+ #
5607
+ # @!attribute [rw] filters
5608
+ # The configuration of specific filters applied to your data source
5609
+ # content. You can filter out or include certain content.
5610
+ # @return [Array<Types::PatternObjectFilter>]
5611
+ #
5612
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PatternObjectFilterConfiguration AWS API Documentation
5613
+ #
5614
+ class PatternObjectFilterConfiguration < Struct.new(
5615
+ :filters)
5616
+ SENSITIVE = [:filters]
5617
+ include Aws::Structure
5618
+ end
5619
+
3211
5620
  # Contains details about the storage configuration of the knowledge base
3212
5621
  # in Pinecone. For more information, see [Create a vector index in
3213
5622
  # Pinecone][1].
@@ -3310,6 +5719,37 @@ module Aws::BedrockAgent
3310
5719
  include Aws::Structure
3311
5720
  end
3312
5721
 
5722
+ # @!attribute [rw] flow_identifier
5723
+ # The unique identifier of the flow.
5724
+ # @return [String]
5725
+ #
5726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PrepareFlowRequest AWS API Documentation
5727
+ #
5728
+ class PrepareFlowRequest < Struct.new(
5729
+ :flow_identifier)
5730
+ SENSITIVE = []
5731
+ include Aws::Structure
5732
+ end
5733
+
5734
+ # @!attribute [rw] id
5735
+ # The unique identifier of the flow.
5736
+ # @return [String]
5737
+ #
5738
+ # @!attribute [rw] status
5739
+ # The status of the flow. When you submit this request, the status
5740
+ # will be `NotPrepared`. If preparation succeeds, the status becomes
5741
+ # `Prepared`. If it fails, the status becomes `FAILED`.
5742
+ # @return [String]
5743
+ #
5744
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PrepareFlowResponse AWS API Documentation
5745
+ #
5746
+ class PrepareFlowResponse < Struct.new(
5747
+ :id,
5748
+ :status)
5749
+ SENSITIVE = []
5750
+ include Aws::Structure
5751
+ end
5752
+
3313
5753
  # Contains configurations to override a prompt template in one part of
3314
5754
  # an agent sequence. For more information, see [Advanced prompts][1].
3315
5755
  #
@@ -3376,58 +5816,355 @@ module Aws::BedrockAgent
3376
5816
  # * `POST_PROCESSING` – `DISABLED`
3377
5817
  # @return [String]
3378
5818
  #
3379
- # @!attribute [rw] prompt_type
3380
- # The step in the agent sequence that this prompt configuration
3381
- # applies to.
5819
+ # @!attribute [rw] prompt_type
5820
+ # The step in the agent sequence that this prompt configuration
5821
+ # applies to.
5822
+ # @return [String]
5823
+ #
5824
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptConfiguration AWS API Documentation
5825
+ #
5826
+ class PromptConfiguration < Struct.new(
5827
+ :base_prompt_template,
5828
+ :inference_configuration,
5829
+ :parser_mode,
5830
+ :prompt_creation_mode,
5831
+ :prompt_state,
5832
+ :prompt_type)
5833
+ SENSITIVE = [:base_prompt_template]
5834
+ include Aws::Structure
5835
+ end
5836
+
5837
+ # Contains configurations for a prompt node in the flow. You can use a
5838
+ # prompt from Prompt management or you can define one in this node. If
5839
+ # the prompt contains variables, the inputs into this node will fill in
5840
+ # the variables. The output from this node is the response generated by
5841
+ # the model. For more information, see [Node types in Amazon Bedrock
5842
+ # works][1] in the Amazon Bedrock User Guide.
5843
+ #
5844
+ #
5845
+ #
5846
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-nodes.html
5847
+ #
5848
+ # @!attribute [rw] source_configuration
5849
+ # Specifies whether the prompt is from Prompt management or defined
5850
+ # inline.
5851
+ # @return [Types::PromptFlowNodeSourceConfiguration]
5852
+ #
5853
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptFlowNodeConfiguration AWS API Documentation
5854
+ #
5855
+ class PromptFlowNodeConfiguration < Struct.new(
5856
+ :source_configuration)
5857
+ SENSITIVE = []
5858
+ include Aws::Structure
5859
+ end
5860
+
5861
+ # Contains configurations for a prompt defined inline in the node.
5862
+ #
5863
+ # @!attribute [rw] inference_configuration
5864
+ # Contains inference configurations for the prompt.
5865
+ # @return [Types::PromptInferenceConfiguration]
5866
+ #
5867
+ # @!attribute [rw] model_id
5868
+ # The unique identifier of the model to run inference with.
5869
+ # @return [String]
5870
+ #
5871
+ # @!attribute [rw] template_configuration
5872
+ # Contains a prompt and variables in the prompt that can be replaced
5873
+ # with values at runtime.
5874
+ # @return [Types::PromptTemplateConfiguration]
5875
+ #
5876
+ # @!attribute [rw] template_type
5877
+ # The type of prompt template.
5878
+ # @return [String]
5879
+ #
5880
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptFlowNodeInlineConfiguration AWS API Documentation
5881
+ #
5882
+ class PromptFlowNodeInlineConfiguration < Struct.new(
5883
+ :inference_configuration,
5884
+ :model_id,
5885
+ :template_configuration,
5886
+ :template_type)
5887
+ SENSITIVE = []
5888
+ include Aws::Structure
5889
+ end
5890
+
5891
+ # Contains configurations for a prompt from Prompt management to use in
5892
+ # a node.
5893
+ #
5894
+ # @!attribute [rw] prompt_arn
5895
+ # The Amazon Resource Name (ARN) of the prompt from Prompt management.
5896
+ # @return [String]
5897
+ #
5898
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptFlowNodeResourceConfiguration AWS API Documentation
5899
+ #
5900
+ class PromptFlowNodeResourceConfiguration < Struct.new(
5901
+ :prompt_arn)
5902
+ SENSITIVE = []
5903
+ include Aws::Structure
5904
+ end
5905
+
5906
+ # Contains configurations for a prompt and whether it is from Prompt
5907
+ # management or defined inline.
5908
+ #
5909
+ # @note PromptFlowNodeSourceConfiguration is a union - when making an API calls you must set exactly one of the members.
5910
+ #
5911
+ # @note PromptFlowNodeSourceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PromptFlowNodeSourceConfiguration corresponding to the set member.
5912
+ #
5913
+ # @!attribute [rw] inline
5914
+ # Contains configurations for a prompt that is defined inline
5915
+ # @return [Types::PromptFlowNodeInlineConfiguration]
5916
+ #
5917
+ # @!attribute [rw] resource
5918
+ # Contains configurations for a prompt from Prompt management.
5919
+ # @return [Types::PromptFlowNodeResourceConfiguration]
5920
+ #
5921
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptFlowNodeSourceConfiguration AWS API Documentation
5922
+ #
5923
+ class PromptFlowNodeSourceConfiguration < Struct.new(
5924
+ :inline,
5925
+ :resource,
5926
+ :unknown)
5927
+ SENSITIVE = []
5928
+ include Aws::Structure
5929
+ include Aws::Structure::Union
5930
+
5931
+ class Inline < PromptFlowNodeSourceConfiguration; end
5932
+ class Resource < PromptFlowNodeSourceConfiguration; end
5933
+ class Unknown < PromptFlowNodeSourceConfiguration; end
5934
+ end
5935
+
5936
+ # Contains inference configurations for the prompt.
5937
+ #
5938
+ # @note PromptInferenceConfiguration is a union - when making an API calls you must set exactly one of the members.
5939
+ #
5940
+ # @note PromptInferenceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PromptInferenceConfiguration corresponding to the set member.
5941
+ #
5942
+ # @!attribute [rw] text
5943
+ # Contains inference configurations for a text prompt.
5944
+ # @return [Types::PromptModelInferenceConfiguration]
5945
+ #
5946
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptInferenceConfiguration AWS API Documentation
5947
+ #
5948
+ class PromptInferenceConfiguration < Struct.new(
5949
+ :text,
5950
+ :unknown)
5951
+ SENSITIVE = []
5952
+ include Aws::Structure
5953
+ include Aws::Structure::Union
5954
+
5955
+ class Text < PromptInferenceConfiguration; end
5956
+ class Unknown < PromptInferenceConfiguration; end
5957
+ end
5958
+
5959
+ # Contains information about a variable in the prompt.
5960
+ #
5961
+ # @!attribute [rw] name
5962
+ # The name of the variable.
5963
+ # @return [String]
5964
+ #
5965
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptInputVariable AWS API Documentation
5966
+ #
5967
+ class PromptInputVariable < Struct.new(
5968
+ :name)
5969
+ SENSITIVE = []
5970
+ include Aws::Structure
5971
+ end
5972
+
5973
+ # Contains inference configurations related to model inference for a
5974
+ # prompt. For more information, see [Inference parameters][1].
5975
+ #
5976
+ #
5977
+ #
5978
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/inference-parameters.html
5979
+ #
5980
+ # @!attribute [rw] max_tokens
5981
+ # The maximum number of tokens to return in the response.
5982
+ # @return [Integer]
5983
+ #
5984
+ # @!attribute [rw] stop_sequences
5985
+ # A list of strings that define sequences after which the model will
5986
+ # stop generating.
5987
+ # @return [Array<String>]
5988
+ #
5989
+ # @!attribute [rw] temperature
5990
+ # Controls the randomness of the response. Choose a lower value for
5991
+ # more predictable outputs and a higher value for more surprising
5992
+ # outputs.
5993
+ # @return [Float]
5994
+ #
5995
+ # @!attribute [rw] top_k
5996
+ # The number of most-likely candidates that the model considers for
5997
+ # the next token during generation.
5998
+ # @return [Integer]
5999
+ #
6000
+ # @!attribute [rw] top_p
6001
+ # The percentage of most-likely candidates that the model considers
6002
+ # for the next token.
6003
+ # @return [Float]
6004
+ #
6005
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptModelInferenceConfiguration AWS API Documentation
6006
+ #
6007
+ class PromptModelInferenceConfiguration < Struct.new(
6008
+ :max_tokens,
6009
+ :stop_sequences,
6010
+ :temperature,
6011
+ :top_k,
6012
+ :top_p)
6013
+ SENSITIVE = []
6014
+ include Aws::Structure
6015
+ end
6016
+
6017
+ # Contains configurations to override prompts in different parts of an
6018
+ # agent sequence. For more information, see [Advanced prompts][1].
6019
+ #
6020
+ #
6021
+ #
6022
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
6023
+ #
6024
+ # @!attribute [rw] override_lambda
6025
+ # The ARN of the Lambda function to use when parsing the raw
6026
+ # foundation model output in parts of the agent sequence. If you
6027
+ # specify this field, at least one of the `promptConfigurations` must
6028
+ # contain a `parserMode` value that is set to `OVERRIDDEN`. For more
6029
+ # information, see [Parser Lambda function in Agents for Amazon
6030
+ # Bedrock][1].
6031
+ #
6032
+ #
6033
+ #
6034
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html
6035
+ # @return [String]
6036
+ #
6037
+ # @!attribute [rw] prompt_configurations
6038
+ # Contains configurations to override a prompt template in one part of
6039
+ # an agent sequence. For more information, see [Advanced prompts][1].
6040
+ #
6041
+ #
6042
+ #
6043
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
6044
+ # @return [Array<Types::PromptConfiguration>]
6045
+ #
6046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptOverrideConfiguration AWS API Documentation
6047
+ #
6048
+ class PromptOverrideConfiguration < Struct.new(
6049
+ :override_lambda,
6050
+ :prompt_configurations)
6051
+ SENSITIVE = []
6052
+ include Aws::Structure
6053
+ end
6054
+
6055
+ # Contains information about a prompt in your Prompt management tool.
6056
+ #
6057
+ # This data type is used in the following API operations:
6058
+ #
6059
+ # * [ListPrompts response][1]
6060
+ #
6061
+ # ^
6062
+ #
6063
+ #
6064
+ #
6065
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_ListPrompts.html#API_agent_ListPrompts_ResponseSyntax
6066
+ #
6067
+ # @!attribute [rw] arn
6068
+ # The Amazon Resource Name (ARN) of the prompt.
6069
+ # @return [String]
6070
+ #
6071
+ # @!attribute [rw] created_at
6072
+ # The time at which the prompt was created.
6073
+ # @return [Time]
6074
+ #
6075
+ # @!attribute [rw] description
6076
+ # The description of the prompt.
6077
+ # @return [String]
6078
+ #
6079
+ # @!attribute [rw] id
6080
+ # The unique identifier of the prompt.
6081
+ # @return [String]
6082
+ #
6083
+ # @!attribute [rw] name
6084
+ # The name of the prompt.
6085
+ # @return [String]
6086
+ #
6087
+ # @!attribute [rw] updated_at
6088
+ # The time at which the prompt was last updated.
6089
+ # @return [Time]
6090
+ #
6091
+ # @!attribute [rw] version
6092
+ # The version of the prompt that this summary applies to.
3382
6093
  # @return [String]
3383
6094
  #
3384
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptConfiguration AWS API Documentation
6095
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptSummary AWS API Documentation
3385
6096
  #
3386
- class PromptConfiguration < Struct.new(
3387
- :base_prompt_template,
3388
- :inference_configuration,
3389
- :parser_mode,
3390
- :prompt_creation_mode,
3391
- :prompt_state,
3392
- :prompt_type)
6097
+ class PromptSummary < Struct.new(
6098
+ :arn,
6099
+ :created_at,
6100
+ :description,
6101
+ :id,
6102
+ :name,
6103
+ :updated_at,
6104
+ :version)
3393
6105
  SENSITIVE = []
3394
6106
  include Aws::Structure
3395
6107
  end
3396
6108
 
3397
- # Contains configurations to override prompts in different parts of an
3398
- # agent sequence. For more information, see [Advanced prompts][1].
6109
+ # Contains the message for a prompt. For more information, see [Prompt
6110
+ # management in Amazon Bedrock][1].
3399
6111
  #
3400
6112
  #
3401
6113
  #
3402
- # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
6114
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html
3403
6115
  #
3404
- # @!attribute [rw] override_lambda
3405
- # The ARN of the Lambda function to use when parsing the raw
3406
- # foundation model output in parts of the agent sequence. If you
3407
- # specify this field, at least one of the `promptConfigurations` must
3408
- # contain a `parserMode` value that is set to `OVERRIDDEN`. For more
3409
- # information, see [Parser Lambda function in Agents for Amazon
3410
- # Bedrock][1].
6116
+ # @note PromptTemplateConfiguration is a union - when making an API calls you must set exactly one of the members.
3411
6117
  #
6118
+ # @note PromptTemplateConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of PromptTemplateConfiguration corresponding to the set member.
3412
6119
  #
6120
+ # @!attribute [rw] text
6121
+ # Contains configurations for the text in a message for a prompt.
6122
+ # @return [Types::TextPromptTemplateConfiguration]
3413
6123
  #
3414
- # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/lambda-parser.html
3415
- # @return [String]
6124
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptTemplateConfiguration AWS API Documentation
3416
6125
  #
3417
- # @!attribute [rw] prompt_configurations
3418
- # Contains configurations to override a prompt template in one part of
3419
- # an agent sequence. For more information, see [Advanced prompts][1].
6126
+ class PromptTemplateConfiguration < Struct.new(
6127
+ :text,
6128
+ :unknown)
6129
+ SENSITIVE = [:text]
6130
+ include Aws::Structure
6131
+ include Aws::Structure::Union
6132
+
6133
+ class Text < PromptTemplateConfiguration; end
6134
+ class Unknown < PromptTemplateConfiguration; end
6135
+ end
6136
+
6137
+ # Contains details about a variant of the prompt.
3420
6138
  #
6139
+ # @!attribute [rw] inference_configuration
6140
+ # Contains inference configurations for the prompt variant.
6141
+ # @return [Types::PromptInferenceConfiguration]
3421
6142
  #
6143
+ # @!attribute [rw] model_id
6144
+ # The unique identifier of the model with which to run inference on
6145
+ # the prompt.
6146
+ # @return [String]
3422
6147
  #
3423
- # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html
3424
- # @return [Array<Types::PromptConfiguration>]
6148
+ # @!attribute [rw] name
6149
+ # The name of the prompt variant.
6150
+ # @return [String]
3425
6151
  #
3426
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptOverrideConfiguration AWS API Documentation
6152
+ # @!attribute [rw] template_configuration
6153
+ # Contains configurations for the prompt template.
6154
+ # @return [Types::PromptTemplateConfiguration]
3427
6155
  #
3428
- class PromptOverrideConfiguration < Struct.new(
3429
- :override_lambda,
3430
- :prompt_configurations)
6156
+ # @!attribute [rw] template_type
6157
+ # The type of prompt template to use.
6158
+ # @return [String]
6159
+ #
6160
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/PromptVariant AWS API Documentation
6161
+ #
6162
+ class PromptVariant < Struct.new(
6163
+ :inference_configuration,
6164
+ :model_id,
6165
+ :name,
6166
+ :template_configuration,
6167
+ :template_type)
3431
6168
  SENSITIVE = []
3432
6169
  include Aws::Structure
3433
6170
  end
@@ -3590,21 +6327,78 @@ module Aws::BedrockAgent
3590
6327
  include Aws::Structure
3591
6328
  end
3592
6329
 
3593
- # Contains information about the S3 configuration of the data source.
6330
+ # Contains configurations for a Retrieval node in a flow. This node
6331
+ # retrieves data from the Amazon S3 location that you specify and
6332
+ # returns it as the output.
6333
+ #
6334
+ # @!attribute [rw] service_configuration
6335
+ # Contains configurations for the service to use for retrieving data
6336
+ # to return as the output from the node.
6337
+ # @return [Types::RetrievalFlowNodeServiceConfiguration]
6338
+ #
6339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RetrievalFlowNodeConfiguration AWS API Documentation
6340
+ #
6341
+ class RetrievalFlowNodeConfiguration < Struct.new(
6342
+ :service_configuration)
6343
+ SENSITIVE = []
6344
+ include Aws::Structure
6345
+ end
6346
+
6347
+ # Contains configurations for the Amazon S3 location from which to
6348
+ # retrieve data to return as the output from the node.
6349
+ #
6350
+ # @!attribute [rw] bucket_name
6351
+ # The name of the Amazon S3 bucket from which to retrieve data.
6352
+ # @return [String]
6353
+ #
6354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RetrievalFlowNodeS3Configuration AWS API Documentation
6355
+ #
6356
+ class RetrievalFlowNodeS3Configuration < Struct.new(
6357
+ :bucket_name)
6358
+ SENSITIVE = []
6359
+ include Aws::Structure
6360
+ end
6361
+
6362
+ # Contains configurations for the service to use for retrieving data to
6363
+ # return as the output from the node.
6364
+ #
6365
+ # @note RetrievalFlowNodeServiceConfiguration is a union - when making an API calls you must set exactly one of the members.
6366
+ #
6367
+ # @note RetrievalFlowNodeServiceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RetrievalFlowNodeServiceConfiguration corresponding to the set member.
6368
+ #
6369
+ # @!attribute [rw] s3
6370
+ # Contains configurations for the Amazon S3 location from which to
6371
+ # retrieve data to return as the output from the node.
6372
+ # @return [Types::RetrievalFlowNodeS3Configuration]
6373
+ #
6374
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RetrievalFlowNodeServiceConfiguration AWS API Documentation
6375
+ #
6376
+ class RetrievalFlowNodeServiceConfiguration < Struct.new(
6377
+ :s3,
6378
+ :unknown)
6379
+ SENSITIVE = []
6380
+ include Aws::Structure
6381
+ include Aws::Structure::Union
6382
+
6383
+ class S3 < RetrievalFlowNodeServiceConfiguration; end
6384
+ class Unknown < RetrievalFlowNodeServiceConfiguration; end
6385
+ end
6386
+
6387
+ # The configuration information to connect to Amazon S3 as your data
6388
+ # source.
3594
6389
  #
3595
6390
  # @!attribute [rw] bucket_arn
3596
- # The Amazon Resource Name (ARN) of the bucket that contains the data
3597
- # source.
6391
+ # The Amazon Resource Name (ARN) of the S3 bucket that contains your
6392
+ # data.
3598
6393
  # @return [String]
3599
6394
  #
3600
6395
  # @!attribute [rw] bucket_owner_account_id
3601
- # The bucket account owner ID for the S3 bucket.
6396
+ # The account ID for the owner of the S3 bucket.
3602
6397
  # @return [String]
3603
6398
  #
3604
6399
  # @!attribute [rw] inclusion_prefixes
3605
- # A list of S3 prefixes that define the object containing the data
3606
- # sources. For more information, see [Organizing objects using
3607
- # prefixes][1].
6400
+ # A list of S3 prefixes to include certain files or content. For more
6401
+ # information, see [Organizing objects using prefixes][1].
3608
6402
  #
3609
6403
  #
3610
6404
  #
@@ -3621,14 +6415,14 @@ module Aws::BedrockAgent
3621
6415
  include Aws::Structure
3622
6416
  end
3623
6417
 
3624
- # Contains information about the S3 object containing the resource.
6418
+ # The identifier information for an Amazon S3 bucket.
3625
6419
  #
3626
6420
  # @!attribute [rw] s3_bucket_name
3627
6421
  # The name of the S3 bucket.
3628
6422
  # @return [String]
3629
6423
  #
3630
6424
  # @!attribute [rw] s3_object_key
3631
- # The S3 object key containing the resource.
6425
+ # The S3 object key for the S3 resource.
3632
6426
  # @return [String]
3633
6427
  #
3634
6428
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/S3Identifier AWS API Documentation
@@ -3640,6 +6434,149 @@ module Aws::BedrockAgent
3640
6434
  include Aws::Structure
3641
6435
  end
3642
6436
 
6437
+ # An Amazon S3 location.
6438
+ #
6439
+ # @!attribute [rw] uri
6440
+ # The location's URI. For example, `s3://my-bucket/chunk-processor/`.
6441
+ # @return [String]
6442
+ #
6443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/S3Location AWS API Documentation
6444
+ #
6445
+ class S3Location < Struct.new(
6446
+ :uri)
6447
+ SENSITIVE = []
6448
+ include Aws::Structure
6449
+ end
6450
+
6451
+ # The configuration of the Salesforce content. For example, configuring
6452
+ # specific types of Salesforce content.
6453
+ #
6454
+ # @!attribute [rw] filter_configuration
6455
+ # The configuration of filtering the Salesforce content. For example,
6456
+ # configuring regular expression patterns to include or exclude
6457
+ # certain content.
6458
+ # @return [Types::CrawlFilterConfiguration]
6459
+ #
6460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SalesforceCrawlerConfiguration AWS API Documentation
6461
+ #
6462
+ class SalesforceCrawlerConfiguration < Struct.new(
6463
+ :filter_configuration)
6464
+ SENSITIVE = []
6465
+ include Aws::Structure
6466
+ end
6467
+
6468
+ # The configuration information to connect to Salesforce as your data
6469
+ # source.
6470
+ #
6471
+ # @!attribute [rw] crawler_configuration
6472
+ # The configuration of the Salesforce content. For example,
6473
+ # configuring specific types of Salesforce content.
6474
+ # @return [Types::SalesforceCrawlerConfiguration]
6475
+ #
6476
+ # @!attribute [rw] source_configuration
6477
+ # The endpoint information to connect to your Salesforce data source.
6478
+ # @return [Types::SalesforceSourceConfiguration]
6479
+ #
6480
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SalesforceDataSourceConfiguration AWS API Documentation
6481
+ #
6482
+ class SalesforceDataSourceConfiguration < Struct.new(
6483
+ :crawler_configuration,
6484
+ :source_configuration)
6485
+ SENSITIVE = []
6486
+ include Aws::Structure
6487
+ end
6488
+
6489
+ # The endpoint information to connect to your Salesforce data source.
6490
+ #
6491
+ # @!attribute [rw] auth_type
6492
+ # The supported authentication type to authenticate and connect to
6493
+ # your Salesforce instance.
6494
+ # @return [String]
6495
+ #
6496
+ # @!attribute [rw] credentials_secret_arn
6497
+ # The Amazon Resource Name of an Secrets Manager secret that stores
6498
+ # your authentication credentials for your SharePoint site/sites. For
6499
+ # more information on the key-value pairs that must be included in
6500
+ # your secret, depending on your authentication type, see [Salesforce
6501
+ # connection configuration][1].
6502
+ #
6503
+ #
6504
+ #
6505
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/salesforce-data-source-connector.html#configuration-salesforce-connector
6506
+ # @return [String]
6507
+ #
6508
+ # @!attribute [rw] host_url
6509
+ # The Salesforce host URL or instance URL.
6510
+ # @return [String]
6511
+ #
6512
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SalesforceSourceConfiguration AWS API Documentation
6513
+ #
6514
+ class SalesforceSourceConfiguration < Struct.new(
6515
+ :auth_type,
6516
+ :credentials_secret_arn,
6517
+ :host_url)
6518
+ SENSITIVE = []
6519
+ include Aws::Structure
6520
+ end
6521
+
6522
+ # The seed or starting point URL. You should be authorized to crawl the
6523
+ # URL.
6524
+ #
6525
+ # @!attribute [rw] url
6526
+ # A seed or starting point URL.
6527
+ # @return [String]
6528
+ #
6529
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SeedUrl AWS API Documentation
6530
+ #
6531
+ class SeedUrl < Struct.new(
6532
+ :url)
6533
+ SENSITIVE = []
6534
+ include Aws::Structure
6535
+ end
6536
+
6537
+ # Settings for semantic document chunking for a data source. Semantic
6538
+ # chunking splits a document into into smaller documents based on groups
6539
+ # of similar content derived from the text with natural language
6540
+ # processing.
6541
+ #
6542
+ # With semantic chunking, each sentence is compared to the next to
6543
+ # determine how similar they are. You specify a threshold in the form of
6544
+ # a percentile, where adjacent sentences that are less similar than that
6545
+ # percentage of sentence pairs are divided into separate chunks. For
6546
+ # example, if you set the threshold to 90, then the 10 percent of
6547
+ # sentence pairs that are least similar are split. So if you have 101
6548
+ # sentences, 100 sentence pairs are compared, and the 10 with the least
6549
+ # similarity are split, creating 11 chunks. These chunks are further
6550
+ # split if they exceed the max token size.
6551
+ #
6552
+ # You must also specify a buffer size, which determines whether
6553
+ # sentences are compared in isolation, or within a moving context window
6554
+ # that includes the previous and following sentence. For example, if you
6555
+ # set the buffer size to `1`, the embedding for sentence 10 is derived
6556
+ # from sentences 9, 10, and 11 combined.
6557
+ #
6558
+ # @!attribute [rw] breakpoint_percentile_threshold
6559
+ # The dissimilarity threshold for splitting chunks.
6560
+ # @return [Integer]
6561
+ #
6562
+ # @!attribute [rw] buffer_size
6563
+ # The buffer size.
6564
+ # @return [Integer]
6565
+ #
6566
+ # @!attribute [rw] max_tokens
6567
+ # The maximum number of tokens that a chunk can contain.
6568
+ # @return [Integer]
6569
+ #
6570
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SemanticChunkingConfiguration AWS API Documentation
6571
+ #
6572
+ class SemanticChunkingConfiguration < Struct.new(
6573
+ :breakpoint_percentile_threshold,
6574
+ :buffer_size,
6575
+ :max_tokens)
6576
+ SENSITIVE = []
6577
+ include Aws::Structure
6578
+ end
6579
+
3643
6580
  # Contains the configuration for server-side encryption.
3644
6581
  #
3645
6582
  # @!attribute [rw] kms_key_arn
@@ -3669,6 +6606,92 @@ module Aws::BedrockAgent
3669
6606
  include Aws::Structure
3670
6607
  end
3671
6608
 
6609
+ # The configuration of the SharePoint content. For example, configuring
6610
+ # specific types of SharePoint content.
6611
+ #
6612
+ # @!attribute [rw] filter_configuration
6613
+ # The configuration of filtering the SharePoint content. For example,
6614
+ # configuring regular expression patterns to include or exclude
6615
+ # certain content.
6616
+ # @return [Types::CrawlFilterConfiguration]
6617
+ #
6618
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SharePointCrawlerConfiguration AWS API Documentation
6619
+ #
6620
+ class SharePointCrawlerConfiguration < Struct.new(
6621
+ :filter_configuration)
6622
+ SENSITIVE = []
6623
+ include Aws::Structure
6624
+ end
6625
+
6626
+ # The configuration information to connect to SharePoint as your data
6627
+ # source.
6628
+ #
6629
+ # @!attribute [rw] crawler_configuration
6630
+ # The configuration of the SharePoint content. For example,
6631
+ # configuring specific types of SharePoint content.
6632
+ # @return [Types::SharePointCrawlerConfiguration]
6633
+ #
6634
+ # @!attribute [rw] source_configuration
6635
+ # The endpoint information to connect to your SharePoint data source.
6636
+ # @return [Types::SharePointSourceConfiguration]
6637
+ #
6638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SharePointDataSourceConfiguration AWS API Documentation
6639
+ #
6640
+ class SharePointDataSourceConfiguration < Struct.new(
6641
+ :crawler_configuration,
6642
+ :source_configuration)
6643
+ SENSITIVE = []
6644
+ include Aws::Structure
6645
+ end
6646
+
6647
+ # The endpoint information to connect to your SharePoint data source.
6648
+ #
6649
+ # @!attribute [rw] auth_type
6650
+ # The supported authentication type to authenticate and connect to
6651
+ # your SharePoint site/sites.
6652
+ # @return [String]
6653
+ #
6654
+ # @!attribute [rw] credentials_secret_arn
6655
+ # The Amazon Resource Name of an Secrets Manager secret that stores
6656
+ # your authentication credentials for your SharePoint site/sites. For
6657
+ # more information on the key-value pairs that must be included in
6658
+ # your secret, depending on your authentication type, see [SharePoint
6659
+ # connection configuration][1].
6660
+ #
6661
+ #
6662
+ #
6663
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/sharepoint-data-source-connector.html#configuration-sharepoint-connector
6664
+ # @return [String]
6665
+ #
6666
+ # @!attribute [rw] domain
6667
+ # The domain of your SharePoint instance or site URL/URLs.
6668
+ # @return [String]
6669
+ #
6670
+ # @!attribute [rw] host_type
6671
+ # The supported host type, whether online/cloud or server/on-premises.
6672
+ # @return [String]
6673
+ #
6674
+ # @!attribute [rw] site_urls
6675
+ # A list of one or more SharePoint site URLs.
6676
+ # @return [Array<String>]
6677
+ #
6678
+ # @!attribute [rw] tenant_id
6679
+ # The identifier of your Microsoft 365 tenant.
6680
+ # @return [String]
6681
+ #
6682
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SharePointSourceConfiguration AWS API Documentation
6683
+ #
6684
+ class SharePointSourceConfiguration < Struct.new(
6685
+ :auth_type,
6686
+ :credentials_secret_arn,
6687
+ :domain,
6688
+ :host_type,
6689
+ :site_urls,
6690
+ :tenant_id)
6691
+ SENSITIVE = []
6692
+ include Aws::Structure
6693
+ end
6694
+
3672
6695
  # @!attribute [rw] client_token
3673
6696
  # A unique, case-sensitive identifier to ensure that the API request
3674
6697
  # completes no more than one time. If this token matches a previous
@@ -3768,37 +6791,164 @@ module Aws::BedrockAgent
3768
6791
  include Aws::Structure
3769
6792
  end
3770
6793
 
3771
- # @!attribute [rw] resource_arn
3772
- # The Amazon Resource Name (ARN) of the resource to tag.
6794
+ # Contains configurations for a Storage node in a flow. This node stores
6795
+ # the input in an Amazon S3 location that you specify.
6796
+ #
6797
+ # @!attribute [rw] service_configuration
6798
+ # Contains configurations for the service to use for storing the input
6799
+ # into the node.
6800
+ # @return [Types::StorageFlowNodeServiceConfiguration]
6801
+ #
6802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StorageFlowNodeConfiguration AWS API Documentation
6803
+ #
6804
+ class StorageFlowNodeConfiguration < Struct.new(
6805
+ :service_configuration)
6806
+ SENSITIVE = []
6807
+ include Aws::Structure
6808
+ end
6809
+
6810
+ # Contains configurations for the Amazon S3 location in which to store
6811
+ # the input into the node.
6812
+ #
6813
+ # @!attribute [rw] bucket_name
6814
+ # The name of the Amazon S3 bucket in which to store the input into
6815
+ # the node.
6816
+ # @return [String]
6817
+ #
6818
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StorageFlowNodeS3Configuration AWS API Documentation
6819
+ #
6820
+ class StorageFlowNodeS3Configuration < Struct.new(
6821
+ :bucket_name)
6822
+ SENSITIVE = []
6823
+ include Aws::Structure
6824
+ end
6825
+
6826
+ # Contains configurations for the service to use for storing the input
6827
+ # into the node.
6828
+ #
6829
+ # @note StorageFlowNodeServiceConfiguration is a union - when making an API calls you must set exactly one of the members.
6830
+ #
6831
+ # @note StorageFlowNodeServiceConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of StorageFlowNodeServiceConfiguration corresponding to the set member.
6832
+ #
6833
+ # @!attribute [rw] s3
6834
+ # Contains configurations for the Amazon S3 location in which to store
6835
+ # the input into the node.
6836
+ # @return [Types::StorageFlowNodeS3Configuration]
6837
+ #
6838
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/StorageFlowNodeServiceConfiguration AWS API Documentation
6839
+ #
6840
+ class StorageFlowNodeServiceConfiguration < Struct.new(
6841
+ :s3,
6842
+ :unknown)
6843
+ SENSITIVE = []
6844
+ include Aws::Structure
6845
+ include Aws::Structure::Union
6846
+
6847
+ class S3 < StorageFlowNodeServiceConfiguration; end
6848
+ class Unknown < StorageFlowNodeServiceConfiguration; end
6849
+ end
6850
+
6851
+ # @!attribute [rw] resource_arn
6852
+ # The Amazon Resource Name (ARN) of the resource to tag.
6853
+ # @return [String]
6854
+ #
6855
+ # @!attribute [rw] tags
6856
+ # An object containing key-value pairs that define the tags to attach
6857
+ # to the resource.
6858
+ # @return [Hash<String,String>]
6859
+ #
6860
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TagResourceRequest AWS API Documentation
6861
+ #
6862
+ class TagResourceRequest < Struct.new(
6863
+ :resource_arn,
6864
+ :tags)
6865
+ SENSITIVE = []
6866
+ include Aws::Structure
6867
+ end
6868
+
6869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TagResourceResponse AWS API Documentation
6870
+ #
6871
+ class TagResourceResponse < Aws::EmptyStructure; end
6872
+
6873
+ # Contains configurations for a text prompt template. To include a
6874
+ # variable, enclose a word in double curly braces as in
6875
+ # `\{\{variable\}\}`.
6876
+ #
6877
+ # @!attribute [rw] input_variables
6878
+ # An array of the variables in the prompt template.
6879
+ # @return [Array<Types::PromptInputVariable>]
6880
+ #
6881
+ # @!attribute [rw] text
6882
+ # The message for the prompt.
6883
+ # @return [String]
6884
+ #
6885
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TextPromptTemplateConfiguration AWS API Documentation
6886
+ #
6887
+ class TextPromptTemplateConfiguration < Struct.new(
6888
+ :input_variables,
6889
+ :text)
6890
+ SENSITIVE = [:input_variables, :text]
6891
+ include Aws::Structure
6892
+ end
6893
+
6894
+ # The number of requests exceeds the limit. Resubmit your request later.
6895
+ #
6896
+ # @!attribute [rw] message
6897
+ # @return [String]
6898
+ #
6899
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ThrottlingException AWS API Documentation
6900
+ #
6901
+ class ThrottlingException < Struct.new(
6902
+ :message)
6903
+ SENSITIVE = []
6904
+ include Aws::Structure
6905
+ end
6906
+
6907
+ # A custom processing step for documents moving through a data source
6908
+ # ingestion pipeline. To process documents after they have been
6909
+ # converted into chunks, set the step to apply to `POST_CHUNKING`.
6910
+ #
6911
+ # @!attribute [rw] step_to_apply
6912
+ # When the service applies the transformation.
3773
6913
  # @return [String]
3774
6914
  #
3775
- # @!attribute [rw] tags
3776
- # An object containing key-value pairs that define the tags to attach
3777
- # to the resource.
3778
- # @return [Hash<String,String>]
6915
+ # @!attribute [rw] transformation_function
6916
+ # A Lambda function that processes documents.
6917
+ # @return [Types::TransformationFunction]
3779
6918
  #
3780
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TagResourceRequest AWS API Documentation
6919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/Transformation AWS API Documentation
3781
6920
  #
3782
- class TagResourceRequest < Struct.new(
3783
- :resource_arn,
3784
- :tags)
6921
+ class Transformation < Struct.new(
6922
+ :step_to_apply,
6923
+ :transformation_function)
3785
6924
  SENSITIVE = []
3786
6925
  include Aws::Structure
3787
6926
  end
3788
6927
 
3789
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TagResourceResponse AWS API Documentation
6928
+ # A Lambda function that processes documents.
3790
6929
  #
3791
- class TagResourceResponse < Aws::EmptyStructure; end
6930
+ # @!attribute [rw] transformation_lambda_configuration
6931
+ # The Lambda function.
6932
+ # @return [Types::TransformationLambdaConfiguration]
6933
+ #
6934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TransformationFunction AWS API Documentation
6935
+ #
6936
+ class TransformationFunction < Struct.new(
6937
+ :transformation_lambda_configuration)
6938
+ SENSITIVE = []
6939
+ include Aws::Structure
6940
+ end
3792
6941
 
3793
- # The number of requests exceeds the limit. Resubmit your request later.
6942
+ # A Lambda function that processes documents.
3794
6943
  #
3795
- # @!attribute [rw] message
6944
+ # @!attribute [rw] lambda_arn
6945
+ # The function's ARN identifier.
3796
6946
  # @return [String]
3797
6947
  #
3798
- # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ThrottlingException AWS API Documentation
6948
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TransformationLambdaConfiguration AWS API Documentation
3799
6949
  #
3800
- class ThrottlingException < Struct.new(
3801
- :message)
6950
+ class TransformationLambdaConfiguration < Struct.new(
6951
+ :lambda_arn)
3802
6952
  SENSITIVE = []
3803
6953
  include Aws::Structure
3804
6954
  end
@@ -4067,6 +7217,10 @@ module Aws::BedrockAgent
4067
7217
  # how it should interact with users.
4068
7218
  # @return [String]
4069
7219
  #
7220
+ # @!attribute [rw] memory_configuration
7221
+ # Specifies the new memory configuration for the agent.
7222
+ # @return [Types::MemoryConfiguration]
7223
+ #
4070
7224
  # @!attribute [rw] prompt_override_configuration
4071
7225
  # Contains configurations to override prompts in different parts of an
4072
7226
  # agent sequence. For more information, see [Advanced prompts][1].
@@ -4088,6 +7242,7 @@ module Aws::BedrockAgent
4088
7242
  :guardrail_configuration,
4089
7243
  :idle_session_ttl_in_seconds,
4090
7244
  :instruction,
7245
+ :memory_configuration,
4091
7246
  :prompt_override_configuration)
4092
7247
  SENSITIVE = [:instruction, :prompt_override_configuration]
4093
7248
  include Aws::Structure
@@ -4106,11 +7261,13 @@ module Aws::BedrockAgent
4106
7261
  end
4107
7262
 
4108
7263
  # @!attribute [rw] data_deletion_policy
4109
- # The data deletion policy of the updated data source.
7264
+ # The data deletion policy for the data source that you want to
7265
+ # update.
4110
7266
  # @return [String]
4111
7267
  #
4112
7268
  # @!attribute [rw] data_source_configuration
4113
- # Contains details about the storage configuration of the data source.
7269
+ # The connection configuration for the data source that you want to
7270
+ # update.
4114
7271
  # @return [Types::DataSourceConfiguration]
4115
7272
  #
4116
7273
  # @!attribute [rw] data_source_id
@@ -4122,8 +7279,7 @@ module Aws::BedrockAgent
4122
7279
  # @return [String]
4123
7280
  #
4124
7281
  # @!attribute [rw] knowledge_base_id
4125
- # The unique identifier of the knowledge base to which the data source
4126
- # belongs.
7282
+ # The unique identifier of the knowledge base for the data source.
4127
7283
  # @return [String]
4128
7284
  #
4129
7285
  # @!attribute [rw] name
@@ -4166,6 +7322,203 @@ module Aws::BedrockAgent
4166
7322
  include Aws::Structure
4167
7323
  end
4168
7324
 
7325
+ # @!attribute [rw] alias_identifier
7326
+ # The unique identifier of the alias.
7327
+ # @return [String]
7328
+ #
7329
+ # @!attribute [rw] description
7330
+ # A description for the flow alias.
7331
+ # @return [String]
7332
+ #
7333
+ # @!attribute [rw] flow_identifier
7334
+ # The unique identifier of the flow.
7335
+ # @return [String]
7336
+ #
7337
+ # @!attribute [rw] name
7338
+ # The name of the flow alias.
7339
+ # @return [String]
7340
+ #
7341
+ # @!attribute [rw] routing_configuration
7342
+ # Contains information about the version to which to map the alias.
7343
+ # @return [Array<Types::FlowAliasRoutingConfigurationListItem>]
7344
+ #
7345
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateFlowAliasRequest AWS API Documentation
7346
+ #
7347
+ class UpdateFlowAliasRequest < Struct.new(
7348
+ :alias_identifier,
7349
+ :description,
7350
+ :flow_identifier,
7351
+ :name,
7352
+ :routing_configuration)
7353
+ SENSITIVE = []
7354
+ include Aws::Structure
7355
+ end
7356
+
7357
+ # @!attribute [rw] arn
7358
+ # The Amazon Resource Name (ARN) of the flow.
7359
+ # @return [String]
7360
+ #
7361
+ # @!attribute [rw] created_at
7362
+ # The time at which the flow was created.
7363
+ # @return [Time]
7364
+ #
7365
+ # @!attribute [rw] description
7366
+ # The description of the flow.
7367
+ # @return [String]
7368
+ #
7369
+ # @!attribute [rw] flow_id
7370
+ # The unique identifier of the flow.
7371
+ # @return [String]
7372
+ #
7373
+ # @!attribute [rw] id
7374
+ # The unique identifier of the alias.
7375
+ # @return [String]
7376
+ #
7377
+ # @!attribute [rw] name
7378
+ # The name of the flow alias.
7379
+ # @return [String]
7380
+ #
7381
+ # @!attribute [rw] routing_configuration
7382
+ # Contains information about the version that the alias is mapped to.
7383
+ # @return [Array<Types::FlowAliasRoutingConfigurationListItem>]
7384
+ #
7385
+ # @!attribute [rw] updated_at
7386
+ # The time at which the flow alias was last updated.
7387
+ # @return [Time]
7388
+ #
7389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateFlowAliasResponse AWS API Documentation
7390
+ #
7391
+ class UpdateFlowAliasResponse < Struct.new(
7392
+ :arn,
7393
+ :created_at,
7394
+ :description,
7395
+ :flow_id,
7396
+ :id,
7397
+ :name,
7398
+ :routing_configuration,
7399
+ :updated_at)
7400
+ SENSITIVE = []
7401
+ include Aws::Structure
7402
+ end
7403
+
7404
+ # @!attribute [rw] customer_encryption_key_arn
7405
+ # The Amazon Resource Name (ARN) of the KMS key to encrypt the flow.
7406
+ # @return [String]
7407
+ #
7408
+ # @!attribute [rw] definition
7409
+ # A definition of the nodes and the connections between the nodes in
7410
+ # the flow.
7411
+ # @return [Types::FlowDefinition]
7412
+ #
7413
+ # @!attribute [rw] description
7414
+ # A description for the flow.
7415
+ # @return [String]
7416
+ #
7417
+ # @!attribute [rw] execution_role_arn
7418
+ # The Amazon Resource Name (ARN) of the service role with permissions
7419
+ # to create and manage a flow. For more information, see [Create a
7420
+ # service role for flows in Amazon Bedrock][1] in the Amazon Bedrock
7421
+ # User Guide.
7422
+ #
7423
+ #
7424
+ #
7425
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html
7426
+ # @return [String]
7427
+ #
7428
+ # @!attribute [rw] flow_identifier
7429
+ # The unique identifier of the flow.
7430
+ # @return [String]
7431
+ #
7432
+ # @!attribute [rw] name
7433
+ # A name for the flow.
7434
+ # @return [String]
7435
+ #
7436
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateFlowRequest AWS API Documentation
7437
+ #
7438
+ class UpdateFlowRequest < Struct.new(
7439
+ :customer_encryption_key_arn,
7440
+ :definition,
7441
+ :description,
7442
+ :execution_role_arn,
7443
+ :flow_identifier,
7444
+ :name)
7445
+ SENSITIVE = []
7446
+ include Aws::Structure
7447
+ end
7448
+
7449
+ # @!attribute [rw] arn
7450
+ # The Amazon Resource Name (ARN) of the flow.
7451
+ # @return [String]
7452
+ #
7453
+ # @!attribute [rw] created_at
7454
+ # The time at which the flow was created.
7455
+ # @return [Time]
7456
+ #
7457
+ # @!attribute [rw] customer_encryption_key_arn
7458
+ # The Amazon Resource Name (ARN) of the KMS key that the flow was
7459
+ # encrypted with.
7460
+ # @return [String]
7461
+ #
7462
+ # @!attribute [rw] definition
7463
+ # A definition of the nodes and the connections between nodes in the
7464
+ # flow.
7465
+ # @return [Types::FlowDefinition]
7466
+ #
7467
+ # @!attribute [rw] description
7468
+ # The description of the flow.
7469
+ # @return [String]
7470
+ #
7471
+ # @!attribute [rw] execution_role_arn
7472
+ # The Amazon Resource Name (ARN) of the service role with permissions
7473
+ # to create a flow. For more information, see [Create a service role
7474
+ # for flows in Amazon Bedrock][1] in the Amazon Bedrock User Guide.
7475
+ #
7476
+ #
7477
+ #
7478
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/flows-permissions.html
7479
+ # @return [String]
7480
+ #
7481
+ # @!attribute [rw] id
7482
+ # The unique identifier of the flow.
7483
+ # @return [String]
7484
+ #
7485
+ # @!attribute [rw] name
7486
+ # The name of the flow.
7487
+ # @return [String]
7488
+ #
7489
+ # @!attribute [rw] status
7490
+ # The status of the flow. When you submit this request, the status
7491
+ # will be `NotPrepared`. If updating fails, the status becomes
7492
+ # `Failed`.
7493
+ # @return [String]
7494
+ #
7495
+ # @!attribute [rw] updated_at
7496
+ # The time at which the flow was last updated.
7497
+ # @return [Time]
7498
+ #
7499
+ # @!attribute [rw] version
7500
+ # The version of the flow. When you update a flow, the version updated
7501
+ # is the `DRAFT` version.
7502
+ # @return [String]
7503
+ #
7504
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdateFlowResponse AWS API Documentation
7505
+ #
7506
+ class UpdateFlowResponse < Struct.new(
7507
+ :arn,
7508
+ :created_at,
7509
+ :customer_encryption_key_arn,
7510
+ :definition,
7511
+ :description,
7512
+ :execution_role_arn,
7513
+ :id,
7514
+ :name,
7515
+ :status,
7516
+ :updated_at,
7517
+ :version)
7518
+ SENSITIVE = []
7519
+ include Aws::Structure
7520
+ end
7521
+
4169
7522
  # @!attribute [rw] description
4170
7523
  # Specifies a new description for the knowledge base.
4171
7524
  # @return [String]
@@ -4220,6 +7573,128 @@ module Aws::BedrockAgent
4220
7573
  include Aws::Structure
4221
7574
  end
4222
7575
 
7576
+ # @!attribute [rw] customer_encryption_key_arn
7577
+ # The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
7578
+ # @return [String]
7579
+ #
7580
+ # @!attribute [rw] default_variant
7581
+ # The name of the default variant for the prompt. This value must
7582
+ # match the `name` field in the relevant [PromptVariant][1] object.
7583
+ #
7584
+ #
7585
+ #
7586
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html
7587
+ # @return [String]
7588
+ #
7589
+ # @!attribute [rw] description
7590
+ # A description for the prompt.
7591
+ # @return [String]
7592
+ #
7593
+ # @!attribute [rw] name
7594
+ # A name for the prompt.
7595
+ # @return [String]
7596
+ #
7597
+ # @!attribute [rw] prompt_identifier
7598
+ # The unique identifier of the prompt.
7599
+ # @return [String]
7600
+ #
7601
+ # @!attribute [rw] variants
7602
+ # A list of objects, each containing details about a variant of the
7603
+ # prompt.
7604
+ # @return [Array<Types::PromptVariant>]
7605
+ #
7606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdatePromptRequest AWS API Documentation
7607
+ #
7608
+ class UpdatePromptRequest < Struct.new(
7609
+ :customer_encryption_key_arn,
7610
+ :default_variant,
7611
+ :description,
7612
+ :name,
7613
+ :prompt_identifier,
7614
+ :variants)
7615
+ SENSITIVE = [:variants]
7616
+ include Aws::Structure
7617
+ end
7618
+
7619
+ # @!attribute [rw] arn
7620
+ # The Amazon Resource Name (ARN) of the prompt.
7621
+ # @return [String]
7622
+ #
7623
+ # @!attribute [rw] created_at
7624
+ # The time at which the prompt was created.
7625
+ # @return [Time]
7626
+ #
7627
+ # @!attribute [rw] customer_encryption_key_arn
7628
+ # The Amazon Resource Name (ARN) of the KMS key to encrypt the prompt.
7629
+ # @return [String]
7630
+ #
7631
+ # @!attribute [rw] default_variant
7632
+ # The name of the default variant for the prompt. This value must
7633
+ # match the `name` field in the relevant [PromptVariant][1] object.
7634
+ #
7635
+ #
7636
+ #
7637
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent_PromptVariant.html
7638
+ # @return [String]
7639
+ #
7640
+ # @!attribute [rw] description
7641
+ # The description of the prompt.
7642
+ # @return [String]
7643
+ #
7644
+ # @!attribute [rw] id
7645
+ # The unique identifier of the prompt.
7646
+ # @return [String]
7647
+ #
7648
+ # @!attribute [rw] name
7649
+ # The name of the prompt.
7650
+ # @return [String]
7651
+ #
7652
+ # @!attribute [rw] updated_at
7653
+ # The time at which the prompt was last updated.
7654
+ # @return [Time]
7655
+ #
7656
+ # @!attribute [rw] variants
7657
+ # A list of objects, each containing details about a variant of the
7658
+ # prompt.
7659
+ # @return [Array<Types::PromptVariant>]
7660
+ #
7661
+ # @!attribute [rw] version
7662
+ # The version of the prompt. When you update a prompt, the version
7663
+ # updated is the `DRAFT` version.
7664
+ # @return [String]
7665
+ #
7666
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UpdatePromptResponse AWS API Documentation
7667
+ #
7668
+ class UpdatePromptResponse < Struct.new(
7669
+ :arn,
7670
+ :created_at,
7671
+ :customer_encryption_key_arn,
7672
+ :default_variant,
7673
+ :description,
7674
+ :id,
7675
+ :name,
7676
+ :updated_at,
7677
+ :variants,
7678
+ :version)
7679
+ SENSITIVE = [:variants]
7680
+ include Aws::Structure
7681
+ end
7682
+
7683
+ # The configuration of web URLs that you want to crawl. You should be
7684
+ # authorized to crawl the URLs.
7685
+ #
7686
+ # @!attribute [rw] seed_urls
7687
+ # One or more seed or starting point URLs.
7688
+ # @return [Array<Types::SeedUrl>]
7689
+ #
7690
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/UrlConfiguration AWS API Documentation
7691
+ #
7692
+ class UrlConfiguration < Struct.new(
7693
+ :seed_urls)
7694
+ SENSITIVE = []
7695
+ include Aws::Structure
7696
+ end
7697
+
4223
7698
  # Input validation failed. Check your request parameters and retry the
4224
7699
  # request.
4225
7700
  #
@@ -4268,10 +7743,20 @@ module Aws::BedrockAgent
4268
7743
  # when the knowledge base that it belongs to is queried.
4269
7744
  # @return [Types::ChunkingConfiguration]
4270
7745
  #
7746
+ # @!attribute [rw] custom_transformation_configuration
7747
+ # A custom document transformer for parsed data source documents.
7748
+ # @return [Types::CustomTransformationConfiguration]
7749
+ #
7750
+ # @!attribute [rw] parsing_configuration
7751
+ # A custom parser for data source documents.
7752
+ # @return [Types::ParsingConfiguration]
7753
+ #
4271
7754
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorIngestionConfiguration AWS API Documentation
4272
7755
  #
4273
7756
  class VectorIngestionConfiguration < Struct.new(
4274
- :chunking_configuration)
7757
+ :chunking_configuration,
7758
+ :custom_transformation_configuration,
7759
+ :parsing_configuration)
4275
7760
  SENSITIVE = []
4276
7761
  include Aws::Structure
4277
7762
  end
@@ -4298,5 +7783,99 @@ module Aws::BedrockAgent
4298
7783
  include Aws::Structure
4299
7784
  end
4300
7785
 
7786
+ # The configuration of web URLs that you want to crawl. You should be
7787
+ # authorized to crawl the URLs.
7788
+ #
7789
+ # @!attribute [rw] crawler_limits
7790
+ # The configuration of crawl limits for the web URLs.
7791
+ # @return [Types::WebCrawlerLimits]
7792
+ #
7793
+ # @!attribute [rw] exclusion_filters
7794
+ # A list of one or more exclusion regular expression patterns to
7795
+ # exclude certain URLs. If you specify an inclusion and exclusion
7796
+ # filter/pattern and both match a URL, the exclusion filter takes
7797
+ # precedence and the web content of the URL isn’t crawled.
7798
+ # @return [Array<String>]
7799
+ #
7800
+ # @!attribute [rw] inclusion_filters
7801
+ # A list of one or more inclusion regular expression patterns to
7802
+ # include certain URLs. If you specify an inclusion and exclusion
7803
+ # filter/pattern and both match a URL, the exclusion filter takes
7804
+ # precedence and the web content of the URL isn’t crawled.
7805
+ # @return [Array<String>]
7806
+ #
7807
+ # @!attribute [rw] scope
7808
+ # The scope of what is crawled for your URLs.
7809
+ #
7810
+ # You can choose to crawl only web pages that belong to the same host
7811
+ # or primary domain. For example, only web pages that contain the seed
7812
+ # URL "https://docs.aws.amazon.com/bedrock/latest/userguide/" and no
7813
+ # other domains. You can choose to include sub domains in addition to
7814
+ # the host or primary domain. For example, web pages that contain
7815
+ # "aws.amazon.com" can also include sub domain
7816
+ # "docs.aws.amazon.com".
7817
+ # @return [String]
7818
+ #
7819
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/WebCrawlerConfiguration AWS API Documentation
7820
+ #
7821
+ class WebCrawlerConfiguration < Struct.new(
7822
+ :crawler_limits,
7823
+ :exclusion_filters,
7824
+ :inclusion_filters,
7825
+ :scope)
7826
+ SENSITIVE = [:exclusion_filters, :inclusion_filters]
7827
+ include Aws::Structure
7828
+ end
7829
+
7830
+ # The rate limits for the URLs that you want to crawl. You should be
7831
+ # authorized to crawl the URLs.
7832
+ #
7833
+ # @!attribute [rw] rate_limit
7834
+ # The max rate at which pages are crawled, up to 300 per minute per
7835
+ # host.
7836
+ # @return [Integer]
7837
+ #
7838
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/WebCrawlerLimits AWS API Documentation
7839
+ #
7840
+ class WebCrawlerLimits < Struct.new(
7841
+ :rate_limit)
7842
+ SENSITIVE = []
7843
+ include Aws::Structure
7844
+ end
7845
+
7846
+ # The configuration details for the web data source.
7847
+ #
7848
+ # @!attribute [rw] crawler_configuration
7849
+ # The Web Crawler configuration details for the web data source.
7850
+ # @return [Types::WebCrawlerConfiguration]
7851
+ #
7852
+ # @!attribute [rw] source_configuration
7853
+ # The source configuration details for the web data source.
7854
+ # @return [Types::WebSourceConfiguration]
7855
+ #
7856
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/WebDataSourceConfiguration AWS API Documentation
7857
+ #
7858
+ class WebDataSourceConfiguration < Struct.new(
7859
+ :crawler_configuration,
7860
+ :source_configuration)
7861
+ SENSITIVE = []
7862
+ include Aws::Structure
7863
+ end
7864
+
7865
+ # The configuration of the URL/URLs for the web content that you want to
7866
+ # crawl. You should be authorized to crawl the URLs.
7867
+ #
7868
+ # @!attribute [rw] url_configuration
7869
+ # The configuration of the URL/URLs.
7870
+ # @return [Types::UrlConfiguration]
7871
+ #
7872
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/WebSourceConfiguration AWS API Documentation
7873
+ #
7874
+ class WebSourceConfiguration < Struct.new(
7875
+ :url_configuration)
7876
+ SENSITIVE = []
7877
+ include Aws::Structure
7878
+ end
7879
+
4301
7880
  end
4302
7881
  end