aws-sdk-kendra 1.64.0 → 1.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8db83296966f4238a91ac05402466f928b50af51695321c9571639c510b48221
-  data.tar.gz: bc738c1e1a85a8675575e003f0d8515abbfd2e50666480311cb3c3d2ba41bb0a
+  metadata.gz: af2f9514388d9284be2b0d7bb44d282a6363f30efed93f52a8e545d1cd080c71
+  data.tar.gz: 186df6ced079724421e6653732a7c9043a25d5e7496c477c148ff36ba1ba4891
 SHA512:
-  metadata.gz: 997f04f694b9983e7334352516beb38f1ad1410130da64b23430740d1fb9cc667af5f9787fc481dff83b966b7ab5b1e2b0ac4327df3f5c65de1b393e47a4468e
-  data.tar.gz: 3f99d218d06043f4db393d04ee0616404ed0dfb6820130ad9498e34f7b9bac66c30f73a2a08568968baef0b9b3a962bd108dd44b9b9b14a00599a877ffb5c685
+  metadata.gz: 4af4556449705d36ca788ab080cb9e57911e85b95afb3bfcae1978479bd694265d61e158fcb7e2a9736efb466f6b8a23b55c2b23ce90c97d6c2e3da77954cc94
+  data.tar.gz: 728eaf5a6ccadafff788931be6da6f0df0a02d65f87a29929dfe570b2acb567caf7d5f4ab297e345306f9d9807360869d3f2f5257baf06d570f1bbdf62468aa7

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.66.0 (2023-05-31)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
+1.65.0 (2023-05-02)
+------------------
+
+* Feature - AWS Kendra now supports configuring document fields/attributes via the GetQuerySuggestions API. You can now base query suggestions on the contents of document fields.
+
 1.64.0 (2023-03-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.64.0
+1.66.0

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

@@ -275,6 +275,11 @@ module Aws::Kendra
     #       in the future.
     #
     #
+    #   @option options [String] :sdk_ua_app_id
+    #     A unique and opaque application ID that is appended to the
+    #     User-Agent header as app/<sdk_ua_app_id>. It should have a
+    #     maximum length of 50.
+    #
     #   @option options [String] :secret_access_key
     #
     #   @option options [String] :session_token
@@ -2306,7 +2311,7 @@ module Aws::Kendra
     #
     #
     # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
-    # [2]: https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-block-list
+    # [2]: https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist
     #
     # @option params [required, String] :index_id
     #   The identifier of the index you want to create a query suggestions
@@ -3767,6 +3772,7 @@ module Aws::Kendra
     #   * {Types::DescribeQuerySuggestionsConfigResponse#last_suggestions_build_time #last_suggestions_build_time} => Time
     #   * {Types::DescribeQuerySuggestionsConfigResponse#last_clear_time #last_clear_time} => Time
     #   * {Types::DescribeQuerySuggestionsConfigResponse#total_suggestions_count #total_suggestions_count} => Integer
+    #   * {Types::DescribeQuerySuggestionsConfigResponse#attribute_suggestions_config #attribute_suggestions_config} => Types::AttributeSuggestionsDescribeConfig
     #
     # @example Request syntax with placeholder values
     #
@@ -3785,6 +3791,10 @@ module Aws::Kendra
     #   resp.last_suggestions_build_time #=> Time
     #   resp.last_clear_time #=> Time
     #   resp.total_suggestions_count #=> Integer
+    #   resp.attribute_suggestions_config.suggestable_config_list #=> Array
+    #   resp.attribute_suggestions_config.suggestable_config_list[0].attribute_name #=> String
+    #   resp.attribute_suggestions_config.suggestable_config_list[0].suggestable #=> Boolean
+    #   resp.attribute_suggestions_config.attribute_suggestions_mode #=> String, one of "ACTIVE", "INACTIVE"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfig AWS API Documentation
     #
@@ -3974,6 +3984,23 @@ module Aws::Kendra
     #   The maximum number of query suggestions you want to show to your
     #   users.
     #
+    # @option params [Array<String>] :suggestion_types
+    #   The suggestions type to base query suggestions on. The suggestion
+    #   types are query history or document fields/attributes. You can set one
+    #   type or the other.
+    #
+    #   If you set query history as your suggestions type, Amazon Kendra
+    #   suggests queries relevant to your users based on popular queries in
+    #   the query history.
+    #
+    #   If you set document fields/attributes as your suggestions type, Amazon
+    #   Kendra suggests queries relevant to your users based on the contents
+    #   of document fields.
+    #
+    # @option params [Types::AttributeSuggestionsGetConfig] :attribute_suggestions_config
+    #   Configuration information for the document fields/attributes that you
+    #   want to base query suggestions on.
+    #
     # @return [Types::GetQuerySuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetQuerySuggestionsResponse#query_suggestions_id #query_suggestions_id} => String
@@ -3985,6 +4012,100 @@ module Aws::Kendra
     #     index_id: "IndexId", # required
     #     query_text: "SuggestionQueryText", # required
     #     max_suggestions_count: 1,
+    #     suggestion_types: ["QUERY"], # accepts QUERY, DOCUMENT_ATTRIBUTES
+    #     attribute_suggestions_config: {
+    #       suggestion_attributes: ["DocumentAttributeKey"],
+    #       additional_response_attributes: ["DocumentAttributeKey"],
+    #       attribute_filter: {
+    #         and_all_filters: [
+    #           {
+    #             # recursive AttributeFilter
+    #           },
+    #         ],
+    #         or_all_filters: [
+    #           {
+    #             # recursive AttributeFilter
+    #           },
+    #         ],
+    #         not_filter: {
+    #           # recursive AttributeFilter
+    #         },
+    #         equals_to: {
+    #           key: "DocumentAttributeKey", # required
+    #           value: { # required
+    #             string_value: "DocumentAttributeStringValue",
+    #             string_list_value: ["String"],
+    #             long_value: 1,
+    #             date_value: Time.now,
+    #           },
+    #         },
+    #         contains_all: {
+    #           key: "DocumentAttributeKey", # required
+    #           value: { # required
+    #             string_value: "DocumentAttributeStringValue",
+    #             string_list_value: ["String"],
+    #             long_value: 1,
+    #             date_value: Time.now,
+    #           },
+    #         },
+    #         contains_any: {
+    #           key: "DocumentAttributeKey", # required
+    #           value: { # required
+    #             string_value: "DocumentAttributeStringValue",
+    #             string_list_value: ["String"],
+    #             long_value: 1,
+    #             date_value: Time.now,
+    #           },
+    #         },
+    #         greater_than: {
+    #           key: "DocumentAttributeKey", # required
+    #           value: { # required
+    #             string_value: "DocumentAttributeStringValue",
+    #             string_list_value: ["String"],
+    #             long_value: 1,
+    #             date_value: Time.now,
+    #           },
+    #         },
+    #         greater_than_or_equals: {
+    #           key: "DocumentAttributeKey", # required
+    #           value: { # required
+    #             string_value: "DocumentAttributeStringValue",
+    #             string_list_value: ["String"],
+    #             long_value: 1,
+    #             date_value: Time.now,
+    #           },
+    #         },
+    #         less_than: {
+    #           key: "DocumentAttributeKey", # required
+    #           value: { # required
+    #             string_value: "DocumentAttributeStringValue",
+    #             string_list_value: ["String"],
+    #             long_value: 1,
+    #             date_value: Time.now,
+    #           },
+    #         },
+    #         less_than_or_equals: {
+    #           key: "DocumentAttributeKey", # required
+    #           value: { # required
+    #             string_value: "DocumentAttributeStringValue",
+    #             string_list_value: ["String"],
+    #             long_value: 1,
+    #             date_value: Time.now,
+    #           },
+    #         },
+    #       },
+    #       user_context: {
+    #         token: "Token",
+    #         user_id: "PrincipalName",
+    #         groups: ["PrincipalName"],
+    #         data_source_groups: [
+    #           {
+    #             group_id: "PrincipalName", # required
+    #             data_source_id: "DataSourceId", # required
+    #           },
+    #         ],
+    #       },
+    #     },
     #   })
     #
     # @example Response structure
@@ -3996,6 +4117,17 @@ module Aws::Kendra
     #   resp.suggestions[0].value.text.highlights #=> Array
     #   resp.suggestions[0].value.text.highlights[0].begin_offset #=> Integer
     #   resp.suggestions[0].value.text.highlights[0].end_offset #=> Integer
+    #   resp.suggestions[0].source_documents #=> Array
+    #   resp.suggestions[0].source_documents[0].document_id #=> String
+    #   resp.suggestions[0].source_documents[0].suggestion_attributes #=> Array
+    #   resp.suggestions[0].source_documents[0].suggestion_attributes[0] #=> String
+    #   resp.suggestions[0].source_documents[0].additional_attributes #=> Array
+    #   resp.suggestions[0].source_documents[0].additional_attributes[0].key #=> String
+    #   resp.suggestions[0].source_documents[0].additional_attributes[0].value.string_value #=> String
+    #   resp.suggestions[0].source_documents[0].additional_attributes[0].value.string_list_value #=> Array
+    #   resp.suggestions[0].source_documents[0].additional_attributes[0].value.string_list_value[0] #=> String
+    #   resp.suggestions[0].source_documents[0].additional_attributes[0].value.long_value #=> Integer
+    #   resp.suggestions[0].source_documents[0].additional_attributes[0].value.date_value #=> Time
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestions AWS API Documentation
     #
@@ -6385,7 +6517,7 @@ module Aws::Kendra
     #   The identifier of the index used for featuring results.
     #
     # @option params [required, String] :featured_results_set_id
-    #   The identifier of the index used for featuring results.
+    #   The identifier of the set of featured results that you want to update.
     #
     # @option params [String] :featured_results_set_name
     #   A new name for the set of featured results.
@@ -6645,8 +6777,8 @@ module Aws::Kendra
     # Amazon Kendra supports partial updates, so you only need to provide
     # the fields you want to update.
     #
-    # If an update is currently processing (i.e. 'happening'), you need to
-    # wait for the update to finish before making another update.
+    # If an update is currently processing, you need to wait for the update
+    # to finish before making another update.
     #
     # Updates to query suggestions settings might not take effect right
     # away. The time for your updated settings to take effect depends on the
@@ -6714,6 +6846,10 @@ module Aws::Kendra
     #
     #   How you tune this setting depends on your specific needs.
     #
+    # @option params [Types::AttributeSuggestionsUpdateConfig] :attribute_suggestions_config
+    #   Configuration information for the document fields/attributes that you
+    #   want to base query suggestions on.
+    #
     # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
     #
     # @example Request syntax with placeholder values
@@ -6725,6 +6861,15 @@ module Aws::Kendra
     #     include_queries_without_user_information: false,
     #     minimum_number_of_querying_users: 1,
     #     minimum_query_count: 1,
+    #     attribute_suggestions_config: {
+    #       suggestable_config_list: [
+    #         {
+    #           attribute_name: "DocumentAttributeKey",
+    #           suggestable: false,
+    #         },
+    #       ],
+    #       attribute_suggestions_mode: "ACTIVE", # accepts ACTIVE, INACTIVE
+    #     },
     #   })
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfig AWS API Documentation
@@ -6795,7 +6940,7 @@ module Aws::Kendra
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kendra'
-      context[:gem_version] = '1.64.0'
+      context[:gem_version] = '1.66.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -35,6 +35,10 @@ module Aws::Kendra
     AssociatePersonasToEntitiesResponse = Shapes::StructureShape.new(name: 'AssociatePersonasToEntitiesResponse')
     AttributeFilter = Shapes::StructureShape.new(name: 'AttributeFilter')
     AttributeFilterList = Shapes::ListShape.new(name: 'AttributeFilterList')
+    AttributeSuggestionsDescribeConfig = Shapes::StructureShape.new(name: 'AttributeSuggestionsDescribeConfig')
+    AttributeSuggestionsGetConfig = Shapes::StructureShape.new(name: 'AttributeSuggestionsGetConfig')
+    AttributeSuggestionsMode = Shapes::StringShape.new(name: 'AttributeSuggestionsMode')
+    AttributeSuggestionsUpdateConfig = Shapes::StructureShape.new(name: 'AttributeSuggestionsUpdateConfig')
     AuthenticationConfiguration = Shapes::StructureShape.new(name: 'AuthenticationConfiguration')
     BasicAuthenticationConfiguration = Shapes::StructureShape.new(name: 'BasicAuthenticationConfiguration')
     BasicAuthenticationConfigurationList = Shapes::ListShape.new(name: 'BasicAuthenticationConfigurationList')
@@ -492,6 +496,8 @@ module Aws::Kendra
     SnapshotsDataRecords = Shapes::ListShape.new(name: 'SnapshotsDataRecords')
     SortOrder = Shapes::StringShape.new(name: 'SortOrder')
     SortingConfiguration = Shapes::StructureShape.new(name: 'SortingConfiguration')
+    SourceDocument = Shapes::StructureShape.new(name: 'SourceDocument')
+    SourceDocuments = Shapes::ListShape.new(name: 'SourceDocuments')
     SpellCorrectedQuery = Shapes::StructureShape.new(name: 'SpellCorrectedQuery')
     SpellCorrectedQueryList = Shapes::ListShape.new(name: 'SpellCorrectedQueryList')
     SpellCorrectionConfiguration = Shapes::StructureShape.new(name: 'SpellCorrectionConfiguration')
@@ -506,6 +512,8 @@ module Aws::Kendra
     SubmitFeedbackRequest = Shapes::StructureShape.new(name: 'SubmitFeedbackRequest')
     SubnetId = Shapes::StringShape.new(name: 'SubnetId')
     SubnetIdList = Shapes::ListShape.new(name: 'SubnetIdList')
+    SuggestableConfig = Shapes::StructureShape.new(name: 'SuggestableConfig')
+    SuggestableConfigList = Shapes::ListShape.new(name: 'SuggestableConfigList')
     SuggestedQueryText = Shapes::StringShape.new(name: 'SuggestedQueryText')
     Suggestion = Shapes::StructureShape.new(name: 'Suggestion')
     SuggestionHighlight = Shapes::StructureShape.new(name: 'SuggestionHighlight')
@@ -513,6 +521,8 @@ module Aws::Kendra
     SuggestionList = Shapes::ListShape.new(name: 'SuggestionList')
     SuggestionQueryText = Shapes::StringShape.new(name: 'SuggestionQueryText')
     SuggestionTextWithHighlights = Shapes::StructureShape.new(name: 'SuggestionTextWithHighlights')
+    SuggestionType = Shapes::StringShape.new(name: 'SuggestionType')
+    SuggestionTypes = Shapes::ListShape.new(name: 'SuggestionTypes')
     SuggestionValue = Shapes::StructureShape.new(name: 'SuggestionValue')
     TableCell = Shapes::StructureShape.new(name: 'TableCell')
     TableCellList = Shapes::ListShape.new(name: 'TableCellList')
@@ -655,6 +665,20 @@ module Aws::Kendra
 
     AttributeFilterList.member = Shapes::ShapeRef.new(shape: AttributeFilter)
 
+    AttributeSuggestionsDescribeConfig.add_member(:suggestable_config_list, Shapes::ShapeRef.new(shape: SuggestableConfigList, location_name: "SuggestableConfigList"))
+    AttributeSuggestionsDescribeConfig.add_member(:attribute_suggestions_mode, Shapes::ShapeRef.new(shape: AttributeSuggestionsMode, location_name: "AttributeSuggestionsMode"))
+    AttributeSuggestionsDescribeConfig.struct_class = Types::AttributeSuggestionsDescribeConfig
+
+    AttributeSuggestionsGetConfig.add_member(:suggestion_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeKeyList, location_name: "SuggestionAttributes"))
+    AttributeSuggestionsGetConfig.add_member(:additional_response_attributes, Shapes::ShapeRef.new(shape: DocumentAttributeKeyList, location_name: "AdditionalResponseAttributes"))
+    AttributeSuggestionsGetConfig.add_member(:attribute_filter, Shapes::ShapeRef.new(shape: AttributeFilter, location_name: "AttributeFilter"))
+    AttributeSuggestionsGetConfig.add_member(:user_context, Shapes::ShapeRef.new(shape: UserContext, location_name: "UserContext"))
+    AttributeSuggestionsGetConfig.struct_class = Types::AttributeSuggestionsGetConfig
+
+    AttributeSuggestionsUpdateConfig.add_member(:suggestable_config_list, Shapes::ShapeRef.new(shape: SuggestableConfigList, location_name: "SuggestableConfigList"))
+    AttributeSuggestionsUpdateConfig.add_member(:attribute_suggestions_mode, Shapes::ShapeRef.new(shape: AttributeSuggestionsMode, location_name: "AttributeSuggestionsMode"))
+    AttributeSuggestionsUpdateConfig.struct_class = Types::AttributeSuggestionsUpdateConfig
+
     AuthenticationConfiguration.add_member(:basic_authentication, Shapes::ShapeRef.new(shape: BasicAuthenticationConfigurationList, location_name: "BasicAuthentication"))
     AuthenticationConfiguration.struct_class = Types::AuthenticationConfiguration
 
