aws-sdk-qbusiness 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e413988ef004c583a2f5401948333df764bcbb430e622ff6dadc3f54394d5af0
-  data.tar.gz: 98182d7802fb4cdb6ac647b9568d2572da09fc9e155a9b70c2e6deec5d4b8a14
+  metadata.gz: '096dc363dc27854eb362be3a4dbd859ddd1a39d8653d2657ef5cd061982e4941'
+  data.tar.gz: 39854aee040e58f12147a54aa988d1114531c452ef9af7fa744778ae66ff4afe
 SHA512:
-  metadata.gz: 53bbb3e2d54169ba654bdb3957b5ba502ba613e80b5438ffebf871cccfeb886d01dc5a8af8e2d57312e820150439e3e6bb689068effe2d1691ca6fb3acb9c5d8
-  data.tar.gz: 194e09e0f7a1dcde3a71debc6d015635bfabed10884fde311fcc8485856d3be0acd056cde7c492322287a89894e09f647e0481453a74ab31d023c12ffca77270
+  metadata.gz: aafbb9055c296a1d53724f76455efeb0a940254d25d1856348e91c4b95b5826952055b82ee4e3331a3a8d1b3730f1755bc95a570db217e7fb35206f3c245565a
+  data.tar.gz: 2b21a52b893363b43aaa94bc9ea97eb3104b8ee21724302e04aed9b06f9998276995c881619778629eafc19e5937cdd6c7ec46b4339fda059a87a93219e94ed1

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.2.0 (2024-02-14)
+------------------
+
+* Feature - This release adds the metadata-boosting feature, which allows customers to easily fine-tune the underlying ranking of retrieved RAG passages in order to optimize Q&A answer relevance. It also adds new feedback reasons for the PutFeedback API.
+
+1.1.0 (2024-01-26)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.0.0 (2023-11-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.2.0

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

@@ -1068,8 +1068,8 @@ module Aws::QBusiness
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_BatchPutDocument.html
-    # [2]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CreateDataSource.html
+    # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html
+    # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html
     #
     # @option params [required, String] :application_id
     #   The identifier of the Amazon Q application using the index.
@@ -1258,6 +1258,27 @@ module Aws::QBusiness
     #         index_id: "KendraIndexId", # required
     #       },
     #       native_index_configuration: {
+    #         boosting_override: {
+    #           "DocumentAttributeKey" => {
+    #             date_configuration: {
+    #               boosting_duration_in_seconds: 1,
+    #               boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
+    #             },
+    #             number_configuration: {
+    #               boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
+    #               boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
+    #             },
+    #             string_configuration: {
+    #               attribute_value_boosting: {
+    #                 "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
+    #               },
+    #               boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
+    #             },
+    #             string_list_configuration: {
+    #               boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
+    #             },
+    #           },
+    #         },
     #         index_id: "IndexId", # required
     #       },
     #     },
@@ -2114,6 +2135,15 @@ module Aws::QBusiness
     #
     #   resp.application_id #=> String
     #   resp.configuration.kendra_index_configuration.index_id #=> String
+    #   resp.configuration.native_index_configuration.boosting_override #=> Hash
+    #   resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_duration_in_seconds #=> Integer
+    #   resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
+    #   resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
+    #   resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_type #=> String, one of "PRIORITIZE_LARGER_VALUES", "PRIORITIZE_SMALLER_VALUES"
+    #   resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting #=> Hash
+    #   resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting["String"] #=> String, one of "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
+    #   resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
+    #   resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_list_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
     #   resp.configuration.native_index_configuration.index_id #=> String
     #   resp.created_at #=> Time
     #   resp.display_name #=> String
@@ -2912,7 +2942,7 @@ module Aws::QBusiness
     #     message_id: "SystemMessageId", # required
     #     message_usefulness: {
     #       comment: "MessageUsefulnessComment",
-    #       reason: "NOT_FACTUALLY_CORRECT", # accepts NOT_FACTUALLY_CORRECT, HARMFUL_OR_UNSAFE, INCORRECT_OR_MISSING_SOURCES, NOT_HELPFUL, FACTUALLY_CORRECT, COMPLETE, RELEVANT_SOURCES, HELPFUL
+    #       reason: "NOT_FACTUALLY_CORRECT", # accepts NOT_FACTUALLY_CORRECT, HARMFUL_OR_UNSAFE, INCORRECT_OR_MISSING_SOURCES, NOT_HELPFUL, FACTUALLY_CORRECT, COMPLETE, RELEVANT_SOURCES, HELPFUL, NOT_BASED_ON_DOCUMENTS, NOT_COMPLETE, NOT_CONCISE, OTHER
     #       submitted_at: Time.now, # required
     #       usefulness: "USEFUL", # required, accepts USEFUL, NOT_USEFUL
     #     },
@@ -3582,6 +3612,27 @@ module Aws::QBusiness
     #         index_id: "KendraIndexId", # required
     #       },
     #       native_index_configuration: {
+    #         boosting_override: {
+    #           "DocumentAttributeKey" => {
+    #             date_configuration: {
+    #               boosting_duration_in_seconds: 1,
+    #               boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
+    #             },
+    #             number_configuration: {
+    #               boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
+    #               boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
+    #             },
+    #             string_configuration: {
+    #               attribute_value_boosting: {
+    #                 "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
+    #               },
+    #               boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
+    #             },
+    #             string_list_configuration: {
+    #               boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
+    #             },
+    #           },
+    #         },
     #         index_id: "IndexId", # required
     #       },
     #     },
@@ -3733,7 +3784,7 @@ module Aws::QBusiness
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-qbusiness'
-      context[:gem_version] = '1.0.0'
+      context[:gem_version] = '1.2.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -60,6 +60,7 @@ module Aws::QBusiness
     BlockedPhrasesConfiguration = Shapes::StructureShape.new(name: 'BlockedPhrasesConfiguration')
     BlockedPhrasesConfigurationUpdate = Shapes::StructureShape.new(name: 'BlockedPhrasesConfigurationUpdate')
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
+    BoostingDurationInSeconds = Shapes::IntegerShape.new(name: 'BoostingDurationInSeconds')
     ChatSyncInput = Shapes::StructureShape.new(name: 'ChatSyncInput')
     ChatSyncOutput = Shapes::StructureShape.new(name: 'ChatSyncOutput')
     ClientToken = Shapes::StringShape.new(name: 'ClientToken')
@@ -100,6 +101,7 @@ module Aws::QBusiness
     DataSourceUserId = Shapes::StringShape.new(name: 'DataSourceUserId')
     DataSourceVpcConfiguration = Shapes::StructureShape.new(name: 'DataSourceVpcConfiguration')
     DataSources = Shapes::ListShape.new(name: 'DataSources')
+    DateAttributeBoostingConfiguration = Shapes::StructureShape.new(name: 'DateAttributeBoostingConfiguration')
     DeleteApplicationRequest = Shapes::StructureShape.new(name: 'DeleteApplicationRequest')
     DeleteApplicationResponse = Shapes::StructureShape.new(name: 'DeleteApplicationResponse')
     DeleteChatControlsConfigurationRequest = Shapes::StructureShape.new(name: 'DeleteChatControlsConfigurationRequest')
@@ -125,6 +127,9 @@ module Aws::QBusiness
     Description = Shapes::StringShape.new(name: 'Description')
     Document = Shapes::StructureShape.new(name: 'Document')
     DocumentAttribute = Shapes::StructureShape.new(name: 'DocumentAttribute')
+    DocumentAttributeBoostingConfiguration = Shapes::UnionShape.new(name: 'DocumentAttributeBoostingConfiguration')
+    DocumentAttributeBoostingLevel = Shapes::StringShape.new(name: 'DocumentAttributeBoostingLevel')
+    DocumentAttributeBoostingOverrideMap = Shapes::MapShape.new(name: 'DocumentAttributeBoostingOverrideMap')
     DocumentAttributeCondition = Shapes::StructureShape.new(name: 'DocumentAttributeCondition')
     DocumentAttributeConfiguration = Shapes::StructureShape.new(name: 'DocumentAttributeConfiguration')
     DocumentAttributeConfigurations = Shapes::ListShape.new(name: 'DocumentAttributeConfigurations')
@@ -255,6 +260,8 @@ module Aws::QBusiness
     MetricValue = Shapes::StringShape.new(name: 'MetricValue')
     NativeIndexConfiguration = Shapes::StructureShape.new(name: 'NativeIndexConfiguration')
     NextToken = Shapes::StringShape.new(name: 'NextToken')
+    NumberAttributeBoostingConfiguration = Shapes::StructureShape.new(name: 'NumberAttributeBoostingConfiguration')
+    NumberAttributeBoostingType = Shapes::StringShape.new(name: 'NumberAttributeBoostingType')
     OAuth2ClientCredentialConfiguration = Shapes::StructureShape.new(name: 'OAuth2ClientCredentialConfiguration')
     Plugin = Shapes::StructureShape.new(name: 'Plugin')
     PluginArn = Shapes::StringShape.new(name: 'PluginArn')
@@ -305,6 +312,10 @@ module Aws::QBusiness
     StopDataSourceSyncJobRequest = Shapes::StructureShape.new(name: 'StopDataSourceSyncJobRequest')
     StopDataSourceSyncJobResponse = Shapes::StructureShape.new(name: 'StopDataSourceSyncJobResponse')
     String = Shapes::StringShape.new(name: 'String')
+    StringAttributeBoostingConfiguration = Shapes::StructureShape.new(name: 'StringAttributeBoostingConfiguration')
+    StringAttributeValueBoosting = Shapes::MapShape.new(name: 'StringAttributeValueBoosting')
+    StringAttributeValueBoostingLevel = Shapes::StringShape.new(name: 'StringAttributeValueBoostingLevel')
+    StringListAttributeBoostingConfiguration = Shapes::StructureShape.new(name: 'StringListAttributeBoostingConfiguration')
     SubnetId = Shapes::StringShape.new(name: 'SubnetId')
     SubnetIds = Shapes::ListShape.new(name: 'SubnetIds')
     SyncSchedule = Shapes::StringShape.new(name: 'SyncSchedule')
@@ -655,6 +666,10 @@ module Aws::QBusiness
 
     DataSources.member = Shapes::ShapeRef.new(shape: DataSource)
 
+    DateAttributeBoostingConfiguration.add_member(:boosting_duration_in_seconds, Shapes::ShapeRef.new(shape: BoostingDurationInSeconds, location_name: "boostingDurationInSeconds"))
+    DateAttributeBoostingConfiguration.add_member(:boosting_level, Shapes::ShapeRef.new(shape: DocumentAttributeBoostingLevel, required: true, location_name: "boostingLevel"))
+    DateAttributeBoostingConfiguration.struct_class = Types::DateAttributeBoostingConfiguration
+
     DeleteApplicationRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, required: true, location: "uri", location_name: "applicationId"))
     DeleteApplicationRequest.struct_class = Types::DeleteApplicationRequest
 
