aws-sdk-qbusiness 1.41.0 → 1.42.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1350,6 +1350,112 @@ module Aws::QBusiness
1350
1350
  include Aws::Structure
1351
1351
  end
1352
1352
 
1353
+ # Configuration details that define how Amazon Q Business generates and
1354
+ # formats responses to user queries in chat interactions. This
1355
+ # configuration allows administrators to customize response
1356
+ # characteristics to meet specific organizational needs and
1357
+ # communication standards.
1358
+ #
1359
+ # @!attribute [rw] chat_response_configuration_id
1360
+ # A unique identifier for your chat response configuration settings,
1361
+ # used to reference and manage the configuration within the Amazon Q
1362
+ # Business service.
1363
+ # @return [String]
1364
+ #
1365
+ # @!attribute [rw] chat_response_configuration_arn
1366
+ # The Amazon Resource Name (ARN) of the chat response configuration,
1367
+ # which uniquely identifies the resource across all Amazon Web
1368
+ # Services services and accounts.
1369
+ # @return [String]
1370
+ #
1371
+ # @!attribute [rw] display_name
1372
+ # A human-readable name for the chat response configuration, making it
1373
+ # easier to identify and manage multiple configurations within an
1374
+ # organization.
1375
+ # @return [String]
1376
+ #
1377
+ # @!attribute [rw] response_configuration_summary
1378
+ # A summary of the response configuration settings, providing a
1379
+ # concise overview of the key parameters that define how responses are
1380
+ # generated and formatted.
1381
+ # @return [String]
1382
+ #
1383
+ # @!attribute [rw] status
1384
+ # The current status of the chat response configuration, indicating
1385
+ # whether it is active, pending, or in another state that affects its
1386
+ # availability for use in chat interactions.
1387
+ # @return [String]
1388
+ #
1389
+ # @!attribute [rw] created_at
1390
+ # The timestamp indicating when the chat response configuration was
1391
+ # initially created, useful for tracking the lifecycle of
1392
+ # configuration resources.
1393
+ # @return [Time]
1394
+ #
1395
+ # @!attribute [rw] updated_at
1396
+ # The timestamp indicating when the chat response configuration was
1397
+ # last modified, helping administrators track changes and maintain
1398
+ # version awareness.
1399
+ # @return [Time]
1400
+ #
1401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ChatResponseConfiguration AWS API Documentation
1402
+ #
1403
+ class ChatResponseConfiguration < Struct.new(
1404
+ :chat_response_configuration_id,
1405
+ :chat_response_configuration_arn,
1406
+ :display_name,
1407
+ :response_configuration_summary,
1408
+ :status,
1409
+ :created_at,
1410
+ :updated_at)
1411
+ SENSITIVE = []
1412
+ include Aws::Structure
1413
+ end
1414
+
1415
+ # Detailed information about a chat response configuration, including
1416
+ # comprehensive settings and parameters that define how Amazon Q
1417
+ # Business generates and formats responses.
1418
+ #
1419
+ # @!attribute [rw] response_configurations
1420
+ # A collection of specific response configuration settings that
1421
+ # collectively define how responses are generated, formatted, and
1422
+ # presented to users in chat interactions.
1423
+ # @return [Hash<String,Types::ResponseConfiguration>]
1424
+ #
1425
+ # @!attribute [rw] response_configuration_summary
1426
+ # A summary of the response configuration details, providing a concise
1427
+ # overview of the key parameters and settings that define the response
1428
+ # generation behavior.
1429
+ # @return [String]
1430
+ #
1431
+ # @!attribute [rw] status
1432
+ # The current status of the chat response configuration, indicating
1433
+ # whether it is active, pending, or in another state that affects its
1434
+ # availability for use.
1435
+ # @return [String]
1436
+ #
1437
+ # @!attribute [rw] error
1438
+ # Provides information about a Amazon Q Business request error.
1439
+ # @return [Types::ErrorDetail]
1440
+ #
1441
+ # @!attribute [rw] updated_at
1442
+ # The timestamp indicating when the detailed chat response
1443
+ # configuration was last modified, helping administrators track
1444
+ # changes and maintain version awareness.
1445
+ # @return [Time]
1446
+ #
1447
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ChatResponseConfigurationDetail AWS API Documentation
1448
+ #
1449
+ class ChatResponseConfigurationDetail < Struct.new(
1450
+ :response_configurations,
1451
+ :response_configuration_summary,
1452
+ :status,
1453
+ :error,
1454
+ :updated_at)
1455
+ SENSITIVE = []
1456
+ include Aws::Structure
1457
+ end
1458
+
1353
1459
  # @!attribute [rw] application_id