@@ -1228,6 +1252,7 @@ module Aws::Kendra
     DescribeQuerySuggestionsConfigResponse.add_member(:last_suggestions_build_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastSuggestionsBuildTime"))
     DescribeQuerySuggestionsConfigResponse.add_member(:last_clear_time, Shapes::ShapeRef.new(shape: Timestamp, location_name: "LastClearTime"))
     DescribeQuerySuggestionsConfigResponse.add_member(:total_suggestions_count, Shapes::ShapeRef.new(shape: Integer, location_name: "TotalSuggestionsCount"))
+    DescribeQuerySuggestionsConfigResponse.add_member(:attribute_suggestions_config, Shapes::ShapeRef.new(shape: AttributeSuggestionsDescribeConfig, location_name: "AttributeSuggestionsConfig"))
     DescribeQuerySuggestionsConfigResponse.struct_class = Types::DescribeQuerySuggestionsConfigResponse
 
     DescribeThesaurusRequest.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, required: true, location_name: "Id"))
@@ -1498,6 +1523,8 @@ module Aws::Kendra
     GetQuerySuggestionsRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
     GetQuerySuggestionsRequest.add_member(:query_text, Shapes::ShapeRef.new(shape: SuggestionQueryText, required: true, location_name: "QueryText"))
     GetQuerySuggestionsRequest.add_member(:max_suggestions_count, Shapes::ShapeRef.new(shape: Integer, location_name: "MaxSuggestionsCount"))