@@ -735,6 +750,21 @@ module Aws::QBusiness
     DocumentAttribute.add_member(:value, Shapes::ShapeRef.new(shape: DocumentAttributeValue, required: true, location_name: "value"))
     DocumentAttribute.struct_class = Types::DocumentAttribute
 
+    DocumentAttributeBoostingConfiguration.add_member(:date_configuration, Shapes::ShapeRef.new(shape: DateAttributeBoostingConfiguration, location_name: "dateConfiguration"))
+    DocumentAttributeBoostingConfiguration.add_member(:number_configuration, Shapes::ShapeRef.new(shape: NumberAttributeBoostingConfiguration, location_name: "numberConfiguration"))
+    DocumentAttributeBoostingConfiguration.add_member(:string_configuration, Shapes::ShapeRef.new(shape: StringAttributeBoostingConfiguration, location_name: "stringConfiguration"))
+    DocumentAttributeBoostingConfiguration.add_member(:string_list_configuration, Shapes::ShapeRef.new(shape: StringListAttributeBoostingConfiguration, location_name: "stringListConfiguration"))
+    DocumentAttributeBoostingConfiguration.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
+    DocumentAttributeBoostingConfiguration.add_member_subclass(:date_configuration, Types::DocumentAttributeBoostingConfiguration::DateConfiguration)
+    DocumentAttributeBoostingConfiguration.add_member_subclass(:number_configuration, Types::DocumentAttributeBoostingConfiguration::NumberConfiguration)
+    DocumentAttributeBoostingConfiguration.add_member_subclass(:string_configuration, Types::DocumentAttributeBoostingConfiguration::StringConfiguration)
+    DocumentAttributeBoostingConfiguration.add_member_subclass(:string_list_configuration, Types::DocumentAttributeBoostingConfiguration::StringListConfiguration)
+    DocumentAttributeBoostingConfiguration.add_member_subclass(:unknown, Types::DocumentAttributeBoostingConfiguration::Unknown)
+    DocumentAttributeBoostingConfiguration.struct_class = Types::DocumentAttributeBoostingConfiguration
+
+    DocumentAttributeBoostingOverrideMap.key = Shapes::ShapeRef.new(shape: DocumentAttributeKey)
+    DocumentAttributeBoostingOverrideMap.value = Shapes::ShapeRef.new(shape: DocumentAttributeBoostingConfiguration)
+
     DocumentAttributeCondition.add_member(:key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, required: true, location_name: "key"))
     DocumentAttributeCondition.add_member(:operator, Shapes::ShapeRef.new(shape: DocumentEnrichmentConditionOperator, required: true, location_name: "operator"))
     DocumentAttributeCondition.add_member(:value, Shapes::ShapeRef.new(shape: DocumentAttributeValue, location_name: "value"))
