aws-sdk-bedrockagentruntime 1.34.0 → 1.35.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.
@@ -39,15 +39,21 @@ module Aws::BedrockAgentRuntime
39
39
  ApiPath = Shapes::StringShape.new(name: 'ApiPath')
40
40
  ApiRequestBody = Shapes::StructureShape.new(name: 'ApiRequestBody')
41
41
  ApiResult = Shapes::StructureShape.new(name: 'ApiResult')
42
+ AttributeType = Shapes::StringShape.new(name: 'AttributeType')
42
43
  Attribution = Shapes::StructureShape.new(name: 'Attribution')
43
44
  BadGatewayException = Shapes::StructureShape.new(name: 'BadGatewayException')
44
45
  BasePromptTemplate = Shapes::StringShape.new(name: 'BasePromptTemplate')
45
46
  BedrockModelArn = Shapes::StringShape.new(name: 'BedrockModelArn')
47
+ BedrockRerankingConfiguration = Shapes::StructureShape.new(name: 'BedrockRerankingConfiguration')
48
+ BedrockRerankingConfigurationNumberOfResultsInteger = Shapes::IntegerShape.new(name: 'BedrockRerankingConfigurationNumberOfResultsInteger')
49
+ BedrockRerankingModelArn = Shapes::StringShape.new(name: 'BedrockRerankingModelArn')
50
+ BedrockRerankingModelConfiguration = Shapes::StructureShape.new(name: 'BedrockRerankingModelConfiguration')
46
51
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
47
52
  ByteContentBlob = Shapes::BlobShape.new(name: 'ByteContentBlob')
48
53
  ByteContentDoc = Shapes::StructureShape.new(name: 'ByteContentDoc')
49
54
  ByteContentFile = Shapes::StructureShape.new(name: 'ByteContentFile')
50
55
  Citation = Shapes::StructureShape.new(name: 'Citation')
56
+ CitationEvent = Shapes::StructureShape.new(name: 'CitationEvent')
51
57
  Citations = Shapes::ListShape.new(name: 'Citations')
52
58
  CodeInterpreterInvocationInput = Shapes::StructureShape.new(name: 'CodeInterpreterInvocationInput')
53
59
  CodeInterpreterInvocationOutput = Shapes::StructureShape.new(name: 'CodeInterpreterInvocationOutput')
@@ -74,6 +80,9 @@ module Aws::BedrockAgentRuntime
74
80
  ExternalSourcesRetrieveAndGenerateConfiguration = Shapes::StructureShape.new(name: 'ExternalSourcesRetrieveAndGenerateConfiguration')
75
81
  FailureReasonString = Shapes::StringShape.new(name: 'FailureReasonString')
76
82
  FailureTrace = Shapes::StructureShape.new(name: 'FailureTrace')
83
+ FieldForReranking = Shapes::StructureShape.new(name: 'FieldForReranking')
84
+ FieldForRerankingFieldNameString = Shapes::StringShape.new(name: 'FieldForRerankingFieldNameString')
85
+ FieldsForReranking = Shapes::ListShape.new(name: 'FieldsForReranking')
77
86
  FileBody = Shapes::BlobShape.new(name: 'FileBody')
78
87
  FilePart = Shapes::StructureShape.new(name: 'FilePart')
79
88
  FileSource = Shapes::StructureShape.new(name: 'FileSource')
@@ -85,6 +94,7 @@ module Aws::BedrockAgentRuntime
85
94
  FilterValue = Shapes::DocumentShape.new(name: 'FilterValue', document: true)
86
95
  FinalResponse = Shapes::StructureShape.new(name: 'FinalResponse')
87
96
  FinalResponseString = Shapes::StringShape.new(name: 'FinalResponseString')
97
+ Float = Shapes::FloatShape.new(name: 'Float')
88
98
  FlowAliasIdentifier = Shapes::StringShape.new(name: 'FlowAliasIdentifier')
89
99
  FlowCompletionEvent = Shapes::StructureShape.new(name: 'FlowCompletionEvent')
90
100
  FlowCompletionReason = Shapes::StringShape.new(name: 'FlowCompletionReason')
@@ -137,6 +147,7 @@ module Aws::BedrockAgentRuntime
137
147
  GuardrailContentPolicyAssessment = Shapes::StructureShape.new(name: 'GuardrailContentPolicyAssessment')
138
148
  GuardrailCustomWord = Shapes::StructureShape.new(name: 'GuardrailCustomWord')
139
149
  GuardrailCustomWordList = Shapes::ListShape.new(name: 'GuardrailCustomWordList')
150
+ GuardrailEvent = Shapes::StructureShape.new(name: 'GuardrailEvent')
140
151
  GuardrailIdentifierWithArn = Shapes::StringShape.new(name: 'GuardrailIdentifierWithArn')
141
152
  GuardrailManagedWord = Shapes::StructureShape.new(name: 'GuardrailManagedWord')
142
153
  GuardrailManagedWordList = Shapes::ListShape.new(name: 'GuardrailManagedWordList')
@@ -158,6 +169,7 @@ module Aws::BedrockAgentRuntime
158
169
  GuardrailWordPolicyAction = Shapes::StringShape.new(name: 'GuardrailWordPolicyAction')
159
170
  GuardrailWordPolicyAssessment = Shapes::StructureShape.new(name: 'GuardrailWordPolicyAssessment')
160
171
  Identifier = Shapes::StringShape.new(name: 'Identifier')
172
+ ImplicitFilterConfiguration = Shapes::StructureShape.new(name: 'ImplicitFilterConfiguration')
161
173
  InferenceConfig = Shapes::StructureShape.new(name: 'InferenceConfig')
