aws-sdk-kendra 1.73.0 → 1.74.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 390d6b9c2a4f3365d8ac0b9319a02e247da851ee61b193fab7685a8c0aeba786
-  data.tar.gz: 1a54af7fd0f501068e9616e4745d3fcedad80a34d1ef16775d508ac5a882f111
+  metadata.gz: fdeddfaf24ab246ef8445ab519b8dcbdb0eea5f073907d07bbd9f2857fd4aff7
+  data.tar.gz: f3d91c85bbb0d8cad696d49d1b2d00fd0f9ec69f2cc152e26d4562a719daafa2
 SHA512:
-  metadata.gz: d5e03c320df6d6ecb43200c532c2a534f718bae444d9d86c43b606acfaba9a008ad4149d7c78f7968cbac05480265ebf7f5484279534379d3b4d1fd75a3c0a66
-  data.tar.gz: 9afb7c55f821c3ef323068468f8acb75dc9d320337f28ab5de1a696645470d7674abfee2e6bac7b1f8859cd4fc7d4ab67a96aa2bf668ad648442a76e38f4df0a
+  metadata.gz: cdfde84479b54b4ff0b13e2e0131af45bfc73aedae83a1d50af8d82338cb49be3f4911aa8054ebb4f6ad6cde75c5ba8ecec1cf3d447931cf469ebaad0972bfd4
+  data.tar.gz: ae69e2f933c5cac368400a6bb08111ddbaa5f5b532ab0f596cfcb71b656f70063775d8ed5abba15eb75134824b77714220e1573dd0615a054699caad1dda11d1

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.74.0 (2023-10-18)
+------------------
+
+* Feature - Changes for a new feature in Amazon Kendra's Query API to Collapse/Expand query results
+
 1.73.0 (2023-09-27)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.73.0
+1.74.0

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

@@ -1874,9 +1874,8 @@ module Aws::Kendra
     #   The Amazon Resource Name (ARN) of an IAM role with permission to
     #   access `Query` API, `GetQuerySuggestions` API, and other required
     #   APIs. The role also must include permission to access IAM Identity
-    #   Center (successor to Single Sign-On) that stores your user and group
-    #   information. For more information, see [IAM access roles for Amazon
-    #   Kendra][1].
+    #   Center that stores your user and group information. For more
+    #   information, see [IAM access roles for Amazon Kendra][1].
     #
     #
     #
@@ -2251,9 +2250,8 @@ module Aws::Kendra
     #     accessible to the user will be searchable and displayable.
     #
     # @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
-    #   Gets users and groups from IAM Identity Center (successor to Single
-    #   Sign-On) identity source. To configure this, see
-    #   [UserGroupResolutionConfiguration][1].
+    #   Gets users and groups from IAM Identity Center identity source. To
+    #   configure this, see [UserGroupResolutionConfiguration][1].
     #
     #
     #
@@ -5068,6 +5066,15 @@ module Aws::Kendra
 
     # Searches an index given an input query.
     #
+    # <note markdown="1"> If you are working with large language models (LLMs) or implementing
+    # retrieval augmented generation (RAG) systems, you can use Amazon
+    # Kendra's [Retrieve][1] API, which can return longer semantically
+    # relevant passages. We recommend using the `Retrieve` API instead of
+    # filing a service limit increase to increase the `Query` API document
+    # excerpt length.
+    #
+    #  </note>
+    #
     # You can configure boosting or relevance tuning at the query level to
     # override boosting at the index level, filter based on document
     # fields/attributes and faceted search, and filter based on the user or
@@ -5091,6 +5098,10 @@ module Aws::Kendra
     # a maximum of four results are returned. If you filter result type to
     # only answers, a maximum of three results are returned.
     #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_Retrieve.html
+    #
     # @option params [required, String] :index_id
     #   The identifier of the index for the search.
     #
@@ -5156,6 +5167,19 @@ module Aws::Kendra
     #   If you don't provide sorting configuration, the results are sorted by
     #   the relevance that Amazon Kendra determines for the result.
     #