1354
1460
  # The identifier of the Amazon Q Business application linked to the
1355
1461
  # Amazon Q Business conversation.
@@ -1959,6 +2065,70 @@ module Aws::QBusiness
1959
2065
  include Aws::Structure
1960
2066
  end
1961
2067
 
2068
+ # @!attribute [rw] application_id
2069
+ # The unique identifier of the Amazon Q Business application for which
2070
+ # to create the new chat response configuration.
2071
+ # @return [String]
2072
+ #
2073
+ # @!attribute [rw] display_name
2074
+ # A human-readable name for the new chat response configuration,
2075
+ # making it easier to identify and manage among multiple
2076
+ # configurations.
2077
+ # @return [String]
2078
+ #
2079
+ # @!attribute [rw] client_token
2080
+ # A unique, case-sensitive identifier to ensure idempotency of the
2081
+ # request. This helps prevent the same configuration from being
2082
+ # created multiple times if retries occur.
2083
+ #
2084
+ # **A suitable default value is auto-generated.** You should normally
2085
+ # not need to pass this option.
2086
+ # @return [String]
2087
+ #
2088
+ # @!attribute [rw] response_configurations
2089
+ # A collection of response configuration settings that define how
2090
+ # Amazon Q Business will generate and format responses to user queries
2091
+ # in chat interactions.
2092
+ # @return [Hash<String,Types::ResponseConfiguration>]
2093
+ #
2094
+ # @!attribute [rw] tags
2095
+ # A list of key-value pairs to apply as tags to the new chat response
2096
+ # configuration, enabling categorization and management of resources
2097
+ # across Amazon Web Services services.
2098
+ # @return [Array<Types::Tag>]
2099
+ #
2100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateChatResponseConfigurationRequest AWS API Documentation
2101
+ #
2102
+ class CreateChatResponseConfigurationRequest < Struct.new(
2103
+ :application_id,
2104
+ :display_name,
2105
+ :client_token,
2106
+ :response_configurations,
2107
+ :tags)
2108
+ SENSITIVE = []
2109
+ include Aws::Structure
2110
+ end
2111
+
2112
+ # @!attribute [rw] chat_response_configuration_id
2113
+ # The unique identifier assigned to a newly created chat response
2114
+ # configuration, used for subsequent operations on this resource.
2115
+ # @return [String]
2116
+ #
2117
+ # @!attribute [rw] chat_response_configuration_arn
2118
+ # The Amazon Resource Name (ARN) of the newly created chat response
2119
+ # configuration, which uniquely identifies the resource across all
2120
+ # Amazon Web Services services.
2121
+ # @return [String]
2122
+ #
2123
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateChatResponseConfigurationResponse AWS API Documentation
2124
+ #
2125
+ class CreateChatResponseConfigurationResponse < Struct.new(
2126
+ :chat_response_configuration_id,
2127
+ :chat_response_configuration_arn)
2128
+ SENSITIVE = []
2129
+ include Aws::Structure
2130
+ end
2131
+
1962
2132
  # @!attribute [rw] application_id
1963
2133
  # The unique identifier of the Amazon Q Business application.
1964
2134
  # @return [String]
@@ -3009,7 +3179,15 @@ module Aws::QBusiness
3009
3179
  # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
3010
3180
  #
3011
3181
  # @!attribute [rw] boosting_level