162
174
  InferenceConfiguration = Shapes::StructureShape.new(name: 'InferenceConfiguration')
163
175
  InlineAgentFilePart = Shapes::StructureShape.new(name: 'InlineAgentFilePart')
@@ -212,6 +224,11 @@ module Aws::BedrockAgentRuntime
212
224
  MemorySessionSummary = Shapes::StructureShape.new(name: 'MemorySessionSummary')
213
225
  MemoryType = Shapes::StringShape.new(name: 'MemoryType')
214
226
  Metadata = Shapes::StructureShape.new(name: 'Metadata')
227
+ MetadataAttributeSchema = Shapes::StructureShape.new(name: 'MetadataAttributeSchema')
228
+ MetadataAttributeSchemaDescriptionString = Shapes::StringShape.new(name: 'MetadataAttributeSchemaDescriptionString')
229
+ MetadataAttributeSchemaKeyString = Shapes::StringShape.new(name: 'MetadataAttributeSchemaKeyString')
230
+ MetadataAttributeSchemaList = Shapes::ListShape.new(name: 'MetadataAttributeSchemaList')
231
+ MetadataConfigurationForReranking = Shapes::StructureShape.new(name: 'MetadataConfigurationForReranking')
215
232
  MimeType = Shapes::StringShape.new(name: 'MimeType')
216
233
  ModelIdentifier = Shapes::StringShape.new(name: 'ModelIdentifier')
217
234
  ModelInvocationInput = Shapes::StructureShape.new(name: 'ModelInvocationInput')
@@ -270,6 +287,25 @@ module Aws::BedrockAgentRuntime
270
287
  RepromptResponse = Shapes::StructureShape.new(name: 'RepromptResponse')
271
288
  RequestBody = Shapes::StructureShape.new(name: 'RequestBody')
272
289
  RequireConfirmation = Shapes::StringShape.new(name: 'RequireConfirmation')
290
+ RerankDocument = Shapes::StructureShape.new(name: 'RerankDocument')
291
+ RerankDocumentType = Shapes::StringShape.new(name: 'RerankDocumentType')
292
+ RerankQueriesList = Shapes::ListShape.new(name: 'RerankQueriesList')
293
+ RerankQuery = Shapes::StructureShape.new(name: 'RerankQuery')
294
+ RerankQueryContentType = Shapes::StringShape.new(name: 'RerankQueryContentType')
295
+ RerankRequest = Shapes::StructureShape.new(name: 'RerankRequest')
296
+ RerankResponse = Shapes::StructureShape.new(name: 'RerankResponse')
297
+ RerankResult = Shapes::StructureShape.new(name: 'RerankResult')
298
+ RerankResultIndexInteger = Shapes::IntegerShape.new(name: 'RerankResultIndexInteger')
299
+ RerankResultsList = Shapes::ListShape.new(name: 'RerankResultsList')
300
+ RerankSource = Shapes::StructureShape.new(name: 'RerankSource')
301
+ RerankSourceType = Shapes::StringShape.new(name: 'RerankSourceType')
302
+ RerankSourcesList = Shapes::ListShape.new(name: 'RerankSourcesList')
303
+ RerankTextDocument = Shapes::StructureShape.new(name: 'RerankTextDocument')
304
+ RerankTextDocumentTextString = Shapes::StringShape.new(name: 'RerankTextDocumentTextString')
305
+ RerankingConfiguration = Shapes::StructureShape.new(name: 'RerankingConfiguration')
306
+ RerankingConfigurationType = Shapes::StringShape.new(name: 'RerankingConfigurationType')
307
+ RerankingMetadataSelectionMode = Shapes::StringShape.new(name: 'RerankingMetadataSelectionMode')
308
+ RerankingMetadataSelectiveModeConfiguration = Shapes::UnionShape.new(name: 'RerankingMetadataSelectiveModeConfiguration')
273
309
  ResourceDescription = Shapes::StringShape.new(name: 'ResourceDescription')
274
310
  ResourceName = Shapes::StringShape.new(name: 'ResourceName')
275
311
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
@@ -280,6 +316,7 @@ module Aws::BedrockAgentRuntime
280
316
  RetrievalFilterList = Shapes::ListShape.new(name: 'RetrievalFilterList')
281
317
  RetrievalResultConfluenceLocation = Shapes::StructureShape.new(name: 'RetrievalResultConfluenceLocation')
282
318
  RetrievalResultContent = Shapes::StructureShape.new(name: 'RetrievalResultContent')
319
+ RetrievalResultCustomDocumentLocation = Shapes::StructureShape.new(name: 'RetrievalResultCustomDocumentLocation')
283
320
  RetrievalResultLocation = Shapes::StructureShape.new(name: 'RetrievalResultLocation')
284
321
  RetrievalResultLocationType = Shapes::StringShape.new(name: 'RetrievalResultLocationType')
285
322
  RetrievalResultMetadata = Shapes::MapShape.new(name: 'RetrievalResultMetadata')
@@ -293,9 +330,13 @@ module Aws::BedrockAgentRuntime
293
330
  RetrieveAndGenerateInput = Shapes::StructureShape.new(name: 'RetrieveAndGenerateInput')
294
331
  RetrieveAndGenerateInputTextString = Shapes::StringShape.new(name: 'RetrieveAndGenerateInputTextString')
295
332
  RetrieveAndGenerateOutput = Shapes::StructureShape.new(name: 'RetrieveAndGenerateOutput')
