aws-sdk-qbusiness 1.0.0 → 1.2.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: e413988ef004c583a2f5401948333df764bcbb430e622ff6dadc3f54394d5af0
4
- data.tar.gz: 98182d7802fb4cdb6ac647b9568d2572da09fc9e155a9b70c2e6deec5d4b8a14
3
+ metadata.gz: '096dc363dc27854eb362be3a4dbd859ddd1a39d8653d2657ef5cd061982e4941'
4
+ data.tar.gz: 39854aee040e58f12147a54aa988d1114531c452ef9af7fa744778ae66ff4afe
5
5
  SHA512:
6
- metadata.gz: 53bbb3e2d54169ba654bdb3957b5ba502ba613e80b5438ffebf871cccfeb886d01dc5a8af8e2d57312e820150439e3e6bb689068effe2d1691ca6fb3acb9c5d8
7
- data.tar.gz: 194e09e0f7a1dcde3a71debc6d015635bfabed10884fde311fcc8485856d3be0acd056cde7c492322287a89894e09f647e0481453a74ab31d023c12ffca77270
6
+ metadata.gz: aafbb9055c296a1d53724f76455efeb0a940254d25d1856348e91c4b95b5826952055b82ee4e3331a3a8d1b3730f1755bc95a570db217e7fb35206f3c245565a
7
+ data.tar.gz: 2b21a52b893363b43aaa94bc9ea97eb3104b8ee21724302e04aed9b06f9998276995c881619778629eafc19e5937cdd6c7ec46b4339fda059a87a93219e94ed1
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.2.0 (2024-02-14)
5
+ ------------------
6
+
7
+ * 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.
8
+
9
+ 1.1.0 (2024-01-26)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
4
14
  1.0.0 (2023-11-28)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.0.0
1
+ 1.2.0
@@ -1068,8 +1068,8 @@ module Aws::QBusiness
1068
1068
  #
1069
1069
  #
1070
1070
  #
1071
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_BatchPutDocument.html
1072
- # [2]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CreateDataSource.html
1071
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_BatchPutDocument.html
1072
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_CreateDataSource.html
1073
1073
  #
1074
1074
  # @option params [required, String] :application_id
1075
1075
  # The identifier of the Amazon Q application using the index.
@@ -1258,6 +1258,27 @@ module Aws::QBusiness
1258
1258
  # index_id: "KendraIndexId", # required
1259
1259
  # },
1260
1260
  # native_index_configuration: {
1261
+ # boosting_override: {
1262
+ # "DocumentAttributeKey" => {
1263
+ # date_configuration: {
1264
+ # boosting_duration_in_seconds: 1,
1265
+ # boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
1266
+ # },
1267
+ # number_configuration: {
1268
+ # boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
1269
+ # boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
1270
+ # },
1271
+ # string_configuration: {
1272
+ # attribute_value_boosting: {
1273
+ # "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
1274
+ # },
1275
+ # boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
1276
+ # },
1277
+ # string_list_configuration: {
1278
+ # boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
1279
+ # },
1280
+ # },
1281
+ # },
1261
1282
  # index_id: "IndexId", # required
1262
1283
  # },
1263
1284
  # },
@@ -2114,6 +2135,15 @@ module Aws::QBusiness
2114
2135
  #
2115
2136
  # resp.application_id #=> String
2116
2137
  # resp.configuration.kendra_index_configuration.index_id #=> String
2138
+ # resp.configuration.native_index_configuration.boosting_override #=> Hash
2139
+ # resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_duration_in_seconds #=> Integer
2140
+ # resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
2141
+ # resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
2142
+ # resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_type #=> String, one of "PRIORITIZE_LARGER_VALUES", "PRIORITIZE_SMALLER_VALUES"
2143
+ # resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting #=> Hash
2144
+ # resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting["String"] #=> String, one of "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
2145
+ # resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
2146
+ # resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_list_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
2117
2147
  # resp.configuration.native_index_configuration.index_id #=> String
2118
2148
  # resp.created_at #=> Time
2119
2149
  # resp.display_name #=> String