@@ -1151,9 +1181,14 @@ module Aws::QBusiness
 
     Messages.member = Shapes::ShapeRef.new(shape: Message)
 
+    NativeIndexConfiguration.add_member(:boosting_override, Shapes::ShapeRef.new(shape: DocumentAttributeBoostingOverrideMap, location_name: "boostingOverride"))
     NativeIndexConfiguration.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "indexId"))
     NativeIndexConfiguration.struct_class = Types::NativeIndexConfiguration
 
+    NumberAttributeBoostingConfiguration.add_member(:boosting_level, Shapes::ShapeRef.new(shape: DocumentAttributeBoostingLevel, required: true, location_name: "boostingLevel"))
+    NumberAttributeBoostingConfiguration.add_member(:boosting_type, Shapes::ShapeRef.new(shape: NumberAttributeBoostingType, location_name: "boostingType"))
+    NumberAttributeBoostingConfiguration.struct_class = Types::NumberAttributeBoostingConfiguration
+
     OAuth2ClientCredentialConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
     OAuth2ClientCredentialConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "secretArn"))
     OAuth2ClientCredentialConfiguration.struct_class = Types::OAuth2ClientCredentialConfiguration
@@ -1295,6 +1330,16 @@ module Aws::QBusiness
 
     StopDataSourceSyncJobResponse.struct_class = Types::StopDataSourceSyncJobResponse
 
