aws-sdk-kendra 1.73.0 → 1.74.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 390d6b9c2a4f3365d8ac0b9319a02e247da851ee61b193fab7685a8c0aeba786
4
- data.tar.gz: 1a54af7fd0f501068e9616e4745d3fcedad80a34d1ef16775d508ac5a882f111
3
+ metadata.gz: fdeddfaf24ab246ef8445ab519b8dcbdb0eea5f073907d07bbd9f2857fd4aff7
4
+ data.tar.gz: f3d91c85bbb0d8cad696d49d1b2d00fd0f9ec69f2cc152e26d4562a719daafa2
5
5
  SHA512:
6
- metadata.gz: d5e03c320df6d6ecb43200c532c2a534f718bae444d9d86c43b606acfaba9a008ad4149d7c78f7968cbac05480265ebf7f5484279534379d3b4d1fd75a3c0a66
7
- data.tar.gz: 9afb7c55f821c3ef323068468f8acb75dc9d320337f28ab5de1a696645470d7674abfee2e6bac7b1f8859cd4fc7d4ab67a96aa2bf668ad648442a76e38f4df0a
6
+ metadata.gz: cdfde84479b54b4ff0b13e2e0131af45bfc73aedae83a1d50af8d82338cb49be3f4911aa8054ebb4f6ad6cde75c5ba8ecec1cf3d447931cf469ebaad0972bfd4
7
+ data.tar.gz: ae69e2f933c5cac368400a6bb08111ddbaa5f5b532ab0f596cfcb71b656f70063775d8ed5abba15eb75134824b77714220e1573dd0615a054699caad1dda11d1
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.74.0 (2023-10-18)
5
+ ------------------
6
+
7
+ * Feature - Changes for a new feature in Amazon Kendra's Query API to Collapse/Expand query results
8
+
4
9
  1.73.0 (2023-09-27)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.73.0
1
+ 1.74.0
@@ -1874,9 +1874,8 @@ module Aws::Kendra
1874
1874
  # The Amazon Resource Name (ARN) of an IAM role with permission to
1875
1875
  # access `Query` API, `GetQuerySuggestions` API, and other required
1876
1876
  # APIs. The role also must include permission to access IAM Identity
1877
- # Center (successor to Single Sign-On) that stores your user and group
1878
- # information. For more information, see [IAM access roles for Amazon
1879
- # Kendra][1].
1877
+ # Center that stores your user and group information. For more
1878
+ # information, see [IAM access roles for Amazon Kendra][1].
1880
1879
  #
1881
1880
  #
1882
1881
  #
@@ -2251,9 +2250,8 @@ module Aws::Kendra
2251
2250
  # accessible to the user will be searchable and displayable.
2252
2251
  #
2253
2252
  # @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
2254
- # Gets users and groups from IAM Identity Center (successor to Single
2255
- # Sign-On) identity source. To configure this, see
2256
- # [UserGroupResolutionConfiguration][1].
2253
+ # Gets users and groups from IAM Identity Center identity source. To
2254
+ # configure this, see [UserGroupResolutionConfiguration][1].
2257
2255
  #
2258
2256
  #
2259
2257
  #
@@ -5068,6 +5066,15 @@ module Aws::Kendra
5068
5066
 
5069
5067
  # Searches an index given an input query.
5070
5068
  #
5069
+ # <note markdown="1"> If you are working with large language models (LLMs) or implementing
5070
+ # retrieval augmented generation (RAG) systems, you can use Amazon
5071
+ # Kendra's [Retrieve][1] API, which can return longer semantically
5072
+ # relevant passages. We recommend using the `Retrieve` API instead of
5073
+ # filing a service limit increase to increase the `Query` API document
5074
+ # excerpt length.
5075
+ #
5076
+ # </note>
5077
+ #
5071
5078
  # You can configure boosting or relevance tuning at the query level to
5072
5079
  # override boosting at the index level, filter based on document
5073
5080
  # fields/attributes and faceted search, and filter based on the user or
@@ -5091,6 +5098,10 @@ module Aws::Kendra
5091
5098
  # a maximum of four results are returned. If you filter result type to
5092
5099
  # only answers, a maximum of three results are returned.
5093
5100
  #
5101
+ #
5102
+ #
5103
+ # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_Retrieve.html
5104
+ #
5094
5105
  # @option params [required, String] :index_id
5095
5106
  # The identifier of the index for the search.
5096
5107
  #
@@ -5156,6 +5167,19 @@ module Aws::Kendra
5156
5167
  # If you don't provide sorting configuration, the results are sorted by
5157
5168
  # the relevance that Amazon Kendra determines for the result.
5158
5169
  #