333
+ RetrieveAndGenerateOutputEvent = Shapes::StructureShape.new(name: 'RetrieveAndGenerateOutputEvent')
296
334
  RetrieveAndGenerateRequest = Shapes::StructureShape.new(name: 'RetrieveAndGenerateRequest')
297
335
  RetrieveAndGenerateResponse = Shapes::StructureShape.new(name: 'RetrieveAndGenerateResponse')
298
336
  RetrieveAndGenerateSessionConfiguration = Shapes::StructureShape.new(name: 'RetrieveAndGenerateSessionConfiguration')
337
+ RetrieveAndGenerateStreamRequest = Shapes::StructureShape.new(name: 'RetrieveAndGenerateStreamRequest')
338
+ RetrieveAndGenerateStreamResponse = Shapes::StructureShape.new(name: 'RetrieveAndGenerateStreamResponse')
339
+ RetrieveAndGenerateStreamResponseOutput = Shapes::StructureShape.new(name: 'RetrieveAndGenerateStreamResponseOutput')
299
340
  RetrieveAndGenerateType = Shapes::StringShape.new(name: 'RetrieveAndGenerateType')
300
341
  RetrieveRequest = Shapes::StructureShape.new(name: 'RetrieveRequest')
301
342
  RetrieveResponse = Shapes::StructureShape.new(name: 'RetrieveResponse')
@@ -340,6 +381,11 @@ module Aws::BedrockAgentRuntime
340
381
  Type = Shapes::StringShape.new(name: 'Type')
341
382
  Usage = Shapes::StructureShape.new(name: 'Usage')
342
383
  ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
384
+ VectorSearchBedrockRerankingConfiguration = Shapes::StructureShape.new(name: 'VectorSearchBedrockRerankingConfiguration')
385
+ VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger = Shapes::IntegerShape.new(name: 'VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger')
386
+ VectorSearchBedrockRerankingModelConfiguration = Shapes::StructureShape.new(name: 'VectorSearchBedrockRerankingModelConfiguration')
387
+ VectorSearchRerankingConfiguration = Shapes::StructureShape.new(name: 'VectorSearchRerankingConfiguration')
388
+ VectorSearchRerankingConfigurationType = Shapes::StringShape.new(name: 'VectorSearchRerankingConfigurationType')
343
389
  Verb = Shapes::StringShape.new(name: 'Verb')
344
390
 
345
391
  APISchema.add_member(:payload, Shapes::ShapeRef.new(shape: Payload, location_name: "payload"))
@@ -427,6 +473,14 @@ module Aws::BedrockAgentRuntime
427
473
  BadGatewayException.add_member(:resource_name, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "resourceName"))
428
474
  BadGatewayException.struct_class = Types::BadGatewayException
429
475
 
476
+ BedrockRerankingConfiguration.add_member(:model_configuration, Shapes::ShapeRef.new(shape: BedrockRerankingModelConfiguration, required: true, location_name: "modelConfiguration"))
477
+ BedrockRerankingConfiguration.add_member(:number_of_results, Shapes::ShapeRef.new(shape: BedrockRerankingConfigurationNumberOfResultsInteger, location_name: "numberOfResults"))
478
+ BedrockRerankingConfiguration.struct_class = Types::BedrockRerankingConfiguration
479
+
480
+ BedrockRerankingModelConfiguration.add_member(:additional_model_request_fields, Shapes::ShapeRef.new(shape: AdditionalModelRequestFields, location_name: "additionalModelRequestFields"))
481
+ BedrockRerankingModelConfiguration.add_member(:model_arn, Shapes::ShapeRef.new(shape: BedrockModelArn, required: true, location_name: "modelArn"))
482
+ BedrockRerankingModelConfiguration.struct_class = Types::BedrockRerankingModelConfiguration
483
+
430
484
  ByteContentDoc.add_member(:content_type, Shapes::ShapeRef.new(shape: ContentType, required: true, location_name: "contentType"))
431
485
  ByteContentDoc.add_member(:data, Shapes::ShapeRef.new(shape: ByteContentBlob, required: true, location_name: "data"))
432
486
  ByteContentDoc.add_member(:identifier, Shapes::ShapeRef.new(shape: Identifier, required: true, location_name: "identifier"))
@@ -440,6 +494,9 @@ module Aws::BedrockAgentRuntime
440
494
  Citation.add_member(:retrieved_references, Shapes::ShapeRef.new(shape: RetrievedReferences, location_name: "retrievedReferences"))
441
495
  Citation.struct_class = Types::Citation
442
496
 
497
+ CitationEvent.add_member(:citation, Shapes::ShapeRef.new(shape: Citation, location_name: "citation"))
498
+ CitationEvent.struct_class = Types::CitationEvent
499
+
443
500
  Citations.member = Shapes::ShapeRef.new(shape: Citation)
444
501
 
445
502
  CodeInterpreterInvocationInput.add_member(:code, Shapes::ShapeRef.new(shape: String, location_name: "code"))
@@ -501,6 +558,11 @@ module Aws::BedrockAgentRuntime
501
558
  FailureTrace.add_member(:trace_id, Shapes::ShapeRef.new(shape: TraceId, location_name: "traceId"))
502
559
  FailureTrace.struct_class = Types::FailureTrace
503
560
 
561
+ FieldForReranking.add_member(:field_name, Shapes::ShapeRef.new(shape: FieldForRerankingFieldNameString, required: true, location_name: "fieldName"))
562
+ FieldForReranking.struct_class = Types::FieldForReranking
563
+
564
+ FieldsForReranking.member = Shapes::ShapeRef.new(shape: FieldForReranking)
565
+
504
566
  FilePart.add_member(:files, Shapes::ShapeRef.new(shape: OutputFiles, location_name: "files"))
