aws-sdk-bedrockagentruntime 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cc803bf4f889db4885d44233100f88828fc7cfb99149a1a2ac536104e28e629
-  data.tar.gz: 99eb1b4a9fbc673091079294ec6a5c69db1ea6c59ece19b623ed9f1dce14a0a2
+  metadata.gz: 24e10fc42b8ea0b4e35d44ca0c691949feaab6fe28ebe2a12c290ea005730c27
+  data.tar.gz: 7239ae58b7fc4a5343de154490f9c81eb7011fdd9a1be9472fc64575f6b4f803
 SHA512:
-  metadata.gz: cd0d0b58178239d1ef2eed238b570d86a4a2b5f260cd5e3c21a2957f4299b1ef6bc92119691d1581c035765009d068396d2fed6a93838910f52bdda6c55b9017
-  data.tar.gz: 8d9f09594ad68bcd0f79990e9ade1524719349ddde8c5e89370fa058e44f4bea7fe274aff63d3c646b034abb3089a0eda266444d522b5981d6025e5367f9f400
+  metadata.gz: 3f4d8ef61cdf0882cea1ab50df77212c91dda6f4a9457ad6632702c328f21fa20c1ff2dcff52544e935f747bb7b973c65f68ee40d77c63342c14f079599be7d7
+  data.tar.gz: 7b77085b8fe83e0f72e6276a82403b2a891515a51c3f2957860d516cb4b9657ea8be881250cda8abe01cd5417ef783b2ee499b8a84484bf72ca3f82f2e483ae6

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.5.0 (2024-03-27)
+------------------
+
+* Feature - This release introduces filtering support on Retrieve and RetrieveAndGenerate APIs.
+
 1.4.0 (2024-03-26)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.4.0
+1.5.0

data/lib/aws-sdk-bedrockagentruntime/client.rb

@@ -686,6 +686,7 @@ module Aws::BedrockAgentRuntime
     #   event.attribution.citations[0].retrieved_references[0].content.text #=> String
     #   event.attribution.citations[0].retrieved_references[0].location.s3_location.uri #=> String
     #   event.attribution.citations[0].retrieved_references[0].location.type #=> String, one of "S3"
+    #   event.attribution.citations[0].retrieved_references[0].metadata #=> Hash
     #   event.bytes #=> String
     #
     #   For :conflict_exception event available at #on_conflict_exception_event callback and response eventstream enumerator:
@@ -747,6 +748,7 @@ module Aws::BedrockAgentRuntime
     #   event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].content.text #=> String
     #   event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.s3_location.uri #=> String
     #   event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].location.type #=> String, one of "S3"
+    #   event.trace.orchestration_trace.observation.knowledge_base_lookup_output.retrieved_references[0].metadata #=> Hash
     #   event.trace.orchestration_trace.observation.reprompt_response.source #=> String, one of "ACTION_GROUP", "KNOWLEDGE_BASE", "PARSER"
     #   event.trace.orchestration_trace.observation.reprompt_response.text #=> String
     #   event.trace.orchestration_trace.observation.trace_id #=> String
@@ -851,6 +853,63 @@ module Aws::BedrockAgentRuntime
     #     next_token: "NextToken",
     #     retrieval_configuration: {
     #       vector_search_configuration: { # required
+    #         filter: {
+    #           and_all: [
+    #             {
+    #               # recursive RetrievalFilter
+    #             },
+    #           ],
+    #           equals: {
+    #             key: "FilterKey", # required
+    #             value: { # required
+    #             },
+    #           },
+    #           greater_than: {
+    #             key: "FilterKey", # required
+    #             value: { # required
+    #             },
+    #           },
+    #           greater_than_or_equals: {
+    #             key: "FilterKey", # required
+    #             value: { # required
+    #             },
+    #           },
+    #           in: {
+    #             key: "FilterKey", # required
+    #             value: { # required
+    #             },
+    #           },
+    #           less_than: {
+    #             key: "FilterKey", # required
+    #             value: { # required
+    #             },
+    #           },
+    #           less_than_or_equals: {
+    #             key: "FilterKey", # required
+    #             value: { # required
+    #             },
+    #           },
+    #           not_equals: {
+    #             key: "FilterKey", # required
+    #             value: { # required
+    #             },
+    #           },
+    #           not_in: {
+    #             key: "FilterKey", # required
+    #             value: { # required
+    #             },
+    #           },
+    #           or_all: [
+    #             {
+    #               # recursive RetrievalFilter
+    #             },
+    #           ],
+    #           starts_with: {
+    #             key: "FilterKey", # required
+    #             value: { # required
+    #             },
+    #           },
+    #         },
     #         number_of_results: 1,
     #         override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
     #       },
