aws-sdk-qbusiness 1.33.0 → 1.37.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-qbusiness/async_client.rb +140 -109
- data/lib/aws-sdk-qbusiness/client.rb +153 -18
- data/lib/aws-sdk-qbusiness/client_api.rb +188 -74
- data/lib/aws-sdk-qbusiness/types.rb +351 -24
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/async_client.rbs +87 -0
- data/sig/client.rbs +35 -18
- data/sig/types.rbs +83 -3
- metadata +3 -2
@@ -576,6 +576,49 @@ module Aws::QBusiness
|
|
576
576
|
include Aws::Structure
|
577
577
|
end
|
578
578
|
|
579
|
+
# Represents a group associated with a given user in the access control
|
580
|
+
# system.
|
581
|
+
#
|
582
|
+
# @!attribute [rw] name
|
583
|
+
# The name of the group associated with the user. This is used to
|
584
|
+
# identify the group in access control decisions.
|
585
|
+
# @return [String]
|
586
|
+
#
|
587
|
+
# @!attribute [rw] type
|
588
|
+
# The type of the associated group. This indicates the scope of the
|
589
|
+
# group's applicability.
|
590
|
+
# @return [String]
|
591
|
+
#
|
592
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AssociatedGroup AWS API Documentation
|
593
|
+
#
|
594
|
+
class AssociatedGroup < Struct.new(
|
595
|
+
:name,
|
596
|
+
:type)
|
597
|
+
SENSITIVE = []
|
598
|
+
include Aws::Structure
|
599
|
+
end
|
600
|
+
|
601
|
+
# Represents an associated user in the access control system.
|
602
|
+
#
|
603
|
+
# @!attribute [rw] id
|
604
|
+
# The unique identifier of the associated user. This is used to
|
605
|
+
# identify the user in access control decisions.
|
606
|
+
# @return [String]
|
607
|
+
#
|
608
|
+
# @!attribute [rw] type
|
609
|
+
# The type of the associated user. This indicates the scope of the
|
610
|
+
# user's association.
|
611
|
+
# @return [String]
|
612
|
+
#
|
613
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AssociatedUser AWS API Documentation
|
614
|
+
#
|
615
|
+
class AssociatedUser < Struct.new(
|
616
|
+
:id,
|
617
|
+
:type)
|
618
|
+
SENSITIVE = []
|
619
|
+
include Aws::Structure
|
620
|
+
end
|
621
|
+
|
579
622
|
# An attachment in an Amazon Q Business conversation.
|
580
623
|
#
|
581
624
|
# @!attribute [rw] attachment_id
|
@@ -1466,6 +1509,78 @@ module Aws::QBusiness
|
|
1466
1509
|
include Aws::Structure
|
1467
1510
|
end
|
1468
1511
|
|
1512
|
+
# @!attribute [rw] application_id
|
1513
|
+
# The unique identifier of the application. This is required to
|
1514
|
+
# identify the specific Amazon Q Business application context for the
|
1515
|
+
# document access check.
|
1516
|
+
# @return [String]
|
1517
|
+
#
|
1518
|
+
# @!attribute [rw] index_id
|
1519
|
+
# The unique identifier of the index. Used to locate the correct index
|
1520
|
+
# within the application where the document is stored.
|
1521
|
+
# @return [String]
|
1522
|
+
#
|
1523
|
+
# @!attribute [rw] user_id
|
1524
|
+
# The unique identifier of the user. Used to check the access
|
1525
|
+
# permissions for this specific user against the document's ACL.
|
1526
|
+
# @return [String]
|
1527
|
+
#
|
1528
|
+
# @!attribute [rw] document_id
|
1529
|
+
# The unique identifier of the document. Specifies which document's
|
1530
|
+
# access permissions are being checked.
|
1531
|
+
# @return [String]
|
1532
|
+
#
|
1533
|
+
# @!attribute [rw] data_source_id
|
1534
|
+
# The unique identifier of the data source. Identifies the specific
|
1535
|
+
# data source from which the document originates. Should not be used
|
1536
|
+
# when a document is uploaded directly with BatchPutDocument, as no
|
1537
|
+
# dataSourceId is available or necessary.
|
1538
|
+
# @return [String]
|
1539
|
+
#
|
1540
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CheckDocumentAccessRequest AWS API Documentation
|
1541
|
+
#
|
1542
|
+
class CheckDocumentAccessRequest < Struct.new(
|
1543
|
+
:application_id,
|
1544
|
+
:index_id,
|
1545
|
+
:user_id,
|
1546
|
+
:document_id,
|
1547
|
+
:data_source_id)
|
1548
|
+
SENSITIVE = []
|
1549
|
+
include Aws::Structure
|
1550
|
+
end
|
1551
|
+
|
1552
|
+
# @!attribute [rw] user_groups
|
1553
|
+
# An array of groups the user is part of for the specified data
|
1554
|
+
# source. Each group has a name and type.
|
1555
|
+
# @return [Array<Types::AssociatedGroup>]
|
1556
|
+
#
|
1557
|
+
# @!attribute [rw] user_aliases
|
1558
|
+
# An array of aliases associated with the user. This includes both
|
1559
|
+
# global and local aliases, each with a name and type.
|
1560
|
+
# @return [Array<Types::AssociatedUser>]
|
1561
|
+
#
|
1562
|
+
# @!attribute [rw] has_access
|
1563
|
+
# A boolean value indicating whether the specified user has access to
|
1564
|
+
# the document, either direct access or transitive access via groups
|
1565
|
+
# and aliases attached to the document.
|
1566
|
+
# @return [Boolean]
|
1567
|
+
#
|
1568
|
+
# @!attribute [rw] document_acl
|
1569
|
+
# The Access Control List (ACL) associated with the document. Includes
|
1570
|
+
# allowlist and denylist conditions that determine user access.
|
1571
|
+
# @return [Types::DocumentAcl]
|
1572
|
+
#
|
1573
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CheckDocumentAccessResponse AWS API Documentation
|
1574
|
+
#
|
1575
|
+
class CheckDocumentAccessResponse < Struct.new(
|
1576
|
+
:user_groups,
|
1577
|
+
:user_aliases,
|
1578
|
+
:has_access,
|
1579
|
+
:document_acl)
|
1580
|
+
SENSITIVE = []
|
1581
|
+
include Aws::Structure
|
1582
|
+
end
|
1583
|
+
|
1469
1584
|
# A configuration event activated by an end user request to select a
|
1470
1585
|
# specific chat mode.
|
1471
1586
|
#
|
@@ -1670,6 +1785,45 @@ module Aws::QBusiness
|
|
1670
1785
|
class Unknown < CopyFromSource; end
|
1671
1786
|
end
|
1672
1787
|
|
1788
|
+
# @!attribute [rw] application_id
|
1789
|
+
# The identifier of the Amazon Q Business application environment
|
1790
|
+
# attached to the web experience.
|
1791
|
+
# @return [String]
|
1792
|
+
#
|
1793
|
+
# @!attribute [rw] web_experience_id
|
1794
|
+
# The identifier of the web experience.
|
1795
|
+
# @return [String]
|
1796
|
+
#
|
1797
|
+
# @!attribute [rw] session_duration_in_minutes
|
1798
|
+
# The duration of the session associated with the unique URL for the
|
1799
|
+
# web experience.
|
1800
|
+
# @return [Integer]
|
1801
|
+
#
|
1802
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrlRequest AWS API Documentation
|
1803
|
+
#
|
1804
|
+
class CreateAnonymousWebExperienceUrlRequest < Struct.new(
|
1805
|
+
:application_id,
|
1806
|
+
:web_experience_id,
|
1807
|
+
:session_duration_in_minutes)
|
1808
|
+
SENSITIVE = []
|
1809
|
+
include Aws::Structure
|
1810
|
+
end
|
1811
|
+
|
1812
|
+
# @!attribute [rw] anonymous_url
|
1813
|
+
# The unique URL for accessing the web experience.
|
1814
|
+
#
|
1815
|
+
# This URL can only be used once and must be used within 5 minutes
|
1816
|
+
# after it's generated.
|
1817
|
+
# @return [String]
|
1818
|
+
#
|
1819
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateAnonymousWebExperienceUrlResponse AWS API Documentation
|
1820
|
+
#
|
1821
|
+
class CreateAnonymousWebExperienceUrlResponse < Struct.new(
|
1822
|
+
:anonymous_url)
|
1823
|
+
SENSITIVE = []
|
1824
|
+
include Aws::Structure
|
1825
|
+
end
|
1826
|
+
|
1673
1827
|
# @!attribute [rw] display_name
|
1674
1828
|
# A name for the Amazon Q Business application.
|
1675
1829
|
# @return [String]
|
@@ -2351,12 +2505,14 @@ module Aws::QBusiness
|
|
2351
2505
|
#
|
2352
2506
|
# @!attribute [rw] origins
|
2353
2507
|
# Sets the website domain origins that are allowed to embed the Amazon
|
2354
|
-
# Q Business web experience.
|
2355
|
-
#
|
2356
|
-
#
|
2357
|
-
#
|
2358
|
-
# and not a full path. For example,
|
2359
|
-
#
|
2508
|
+
# Q Business web experience. The *domain origin* refers to the base
|
2509
|
+
# URL for accessing a website including the protocol (`http/https`),
|
2510
|
+
# the domain name, and the port number (if specified).
|
2511
|
+
#
|
2512
|
+
# <note markdown="1"> You must only submit a *base URL* and not a full path. For example,
|
2513
|
+
# `https://docs.aws.amazon.com`.
|
2514
|
+
#
|
2515
|
+
# </note>
|
2360
2516
|
# @return [Array<String>]
|
2361
2517
|
#
|
2362
2518
|
# @!attribute [rw] role_arn
|
@@ -3152,6 +3308,126 @@ module Aws::QBusiness
|
|
3152
3308
|
include Aws::Structure
|
3153
3309
|
end
|
3154
3310
|
|
3311
|
+
# Represents the Access Control List (ACL) for a document, containing
|
3312
|
+
# both allowlist and denylist conditions.
|
3313
|
+
#
|
3314
|
+
# @!attribute [rw] allowlist
|
3315
|
+
# The allowlist conditions for the document. Users or groups matching
|
3316
|
+
# these conditions are granted access to the document.
|
3317
|
+
# @return [Types::DocumentAclMembership]
|
3318
|
+
#
|
3319
|
+
# @!attribute [rw] deny_list
|
3320
|
+
# The denylist conditions for the document. Users or groups matching
|
3321
|
+
# these conditions are denied access to the document, overriding
|
3322
|
+
# allowlist permissions.
|
3323
|
+
# @return [Types::DocumentAclMembership]
|
3324
|
+
#
|
3325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DocumentAcl AWS API Documentation
|
3326
|
+
#
|
3327
|
+
class DocumentAcl < Struct.new(
|
3328
|
+
:allowlist,
|
3329
|
+
:deny_list)
|
3330
|
+
SENSITIVE = []
|
3331
|
+
include Aws::Structure
|
3332
|
+
end
|
3333
|
+
|
3334
|
+
# Represents a condition in the document's ACL, specifying access rules
|
3335
|
+
# for users and groups.
|
3336
|
+
#
|
3337
|
+
# @!attribute [rw] member_relation
|
3338
|
+
# The logical relation between members in the condition, determining
|
3339
|
+
# how multiple user or group conditions are combined.
|
3340
|
+
# @return [String]
|
3341
|
+
#
|
3342
|
+
# @!attribute [rw] users
|
3343
|
+
# An array of user identifiers that this condition applies to. Users
|
3344
|
+
# listed here are subject to the access rule defined by this
|
3345
|
+
# condition.
|
3346
|
+
# @return [Array<Types::DocumentAclUser>]
|
3347
|
+
#
|
3348
|
+
# @!attribute [rw] groups
|
3349
|
+
# An array of group identifiers that this condition applies to. Groups
|
3350
|
+
# listed here are subject to the access rule defined by this
|
3351
|
+
# condition.
|
3352
|
+
# @return [Array<Types::DocumentAclGroup>]
|
3353
|
+
#
|
3354
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DocumentAclCondition AWS API Documentation
|
3355
|
+
#
|
3356
|
+
class DocumentAclCondition < Struct.new(
|
3357
|
+
:member_relation,
|
3358
|
+
:users,
|
3359
|
+
:groups)
|
3360
|
+
SENSITIVE = []
|
3361
|
+
include Aws::Structure
|
3362
|
+
end
|
3363
|
+
|
3364
|
+
# Represents a group in the document's ACL, used to define access
|
3365
|
+
# permissions for multiple users collectively.
|
3366
|
+
#
|
3367
|
+
# @!attribute [rw] name
|
3368
|
+
# The name of the group in the document's ACL. This is used to
|
3369
|
+
# identify the group when applying access rules.
|
3370
|
+
# @return [String]
|
3371
|
+
#
|
3372
|
+
# @!attribute [rw] type
|
3373
|
+
# The type of the group. This indicates the scope of the group's
|
3374
|
+
# applicability in access control.
|
3375
|
+
# @return [String]
|
3376
|
+
#
|
3377
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DocumentAclGroup AWS API Documentation
|
3378
|
+
#
|
3379
|
+
class DocumentAclGroup < Struct.new(
|
3380
|
+
:name,
|
3381
|
+
:type)
|
3382
|
+
SENSITIVE = []
|
3383
|
+
include Aws::Structure
|
3384
|
+
end
|
3385
|
+
|
3386
|
+
# Represents membership rules in the document's ACL, defining how users
|
3387
|
+
# or groups are associated with access permissions.
|
3388
|
+
#
|
3389
|
+
# @!attribute [rw] member_relation
|
3390
|
+
# The logical relation between members in the membership rule,
|
3391
|
+
# determining how multiple conditions are combined.
|
3392
|
+
# @return [String]
|
3393
|
+
#
|
3394
|
+
# @!attribute [rw] conditions
|
3395
|
+
# An array of conditions that define the membership rules. Each
|
3396
|
+
# condition specifies criteria for users or groups to be included in
|
3397
|
+
# this membership.
|
3398
|
+
# @return [Array<Types::DocumentAclCondition>]
|
3399
|
+
#
|
3400
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DocumentAclMembership AWS API Documentation
|
3401
|
+
#
|
3402
|
+
class DocumentAclMembership < Struct.new(
|
3403
|
+
:member_relation,
|
3404
|
+
:conditions)
|
3405
|
+
SENSITIVE = []
|
3406
|
+
include Aws::Structure
|
3407
|
+
end
|
3408
|
+
|
3409
|
+
# Represents a user in the document's ACL, used to define access
|
3410
|
+
# permissions for individual users.
|
3411
|
+
#
|
3412
|
+
# @!attribute [rw] id
|
3413
|
+
# The unique identifier of the user in the document's ACL. This is
|
3414
|
+
# used to identify the user when applying access rules.
|
3415
|
+
# @return [String]
|
3416
|
+
#
|
3417
|
+
# @!attribute [rw] type
|
3418
|
+
# The type of the user. This indicates the scope of the user's
|
3419
|
+
# applicability in access control.
|
3420
|
+
# @return [String]
|
3421
|
+
#
|
3422
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/DocumentAclUser AWS API Documentation
|
3423
|
+
#
|
3424
|
+
class DocumentAclUser < Struct.new(
|
3425
|
+
:id,
|
3426
|
+
:type)
|
3427
|
+
SENSITIVE = []
|
3428
|
+
include Aws::Structure
|
3429
|
+
end
|
3430
|
+
|
3155
3431
|
# A document attribute or metadata field.
|
3156
3432
|
#
|
3157
3433
|
# @!attribute [rw] name
|
@@ -3905,6 +4181,10 @@ module Aws::QBusiness
|
|
3905
4181
|
# set of Amazon Q Business chat controls configured.
|
3906
4182
|
# @return [String]
|
3907
4183
|
#
|
4184
|
+
# @!attribute [rw] hallucination_reduction_configuration
|
4185
|
+
# The hallucination reduction settings for your application.
|
4186
|
+
# @return [Types::HallucinationReductionConfiguration]
|
4187
|
+
#
|
3908
4188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetChatControlsConfigurationResponse AWS API Documentation
|
3909
4189
|
#
|
3910
4190
|
class GetChatControlsConfigurationResponse < Struct.new(
|
@@ -3913,7 +4193,8 @@ module Aws::QBusiness
|
|
3913
4193
|
:blocked_phrases,
|
3914
4194
|
:topic_configurations,
|
3915
4195
|
:creator_mode_configuration,
|
3916
|
-
:next_token
|
4196
|
+
:next_token,
|
4197
|
+
:hallucination_reduction_configuration)
|
3917
4198
|
SENSITIVE = []
|
3918
4199
|
include Aws::Structure
|
3919
4200
|
end
|
@@ -4605,10 +4886,9 @@ module Aws::QBusiness
|
|
4605
4886
|
#
|
4606
4887
|
# @!attribute [rw] origins
|
4607
4888
|
# Gets the website domain origins that are allowed to embed the Amazon
|
4608
|
-
# Q Business web experience.
|
4609
|
-
#
|
4610
|
-
#
|
4611
|
-
# specified). </p>
|
4889
|
+
# Q Business web experience. The *domain origin* refers to the base
|
4890
|
+
# URL for accessing a website including the protocol (`http/https`),
|
4891
|
+
# the domain name, and the port number (if specified).
|
4612
4892
|
# @return [Array<String>]
|
4613
4893
|
#
|
4614
4894
|
# @!attribute [rw] role_arn
|
@@ -4736,6 +5016,31 @@ module Aws::QBusiness
|
|
4736
5016
|
include Aws::Structure
|
4737
5017
|
end
|
4738
5018
|
|
5019
|
+
# Configuration information required to setup hallucination reduction.
|
5020
|
+
# For more information, see [ hallucination reduction][1].
|
5021
|
+
#
|
5022
|
+
# <note markdown="1"> The hallucination reduction feature won't work if chat orchestration
|
5023
|
+
# controls are enabled for your application.
|
5024
|
+
#
|
5025
|
+
# </note>
|
5026
|
+
#
|
5027
|
+
#
|
5028
|
+
#
|
5029
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/hallucination-reduction.html
|
5030
|
+
#
|
5031
|
+
# @!attribute [rw] hallucination_reduction_control
|
5032
|
+
# Controls whether hallucination reduction has been enabled or
|
5033
|
+
# disabled for your application. The default status is `DISABLED`.
|
5034
|
+
# @return [String]
|
5035
|
+
#
|
5036
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/HallucinationReductionConfiguration AWS API Documentation
|
5037
|
+
#
|
5038
|
+
class HallucinationReductionConfiguration < Struct.new(
|
5039
|
+
:hallucination_reduction_control)
|
5040
|
+
SENSITIVE = []
|
5041
|
+
include Aws::Structure
|
5042
|
+
end
|
5043
|
+
|
4739
5044
|
# Provides the configuration information for invoking a Lambda function
|
4740
5045
|
# in Lambda to alter document metadata and content when ingesting
|
4741
5046
|
# documents into Amazon Q Business.
|
@@ -4766,13 +5071,13 @@ module Aws::QBusiness
|
|
4766
5071
|
# @return [Types::DocumentAttributeCondition]
|
4767
5072
|
#
|
4768
5073
|
# @!attribute [rw] lambda_arn
|
4769
|
-
# The Amazon Resource Name (ARN) of
|
4770
|
-
#
|
4771
|
-
#
|
5074
|
+
# The Amazon Resource Name (ARN) of the Lambda function sduring
|
5075
|
+
# ingestion. For more information, see [Using Lambda functions for
|
5076
|
+
# Amazon Q Business document enrichment][1].
|
4772
5077
|
#
|
4773
5078
|
#
|
4774
5079
|
#
|
4775
|
-
# [1]: https://docs.aws.amazon.com/amazonq/latest/
|
5080
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/cde-lambda-operations.html
|
4776
5081
|
# @return [String]
|
4777
5082
|
#
|
4778
5083
|
# @!attribute [rw] s3_bucket_name
|
@@ -7470,6 +7775,19 @@ module Aws::QBusiness
|
|
7470
7775
|
# An output event for an AI-generated response in an Amazon Q Business
|
7471
7776
|
# web experience.
|
7472
7777
|
#
|
7778
|
+
# @!attribute [rw] system_message_type
|
7779
|
+
# The type of AI-generated message in a `TextOutputEvent`. Amazon Q
|
7780
|
+
# Business currently supports two types of messages:
|
7781
|
+
#
|
7782
|
+
# * `RESPONSE` - The Amazon Q Business system response.
|
7783
|
+
#
|
7784
|
+
# * `GROUNDED_RESPONSE` - The corrected, hallucination-reduced,
|
7785
|
+
# response returned by Amazon Q Business. Available only if
|
7786
|
+
# hallucination reduction is supported and configured for the
|
7787
|
+
# application and detected in the end user chat query by Amazon Q
|
7788
|
+
# Business.
|
7789
|
+
# @return [String]
|
7790
|
+
#
|
7473
7791
|
# @!attribute [rw] conversation_id
|
7474
7792
|
# The identifier of the conversation with which the text output event
|
7475
7793
|
# is associated.
|
@@ -7490,6 +7808,7 @@ module Aws::QBusiness
|
|
7490
7808
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/TextOutputEvent AWS API Documentation
|
7491
7809
|
#
|
7492
7810
|
class TextOutputEvent < Struct.new(
|
7811
|
+
:system_message_type,
|
7493
7812
|
:conversation_id,
|
7494
7813
|
:user_message_id,
|
7495
7814
|
:system_message_id,
|
@@ -7725,6 +8044,10 @@ module Aws::QBusiness
|
|
7725
8044
|
# The configuration details for `CREATOR_MODE`.
|
7726
8045
|
# @return [Types::CreatorModeConfiguration]
|
7727
8046
|
#
|
8047
|
+
# @!attribute [rw] hallucination_reduction_configuration
|
8048
|
+
# The hallucination reduction settings for your application.
|
8049
|
+
# @return [Types::HallucinationReductionConfiguration]
|
8050
|
+
#
|
7728
8051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateChatControlsConfigurationRequest AWS API Documentation
|
7729
8052
|
#
|
7730
8053
|
class UpdateChatControlsConfigurationRequest < Struct.new(
|
@@ -7735,7 +8058,8 @@ module Aws::QBusiness
|
|
7735
8058
|
:blocked_phrases_configuration_update,
|
7736
8059
|
:topic_configurations_to_create_or_update,
|
7737
8060
|
:topic_configurations_to_delete,
|
7738
|
-
:creator_mode_configuration
|
8061
|
+
:creator_mode_configuration,
|
8062
|
+
:hallucination_reduction_configuration)
|
7739
8063
|
SENSITIVE = []
|
7740
8064
|
include Aws::Structure
|
7741
8065
|
end
|
@@ -8129,14 +8453,17 @@ module Aws::QBusiness
|
|
8129
8453
|
#
|
8130
8454
|
# @!attribute [rw] origins
|
8131
8455
|
# Updates the website domain origins that are allowed to embed the
|
8132
|
-
# Amazon Q Business web experience.
|
8133
|
-
#
|
8134
|
-
#
|
8135
|
-
#
|
8136
|
-
# <
|
8137
|
-
#
|
8138
|
-
#
|
8139
|
-
#
|
8456
|
+
# Amazon Q Business web experience. The *domain origin* refers to the
|
8457
|
+
# *base URL* for accessing a website including the protocol
|
8458
|
+
# (`http/https`), the domain name, and the port number (if specified).
|
8459
|
+
#
|
8460
|
+
# <note markdown="1"> * Any values except `null` submitted as part of this update will
|
8461
|
+
# replace all previous values.
|
8462
|
+
#
|
8463
|
+
# * You must only submit a *base URL* and not a full path. For
|
8464
|
+
# example, `https://docs.aws.amazon.com`.
|
8465
|
+
#
|
8466
|
+
# </note>
|
8140
8467
|
# @return [Array<String>]
|
8141
8468
|
#
|
8142
8469
|
# @!attribute [rw] browser_extension_configuration
|
data/lib/aws-sdk-qbusiness.rb
CHANGED
@@ -0,0 +1,87 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module QBusiness
|
10
|
+
class AsyncClient < ::Seahorse::Client::AsyncBase
|
11
|
+
include ::Aws::AsyncClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/AsyncClient.html#initialize-instance_method
|
14
|
+
def self.new: (
|
15
|
+
?credentials: untyped,
|
16
|
+
?region: String,
|
17
|
+
?access_key_id: String,
|
18
|
+
?account_id: String,
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
20
|
+
?convert_params: bool,
|
21
|
+
?correct_clock_skew: bool,
|
22
|
+
?defaults_mode: String,
|
23
|
+
?disable_request_compression: bool,
|
24
|
+
?endpoint: String,
|
25
|
+
?event_stream_handler: Proc,
|
26
|
+
?ignore_configured_endpoint_urls: bool,
|
27
|
+
?input_event_stream_handler: Proc,
|
28
|
+
?log_formatter: untyped,
|
29
|
+
?log_level: Symbol,
|
30
|
+
?logger: untyped,
|
31
|
+
?max_attempts: Integer,
|
32
|
+
?output_event_stream_handler: Proc,
|
33
|
+
?profile: String,
|
34
|
+
?request_checksum_calculation: String,
|
35
|
+
?request_min_compression_size_bytes: Integer,
|
36
|
+
?response_checksum_validation: String,
|
37
|
+
?retry_backoff: Proc,
|
38
|
+
?retry_base_delay: Float,
|
39
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
40
|
+
?retry_limit: Integer,
|
41
|
+
?retry_max_delay: Integer,
|
42
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
43
|
+
?sdk_ua_app_id: String,
|
44
|
+
?secret_access_key: String,
|
45
|
+
?session_token: String,
|
46
|
+
?sigv4a_signing_region_set: Array[String],
|
47
|
+
?stub_responses: untyped,
|
48
|
+
?telemetry_provider: Aws::Telemetry::TelemetryProviderBase,
|
49
|
+
?token_provider: untyped,
|
50
|
+
?use_dualstack_endpoint: bool,
|
51
|
+
?use_fips_endpoint: bool,
|
52
|
+
?validate_params: bool,
|
53
|
+
?endpoint_provider: untyped,
|
54
|
+
?connection_read_timeout: (Float | Integer),
|
55
|
+
?connection_timeout: (Float | Integer),
|
56
|
+
?enable_alpn: bool,
|
57
|
+
?max_concurrent_streams: (Float | Integer),
|
58
|
+
?read_chunk_size: (Float | Integer),
|
59
|
+
?http_wire_trace: bool,
|
60
|
+
?ssl_verify_peer: bool,
|
61
|
+
?ssl_ca_bundle: String,
|
62
|
+
?ssl_ca_directory: String,
|
63
|
+
?ssl_ca_store: String,
|
64
|
+
?raise_response_errors: bool
|
65
|
+
) -> instance
|
66
|
+
| (?Hash[Symbol, untyped]) -> instance
|
67
|
+
|
68
|
+
|
69
|
+
interface _ChatResponseSuccess
|
70
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ChatOutput]
|
71
|
+
def output_stream: () -> Types::ChatOutputStream
|
72
|
+
end
|
73
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/AsyncClient.html#chat-instance_method
|
74
|
+
def chat: (
|
75
|
+
application_id: ::String,
|
76
|
+
?user_id: ::String,
|
77
|
+
?user_groups: Array[::String],
|
78
|
+
?conversation_id: ::String,
|
79
|
+
?parent_message_id: ::String,
|
80
|
+
?client_token: ::String,
|
81
|
+
input_event_stream_handler: untyped,
|
82
|
+
output_event_stream_handler: untyped
|
83
|
+
) ?{ (*untyped) -> void } -> _ChatResponseSuccess
|
84
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) ?{ (*untyped) -> void } -> _ChatResponseSuccess
|
85
|
+
end
|
86
|
+
end
|
87
|
+
end
|
data/sig/client.rbs
CHANGED
@@ -251,22 +251,6 @@ module Aws
|
|
251
251
|
) -> _CancelSubscriptionResponseSuccess
|
252
252
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CancelSubscriptionResponseSuccess
|
253
253
|
|
254
|
-
interface _ChatResponseSuccess
|
255
|
-
include ::Seahorse::Client::_ResponseSuccess[Types::ChatOutput]
|
256
|
-
def output_stream: () -> Types::ChatOutputStream
|
257
|
-
end
|
258
|
-
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#chat-instance_method
|
259
|
-
def chat: (
|
260
|
-
application_id: ::String,
|
261
|
-
?user_id: ::String,
|
262
|
-
?user_groups: Array[::String],
|
263
|
-
?conversation_id: ::String,
|
264
|
-
?parent_message_id: ::String,
|
265
|
-
?client_token: ::String,
|
266
|
-
input_event_stream_hander: untyped
|
267
|
-
) ?{ (*untyped) -> void } -> _ChatResponseSuccess
|
268
|
-
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) ?{ (*untyped) -> void } -> _ChatResponseSuccess
|
269
|
-
|
270
254
|
interface _ChatSyncResponseSuccess
|
271
255
|
include ::Seahorse::Client::_ResponseSuccess[Types::ChatSyncOutput]
|
272
256
|
def conversation_id: () -> ::String
|
@@ -391,6 +375,35 @@ module Aws
|
|
391
375
|
) -> _ChatSyncResponseSuccess
|
392
376
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ChatSyncResponseSuccess
|
393
377
|
|
378
|
+
interface _CheckDocumentAccessResponseSuccess
|
379
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CheckDocumentAccessResponse]
|
380
|
+
def user_groups: () -> ::Array[Types::AssociatedGroup]
|
381
|
+
def user_aliases: () -> ::Array[Types::AssociatedUser]
|
382
|
+
def has_access: () -> bool
|
383
|
+
def document_acl: () -> Types::DocumentAcl
|
384
|
+
end
|
385
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#check_document_access-instance_method
|
386
|
+
def check_document_access: (
|
387
|
+
application_id: ::String,
|
388
|
+
index_id: ::String,
|
389
|
+
user_id: ::String,
|
390
|
+
document_id: ::String,
|
391
|
+
?data_source_id: ::String
|
392
|
+
) -> _CheckDocumentAccessResponseSuccess
|
393
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CheckDocumentAccessResponseSuccess
|
394
|
+
|
395
|
+
interface _CreateAnonymousWebExperienceUrlResponseSuccess
|
396
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateAnonymousWebExperienceUrlResponse]
|
397
|
+
def anonymous_url: () -> ::String
|
398
|
+
end
|
399
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#create_anonymous_web_experience_url-instance_method
|
400
|
+
def create_anonymous_web_experience_url: (
|
401
|
+
application_id: ::String,
|
402
|
+
web_experience_id: ::String,
|
403
|
+
?session_duration_in_minutes: ::Integer
|
404
|
+
) -> _CreateAnonymousWebExperienceUrlResponseSuccess
|
405
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateAnonymousWebExperienceUrlResponseSuccess
|
406
|
+
|
394
407
|
interface _CreateApplicationResponseSuccess
|
395
408
|
include ::Seahorse::Client::_ResponseSuccess[Types::CreateApplicationResponse]
|
396
409
|
def application_id: () -> ::String
|
@@ -400,7 +413,7 @@ module Aws
|
|
400
413
|
def create_application: (
|
401
414
|
display_name: ::String,
|
402
415
|
?role_arn: ::String,
|
403
|
-
?identity_type: ("AWS_IAM_IDP_SAML" | "AWS_IAM_IDP_OIDC" | "AWS_IAM_IDC" | "AWS_QUICKSIGHT_IDP"),
|
416
|
+
?identity_type: ("AWS_IAM_IDP_SAML" | "AWS_IAM_IDP_OIDC" | "AWS_IAM_IDC" | "AWS_QUICKSIGHT_IDP" | "ANONYMOUS"),
|
404
417
|
?iam_identity_provider_arn: ::String,
|
405
418
|
?identity_center_instance_arn: ::String,
|
406
419
|
?client_ids_for_oidc: Array[::String],
|
@@ -966,7 +979,7 @@ module Aws
|
|
966
979
|
def display_name: () -> ::String
|
967
980
|
def application_id: () -> ::String
|
968
981
|
def application_arn: () -> ::String
|
969
|
-
def identity_type: () -> ("AWS_IAM_IDP_SAML" | "AWS_IAM_IDP_OIDC" | "AWS_IAM_IDC" | "AWS_QUICKSIGHT_IDP")
|
982
|
+
def identity_type: () -> ("AWS_IAM_IDP_SAML" | "AWS_IAM_IDP_OIDC" | "AWS_IAM_IDC" | "AWS_QUICKSIGHT_IDP" | "ANONYMOUS")
|
970
983
|
def iam_identity_provider_arn: () -> ::String
|
971
984
|
def identity_center_application_arn: () -> ::String
|
972
985
|
def role_arn: () -> ::String
|
@@ -996,6 +1009,7 @@ module Aws
|
|
996
1009
|
def topic_configurations: () -> ::Array[Types::TopicConfiguration]
|
997
1010
|
def creator_mode_configuration: () -> Types::AppliedCreatorModeConfiguration
|
998
1011
|
def next_token: () -> ::String
|
1012
|
+
def hallucination_reduction_configuration: () -> Types::HallucinationReductionConfiguration
|
999
1013
|
end
|
1000
1014
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/QBusiness/Client.html#get_chat_controls_configuration-instance_method
|
1001
1015
|
def get_chat_controls_configuration: (
|
@@ -1734,6 +1748,9 @@ module Aws
|
|
1734
1748
|
],
|
1735
1749
|
?creator_mode_configuration: {
|
1736
1750
|
creator_mode_control: ("ENABLED" | "DISABLED")
|
1751
|
+
},
|
1752
|
+
?hallucination_reduction_configuration: {
|
1753
|
+
hallucination_reduction_control: ("ENABLED" | "DISABLED")?
|
1737
1754
|
}
|
1738
1755
|
) -> _UpdateChatControlsConfigurationResponseSuccess
|
1739
1756
|
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateChatControlsConfigurationResponseSuccess
|