505
567
  FilePart.struct_class = Types::FilePart
506
568
 
@@ -703,6 +765,9 @@ module Aws::BedrockAgentRuntime
703
765
 
704
766
  GuardrailCustomWordList.member = Shapes::ShapeRef.new(shape: GuardrailCustomWord)
705
767
 
768
+ GuardrailEvent.add_member(:action, Shapes::ShapeRef.new(shape: GuadrailAction, location_name: "action"))
769
+ GuardrailEvent.struct_class = Types::GuardrailEvent
770
+
706
771
  GuardrailManagedWord.add_member(:action, Shapes::ShapeRef.new(shape: GuardrailWordPolicyAction, location_name: "action"))
707
772
  GuardrailManagedWord.add_member(:match, Shapes::ShapeRef.new(shape: String, location_name: "match"))
708
773
  GuardrailManagedWord.add_member(:type, Shapes::ShapeRef.new(shape: GuardrailManagedWordType, location_name: "type"))
@@ -749,6 +814,10 @@ module Aws::BedrockAgentRuntime
749
814
  GuardrailWordPolicyAssessment.add_member(:managed_word_lists, Shapes::ShapeRef.new(shape: GuardrailManagedWordList, location_name: "managedWordLists"))
750
815
  GuardrailWordPolicyAssessment.struct_class = Types::GuardrailWordPolicyAssessment
751
816
 
817
+ ImplicitFilterConfiguration.add_member(:metadata_attributes, Shapes::ShapeRef.new(shape: MetadataAttributeSchemaList, required: true, location_name: "metadataAttributes"))
818
+ ImplicitFilterConfiguration.add_member(:model_arn, Shapes::ShapeRef.new(shape: BedrockModelArn, required: true, location_name: "modelArn"))
819
+ ImplicitFilterConfiguration.struct_class = Types::ImplicitFilterConfiguration
820
+
752
821
  InferenceConfig.add_member(:text_inference_config, Shapes::ShapeRef.new(shape: TextInferenceConfig, location_name: "textInferenceConfig"))
753
822
  InferenceConfig.struct_class = Types::InferenceConfig
754
823
 
@@ -929,8 +998,10 @@ module Aws::BedrockAgentRuntime
929
998
  KnowledgeBaseRetrieveAndGenerateConfiguration.struct_class = Types::KnowledgeBaseRetrieveAndGenerateConfiguration
930
999
 
931
1000
  KnowledgeBaseVectorSearchConfiguration.add_member(:filter, Shapes::ShapeRef.new(shape: RetrievalFilter, location_name: "filter"))
1001
+ KnowledgeBaseVectorSearchConfiguration.add_member(:implicit_filter_configuration, Shapes::ShapeRef.new(shape: ImplicitFilterConfiguration, location_name: "implicitFilterConfiguration"))
932
1002
  KnowledgeBaseVectorSearchConfiguration.add_member(:number_of_results, Shapes::ShapeRef.new(shape: KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger, location_name: "numberOfResults", metadata: {"box"=>true}))
933
1003
  KnowledgeBaseVectorSearchConfiguration.add_member(:override_search_type, Shapes::ShapeRef.new(shape: SearchType, location_name: "overrideSearchType"))
1004
+ KnowledgeBaseVectorSearchConfiguration.add_member(:reranking_configuration, Shapes::ShapeRef.new(shape: VectorSearchRerankingConfiguration, location_name: "rerankingConfiguration"))
934
1005
  KnowledgeBaseVectorSearchConfiguration.struct_class = Types::KnowledgeBaseVectorSearchConfiguration
935
1006
 
936
1007
  KnowledgeBases.member = Shapes::ShapeRef.new(shape: KnowledgeBase)
@@ -953,6 +1024,17 @@ module Aws::BedrockAgentRuntime
953
1024
  Metadata.add_member(:usage, Shapes::ShapeRef.new(shape: Usage, location_name: "usage"))
954
1025
  Metadata.struct_class = Types::Metadata
955
1026
 
1027
+ MetadataAttributeSchema.add_member(:description, Shapes::ShapeRef.new(shape: MetadataAttributeSchemaDescriptionString, required: true, location_name: "description"))
1028
+ MetadataAttributeSchema.add_member(:key, Shapes::ShapeRef.new(shape: MetadataAttributeSchemaKeyString, required: true, location_name: "key"))
1029
+ MetadataAttributeSchema.add_member(:type, Shapes::ShapeRef.new(shape: AttributeType, required: true, location_name: "type"))
1030
+ MetadataAttributeSchema.struct_class = Types::MetadataAttributeSchema
1031
+
1032
+ MetadataAttributeSchemaList.member = Shapes::ShapeRef.new(shape: MetadataAttributeSchema)
1033
+
1034
+ MetadataConfigurationForReranking.add_member(:selection_mode, Shapes::ShapeRef.new(shape: RerankingMetadataSelectionMode, required: true, location_name: "selectionMode"))
1035
+ MetadataConfigurationForReranking.add_member(:selective_mode_configuration, Shapes::ShapeRef.new(shape: RerankingMetadataSelectiveModeConfiguration, location_name: "selectiveModeConfiguration"))
1036
+ MetadataConfigurationForReranking.struct_class = Types::MetadataConfigurationForReranking
1037
+
956
1038
  ModelInvocationInput.add_member(:inference_configuration, Shapes::ShapeRef.new(shape: InferenceConfiguration, location_name: "inferenceConfiguration"))
957
1039
  ModelInvocationInput.add_member(:override_lambda, Shapes::ShapeRef.new(shape: LambdaArn, location_name: "overrideLambda"))