@@ -867,6 +926,7 @@ module Aws::BedrockAgentRuntime
     #   resp.retrieval_results[0].content.text #=> String
     #   resp.retrieval_results[0].location.s3_location.uri #=> String
     #   resp.retrieval_results[0].location.type #=> String, one of "S3"
+    #   resp.retrieval_results[0].metadata #=> Hash
     #   resp.retrieval_results[0].score #=> Float
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/Retrieve AWS API Documentation
@@ -879,8 +939,8 @@ module Aws::BedrockAgentRuntime
     end
 
     # Queries a knowledge base and generates responses based on the
-    # retrieved results. The response cites up to five sources but only
-    # selects the ones that are relevant to the query.
+    # retrieved results. The response only cites sources that are relevant
+    # to the query.
     #
     # @option params [required, Types::RetrieveAndGenerateInput] :input
     #   Contains the query to be made to the knowledge base.
@@ -923,6 +983,63 @@ module Aws::BedrockAgentRuntime
     #         model_arn: "BedrockModelArn", # required
     #         retrieval_configuration: {
     #           vector_search_configuration: { # required
+    #             filter: {
+    #               and_all: [
+    #                 {
+    #                   # recursive RetrievalFilter
+    #                 },
+    #               ],
+    #               equals: {
+    #                 key: "FilterKey", # required
+    #                 value: { # required
+    #                 },
+    #               },
+    #               greater_than: {
+    #                 key: "FilterKey", # required
+    #                 value: { # required
+    #                 },
+    #               },
+    #               greater_than_or_equals: {
+    #                 key: "FilterKey", # required
+    #                 value: { # required
+    #                 },
+    #               },
+    #               in: {
+    #                 key: "FilterKey", # required
+    #                 value: { # required
+    #                 },
+    #               },
+    #               less_than: {
+    #                 key: "FilterKey", # required
+    #                 value: { # required
+    #                 },
+    #               },
+    #               less_than_or_equals: {
+    #                 key: "FilterKey", # required
+    #                 value: { # required
+    #                 },
+    #               },
+    #               not_equals: {
+    #                 key: "FilterKey", # required
+    #                 value: { # required
+    #                 },
+    #               },
+    #               not_in: {
+    #                 key: "FilterKey", # required
+    #                 value: { # required
+    #                 },
+    #               },
+    #               or_all: [
+    #                 {
+    #                   # recursive RetrievalFilter
+    #                 },
+    #               ],
+    #               starts_with: {
+    #                 key: "FilterKey", # required
+    #                 value: { # required
+    #                 },
+    #               },
+    #             },
     #             number_of_results: 1,
     #             override_search_type: "HYBRID", # accepts HYBRID, SEMANTIC
     #           },
@@ -946,6 +1063,7 @@ module Aws::BedrockAgentRuntime
     #   resp.citations[0].retrieved_references[0].content.text #=> String
     #   resp.citations[0].retrieved_references[0].location.s3_location.uri #=> String
     #   resp.citations[0].retrieved_references[0].location.type #=> String, one of "S3"
+    #   resp.citations[0].retrieved_references[0].metadata #=> Hash
     #   resp.output.text #=> String
     #   resp.session_id #=> String
     #
@@ -971,7 +1089,7 @@ module Aws::BedrockAgentRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-bedrockagentruntime'
-      context[:gem_version] = '1.4.0'
+      context[:gem_version] = '1.5.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-bedrockagentruntime/client_api.rb

@@ -34,6 +34,9 @@ module Aws::BedrockAgentRuntime
     Double = Shapes::FloatShape.new(name: 'Double')
     FailureReasonString = Shapes::StringShape.new(name: 'FailureReasonString')
     FailureTrace = Shapes::StructureShape.new(name: 'FailureTrace')