3012
- # Specifies how much a document attribute is boosted.
3182
+ # Specifies the priority tier ranking of boosting applied to document
3183
+ # attributes. For version 2, this parameter indicates the relative
3184
+ # ranking between boosted fields (ONE being highest priority, TWO
3185
+ # being second highest, etc.) and determines the order in which
3186
+ # attributes influence document ranking in search results. For version
3187
+ # 1, this parameter specifies the boosting intensity. For version 2,
3188
+ # boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not
3189
+ # supported. Note that in version 2, you are not allowed to boost on
3190
+ # only one field and make this value TWO.
3013
3191
  # @return [String]
3014
3192
  #
3015
3193
  # @!attribute [rw] boosting_duration_in_seconds
@@ -3091,6 +3269,29 @@ module Aws::QBusiness
3091
3269
  #
3092
3270
  class DeleteChatControlsConfigurationResponse < Aws::EmptyStructure; end
3093
3271
 
3272
+ # @!attribute [rw] application_id
3273
+ # The unique identifier of theAmazon Q Business application from which
3274
+ # to delete the chat response configuration.
3275
+ # @return [String]
3276
+ #
3277
+ # @!attribute [rw] chat_response_configuration_id
3278
+ # The unique identifier of the chat response configuration to delete
3279
+ # from the specified application.
3280
+ # @return [String]
3281
+ #
3282
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteChatResponseConfigurationRequest AWS API Documentation
3283
+ #
3284
+ class DeleteChatResponseConfigurationRequest < Struct.new(
3285
+ :application_id,
3286
+ :chat_response_configuration_id)
3287
+ SENSITIVE = []
3288
+ include Aws::Structure
3289
+ end
3290
+
3291
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteChatResponseConfigurationResponse AWS API Documentation
3292
+ #
3293
+ class DeleteChatResponseConfigurationResponse < Aws::EmptyStructure; end
3294
+
3094
3295
  # @!attribute [rw] conversation_id
3095
3296
  # The identifier of the Amazon Q Business web experience conversation
3096
3297
  # being deleted.
@@ -3556,6 +3757,11 @@ module Aws::QBusiness
3556
3757
  # generating responses from content that matches the boosted document
3557
3758
  # attributes.
3558
3759
  #
3760
+ # In version 2, boosting uses numeric values (ONE, TWO) to indicate
3761
+ # priority tiers that establish clear hierarchical relationships between
3762
+ # boosted attributes. This allows for more precise control over how
3763
+ # different attributes influence search results.
3764
+ #
3559
3765
  # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
3560
3766
  # boosting on the console and the API, they must be enabled for search
3561
3767
  # using the [DocumentAttributeConfiguration][1] object of the
@@ -3580,19 +3786,36 @@ module Aws::QBusiness
3580
3786
  #
3581
3787
  # @!attribute [rw] number_configuration
3582
3788
  # Provides information on boosting `NUMBER` type document attributes.
3789
+ #
3790
+ # `NUMBER` attributes are not supported when using
3791
+ # `NativeIndexConfiguration` version 2, which focuses on `DATE`
3792
+ # attributes for recency and `STRING` attributes for source
3793
+ # prioritization.
3583
3794
  # @return [Types::NumberAttributeBoostingConfiguration]
3584
3795
  #
3585
3796
  # @!attribute [rw] string_configuration
3586
3797
  # Provides information on boosting `STRING` type document attributes.
3798
+ #
3799
+ # Version 2 assigns priority tiers to `STRING` attributes,
3800
+ # establishing clear hierarchical relationships with other boosted
3801
+ # attributes.
3587
3802
  # @return [Types::StringAttributeBoostingConfiguration]
3588
3803
  #
3589
3804
  # @!attribute [rw] date_configuration
3590
3805
  # Provides information on boosting `DATE` type document attributes.
3806
+ #
3807
+ # Version 2 assigns priority tiers to `DATE` attributes, establishing
3808
+ # clear hierarchical relationships with other boosted attributes.
3591
3809
  # @return [Types::DateAttributeBoostingConfiguration]