+    GetQuerySuggestionsRequest.add_member(:suggestion_types, Shapes::ShapeRef.new(shape: SuggestionTypes, location_name: "SuggestionTypes"))
+    GetQuerySuggestionsRequest.add_member(:attribute_suggestions_config, Shapes::ShapeRef.new(shape: AttributeSuggestionsGetConfig, location_name: "AttributeSuggestionsConfig"))
     GetQuerySuggestionsRequest.struct_class = Types::GetQuerySuggestionsRequest
 
     GetQuerySuggestionsResponse.add_member(:query_suggestions_id, Shapes::ShapeRef.new(shape: QuerySuggestionsId, location_name: "QuerySuggestionsId"))
@@ -2106,6 +2133,13 @@ module Aws::Kendra
     SortingConfiguration.add_member(:sort_order, Shapes::ShapeRef.new(shape: SortOrder, required: true, location_name: "SortOrder"))
     SortingConfiguration.struct_class = Types::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"))
+    SourceDocument.struct_class = Types::SourceDocument
+
+    SourceDocuments.member = Shapes::ShapeRef.new(shape: SourceDocument)
+
     SpellCorrectedQuery.add_member(:suggested_query_text, Shapes::ShapeRef.new(shape: SuggestedQueryText, location_name: "SuggestedQueryText"))
     SpellCorrectedQuery.add_member(:corrections, Shapes::ShapeRef.new(shape: CorrectionList, location_name: "Corrections"))
     SpellCorrectedQuery.struct_class = Types::SpellCorrectedQuery