+    FilterAttribute = Shapes::StructureShape.new(name: 'FilterAttribute')
+    FilterKey = Shapes::StringShape.new(name: 'FilterKey')
+    FilterValue = Shapes::DocumentShape.new(name: 'FilterValue', document: true)
     FinalResponse = Shapes::StructureShape.new(name: 'FinalResponse')
     FinalResponseString = Shapes::StringShape.new(name: 'FinalResponseString')
     GeneratedResponsePart = Shapes::StructureShape.new(name: 'GeneratedResponsePart')
@@ -87,9 +90,14 @@ module Aws::BedrockAgentRuntime
     RequestBody = Shapes::StructureShape.new(name: 'RequestBody')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     ResponseStream = Shapes::StructureShape.new(name: 'ResponseStream')
+    RetrievalFilter = Shapes::UnionShape.new(name: 'RetrievalFilter')
+    RetrievalFilterList = Shapes::ListShape.new(name: 'RetrievalFilterList')
     RetrievalResultContent = Shapes::StructureShape.new(name: 'RetrievalResultContent')
     RetrievalResultLocation = Shapes::StructureShape.new(name: 'RetrievalResultLocation')
     RetrievalResultLocationType = Shapes::StringShape.new(name: 'RetrievalResultLocationType')
+    RetrievalResultMetadata = Shapes::MapShape.new(name: 'RetrievalResultMetadata')
+    RetrievalResultMetadataKey = Shapes::StringShape.new(name: 'RetrievalResultMetadataKey')
+    RetrievalResultMetadataValue = Shapes::DocumentShape.new(name: 'RetrievalResultMetadataValue', document: true)
     RetrievalResultS3Location = Shapes::StructureShape.new(name: 'RetrievalResultS3Location')
     RetrieveAndGenerateConfiguration = Shapes::StructureShape.new(name: 'RetrieveAndGenerateConfiguration')
     RetrieveAndGenerateInput = Shapes::StructureShape.new(name: 'RetrieveAndGenerateInput')
@@ -168,6 +176,10 @@ module Aws::BedrockAgentRuntime
     FailureTrace.add_member(:trace_id, Shapes::ShapeRef.new(shape: TraceId, location_name: "traceId"))
     FailureTrace.struct_class = Types::FailureTrace
 
+    FilterAttribute.add_member(:key, Shapes::ShapeRef.new(shape: FilterKey, required: true, location_name: "key"))
+    FilterAttribute.add_member(:value, Shapes::ShapeRef.new(shape: FilterValue, required: true, location_name: "value"))
+    FilterAttribute.struct_class = Types::FilterAttribute
+
     FinalResponse.add_member(:text, Shapes::ShapeRef.new(shape: FinalResponseString, location_name: "text"))
     FinalResponse.struct_class = Types::FinalResponse
 
@@ -224,6 +236,7 @@ module Aws::BedrockAgentRuntime
 
     KnowledgeBaseRetrievalResult.add_member(:content, Shapes::ShapeRef.new(shape: RetrievalResultContent, required: true, location_name: "content"))
     KnowledgeBaseRetrievalResult.add_member(:location, Shapes::ShapeRef.new(shape: RetrievalResultLocation, location_name: "location"))
+    KnowledgeBaseRetrievalResult.add_member(:metadata, Shapes::ShapeRef.new(shape: RetrievalResultMetadata, location_name: "metadata"))
     KnowledgeBaseRetrievalResult.add_member(:score, Shapes::ShapeRef.new(shape: Double, location_name: "score"))
     KnowledgeBaseRetrievalResult.struct_class = Types::KnowledgeBaseRetrievalResult
 
@@ -235,6 +248,7 @@ module Aws::BedrockAgentRuntime
     KnowledgeBaseRetrieveAndGenerateConfiguration.add_member(:retrieval_configuration, Shapes::ShapeRef.new(shape: KnowledgeBaseRetrievalConfiguration, location_name: "retrievalConfiguration"))
     KnowledgeBaseRetrieveAndGenerateConfiguration.struct_class = Types::KnowledgeBaseRetrieveAndGenerateConfiguration
 
