aws-sdk-qbusiness 1.40.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/async_client.rb +1 -1
- data/lib/aws-sdk-qbusiness/client.rb +367 -18
- data/lib/aws-sdk-qbusiness/client_api.rb +224 -1
- data/lib/aws-sdk-qbusiness/types.rb +686 -8
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/client.rbs +134 -12
- data/sig/types.rbs +143 -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,16 @@
|
|
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
|
+
|
9
|
+
1.41.0 (2025-06-26)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Added support for App level authentication for QBusiness DataAccessor using AWS IAM Identity center Trusted Token issuer
|
13
|
+
|
4
14
|
1.40.0 (2025-06-02)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.42.0
|
@@ -497,6 +497,11 @@ module Aws::QBusiness
|
|
497
497
|
# The list of Amazon Q Business actions that the ISV is allowed to
|
498
498
|
# perform.
|
499
499
|
#
|
500
|
+
# @option params [Array<Types::PermissionCondition>] :conditions
|
501
|
+
# The conditions that restrict when the permission is effective. These
|
502
|
+
# conditions can be used to limit the permission based on specific
|
503
|
+
# attributes of the request.
|
504
|
+
#
|
500
505
|
# @option params [required, String] :principal
|
501
506
|
# The Amazon Resource Name of the IAM role for the ISV that is being
|
502
507
|
# granted permission.
|
@@ -511,6 +516,13 @@ module Aws::QBusiness
|
|
511
516
|
# application_id: "ApplicationId", # required
|
512
517
|
# statement_id: "StatementId", # required
|
513
518
|
# actions: ["QIamAction"], # required
|
519
|
+
# conditions: [
|
520
|
+
# {
|
521
|
+
# condition_operator: "StringEquals", # required, accepts StringEquals
|
522
|
+
# condition_key: "PermissionConditionKey", # required
|
523
|
+
# condition_values: ["PermissionConditionValue"], # required
|
524
|
+
# },
|
525
|
+
# ],
|
514
526
|
# principal: "PrincipalRoleArn", # required
|
515
527
|
# })
|
516
528
|
#
|
@@ -1348,6 +1360,84 @@ module Aws::QBusiness
|
|
1348
1360
|
req.send_request(options)
|
1349
1361
|
end
|
1350
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
|
+
|
1351
1441
|
# Creates a new data accessor for an ISV to access data from a Amazon Q
|
1352
1442
|
# Business application. The data accessor is an entity that represents
|
1353
1443
|
# the ISV's access to the Amazon Q Business application's data. It
|
@@ -1379,6 +1469,11 @@ module Aws::QBusiness
|
|
1379
1469
|
# @option params [required, String] :display_name
|
1380
1470
|
# A friendly name for the data accessor.
|
1381
1471
|
#
|
1472
|
+
# @option params [Types::DataAccessorAuthenticationDetail] :authentication_detail
|
1473
|
+
# The authentication configuration details for the data accessor. This
|
1474
|
+
# specifies how the ISV will authenticate when accessing data through
|
1475
|
+
# this data accessor.
|
1476
|
+
#
|
1382
1477
|
# @option params [Array<Types::Tag>] :tags
|
1383
1478
|
# The tags to associate with the data accessor.
|
1384
1479
|
#
|
@@ -1480,6 +1575,15 @@ module Aws::QBusiness
|
|
1480
1575
|
# ],
|
1481
1576
|
# client_token: "ClientToken",
|
1482
1577
|
# display_name: "DataAccessorName", # required
|
1578
|
+
# authentication_detail: {
|
1579
|
+
# authentication_type: "AWS_IAM_IDC_TTI", # required, accepts AWS_IAM_IDC_TTI, AWS_IAM_IDC_AUTH_CODE
|
1580
|
+
# authentication_configuration: {
|
1581
|
+
# idc_trusted_token_issuer_configuration: {
|
1582
|
+
# idc_trusted_token_issuer_arn: "IdcTrustedTokenIssuerArn", # required
|
1583
|
+
# },
|
1584
|
+
# },
|
1585
|
+
# external_ids: ["DataAccessorExternalId"],
|
1586
|
+
# },
|
1483
1587
|
# tags: [
|
1484
1588
|
# {
|
1485
1589
|
# key: "TagKey", # required
|
@@ -1877,7 +1981,7 @@ module Aws::QBusiness
|
|
1877
1981
|
# custom_plugin_configuration: {
|
1878
1982
|
# description: "PluginDescription", # required
|
1879
1983
|
# api_schema_type: "OPEN_API_V3", # required, accepts OPEN_API_V3
|
1880
|
-
# api_schema: {
|
1984
|
+
# api_schema: {
|
1881
1985
|
# payload: "Payload",
|
1882
1986
|
# s3: {
|
1883
1987
|
# bucket: "S3BucketName", # required
|
@@ -1955,24 +2059,25 @@ module Aws::QBusiness
|
|
1955
2059
|
# configuration: { # required
|
1956
2060
|
# native_index_configuration: {
|
1957
2061
|
# index_id: "IndexId", # required
|
2062
|
+
# version: 1,
|
1958
2063
|
# boosting_override: {
|
1959
2064
|
# "DocumentAttributeKey" => {
|
1960
2065
|
# number_configuration: {
|
1961
|
-
# 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
|
1962
2067
|
# boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
|
1963
2068
|
# },
|
1964
2069
|
# string_configuration: {
|
1965
|
-
# 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
|
1966
2071
|
# attribute_value_boosting: {
|
1967
|
-
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
|
2072
|
+
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO, THREE, FOUR, FIVE
|
1968
2073
|
# },
|
1969
2074
|
# },
|
1970
2075
|
# date_configuration: {
|
1971
|
-
# 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
|
1972
2077
|
# boosting_duration_in_seconds: 1,
|
1973
2078
|
# },
|
1974
2079
|
# string_list_configuration: {
|
1975
|
-
# 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
|
1976
2081
|
# },
|
1977
2082
|
# },
|
1978
2083
|
# },
|
@@ -2334,6 +2439,35 @@ module Aws::QBusiness
|
|
2334
2439
|
req.send_request(options)
|
2335
2440
|
end
|
2336
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
|
+
|
2337
2471
|
# Deletes an Amazon Q Business web experience conversation.
|
2338
2472
|
#
|
2339
2473
|
# @option params [required, String] :conversation_id
|
@@ -2788,6 +2922,78 @@ module Aws::QBusiness
|
|
2788
2922
|
req.send_request(options)
|
2789
2923
|
end
|
2790
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
|
+
|
2791
2997
|
# Retrieves information about a specified data accessor. This operation
|
2792
2998
|
# returns details about the data accessor, including its display name,
|
2793
2999
|
# unique identifier, Amazon Resource Name (ARN), the associated Amazon Q
|
@@ -2810,6 +3016,7 @@ module Aws::QBusiness
|
|
2810
3016
|
# * {Types::GetDataAccessorResponse#idc_application_arn #idc_application_arn} => String
|
2811
3017
|
# * {Types::GetDataAccessorResponse#principal #principal} => String
|
2812
3018
|
# * {Types::GetDataAccessorResponse#action_configurations #action_configurations} => Array<Types::ActionConfiguration>
|
3019
|
+
# * {Types::GetDataAccessorResponse#authentication_detail #authentication_detail} => Types::DataAccessorAuthenticationDetail
|
2813
3020
|
# * {Types::GetDataAccessorResponse#created_at #created_at} => Time
|
2814
3021
|
# * {Types::GetDataAccessorResponse#updated_at #updated_at} => Time
|
2815
3022
|
#
|
@@ -2877,6 +3084,10 @@ module Aws::QBusiness
|
|
2877
3084
|
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than_or_equals.value.string_list_value[0] #=> String
|
2878
3085
|
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than_or_equals.value.long_value #=> Integer
|
2879
3086
|
# resp.action_configurations[0].filter_configuration.document_attribute_filter.less_than_or_equals.value.date_value #=> Time
|
3087
|
+
# resp.authentication_detail.authentication_type #=> String, one of "AWS_IAM_IDC_TTI", "AWS_IAM_IDC_AUTH_CODE"
|
3088
|
+
# resp.authentication_detail.authentication_configuration.idc_trusted_token_issuer_configuration.idc_trusted_token_issuer_arn #=> String
|
3089
|
+
# resp.authentication_detail.external_ids #=> Array
|
3090
|
+
# resp.authentication_detail.external_ids[0] #=> String
|
2880
3091
|
# resp.created_at #=> Time
|
2881
3092
|
# resp.updated_at #=> Time
|
2882
3093
|
#
|
@@ -3300,15 +3511,16 @@ module Aws::QBusiness
|
|
3300
3511
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "FAILED"
|
3301
3512
|
# resp.display_name #=> String
|
3302
3513
|
# resp.configuration.native_index_configuration.index_id #=> String
|
3514
|
+
# resp.configuration.native_index_configuration.version #=> Integer
|
3303
3515
|
# resp.configuration.native_index_configuration.boosting_override #=> Hash
|
3304
|
-
# 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"
|
3305
3517
|
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_type #=> String, one of "PRIORITIZE_LARGER_VALUES", "PRIORITIZE_SMALLER_VALUES"
|
3306
|
-
# 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"
|
3307
3519
|
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting #=> Hash
|
3308
|
-
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.attribute_value_boosting["String"] #=> String, one of "LOW", "MEDIUM", "HIGH", "VERY_HIGH"
|
3309
|
-
# 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"
|
3310
3522
|
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_duration_in_seconds #=> Integer
|
3311
|
-
# 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"
|
3312
3524
|
# resp.configuration.kendra_index_configuration.index_id #=> String
|
3313
3525
|
# resp.role_arn #=> String
|
3314
3526
|
# resp.created_at #=> Time
|
@@ -3560,6 +3772,60 @@ module Aws::QBusiness
|
|
3560
3772
|
req.send_request(options)
|
3561
3773
|
end
|
3562
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
|
+
|
3563
3829
|
# Lists one or more Amazon Q Business conversations.
|
3564
3830
|
#
|
3565
3831
|
# @option params [required, String] :application_id
|
@@ -3649,6 +3915,10 @@ module Aws::QBusiness
|
|
3649
3915
|
# resp.data_accessors[0].data_accessor_arn #=> String
|
3650
3916
|
# resp.data_accessors[0].idc_application_arn #=> String
|
3651
3917
|
# resp.data_accessors[0].principal #=> String
|
3918
|
+
# resp.data_accessors[0].authentication_detail.authentication_type #=> String, one of "AWS_IAM_IDC_TTI", "AWS_IAM_IDC_AUTH_CODE"
|
3919
|
+
# resp.data_accessors[0].authentication_detail.authentication_configuration.idc_trusted_token_issuer_configuration.idc_trusted_token_issuer_arn #=> String
|
3920
|
+
# resp.data_accessors[0].authentication_detail.external_ids #=> Array
|
3921
|
+
# resp.data_accessors[0].authentication_detail.external_ids[0] #=> String
|
3652
3922
|
# resp.data_accessors[0].created_at #=> Time
|
3653
3923
|
# resp.data_accessors[0].updated_at #=> Time
|
3654
3924
|
# resp.next_token #=> String
|
@@ -5100,6 +5370,70 @@ module Aws::QBusiness
|
|
5100
5370
|
req.send_request(options)
|
5101
5371
|
end
|
5102
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
|
+
|
5103
5437
|
# Updates an existing data accessor. This operation allows modifying the
|
5104
5438
|
# action configurations (the allowed actions and associated filters) and
|
5105
5439
|
# the display name of the data accessor. It does not allow changing the
|
@@ -5116,6 +5450,11 @@ module Aws::QBusiness
|
|
5116
5450
|
# The updated list of action configurations specifying the allowed
|
5117
5451
|
# actions and any associated filters.
|
5118
5452
|
#
|
5453
|
+
# @option params [Types::DataAccessorAuthenticationDetail] :authentication_detail
|
5454
|
+
# The updated authentication configuration details for the data
|
5455
|
+
# accessor. This specifies how the ISV will authenticate when accessing
|
5456
|
+
# data through this data accessor.
|
5457
|
+
#
|
5119
5458
|
# @option params [String] :display_name
|
5120
5459
|
# The updated friendly name for the data accessor.
|
5121
5460
|
#
|
@@ -5211,6 +5550,15 @@ module Aws::QBusiness
|
|
5211
5550
|
# },
|
5212
5551
|
# },
|
5213
5552
|
# ],
|
5553
|
+
# authentication_detail: {
|
5554
|
+
# authentication_type: "AWS_IAM_IDC_TTI", # required, accepts AWS_IAM_IDC_TTI, AWS_IAM_IDC_AUTH_CODE
|
5555
|
+
# authentication_configuration: {
|
5556
|
+
# idc_trusted_token_issuer_configuration: {
|
5557
|
+
# idc_trusted_token_issuer_arn: "IdcTrustedTokenIssuerArn", # required
|
5558
|
+
# },
|
5559
|
+
# },
|
5560
|
+
# external_ids: ["DataAccessorExternalId"],
|
5561
|
+
# },
|
5214
5562
|
# display_name: "DataAccessorName",
|
5215
5563
|
# })
|
5216
5564
|
#
|
@@ -5468,7 +5816,7 @@ module Aws::QBusiness
|
|
5468
5816
|
# custom_plugin_configuration: {
|
5469
5817
|
# description: "PluginDescription", # required
|
5470
5818
|
# api_schema_type: "OPEN_API_V3", # required, accepts OPEN_API_V3
|
5471
|
-
# api_schema: {
|
5819
|
+
# api_schema: {
|
5472
5820
|
# payload: "Payload",
|
5473
5821
|
# s3: {
|
5474
5822
|
# bucket: "S3BucketName", # required
|
@@ -5534,24 +5882,25 @@ module Aws::QBusiness
|
|
5534
5882
|
# configuration: {
|
5535
5883
|
# native_index_configuration: {
|
5536
5884
|
# index_id: "IndexId", # required
|
5885
|
+
# version: 1,
|
5537
5886
|
# boosting_override: {
|
5538
5887
|
# "DocumentAttributeKey" => {
|
5539
5888
|
# number_configuration: {
|
5540
|
-
# 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
|
5541
5890
|
# boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
|
5542
5891
|
# },
|
5543
5892
|
# string_configuration: {
|
5544
|
-
# 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
|
5545
5894
|
# attribute_value_boosting: {
|
5546
|
-
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
|
5895
|
+
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO, THREE, FOUR, FIVE
|
5547
5896
|
# },
|
5548
5897
|
# },
|
5549
5898
|
# date_configuration: {
|
5550
|
-
# 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
|
5551
5900
|
# boosting_duration_in_seconds: 1,
|
5552
5901
|
# },
|
5553
5902
|
# string_list_configuration: {
|
5554
|
-
# 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
|
5555
5904
|
# },
|
5556
5905
|
# },
|
5557
5906
|
# },
|
@@ -5824,7 +6173,7 @@ module Aws::QBusiness
|
|
5824
6173
|
tracer: tracer
|
5825
6174
|
)
|
5826
6175
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
5827
|
-
context[:gem_version] = '1.
|
6176
|
+
context[:gem_version] = '1.42.0'
|
5828
6177
|
Seahorse::Client::Request.new(handlers, context)
|
5829
6178
|
end
|
5830
6179
|
|