+    # @option params [Array<Types::SortingConfiguration>] :sorting_configurations
+    #   Provides configuration information to determine how the results of a
+    #   query are sorted.
+    #
+    #   You can set upto 3 fields that Amazon Kendra should sort the results
+    #   on, and specify whether the results should be sorted in ascending or
+    #   descending order. The sort field quota can be increased.
+    #
+    #   If you don't provide a sorting configuration, the results are sorted
+    #   by the relevance that Amazon Kendra determines for the result. In the
+    #   case of ties in sorting the results, the results are sorted by
+    #   relevance.
+    #
     # @option params [Types::UserContext] :user_context
     #   The user context token or user and group information.
     #
@@ -5168,6 +5192,11 @@ module Aws::Kendra
     # @option params [Types::SpellCorrectionConfiguration] :spell_correction_configuration
     #   Enables suggested spell corrections for queries.
     #
+    # @option params [Types::CollapseConfiguration] :collapse_configuration
+    #   Provides configuration to determine how to group results by document
+    #   attribute value, and how to display them (collapsed or expanded) under
+    #   a designated primary document for each group.
+    #
     # @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::QueryResult#query_id #query_id} => String
@@ -5292,6 +5321,12 @@ module Aws::Kendra
     #       document_attribute_key: "DocumentAttributeKey", # required
     #       sort_order: "DESC", # required, accepts DESC, ASC
     #     },
+    #     sorting_configurations: [
+    #       {
+    #         document_attribute_key: "DocumentAttributeKey", # required
+    #         sort_order: "DESC", # required, accepts DESC, ASC
+    #       },
+    #     ],
     #     user_context: {
     #       token: "Token",
     #       user_id: "PrincipalName",
@@ -5307,6 +5342,21 @@ module Aws::Kendra
     #     spell_correction_configuration: {
     #       include_query_spell_check_suggestions: false, # required
     #     },
+    #     collapse_configuration: {
+    #       document_attribute_key: "DocumentAttributeKey", # required
+    #       sorting_configurations: [
+    #         {
+    #           document_attribute_key: "DocumentAttributeKey", # required
+    #           sort_order: "DESC", # required, accepts DESC, ASC
+    #         },
+    #       ],
+    #       missing_attribute_key_strategy: "IGNORE", # accepts IGNORE, COLLAPSE, EXPAND
+    #       expand: false,
+    #       expand_configuration: {
+    #         max_result_items_to_expand: 1,
+    #         max_expanded_results_per_item: 1,
+    #       },
+    #     },
     #   })
     #
     # @example Response structure
@@ -5355,6 +5405,35 @@ module Aws::Kendra
     #   resp.result_items[0].table_excerpt.rows[0].cells[0].highlighted #=> Boolean
     #   resp.result_items[0].table_excerpt.rows[0].cells[0].header #=> Boolean
     #   resp.result_items[0].table_excerpt.total_number_of_rows #=> Integer
+    #   resp.result_items[0].collapsed_result_detail.document_attribute.key #=> String
+    #   resp.result_items[0].collapsed_result_detail.document_attribute.value.string_value #=> String
+    #   resp.result_items[0].collapsed_result_detail.document_attribute.value.string_list_value #=> Array
+    #   resp.result_items[0].collapsed_result_detail.document_attribute.value.string_list_value[0] #=> String
+    #   resp.result_items[0].collapsed_result_detail.document_attribute.value.long_value #=> Integer
+    #   resp.result_items[0].collapsed_result_detail.document_attribute.value.date_value #=> Time
+    #   resp.result_items[0].collapsed_result_detail.expanded_results #=> Array
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].id #=> String
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_id #=> String
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.text #=> String
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.highlights #=> Array
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.highlights[0].begin_offset #=> Integer
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.highlights[0].end_offset #=> Integer
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.highlights[0].top_answer #=> Boolean
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.text #=> String
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.highlights #=> Array
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.highlights[0].begin_offset #=> Integer
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.highlights[0].end_offset #=> Integer
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.highlights[0].top_answer #=> Boolean
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_uri #=> String
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes #=> Array
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].key #=> String
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].value.string_value #=> String
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].value.string_list_value #=> Array
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].value.string_list_value[0] #=> String
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].value.long_value #=> Integer
+    #   resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].value.date_value #=> Time
     #   resp.facet_results #=> Array
     #   resp.facet_results[0].document_attribute_key #=> String
     #   resp.facet_results[0].document_attribute_value_type #=> String, one of "STRING_VALUE", "STRING_LIST_VALUE", "LONG_VALUE", "DATE_VALUE"