5170
+ # @option params [Array<Types::SortingConfiguration>] :sorting_configurations
5171
+ # Provides configuration information to determine how the results of a
5172
+ # query are sorted.
5173
+ #
5174
+ # You can set upto 3 fields that Amazon Kendra should sort the results
5175
+ # on, and specify whether the results should be sorted in ascending or
5176
+ # descending order. The sort field quota can be increased.
5177
+ #
5178
+ # If you don't provide a sorting configuration, the results are sorted
5179
+ # by the relevance that Amazon Kendra determines for the result. In the
5180
+ # case of ties in sorting the results, the results are sorted by
5181
+ # relevance.
5182
+ #
5159
5183
  # @option params [Types::UserContext] :user_context
5160
5184
  # The user context token or user and group information.
5161
5185
  #
@@ -5168,6 +5192,11 @@ module Aws::Kendra
5168
5192
  # @option params [Types::SpellCorrectionConfiguration] :spell_correction_configuration
5169
5193
  # Enables suggested spell corrections for queries.
5170
5194
  #
5195
+ # @option params [Types::CollapseConfiguration] :collapse_configuration
5196
+ # Provides configuration to determine how to group results by document
5197
+ # attribute value, and how to display them (collapsed or expanded) under
5198
+ # a designated primary document for each group.
5199
+ #
5171
5200
  # @return [Types::QueryResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5172
5201
  #
5173
5202
  # * {Types::QueryResult#query_id #query_id} => String
@@ -5292,6 +5321,12 @@ module Aws::Kendra
5292
5321
  # document_attribute_key: "DocumentAttributeKey", # required
5293
5322
  # sort_order: "DESC", # required, accepts DESC, ASC
5294
5323
  # },
5324
+ # sorting_configurations: [
5325
+ # {
5326
+ # document_attribute_key: "DocumentAttributeKey", # required
5327
+ # sort_order: "DESC", # required, accepts DESC, ASC
5328
+ # },
5329
+ # ],
5295
5330
  # user_context: {
5296
5331
  # token: "Token",
5297
5332
  # user_id: "PrincipalName",
@@ -5307,6 +5342,21 @@ module Aws::Kendra
5307
5342
  # spell_correction_configuration: {
5308
5343
  # include_query_spell_check_suggestions: false, # required
5309
5344
  # },
5345
+ # collapse_configuration: {
5346
+ # document_attribute_key: "DocumentAttributeKey", # required
5347
+ # sorting_configurations: [
5348
+ # {
5349
+ # document_attribute_key: "DocumentAttributeKey", # required
5350
+ # sort_order: "DESC", # required, accepts DESC, ASC
5351
+ # },
5352
+ # ],
5353
+ # missing_attribute_key_strategy: "IGNORE", # accepts IGNORE, COLLAPSE, EXPAND
5354
+ # expand: false,
5355
+ # expand_configuration: {
5356
+ # max_result_items_to_expand: 1,
5357
+ # max_expanded_results_per_item: 1,
5358
+ # },
5359
+ # },
5310
5360
  # })
5311
5361
  #
5312
5362
  # @example Response structure
@@ -5355,6 +5405,35 @@ module Aws::Kendra
5355
5405
  # resp.result_items[0].table_excerpt.rows[0].cells[0].highlighted #=> Boolean
5356
5406
  # resp.result_items[0].table_excerpt.rows[0].cells[0].header #=> Boolean
5357
5407
  # resp.result_items[0].table_excerpt.total_number_of_rows #=> Integer
5408
+ # resp.result_items[0].collapsed_result_detail.document_attribute.key #=> String
5409
+ # resp.result_items[0].collapsed_result_detail.document_attribute.value.string_value #=> String
5410
+ # resp.result_items[0].collapsed_result_detail.document_attribute.value.string_list_value #=> Array
5411
+ # resp.result_items[0].collapsed_result_detail.document_attribute.value.string_list_value[0] #=> String
5412
+ # resp.result_items[0].collapsed_result_detail.document_attribute.value.long_value #=> Integer
5413
+ # resp.result_items[0].collapsed_result_detail.document_attribute.value.date_value #=> Time
5414
+ # resp.result_items[0].collapsed_result_detail.expanded_results #=> Array
5415
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].id #=> String
5416
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_id #=> String
5417
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.text #=> String
5418
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.highlights #=> Array
5419
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.highlights[0].begin_offset #=> Integer
5420
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.highlights[0].end_offset #=> Integer
5421
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.highlights[0].top_answer #=> Boolean
5422
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_title.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
5423
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.text #=> String
5424
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.highlights #=> Array
5425
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.highlights[0].begin_offset #=> Integer
5426
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.highlights[0].end_offset #=> Integer
5427
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.highlights[0].top_answer #=> Boolean
5428
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_excerpt.highlights[0].type #=> String, one of "STANDARD", "THESAURUS_SYNONYM"
5429
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_uri #=> String
5430
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes #=> Array
5431
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].key #=> String
5432
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].value.string_value #=> String
5433
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].value.string_list_value #=> Array
5434
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].value.string_list_value[0] #=> String
5435
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].value.long_value #=> Integer
5436
+ # resp.result_items[0].collapsed_result_detail.expanded_results[0].document_attributes[0].value.date_value #=> Time
5358
5437
  # resp.facet_results #=> Array
