aws-sdk-qbusiness 1.41.0 → 1.43.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 +19 -9
- data/lib/aws-sdk-qbusiness/client.rb +336 -26
- 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/async_client.rbs +1 -0
- data/sig/client.rbs +109 -12
- data/sig/resource.rbs +1 -0
- data/sig/types.rbs +108 -5
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1c0c3becdca471691ea1fb0f80ccc852dcfd2e164ddc2b5fc50c3f7cb0db6d08
|
4
|
+
data.tar.gz: be2de8c9cc458fcbb71fa6eb28c686399d583e3191f6b9555556efb07c28b536
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1a8edc9ebb94d0a694ac07f26a41bf441f0b444adcb1f842c205a3e3bd44696390c02e9b8817342d2211f7e8218f8f77aa4efef0adca4f1c2a51bc454b72b26a
|
7
|
+
data.tar.gz: a9af861ae705afcae2597261e04f2fc47ff54de248ba7262a07c11ab72ab68d14456b8ba224cce9e47f3abc5ae9bc57366479ad67b43c61881d4d26b998706d8
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.43.0 (2025-07-21)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.42.0 (2025-07-01)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* 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.
|
13
|
+
|
4
14
|
1.41.0 (2025-06-26)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.43.0
|
@@ -88,7 +88,7 @@ module Aws::QBusiness
|
|
88
88
|
# class name or an instance of a plugin class.
|
89
89
|
#
|
90
90
|
# @option options [required, Aws::CredentialProvider] :credentials
|
91
|
-
# Your AWS credentials. This can be an instance of any one of the
|
91
|
+
# Your AWS credentials used for authentication. This can be an instance of any one of the
|
92
92
|
# following classes:
|
93
93
|
#
|
94
94
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
@@ -121,18 +121,23 @@ module Aws::QBusiness
|
|
121
121
|
# locations will be searched for credentials:
|
122
122
|
#
|
123
123
|
# * `Aws.config[:credentials]`
|
124
|
+
#
|
124
125
|
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
125
126
|
# `:account_id` options.
|
126
|
-
#
|
127
|
-
#
|
127
|
+
#
|
128
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
129
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
130
|
+
#
|
128
131
|
# * `~/.aws/credentials`
|
132
|
+
#
|
129
133
|
# * `~/.aws/config`
|
134
|
+
#
|
130
135
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
131
136
|
# are very aggressive. Construct and pass an instance of
|
132
137
|
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
133
138
|
# enable retries and extended timeouts. Instance profile credential
|
134
|
-
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
135
|
-
# to true
|
139
|
+
# fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
|
140
|
+
# to `true`.
|
136
141
|
#
|
137
142
|
# @option options [required, String] :region
|
138
143
|
# The AWS region to connect to. The configured `:region` is
|
@@ -156,6 +161,11 @@ module Aws::QBusiness
|
|
156
161
|
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
157
162
|
# not retry instead of sleeping.
|
158
163
|
#
|
164
|
+
# @option options [Array<String>] :auth_scheme_preference
|
165
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
166
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
167
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
168
|
+
#
|
159
169
|
# @option options [Boolean] :convert_params (true)
|
160
170
|
# When `true`, an attempt is made to coerce request parameters into
|
161
171
|
# the required types.
|
@@ -213,8 +223,8 @@ module Aws::QBusiness
|
|
213
223
|
# When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
|
214
224
|
#
|
215
225
|
# @option options [String] :profile ("default")
|
216
|
-
# Used when loading credentials from the shared credentials file
|
217
|
-
#
|
226
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
227
|
+
# When not specified, 'default' is used.
|
218
228
|
#
|
219
229
|
# @option options [String] :request_checksum_calculation ("when_supported")
|
220
230
|
# Determines when a checksum will be calculated for request payloads. Values are:
|
@@ -327,7 +337,7 @@ module Aws::QBusiness
|
|
327
337
|
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
328
338
|
#
|
329
339
|
# @option options [Aws::TokenProvider] :token_provider
|
330
|
-
#
|
340
|
+
# Your Bearer token used for authentication. This can be an instance of any one of the
|
331
341
|
# following classes:
|
332
342
|
#
|
333
343
|
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
@@ -673,7 +683,7 @@ module Aws::QBusiness
|
|
673
683
|
tracer: tracer
|
674
684
|
)
|
675
685
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
676
|
-
context[:gem_version] = '1.
|
686
|
+
context[:gem_version] = '1.43.0'
|
677
687
|
Seahorse::Client::Request.new(handlers, context)
|
678
688
|
end
|
679
689
|
|
@@ -97,7 +97,7 @@ module Aws::QBusiness
|
|
97
97
|
# class name or an instance of a plugin class.
|
98
98
|
#
|
99
99
|
# @option options [required, Aws::CredentialProvider] :credentials
|
100
|
-
# Your AWS credentials. This can be an instance of any one of the
|
100
|
+
# Your AWS credentials used for authentication. This can be an instance of any one of the
|
101
101
|
# following classes:
|
102
102
|
#
|
103
103
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
@@ -130,18 +130,23 @@ module Aws::QBusiness
|
|
130
130
|
# locations will be searched for credentials:
|
131
131
|
#
|
132
132
|
# * `Aws.config[:credentials]`
|
133
|
+
#
|
133
134
|
# * The `:access_key_id`, `:secret_access_key`, `:session_token`, and
|
134
135
|
# `:account_id` options.
|
135
|
-
#
|
136
|
-
#
|
136
|
+
#
|
137
|
+
# * `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`,
|
138
|
+
# `ENV['AWS_SESSION_TOKEN']`, and `ENV['AWS_ACCOUNT_ID']`.
|
139
|
+
#
|
137
140
|
# * `~/.aws/credentials`
|
141
|
+
#
|
138
142
|
# * `~/.aws/config`
|
143
|
+
#
|
139
144
|
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
140
145
|
# are very aggressive. Construct and pass an instance of
|
141
146
|
# `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to
|
142
147
|
# enable retries and extended timeouts. Instance profile credential
|
143
|
-
# fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED']
|
144
|
-
# to true
|
148
|
+
# fetching can be disabled by setting `ENV['AWS_EC2_METADATA_DISABLED']`
|
149
|
+
# to `true`.
|
145
150
|
#
|
146
151
|
# @option options [required, String] :region
|
147
152
|
# The AWS region to connect to. The configured `:region` is
|
@@ -169,6 +174,11 @@ module Aws::QBusiness
|
|
169
174
|
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
170
175
|
# not retry instead of sleeping.
|
171
176
|
#
|
177
|
+
# @option options [Array<String>] :auth_scheme_preference
|
178
|
+
# A list of preferred authentication schemes to use when making a request. Supported values are:
|
179
|
+
# `sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV['AWS_AUTH_SCHEME_PREFERENCE']` or in
|
180
|
+
# shared config as `auth_scheme_preference`, the value should be a comma-separated list.
|
181
|
+
#
|
172
182
|
# @option options [Boolean] :client_side_monitoring (false)
|
173
183
|
# When `true`, client-side metrics will be collected for all API requests from
|
174
184
|
# this client.
|
@@ -264,8 +274,8 @@ module Aws::QBusiness
|
|
264
274
|
# When an EventStream or Proc object is provided, it will be used as callback for each chunk of event stream response received along the way.
|
265
275
|
#
|
266
276
|
# @option options [String] :profile ("default")
|
267
|
-
# Used when loading credentials from the shared credentials file
|
268
|
-
#
|
277
|
+
# Used when loading credentials from the shared credentials file at `HOME/.aws/credentials`.
|
278
|
+
# When not specified, 'default' is used.
|
269
279
|
#
|
270
280
|
# @option options [String] :request_checksum_calculation ("when_supported")
|
271
281
|
# Determines when a checksum will be calculated for request payloads. Values are:
|
@@ -378,7 +388,7 @@ module Aws::QBusiness
|
|
378
388
|
# `Aws::Telemetry::OTelProvider` for telemetry provider.
|
379
389
|
#
|
380
390
|
# @option options [Aws::TokenProvider] :token_provider
|
381
|
-
#
|
391
|
+
# Your Bearer token used for authentication. This can be an instance of any one of the
|
382
392
|
# following classes:
|
383
393
|
#
|
384
394
|
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
@@ -1360,6 +1370,84 @@ module Aws::QBusiness
|
|
1360
1370
|
req.send_request(options)
|
1361
1371
|
end
|
1362
1372
|
|
1373
|
+
# Creates a new chat response configuration for an Amazon Q Business
|
1374
|
+
# application. This operation establishes a set of parameters that
|
1375
|
+
# define how the system generates and formats responses to user queries
|
1376
|
+
# in chat interactions.
|
1377
|
+
#
|
1378
|
+
# @option params [required, String] :application_id
|
1379
|
+
# The unique identifier of the Amazon Q Business application for which
|
1380
|
+
# to create the new chat response configuration.
|
1381
|
+
#
|
1382
|
+
# @option params [required, String] :display_name
|
1383
|
+
# A human-readable name for the new chat response configuration, making
|
1384
|
+
# it easier to identify and manage among multiple configurations.
|
1385
|
+
#
|
1386
|
+
# @option params [String] :client_token
|
1387
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
1388
|
+
# request. This helps prevent the same configuration from being created
|
1389
|
+
# multiple times if retries occur.
|
1390
|
+
#
|
1391
|
+
# **A suitable default value is auto-generated.** You should normally
|
1392
|
+
# not need to pass this option.**
|
1393
|
+
#
|
1394
|
+
# @option params [required, Hash<String,Types::ResponseConfiguration>] :response_configurations
|
1395
|
+
# A collection of response configuration settings that define how Amazon
|
1396
|
+
# Q Business will generate and format responses to user queries in chat
|
1397
|
+
# interactions.
|
1398
|
+
#
|
1399
|
+
# @option params [Array<Types::Tag>] :tags
|
1400
|
+
# A list of key-value pairs to apply as tags to the new chat response
|
1401
|
+
# configuration, enabling categorization and management of resources
|
1402
|
+
# across Amazon Web Services services.
|
1403
|
+
#
|
1404
|
+
# @return [Types::CreateChatResponseConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1405
|
+
#
|
1406
|
+
# * {Types::CreateChatResponseConfigurationResponse#chat_response_configuration_id #chat_response_configuration_id} => String
|
1407
|
+
# * {Types::CreateChatResponseConfigurationResponse#chat_response_configuration_arn #chat_response_configuration_arn} => String
|
1408
|
+
#
|
1409
|
+
# @example Request syntax with placeholder values
|
1410
|
+
#
|
1411
|
+
# resp = client.create_chat_response_configuration({
|
1412
|
+
# application_id: "ApplicationId", # required
|
1413
|
+
# display_name: "DisplayName", # required
|
1414
|
+
# client_token: "String",
|
1415
|
+
# response_configurations: { # required
|
1416
|
+
# "ALL" => {
|
1417
|
+
# instruction_collection: {
|
1418
|
+
# response_length: "Instruction",
|
1419
|
+
# target_audience: "Instruction",
|
1420
|
+
# perspective: "Instruction",
|
1421
|
+
# output_style: "Instruction",
|
1422
|
+
# identity: "Instruction",
|
1423
|
+
# tone: "Instruction",
|
1424
|
+
# custom_instructions: "Instruction",
|
1425
|
+
# examples: "Instruction",
|
1426
|
+
# },
|
1427
|
+
# },
|
1428
|
+
# },
|
1429
|
+
# tags: [
|
1430
|
+
# {
|
1431
|
+
# key: "TagKey", # required
|
1432
|
+
# value: "TagValue", # required
|
1433
|
+
# },
|
1434
|
+
# ],
|
1435
|
+
# })
|
1436
|
+
#
|
1437
|
+
# @example Response structure
|
1438
|
+
#
|
1439
|
+
# resp.chat_response_configuration_id #=> String
|
1440
|
+
# resp.chat_response_configuration_arn #=> String
|
1441
|
+
#
|
1442
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateChatResponseConfiguration AWS API Documentation
|
1443
|
+
#
|
1444
|
+
# @overload create_chat_response_configuration(params = {})
|
1445
|
+
# @param [Hash] params ({})
|
1446
|
+
def create_chat_response_configuration(params = {}, options = {})
|
1447
|
+
req = build_request(:create_chat_response_configuration, params)
|
1448
|
+
req.send_request(options)
|
1449
|
+
end
|
1450
|
+
|
1363
1451
|
# Creates a new data accessor for an ISV to access data from a Amazon Q
|
1364
1452
|
# Business application. The data accessor is an entity that represents
|
1365
1453
|
# the ISV's access to the Amazon Q Business application's data. It
|
@@ -1903,7 +1991,7 @@ module Aws::QBusiness
|
|
1903
1991
|
# custom_plugin_configuration: {
|
1904
1992
|
# description: "PluginDescription", # required
|
1905
1993
|
# api_schema_type: "OPEN_API_V3", # required, accepts OPEN_API_V3
|
1906
|
-
# api_schema: {
|
1994
|
+
# api_schema: {
|
1907
1995
|
# payload: "Payload",
|
1908
1996
|
# s3: {
|
1909
1997
|
# bucket: "S3BucketName", # required
|
@@ -1981,24 +2069,25 @@ module Aws::QBusiness
|
|
1981
2069
|
# configuration: { # required
|
1982
2070
|
# native_index_configuration: {
|
1983
2071
|
# index_id: "IndexId", # required
|
2072
|
+
# version: 1,
|
1984
2073
|
# boosting_override: {
|
1985
2074
|
# "DocumentAttributeKey" => {
|
1986
2075
|
# number_configuration: {
|
1987
|
-
# 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
|
1988
2077
|
# boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
|
1989
2078
|
# },
|
1990
2079
|
# string_configuration: {
|
1991
|
-
# 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
|
1992
2081
|
# attribute_value_boosting: {
|
1993
|
-
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
|
2082
|
+
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO, THREE, FOUR, FIVE
|
1994
2083
|
# },
|
1995
2084
|
# },
|
1996
2085
|
# date_configuration: {
|
1997
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
2086
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
1998
2087
|
# boosting_duration_in_seconds: 1,
|
1999
2088
|
# },
|
2000
2089
|
# string_list_configuration: {
|
2001
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
2090
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
2002
2091
|
# },
|
2003
2092
|
# },
|
2004
2093
|
# },
|
@@ -2360,6 +2449,35 @@ module Aws::QBusiness
|
|
2360
2449
|
req.send_request(options)
|
2361
2450
|
end
|
2362
2451
|
|
2452
|
+
# Deletes a specified chat response configuration from an Amazon Q
|
2453
|
+
# Business application.
|
2454
|
+
#
|
2455
|
+
# @option params [required, String] :application_id
|
2456
|
+
# The unique identifier of theAmazon Q Business application from which
|
2457
|
+
# to delete the chat response configuration.
|
2458
|
+
#
|
2459
|
+
# @option params [required, String] :chat_response_configuration_id
|
2460
|
+
# The unique identifier of the chat response configuration to delete
|
2461
|
+
# from the specified application.
|
2462
|
+
#
|
2463
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2464
|
+
#
|
2465
|
+
# @example Request syntax with placeholder values
|
2466
|
+
#
|
2467
|
+
# resp = client.delete_chat_response_configuration({
|
2468
|
+
# application_id: "ApplicationId", # required
|
2469
|
+
# chat_response_configuration_id: "ChatResponseConfigurationId", # required
|
2470
|
+
# })
|
2471
|
+
#
|
2472
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DeleteChatResponseConfiguration AWS API Documentation
|
2473
|
+
#
|
2474
|
+
# @overload delete_chat_response_configuration(params = {})
|
2475
|
+
# @param [Hash] params ({})
|
2476
|
+
def delete_chat_response_configuration(params = {}, options = {})
|
2477
|
+
req = build_request(:delete_chat_response_configuration, params)
|
2478
|
+
req.send_request(options)
|
2479
|
+
end
|
2480
|
+
|
2363
2481
|
# Deletes an Amazon Q Business web experience conversation.
|
2364
2482
|
#
|
2365
2483
|
# @option params [required, String] :conversation_id
|
@@ -2814,6 +2932,78 @@ module Aws::QBusiness
|
|
2814
2932
|
req.send_request(options)
|
2815
2933
|
end
|
2816
2934
|
|
2935
|
+
# Retrieves detailed information about a specific chat response
|
2936
|
+
# configuration from an Amazon Q Business application. This operation
|
2937
|
+
# returns the complete configuration settings and metadata.
|
2938
|
+
#
|
2939
|
+
# @option params [required, String] :application_id
|
2940
|
+
# The unique identifier of the Amazon Q Business application containing
|
2941
|
+
# the chat response configuration to retrieve.
|
2942
|
+
#
|
2943
|
+
# @option params [required, String] :chat_response_configuration_id
|
2944
|
+
# The unique identifier of the chat response configuration to retrieve
|
2945
|
+
# from the specified application.
|
2946
|
+
#
|
2947
|
+
# @return [Types::GetChatResponseConfigurationResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2948
|
+
#
|
2949
|
+
# * {Types::GetChatResponseConfigurationResponse#chat_response_configuration_id #chat_response_configuration_id} => String
|
2950
|
+
# * {Types::GetChatResponseConfigurationResponse#chat_response_configuration_arn #chat_response_configuration_arn} => String
|
2951
|
+
# * {Types::GetChatResponseConfigurationResponse#display_name #display_name} => String
|
2952
|
+
# * {Types::GetChatResponseConfigurationResponse#created_at #created_at} => Time
|
2953
|
+
# * {Types::GetChatResponseConfigurationResponse#in_use_configuration #in_use_configuration} => Types::ChatResponseConfigurationDetail
|
2954
|
+
# * {Types::GetChatResponseConfigurationResponse#last_update_configuration #last_update_configuration} => Types::ChatResponseConfigurationDetail
|
2955
|
+
#
|
2956
|
+
# @example Request syntax with placeholder values
|
2957
|
+
#
|
2958
|
+
# resp = client.get_chat_response_configuration({
|
2959
|
+
# application_id: "ApplicationId", # required
|
2960
|
+
# chat_response_configuration_id: "ChatResponseConfigurationId", # required
|
2961
|
+
# })
|
2962
|
+
#
|
2963
|
+
# @example Response structure
|
2964
|
+
#
|
2965
|
+
# resp.chat_response_configuration_id #=> String
|
2966
|
+
# resp.chat_response_configuration_arn #=> String
|
2967
|
+
# resp.display_name #=> String
|
2968
|
+
# resp.created_at #=> Time
|
2969
|
+
# resp.in_use_configuration.response_configurations #=> Hash
|
2970
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.response_length #=> String
|
2971
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.target_audience #=> String
|
2972
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.perspective #=> String
|
2973
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.output_style #=> String
|
2974
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.identity #=> String
|
2975
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.tone #=> String
|
2976
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.custom_instructions #=> String
|
2977
|
+
# resp.in_use_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.examples #=> String
|
2978
|
+
# resp.in_use_configuration.response_configuration_summary #=> String
|
2979
|
+
# resp.in_use_configuration.status #=> String, one of "CREATING", "UPDATING", "FAILED", "ACTIVE"
|
2980
|
+
# resp.in_use_configuration.error.error_message #=> String
|
2981
|
+
# resp.in_use_configuration.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2982
|
+
# resp.in_use_configuration.updated_at #=> Time
|
2983
|
+
# resp.last_update_configuration.response_configurations #=> Hash
|
2984
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.response_length #=> String
|
2985
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.target_audience #=> String
|
2986
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.perspective #=> String
|
2987
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.output_style #=> String
|
2988
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.identity #=> String
|
2989
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.tone #=> String
|
2990
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.custom_instructions #=> String
|
2991
|
+
# resp.last_update_configuration.response_configurations["ResponseConfigurationType"].instruction_collection.examples #=> String
|
2992
|
+
# resp.last_update_configuration.response_configuration_summary #=> String
|
2993
|
+
# resp.last_update_configuration.status #=> String, one of "CREATING", "UPDATING", "FAILED", "ACTIVE"
|
2994
|
+
# resp.last_update_configuration.error.error_message #=> String
|
2995
|
+
# resp.last_update_configuration.error.error_code #=> String, one of "InternalError", "InvalidRequest", "ResourceInactive", "ResourceNotFound"
|
2996
|
+
# resp.last_update_configuration.updated_at #=> Time
|
2997
|
+
#
|
2998
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatResponseConfiguration AWS API Documentation
|
2999
|
+
#
|
3000
|
+
# @overload get_chat_response_configuration(params = {})
|
3001
|
+
# @param [Hash] params ({})
|
3002
|
+
def get_chat_response_configuration(params = {}, options = {})
|
3003
|
+
req = build_request(:get_chat_response_configuration, params)
|
3004
|
+
req.send_request(options)
|
3005
|
+
end
|
3006
|
+
|
2817
3007
|
# Retrieves information about a specified data accessor. This operation
|
2818
3008
|
# returns details about the data accessor, including its display name,
|
2819
3009
|
# unique identifier, Amazon Resource Name (ARN), the associated Amazon Q
|
@@ -3331,15 +3521,16 @@ module Aws::QBusiness
|
|
3331
3521
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "FAILED"
|
3332
3522
|
# resp.display_name #=> String
|
3333
3523
|
# resp.configuration.native_index_configuration.index_id #=> String
|
3524
|
+
# resp.configuration.native_index_configuration.version #=> Integer
|
3334
3525
|
# 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"
|
3526
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].number_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH", "ONE", "TWO"
|
3336
3527
|
# 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"
|
3528
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].string_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH", "ONE", "TWO"
|
3338
3529
|
# 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"
|
3530
|
+
# 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"
|
3531
|
+
# resp.configuration.native_index_configuration.boosting_override["DocumentAttributeKey"].date_configuration.boosting_level #=> String, one of "NONE", "LOW", "MEDIUM", "HIGH", "VERY_HIGH", "ONE", "TWO"
|
3341
3532
|
# 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"
|
3533
|
+
# 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
3534
|
# resp.configuration.kendra_index_configuration.index_id #=> String
|
3344
3535
|
# resp.role_arn #=> String
|
3345
3536
|
# resp.created_at #=> Time
|
@@ -3591,6 +3782,60 @@ module Aws::QBusiness
|
|
3591
3782
|
req.send_request(options)
|
3592
3783
|
end
|
3593
3784
|
|
3785
|
+
# Retrieves a list of all chat response configurations available in a
|
3786
|
+
# specified Amazon Q Business application. This operation returns
|
3787
|
+
# summary information about each configuration to help administrators
|
3788
|
+
# manage and select appropriate response settings.
|
3789
|
+
#
|
3790
|
+
# @option params [required, String] :application_id
|
3791
|
+
# The unique identifier of the Amazon Q Business application for which
|
3792
|
+
# to list available chat response configurations.
|
3793
|
+
#
|
3794
|
+
# @option params [Integer] :max_results
|
3795
|
+
# The maximum number of chat response configurations to return in a
|
3796
|
+
# single response. This parameter helps control pagination of results
|
3797
|
+
# when many configurations exist.
|
3798
|
+
#
|
3799
|
+
# @option params [String] :next_token
|
3800
|
+
# A pagination token used to retrieve the next set of results when the
|
3801
|
+
# number of configurations exceeds the specified `maxResults` value.
|
3802
|
+
#
|
3803
|
+
# @return [Types::ListChatResponseConfigurationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3804
|
+
#
|
3805
|
+
# * {Types::ListChatResponseConfigurationsResponse#chat_response_configurations #chat_response_configurations} => Array<Types::ChatResponseConfiguration>
|
3806
|
+
# * {Types::ListChatResponseConfigurationsResponse#next_token #next_token} => String
|
3807
|
+
#
|
3808
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3809
|
+
#
|
3810
|
+
# @example Request syntax with placeholder values
|
3811
|
+
#
|
3812
|
+
# resp = client.list_chat_response_configurations({
|
3813
|
+
# application_id: "ApplicationId", # required
|
3814
|
+
# max_results: 1,
|
3815
|
+
# next_token: "NextToken",
|
3816
|
+
# })
|
3817
|
+
#
|
3818
|
+
# @example Response structure
|
3819
|
+
#
|
3820
|
+
# resp.chat_response_configurations #=> Array
|
3821
|
+
# resp.chat_response_configurations[0].chat_response_configuration_id #=> String
|
3822
|
+
# resp.chat_response_configurations[0].chat_response_configuration_arn #=> String
|
3823
|
+
# resp.chat_response_configurations[0].display_name #=> String
|
3824
|
+
# resp.chat_response_configurations[0].response_configuration_summary #=> String
|
3825
|
+
# resp.chat_response_configurations[0].status #=> String, one of "CREATING", "UPDATING", "FAILED", "ACTIVE"
|
3826
|
+
# resp.chat_response_configurations[0].created_at #=> Time
|
3827
|
+
# resp.chat_response_configurations[0].updated_at #=> Time
|
3828
|
+
# resp.next_token #=> String
|
3829
|
+
#
|
3830
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListChatResponseConfigurations AWS API Documentation
|
3831
|
+
#
|
3832
|
+
# @overload list_chat_response_configurations(params = {})
|
3833
|
+
# @param [Hash] params ({})
|
3834
|
+
def list_chat_response_configurations(params = {}, options = {})
|
3835
|
+
req = build_request(:list_chat_response_configurations, params)
|
3836
|
+
req.send_request(options)
|
3837
|
+
end
|
3838
|
+
|
3594
3839
|
# Lists one or more Amazon Q Business conversations.
|
3595
3840
|
#
|
3596
3841
|
# @option params [required, String] :application_id
|
@@ -5135,6 +5380,70 @@ module Aws::QBusiness
|
|
5135
5380
|
req.send_request(options)
|
5136
5381
|
end
|
5137
5382
|
|
5383
|
+
# Updates an existing chat response configuration in an Amazon Q
|
5384
|
+
# Business application. This operation allows administrators to modify
|
5385
|
+
# configuration settings, display name, and response parameters to
|
5386
|
+
# refine how the system generates responses.
|
5387
|
+
#
|
5388
|
+
# @option params [required, String] :application_id
|
5389
|
+
# The unique identifier of the Amazon Q Business application containing
|
5390
|
+
# the chat response configuration to update.
|
5391
|
+
#
|
5392
|
+
# @option params [required, String] :chat_response_configuration_id
|
5393
|
+
# The unique identifier of the chat response configuration to update
|
5394
|
+
# within the specified application.
|
5395
|
+
#
|
5396
|
+
# @option params [String] :display_name
|
5397
|
+
# The new human-readable name to assign to the chat response
|
5398
|
+
# configuration, making it easier to identify among multiple
|
5399
|
+
# configurations.
|
5400
|
+
#
|
5401
|
+
# @option params [required, Hash<String,Types::ResponseConfiguration>] :response_configurations
|
5402
|
+
# The updated collection of response configuration settings that define
|
5403
|
+
# how Amazon Q Business generates and formats responses to user queries.
|
5404
|
+
#
|
5405
|
+
# @option params [String] :client_token
|
5406
|
+
# A unique, case-sensitive identifier to ensure idempotency of the
|
5407
|
+
# request. This helps prevent the same update from being processed
|
5408
|
+
# multiple times if retries occur.
|
5409
|
+
#
|
5410
|
+
# **A suitable default value is auto-generated.** You should normally
|
5411
|
+
# not need to pass this option.**
|
5412
|
+
#
|
5413
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5414
|
+
#
|
5415
|
+
# @example Request syntax with placeholder values
|
5416
|
+
#
|
5417
|
+
# resp = client.update_chat_response_configuration({
|
5418
|
+
# application_id: "ApplicationId", # required
|
5419
|
+
# chat_response_configuration_id: "ChatResponseConfigurationId", # required
|
5420
|
+
# display_name: "DisplayName",
|
5421
|
+
# response_configurations: { # required
|
5422
|
+
# "ALL" => {
|
5423
|
+
# instruction_collection: {
|
5424
|
+
# response_length: "Instruction",
|
5425
|
+
# target_audience: "Instruction",
|
5426
|
+
# perspective: "Instruction",
|
5427
|
+
# output_style: "Instruction",
|
5428
|
+
# identity: "Instruction",
|
5429
|
+
# tone: "Instruction",
|
5430
|
+
# custom_instructions: "Instruction",
|
5431
|
+
# examples: "Instruction",
|
5432
|
+
# },
|
5433
|
+
# },
|
5434
|
+
# },
|
5435
|
+
# client_token: "String",
|
5436
|
+
# })
|
5437
|
+
#
|
5438
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateChatResponseConfiguration AWS API Documentation
|
5439
|
+
#
|
5440
|
+
# @overload update_chat_response_configuration(params = {})
|
5441
|
+
# @param [Hash] params ({})
|
5442
|
+
def update_chat_response_configuration(params = {}, options = {})
|
5443
|
+
req = build_request(:update_chat_response_configuration, params)
|
5444
|
+
req.send_request(options)
|
5445
|
+
end
|
5446
|
+
|
5138
5447
|
# Updates an existing data accessor. This operation allows modifying the
|
5139
5448
|
# action configurations (the allowed actions and associated filters) and
|
5140
5449
|
# the display name of the data accessor. It does not allow changing the
|
@@ -5517,7 +5826,7 @@ module Aws::QBusiness
|
|
5517
5826
|
# custom_plugin_configuration: {
|
5518
5827
|
# description: "PluginDescription", # required
|
5519
5828
|
# api_schema_type: "OPEN_API_V3", # required, accepts OPEN_API_V3
|
5520
|
-
# api_schema: {
|
5829
|
+
# api_schema: {
|
5521
5830
|
# payload: "Payload",
|
5522
5831
|
# s3: {
|
5523
5832
|
# bucket: "S3BucketName", # required
|
@@ -5583,24 +5892,25 @@ module Aws::QBusiness
|
|
5583
5892
|
# configuration: {
|
5584
5893
|
# native_index_configuration: {
|
5585
5894
|
# index_id: "IndexId", # required
|
5895
|
+
# version: 1,
|
5586
5896
|
# boosting_override: {
|
5587
5897
|
# "DocumentAttributeKey" => {
|
5588
5898
|
# number_configuration: {
|
5589
|
-
# 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
|
5590
5900
|
# boosting_type: "PRIORITIZE_LARGER_VALUES", # accepts PRIORITIZE_LARGER_VALUES, PRIORITIZE_SMALLER_VALUES
|
5591
5901
|
# },
|
5592
5902
|
# string_configuration: {
|
5593
|
-
# 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
|
5594
5904
|
# attribute_value_boosting: {
|
5595
|
-
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH
|
5905
|
+
# "String" => "LOW", # accepts LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO, THREE, FOUR, FIVE
|
5596
5906
|
# },
|
5597
5907
|
# },
|
5598
5908
|
# date_configuration: {
|
5599
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
5909
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
5600
5910
|
# boosting_duration_in_seconds: 1,
|
5601
5911
|
# },
|
5602
5912
|
# string_list_configuration: {
|
5603
|
-
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH
|
5913
|
+
# boosting_level: "NONE", # required, accepts NONE, LOW, MEDIUM, HIGH, VERY_HIGH, ONE, TWO
|
5604
5914
|
# },
|
5605
5915
|
# },
|
5606
5916
|
# },
|
@@ -5873,7 +6183,7 @@ module Aws::QBusiness
|
|
5873
6183
|
tracer: tracer
|
5874
6184
|
)
|
5875
6185
|
context[:gem_name] = 'aws-sdk-qbusiness'
|
5876
|
-
context[:gem_version] = '1.
|
6186
|
+
context[:gem_version] = '1.43.0'
|
5877
6187
|
Seahorse::Client::Request.new(handlers, context)
|
5878
6188
|
end
|
5879
6189
|
|