@@ -2912,7 +2942,7 @@ module Aws::QBusiness
2912
2942
  # message_id: "SystemMessageId", # required
2913
2943
  # message_usefulness: {
2914
2944
  # comment: "MessageUsefulnessComment",
2915
- # reason: "NOT_FACTUALLY_CORRECT", # accepts NOT_FACTUALLY_CORRECT, HARMFUL_OR_UNSAFE, INCORRECT_OR_MISSING_SOURCES, NOT_HELPFUL, FACTUALLY_CORRECT, COMPLETE, RELEVANT_SOURCES, HELPFUL
2945
+ # 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
2916
2946
  # submitted_at: Time.now, # required
2917
2947
  # usefulness: "USEFUL", # required, accepts USEFUL, NOT_USEFUL
2918
2948
  # },
@@ -3582,6 +3612,27 @@ module Aws::QBusiness
3582
3612
  # index_id: "KendraIndexId", # required
3583
3613
  # },
3584
3614
  # native_index_configuration: {
3615
+ # boosting_override: {
3616
+ # "DocumentAttributeKey" => {
3617
+ # date_configuration: {
3618
+ # boosting_duration_in_seconds: 1,
3619
+ # boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
3620
+ # },
3621
+ # number_configuration: {
3622
+ # boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
3623
+ # boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
3624
+ # },
3625
+ # string_configuration: {
3626
+ # attribute_value_boosting: {
3627
+ # "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
3628
+ # },
3629
+ # boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
3630
+ # },
3631
+ # string_list_configuration: {
3632
+ # boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
3633
+ # },
3634
+ # },
3635
+ # },
3585
3636
  # index_id: "IndexId", # required
3586
3637
  # },
3587
3638
  # },
@@ -3733,7 +3784,7 @@ module Aws::QBusiness
3733
3784
  params: params,
3734
3785
  config: config)
3735
3786
  context[:gem_name] = 'aws-sdk-qbusiness'
3736
- context[:gem_version] = '1.0.0'
3787
+ context[:gem_version] = '1.2.0'
3737
3788
  Seahorse::Client::Request.new(handlers, context)
3738
3789
  end
3739
3790
 
@@ -60,6 +60,7 @@ module Aws::QBusiness
60
60
  BlockedPhrasesConfiguration = Shapes::StructureShape.new(name: 'BlockedPhrasesConfiguration')
61
61
  BlockedPhrasesConfigurationUpdate = Shapes::StructureShape.new(name: 'BlockedPhrasesConfigurationUpdate')
62
62
  Boolean = Shapes::BooleanShape.new(name: 'Boolean')
63
+ BoostingDurationInSeconds = Shapes::IntegerShape.new(name: 'BoostingDurationInSeconds')
63
64
  ChatSyncInput = Shapes::StructureShape.new(name: 'ChatSyncInput')
64
65
  ChatSyncOutput = Shapes::StructureShape.new(name: 'ChatSyncOutput')
65
66
  ClientToken = Shapes::StringShape.new(name: 'ClientToken')
@@ -100,6 +101,7 @@ module Aws::QBusiness
100
101
  DataSourceUserId = Shapes::StringShape.new(name: 'DataSourceUserId')
101
102
  DataSourceVpcConfiguration = Shapes::StructureShape.new(name: 'DataSourceVpcConfiguration')
102
103
  DataSources = Shapes::ListShape.new(name: 'DataSources')
104
+ DateAttributeBoostingConfiguration = Shapes::StructureShape.new(name: 'DateAttributeBoostingConfiguration')
103
105
  DeleteApplicationRequest = Shapes::StructureShape.new(name: 'DeleteApplicationRequest')
104
106
  DeleteApplicationResponse = Shapes::StructureShape.new(name: 'DeleteApplicationResponse')
105
107
  DeleteChatControlsConfigurationRequest = Shapes::StructureShape.new(name: 'DeleteChatControlsConfigurationRequest')
@@ -125,6 +127,9 @@ module Aws::QBusiness
125
127
  Description = Shapes::StringShape.new(name: 'Description')
126
128
  Document = Shapes::StructureShape.new(name: 'Document')