5359
5438
  # resp.facet_results[0].document_attribute_key #=> String
5360
5439
  # 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
5442
5521
  #
5443
5522
  # * Filter based on the user or their group access to documents
5444
5523
  #
5524
+ # * View the confidence score bucket for a retrieved passage result. The
5525
+ # confidence bucket provides a relative ranking that indicates how
5526
+ # confident Amazon Kendra is that the response is relevant to the
5527
+ # query.
5528
+ #
5529
+ # <note markdown="1"> Confidence score buckets are currently available only for English.
5530
+ #
5531
+ # </note>
5532
+ #
5445
5533
  # You can also include certain fields in the response that might provide
5446
5534
  # useful additional information.
5447
5535
  #
@@ -6892,8 +6980,8 @@ module Aws::Kendra
6892
6980
  #
6893
6981
  # @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
6894
6982
  # Enables fetching access levels of groups and users from an IAM
6895
- # Identity Center (successor to Single Sign-On) identity source. To
6896
- # configure this, see [UserGroupResolutionConfiguration][1].
6983
+ # Identity Center identity source. To configure this, see
6984
+ # [UserGroupResolutionConfiguration][1].
6897
6985
  #
6898
6986
  #
6899
6987
  #
@@ -7203,7 +7291,7 @@ module Aws::Kendra
7203
7291
  params: params,
7204
7292
  config: config)
7205
7293
  context[:gem_name] = 'aws-sdk-kendra'
7206
- context[:gem_version] = '1.73.0'
7294
+ context[:gem_version] = '1.74.0'
7207
7295
  Seahorse::Client::Request.new(handlers, context)
7208
7296
  end
7209
7297
 
@@ -68,6 +68,8 @@ module Aws::Kendra
68
68
  ClickFeedback = Shapes::StructureShape.new(name: 'ClickFeedback')
69
69
  ClickFeedbackList = Shapes::ListShape.new(name: 'ClickFeedbackList')
70
70
  ClientTokenName = Shapes::StringShape.new(name: 'ClientTokenName')
71
+ CollapseConfiguration = Shapes::StructureShape.new(name: 'CollapseConfiguration')
72
+ CollapsedResultDetail = Shapes::StructureShape.new(name: 'CollapsedResultDetail')
71
73
  ColumnConfiguration = Shapes::StructureShape.new(name: 'ColumnConfiguration')
72
74
  ColumnName = Shapes::StringShape.new(name: 'ColumnName')
73
75
  ConditionOperator = Shapes::StringShape.new(name: 'ConditionOperator')
@@ -229,6 +231,9 @@ module Aws::Kendra
229
231
  ExcludeMimeTypesList = Shapes::ListShape.new(name: 'ExcludeMimeTypesList')
230
232
  ExcludeSharedDrivesList = Shapes::ListShape.new(name: 'ExcludeSharedDrivesList')
231
233
  ExcludeUserAccountsList = Shapes::ListShape.new(name: 'ExcludeUserAccountsList')
234
+ ExpandConfiguration = Shapes::StructureShape.new(name: 'ExpandConfiguration')
235
+ ExpandedResultItem = Shapes::StructureShape.new(name: 'ExpandedResultItem')
236
+ ExpandedResultList = Shapes::ListShape.new(name: 'ExpandedResultList')
232
237
  ExperienceConfiguration = Shapes::StructureShape.new(name: 'ExperienceConfiguration')
233
238
  ExperienceEndpoint = Shapes::StructureShape.new(name: 'ExperienceEndpoint')
234
239
  ExperienceEndpoints = Shapes::ListShape.new(name: 'ExperienceEndpoints')
@@ -382,6 +387,7 @@ module Aws::Kendra
382
387
  MimeType = Shapes::StringShape.new(name: 'MimeType')
383
388
  MinimumNumberOfQueryingUsers = Shapes::IntegerShape.new(name: 'MinimumNumberOfQueryingUsers')
384
389
  MinimumQueryCount = Shapes::IntegerShape.new(name: 'MinimumQueryCount')