@@ -2145,8 +2179,15 @@ module Aws::Kendra
 
     SubnetIdList.member = Shapes::ShapeRef.new(shape: SubnetId)
 
+    SuggestableConfig.add_member(:attribute_name, Shapes::ShapeRef.new(shape: DocumentAttributeKey, location_name: "AttributeName"))
+    SuggestableConfig.add_member(:suggestable, Shapes::ShapeRef.new(shape: ObjectBoolean, location_name: "Suggestable"))
+    SuggestableConfig.struct_class = Types::SuggestableConfig
+
+    SuggestableConfigList.member = Shapes::ShapeRef.new(shape: SuggestableConfig)
+
     Suggestion.add_member(:id, Shapes::ShapeRef.new(shape: ResultId, location_name: "Id"))
     Suggestion.add_member(:value, Shapes::ShapeRef.new(shape: SuggestionValue, location_name: "Value"))
+    Suggestion.add_member(:source_documents, Shapes::ShapeRef.new(shape: SourceDocuments, location_name: "SourceDocuments"))
     Suggestion.struct_class = Types::Suggestion
 
     SuggestionHighlight.add_member(:begin_offset, Shapes::ShapeRef.new(shape: Integer, location_name: "BeginOffset"))
@@ -2161,6 +2202,8 @@ module Aws::Kendra
     SuggestionTextWithHighlights.add_member(:highlights, Shapes::ShapeRef.new(shape: SuggestionHighlightList, location_name: "Highlights"))
     SuggestionTextWithHighlights.struct_class = Types::SuggestionTextWithHighlights
 