127
129
  DocumentAttribute = Shapes::StructureShape.new(name: 'DocumentAttribute')
130
+ DocumentAttributeBoostingConfiguration = Shapes::UnionShape.new(name: 'DocumentAttributeBoostingConfiguration')
131
+ DocumentAttributeBoostingLevel = Shapes::StringShape.new(name: 'DocumentAttributeBoostingLevel')
132
+ DocumentAttributeBoostingOverrideMap = Shapes::MapShape.new(name: 'DocumentAttributeBoostingOverrideMap')
128
133
  DocumentAttributeCondition = Shapes::StructureShape.new(name: 'DocumentAttributeCondition')
129
134
  DocumentAttributeConfiguration = Shapes::StructureShape.new(name: 'DocumentAttributeConfiguration')
130
135
  DocumentAttributeConfigurations = Shapes::ListShape.new(name: 'DocumentAttributeConfigurations')
@@ -255,6 +260,8 @@ module Aws::QBusiness
255
260
  MetricValue = Shapes::StringShape.new(name: 'MetricValue')
256
261
  NativeIndexConfiguration = Shapes::StructureShape.new(name: 'NativeIndexConfiguration')
257
262
  NextToken = Shapes::StringShape.new(name: 'NextToken')
263
+ NumberAttributeBoostingConfiguration = Shapes::StructureShape.new(name: 'NumberAttributeBoostingConfiguration')
264
+ NumberAttributeBoostingType = Shapes::StringShape.new(name: 'NumberAttributeBoostingType')
258
265
  OAuth2ClientCredentialConfiguration = Shapes::StructureShape.new(name: 'OAuth2ClientCredentialConfiguration')
259
266
  Plugin = Shapes::StructureShape.new(name: 'Plugin')
260
267
  PluginArn = Shapes::StringShape.new(name: 'PluginArn')
@@ -305,6 +312,10 @@ module Aws::QBusiness
305
312
  StopDataSourceSyncJobRequest = Shapes::StructureShape.new(name: 'StopDataSourceSyncJobRequest')
306
313
  StopDataSourceSyncJobResponse = Shapes::StructureShape.new(name: 'StopDataSourceSyncJobResponse')
307
314
  String = Shapes::StringShape.new(name: 'String')
315
+ StringAttributeBoostingConfiguration = Shapes::StructureShape.new(name: 'StringAttributeBoostingConfiguration')
316
+ StringAttributeValueBoosting = Shapes::MapShape.new(name: 'StringAttributeValueBoosting')
317
+ StringAttributeValueBoostingLevel = Shapes::StringShape.new(name: 'StringAttributeValueBoostingLevel')
318
+ StringListAttributeBoostingConfiguration = Shapes::StructureShape.new(name: 'StringListAttributeBoostingConfiguration')
308
319
  SubnetId = Shapes::StringShape.new(name: 'SubnetId')
309
320
  SubnetIds = Shapes::ListShape.new(name: 'SubnetIds')
310
321
  SyncSchedule = Shapes::StringShape.new(name: 'SyncSchedule')
@@ -655,6 +666,10 @@ module Aws::QBusiness
655
666
 
656
667
  DataSources.member = Shapes::ShapeRef.new(shape: DataSource)
657
668
 
669
+ DateAttributeBoostingConfiguration.add_member(:boosting_duration_in_seconds, Shapes::ShapeRef.new(shape: BoostingDurationInSeconds, location_name: "boostingDurationInSeconds"))
670
+ DateAttributeBoostingConfiguration.add_member(:boosting_level, Shapes::ShapeRef.new(shape: DocumentAttributeBoostingLevel, required: true, location_name: "boostingLevel"))
671
+ DateAttributeBoostingConfiguration.struct_class = Types::DateAttributeBoostingConfiguration
672
+
658
673
  DeleteApplicationRequest.add_member(:application_id, Shapes::ShapeRef.new(shape: ApplicationId, required: true, location: "uri", location_name: "applicationId"))
659
674
  DeleteApplicationRequest.struct_class = Types::DeleteApplicationRequest
660
675
 
@@ -735,6 +750,21 @@ module Aws::QBusiness
735
750
  DocumentAttribute.add_member(:value, Shapes::ShapeRef.new(shape: DocumentAttributeValue, required: true, location_name: "value"))