+    KnowledgeBaseVectorSearchConfiguration.add_member(:filter, Shapes::ShapeRef.new(shape: RetrievalFilter, location_name: "filter"))
     KnowledgeBaseVectorSearchConfiguration.add_member(:number_of_results, Shapes::ShapeRef.new(shape: KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger, location_name: "numberOfResults", metadata: {"box"=>true}))
     KnowledgeBaseVectorSearchConfiguration.add_member(:override_search_type, Shapes::ShapeRef.new(shape: SearchType, location_name: "overrideSearchType"))
     KnowledgeBaseVectorSearchConfiguration.struct_class = Types::KnowledgeBaseVectorSearchConfiguration
@@ -343,6 +357,34 @@ module Aws::BedrockAgentRuntime
     ResponseStream.add_member(:validation_exception, Shapes::ShapeRef.new(shape: ValidationException, location_name: "validationException"))
     ResponseStream.struct_class = Types::ResponseStream
 
+    RetrievalFilter.add_member(:and_all, Shapes::ShapeRef.new(shape: RetrievalFilterList, location_name: "andAll"))
+    RetrievalFilter.add_member(:equals, Shapes::ShapeRef.new(shape: FilterAttribute, location_name: "equals"))
+    RetrievalFilter.add_member(:greater_than, Shapes::ShapeRef.new(shape: FilterAttribute, location_name: "greaterThan"))
+    RetrievalFilter.add_member(:greater_than_or_equals, Shapes::ShapeRef.new(shape: FilterAttribute, location_name: "greaterThanOrEquals"))
+    RetrievalFilter.add_member(:in, Shapes::ShapeRef.new(shape: FilterAttribute, location_name: "in"))
+    RetrievalFilter.add_member(:less_than, Shapes::ShapeRef.new(shape: FilterAttribute, location_name: "lessThan"))
+    RetrievalFilter.add_member(:less_than_or_equals, Shapes::ShapeRef.new(shape: FilterAttribute, location_name: "lessThanOrEquals"))
+    RetrievalFilter.add_member(:not_equals, Shapes::ShapeRef.new(shape: FilterAttribute, location_name: "notEquals"))
+    RetrievalFilter.add_member(:not_in, Shapes::ShapeRef.new(shape: FilterAttribute, location_name: "notIn"))
+    RetrievalFilter.add_member(:or_all, Shapes::ShapeRef.new(shape: RetrievalFilterList, location_name: "orAll"))
+    RetrievalFilter.add_member(:starts_with, Shapes::ShapeRef.new(shape: FilterAttribute, location_name: "startsWith"))
+    RetrievalFilter.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    RetrievalFilter.add_member_subclass(:and_all, Types::RetrievalFilter::AndAll)
+    RetrievalFilter.add_member_subclass(:equals, Types::RetrievalFilter::Equals)
+    RetrievalFilter.add_member_subclass(:greater_than, Types::RetrievalFilter::GreaterThan)
+    RetrievalFilter.add_member_subclass(:greater_than_or_equals, Types::RetrievalFilter::GreaterThanOrEquals)
+    RetrievalFilter.add_member_subclass(:in, Types::RetrievalFilter::In)
+    RetrievalFilter.add_member_subclass(:less_than, Types::RetrievalFilter::LessThan)
+    RetrievalFilter.add_member_subclass(:less_than_or_equals, Types::RetrievalFilter::LessThanOrEquals)
+    RetrievalFilter.add_member_subclass(:not_equals, Types::RetrievalFilter::NotEquals)
+    RetrievalFilter.add_member_subclass(:not_in, Types::RetrievalFilter::NotIn)
+    RetrievalFilter.add_member_subclass(:or_all, Types::RetrievalFilter::OrAll)
+    RetrievalFilter.add_member_subclass(:starts_with, Types::RetrievalFilter::StartsWith)
+    RetrievalFilter.add_member_subclass(:unknown, Types::RetrievalFilter::Unknown)
+    RetrievalFilter.struct_class = Types::RetrievalFilter
+
+    RetrievalFilterList.member = Shapes::ShapeRef.new(shape: RetrievalFilter)
+
     RetrievalResultContent.add_member(:text, Shapes::ShapeRef.new(shape: String, required: true, location_name: "text"))
     RetrievalResultContent.struct_class = Types::RetrievalResultContent
 