390
+ MissingAttributeKeyStrategy = Shapes::StringShape.new(name: 'MissingAttributeKeyStrategy')
385
391
  Mode = Shapes::StringShape.new(name: 'Mode')
386
392
  NameType = Shapes::StringShape.new(name: 'NameType')
387
393
  NextToken = Shapes::StringShape.new(name: 'NextToken')
@@ -502,6 +508,7 @@ module Aws::Kendra
502
508
  SnapshotsDataRecords = Shapes::ListShape.new(name: 'SnapshotsDataRecords')
503
509
  SortOrder = Shapes::StringShape.new(name: 'SortOrder')
504
510
  SortingConfiguration = Shapes::StructureShape.new(name: 'SortingConfiguration')
511
+ SortingConfigurationList = Shapes::ListShape.new(name: 'SortingConfigurationList')
505
512
  SourceDocument = Shapes::StructureShape.new(name: 'SourceDocument')
506
513
  SourceDocuments = Shapes::ListShape.new(name: 'SourceDocuments')
507
514
  SpellCorrectedQuery = Shapes::StructureShape.new(name: 'SpellCorrectedQuery')
@@ -785,6 +792,17 @@ module Aws::Kendra
785
792
 
786
793
  ClickFeedbackList.member = Shapes::ShapeRef.new(shape: ClickFeedback)
787
794
 
795
+ CollapseConfiguration.add_member(:document_attribute_key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, required: true, location_name: "DocumentAttributeKey"))
796
+ CollapseConfiguration.add_member(:sorting_configurations, Shapes::ShapeRef.new(shape: SortingConfigurationList, location_name: "SortingConfigurations"))
797
+ CollapseConfiguration.add_member(:missing_attribute_key_strategy, Shapes::ShapeRef.new(shape: MissingAttributeKeyStrategy, location_name: "MissingAttributeKeyStrategy"))
798
+ CollapseConfiguration.add_member(:expand, Shapes::ShapeRef.new(shape: Boolean, location_name: "Expand"))
799
+ CollapseConfiguration.add_member(:expand_configuration, Shapes::ShapeRef.new(shape: ExpandConfiguration, location_name: "ExpandConfiguration"))
800
+ CollapseConfiguration.struct_class = Types::CollapseConfiguration
801
+
802
+ CollapsedResultDetail.add_member(:document_attribute, Shapes::ShapeRef.new(shape: DocumentAttribute, required: true, location_name: "DocumentAttribute"))
803
+ CollapsedResultDetail.add_member(:expanded_results, Shapes::ShapeRef.new(shape: ExpandedResultList, location_name: "ExpandedResults"))
804
+ CollapsedResultDetail.struct_class = Types::CollapsedResultDetail
805
+
788
806
  ColumnConfiguration.add_member(:document_id_column_name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "DocumentIdColumnName"))
789
807
  ColumnConfiguration.add_member(:document_data_column_name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "DocumentDataColumnName"))
790
808
  ColumnConfiguration.add_member(:document_title_column_name, Shapes::ShapeRef.new(shape: ColumnName, location_name: "DocumentTitleColumnName"))
@@ -1398,6 +1416,20 @@ module Aws::Kendra
1398
1416
 
1399
1417
  ExcludeUserAccountsList.member = Shapes::ShapeRef.new(shape: UserAccount)
1400
1418
 