+    SuggestionTypes.member = Shapes::ShapeRef.new(shape: SuggestionType)
+
     SuggestionValue.add_member(:text, Shapes::ShapeRef.new(shape: SuggestionTextWithHighlights, location_name: "Text"))
     SuggestionValue.struct_class = Types::SuggestionValue
 
@@ -2295,6 +2338,7 @@ module Aws::Kendra
     UpdateQuerySuggestionsConfigRequest.add_member(:include_queries_without_user_information, Shapes::ShapeRef.new(shape: ObjectBoolean, location_name: "IncludeQueriesWithoutUserInformation"))
     UpdateQuerySuggestionsConfigRequest.add_member(:minimum_number_of_querying_users, Shapes::ShapeRef.new(shape: MinimumNumberOfQueryingUsers, location_name: "MinimumNumberOfQueryingUsers"))
     UpdateQuerySuggestionsConfigRequest.add_member(:minimum_query_count, Shapes::ShapeRef.new(shape: MinimumQueryCount, location_name: "MinimumQueryCount"))
+    UpdateQuerySuggestionsConfigRequest.add_member(:attribute_suggestions_config, Shapes::ShapeRef.new(shape: AttributeSuggestionsUpdateConfig, location_name: "AttributeSuggestionsConfig"))
     UpdateQuerySuggestionsConfigRequest.struct_class = Types::UpdateQuerySuggestionsConfigRequest
 
     UpdateThesaurusRequest.add_member(:id, Shapes::ShapeRef.new(shape: ThesaurusId, required: true, location_name: "Id"))

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

