@aws-sdk/client-qbusiness 3.554.0 → 3.557.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.
- package/README.md +15 -16
- package/dist-cjs/index.js +36 -5
- package/dist-es/models/models_0.js +17 -0
- package/dist-es/protocols/Aws_restJson1.js +13 -5
- package/dist-types/QBusiness.d.ts +15 -16
- package/dist-types/QBusinessClient.d.ts +15 -16
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +3 -3
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +7 -7
- package/dist-types/commands/ChatSyncCommand.d.ts +10 -4
- package/dist-types/commands/CreateApplicationCommand.d.ts +5 -4
- package/dist-types/commands/CreateDataSourceCommand.d.ts +4 -4
- package/dist-types/commands/CreateIndexCommand.d.ts +4 -4
- package/dist-types/commands/CreatePluginCommand.d.ts +4 -4
- package/dist-types/commands/CreateRetrieverCommand.d.ts +4 -4
- package/dist-types/commands/CreateUserCommand.d.ts +3 -3
- package/dist-types/commands/CreateWebExperienceCommand.d.ts +5 -4
- package/dist-types/commands/DeleteApplicationCommand.d.ts +3 -3
- package/dist-types/commands/DeleteChatControlsConfigurationCommand.d.ts +3 -3
- package/dist-types/commands/DeleteConversationCommand.d.ts +4 -4
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +3 -3
- package/dist-types/commands/DeleteGroupCommand.d.ts +2 -2
- package/dist-types/commands/DeleteIndexCommand.d.ts +3 -3
- package/dist-types/commands/DeletePluginCommand.d.ts +3 -3
- package/dist-types/commands/DeleteRetrieverCommand.d.ts +3 -3
- package/dist-types/commands/DeleteUserCommand.d.ts +2 -2
- package/dist-types/commands/DeleteWebExperienceCommand.d.ts +3 -3
- package/dist-types/commands/GetApplicationCommand.d.ts +4 -3
- package/dist-types/commands/GetChatControlsConfigurationCommand.d.ts +6 -3
- package/dist-types/commands/GetDataSourceCommand.d.ts +3 -3
- package/dist-types/commands/GetGroupCommand.d.ts +2 -2
- package/dist-types/commands/GetIndexCommand.d.ts +3 -3
- package/dist-types/commands/GetPluginCommand.d.ts +3 -3
- package/dist-types/commands/GetRetrieverCommand.d.ts +3 -3
- package/dist-types/commands/GetUserCommand.d.ts +2 -2
- package/dist-types/commands/GetWebExperienceCommand.d.ts +4 -3
- package/dist-types/commands/ListApplicationsCommand.d.ts +3 -3
- package/dist-types/commands/ListConversationsCommand.d.ts +4 -4
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +3 -3
- package/dist-types/commands/ListDataSourcesCommand.d.ts +3 -3
- package/dist-types/commands/ListDocumentsCommand.d.ts +2 -2
- package/dist-types/commands/ListGroupsCommand.d.ts +2 -2
- package/dist-types/commands/ListIndicesCommand.d.ts +3 -3
- package/dist-types/commands/ListMessagesCommand.d.ts +4 -4
- package/dist-types/commands/ListPluginsCommand.d.ts +3 -3
- package/dist-types/commands/ListRetrieversCommand.d.ts +3 -3
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +3 -3
- package/dist-types/commands/ListWebExperiencesCommand.d.ts +3 -3
- package/dist-types/commands/PutFeedbackCommand.d.ts +4 -4
- package/dist-types/commands/PutGroupCommand.d.ts +4 -4
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +4 -4
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +3 -3
- package/dist-types/commands/TagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
- package/dist-types/commands/UpdateApplicationCommand.d.ts +3 -3
- package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +7 -4
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +3 -3
- package/dist-types/commands/UpdateIndexCommand.d.ts +4 -4
- package/dist-types/commands/UpdatePluginCommand.d.ts +4 -4
- package/dist-types/commands/UpdateRetrieverCommand.d.ts +4 -4
- package/dist-types/commands/UpdateUserCommand.d.ts +3 -3
- package/dist-types/commands/UpdateWebExperienceCommand.d.ts +3 -3
- package/dist-types/index.d.ts +15 -16
- package/dist-types/models/models_0.d.ts +491 -320
- package/dist-types/ts3.4/models/models_0.d.ts +52 -5
- package/package.json +4 -4
|
@@ -81,7 +81,7 @@ export interface PrincipalUser {
|
|
|
81
81
|
}
|
|
82
82
|
/**
|
|
83
83
|
* <p>Provides user and group information used for filtering documents to use for generating
|
|
84
|
-
* Amazon Q conversation responses.</p>
|
|
84
|
+
* Amazon Q Business conversation responses.</p>
|
|
85
85
|
* @public
|
|
86
86
|
*/
|
|
87
87
|
export type Principal = Principal.GroupMember | Principal.UserMember | Principal.$UnknownMember;
|
|
@@ -183,7 +183,7 @@ export interface ActionExecutionPayloadField {
|
|
|
183
183
|
value: __DocumentType | undefined;
|
|
184
184
|
}
|
|
185
185
|
/**
|
|
186
|
-
* <p>Performs an Amazon Q plugin action during a non-streaming chat
|
|
186
|
+
* <p>Performs an Amazon Q Business plugin action during a non-streaming chat
|
|
187
187
|
* conversation.</p>
|
|
188
188
|
* @public
|
|
189
189
|
*/
|
|
@@ -195,7 +195,7 @@ export interface ActionExecution {
|
|
|
195
195
|
pluginId: string | undefined;
|
|
196
196
|
/**
|
|
197
197
|
* <p>A mapping of field names to the field values in input that an end user provides to
|
|
198
|
-
* Amazon Q requests to perform their plugin action. </p>
|
|
198
|
+
* Amazon Q Business requests to perform their plugin action. </p>
|
|
199
199
|
* @public
|
|
200
200
|
*/
|
|
201
201
|
payload: Record<string, ActionExecutionPayloadField> | undefined;
|
|
@@ -222,7 +222,7 @@ export declare const ActionPayloadFieldType: {
|
|
|
222
222
|
export type ActionPayloadFieldType = (typeof ActionPayloadFieldType)[keyof typeof ActionPayloadFieldType];
|
|
223
223
|
/**
|
|
224
224
|
* <p>Information about the field values that an end user can use to provide to
|
|
225
|
-
* Amazon Q for Amazon Q to perform the requested plugin action.</p>
|
|
225
|
+
* Amazon Q Business for Amazon Q Business to perform the requested plugin action.</p>
|
|
226
226
|
* @public
|
|
227
227
|
*/
|
|
228
228
|
export interface ActionReviewPayloadFieldAllowedValue {
|
|
@@ -264,7 +264,7 @@ export interface ActionReviewPayloadField {
|
|
|
264
264
|
value?: __DocumentType;
|
|
265
265
|
/**
|
|
266
266
|
* <p>Information about the field values that an end user can use to provide to
|
|
267
|
-
* Amazon Q for Amazon Q to perform the requested plugin action.</p>
|
|
267
|
+
* Amazon Q Business for Amazon Q Business to perform the requested plugin action.</p>
|
|
268
268
|
* @public
|
|
269
269
|
*/
|
|
270
270
|
allowedValues?: ActionReviewPayloadFieldAllowedValue[];
|
|
@@ -289,10 +289,10 @@ export declare const PluginType: {
|
|
|
289
289
|
*/
|
|
290
290
|
export type PluginType = (typeof PluginType)[keyof typeof PluginType];
|
|
291
291
|
/**
|
|
292
|
-
* <p>An output event that Amazon Q returns to an user who wants to perform a plugin
|
|
292
|
+
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin
|
|
293
293
|
* action during a non-streaming chat conversation. It contains information about the
|
|
294
294
|
* selected action with a list of possible user input fields, some pre-populated by
|
|
295
|
-
* Amazon Q.</p>
|
|
295
|
+
* Amazon Q Business.</p>
|
|
296
296
|
* @public
|
|
297
297
|
*/
|
|
298
298
|
export interface ActionReview {
|
|
@@ -307,7 +307,7 @@ export interface ActionReview {
|
|
|
307
307
|
*/
|
|
308
308
|
pluginType?: PluginType;
|
|
309
309
|
/**
|
|
310
|
-
* <p>Field values that an end user needs to provide to Amazon Q for Amazon Q to
|
|
310
|
+
* <p>Field values that an end user needs to provide to Amazon Q Business for Amazon Q Business to
|
|
311
311
|
* perform the requested plugin action.</p>
|
|
312
312
|
* @public
|
|
313
313
|
*/
|
|
@@ -335,32 +335,32 @@ export declare const ApplicationStatus: {
|
|
|
335
335
|
*/
|
|
336
336
|
export type ApplicationStatus = (typeof ApplicationStatus)[keyof typeof ApplicationStatus];
|
|
337
337
|
/**
|
|
338
|
-
* <p>Summary information for an Amazon Q application.</p>
|
|
338
|
+
* <p>Summary information for an Amazon Q Business application.</p>
|
|
339
339
|
* @public
|
|
340
340
|
*/
|
|
341
341
|
export interface Application {
|
|
342
342
|
/**
|
|
343
|
-
* <p>The name of the Amazon Q application.</p>
|
|
343
|
+
* <p>The name of the Amazon Q Business application.</p>
|
|
344
344
|
* @public
|
|
345
345
|
*/
|
|
346
346
|
displayName?: string;
|
|
347
347
|
/**
|
|
348
|
-
* <p>The identifier for the Amazon Q application.</p>
|
|
348
|
+
* <p>The identifier for the Amazon Q Business application.</p>
|
|
349
349
|
* @public
|
|
350
350
|
*/
|
|
351
351
|
applicationId?: string;
|
|
352
352
|
/**
|
|
353
|
-
* <p>The Unix timestamp when the Amazon Q application was created.</p>
|
|
353
|
+
* <p>The Unix timestamp when the Amazon Q Business application was created.</p>
|
|
354
354
|
* @public
|
|
355
355
|
*/
|
|
356
356
|
createdAt?: Date;
|
|
357
357
|
/**
|
|
358
|
-
* <p>The Unix timestamp when the Amazon Q application was last updated. </p>
|
|
358
|
+
* <p>The Unix timestamp when the Amazon Q Business application was last updated. </p>
|
|
359
359
|
* @public
|
|
360
360
|
*/
|
|
361
361
|
updatedAt?: Date;
|
|
362
362
|
/**
|
|
363
|
-
* <p>The status of the Amazon Q application. The application is ready to use when the
|
|
363
|
+
* <p>The status of the Amazon Q Business application. The application is ready to use when the
|
|
364
364
|
* status is <code>ACTIVE</code>.</p>
|
|
365
365
|
* @public
|
|
366
366
|
*/
|
|
@@ -415,12 +415,12 @@ export interface AttachmentsConfiguration {
|
|
|
415
415
|
}
|
|
416
416
|
/**
|
|
417
417
|
* <p>Provides the identifier of the KMS key used to encrypt data indexed by
|
|
418
|
-
* Amazon Q. Amazon Q doesn't support asymmetric keys.</p>
|
|
418
|
+
* Amazon Q Business. Amazon Q Business doesn't support asymmetric keys.</p>
|
|
419
419
|
* @public
|
|
420
420
|
*/
|
|
421
421
|
export interface EncryptionConfiguration {
|
|
422
422
|
/**
|
|
423
|
-
* <p>The identifier of the KMS key. Amazon Q doesn't support asymmetric
|
|
423
|
+
* <p>The identifier of the KMS key. Amazon Q Business doesn't support asymmetric
|
|
424
424
|
* keys.</p>
|
|
425
425
|
* @public
|
|
426
426
|
*/
|
|
@@ -435,7 +435,7 @@ export interface EncryptionConfiguration {
|
|
|
435
435
|
export interface Tag {
|
|
436
436
|
/**
|
|
437
437
|
* <p> The key for the tag. Keys are not case sensitive and must be unique for the
|
|
438
|
-
* Amazon Q application or data source.</p>
|
|
438
|
+
* Amazon Q Business application or data source.</p>
|
|
439
439
|
* @public
|
|
440
440
|
*/
|
|
441
441
|
key: string | undefined;
|
|
@@ -451,7 +451,7 @@ export interface Tag {
|
|
|
451
451
|
*/
|
|
452
452
|
export interface CreateApplicationRequest {
|
|
453
453
|
/**
|
|
454
|
-
* <p>A name for the Amazon Q application. </p>
|
|
454
|
+
* <p>A name for the Amazon Q Business application. </p>
|
|
455
455
|
* @public
|
|
456
456
|
*/
|
|
457
457
|
displayName: string | undefined;
|
|
@@ -462,18 +462,24 @@ export interface CreateApplicationRequest {
|
|
|
462
462
|
*/
|
|
463
463
|
roleArn: string | undefined;
|
|
464
464
|
/**
|
|
465
|
-
* <p>
|
|
465
|
+
* <p> The Amazon Resource Name (ARN) of the IAM Identity Center instance you are either
|
|
466
|
+
* creating for—or connecting to—your Amazon Q Business application.</p>
|
|
467
|
+
* @public
|
|
468
|
+
*/
|
|
469
|
+
identityCenterInstanceArn?: string;
|
|
470
|
+
/**
|
|
471
|
+
* <p>A description for the Amazon Q Business application. </p>
|
|
466
472
|
* @public
|
|
467
473
|
*/
|
|
468
474
|
description?: string;
|
|
469
475
|
/**
|
|
470
476
|
* <p>The identifier of the KMS key that is used to encrypt your data.
|
|
471
|
-
* Amazon Q doesn't support asymmetric keys.</p>
|
|
477
|
+
* Amazon Q Business doesn't support asymmetric keys.</p>
|
|
472
478
|
* @public
|
|
473
479
|
*/
|
|
474
480
|
encryptionConfiguration?: EncryptionConfiguration;
|
|
475
481
|
/**
|
|
476
|
-
* <p>A list of key-value pairs that identify or categorize your Amazon Q application.
|
|
482
|
+
* <p>A list of key-value pairs that identify or categorize your Amazon Q Business application.
|
|
477
483
|
* You can also use tags to help control access to the application. Tag keys and values can
|
|
478
484
|
* consist of Unicode letters, digits, white space, and any of the following symbols: _ . :
|
|
479
485
|
* / = + - @.</p>
|
|
@@ -481,7 +487,7 @@ export interface CreateApplicationRequest {
|
|
|
481
487
|
*/
|
|
482
488
|
tags?: Tag[];
|
|
483
489
|
/**
|
|
484
|
-
* <p>A token that you provide to identify the request to create your Amazon Q
|
|
490
|
+
* <p>A token that you provide to identify the request to create your Amazon Q Business
|
|
485
491
|
* application.</p>
|
|
486
492
|
* @public
|
|
487
493
|
*/
|
|
@@ -497,18 +503,18 @@ export interface CreateApplicationRequest {
|
|
|
497
503
|
*/
|
|
498
504
|
export interface CreateApplicationResponse {
|
|
499
505
|
/**
|
|
500
|
-
* <p>The identifier of the Amazon Q application.</p>
|
|
506
|
+
* <p>The identifier of the Amazon Q Business application.</p>
|
|
501
507
|
* @public
|
|
502
508
|
*/
|
|
503
509
|
applicationId?: string;
|
|
504
510
|
/**
|
|
505
|
-
* <p> The Amazon Resource Name (ARN) of the Amazon Q application. </p>
|
|
511
|
+
* <p> The Amazon Resource Name (ARN) of the Amazon Q Business application. </p>
|
|
506
512
|
* @public
|
|
507
513
|
*/
|
|
508
514
|
applicationArn?: string;
|
|
509
515
|
}
|
|
510
516
|
/**
|
|
511
|
-
* <p>An issue occurred with the internal server used for your Amazon Q service. Wait
|
|
517
|
+
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait
|
|
512
518
|
* some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
513
519
|
* @public
|
|
514
520
|
*/
|
|
@@ -544,7 +550,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
544
550
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
545
551
|
}
|
|
546
552
|
/**
|
|
547
|
-
* <p>You have exceeded the set limits for your Amazon Q service. </p>
|
|
553
|
+
* <p>You have exceeded the set limits for your Amazon Q Business service. </p>
|
|
548
554
|
* @public
|
|
549
555
|
*/
|
|
550
556
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
@@ -579,7 +585,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
579
585
|
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
580
586
|
}
|
|
581
587
|
/**
|
|
582
|
-
* <p>The input failed to meet the constraints specified by Amazon Q in a specified
|
|
588
|
+
* <p>The input failed to meet the constraints specified by Amazon Q Business in a specified
|
|
583
589
|
* field.</p>
|
|
584
590
|
* @public
|
|
585
591
|
*/
|
|
@@ -609,7 +615,7 @@ export declare const ValidationExceptionReason: {
|
|
|
609
615
|
*/
|
|
610
616
|
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
611
617
|
/**
|
|
612
|
-
* <p>The input doesn't meet the constraints set by the Amazon Q service. Provide the
|
|
618
|
+
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the
|
|
613
619
|
* correct input and try again.</p>
|
|
614
620
|
* @public
|
|
615
621
|
*/
|
|
@@ -636,7 +642,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
636
642
|
*/
|
|
637
643
|
export interface DeleteApplicationRequest {
|
|
638
644
|
/**
|
|
639
|
-
* <p>The identifier of the Amazon Q application.</p>
|
|
645
|
+
* <p>The identifier of the Amazon Q Business application.</p>
|
|
640
646
|
* @public
|
|
641
647
|
*/
|
|
642
648
|
applicationId: string | undefined;
|
|
@@ -651,7 +657,7 @@ export interface DeleteApplicationResponse {
|
|
|
651
657
|
*/
|
|
652
658
|
export interface GetApplicationRequest {
|
|
653
659
|
/**
|
|
654
|
-
* <p>The identifier of the Amazon Q application.</p>
|
|
660
|
+
* <p>The identifier of the Amazon Q Business application.</p>
|
|
655
661
|
* @public
|
|
656
662
|
*/
|
|
657
663
|
applicationId: string | undefined;
|
|
@@ -704,20 +710,26 @@ export interface ErrorDetail {
|
|
|
704
710
|
*/
|
|
705
711
|
export interface GetApplicationResponse {
|
|
706
712
|
/**
|
|
707
|
-
* <p>The name of the Amazon Q application.</p>
|
|
713
|
+
* <p>The name of the Amazon Q Business application.</p>
|
|
708
714
|
* @public
|
|
709
715
|
*/
|
|
710
716
|
displayName?: string;
|
|
711
717
|
/**
|
|
712
|
-
* <p>The identifier of the Amazon Q application.</p>
|
|
718
|
+
* <p>The identifier of the Amazon Q Business application.</p>
|
|
713
719
|
* @public
|
|
714
720
|
*/
|
|
715
721
|
applicationId?: string;
|
|
716
722
|
/**
|
|
717
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q application.</p>
|
|
723
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application.</p>
|
|
718
724
|
* @public
|
|
719
725
|
*/
|
|
720
726
|
applicationArn?: string;
|
|
727
|
+
/**
|
|
728
|
+
* <p>The Amazon Resource Name (ARN) of the AWS IAM Identity Center instance attached to
|
|
729
|
+
* your Amazon Q Business application.</p>
|
|
730
|
+
* @public
|
|
731
|
+
*/
|
|
732
|
+
identityCenterApplicationArn?: string;
|
|
721
733
|
/**
|
|
722
734
|
* <p>The Amazon Resource Name (ARN) of the IAM with permissions to access
|
|
723
735
|
* your CloudWatch logs and metrics.</p>
|
|
@@ -725,29 +737,29 @@ export interface GetApplicationResponse {
|
|
|
725
737
|
*/
|
|
726
738
|
roleArn?: string;
|
|
727
739
|
/**
|
|
728
|
-
* <p>The status of the Amazon Q application.</p>
|
|
740
|
+
* <p>The status of the Amazon Q Business application.</p>
|
|
729
741
|
* @public
|
|
730
742
|
*/
|
|
731
743
|
status?: ApplicationStatus;
|
|
732
744
|
/**
|
|
733
|
-
* <p>A description for the Amazon Q application.</p>
|
|
745
|
+
* <p>A description for the Amazon Q Business application.</p>
|
|
734
746
|
* @public
|
|
735
747
|
*/
|
|
736
748
|
description?: string;
|
|
737
749
|
/**
|
|
738
750
|
* <p>The identifier of the Amazon Web Services
|
|
739
|
-
* KMS key that is used to encrypt your data. Amazon Q doesn't support
|
|
751
|
+
* KMS key that is used to encrypt your data. Amazon Q Business doesn't support
|
|
740
752
|
* asymmetric keys.</p>
|
|
741
753
|
* @public
|
|
742
754
|
*/
|
|
743
755
|
encryptionConfiguration?: EncryptionConfiguration;
|
|
744
756
|
/**
|
|
745
|
-
* <p>The Unix timestamp when the Amazon Q application was last updated.</p>
|
|
757
|
+
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
746
758
|
* @public
|
|
747
759
|
*/
|
|
748
760
|
createdAt?: Date;
|
|
749
761
|
/**
|
|
750
|
-
* <p>The Unix timestamp when the Amazon Q application was last updated.</p>
|
|
762
|
+
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
751
763
|
* @public
|
|
752
764
|
*/
|
|
753
765
|
updatedAt?: Date;
|
|
@@ -770,7 +782,7 @@ export interface GetApplicationResponse {
|
|
|
770
782
|
*/
|
|
771
783
|
export interface IndexCapacityConfiguration {
|
|
772
784
|
/**
|
|
773
|
-
* <p>The number of storage units configured for an Amazon Q index.</p>
|
|
785
|
+
* <p>The number of storage units configured for an Amazon Q Business index.</p>
|
|
774
786
|
* @public
|
|
775
787
|
*/
|
|
776
788
|
units?: number;
|
|
@@ -780,17 +792,17 @@ export interface IndexCapacityConfiguration {
|
|
|
780
792
|
*/
|
|
781
793
|
export interface CreateIndexRequest {
|
|
782
794
|
/**
|
|
783
|
-
* <p>The identifier of the Amazon Q application using the index.</p>
|
|
795
|
+
* <p>The identifier of the Amazon Q Business application using the index.</p>
|
|
784
796
|
* @public
|
|
785
797
|
*/
|
|
786
798
|
applicationId: string | undefined;
|
|
787
799
|
/**
|
|
788
|
-
* <p>A name for the Amazon Q index.</p>
|
|
800
|
+
* <p>A name for the Amazon Q Business index.</p>
|
|
789
801
|
* @public
|
|
790
802
|
*/
|
|
791
803
|
displayName: string | undefined;
|
|
792
804
|
/**
|
|
793
|
-
* <p>A description for the Amazon Q index.</p>
|
|
805
|
+
* <p>A description for the Amazon Q Business index.</p>
|
|
794
806
|
* @public
|
|
795
807
|
*/
|
|
796
808
|
description?: string;
|
|
@@ -820,12 +832,12 @@ export interface CreateIndexRequest {
|
|
|
820
832
|
*/
|
|
821
833
|
export interface CreateIndexResponse {
|
|
822
834
|
/**
|
|
823
|
-
* <p>The identifier for the Amazon Q index.</p>
|
|
835
|
+
* <p>The identifier for the Amazon Q Business index.</p>
|
|
824
836
|
* @public
|
|
825
837
|
*/
|
|
826
838
|
indexId?: string;
|
|
827
839
|
/**
|
|
828
|
-
* <p> The Amazon Resource Name (ARN) of an Amazon Q index.</p>
|
|
840
|
+
* <p> The Amazon Resource Name (ARN) of an Amazon Q Business index.</p>
|
|
829
841
|
* @public
|
|
830
842
|
*/
|
|
831
843
|
indexArn?: string;
|
|
@@ -929,7 +941,7 @@ export declare namespace DocumentAttributeValue {
|
|
|
929
941
|
}
|
|
930
942
|
/**
|
|
931
943
|
* <p>The condition used for the target document attribute or metadata field when ingesting
|
|
932
|
-
* documents into Amazon Q. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
|
|
944
|
+
* documents into Amazon Q Business. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
|
|
933
945
|
* <code>DocumentAttributeTarget</code>
|
|
934
946
|
* </a> to apply the condition.</p>
|
|
935
947
|
* <p>For example, you can create the 'Department' target field and have it prefill
|
|
@@ -937,9 +949,9 @@ export declare namespace DocumentAttributeValue {
|
|
|
937
949
|
* field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI
|
|
938
950
|
* value, then prefill the target field 'Department' with the target value 'Finance' for
|
|
939
951
|
* the document.</p>
|
|
940
|
-
* <p>Amazon Q can't create a target field if it has not already been created as an
|
|
952
|
+
* <p>Amazon Q Business can't create a target field if it has not already been created as an
|
|
941
953
|
* index field. After you create your index field, you can create a document metadata field
|
|
942
|
-
* using <code>DocumentAttributeTarget</code>. Amazon Q then will map your newly
|
|
954
|
+
* using <code>DocumentAttributeTarget</code>. Amazon Q Business then will map your newly
|
|
943
955
|
* created metadata field to your index field.</p>
|
|
944
956
|
* @public
|
|
945
957
|
*/
|
|
@@ -948,7 +960,7 @@ export interface DocumentAttributeCondition {
|
|
|
948
960
|
* <p>The identifier of the document attribute used for the condition.</p>
|
|
949
961
|
* <p>For example, 'Source_URI' could be an identifier for the attribute or metadata field
|
|
950
962
|
* that contains source URIs associated with the documents.</p>
|
|
951
|
-
* <p>Amazon Q currently doesn't support <code>_document_body</code> as an attribute
|
|
963
|
+
* <p>Amazon Q Business currently doesn't support <code>_document_body</code> as an attribute
|
|
952
964
|
* key used for the condition.</p>
|
|
953
965
|
* @public
|
|
954
966
|
*/
|
|
@@ -993,17 +1005,17 @@ export declare const AttributeValueOperator: {
|
|
|
993
1005
|
export type AttributeValueOperator = (typeof AttributeValueOperator)[keyof typeof AttributeValueOperator];
|
|
994
1006
|
/**
|
|
995
1007
|
* <p>The target document attribute or metadata field you want to alter when ingesting
|
|
996
|
-
* documents into Amazon Q.</p>
|
|
1008
|
+
* documents into Amazon Q Business.</p>
|
|
997
1009
|
* <p>For example, you can delete all customer identification numbers associated with the
|
|
998
1010
|
* documents, stored in the document metadata field called 'Customer_ID' by setting the
|
|
999
1011
|
* target key as 'Customer_ID' and the deletion flag to <code>TRUE</code>. This removes all
|
|
1000
1012
|
* customer ID values in the field 'Customer_ID'. This would scrub personally identifiable
|
|
1001
1013
|
* information from each document's metadata.</p>
|
|
1002
|
-
* <p>Amazon Q can't create a target field if it has not already been created as an
|
|
1014
|
+
* <p>Amazon Q Business can't create a target field if it has not already been created as an
|
|
1003
1015
|
* index field. After you create your index field, you can create a document metadata field
|
|
1004
1016
|
* using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
|
|
1005
1017
|
* <code>DocumentAttributeTarget</code>
|
|
1006
|
-
* </a>. Amazon Q
|
|
1018
|
+
* </a>. Amazon Q Business
|
|
1007
1019
|
* will then map your newly created document attribute to your index field.</p>
|
|
1008
1020
|
* <p>You can also use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html">
|
|
1009
1021
|
* <code>DocumentAttributeCondition</code>
|
|
@@ -1035,7 +1047,7 @@ export interface DocumentAttributeTarget {
|
|
|
1035
1047
|
}
|
|
1036
1048
|
/**
|
|
1037
1049
|
* <p>Provides the configuration information for applying basic logic to alter document
|
|
1038
|
-
* metadata and content when ingesting documents into Amazon Q.</p>
|
|
1050
|
+
* metadata and content when ingesting documents into Amazon Q Business.</p>
|
|
1039
1051
|
* <p>To apply advanced logic, to go beyond what you can do with basic logic, see <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_HookConfiguration.html">
|
|
1040
1052
|
* <code>HookConfiguration</code>
|
|
1041
1053
|
* </a>.</p>
|
|
@@ -1045,7 +1057,7 @@ export interface DocumentAttributeTarget {
|
|
|
1045
1057
|
export interface InlineDocumentEnrichmentConfiguration {
|
|
1046
1058
|
/**
|
|
1047
1059
|
* <p>The condition used for the target document attribute or metadata field when ingesting
|
|
1048
|
-
* documents into Amazon Q. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
|
|
1060
|
+
* documents into Amazon Q Business. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
|
|
1049
1061
|
* <code>DocumentAttributeTarget</code>
|
|
1050
1062
|
* </a> to apply the condition.</p>
|
|
1051
1063
|
* <p>For example, you can create the 'Department' target field and have it prefill
|
|
@@ -1053,26 +1065,26 @@ export interface InlineDocumentEnrichmentConfiguration {
|
|
|
1053
1065
|
* field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI
|
|
1054
1066
|
* value, then prefill the target field 'Department' with the target value 'Finance' for
|
|
1055
1067
|
* the document.</p>
|
|
1056
|
-
* <p>Amazon Q can't create a target field if it has not already been created as an
|
|
1068
|
+
* <p>Amazon Q Business can't create a target field if it has not already been created as an
|
|
1057
1069
|
* index field. After you create your index field, you can create a document metadata field
|
|
1058
|
-
* using <code>DocumentAttributeTarget</code>. Amazon Q then will map your newly
|
|
1070
|
+
* using <code>DocumentAttributeTarget</code>. Amazon Q Business then will map your newly
|
|
1059
1071
|
* created metadata field to your index field.</p>
|
|
1060
1072
|
* @public
|
|
1061
1073
|
*/
|
|
1062
1074
|
condition?: DocumentAttributeCondition;
|
|
1063
1075
|
/**
|
|
1064
1076
|
* <p>The target document attribute or metadata field you want to alter when ingesting
|
|
1065
|
-
* documents into Amazon Q.</p>
|
|
1077
|
+
* documents into Amazon Q Business.</p>
|
|
1066
1078
|
* <p>For example, you can delete all customer identification numbers associated with the
|
|
1067
1079
|
* documents, stored in the document metadata field called 'Customer_ID' by setting the
|
|
1068
1080
|
* target key as 'Customer_ID' and the deletion flag to <code>TRUE</code>. This removes all
|
|
1069
1081
|
* customer ID values in the field 'Customer_ID'. This would scrub personally identifiable
|
|
1070
1082
|
* information from each document's metadata.</p>
|
|
1071
|
-
* <p>Amazon Q can't create a target field if it has not already been created as an
|
|
1083
|
+
* <p>Amazon Q Business can't create a target field if it has not already been created as an
|
|
1072
1084
|
* index field. After you create your index field, you can create a document metadata field
|
|
1073
1085
|
* using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html">
|
|
1074
1086
|
* <code>DocumentAttributeTarget</code>
|
|
1075
|
-
* </a>. Amazon Q
|
|
1087
|
+
* </a>. Amazon Q Business
|
|
1076
1088
|
* will then map your newly created document attribute to your index field.</p>
|
|
1077
1089
|
* <p>You can also use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html">
|
|
1078
1090
|
* <code>DocumentAttributeCondition</code>
|
|
@@ -1091,10 +1103,10 @@ export interface InlineDocumentEnrichmentConfiguration {
|
|
|
1091
1103
|
/**
|
|
1092
1104
|
* <p>Provides the configuration information for invoking a Lambda function in
|
|
1093
1105
|
* Lambda to alter document metadata and content when ingesting
|
|
1094
|
-
* documents into Amazon Q.</p>
|
|
1106
|
+
* documents into Amazon Q Business.</p>
|
|
1095
1107
|
* <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> if you want to apply advanced alterations on
|
|
1096
1108
|
* the original or raw documents.</p>
|
|
1097
|
-
* <p>If you want to apply advanced alterations on the Amazon Q structured documents,
|
|
1109
|
+
* <p>If you want to apply advanced alterations on the Amazon Q Business structured documents,
|
|
1098
1110
|
* you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
|
|
1099
1111
|
* <p>You can only invoke one Lambda function. However, this function can invoke
|
|
1100
1112
|
* other functions it requires.</p>
|
|
@@ -1105,7 +1117,7 @@ export interface HookConfiguration {
|
|
|
1105
1117
|
/**
|
|
1106
1118
|
* <p>The condition used for when a Lambda function should be invoked.</p>
|
|
1107
1119
|
* <p>For example, you can specify a condition that if there are empty date-time values,
|
|
1108
|
-
* then Amazon Q should invoke a function that inserts the current date-time.</p>
|
|
1120
|
+
* then Amazon Q Business should invoke a function that inserts the current date-time.</p>
|
|
1109
1121
|
* @public
|
|
1110
1122
|
*/
|
|
1111
1123
|
invocationCondition?: DocumentAttributeCondition;
|
|
@@ -1141,17 +1153,17 @@ export interface HookConfiguration {
|
|
|
1141
1153
|
export interface DocumentEnrichmentConfiguration {
|
|
1142
1154
|
/**
|
|
1143
1155
|
* <p>Configuration information to alter document attributes or metadata fields and content
|
|
1144
|
-
* when ingesting documents into Amazon Q.</p>
|
|
1156
|
+
* when ingesting documents into Amazon Q Business.</p>
|
|
1145
1157
|
* @public
|
|
1146
1158
|
*/
|
|
1147
1159
|
inlineConfigurations?: InlineDocumentEnrichmentConfiguration[];
|
|
1148
1160
|
/**
|
|
1149
1161
|
* <p>Provides the configuration information for invoking a Lambda function in
|
|
1150
1162
|
* Lambda to alter document metadata and content when ingesting
|
|
1151
|
-
* documents into Amazon Q.</p>
|
|
1163
|
+
* documents into Amazon Q Business.</p>
|
|
1152
1164
|
* <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> if you want to apply advanced alterations on
|
|
1153
1165
|
* the original or raw documents.</p>
|
|
1154
|
-
* <p>If you want to apply advanced alterations on the Amazon Q structured documents,
|
|
1166
|
+
* <p>If you want to apply advanced alterations on the Amazon Q Business structured documents,
|
|
1155
1167
|
* you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
|
|
1156
1168
|
* <p>You can only invoke one Lambda function. However, this function can invoke
|
|
1157
1169
|
* other functions it requires.</p>
|
|
@@ -1162,10 +1174,10 @@ export interface DocumentEnrichmentConfiguration {
|
|
|
1162
1174
|
/**
|
|
1163
1175
|
* <p>Provides the configuration information for invoking a Lambda function in
|
|
1164
1176
|
* Lambda to alter document metadata and content when ingesting
|
|
1165
|
-
* documents into Amazon Q.</p>
|
|
1177
|
+
* documents into Amazon Q Business.</p>
|
|
1166
1178
|
* <p>You can configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PreExtractionHookConfiguration</a> if you want to apply advanced alterations on
|
|
1167
1179
|
* the original or raw documents.</p>
|
|
1168
|
-
* <p>If you want to apply advanced alterations on the Amazon Q structured documents,
|
|
1180
|
+
* <p>If you want to apply advanced alterations on the Amazon Q Business structured documents,
|
|
1169
1181
|
* you must configure your Lambda function using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentEnrichmentConfiguration.html">PostExtractionHookConfiguration</a>.</p>
|
|
1170
1182
|
* <p>You can only invoke one Lambda function. However, this function can invoke
|
|
1171
1183
|
* other functions it requires.</p>
|
|
@@ -1189,7 +1201,7 @@ export interface DataSourceVpcConfiguration {
|
|
|
1189
1201
|
subnetIds: string[] | undefined;
|
|
1190
1202
|
/**
|
|
1191
1203
|
* <p>A list of identifiers of security groups within your Amazon VPC. The security
|
|
1192
|
-
* groups should enable Amazon Q to connect to the data source.</p>
|
|
1204
|
+
* groups should enable Amazon Q Business to connect to the data source.</p>
|
|
1193
1205
|
* @public
|
|
1194
1206
|
*/
|
|
1195
1207
|
securityGroupIds: string[] | undefined;
|
|
@@ -1199,7 +1211,7 @@ export interface DataSourceVpcConfiguration {
|
|
|
1199
1211
|
*/
|
|
1200
1212
|
export interface CreateDataSourceRequest {
|
|
1201
1213
|
/**
|
|
1202
|
-
* <p> The identifier of the Amazon Q application the data source will be attached
|
|
1214
|
+
* <p> The identifier of the Amazon Q Business application the data source will be attached
|
|
1203
1215
|
* to.</p>
|
|
1204
1216
|
* @public
|
|
1205
1217
|
*/
|
|
@@ -1217,7 +1229,7 @@ export interface CreateDataSourceRequest {
|
|
|
1217
1229
|
displayName: string | undefined;
|
|
1218
1230
|
/**
|
|
1219
1231
|
* <p>Configuration information to connect to your data source repository. For configuration
|
|
1220
|
-
* templates for your specific data source, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html
|
|
1232
|
+
* templates for your specific data source, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connectors-list.html">Supported
|
|
1221
1233
|
* connectors</a>.</p>
|
|
1222
1234
|
* @public
|
|
1223
1235
|
*/
|
|
@@ -1225,7 +1237,7 @@ export interface CreateDataSourceRequest {
|
|
|
1225
1237
|
/**
|
|
1226
1238
|
* <p>Configuration information for an Amazon VPC (Virtual Private Cloud) to connect
|
|
1227
1239
|
* to your data source. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/connector-vpc.html">Using
|
|
1228
|
-
* Amazon VPC with Amazon Q connectors</a>.</p>
|
|
1240
|
+
* Amazon VPC with Amazon Q Business connectors</a>.</p>
|
|
1229
1241
|
* @public
|
|
1230
1242
|
*/
|
|
1231
1243
|
vpcConfiguration?: DataSourceVpcConfiguration;
|
|
@@ -1243,8 +1255,8 @@ export interface CreateDataSourceRequest {
|
|
|
1243
1255
|
*/
|
|
1244
1256
|
tags?: Tag[];
|
|
1245
1257
|
/**
|
|
1246
|
-
* <p>Sets the frequency for Amazon Q to check the documents in your data source
|
|
1247
|
-
* repository and update your index. If you don't set a schedule, Amazon Q won't
|
|
1258
|
+
* <p>Sets the frequency for Amazon Q Business to check the documents in your data source
|
|
1259
|
+
* repository and update your index. If you don't set a schedule, Amazon Q Business won't
|
|
1248
1260
|
* periodically update the index.</p>
|
|
1249
1261
|
* <p>Specify a <code>cron-</code> format schedule string or an empty string to indicate
|
|
1250
1262
|
* that the index is updated on demand. You can't specify the <code>Schedule</code>
|
|
@@ -1285,7 +1297,7 @@ export interface CreateDataSourceResponse {
|
|
|
1285
1297
|
*/
|
|
1286
1298
|
dataSourceId?: string;
|
|
1287
1299
|
/**
|
|
1288
|
-
* <p> The Amazon Resource Name (ARN) of a data source in an Amazon Q application.
|
|
1300
|
+
* <p> The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.
|
|
1289
1301
|
* </p>
|
|
1290
1302
|
* @public
|
|
1291
1303
|
*/
|
|
@@ -1296,7 +1308,7 @@ export interface CreateDataSourceResponse {
|
|
|
1296
1308
|
*/
|
|
1297
1309
|
export interface DeleteDataSourceRequest {
|
|
1298
1310
|
/**
|
|
1299
|
-
* <p>The identifier of the Amazon Q application used with the data source
|
|
1311
|
+
* <p>The identifier of the Amazon Q Business application used with the data source
|
|
1300
1312
|
* connector.</p>
|
|
1301
1313
|
* @public
|
|
1302
1314
|
*/
|
|
@@ -1322,7 +1334,7 @@ export interface DeleteDataSourceResponse {
|
|
|
1322
1334
|
*/
|
|
1323
1335
|
export interface GetDataSourceRequest {
|
|
1324
1336
|
/**
|
|
1325
|
-
* <p>The identifier of the Amazon Q application.</p>
|
|
1337
|
+
* <p>The identifier of the Amazon Q Business application.</p>
|
|
1326
1338
|
* @public
|
|
1327
1339
|
*/
|
|
1328
1340
|
applicationId: string | undefined;
|
|
@@ -1358,7 +1370,7 @@ export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSource
|
|
|
1358
1370
|
*/
|
|
1359
1371
|
export interface GetDataSourceResponse {
|
|
1360
1372
|
/**
|
|
1361
|
-
* <p>The identifier of the Amazon Q application.</p>
|
|
1373
|
+
* <p>The identifier of the Amazon Q Business application.</p>
|
|
1362
1374
|
* @public
|
|
1363
1375
|
*/
|
|
1364
1376
|
applicationId?: string;
|
|
@@ -1421,7 +1433,7 @@ export interface GetDataSourceResponse {
|
|
|
1421
1433
|
*/
|
|
1422
1434
|
status?: DataSourceStatus;
|
|
1423
1435
|
/**
|
|
1424
|
-
* <p>The schedule for Amazon Q to update the index.</p>
|
|
1436
|
+
* <p>The schedule for Amazon Q Business to update the index.</p>
|
|
1425
1437
|
* @public
|
|
1426
1438
|
*/
|
|
1427
1439
|
syncSchedule?: string;
|
|
@@ -1452,7 +1464,7 @@ export interface GetDataSourceResponse {
|
|
|
1452
1464
|
*/
|
|
1453
1465
|
export interface ListDataSourcesRequest {
|
|
1454
1466
|
/**
|
|
1455
|
-
* <p>The identifier of the Amazon Q application linked to the data source
|
|
1467
|
+
* <p>The identifier of the Amazon Q Business application linked to the data source
|
|
1456
1468
|
* connectors.</p>
|
|
1457
1469
|
* @public
|
|
1458
1470
|
*/
|
|
@@ -1464,8 +1476,8 @@ export interface ListDataSourcesRequest {
|
|
|
1464
1476
|
indexId: string | undefined;
|
|
1465
1477
|
/**
|
|
1466
1478
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
1467
|
-
* retrieve, Amazon Q returns a pagination token in the response. You can use this
|
|
1468
|
-
* pagination token to retrieve the next set of Amazon Q data source
|
|
1479
|
+
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
1480
|
+
* pagination token to retrieve the next set of Amazon Q Business data source
|
|
1469
1481
|
* connectors.</p>
|
|
1470
1482
|
* @public
|
|
1471
1483
|
*/
|
|
@@ -1477,37 +1489,37 @@ export interface ListDataSourcesRequest {
|
|
|
1477
1489
|
maxResults?: number;
|
|
1478
1490
|
}
|
|
1479
1491
|
/**
|
|
1480
|
-
* <p>A data source in an Amazon Q application.</p>
|
|
1492
|
+
* <p>A data source in an Amazon Q Business application.</p>
|
|
1481
1493
|
* @public
|
|
1482
1494
|
*/
|
|
1483
1495
|
export interface DataSource {
|
|
1484
1496
|
/**
|
|
1485
|
-
* <p>The name of the Amazon Q data source.</p>
|
|
1497
|
+
* <p>The name of the Amazon Q Business data source.</p>
|
|
1486
1498
|
* @public
|
|
1487
1499
|
*/
|
|
1488
1500
|
displayName?: string;
|
|
1489
1501
|
/**
|
|
1490
|
-
* <p>The identifier of the Amazon Q data source.</p>
|
|
1502
|
+
* <p>The identifier of the Amazon Q Business data source.</p>
|
|
1491
1503
|
* @public
|
|
1492
1504
|
*/
|
|
1493
1505
|
dataSourceId?: string;
|
|
1494
1506
|
/**
|
|
1495
|
-
* <p>The type of the Amazon Q data source.</p>
|
|
1507
|
+
* <p>The type of the Amazon Q Business data source.</p>
|
|
1496
1508
|
* @public
|
|
1497
1509
|
*/
|
|
1498
1510
|
type?: string;
|
|
1499
1511
|
/**
|
|
1500
|
-
* <p>The Unix timestamp when the Amazon Q data source was created.</p>
|
|
1512
|
+
* <p>The Unix timestamp when the Amazon Q Business data source was created.</p>
|
|
1501
1513
|
* @public
|
|
1502
1514
|
*/
|
|
1503
1515
|
createdAt?: Date;
|
|
1504
1516
|
/**
|
|
1505
|
-
* <p>The Unix timestamp when the Amazon Q data source was last updated. </p>
|
|
1517
|
+
* <p>The Unix timestamp when the Amazon Q Business data source was last updated. </p>
|
|
1506
1518
|
* @public
|
|
1507
1519
|
*/
|
|
1508
1520
|
updatedAt?: Date;
|
|
1509
1521
|
/**
|
|
1510
|
-
* <p>The status of the Amazon Q data source.</p>
|
|
1522
|
+
* <p>The status of the Amazon Q Business data source.</p>
|
|
1511
1523
|
* @public
|
|
1512
1524
|
*/
|
|
1513
1525
|
status?: DataSourceStatus;
|
|
@@ -1522,7 +1534,7 @@ export interface ListDataSourcesResponse {
|
|
|
1522
1534
|
*/
|
|
1523
1535
|
dataSources?: DataSource[];
|
|
1524
1536
|
/**
|
|
1525
|
-
* <p>If the response is truncated, Amazon Q returns this token. You can use this token
|
|
1537
|
+
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token
|
|
1526
1538
|
* in a subsequent request to retrieve the next set of data source connectors.</p>
|
|
1527
1539
|
* @public
|
|
1528
1540
|
*/
|
|
@@ -1533,7 +1545,7 @@ export interface ListDataSourcesResponse {
|
|
|
1533
1545
|
*/
|
|
1534
1546
|
export interface UpdateDataSourceRequest {
|
|
1535
1547
|
/**
|
|
1536
|
-
* <p> The identifier of the Amazon Q application the data source is attached
|
|
1548
|
+
* <p> The identifier of the Amazon Q Business application the data source is attached
|
|
1537
1549
|
* to.</p>
|
|
1538
1550
|
* @public
|
|
1539
1551
|
*/
|
|
@@ -1554,7 +1566,7 @@ export interface UpdateDataSourceRequest {
|
|
|
1554
1566
|
*/
|
|
1555
1567
|
displayName?: string;
|
|
1556
1568
|
/**
|
|
1557
|
-
* <p>Provides the configuration information for an Amazon Q data source.</p>
|
|
1569
|
+
* <p>Provides the configuration information for an Amazon Q Business data source.</p>
|
|
1558
1570
|
* @public
|
|
1559
1571
|
*/
|
|
1560
1572
|
configuration?: __DocumentType;
|
|
@@ -1599,13 +1611,13 @@ export interface UpdateDataSourceResponse {
|
|
|
1599
1611
|
*/
|
|
1600
1612
|
export interface DeleteIndexRequest {
|
|
1601
1613
|
/**
|
|
1602
|
-
* <p>The identifier of the Amazon Q application the Amazon Q index is linked
|
|
1614
|
+
* <p>The identifier of the Amazon Q Business application the Amazon Q Business index is linked
|
|
1603
1615
|
* to.</p>
|
|
1604
1616
|
* @public
|
|
1605
1617
|
*/
|
|
1606
1618
|
applicationId: string | undefined;
|
|
1607
1619
|
/**
|
|
1608
|
-
* <p>The identifier of the Amazon Q index.</p>
|
|
1620
|
+
* <p>The identifier of the Amazon Q Business index.</p>
|
|
1609
1621
|
* @public
|
|
1610
1622
|
*/
|
|
1611
1623
|
indexId: string | undefined;
|
|
@@ -1620,12 +1632,12 @@ export interface DeleteIndexResponse {
|
|
|
1620
1632
|
*/
|
|
1621
1633
|
export interface GetIndexRequest {
|
|
1622
1634
|
/**
|
|
1623
|
-
* <p>The identifier of the Amazon Q application connected to the index.</p>
|
|
1635
|
+
* <p>The identifier of the Amazon Q Business application connected to the index.</p>
|
|
1624
1636
|
* @public
|
|
1625
1637
|
*/
|
|
1626
1638
|
applicationId: string | undefined;
|
|
1627
1639
|
/**
|
|
1628
|
-
* <p>The identifier of the Amazon Q index you want information on.</p>
|
|
1640
|
+
* <p>The identifier of the Amazon Q Business index you want information on.</p>
|
|
1629
1641
|
* @public
|
|
1630
1642
|
*/
|
|
1631
1643
|
indexId: string | undefined;
|
|
@@ -1728,22 +1740,22 @@ export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
|
|
|
1728
1740
|
*/
|
|
1729
1741
|
export interface GetIndexResponse {
|
|
1730
1742
|
/**
|
|
1731
|
-
* <p>The identifier of the Amazon Q application associated with the index.</p>
|
|
1743
|
+
* <p>The identifier of the Amazon Q Business application associated with the index.</p>
|
|
1732
1744
|
* @public
|
|
1733
1745
|
*/
|
|
1734
1746
|
applicationId?: string;
|
|
1735
1747
|
/**
|
|
1736
|
-
* <p>The identifier of the Amazon Q index.</p>
|
|
1748
|
+
* <p>The identifier of the Amazon Q Business index.</p>
|
|
1737
1749
|
* @public
|
|
1738
1750
|
*/
|
|
1739
1751
|
indexId?: string;
|
|
1740
1752
|
/**
|
|
1741
|
-
* <p>The name of the Amazon Q index.</p>
|
|
1753
|
+
* <p>The name of the Amazon Q Business index.</p>
|
|
1742
1754
|
* @public
|
|
1743
1755
|
*/
|
|
1744
1756
|
displayName?: string;
|
|
1745
1757
|
/**
|
|
1746
|
-
* <p> The Amazon Resource Name (ARN) of the Amazon Q index. </p>
|
|
1758
|
+
* <p> The Amazon Resource Name (ARN) of the Amazon Q Business index. </p>
|
|
1747
1759
|
* @public
|
|
1748
1760
|
*/
|
|
1749
1761
|
indexArn?: string;
|
|
@@ -1755,22 +1767,22 @@ export interface GetIndexResponse {
|
|
|
1755
1767
|
*/
|
|
1756
1768
|
status?: IndexStatus;
|
|
1757
1769
|
/**
|
|
1758
|
-
* <p>The description for the Amazon Q index.</p>
|
|
1770
|
+
* <p>The description for the Amazon Q Business index.</p>
|
|
1759
1771
|
* @public
|
|
1760
1772
|
*/
|
|
1761
1773
|
description?: string;
|
|
1762
1774
|
/**
|
|
1763
|
-
* <p>The Unix timestamp when the Amazon Q index was created.</p>
|
|
1775
|
+
* <p>The Unix timestamp when the Amazon Q Business index was created.</p>
|
|
1764
1776
|
* @public
|
|
1765
1777
|
*/
|
|
1766
1778
|
createdAt?: Date;
|
|
1767
1779
|
/**
|
|
1768
|
-
* <p>The Unix timestamp when the Amazon Q index was last updated.</p>
|
|
1780
|
+
* <p>The Unix timestamp when the Amazon Q Business index was last updated.</p>
|
|
1769
1781
|
* @public
|
|
1770
1782
|
*/
|
|
1771
1783
|
updatedAt?: Date;
|
|
1772
1784
|
/**
|
|
1773
|
-
* <p>The storage capacity units chosen for your Amazon Q index.</p>
|
|
1785
|
+
* <p>The storage capacity units chosen for your Amazon Q Business index.</p>
|
|
1774
1786
|
* @public
|
|
1775
1787
|
*/
|
|
1776
1788
|
capacityConfiguration?: IndexCapacityConfiguration;
|
|
@@ -1798,14 +1810,14 @@ export interface GetIndexResponse {
|
|
|
1798
1810
|
*/
|
|
1799
1811
|
export interface ListIndicesRequest {
|
|
1800
1812
|
/**
|
|
1801
|
-
* <p>The identifier of the Amazon Q application connected to the index.</p>
|
|
1813
|
+
* <p>The identifier of the Amazon Q Business application connected to the index.</p>
|
|
1802
1814
|
* @public
|
|
1803
1815
|
*/
|
|
1804
1816
|
applicationId: string | undefined;
|
|
1805
1817
|
/**
|
|
1806
1818
|
* <p>If the maxResults response was incomplete because there is more data to retrieve,
|
|
1807
|
-
* Amazon Q returns a pagination token in the response. You can use this pagination
|
|
1808
|
-
* token to retrieve the next set of Amazon Q indices.</p>
|
|
1819
|
+
* Amazon Q Business returns a pagination token in the response. You can use this pagination
|
|
1820
|
+
* token to retrieve the next set of Amazon Q Business indices.</p>
|
|
1809
1821
|
* @public
|
|
1810
1822
|
*/
|
|
1811
1823
|
nextToken?: string;
|
|
@@ -1816,7 +1828,7 @@ export interface ListIndicesRequest {
|
|
|
1816
1828
|
maxResults?: number;
|
|
1817
1829
|
}
|
|
1818
1830
|
/**
|
|
1819
|
-
* <p>Summary information for your Amazon Q index.</p>
|
|
1831
|
+
* <p>Summary information for your Amazon Q Business index.</p>
|
|
1820
1832
|
* @public
|
|
1821
1833
|
*/
|
|
1822
1834
|
export interface Index {
|
|
@@ -1852,7 +1864,7 @@ export interface Index {
|
|
|
1852
1864
|
*/
|
|
1853
1865
|
export interface ListIndicesResponse {
|
|
1854
1866
|
/**
|
|
1855
|
-
* <p>If the response is truncated, Amazon Q returns this token that you can use in the
|
|
1867
|
+
* <p>If the response is truncated, Amazon Q Business returns this token that you can use in the
|
|
1856
1868
|
* subsequent request to retrieve the next set of indexes.</p>
|
|
1857
1869
|
* @public
|
|
1858
1870
|
*/
|
|
@@ -1868,27 +1880,27 @@ export interface ListIndicesResponse {
|
|
|
1868
1880
|
*/
|
|
1869
1881
|
export interface UpdateIndexRequest {
|
|
1870
1882
|
/**
|
|
1871
|
-
* <p>The identifier of the Amazon Q application connected to the index.</p>
|
|
1883
|
+
* <p>The identifier of the Amazon Q Business application connected to the index.</p>
|
|
1872
1884
|
* @public
|
|
1873
1885
|
*/
|
|
1874
1886
|
applicationId: string | undefined;
|
|
1875
1887
|
/**
|
|
1876
|
-
* <p>The identifier of the Amazon Q index.</p>
|
|
1888
|
+
* <p>The identifier of the Amazon Q Business index.</p>
|
|
1877
1889
|
* @public
|
|
1878
1890
|
*/
|
|
1879
1891
|
indexId: string | undefined;
|
|
1880
1892
|
/**
|
|
1881
|
-
* <p>The name of the Amazon Q index.</p>
|
|
1893
|
+
* <p>The name of the Amazon Q Business index.</p>
|
|
1882
1894
|
* @public
|
|
1883
1895
|
*/
|
|
1884
1896
|
displayName?: string;
|
|
1885
1897
|
/**
|
|
1886
|
-
* <p>The description of the Amazon Q index.</p>
|
|
1898
|
+
* <p>The description of the Amazon Q Business index.</p>
|
|
1887
1899
|
* @public
|
|
1888
1900
|
*/
|
|
1889
1901
|
description?: string;
|
|
1890
1902
|
/**
|
|
1891
|
-
* <p>The storage capacity units you want to provision for your Amazon Q index. You can
|
|
1903
|
+
* <p>The storage capacity units you want to provision for your Amazon Q Business index. You can
|
|
1892
1904
|
* add and remove capacity to fit your usage needs.</p>
|
|
1893
1905
|
* @public
|
|
1894
1906
|
*/
|
|
@@ -1912,13 +1924,13 @@ export interface UpdateIndexResponse {
|
|
|
1912
1924
|
export interface ListApplicationsRequest {
|
|
1913
1925
|
/**
|
|
1914
1926
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
1915
|
-
* retrieve, Amazon Q returns a pagination token in the response. You can use this
|
|
1916
|
-
* pagination token to retrieve the next set of Amazon Q applications.</p>
|
|
1927
|
+
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
1928
|
+
* pagination token to retrieve the next set of Amazon Q Business applications.</p>
|
|
1917
1929
|
* @public
|
|
1918
1930
|
*/
|
|
1919
1931
|
nextToken?: string;
|
|
1920
1932
|
/**
|
|
1921
|
-
* <p>The maximum number of Amazon Q applications to return.</p>
|
|
1933
|
+
* <p>The maximum number of Amazon Q Business applications to return.</p>
|
|
1922
1934
|
* @public
|
|
1923
1935
|
*/
|
|
1924
1936
|
maxResults?: number;
|
|
@@ -1928,13 +1940,13 @@ export interface ListApplicationsRequest {
|
|
|
1928
1940
|
*/
|
|
1929
1941
|
export interface ListApplicationsResponse {
|
|
1930
1942
|
/**
|
|
1931
|
-
* <p>If the response is truncated, Amazon Q returns this token. You can use this token
|
|
1943
|
+
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token
|
|
1932
1944
|
* in a subsequent request to retrieve the next set of applications.</p>
|
|
1933
1945
|
* @public
|
|
1934
1946
|
*/
|
|
1935
1947
|
nextToken?: string;
|
|
1936
1948
|
/**
|
|
1937
|
-
* <p>An array of summary information on the configuration of one or more Amazon Q
|
|
1949
|
+
* <p>An array of summary information on the configuration of one or more Amazon Q Business
|
|
1938
1950
|
* applications.</p>
|
|
1939
1951
|
* @public
|
|
1940
1952
|
*/
|
|
@@ -1953,7 +1965,7 @@ export interface BasicAuthConfiguration {
|
|
|
1953
1965
|
*/
|
|
1954
1966
|
secretArn: string | undefined;
|
|
1955
1967
|
/**
|
|
1956
|
-
* <p>The ARN of an IAM role used by Amazon Q to access the basic
|
|
1968
|
+
* <p>The ARN of an IAM role used by Amazon Q Business to access the basic
|
|
1957
1969
|
* authentication credentials stored in a Secrets Manager secret.</p>
|
|
1958
1970
|
* @public
|
|
1959
1971
|
*/
|
|
@@ -1972,14 +1984,14 @@ export interface OAuth2ClientCredentialConfiguration {
|
|
|
1972
1984
|
*/
|
|
1973
1985
|
secretArn: string | undefined;
|
|
1974
1986
|
/**
|
|
1975
|
-
* <p>The ARN of an IAM role used by Amazon Q to access the OAuth 2.0
|
|
1987
|
+
* <p>The ARN of an IAM role used by Amazon Q Business to access the OAuth 2.0
|
|
1976
1988
|
* authentication credentials stored in a Secrets Manager secret.</p>
|
|
1977
1989
|
* @public
|
|
1978
1990
|
*/
|
|
1979
1991
|
roleArn: string | undefined;
|
|
1980
1992
|
}
|
|
1981
1993
|
/**
|
|
1982
|
-
* <p>Authentication configuration information for an Amazon Q plugin.</p>
|
|
1994
|
+
* <p>Authentication configuration information for an Amazon Q Business plugin.</p>
|
|
1983
1995
|
* @public
|
|
1984
1996
|
*/
|
|
1985
1997
|
export type PluginAuthConfiguration = PluginAuthConfiguration.BasicAuthConfigurationMember | PluginAuthConfiguration.OAuth2ClientCredentialConfigurationMember | PluginAuthConfiguration.$UnknownMember;
|
|
@@ -2047,7 +2059,7 @@ export interface CreatePluginRequest {
|
|
|
2047
2059
|
*/
|
|
2048
2060
|
serverUrl: string | undefined;
|
|
2049
2061
|
/**
|
|
2050
|
-
* <p>Authentication configuration information for an Amazon Q plugin.</p>
|
|
2062
|
+
* <p>Authentication configuration information for an Amazon Q Business plugin.</p>
|
|
2051
2063
|
* @public
|
|
2052
2064
|
*/
|
|
2053
2065
|
authConfiguration: PluginAuthConfiguration | undefined;
|
|
@@ -2060,7 +2072,7 @@ export interface CreatePluginRequest {
|
|
|
2060
2072
|
*/
|
|
2061
2073
|
tags?: Tag[];
|
|
2062
2074
|
/**
|
|
2063
|
-
* <p>A token that you provide to identify the request to create your Amazon Q
|
|
2075
|
+
* <p>A token that you provide to identify the request to create your Amazon Q Business
|
|
2064
2076
|
* plugin.</p>
|
|
2065
2077
|
* @public
|
|
2066
2078
|
*/
|
|
@@ -2086,7 +2098,7 @@ export interface CreatePluginResponse {
|
|
|
2086
2098
|
*/
|
|
2087
2099
|
export interface DeletePluginRequest {
|
|
2088
2100
|
/**
|
|
2089
|
-
* <p>The identifier the application attached to the Amazon Q plugin.</p>
|
|
2101
|
+
* <p>The identifier the application attached to the Amazon Q Business plugin.</p>
|
|
2090
2102
|
* @public
|
|
2091
2103
|
*/
|
|
2092
2104
|
applicationId: string | undefined;
|
|
@@ -2158,7 +2170,7 @@ export interface GetPluginResponse {
|
|
|
2158
2170
|
*/
|
|
2159
2171
|
serverUrl?: string;
|
|
2160
2172
|
/**
|
|
2161
|
-
* <p>Authentication configuration information for an Amazon Q plugin.</p>
|
|
2173
|
+
* <p>Authentication configuration information for an Amazon Q Business plugin.</p>
|
|
2162
2174
|
* @public
|
|
2163
2175
|
*/
|
|
2164
2176
|
authConfiguration?: PluginAuthConfiguration;
|
|
@@ -2195,7 +2207,7 @@ export interface ListPluginsRequest {
|
|
|
2195
2207
|
applicationId: string | undefined;
|
|
2196
2208
|
/**
|
|
2197
2209
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
2198
|
-
* retrieve, Amazon Q returns a pagination token in the response. You can use this
|
|
2210
|
+
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
2199
2211
|
* pagination token to retrieve the next set of plugins.</p>
|
|
2200
2212
|
* @public
|
|
2201
2213
|
*/
|
|
@@ -2207,7 +2219,7 @@ export interface ListPluginsRequest {
|
|
|
2207
2219
|
maxResults?: number;
|
|
2208
2220
|
}
|
|
2209
2221
|
/**
|
|
2210
|
-
* <p>Information about an Amazon Q plugin and its configuration.</p>
|
|
2222
|
+
* <p>Information about an Amazon Q Business plugin and its configuration.</p>
|
|
2211
2223
|
* @public
|
|
2212
2224
|
*/
|
|
2213
2225
|
export interface Plugin {
|
|
@@ -2253,7 +2265,7 @@ export interface Plugin {
|
|
|
2253
2265
|
export interface ListPluginsResponse {
|
|
2254
2266
|
/**
|
|
2255
2267
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
2256
|
-
* retrieve, Amazon Q returns a pagination token in the response. You can use this
|
|
2268
|
+
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
2257
2269
|
* pagination token to retrieve the next set of plugins.</p>
|
|
2258
2270
|
* @public
|
|
2259
2271
|
*/
|
|
@@ -2332,7 +2344,7 @@ export declare const DocumentAttributeBoostingLevel: {
|
|
|
2332
2344
|
export type DocumentAttributeBoostingLevel = (typeof DocumentAttributeBoostingLevel)[keyof typeof DocumentAttributeBoostingLevel];
|
|
2333
2345
|
/**
|
|
2334
2346
|
* <p>Provides information on boosting <code>DATE</code> type document attributes.</p>
|
|
2335
|
-
* <p>For more information on how boosting document attributes work in Amazon Q, see
|
|
2347
|
+
* <p>For more information on how boosting document attributes work in Amazon Q Business, see
|
|
2336
2348
|
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2337
2349
|
* @public
|
|
2338
2350
|
*/
|
|
@@ -2363,7 +2375,7 @@ export declare const NumberAttributeBoostingType: {
|
|
|
2363
2375
|
export type NumberAttributeBoostingType = (typeof NumberAttributeBoostingType)[keyof typeof NumberAttributeBoostingType];
|
|
2364
2376
|
/**
|
|
2365
2377
|
* <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p>
|
|
2366
|
-
* <p>For more information on how boosting document attributes work in Amazon Q, see
|
|
2378
|
+
* <p>For more information on how boosting document attributes work in Amazon Q Business, see
|
|
2367
2379
|
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2368
2380
|
* @public
|
|
2369
2381
|
*/
|
|
@@ -2403,7 +2415,7 @@ export type StringAttributeValueBoostingLevel = (typeof StringAttributeValueBoos
|
|
|
2403
2415
|
* you can't boost attributes of these data types on either the console or the
|
|
2404
2416
|
* API.</p>
|
|
2405
2417
|
* </note>
|
|
2406
|
-
* <p>For more information on how boosting document attributes work in Amazon Q, see
|
|
2418
|
+
* <p>For more information on how boosting document attributes work in Amazon Q Business, see
|
|
2407
2419
|
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2408
2420
|
* @public
|
|
2409
2421
|
*/
|
|
@@ -2430,7 +2442,7 @@ export interface StringAttributeBoostingConfiguration {
|
|
|
2430
2442
|
* you can't boost attributes of these data types on either the console or the
|
|
2431
2443
|
* API.</p>
|
|
2432
2444
|
* </note>
|
|
2433
|
-
* <p>For more information on how boosting document attributes work in Amazon Q, see
|
|
2445
|
+
* <p>For more information on how boosting document attributes work in Amazon Q Business, see
|
|
2434
2446
|
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2435
2447
|
* @public
|
|
2436
2448
|
*/
|
|
@@ -2442,9 +2454,9 @@ export interface StringListAttributeBoostingConfiguration {
|
|
|
2442
2454
|
boostingLevel: DocumentAttributeBoostingLevel | undefined;
|
|
2443
2455
|
}
|
|
2444
2456
|
/**
|
|
2445
|
-
* <p>Provides information on boosting supported Amazon Q document attribute types.
|
|
2457
|
+
* <p>Provides information on boosting supported Amazon Q Business document attribute types.
|
|
2446
2458
|
* When an end user chat query matches document attributes that have been boosted,
|
|
2447
|
-
* Amazon Q prioritizes generating responses from content that matches the boosted
|
|
2459
|
+
* Amazon Q Business prioritizes generating responses from content that matches the boosted
|
|
2448
2460
|
* document attributes.</p>
|
|
2449
2461
|
* <note>
|
|
2450
2462
|
* <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to
|
|
@@ -2453,7 +2465,7 @@ export interface StringListAttributeBoostingConfiguration {
|
|
|
2453
2465
|
* you can't boost attributes of these data types on either the console or the
|
|
2454
2466
|
* API.</p>
|
|
2455
2467
|
* </note>
|
|
2456
|
-
* <p>For more information on how boosting document attributes work in Amazon Q, see
|
|
2468
|
+
* <p>For more information on how boosting document attributes work in Amazon Q Business, see
|
|
2457
2469
|
* <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2458
2470
|
* @public
|
|
2459
2471
|
*/
|
|
@@ -2527,24 +2539,24 @@ export declare namespace DocumentAttributeBoostingConfiguration {
|
|
|
2527
2539
|
const visit: <T>(value: DocumentAttributeBoostingConfiguration, visitor: Visitor<T>) => T;
|
|
2528
2540
|
}
|
|
2529
2541
|
/**
|
|
2530
|
-
* <p>Configuration information for an Amazon Q index.</p>
|
|
2542
|
+
* <p>Configuration information for an Amazon Q Business index.</p>
|
|
2531
2543
|
* @public
|
|
2532
2544
|
*/
|
|
2533
2545
|
export interface NativeIndexConfiguration {
|
|
2534
2546
|
/**
|
|
2535
|
-
* <p>The identifier for the Amazon Q index.</p>
|
|
2547
|
+
* <p>The identifier for the Amazon Q Business index.</p>
|
|
2536
2548
|
* @public
|
|
2537
2549
|
*/
|
|
2538
2550
|
indexId: string | undefined;
|
|
2539
2551
|
/**
|
|
2540
|
-
* <p>Overrides the default boosts applied by Amazon Q to supported document attribute
|
|
2552
|
+
* <p>Overrides the default boosts applied by Amazon Q Business to supported document attribute
|
|
2541
2553
|
* data types.</p>
|
|
2542
2554
|
* @public
|
|
2543
2555
|
*/
|
|
2544
2556
|
boostingOverride?: Record<string, DocumentAttributeBoostingConfiguration>;
|
|
2545
2557
|
}
|
|
2546
2558
|
/**
|
|
2547
|
-
* <p>Provides information on how the retriever used for your Amazon Q application is
|
|
2559
|
+
* <p>Provides information on how the retriever used for your Amazon Q Business application is
|
|
2548
2560
|
* configured.</p>
|
|
2549
2561
|
* @public
|
|
2550
2562
|
*/
|
|
@@ -2554,8 +2566,8 @@ export type RetrieverConfiguration = RetrieverConfiguration.KendraIndexConfigura
|
|
|
2554
2566
|
*/
|
|
2555
2567
|
export declare namespace RetrieverConfiguration {
|
|
2556
2568
|
/**
|
|
2557
|
-
* <p>Provides information on how a Amazon Q index used as a retriever for your
|
|
2558
|
-
* Amazon Q application is configured.</p>
|
|
2569
|
+
* <p>Provides information on how a Amazon Q Business index used as a retriever for your
|
|
2570
|
+
* Amazon Q Business application is configured.</p>
|
|
2559
2571
|
* @public
|
|
2560
2572
|
*/
|
|
2561
2573
|
interface NativeIndexConfigurationMember {
|
|
@@ -2565,7 +2577,7 @@ export declare namespace RetrieverConfiguration {
|
|
|
2565
2577
|
}
|
|
2566
2578
|
/**
|
|
2567
2579
|
* <p>Provides information on how the Amazon Kendra index used as a retriever for your
|
|
2568
|
-
* Amazon Q application is configured.</p>
|
|
2580
|
+
* Amazon Q Business application is configured.</p>
|
|
2569
2581
|
* @public
|
|
2570
2582
|
*/
|
|
2571
2583
|
interface KendraIndexConfigurationMember {
|
|
@@ -2605,7 +2617,7 @@ export type RetrieverType = (typeof RetrieverType)[keyof typeof RetrieverType];
|
|
|
2605
2617
|
*/
|
|
2606
2618
|
export interface CreateRetrieverRequest {
|
|
2607
2619
|
/**
|
|
2608
|
-
* <p>The identifier of your Amazon Q application.</p>
|
|
2620
|
+
* <p>The identifier of your Amazon Q Business application.</p>
|
|
2609
2621
|
* @public
|
|
2610
2622
|
*/
|
|
2611
2623
|
applicationId: string | undefined;
|
|
@@ -2620,19 +2632,19 @@ export interface CreateRetrieverRequest {
|
|
|
2620
2632
|
*/
|
|
2621
2633
|
displayName: string | undefined;
|
|
2622
2634
|
/**
|
|
2623
|
-
* <p>Provides information on how the retriever used for your Amazon Q application is
|
|
2635
|
+
* <p>Provides information on how the retriever used for your Amazon Q Business application is
|
|
2624
2636
|
* configured.</p>
|
|
2625
2637
|
* @public
|
|
2626
2638
|
*/
|
|
2627
2639
|
configuration: RetrieverConfiguration | undefined;
|
|
2628
2640
|
/**
|
|
2629
|
-
* <p>The ARN of an IAM role used by Amazon Q to access the basic
|
|
2641
|
+
* <p>The ARN of an IAM role used by Amazon Q Business to access the basic
|
|
2630
2642
|
* authentication credentials stored in a Secrets Manager secret.</p>
|
|
2631
2643
|
* @public
|
|
2632
2644
|
*/
|
|
2633
2645
|
roleArn?: string;
|
|
2634
2646
|
/**
|
|
2635
|
-
* <p>A token that you provide to identify the request to create your Amazon Q
|
|
2647
|
+
* <p>A token that you provide to identify the request to create your Amazon Q Business
|
|
2636
2648
|
* application retriever.</p>
|
|
2637
2649
|
* @public
|
|
2638
2650
|
*/
|
|
@@ -2665,7 +2677,7 @@ export interface CreateRetrieverResponse {
|
|
|
2665
2677
|
*/
|
|
2666
2678
|
export interface DeleteRetrieverRequest {
|
|
2667
2679
|
/**
|
|
2668
|
-
* <p>The identifier of the Amazon Q application using the retriever.</p>
|
|
2680
|
+
* <p>The identifier of the Amazon Q Business application using the retriever.</p>
|
|
2669
2681
|
* @public
|
|
2670
2682
|
*/
|
|
2671
2683
|
applicationId: string | undefined;
|
|
@@ -2685,7 +2697,7 @@ export interface DeleteRetrieverResponse {
|
|
|
2685
2697
|
*/
|
|
2686
2698
|
export interface GetRetrieverRequest {
|
|
2687
2699
|
/**
|
|
2688
|
-
* <p>The identifier of the Amazon Q application using the retriever.</p>
|
|
2700
|
+
* <p>The identifier of the Amazon Q Business application using the retriever.</p>
|
|
2689
2701
|
* @public
|
|
2690
2702
|
*/
|
|
2691
2703
|
applicationId: string | undefined;
|
|
@@ -2713,7 +2725,7 @@ export type RetrieverStatus = (typeof RetrieverStatus)[keyof typeof RetrieverSta
|
|
|
2713
2725
|
*/
|
|
2714
2726
|
export interface GetRetrieverResponse {
|
|
2715
2727
|
/**
|
|
2716
|
-
* <p>The identifier of the Amazon Q application using the retriever. </p>
|
|
2728
|
+
* <p>The identifier of the Amazon Q Business application using the retriever. </p>
|
|
2717
2729
|
* @public
|
|
2718
2730
|
*/
|
|
2719
2731
|
applicationId?: string;
|
|
@@ -2743,7 +2755,7 @@ export interface GetRetrieverResponse {
|
|
|
2743
2755
|
*/
|
|
2744
2756
|
displayName?: string;
|
|
2745
2757
|
/**
|
|
2746
|
-
* <p>Provides information on how the retriever used for your Amazon Q application is
|
|
2758
|
+
* <p>Provides information on how the retriever used for your Amazon Q Business application is
|
|
2747
2759
|
* configured.</p>
|
|
2748
2760
|
* @public
|
|
2749
2761
|
*/
|
|
@@ -2770,12 +2782,12 @@ export interface GetRetrieverResponse {
|
|
|
2770
2782
|
*/
|
|
2771
2783
|
export interface ListRetrieversRequest {
|
|
2772
2784
|
/**
|
|
2773
|
-
* <p>The identifier of the Amazon Q application using the retriever.</p>
|
|
2785
|
+
* <p>The identifier of the Amazon Q Business application using the retriever.</p>
|
|
2774
2786
|
* @public
|
|
2775
2787
|
*/
|
|
2776
2788
|
applicationId: string | undefined;
|
|
2777
2789
|
/**
|
|
2778
|
-
* <p>If the number of retrievers returned exceeds <code>maxResults</code>, Amazon Q
|
|
2790
|
+
* <p>If the number of retrievers returned exceeds <code>maxResults</code>, Amazon Q Business
|
|
2779
2791
|
* returns a next token as a pagination token to retrieve the next set of
|
|
2780
2792
|
* retrievers.</p>
|
|
2781
2793
|
* @public
|
|
@@ -2788,17 +2800,17 @@ export interface ListRetrieversRequest {
|
|
|
2788
2800
|
maxResults?: number;
|
|
2789
2801
|
}
|
|
2790
2802
|
/**
|
|
2791
|
-
* <p>Summary information for the retriever used for your Amazon Q application.</p>
|
|
2803
|
+
* <p>Summary information for the retriever used for your Amazon Q Business application.</p>
|
|
2792
2804
|
* @public
|
|
2793
2805
|
*/
|
|
2794
2806
|
export interface Retriever {
|
|
2795
2807
|
/**
|
|
2796
|
-
* <p>The identifier of the Amazon Q application using the retriever.</p>
|
|
2808
|
+
* <p>The identifier of the Amazon Q Business application using the retriever.</p>
|
|
2797
2809
|
* @public
|
|
2798
2810
|
*/
|
|
2799
2811
|
applicationId?: string;
|
|
2800
2812
|
/**
|
|
2801
|
-
* <p>The identifier of the retriever used by your Amazon Q application.</p>
|
|
2813
|
+
* <p>The identifier of the retriever used by your Amazon Q Business application.</p>
|
|
2802
2814
|
* @public
|
|
2803
2815
|
*/
|
|
2804
2816
|
retrieverId?: string;
|
|
@@ -2828,7 +2840,7 @@ export interface ListRetrieversResponse {
|
|
|
2828
2840
|
*/
|
|
2829
2841
|
retrievers?: Retriever[];
|
|
2830
2842
|
/**
|
|
2831
|
-
* <p>If the response is truncated, Amazon Q returns this token, which you can use in a
|
|
2843
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
2832
2844
|
* later request to list the next set of retrievers.</p>
|
|
2833
2845
|
* @public
|
|
2834
2846
|
*/
|
|
@@ -2839,7 +2851,7 @@ export interface ListRetrieversResponse {
|
|
|
2839
2851
|
*/
|
|
2840
2852
|
export interface UpdateRetrieverRequest {
|
|
2841
2853
|
/**
|
|
2842
|
-
* <p>The identifier of your Amazon Q application.</p>
|
|
2854
|
+
* <p>The identifier of your Amazon Q Business application.</p>
|
|
2843
2855
|
* @public
|
|
2844
2856
|
*/
|
|
2845
2857
|
applicationId: string | undefined;
|
|
@@ -2849,7 +2861,7 @@ export interface UpdateRetrieverRequest {
|
|
|
2849
2861
|
*/
|
|
2850
2862
|
retrieverId: string | undefined;
|
|
2851
2863
|
/**
|
|
2852
|
-
* <p>Provides information on how the retriever used for your Amazon Q application is
|
|
2864
|
+
* <p>Provides information on how the retriever used for your Amazon Q Business application is
|
|
2853
2865
|
* configured.</p>
|
|
2854
2866
|
* @public
|
|
2855
2867
|
*/
|
|
@@ -2876,23 +2888,23 @@ export interface UpdateRetrieverResponse {
|
|
|
2876
2888
|
*/
|
|
2877
2889
|
export interface UpdateApplicationRequest {
|
|
2878
2890
|
/**
|
|
2879
|
-
* <p>The identifier of the Amazon Q application.</p>
|
|
2891
|
+
* <p>The identifier of the Amazon Q Business application.</p>
|
|
2880
2892
|
* @public
|
|
2881
2893
|
*/
|
|
2882
2894
|
applicationId: string | undefined;
|
|
2883
2895
|
/**
|
|
2884
|
-
* <p>A name for the Amazon Q application.</p>
|
|
2896
|
+
* <p>A name for the Amazon Q Business application.</p>
|
|
2885
2897
|
* @public
|
|
2886
2898
|
*/
|
|
2887
2899
|
displayName?: string;
|
|
2888
2900
|
/**
|
|
2889
|
-
* <p>A description for the Amazon Q application.</p>
|
|
2901
|
+
* <p>A description for the Amazon Q Business application.</p>
|
|
2890
2902
|
* @public
|
|
2891
2903
|
*/
|
|
2892
2904
|
description?: string;
|
|
2893
2905
|
/**
|
|
2894
2906
|
* <p>An Amazon Web Services Identity and Access Management (IAM) role that
|
|
2895
|
-
* gives Amazon Q permission to access Amazon CloudWatch logs and
|
|
2907
|
+
* gives Amazon Q Business permission to access Amazon CloudWatch logs and
|
|
2896
2908
|
* metrics.</p>
|
|
2897
2909
|
* @public
|
|
2898
2910
|
*/
|
|
@@ -2925,22 +2937,22 @@ export type WebExperienceSamplePromptsControlMode = (typeof WebExperienceSampleP
|
|
|
2925
2937
|
*/
|
|
2926
2938
|
export interface CreateWebExperienceRequest {
|
|
2927
2939
|
/**
|
|
2928
|
-
* <p>The identifier of the Amazon Q web experience.</p>
|
|
2940
|
+
* <p>The identifier of the Amazon Q Business web experience.</p>
|
|
2929
2941
|
* @public
|
|
2930
2942
|
*/
|
|
2931
2943
|
applicationId: string | undefined;
|
|
2932
2944
|
/**
|
|
2933
|
-
* <p>The title for your Amazon Q web experience.</p>
|
|
2945
|
+
* <p>The title for your Amazon Q Business web experience.</p>
|
|
2934
2946
|
* @public
|
|
2935
2947
|
*/
|
|
2936
2948
|
title?: string;
|
|
2937
2949
|
/**
|
|
2938
|
-
* <p>A subtitle to personalize your Amazon Q web experience.</p>
|
|
2950
|
+
* <p>A subtitle to personalize your Amazon Q Business web experience.</p>
|
|
2939
2951
|
* @public
|
|
2940
2952
|
*/
|
|
2941
2953
|
subtitle?: string;
|
|
2942
2954
|
/**
|
|
2943
|
-
* <p>The customized welcome message for end users of an Amazon Q web
|
|
2955
|
+
* <p>The customized welcome message for end users of an Amazon Q Business web
|
|
2944
2956
|
* experience.</p>
|
|
2945
2957
|
* @public
|
|
2946
2958
|
*/
|
|
@@ -2952,7 +2964,13 @@ export interface CreateWebExperienceRequest {
|
|
|
2952
2964
|
*/
|
|
2953
2965
|
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
|
|
2954
2966
|
/**
|
|
2955
|
-
* <p>
|
|
2967
|
+
* <p>The Amazon Resource Name (ARN) of the service role attached to your web
|
|
2968
|
+
* experience.</p>
|
|
2969
|
+
* @public
|
|
2970
|
+
*/
|
|
2971
|
+
roleArn?: string;
|
|
2972
|
+
/**
|
|
2973
|
+
* <p>A list of key-value pairs that identify or categorize your Amazon Q Business web
|
|
2956
2974
|
* experience. You can also use tags to help control access to the web experience. Tag keys
|
|
2957
2975
|
* and values can consist of Unicode letters, digits, white space, and any of the following
|
|
2958
2976
|
* symbols: _ . : / = + - @.</p>
|
|
@@ -2960,7 +2978,7 @@ export interface CreateWebExperienceRequest {
|
|
|
2960
2978
|
*/
|
|
2961
2979
|
tags?: Tag[];
|
|
2962
2980
|
/**
|
|
2963
|
-
* <p>A token you provide to identify a request to create an Amazon Q web experience.
|
|
2981
|
+
* <p>A token you provide to identify a request to create an Amazon Q Business web experience.
|
|
2964
2982
|
* </p>
|
|
2965
2983
|
* @public
|
|
2966
2984
|
*/
|
|
@@ -2971,12 +2989,12 @@ export interface CreateWebExperienceRequest {
|
|
|
2971
2989
|
*/
|
|
2972
2990
|
export interface CreateWebExperienceResponse {
|
|
2973
2991
|
/**
|
|
2974
|
-
* <p>The identifier of the Amazon Q web experience.</p>
|
|
2992
|
+
* <p>The identifier of the Amazon Q Business web experience.</p>
|
|
2975
2993
|
* @public
|
|
2976
2994
|
*/
|
|
2977
2995
|
webExperienceId?: string;
|
|
2978
2996
|
/**
|
|
2979
|
-
* <p> The Amazon Resource Name (ARN) of an Amazon Q web experience.</p>
|
|
2997
|
+
* <p> The Amazon Resource Name (ARN) of an Amazon Q Business web experience.</p>
|
|
2980
2998
|
* @public
|
|
2981
2999
|
*/
|
|
2982
3000
|
webExperienceArn?: string;
|
|
@@ -2986,13 +3004,13 @@ export interface CreateWebExperienceResponse {
|
|
|
2986
3004
|
*/
|
|
2987
3005
|
export interface DeleteWebExperienceRequest {
|
|
2988
3006
|
/**
|
|
2989
|
-
* <p>The identifier of the Amazon Q application linked to the Amazon Q web
|
|
3007
|
+
* <p>The identifier of the Amazon Q Business application linked to the Amazon Q Business web
|
|
2990
3008
|
* experience.</p>
|
|
2991
3009
|
* @public
|
|
2992
3010
|
*/
|
|
2993
3011
|
applicationId: string | undefined;
|
|
2994
3012
|
/**
|
|
2995
|
-
* <p>The identifier of the Amazon Q web experience being deleted.</p>
|
|
3013
|
+
* <p>The identifier of the Amazon Q Business web experience being deleted.</p>
|
|
2996
3014
|
* @public
|
|
2997
3015
|
*/
|
|
2998
3016
|
webExperienceId: string | undefined;
|
|
@@ -3007,19 +3025,19 @@ export interface DeleteWebExperienceResponse {
|
|
|
3007
3025
|
*/
|
|
3008
3026
|
export interface GetWebExperienceRequest {
|
|
3009
3027
|
/**
|
|
3010
|
-
* <p>The identifier of the Amazon Q application linked to the web experience.</p>
|
|
3028
|
+
* <p>The identifier of the Amazon Q Business application linked to the web experience.</p>
|
|
3011
3029
|
* @public
|
|
3012
3030
|
*/
|
|
3013
3031
|
applicationId: string | undefined;
|
|
3014
3032
|
/**
|
|
3015
|
-
* <p>The identifier of the Amazon Q web experience. </p>
|
|
3033
|
+
* <p>The identifier of the Amazon Q Business web experience. </p>
|
|
3016
3034
|
* @public
|
|
3017
3035
|
*/
|
|
3018
3036
|
webExperienceId: string | undefined;
|
|
3019
3037
|
}
|
|
3020
3038
|
/**
|
|
3021
3039
|
* <p>Provides the SAML 2.0 compliant identity provider (IdP) configuration information
|
|
3022
|
-
* Amazon Q needs to deploy a Amazon Q web experience.</p>
|
|
3040
|
+
* Amazon Q Business needs to deploy a Amazon Q Business web experience.</p>
|
|
3023
3041
|
* @public
|
|
3024
3042
|
*/
|
|
3025
3043
|
export interface SamlConfiguration {
|
|
@@ -3030,8 +3048,8 @@ export interface SamlConfiguration {
|
|
|
3030
3048
|
metadataXML: string | undefined;
|
|
3031
3049
|
/**
|
|
3032
3050
|
* <p>The Amazon Resource Name (ARN) of an IAM role assumed by users when
|
|
3033
|
-
* they authenticate into their Amazon Q web experience, containing the relevant
|
|
3034
|
-
* Amazon Q permissions for conversing with Amazon Q.</p>
|
|
3051
|
+
* they authenticate into their Amazon Q Business web experience, containing the relevant
|
|
3052
|
+
* Amazon Q Business permissions for conversing with Amazon Q Business.</p>
|
|
3035
3053
|
* @public
|
|
3036
3054
|
*/
|
|
3037
3055
|
roleArn: string | undefined;
|
|
@@ -3047,7 +3065,7 @@ export interface SamlConfiguration {
|
|
|
3047
3065
|
userGroupAttribute?: string;
|
|
3048
3066
|
}
|
|
3049
3067
|
/**
|
|
3050
|
-
* <p>Provides the authorization configuration information needed to deploy a Amazon Q
|
|
3068
|
+
* <p>Provides the authorization configuration information needed to deploy a Amazon Q Business
|
|
3051
3069
|
* web experience to end users.</p>
|
|
3052
3070
|
* @public
|
|
3053
3071
|
*/
|
|
@@ -3058,7 +3076,7 @@ export type WebExperienceAuthConfiguration = WebExperienceAuthConfiguration.Saml
|
|
|
3058
3076
|
export declare namespace WebExperienceAuthConfiguration {
|
|
3059
3077
|
/**
|
|
3060
3078
|
* <p>Provides the SAML 2.0 compliant identity provider (IdP) configuration information
|
|
3061
|
-
* Amazon Q needs to deploy a Amazon Q web experience.</p>
|
|
3079
|
+
* Amazon Q Business needs to deploy a Amazon Q Business web experience.</p>
|
|
3062
3080
|
* @public
|
|
3063
3081
|
*/
|
|
3064
3082
|
interface SamlConfigurationMember {
|
|
@@ -3098,28 +3116,28 @@ export type WebExperienceStatus = (typeof WebExperienceStatus)[keyof typeof WebE
|
|
|
3098
3116
|
*/
|
|
3099
3117
|
export interface GetWebExperienceResponse {
|
|
3100
3118
|
/**
|
|
3101
|
-
* <p>The identifier of the Amazon Q application linked to the web experience.</p>
|
|
3119
|
+
* <p>The identifier of the Amazon Q Business application linked to the web experience.</p>
|
|
3102
3120
|
* @public
|
|
3103
3121
|
*/
|
|
3104
3122
|
applicationId?: string;
|
|
3105
3123
|
/**
|
|
3106
|
-
* <p>The identifier of the Amazon Q web experience.</p>
|
|
3124
|
+
* <p>The identifier of the Amazon Q Business web experience.</p>
|
|
3107
3125
|
* @public
|
|
3108
3126
|
*/
|
|
3109
3127
|
webExperienceId?: string;
|
|
3110
3128
|
/**
|
|
3111
3129
|
* <p>The Amazon Resource Name (ARN) of the role with the permission to access the
|
|
3112
|
-
* Amazon Q web experience and required resources.</p>
|
|
3130
|
+
* Amazon Q Business web experience and required resources.</p>
|
|
3113
3131
|
* @public
|
|
3114
3132
|
*/
|
|
3115
3133
|
webExperienceArn?: string;
|
|
3116
3134
|
/**
|
|
3117
|
-
* <p>The endpoint of your Amazon Q web experience.</p>
|
|
3135
|
+
* <p>The endpoint of your Amazon Q Business web experience.</p>
|
|
3118
3136
|
* @public
|
|
3119
3137
|
*/
|
|
3120
3138
|
defaultEndpoint?: string;
|
|
3121
3139
|
/**
|
|
3122
|
-
* <p>The current status of the Amazon Q web experience. When the <code>Status</code>
|
|
3140
|
+
* <p>The current status of the Amazon Q Business web experience. When the <code>Status</code>
|
|
3123
3141
|
* field value is <code>FAILED</code>, the <code>ErrorMessage</code> field contains a
|
|
3124
3142
|
* description of the error that caused the data source connector to fail. </p>
|
|
3125
3143
|
* @public
|
|
@@ -3136,17 +3154,17 @@ export interface GetWebExperienceResponse {
|
|
|
3136
3154
|
*/
|
|
3137
3155
|
updatedAt?: Date;
|
|
3138
3156
|
/**
|
|
3139
|
-
* <p>The title for your Amazon Q web experience. </p>
|
|
3157
|
+
* <p>The title for your Amazon Q Business web experience. </p>
|
|
3140
3158
|
* @public
|
|
3141
3159
|
*/
|
|
3142
3160
|
title?: string;
|
|
3143
3161
|
/**
|
|
3144
|
-
* <p>The subtitle for your Amazon Q web experience. </p>
|
|
3162
|
+
* <p>The subtitle for your Amazon Q Business web experience. </p>
|
|
3145
3163
|
* @public
|
|
3146
3164
|
*/
|
|
3147
3165
|
subtitle?: string;
|
|
3148
3166
|
/**
|
|
3149
|
-
* <p>The customized welcome message for end users of an Amazon Q web
|
|
3167
|
+
* <p>The customized welcome message for end users of an Amazon Q Business web
|
|
3150
3168
|
* experience.</p>
|
|
3151
3169
|
* @public
|
|
3152
3170
|
*/
|
|
@@ -3158,7 +3176,13 @@ export interface GetWebExperienceResponse {
|
|
|
3158
3176
|
*/
|
|
3159
3177
|
samplePromptsControlMode?: WebExperienceSamplePromptsControlMode;
|
|
3160
3178
|
/**
|
|
3161
|
-
* <p>The
|
|
3179
|
+
* <p> The Amazon Resource Name (ARN) of the service role attached to your web
|
|
3180
|
+
* experience.</p>
|
|
3181
|
+
* @public
|
|
3182
|
+
*/
|
|
3183
|
+
roleArn?: string;
|
|
3184
|
+
/**
|
|
3185
|
+
* <p>The authentication configuration information for your Amazon Q Business web
|
|
3162
3186
|
* experience.</p>
|
|
3163
3187
|
* @public
|
|
3164
3188
|
*/
|
|
@@ -3176,52 +3200,52 @@ export interface GetWebExperienceResponse {
|
|
|
3176
3200
|
*/
|
|
3177
3201
|
export interface ListWebExperiencesRequest {
|
|
3178
3202
|
/**
|
|
3179
|
-
* <p>The identifier of the Amazon Q application linked to the listed web
|
|
3203
|
+
* <p>The identifier of the Amazon Q Business application linked to the listed web
|
|
3180
3204
|
* experiences.</p>
|
|
3181
3205
|
* @public
|
|
3182
3206
|
*/
|
|
3183
3207
|
applicationId: string | undefined;
|
|
3184
3208
|
/**
|
|
3185
3209
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
3186
|
-
* retrieve, Amazon Q returns a pagination token in the response. You can use this
|
|
3187
|
-
* pagination token to retrieve the next set of Amazon Q conversations.</p>
|
|
3210
|
+
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
3211
|
+
* pagination token to retrieve the next set of Amazon Q Business conversations.</p>
|
|
3188
3212
|
* @public
|
|
3189
3213
|
*/
|
|
3190
3214
|
nextToken?: string;
|
|
3191
3215
|
/**
|
|
3192
|
-
* <p>The maximum number of Amazon Q Web Experiences to return.</p>
|
|
3216
|
+
* <p>The maximum number of Amazon Q Business Web Experiences to return.</p>
|
|
3193
3217
|
* @public
|
|
3194
3218
|
*/
|
|
3195
3219
|
maxResults?: number;
|
|
3196
3220
|
}
|
|
3197
3221
|
/**
|
|
3198
|
-
* <p>Provides information for an Amazon Q web experience.</p>
|
|
3222
|
+
* <p>Provides information for an Amazon Q Business web experience.</p>
|
|
3199
3223
|
* @public
|
|
3200
3224
|
*/
|
|
3201
3225
|
export interface WebExperience {
|
|
3202
3226
|
/**
|
|
3203
|
-
* <p>The identifier of your Amazon Q web experience.</p>
|
|
3227
|
+
* <p>The identifier of your Amazon Q Business web experience.</p>
|
|
3204
3228
|
* @public
|
|
3205
3229
|
*/
|
|
3206
3230
|
webExperienceId?: string;
|
|
3207
3231
|
/**
|
|
3208
|
-
* <p>The Unix timestamp when the Amazon Q application was last updated.</p>
|
|
3232
|
+
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
3209
3233
|
* @public
|
|
3210
3234
|
*/
|
|
3211
3235
|
createdAt?: Date;
|
|
3212
3236
|
/**
|
|
3213
|
-
* <p>The Unix timestamp when your Amazon Q web experience was updated.</p>
|
|
3237
|
+
* <p>The Unix timestamp when your Amazon Q Business web experience was updated.</p>
|
|
3214
3238
|
* @public
|
|
3215
3239
|
*/
|
|
3216
3240
|
updatedAt?: Date;
|
|
3217
3241
|
/**
|
|
3218
|
-
* <p>The endpoint URLs for your Amazon Q web experience. The URLs are unique and fully
|
|
3242
|
+
* <p>The endpoint URLs for your Amazon Q Business web experience. The URLs are unique and fully
|
|
3219
3243
|
* hosted by Amazon Web Services.</p>
|
|
3220
3244
|
* @public
|
|
3221
3245
|
*/
|
|
3222
3246
|
defaultEndpoint?: string;
|
|
3223
3247
|
/**
|
|
3224
|
-
* <p>The status of your Amazon Q web experience.</p>
|
|
3248
|
+
* <p>The status of your Amazon Q Business web experience.</p>
|
|
3225
3249
|
* @public
|
|
3226
3250
|
*/
|
|
3227
3251
|
status?: WebExperienceStatus;
|
|
@@ -3231,12 +3255,12 @@ export interface WebExperience {
|
|
|
3231
3255
|
*/
|
|
3232
3256
|
export interface ListWebExperiencesResponse {
|
|
3233
3257
|
/**
|
|
3234
|
-
* <p>An array of summary information for one or more Amazon Q experiences.</p>
|
|
3258
|
+
* <p>An array of summary information for one or more Amazon Q Business experiences.</p>
|
|
3235
3259
|
* @public
|
|
3236
3260
|
*/
|
|
3237
3261
|
webExperiences?: WebExperience[];
|
|
3238
3262
|
/**
|
|
3239
|
-
* <p>If the response is truncated, Amazon Q returns this token, which you can use in a
|
|
3263
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
3240
3264
|
* later request to list the next set of messages.</p>
|
|
3241
3265
|
* @public
|
|
3242
3266
|
*/
|
|
@@ -3247,32 +3271,32 @@ export interface ListWebExperiencesResponse {
|
|
|
3247
3271
|
*/
|
|
3248
3272
|
export interface UpdateWebExperienceRequest {
|
|
3249
3273
|
/**
|
|
3250
|
-
* <p>The identifier of the Amazon Q application attached to the web experience.</p>
|
|
3274
|
+
* <p>The identifier of the Amazon Q Business application attached to the web experience.</p>
|
|
3251
3275
|
* @public
|
|
3252
3276
|
*/
|
|
3253
3277
|
applicationId: string | undefined;
|
|
3254
3278
|
/**
|
|
3255
|
-
* <p>The identifier of the Amazon Q web experience.</p>
|
|
3279
|
+
* <p>The identifier of the Amazon Q Business web experience.</p>
|
|
3256
3280
|
* @public
|
|
3257
3281
|
*/
|
|
3258
3282
|
webExperienceId: string | undefined;
|
|
3259
3283
|
/**
|
|
3260
|
-
* <p>The authentication configuration of the Amazon Q web experience.</p>
|
|
3284
|
+
* <p>The authentication configuration of the Amazon Q Business web experience.</p>
|
|
3261
3285
|
* @public
|
|
3262
3286
|
*/
|
|
3263
3287
|
authenticationConfiguration?: WebExperienceAuthConfiguration;
|
|
3264
3288
|
/**
|
|
3265
|
-
* <p>The title of the Amazon Q web experience.</p>
|
|
3289
|
+
* <p>The title of the Amazon Q Business web experience.</p>
|
|
3266
3290
|
* @public
|
|
3267
3291
|
*/
|
|
3268
3292
|
title?: string;
|
|
3269
3293
|
/**
|
|
3270
|
-
* <p>The subtitle of the Amazon Q web experience.</p>
|
|
3294
|
+
* <p>The subtitle of the Amazon Q Business web experience.</p>
|
|
3271
3295
|
* @public
|
|
3272
3296
|
*/
|
|
3273
3297
|
subtitle?: string;
|
|
3274
3298
|
/**
|
|
3275
|
-
* <p>A customized welcome message for an end user in an Amazon Q web
|
|
3299
|
+
* <p>A customized welcome message for an end user in an Amazon Q Business web
|
|
3276
3300
|
* experience.</p>
|
|
3277
3301
|
* @public
|
|
3278
3302
|
*/
|
|
@@ -3289,6 +3313,33 @@ export interface UpdateWebExperienceRequest {
|
|
|
3289
3313
|
*/
|
|
3290
3314
|
export interface UpdateWebExperienceResponse {
|
|
3291
3315
|
}
|
|
3316
|
+
/**
|
|
3317
|
+
* @public
|
|
3318
|
+
* @enum
|
|
3319
|
+
*/
|
|
3320
|
+
export declare const CreatorModeControl: {
|
|
3321
|
+
readonly DISABLED: "DISABLED";
|
|
3322
|
+
readonly ENABLED: "ENABLED";
|
|
3323
|
+
};
|
|
3324
|
+
/**
|
|
3325
|
+
* @public
|
|
3326
|
+
*/
|
|
3327
|
+
export type CreatorModeControl = (typeof CreatorModeControl)[keyof typeof CreatorModeControl];
|
|
3328
|
+
/**
|
|
3329
|
+
* <p>The creator mode specific admin controls configured for an Amazon Q Business application.
|
|
3330
|
+
* Determines whether an end user can generate LLM-only responses when they use the web
|
|
3331
|
+
* experience.</p>
|
|
3332
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
3333
|
+
* @public
|
|
3334
|
+
*/
|
|
3335
|
+
export interface AppliedCreatorModeConfiguration {
|
|
3336
|
+
/**
|
|
3337
|
+
* <p> Information about whether creator mode is enabled or disabled for an Amazon Q Business
|
|
3338
|
+
* application. </p>
|
|
3339
|
+
* @public
|
|
3340
|
+
*/
|
|
3341
|
+
creatorModeControl: CreatorModeControl | undefined;
|
|
3342
|
+
}
|
|
3292
3343
|
/**
|
|
3293
3344
|
* <p>A file directly uploaded into a web experience chat.</p>
|
|
3294
3345
|
* @public
|
|
@@ -3355,7 +3406,7 @@ export interface DocumentAttribute {
|
|
|
3355
3406
|
value: DocumentAttributeValue | undefined;
|
|
3356
3407
|
}
|
|
3357
3408
|
/**
|
|
3358
|
-
* <p>A document deleted from an Amazon Q data source connector.</p>
|
|
3409
|
+
* <p>A document deleted from an Amazon Q Business data source connector.</p>
|
|
3359
3410
|
* @public
|
|
3360
3411
|
*/
|
|
3361
3412
|
export interface DeleteDocument {
|
|
@@ -3370,18 +3421,18 @@ export interface DeleteDocument {
|
|
|
3370
3421
|
*/
|
|
3371
3422
|
export interface BatchDeleteDocumentRequest {
|
|
3372
3423
|
/**
|
|
3373
|
-
* <p>The identifier of the Amazon Q application.</p>
|
|
3424
|
+
* <p>The identifier of the Amazon Q Business application.</p>
|
|
3374
3425
|
* @public
|
|
3375
3426
|
*/
|
|
3376
3427
|
applicationId: string | undefined;
|
|
3377
3428
|
/**
|
|
3378
|
-
* <p>The identifier of the Amazon Q index that contains the documents to
|
|
3429
|
+
* <p>The identifier of the Amazon Q Business index that contains the documents to
|
|
3379
3430
|
* delete.</p>
|
|
3380
3431
|
* @public
|
|
3381
3432
|
*/
|
|
3382
3433
|
indexId: string | undefined;
|
|
3383
3434
|
/**
|
|
3384
|
-
* <p>Documents deleted from the Amazon Q index.</p>
|
|
3435
|
+
* <p>Documents deleted from the Amazon Q Business index.</p>
|
|
3385
3436
|
* @public
|
|
3386
3437
|
*/
|
|
3387
3438
|
documents: DeleteDocument[] | undefined;
|
|
@@ -3392,14 +3443,14 @@ export interface BatchDeleteDocumentRequest {
|
|
|
3392
3443
|
dataSourceSyncId?: string;
|
|
3393
3444
|
}
|
|
3394
3445
|
/**
|
|
3395
|
-
* <p>A list of documents that could not be removed from an Amazon Q index. Each entry
|
|
3446
|
+
* <p>A list of documents that could not be removed from an Amazon Q Business index. Each entry
|
|
3396
3447
|
* contains an error message that indicates why the document couldn't be removed from the
|
|
3397
3448
|
* index.</p>
|
|
3398
3449
|
* @public
|
|
3399
3450
|
*/
|
|
3400
3451
|
export interface FailedDocument {
|
|
3401
3452
|
/**
|
|
3402
|
-
* <p>The identifier of the document that couldn't be removed from the Amazon Q
|
|
3453
|
+
* <p>The identifier of the document that couldn't be removed from the Amazon Q Business
|
|
3403
3454
|
* index.</p>
|
|
3404
3455
|
* @public
|
|
3405
3456
|
*/
|
|
@@ -3410,7 +3461,7 @@ export interface FailedDocument {
|
|
|
3410
3461
|
*/
|
|
3411
3462
|
error?: ErrorDetail;
|
|
3412
3463
|
/**
|
|
3413
|
-
* <p>The identifier of the Amazon Q data source connector that contains the failed
|
|
3464
|
+
* <p>The identifier of the Amazon Q Business data source connector that contains the failed
|
|
3414
3465
|
* document.</p>
|
|
3415
3466
|
* @public
|
|
3416
3467
|
*/
|
|
@@ -3421,7 +3472,7 @@ export interface FailedDocument {
|
|
|
3421
3472
|
*/
|
|
3422
3473
|
export interface BatchDeleteDocumentResponse {
|
|
3423
3474
|
/**
|
|
3424
|
-
* <p>A list of documents that couldn't be removed from the Amazon Q index. Each entry
|
|
3475
|
+
* <p>A list of documents that couldn't be removed from the Amazon Q Business index. Each entry
|
|
3425
3476
|
* contains an error message that indicates why the document couldn't be removed from the
|
|
3426
3477
|
* index. </p>
|
|
3427
3478
|
* @public
|
|
@@ -3429,7 +3480,7 @@ export interface BatchDeleteDocumentResponse {
|
|
|
3429
3480
|
failedDocuments?: FailedDocument[];
|
|
3430
3481
|
}
|
|
3431
3482
|
/**
|
|
3432
|
-
* <p>Information required for Amazon Q to find a specific file in an Amazon S3
|
|
3483
|
+
* <p>Information required for Amazon Q Business to find a specific file in an Amazon S3
|
|
3433
3484
|
* bucket.</p>
|
|
3434
3485
|
* @public
|
|
3435
3486
|
*/
|
|
@@ -3457,8 +3508,8 @@ export declare namespace DocumentContent {
|
|
|
3457
3508
|
/**
|
|
3458
3509
|
* <p>The contents of the document. Documents passed to the <code>blob</code> parameter must
|
|
3459
3510
|
* be base64 encoded. Your code might not need to encode the document file bytes if you're
|
|
3460
|
-
* using an Amazon Web Services SDK to call Amazon Q APIs. If you are calling the
|
|
3461
|
-
* Amazon Q endpoint directly using REST, you must base64 encode the contents before
|
|
3511
|
+
* using an Amazon Web Services SDK to call Amazon Q Business APIs. If you are calling the
|
|
3512
|
+
* Amazon Q Business endpoint directly using REST, you must base64 encode the contents before
|
|
3462
3513
|
* sending.</p>
|
|
3463
3514
|
* @public
|
|
3464
3515
|
*/
|
|
@@ -3514,7 +3565,7 @@ export declare const ContentType: {
|
|
|
3514
3565
|
*/
|
|
3515
3566
|
export type ContentType = (typeof ContentType)[keyof typeof ContentType];
|
|
3516
3567
|
/**
|
|
3517
|
-
* <p>A document in an Amazon Q application.</p>
|
|
3568
|
+
* <p>A document in an Amazon Q Business application.</p>
|
|
3518
3569
|
* @public
|
|
3519
3570
|
*/
|
|
3520
3571
|
export interface Document {
|
|
@@ -3524,7 +3575,7 @@ export interface Document {
|
|
|
3524
3575
|
*/
|
|
3525
3576
|
id: string | undefined;
|
|
3526
3577
|
/**
|
|
3527
|
-
* <p>Custom attributes to apply to the document for refining Amazon Q web experience
|
|
3578
|
+
* <p>Custom attributes to apply to the document for refining Amazon Q Business web experience
|
|
3528
3579
|
* responses.</p>
|
|
3529
3580
|
* @public
|
|
3530
3581
|
*/
|
|
@@ -3564,12 +3615,12 @@ export interface Document {
|
|
|
3564
3615
|
*/
|
|
3565
3616
|
export interface BatchPutDocumentRequest {
|
|
3566
3617
|
/**
|
|
3567
|
-
* <p>The identifier of the Amazon Q application.</p>
|
|
3618
|
+
* <p>The identifier of the Amazon Q Business application.</p>
|
|
3568
3619
|
* @public
|
|
3569
3620
|
*/
|
|
3570
3621
|
applicationId: string | undefined;
|
|
3571
3622
|
/**
|
|
3572
|
-
* <p>The identifier of the Amazon Q index to add the documents to. </p>
|
|
3623
|
+
* <p>The identifier of the Amazon Q Business index to add the documents to. </p>
|
|
3573
3624
|
* @public
|
|
3574
3625
|
*/
|
|
3575
3626
|
indexId: string | undefined;
|
|
@@ -3595,7 +3646,7 @@ export interface BatchPutDocumentRequest {
|
|
|
3595
3646
|
*/
|
|
3596
3647
|
export interface BatchPutDocumentResponse {
|
|
3597
3648
|
/**
|
|
3598
|
-
* <p> A list of documents that were not added to the Amazon Q index because the
|
|
3649
|
+
* <p> A list of documents that were not added to the Amazon Q Business index because the
|
|
3599
3650
|
* document failed a validation check. Each document contains an error message that
|
|
3600
3651
|
* indicates why the document couldn't be added to the index. </p>
|
|
3601
3652
|
* @public
|
|
@@ -3609,7 +3660,7 @@ export interface BatchPutDocumentResponse {
|
|
|
3609
3660
|
*/
|
|
3610
3661
|
export interface BlockedPhrasesConfiguration {
|
|
3611
3662
|
/**
|
|
3612
|
-
* <p>A list of phrases blocked from a Amazon Q web experience chat.</p>
|
|
3663
|
+
* <p>A list of phrases blocked from a Amazon Q Business web experience chat.</p>
|
|
3613
3664
|
* @public
|
|
3614
3665
|
*/
|
|
3615
3666
|
blockedPhrases?: string[];
|
|
@@ -3621,18 +3672,18 @@ export interface BlockedPhrasesConfiguration {
|
|
|
3621
3672
|
systemMessageOverride?: string;
|
|
3622
3673
|
}
|
|
3623
3674
|
/**
|
|
3624
|
-
* <p>Updates a blocked phrases configuration in your Amazon Q application.</p>
|
|
3675
|
+
* <p>Updates a blocked phrases configuration in your Amazon Q Business application.</p>
|
|
3625
3676
|
* @public
|
|
3626
3677
|
*/
|
|
3627
3678
|
export interface BlockedPhrasesConfigurationUpdate {
|
|
3628
3679
|
/**
|
|
3629
|
-
* <p>Creates or updates a blocked phrases configuration in your Amazon Q
|
|
3680
|
+
* <p>Creates or updates a blocked phrases configuration in your Amazon Q Business
|
|
3630
3681
|
* application.</p>
|
|
3631
3682
|
* @public
|
|
3632
3683
|
*/
|
|
3633
3684
|
blockedPhrasesToCreateOrUpdate?: string[];
|
|
3634
3685
|
/**
|
|
3635
|
-
* <p>Deletes a blocked phrases configuration in your Amazon Q application.</p>
|
|
3686
|
+
* <p>Deletes a blocked phrases configuration in your Amazon Q Business application.</p>
|
|
3636
3687
|
* @public
|
|
3637
3688
|
*/
|
|
3638
3689
|
blockedPhrasesToDelete?: string[];
|
|
@@ -3643,6 +3694,63 @@ export interface BlockedPhrasesConfigurationUpdate {
|
|
|
3643
3694
|
*/
|
|
3644
3695
|
systemMessageOverride?: string;
|
|
3645
3696
|
}
|
|
3697
|
+
/**
|
|
3698
|
+
* @public
|
|
3699
|
+
* @enum
|
|
3700
|
+
*/
|
|
3701
|
+
export declare const ChatMode: {
|
|
3702
|
+
readonly CREATOR_MODE: "CREATOR_MODE";
|
|
3703
|
+
readonly PLUGIN_MODE: "PLUGIN_MODE";
|
|
3704
|
+
readonly RETRIEVAL_MODE: "RETRIEVAL_MODE";
|
|
3705
|
+
};
|
|
3706
|
+
/**
|
|
3707
|
+
* @public
|
|
3708
|
+
*/
|
|
3709
|
+
export type ChatMode = (typeof ChatMode)[keyof typeof ChatMode];
|
|
3710
|
+
/**
|
|
3711
|
+
* <p>Configuration information required to invoke chat in <code>PLUGIN_MODE</code>.</p>
|
|
3712
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>,
|
|
3713
|
+
* and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
3714
|
+
* @public
|
|
3715
|
+
*/
|
|
3716
|
+
export interface PluginConfiguration {
|
|
3717
|
+
/**
|
|
3718
|
+
* <p> The identifier of the plugin you want to use.</p>
|
|
3719
|
+
* @public
|
|
3720
|
+
*/
|
|
3721
|
+
pluginId: string | undefined;
|
|
3722
|
+
}
|
|
3723
|
+
/**
|
|
3724
|
+
* <p>Configuration information for Amazon Q Business conversation modes.</p>
|
|
3725
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
3726
|
+
* @public
|
|
3727
|
+
*/
|
|
3728
|
+
export type ChatModeConfiguration = ChatModeConfiguration.PluginConfigurationMember | ChatModeConfiguration.$UnknownMember;
|
|
3729
|
+
/**
|
|
3730
|
+
* @public
|
|
3731
|
+
*/
|
|
3732
|
+
export declare namespace ChatModeConfiguration {
|
|
3733
|
+
/**
|
|
3734
|
+
* <p>Configuration information required to invoke chat in <code>PLUGIN_MODE</code>.</p>
|
|
3735
|
+
* @public
|
|
3736
|
+
*/
|
|
3737
|
+
interface PluginConfigurationMember {
|
|
3738
|
+
pluginConfiguration: PluginConfiguration;
|
|
3739
|
+
$unknown?: never;
|
|
3740
|
+
}
|
|
3741
|
+
/**
|
|
3742
|
+
* @public
|
|
3743
|
+
*/
|
|
3744
|
+
interface $UnknownMember {
|
|
3745
|
+
pluginConfiguration?: never;
|
|
3746
|
+
$unknown: [string, any];
|
|
3747
|
+
}
|
|
3748
|
+
interface Visitor<T> {
|
|
3749
|
+
pluginConfiguration: (value: PluginConfiguration) => T;
|
|
3750
|
+
_: (name: string, value: any) => T;
|
|
3751
|
+
}
|
|
3752
|
+
const visit: <T>(value: ChatModeConfiguration, visitor: Visitor<T>) => T;
|
|
3753
|
+
}
|
|
3646
3754
|
/**
|
|
3647
3755
|
* <p>Provides information about a text extract in a chat response that can be attributed to
|
|
3648
3756
|
* a source document.</p>
|
|
@@ -3663,12 +3771,12 @@ export interface TextSegment {
|
|
|
3663
3771
|
endOffset?: number;
|
|
3664
3772
|
}
|
|
3665
3773
|
/**
|
|
3666
|
-
* <p>The documents used to generate an Amazon Q web experience response.</p>
|
|
3774
|
+
* <p>The documents used to generate an Amazon Q Business web experience response.</p>
|
|
3667
3775
|
* @public
|
|
3668
3776
|
*/
|
|
3669
3777
|
export interface SourceAttribution {
|
|
3670
3778
|
/**
|
|
3671
|
-
* <p>The title of the document which is the source for the Amazon Q generated
|
|
3779
|
+
* <p>The title of the document which is the source for the Amazon Q Business generated
|
|
3672
3780
|
* response. </p>
|
|
3673
3781
|
* @public
|
|
3674
3782
|
*/
|
|
@@ -3680,18 +3788,18 @@ export interface SourceAttribution {
|
|
|
3680
3788
|
*/
|
|
3681
3789
|
snippet?: string;
|
|
3682
3790
|
/**
|
|
3683
|
-
* <p>The URL of the document which is the source for the Amazon Q generated response.
|
|
3791
|
+
* <p>The URL of the document which is the source for the Amazon Q Business generated response.
|
|
3684
3792
|
* </p>
|
|
3685
3793
|
* @public
|
|
3686
3794
|
*/
|
|
3687
3795
|
url?: string;
|
|
3688
3796
|
/**
|
|
3689
|
-
* <p>The number attached to a citation in an Amazon Q generated response.</p>
|
|
3797
|
+
* <p>The number attached to a citation in an Amazon Q Business generated response.</p>
|
|
3690
3798
|
* @public
|
|
3691
3799
|
*/
|
|
3692
3800
|
citationNumber?: number;
|
|
3693
3801
|
/**
|
|
3694
|
-
* <p>The Unix timestamp when the Amazon Q application was last updated.</p>
|
|
3802
|
+
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
3695
3803
|
* @public
|
|
3696
3804
|
*/
|
|
3697
3805
|
updatedAt?: Date;
|
|
@@ -3706,7 +3814,7 @@ export interface SourceAttribution {
|
|
|
3706
3814
|
*/
|
|
3707
3815
|
export interface ChatSyncOutput {
|
|
3708
3816
|
/**
|
|
3709
|
-
* <p>The identifier of the Amazon Q conversation.</p>
|
|
3817
|
+
* <p>The identifier of the Amazon Q Business conversation.</p>
|
|
3710
3818
|
* @public
|
|
3711
3819
|
*/
|
|
3712
3820
|
conversationId?: string;
|
|
@@ -3716,19 +3824,19 @@ export interface ChatSyncOutput {
|
|
|
3716
3824
|
*/
|
|
3717
3825
|
systemMessage?: string;
|
|
3718
3826
|
/**
|
|
3719
|
-
* <p>The identifier of an Amazon Q AI generated message within the
|
|
3827
|
+
* <p>The identifier of an Amazon Q Business AI generated message within the
|
|
3720
3828
|
* conversation.</p>
|
|
3721
3829
|
* @public
|
|
3722
3830
|
*/
|
|
3723
3831
|
systemMessageId?: string;
|
|
3724
3832
|
/**
|
|
3725
|
-
* <p>The identifier of an Amazon Q end user text input message within the
|
|
3833
|
+
* <p>The identifier of an Amazon Q Business end user text input message within the
|
|
3726
3834
|
* conversation.</p>
|
|
3727
3835
|
* @public
|
|
3728
3836
|
*/
|
|
3729
3837
|
userMessageId?: string;
|
|
3730
3838
|
/**
|
|
3731
|
-
* <p>A request from Amazon Q to the end user for information Amazon Q needs to
|
|
3839
|
+
* <p>A request from Amazon Q Business to the end user for information Amazon Q Business needs to
|
|
3732
3840
|
* successfully complete a requested plugin action.</p>
|
|
3733
3841
|
* @public
|
|
3734
3842
|
*/
|
|
@@ -3758,7 +3866,7 @@ export declare class LicenseNotFoundException extends __BaseException {
|
|
|
3758
3866
|
constructor(opts: __ExceptionOptionType<LicenseNotFoundException, __BaseException>);
|
|
3759
3867
|
}
|
|
3760
3868
|
/**
|
|
3761
|
-
* <p>A rule for configuring how Amazon Q responds when it encounters a a blocked
|
|
3869
|
+
* <p>A rule for configuring how Amazon Q Business responds when it encounters a a blocked
|
|
3762
3870
|
* topic. You can configure a custom message to inform your end users that they have asked
|
|
3763
3871
|
* about a restricted topic and suggest any next steps they should take.</p>
|
|
3764
3872
|
* @public
|
|
@@ -3772,7 +3880,7 @@ export interface ContentBlockerRule {
|
|
|
3772
3880
|
systemMessageOverride?: string;
|
|
3773
3881
|
}
|
|
3774
3882
|
/**
|
|
3775
|
-
* <p>The identifier of the data source Amazon Q will generate responses from.</p>
|
|
3883
|
+
* <p>The identifier of the data source Amazon Q Business will generate responses from.</p>
|
|
3776
3884
|
* @public
|
|
3777
3885
|
*/
|
|
3778
3886
|
export interface EligibleDataSource {
|
|
@@ -3788,25 +3896,25 @@ export interface EligibleDataSource {
|
|
|
3788
3896
|
dataSourceId?: string;
|
|
3789
3897
|
}
|
|
3790
3898
|
/**
|
|
3791
|
-
* <p>Rules for retrieving content from data sources connected to a Amazon Q
|
|
3899
|
+
* <p>Rules for retrieving content from data sources connected to a Amazon Q Business
|
|
3792
3900
|
* application for a specific topic control configuration.</p>
|
|
3793
3901
|
* @public
|
|
3794
3902
|
*/
|
|
3795
3903
|
export interface ContentRetrievalRule {
|
|
3796
3904
|
/**
|
|
3797
|
-
* <p>Specifies data sources in a Amazon Q application to use for content
|
|
3905
|
+
* <p>Specifies data sources in a Amazon Q Business application to use for content
|
|
3798
3906
|
* generation.</p>
|
|
3799
3907
|
* @public
|
|
3800
3908
|
*/
|
|
3801
3909
|
eligibleDataSources?: EligibleDataSource[];
|
|
3802
3910
|
}
|
|
3803
3911
|
/**
|
|
3804
|
-
* <p>A conversation in an Amazon Q application.</p>
|
|
3912
|
+
* <p>A conversation in an Amazon Q Business application.</p>
|
|
3805
3913
|
* @public
|
|
3806
3914
|
*/
|
|
3807
3915
|
export interface Conversation {
|
|
3808
3916
|
/**
|
|
3809
|
-
* <p>The identifier of the Amazon Q conversation.</p>
|
|
3917
|
+
* <p>The identifier of the Amazon Q Business conversation.</p>
|
|
3810
3918
|
* @public
|
|
3811
3919
|
*/
|
|
3812
3920
|
conversationId?: string;
|
|
@@ -3822,7 +3930,7 @@ export interface Conversation {
|
|
|
3822
3930
|
startTime?: Date;
|
|
3823
3931
|
}
|
|
3824
3932
|
/**
|
|
3825
|
-
* <p>Aliases attached to a user id within an Amazon Q application.</p>
|
|
3933
|
+
* <p>Aliases attached to a user id within an Amazon Q Business application.</p>
|
|
3826
3934
|
* @public
|
|
3827
3935
|
*/
|
|
3828
3936
|
export interface UserAlias {
|
|
@@ -3862,7 +3970,7 @@ export interface CreateUserRequest {
|
|
|
3862
3970
|
*/
|
|
3863
3971
|
userAliases?: UserAlias[];
|
|
3864
3972
|
/**
|
|
3865
|
-
* <p>A token that you provide to identify the request to create your Amazon Q user
|
|
3973
|
+
* <p>A token that you provide to identify the request to create your Amazon Q Business user
|
|
3866
3974
|
* mapping.</p>
|
|
3867
3975
|
* @public
|
|
3868
3976
|
*/
|
|
@@ -3874,7 +3982,20 @@ export interface CreateUserRequest {
|
|
|
3874
3982
|
export interface CreateUserResponse {
|
|
3875
3983
|
}
|
|
3876
3984
|
/**
|
|
3877
|
-
* <p>
|
|
3985
|
+
* <p>Configuration information required to invoke chat in <code>CREATOR_MODE</code>.</p>
|
|
3986
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
3987
|
+
* @public
|
|
3988
|
+
*/
|
|
3989
|
+
export interface CreatorModeConfiguration {
|
|
3990
|
+
/**
|
|
3991
|
+
* <p>Status information about whether <code>CREATOR_MODE</code> has been enabled or
|
|
3992
|
+
* disabled. The default status is <code>DISABLED</code>.</p>
|
|
3993
|
+
* @public
|
|
3994
|
+
*/
|
|
3995
|
+
creatorModeControl: CreatorModeControl | undefined;
|
|
3996
|
+
}
|
|
3997
|
+
/**
|
|
3998
|
+
* <p>Maps a batch delete document request to a specific Amazon Q Business data source connector
|
|
3878
3999
|
* sync job.</p>
|
|
3879
4000
|
* @public
|
|
3880
4001
|
*/
|
|
@@ -3928,7 +4049,7 @@ export declare const DataSourceSyncJobStatus: {
|
|
|
3928
4049
|
*/
|
|
3929
4050
|
export type DataSourceSyncJobStatus = (typeof DataSourceSyncJobStatus)[keyof typeof DataSourceSyncJobStatus];
|
|
3930
4051
|
/**
|
|
3931
|
-
* <p>Provides information about an Amazon Q data source connector synchronization
|
|
4052
|
+
* <p>Provides information about an Amazon Q Business data source connector synchronization
|
|
3932
4053
|
* job.</p>
|
|
3933
4054
|
* @public
|
|
3934
4055
|
*/
|
|
@@ -3996,12 +4117,12 @@ export interface DeleteChatControlsConfigurationResponse {
|
|
|
3996
4117
|
*/
|
|
3997
4118
|
export interface DeleteConversationRequest {
|
|
3998
4119
|
/**
|
|
3999
|
-
* <p>The identifier of the Amazon Q web experience conversation being deleted.</p>
|
|
4120
|
+
* <p>The identifier of the Amazon Q Business web experience conversation being deleted.</p>
|
|
4000
4121
|
* @public
|
|
4001
4122
|
*/
|
|
4002
4123
|
conversationId: string | undefined;
|
|
4003
4124
|
/**
|
|
4004
|
-
* <p>The identifier of the Amazon Q application associated with the
|
|
4125
|
+
* <p>The identifier of the Amazon Q Business application associated with the
|
|
4005
4126
|
* conversation.</p>
|
|
4006
4127
|
* @public
|
|
4007
4128
|
*/
|
|
@@ -4010,7 +4131,7 @@ export interface DeleteConversationRequest {
|
|
|
4010
4131
|
* <p>The identifier of the user who is deleting the conversation.</p>
|
|
4011
4132
|
* @public
|
|
4012
4133
|
*/
|
|
4013
|
-
userId
|
|
4134
|
+
userId?: string;
|
|
4014
4135
|
}
|
|
4015
4136
|
/**
|
|
4016
4137
|
* @public
|
|
@@ -4093,7 +4214,7 @@ export declare const DocumentStatus: {
|
|
|
4093
4214
|
*/
|
|
4094
4215
|
export type DocumentStatus = (typeof DocumentStatus)[keyof typeof DocumentStatus];
|
|
4095
4216
|
/**
|
|
4096
|
-
* <p>The details of a document within an Amazon Q index.</p>
|
|
4217
|
+
* <p>The details of a document within an Amazon Q Business index.</p>
|
|
4097
4218
|
* @public
|
|
4098
4219
|
*/
|
|
4099
4220
|
export interface DocumentDetails {
|
|
@@ -4139,8 +4260,8 @@ export interface GetChatControlsConfigurationRequest {
|
|
|
4139
4260
|
maxResults?: number;
|
|
4140
4261
|
/**
|
|
4141
4262
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
4142
|
-
* retrieve, Amazon Q returns a pagination token in the response. You can use this
|
|
4143
|
-
* pagination token to retrieve the next set of Amazon Q chat controls
|
|
4263
|
+
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
4264
|
+
* pagination token to retrieve the next set of Amazon Q Business chat controls
|
|
4144
4265
|
* configured.</p>
|
|
4145
4266
|
* @public
|
|
4146
4267
|
*/
|
|
@@ -4185,7 +4306,7 @@ export type RuleConfiguration = RuleConfiguration.ContentBlockerRuleMember | Rul
|
|
|
4185
4306
|
*/
|
|
4186
4307
|
export declare namespace RuleConfiguration {
|
|
4187
4308
|
/**
|
|
4188
|
-
* <p>A rule for configuring how Amazon Q responds when it encounters a a blocked
|
|
4309
|
+
* <p>A rule for configuring how Amazon Q Business responds when it encounters a a blocked
|
|
4189
4310
|
* topic.</p>
|
|
4190
4311
|
* @public
|
|
4191
4312
|
*/
|
|
@@ -4195,7 +4316,7 @@ export declare namespace RuleConfiguration {
|
|
|
4195
4316
|
$unknown?: never;
|
|
4196
4317
|
}
|
|
4197
4318
|
/**
|
|
4198
|
-
* <p>Rules for retrieving content from data sources connected to a Amazon Q
|
|
4319
|
+
* <p>Rules for retrieving content from data sources connected to a Amazon Q Business
|
|
4199
4320
|
* application for a specific topic control configuration.</p>
|
|
4200
4321
|
* @public
|
|
4201
4322
|
*/
|
|
@@ -4232,7 +4353,7 @@ export declare const RuleType: {
|
|
|
4232
4353
|
*/
|
|
4233
4354
|
export type RuleType = (typeof RuleType)[keyof typeof RuleType];
|
|
4234
4355
|
/**
|
|
4235
|
-
* <p>Guardrail rules for an Amazon Q application. Amazon Q supports only one rule
|
|
4356
|
+
* <p>Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule
|
|
4236
4357
|
* at a time.</p>
|
|
4237
4358
|
* @public
|
|
4238
4359
|
*/
|
|
@@ -4259,7 +4380,7 @@ export interface Rule {
|
|
|
4259
4380
|
ruleConfiguration?: RuleConfiguration;
|
|
4260
4381
|
}
|
|
4261
4382
|
/**
|
|
4262
|
-
* <p>The topic specific controls configured for an Amazon Q application.</p>
|
|
4383
|
+
* <p>The topic specific controls configured for an Amazon Q Business application.</p>
|
|
4263
4384
|
* @public
|
|
4264
4385
|
*/
|
|
4265
4386
|
export interface TopicConfiguration {
|
|
@@ -4291,7 +4412,7 @@ export interface TopicConfiguration {
|
|
|
4291
4412
|
*/
|
|
4292
4413
|
export interface GetChatControlsConfigurationResponse {
|
|
4293
4414
|
/**
|
|
4294
|
-
* <p>The response scope configured for a Amazon Q application. This determines whether
|
|
4415
|
+
* <p>The response scope configured for a Amazon Q Business application. This determines whether
|
|
4295
4416
|
* your application uses its retrieval augmented generation (RAG) system to generate
|
|
4296
4417
|
* answers only from your enterprise data, or also uses the large language models (LLM)
|
|
4297
4418
|
* knowledge to respons to end user questions in chat.</p>
|
|
@@ -4304,14 +4425,19 @@ export interface GetChatControlsConfigurationResponse {
|
|
|
4304
4425
|
*/
|
|
4305
4426
|
blockedPhrases?: BlockedPhrasesConfiguration;
|
|
4306
4427
|
/**
|
|
4307
|
-
* <p>The topic specific controls configured for a Amazon Q application.</p>
|
|
4428
|
+
* <p>The topic specific controls configured for a Amazon Q Business application.</p>
|
|
4308
4429
|
* @public
|
|
4309
4430
|
*/
|
|
4310
4431
|
topicConfigurations?: TopicConfiguration[];
|
|
4432
|
+
/**
|
|
4433
|
+
* <p>The configuration details for <code>CREATOR_MODE</code>.</p>
|
|
4434
|
+
* @public
|
|
4435
|
+
*/
|
|
4436
|
+
creatorModeConfiguration?: AppliedCreatorModeConfiguration;
|
|
4311
4437
|
/**
|
|
4312
4438
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
4313
|
-
* retrieve, Amazon Q returns a pagination token in the response. You can use this
|
|
4314
|
-
* pagination token to retrieve the next set of Amazon Q chat controls
|
|
4439
|
+
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
4440
|
+
* pagination token to retrieve the next set of Amazon Q Business chat controls
|
|
4315
4441
|
* configured.</p>
|
|
4316
4442
|
* @public
|
|
4317
4443
|
*/
|
|
@@ -4368,7 +4494,7 @@ export interface GroupStatusDetail {
|
|
|
4368
4494
|
*/
|
|
4369
4495
|
status?: GroupStatus;
|
|
4370
4496
|
/**
|
|
4371
|
-
* <p>The Unix timestamp when the Amazon Q application was last updated.</p>
|
|
4497
|
+
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
4372
4498
|
* @public
|
|
4373
4499
|
*/
|
|
4374
4500
|
lastUpdatedAt?: Date;
|
|
@@ -4423,25 +4549,25 @@ export interface GetUserResponse {
|
|
|
4423
4549
|
*/
|
|
4424
4550
|
export interface ListConversationsRequest {
|
|
4425
4551
|
/**
|
|
4426
|
-
* <p>The identifier of the Amazon Q application.</p>
|
|
4552
|
+
* <p>The identifier of the Amazon Q Business application.</p>
|
|
4427
4553
|
* @public
|
|
4428
4554
|
*/
|
|
4429
4555
|
applicationId: string | undefined;
|
|
4430
4556
|
/**
|
|
4431
|
-
* <p>The identifier of the user involved in the Amazon Q web experience conversation.
|
|
4557
|
+
* <p>The identifier of the user involved in the Amazon Q Business web experience conversation.
|
|
4432
4558
|
* </p>
|
|
4433
4559
|
* @public
|
|
4434
4560
|
*/
|
|
4435
|
-
userId
|
|
4561
|
+
userId?: string;
|
|
4436
4562
|
/**
|
|
4437
4563
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
4438
|
-
* retrieve, Amazon Q returns a pagination token in the response. You can use this
|
|
4439
|
-
* pagination token to retrieve the next set of Amazon Q conversations.</p>
|
|
4564
|
+
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
4565
|
+
* pagination token to retrieve the next set of Amazon Q Business conversations.</p>
|
|
4440
4566
|
* @public
|
|
4441
4567
|
*/
|
|
4442
4568
|
nextToken?: string;
|
|
4443
4569
|
/**
|
|
4444
|
-
* <p>The maximum number of Amazon Q conversations to return.</p>
|
|
4570
|
+
* <p>The maximum number of Amazon Q Business conversations to return.</p>
|
|
4445
4571
|
* @public
|
|
4446
4572
|
*/
|
|
4447
4573
|
maxResults?: number;
|
|
@@ -4451,13 +4577,13 @@ export interface ListConversationsRequest {
|
|
|
4451
4577
|
*/
|
|
4452
4578
|
export interface ListConversationsResponse {
|
|
4453
4579
|
/**
|
|
4454
|
-
* <p>If the response is truncated, Amazon Q returns this token, which you can use in a
|
|
4580
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
4455
4581
|
* later request to list the next set of messages.</p>
|
|
4456
4582
|
* @public
|
|
4457
4583
|
*/
|
|
4458
4584
|
nextToken?: string;
|
|
4459
4585
|
/**
|
|
4460
|
-
* <p>An array of summary information on the configuration of one or more Amazon Q web
|
|
4586
|
+
* <p>An array of summary information on the configuration of one or more Amazon Q Business web
|
|
4461
4587
|
* experiences.</p>
|
|
4462
4588
|
* @public
|
|
4463
4589
|
*/
|
|
@@ -4473,18 +4599,18 @@ export interface ListDataSourceSyncJobsRequest {
|
|
|
4473
4599
|
*/
|
|
4474
4600
|
dataSourceId: string | undefined;
|
|
4475
4601
|
/**
|
|
4476
|
-
* <p>The identifier of the Amazon Q application connected to the data source.</p>
|
|
4602
|
+
* <p>The identifier of the Amazon Q Business application connected to the data source.</p>
|
|
4477
4603
|
* @public
|
|
4478
4604
|
*/
|
|
4479
4605
|
applicationId: string | undefined;
|
|
4480
4606
|
/**
|
|
4481
|
-
* <p>The identifier of the index used with the Amazon Q data source connector.</p>
|
|
4607
|
+
* <p>The identifier of the index used with the Amazon Q Business data source connector.</p>
|
|
4482
4608
|
* @public
|
|
4483
4609
|
*/
|
|
4484
4610
|
indexId: string | undefined;
|
|
4485
4611
|
/**
|
|
4486
4612
|
* <p>If the <code>maxResults</code> response was incpmplete because there is more data to
|
|
4487
|
-
* retriever, Amazon Q returns a pagination token in the response. You can use this
|
|
4613
|
+
* retriever, Amazon Q Business returns a pagination token in the response. You can use this
|
|
4488
4614
|
* pagination token to retrieve the next set of responses.</p>
|
|
4489
4615
|
* @public
|
|
4490
4616
|
*/
|
|
@@ -4521,7 +4647,7 @@ export interface ListDataSourceSyncJobsResponse {
|
|
|
4521
4647
|
*/
|
|
4522
4648
|
history?: DataSourceSyncJob[];
|
|
4523
4649
|
/**
|
|
4524
|
-
* <p>If the response is truncated, Amazon Q returns this token. You can use this token
|
|
4650
|
+
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token
|
|
4525
4651
|
* in any subsequent request to retrieve the next set of jobs.</p>
|
|
4526
4652
|
* @public
|
|
4527
4653
|
*/
|
|
@@ -4548,7 +4674,7 @@ export interface ListDocumentsRequest {
|
|
|
4548
4674
|
dataSourceIds?: string[];
|
|
4549
4675
|
/**
|
|
4550
4676
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
4551
|
-
* retrieve, Amazon Q returns a pagination token in the response. You can use this
|
|
4677
|
+
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
4552
4678
|
* pagination token to retrieve the next set of documents.</p>
|
|
4553
4679
|
* @public
|
|
4554
4680
|
*/
|
|
@@ -4570,7 +4696,7 @@ export interface ListDocumentsResponse {
|
|
|
4570
4696
|
documentDetailList?: DocumentDetails[];
|
|
4571
4697
|
/**
|
|
4572
4698
|
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
4573
|
-
* retrieve, Amazon Q returns a pagination token in the response. You can use this
|
|
4699
|
+
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
4574
4700
|
* pagination token to retrieve the next set of documents.</p>
|
|
4575
4701
|
* @public
|
|
4576
4702
|
*/
|
|
@@ -4603,7 +4729,7 @@ export interface ListGroupsRequest {
|
|
|
4603
4729
|
dataSourceId?: string;
|
|
4604
4730
|
/**
|
|
4605
4731
|
* <p>If the previous response was incomplete (because there is more data to retrieve),
|
|
4606
|
-
* Amazon Q returns a pagination token in the response. You can use this pagination
|
|
4732
|
+
* Amazon Q Business returns a pagination token in the response. You can use this pagination
|
|
4607
4733
|
* token to retrieve the next set of groups that are mapped to users.</p>
|
|
4608
4734
|
* @public
|
|
4609
4735
|
*/
|
|
@@ -4630,7 +4756,7 @@ export interface GroupSummary {
|
|
|
4630
4756
|
*/
|
|
4631
4757
|
export interface ListGroupsResponse {
|
|
4632
4758
|
/**
|
|
4633
|
-
* <p>If the response is truncated, Amazon Q returns this token that you can use in the
|
|
4759
|
+
* <p>If the response is truncated, Amazon Q Business returns this token that you can use in the
|
|
4634
4760
|
* subsequent request to retrieve the next set of groups that are mapped to users.</p>
|
|
4635
4761
|
* @public
|
|
4636
4762
|
*/
|
|
@@ -4646,23 +4772,23 @@ export interface ListGroupsResponse {
|
|
|
4646
4772
|
*/
|
|
4647
4773
|
export interface ListMessagesRequest {
|
|
4648
4774
|
/**
|
|
4649
|
-
* <p>The identifier of the Amazon Q web experience conversation.</p>
|
|
4775
|
+
* <p>The identifier of the Amazon Q Business web experience conversation.</p>
|
|
4650
4776
|
* @public
|
|
4651
4777
|
*/
|
|
4652
4778
|
conversationId: string | undefined;
|
|
4653
4779
|
/**
|
|
4654
|
-
* <p>The identifier for the Amazon Q application.</p>
|
|
4780
|
+
* <p>The identifier for the Amazon Q Business application.</p>
|
|
4655
4781
|
* @public
|
|
4656
4782
|
*/
|
|
4657
4783
|
applicationId: string | undefined;
|
|
4658
4784
|
/**
|
|
4659
|
-
* <p>The identifier of the user involved in the Amazon Q web experience
|
|
4785
|
+
* <p>The identifier of the user involved in the Amazon Q Business web experience
|
|
4660
4786
|
* conversation.</p>
|
|
4661
4787
|
* @public
|
|
4662
4788
|
*/
|
|
4663
|
-
userId
|
|
4789
|
+
userId?: string;
|
|
4664
4790
|
/**
|
|
4665
|
-
* <p>If the number of retrievers returned exceeds <code>maxResults</code>, Amazon Q
|
|
4791
|
+
* <p>If the number of retrievers returned exceeds <code>maxResults</code>, Amazon Q Business
|
|
4666
4792
|
* returns a next token as a pagination token to retrieve the next set of messages.</p>
|
|
4667
4793
|
* @public
|
|
4668
4794
|
*/
|
|
@@ -4686,51 +4812,51 @@ export declare const MessageType: {
|
|
|
4686
4812
|
*/
|
|
4687
4813
|
export type MessageType = (typeof MessageType)[keyof typeof MessageType];
|
|
4688
4814
|
/**
|
|
4689
|
-
* <p>A message in an Amazon Q web experience.</p>
|
|
4815
|
+
* <p>A message in an Amazon Q Business web experience.</p>
|
|
4690
4816
|
* @public
|
|
4691
4817
|
*/
|
|
4692
4818
|
export interface Message {
|
|
4693
4819
|
/**
|
|
4694
|
-
* <p>The identifier of the Amazon Q web experience message.</p>
|
|
4820
|
+
* <p>The identifier of the Amazon Q Business web experience message.</p>
|
|
4695
4821
|
* @public
|
|
4696
4822
|
*/
|
|
4697
4823
|
messageId?: string;
|
|
4698
4824
|
/**
|
|
4699
|
-
* <p>The content of the Amazon Q web experience message.</p>
|
|
4825
|
+
* <p>The content of the Amazon Q Business web experience message.</p>
|
|
4700
4826
|
* @public
|
|
4701
4827
|
*/
|
|
4702
4828
|
body?: string;
|
|
4703
4829
|
/**
|
|
4704
|
-
* <p>The timestamp of the first Amazon Q web experience message.</p>
|
|
4830
|
+
* <p>The timestamp of the first Amazon Q Business web experience message.</p>
|
|
4705
4831
|
* @public
|
|
4706
4832
|
*/
|
|
4707
4833
|
time?: Date;
|
|
4708
4834
|
/**
|
|
4709
|
-
* <p>The type of Amazon Q message, whether <code>HUMAN</code> or <code>AI</code>
|
|
4835
|
+
* <p>The type of Amazon Q Business message, whether <code>HUMAN</code> or <code>AI</code>
|
|
4710
4836
|
* generated.</p>
|
|
4711
4837
|
* @public
|
|
4712
4838
|
*/
|
|
4713
4839
|
type?: MessageType;
|
|
4714
4840
|
/**
|
|
4715
|
-
* <p>A file directly uploaded into an Amazon Q web experience chat.</p>
|
|
4841
|
+
* <p>A file directly uploaded into an Amazon Q Business web experience chat.</p>
|
|
4716
4842
|
* @public
|
|
4717
4843
|
*/
|
|
4718
4844
|
attachments?: AttachmentOutput[];
|
|
4719
4845
|
/**
|
|
4720
|
-
* <p>The source documents used to generate Amazon Q web experience message.</p>
|
|
4846
|
+
* <p>The source documents used to generate Amazon Q Business web experience message.</p>
|
|
4721
4847
|
* @public
|
|
4722
4848
|
*/
|
|
4723
4849
|
sourceAttribution?: SourceAttribution[];
|
|
4724
4850
|
/**
|
|
4725
|
-
* <p>An output event that Amazon Q returns to an user who wants to perform a plugin
|
|
4851
|
+
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin
|
|
4726
4852
|
* action during a non-streaming chat conversation. It contains information about the
|
|
4727
4853
|
* selected action with a list of possible user input fields, some pre-populated by
|
|
4728
|
-
* Amazon Q.</p>
|
|
4854
|
+
* Amazon Q Business.</p>
|
|
4729
4855
|
* @public
|
|
4730
4856
|
*/
|
|
4731
4857
|
actionReview?: ActionReview;
|
|
4732
4858
|
/**
|
|
4733
|
-
* <p>Performs an Amazon Q plugin action during a non-streaming chat
|
|
4859
|
+
* <p>Performs an Amazon Q Business plugin action during a non-streaming chat
|
|
4734
4860
|
* conversation.</p>
|
|
4735
4861
|
* @public
|
|
4736
4862
|
*/
|
|
@@ -4746,7 +4872,7 @@ export interface ListMessagesResponse {
|
|
|
4746
4872
|
*/
|
|
4747
4873
|
messages?: Message[];
|
|
4748
4874
|
/**
|
|
4749
|
-
* <p>If the response is truncated, Amazon Q returns this token, which you can use in a
|
|
4875
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a
|
|
4750
4876
|
* later request to list the next set of messages.</p>
|
|
4751
4877
|
* @public
|
|
4752
4878
|
*/
|
|
@@ -4757,7 +4883,7 @@ export interface ListMessagesResponse {
|
|
|
4757
4883
|
*/
|
|
4758
4884
|
export interface ListTagsForResourceRequest {
|
|
4759
4885
|
/**
|
|
4760
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q application or data source to get
|
|
4886
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get
|
|
4761
4887
|
* a list of tags for.</p>
|
|
4762
4888
|
* @public
|
|
4763
4889
|
*/
|
|
@@ -4768,7 +4894,7 @@ export interface ListTagsForResourceRequest {
|
|
|
4768
4894
|
*/
|
|
4769
4895
|
export interface ListTagsForResourceResponse {
|
|
4770
4896
|
/**
|
|
4771
|
-
* <p>A list of tags associated with the Amazon Q application or data source.</p>
|
|
4897
|
+
* <p>A list of tags associated with the Amazon Q Business application or data source.</p>
|
|
4772
4898
|
* @public
|
|
4773
4899
|
*/
|
|
4774
4900
|
tags?: Tag[];
|
|
@@ -4847,7 +4973,7 @@ export interface PutFeedbackRequest {
|
|
|
4847
4973
|
* <p>The identifier of the user giving the feedback.</p>
|
|
4848
4974
|
* @public
|
|
4849
4975
|
*/
|
|
4850
|
-
userId
|
|
4976
|
+
userId?: string;
|
|
4851
4977
|
/**
|
|
4852
4978
|
* <p>The identifier of the conversation the feedback is attached to.</p>
|
|
4853
4979
|
* @public
|
|
@@ -4903,7 +5029,7 @@ export interface MemberUser {
|
|
|
4903
5029
|
}
|
|
4904
5030
|
/**
|
|
4905
5031
|
* <p>A list of users or sub groups that belong to a group. This is for generating
|
|
4906
|
-
* Amazon Q chat results only from document a user has access to.</p>
|
|
5032
|
+
* Amazon Q Business chat results only from document a user has access to.</p>
|
|
4907
5033
|
* @public
|
|
4908
5034
|
*/
|
|
4909
5035
|
export interface GroupMembers {
|
|
@@ -4962,7 +5088,7 @@ export interface PutGroupRequest {
|
|
|
4962
5088
|
type: MembershipType | undefined;
|
|
4963
5089
|
/**
|
|
4964
5090
|
* <p>A list of users or sub groups that belong to a group. This is for generating
|
|
4965
|
-
* Amazon Q chat results only from document a user has access to.</p>
|
|
5091
|
+
* Amazon Q Business chat results only from document a user has access to.</p>
|
|
4966
5092
|
* @public
|
|
4967
5093
|
*/
|
|
4968
5094
|
groupMembers: GroupMembers | undefined;
|
|
@@ -4982,7 +5108,7 @@ export interface StartDataSourceSyncJobRequest {
|
|
|
4982
5108
|
*/
|
|
4983
5109
|
dataSourceId: string | undefined;
|
|
4984
5110
|
/**
|
|
4985
|
-
* <p>The identifier of Amazon Q application the data source is connected to.</p>
|
|
5111
|
+
* <p>The identifier of Amazon Q Business application the data source is connected to.</p>
|
|
4986
5112
|
* @public
|
|
4987
5113
|
*/
|
|
4988
5114
|
applicationId: string | undefined;
|
|
@@ -5012,13 +5138,13 @@ export interface StopDataSourceSyncJobRequest {
|
|
|
5012
5138
|
*/
|
|
5013
5139
|
dataSourceId: string | undefined;
|
|
5014
5140
|
/**
|
|
5015
|
-
* <p>The identifier of the Amazon Q application that the data source is connected
|
|
5141
|
+
* <p>The identifier of the Amazon Q Business application that the data source is connected
|
|
5016
5142
|
* to.</p>
|
|
5017
5143
|
* @public
|
|
5018
5144
|
*/
|
|
5019
5145
|
applicationId: string | undefined;
|
|
5020
5146
|
/**
|
|
5021
|
-
* <p>The identifier of the index used with the Amazon Q data source connector.</p>
|
|
5147
|
+
* <p>The identifier of the index used with the Amazon Q Business data source connector.</p>
|
|
5022
5148
|
* @public
|
|
5023
5149
|
*/
|
|
5024
5150
|
indexId: string | undefined;
|
|
@@ -5033,13 +5159,13 @@ export interface StopDataSourceSyncJobResponse {
|
|
|
5033
5159
|
*/
|
|
5034
5160
|
export interface TagResourceRequest {
|
|
5035
5161
|
/**
|
|
5036
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q application or data source to
|
|
5162
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to
|
|
5037
5163
|
* tag.</p>
|
|
5038
5164
|
* @public
|
|
5039
5165
|
*/
|
|
5040
5166
|
resourceARN: string | undefined;
|
|
5041
5167
|
/**
|
|
5042
|
-
* <p>A list of tag keys to add to the Amazon Q application or data source. If a tag
|
|
5168
|
+
* <p>A list of tag keys to add to the Amazon Q Business application or data source. If a tag
|
|
5043
5169
|
* already exists, the existing value is replaced with the new value.</p>
|
|
5044
5170
|
* @public
|
|
5045
5171
|
*/
|
|
@@ -5055,13 +5181,13 @@ export interface TagResourceResponse {
|
|
|
5055
5181
|
*/
|
|
5056
5182
|
export interface UntagResourceRequest {
|
|
5057
5183
|
/**
|
|
5058
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q application, or data source to
|
|
5184
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to
|
|
5059
5185
|
* remove the tag from.</p>
|
|
5060
5186
|
* @public
|
|
5061
5187
|
*/
|
|
5062
5188
|
resourceARN: string | undefined;
|
|
5063
5189
|
/**
|
|
5064
|
-
* <p>A list of tag keys to remove from the Amazon Q application or data source. If a
|
|
5190
|
+
* <p>A list of tag keys to remove from the Amazon Q Business application or data source. If a
|
|
5065
5191
|
* tag key does not exist on the resource, it is ignored.</p>
|
|
5066
5192
|
* @public
|
|
5067
5193
|
*/
|
|
@@ -5082,7 +5208,7 @@ export interface UpdateChatControlsConfigurationRequest {
|
|
|
5082
5208
|
*/
|
|
5083
5209
|
applicationId: string | undefined;
|
|
5084
5210
|
/**
|
|
5085
|
-
* <p>A token that you provide to identify the request to update a Amazon Q application
|
|
5211
|
+
* <p>A token that you provide to identify the request to update a Amazon Q Business application
|
|
5086
5212
|
* chat configuration.</p>
|
|
5087
5213
|
* @public
|
|
5088
5214
|
*/
|
|
@@ -5110,6 +5236,11 @@ export interface UpdateChatControlsConfigurationRequest {
|
|
|
5110
5236
|
* @public
|
|
5111
5237
|
*/
|
|
5112
5238
|
topicConfigurationsToDelete?: TopicConfiguration[];
|
|
5239
|
+
/**
|
|
5240
|
+
* <p>The configuration details for <code>CREATOR_MODE</code>.</p>
|
|
5241
|
+
* @public
|
|
5242
|
+
*/
|
|
5243
|
+
creatorModeConfiguration?: CreatorModeConfiguration;
|
|
5113
5244
|
}
|
|
5114
5245
|
/**
|
|
5115
5246
|
* @public
|
|
@@ -5182,45 +5313,53 @@ export interface AttributeFilter {
|
|
|
5182
5313
|
*/
|
|
5183
5314
|
notFilter?: AttributeFilter;
|
|
5184
5315
|
/**
|
|
5185
|
-
* <p>Performs an equals operation on two document attributes or metadata fields
|
|
5316
|
+
* <p>Performs an equals operation on two document attributes or metadata fields. Supported
|
|
5317
|
+
* for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>,
|
|
5318
|
+
* <code>longValue</code>, <code>stringListValue</code> and
|
|
5319
|
+
* <code>stringValue</code>.</p>
|
|
5186
5320
|
* @public
|
|
5187
5321
|
*/
|
|
5188
5322
|
equalsTo?: DocumentAttribute;
|
|
5189
5323
|
/**
|
|
5190
5324
|
* <p>Returns <code>true</code> when a document contains all the specified document
|
|
5191
|
-
* attributes or metadata fields
|
|
5325
|
+
* attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
|
|
5326
|
+
* <code>stringListValue</code>.</p>
|
|
5192
5327
|
* @public
|
|
5193
5328
|
*/
|
|
5194
5329
|
containsAll?: DocumentAttribute;
|
|
5195
5330
|
/**
|
|
5196
5331
|
* <p>Returns <code>true</code> when a document contains any of the specified document
|
|
5197
|
-
* attributes or metadata fields
|
|
5332
|
+
* attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>,
|
|
5333
|
+
* <code>longValue</code>, <code>stringListValue</code> and
|
|
5334
|
+
* <code>stringValue</code>.</p>
|
|
5198
5335
|
* @public
|
|
5199
5336
|
*/
|
|
5200
5337
|
containsAny?: DocumentAttribute;
|
|
5201
5338
|
/**
|
|
5202
|
-
* <p>Performs a greater than operation on two document attributes or metadata fields.
|
|
5203
|
-
*
|
|
5339
|
+
* <p>Performs a greater than operation on two document attributes or metadata fields.
|
|
5340
|
+
* Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
|
|
5341
|
+
* and <code>longValue</code>.</p>
|
|
5204
5342
|
* @public
|
|
5205
5343
|
*/
|
|
5206
5344
|
greaterThan?: DocumentAttribute;
|
|
5207
5345
|
/**
|
|
5208
5346
|
* <p>Performs a greater or equals than operation on two document attributes or metadata
|
|
5209
|
-
* fields.
|
|
5210
|
-
*
|
|
5347
|
+
* fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
|
|
5348
|
+
* and <code>longValue</code>. </p>
|
|
5211
5349
|
* @public
|
|
5212
5350
|
*/
|
|
5213
5351
|
greaterThanOrEquals?: DocumentAttribute;
|
|
5214
5352
|
/**
|
|
5215
|
-
* <p>Performs a less than operation on two document attributes or metadata fields.
|
|
5216
|
-
* a document attribute
|
|
5353
|
+
* <p>Performs a less than operation on two document attributes or metadata fields.
|
|
5354
|
+
* Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
|
|
5355
|
+
* and <code>longValue</code>.</p>
|
|
5217
5356
|
* @public
|
|
5218
5357
|
*/
|
|
5219
5358
|
lessThan?: DocumentAttribute;
|
|
5220
5359
|
/**
|
|
5221
5360
|
* <p>Performs a less than or equals operation on two document attributes or metadata
|
|
5222
|
-
* fields.
|
|
5223
|
-
*
|
|
5361
|
+
* fields.Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value type</a>: <code>dateValue</code>
|
|
5362
|
+
* and <code>longValue</code>. </p>
|
|
5224
5363
|
* @public
|
|
5225
5364
|
*/
|
|
5226
5365
|
lessThanOrEquals?: DocumentAttribute;
|
|
@@ -5230,7 +5369,7 @@ export interface AttributeFilter {
|
|
|
5230
5369
|
*/
|
|
5231
5370
|
export interface ChatSyncInput {
|
|
5232
5371
|
/**
|
|
5233
|
-
* <p>The identifier of the Amazon Q application linked to the Amazon Q
|
|
5372
|
+
* <p>The identifier of the Amazon Q Business application linked to the Amazon Q Business
|
|
5234
5373
|
* conversation.</p>
|
|
5235
5374
|
* @public
|
|
5236
5375
|
*/
|
|
@@ -5239,7 +5378,7 @@ export interface ChatSyncInput {
|
|
|
5239
5378
|
* <p>The identifier of the user attached to the chat input.</p>
|
|
5240
5379
|
* @public
|
|
5241
5380
|
*/
|
|
5242
|
-
userId
|
|
5381
|
+
userId?: string;
|
|
5243
5382
|
/**
|
|
5244
5383
|
* <p>The groups that a user associated with the chat input belongs to.</p>
|
|
5245
5384
|
* @public
|
|
@@ -5257,12 +5396,12 @@ export interface ChatSyncInput {
|
|
|
5257
5396
|
*/
|
|
5258
5397
|
attachments?: AttachmentInput[];
|
|
5259
5398
|
/**
|
|
5260
|
-
* <p>A request from an end user to perform an Amazon Q plugin action.</p>
|
|
5399
|
+
* <p>A request from an end user to perform an Amazon Q Business plugin action.</p>
|
|
5261
5400
|
* @public
|
|
5262
5401
|
*/
|
|
5263
5402
|
actionExecution?: ActionExecution;
|
|
5264
5403
|
/**
|
|
5265
|
-
* <p>The identifier of the Amazon Q conversation.</p>
|
|
5404
|
+
* <p>The identifier of the Amazon Q Business conversation.</p>
|
|
5266
5405
|
* @public
|
|
5267
5406
|
*/
|
|
5268
5407
|
conversationId?: string;
|
|
@@ -5272,11 +5411,43 @@ export interface ChatSyncInput {
|
|
|
5272
5411
|
*/
|
|
5273
5412
|
parentMessageId?: string;
|
|
5274
5413
|
/**
|
|
5275
|
-
* <p>Enables filtering of Amazon Q web experience responses based on document
|
|
5414
|
+
* <p>Enables filtering of Amazon Q Business web experience responses based on document
|
|
5276
5415
|
* attributes or metadata fields.</p>
|
|
5277
5416
|
* @public
|
|
5278
5417
|
*/
|
|
5279
5418
|
attributeFilter?: AttributeFilter;
|
|
5419
|
+
/**
|
|
5420
|
+
* <p>The chat modes available in an Amazon Q Business web experience.</p>
|
|
5421
|
+
* <ul>
|
|
5422
|
+
* <li>
|
|
5423
|
+
* <p>
|
|
5424
|
+
* <code>RETRIEVAL_MODE</code> - The default chat mode for an
|
|
5425
|
+
* Amazon Q Business application. When this mode is enabled, Amazon Q Business generates
|
|
5426
|
+
* responses only from data sources connected to an Amazon Q Business
|
|
5427
|
+
* application.</p>
|
|
5428
|
+
* </li>
|
|
5429
|
+
* <li>
|
|
5430
|
+
* <p>
|
|
5431
|
+
* <code>CREATOR_MODE</code> - By selecting this mode, users can choose to
|
|
5432
|
+
* generate responses only from the LLM knowledge, without consulting connected
|
|
5433
|
+
* data sources, for a chat request.</p>
|
|
5434
|
+
* </li>
|
|
5435
|
+
* <li>
|
|
5436
|
+
* <p>
|
|
5437
|
+
* <code>PLUGIN_MODE</code> - By selecting this mode, users can choose to
|
|
5438
|
+
* use plugins in chat.</p>
|
|
5439
|
+
* </li>
|
|
5440
|
+
* </ul>
|
|
5441
|
+
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>,
|
|
5442
|
+
* and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
5443
|
+
* @public
|
|
5444
|
+
*/
|
|
5445
|
+
chatMode?: ChatMode;
|
|
5446
|
+
/**
|
|
5447
|
+
* <p>The chat mode configuration for an Amazon Q Business application.</p>
|
|
5448
|
+
* @public
|
|
5449
|
+
*/
|
|
5450
|
+
chatModeConfiguration?: ChatModeConfiguration;
|
|
5280
5451
|
/**
|
|
5281
5452
|
* <p>A token that you provide to identify a chat request.</p>
|
|
5282
5453
|
* @public
|