958
1040
  ModelInvocationInput.add_member(:parser_mode, Shapes::ShapeRef.new(shape: CreationMode, location_name: "parserMode"))
@@ -1129,6 +1211,55 @@ module Aws::BedrockAgentRuntime
1129
1211
  RequestBody.add_member(:content, Shapes::ShapeRef.new(shape: ContentMap, location_name: "content"))
1130
1212
  RequestBody.struct_class = Types::RequestBody
1131
1213
 
1214
+ RerankDocument.add_member(:json_document, Shapes::ShapeRef.new(shape: Document, location_name: "jsonDocument"))
1215
+ RerankDocument.add_member(:text_document, Shapes::ShapeRef.new(shape: RerankTextDocument, location_name: "textDocument"))
1216
+ RerankDocument.add_member(:type, Shapes::ShapeRef.new(shape: RerankDocumentType, required: true, location_name: "type"))
1217
+ RerankDocument.struct_class = Types::RerankDocument
1218
+
1219
+ RerankQueriesList.member = Shapes::ShapeRef.new(shape: RerankQuery)
1220
+
1221
+ RerankQuery.add_member(:text_query, Shapes::ShapeRef.new(shape: RerankTextDocument, required: true, location_name: "textQuery"))
1222
+ RerankQuery.add_member(:type, Shapes::ShapeRef.new(shape: RerankQueryContentType, required: true, location_name: "type"))
1223
+ RerankQuery.struct_class = Types::RerankQuery
1224
+
1225
+ RerankRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
1226
+ RerankRequest.add_member(:queries, Shapes::ShapeRef.new(shape: RerankQueriesList, required: true, location_name: "queries"))
1227
+ RerankRequest.add_member(:reranking_configuration, Shapes::ShapeRef.new(shape: RerankingConfiguration, required: true, location_name: "rerankingConfiguration"))
1228
+ RerankRequest.add_member(:sources, Shapes::ShapeRef.new(shape: RerankSourcesList, required: true, location_name: "sources"))
1229
+ RerankRequest.struct_class = Types::RerankRequest
1230
+
1231
+ RerankResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
1232
+ RerankResponse.add_member(:results, Shapes::ShapeRef.new(shape: RerankResultsList, required: true, location_name: "results"))
1233
+ RerankResponse.struct_class = Types::RerankResponse
1234
+
1235
+ RerankResult.add_member(:document, Shapes::ShapeRef.new(shape: RerankDocument, location_name: "document"))
1236
+ RerankResult.add_member(:index, Shapes::ShapeRef.new(shape: RerankResultIndexInteger, required: true, location_name: "index"))
1237
+ RerankResult.add_member(:relevance_score, Shapes::ShapeRef.new(shape: Float, required: true, location_name: "relevanceScore"))
1238
+ RerankResult.struct_class = Types::RerankResult
1239
+
1240
+ RerankResultsList.member = Shapes::ShapeRef.new(shape: RerankResult)
1241
+
1242
+ RerankSource.add_member(:inline_document_source, Shapes::ShapeRef.new(shape: RerankDocument, required: true, location_name: "inlineDocumentSource"))
1243
+ RerankSource.add_member(:type, Shapes::ShapeRef.new(shape: RerankSourceType, required: true, location_name: "type"))
1244
+ RerankSource.struct_class = Types::RerankSource
1245
+
1246
+ RerankSourcesList.member = Shapes::ShapeRef.new(shape: RerankSource)
1247
+
1248
+ RerankTextDocument.add_member(:text, Shapes::ShapeRef.new(shape: RerankTextDocumentTextString, location_name: "text"))
1249
+ RerankTextDocument.struct_class = Types::RerankTextDocument
1250
+
1251
+ RerankingConfiguration.add_member(:bedrock_reranking_configuration, Shapes::ShapeRef.new(shape: BedrockRerankingConfiguration, required: true, location_name: "bedrockRerankingConfiguration"))
1252
+ RerankingConfiguration.add_member(:type, Shapes::ShapeRef.new(shape: RerankingConfigurationType, required: true, location_name: "type"))
1253
+ RerankingConfiguration.struct_class = Types::RerankingConfiguration
1254
+
1255
+ RerankingMetadataSelectiveModeConfiguration.add_member(:fields_to_exclude, Shapes::ShapeRef.new(shape: FieldsForReranking, location_name: "fieldsToExclude"))
1256
+ RerankingMetadataSelectiveModeConfiguration.add_member(:fields_to_include, Shapes::ShapeRef.new(shape: FieldsForReranking, location_name: "fieldsToInclude"))
1257
+ RerankingMetadataSelectiveModeConfiguration.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
1258
+ RerankingMetadataSelectiveModeConfiguration.add_member_subclass(:fields_to_exclude, Types::RerankingMetadataSelectiveModeConfiguration::FieldsToExclude)
1259
+ RerankingMetadataSelectiveModeConfiguration.add_member_subclass(:fields_to_include, Types::RerankingMetadataSelectiveModeConfiguration::FieldsToInclude)
1260
+ RerankingMetadataSelectiveModeConfiguration.add_member_subclass(:unknown, Types::RerankingMetadataSelectiveModeConfiguration::Unknown)
1261
+ RerankingMetadataSelectiveModeConfiguration.struct_class = Types::RerankingMetadataSelectiveModeConfiguration
1262
+
1132
1263
  ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
1133
1264
  ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
1134
1265
 
@@ -1188,7 +1319,11 @@ module Aws::BedrockAgentRuntime
1188
1319
  RetrievalResultContent.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "text"))