736
751
  DocumentAttribute.struct_class = Types::DocumentAttribute
737
752
 
753
+ DocumentAttributeBoostingConfiguration.add_member(:date_configuration, Shapes::ShapeRef.new(shape: DateAttributeBoostingConfiguration, location_name: "dateConfiguration"))
754
+ DocumentAttributeBoostingConfiguration.add_member(:number_configuration, Shapes::ShapeRef.new(shape: NumberAttributeBoostingConfiguration, location_name: "numberConfiguration"))
755
+ DocumentAttributeBoostingConfiguration.add_member(:string_configuration, Shapes::ShapeRef.new(shape: StringAttributeBoostingConfiguration, location_name: "stringConfiguration"))
756
+ DocumentAttributeBoostingConfiguration.add_member(:string_list_configuration, Shapes::ShapeRef.new(shape: StringListAttributeBoostingConfiguration, location_name: "stringListConfiguration"))
757
+ DocumentAttributeBoostingConfiguration.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
758
+ DocumentAttributeBoostingConfiguration.add_member_subclass(:date_configuration, Types::DocumentAttributeBoostingConfiguration::DateConfiguration)
759
+ DocumentAttributeBoostingConfiguration.add_member_subclass(:number_configuration, Types::DocumentAttributeBoostingConfiguration::NumberConfiguration)
760
+ DocumentAttributeBoostingConfiguration.add_member_subclass(:string_configuration, Types::DocumentAttributeBoostingConfiguration::StringConfiguration)
761
+ DocumentAttributeBoostingConfiguration.add_member_subclass(:string_list_configuration, Types::DocumentAttributeBoostingConfiguration::StringListConfiguration)
762
+ DocumentAttributeBoostingConfiguration.add_member_subclass(:unknown, Types::DocumentAttributeBoostingConfiguration::Unknown)
763
+ DocumentAttributeBoostingConfiguration.struct_class = Types::DocumentAttributeBoostingConfiguration
764
+
765
+ DocumentAttributeBoostingOverrideMap.key = Shapes::ShapeRef.new(shape: DocumentAttributeKey)
766
+ DocumentAttributeBoostingOverrideMap.value = Shapes::ShapeRef.new(shape: DocumentAttributeBoostingConfiguration)
767
+
738
768
  DocumentAttributeCondition.add_member(:key, Shapes::ShapeRef.new(shape: DocumentAttributeKey, required: true, location_name: "key"))
739
769
  DocumentAttributeCondition.add_member(:operator, Shapes::ShapeRef.new(shape: DocumentEnrichmentConditionOperator, required: true, location_name: "operator"))
740
770
  DocumentAttributeCondition.add_member(:value, Shapes::ShapeRef.new(shape: DocumentAttributeValue, location_name: "value"))
@@ -1151,9 +1181,14 @@ module Aws::QBusiness
1151
1181
 
1152
1182
  Messages.member = Shapes::ShapeRef.new(shape: Message)
1153
1183
 
1184
+ NativeIndexConfiguration.add_member(:boosting_override, Shapes::ShapeRef.new(shape: DocumentAttributeBoostingOverrideMap, location_name: "boostingOverride"))
1154
1185
  NativeIndexConfiguration.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "indexId"))
1155
1186
  NativeIndexConfiguration.struct_class = Types::NativeIndexConfiguration
1156
1187
 
1188
+ NumberAttributeBoostingConfiguration.add_member(:boosting_level, Shapes::ShapeRef.new(shape: DocumentAttributeBoostingLevel, required: true, location_name: "boostingLevel"))
1189
+ NumberAttributeBoostingConfiguration.add_member(:boosting_type, Shapes::ShapeRef.new(shape: NumberAttributeBoostingType, location_name: "boostingType"))
1190
+ NumberAttributeBoostingConfiguration.struct_class = Types::NumberAttributeBoostingConfiguration
1191
+
1157
1192
  OAuth2ClientCredentialConfiguration.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
1158
1193
  OAuth2ClientCredentialConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "secretArn"))