1419
+ ExpandConfiguration.add_member(:max_result_items_to_expand, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxResultItemsToExpand"))
1420
+ ExpandConfiguration.add_member(:max_expanded_results_per_item, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxExpandedResultsPerItem"))
1421
+ ExpandConfiguration.struct_class = Types::ExpandConfiguration
1422
+
1423
+ ExpandedResultItem.add_member(:id, Shapes::ShapeRef.new(shape: ResultId, location_name: "Id"))
1424
+ ExpandedResultItem.add_member(:document_id, Shapes::ShapeRef.new(shape: DocumentId, location_name: "DocumentId"))
1425
+ ExpandedResultItem.add_member(:document_title, Shapes::ShapeRef.new(shape: TextWithHighlights, location_name: "DocumentTitle"))
1426
+ ExpandedResultItem.add_member(:document_excerpt, Shapes::ShapeRef.new(shape: TextWithHighlights, location_name: "DocumentExcerpt"))
1427
+ ExpandedResultItem.add_member(:document_uri, Shapes::ShapeRef.new(shape: Url, location_name: "DocumentURI"))
1428
+ ExpandedResultItem.add_member(:document_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeList, location_name: "DocumentAttributes"))
1429
+ ExpandedResultItem.struct_class = Types::ExpandedResultItem
1430
+
1431
+ ExpandedResultList.member = Shapes::ShapeRef.new(shape: ExpandedResultItem)
1432
+
1401
1433
  ExperienceConfiguration.add_member(:content_source_configuration, Shapes::ShapeRef.new(shape: ContentSourceConfiguration, location_name: "ContentSourceConfiguration"))
1402
1434
  ExperienceConfiguration.add_member(:user_identity_configuration, Shapes::ShapeRef.new(shape: UserIdentityConfiguration, location_name: "UserIdentityConfiguration"))
1403
1435
  ExperienceConfiguration.struct_class = Types::ExperienceConfiguration
@@ -1890,9 +1922,11 @@ module Aws::Kendra
1890
1922
  QueryRequest.add_member(:page_number, Shapes::ShapeRef.new(shape: Integer, location_name: "PageNumber"))
1891
1923
  QueryRequest.add_member(:page_size, Shapes::ShapeRef.new(shape: Integer, location_name: "PageSize"))
1892
1924
  QueryRequest.add_member(:sorting_configuration, Shapes::ShapeRef.new(shape: SortingConfiguration, location_name: "SortingConfiguration"))
1925
+ QueryRequest.add_member(:sorting_configurations, Shapes::ShapeRef.new(shape: SortingConfigurationList, location_name: "SortingConfigurations"))
1893
1926
  QueryRequest.add_member(:user_context, Shapes::ShapeRef.new(shape: UserContext, location_name: "UserContext"))
1894
1927
  QueryRequest.add_member(:visitor_id, Shapes::ShapeRef.new(shape: VisitorId, location_name: "VisitorId"))
1895
1928
  QueryRequest.add_member(:spell_correction_configuration, Shapes::ShapeRef.new(shape: SpellCorrectionConfiguration, location_name: "SpellCorrectionConfiguration"))
1929
+ QueryRequest.add_member(:collapse_configuration, Shapes::ShapeRef.new(shape: CollapseConfiguration, location_name: "CollapseConfiguration"))
1896
1930
  QueryRequest.struct_class = Types::QueryRequest
1897
1931
 
1898
1932
  QueryResult.add_member(:query_id, Shapes::ShapeRef.new(shape: QueryId, location_name: "QueryId"))
@@ -1916,6 +1950,7 @@ module Aws::Kendra
1916
1950
  QueryResultItem.add_member(:score_attributes, Shapes::ShapeRef.new(shape: ScoreAttributes, location_name: "ScoreAttributes"))
1917
1951
  QueryResultItem.add_member(:feedback_token, Shapes::ShapeRef.new(shape: FeedbackToken, location_name: "FeedbackToken"))
1918
1952
  QueryResultItem.add_member(:table_excerpt, Shapes::ShapeRef.new(shape: TableExcerpt, location_name: "TableExcerpt"))
1953
+ QueryResultItem.add_member(:collapsed_result_detail, Shapes::ShapeRef.new(shape: CollapsedResultDetail, location_name: "CollapsedResultDetail"))
1919
1954
  QueryResultItem.struct_class = Types::QueryResultItem
1920
1955
 
1921
1956
  QueryResultItemList.member = Shapes::ShapeRef.new(shape: QueryResultItem)
@@ -2164,6 +2199,8 @@ module Aws::Kendra
2164
2199
  SortingConfiguration.add_member(:sort_order, Shapes::ShapeRef.new(shape: SortOrder, required: true, location_name: "SortOrder"))
2165
2200
  SortingConfiguration.struct_class = Types::SortingConfiguration
2166
2201
 
2202
+ SortingConfigurationList.member = Shapes::ShapeRef.new(shape: SortingConfiguration)
2203
+
2167
2204
  SourceDocument.add_member(:document_id, Shapes::ShapeRef.new(shape: String, location_name: "DocumentId"))
2168
2205
  SourceDocument.add_member(:suggestion_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeKeyList, location_name: "SuggestionAttributes"))
2169
2206
  SourceDocument.add_member(:additional_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeList, location_name: "AdditionalAttributes"))
@@ -32,7 +32,7 @@ module Aws::Kendra
32
32
  raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
33
33
  end
34
34
  if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