1189
1320
  RetrievalResultContent.struct_class = Types::RetrievalResultContent
1190
1321
 
1322
+ RetrievalResultCustomDocumentLocation.add_member(:id, Shapes::ShapeRef.new(shape: String, location_name: "id"))
1323
+ RetrievalResultCustomDocumentLocation.struct_class = Types::RetrievalResultCustomDocumentLocation
1324
+
1191
1325
  RetrievalResultLocation.add_member(:confluence_location, Shapes::ShapeRef.new(shape: RetrievalResultConfluenceLocation, location_name: "confluenceLocation"))
1326
+ RetrievalResultLocation.add_member(:custom_document_location, Shapes::ShapeRef.new(shape: RetrievalResultCustomDocumentLocation, location_name: "customDocumentLocation"))
1192
1327
  RetrievalResultLocation.add_member(:s3_location, Shapes::ShapeRef.new(shape: RetrievalResultS3Location, location_name: "s3Location"))
1193
1328
  RetrievalResultLocation.add_member(:salesforce_location, Shapes::ShapeRef.new(shape: RetrievalResultSalesforceLocation, location_name: "salesforceLocation"))
1194
1329
  RetrievalResultLocation.add_member(:share_point_location, Shapes::ShapeRef.new(shape: RetrievalResultSharePointLocation, location_name: "sharePointLocation"))
@@ -1222,6 +1357,9 @@ module Aws::BedrockAgentRuntime
1222
1357
  RetrieveAndGenerateOutput.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "text"))
1223
1358
  RetrieveAndGenerateOutput.struct_class = Types::RetrieveAndGenerateOutput
1224
1359
 
1360
+ RetrieveAndGenerateOutputEvent.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "text"))
1361
+ RetrieveAndGenerateOutputEvent.struct_class = Types::RetrieveAndGenerateOutputEvent
1362
+
1225
1363
  RetrieveAndGenerateRequest.add_member(:input, Shapes::ShapeRef.new(shape: RetrieveAndGenerateInput, required: true, location_name: "input"))
1226
1364
  RetrieveAndGenerateRequest.add_member(:retrieve_and_generate_configuration, Shapes::ShapeRef.new(shape: RetrieveAndGenerateConfiguration, location_name: "retrieveAndGenerateConfiguration"))
1227
1365
  RetrieveAndGenerateRequest.add_member(:session_configuration, Shapes::ShapeRef.new(shape: RetrieveAndGenerateSessionConfiguration, location_name: "sessionConfiguration"))
@@ -1237,12 +1375,40 @@ module Aws::BedrockAgentRuntime
1237
1375
  RetrieveAndGenerateSessionConfiguration.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, required: true, location_name: "kmsKeyArn"))
1238
1376
  RetrieveAndGenerateSessionConfiguration.struct_class = Types::RetrieveAndGenerateSessionConfiguration
1239
1377
 
1378
+ RetrieveAndGenerateStreamRequest.add_member(:input, Shapes::ShapeRef.new(shape: RetrieveAndGenerateInput, required: true, location_name: "input"))
1379
+ RetrieveAndGenerateStreamRequest.add_member(:retrieve_and_generate_configuration, Shapes::ShapeRef.new(shape: RetrieveAndGenerateConfiguration, location_name: "retrieveAndGenerateConfiguration"))
1380
+ RetrieveAndGenerateStreamRequest.add_member(:session_configuration, Shapes::ShapeRef.new(shape: RetrieveAndGenerateSessionConfiguration, location_name: "sessionConfiguration"))
1381
+ RetrieveAndGenerateStreamRequest.add_member(:session_id, Shapes::ShapeRef.new(shape: SessionId, location_name: "sessionId"))
1382
+ RetrieveAndGenerateStreamRequest.struct_class = Types::RetrieveAndGenerateStreamRequest
1383
+
1384
+ RetrieveAndGenerateStreamResponse.add_member(:session_id, Shapes::ShapeRef.new(shape: SessionId, required: true, location: "header", location_name: "x-amzn-bedrock-knowledge-base-session-id"))
1385
+ RetrieveAndGenerateStreamResponse.add_member(:stream, Shapes::ShapeRef.new(shape: RetrieveAndGenerateStreamResponseOutput, required: true, eventstream: true, location_name: "stream"))
1386
+ RetrieveAndGenerateStreamResponse.struct_class = Types::RetrieveAndGenerateStreamResponse
1387
+ RetrieveAndGenerateStreamResponse[:payload] = :stream
1388
+ RetrieveAndGenerateStreamResponse[:payload_member] = RetrieveAndGenerateStreamResponse.member(:stream)
1389
+
1390
+ RetrieveAndGenerateStreamResponseOutput.add_member(:access_denied_exception, Shapes::ShapeRef.new(shape: AccessDeniedException, location_name: "accessDeniedException"))
1391
+ RetrieveAndGenerateStreamResponseOutput.add_member(:bad_gateway_exception, Shapes::ShapeRef.new(shape: BadGatewayException, location_name: "badGatewayException"))
1392
+ RetrieveAndGenerateStreamResponseOutput.add_member(:citation, Shapes::ShapeRef.new(shape: CitationEvent, event: true, location_name: "citation"))
1393
+ RetrieveAndGenerateStreamResponseOutput.add_member(:conflict_exception, Shapes::ShapeRef.new(shape: ConflictException, location_name: "conflictException"))
1394
+ RetrieveAndGenerateStreamResponseOutput.add_member(:dependency_failed_exception, Shapes::ShapeRef.new(shape: DependencyFailedException, location_name: "dependencyFailedException"))
1395
+ RetrieveAndGenerateStreamResponseOutput.add_member(:guardrail, Shapes::ShapeRef.new(shape: GuardrailEvent, event: true, location_name: "guardrail"))
1396
+ RetrieveAndGenerateStreamResponseOutput.add_member(:internal_server_exception, Shapes::ShapeRef.new(shape: InternalServerException, location_name: "internalServerException"))
1397
+ RetrieveAndGenerateStreamResponseOutput.add_member(:output, Shapes::ShapeRef.new(shape: RetrieveAndGenerateOutputEvent, event: true, location_name: "output"))
1398
+ RetrieveAndGenerateStreamResponseOutput.add_member(:resource_not_found_exception, Shapes::ShapeRef.new(shape: ResourceNotFoundException, location_name: "resourceNotFoundException"))
1399
+ RetrieveAndGenerateStreamResponseOutput.add_member(:service_quota_exceeded_exception, Shapes::ShapeRef.new(shape: ServiceQuotaExceededException, location_name: "serviceQuotaExceededException"))
1400
+ RetrieveAndGenerateStreamResponseOutput.add_member(:throttling_exception, Shapes::ShapeRef.new(shape: ThrottlingException, location_name: "throttlingException"))
1401
+ RetrieveAndGenerateStreamResponseOutput.add_member(:validation_exception, Shapes::ShapeRef.new(shape: ValidationException, location_name: "validationException"))
1402
+ RetrieveAndGenerateStreamResponseOutput.struct_class = Types::RetrieveAndGenerateStreamResponseOutput
1403
+
1404
+ RetrieveRequest.add_member(:guardrail_configuration, Shapes::ShapeRef.new(shape: GuardrailConfiguration, location_name: "guardrailConfiguration"))
1240
1405
  RetrieveRequest.add_member(:knowledge_base_id, Shapes::ShapeRef.new(shape: KnowledgeBaseId, required: true, location: "uri", location_name: "knowledgeBaseId"))
