aws-sdk-bedrockagent 1.39.0 → 1.41.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagent/client.rb +299 -31
- data/lib/aws-sdk-bedrockagent/client_api.rb +152 -3
- data/lib/aws-sdk-bedrockagent/types.rb +537 -26
- data/lib/aws-sdk-bedrockagent.rb +1 -1
- data/sig/client.rbs +176 -14
- data/sig/types.rbs +135 -6
- metadata +2 -2
@@ -1184,6 +1184,22 @@ module Aws::BedrockAgent
|
|
1184
1184
|
#
|
1185
1185
|
class AutoToolChoice < Aws::EmptyStructure; end
|
1186
1186
|
|
1187
|
+
# Contains configurations for using Amazon Bedrock Data Automation as
|
1188
|
+
# the parser for ingesting your data sources.
|
1189
|
+
#
|
1190
|
+
# @!attribute [rw] parsing_modality
|
1191
|
+
# Specifies whether to enable parsing of multimodal data, including
|
1192
|
+
# both text and/or images.
|
1193
|
+
# @return [String]
|
1194
|
+
#
|
1195
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/BedrockDataAutomationConfiguration AWS API Documentation
|
1196
|
+
#
|
1197
|
+
class BedrockDataAutomationConfiguration < Struct.new(
|
1198
|
+
:parsing_modality)
|
1199
|
+
SENSITIVE = []
|
1200
|
+
include Aws::Structure
|
1201
|
+
end
|
1202
|
+
|
1187
1203
|
# The vector configuration details for the Bedrock embeddings model.
|
1188
1204
|
#
|
1189
1205
|
# @!attribute [rw] dimensions
|
@@ -1221,13 +1237,19 @@ module Aws::BedrockAgent
|
|
1221
1237
|
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html
|
1222
1238
|
#
|
1223
1239
|
# @!attribute [rw] model_arn
|
1224
|
-
# The ARN of the foundation model or [inference profile][1]
|
1240
|
+
# The ARN of the foundation model or [inference profile][1] to use for
|
1241
|
+
# parsing.
|
1225
1242
|
#
|
1226
1243
|
#
|
1227
1244
|
#
|
1228
1245
|
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html
|
1229
1246
|
# @return [String]
|
1230
1247
|
#
|
1248
|
+
# @!attribute [rw] parsing_modality
|
1249
|
+
# Specifies whether to enable parsing of multimodal data, including
|
1250
|
+
# both text and/or images.
|
1251
|
+
# @return [String]
|
1252
|
+
#
|
1231
1253
|
# @!attribute [rw] parsing_prompt
|
1232
1254
|
# Instructions for interpreting the contents of a document.
|
1233
1255
|
# @return [Types::ParsingPrompt]
|
@@ -1236,6 +1258,7 @@ module Aws::BedrockAgent
|
|
1236
1258
|
#
|
1237
1259
|
class BedrockFoundationModelConfiguration < Struct.new(
|
1238
1260
|
:model_arn,
|
1261
|
+
:parsing_modality,
|
1239
1262
|
:parsing_prompt)
|
1240
1263
|
SENSITIVE = []
|
1241
1264
|
include Aws::Structure
|
@@ -2625,6 +2648,27 @@ module Aws::BedrockAgent
|
|
2625
2648
|
include Aws::Structure
|
2626
2649
|
end
|
2627
2650
|
|
2651
|
+
# Contains configurations for a query, each of which defines information
|
2652
|
+
# about example queries to help the query engine generate appropriate
|
2653
|
+
# SQL queries.
|
2654
|
+
#
|
2655
|
+
# @!attribute [rw] natural_language
|
2656
|
+
# An example natural language query.
|
2657
|
+
# @return [String]
|
2658
|
+
#
|
2659
|
+
# @!attribute [rw] sql
|
2660
|
+
# The SQL equivalent of the natural language query.
|
2661
|
+
# @return [String]
|
2662
|
+
#
|
2663
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CuratedQuery AWS API Documentation
|
2664
|
+
#
|
2665
|
+
class CuratedQuery < Struct.new(
|
2666
|
+
:natural_language,
|
2667
|
+
:sql)
|
2668
|
+
SENSITIVE = []
|
2669
|
+
include Aws::Structure
|
2670
|
+
end
|
2671
|
+
|
2628
2672
|
# Contains information about the content to ingest into a knowledge base
|
2629
2673
|
# connected to a custom data source. Choose a `sourceType` and include
|
2630
2674
|
# the field that corresponds to it.
|
@@ -5555,6 +5599,20 @@ module Aws::BedrockAgent
|
|
5555
5599
|
#
|
5556
5600
|
class IteratorFlowNodeConfiguration < Aws::EmptyStructure; end
|
5557
5601
|
|
5602
|
+
# Settings for an Amazon Kendra knowledge base.
|
5603
|
+
#
|
5604
|
+
# @!attribute [rw] kendra_index_arn
|
5605
|
+
# The ARN of the Amazon Kendra index.
|
5606
|
+
# @return [String]
|
5607
|
+
#
|
5608
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KendraKnowledgeBaseConfiguration AWS API Documentation
|
5609
|
+
#
|
5610
|
+
class KendraKnowledgeBaseConfiguration < Struct.new(
|
5611
|
+
:kendra_index_arn)
|
5612
|
+
SENSITIVE = []
|
5613
|
+
include Aws::Structure
|
5614
|
+
end
|
5615
|
+
|
5558
5616
|
# Contains information about a knowledge base.
|
5559
5617
|
#
|
5560
5618
|
# @!attribute [rw] created_at
|
@@ -5637,6 +5695,15 @@ module Aws::BedrockAgent
|
|
5637
5695
|
# Contains details about the vector embeddings configuration of the
|
5638
5696
|
# knowledge base.
|
5639
5697
|
#
|
5698
|
+
# @!attribute [rw] kendra_knowledge_base_configuration
|
5699
|
+
# Settings for an Amazon Kendra knowledge base.
|
5700
|
+
# @return [Types::KendraKnowledgeBaseConfiguration]
|
5701
|
+
#
|
5702
|
+
# @!attribute [rw] sql_knowledge_base_configuration
|
5703
|
+
# Specifies configurations for a knowledge base connected to an SQL
|
5704
|
+
# database.
|
5705
|
+
# @return [Types::SqlKnowledgeBaseConfiguration]
|
5706
|
+
#
|
5640
5707
|
# @!attribute [rw] type
|
5641
5708
|
# The type of data that the data source is converted into for the
|
5642
5709
|
# knowledge base.
|
@@ -5650,6 +5717,8 @@ module Aws::BedrockAgent
|
|
5650
5717
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseConfiguration AWS API Documentation
|
5651
5718
|
#
|
5652
5719
|
class KnowledgeBaseConfiguration < Struct.new(
|
5720
|
+
:kendra_knowledge_base_configuration,
|
5721
|
+
:sql_knowledge_base_configuration,
|
5653
5722
|
:type,
|
5654
5723
|
:vector_knowledge_base_configuration)
|
5655
5724
|
SENSITIVE = []
|
@@ -6652,6 +6721,11 @@ module Aws::BedrockAgent
|
|
6652
6721
|
# The type of memory that is stored.
|
6653
6722
|
# @return [Array<String>]
|
6654
6723
|
#
|
6724
|
+
# @!attribute [rw] session_summary_configuration
|
6725
|
+
# Contains the configuration for SESSION\_SUMMARY memory type enabled
|
6726
|
+
# for the agent.
|
6727
|
+
# @return [Types::SessionSummaryConfiguration]
|
6728
|
+
#
|
6655
6729
|
# @!attribute [rw] storage_days
|
6656
6730
|
# The number of days the agent is configured to retain the
|
6657
6731
|
# conversational context.
|
@@ -6661,6 +6735,7 @@ module Aws::BedrockAgent
|
|
6661
6735
|
#
|
6662
6736
|
class MemoryConfiguration < Struct.new(
|
6663
6737
|
:enabled_memory_types,
|
6738
|
+
:session_summary_configuration,
|
6664
6739
|
:storage_days)
|
6665
6740
|
SENSITIVE = []
|
6666
6741
|
include Aws::Structure
|
@@ -7131,35 +7206,33 @@ module Aws::BedrockAgent
|
|
7131
7206
|
include Aws::Structure
|
7132
7207
|
end
|
7133
7208
|
|
7134
|
-
# Settings for parsing document contents.
|
7135
|
-
# converts the contents of each document into text before
|
7136
|
-
# into chunks.
|
7137
|
-
#
|
7138
|
-
#
|
7139
|
-
#
|
7140
|
-
# To use a model to parse PDF documents, set the parsing strategy to
|
7141
|
-
# `BEDROCK_FOUNDATION_MODEL` and specify the model or [inference
|
7142
|
-
# profile][1] to use by ARN. You can also override the default parsing
|
7143
|
-
# prompt with instructions for how to interpret images and tables in
|
7144
|
-
# your documents. The following models are supported.
|
7209
|
+
# Settings for parsing document contents. If you exclude this field, the
|
7210
|
+
# default parser converts the contents of each document into text before
|
7211
|
+
# splitting it into chunks. Specify the parsing strategy to use in the
|
7212
|
+
# `parsingStrategy` field and include the relevant configuration, or
|
7213
|
+
# omit it to use the Amazon Bedrock default parser. For more
|
7214
|
+
# information, see [Parsing options for your data source][1].
|
7145
7215
|
#
|
7146
|
-
#
|
7147
|
-
#
|
7216
|
+
# <note markdown="1"> If you specify `BEDROCK_DATA_AUTOMATION` or `BEDROCK_FOUNDATION_MODEL`
|
7217
|
+
# and it fails to parse a file, the Amazon Bedrock default parser will
|
7218
|
+
# be used instead.
|
7148
7219
|
#
|
7149
|
-
#
|
7220
|
+
# </note>
|
7150
7221
|
#
|
7151
|
-
# You can get the ARN of a model with the [ListFoundationModels][2]
|
7152
|
-
# action. Standard model usage charges apply for the foundation model
|
7153
|
-
# parsing strategy.
|
7154
7222
|
#
|
7155
7223
|
#
|
7224
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-advanced-parsing.html
|
7156
7225
|
#
|
7157
|
-
# [
|
7158
|
-
#
|
7226
|
+
# @!attribute [rw] bedrock_data_automation_configuration
|
7227
|
+
# If you specify `BEDROCK_DATA_AUTOMATION` as the parsing strategy for
|
7228
|
+
# ingesting your data source, use this object to modify configurations
|
7229
|
+
# for using the Amazon Bedrock Data Automation parser.
|
7230
|
+
# @return [Types::BedrockDataAutomationConfiguration]
|
7159
7231
|
#
|
7160
7232
|
# @!attribute [rw] bedrock_foundation_model_configuration
|
7161
|
-
#
|
7162
|
-
# source
|
7233
|
+
# If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy
|
7234
|
+
# for ingesting your data source, use this object to modify
|
7235
|
+
# configurations for using a foundation model to parse documents.
|
7163
7236
|
# @return [Types::BedrockFoundationModelConfiguration]
|
7164
7237
|
#
|
7165
7238
|
# @!attribute [rw] parsing_strategy
|
@@ -7169,6 +7242,7 @@ module Aws::BedrockAgent
|
|
7169
7242
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ParsingConfiguration AWS API Documentation
|
7170
7243
|
#
|
7171
7244
|
class ParsingConfiguration < Struct.new(
|
7245
|
+
:bedrock_data_automation_configuration,
|
7172
7246
|
:bedrock_foundation_model_configuration,
|
7173
7247
|
:parsing_strategy)
|
7174
7248
|
SENSITIVE = []
|
@@ -7918,6 +7992,117 @@ module Aws::BedrockAgent
|
|
7918
7992
|
include Aws::Structure
|
7919
7993
|
end
|
7920
7994
|
|
7995
|
+
# Contains information about a column in the current table for the query
|
7996
|
+
# engine to consider.
|
7997
|
+
#
|
7998
|
+
# @!attribute [rw] description
|
7999
|
+
# A description of the column that helps the query engine understand
|
8000
|
+
# the contents of the column.
|
8001
|
+
# @return [String]
|
8002
|
+
#
|
8003
|
+
# @!attribute [rw] inclusion
|
8004
|
+
# Specifies whether to include or exclude the column during query
|
8005
|
+
# generation. If you specify `EXCLUDE`, the column will be ignored. If
|
8006
|
+
# you specify `INCLUDE`, all other columns in the table will be
|
8007
|
+
# ignored.
|
8008
|
+
# @return [String]
|
8009
|
+
#
|
8010
|
+
# @!attribute [rw] name
|
8011
|
+
# The name of the column for which the other fields in this object
|
8012
|
+
# apply.
|
8013
|
+
# @return [String]
|
8014
|
+
#
|
8015
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/QueryGenerationColumn AWS API Documentation
|
8016
|
+
#
|
8017
|
+
class QueryGenerationColumn < Struct.new(
|
8018
|
+
:description,
|
8019
|
+
:inclusion,
|
8020
|
+
:name)
|
8021
|
+
SENSITIVE = []
|
8022
|
+
include Aws::Structure
|
8023
|
+
end
|
8024
|
+
|
8025
|
+
# Contains configurations for query generation. For more information,
|
8026
|
+
# see [Build a knowledge base by connecting to a structured data
|
8027
|
+
# source][1] in the Amazon Bedrock User Guide..
|
8028
|
+
#
|
8029
|
+
#
|
8030
|
+
#
|
8031
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html
|
8032
|
+
#
|
8033
|
+
# @!attribute [rw] execution_timeout_seconds
|
8034
|
+
# The time after which query generation will time out.
|
8035
|
+
# @return [Integer]
|
8036
|
+
#
|
8037
|
+
# @!attribute [rw] generation_context
|
8038
|
+
# Specifies configurations for context to use during query generation.
|
8039
|
+
# @return [Types::QueryGenerationContext]
|
8040
|
+
#
|
8041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/QueryGenerationConfiguration AWS API Documentation
|
8042
|
+
#
|
8043
|
+
class QueryGenerationConfiguration < Struct.new(
|
8044
|
+
:execution_timeout_seconds,
|
8045
|
+
:generation_context)
|
8046
|
+
SENSITIVE = [:generation_context]
|
8047
|
+
include Aws::Structure
|
8048
|
+
end
|
8049
|
+
|
8050
|
+
# >Contains configurations for context to use during query
|
8051
|
+
# generation.
|
8052
|
+
#
|
8053
|
+
# @!attribute [rw] curated_queries
|
8054
|
+
# An array of objects, each of which defines information about example
|
8055
|
+
# queries to help the query engine generate appropriate SQL queries.
|
8056
|
+
# @return [Array<Types::CuratedQuery>]
|
8057
|
+
#
|
8058
|
+
# @!attribute [rw] tables
|
8059
|
+
# An array of objects, each of which defines information about a table
|
8060
|
+
# in the database.
|
8061
|
+
# @return [Array<Types::QueryGenerationTable>]
|
8062
|
+
#
|
8063
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/QueryGenerationContext AWS API Documentation
|
8064
|
+
#
|
8065
|
+
class QueryGenerationContext < Struct.new(
|
8066
|
+
:curated_queries,
|
8067
|
+
:tables)
|
8068
|
+
SENSITIVE = []
|
8069
|
+
include Aws::Structure
|
8070
|
+
end
|
8071
|
+
|
8072
|
+
# Contains information about a table for the query engine to consider.
|
8073
|
+
#
|
8074
|
+
# @!attribute [rw] columns
|
8075
|
+
# An array of objects, each of which defines information about a
|
8076
|
+
# column in the table.
|
8077
|
+
# @return [Array<Types::QueryGenerationColumn>]
|
8078
|
+
#
|
8079
|
+
# @!attribute [rw] description
|
8080
|
+
# A description of the table that helps the query engine understand
|
8081
|
+
# the contents of the table.
|
8082
|
+
# @return [String]
|
8083
|
+
#
|
8084
|
+
# @!attribute [rw] inclusion
|
8085
|
+
# Specifies whether to include or exclude the table during query
|
8086
|
+
# generation. If you specify `EXCLUDE`, the table will be ignored. If
|
8087
|
+
# you specify `INCLUDE`, all other tables will be ignored.
|
8088
|
+
# @return [String]
|
8089
|
+
#
|
8090
|
+
# @!attribute [rw] name
|
8091
|
+
# The name of the table for which the other fields in this object
|
8092
|
+
# apply.
|
8093
|
+
# @return [String]
|
8094
|
+
#
|
8095
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/QueryGenerationTable AWS API Documentation
|
8096
|
+
#
|
8097
|
+
class QueryGenerationTable < Struct.new(
|
8098
|
+
:columns,
|
8099
|
+
:description,
|
8100
|
+
:inclusion,
|
8101
|
+
:name)
|
8102
|
+
SENSITIVE = []
|
8103
|
+
include Aws::Structure
|
8104
|
+
end
|
8105
|
+
|
7921
8106
|
# Contains details about the storage configuration of the knowledge base
|
7922
8107
|
# in Amazon RDS. For more information, see [Create a vector index in
|
7923
8108
|
# Amazon RDS][1].
|
@@ -8062,6 +8247,220 @@ module Aws::BedrockAgent
|
|
8062
8247
|
include Aws::Structure
|
8063
8248
|
end
|
8064
8249
|
|
8250
|
+
# Contains configurations for an Amazon Redshift database. For more
|
8251
|
+
# information, see [Build a knowledge base by connecting to a structured
|
8252
|
+
# data source][1] in the Amazon Bedrock User Guide.
|
8253
|
+
#
|
8254
|
+
#
|
8255
|
+
#
|
8256
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html
|
8257
|
+
#
|
8258
|
+
# @!attribute [rw] query_engine_configuration
|
8259
|
+
# Specifies configurations for an Amazon Redshift query engine.
|
8260
|
+
# @return [Types::RedshiftQueryEngineConfiguration]
|
8261
|
+
#
|
8262
|
+
# @!attribute [rw] query_generation_configuration
|
8263
|
+
# Specifies configurations for generating queries.
|
8264
|
+
# @return [Types::QueryGenerationConfiguration]
|
8265
|
+
#
|
8266
|
+
# @!attribute [rw] storage_configurations
|
8267
|
+
# Specifies configurations for Amazon Redshift database storage.
|
8268
|
+
# @return [Array<Types::RedshiftQueryEngineStorageConfiguration>]
|
8269
|
+
#
|
8270
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftConfiguration AWS API Documentation
|
8271
|
+
#
|
8272
|
+
class RedshiftConfiguration < Struct.new(
|
8273
|
+
:query_engine_configuration,
|
8274
|
+
:query_generation_configuration,
|
8275
|
+
:storage_configurations)
|
8276
|
+
SENSITIVE = []
|
8277
|
+
include Aws::Structure
|
8278
|
+
end
|
8279
|
+
|
8280
|
+
# Contains configurations for authentication to an Amazon Redshift
|
8281
|
+
# provisioned data warehouse. Specify the type of authentication to use
|
8282
|
+
# in the `type` field and include the corresponding field. If you
|
8283
|
+
# specify IAM authentication, you don't need to include another field.
|
8284
|
+
#
|
8285
|
+
# @!attribute [rw] database_user
|
8286
|
+
# The database username for authentication to an Amazon Redshift
|
8287
|
+
# provisioned data warehouse.
|
8288
|
+
# @return [String]
|
8289
|
+
#
|
8290
|
+
# @!attribute [rw] type
|
8291
|
+
# The type of authentication to use.
|
8292
|
+
# @return [String]
|
8293
|
+
#
|
8294
|
+
# @!attribute [rw] username_password_secret_arn
|
8295
|
+
# The ARN of an Secrets Manager secret for authentication.
|
8296
|
+
# @return [String]
|
8297
|
+
#
|
8298
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftProvisionedAuthConfiguration AWS API Documentation
|
8299
|
+
#
|
8300
|
+
class RedshiftProvisionedAuthConfiguration < Struct.new(
|
8301
|
+
:database_user,
|
8302
|
+
:type,
|
8303
|
+
:username_password_secret_arn)
|
8304
|
+
SENSITIVE = []
|
8305
|
+
include Aws::Structure
|
8306
|
+
end
|
8307
|
+
|
8308
|
+
# Contains configurations for a provisioned Amazon Redshift query
|
8309
|
+
# engine.
|
8310
|
+
#
|
8311
|
+
# @!attribute [rw] auth_configuration
|
8312
|
+
# Specifies configurations for authentication to Amazon Redshift.
|
8313
|
+
# @return [Types::RedshiftProvisionedAuthConfiguration]
|
8314
|
+
#
|
8315
|
+
# @!attribute [rw] cluster_identifier
|
8316
|
+
# The ID of the Amazon Redshift cluster.
|
8317
|
+
# @return [String]
|
8318
|
+
#
|
8319
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftProvisionedConfiguration AWS API Documentation
|
8320
|
+
#
|
8321
|
+
class RedshiftProvisionedConfiguration < Struct.new(
|
8322
|
+
:auth_configuration,
|
8323
|
+
:cluster_identifier)
|
8324
|
+
SENSITIVE = []
|
8325
|
+
include Aws::Structure
|
8326
|
+
end
|
8327
|
+
|
8328
|
+
# Contains configurations for storage in Glue Data Catalog.
|
8329
|
+
#
|
8330
|
+
# @!attribute [rw] table_names
|
8331
|
+
# A list of names of the tables to use.
|
8332
|
+
# @return [Array<String>]
|
8333
|
+
#
|
8334
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftQueryEngineAwsDataCatalogStorageConfiguration AWS API Documentation
|
8335
|
+
#
|
8336
|
+
class RedshiftQueryEngineAwsDataCatalogStorageConfiguration < Struct.new(
|
8337
|
+
:table_names)
|
8338
|
+
SENSITIVE = []
|
8339
|
+
include Aws::Structure
|
8340
|
+
end
|
8341
|
+
|
8342
|
+
# Contains configurations for an Amazon Redshift query engine. Specify
|
8343
|
+
# the type of query engine in `type` and include the corresponding
|
8344
|
+
# field. For more information, see [Build a knowledge base by connecting
|
8345
|
+
# to a structured data source][1] in the Amazon Bedrock User Guide.
|
8346
|
+
#
|
8347
|
+
#
|
8348
|
+
#
|
8349
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html
|
8350
|
+
#
|
8351
|
+
# @!attribute [rw] provisioned_configuration
|
8352
|
+
# Specifies configurations for a provisioned Amazon Redshift query
|
8353
|
+
# engine.
|
8354
|
+
# @return [Types::RedshiftProvisionedConfiguration]
|
8355
|
+
#
|
8356
|
+
# @!attribute [rw] serverless_configuration
|
8357
|
+
# Specifies configurations for a serverless Amazon Redshift query
|
8358
|
+
# engine.
|
8359
|
+
# @return [Types::RedshiftServerlessConfiguration]
|
8360
|
+
#
|
8361
|
+
# @!attribute [rw] type
|
8362
|
+
# The type of query engine.
|
8363
|
+
# @return [String]
|
8364
|
+
#
|
8365
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftQueryEngineConfiguration AWS API Documentation
|
8366
|
+
#
|
8367
|
+
class RedshiftQueryEngineConfiguration < Struct.new(
|
8368
|
+
:provisioned_configuration,
|
8369
|
+
:serverless_configuration,
|
8370
|
+
:type)
|
8371
|
+
SENSITIVE = []
|
8372
|
+
include Aws::Structure
|
8373
|
+
end
|
8374
|
+
|
8375
|
+
# Contains configurations for storage in Amazon Redshift.
|
8376
|
+
#
|
8377
|
+
# @!attribute [rw] database_name
|
8378
|
+
# The name of the Amazon Redshift database.
|
8379
|
+
# @return [String]
|
8380
|
+
#
|
8381
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftQueryEngineRedshiftStorageConfiguration AWS API Documentation
|
8382
|
+
#
|
8383
|
+
class RedshiftQueryEngineRedshiftStorageConfiguration < Struct.new(
|
8384
|
+
:database_name)
|
8385
|
+
SENSITIVE = []
|
8386
|
+
include Aws::Structure
|
8387
|
+
end
|
8388
|
+
|
8389
|
+
# Contains configurations for Amazon Redshift data storage. Specify the
|
8390
|
+
# data storage service to use in the `type` field and include the
|
8391
|
+
# corresponding field. For more information, see [Build a knowledge base
|
8392
|
+
# by connecting to a structured data source][1] in the Amazon Bedrock
|
8393
|
+
# User Guide.
|
8394
|
+
#
|
8395
|
+
#
|
8396
|
+
#
|
8397
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html
|
8398
|
+
#
|
8399
|
+
# @!attribute [rw] aws_data_catalog_configuration
|
8400
|
+
# Specifies configurations for storage in Glue Data Catalog.
|
8401
|
+
# @return [Types::RedshiftQueryEngineAwsDataCatalogStorageConfiguration]
|
8402
|
+
#
|
8403
|
+
# @!attribute [rw] redshift_configuration
|
8404
|
+
# Specifies configurations for storage in Amazon Redshift.
|
8405
|
+
# @return [Types::RedshiftQueryEngineRedshiftStorageConfiguration]
|
8406
|
+
#
|
8407
|
+
# @!attribute [rw] type
|
8408
|
+
# The data storage service to use.
|
8409
|
+
# @return [String]
|
8410
|
+
#
|
8411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftQueryEngineStorageConfiguration AWS API Documentation
|
8412
|
+
#
|
8413
|
+
class RedshiftQueryEngineStorageConfiguration < Struct.new(
|
8414
|
+
:aws_data_catalog_configuration,
|
8415
|
+
:redshift_configuration,
|
8416
|
+
:type)
|
8417
|
+
SENSITIVE = []
|
8418
|
+
include Aws::Structure
|
8419
|
+
end
|
8420
|
+
|
8421
|
+
# Specifies configurations for authentication to a Redshift Serverless.
|
8422
|
+
# Specify the type of authentication to use in the `type` field and
|
8423
|
+
# include the corresponding field. If you specify IAM authentication,
|
8424
|
+
# you don't need to include another field.
|
8425
|
+
#
|
8426
|
+
# @!attribute [rw] type
|
8427
|
+
# The type of authentication to use.
|
8428
|
+
# @return [String]
|
8429
|
+
#
|
8430
|
+
# @!attribute [rw] username_password_secret_arn
|
8431
|
+
# The ARN of an Secrets Manager secret for authentication.
|
8432
|
+
# @return [String]
|
8433
|
+
#
|
8434
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftServerlessAuthConfiguration AWS API Documentation
|
8435
|
+
#
|
8436
|
+
class RedshiftServerlessAuthConfiguration < Struct.new(
|
8437
|
+
:type,
|
8438
|
+
:username_password_secret_arn)
|
8439
|
+
SENSITIVE = []
|
8440
|
+
include Aws::Structure
|
8441
|
+
end
|
8442
|
+
|
8443
|
+
# Contains configurations for authentication to Amazon Redshift
|
8444
|
+
# Serverless.
|
8445
|
+
#
|
8446
|
+
# @!attribute [rw] auth_configuration
|
8447
|
+
# Specifies configurations for authentication to an Amazon Redshift
|
8448
|
+
# provisioned data warehouse.
|
8449
|
+
# @return [Types::RedshiftServerlessAuthConfiguration]
|
8450
|
+
#
|
8451
|
+
# @!attribute [rw] workgroup_arn
|
8452
|
+
# The ARN of the Amazon Redshift workgroup.
|
8453
|
+
# @return [String]
|
8454
|
+
#
|
8455
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftServerlessConfiguration AWS API Documentation
|
8456
|
+
#
|
8457
|
+
class RedshiftServerlessConfiguration < Struct.new(
|
8458
|
+
:auth_configuration,
|
8459
|
+
:workgroup_arn)
|
8460
|
+
SENSITIVE = []
|
8461
|
+
include Aws::Structure
|
8462
|
+
end
|
8463
|
+
|
8065
8464
|
# The specified resource Amazon Resource Name (ARN) was not found. Check
|
8066
8465
|
# the Amazon Resource Name (ARN) and try your request again.
|
8067
8466
|
#
|
@@ -8370,6 +8769,21 @@ module Aws::BedrockAgent
|
|
8370
8769
|
include Aws::Structure
|
8371
8770
|
end
|
8372
8771
|
|
8772
|
+
# Configuration for SESSION\_SUMMARY memory type enabled for the agent.
|
8773
|
+
#
|
8774
|
+
# @!attribute [rw] max_recent_sessions
|
8775
|
+
# Maximum number of recent session summaries to include in the
|
8776
|
+
# agent's prompt context.
|
8777
|
+
# @return [Integer]
|
8778
|
+
#
|
8779
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SessionSummaryConfiguration AWS API Documentation
|
8780
|
+
#
|
8781
|
+
class SessionSummaryConfiguration < Struct.new(
|
8782
|
+
:max_recent_sessions)
|
8783
|
+
SENSITIVE = []
|
8784
|
+
include Aws::Structure
|
8785
|
+
end
|
8786
|
+
|
8373
8787
|
# The configuration of the SharePoint content. For example, configuring
|
8374
8788
|
# specific types of SharePoint content.
|
8375
8789
|
#
|
@@ -8477,6 +8891,34 @@ module Aws::BedrockAgent
|
|
8477
8891
|
include Aws::Structure
|
8478
8892
|
end
|
8479
8893
|
|
8894
|
+
# Contains configurations for a knowledge base connected to an SQL
|
8895
|
+
# database. Specify the SQL database type in the `type` field and
|
8896
|
+
# include the corresponding field. For more information, see [Build a
|
8897
|
+
# knowledge base by connecting to a structured data source][1] in the
|
8898
|
+
# Amazon Bedrock User Guide.
|
8899
|
+
#
|
8900
|
+
#
|
8901
|
+
#
|
8902
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html
|
8903
|
+
#
|
8904
|
+
# @!attribute [rw] redshift_configuration
|
8905
|
+
# Specifies configurations for a knowledge base connected to an Amazon
|
8906
|
+
# Redshift database.
|
8907
|
+
# @return [Types::RedshiftConfiguration]
|
8908
|
+
#
|
8909
|
+
# @!attribute [rw] type
|
8910
|
+
# The type of SQL database to connect to the knowledge base.
|
8911
|
+
# @return [String]
|
8912
|
+
#
|
8913
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SqlKnowledgeBaseConfiguration AWS API Documentation
|
8914
|
+
#
|
8915
|
+
class SqlKnowledgeBaseConfiguration < Struct.new(
|
8916
|
+
:redshift_configuration,
|
8917
|
+
:type)
|
8918
|
+
SENSITIVE = []
|
8919
|
+
include Aws::Structure
|
8920
|
+
end
|
8921
|
+
|
8480
8922
|
# @!attribute [rw] client_token
|
8481
8923
|
# A unique, case-sensitive identifier to ensure that the API request
|
8482
8924
|
# completes no more than one time. If this token matches a previous
|
@@ -8670,6 +9112,44 @@ module Aws::BedrockAgent
|
|
8670
9112
|
class Unknown < StorageFlowNodeServiceConfiguration; end
|
8671
9113
|
end
|
8672
9114
|
|
9115
|
+
# Specifies configurations for the storage location of the images
|
9116
|
+
# extracted from multimodal documents in your data source. These images
|
9117
|
+
# can be retrieved and returned to the end user.
|
9118
|
+
#
|
9119
|
+
# @!attribute [rw] storage_locations
|
9120
|
+
# A list of objects specifying storage locations for images extracted
|
9121
|
+
# from multimodal documents in your data source.
|
9122
|
+
# @return [Array<Types::SupplementalDataStorageLocation>]
|
9123
|
+
#
|
9124
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SupplementalDataStorageConfiguration AWS API Documentation
|
9125
|
+
#
|
9126
|
+
class SupplementalDataStorageConfiguration < Struct.new(
|
9127
|
+
:storage_locations)
|
9128
|
+
SENSITIVE = []
|
9129
|
+
include Aws::Structure
|
9130
|
+
end
|
9131
|
+
|
9132
|
+
# Contains information about a storage location for images extracted
|
9133
|
+
# from multimodal documents in your data source.
|
9134
|
+
#
|
9135
|
+
# @!attribute [rw] s3_location
|
9136
|
+
# Contains information about the Amazon S3 location for the extracted
|
9137
|
+
# images.
|
9138
|
+
# @return [Types::S3Location]
|
9139
|
+
#
|
9140
|
+
# @!attribute [rw] type
|
9141
|
+
# Specifies the storage service used for this location.
|
9142
|
+
# @return [String]
|
9143
|
+
#
|
9144
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SupplementalDataStorageLocation AWS API Documentation
|
9145
|
+
#
|
9146
|
+
class SupplementalDataStorageLocation < Struct.new(
|
9147
|
+
:s3_location,
|
9148
|
+
:type)
|
9149
|
+
SENSITIVE = []
|
9150
|
+
include Aws::Structure
|
9151
|
+
end
|
9152
|
+
|
8673
9153
|
# Contains a system prompt to provide context to the model or to
|
8674
9154
|
# describe how it should behave. For more information, see [Create a
|
8675
9155
|
# prompt using Prompt management][1].
|
@@ -10028,7 +10508,9 @@ module Aws::BedrockAgent
|
|
10028
10508
|
# @return [Types::CustomTransformationConfiguration]
|
10029
10509
|
#
|
10030
10510
|
# @!attribute [rw] parsing_configuration
|
10031
|
-
#
|
10511
|
+
# Configurations for a parser to use for parsing documents in your
|
10512
|
+
# data source. If you exclude this field, the default parser will be
|
10513
|
+
# used.
|
10032
10514
|
# @return [Types::ParsingConfiguration]
|
10033
10515
|
#
|
10034
10516
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorIngestionConfiguration AWS API Documentation
|
@@ -10054,11 +10536,24 @@ module Aws::BedrockAgent
|
|
10054
10536
|
# in Knowledge Base.
|
10055
10537
|
# @return [Types::EmbeddingModelConfiguration]
|
10056
10538
|
#
|
10539
|
+
# @!attribute [rw] supplemental_data_storage_configuration
|
10540
|
+
# If you include multimodal data from your data source, use this
|
10541
|
+
# object to specify configurations for the storage location of the
|
10542
|
+
# images extracted from your documents. These images can be retrieved
|
10543
|
+
# and returned to the end user. They can also be used in generation
|
10544
|
+
# when using [RetrieveAndGenerate][1].
|
10545
|
+
#
|
10546
|
+
#
|
10547
|
+
#
|
10548
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html
|
10549
|
+
# @return [Types::SupplementalDataStorageConfiguration]
|
10550
|
+
#
|
10057
10551
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorKnowledgeBaseConfiguration AWS API Documentation
|
10058
10552
|
#
|
10059
10553
|
class VectorKnowledgeBaseConfiguration < Struct.new(
|
10060
10554
|
:embedding_model_arn,
|
10061
|
-
:embedding_model_configuration
|
10555
|
+
:embedding_model_configuration,
|
10556
|
+
:supplemental_data_storage_configuration)
|
10062
10557
|
SENSITIVE = []
|
10063
10558
|
include Aws::Structure
|
10064
10559
|
end
|
@@ -10096,20 +10591,35 @@ module Aws::BedrockAgent
|
|
10096
10591
|
# "docs.aws.amazon.com".
|
10097
10592
|
# @return [String]
|
10098
10593
|
#
|
10594
|
+
# @!attribute [rw] user_agent
|
10595
|
+
# A string used for identifying the crawler or a bot when it accesses
|
10596
|
+
# a web server. By default, this is set to `bedrockbot_UUID` for your
|
10597
|
+
# crawler. You can optionally append a custom string to
|
10598
|
+
# `bedrockbot_UUID` to allowlist a specific user agent permitted to
|
10599
|
+
# access your source URLs.
|
10600
|
+
# @return [String]
|
10601
|
+
#
|
10099
10602
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/WebCrawlerConfiguration AWS API Documentation
|
10100
10603
|
#
|
10101
10604
|
class WebCrawlerConfiguration < Struct.new(
|
10102
10605
|
:crawler_limits,
|
10103
10606
|
:exclusion_filters,
|
10104
10607
|
:inclusion_filters,
|
10105
|
-
:scope
|
10106
|
-
|
10608
|
+
:scope,
|
10609
|
+
:user_agent)
|
10610
|
+
SENSITIVE = [:exclusion_filters, :inclusion_filters, :user_agent]
|
10107
10611
|
include Aws::Structure
|
10108
10612
|
end
|
10109
10613
|
|
10110
10614
|
# The rate limits for the URLs that you want to crawl. You should be
|
10111
10615
|
# authorized to crawl the URLs.
|
10112
10616
|
#
|
10617
|
+
# @!attribute [rw] max_pages
|
10618
|
+
# The max number of web pages crawled from your source URLs, up to
|
10619
|
+
# 25,000 pages. If the web pages exceed this limit, the data source
|
10620
|
+
# sync will fail and no web pages will be ingested.
|
10621
|
+
# @return [Integer]
|
10622
|
+
#
|
10113
10623
|
# @!attribute [rw] rate_limit
|
10114
10624
|
# The max rate at which pages are crawled, up to 300 per minute per
|
10115
10625
|
# host.
|
@@ -10118,6 +10628,7 @@ module Aws::BedrockAgent
|
|
10118
10628
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/WebCrawlerLimits AWS API Documentation
|
10119
10629
|
#
|
10120
10630
|
class WebCrawlerLimits < Struct.new(
|
10631
|
+
:max_pages,
|
10121
10632
|
:rate_limit)
|
10122
10633
|
SENSITIVE = []
|
10123
10634
|
include Aws::Structure
|