@@ -433,6 +433,125 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # Gets information on the configuration of document fields/attributes
+    # that you want to base query suggestions on. To change your
+    # configuration, use [AttributeSuggestionsUpdateConfig][1] and then call
+    # [UpdateQuerySuggestionsConfig][2].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_AttributeSuggestionsUpdateConfig.html
+    # [2]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
+    #
+    # @!attribute [rw] suggestable_config_list
+    #   The list of fields/attributes that you want to set as suggestible
+    #   for query suggestions.
+    #   @return [Array<Types::SuggestableConfig>]
+    #
+    # @!attribute [rw] attribute_suggestions_mode
+    #   The mode is set to either `ACTIVE` or `INACTIVE`. If the `Mode` for
+    #   query history is set to `ENABLED` when calling
+    #   [UpdateQuerySuggestionsConfig][1] and `AttributeSuggestionsMode` to
+    #   use fields/attributes is set to `ACTIVE`, and you haven't set your
+    #   `SuggestionTypes` preference to `DOCUMENT_ATTRIBUTES`, then Amazon
+    #   Kendra uses the query history.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeSuggestionsDescribeConfig AWS API Documentation
+    #
+    class AttributeSuggestionsDescribeConfig < Struct.new(
+      :suggestable_config_list,
+      :attribute_suggestions_mode)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides the configuration information for the document
+    # fields/attributes that you want to base query suggestions on.
+    #
+    # @!attribute [rw] suggestion_attributes
+    #   The list of document field/attribute keys or field names to use for
+    #   query suggestions. If the content within any of the fields match
+    #   what your user starts typing as their query, then the field content
+    #   is returned as a query suggestion.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] additional_response_attributes
+    #   The list of additional document field/attribute keys or field names
+    #   to include in the response. You can use additional fields to provide
+    #   extra information in the response. Additional fields are not used to
+    #   based suggestions on.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] attribute_filter
+    #   Filters the search results based on document fields/attributes.
+    #   @return [Types::AttributeFilter]
+    #
+    # @!attribute [rw] user_context
+    #   Applies user context filtering so that only users who are given
+    #   access to certain documents see these document in their search
+    #   results.
+    #   @return [Types::UserContext]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeSuggestionsGetConfig AWS API Documentation
+    #
+    class AttributeSuggestionsGetConfig < Struct.new(
+      :suggestion_attributes,
+      :additional_response_attributes,
+      :attribute_filter,
+      :user_context)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Updates the configuration information for the document
+    # fields/attributes that you want to base query suggestions on.
+    #
+    # To deactivate using documents fields for query suggestions, set the
+    # mode to `INACTIVE`. You must also set `SuggestionTypes` as either
+    # `QUERY` or `DOCUMENT_ATTRIBUTES` and then call
+    # [GetQuerySuggestions][1]. If you set to `QUERY`, then Amazon Kendra
+    # uses the query history to base suggestions on. If you set to
+    # `DOCUMENT_ATTRIBUTES`, then Amazon Kendra uses the contents of
+    # document fields to base suggestions on.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html
+    #
+    # @!attribute [rw] suggestable_config_list
+    #   The list of fields/attributes that you want to set as suggestible
+    #   for query suggestions.
+    #   @return [Array<Types::SuggestableConfig>]
+    #
+    # @!attribute [rw] attribute_suggestions_mode
+    #   You can set the mode to `ACTIVE` or `INACTIVE`. You must also set
+    #   `SuggestionTypes` as either `QUERY` or `DOCUMENT_ATTRIBUTES` and
+    #   then call [GetQuerySuggestions][1]. If `Mode` to use query history
+    #   is set to `ENABLED` when calling [UpdateQuerySuggestionsConfig][2]
+    #   and `AttributeSuggestionsMode` to use fields/attributes is set to
+    #   `ACTIVE`, and you haven't set your `SuggestionTypes` preference to
+    #   `DOCUMENT_ATTRIBUTES`, then Amazon Kendra uses the query history.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_GetQuerySuggestions.html
+    #   [2]: https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeSuggestionsUpdateConfig AWS API Documentation
+    #
+    class AttributeSuggestionsUpdateConfig < Struct.new(
+      :suggestable_config_list,
+      :attribute_suggestions_mode)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Provides the configuration information to connect to websites that
     # require user authentication.
     #