1241
1406
  RetrieveRequest.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
1242
1407
  RetrieveRequest.add_member(:retrieval_configuration, Shapes::ShapeRef.new(shape: KnowledgeBaseRetrievalConfiguration, location_name: "retrievalConfiguration"))
1243
1408
  RetrieveRequest.add_member(:retrieval_query, Shapes::ShapeRef.new(shape: KnowledgeBaseQuery, required: true, location_name: "retrievalQuery"))
1244
1409
  RetrieveRequest.struct_class = Types::RetrieveRequest
1245
1410
 
1411
+ RetrieveResponse.add_member(:guardrail_action, Shapes::ShapeRef.new(shape: GuadrailAction, location_name: "guardrailAction"))
1246
1412
  RetrieveResponse.add_member(:next_token, Shapes::ShapeRef.new(shape: NextToken, location_name: "nextToken"))
1247
1413
  RetrieveResponse.add_member(:retrieval_results, Shapes::ShapeRef.new(shape: KnowledgeBaseRetrievalResults, required: true, location_name: "retrievalResults"))
1248
1414
  RetrieveResponse.struct_class = Types::RetrieveResponse
@@ -1340,6 +1506,19 @@ module Aws::BedrockAgentRuntime
1340
1506
  ValidationException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
1341
1507
  ValidationException.struct_class = Types::ValidationException
1342
1508
 
1509
+ VectorSearchBedrockRerankingConfiguration.add_member(:metadata_configuration, Shapes::ShapeRef.new(shape: MetadataConfigurationForReranking, location_name: "metadataConfiguration"))
1510
+ VectorSearchBedrockRerankingConfiguration.add_member(:model_configuration, Shapes::ShapeRef.new(shape: VectorSearchBedrockRerankingModelConfiguration, required: true, location_name: "modelConfiguration"))
1511
+ VectorSearchBedrockRerankingConfiguration.add_member(:number_of_reranked_results, Shapes::ShapeRef.new(shape: VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger, location_name: "numberOfRerankedResults"))
1512
+ VectorSearchBedrockRerankingConfiguration.struct_class = Types::VectorSearchBedrockRerankingConfiguration
1513
+
1514
+ VectorSearchBedrockRerankingModelConfiguration.add_member(:additional_model_request_fields, Shapes::ShapeRef.new(shape: AdditionalModelRequestFields, location_name: "additionalModelRequestFields"))
1515
+ VectorSearchBedrockRerankingModelConfiguration.add_member(:model_arn, Shapes::ShapeRef.new(shape: BedrockRerankingModelArn, required: true, location_name: "modelArn"))
1516
+ VectorSearchBedrockRerankingModelConfiguration.struct_class = Types::VectorSearchBedrockRerankingModelConfiguration
1517
+
1518
+ VectorSearchRerankingConfiguration.add_member(:bedrock_reranking_configuration, Shapes::ShapeRef.new(shape: VectorSearchBedrockRerankingConfiguration, location_name: "bedrockRerankingConfiguration"))
1519
+ VectorSearchRerankingConfiguration.add_member(:type, Shapes::ShapeRef.new(shape: VectorSearchRerankingConfigurationType, required: true, location_name: "type"))
1520
+ VectorSearchRerankingConfiguration.struct_class = Types::VectorSearchRerankingConfiguration
1521
+
1343
1522
 
1344
1523
  # @api private
1345
1524
  API = Seahorse::Model::Api.new.tap do |api|
@@ -1465,6 +1644,28 @@ module Aws::BedrockAgentRuntime
1465
1644
  o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1466
1645
  end)
1467
1646
 