3592
3810
  #
3593
3811
  # @!attribute [rw] string_list_configuration
3594
3812
  # Provides information on boosting `STRING_LIST` type document
3595
3813
  # attributes.
3814
+ #
3815
+ # `STRING_LIST` attributes are not supported when using
3816
+ # `NativeIndexConfiguration` version 2, which focuses on `DATE`
3817
+ # attributes for recency and `STRING` attributes for source
3818
+ # prioritization.
3596
3819
  # @return [Types::StringListAttributeBoostingConfiguration]
3597
3820
  #
3598
3821
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DocumentAttributeBoostingConfiguration AWS API Documentation
@@ -4302,6 +4525,69 @@ module Aws::QBusiness
4302
4525
  include Aws::Structure
4303
4526
  end
4304
4527
 
4528
+ # @!attribute [rw] application_id
4529
+ # The unique identifier of the Amazon Q Business application
4530
+ # containing the chat response configuration to retrieve.
4531
+ # @return [String]
4532
+ #
4533
+ # @!attribute [rw] chat_response_configuration_id
4534
+ # The unique identifier of the chat response configuration to retrieve
4535
+ # from the specified application.
4536
+ # @return [String]
4537
+ #
4538
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatResponseConfigurationRequest AWS API Documentation
4539
+ #
4540
+ class GetChatResponseConfigurationRequest < Struct.new(
4541
+ :application_id,
4542
+ :chat_response_configuration_id)
4543
+ SENSITIVE = []
4544
+ include Aws::Structure
4545
+ end
4546
+
4547
+ # @!attribute [rw] chat_response_configuration_id
4548
+ # The unique identifier of the retrieved chat response configuration.
4549
+ # @return [String]
4550
+ #
4551
+ # @!attribute [rw] chat_response_configuration_arn
4552
+ # The Amazon Resource Name (ARN) of the retrieved chat response
4553
+ # configuration, which uniquely identifies the resource across all
4554
+ # Amazon Web Services services.
4555
+ # @return [String]
4556
+ #
4557
+ # @!attribute [rw] display_name
4558
+ # The human-readable name of the retrieved chat response
4559
+ # configuration, making it easier to identify among multiple
4560
+ # configurations.
4561
+ # @return [String]
4562
+ #
4563
+ # @!attribute [rw] created_at
4564
+ # The timestamp indicating when the chat response configuration was
4565
+ # initially created.
4566
+ # @return [Time]
4567
+ #
4568
+ # @!attribute [rw] in_use_configuration
4569
+ # The currently active configuration settings that are being used to
4570
+ # generate responses in the Amazon Q Business application.
4571
+ # @return [Types::ChatResponseConfigurationDetail]
4572
+ #
4573
+ # @!attribute [rw] last_update_configuration
4574
+ # Information about the most recent update to the configuration,
4575
+ # including timestamp and modification details.
4576
+ # @return [Types::ChatResponseConfigurationDetail]
4577
+ #
4578
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatResponseConfigurationResponse AWS API Documentation
4579
+ #
4580
+ class GetChatResponseConfigurationResponse < Struct.new(
4581
+ :chat_response_configuration_id,
4582
+ :chat_response_configuration_arn,
4583
+ :display_name,
4584
+ :created_at,
4585
+ :in_use_configuration,
4586
+ :last_update_configuration)
4587
+ SENSITIVE = []
4588
+ include Aws::Structure
4589
+ end
4590
+
4305
4591
  # @!attribute [rw] application_id
4306
4592
  # The unique identifier of the Amazon Q Business application.
4307
4593
  # @return [String]
@@ -5454,6 +5740,80 @@ module Aws::QBusiness
5454
5740
  include Aws::Structure
5455
5741
  end
5456
5742
 
