aws-sdk-kendra 1.23.0 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13ef9deb75aa3e25a0f22eb8f435dc97249bbb0a9c8620310bcbccae155309ce
-  data.tar.gz: 32b19f5f2b1295864ebc017073de00eded9ef29f7385db7ebe114d3b2d085143
+  metadata.gz: f3cba49ab0bd0ebf0402ed5cfa575f7974f0cc2237808f474615a3d2bbc09ce6
+  data.tar.gz: 8cab555f2b156c2997cc48c51d7a85f76ed74b255ec013d5fdf01860ba4e31da
 SHA512:
-  metadata.gz: ed3c5d1d147b776e2b8e177b2f0de93dcb226d0cb8a56f1de887e33811fd85cb43dedf3c38121073c0130425450f72e3032b4eb352a3ec923a60a900c9565f1f
-  data.tar.gz: '0996fde8b0b7b298047a6a5d98e6d08d6b396288b9405c6f25be384cad828b34e073691f4857df3181624d4eecff36867457c1dad33199a3c4b6b477497d7c82'
+  metadata.gz: 4476c80222605da34edc81d2cfc7efe2209a574c067bace3c9bf23a872c37bc100fa34d2e75934db17c6c3ca532a659cf5be21d1ba85e610768c05266aafaaad
+  data.tar.gz: 59a7170b16fea52f95bc57e0f9be6ebdb411f9d05ed444f7811ed9ddf41f5ac6d7d375c3cc0e7649c0d7d145839349a184169549494ea0fe7f0ece5db2affb38

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.24.0 (2021-04-21)
+------------------
+
+* Feature - Amazon Kendra now enables users to override index-level boosting configurations for each query.
+
 1.23.0 (2021-04-01)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.23.0
+1.24.0

data/lib/aws-sdk-kendra.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kendra/customizations'
 # @!group service
 module Aws::Kendra
 
-  GEM_VERSION = '1.23.0'
+  GEM_VERSION = '1.24.0'
 
 end

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

@@ -2018,6 +2018,23 @@ module Aws::Kendra
     #   Sets the type of query. Only results for the specified query type are
     #   returned.
     #
+    # @option params [Array<Types::DocumentRelevanceConfiguration>] :document_relevance_override_configurations
+    #   Overrides relevance tuning configurations of fields or attributes set
+    #   at the index level.
+    #
+    #   If you use this API to override the relevance tuning configured at the
+    #   index level, but there is no relevance tuning configured at the index
+    #   level, then Amazon Kendra does not apply any relevance tuning.
+    #
+    #   If there is relevance tuning configured at the index level, but you do
+    #   not use this API to override any relevance tuning in the index, then
+    #   Amazon Kendra uses the relevance tuning that is configured at the
+    #   index level.
+    #
+    #   If there is relevance tuning configured for fields at the index level,
+    #   but you use this API to override only some of these fields, then for
+    #   the fields you did not override, the importance is set to 1.
+    #
     # @option params [Integer] :page_number
     #   Query results are returned in pages the size of the `PageSize`
     #   parameter. By default, Amazon Kendra returns the first page of
@@ -2144,6 +2161,20 @@ module Aws::Kendra
     #     ],
     #     requested_document_attributes: ["DocumentAttributeKey"],
     #     query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
+    #     document_relevance_override_configurations: [
+    #       {
+    #         name: "DocumentMetadataConfigurationName", # required
+    #         relevance: { # required
+    #           freshness: false,
+    #           importance: 1,
+    #           duration: "Duration",
+    #           rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
+    #           value_importance_map: {
+    #             "ValueImportanceMapKey" => 1,
+    #           },
+    #         },
+    #       },
+    #     ],
     #     page_number: 1,
     #     page_size: 1,
     #     sorting_configuration: {
@@ -2853,7 +2884,7 @@ module Aws::Kendra
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kendra'
-      context[:gem_version] = '1.23.0'
+      context[:gem_version] = '1.24.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -128,6 +128,8 @@ module Aws::Kendra
     DocumentMetadataConfiguration = Shapes::StructureShape.new(name: 'DocumentMetadataConfiguration')
     DocumentMetadataConfigurationList = Shapes::ListShape.new(name: 'DocumentMetadataConfigurationList')
     DocumentMetadataConfigurationName = Shapes::StringShape.new(name: 'DocumentMetadataConfigurationName')
+    DocumentRelevanceConfiguration = Shapes::StructureShape.new(name: 'DocumentRelevanceConfiguration')
+    DocumentRelevanceOverrideConfigurationList = Shapes::ListShape.new(name: 'DocumentRelevanceOverrideConfigurationList')
     DocumentsMetadataConfiguration = Shapes::StructureShape.new(name: 'DocumentsMetadataConfiguration')
     Duration = Shapes::StringShape.new(name: 'Duration')
     ErrorCode = Shapes::StringShape.new(name: 'ErrorCode')
@@ -709,6 +711,12 @@ module Aws::Kendra
 
     DocumentMetadataConfigurationList.member = Shapes::ShapeRef.new(shape: DocumentMetadataConfiguration)
 