1647
+ api.add_operation(:rerank, Seahorse::Model::Operation.new.tap do |o|
1648
+ o.name = "Rerank"
1649
+ o.http_method = "POST"
1650
+ o.http_request_uri = "/rerank"
1651
+ o.input = Shapes::ShapeRef.new(shape: RerankRequest)
1652
+ o.output = Shapes::ShapeRef.new(shape: RerankResponse)
1653
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
1654
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1655
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
1656
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1657
+ o.errors << Shapes::ShapeRef.new(shape: DependencyFailedException)
1658
+ o.errors << Shapes::ShapeRef.new(shape: BadGatewayException)
1659
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1660
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1661
+ o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
1662
+ o[:pager] = Aws::Pager.new(
1663
+ tokens: {
1664
+ "next_token" => "next_token"
1665
+ }
1666
+ )
1667
+ end)
1668
+
1468
1669
  api.add_operation(:retrieve, Seahorse::Model::Operation.new.tap do |o|
1469
1670
  o.name = "Retrieve"
1470
1671
  o.http_method = "POST"
@@ -1503,6 +1704,23 @@ module Aws::BedrockAgentRuntime
1503
1704
  o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1504
1705
  o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
1505
1706
  end)
1707
+
1708
+ api.add_operation(:retrieve_and_generate_stream, Seahorse::Model::Operation.new.tap do |o|
1709
+ o.name = "RetrieveAndGenerateStream"
1710
+ o.http_method = "POST"
1711
+ o.http_request_uri = "/retrieveAndGenerateStream"
1712
+ o.input = Shapes::ShapeRef.new(shape: RetrieveAndGenerateStreamRequest)
1713
+ o.output = Shapes::ShapeRef.new(shape: RetrieveAndGenerateStreamResponse)
1714
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
1715
+ o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
1716
+ o.errors << Shapes::ShapeRef.new(shape: ValidationException)
1717
+ o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
1718
+ o.errors << Shapes::ShapeRef.new(shape: DependencyFailedException)
1719
+ o.errors << Shapes::ShapeRef.new(shape: BadGatewayException)
1720
+ o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
1721
+ o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
1722
+ o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
1723
+ end)
1506
1724
  end
1507
1725
 
1508
1726
  end
@@ -355,6 +355,95 @@ module Aws::BedrockAgentRuntime
355
355
  attr_reader :event_emitter
356
356
 
357
357
  end
358
+ class RetrieveAndGenerateStreamResponseOutput
359
+
360
+ def initialize
361
+ @event_emitter = Aws::EventEmitter.new
362
+ end
363
+
364
+ def on_access_denied_exception_event(&block)
365
+ @event_emitter.on(:access_denied_exception, block) if block_given?
366
+ end
367
+
368
+ def on_bad_gateway_exception_event(&block)
369
+ @event_emitter.on(:bad_gateway_exception, block) if block_given?
370
+ end
371
+
372
+ def on_citation_event(&block)
373
+ @event_emitter.on(:citation, block) if block_given?
374
+ end
375
+
376
+ def on_conflict_exception_event(&block)
377
+ @event_emitter.on(:conflict_exception, block) if block_given?
378
+ end
379
+
380
+ def on_dependency_failed_exception_event(&block)
381
+ @event_emitter.on(:dependency_failed_exception, block) if block_given?
382
+ end
383
+
384
+ def on_guardrail_event(&block)
385
+ @event_emitter.on(:guardrail, block) if block_given?
386
+ end
387
+
388
+ def on_internal_server_exception_event(&block)
389
+ @event_emitter.on(:internal_server_exception, block) if block_given?
390
+ end
391
+
392
+ def on_output_event(&block)
393
+ @event_emitter.on(:output, block) if block_given?
394
+ end
395
+
396
+ def on_resource_not_found_exception_event(&block)
397
+ @event_emitter.on(:resource_not_found_exception, block) if block_given?
398
+ end
399
+
400
+ def on_service_quota_exceeded_exception_event(&block)
401
+ @event_emitter.on(:service_quota_exceeded_exception, block) if block_given?
402
+ end
403
+
404
+ def on_throttling_exception_event(&block)
405
+ @event_emitter.on(:throttling_exception, block) if block_given?
406
+ end
407
+
408
+ def on_validation_exception_event(&block)
409
+ @event_emitter.on(:validation_exception, block) if block_given?
410
+ end
411
+
412
+ def on_error_event(&block)
413
+ @event_emitter.on(:error, block) if block_given?
414
+ end
415
+
416
+ def on_initial_response_event(&block)
417
+ @event_emitter.on(:initial_response, block) if block_given?
418
+ end
419
+
420
+ def on_unknown_event(&block)
421
+ @event_emitter.on(:unknown_event, block) if block_given?
422
+ end
423
+
424
+ def on_event(&block)
425
+ on_access_denied_exception_event(&block)
426
+ on_bad_gateway_exception_event(&block)
427
+ on_citation_event(&block)
428
+ on_conflict_exception_event(&block)
429
+ on_dependency_failed_exception_event(&block)
430
+ on_guardrail_event(&block)
431
+ on_internal_server_exception_event(&block)
432
+ on_output_event(&block)
433
+ on_resource_not_found_exception_event(&block)
434
+ on_service_quota_exceeded_exception_event(&block)
435
+ on_throttling_exception_event(&block)
436
+ on_validation_exception_event(&block)
437
+ on_error_event(&block)
438
+ on_initial_response_event(&block)
439
+ on_unknown_event(&block)
440
+ end
441
+
442
+ # @api private
443
+ # @return Aws::EventEmitter
444
+ attr_reader :event_emitter
445
+
446
+ end
358
447
 
359
448
  end
360
449
  end