5743
+ # A set of instructions that define how Amazon Q Business should
5744
+ # generate and format responses to user queries. This collection
5745
+ # includes parameters for controlling response characteristics such as
5746
+ # length, audience targeting, perspective, style, identity, tone, and
5747
+ # custom instructions.
5748
+ #
5749
+ # @!attribute [rw] response_length
5750
+ # Specifies the desired length of responses generated by Amazon Q
5751
+ # Business. This parameter allows administrators to control whether
5752
+ # responses are concise and brief or more detailed and comprehensive.
5753
+ # @return [String]
5754
+ #
5755
+ # @!attribute [rw] target_audience
5756
+ # Defines the intended audience for the responses, allowing Amazon Q
5757
+ # Business to tailor its language, terminology, and explanations
5758
+ # appropriately. This could range from technical experts to general
5759
+ # users with varying levels of domain knowledge.
5760
+ # @return [String]
5761
+ #
5762
+ # @!attribute [rw] perspective
5763
+ # Determines the point of view or perspective from which Amazon Q
5764
+ # Business generates responses, such as first-person, second-person,
5765
+ # or third-person perspective, affecting how information is presented
5766
+ # to users.
5767
+ # @return [String]
5768
+ #
5769
+ # @!attribute [rw] output_style
5770
+ # Specifies the formatting and structural style of responses, such as
5771
+ # bullet points, paragraphs, step-by-step instructions, or other
5772
+ # organizational formats that enhance readability and comprehension.
5773
+ # @return [String]
5774
+ #
5775
+ # @!attribute [rw] identity
5776
+ # Defines the persona or identity that Amazon Q Business should adopt
5777
+ # when responding to users, allowing for customization of the
5778
+ # assistant's character, role, or representation within an
5779
+ # organization.
5780
+ # @return [String]
5781
+ #
5782
+ # @!attribute [rw] tone
5783
+ # Controls the emotional tone and communication style of responses,
5784
+ # such as formal, casual, technical, friendly, or professional, to
5785
+ # align with organizational communication standards and user
5786
+ # expectations.
5787
+ # @return [String]
5788
+ #
5789
+ # @!attribute [rw] custom_instructions
5790
+ # Allows administrators to provide specific, custom instructions that
5791
+ # guide how Amazon Q Business should respond in particular scenarios
5792
+ # or to certain types of queries, enabling fine-grained control over
5793
+ # response generation.
5794
+ # @return [String]
5795
+ #
5796
+ # @!attribute [rw] examples
5797
+ # Provides sample responses or templates that Amazon Q Business can
5798
+ # reference when generating responses, helping to establish consistent
5799
+ # patterns and formats for different types of user queries.
5800
+ # @return [String]
5801
+ #
5802
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/InstructionCollection AWS API Documentation
5803
+ #
5804
+ class InstructionCollection < Struct.new(
5805
+ :response_length,
5806
+ :target_audience,
5807
+ :perspective,
5808
+ :output_style,
5809
+ :identity,
5810
+ :tone,
5811
+ :custom_instructions,
5812
+ :examples)
5813
+ SENSITIVE = []
5814
+ include Aws::Structure
5815
+ end
5816
+
5457
5817
  # An issue occurred with the internal server used for your Amazon Q
5458
5818
  # Business service. Wait some minutes and try again, or contact
5459
5819
  # [Support][1] for help.
@@ -5597,6 +5957,53 @@ module Aws::QBusiness
5597
5957
  include Aws::Structure
5598
5958
  end
5599
5959
 
