aws-sdk-bedrockagent 1.37.0 → 1.38.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrockagent/client.rb +333 -7
- data/lib/aws-sdk-bedrockagent/client_api.rb +215 -0
- data/lib/aws-sdk-bedrockagent/types.rb +615 -0
- data/lib/aws-sdk-bedrockagent.rb +1 -1
- data/sig/client.rbs +124 -2
- data/sig/types.rbs +147 -1
- metadata +2 -2
@@ -1047,6 +1047,70 @@ module Aws::BedrockAgent
|
|
1047
1047
|
include Aws::Structure
|
1048
1048
|
end
|
1049
1049
|
|
1050
|
+
# Contains information about content defined inline in bytes.
|
1051
|
+
#
|
1052
|
+
# @!attribute [rw] data
|
1053
|
+
# The base64-encoded string of the content.
|
1054
|
+
# @return [String]
|
1055
|
+
#
|
1056
|
+
# @!attribute [rw] mime_type
|
1057
|
+
# The MIME type of the content. For a list of MIME types, see [Media
|
1058
|
+
# Types][1]. The following MIME types are supported:
|
1059
|
+
#
|
1060
|
+
# * text/plain
|
1061
|
+
#
|
1062
|
+
# * text/html
|
1063
|
+
#
|
1064
|
+
# * text/csv
|
1065
|
+
#
|
1066
|
+
# * text/vtt
|
1067
|
+
#
|
1068
|
+
# * message/rfc822
|
1069
|
+
#
|
1070
|
+
# * application/xhtml+xml
|
1071
|
+
#
|
1072
|
+
# * application/pdf
|
1073
|
+
#
|
1074
|
+
# * application/msword
|
1075
|
+
#
|
1076
|
+
# * application/vnd.ms-word.document.macroenabled.12
|
1077
|
+
#
|
1078
|
+
# * application/vnd.ms-word.template.macroenabled.12
|
1079
|
+
#
|
1080
|
+
# * application/vnd.ms-excel
|
1081
|
+
#
|
1082
|
+
# * application/vnd.ms-excel.addin.macroenabled.12
|
1083
|
+
#
|
1084
|
+
# * application/vnd.ms-excel.sheet.macroenabled.12
|
1085
|
+
#
|
1086
|
+
# * application/vnd.ms-excel.template.macroenabled.12
|
1087
|
+
#
|
1088
|
+
# * application/vnd.ms-excel.sheet.binary.macroenabled.12
|
1089
|
+
#
|
1090
|
+
# * application/vnd.ms-spreadsheetml
|
1091
|
+
#
|
1092
|
+
# * application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
|
1093
|
+
#
|
1094
|
+
# * application/vnd.openxmlformats-officedocument.spreadsheetml.template
|
1095
|
+
#
|
1096
|
+
# * application/vnd.openxmlformats-officedocument.wordprocessingml.document
|
1097
|
+
#
|
1098
|
+
# * application/vnd.openxmlformats-officedocument.wordprocessingml.template
|
1099
|
+
#
|
1100
|
+
#
|
1101
|
+
#
|
1102
|
+
# [1]: https://www.iana.org/assignments/media-types/media-types.xhtml
|
1103
|
+
# @return [String]
|
1104
|
+
#
|
1105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ByteContentDoc AWS API Documentation
|
1106
|
+
#
|
1107
|
+
class ByteContentDoc < Struct.new(
|
1108
|
+
:data,
|
1109
|
+
:mime_type)
|
1110
|
+
SENSITIVE = [:data]
|
1111
|
+
include Aws::Structure
|
1112
|
+
end
|
1113
|
+
|
1050
1114
|
# Contains configurations to use a prompt in a conversational format.
|
1051
1115
|
# For more information, see [Create a prompt using Prompt
|
1052
1116
|
# management][1].
|
@@ -2362,6 +2426,54 @@ module Aws::BedrockAgent
|
|
2362
2426
|
include Aws::Structure
|
2363
2427
|
end
|
2364
2428
|
|
2429
|
+
# Contains information about the content to ingest into a knowledge base
|
2430
|
+
# connected to a custom data source. Choose a `sourceType` and include
|
2431
|
+
# the field that corresponds to it.
|
2432
|
+
#
|
2433
|
+
# @!attribute [rw] custom_document_identifier
|
2434
|
+
# A unique identifier for the document.
|
2435
|
+
# @return [Types::CustomDocumentIdentifier]
|
2436
|
+
#
|
2437
|
+
# @!attribute [rw] inline_content
|
2438
|
+
# Contains information about content defined inline to ingest into a
|
2439
|
+
# knowledge base.
|
2440
|
+
# @return [Types::InlineContent]
|
2441
|
+
#
|
2442
|
+
# @!attribute [rw] s3_location
|
2443
|
+
# Contains information about the Amazon S3 location of the file from
|
2444
|
+
# which to ingest data.
|
2445
|
+
# @return [Types::CustomS3Location]
|
2446
|
+
#
|
2447
|
+
# @!attribute [rw] source_type
|
2448
|
+
# The source of the data to ingest.
|
2449
|
+
# @return [String]
|
2450
|
+
#
|
2451
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CustomContent AWS API Documentation
|
2452
|
+
#
|
2453
|
+
class CustomContent < Struct.new(
|
2454
|
+
:custom_document_identifier,
|
2455
|
+
:inline_content,
|
2456
|
+
:s3_location,
|
2457
|
+
:source_type)
|
2458
|
+
SENSITIVE = []
|
2459
|
+
include Aws::Structure
|
2460
|
+
end
|
2461
|
+
|
2462
|
+
# Contains information about the identifier of the document to ingest
|
2463
|
+
# into a custom data source.
|
2464
|
+
#
|
2465
|
+
# @!attribute [rw] id
|
2466
|
+
# The identifier of the document to ingest into a custom data source.
|
2467
|
+
# @return [String]
|
2468
|
+
#
|
2469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CustomDocumentIdentifier AWS API Documentation
|
2470
|
+
#
|
2471
|
+
class CustomDocumentIdentifier < Struct.new(
|
2472
|
+
:id)
|
2473
|
+
SENSITIVE = []
|
2474
|
+
include Aws::Structure
|
2475
|
+
end
|
2476
|
+
|
2365
2477
|
# Details of custom orchestration.
|
2366
2478
|
#
|
2367
2479
|
# @!attribute [rw] executor
|
@@ -2377,6 +2489,28 @@ module Aws::BedrockAgent
|
|
2377
2489
|
include Aws::Structure
|
2378
2490
|
end
|
2379
2491
|
|
2492
|
+
# Contains information about the Amazon S3 location of the file
|
2493
|
+
# containing the content to ingest into a knowledge base connected to a
|
2494
|
+
# custom data source.
|
2495
|
+
#
|
2496
|
+
# @!attribute [rw] bucket_owner_account_id
|
2497
|
+
# The identifier of the Amazon Web Services account that owns the S3
|
2498
|
+
# bucket containing the content to ingest.
|
2499
|
+
# @return [String]
|
2500
|
+
#
|
2501
|
+
# @!attribute [rw] uri
|
2502
|
+
# The S3 URI of the file containing the content to ingest.
|
2503
|
+
# @return [String]
|
2504
|
+
#
|
2505
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/CustomS3Location AWS API Documentation
|
2506
|
+
#
|
2507
|
+
class CustomS3Location < Struct.new(
|
2508
|
+
:bucket_owner_account_id,
|
2509
|
+
:uri)
|
2510
|
+
SENSITIVE = []
|
2511
|
+
include Aws::Structure
|
2512
|
+
end
|
2513
|
+
|
2380
2514
|
# Settings for customizing steps in the data source content ingestion
|
2381
2515
|
# pipeline.
|
2382
2516
|
#
|
@@ -2905,6 +3039,59 @@ module Aws::BedrockAgent
|
|
2905
3039
|
include Aws::Structure
|
2906
3040
|
end
|
2907
3041
|
|
3042
|
+
# @!attribute [rw] client_token
|
3043
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
3044
|
+
# completes no more than one time. If this token matches a previous
|
3045
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
3046
|
+
# error. For more information, see [Ensuring idempotency][1].
|
3047
|
+
#
|
3048
|
+
# **A suitable default value is auto-generated.** You should normally
|
3049
|
+
# not need to pass this option.
|
3050
|
+
#
|
3051
|
+
#
|
3052
|
+
#
|
3053
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
3054
|
+
# @return [String]
|
3055
|
+
#
|
3056
|
+
# @!attribute [rw] data_source_id
|
3057
|
+
# The unique identifier of the data source that contains the
|
3058
|
+
# documents.
|
3059
|
+
# @return [String]
|
3060
|
+
#
|
3061
|
+
# @!attribute [rw] document_identifiers
|
3062
|
+
# A list of objects, each of which contains information to identify a
|
3063
|
+
# document to delete.
|
3064
|
+
# @return [Array<Types::DocumentIdentifier>]
|
3065
|
+
#
|
3066
|
+
# @!attribute [rw] knowledge_base_id
|
3067
|
+
# The unique identifier of the knowledge base that is connected to the
|
3068
|
+
# data source.
|
3069
|
+
# @return [String]
|
3070
|
+
#
|
3071
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocumentsRequest AWS API Documentation
|
3072
|
+
#
|
3073
|
+
class DeleteKnowledgeBaseDocumentsRequest < Struct.new(
|
3074
|
+
:client_token,
|
3075
|
+
:data_source_id,
|
3076
|
+
:document_identifiers,
|
3077
|
+
:knowledge_base_id)
|
3078
|
+
SENSITIVE = []
|
3079
|
+
include Aws::Structure
|
3080
|
+
end
|
3081
|
+
|
3082
|
+
# @!attribute [rw] document_details
|
3083
|
+
# A list of objects, each of which contains information about the
|
3084
|
+
# documents that were deleted.
|
3085
|
+
# @return [Array<Types::KnowledgeBaseDocumentDetail>]
|
3086
|
+
#
|
3087
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DeleteKnowledgeBaseDocumentsResponse AWS API Documentation
|
3088
|
+
#
|
3089
|
+
class DeleteKnowledgeBaseDocumentsResponse < Struct.new(
|
3090
|
+
:document_details)
|
3091
|
+
SENSITIVE = []
|
3092
|
+
include Aws::Structure
|
3093
|
+
end
|
3094
|
+
|
2908
3095
|
# @!attribute [rw] knowledge_base_id
|
2909
3096
|
# The unique identifier of the knowledge base to delete.
|
2910
3097
|
# @return [String]
|
@@ -2998,6 +3185,90 @@ module Aws::BedrockAgent
|
|
2998
3185
|
#
|
2999
3186
|
class DisassociateAgentKnowledgeBaseResponse < Aws::EmptyStructure; end
|
3000
3187
|
|
3188
|
+
# Contains information about the content of a document. Choose a
|
3189
|
+
# `dataSourceType` and include the field that corresponds to it.
|
3190
|
+
#
|
3191
|
+
# @!attribute [rw] custom
|
3192
|
+
# Contains information about the content to ingest into a knowledge
|
3193
|
+
# base connected to a custom data source.
|
3194
|
+
# @return [Types::CustomContent]
|
3195
|
+
#
|
3196
|
+
# @!attribute [rw] data_source_type
|
3197
|
+
# The type of data source that is connected to the knowledge base to
|
3198
|
+
# which to ingest this document.
|
3199
|
+
# @return [String]
|
3200
|
+
#
|
3201
|
+
# @!attribute [rw] s3
|
3202
|
+
# Contains information about the content to ingest into a knowledge
|
3203
|
+
# base connected to an Amazon S3 data source
|
3204
|
+
# @return [Types::S3Content]
|
3205
|
+
#
|
3206
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DocumentContent AWS API Documentation
|
3207
|
+
#
|
3208
|
+
class DocumentContent < Struct.new(
|
3209
|
+
:custom,
|
3210
|
+
:data_source_type,
|
3211
|
+
:s3)
|
3212
|
+
SENSITIVE = []
|
3213
|
+
include Aws::Structure
|
3214
|
+
end
|
3215
|
+
|
3216
|
+
# Contains information that identifies the document.
|
3217
|
+
#
|
3218
|
+
# @!attribute [rw] custom
|
3219
|
+
# Contains information that identifies the document in a custom data
|
3220
|
+
# source.
|
3221
|
+
# @return [Types::CustomDocumentIdentifier]
|
3222
|
+
#
|
3223
|
+
# @!attribute [rw] data_source_type
|
3224
|
+
# The type of data source connected to the knowledge base that
|
3225
|
+
# contains the document.
|
3226
|
+
# @return [String]
|
3227
|
+
#
|
3228
|
+
# @!attribute [rw] s3
|
3229
|
+
# Contains information that identifies the document in an S3 data
|
3230
|
+
# source.
|
3231
|
+
# @return [Types::S3Location]
|
3232
|
+
#
|
3233
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DocumentIdentifier AWS API Documentation
|
3234
|
+
#
|
3235
|
+
class DocumentIdentifier < Struct.new(
|
3236
|
+
:custom,
|
3237
|
+
:data_source_type,
|
3238
|
+
:s3)
|
3239
|
+
SENSITIVE = []
|
3240
|
+
include Aws::Structure
|
3241
|
+
end
|
3242
|
+
|
3243
|
+
# Contains information about the metadata associate with the content to
|
3244
|
+
# ingest into a knowledge base. Choose a `type` and include the field
|
3245
|
+
# that corresponds to it.
|
3246
|
+
#
|
3247
|
+
# @!attribute [rw] inline_attributes
|
3248
|
+
# An array of objects, each of which defines a metadata attribute to
|
3249
|
+
# associate with the content to ingest. You define the attributes
|
3250
|
+
# inline.
|
3251
|
+
# @return [Array<Types::MetadataAttribute>]
|
3252
|
+
#
|
3253
|
+
# @!attribute [rw] s3_location
|
3254
|
+
# The Amazon S3 location of the file containing metadata to associate
|
3255
|
+
# with the content to ingest.
|
3256
|
+
# @return [Types::CustomS3Location]
|
3257
|
+
#
|
3258
|
+
# @!attribute [rw] type
|
3259
|
+
# The type of the source source from which to add metadata.
|
3260
|
+
# @return [String]
|
3261
|
+
#
|
3262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/DocumentMetadata AWS API Documentation
|
3263
|
+
#
|
3264
|
+
class DocumentMetadata < Struct.new(
|
3265
|
+
:inline_attributes,
|
3266
|
+
:s3_location,
|
3267
|
+
:type)
|
3268
|
+
SENSITIVE = []
|
3269
|
+
include Aws::Structure
|
3270
|
+
end
|
3271
|
+
|
3001
3272
|
# Details about duplicate condition expressions found in a condition
|
3002
3273
|
# node.
|
3003
3274
|
#
|
@@ -4399,6 +4670,44 @@ module Aws::BedrockAgent
|
|
4399
4670
|
include Aws::Structure
|
4400
4671
|
end
|
4401
4672
|
|
4673
|
+
# @!attribute [rw] data_source_id
|
4674
|
+
# The unique identifier of the data source that contains the
|
4675
|
+
# documents.
|
4676
|
+
# @return [String]
|
4677
|
+
#
|
4678
|
+
# @!attribute [rw] document_identifiers
|
4679
|
+
# A list of objects, each of which contains information to identify a
|
4680
|
+
# document for which to retrieve information.
|
4681
|
+
# @return [Array<Types::DocumentIdentifier>]
|
4682
|
+
#
|
4683
|
+
# @!attribute [rw] knowledge_base_id
|
4684
|
+
# The unique identifier of the knowledge base that is connected to the
|
4685
|
+
# data source.
|
4686
|
+
# @return [String]
|
4687
|
+
#
|
4688
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseDocumentsRequest AWS API Documentation
|
4689
|
+
#
|
4690
|
+
class GetKnowledgeBaseDocumentsRequest < Struct.new(
|
4691
|
+
:data_source_id,
|
4692
|
+
:document_identifiers,
|
4693
|
+
:knowledge_base_id)
|
4694
|
+
SENSITIVE = []
|
4695
|
+
include Aws::Structure
|
4696
|
+
end
|
4697
|
+
|
4698
|
+
# @!attribute [rw] document_details
|
4699
|
+
# A list of objects, each of which contains information about the
|
4700
|
+
# documents that were retrieved.
|
4701
|
+
# @return [Array<Types::KnowledgeBaseDocumentDetail>]
|
4702
|
+
#
|
4703
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/GetKnowledgeBaseDocumentsResponse AWS API Documentation
|
4704
|
+
#
|
4705
|
+
class GetKnowledgeBaseDocumentsResponse < Struct.new(
|
4706
|
+
:document_details)
|
4707
|
+
SENSITIVE = []
|
4708
|
+
include Aws::Structure
|
4709
|
+
end
|
4710
|
+
|
4402
4711
|
# @!attribute [rw] knowledge_base_id
|
4403
4712
|
# The unique identifier of the knowledge base you want to get
|
4404
4713
|
# information on.
|
@@ -4638,6 +4947,59 @@ module Aws::BedrockAgent
|
|
4638
4947
|
include Aws::Structure
|
4639
4948
|
end
|
4640
4949
|
|
4950
|
+
# @!attribute [rw] client_token
|
4951
|
+
# A unique, case-sensitive identifier to ensure that the API request
|
4952
|
+
# completes no more than one time. If this token matches a previous
|
4953
|
+
# request, Amazon Bedrock ignores the request, but does not return an
|
4954
|
+
# error. For more information, see [Ensuring idempotency][1].
|
4955
|
+
#
|
4956
|
+
# **A suitable default value is auto-generated.** You should normally
|
4957
|
+
# not need to pass this option.
|
4958
|
+
#
|
4959
|
+
#
|
4960
|
+
#
|
4961
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
|
4962
|
+
# @return [String]
|
4963
|
+
#
|
4964
|
+
# @!attribute [rw] data_source_id
|
4965
|
+
# The unique identifier of the data source connected to the knowledge
|
4966
|
+
# base that you're adding documents to.
|
4967
|
+
# @return [String]
|
4968
|
+
#
|
4969
|
+
# @!attribute [rw] documents
|
4970
|
+
# A list of objects, each of which contains information about the
|
4971
|
+
# documents to add.
|
4972
|
+
# @return [Array<Types::KnowledgeBaseDocument>]
|
4973
|
+
#
|
4974
|
+
# @!attribute [rw] knowledge_base_id
|
4975
|
+
# The unique identifier of the knowledge base to ingest the documents
|
4976
|
+
# into.
|
4977
|
+
# @return [String]
|
4978
|
+
#
|
4979
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocumentsRequest AWS API Documentation
|
4980
|
+
#
|
4981
|
+
class IngestKnowledgeBaseDocumentsRequest < Struct.new(
|
4982
|
+
:client_token,
|
4983
|
+
:data_source_id,
|
4984
|
+
:documents,
|
4985
|
+
:knowledge_base_id)
|
4986
|
+
SENSITIVE = []
|
4987
|
+
include Aws::Structure
|
4988
|
+
end
|
4989
|
+
|
4990
|
+
# @!attribute [rw] document_details
|
4991
|
+
# A list of objects, each of which contains information about the
|
4992
|
+
# documents that were ingested.
|
4993
|
+
# @return [Array<Types::KnowledgeBaseDocumentDetail>]
|
4994
|
+
#
|
4995
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/IngestKnowledgeBaseDocumentsResponse AWS API Documentation
|
4996
|
+
#
|
4997
|
+
class IngestKnowledgeBaseDocumentsResponse < Struct.new(
|
4998
|
+
:document_details)
|
4999
|
+
SENSITIVE = []
|
5000
|
+
include Aws::Structure
|
5001
|
+
end
|
5002
|
+
|
4641
5003
|
# Contains details about a data ingestion job. Data sources are ingested
|
4642
5004
|
# into a knowledge base so that Large Language Models (LLMs) can use
|
4643
5005
|
# your data.
|
@@ -4855,6 +5217,32 @@ module Aws::BedrockAgent
|
|
4855
5217
|
include Aws::Structure
|
4856
5218
|
end
|
4857
5219
|
|
5220
|
+
# Contains information about content defined inline to ingest into a
|
5221
|
+
# data source. Choose a `type` and include the field that corresponds to
|
5222
|
+
# it.
|
5223
|
+
#
|
5224
|
+
# @!attribute [rw] byte_content
|
5225
|
+
# Contains information about content defined inline in bytes.
|
5226
|
+
# @return [Types::ByteContentDoc]
|
5227
|
+
#
|
5228
|
+
# @!attribute [rw] text_content
|
5229
|
+
# Contains information about content defined inline in text.
|
5230
|
+
# @return [Types::TextContentDoc]
|
5231
|
+
#
|
5232
|
+
# @!attribute [rw] type
|
5233
|
+
# The type of inline content to define.
|
5234
|
+
# @return [String]
|
5235
|
+
#
|
5236
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/InlineContent AWS API Documentation
|
5237
|
+
#
|
5238
|
+
class InlineContent < Struct.new(
|
5239
|
+
:byte_content,
|
5240
|
+
:text_content,
|
5241
|
+
:type)
|
5242
|
+
SENSITIVE = []
|
5243
|
+
include Aws::Structure
|
5244
|
+
end
|
5245
|
+
|
4858
5246
|
# Contains configurations for the input flow node for a flow. This node
|
4859
5247
|
# takes the input from flow invocation and passes it to the next node in
|
4860
5248
|
# the data type that you specify.
|
@@ -5009,6 +5397,94 @@ module Aws::BedrockAgent
|
|
5009
5397
|
include Aws::Structure
|
5010
5398
|
end
|
5011
5399
|
|
5400
|
+
# Contains information about a document to ingest into a knowledge base
|
5401
|
+
# and metadata to associate with it.
|
5402
|
+
#
|
5403
|
+
# @!attribute [rw] content
|
5404
|
+
# Contains the content of the document.
|
5405
|
+
# @return [Types::DocumentContent]
|
5406
|
+
#
|
5407
|
+
# @!attribute [rw] metadata
|
5408
|
+
# Contains the metadata to associate with the document.
|
5409
|
+
# @return [Types::DocumentMetadata]
|
5410
|
+
#
|
5411
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseDocument AWS API Documentation
|
5412
|
+
#
|
5413
|
+
class KnowledgeBaseDocument < Struct.new(
|
5414
|
+
:content,
|
5415
|
+
:metadata)
|
5416
|
+
SENSITIVE = []
|
5417
|
+
include Aws::Structure
|
5418
|
+
end
|
5419
|
+
|
5420
|
+
# Contains the details for a document that was ingested or deleted.
|
5421
|
+
#
|
5422
|
+
# @!attribute [rw] data_source_id
|
5423
|
+
# The identifier of the data source connected to the knowledge base
|
5424
|
+
# that the document was ingested into or deleted from.
|
5425
|
+
# @return [String]
|
5426
|
+
#
|
5427
|
+
# @!attribute [rw] identifier
|
5428
|
+
# Contains information that identifies the document.
|
5429
|
+
# @return [Types::DocumentIdentifier]
|
5430
|
+
#
|
5431
|
+
# @!attribute [rw] knowledge_base_id
|
5432
|
+
# The identifier of the knowledge base that the document was ingested
|
5433
|
+
# into or deleted from.
|
5434
|
+
# @return [String]
|
5435
|
+
#
|
5436
|
+
# @!attribute [rw] status
|
5437
|
+
# The ingestion status of the document. The following statuses are
|
5438
|
+
# possible:
|
5439
|
+
#
|
5440
|
+
# * STARTED – You submitted the ingestion job containing the document.
|
5441
|
+
#
|
5442
|
+
# * PENDING – The document is waiting to be ingested.
|
5443
|
+
#
|
5444
|
+
# * IN\_PROGRESS – The document is being ingested.
|
5445
|
+
#
|
5446
|
+
# * INDEXED – The document was successfully indexed.
|
5447
|
+
#
|
5448
|
+
# * PARTIALLY\_INDEXED – The document was partially indexed.
|
5449
|
+
#
|
5450
|
+
# * METADATA\_PARTIALLY\_INDEXED – You submitted metadata for an
|
5451
|
+
# existing document and it was partially indexed.
|
5452
|
+
#
|
5453
|
+
# * METADATA\_UPDATE\_FAILED – You submitted a metadata update for an
|
5454
|
+
# existing document but it failed.
|
5455
|
+
#
|
5456
|
+
# * FAILED – The document failed to be ingested.
|
5457
|
+
#
|
5458
|
+
# * NOT\_FOUND – The document wasn't found.
|
5459
|
+
#
|
5460
|
+
# * IGNORED – The document was ignored during ingestion.
|
5461
|
+
#
|
5462
|
+
# * DELETING – You submitted the delete job containing the document.
|
5463
|
+
#
|
5464
|
+
# * DELETE\_IN\_PROGRESS – The document is being deleted.
|
5465
|
+
# @return [String]
|
5466
|
+
#
|
5467
|
+
# @!attribute [rw] status_reason
|
5468
|
+
# The reason for the status. Appears alongside the status `IGNORED`.
|
5469
|
+
# @return [String]
|
5470
|
+
#
|
5471
|
+
# @!attribute [rw] updated_at
|
5472
|
+
# The date and time at which the document was last updated.
|
5473
|
+
# @return [Time]
|
5474
|
+
#
|
5475
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/KnowledgeBaseDocumentDetail AWS API Documentation
|
5476
|
+
#
|
5477
|
+
class KnowledgeBaseDocumentDetail < Struct.new(
|
5478
|
+
:data_source_id,
|
5479
|
+
:identifier,
|
5480
|
+
:knowledge_base_id,
|
5481
|
+
:status,
|
5482
|
+
:status_reason,
|
5483
|
+
:updated_at)
|
5484
|
+
SENSITIVE = []
|
5485
|
+
include Aws::Structure
|
5486
|
+
end
|
5487
|
+
|
5012
5488
|
# Contains configurations for a knowledge base node in a flow. This node
|
5013
5489
|
# takes a query as the input and returns, as the output, the retrieved
|
5014
5490
|
# responses directly (as an array) or a response generated based on the
|
@@ -5639,6 +6115,62 @@ module Aws::BedrockAgent
|
|
5639
6115
|
include Aws::Structure
|
5640
6116
|
end
|
5641
6117
|
|
6118
|
+
# @!attribute [rw] data_source_id
|
6119
|
+
# The unique identifier of the data source that contains the
|
6120
|
+
# documents.
|
6121
|
+
# @return [String]
|
6122
|
+
#
|
6123
|
+
# @!attribute [rw] knowledge_base_id
|
6124
|
+
# The unique identifier of the knowledge base that is connected to the
|
6125
|
+
# data source.
|
6126
|
+
# @return [String]
|
6127
|
+
#
|
6128
|
+
# @!attribute [rw] max_results
|
6129
|
+
# The maximum number of results to return in the response. If the
|
6130
|
+
# total number of results is greater than this value, use the token
|
6131
|
+
# returned in the response in the `nextToken` field when making
|
6132
|
+
# another request to return the next batch of results.
|
6133
|
+
# @return [Integer]
|
6134
|
+
#
|
6135
|
+
# @!attribute [rw] next_token
|
6136
|
+
# If the total number of results is greater than the `maxResults`
|
6137
|
+
# value provided in the request, enter the token returned in the
|
6138
|
+
# `nextToken` field in the response in this field to return the next
|
6139
|
+
# batch of results.
|
6140
|
+
# @return [String]
|
6141
|
+
#
|
6142
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBaseDocumentsRequest AWS API Documentation
|
6143
|
+
#
|
6144
|
+
class ListKnowledgeBaseDocumentsRequest < Struct.new(
|
6145
|
+
:data_source_id,
|
6146
|
+
:knowledge_base_id,
|
6147
|
+
:max_results,
|
6148
|
+
:next_token)
|
6149
|
+
SENSITIVE = []
|
6150
|
+
include Aws::Structure
|
6151
|
+
end
|
6152
|
+
|
6153
|
+
# @!attribute [rw] document_details
|
6154
|
+
# A list of objects, each of which contains information about the
|
6155
|
+
# documents that were retrieved.
|
6156
|
+
# @return [Array<Types::KnowledgeBaseDocumentDetail>]
|
6157
|
+
#
|
6158
|
+
# @!attribute [rw] next_token
|
6159
|
+
# If the total number of results is greater than the `maxResults`
|
6160
|
+
# value provided in the request, use this token when making another
|
6161
|
+
# request in the `nextToken` field to return the next batch of
|
6162
|
+
# results.
|
6163
|
+
# @return [String]
|
6164
|
+
#
|
6165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/ListKnowledgeBaseDocumentsResponse AWS API Documentation
|
6166
|
+
#
|
6167
|
+
class ListKnowledgeBaseDocumentsResponse < Struct.new(
|
6168
|
+
:document_details,
|
6169
|
+
:next_token)
|
6170
|
+
SENSITIVE = []
|
6171
|
+
include Aws::Structure
|
6172
|
+
end
|
6173
|
+
|
5642
6174
|
# @!attribute [rw] max_results
|
5643
6175
|
# The maximum number of results to return in the response. If the
|
5644
6176
|
# total number of results is greater than this value, use the token
|
@@ -5852,6 +6384,60 @@ module Aws::BedrockAgent
|
|
5852
6384
|
include Aws::Structure
|
5853
6385
|
end
|
5854
6386
|
|
6387
|
+
# Contains information about a metadata attribute.
|
6388
|
+
#
|
6389
|
+
# @!attribute [rw] key
|
6390
|
+
# The key of the metadata attribute.
|
6391
|
+
# @return [String]
|
6392
|
+
#
|
6393
|
+
# @!attribute [rw] value
|
6394
|
+
# Contains the value of the metadata attribute.
|
6395
|
+
# @return [Types::MetadataAttributeValue]
|
6396
|
+
#
|
6397
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MetadataAttribute AWS API Documentation
|
6398
|
+
#
|
6399
|
+
class MetadataAttribute < Struct.new(
|
6400
|
+
:key,
|
6401
|
+
:value)
|
6402
|
+
SENSITIVE = [:key]
|
6403
|
+
include Aws::Structure
|
6404
|
+
end
|
6405
|
+
|
6406
|
+
# Contains the value of the metadata attribute. Choose a `type` and
|
6407
|
+
# include the field that corresponds to it.
|
6408
|
+
#
|
6409
|
+
# @!attribute [rw] boolean_value
|
6410
|
+
# The value of the Boolean metadata attribute.
|
6411
|
+
# @return [Boolean]
|
6412
|
+
#
|
6413
|
+
# @!attribute [rw] number_value
|
6414
|
+
# The value of the numeric metadata attribute.
|
6415
|
+
# @return [Float]
|
6416
|
+
#
|
6417
|
+
# @!attribute [rw] string_list_value
|
6418
|
+
# An array of strings that define the value of the metadata attribute.
|
6419
|
+
# @return [Array<String>]
|
6420
|
+
#
|
6421
|
+
# @!attribute [rw] string_value
|
6422
|
+
# The value of the string metadata attribute.
|
6423
|
+
# @return [String]
|
6424
|
+
#
|
6425
|
+
# @!attribute [rw] type
|
6426
|
+
# The type of the metadata attribute.
|
6427
|
+
# @return [String]
|
6428
|
+
#
|
6429
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/MetadataAttributeValue AWS API Documentation
|
6430
|
+
#
|
6431
|
+
class MetadataAttributeValue < Struct.new(
|
6432
|
+
:boolean_value,
|
6433
|
+
:number_value,
|
6434
|
+
:string_list_value,
|
6435
|
+
:string_value,
|
6436
|
+
:type)
|
6437
|
+
SENSITIVE = [:number_value, :string_list_value, :string_value]
|
6438
|
+
include Aws::Structure
|
6439
|
+
end
|
6440
|
+
|
5855
6441
|
# Details about mismatched input data types in a node.
|
5856
6442
|
#
|
5857
6443
|
# @!attribute [rw] expected_type
|
@@ -7236,6 +7822,21 @@ module Aws::BedrockAgent
|
|
7236
7822
|
class Unknown < RetrievalFlowNodeServiceConfiguration; end
|
7237
7823
|
end
|
7238
7824
|
|
7825
|
+
# Contains information about the content to ingest into a knowledge base
|
7826
|
+
# connected to an Amazon S3 data source.
|
7827
|
+
#
|
7828
|
+
# @!attribute [rw] s3_location
|
7829
|
+
# The S3 location of the file containing the content to ingest.
|
7830
|
+
# @return [Types::S3Location]
|
7831
|
+
#
|
7832
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/S3Content AWS API Documentation
|
7833
|
+
#
|
7834
|
+
class S3Content < Struct.new(
|
7835
|
+
:s3_location)
|
7836
|
+
SENSITIVE = []
|
7837
|
+
include Aws::Structure
|
7838
|
+
end
|
7839
|
+
|
7239
7840
|
# The configuration information to connect to Amazon S3 as your data
|
7240
7841
|
# source.
|
7241
7842
|
#
|
@@ -7809,6 +8410,20 @@ module Aws::BedrockAgent
|
|
7809
8410
|
#
|
7810
8411
|
class TagResourceResponse < Aws::EmptyStructure; end
|
7811
8412
|
|
8413
|
+
# Contains information about content defined inline in text.
|
8414
|
+
#
|
8415
|
+
# @!attribute [rw] data
|
8416
|
+
# The text of the content.
|
8417
|
+
# @return [String]
|
8418
|
+
#
|
8419
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-2023-06-05/TextContentDoc AWS API Documentation
|
8420
|
+
#
|
8421
|
+
class TextContentDoc < Struct.new(
|
8422
|
+
:data)
|
8423
|
+
SENSITIVE = [:data]
|
8424
|
+
include Aws::Structure
|
8425
|
+
end
|
8426
|
+
|
7812
8427
|
# Contains configurations for a text prompt template. To include a
|
7813
8428
|
# variable, enclose a word in double curly braces as in `{{variable}}`.
|
7814
8429
|
#
|
data/lib/aws-sdk-bedrockagent.rb
CHANGED