+    StringAttributeBoostingConfiguration.add_member(:attribute_value_boosting, Shapes::ShapeRef.new(shape: StringAttributeValueBoosting, location_name: "attributeValueBoosting"))
+    StringAttributeBoostingConfiguration.add_member(:boosting_level, Shapes::ShapeRef.new(shape: DocumentAttributeBoostingLevel, required: true, location_name: "boostingLevel"))
+    StringAttributeBoostingConfiguration.struct_class = Types::StringAttributeBoostingConfiguration
+
+    StringAttributeValueBoosting.key = Shapes::ShapeRef.new(shape: String)
+    StringAttributeValueBoosting.value = Shapes::ShapeRef.new(shape: StringAttributeValueBoostingLevel)
+
+    StringListAttributeBoostingConfiguration.add_member(:boosting_level, Shapes::ShapeRef.new(shape: DocumentAttributeBoostingLevel, required: true, location_name: "boostingLevel"))
+    StringListAttributeBoostingConfiguration.struct_class = Types::StringListAttributeBoostingConfiguration
+
     SubnetIds.member = Shapes::ShapeRef.new(shape: SubnetId)
 
     Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "key"))

data/lib/aws-sdk-qbusiness/plugins/endpoints.rb

@@ -14,6 +14,7 @@ module Aws::QBusiness
       option(
         :endpoint_provider,
         doc_type: 'Aws::QBusiness::EndpointProvider',
+        rbs_type: 'untyped',
         docstring: 'The endpoint provider used to resolve endpoints. Any '\
                    'object that responds to `#resolve_endpoint(parameters)` '\
                    'where `parameters` is a Struct similar to '\

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

@@ -312,8 +312,8 @@ module Aws::QBusiness
       include Aws::Structure
     end
 
-    # Enables filtering of Amazon Q web experience responses based on
-    # document attributes or metadata fields.
+    # Enables filtering of responses based on document attributes or
+    # metadata fields.
     #
     # @!attribute [rw] and_all_filters
     #   Performs a logical `AND` operation on all supplied filters.
@@ -1386,6 +1386,33 @@ module Aws::QBusiness
       include Aws::Structure
     end
 
+    # Provides information on boosting `DATE` type document attributes.
+    #
+    # For more information on how boosting document attributes work in
+    # Amazon Q, see [Boosting using document attributes][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
+    #
+    # @!attribute [rw] boosting_duration_in_seconds
+    #   Specifies the duration, in seconds, of a boost applies to a `DATE`
+    #   type document attribute.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] boosting_level
+    #   Specifies how much a document attribute is boosted.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DateAttributeBoostingConfiguration AWS API Documentation
+    #
+    class DateAttributeBoostingConfiguration < Struct.new(
+      :boosting_duration_in_seconds,
+      :boosting_level)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] application_id
     #   The identifier of the Amazon Q application.
     #   @return [String]
@@ -1707,6 +1734,69 @@ module Aws::QBusiness
       include Aws::Structure
     end
 
+    # Provides information on boosting supported Amazon Q document attribute
+    # types. When an end user chat query matches document attributes that
+    # have been boosted, Amazon Q prioritizes generating responses from
+    # content that matches the boosted document attributes.
+    #
+    # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
+    # boosting on the console and the API, they must be enabled for search
+    # using the [DocumentAttributeConfiguration][1] object of the
+    # [UpdateIndex][2] API. If you haven't enabled searching on these
+    # attributes, you can't boost attributes of these data types on either
+    # the console or the API.
+    #
+    #  </note>
+    #
+    # For more information on how boosting document attributes work in
+    # Amazon Q, see [Boosting using document attributes][3].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html
+    # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html
+    # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
+    #
+    # @note DocumentAttributeBoostingConfiguration is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @note DocumentAttributeBoostingConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of DocumentAttributeBoostingConfiguration corresponding to the set member.
+    #
+    # @!attribute [rw] date_configuration
+    #   Provides information on boosting `DATE` type document attributes.
+    #   @return [Types::DateAttributeBoostingConfiguration]
+    #
+    # @!attribute [rw] number_configuration
+    #   Provides information on boosting `NUMBER` type document attributes.
+    #   @return [Types::NumberAttributeBoostingConfiguration]
+    #
+    # @!attribute [rw] string_configuration
+    #   Provides information on boosting `STRING` type document attributes.
+    #   @return [Types::StringAttributeBoostingConfiguration]
+    #
+    # @!attribute [rw] string_list_configuration
+    #   Provides information on boosting `STRING_LIST` type document
+    #   attributes.
+    #   @return [Types::StringListAttributeBoostingConfiguration]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DocumentAttributeBoostingConfiguration AWS API Documentation
+    #
+    class DocumentAttributeBoostingConfiguration < Struct.new(
+      :date_configuration,
+      :number_configuration,
+      :string_configuration,
+      :string_list_configuration,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class DateConfiguration < DocumentAttributeBoostingConfiguration; end
+      class NumberConfiguration < DocumentAttributeBoostingConfiguration; end
+      class StringConfiguration < DocumentAttributeBoostingConfiguration; end
+      class StringListConfiguration < DocumentAttributeBoostingConfiguration; end
+      class Unknown < DocumentAttributeBoostingConfiguration; end
+    end
+
     # The condition used for the target document attribute or metadata field
     # when ingesting documents into Amazon Q. You use this with [
     # `DocumentAttributeTarget` ][1] to apply the condition.
@@ -1726,7 +1816,7 @@ module Aws::QBusiness
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
+    # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
     #
     # @!attribute [rw] key
     #   The identifier of the document attribute used for the condition.
@@ -1818,8 +1908,8 @@ module Aws::QBusiness
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
-    # [2]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeCondition.html
+    # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
+    # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html
     #
     # @!attribute [rw] attribute_value_operator
     #   `TRUE` to delete the existing target value for your specified target
@@ -1996,7 +2086,7 @@ module Aws::QBusiness
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html
+    #   [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html
     #   [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
     #   @return [Types::HookConfiguration]
     #
@@ -2020,7 +2110,7 @@ module Aws::QBusiness
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html
+    #   [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html
     #   [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
     #   @return [Types::HookConfiguration]
     #
@@ -2881,7 +2971,7 @@ module Aws::QBusiness
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html
+    # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html
     # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
     #
     # @!attribute [rw] invocation_condition
@@ -3004,7 +3094,7 @@ module Aws::QBusiness
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_HookConfiguration.html
+    # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html
     # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
     #
     # @!attribute [rw] condition
@@ -3027,7 +3117,7 @@ module Aws::QBusiness
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
+    #   [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
     #   @return [Types::DocumentAttributeCondition]
     #
     # @!attribute [rw] document_content_operator
@@ -3056,8 +3146,8 @@ module Aws::QBusiness
     #
     #
     #
-    #   [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
-    #   [2]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeCondition.html
+    #   [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
+    #   [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html
     #   @return [Types::DocumentAttributeTarget]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/InlineDocumentEnrichmentConfiguration AWS API Documentation
@@ -3831,6 +3921,11 @@ module Aws::QBusiness
 
     # Configuration information for an Amazon Q index.
     #
+    # @!attribute [rw] boosting_override
+    #   Overrides the default boosts applied by Amazon Q to supported
+    #   document attribute data types.
+    #   @return [Hash<String,Types::DocumentAttributeBoostingConfiguration>]
+    #
     # @!attribute [rw] index_id
     #   The identifier for the Amazon Q index.
     #   @return [String]
@@ -3838,11 +3933,39 @@ module Aws::QBusiness
     # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/NativeIndexConfiguration AWS API Documentation
     #
     class NativeIndexConfiguration < Struct.new(
+      :boosting_override,
       :index_id)
       SENSITIVE = []
       include Aws::Structure
     end
 
+    # Provides information on boosting `NUMBER` type document attributes.
+    #
+    # For more information on how boosting document attributes work in
+    # Amazon Q, see [Boosting using document attributes][1].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
+    #
+    # @!attribute [rw] boosting_level
+    #   Specifies the duration, in seconds, of a boost applies to a `NUMBER`
+    #   type document attribute.
+    #   @return [String]
+    #
+    # @!attribute [rw] boosting_type
+    #   Specifies how much a document attribute is boosted.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/NumberAttributeBoostingConfiguration AWS API Documentation
+    #
+    class NumberAttributeBoostingConfiguration < Struct.new(
+      :boosting_level,
+      :boosting_type)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Information about the OAuth 2.0 authentication credential/token used
     # to configure a plugin.
     #
@@ -4224,7 +4347,7 @@ module Aws::QBusiness
     #   @return [Types::RuleConfiguration]
     #
     # @!attribute [rw] rule_type
-    #   The type fo rule.
+    #   The type of rule.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Rule AWS API Documentation
@@ -4451,6 +4574,77 @@ module Aws::QBusiness
     #
     class StopDataSourceSyncJobResponse < Aws::EmptyStructure; end
 
+    # Provides information on boosting `STRING` type document attributes.
+    #
+    # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
+    # boosting on the console and the API, they must be enabled for search
+    # using the [DocumentAttributeConfiguration][1] object of the
+    # [UpdateIndex][2] API. If you haven't enabled searching on these
+    # attributes, you can't boost attributes of these data types on either
+    # the console or the API.
+    #
+    #  </note>
+    #
+    # For more information on how boosting document attributes work in
+    # Amazon Q, see [Boosting using document attributes][3].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html
+    # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html
+    # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
+    #
+    # @!attribute [rw] attribute_value_boosting
+    #   Specifies specific values of a `STRING` type document attribute
+    #   being boosted.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] boosting_level
+    #   Specifies how much a document attribute is boosted.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StringAttributeBoostingConfiguration AWS API Documentation
+    #
+    class StringAttributeBoostingConfiguration < Struct.new(
+      :attribute_value_boosting,
+      :boosting_level)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Provides information on boosting `STRING_LIST` type document
+    # attributes.
+    #
+    # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
+    # boosting on the console and the API, they must be enabled for search
+    # using the [DocumentAttributeConfiguration][1] object of the
+    # [UpdateIndex][2] API. If you haven't enabled searching on these
+    # attributes, you can't boost attributes of these data types on either
+    # the console or the API.
+    #
+    #  </note>
+    #
+    # For more information on how boosting document attributes work in
+    # Amazon Q, see [Boosting using document attributes][3].
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html
+    # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html
+    # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
+    #
+    # @!attribute [rw] boosting_level
+    #   Specifies how much a document attribute is boosted.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StringListAttributeBoostingConfiguration AWS API Documentation
+    #
+    class StringListAttributeBoostingConfiguration < Struct.new(
+      :boosting_level)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A list of key/value pairs that identify an index, FAQ, or data source.
     # Tag keys and values can consist of Unicode letters, digits, white
     # space, and any of the following symbols: \_ . : / = + - @.
@@ -4556,9 +4750,9 @@ module Aws::QBusiness
     # The topic specific controls configured for an Amazon Q application.
     #
     # @!attribute [rw] description
-    #   A description for your topic control configuration. Use this outline
-    #   how the large language model (LLM) should use this topic control
-    #   configuration.
+    #   A description for your topic control configuration. Use this to
+    #   outline how the large language model (LLM) should use this topic
+    #   control configuration.
     #   @return [String]
     #
     # @!attribute [rw] example_chat_messages

data/lib/aws-sdk-qbusiness.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-qbusiness/customizations'
 # @!group service
 module Aws::QBusiness
 
-  GEM_VERSION = '1.0.0'
+  GEM_VERSION = '1.2.0'
 
 end