5960
+ # @!attribute [rw] application_id
5961
+ # The unique identifier of the Amazon Q Business application for which
5962
+ # to list available chat response configurations.
5963
+ # @return [String]
5964
+ #
5965
+ # @!attribute [rw] max_results
5966
+ # The maximum number of chat response configurations to return in a
5967
+ # single response. This parameter helps control pagination of results
5968
+ # when many configurations exist.
5969
+ # @return [Integer]
5970
+ #
5971
+ # @!attribute [rw] next_token
5972
+ # A pagination token used to retrieve the next set of results when the
5973
+ # number of configurations exceeds the specified `maxResults` value.
5974
+ # @return [String]
5975
+ #
5976
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListChatResponseConfigurationsRequest AWS API Documentation
5977
+ #
5978
+ class ListChatResponseConfigurationsRequest < Struct.new(
5979
+ :application_id,
5980
+ :max_results,
5981
+ :next_token)
5982
+ SENSITIVE = []
5983
+ include Aws::Structure
5984
+ end
5985
+
5986
+ # @!attribute [rw] chat_response_configurations
5987
+ # A list of chat response configuration summaries, each containing key
5988
+ # information about an available configuration in the specified
5989
+ # application.
5990
+ # @return [Array<Types::ChatResponseConfiguration>]
5991
+ #
5992
+ # @!attribute [rw] next_token
5993
+ # A pagination token that can be used in a subsequent request to
5994
+ # retrieve additional chat response configurations if the results were
5995
+ # truncated due to the `maxResults` parameter.
5996
+ # @return [String]
5997
+ #
5998
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListChatResponseConfigurationsResponse AWS API Documentation
5999
+ #
6000
+ class ListChatResponseConfigurationsResponse < Struct.new(
6001
+ :chat_response_configurations,
6002
+ :next_token)
6003
+ SENSITIVE = []
6004
+ include Aws::Structure
6005
+ end
6006
+
5600
6007
  # @!attribute [rw] application_id
5601
6008
  # The identifier of the Amazon Q Business application.
5602
6009
  # @return [String]
@@ -6583,6 +6990,32 @@ module Aws::QBusiness
6583
6990
  # The identifier for the Amazon Q Business index.
6584
6991
  # @return [String]
6585
6992
  #
6993
+ # @!attribute [rw] version
6994
+ # A read-only field that specifies the version of the
6995
+ # `NativeIndexConfiguration`.
6996
+ #
6997
+ # Amazon Q Business introduces enhanced document retrieval
6998
+ # capabilities in version 2 of `NativeIndexConfiguration`, focusing on
6999
+ # streamlined metadata boosting that prioritizes recency and source
7000
+ # relevance to deliver more accurate responses to your queries.
7001
+ # Version 2 has the following differences from version 1:
7002
+ #
7003
+ # * Version 2 supports a single Date field (created\_at OR
7004
+ # last\_updated\_at) for recency boosting
7005
+ #
7006
+ # * Version 2 supports a single String field with an ordered list of
7007
+ # up to 5 values
7008
+ #
7009
+ # * Version 2 introduces number-based boost levels (ONE, TWO)
7010
+ # alongside the text-based levels
7011
+ #
7012
+ # * Version 2 allows specifying prioritization between Date and String
7013
+ # fields
7014
+ #
7015
+ # * Version 2 maintains backward compatibility with existing
7016
+ # configurations
7017
+ # @return [Integer]
7018
+ #
6586
7019
  # @!attribute [rw] boosting_override
6587
7020
  # Overrides the default boosts applied by Amazon Q Business to
6588
7021
  # supported document attribute data types.
@@ -6592,6 +7025,7 @@ module Aws::QBusiness
6592
7025
  #
6593
7026
  class NativeIndexConfiguration < Struct.new(
6594
7027
  :index_id,
7028
+ :version,
6595
7029
  :boosting_override)
6596
7030
  SENSITIVE = []
6597
7031
  include Aws::Structure
@@ -6608,6 +7042,12 @@ module Aws::QBusiness
6608
7042
 
6609
7043
  # Provides information on boosting `NUMBER` type document attributes.
6610
7044
  #
7045
+ # In the current boosting implementation, boosting focuses primarily on
7046
+ # `DATE` attributes for recency and `STRING` attributes for source
7047
+ # prioritization. `NUMBER` attributes can serve as additional boosting
7048
+ # factors when needed, but are not supported when using
7049
+ # `NativeIndexConfiguration` version 2.
7050
+ #
6611
7051
  # For more information on how boosting document attributes work in
6612
7052
  # Amazon Q Business, see [Boosting using document attributes][1].
6613
7053
  #
@@ -6616,12 +7056,18 @@ module Aws::QBusiness
6616
7056
  # [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
6617
7057
  #
6618
7058
  # @!attribute [rw] boosting_level
6619
- # Specifies the duration, in seconds, of a boost applies to a `NUMBER`
6620
- # type document attribute.
7059
+ # Specifies the priority of boosted document attributes in relation to
7060
+ # other boosted attributes. This parameter determines how strongly the
7061
+ # attribute influences document ranking in search results. `NUMBER`
7062
+ # attributes can serve as additional boosting factors when needed, but
7063
+ # are not supported when using `NativeIndexConfiguration` version 2.
6621
7064
  # @return [String]
6622
7065
  #
6623
7066
  # @!attribute [rw] boosting_type
6624
- # Specifies how much a document attribute is boosted.
7067
+ # Specifies whether higher or lower numeric values should be
7068
+ # prioritized when boosting. Valid values are ASCENDING (higher
7069
+ # numbers are more important) and DESCENDING (lower numbers are more
7070
+ # important).
6625
7071
  # @return [String]
6626
7072
  #
6627
7073
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/NumberAttributeBoostingConfiguration AWS API Documentation
@@ -7193,6 +7639,25 @@ module Aws::QBusiness
7193
7639
  include Aws::Structure
7194
7640
  end
7195
7641
 
7642
+ # Configuration settings to define how Amazon Q Business generates and
7643
+ # formats responses to user queries. This includes customization options
7644
+ # for response style, tone, length, and other characteristics.
7645
+ #
7646
+ # @!attribute [rw] instruction_collection
7647
+ # A collection of instructions that guide how Amazon Q Business
7648
+ # generates responses, including parameters for response length,
7649
+ # target audience, perspective, output style, identity, tone, and
7650
+ # custom instructions.
7651
+ # @return [Types::InstructionCollection]
7652
+ #
7653
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ResponseConfiguration AWS API Documentation
7654
+ #
7655
+ class ResponseConfiguration < Struct.new(
7656
+ :instruction_collection)
7657
+ SENSITIVE = []
7658
+ include Aws::Structure
7659
+ end
7660
+
7196
7661
  # Summary information for the retriever used for your Amazon Q Business
7197
7662
  # application.
7198
7663
  #
@@ -7684,12 +8149,21 @@ module Aws::QBusiness
7684
8149
  # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
7685
8150
  #
7686
8151
  # @!attribute [rw] boosting_level
7687
- # Specifies how much a document attribute is boosted.
8152
+ # Specifies the priority tier ranking of boosting applied to document
8153
+ # attributes. For version 2, this parameter indicates the relative
8154
+ # ranking between boosted fields (ONE being highest priority, TWO
8155
+ # being second highest, etc.) and determines the order in which
8156
+ # attributes influence document ranking in search results. For version
8157
+ # 1, this parameter specifies the boosting intensity. For version 2,
8158
+ # boosting intensity (VERY HIGH, HIGH, MEDIUM, LOW, NONE) are not
8159
+ # supported. Note that in version 2, you are not allowed to boost on
8160
+ # only one field and make this value TWO.
7688
8161
  # @return [String]
7689
8162
  #
7690
8163
  # @!attribute [rw] attribute_value_boosting
7691
8164
  # Specifies specific values of a `STRING` type document attribute
7692
- # being boosted.
8165
+ # being boosted. When using `NativeIndexConfiguration` version 2, you
8166
+ # can specify up to five values in order of priority.
7693
8167
  # @return [Hash<String,String>]
7694
8168
  #
7695
8169
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StringAttributeBoostingConfiguration AWS API Documentation
@@ -7704,6 +8178,12 @@ module Aws::QBusiness
7704
8178
  # Provides information on boosting `STRING_LIST` type document
7705
8179
  # attributes.
7706
8180
  #
8181
+ # In the current boosting implementation, boosting focuses primarily on
8182
+ # `DATE` attributes for recency and `STRING` attributes for source
8183
+ # prioritization. `STRING_LIST` attributes can serve as additional
8184
+ # boosting factors when needed, but are not supported when using
8185
+ # `NativeIndexConfiguration` version 2.
8186
+ #
7707
8187
  # <note markdown="1"> For `STRING` and `STRING_LIST` type document attributes to be used for
7708
8188
  # boosting on the console and the API, they must be enabled for search
7709
8189
  # using the [DocumentAttributeConfiguration][1] object of the
@@ -7723,7 +8203,12 @@ module Aws::QBusiness
7723
8203
  # [3]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html
7724
8204
  #
7725
8205
  # @!attribute [rw] boosting_level
7726
- # Specifies how much a document attribute is boosted.
8206
+ # Specifies the priority of boosted document attributes in relation to
8207
+ # other boosted attributes. This parameter determines how strongly the
8208
+ # attribute influences document ranking in search results.
8209
+ # `STRING_LIST` attributes can serve as additional boosting factors
8210
+ # when needed, but are not supported when using
8211
+ # `NativeIndexConfiguration` version 2.
7727
8212
  # @return [String]
7728
8213
  #
7729
8214
  # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/StringListAttributeBoostingConfiguration AWS API Documentation
@@ -8207,6 +8692,53 @@ module Aws::QBusiness
8207
8692
  #
8208
8693
  class UpdateChatControlsConfigurationResponse < Aws::EmptyStructure; end
8209
8694
 
8695
+ # @!attribute [rw] application_id
8696
+ # The unique identifier of the Amazon Q Business application
8697
+ # containing the chat response configuration to update.
8698
+ # @return [String]
8699
+ #
8700
+ # @!attribute [rw] chat_response_configuration_id
8701
+ # The unique identifier of the chat response configuration to update
8702
+ # within the specified application.
8703
+ # @return [String]
8704
+ #
8705
+ # @!attribute [rw] display_name
8706
+ # The new human-readable name to assign to the chat response
8707
+ # configuration, making it easier to identify among multiple
8708
+ # configurations.
8709
+ # @return [String]
8710
+ #
8711
+ # @!attribute [rw] response_configurations
8712
+ # The updated collection of response configuration settings that
8713
+ # define how Amazon Q Business generates and formats responses to user
8714
+ # queries.
8715
+ # @return [Hash<String,Types::ResponseConfiguration>]
8716
+ #
8717
+ # @!attribute [rw] client_token
8718
+ # A unique, case-sensitive identifier to ensure idempotency of the
8719
+ # request. This helps prevent the same update from being processed
8720
+ # multiple times if retries occur.
8721
+ #
8722
+ # **A suitable default value is auto-generated.** You should normally
8723
+ # not need to pass this option.
8724
+ # @return [String]
8725
+ #
8726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateChatResponseConfigurationRequest AWS API Documentation
8727
+ #
8728
+ class UpdateChatResponseConfigurationRequest < Struct.new(
8729
+ :application_id,
8730
+ :chat_response_configuration_id,
8731
+ :display_name,
8732
+ :response_configurations,
8733
+ :client_token)
8734
+ SENSITIVE = []
8735
+ include Aws::Structure
8736
+ end
8737
+
8738
+ # @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateChatResponseConfigurationResponse AWS API Documentation
8739
+ #
8740
+ class UpdateChatResponseConfigurationResponse < Aws::EmptyStructure; end
8741
+
8210
8742
  # @!attribute [rw] application_id
8211
8743
  # The unique identifier of the Amazon Q Business application.
8212
8744
  # @return [String]
@@ -57,7 +57,7 @@ module Aws::QBusiness
57
57
  autoload :AsyncClient, 'aws-sdk-qbusiness/async_client'
58
58
  autoload :EventStreams, 'aws-sdk-qbusiness/event_streams'
59
59
 
60
- GEM_VERSION = '1.41.0'
60
+ GEM_VERSION = '1.42.0'
61
61
 
62
62
  end
63
63