@@ -3841,6 +3960,13 @@ module Aws::Kendra
     # @!attribute [rw] last_suggestions_build_time
     #   The Unix timestamp when query suggestions for an index was last
     #   updated.
+    #
+    #   Amazon Kendra automatically updates suggestions every 24 hours,
+    #   after you change a setting or after you apply a [block list][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#query-suggestions-blocklist
     #   @return [Time]
     #
     # @!attribute [rw] last_clear_time
@@ -3860,8 +3986,17 @@ module Aws::Kendra
     #   settings, if you filter out certain queries from suggestions using a
     #   block list, and as the query log accumulates more queries for Amazon
     #   Kendra to learn from.
+    #
+    #   If the count is much lower than you expected, it could be because
+    #   Amazon Kendra needs more queries in the query history to learn from
+    #   or your current query suggestions settings are too strict.
     #   @return [Integer]
     #
+    # @!attribute [rw] attribute_suggestions_config
+    #   Configuration information for the document fields/attributes that
+    #   you want to base query suggestions on.
+    #   @return [Types::AttributeSuggestionsDescribeConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigResponse AWS API Documentation
     #
     class DescribeQuerySuggestionsConfigResponse < Struct.new(
@@ -3873,7 +4008,8 @@ module Aws::Kendra
       :minimum_query_count,
       :last_suggestions_build_time,
       :last_clear_time,
-      :total_suggestions_count)
+      :total_suggestions_count,
+      :attribute_suggestions_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -5263,12 +5399,33 @@ module Aws::Kendra
     #   users.
     #   @return [Integer]
     #