@@ -5442,6 +5521,15 @@ module Aws::Kendra
     #
     # * Filter based on the user or their group access to documents
     #
+    # * View the confidence score bucket for a retrieved passage result. The
+    #   confidence bucket provides a relative ranking that indicates how
+    #   confident Amazon Kendra is that the response is relevant to the
+    #   query.
+    #
+    #   <note markdown="1"> Confidence score buckets are currently available only for English.
+    #
+    #    </note>
+    #
     # You can also include certain fields in the response that might provide
     # useful additional information.
     #
@@ -6892,8 +6980,8 @@ module Aws::Kendra
     #
     # @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
     #   Enables fetching access levels of groups and users from an IAM
-    #   Identity Center (successor to Single Sign-On) identity source. To
-    #   configure this, see [UserGroupResolutionConfiguration][1].
+    #   Identity Center identity source. To configure this, see
+    #   [UserGroupResolutionConfiguration][1].
     #
     #
     #
@@ -7203,7 +7291,7 @@ module Aws::Kendra
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kendra'
-      context[:gem_version] = '1.73.0'
+      context[:gem_version] = '1.74.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -68,6 +68,8 @@ module Aws::Kendra
     ClickFeedback = Shapes::StructureShape.new(name: 'ClickFeedback')
     ClickFeedbackList = Shapes::ListShape.new(name: 'ClickFeedbackList')
     ClientTokenName = Shapes::StringShape.new(name: 'ClientTokenName')
+    CollapseConfiguration = Shapes::StructureShape.new(name: 'CollapseConfiguration')
+    CollapsedResultDetail = Shapes::StructureShape.new(name: 'CollapsedResultDetail')
     ColumnConfiguration = Shapes::StructureShape.new(name: 'ColumnConfiguration')
     ColumnName = Shapes::StringShape.new(name: 'ColumnName')
     ConditionOperator = Shapes::StringShape.new(name: 'ConditionOperator')
@@ -229,6 +231,9 @@ module Aws::Kendra
     ExcludeMimeTypesList = Shapes::ListShape.new(name: 'ExcludeMimeTypesList')
     ExcludeSharedDrivesList = Shapes::ListShape.new(name: 'ExcludeSharedDrivesList')
     ExcludeUserAccountsList = Shapes::ListShape.new(name: 'ExcludeUserAccountsList')
+    ExpandConfiguration = Shapes::StructureShape.new(name: 'ExpandConfiguration')
+    ExpandedResultItem = Shapes::StructureShape.new(name: 'ExpandedResultItem')
+    ExpandedResultList = Shapes::ListShape.new(name: 'ExpandedResultList')
     ExperienceConfiguration = Shapes::StructureShape.new(name: 'ExperienceConfiguration')
     ExperienceEndpoint = Shapes::StructureShape.new(name: 'ExperienceEndpoint')
     ExperienceEndpoints = Shapes::ListShape.new(name: 'ExperienceEndpoints')
@@ -382,6 +387,7 @@ module Aws::Kendra
     MimeType = Shapes::StringShape.new(name: 'MimeType')
     MinimumNumberOfQueryingUsers = Shapes::IntegerShape.new(name: 'MinimumNumberOfQueryingUsers')
     MinimumQueryCount = Shapes::IntegerShape.new(name: 'MinimumQueryCount')
+    MissingAttributeKeyStrategy = Shapes::StringShape.new(name: 'MissingAttributeKeyStrategy')
     Mode = Shapes::StringShape.new(name: 'Mode')
     NameType = Shapes::StringShape.new(name: 'NameType')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
@@ -502,6 +508,7 @@ module Aws::Kendra
     SnapshotsDataRecords = Shapes::ListShape.new(name: 'SnapshotsDataRecords')
     SortOrder = Shapes::StringShape.new(name: 'SortOrder')
     SortingConfiguration = Shapes::StructureShape.new(name: 'SortingConfiguration')
+    SortingConfigurationList = Shapes::ListShape.new(name: 'SortingConfigurationList')
     SourceDocument = Shapes::StructureShape.new(name: 'SourceDocument')
     SourceDocuments = Shapes::ListShape.new(name: 'SourceDocuments')
     SpellCorrectedQuery = Shapes::StructureShape.new(name: 'SpellCorrectedQuery')
@@ -785,6 +792,17 @@ module Aws::Kendra
 
     ClickFeedbackList.member = Shapes::ShapeRef.new(shape: ClickFeedback)
 
+    CollapseConfiguration.add_member(:document_attribute_key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, required: true, location_name: "DocumentAttributeKey"))
+    CollapseConfiguration.add_member(:sorting_configurations, Shapes::ShapeRef.new(shape: SortingConfigurationList, location_name: "SortingConfigurations"))
+    CollapseConfiguration.add_member(:missing_attribute_key_strategy, Shapes::ShapeRef.new(shape: MissingAttributeKeyStrategy, location_name: "MissingAttributeKeyStrategy"))
+    CollapseConfiguration.add_member(:expand, Shapes::ShapeRef.new(shape: Boolean, location_name: "Expand"))
+    CollapseConfiguration.add_member(:expand_configuration, Shapes::ShapeRef.new(shape: ExpandConfiguration, location_name: "ExpandConfiguration"))
+    CollapseConfiguration.struct_class = Types::CollapseConfiguration
+
+    CollapsedResultDetail.add_member(:document_attribute, Shapes::ShapeRef.new(shape: DocumentAttribute, required: true, location_name: "DocumentAttribute"))
+    CollapsedResultDetail.add_member(:expanded_results, Shapes::ShapeRef.new(shape: ExpandedResultList, location_name: "ExpandedResults"))
+    CollapsedResultDetail.struct_class = Types::CollapsedResultDetail
+
     ColumnConfiguration.add_member(:document_id_column_name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "DocumentIdColumnName"))
     ColumnConfiguration.add_member(:document_data_column_name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "DocumentDataColumnName"))
     ColumnConfiguration.add_member(:document_title_column_name, Shapes::ShapeRef.new(shape: ColumnName, location_name: "DocumentTitleColumnName"))
@@ -1398,6 +1416,20 @@ module Aws::Kendra
 
     ExcludeUserAccountsList.member = Shapes::ShapeRef.new(shape: UserAccount)
 
+    ExpandConfiguration.add_member(:max_result_items_to_expand, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxResultItemsToExpand"))
+    ExpandConfiguration.add_member(:max_expanded_results_per_item, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxExpandedResultsPerItem"))
+    ExpandConfiguration.struct_class = Types::ExpandConfiguration
+
+    ExpandedResultItem.add_member(:id, Shapes::ShapeRef.new(shape: ResultId, location_name: "Id"))
+    ExpandedResultItem.add_member(:document_id, Shapes::ShapeRef.new(shape: DocumentId, location_name: "DocumentId"))
+    ExpandedResultItem.add_member(:document_title, Shapes::ShapeRef.new(shape: TextWithHighlights, location_name: "DocumentTitle"))
+    ExpandedResultItem.add_member(:document_excerpt, Shapes::ShapeRef.new(shape: TextWithHighlights, location_name: "DocumentExcerpt"))
+    ExpandedResultItem.add_member(:document_uri, Shapes::ShapeRef.new(shape: Url, location_name: "DocumentURI"))
+    ExpandedResultItem.add_member(:document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeList, location_name: "DocumentAttributes"))
+    ExpandedResultItem.struct_class = Types::ExpandedResultItem
+
+    ExpandedResultList.member = Shapes::ShapeRef.new(shape: ExpandedResultItem)
+
     ExperienceConfiguration.add_member(:content_source_configuration, Shapes::ShapeRef.new(shape: ContentSourceConfiguration, location_name: "ContentSourceConfiguration"))
     ExperienceConfiguration.add_member(:user_identity_configuration, Shapes::ShapeRef.new(shape: UserIdentityConfiguration, location_name: "UserIdentityConfiguration"))
     ExperienceConfiguration.struct_class = Types::ExperienceConfiguration
@@ -1890,9 +1922,11 @@ module Aws::Kendra
     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"))
+    QueryRequest.add_member(:sorting_configurations, Shapes::ShapeRef.new(shape: SortingConfigurationList, location_name: "SortingConfigurations"))
     QueryRequest.add_member(:user_context, Shapes::ShapeRef.new(shape: UserContext, location_name: "UserContext"))
     QueryRequest.add_member(:visitor_id, Shapes::ShapeRef.new(shape: VisitorId, location_name: "VisitorId"))
     QueryRequest.add_member(:spell_correction_configuration, Shapes::ShapeRef.new(shape: SpellCorrectionConfiguration, location_name: "SpellCorrectionConfiguration"))
+    QueryRequest.add_member(:collapse_configuration, Shapes::ShapeRef.new(shape: CollapseConfiguration, location_name: "CollapseConfiguration"))
     QueryRequest.struct_class = Types::QueryRequest
 
     QueryResult.add_member(:query_id, Shapes::ShapeRef.new(shape: QueryId, location_name: "QueryId"))
@@ -1916,6 +1950,7 @@ module Aws::Kendra
     QueryResultItem.add_member(:score_attributes, Shapes::ShapeRef.new(shape: ScoreAttributes, location_name: "ScoreAttributes"))
     QueryResultItem.add_member(:feedback_token, Shapes::ShapeRef.new(shape: FeedbackToken, location_name: "FeedbackToken"))
     QueryResultItem.add_member(:table_excerpt, Shapes::ShapeRef.new(shape: TableExcerpt, location_name: "TableExcerpt"))
+    QueryResultItem.add_member(:collapsed_result_detail, Shapes::ShapeRef.new(shape: CollapsedResultDetail, location_name: "CollapsedResultDetail"))
     QueryResultItem.struct_class = Types::QueryResultItem
 
     QueryResultItemList.member = Shapes::ShapeRef.new(shape: QueryResultItem)
@@ -2164,6 +2199,8 @@ module Aws::Kendra
     SortingConfiguration.add_member(:sort_order, Shapes::ShapeRef.new(shape: SortOrder, required: true, location_name: "SortOrder"))
     SortingConfiguration.struct_class = Types::SortingConfiguration
 
+    SortingConfigurationList.member = Shapes::ShapeRef.new(shape: SortingConfiguration)
+
     SourceDocument.add_member(:document_id, Shapes::ShapeRef.new(shape: String, location_name: "DocumentId"))
     SourceDocument.add_member(:suggestion_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeKeyList, location_name: "SuggestionAttributes"))
     SourceDocument.add_member(:additional_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeList, location_name: "AdditionalAttributes"))

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

@@ -32,7 +32,7 @@ module Aws::Kendra
             raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
           end
           if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
-            if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
+            if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
               return Aws::Endpoints::Endpoint.new(url: "https://kendra-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
             end
             raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"

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

@@ -1192,6 +1192,79 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # Specifies how to group results by document attribute value, and how to
+    # display them collapsed/expanded under a designated primary document
+    # for each group.
+    #
+    # @!attribute [rw] document_attribute_key
+    #   The document attribute used to group search results. You can use any
+    #   attribute that has the `Sortable` flag set to true. You can also
+    #   sort by any of the following built-in
+    #   attributes:"\_category","\_created\_at",
+    #   "\_last\_updated\_at", "\_version", "\_view\_count".
+    #   @return [String]
+    #
+    # @!attribute [rw] sorting_configurations
+    #   A prioritized list of document attributes/fields that determine the
+    #   primary document among those in a collapsed group.
+    #   @return [Array<Types::SortingConfiguration>]
+    #
+    # @!attribute [rw] missing_attribute_key_strategy
+    #   Specifies the behavior for documents without a value for the
+    #   collapse attribute.
+    #
+    #   Amazon Kendra offers three customization options:
+    #
+    #   * Choose to `COLLAPSE` all documents with null or missing values in
+    #     one group. This is the default configuration.
+    #
+    #   * Choose to `IGNORE` documents with null or missing values. Ignored
+    #     documents will not appear in query results.
+    #
+    #   * Choose to `EXPAND` each document with a null or missing value into
+    #     a group of its own.
+    #   @return [String]
+    #
+    # @!attribute [rw] expand
+    #   Specifies whether to expand the collapsed results.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] expand_configuration
+    #   Provides configuration information to customize expansion options
+    #   for a collapsed group.
+    #   @return [Types::ExpandConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CollapseConfiguration AWS API Documentation
+    #
+    class CollapseConfiguration < Struct.new(
+      :document_attribute_key,
+      :sorting_configurations,
+      :missing_attribute_key_strategy,
+      :expand,
+      :expand_configuration)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides details about a collapsed group of search results.
+    #
+    # @!attribute [rw] document_attribute
+    #   The value of the document attribute that results are collapsed on.
+    #   @return [Types::DocumentAttribute]
+    #
+    # @!attribute [rw] expanded_results
+    #   A list of results in the collapsed group.
+    #   @return [Array<Types::ExpandedResultItem>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CollapsedResultDetail AWS API Documentation
+    #
+    class CollapsedResultDetail < Struct.new(
+      :document_attribute,
+      :expanded_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Provides information about how Amazon Kendra should use the columns of
     # a database in an index.
     #
@@ -2016,9 +2089,8 @@ module Aws::Kendra
     #   The Amazon Resource Name (ARN) of an IAM role with permission to
     #   access `Query` API, `GetQuerySuggestions` API, and other required
     #   APIs. The role also must include permission to access IAM Identity
-    #   Center (successor to Single Sign-On) that stores your user and group
-    #   information. For more information, see [IAM access roles for Amazon
-    #   Kendra][1].
+    #   Center that stores your user and group information. For more
+    #   information, see [IAM access roles for Amazon Kendra][1].
     #
     #
     #
@@ -2340,9 +2412,8 @@ module Aws::Kendra
     #   @return [String]
     #
     # @!attribute [rw] user_group_resolution_configuration
-    #   Gets users and groups from IAM Identity Center (successor to Single
-    #   Sign-On) identity source. To configure this, see
-    #   [UserGroupResolutionConfiguration][1].
+    #   Gets users and groups from IAM Identity Center identity source. To
+    #   configure this, see [UserGroupResolutionConfiguration][1].
     #
     #
     #
@@ -3775,8 +3846,8 @@ module Aws::Kendra
     #
     # @!attribute [rw] user_group_resolution_configuration
     #   Whether you have enabled the configuration for fetching access
-    #   levels of groups and users from an IAM Identity Center (successor to
-    #   Single Sign-On) identity source.
+    #   levels of groups and users from an IAM Identity Center identity
+    #   source.
     #   @return [Types::UserGroupResolutionConfiguration]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
@@ -4751,6 +4822,77 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # Specifies the configuration information needed to customize how
+    # collapsed search result groups expand.
+    #
+    # @!attribute [rw] max_result_items_to_expand
+    #   The number of collapsed search result groups to expand. If you set
+    #   this value to 10, for example, only the first 10 out of 100 result
+    #   groups will have expand functionality.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] max_expanded_results_per_item
+    #   The number of expanded results to show per collapsed primary
+    #   document. For instance, if you set this value to 3, then at most 3
+    #   results per collapsed group will be displayed.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExpandConfiguration AWS API Documentation
+    #
+    class ExpandConfiguration < Struct.new(
+      :max_result_items_to_expand,
+      :max_expanded_results_per_item)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # A single expanded result in a collapsed group of search results.
+    #
+    # An expanded result item contains information about an expanded result
+    # document within a collapsed group of search results. This includes the
+    # original location of the document, a list of attributes assigned to
+    # the document, and relevant text from the document that satisfies the
+    # query.
+    #
+    # @!attribute [rw] id
+    #   The identifier for the expanded result.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_id
+    #   The idenitifier of the document.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_title
+    #   Provides text and information about where to highlight the text.
+    #   @return [Types::TextWithHighlights]
+    #
+    # @!attribute [rw] document_excerpt
+    #   Provides text and information about where to highlight the text.
+    #   @return [Types::TextWithHighlights]
+    #
+    # @!attribute [rw] document_uri
+    #   The URI of the original location of the document.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_attributes
+    #   An array of document attributes assigned to a document in the search
+    #   results. For example, the document author ("\_author") or the
+    #   source URI ("\_source\_uri") of the document.
+    #   @return [Array<Types::DocumentAttribute>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExpandedResultItem AWS API Documentation
+    #
+    class ExpandedResultItem < Struct.new(
+      :id,
+      :document_id,
+      :document_title,
+      :document_excerpt,
+      :document_uri,
+      :document_attributes)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Provides the configuration information for your Amazon Kendra
     # experience. This includes the data source IDs and/or FAQ IDs, and user
     # or group information to grant access to your Amazon Kendra experience.
@@ -7641,6 +7783,20 @@ module Aws::Kendra
     #   by the relevance that Amazon Kendra determines for the result.
     #   @return [Types::SortingConfiguration]
     #
+    # @!attribute [rw] sorting_configurations
+    #   Provides configuration information to determine how the results of a
+    #   query are sorted.
+    #
+    #   You can set upto 3 fields that Amazon Kendra should sort the results
+    #   on, and specify whether the results should be sorted in ascending or
+    #   descending order. The sort field quota can be increased.
+    #
+    #   If you don't provide a sorting configuration, the results are
+    #   sorted by the relevance that Amazon Kendra determines for the
+    #   result. In the case of ties in sorting the results, the results are
+    #   sorted by relevance.
+    #   @return [Array<Types::SortingConfiguration>]
+    #
     # @!attribute [rw] user_context
     #   The user context token or user and group information.
     #   @return [Types::UserContext]
@@ -7656,6 +7812,12 @@ module Aws::Kendra
     #   Enables suggested spell corrections for queries.
     #   @return [Types::SpellCorrectionConfiguration]
     #
+    # @!attribute [rw] collapse_configuration
+    #   Provides configuration to determine how to group results by document
+    #   attribute value, and how to display them (collapsed or expanded)
+    #   under a designated primary document for each group.
+    #   @return [Types::CollapseConfiguration]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
     #
     class QueryRequest < Struct.new(
@@ -7669,9 +7831,11 @@ module Aws::Kendra
       :page_number,
       :page_size,
       :sorting_configuration,
+      :sorting_configurations,
       :user_context,
       :visitor_id,
-      :spell_correction_configuration)
+      :spell_correction_configuration,
+      :collapse_configuration)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -7818,6 +7982,10 @@ module Aws::Kendra
     #   An excerpt from a table within a document.
     #   @return [Types::TableExcerpt]
     #
+    # @!attribute [rw] collapsed_result_detail
+    #   Provides details about a collapsed group of search results.
+    #   @return [Types::CollapsedResultDetail]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResultItem AWS API Documentation
     #
     class QueryResultItem < Struct.new(
@@ -7832,7 +8000,8 @@ module Aws::Kendra
       :document_attributes,
       :score_attributes,
       :feedback_token,
-      :table_excerpt)
+      :table_excerpt,
+      :collapsed_result_detail)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -10351,8 +10520,8 @@ module Aws::Kendra
     #
     # @!attribute [rw] user_group_resolution_configuration
     #   Enables fetching access levels of groups and users from an IAM
-    #   Identity Center (successor to Single Sign-On) identity source. To
-    #   configure this, see [UserGroupResolutionConfiguration][1].
+    #   Identity Center identity source. To configure this, see
+    #   [UserGroupResolutionConfiguration][1].
     #
     #
     #
@@ -10639,11 +10808,11 @@ module Aws::Kendra
     end
 
     # Provides the configuration information to get users and groups from an
-    # IAM Identity Center (successor to Single Sign-On) identity source.
-    # This is useful for user context filtering, where search results are
-    # filtered based on the user or their group access to documents. You can
-    # also use the [PutPrincipalMapping][1] API to map users to their groups
-    # so that you only need to provide the user ID when you issue the query.
+    # IAM Identity Center identity source. This is useful for user context
+    # filtering, where search results are filtered based on the user or
+    # their group access to documents. You can also use the
+    # [PutPrincipalMapping][1] API to map users to their groups so that you
+    # only need to provide the user ID when you issue the query.
     #
     # To set up an IAM Identity Center identity source in the console to use
     # with Amazon Kendra, see [Getting started with an IAM Identity Center
@@ -10665,9 +10834,9 @@ module Aws::Kendra
     #
     # @!attribute [rw] user_group_resolution_mode
     #   The identity store provider (mode) you want to use to get users and
-    #   groups. IAM Identity Center (successor to Single Sign-On) is
-    #   currently the only available mode. Your users and groups must exist
-    #   in an IAM Identity Center identity source in order to use this mode.
+    #   groups. IAM Identity Center is currently the only available mode.
+    #   Your users and groups must exist in an IAM Identity Center identity
+    #   source in order to use this mode.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserGroupResolutionConfiguration AWS API Documentation

data/lib/aws-sdk-kendra.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-kendra/customizations'
 # @!group service
 module Aws::Kendra
 
-  GEM_VERSION = '1.73.0'
+  GEM_VERSION = '1.74.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kendra
 version: !ruby/object:Gem::Version
-  version: 1.73.0
+  version: 1.74.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-27 00:00:00.000000000 Z
+date: 2023-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core