@@ -350,6 +392,9 @@ module Aws::BedrockAgentRuntime
     RetrievalResultLocation.add_member(:type, Shapes::ShapeRef.new(shape: RetrievalResultLocationType, required: true, location_name: "type"))
     RetrievalResultLocation.struct_class = Types::RetrievalResultLocation
 
+    RetrievalResultMetadata.key = Shapes::ShapeRef.new(shape: RetrievalResultMetadataKey)
+    RetrievalResultMetadata.value = Shapes::ShapeRef.new(shape: RetrievalResultMetadataValue)
+
     RetrievalResultS3Location.add_member(:uri, Shapes::ShapeRef.new(shape: String, location_name: "uri"))
     RetrievalResultS3Location.struct_class = Types::RetrievalResultS3Location
 
@@ -389,6 +434,7 @@ module Aws::BedrockAgentRuntime
 
     RetrievedReference.add_member(:content, Shapes::ShapeRef.new(shape: RetrievalResultContent, location_name: "content"))
     RetrievedReference.add_member(:location, Shapes::ShapeRef.new(shape: RetrievalResultLocation, location_name: "location"))
+    RetrievedReference.add_member(:metadata, Shapes::ShapeRef.new(shape: RetrievalResultMetadata, location_name: "metadata"))
     RetrievedReference.struct_class = Types::RetrievedReference
 
     RetrievedReferences.member = Shapes::ShapeRef.new(shape: RetrievedReference)

data/lib/aws-sdk-bedrockagentruntime/types.rb

@@ -199,6 +199,38 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Specifies the name that the metadata attribute must match and the
+    # value to which to compare the value of the metadata attribute. For
+    # more information, see [Query configurations][1].
+    #
+    # This data type is used in the following API operations:
+    #
+    # * [RetrieveAndGenerate request][2]
+    #
+    # ^
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
+    #
+    # @!attribute [rw] key
+    #   The name that the metadata attribute must match.
+    #   @return [String]
+    #
+    # @!attribute [rw] value
+    #   The value to whcih to compare the value of the metadata attribute.
+    #   @return [Hash,Array,String,Numeric,Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/FilterAttribute AWS API Documentation
+    #
+    class FilterAttribute < Struct.new(
+      :key,
+      :value)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Contains details about the response to the user.
     #
     # @!attribute [rw] text
@@ -558,6 +590,15 @@ module Aws::BedrockAgentRuntime
     #   Contains information about the location of the data source.
     #   @return [Types::RetrievalResultLocation]
     #
+    # @!attribute [rw] metadata
+    #   Contains metadata attributes and their values for the file in the
+    #   data source. For more information, see [Metadata and filtering][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata
+    #   @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
+    #
     # @!attribute [rw] score
     #   The level of relevance of the result to the query.
     #   @return [Float]
@@ -567,8 +608,9 @@ module Aws::BedrockAgentRuntime
     class KnowledgeBaseRetrievalResult < Struct.new(
       :content,
       :location,
+      :metadata,
       :score)
-      SENSITIVE = [:content, :location]
+      SENSITIVE = [:content, :location, :metadata]
       include Aws::Structure
     end
 
@@ -632,6 +674,16 @@ module Aws::BedrockAgentRuntime
     # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
     # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
     #
+    # @!attribute [rw] filter
+    #   Specifies the filters to use on the metadata in the knowledge base
+    #   data sources before returning results. For more information, see
+    #   [Query configurations][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
+    #   @return [Types::RetrievalFilter]
+    #
     # @!attribute [rw] number_of_results
     #   The number of source chunks to retrieve.
     #   @return [Integer]
@@ -654,9 +706,10 @@ module Aws::BedrockAgentRuntime
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/KnowledgeBaseVectorSearchConfiguration AWS API Documentation
     #
     class KnowledgeBaseVectorSearchConfiguration < Struct.new(
+      :filter,
       :number_of_results,
       :override_search_type)
-      SENSITIVE = []
+      SENSITIVE = [:filter]
       include Aws::Structure
     end
 
@@ -1056,7 +1109,7 @@ module Aws::BedrockAgentRuntime
     #
     # This data type is used in the following API operations:
     #
-    # * [RetrieveAndGenerate request][2]
+    # * [RetrieveAndGenerate request][2] – in the `filter` field
     #
     # ^
     #
@@ -1161,6 +1214,122 @@ module Aws::BedrockAgentRuntime
       include Aws::Structure
     end
 
+    # Specifies the filters to use on the metadata attributes in the
+    # knowledge base data sources before returning results. For more
+    # information, see [Query configurations][1].
+    #
+    # This data type is used in the following API operations:
+    #
+    # * [Retrieve request][2] – in the `filter` field
+    #
+    # * [RetrieveAndGenerate request][3] – in the `filter` field
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html
+    # [2]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_Retrieve.html#API_agent-runtime_Retrieve_RequestSyntax
+    # [3]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_agent-runtime_RetrieveAndGenerate.html#API_agent-runtime_RetrieveAndGenerate_RequestSyntax
+    #
+    # @note RetrievalFilter is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @!attribute [rw] and_all
+    #   Knowledge base data sources whose metadata attributes fulfill all
+    #   the filter conditions inside this list are returned.
+    #   @return [Array<Types::RetrievalFilter>]
+    #
+    # @!attribute [rw] equals
+    #   Knowledge base data sources that contain a metadata attribute whose
+    #   name matches the `key` and whose value matches the `value` in this
+    #   object are returned.
+    #   @return [Types::FilterAttribute]
+    #
+    # @!attribute [rw] greater_than
+    #   Knowledge base data sources that contain a metadata attribute whose
+    #   name matches the `key` and whose value is greater than the `value`
+    #   in this object are returned.
+    #   @return [Types::FilterAttribute]
+    #
+    # @!attribute [rw] greater_than_or_equals
+    #   Knowledge base data sources that contain a metadata attribute whose
+    #   name matches the `key` and whose value is greater than or equal to
+    #   the `value` in this object are returned.
+    #   @return [Types::FilterAttribute]
+    #
+    # @!attribute [rw] in
+    #   Knowledge base data sources that contain a metadata attribute whose
+    #   name matches the `key` and whose value is in the list specified in
+    #   the `value` in this object are returned.
+    #   @return [Types::FilterAttribute]
+    #
+    # @!attribute [rw] less_than
+    #   Knowledge base data sources that contain a metadata attribute whose
+    #   name matches the `key` and whose value is less than the `value` in
+    #   this object are returned.
+    #   @return [Types::FilterAttribute]
+    #
+    # @!attribute [rw] less_than_or_equals
+    #   Knowledge base data sources that contain a metadata attribute whose
+    #   name matches the `key` and whose value is less than or equal to the
+    #   `value` in this object are returned.
+    #   @return [Types::FilterAttribute]
+    #
+    # @!attribute [rw] not_equals
+    #   Knowledge base data sources that contain a metadata attribute whose
+    #   name matches the `key` and whose value doesn't match the `value` in
+    #   this object are returned.
+    #   @return [Types::FilterAttribute]
+    #
+    # @!attribute [rw] not_in
+    #   Knowledge base data sources that contain a metadata attribute whose
+    #   name matches the `key` and whose value isn't in the list specified
+    #   in the `value` in this object are returned.
+    #   @return [Types::FilterAttribute]
+    #
+    # @!attribute [rw] or_all
+    #   Knowledge base data sources whose metadata attributes fulfill at
+    #   least one of the filter conditions inside this list are returned.
+    #   @return [Array<Types::RetrievalFilter>]
+    #
+    # @!attribute [rw] starts_with
+    #   Knowledge base data sources that contain a metadata attribute whose
+    #   name matches the `key` and whose value starts with the `value` in
+    #   this object are returned. This filter is currently only supported
+    #   for Amazon OpenSearch Serverless vector stores.
+    #   @return [Types::FilterAttribute]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievalFilter AWS API Documentation
+    #
+    class RetrievalFilter < Struct.new(
+      :and_all,
+      :equals,
+      :greater_than,
+      :greater_than_or_equals,
+      :in,
+      :less_than,
+      :less_than_or_equals,
+      :not_equals,
+      :not_in,
+      :or_all,
+      :starts_with,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class AndAll < RetrievalFilter; end
+      class Equals < RetrievalFilter; end
+      class GreaterThan < RetrievalFilter; end
+      class GreaterThanOrEquals < RetrievalFilter; end
+      class In < RetrievalFilter; end
+      class LessThan < RetrievalFilter; end
+      class LessThanOrEquals < RetrievalFilter; end
+      class NotEquals < RetrievalFilter; end
+      class NotIn < RetrievalFilter; end
+      class OrAll < RetrievalFilter; end
+      class StartsWith < RetrievalFilter; end
+      class Unknown < RetrievalFilter; end
+    end
+
     # Contains the cited text from the data source.
     #
     # This data type is used in the following API operations:
@@ -1483,12 +1652,22 @@ module Aws::BedrockAgentRuntime
     #   Contains information about the location of the data source.
     #   @return [Types::RetrievalResultLocation]
     #
+    # @!attribute [rw] metadata
+    #   Contains metadata attributes and their values for the file in the
+    #   data source. For more information, see [Metadata and filtering][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/knowledge-base-ds.html#kb-ds-metadata
+    #   @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-agent-runtime-2023-07-26/RetrievedReference AWS API Documentation
     #
     class RetrievedReference < Struct.new(
       :content,
-      :location)
-      SENSITIVE = [:content, :location]
+      :location,
+      :metadata)
+      SENSITIVE = [:content, :location, :metadata]
       include Aws::Structure
     end
 

data/lib/aws-sdk-bedrockagentruntime.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-bedrockagentruntime/event_streams'
 # @!group service
 module Aws::BedrockAgentRuntime
 
-  GEM_VERSION = '1.4.0'
+  GEM_VERSION = '1.5.0'
 
 end

data/sig/client.rbs

@@ -107,6 +107,59 @@ module Aws
                       ?next_token: ::String,
                       ?retrieval_configuration: {
                         vector_search_configuration: {
+                          filter: {
+                            and_all: Array[
+                              untyped,
+                            ]?,
+                            equals: {
+                              key: ::String,
+                              value: {
+                              }
+                            }?,
+                            greater_than: {
+                              key: ::String,
+                              value: {
+                              }
+                            }?,
+                            greater_than_or_equals: {
+                              key: ::String,
+                              value: {
+                              }
+                            }?,
+                            in: {
+                              key: ::String,
+                              value: {
+                              }
+                            }?,
+                            less_than: {
+                              key: ::String,
+                              value: {
+                              }
+                            }?,
+                            less_than_or_equals: {
+                              key: ::String,
+                              value: {
+                              }
+                            }?,
+                            not_equals: {
+                              key: ::String,
+                              value: {
+                              }
+                            }?,
+                            not_in: {
+                              key: ::String,
+                              value: {
+                              }
+                            }?,
+                            or_all: Array[
+                              untyped,
+                            ]?,
+                            starts_with: {
+                              key: ::String,
+                              value: {
+                              }
+                            }?
+                          }?,
                           number_of_results: ::Integer?,
                           override_search_type: ("HYBRID" | "SEMANTIC")?
                         }
@@ -139,6 +192,59 @@ module Aws
                                        model_arn: ::String,
                                        retrieval_configuration: {
                                          vector_search_configuration: {
+                                           filter: {
+                                             and_all: Array[
+                                               untyped,
+                                             ]?,
+                                             equals: {
+                                               key: ::String,
+                                               value: {
+                                               }
+                                             }?,
+                                             greater_than: {
+                                               key: ::String,
+                                               value: {
+                                               }
+                                             }?,
+                                             greater_than_or_equals: {
+                                               key: ::String,
+                                               value: {
+                                               }
+                                             }?,
+                                             in: {
+                                               key: ::String,
+                                               value: {
+                                               }
+                                             }?,
+                                             less_than: {
+                                               key: ::String,
+                                               value: {
+                                               }
+                                             }?,
+                                             less_than_or_equals: {
+                                               key: ::String,
+                                               value: {
+                                               }
+                                             }?,
+                                             not_equals: {
+                                               key: ::String,
+                                               value: {
+                                               }
+                                             }?,
+                                             not_in: {
+                                               key: ::String,
+                                               value: {
+                                               }
+                                             }?,
+                                             or_all: Array[
+                                               untyped,
+                                             ]?,
+                                             starts_with: {
+                                               key: ::String,
+                                               value: {
+                                               }
+                                             }?
+                                           }?,
                                            number_of_results: ::Integer?,
                                            override_search_type: ("HYBRID" | "SEMANTIC")?
                                          }

data/sig/types.rbs

@@ -65,6 +65,12 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: [:failure_reason]
     end
 
+    class FilterAttribute
+      attr_accessor key: ::String
+      attr_accessor value: untyped
+      SENSITIVE: []
+    end
+
     class FinalResponse
       attr_accessor text: ::String
       SENSITIVE: [:text]
@@ -145,8 +151,9 @@ module Aws::BedrockAgentRuntime
     class KnowledgeBaseRetrievalResult
       attr_accessor content: Types::RetrievalResultContent
       attr_accessor location: Types::RetrievalResultLocation
+      attr_accessor metadata: ::Hash[::String, untyped]
       attr_accessor score: ::Float
-      SENSITIVE: [:content, :location]
+      SENSITIVE: [:content, :location, :metadata]
     end
 
     class KnowledgeBaseRetrieveAndGenerateConfiguration
@@ -158,9 +165,10 @@ module Aws::BedrockAgentRuntime
     end
 
     class KnowledgeBaseVectorSearchConfiguration
+      attr_accessor filter: Types::RetrievalFilter
       attr_accessor number_of_results: ::Integer
       attr_accessor override_search_type: ("HYBRID" | "SEMANTIC")
-      SENSITIVE: []
+      SENSITIVE: [:filter]
     end
 
     class ModelInvocationInput
@@ -297,6 +305,47 @@ module Aws::BedrockAgentRuntime
       SENSITIVE: []
     end
 
+    class RetrievalFilter
+      attr_accessor and_all: ::Array[Types::RetrievalFilter]
+      attr_accessor equals: Types::FilterAttribute
+      attr_accessor greater_than: Types::FilterAttribute
+      attr_accessor greater_than_or_equals: Types::FilterAttribute
+      attr_accessor in: Types::FilterAttribute
+      attr_accessor less_than: Types::FilterAttribute
+      attr_accessor less_than_or_equals: Types::FilterAttribute
+      attr_accessor not_equals: Types::FilterAttribute
+      attr_accessor not_in: Types::FilterAttribute
+      attr_accessor or_all: ::Array[Types::RetrievalFilter]
+      attr_accessor starts_with: Types::FilterAttribute
+      attr_accessor unknown: untyped
+      SENSITIVE: []
+
+      class AndAll < RetrievalFilter
+      end
+      class Equals < RetrievalFilter
+      end
+      class GreaterThan < RetrievalFilter
+      end
+      class GreaterThanOrEquals < RetrievalFilter
+      end
+      class In < RetrievalFilter
+      end
+      class LessThan < RetrievalFilter
+      end
+      class LessThanOrEquals < RetrievalFilter
+      end
+      class NotEquals < RetrievalFilter
+      end
+      class NotIn < RetrievalFilter
+      end
+      class OrAll < RetrievalFilter
+      end
+      class StartsWith < RetrievalFilter
+      end
+      class Unknown < RetrievalFilter
+      end
+    end
+
     class RetrievalResultContent
       attr_accessor text: ::String
       SENSITIVE: []
@@ -366,7 +415,8 @@ module Aws::BedrockAgentRuntime
     class RetrievedReference
       attr_accessor content: Types::RetrievalResultContent
       attr_accessor location: Types::RetrievalResultLocation
-      SENSITIVE: [:content, :location]
+      attr_accessor metadata: ::Hash[::String, untyped]
+      SENSITIVE: [:content, :location, :metadata]
     end
 
     class ServiceQuotaExceededException

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-bedrockagentruntime
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-26 00:00:00.000000000 Z
+date: 2024-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core