35
- if Aws::Endpoints::Matchers.boolean_equals?(true, Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"))
35
+ if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
36
36
  return Aws::Endpoints::Endpoint.new(url: "https://kendra-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
37
37
  end
38
38
  raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
@@ -1192,6 +1192,79 @@ module Aws::Kendra
1192
1192
  include Aws::Structure
1193
1193
  end
1194
1194
 
1195
+ # Specifies how to group results by document attribute value, and how to
1196
+ # display them collapsed/expanded under a designated primary document
1197
+ # for each group.
1198
+ #
1199
+ # @!attribute [rw] document_attribute_key
1200
+ # The document attribute used to group search results. You can use any
1201
+ # attribute that has the `Sortable` flag set to true. You can also
1202
+ # sort by any of the following built-in
1203
+ # attributes:"\_category","\_created\_at",
1204
+ # "\_last\_updated\_at", "\_version", "\_view\_count".
1205
+ # @return [String]
1206
+ #
1207
+ # @!attribute [rw] sorting_configurations
1208
+ # A prioritized list of document attributes/fields that determine the
1209
+ # primary document among those in a collapsed group.
1210
+ # @return [Array<Types::SortingConfiguration>]
1211
+ #
1212
+ # @!attribute [rw] missing_attribute_key_strategy
1213
+ # Specifies the behavior for documents without a value for the
1214
+ # collapse attribute.
1215
+ #
1216
+ # Amazon Kendra offers three customization options:
1217
+ #
1218
+ # * Choose to `COLLAPSE` all documents with null or missing values in
1219
+ # one group. This is the default configuration.
1220
+ #
1221
+ # * Choose to `IGNORE` documents with null or missing values. Ignored
1222
+ # documents will not appear in query results.
1223
+ #
1224
+ # * Choose to `EXPAND` each document with a null or missing value into
1225
+ # a group of its own.
1226
+ # @return [String]
1227
+ #
1228
+ # @!attribute [rw] expand
1229
+ # Specifies whether to expand the collapsed results.
1230
+ # @return [Boolean]
1231
+ #
1232
+ # @!attribute [rw] expand_configuration
1233
+ # Provides configuration information to customize expansion options
1234
+ # for a collapsed group.
1235
+ # @return [Types::ExpandConfiguration]
1236
+ #
1237
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CollapseConfiguration AWS API Documentation
1238
+ #
1239
+ class CollapseConfiguration < Struct.new(
1240
+ :document_attribute_key,
1241
+ :sorting_configurations,
1242
+ :missing_attribute_key_strategy,
1243
+ :expand,
1244
+ :expand_configuration)
1245
+ SENSITIVE = []
1246
+ include Aws::Structure
1247
+ end
1248
+
1249
+ # Provides details about a collapsed group of search results.
1250
+ #
1251
+ # @!attribute [rw] document_attribute
1252
+ # The value of the document attribute that results are collapsed on.
1253
+ # @return [Types::DocumentAttribute]
1254
+ #
1255
+ # @!attribute [rw] expanded_results
1256
+ # A list of results in the collapsed group.
1257
+ # @return [Array<Types::ExpandedResultItem>]
1258
+ #
1259
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CollapsedResultDetail AWS API Documentation
1260
+ #
1261
+ class CollapsedResultDetail < Struct.new(
1262
+ :document_attribute,
1263
+ :expanded_results)
1264
+ SENSITIVE = []
1265
+ include Aws::Structure
1266
+ end
1267
+
1195
1268
  # Provides information about how Amazon Kendra should use the columns of
1196
1269
  # a database in an index.
1197
1270
  #
@@ -2016,9 +2089,8 @@ module Aws::Kendra
2016
2089
  # The Amazon Resource Name (ARN) of an IAM role with permission to
2017
2090
  # access `Query` API, `GetQuerySuggestions` API, and other required
2018
2091
  # APIs. The role also must include permission to access IAM Identity
2019
- # Center (successor to Single Sign-On) that stores your user and group
2020
- # information. For more information, see [IAM access roles for Amazon
2021
- # Kendra][1].
2092
+ # Center that stores your user and group information. For more
2093
+ # information, see [IAM access roles for Amazon Kendra][1].
2022
2094
  #
2023
2095
  #
2024
2096
  #
@@ -2340,9 +2412,8 @@ module Aws::Kendra
2340
2412
  # @return [String]
2341
2413
  #
2342
2414
  # @!attribute [rw] user_group_resolution_configuration
2343
- # Gets users and groups from IAM Identity Center (successor to Single
2344
- # Sign-On) identity source. To configure this, see
2345
- # [UserGroupResolutionConfiguration][1].
2415
+ # Gets users and groups from IAM Identity Center identity source. To
2416
+ # configure this, see [UserGroupResolutionConfiguration][1].
2346
2417
  #
2347
2418
  #
2348
2419
  #
@@ -3775,8 +3846,8 @@ module Aws::Kendra
3775
3846
  #
3776
3847
  # @!attribute [rw] user_group_resolution_configuration
3777
3848
  # Whether you have enabled the configuration for fetching access
3778
- # levels of groups and users from an IAM Identity Center (successor to
3779
- # Single Sign-On) identity source.
3849
+ # levels of groups and users from an IAM Identity Center identity
3850
+ # source.
3780
3851
  # @return [Types::UserGroupResolutionConfiguration]
3781
3852
  #
3782
3853
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
@@ -4751,6 +4822,77 @@ module Aws::Kendra
4751
4822
  include Aws::Structure
4752
4823
  end
4753
4824
 
4825
+ # Specifies the configuration information needed to customize how
4826
+ # collapsed search result groups expand.
4827
+ #
4828
+ # @!attribute [rw] max_result_items_to_expand
4829
+ # The number of collapsed search result groups to expand. If you set
4830
+ # this value to 10, for example, only the first 10 out of 100 result
4831
+ # groups will have expand functionality.
4832
+ # @return [Integer]
4833
+ #
4834
+ # @!attribute [rw] max_expanded_results_per_item
4835
+ # The number of expanded results to show per collapsed primary
4836
+ # document. For instance, if you set this value to 3, then at most 3
4837
+ # results per collapsed group will be displayed.
4838
+ # @return [Integer]
4839
+ #
4840
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExpandConfiguration AWS API Documentation
4841
+ #
4842
+ class ExpandConfiguration < Struct.new(
4843
+ :max_result_items_to_expand,
4844
+ :max_expanded_results_per_item)
4845
+ SENSITIVE = []
4846
+ include Aws::Structure
4847
+ end
4848
+
4849
+ # A single expanded result in a collapsed group of search results.
4850
+ #
4851
+ # An expanded result item contains information about an expanded result
4852
+ # document within a collapsed group of search results. This includes the
4853
+ # original location of the document, a list of attributes assigned to
4854
+ # the document, and relevant text from the document that satisfies the
4855
+ # query.
4856
+ #
4857
+ # @!attribute [rw] id
4858
+ # The identifier for the expanded result.
4859
+ # @return [String]
4860
+ #
4861
+ # @!attribute [rw] document_id
4862
+ # The idenitifier of the document.
4863
+ # @return [String]
4864
+ #
4865
+ # @!attribute [rw] document_title
4866
+ # Provides text and information about where to highlight the text.
4867
+ # @return [Types::TextWithHighlights]
4868
+ #
4869
+ # @!attribute [rw] document_excerpt
4870
+ # Provides text and information about where to highlight the text.
4871
+ # @return [Types::TextWithHighlights]
4872
+ #
4873
+ # @!attribute [rw] document_uri
4874
+ # The URI of the original location of the document.
4875
+ # @return [String]
4876
+ #
4877
+ # @!attribute [rw] document_attributes
4878
+ # An array of document attributes assigned to a document in the search
4879
+ # results. For example, the document author ("\_author") or the
4880
+ # source URI ("\_source\_uri") of the document.
4881
+ # @return [Array<Types::DocumentAttribute>]
4882
+ #
4883
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ExpandedResultItem AWS API Documentation
4884
+ #
4885
+ class ExpandedResultItem < Struct.new(
4886
+ :id,
4887
+ :document_id,
4888
+ :document_title,
4889
+ :document_excerpt,
4890
+ :document_uri,
4891
+ :document_attributes)
4892
+ SENSITIVE = []
4893
+ include Aws::Structure
4894
+ end
4895
+
4754
4896
  # Provides the configuration information for your Amazon Kendra
4755
4897
  # experience. This includes the data source IDs and/or FAQ IDs, and user
4756
4898
  # or group information to grant access to your Amazon Kendra experience.
@@ -7641,6 +7783,20 @@ module Aws::Kendra
7641
7783
  # by the relevance that Amazon Kendra determines for the result.
7642
7784
  # @return [Types::SortingConfiguration]
7643
7785
  #
7786
+ # @!attribute [rw] sorting_configurations
7787
+ # Provides configuration information to determine how the results of a
7788
+ # query are sorted.
7789
+ #
7790
+ # You can set upto 3 fields that Amazon Kendra should sort the results
7791
+ # on, and specify whether the results should be sorted in ascending or
7792
+ # descending order. The sort field quota can be increased.
7793
+ #
7794
+ # If you don't provide a sorting configuration, the results are
7795
+ # sorted by the relevance that Amazon Kendra determines for the
7796
+ # result. In the case of ties in sorting the results, the results are
7797
+ # sorted by relevance.
7798
+ # @return [Array<Types::SortingConfiguration>]
7799
+ #
7644
7800
  # @!attribute [rw] user_context
7645
7801
  # The user context token or user and group information.
7646
7802
  # @return [Types::UserContext]
@@ -7656,6 +7812,12 @@ module Aws::Kendra
7656
7812
  # Enables suggested spell corrections for queries.
7657
7813
  # @return [Types::SpellCorrectionConfiguration]
7658
7814
  #
7815
+ # @!attribute [rw] collapse_configuration
7816
+ # Provides configuration to determine how to group results by document
7817
+ # attribute value, and how to display them (collapsed or expanded)
7818
+ # under a designated primary document for each group.
7819
+ # @return [Types::CollapseConfiguration]
7820
+ #
7659
7821
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
7660
7822
  #
7661
7823
  class QueryRequest < Struct.new(
@@ -7669,9 +7831,11 @@ module Aws::Kendra
7669
7831
  :page_number,
7670
7832
  :page_size,
7671
7833
  :sorting_configuration,
7834
+ :sorting_configurations,
7672
7835
  :user_context,
7673
7836
  :visitor_id,
7674
- :spell_correction_configuration)
7837
+ :spell_correction_configuration,
7838
+ :collapse_configuration)
7675
7839
  SENSITIVE = []
7676
7840
  include Aws::Structure
7677
7841
  end
@@ -7818,6 +7982,10 @@ module Aws::Kendra
7818
7982
  # An excerpt from a table within a document.
7819
7983
  # @return [Types::TableExcerpt]
7820
7984
  #
7985
+ # @!attribute [rw] collapsed_result_detail
7986
+ # Provides details about a collapsed group of search results.
7987
+ # @return [Types::CollapsedResultDetail]
7988
+ #
7821
7989
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResultItem AWS API Documentation
7822
7990
  #
7823
7991
  class QueryResultItem < Struct.new(
@@ -7832,7 +8000,8 @@ module Aws::Kendra
7832
8000
  :document_attributes,
7833
8001
  :score_attributes,
7834
8002
  :feedback_token,
7835
- :table_excerpt)
8003
+ :table_excerpt,
8004
+ :collapsed_result_detail)
7836
8005
  SENSITIVE = []
