aws-sdk-bedrockagent 1.39.0 → 1.40.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagent/client.rb +268 -20
- data/lib/aws-sdk-bedrockagent/client_api.rb +142 -3
- data/lib/aws-sdk-bedrockagent/types.rb +498 -24
- data/lib/aws-sdk-bedrockagent.rb +1 -1
- data/sig/client.rbs +160 -8
- data/sig/types.rbs +124 -3
- 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 = []
|
@@ -7131,35 +7200,33 @@ module Aws::BedrockAgent
|
|
7131
7200
|
include Aws::Structure
|
7132
7201
|
end
|
7133
7202
|
|
7134
|
-
# Settings for parsing document contents.
|
7135
|
-
# converts the contents of each document into text before
|
7136
|
-
# into chunks.
|
7137
|
-
#
|
7138
|
-
#
|
7203
|
+
# Settings for parsing document contents. If you exclude this field, the
|
7204
|
+
# default parser converts the contents of each document into text before
|
7205
|
+
# splitting it into chunks. Specify the parsing strategy to use in the
|
7206
|
+
# `parsingStrategy` field and include the relevant configuration, or
|
7207
|
+
# omit it to use the Amazon Bedrock default parser. For more
|
7208
|
+
# information, see [Parsing options for your data source][1].
|
7139
7209
|
#
|
7140
|
-
#
|
7141
|
-
#
|
7142
|
-
#
|
7143
|
-
# prompt with instructions for how to interpret images and tables in
|
7144
|
-
# your documents. The following models are supported.
|
7210
|
+
# <note markdown="1"> If you specify `BEDROCK_DATA_AUTOMATION` or `BEDROCK_FOUNDATION_MODEL`
|
7211
|
+
# and it fails to parse a file, the Amazon Bedrock default parser will
|
7212
|
+
# be used instead.
|
7145
7213
|
#
|
7146
|
-
#
|
7147
|
-
# `anthropic.claude-3-sonnet-20240229-v1:0`
|
7214
|
+
# </note>
|
7148
7215
|
#
|
7149
|
-
# * Anthropic Claude 3 Haiku - `anthropic.claude-3-haiku-20240307-v1:0`
|
7150
7216
|
#
|
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
7217
|
#
|
7218
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-advanced-parsing.html
|
7155
7219
|
#
|
7156
|
-
#
|
7157
|
-
#
|
7158
|
-
#
|
7220
|
+
# @!attribute [rw] bedrock_data_automation_configuration
|
7221
|
+
# If you specify `BEDROCK_DATA_AUTOMATION` as the parsing strategy for
|
7222
|
+
# ingesting your data source, use this object to modify configurations
|
7223
|
+
# for using the Amazon Bedrock Data Automation parser.
|
7224
|
+
# @return [Types::BedrockDataAutomationConfiguration]
|
7159
7225
|
#
|
7160
7226
|
# @!attribute [rw] bedrock_foundation_model_configuration
|
7161
|
-
#
|
7162
|
-
# source
|
7227
|
+
# If you specify `BEDROCK_FOUNDATION_MODEL` as the parsing strategy
|
7228
|
+
# for ingesting your data source, use this object to modify
|
7229
|
+
# configurations for using a foundation model to parse documents.
|
7163
7230
|
# @return [Types::BedrockFoundationModelConfiguration]
|
7164
7231
|
#
|
7165
7232
|
# @!attribute [rw] parsing_strategy
|
@@ -7169,6 +7236,7 @@ module Aws::BedrockAgent
|
|
7169
7236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ParsingConfiguration AWS API Documentation
|
7170
7237
|
#
|
7171
7238
|
class ParsingConfiguration < Struct.new(
|
7239
|
+
:bedrock_data_automation_configuration,
|
7172
7240
|
:bedrock_foundation_model_configuration,
|
7173
7241
|
:parsing_strategy)
|
7174
7242
|
SENSITIVE = []
|
@@ -7918,6 +7986,117 @@ module Aws::BedrockAgent
|
|
7918
7986
|
include Aws::Structure
|
7919
7987
|
end
|
7920
7988
|
|
7989
|
+
# Contains information about a column in the current table for the query
|
7990
|
+
# engine to consider.
|
7991
|
+
#
|
7992
|
+
# @!attribute [rw] description
|
7993
|
+
# A description of the column that helps the query engine understand
|
7994
|
+
# the contents of the column.
|
7995
|
+
# @return [String]
|
7996
|
+
#
|
7997
|
+
# @!attribute [rw] inclusion
|
7998
|
+
# Specifies whether to include or exclude the column during query
|
7999
|
+
# generation. If you specify `EXCLUDE`, the column will be ignored. If
|
8000
|
+
# you specify `INCLUDE`, all other columns in the table will be
|
8001
|
+
# ignored.
|
8002
|
+
# @return [String]
|
8003
|
+
#
|
8004
|
+
# @!attribute [rw] name
|
8005
|
+
# The name of the column for which the other fields in this object
|
8006
|
+
# apply.
|
8007
|
+
# @return [String]
|
8008
|
+
#
|
8009
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/QueryGenerationColumn AWS API Documentation
|
8010
|
+
#
|
8011
|
+
class QueryGenerationColumn < Struct.new(
|
8012
|
+
:description,
|
8013
|
+
:inclusion,
|
8014
|
+
:name)
|
8015
|
+
SENSITIVE = []
|
8016
|
+
include Aws::Structure
|
8017
|
+
end
|
8018
|
+
|
8019
|
+
# Contains configurations for query generation. For more information,
|
8020
|
+
# see [Build a knowledge base by connecting to a structured data
|
8021
|
+
# source][1] in the Amazon Bedrock User Guide..
|
8022
|
+
#
|
8023
|
+
#
|
8024
|
+
#
|
8025
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html
|
8026
|
+
#
|
8027
|
+
# @!attribute [rw] execution_timeout_seconds
|
8028
|
+
# The time after which query generation will time out.
|
8029
|
+
# @return [Integer]
|
8030
|
+
#
|
8031
|
+
# @!attribute [rw] generation_context
|
8032
|
+
# Specifies configurations for context to use during query generation.
|
8033
|
+
# @return [Types::QueryGenerationContext]
|
8034
|
+
#
|
8035
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/QueryGenerationConfiguration AWS API Documentation
|
8036
|
+
#
|
8037
|
+
class QueryGenerationConfiguration < Struct.new(
|
8038
|
+
:execution_timeout_seconds,
|
8039
|
+
:generation_context)
|
8040
|
+
SENSITIVE = [:generation_context]
|
8041
|
+
include Aws::Structure
|
8042
|
+
end
|
8043
|
+
|
8044
|
+
# >Contains configurations for context to use during query
|
8045
|
+
# generation.
|
8046
|
+
#
|
8047
|
+
# @!attribute [rw] curated_queries
|
8048
|
+
# An array of objects, each of which defines information about example
|
8049
|
+
# queries to help the query engine generate appropriate SQL queries.
|
8050
|
+
# @return [Array<Types::CuratedQuery>]
|
8051
|
+
#
|
8052
|
+
# @!attribute [rw] tables
|
8053
|
+
# An array of objects, each of which defines information about a table
|
8054
|
+
# in the database.
|
8055
|
+
# @return [Array<Types::QueryGenerationTable>]
|
8056
|
+
#
|
8057
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/QueryGenerationContext AWS API Documentation
|
8058
|
+
#
|
8059
|
+
class QueryGenerationContext < Struct.new(
|
8060
|
+
:curated_queries,
|
8061
|
+
:tables)
|
8062
|
+
SENSITIVE = []
|
8063
|
+
include Aws::Structure
|
8064
|
+
end
|
8065
|
+
|
8066
|
+
# Contains information about a table for the query engine to consider.
|
8067
|
+
#
|
8068
|
+
# @!attribute [rw] columns
|
8069
|
+
# An array of objects, each of which defines information about a
|
8070
|
+
# column in the table.
|
8071
|
+
# @return [Array<Types::QueryGenerationColumn>]
|
8072
|
+
#
|
8073
|
+
# @!attribute [rw] description
|
8074
|
+
# A description of the table that helps the query engine understand
|
8075
|
+
# the contents of the table.
|
8076
|
+
# @return [String]
|
8077
|
+
#
|
8078
|
+
# @!attribute [rw] inclusion
|
8079
|
+
# Specifies whether to include or exclude the table during query
|
8080
|
+
# generation. If you specify `EXCLUDE`, the table will be ignored. If
|
8081
|
+
# you specify `INCLUDE`, all other tables will be ignored.
|
8082
|
+
# @return [String]
|
8083
|
+
#
|
8084
|
+
# @!attribute [rw] name
|
8085
|
+
# The name of the table for which the other fields in this object
|
8086
|
+
# apply.
|
8087
|
+
# @return [String]
|
8088
|
+
#
|
8089
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/QueryGenerationTable AWS API Documentation
|
8090
|
+
#
|
8091
|
+
class QueryGenerationTable < Struct.new(
|
8092
|
+
:columns,
|
8093
|
+
:description,
|
8094
|
+
:inclusion,
|
8095
|
+
:name)
|
8096
|
+
SENSITIVE = []
|
8097
|
+
include Aws::Structure
|
8098
|
+
end
|
8099
|
+
|
7921
8100
|
# Contains details about the storage configuration of the knowledge base
|
7922
8101
|
# in Amazon RDS. For more information, see [Create a vector index in
|
7923
8102
|
# Amazon RDS][1].
|
@@ -8062,6 +8241,220 @@ module Aws::BedrockAgent
|
|
8062
8241
|
include Aws::Structure
|
8063
8242
|
end
|
8064
8243
|
|
8244
|
+
# Contains configurations for an Amazon Redshift database. For more
|
8245
|
+
# information, see [Build a knowledge base by connecting to a structured
|
8246
|
+
# data source][1] in the Amazon Bedrock User Guide.
|
8247
|
+
#
|
8248
|
+
#
|
8249
|
+
#
|
8250
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html
|
8251
|
+
#
|
8252
|
+
# @!attribute [rw] query_engine_configuration
|
8253
|
+
# Specifies configurations for an Amazon Redshift query engine.
|
8254
|
+
# @return [Types::RedshiftQueryEngineConfiguration]
|
8255
|
+
#
|
8256
|
+
# @!attribute [rw] query_generation_configuration
|
8257
|
+
# Specifies configurations for generating queries.
|
8258
|
+
# @return [Types::QueryGenerationConfiguration]
|
8259
|
+
#
|
8260
|
+
# @!attribute [rw] storage_configurations
|
8261
|
+
# Specifies configurations for Amazon Redshift database storage.
|
8262
|
+
# @return [Array<Types::RedshiftQueryEngineStorageConfiguration>]
|
8263
|
+
#
|
8264
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftConfiguration AWS API Documentation
|
8265
|
+
#
|
8266
|
+
class RedshiftConfiguration < Struct.new(
|
8267
|
+
:query_engine_configuration,
|
8268
|
+
:query_generation_configuration,
|
8269
|
+
:storage_configurations)
|
8270
|
+
SENSITIVE = []
|
8271
|
+
include Aws::Structure
|
8272
|
+
end
|
8273
|
+
|
8274
|
+
# Contains configurations for authentication to an Amazon Redshift
|
8275
|
+
# provisioned data warehouse. Specify the type of authentication to use
|
8276
|
+
# in the `type` field and include the corresponding field. If you
|
8277
|
+
# specify IAM authentication, you don't need to include another field.
|
8278
|
+
#
|
8279
|
+
# @!attribute [rw] database_user
|
8280
|
+
# The database username for authentication to an Amazon Redshift
|
8281
|
+
# provisioned data warehouse.
|
8282
|
+
# @return [String]
|
8283
|
+
#
|
8284
|
+
# @!attribute [rw] type
|
8285
|
+
# The type of authentication to use.
|
8286
|
+
# @return [String]
|
8287
|
+
#
|
8288
|
+
# @!attribute [rw] username_password_secret_arn
|
8289
|
+
# The ARN of an Secrets Manager secret for authentication.
|
8290
|
+
# @return [String]
|
8291
|
+
#
|
8292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftProvisionedAuthConfiguration AWS API Documentation
|
8293
|
+
#
|
8294
|
+
class RedshiftProvisionedAuthConfiguration < Struct.new(
|
8295
|
+
:database_user,
|
8296
|
+
:type,
|
8297
|
+
:username_password_secret_arn)
|
8298
|
+
SENSITIVE = []
|
8299
|
+
include Aws::Structure
|
8300
|
+
end
|
8301
|
+
|
8302
|
+
# Contains configurations for a provisioned Amazon Redshift query
|
8303
|
+
# engine.
|
8304
|
+
#
|
8305
|
+
# @!attribute [rw] auth_configuration
|
8306
|
+
# Specifies configurations for authentication to Amazon Redshift.
|
8307
|
+
# @return [Types::RedshiftProvisionedAuthConfiguration]
|
8308
|
+
#
|
8309
|
+
# @!attribute [rw] cluster_identifier
|
8310
|
+
# The ID of the Amazon Redshift cluster.
|
8311
|
+
# @return [String]
|
8312
|
+
#
|
8313
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftProvisionedConfiguration AWS API Documentation
|
8314
|
+
#
|
8315
|
+
class RedshiftProvisionedConfiguration < Struct.new(
|
8316
|
+
:auth_configuration,
|
8317
|
+
:cluster_identifier)
|
8318
|
+
SENSITIVE = []
|
8319
|
+
include Aws::Structure
|
8320
|
+
end
|
8321
|
+
|
8322
|
+
# Contains configurations for storage in Glue Data Catalog.
|
8323
|
+
#
|
8324
|
+
# @!attribute [rw] table_names
|
8325
|
+
# A list of names of the tables to use.
|
8326
|
+
# @return [Array<String>]
|
8327
|
+
#
|
8328
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftQueryEngineAwsDataCatalogStorageConfiguration AWS API Documentation
|
8329
|
+
#
|
8330
|
+
class RedshiftQueryEngineAwsDataCatalogStorageConfiguration < Struct.new(
|
8331
|
+
:table_names)
|
8332
|
+
SENSITIVE = []
|
8333
|
+
include Aws::Structure
|
8334
|
+
end
|
8335
|
+
|
8336
|
+
# Contains configurations for an Amazon Redshift query engine. Specify
|
8337
|
+
# the type of query engine in `type` and include the corresponding
|
8338
|
+
# field. For more information, see [Build a knowledge base by connecting
|
8339
|
+
# to a structured data source][1] in the Amazon Bedrock User Guide.
|
8340
|
+
#
|
8341
|
+
#
|
8342
|
+
#
|
8343
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html
|
8344
|
+
#
|
8345
|
+
# @!attribute [rw] provisioned_configuration
|
8346
|
+
# Specifies configurations for a provisioned Amazon Redshift query
|
8347
|
+
# engine.
|
8348
|
+
# @return [Types::RedshiftProvisionedConfiguration]
|
8349
|
+
#
|
8350
|
+
# @!attribute [rw] serverless_configuration
|
8351
|
+
# Specifies configurations for a serverless Amazon Redshift query
|
8352
|
+
# engine.
|
8353
|
+
# @return [Types::RedshiftServerlessConfiguration]
|
8354
|
+
#
|
8355
|
+
# @!attribute [rw] type
|
8356
|
+
# The type of query engine.
|
8357
|
+
# @return [String]
|
8358
|
+
#
|
8359
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftQueryEngineConfiguration AWS API Documentation
|
8360
|
+
#
|
8361
|
+
class RedshiftQueryEngineConfiguration < Struct.new(
|
8362
|
+
:provisioned_configuration,
|
8363
|
+
:serverless_configuration,
|
8364
|
+
:type)
|
8365
|
+
SENSITIVE = []
|
8366
|
+
include Aws::Structure
|
8367
|
+
end
|
8368
|
+
|
8369
|
+
# Contains configurations for storage in Amazon Redshift.
|
8370
|
+
#
|
8371
|
+
# @!attribute [rw] database_name
|
8372
|
+
# The name of the Amazon Redshift database.
|
8373
|
+
# @return [String]
|
8374
|
+
#
|
8375
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftQueryEngineRedshiftStorageConfiguration AWS API Documentation
|
8376
|
+
#
|
8377
|
+
class RedshiftQueryEngineRedshiftStorageConfiguration < Struct.new(
|
8378
|
+
:database_name)
|
8379
|
+
SENSITIVE = []
|
8380
|
+
include Aws::Structure
|
8381
|
+
end
|
8382
|
+
|
8383
|
+
# Contains configurations for Amazon Redshift data storage. Specify the
|
8384
|
+
# data storage service to use in the `type` field and include the
|
8385
|
+
# corresponding field. For more information, see [Build a knowledge base
|
8386
|
+
# by connecting to a structured data source][1] in the Amazon Bedrock
|
8387
|
+
# User Guide.
|
8388
|
+
#
|
8389
|
+
#
|
8390
|
+
#
|
8391
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html
|
8392
|
+
#
|
8393
|
+
# @!attribute [rw] aws_data_catalog_configuration
|
8394
|
+
# Specifies configurations for storage in Glue Data Catalog.
|
8395
|
+
# @return [Types::RedshiftQueryEngineAwsDataCatalogStorageConfiguration]
|
8396
|
+
#
|
8397
|
+
# @!attribute [rw] redshift_configuration
|
8398
|
+
# Specifies configurations for storage in Amazon Redshift.
|
8399
|
+
# @return [Types::RedshiftQueryEngineRedshiftStorageConfiguration]
|
8400
|
+
#
|
8401
|
+
# @!attribute [rw] type
|
8402
|
+
# The data storage service to use.
|
8403
|
+
# @return [String]
|
8404
|
+
#
|
8405
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftQueryEngineStorageConfiguration AWS API Documentation
|
8406
|
+
#
|
8407
|
+
class RedshiftQueryEngineStorageConfiguration < Struct.new(
|
8408
|
+
:aws_data_catalog_configuration,
|
8409
|
+
:redshift_configuration,
|
8410
|
+
:type)
|
8411
|
+
SENSITIVE = []
|
8412
|
+
include Aws::Structure
|
8413
|
+
end
|
8414
|
+
|
8415
|
+
# Specifies configurations for authentication to a Redshift Serverless.
|
8416
|
+
# Specify the type of authentication to use in the `type` field and
|
8417
|
+
# include the corresponding field. If you specify IAM authentication,
|
8418
|
+
# you don't need to include another field.
|
8419
|
+
#
|
8420
|
+
# @!attribute [rw] type
|
8421
|
+
# The type of authentication to use.
|
8422
|
+
# @return [String]
|
8423
|
+
#
|
8424
|
+
# @!attribute [rw] username_password_secret_arn
|
8425
|
+
# The ARN of an Secrets Manager secret for authentication.
|
8426
|
+
# @return [String]
|
8427
|
+
#
|
8428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftServerlessAuthConfiguration AWS API Documentation
|
8429
|
+
#
|
8430
|
+
class RedshiftServerlessAuthConfiguration < Struct.new(
|
8431
|
+
:type,
|
8432
|
+
:username_password_secret_arn)
|
8433
|
+
SENSITIVE = []
|
8434
|
+
include Aws::Structure
|
8435
|
+
end
|
8436
|
+
|
8437
|
+
# Contains configurations for authentication to Amazon Redshift
|
8438
|
+
# Serverless.
|
8439
|
+
#
|
8440
|
+
# @!attribute [rw] auth_configuration
|
8441
|
+
# Specifies configurations for authentication to an Amazon Redshift
|
8442
|
+
# provisioned data warehouse.
|
8443
|
+
# @return [Types::RedshiftServerlessAuthConfiguration]
|
8444
|
+
#
|
8445
|
+
# @!attribute [rw] workgroup_arn
|
8446
|
+
# The ARN of the Amazon Redshift workgroup.
|
8447
|
+
# @return [String]
|
8448
|
+
#
|
8449
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/RedshiftServerlessConfiguration AWS API Documentation
|
8450
|
+
#
|
8451
|
+
class RedshiftServerlessConfiguration < Struct.new(
|
8452
|
+
:auth_configuration,
|
8453
|
+
:workgroup_arn)
|
8454
|
+
SENSITIVE = []
|
8455
|
+
include Aws::Structure
|
8456
|
+
end
|
8457
|
+
|
8065
8458
|
# The specified resource Amazon Resource Name (ARN) was not found. Check
|
8066
8459
|
# the Amazon Resource Name (ARN) and try your request again.
|
8067
8460
|
#
|
@@ -8477,6 +8870,34 @@ module Aws::BedrockAgent
|
|
8477
8870
|
include Aws::Structure
|
8478
8871
|
end
|
8479
8872
|
|
8873
|
+
# Contains configurations for a knowledge base connected to an SQL
|
8874
|
+
# database. Specify the SQL database type in the `type` field and
|
8875
|
+
# include the corresponding field. For more information, see [Build a
|
8876
|
+
# knowledge base by connecting to a structured data source][1] in the
|
8877
|
+
# Amazon Bedrock User Guide.
|
8878
|
+
#
|
8879
|
+
#
|
8880
|
+
#
|
8881
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-build-structured.html
|
8882
|
+
#
|
8883
|
+
# @!attribute [rw] redshift_configuration
|
8884
|
+
# Specifies configurations for a knowledge base connected to an Amazon
|
8885
|
+
# Redshift database.
|
8886
|
+
# @return [Types::RedshiftConfiguration]
|
8887
|
+
#
|
8888
|
+
# @!attribute [rw] type
|
8889
|
+
# The type of SQL database to connect to the knowledge base.
|
8890
|
+
# @return [String]
|
8891
|
+
#
|
8892
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SqlKnowledgeBaseConfiguration AWS API Documentation
|
8893
|
+
#
|
8894
|
+
class SqlKnowledgeBaseConfiguration < Struct.new(
|
8895
|
+
:redshift_configuration,
|
8896
|
+
:type)
|
8897
|
+
SENSITIVE = []
|
8898
|
+
include Aws::Structure
|
8899
|
+
end
|
8900
|
+
|
8480
8901
|
# @!attribute [rw] client_token
|
8481
8902
|
# A unique, case-sensitive identifier to ensure that the API request
|
8482
8903
|
# completes no more than one time. If this token matches a previous
|
@@ -8670,6 +9091,44 @@ module Aws::BedrockAgent
|
|
8670
9091
|
class Unknown < StorageFlowNodeServiceConfiguration; end
|
8671
9092
|
end
|
8672
9093
|
|
9094
|
+
# Specifies configurations for the storage location of the images
|
9095
|
+
# extracted from multimodal documents in your data source. These images
|
9096
|
+
# can be retrieved and returned to the end user.
|
9097
|
+
#
|
9098
|
+
# @!attribute [rw] storage_locations
|
9099
|
+
# A list of objects specifying storage locations for images extracted
|
9100
|
+
# from multimodal documents in your data source.
|
9101
|
+
# @return [Array<Types::SupplementalDataStorageLocation>]
|
9102
|
+
#
|
9103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SupplementalDataStorageConfiguration AWS API Documentation
|
9104
|
+
#
|
9105
|
+
class SupplementalDataStorageConfiguration < Struct.new(
|
9106
|
+
:storage_locations)
|
9107
|
+
SENSITIVE = []
|
9108
|
+
include Aws::Structure
|
9109
|
+
end
|
9110
|
+
|
9111
|
+
# Contains information about a storage location for images extracted
|
9112
|
+
# from multimodal documents in your data source.
|
9113
|
+
#
|
9114
|
+
# @!attribute [rw] s3_location
|
9115
|
+
# Contains information about the Amazon S3 location for the extracted
|
9116
|
+
# images.
|
9117
|
+
# @return [Types::S3Location]
|
9118
|
+
#
|
9119
|
+
# @!attribute [rw] type
|
9120
|
+
# Specifies the storage service used for this location.
|
9121
|
+
# @return [String]
|
9122
|
+
#
|
9123
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/SupplementalDataStorageLocation AWS API Documentation
|
9124
|
+
#
|
9125
|
+
class SupplementalDataStorageLocation < Struct.new(
|
9126
|
+
:s3_location,
|
9127
|
+
:type)
|
9128
|
+
SENSITIVE = []
|
9129
|
+
include Aws::Structure
|
9130
|
+
end
|
9131
|
+
|
8673
9132
|
# Contains a system prompt to provide context to the model or to
|
8674
9133
|
# describe how it should behave. For more information, see [Create a
|
8675
9134
|
# prompt using Prompt management][1].
|
@@ -10028,7 +10487,9 @@ module Aws::BedrockAgent
|
|
10028
10487
|
# @return [Types::CustomTransformationConfiguration]
|
10029
10488
|
#
|
10030
10489
|
# @!attribute [rw] parsing_configuration
|
10031
|
-
#
|
10490
|
+
# Configurations for a parser to use for parsing documents in your
|
10491
|
+
# data source. If you exclude this field, the default parser will be
|
10492
|
+
# used.
|
10032
10493
|
# @return [Types::ParsingConfiguration]
|
10033
10494
|
#
|
10034
10495
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorIngestionConfiguration AWS API Documentation
|
@@ -10054,11 +10515,24 @@ module Aws::BedrockAgent
|
|
10054
10515
|
# in Knowledge Base.
|
10055
10516
|
# @return [Types::EmbeddingModelConfiguration]
|
10056
10517
|
#
|
10518
|
+
# @!attribute [rw] supplemental_data_storage_configuration
|
10519
|
+
# If you include multimodal data from your data source, use this
|
10520
|
+
# object to specify configurations for the storage location of the
|
10521
|
+
# images extracted from your documents. These images can be retrieved
|
10522
|
+
# and returned to the end user. They can also be used in generation
|
10523
|
+
# when using [RetrieveAndGenerate][1].
|
10524
|
+
#
|
10525
|
+
#
|
10526
|
+
#
|
10527
|
+
# [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html
|
10528
|
+
# @return [Types::SupplementalDataStorageConfiguration]
|
10529
|
+
#
|
10057
10530
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/VectorKnowledgeBaseConfiguration AWS API Documentation
|
10058
10531
|
#
|
10059
10532
|
class VectorKnowledgeBaseConfiguration < Struct.new(
|
10060
10533
|
:embedding_model_arn,
|
10061
|
-
:embedding_model_configuration
|
10534
|
+
:embedding_model_configuration,
|
10535
|
+
:supplemental_data_storage_configuration)
|
10062
10536
|
SENSITIVE = []
|
10063
10537
|
include Aws::Structure
|
10064
10538
|
end
|
data/lib/aws-sdk-bedrockagent.rb
CHANGED