1159
1194
  OAuth2ClientCredentialConfiguration.struct_class = Types::OAuth2ClientCredentialConfiguration
@@ -1295,6 +1330,16 @@ module Aws::QBusiness
1295
1330
 
1296
1331
  StopDataSourceSyncJobResponse.struct_class = Types::StopDataSourceSyncJobResponse
1297
1332
 
1333
+ StringAttributeBoostingConfiguration.add_member(:attribute_value_boosting, Shapes::ShapeRef.new(shape: StringAttributeValueBoosting, location_name: "attributeValueBoosting"))
1334
+ StringAttributeBoostingConfiguration.add_member(:boosting_level, Shapes::ShapeRef.new(shape: DocumentAttributeBoostingLevel, required: true, location_name: "boostingLevel"))
1335
+ StringAttributeBoostingConfiguration.struct_class = Types::StringAttributeBoostingConfiguration
1336
+
1337
+ StringAttributeValueBoosting.key = Shapes::ShapeRef.new(shape: String)
1338
+ StringAttributeValueBoosting.value = Shapes::ShapeRef.new(shape: StringAttributeValueBoostingLevel)
1339
+
1340
+ StringListAttributeBoostingConfiguration.add_member(:boosting_level, Shapes::ShapeRef.new(shape: DocumentAttributeBoostingLevel, required: true, location_name: "boostingLevel"))
1341
+ StringListAttributeBoostingConfiguration.struct_class = Types::StringListAttributeBoostingConfiguration
1342
+
1298
1343
  SubnetIds.member = Shapes::ShapeRef.new(shape: SubnetId)
1299
1344
 
1300
1345
  Tag.add_member(:key, Shapes::ShapeRef.new(shape: TagKey, required: true, location_name: "key"))
