aws-sdk-qbusiness 1.21.0 → 1.23.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 +6 -2
- data/lib/aws-sdk-qbusiness/client.rb +290 -24
- data/lib/aws-sdk-qbusiness/client_api.rb +142 -7
- data/lib/aws-sdk-qbusiness/errors.rb +32 -0
- data/lib/aws-sdk-qbusiness/event_streams.rb +3 -1
- data/lib/aws-sdk-qbusiness/types.rb +466 -42
- data/lib/aws-sdk-qbusiness.rb +1 -1
- data/sig/client.rbs +70 -7
- data/sig/errors.rbs +6 -0
- data/sig/types.rbs +103 -4
- metadata +2 -2
@@ -434,21 +434,91 @@ module Aws::QBusiness
|
|
434
434
|
include Aws::Structure
|
435
435
|
end
|
436
436
|
|
437
|
-
#
|
437
|
+
# An attachment in an Amazon Q Business conversation.
|
438
|
+
#
|
439
|
+
# @!attribute [rw] attachment_id
|
440
|
+
# The identifier of the Amazon Q Business attachment.
|
441
|
+
# @return [String]
|
442
|
+
#
|
443
|
+
# @!attribute [rw] conversation_id
|
444
|
+
# The identifier of the Amazon Q Business conversation the attachment
|
445
|
+
# is associated with.
|
446
|
+
# @return [String]
|
438
447
|
#
|
439
448
|
# @!attribute [rw] name
|
440
|
-
#
|
449
|
+
# Filename of the Amazon Q Business attachment.
|
450
|
+
# @return [String]
|
451
|
+
#
|
452
|
+
# @!attribute [rw] copy_from
|
453
|
+
# A CopyFromSource containing a reference to the original source of
|
454
|
+
# the Amazon Q Business attachment.
|
455
|
+
# @return [Types::CopyFromSource]
|
456
|
+
#
|
457
|
+
# @!attribute [rw] file_type
|
458
|
+
# Filetype of the Amazon Q Business attachment.
|
441
459
|
# @return [String]
|
442
460
|
#
|
461
|
+
# @!attribute [rw] file_size
|
462
|
+
# Size in bytes of the Amazon Q Business attachment.
|
463
|
+
# @return [Integer]
|
464
|
+
#
|
465
|
+
# @!attribute [rw] md5chksum
|
466
|
+
# MD5 checksum of the Amazon Q Business attachment contents.
|
467
|
+
# @return [String]
|
468
|
+
#
|
469
|
+
# @!attribute [rw] created_at
|
470
|
+
# The Unix timestamp when the Amazon Q Business attachment was
|
471
|
+
# created.
|
472
|
+
# @return [Time]
|
473
|
+
#
|
474
|
+
# @!attribute [rw] status
|
475
|
+
# AttachmentStatus of the Amazon Q Business attachment.
|
476
|
+
# @return [String]
|
477
|
+
#
|
478
|
+
# @!attribute [rw] error
|
479
|
+
# ErrorDetail providing information about a Amazon Q Business
|
480
|
+
# attachment error.
|
481
|
+
# @return [Types::ErrorDetail]
|
482
|
+
#
|
483
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Attachment AWS API Documentation
|
484
|
+
#
|
485
|
+
class Attachment < Struct.new(
|
486
|
+
:attachment_id,
|
487
|
+
:conversation_id,
|
488
|
+
:name,
|
489
|
+
:copy_from,
|
490
|
+
:file_type,
|
491
|
+
:file_size,
|
492
|
+
:md5chksum,
|
493
|
+
:created_at,
|
494
|
+
:status,
|
495
|
+
:error)
|
496
|
+
SENSITIVE = []
|
497
|
+
include Aws::Structure
|
498
|
+
end
|
499
|
+
|
500
|
+
# This is either a file directly uploaded into a web experience chat or
|
501
|
+
# a reference to an existing attachment that is part of a web experience
|
502
|
+
# chat.
|
503
|
+
#
|
443
504
|
# @!attribute [rw] data
|
444
|
-
# The
|
505
|
+
# The contents of the attachment.
|
445
506
|
# @return [String]
|
446
507
|
#
|
508
|
+
# @!attribute [rw] name
|
509
|
+
# The filename of the attachment.
|
510
|
+
# @return [String]
|
511
|
+
#
|
512
|
+
# @!attribute [rw] copy_from
|
513
|
+
# A reference to an existing attachment.
|
514
|
+
# @return [Types::CopyFromSource]
|
515
|
+
#
|
447
516
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AttachmentInput AWS API Documentation
|
448
517
|
#
|
449
518
|
class AttachmentInput < Struct.new(
|
519
|
+
:data,
|
450
520
|
:name,
|
451
|
-
:
|
521
|
+
:copy_from)
|
452
522
|
SENSITIVE = []
|
453
523
|
include Aws::Structure
|
454
524
|
end
|
@@ -457,7 +527,9 @@ module Aws::QBusiness
|
|
457
527
|
# into their web experience chat.
|
458
528
|
#
|
459
529
|
# @!attribute [rw] attachment
|
460
|
-
#
|
530
|
+
# This is either a file directly uploaded into a web experience chat
|
531
|
+
# or a reference to an existing attachment that is part of a web
|
532
|
+
# experience chat.
|
461
533
|
# @return [Types::AttachmentInput]
|
462
534
|
#
|
463
535
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AttachmentInputEvent AWS API Documentation
|
@@ -483,12 +555,22 @@ module Aws::QBusiness
|
|
483
555
|
# An error associated with a file uploaded during chat.
|
484
556
|
# @return [Types::ErrorDetail]
|
485
557
|
#
|
558
|
+
# @!attribute [rw] attachment_id
|
559
|
+
# The unique identifier of the Amazon Q Business attachment.
|
560
|
+
# @return [String]
|
561
|
+
#
|
562
|
+
# @!attribute [rw] conversation_id
|
563
|
+
# The unique identifier of the Amazon Q Business conversation.
|
564
|
+
# @return [String]
|
565
|
+
#
|
486
566
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/AttachmentOutput AWS API Documentation
|
487
567
|
#
|
488
568
|
class AttachmentOutput < Struct.new(
|
489
569
|
:name,
|
490
570
|
:status,
|
491
|
-
:error
|
571
|
+
:error,
|
572
|
+
:attachment_id,
|
573
|
+
:conversation_id)
|
492
574
|
SENSITIVE = []
|
493
575
|
include Aws::Structure
|
494
576
|
end
|
@@ -870,6 +952,30 @@ module Aws::QBusiness
|
|
870
952
|
include Aws::Structure
|
871
953
|
end
|
872
954
|
|
955
|
+
# The container for browser extension configuration for an Amazon Q
|
956
|
+
# Business web experience.
|
957
|
+
#
|
958
|
+
# @!attribute [rw] enabled_browser_extensions
|
959
|
+
# Specify the browser extensions allowed for your Amazon Q web
|
960
|
+
# experience.
|
961
|
+
#
|
962
|
+
# * `CHROME` — Enables the extension for Chromium-based browsers
|
963
|
+
# (Google Chrome, Microsoft Edge, Opera, etc.).
|
964
|
+
#
|
965
|
+
# * `FIREFOX` — Enables the extension for Mozilla Firefox.
|
966
|
+
#
|
967
|
+
# * `CHROME` and `FIREFOX` — Enable the extension for Chromium-based
|
968
|
+
# browsers and Mozilla Firefox.
|
969
|
+
# @return [Array<String>]
|
970
|
+
#
|
971
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/BrowserExtensionConfiguration AWS API Documentation
|
972
|
+
#
|
973
|
+
class BrowserExtensionConfiguration < Struct.new(
|
974
|
+
:enabled_browser_extensions)
|
975
|
+
SENSITIVE = []
|
976
|
+
include Aws::Structure
|
977
|
+
end
|
978
|
+
|
873
979
|
# @!attribute [rw] application_id
|
874
980
|
# The identifier of the Amazon Q Business application linked to a
|
875
981
|
# streaming Amazon Q Business conversation.
|
@@ -1006,22 +1112,34 @@ module Aws::QBusiness
|
|
1006
1112
|
# @return [Types::AttributeFilter]
|
1007
1113
|
#
|
1008
1114
|
# @!attribute [rw] chat_mode
|
1009
|
-
# The chat modes available to
|
1115
|
+
# The `chatMode` parameter determines the chat modes available to
|
1116
|
+
# Amazon Q Business users:
|
1117
|
+
#
|
1118
|
+
# * `RETRIEVAL_MODE` - If you choose this mode, Amazon Q generates
|
1119
|
+
# responses solely from the data sources connected and indexed by
|
1120
|
+
# the application. If an answer is not found in the data sources or
|
1121
|
+
# there are no data sources available, Amazon Q will respond with a
|
1122
|
+
# "*No Answer Found*" message, unless LLM knowledge has been
|
1123
|
+
# enabled. In that case, Amazon Q will generate a response from the
|
1124
|
+
# LLM knowledge
|
1125
|
+
#
|
1126
|
+
# * `CREATOR_MODE` - By selecting this mode, you can choose to
|
1127
|
+
# generate responses only from the LLM knowledge. You can also
|
1128
|
+
# attach files and have Amazon Q generate a response based on the
|
1129
|
+
# data in those files. If the attached files do not contain an
|
1130
|
+
# answer for the query, Amazon Q will automatically fall back to
|
1131
|
+
# generating a response from the LLM knowledge.
|
1010
1132
|
#
|
1011
|
-
# * `
|
1012
|
-
#
|
1013
|
-
# generates responses only from data sources connected to an Amazon
|
1014
|
-
# Q Business application.
|
1133
|
+
# * `PLUGIN_MODE` - By selecting this mode, users can choose to use
|
1134
|
+
# plugins in chat to get their responses.
|
1015
1135
|
#
|
1016
|
-
#
|
1017
|
-
#
|
1018
|
-
# connected data sources, for a chat request.
|
1136
|
+
# <note markdown="1"> If none of the modes are selected, Amazon Q will only respond using
|
1137
|
+
# the information from the attached files.
|
1019
1138
|
#
|
1020
|
-
#
|
1021
|
-
# plugins in chat.
|
1139
|
+
# </note>
|
1022
1140
|
#
|
1023
1141
|
# For more information, see [Admin controls and guardrails][1],
|
1024
|
-
# [Plugins][2], and [
|
1142
|
+
# [Plugins][2], and [Response sources][3].
|
1025
1143
|
#
|
1026
1144
|
#
|
1027
1145
|
#
|
@@ -1170,7 +1288,7 @@ module Aws::QBusiness
|
|
1170
1288
|
end
|
1171
1289
|
|
1172
1290
|
# You are trying to perform an action that conflicts with the current
|
1173
|
-
# status of your resource. Fix any
|
1291
|
+
# status of your resource. Fix any inconsistencies with your resources
|
1174
1292
|
# and try again.
|
1175
1293
|
#
|
1176
1294
|
# @!attribute [rw] message
|
@@ -1253,6 +1371,49 @@ module Aws::QBusiness
|
|
1253
1371
|
include Aws::Structure
|
1254
1372
|
end
|
1255
1373
|
|
1374
|
+
# The source reference for an existing attachment in an existing
|
1375
|
+
# conversation.
|
1376
|
+
#
|
1377
|
+
# @!attribute [rw] conversation_id
|
1378
|
+
# The unique identifier of the Amazon Q Business conversation.
|
1379
|
+
# @return [String]
|
1380
|
+
#
|
1381
|
+
# @!attribute [rw] attachment_id
|
1382
|
+
# The unique identifier of the Amazon Q Business attachment.
|
1383
|
+
# @return [String]
|
1384
|
+
#
|
1385
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ConversationSource AWS API Documentation
|
1386
|
+
#
|
1387
|
+
class ConversationSource < Struct.new(
|
1388
|
+
:conversation_id,
|
1389
|
+
:attachment_id)
|
1390
|
+
SENSITIVE = []
|
1391
|
+
include Aws::Structure
|
1392
|
+
end
|
1393
|
+
|
1394
|
+
# The source reference for an existing attachment.
|
1395
|
+
#
|
1396
|
+
# @note CopyFromSource is a union - when making an API calls you must set exactly one of the members.
|
1397
|
+
#
|
1398
|
+
# @note CopyFromSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of CopyFromSource corresponding to the set member.
|
1399
|
+
#
|
1400
|
+
# @!attribute [rw] conversation
|
1401
|
+
# A reference to an attachment in an existing conversation.
|
1402
|
+
# @return [Types::ConversationSource]
|
1403
|
+
#
|
1404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CopyFromSource AWS API Documentation
|
1405
|
+
#
|
1406
|
+
class CopyFromSource < Struct.new(
|
1407
|
+
:conversation,
|
1408
|
+
:unknown)
|
1409
|
+
SENSITIVE = []
|
1410
|
+
include Aws::Structure
|
1411
|
+
include Aws::Structure::Union
|
1412
|
+
|
1413
|
+
class Conversation < CopyFromSource; end
|
1414
|
+
class Unknown < CopyFromSource; end
|
1415
|
+
end
|
1416
|
+
|
1256
1417
|
# @!attribute [rw] display_name
|
1257
1418
|
# A name for the Amazon Q Business application.
|
1258
1419
|
# @return [String]
|
@@ -1470,6 +1631,11 @@ module Aws::QBusiness
|
|
1470
1631
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
|
1471
1632
|
# @return [Types::DocumentEnrichmentConfiguration]
|
1472
1633
|
#
|
1634
|
+
# @!attribute [rw] media_extraction_configuration
|
1635
|
+
# The configuration for extracting information from media in documents
|
1636
|
+
# during ingestion.
|
1637
|
+
# @return [Types::MediaExtractionConfiguration]
|
1638
|
+
#
|
1473
1639
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateDataSourceRequest AWS API Documentation
|
1474
1640
|
#
|
1475
1641
|
class CreateDataSourceRequest < Struct.new(
|
@@ -1483,7 +1649,8 @@ module Aws::QBusiness
|
|
1483
1649
|
:sync_schedule,
|
1484
1650
|
:role_arn,
|
1485
1651
|
:client_token,
|
1486
|
-
:document_enrichment_configuration
|
1652
|
+
:document_enrichment_configuration,
|
1653
|
+
:media_extraction_configuration)
|
1487
1654
|
SENSITIVE = []
|
1488
1655
|
include Aws::Structure
|
1489
1656
|
end
|
@@ -1514,6 +1681,10 @@ module Aws::QBusiness
|
|
1514
1681
|
# A name for the Amazon Q Business index.
|
1515
1682
|
# @return [String]
|
1516
1683
|
#
|
1684
|
+
# @!attribute [rw] description
|
1685
|
+
# A description for the Amazon Q Business index.
|
1686
|
+
# @return [String]
|
1687
|
+
#
|
1517
1688
|
# @!attribute [rw] type
|
1518
1689
|
# The index type that's suitable for your needs. For more information
|
1519
1690
|
# on what's included in each type of index, see [Amazon Q Business
|
@@ -1524,10 +1695,6 @@ module Aws::QBusiness
|
|
1524
1695
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers
|
1525
1696
|
# @return [String]
|
1526
1697
|
#
|
1527
|
-
# @!attribute [rw] description
|
1528
|
-
# A description for the Amazon Q Business index.
|
1529
|
-
# @return [String]
|
1530
|
-
#
|
1531
1698
|
# @!attribute [rw] tags
|
1532
1699
|
# A list of key-value pairs that identify or categorize the index. You
|
1533
1700
|
# can also use tags to help control access to the index. Tag keys and
|
@@ -1554,8 +1721,8 @@ module Aws::QBusiness
|
|
1554
1721
|
class CreateIndexRequest < Struct.new(
|
1555
1722
|
:application_id,
|
1556
1723
|
:display_name,
|
1557
|
-
:type,
|
1558
1724
|
:description,
|
1725
|
+
:type,
|
1559
1726
|
:tags,
|
1560
1727
|
:capacity_configuration,
|
1561
1728
|
:client_token)
|
@@ -1828,6 +1995,23 @@ module Aws::QBusiness
|
|
1828
1995
|
# end users of an Amazon Q Business web experience.
|
1829
1996
|
# @return [Types::IdentityProviderConfiguration]
|
1830
1997
|
#
|
1998
|
+
# @!attribute [rw] browser_extension_configuration
|
1999
|
+
# The browser extension configuration for an Amazon Q Business web
|
2000
|
+
# experience.
|
2001
|
+
#
|
2002
|
+
# <note markdown="1"> For Amazon Q Business application using external OIDC-compliant
|
2003
|
+
# identity providers (IdPs). The IdP administrator must add the
|
2004
|
+
# browser extension sign-in redirect URLs to the IdP application. For
|
2005
|
+
# more information, see [Configure external OIDC identity provider for
|
2006
|
+
# your browser extensions.][1].
|
2007
|
+
#
|
2008
|
+
# </note>
|
2009
|
+
#
|
2010
|
+
#
|
2011
|
+
#
|
2012
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html
|
2013
|
+
# @return [Types::BrowserExtensionConfiguration]
|
2014
|
+
#
|
1831
2015
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/CreateWebExperienceRequest AWS API Documentation
|
1832
2016
|
#
|
1833
2017
|
class CreateWebExperienceRequest < Struct.new(
|
@@ -1840,7 +2024,8 @@ module Aws::QBusiness
|
|
1840
2024
|
:role_arn,
|
1841
2025
|
:tags,
|
1842
2026
|
:client_token,
|
1843
|
-
:identity_provider_configuration
|
2027
|
+
:identity_provider_configuration,
|
2028
|
+
:browser_extension_configuration)
|
1844
2029
|
SENSITIVE = []
|
1845
2030
|
include Aws::Structure
|
1846
2031
|
end
|
@@ -2389,6 +2574,11 @@ module Aws::QBusiness
|
|
2389
2574
|
# content during the document ingestion process.
|
2390
2575
|
# @return [Types::DocumentEnrichmentConfiguration]
|
2391
2576
|
#
|
2577
|
+
# @!attribute [rw] media_extraction_configuration
|
2578
|
+
# The configuration for extracting information from media in the
|
2579
|
+
# document.
|
2580
|
+
# @return [Types::MediaExtractionConfiguration]
|
2581
|
+
#
|
2392
2582
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/Document AWS API Documentation
|
2393
2583
|
#
|
2394
2584
|
class Document < Struct.new(
|
@@ -2398,7 +2588,8 @@ module Aws::QBusiness
|
|
2398
2588
|
:content_type,
|
2399
2589
|
:title,
|
2400
2590
|
:access_configuration,
|
2401
|
-
:document_enrichment_configuration
|
2591
|
+
:document_enrichment_configuration,
|
2592
|
+
:media_extraction_configuration)
|
2402
2593
|
SENSITIVE = []
|
2403
2594
|
include Aws::Structure
|
2404
2595
|
end
|
@@ -2859,14 +3050,14 @@ module Aws::QBusiness
|
|
2859
3050
|
include Aws::Structure
|
2860
3051
|
end
|
2861
3052
|
|
2862
|
-
# Provides information about a
|
3053
|
+
# Provides information about a Amazon Q Business request error.
|
2863
3054
|
#
|
2864
3055
|
# @!attribute [rw] error_message
|
2865
|
-
# The message explaining the
|
3056
|
+
# The message explaining the Amazon Q Business request error.
|
2866
3057
|
# @return [String]
|
2867
3058
|
#
|
2868
3059
|
# @!attribute [rw] error_code
|
2869
|
-
# The code associated with the
|
3060
|
+
# The code associated with the Amazon Q Business request error.
|
2870
3061
|
# @return [String]
|
2871
3062
|
#
|
2872
3063
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ErrorDetail AWS API Documentation
|
@@ -2878,6 +3069,21 @@ module Aws::QBusiness
|
|
2878
3069
|
include Aws::Structure
|
2879
3070
|
end
|
2880
3071
|
|
3072
|
+
# An external resource that you configured with your application is
|
3073
|
+
# returning errors and preventing this operation from succeeding. Fix
|
3074
|
+
# those errors and try again.
|
3075
|
+
#
|
3076
|
+
# @!attribute [rw] message
|
3077
|
+
# @return [String]
|
3078
|
+
#
|
3079
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ExternalResourceException AWS API Documentation
|
3080
|
+
#
|
3081
|
+
class ExternalResourceException < Struct.new(
|
3082
|
+
:message)
|
3083
|
+
SENSITIVE = []
|
3084
|
+
include Aws::Structure
|
3085
|
+
end
|
3086
|
+
|
2881
3087
|
# A failed file upload during web experience chat.
|
2882
3088
|
#
|
2883
3089
|
# @!attribute [rw] conversation_id
|
@@ -3233,6 +3439,11 @@ module Aws::QBusiness
|
|
3233
3439
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
|
3234
3440
|
# @return [Types::DocumentEnrichmentConfiguration]
|
3235
3441
|
#
|
3442
|
+
# @!attribute [rw] media_extraction_configuration
|
3443
|
+
# The configuration for extracting information from media in documents
|
3444
|
+
# for the data source.
|
3445
|
+
# @return [Types::MediaExtractionConfiguration]
|
3446
|
+
#
|
3236
3447
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetDataSourceResponse AWS API Documentation
|
3237
3448
|
#
|
3238
3449
|
class GetDataSourceResponse < Struct.new(
|
@@ -3251,7 +3462,8 @@ module Aws::QBusiness
|
|
3251
3462
|
:sync_schedule,
|
3252
3463
|
:role_arn,
|
3253
3464
|
:error,
|
3254
|
-
:document_enrichment_configuration
|
3465
|
+
:document_enrichment_configuration,
|
3466
|
+
:media_extraction_configuration)
|
3255
3467
|
SENSITIVE = []
|
3256
3468
|
include Aws::Structure
|
3257
3469
|
end
|
@@ -3332,10 +3544,6 @@ module Aws::QBusiness
|
|
3332
3544
|
# The name of the Amazon Q Business index.
|
3333
3545
|
# @return [String]
|
3334
3546
|
#
|
3335
|
-
# @!attribute [rw] type
|
3336
|
-
# The type of index attached to your Amazon Q Business application.
|
3337
|
-
# @return [String]
|
3338
|
-
#
|
3339
3547
|
# @!attribute [rw] index_arn
|
3340
3548
|
# The Amazon Resource Name (ARN) of the Amazon Q Business index.
|
3341
3549
|
# @return [String]
|
@@ -3346,6 +3554,10 @@ module Aws::QBusiness
|
|
3346
3554
|
# `ErrorMessage` field contains a message that explains why.
|
3347
3555
|
# @return [String]
|
3348
3556
|
#
|
3557
|
+
# @!attribute [rw] type
|
3558
|
+
# The type of index attached to your Amazon Q Business application.
|
3559
|
+
# @return [String]
|
3560
|
+
#
|
3349
3561
|
# @!attribute [rw] description
|
3350
3562
|
# The description for the Amazon Q Business index.
|
3351
3563
|
# @return [String]
|
@@ -3389,9 +3601,9 @@ module Aws::QBusiness
|
|
3389
3601
|
:application_id,
|
3390
3602
|
:index_id,
|
3391
3603
|
:display_name,
|
3392
|
-
:type,
|
3393
3604
|
:index_arn,
|
3394
3605
|
:status,
|
3606
|
+
:type,
|
3395
3607
|
:description,
|
3396
3608
|
:created_at,
|
3397
3609
|
:updated_at,
|
@@ -3403,6 +3615,53 @@ module Aws::QBusiness
|
|
3403
3615
|
include Aws::Structure
|
3404
3616
|
end
|
3405
3617
|
|
3618
|
+
# @!attribute [rw] application_id
|
3619
|
+
# The identifier of the Amazon Q Business which contains the media
|
3620
|
+
# object.
|
3621
|
+
# @return [String]
|
3622
|
+
#
|
3623
|
+
# @!attribute [rw] conversation_id
|
3624
|
+
# The identifier of the Amazon Q Business conversation.
|
3625
|
+
# @return [String]
|
3626
|
+
#
|
3627
|
+
# @!attribute [rw] message_id
|
3628
|
+
# The identifier of the Amazon Q Business message.
|
3629
|
+
# @return [String]
|
3630
|
+
#
|
3631
|
+
# @!attribute [rw] media_id
|
3632
|
+
# The identifier of the media object. You can find this in the
|
3633
|
+
# `sourceAttributions` returned by the `Chat`, `ChatSync`, and
|
3634
|
+
# `ListMessages` API responses.
|
3635
|
+
# @return [String]
|
3636
|
+
#
|
3637
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetMediaRequest AWS API Documentation
|
3638
|
+
#
|
3639
|
+
class GetMediaRequest < Struct.new(
|
3640
|
+
:application_id,
|
3641
|
+
:conversation_id,
|
3642
|
+
:message_id,
|
3643
|
+
:media_id)
|
3644
|
+
SENSITIVE = []
|
3645
|
+
include Aws::Structure
|
3646
|
+
end
|
3647
|
+
|
3648
|
+
# @!attribute [rw] media_bytes
|
3649
|
+
# The base64-encoded bytes of the media object.
|
3650
|
+
# @return [String]
|
3651
|
+
#
|
3652
|
+
# @!attribute [rw] media_mime_type
|
3653
|
+
# The MIME type of the media object (image/png).
|
3654
|
+
# @return [String]
|
3655
|
+
#
|
3656
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetMediaResponse AWS API Documentation
|
3657
|
+
#
|
3658
|
+
class GetMediaResponse < Struct.new(
|
3659
|
+
:media_bytes,
|
3660
|
+
:media_mime_type)
|
3661
|
+
SENSITIVE = []
|
3662
|
+
include Aws::Structure
|
3663
|
+
end
|
3664
|
+
|
3406
3665
|
# @!attribute [rw] application_id
|
3407
3666
|
# The identifier of the application which contains the plugin.
|
3408
3667
|
# @return [String]
|
@@ -3697,6 +3956,11 @@ module Aws::QBusiness
|
|
3697
3956
|
# connector to fail.
|
3698
3957
|
# @return [Types::ErrorDetail]
|
3699
3958
|
#
|
3959
|
+
# @!attribute [rw] browser_extension_configuration
|
3960
|
+
# The browser extension configuration for an Amazon Q Business web
|
3961
|
+
# experience.
|
3962
|
+
# @return [Types::BrowserExtensionConfiguration]
|
3963
|
+
#
|
3700
3964
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GetWebExperienceResponse AWS API Documentation
|
3701
3965
|
#
|
3702
3966
|
class GetWebExperienceResponse < Struct.new(
|
@@ -3715,7 +3979,8 @@ module Aws::QBusiness
|
|
3715
3979
|
:role_arn,
|
3716
3980
|
:identity_provider_configuration,
|
3717
3981
|
:authentication_configuration,
|
3718
|
-
:error
|
3982
|
+
:error,
|
3983
|
+
:browser_extension_configuration)
|
3719
3984
|
SENSITIVE = []
|
3720
3985
|
include Aws::Structure
|
3721
3986
|
end
|
@@ -3735,11 +4000,17 @@ module Aws::QBusiness
|
|
3735
4000
|
# interns all belong to the "Interns" group.
|
3736
4001
|
# @return [Array<Types::MemberUser>]
|
3737
4002
|
#
|
4003
|
+
# @!attribute [rw] s3_path_for_group_members
|
4004
|
+
# Information required for Amazon Q Business to find a specific file
|
4005
|
+
# in an Amazon S3 bucket.
|
4006
|
+
# @return [Types::S3]
|
4007
|
+
#
|
3738
4008
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/GroupMembers AWS API Documentation
|
3739
4009
|
#
|
3740
4010
|
class GroupMembers < Struct.new(
|
3741
4011
|
:member_groups,
|
3742
|
-
:member_users
|
4012
|
+
:member_users,
|
4013
|
+
:s3_path_for_group_members)
|
3743
4014
|
SENSITIVE = []
|
3744
4015
|
include Aws::Structure
|
3745
4016
|
end
|
@@ -3883,6 +4154,27 @@ module Aws::QBusiness
|
|
3883
4154
|
class Unknown < IdentityProviderConfiguration; end
|
3884
4155
|
end
|
3885
4156
|
|
4157
|
+
# The configuration for extracting semantic meaning from images in
|
4158
|
+
# documents. For more information, see [Extracting semantic meaning from
|
4159
|
+
# images and visuals][1].
|
4160
|
+
#
|
4161
|
+
#
|
4162
|
+
#
|
4163
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html
|
4164
|
+
#
|
4165
|
+
# @!attribute [rw] image_extraction_status
|
4166
|
+
# Specify whether to extract semantic meaning from images and visuals
|
4167
|
+
# from documents.
|
4168
|
+
# @return [String]
|
4169
|
+
#
|
4170
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ImageExtractionConfiguration AWS API Documentation
|
4171
|
+
#
|
4172
|
+
class ImageExtractionConfiguration < Struct.new(
|
4173
|
+
:image_extraction_status)
|
4174
|
+
SENSITIVE = []
|
4175
|
+
include Aws::Structure
|
4176
|
+
end
|
4177
|
+
|
3886
4178
|
# Summary information for your Amazon Q Business index.
|
3887
4179
|
#
|
3888
4180
|
# @!attribute [rw] display_name
|
@@ -4112,6 +4404,61 @@ module Aws::QBusiness
|
|
4112
4404
|
include Aws::Structure
|
4113
4405
|
end
|
4114
4406
|
|
4407
|
+
# @!attribute [rw] application_id
|
4408
|
+
# The unique identifier for the Amazon Q Business application.
|
4409
|
+
# @return [String]
|
4410
|
+
#
|
4411
|
+
# @!attribute [rw] conversation_id
|
4412
|
+
# The unique identifier of the Amazon Q Business web experience
|
4413
|
+
# conversation.
|
4414
|
+
# @return [String]
|
4415
|
+
#
|
4416
|
+
# @!attribute [rw] user_id
|
4417
|
+
# The unique identifier of the user involved in the Amazon Q Business
|
4418
|
+
# web experience conversation.
|
4419
|
+
# @return [String]
|
4420
|
+
#
|
4421
|
+
# @!attribute [rw] next_token
|
4422
|
+
# If the number of attachments returned exceeds `maxResults`, Amazon Q
|
4423
|
+
# Business returns a next token as a pagination token to retrieve the
|
4424
|
+
# next set of attachments.
|
4425
|
+
# @return [String]
|
4426
|
+
#
|
4427
|
+
# @!attribute [rw] max_results
|
4428
|
+
# The maximum number of attachements to return.
|
4429
|
+
# @return [Integer]
|
4430
|
+
#
|
4431
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListAttachmentsRequest AWS API Documentation
|
4432
|
+
#
|
4433
|
+
class ListAttachmentsRequest < Struct.new(
|
4434
|
+
:application_id,
|
4435
|
+
:conversation_id,
|
4436
|
+
:user_id,
|
4437
|
+
:next_token,
|
4438
|
+
:max_results)
|
4439
|
+
SENSITIVE = []
|
4440
|
+
include Aws::Structure
|
4441
|
+
end
|
4442
|
+
|
4443
|
+
# @!attribute [rw] attachments
|
4444
|
+
# An array of information on one or more attachments.
|
4445
|
+
# @return [Array<Types::Attachment>]
|
4446
|
+
#
|
4447
|
+
# @!attribute [rw] next_token
|
4448
|
+
# If the response is truncated, Amazon Q Business returns this token,
|
4449
|
+
# which you can use in a later request to list the next set of
|
4450
|
+
# attachments.
|
4451
|
+
# @return [String]
|
4452
|
+
#
|
4453
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/ListAttachmentsResponse AWS API Documentation
|
4454
|
+
#
|
4455
|
+
class ListAttachmentsResponse < Struct.new(
|
4456
|
+
:attachments,
|
4457
|
+
:next_token)
|
4458
|
+
SENSITIVE = []
|
4459
|
+
include Aws::Structure
|
4460
|
+
end
|
4461
|
+
|
4115
4462
|
# @!attribute [rw] application_id
|
4116
4463
|
# The identifier of the Amazon Q Business application.
|
4117
4464
|
# @return [String]
|
@@ -4465,7 +4812,7 @@ module Aws::QBusiness
|
|
4465
4812
|
# @return [String]
|
4466
4813
|
#
|
4467
4814
|
# @!attribute [rw] next_token
|
4468
|
-
# If the number of
|
4815
|
+
# If the number of messages returned exceeds `maxResults`, Amazon Q
|
4469
4816
|
# Business returns a next token as a pagination token to retrieve the
|
4470
4817
|
# next set of messages.
|
4471
4818
|
# @return [String]
|
@@ -4666,6 +5013,39 @@ module Aws::QBusiness
|
|
4666
5013
|
include Aws::Structure
|
4667
5014
|
end
|
4668
5015
|
|
5016
|
+
# The configuration for extracting information from media in documents.
|
5017
|
+
#
|
5018
|
+
# @!attribute [rw] image_extraction_configuration
|
5019
|
+
# The configuration for extracting semantic meaning from images in
|
5020
|
+
# documents. For more information, see [Extracting semantic meaning
|
5021
|
+
# from images and visuals][1].
|
5022
|
+
#
|
5023
|
+
#
|
5024
|
+
#
|
5025
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html
|
5026
|
+
# @return [Types::ImageExtractionConfiguration]
|
5027
|
+
#
|
5028
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/MediaExtractionConfiguration AWS API Documentation
|
5029
|
+
#
|
5030
|
+
class MediaExtractionConfiguration < Struct.new(
|
5031
|
+
:image_extraction_configuration)
|
5032
|
+
SENSITIVE = []
|
5033
|
+
include Aws::Structure
|
5034
|
+
end
|
5035
|
+
|
5036
|
+
# The requested media object is too large to be returned.
|
5037
|
+
#
|
5038
|
+
# @!attribute [rw] message
|
5039
|
+
# @return [String]
|
5040
|
+
#
|
5041
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/MediaTooLargeException AWS API Documentation
|
5042
|
+
#
|
5043
|
+
class MediaTooLargeException < Struct.new(
|
5044
|
+
:message)
|
5045
|
+
SENSITIVE = []
|
5046
|
+
include Aws::Structure
|
5047
|
+
end
|
5048
|
+
|
4669
5049
|
# The sub groups that belong to a group.
|
4670
5050
|
#
|
4671
5051
|
# @!attribute [rw] group_name
|
@@ -5215,6 +5595,13 @@ module Aws::QBusiness
|
|
5215
5595
|
# has access to.
|
5216
5596
|
# @return [Types::GroupMembers]
|
5217
5597
|
#
|
5598
|
+
# @!attribute [rw] role_arn
|
5599
|
+
# The Amazon Resource Name (ARN) of an IAM role that has access to the
|
5600
|
+
# S3 file that contains your list of users that belong to a group.The
|
5601
|
+
# Amazon Resource Name (ARN) of an IAM role that has access to the S3
|
5602
|
+
# file that contains your list of users that belong to a group.
|
5603
|
+
# @return [String]
|
5604
|
+
#
|
5218
5605
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/PutGroupRequest AWS API Documentation
|
5219
5606
|
#
|
5220
5607
|
class PutGroupRequest < Struct.new(
|
@@ -5223,7 +5610,8 @@ module Aws::QBusiness
|
|
5223
5610
|
:group_name,
|
5224
5611
|
:data_source_id,
|
5225
5612
|
:type,
|
5226
|
-
:group_members
|
5613
|
+
:group_members,
|
5614
|
+
:role_arn)
|
5227
5615
|
SENSITIVE = []
|
5228
5616
|
include Aws::Structure
|
5229
5617
|
end
|
@@ -5825,12 +6213,24 @@ module Aws::QBusiness
|
|
5825
6213
|
# citation text segment in an Amazon Q Business chat response.
|
5826
6214
|
# @return [Types::SnippetExcerpt]
|
5827
6215
|
#
|
6216
|
+
# @!attribute [rw] media_id
|
6217
|
+
# The identifier of the media object associated with the text segment
|
6218
|
+
# in the source attribution.
|
6219
|
+
# @return [String]
|
6220
|
+
#
|
6221
|
+
# @!attribute [rw] media_mime_type
|
6222
|
+
# The MIME type (image/png) of the media object associated with the
|
6223
|
+
# text segment in the source attribution.
|
6224
|
+
# @return [String]
|
6225
|
+
#
|
5828
6226
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/TextSegment AWS API Documentation
|
5829
6227
|
#
|
5830
6228
|
class TextSegment < Struct.new(
|
5831
6229
|
:begin_offset,
|
5832
6230
|
:end_offset,
|
5833
|
-
:snippet_excerpt
|
6231
|
+
:snippet_excerpt,
|
6232
|
+
:media_id,
|
6233
|
+
:media_mime_type)
|
5834
6234
|
SENSITIVE = []
|
5835
6235
|
include Aws::Structure
|
5836
6236
|
end
|
@@ -6080,6 +6480,11 @@ module Aws::QBusiness
|
|
6080
6480
|
# [1]: https://docs.aws.amazon.com/amazonq/latest/business-use-dg/custom-document-enrichment.html
|
6081
6481
|
# @return [Types::DocumentEnrichmentConfiguration]
|
6082
6482
|
#
|
6483
|
+
# @!attribute [rw] media_extraction_configuration
|
6484
|
+
# The configuration for extracting information from media in documents
|
6485
|
+
# for your data source.
|
6486
|
+
# @return [Types::MediaExtractionConfiguration]
|
6487
|
+
#
|
6083
6488
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateDataSourceRequest AWS API Documentation
|
6084
6489
|
#
|
6085
6490
|
class UpdateDataSourceRequest < Struct.new(
|
@@ -6092,7 +6497,8 @@ module Aws::QBusiness
|
|
6092
6497
|
:description,
|
6093
6498
|
:sync_schedule,
|
6094
6499
|
:role_arn,
|
6095
|
-
:document_enrichment_configuration
|
6500
|
+
:document_enrichment_configuration,
|
6501
|
+
:media_extraction_configuration)
|
6096
6502
|
SENSITIVE = []
|
6097
6503
|
include Aws::Structure
|
6098
6504
|
end
|
@@ -6340,6 +6746,23 @@ module Aws::QBusiness
|
|
6340
6746
|
# <code>https://docs.aws.amazon.com</code>.</p> </li> </ul> </note>
|
6341
6747
|
# @return [Array<String>]
|
6342
6748
|
#
|
6749
|
+
# @!attribute [rw] browser_extension_configuration
|
6750
|
+
# The browser extension configuration for an Amazon Q Business web
|
6751
|
+
# experience.
|
6752
|
+
#
|
6753
|
+
# <note markdown="1"> For Amazon Q Business application using external OIDC-compliant
|
6754
|
+
# identity providers (IdPs). The IdP administrator must add the
|
6755
|
+
# browser extension sign-in redirect URLs to the IdP application. For
|
6756
|
+
# more information, see [Configure external OIDC identity provider for
|
6757
|
+
# your browser extensions.][1].
|
6758
|
+
#
|
6759
|
+
# </note>
|
6760
|
+
#
|
6761
|
+
#
|
6762
|
+
#
|
6763
|
+
# [1]: https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/browser-extensions.html
|
6764
|
+
# @return [Types::BrowserExtensionConfiguration]
|
6765
|
+
#
|
6343
6766
|
# @see http://docs.aws.amazon.com/goto/WebAPI/qbusiness-2023-11-27/UpdateWebExperienceRequest AWS API Documentation
|
6344
6767
|
#
|
6345
6768
|
class UpdateWebExperienceRequest < Struct.new(
|
@@ -6352,7 +6775,8 @@ module Aws::QBusiness
|
|
6352
6775
|
:welcome_message,
|
6353
6776
|
:sample_prompts_control_mode,
|
6354
6777
|
:identity_provider_configuration,
|
6355
|
-
:origins
|
6778
|
+
:origins,
|
6779
|
+
:browser_extension_configuration)
|
6356
6780
|
SENSITIVE = []
|
6357
6781
|
include Aws::Structure
|
6358
6782
|
end
|