+    DocumentRelevanceConfiguration.add_member(:name, Shapes::ShapeRef.new(shape: DocumentMetadataConfigurationName, required: true, location_name: "Name"))
+    DocumentRelevanceConfiguration.add_member(:relevance, Shapes::ShapeRef.new(shape: Relevance, required: true, location_name: "Relevance"))
+    DocumentRelevanceConfiguration.struct_class = Types::DocumentRelevanceConfiguration
+
+    DocumentRelevanceOverrideConfigurationList.member = Shapes::ShapeRef.new(shape: DocumentRelevanceConfiguration)
+
     DocumentsMetadataConfiguration.add_member(:s3_prefix, Shapes::ShapeRef.new(shape: S3ObjectKey, location_name: "S3Prefix"))
     DocumentsMetadataConfiguration.struct_class = Types::DocumentsMetadataConfiguration
 
@@ -871,6 +879,7 @@ module Aws::Kendra
     QueryRequest.add_member(:facets, Shapes::ShapeRef.new(shape: FacetList, location_name: "Facets"))
     QueryRequest.add_member(:requested_document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeKeyList, location_name: "RequestedDocumentAttributes"))
     QueryRequest.add_member(:query_result_type_filter, Shapes::ShapeRef.new(shape: QueryResultType, location_name: "QueryResultTypeFilter"))
+    QueryRequest.add_member(:document_relevance_override_configurations, Shapes::ShapeRef.new(shape: DocumentRelevanceOverrideConfigurationList, location_name: "DocumentRelevanceOverrideConfigurations"))
     QueryRequest.add_member(:page_number, Shapes::ShapeRef.new(shape: Integer, location_name: "PageNumber"))
     QueryRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: Integer, location_name: "PageSize"))
     QueryRequest.add_member(:sorting_configuration, Shapes::ShapeRef.new(shape: SortingConfiguration, location_name: "SortingConfiguration"))

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

@@ -3449,6 +3449,45 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # Overrides the document relevance properties of a custom index field.
+    #
+    # @note When making an API call, you may pass DocumentRelevanceConfiguration
+    #   data as a hash:
+    #
+    #       {
+    #         name: "DocumentMetadataConfigurationName", # required
+    #         relevance: { # required
+    #           freshness: false,
+    #           importance: 1,
+    #           duration: "Duration",
+    #           rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
+    #           value_importance_map: {
+    #             "ValueImportanceMapKey" => 1,
+    #           },
+    #         },
+    #       }
+    #
+    # @!attribute [rw] name
+    #   The name of the tuning configuration to override document relevance
+    #   at the index level.
+    #   @return [String]
+    #
+    # @!attribute [rw] relevance
+    #   Provides information for manually tuning the relevance of a field in
+    #   a search. When a query includes terms that match the field, the
+    #   results are given a boost in the response based on these tuning
+    #   parameters.
+    #   @return [Types::Relevance]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DocumentRelevanceConfiguration AWS API Documentation
+    #
+    class DocumentRelevanceConfiguration < Struct.new(
+      :name,
+      :relevance)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Document metadata files that contain information such as the document
     # access control information, source URI, document author, and custom
     # attributes. Each metadata file contains metadata about a single
@@ -4437,6 +4476,20 @@ module Aws::Kendra
     #         ],
     #         requested_document_attributes: ["DocumentAttributeKey"],
     #         query_result_type_filter: "DOCUMENT", # accepts DOCUMENT, QUESTION_ANSWER, ANSWER
+    #         document_relevance_override_configurations: [
+    #           {
+    #             name: "DocumentMetadataConfigurationName", # required
+    #             relevance: { # required
+    #               freshness: false,
+    #               importance: 1,
+    #               duration: "Duration",
+    #               rank_order: "ASCENDING", # accepts ASCENDING, DESCENDING
+    #               value_importance_map: {
+    #                 "ValueImportanceMapKey" => 1,
+    #               },
+    #             },
+    #           },
+    #         ],
     #         page_number: 1,
     #         page_size: 1,
     #         sorting_configuration: {
@@ -4486,6 +4539,25 @@ module Aws::Kendra
     #   are returned.
     #   @return [String]
     #
+    # @!attribute [rw] document_relevance_override_configurations
+    #   Overrides relevance tuning configurations of fields or attributes
+    #   set at the index level.
+    #
+    #   If you use this API to override the relevance tuning configured at
+    #   the index level, but there is no relevance tuning configured at the
+    #   index level, then Amazon Kendra does not apply any relevance tuning.
+    #
+    #   If there is relevance tuning configured at the index level, but you
+    #   do not use this API to override any relevance tuning in the index,
+    #   then Amazon Kendra uses the relevance tuning that is configured at
+    #   the index level.
+    #
+    #   If there is relevance tuning configured for fields at the index
+    #   level, but you use this API to override only some of these fields,
+    #   then for the fields you did not override, the importance is set to
+    #   1.
+    #   @return [Array<Types::DocumentRelevanceConfiguration>]
+    #
     # @!attribute [rw] page_number
     #   Query results are returned in pages the size of the `PageSize`
     #   parameter. By default, Amazon Kendra returns the first page of
@@ -4530,6 +4602,7 @@ module Aws::Kendra
       :facets,
       :requested_document_attributes,
       :query_result_type_filter,
+      :document_relevance_override_configurations,
       :page_number,
       :page_size,
       :sorting_configuration,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kendra
 version: !ruby/object:Gem::Version
-  version: 1.23.0
+  version: 1.24.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 2.7.6.3
 signing_key: 
 specification_version: 4
 summary: AWS SDK for Ruby - kendra