@@ -14,6 +14,7 @@ module Aws::QBusiness
14
14
  option(
15
15
  :endpoint_provider,
16
16
  doc_type: 'Aws::QBusiness::EndpointProvider',
17
+ rbs_type: 'untyped',
17
18
  docstring: 'The endpoint provider used to resolve endpoints. Any '\
18
19
  'object that responds to `#resolve_endpoint(parameters)` '\
19
20
  'where `parameters` is a Struct similar to '\
@@ -312,8 +312,8 @@ module Aws::QBusiness
312
312
  include Aws::Structure
313
313
  end
314
314
 
315
- # Enables filtering of Amazon Q web experience responses based on
316
- # document attributes or metadata fields.
315
+ # Enables filtering of responses based on document attributes or
316
+ # metadata fields.
317
317
  #
318
318
  # @!attribute [rw] and_all_filters
319
319
  # Performs a logical `AND` operation on all supplied filters.
@@ -1386,6 +1386,33 @@ module Aws::QBusiness
1386
1386
  include Aws::Structure
1387
1387
  end
1388
1388
 
1389
+ # Provides information on boosting `DATE` type document attributes.
1390
+ #
1391
+ # For more information on how boosting document attributes work in
1392
+ # Amazon Q, see [Boosting using document attributes][1].
1393
+ #
1394
+ #
1395
+ #
1396
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
1397
+ #
1398
+ # @!attribute [rw] boosting_duration_in_seconds
1399
+ # Specifies the duration, in seconds, of a boost applies to a `DATE`
1400
+ # type document attribute.
1401
+ # @return [Integer]
1402
+ #
1403
+ # @!attribute [rw] boosting_level
1404
+ # Specifies how much a document attribute is boosted.
1405
+ # @return [String]
1406
+ #
1407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DateAttributeBoostingConfiguration AWS API Documentation
1408
+ #
1409
+ class DateAttributeBoostingConfiguration < Struct.new(
1410
+ :boosting_duration_in_seconds,
1411
+ :boosting_level)
1412
+ SENSITIVE = []
1413
+ include Aws::Structure
1414
+ end
1415
+
1389
1416
  # @!attribute [rw] application_id
1390
1417
  # The identifier of the Amazon Q application.
1391
1418
  # @return [String]
@@ -1707,6 +1734,69 @@ module Aws::QBusiness
1707
1734
  include Aws::Structure
1708
1735
  end
1709
1736
 
1737
+ # Provides information on boosting supported Amazon Q document attribute
1738
+ # types. When an end user chat query matches document attributes that
1739
+ # have been boosted, Amazon Q prioritizes generating responses from
1740
+ # content that matches the boosted document attributes.
1741
+ #
1742
+ # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
1743
+ # boosting on the console and the API, they must be enabled for search
1744
+ # using the [DocumentAttributeConfiguration][1] object of the
1745
+ # [UpdateIndex][2] API. If you haven't enabled searching on these
1746
+ # attributes, you can't boost attributes of these data types on either
1747
+ # the console or the API.
1748
+ #
1749
+ # </note>
1750
+ #
1751
+ # For more information on how boosting document attributes work in
1752
+ # Amazon Q, see [Boosting using document attributes][3].
1753
+ #
1754
+ #
1755
+ #
1756
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html
1757
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html
1758
+ # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
1759
+ #
1760
+ # @note DocumentAttributeBoostingConfiguration is a union - when making an API calls you must set exactly one of the members.
1761
+ #
1762
+ # @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.
1763
+ #
1764
+ # @!attribute [rw] date_configuration
1765
+ # Provides information on boosting `DATE` type document attributes.
1766
+ # @return [Types::DateAttributeBoostingConfiguration]
1767
+ #
1768
+ # @!attribute [rw] number_configuration
1769
+ # Provides information on boosting `NUMBER` type document attributes.
1770
+ # @return [Types::NumberAttributeBoostingConfiguration]
1771
+ #
1772
+ # @!attribute [rw] string_configuration
1773
+ # Provides information on boosting `STRING` type document attributes.
1774
+ # @return [Types::StringAttributeBoostingConfiguration]
1775
+ #
1776
+ # @!attribute [rw] string_list_configuration
1777
+ # Provides information on boosting `STRING_LIST` type document
1778
+ # attributes.
1779
+ # @return [Types::StringListAttributeBoostingConfiguration]
1780
+ #
1781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DocumentAttributeBoostingConfiguration AWS API Documentation
1782
+ #
1783
+ class DocumentAttributeBoostingConfiguration < Struct.new(
1784
+ :date_configuration,
1785
+ :number_configuration,
1786
+ :string_configuration,
1787
+ :string_list_configuration,
1788
+ :unknown)
1789
+ SENSITIVE = []
1790
+ include Aws::Structure
1791
+ include Aws::Structure::Union
1792
+
1793
+ class DateConfiguration < DocumentAttributeBoostingConfiguration; end
1794
+ class NumberConfiguration < DocumentAttributeBoostingConfiguration; end
1795
+ class StringConfiguration < DocumentAttributeBoostingConfiguration; end
1796
+ class StringListConfiguration < DocumentAttributeBoostingConfiguration; end
1797
+ class Unknown < DocumentAttributeBoostingConfiguration; end
1798
+ end
1799
+
1710
1800
  # The condition used for the target document attribute or metadata field
1711
1801
  # when ingesting documents into Amazon Q. You use this with [
1712
1802
  # `DocumentAttributeTarget` ][1] to apply the condition.
@@ -1726,7 +1816,7 @@ module Aws::QBusiness
1726
1816
  #
1727
1817
  #
1728
1818
  #
1729
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
1819
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
1730
1820
  #
1731
1821
  # @!attribute [rw] key
1732
1822
  # The identifier of the document attribute used for the condition.
@@ -1818,8 +1908,8 @@ module Aws::QBusiness
1818
1908
  #
1819
1909
  #
1820
1910
  #
1821
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
1822
- # [2]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeCondition.html
1911
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
1912
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html
1823
1913
  #
1824
1914
  # @!attribute [rw] attribute_value_operator
1825
1915
  # `TRUE` to delete the existing target value for your specified target
@@ -1996,7 +2086,7 @@ module Aws::QBusiness
1996
2086
  #
1997
2087
  #
1998
2088
  #
1999
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html
2089
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html
2000
2090
  # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
2001
2091
  # @return [Types::HookConfiguration]
2002
2092
  #
@@ -2020,7 +2110,7 @@ module Aws::QBusiness
2020
2110
  #
2021
2111
  #
2022
2112
  #
2023
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html
2113
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html
2024
2114
  # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
2025
2115
  # @return [Types::HookConfiguration]
2026
2116
  #
@@ -2881,7 +2971,7 @@ module Aws::QBusiness
2881
2971
  #
2882
2972
  #
2883
2973
  #
2884
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_CustomDocumentEnrichmentConfiguration.html
2974
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html
2885
2975
  # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
2886
2976
  #
2887
2977
  # @!attribute [rw] invocation_condition
@@ -3004,7 +3094,7 @@ module Aws::QBusiness
3004
3094
  #
3005
3095
  #
3006
3096
  #
3007
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_HookConfiguration.html
3097
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html
3008
3098
  # [2]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
3009
3099
  #
3010
3100
  # @!attribute [rw] condition
@@ -3027,7 +3117,7 @@ module Aws::QBusiness
3027
3117
  #
3028
3118
  #
3029
3119
  #
3030
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
3120
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
3031
3121
  # @return [Types::DocumentAttributeCondition]
3032
3122
  #
3033
3123
  # @!attribute [rw] document_content_operator
@@ -3056,8 +3146,8 @@ module Aws::QBusiness
3056
3146
  #
3057
3147
  #
3058
3148
  #
3059
- # [1]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeTarget.html
3060
- # [2]: https://docs.aws.amazon.com/enterpriseq/latest/APIReference/API_DocumentAttributeCondition.html
3149
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html
3150
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html
3061
3151
  # @return [Types::DocumentAttributeTarget]
3062
3152
  #
3063
3153
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/InlineDocumentEnrichmentConfiguration AWS API Documentation
@@ -3831,6 +3921,11 @@ module Aws::QBusiness
3831
3921
 
3832
3922
  # Configuration information for an Amazon Q index.
3833
3923
  #
3924
+ # @!attribute [rw] boosting_override
3925
+ # Overrides the default boosts applied by Amazon Q to supported
3926
+ # document attribute data types.
3927
+ # @return [Hash<String,Types::DocumentAttributeBoostingConfiguration>]
3928
+ #
3834
3929
  # @!attribute [rw] index_id
3835
3930
  # The identifier for the Amazon Q index.
3836
3931
  # @return [String]
@@ -3838,11 +3933,39 @@ module Aws::QBusiness
3838
3933
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/NativeIndexConfiguration AWS API Documentation
3839
3934
  #
3840
3935
  class NativeIndexConfiguration < Struct.new(
3936
+ :boosting_override,
3841
3937
  :index_id)
3842
3938
  SENSITIVE = []
3843
3939
  include Aws::Structure
3844
3940
  end
3845
3941
 
3942
+ # Provides information on boosting `NUMBER` type document attributes.
3943
+ #
3944
+ # For more information on how boosting document attributes work in
3945
+ # Amazon Q, see [Boosting using document attributes][1].
3946
+ #
3947
+ #
3948
+ #
3949
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
3950
+ #
3951
+ # @!attribute [rw] boosting_level
3952
+ # Specifies the duration, in seconds, of a boost applies to a `NUMBER`
3953
+ # type document attribute.
3954
+ # @return [String]
3955
+ #
3956
+ # @!attribute [rw] boosting_type
3957
+ # Specifies how much a document attribute is boosted.
3958
+ # @return [String]
3959
+ #
3960
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/NumberAttributeBoostingConfiguration AWS API Documentation
3961
+ #
3962
+ class NumberAttributeBoostingConfiguration < Struct.new(
3963
+ :boosting_level,
3964
+ :boosting_type)
3965
+ SENSITIVE = []
3966
+ include Aws::Structure
3967
+ end
3968
+
3846
3969
  # Information about the OAuth 2.0 authentication credential/token used
3847
3970
  # to configure a plugin.
3848
3971
  #
@@ -4224,7 +4347,7 @@ module Aws::QBusiness
4224
4347
  # @return [Types::RuleConfiguration]
4225
4348
  #
4226
4349
  # @!attribute [rw] rule_type
4227
- # The type fo rule.
4350
+ # The type of rule.
4228
4351
  # @return [String]
4229
4352
  #
4230
4353
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Rule AWS API Documentation
@@ -4451,6 +4574,77 @@ module Aws::QBusiness
4451
4574
  #
4452
4575
  class StopDataSourceSyncJobResponse < Aws::EmptyStructure; end
4453
4576
 
4577
+ # Provides information on boosting `STRING` type document attributes.
4578
+ #
4579
+ # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
4580
+ # boosting on the console and the API, they must be enabled for search
4581
+ # using the [DocumentAttributeConfiguration][1] object of the
4582
+ # [UpdateIndex][2] API. If you haven't enabled searching on these
4583
+ # attributes, you can't boost attributes of these data types on either
4584
+ # the console or the API.
4585
+ #
4586
+ # </note>
4587
+ #
4588
+ # For more information on how boosting document attributes work in
4589
+ # Amazon Q, see [Boosting using document attributes][3].
4590
+ #
4591
+ #
4592
+ #
4593
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html
4594
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html
4595
+ # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
4596
+ #
4597
+ # @!attribute [rw] attribute_value_boosting
4598
+ # Specifies specific values of a `STRING` type document attribute
4599
+ # being boosted.
4600
+ # @return [Hash<String,String>]
4601
+ #
4602
+ # @!attribute [rw] boosting_level
4603
+ # Specifies how much a document attribute is boosted.
4604
+ # @return [String]
4605
+ #
4606
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StringAttributeBoostingConfiguration AWS API Documentation
4607
+ #
4608
+ class StringAttributeBoostingConfiguration < Struct.new(
4609
+ :attribute_value_boosting,
4610
+ :boosting_level)
4611
+ SENSITIVE = []
4612
+ include Aws::Structure
4613
+ end
4614
+
4615
+ # Provides information on boosting `STRING_LIST` type document
4616
+ # attributes.
4617
+ #
4618
+ # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
4619
+ # boosting on the console and the API, they must be enabled for search
4620
+ # using the [DocumentAttributeConfiguration][1] object of the
4621
+ # [UpdateIndex][2] API. If you haven't enabled searching on these
4622
+ # attributes, you can't boost attributes of these data types on either
4623
+ # the console or the API.
4624
+ #
4625
+ # </note>
4626
+ #
4627
+ # For more information on how boosting document attributes work in
4628
+ # Amazon Q, see [Boosting using document attributes][3].
4629
+ #
4630
+ #
4631
+ #
4632
+ # [1]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html
4633
+ # [2]: https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html
4634
+ # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
4635
+ #
4636
+ # @!attribute [rw] boosting_level
4637
+ # Specifies how much a document attribute is boosted.
4638
+ # @return [String]
4639
+ #
4640
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StringListAttributeBoostingConfiguration AWS API Documentation
4641
+ #
4642
+ class StringListAttributeBoostingConfiguration < Struct.new(
4643
+ :boosting_level)
4644
+ SENSITIVE = []
4645
+ include Aws::Structure
4646
+ end
4647
+
4454
4648
  # A list of key/value pairs that identify an index, FAQ, or data source.
4455
4649
  # Tag keys and values can consist of Unicode letters, digits, white
4456
4650
  # space, and any of the following symbols: \_ . : / = + - @.
@@ -4556,9 +4750,9 @@ module Aws::QBusiness
4556
4750
  # The topic specific controls configured for an Amazon Q application.
4557
4751
  #
4558
4752
  # @!attribute [rw] description
4559
- # A description for your topic control configuration. Use this outline
4560
- # how the large language model (LLM) should use this topic control
4561
- # configuration.
4753
+ # A description for your topic control configuration. Use this to
4754
+ # outline how the large language model (LLM) should use this topic
4755
+ # control configuration.
4562
4756
  # @return [String]
4563
4757
  #
4564
4758
  # @!attribute [rw] example_chat_messages
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-qbusiness/customizations'
52
52
  # @!group service
53
53
  module Aws::QBusiness
54
54
 
55
- GEM_VERSION = '1.0.0'
55
+ GEM_VERSION = '1.2.0'
56
56
 
57
57
  end