+    # @!attribute [rw] suggestion_types
+    #   The suggestions type to base query suggestions on. The suggestion
+    #   types are query history or document fields/attributes. You can set
+    #   one type or the other.
+    #
+    #   If you set query history as your suggestions type, Amazon Kendra
+    #   suggests queries relevant to your users based on popular queries in
+    #   the query history.
+    #
+    #   If you set document fields/attributes as your suggestions type,
+    #   Amazon Kendra suggests queries relevant to your users based on the
+    #   contents of document fields.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] attribute_suggestions_config
+    #   Configuration information for the document fields/attributes that
+    #   you want to base query suggestions on.
+    #   @return [Types::AttributeSuggestionsGetConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GetQuerySuggestionsRequest AWS API Documentation
     #
     class GetQuerySuggestionsRequest < Struct.new(
       :index_id,
       :query_text,
-      :max_suggestions_count)
+      :max_suggestions_count,
+      :suggestion_types,
+      :attribute_suggestions_config)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -9084,6 +9241,33 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # The document ID and its fields/attributes that are used for a query
+    # suggestion, if document fields set to use for query suggestions.
+    #
+    # @!attribute [rw] document_id
+    #   The identifier of the document used for a query suggestion.
+    #   @return [String]
+    #
+    # @!attribute [rw] suggestion_attributes
+    #   The document fields/attributes used for a query suggestion.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] additional_attributes
+    #   The additional fields/attributes to include in the response. You can
+    #   use additional fields to provide extra information in the response.
+    #   Additional fields are not used to based suggestions on.
+    #   @return [Array<Types::DocumentAttribute>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SourceDocument AWS API Documentation
+    #
+    class SourceDocument < Struct.new(
+      :document_id,
+      :suggestion_attributes,
+      :additional_attributes)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A query with suggested spell corrections.
     #
     # @!attribute [rw] suggested_query_text
@@ -9270,6 +9454,27 @@ module Aws::Kendra
       include Aws::Structure
     end
 
+    # Provides the configuration information for a document field/attribute
+    # that you want to base query suggestions on.
+    #
+    # @!attribute [rw] attribute_name
+    #   The name of the document field/attribute.
+    #   @return [String]
+    #
+    # @!attribute [rw] suggestable
+    #   `TRUE` means the document field/attribute is suggestible, so the
+    #   contents within the field can be used for query suggestions.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SuggestableConfig AWS API Documentation
+    #
+    class SuggestableConfig < Struct.new(
+      :attribute_name,
+      :suggestable)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A single query suggestion.
     #
     # @!attribute [rw] id
@@ -9284,11 +9489,18 @@ module Aws::Kendra
     #   The value is the text string of a suggestion.
     #   @return [Types::SuggestionValue]
     #
+    # @!attribute [rw] source_documents
+    #   The list of document IDs and their fields/attributes that are used
+    #   for a single query suggestion, if document fields set to use for
+    #   query suggestions.
+    #   @return [Array<Types::SourceDocument>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Suggestion AWS API Documentation
     #
     class Suggestion < Struct.new(
       :id,
-      :value)
+      :value,
+      :source_documents)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -9808,7 +10020,8 @@ module Aws::Kendra
     #   @return [String]
     #
     # @!attribute [rw] featured_results_set_id
-    #   The identifier of the index used for featuring results.
+    #   The identifier of the set of featured results that you want to
+    #   update.
     #   @return [String]
     #
     # @!attribute [rw] featured_results_set_name
@@ -10056,6 +10269,11 @@ module Aws::Kendra
     #   How you tune this setting depends on your specific needs.
     #   @return [Integer]
     #
+    # @!attribute [rw] attribute_suggestions_config
+    #   Configuration information for the document fields/attributes that
+    #   you want to base query suggestions on.
+    #   @return [Types::AttributeSuggestionsUpdateConfig]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateQuerySuggestionsConfigRequest AWS API Documentation
     #
     class UpdateQuerySuggestionsConfigRequest < Struct.new(
@@ -10064,7 +10282,8 @@ module Aws::Kendra
       :query_log_look_back_window_in_days,
       :include_queries_without_user_information,
       :minimum_number_of_querying_users,
-      :minimum_query_count)
+      :minimum_query_count,
+      :attribute_suggestions_config)
       SENSITIVE = []
       include Aws::Structure
     end

data/lib/aws-sdk-kendra.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-kendra
 version: !ruby/object:Gem::Version
-  version: 1.64.0
+  version: 1.66.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.165.0
+        version: 3.174.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.165.0
+        version: 3.174.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement