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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/async_client.rb +1 -1
- data/lib/aws-sdk-qbusiness/client.rb +318 -18
- data/lib/aws-sdk-qbusiness/client_api.rb +181 -1
- data/lib/aws-sdk-qbusiness/types.rb +539 -7
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/client.rbs +108 -12
- data/sig/types.rbs +108 -5
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c1a5886c6e69c3ba616901fc99450c2b09aa249be51861283b47ba70c065b932
|
4
|
+
data.tar.gz: 5c953f2422da240537d1b55d93349a70c3d06b31a82a8b77f96ca84bb20e83d4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f1a2f29d0e71de100f28d1fdee3c5442fc0afd1d29e3d3553c15dc353a4d012525651c60893a9d25ae500cc6070d3bd337512e9f89303e9d3a6b6d94705fada9
|
7
|
+
data.tar.gz: 965bc645f7f0fa97410e0fb7143fec9fe3434f7859b7c881c67d7773a538116c773c2353ee1003fd0deb173f66f8cccae3de9e931b6d65bcef667a31ea188c26
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.42.0 (2025-07-01)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - New ChatResponseConfiguration to Customize Q Business chat responses for specific use cases and communication needs. Updated Boosting capability allowing admins to provide preference on date attributes for recency and/or provide a preferred data source.
|
8
|
+
|
4
9
|
1.41.0 (2025-06-26)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.42.0
|
@@ -1360,6 +1360,84 @@ module Aws::QBusiness
|
|
1360
1360
|
req.send_request(options)
|
1361
1361
|
end
|
1362
1362
|
|
1363
|
+
# Creates a new chat response configuration for an Amazon Q Business
|
1364
|
+
# application. This operation establishes a set of parameters that
|
1365
|
+
# define how the system generates and formats responses to user queries
|
1366
|
+
# in chat interactions.
|
1367
|
+
#
|
1368
|
+
# @option params [required, String] :application_id
|
1369
|
+
# The unique identifier of the Amazon Q Business application for which
|
1370
|
+
# to create the new chat response configuration.
|
1371
|
+
#
|
1372
|
+
# @option params [required, String] :display_name
|
1373
|
+
# A human-readable name for the new chat response configuration, making
|
1374
|
+
# it easier to identify and manage among multiple configurations.
|
1375
|
+
#
|
1376
|
+
# @option params [String] :client_token
|
1377
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
1378
|
+
# request. This helps prevent the same configuration from being created
|
1379
|
+
# multiple times if retries occur.
|
1380
|
+
#
|
1381
|
+
# **A suitable default value is auto-generated.** You should normally
|
1382
|
+
# not need to pass this option.**
|
1383
|
+
#
|
1384
|
+
# @option params [required, Hash<String,Types::ResponseConfiguration>] :response_configurations
|
1385
|
+
# A collection of response configuration settings that define how Amazon
|
1386
|
+
# Q Business will generate and format responses to user queries in chat
|
1387
|
+
# interactions.
|
1388
|
+
#
|
1389
|
+
# @option params [Array<Types::Tag>] :tags
|
1390
|
+
# A list of key-value pairs to apply as tags to the new chat response
|
1391
|
+
# configuration, enabling categorization and management of resources
|
1392
|
+
# across Amazon Web Services services.
|
1393
|
+
#
|
1394
|
+
# @return [Types::CreateChatResponseConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1395
|
+
#
|
1396
|
+
# * {Types::CreateChatResponseConfigurationResponse#chat_response_configuration_id #chat_response_configuration_id} => String
|
1397
|
+
# * {Types::CreateChatResponseConfigurationResponse#chat_response_configuration_arn #chat_response_configuration_arn} => String
|
1398
|
+
#
|
1399
|
+
# @example Request syntax with placeholder values
|
1400
|
+
#
|
1401
|
+
# resp = client.create_chat_response_configuration({
|
1402
|
+
# application_id: "ApplicationId", # required
|
1403
|
+
# display_name: "DisplayName", # required
|
1404
|
+
# client_token: "String",
|
1405
|
+
# response_configurations: { # required
|
1406
|
+
# "ALL" => {
|
1407
|
+
# instruction_collection: {
|
1408
|
+
# response_length: "Instruction",
|
1409
|
+
# target_audience: "Instruction",
|
1410
|
+
# perspective: "Instruction",
|
1411
|
+
# output_style: "Instruction",
|
1412
|
+
# identity: "Instruction",
|
1413
|
+
# tone: "Instruction",
|
1414
|
+
# custom_instructions: "Instruction",
|
1415
|
+
# examples: "Instruction",
|
1416
|
+
# },
|
1417
|
+
# },
|
1418
|
+
# },
|
1419
|
+
# tags: [
|
1420
|
+
# {
|
1421
|
+
# key: "TagKey", # required
|
1422
|
+
# value: "TagValue", # required
|
1423
|
+
# },
|
1424
|
+
# ],
|
1425
|
+
# })
|
1426
|
+
#
|
1427
|
+
# @example Response structure
|
1428
|
+
#
|
1429
|
+
# resp.chat_response_configuration_id #=> String
|
1430
|
+
# resp.chat_response_configuration_arn #=> String
|
1431
|
+
#
|
1432
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateChatResponseConfiguration AWS API Documentation
|
1433
|
+
#
|
1434
|
+
# @overload create_chat_response_configuration(params = {})
|
1435
|
+
# @param [Hash] params ({})
|
1436
|
+
def create_chat_response_configuration(params = {}, options = {})
|
1437
|
+
req = build_request(:create_chat_response_configuration, params)
|
1438
|
+
req.send_request(options)
|
1439
|
+
end
|
1440
|
+
|
1363
1441
|
# Creates a new data accessor for an ISV to access data from a Amazon Q
|
1364
1442
|
# Business application. The data accessor is an entity that represents
|
1365
1443
|
# the ISV's access to the Amazon Q Business application's data. It
|
@@ -1903,7 +1981,7 @@ module Aws::QBusiness
|
|
1903
1981
|
# custom_plugin_configuration: {
|
1904
1982
|
# description: "PluginDescription", # required
|
1905
1983
|
# api_schema_type: "OPEN_API_V3", # required, accepts OPEN_API_V3
|
1906
|
-
# api_schema: {
|
1984
|
+
# api_schema: {
|
1907
1985
|
# payload: "Payload",
|
1908
1986
|
# s3: {
|
1909
1987
|
# bucket: "S3BucketName", # required
|
@@ -1981,24 +2059,25 @@ module Aws::QBusiness
|
|
1981
2059
|
# configuration: { # required
|
1982
2060
|
# native_index_configuration: {
|
1983
2061
|
# index_id: "IndexId", # required
|
2062
|
+
# version: 1,
|
1984
2063
|
# boosting_override: {
|
1985
2064
|
# "DocumentAttributeKey" => {
|
1986
2065
|
# number_configuration: {
|
1987
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
2066
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
1988
2067
|
# boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
|
1989
2068
|
# },
|
1990
2069
|
# string_configuration: {
|
1991
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
2070
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
1992
2071
|
# attribute_value_boosting: {
|
1993
|
-
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
|
2072
|
+
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO, THREE, FOUR, FIVE
|
1994
2073
|
# },
|
1995
2074
|
# },
|
1996
2075
|
# date_configuration: {
|
1997
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
2076
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
1998
2077
|
# boosting_duration_in_seconds: 1,
|
1999
2078
|
# },
|
2000
2079
|
# string_list_configuration: {
|
2001
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
2080
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
2002
2081
|
# },
|
2003
2082
|
# },
|
2004
2083
|
# },
|
@@ -2360,6 +2439,35 @@ module Aws::QBusiness
|
|
2360
2439
|
req.send_request(options)
|
2361
2440
|
end
|
2362
2441
|
|
2442
|
+
# Deletes a specified chat response configuration from an Amazon Q
|
2443
|
+
# Business application.
|
2444
|
+
#
|
2445
|
+
# @option params [required, String] :application_id
|
2446
|
+
# The unique identifier of theAmazon Q Business application from which
|
2447
|
+
# to delete the chat response configuration.
|
2448
|
+
#
|
2449
|
+
# @option params [required, String] :chat_response_configuration_id
|
2450
|
+
# The unique identifier of the chat response configuration to delete
|
2451
|
+
# from the specified application.
|
2452
|
+
#
|
2453
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2454
|
+
#
|
2455
|
+
# @example Request syntax with placeholder values
|
2456
|
+
#
|
2457
|
+
# resp = client.delete_chat_response_configuration({
|
2458
|
+
# application_id: "ApplicationId", # required
|
2459
|
+
# chat_response_configuration_id: "ChatResponseConfigurationId", # required
|
2460
|
+
# })
|
2461
|
+
#
|
2462
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteChatResponseConfiguration AWS API Documentation
|
2463
|
+
#
|
2464
|
+
# @overload delete_chat_response_configuration(params = {})
|
2465
|
+
# @param [Hash] params ({})
|
2466
|
+
def delete_chat_response_configuration(params = {}, options = {})
|
2467
|
+
req = build_request(:delete_chat_response_configuration, params)
|
2468
|
+
req.send_request(options)
|
2469
|
+
end
|
2470
|
+
|
2363
2471
|
# Deletes an Amazon Q Business web experience conversation.
|
2364
2472
|
#
|
2365
2473
|
# @option params [required, String] :conversation_id
|
@@ -2814,6 +2922,78 @@ module Aws::QBusiness
|
|
2814
2922
|
req.send_request(options)
|
2815
2923
|
end
|
2816
2924
|
|
2925
|
+
# Retrieves detailed information about a specific chat response
|
2926
|
+
# configuration from an Amazon Q Business application. This operation
|
2927
|
+
# returns the complete configuration settings and metadata.
|
2928
|
+
#
|
2929
|
+
# @option params [required, String] :application_id
|
2930
|
+
# The unique identifier of the Amazon Q Business application containing
|
2931
|
+
# the chat response configuration to retrieve.
|
2932
|
+
#
|
2933
|
+
# @option params [required, String] :chat_response_configuration_id
|
2934
|
+
# The unique identifier of the chat response configuration to retrieve
|
2935
|
+
# from the specified application.
|
2936
|
+
#
|
2937
|
+
# @return [Types::GetChatResponseConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2938
|
+
#
|
2939
|
+
# * {Types::GetChatResponseConfigurationResponse#chat_response_configuration_id #chat_response_configuration_id} => String
|
2940
|
+
# * {Types::GetChatResponseConfigurationResponse#chat_response_configuration_arn #chat_response_configuration_arn} => String
|
2941
|
+
# * {Types::GetChatResponseConfigurationResponse#display_name #display_name} => String
|
2942
|
+
# * {Types::GetChatResponseConfigurationResponse#created_at #created_at} => Time
|
2943
|
+
# * {Types::GetChatResponseConfigurationResponse#in_use_configuration #in_use_configuration} => Types::ChatResponseConfigurationDetail
|
2944
|
+
# * {Types::GetChatResponseConfigurationResponse#last_update_configuration #last_update_configuration} => Types::ChatResponseConfigurationDetail
|
2945
|
+
#
|
2946
|
+
# @example Request syntax with placeholder values
|
2947
|
+
#
|
2948
|
+
# resp = client.get_chat_response_configuration({
|
2949
|
+
# application_id: "ApplicationId", # required
|
2950
|
+
# chat_response_configuration_id: "ChatResponseConfigurationId", # required
|
2951
|
+
# })
|
2952
|
+
#
|
2953
|
+
# @example Response structure
|
2954
|
+
#
|
2955
|
+
# resp.chat_response_configuration_id #=> String
|
2956
|
+
# resp.chat_response_configuration_arn #=> String
|
2957
|
+
# resp.display_name #=> String
|
2958
|
+
# resp.created_at #=> Time
|
2959
|
+
# resp.in_use_configuration.response_configurations #=> Hash
|
2960
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.response_length #=> String
|
2961
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.target_audience #=> String
|
2962
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.perspective #=> String
|
2963
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.output_style #=> String
|
2964
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.identity #=> String
|
2965
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.tone #=> String
|
2966
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.custom_instructions #=> String
|
2967
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.examples #=> String
|
2968
|
+
# resp.in_use_configuration.response_configuration_summary #=> String
|
2969
|
+
# resp.in_use_configuration.status #=> String, one of "CREATING", "UPDATING", "FAILED", "ACTIVE"
|
2970
|
+
# resp.in_use_configuration.error.error_message #=> String
|
2971
|
+
# resp.in_use_configuration.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2972
|
+
# resp.in_use_configuration.updated_at #=> Time
|
2973
|
+
# resp.last_update_configuration.response_configurations #=> Hash
|
2974
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.response_length #=> String
|
2975
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.target_audience #=> String
|
2976
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.perspective #=> String
|
2977
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.output_style #=> String
|
2978
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.identity #=> String
|
2979
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.tone #=> String
|
2980
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.custom_instructions #=> String
|
2981
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.examples #=> String
|
2982
|
+
# resp.last_update_configuration.response_configuration_summary #=> String
|
2983
|
+
# resp.last_update_configuration.status #=> String, one of "CREATING", "UPDATING", "FAILED", "ACTIVE"
|
2984
|
+
# resp.last_update_configuration.error.error_message #=> String
|
2985
|
+
# resp.last_update_configuration.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2986
|
+
# resp.last_update_configuration.updated_at #=> Time
|
2987
|
+
#
|
2988
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatResponseConfiguration AWS API Documentation
|
2989
|
+
#
|
2990
|
+
# @overload get_chat_response_configuration(params = {})
|
2991
|
+
# @param [Hash] params ({})
|
2992
|
+
def get_chat_response_configuration(params = {}, options = {})
|
2993
|
+
req = build_request(:get_chat_response_configuration, params)
|
2994
|
+
req.send_request(options)
|
2995
|
+
end
|
2996
|
+
|
2817
2997
|
# Retrieves information about a specified data accessor. This operation
|
2818
2998
|
# returns details about the data accessor, including its display name,
|
2819
2999
|
# unique identifier, Amazon Resource Name (ARN), the associated Amazon Q
|
@@ -3331,15 +3511,16 @@ module Aws::QBusiness
|
|
3331
3511
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "FAILED"
|
3332
3512
|
# resp.display_name #=> String
|
3333
3513
|
# resp.configuration.native_index_configuration.index_id #=> String
|
3514
|
+
# resp.configuration.native_index_configuration.version #=> Integer
|
3334
3515
|
# resp.configuration.native_index_configuration.boosting_override #=> Hash
|
3335
|
-
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
3516
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH", "ONE", "TWO"
|
3336
3517
|
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_type #=> String, one of "PRIORITIZE_LARGER_VALUES", "PRIORITIZE_SMALLER_VALUES"
|
3337
|
-
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
3518
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH", "ONE", "TWO"
|
3338
3519
|
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting #=> Hash
|
3339
|
-
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting["String"] #=> String, one of "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
3340
|
-
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
3520
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting["String"] #=> String, one of "LOW", "MEDIUM", "HIGH", "VERY_HIGH", "ONE", "TWO", "THREE", "FOUR", "FIVE"
|
3521
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH", "ONE", "TWO"
|
3341
3522
|
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_duration_in_seconds #=> Integer
|
3342
|
-
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_list_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
3523
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_list_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH", "ONE", "TWO"
|
3343
3524
|
# resp.configuration.kendra_index_configuration.index_id #=> String
|
3344
3525
|
# resp.role_arn #=> String
|
3345
3526
|
# resp.created_at #=> Time
|
@@ -3591,6 +3772,60 @@ module Aws::QBusiness
|
|
3591
3772
|
req.send_request(options)
|
3592
3773
|
end
|
3593
3774
|
|
3775
|
+
# Retrieves a list of all chat response configurations available in a
|
3776
|
+
# specified Amazon Q Business application. This operation returns
|
3777
|
+
# summary information about each configuration to help administrators
|
3778
|
+
# manage and select appropriate response settings.
|
3779
|
+
#
|
3780
|
+
# @option params [required, String] :application_id
|
3781
|
+
# The unique identifier of the Amazon Q Business application for which
|
3782
|
+
# to list available chat response configurations.
|
3783
|
+
#
|
3784
|
+
# @option params [Integer] :max_results
|
3785
|
+
# The maximum number of chat response configurations to return in a
|
3786
|
+
# single response. This parameter helps control pagination of results
|
3787
|
+
# when many configurations exist.
|
3788
|
+
#
|
3789
|
+
# @option params [String] :next_token
|
3790
|
+
# A pagination token used to retrieve the next set of results when the
|
3791
|
+
# number of configurations exceeds the specified `maxResults` value.
|
3792
|
+
#
|
3793
|
+
# @return [Types::ListChatResponseConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3794
|
+
#
|
3795
|
+
# * {Types::ListChatResponseConfigurationsResponse#chat_response_configurations #chat_response_configurations} => Array<Types::ChatResponseConfiguration>
|
3796
|
+
# * {Types::ListChatResponseConfigurationsResponse#next_token #next_token} => String
|
3797
|
+
#
|
3798
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3799
|
+
#
|
3800
|
+
# @example Request syntax with placeholder values
|
3801
|
+
#
|
3802
|
+
# resp = client.list_chat_response_configurations({
|
3803
|
+
# application_id: "ApplicationId", # required
|
3804
|
+
# max_results: 1,
|
3805
|
+
# next_token: "NextToken",
|
3806
|
+
# })
|
3807
|
+
#
|
3808
|
+
# @example Response structure
|
3809
|
+
#
|
3810
|
+
# resp.chat_response_configurations #=> Array
|
3811
|
+
# resp.chat_response_configurations[0].chat_response_configuration_id #=> String
|
3812
|
+
# resp.chat_response_configurations[0].chat_response_configuration_arn #=> String
|
3813
|
+
# resp.chat_response_configurations[0].display_name #=> String
|
3814
|
+
# resp.chat_response_configurations[0].response_configuration_summary #=> String
|
3815
|
+
# resp.chat_response_configurations[0].status #=> String, one of "CREATING", "UPDATING", "FAILED", "ACTIVE"
|
3816
|
+
# resp.chat_response_configurations[0].created_at #=> Time
|
3817
|
+
# resp.chat_response_configurations[0].updated_at #=> Time
|
3818
|
+
# resp.next_token #=> String
|
3819
|
+
#
|
3820
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListChatResponseConfigurations AWS API Documentation
|
3821
|
+
#
|
3822
|
+
# @overload list_chat_response_configurations(params = {})
|
3823
|
+
# @param [Hash] params ({})
|
3824
|
+
def list_chat_response_configurations(params = {}, options = {})
|
3825
|
+
req = build_request(:list_chat_response_configurations, params)
|
3826
|
+
req.send_request(options)
|
3827
|
+
end
|
3828
|
+
|
3594
3829
|
# Lists one or more Amazon Q Business conversations.
|
3595
3830
|
#
|
3596
3831
|
# @option params [required, String] :application_id
|
@@ -5135,6 +5370,70 @@ module Aws::QBusiness
|
|
5135
5370
|
req.send_request(options)
|
5136
5371
|
end
|
5137
5372
|
|
5373
|
+
# Updates an existing chat response configuration in an Amazon Q
|
5374
|
+
# Business application. This operation allows administrators to modify
|
5375
|
+
# configuration settings, display name, and response parameters to
|
5376
|
+
# refine how the system generates responses.
|
5377
|
+
#
|
5378
|
+
# @option params [required, String] :application_id
|
5379
|
+
# The unique identifier of the Amazon Q Business application containing
|
5380
|
+
# the chat response configuration to update.
|
5381
|
+
#
|
5382
|
+
# @option params [required, String] :chat_response_configuration_id
|
5383
|
+
# The unique identifier of the chat response configuration to update
|
5384
|
+
# within the specified application.
|
5385
|
+
#
|
5386
|
+
# @option params [String] :display_name
|
5387
|
+
# The new human-readable name to assign to the chat response
|
5388
|
+
# configuration, making it easier to identify among multiple
|
5389
|
+
# configurations.
|
5390
|
+
#
|
5391
|
+
# @option params [required, Hash<String,Types::ResponseConfiguration>] :response_configurations
|
5392
|
+
# The updated collection of response configuration settings that define
|
5393
|
+
# how Amazon Q Business generates and formats responses to user queries.
|
5394
|
+
#
|
5395
|
+
# @option params [String] :client_token
|
5396
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
5397
|
+
# request. This helps prevent the same update from being processed
|
5398
|
+
# multiple times if retries occur.
|
5399
|
+
#
|
5400
|
+
# **A suitable default value is auto-generated.** You should normally
|
5401
|
+
# not need to pass this option.**
|
5402
|
+
#
|
5403
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5404
|
+
#
|
5405
|
+
# @example Request syntax with placeholder values
|
5406
|
+
#
|
5407
|
+
# resp = client.update_chat_response_configuration({
|
5408
|
+
# application_id: "ApplicationId", # required
|
5409
|
+
# chat_response_configuration_id: "ChatResponseConfigurationId", # required
|
5410
|
+
# display_name: "DisplayName",
|
5411
|
+
# response_configurations: { # required
|
5412
|
+
# "ALL" => {
|
5413
|
+
# instruction_collection: {
|
5414
|
+
# response_length: "Instruction",
|
5415
|
+
# target_audience: "Instruction",
|
5416
|
+
# perspective: "Instruction",
|
5417
|
+
# output_style: "Instruction",
|
5418
|
+
# identity: "Instruction",
|
5419
|
+
# tone: "Instruction",
|
5420
|
+
# custom_instructions: "Instruction",
|
5421
|
+
# examples: "Instruction",
|
5422
|
+
# },
|
5423
|
+
# },
|
5424
|
+
# },
|
5425
|
+
# client_token: "String",
|
5426
|
+
# })
|
5427
|
+
#
|
5428
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateChatResponseConfiguration AWS API Documentation
|
5429
|
+
#
|
5430
|
+
# @overload update_chat_response_configuration(params = {})
|
5431
|
+
# @param [Hash] params ({})
|
5432
|
+
def update_chat_response_configuration(params = {}, options = {})
|
5433
|
+
req = build_request(:update_chat_response_configuration, params)
|
5434
|
+
req.send_request(options)
|
5435
|
+
end
|
5436
|
+
|
5138
5437
|
# Updates an existing data accessor. This operation allows modifying the
|
5139
5438
|
# action configurations (the allowed actions and associated filters) and
|
5140
5439
|
# the display name of the data accessor. It does not allow changing the
|
@@ -5517,7 +5816,7 @@ module Aws::QBusiness
|
|
5517
5816
|
# custom_plugin_configuration: {
|
5518
5817
|
# description: "PluginDescription", # required
|
5519
5818
|
# api_schema_type: "OPEN_API_V3", # required, accepts OPEN_API_V3
|
5520
|
-
# api_schema: {
|
5819
|
+
# api_schema: {
|
5521
5820
|
# payload: "Payload",
|
5522
5821
|
# s3: {
|
5523
5822
|
# bucket: "S3BucketName", # required
|
@@ -5583,24 +5882,25 @@ module Aws::QBusiness
|
|
5583
5882
|
# configuration: {
|
5584
5883
|
# native_index_configuration: {
|
5585
5884
|
# index_id: "IndexId", # required
|
5885
|
+
# version: 1,
|
5586
5886
|
# boosting_override: {
|
5587
5887
|
# "DocumentAttributeKey" => {
|
5588
5888
|
# number_configuration: {
|
5589
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
5889
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
5590
5890
|
# boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
|
5591
5891
|
# },
|
5592
5892
|
# string_configuration: {
|
5593
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
5893
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
5594
5894
|
# attribute_value_boosting: {
|
5595
|
-
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
|
5895
|
+
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO, THREE, FOUR, FIVE
|
5596
5896
|
# },
|
5597
5897
|
# },
|
5598
5898
|
# date_configuration: {
|
5599
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
5899
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
5600
5900
|
# boosting_duration_in_seconds: 1,
|
5601
5901
|
# },
|
5602
5902
|
# string_list_configuration: {
|
5603
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
5903
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
5604
5904
|
# },
|
5605
5905
|
# },
|
5606
5906
|
# },
|
@@ -5873,7 +6173,7 @@ module Aws::QBusiness
|
|
5873
6173
|
tracer: tracer
|
5874
6174
|
)
|
5875
6175
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
5876
|
-
context[:gem_version] = '1.
|
6176
|
+
context[:gem_version] = '1.42.0'
|
5877
6177
|
Seahorse::Client::Request.new(handlers, context)
|
5878
6178
|
end
|
5879
6179
|
|