7837
8006
  include Aws::Structure
7838
8007
  end
@@ -10351,8 +10520,8 @@ module Aws::Kendra
10351
10520
  #
10352
10521
  # @!attribute [rw] user_group_resolution_configuration
10353
10522
  # Enables fetching access levels of groups and users from an IAM
10354
- # Identity Center (successor to Single Sign-On) identity source. To
10355
- # configure this, see [UserGroupResolutionConfiguration][1].
10523
+ # Identity Center identity source. To configure this, see
10524
+ # [UserGroupResolutionConfiguration][1].
10356
10525
  #
10357
10526
  #
10358
10527
  #
@@ -10639,11 +10808,11 @@ module Aws::Kendra
10639
10808
  end
10640
10809
 
10641
10810
  # Provides the configuration information to get users and groups from an
10642
- # IAM Identity Center (successor to Single Sign-On) identity source.
10643
- # This is useful for user context filtering, where search results are
10644
- # filtered based on the user or their group access to documents. You can
10645
- # also use the [PutPrincipalMapping][1] API to map users to their groups
10646
- # so that you only need to provide the user ID when you issue the query.
10811
+ # IAM Identity Center identity source. This is useful for user context
10812
+ # filtering, where search results are filtered based on the user or
10813
+ # their group access to documents. You can also use the
10814
+ # [PutPrincipalMapping][1] API to map users to their groups so that you
10815
+ # only need to provide the user ID when you issue the query.
10647
10816
  #
10648
10817
  # To set up an IAM Identity Center identity source in the console to use
10649
10818
  # with Amazon Kendra, see [Getting started with an IAM Identity Center
@@ -10665,9 +10834,9 @@ module Aws::Kendra
10665
10834
  #
10666
10835
  # @!attribute [rw] user_group_resolution_mode
10667
10836
  # The identity store provider (mode) you want to use to get users and
10668
- # groups. IAM Identity Center (successor to Single Sign-On) is
10669
- # currently the only available mode. Your users and groups must exist
10670
- # in an IAM Identity Center identity source in order to use this mode.
10837
+ # groups. IAM Identity Center is currently the only available mode.
10838
+ # Your users and groups must exist in an IAM Identity Center identity
10839
+ # source in order to use this mode.
10671
10840
  # @return [String]
10672
10841
  #
10673
10842
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserGroupResolutionConfiguration AWS API Documentation
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-kendra/customizations'
52
52
  # @!group service
53
53
  module Aws::Kendra
54
54
 
55
- GEM_VERSION = '1.73.0'
55
+ GEM_VERSION = '1.74.0'
56
56
 
57
57
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-kendra
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.73.0
4
+ version: 1.74.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-27 00:00:00.000000000 Z
11
+ date: 2023-10-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core