@aws-sdk/client-qbusiness 3.933.0 → 3.935.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/dist-cjs/index.js +340 -345
- package/dist-es/index.js +2 -1
- package/dist-es/models/enums.js +339 -0
- package/dist-es/models/errors.js +137 -0
- package/dist-es/models/models_0.js +0 -417
- package/dist-es/models/models_1.js +1 -60
- package/dist-es/schemas/schemas_0.js +1 -1
- package/dist-types/commands/GetChatResponseConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/GetDocumentContentCommand.d.ts +1 -1
- package/dist-types/commands/GetGroupCommand.d.ts +1 -1
- package/dist-types/commands/GetMediaCommand.d.ts +1 -1
- package/dist-types/commands/GetPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetUserCommand.d.ts +1 -1
- package/dist-types/commands/ListAttachmentsCommand.d.ts +1 -1
- package/dist-types/commands/ListChatResponseConfigurationsCommand.d.ts +1 -1
- package/dist-types/commands/ListConversationsCommand.d.ts +1 -1
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListDocumentsCommand.d.ts +1 -1
- package/dist-types/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/commands/ListMessagesCommand.d.ts +1 -1
- package/dist-types/commands/ListPluginActionsCommand.d.ts +1 -1
- package/dist-types/commands/ListPluginTypeActionsCommand.d.ts +1 -1
- package/dist-types/commands/ListPluginTypeMetadataCommand.d.ts +1 -1
- package/dist-types/commands/ListSubscriptionsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/PutFeedbackCommand.d.ts +1 -1
- package/dist-types/commands/PutGroupCommand.d.ts +1 -1
- package/dist-types/commands/SearchRelevantContentCommand.d.ts +2 -1
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +2 -1
- package/dist-types/index.d.ts +4 -1
- package/dist-types/models/enums.d.ts +811 -0
- package/dist-types/models/errors.d.ts +164 -0
- package/dist-types/models/models_0.d.ts +1208 -858
- package/dist-types/models/models_1.d.ts +2 -1325
- package/dist-types/ts3.4/commands/GetChatResponseConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetDocumentContentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMediaCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAttachmentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListChatResponseConfigurationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListConversationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDataSourceSyncJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListDocumentsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessagesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPluginActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPluginTypeActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPluginTypeMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSubscriptionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutFeedbackCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/PutGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SearchRelevantContentCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/StartDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateChatControlsConfigurationCommand.d.ts +2 -4
- package/dist-types/ts3.4/index.d.ts +4 -1
- package/dist-types/ts3.4/models/enums.d.ts +440 -0
- package/dist-types/ts3.4/models/errors.d.ts +80 -0
- package/dist-types/ts3.4/models/models_0.d.ts +359 -453
- package/dist-types/ts3.4/models/models_1.d.ts +1 -392
- package/package.json +12 -12
- package/dist-es/models/index.js +0 -2
- package/dist-types/models/index.d.ts +0 -2
- package/dist-types/ts3.4/models/index.d.ts +0 -2
|
@@ -1,42 +1,5 @@
|
|
|
1
|
-
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
1
|
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
-
import {
|
|
4
|
-
/**
|
|
5
|
-
* @public
|
|
6
|
-
* @enum
|
|
7
|
-
*/
|
|
8
|
-
export declare const MemberRelation: {
|
|
9
|
-
readonly AND: "AND";
|
|
10
|
-
readonly OR: "OR";
|
|
11
|
-
};
|
|
12
|
-
/**
|
|
13
|
-
* @public
|
|
14
|
-
*/
|
|
15
|
-
export type MemberRelation = (typeof MemberRelation)[keyof typeof MemberRelation];
|
|
16
|
-
/**
|
|
17
|
-
* @public
|
|
18
|
-
* @enum
|
|
19
|
-
*/
|
|
20
|
-
export declare const ReadAccessType: {
|
|
21
|
-
readonly ALLOW: "ALLOW";
|
|
22
|
-
readonly DENY: "DENY";
|
|
23
|
-
};
|
|
24
|
-
/**
|
|
25
|
-
* @public
|
|
26
|
-
*/
|
|
27
|
-
export type ReadAccessType = (typeof ReadAccessType)[keyof typeof ReadAccessType];
|
|
28
|
-
/**
|
|
29
|
-
* @public
|
|
30
|
-
* @enum
|
|
31
|
-
*/
|
|
32
|
-
export declare const MembershipType: {
|
|
33
|
-
readonly DATASOURCE: "DATASOURCE";
|
|
34
|
-
readonly INDEX: "INDEX";
|
|
35
|
-
};
|
|
36
|
-
/**
|
|
37
|
-
* @public
|
|
38
|
-
*/
|
|
39
|
-
export type MembershipType = (typeof MembershipType)[keyof typeof MembershipType];
|
|
2
|
+
import { ActionPayloadFieldType, APISchemaType, ApplicationStatus, AttachmentsControlMode, AttachmentStatus, AttributeType, AttributeValueOperator, AudioExtractionStatus, AudioExtractionType, AutoSubscriptionStatus, ChatResponseConfigurationStatus, ContentType, CreatorModeControl, DataAccessorAuthenticationType, DataSourceStatus, DataSourceSyncJobStatus, DocumentAttributeBoostingLevel, DocumentContentOperator, DocumentEnrichmentConditionOperator, DocumentStatus, ErrorCode, GroupStatus, HallucinationReductionControl, IdentityType, ImageExtractionStatus, IndexStatus, IndexType, MemberRelation, MembershipType, MessageType, MessageUsefulness, MessageUsefulnessReason, NumberAttributeBoostingType, OrchestrationControl, OutputFormat, PermissionConditionOperator, PersonalizationControlMode, PluginBuildStatus, PluginState, PluginType, PluginTypeCategory, QAppsControlMode, ReadAccessType, ResponseConfigurationType, ResponseScope, RetrieverStatus, RetrieverType, RuleType, ScoreConfidence, Status, StringAttributeValueBoostingLevel, SubscriptionType, SystemMessageType, VideoExtractionStatus, VideoExtractionType, WebExperienceSamplePromptsControlMode, WebExperienceStatus } from "./enums";
|
|
40
3
|
/**
|
|
41
4
|
* <p>Provides information about a group associated with the principal.</p>
|
|
42
5
|
* @public
|
|
@@ -156,18 +119,6 @@ export interface AccessConfiguration {
|
|
|
156
119
|
*/
|
|
157
120
|
memberRelation?: MemberRelation | undefined;
|
|
158
121
|
}
|
|
159
|
-
/**
|
|
160
|
-
* <p> You don't have access to perform this action. Make sure you have the required permission policies and user accounts and try again.</p>
|
|
161
|
-
* @public
|
|
162
|
-
*/
|
|
163
|
-
export declare class AccessDeniedException extends __BaseException {
|
|
164
|
-
readonly name: "AccessDeniedException";
|
|
165
|
-
readonly $fault: "client";
|
|
166
|
-
/**
|
|
167
|
-
* @internal
|
|
168
|
-
*/
|
|
169
|
-
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
170
|
-
}
|
|
171
122
|
/**
|
|
172
123
|
* <p>The value of a document attribute. You can only provide one value for a document attribute.</p>
|
|
173
124
|
* @public
|
|
@@ -312,20 +263,6 @@ export interface ActionExecutionEvent {
|
|
|
312
263
|
*/
|
|
313
264
|
payloadFieldNameSeparator: string | undefined;
|
|
314
265
|
}
|
|
315
|
-
/**
|
|
316
|
-
* @public
|
|
317
|
-
* @enum
|
|
318
|
-
*/
|
|
319
|
-
export declare const ActionPayloadFieldType: {
|
|
320
|
-
readonly ARRAY: "ARRAY";
|
|
321
|
-
readonly BOOLEAN: "BOOLEAN";
|
|
322
|
-
readonly NUMBER: "NUMBER";
|
|
323
|
-
readonly STRING: "STRING";
|
|
324
|
-
};
|
|
325
|
-
/**
|
|
326
|
-
* @public
|
|
327
|
-
*/
|
|
328
|
-
export type ActionPayloadFieldType = (typeof ActionPayloadFieldType)[keyof typeof ActionPayloadFieldType];
|
|
329
266
|
/**
|
|
330
267
|
* <p>Information about the field values that an end user can use to provide to Amazon Q Business for Amazon Q Business to perform the requested plugin action.</p>
|
|
331
268
|
* @public
|
|
@@ -393,33 +330,6 @@ export interface ActionReviewPayloadField {
|
|
|
393
330
|
*/
|
|
394
331
|
required?: boolean | undefined;
|
|
395
332
|
}
|
|
396
|
-
/**
|
|
397
|
-
* @public
|
|
398
|
-
* @enum
|
|
399
|
-
*/
|
|
400
|
-
export declare const PluginType: {
|
|
401
|
-
readonly ASANA: "ASANA";
|
|
402
|
-
readonly ATLASSIAN_CONFLUENCE: "ATLASSIAN_CONFLUENCE";
|
|
403
|
-
readonly CUSTOM: "CUSTOM";
|
|
404
|
-
readonly GOOGLE_CALENDAR: "GOOGLE_CALENDAR";
|
|
405
|
-
readonly JIRA: "JIRA";
|
|
406
|
-
readonly JIRA_CLOUD: "JIRA_CLOUD";
|
|
407
|
-
readonly MICROSOFT_EXCHANGE: "MICROSOFT_EXCHANGE";
|
|
408
|
-
readonly MICROSOFT_TEAMS: "MICROSOFT_TEAMS";
|
|
409
|
-
readonly PAGERDUTY_ADVANCE: "PAGERDUTY_ADVANCE";
|
|
410
|
-
readonly QUICKSIGHT: "QUICKSIGHT";
|
|
411
|
-
readonly SALESFORCE: "SALESFORCE";
|
|
412
|
-
readonly SALESFORCE_CRM: "SALESFORCE_CRM";
|
|
413
|
-
readonly SERVICENOW_NOW_PLATFORM: "SERVICENOW_NOW_PLATFORM";
|
|
414
|
-
readonly SERVICE_NOW: "SERVICE_NOW";
|
|
415
|
-
readonly SMARTSHEET: "SMARTSHEET";
|
|
416
|
-
readonly ZENDESK: "ZENDESK";
|
|
417
|
-
readonly ZENDESK_SUITE: "ZENDESK_SUITE";
|
|
418
|
-
};
|
|
419
|
-
/**
|
|
420
|
-
* @public
|
|
421
|
-
*/
|
|
422
|
-
export type PluginType = (typeof PluginType)[keyof typeof PluginType];
|
|
423
333
|
/**
|
|
424
334
|
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.</p>
|
|
425
335
|
* @public
|
|
@@ -574,32 +484,6 @@ export declare namespace APISchema {
|
|
|
574
484
|
_: (name: string, value: any) => T;
|
|
575
485
|
}
|
|
576
486
|
}
|
|
577
|
-
/**
|
|
578
|
-
* @public
|
|
579
|
-
* @enum
|
|
580
|
-
*/
|
|
581
|
-
export declare const APISchemaType: {
|
|
582
|
-
readonly OPEN_API_V3: "OPEN_API_V3";
|
|
583
|
-
};
|
|
584
|
-
/**
|
|
585
|
-
* @public
|
|
586
|
-
*/
|
|
587
|
-
export type APISchemaType = (typeof APISchemaType)[keyof typeof APISchemaType];
|
|
588
|
-
/**
|
|
589
|
-
* @public
|
|
590
|
-
* @enum
|
|
591
|
-
*/
|
|
592
|
-
export declare const IdentityType: {
|
|
593
|
-
readonly ANONYMOUS: "ANONYMOUS";
|
|
594
|
-
readonly AWS_IAM_IDC: "AWS_IAM_IDC";
|
|
595
|
-
readonly AWS_IAM_IDP_OIDC: "AWS_IAM_IDP_OIDC";
|
|
596
|
-
readonly AWS_IAM_IDP_SAML: "AWS_IAM_IDP_SAML";
|
|
597
|
-
readonly AWS_QUICKSIGHT_IDP: "AWS_QUICKSIGHT_IDP";
|
|
598
|
-
};
|
|
599
|
-
/**
|
|
600
|
-
* @public
|
|
601
|
-
*/
|
|
602
|
-
export type IdentityType = (typeof IdentityType)[keyof typeof IdentityType];
|
|
603
487
|
/**
|
|
604
488
|
* <p>The Amazon QuickSight configuration for an Amazon Q Business application that uses QuickSight as the identity provider. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/create-quicksight-integrated-application.html">Creating an Amazon QuickSight integrated application</a>.</p>
|
|
605
489
|
* @public
|
|
@@ -611,21 +495,6 @@ export interface QuickSightConfiguration {
|
|
|
611
495
|
*/
|
|
612
496
|
clientNamespace: string | undefined;
|
|
613
497
|
}
|
|
614
|
-
/**
|
|
615
|
-
* @public
|
|
616
|
-
* @enum
|
|
617
|
-
*/
|
|
618
|
-
export declare const ApplicationStatus: {
|
|
619
|
-
readonly ACTIVE: "ACTIVE";
|
|
620
|
-
readonly CREATING: "CREATING";
|
|
621
|
-
readonly DELETING: "DELETING";
|
|
622
|
-
readonly FAILED: "FAILED";
|
|
623
|
-
readonly UPDATING: "UPDATING";
|
|
624
|
-
};
|
|
625
|
-
/**
|
|
626
|
-
* @public
|
|
627
|
-
*/
|
|
628
|
-
export type ApplicationStatus = (typeof ApplicationStatus)[keyof typeof ApplicationStatus];
|
|
629
498
|
/**
|
|
630
499
|
* <p>Summary information for an Amazon Q Business application.</p>
|
|
631
500
|
* @public
|
|
@@ -667,40 +536,6 @@ export interface Application {
|
|
|
667
536
|
*/
|
|
668
537
|
quickSightConfiguration?: QuickSightConfiguration | undefined;
|
|
669
538
|
}
|
|
670
|
-
/**
|
|
671
|
-
* <p>You are trying to perform an action that conflicts with the current status of your resource. Fix any inconsistencies with your resources and try again.</p>
|
|
672
|
-
* @public
|
|
673
|
-
*/
|
|
674
|
-
export declare class ConflictException extends __BaseException {
|
|
675
|
-
readonly name: "ConflictException";
|
|
676
|
-
readonly $fault: "client";
|
|
677
|
-
/**
|
|
678
|
-
* <p>The identifier of the resource affected.</p>
|
|
679
|
-
* @public
|
|
680
|
-
*/
|
|
681
|
-
resourceId: string | undefined;
|
|
682
|
-
/**
|
|
683
|
-
* <p>The type of the resource affected.</p>
|
|
684
|
-
* @public
|
|
685
|
-
*/
|
|
686
|
-
resourceType: string | undefined;
|
|
687
|
-
/**
|
|
688
|
-
* @internal
|
|
689
|
-
*/
|
|
690
|
-
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
691
|
-
}
|
|
692
|
-
/**
|
|
693
|
-
* @public
|
|
694
|
-
* @enum
|
|
695
|
-
*/
|
|
696
|
-
export declare const AttachmentsControlMode: {
|
|
697
|
-
readonly DISABLED: "DISABLED";
|
|
698
|
-
readonly ENABLED: "ENABLED";
|
|
699
|
-
};
|
|
700
|
-
/**
|
|
701
|
-
* @public
|
|
702
|
-
*/
|
|
703
|
-
export type AttachmentsControlMode = (typeof AttachmentsControlMode)[keyof typeof AttachmentsControlMode];
|
|
704
539
|
/**
|
|
705
540
|
* <p>Configuration information for the file upload during chat feature.</p>
|
|
706
541
|
* @public
|
|
@@ -723,18 +558,6 @@ export interface EncryptionConfiguration {
|
|
|
723
558
|
*/
|
|
724
559
|
kmsKeyId?: string | undefined;
|
|
725
560
|
}
|
|
726
|
-
/**
|
|
727
|
-
* @public
|
|
728
|
-
* @enum
|
|
729
|
-
*/
|
|
730
|
-
export declare const PersonalizationControlMode: {
|
|
731
|
-
readonly DISABLED: "DISABLED";
|
|
732
|
-
readonly ENABLED: "ENABLED";
|
|
733
|
-
};
|
|
734
|
-
/**
|
|
735
|
-
* @public
|
|
736
|
-
*/
|
|
737
|
-
export type PersonalizationControlMode = (typeof PersonalizationControlMode)[keyof typeof PersonalizationControlMode];
|
|
738
561
|
/**
|
|
739
562
|
* <p>Configuration information about chat response personalization. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/personalizing-chat-responses.html">Personalizing chat responses</a>.</p>
|
|
740
563
|
* @public
|
|
@@ -746,18 +569,6 @@ export interface PersonalizationConfiguration {
|
|
|
746
569
|
*/
|
|
747
570
|
personalizationControlMode: PersonalizationControlMode | undefined;
|
|
748
571
|
}
|
|
749
|
-
/**
|
|
750
|
-
* @public
|
|
751
|
-
* @enum
|
|
752
|
-
*/
|
|
753
|
-
export declare const QAppsControlMode: {
|
|
754
|
-
readonly DISABLED: "DISABLED";
|
|
755
|
-
readonly ENABLED: "ENABLED";
|
|
756
|
-
};
|
|
757
|
-
/**
|
|
758
|
-
* @public
|
|
759
|
-
*/
|
|
760
|
-
export type QAppsControlMode = (typeof QAppsControlMode)[keyof typeof QAppsControlMode];
|
|
761
572
|
/**
|
|
762
573
|
* <p>Configuration information about Amazon Q Apps.</p>
|
|
763
574
|
* @public
|
|
@@ -875,74 +686,6 @@ export interface CreateApplicationResponse {
|
|
|
875
686
|
*/
|
|
876
687
|
applicationArn?: string | undefined;
|
|
877
688
|
}
|
|
878
|
-
/**
|
|
879
|
-
* <p>An issue occurred with the internal server used for your Amazon Q Business service. Wait some minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
|
|
880
|
-
* @public
|
|
881
|
-
*/
|
|
882
|
-
export declare class InternalServerException extends __BaseException {
|
|
883
|
-
readonly name: "InternalServerException";
|
|
884
|
-
readonly $fault: "server";
|
|
885
|
-
/**
|
|
886
|
-
* @internal
|
|
887
|
-
*/
|
|
888
|
-
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
889
|
-
}
|
|
890
|
-
/**
|
|
891
|
-
* <p>The application or plugin resource you want to use doesn’t exist. Make sure you have provided the correct resource and try again.</p>
|
|
892
|
-
* @public
|
|
893
|
-
*/
|
|
894
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
895
|
-
readonly name: "ResourceNotFoundException";
|
|
896
|
-
readonly $fault: "client";
|
|
897
|
-
/**
|
|
898
|
-
* <p>The identifier of the resource affected.</p>
|
|
899
|
-
* @public
|
|
900
|
-
*/
|
|
901
|
-
resourceId: string | undefined;
|
|
902
|
-
/**
|
|
903
|
-
* <p>The type of the resource affected.</p>
|
|
904
|
-
* @public
|
|
905
|
-
*/
|
|
906
|
-
resourceType: string | undefined;
|
|
907
|
-
/**
|
|
908
|
-
* @internal
|
|
909
|
-
*/
|
|
910
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
911
|
-
}
|
|
912
|
-
/**
|
|
913
|
-
* <p>You have exceeded the set limits for your Amazon Q Business service. </p>
|
|
914
|
-
* @public
|
|
915
|
-
*/
|
|
916
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
917
|
-
readonly name: "ServiceQuotaExceededException";
|
|
918
|
-
readonly $fault: "client";
|
|
919
|
-
/**
|
|
920
|
-
* <p>The identifier of the resource affected.</p>
|
|
921
|
-
* @public
|
|
922
|
-
*/
|
|
923
|
-
resourceId: string | undefined;
|
|
924
|
-
/**
|
|
925
|
-
* <p>The type of the resource affected.</p>
|
|
926
|
-
* @public
|
|
927
|
-
*/
|
|
928
|
-
resourceType: string | undefined;
|
|
929
|
-
/**
|
|
930
|
-
* @internal
|
|
931
|
-
*/
|
|
932
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
933
|
-
}
|
|
934
|
-
/**
|
|
935
|
-
* <p>The request was denied due to throttling. Reduce the number of requests and try again.</p>
|
|
936
|
-
* @public
|
|
937
|
-
*/
|
|
938
|
-
export declare class ThrottlingException extends __BaseException {
|
|
939
|
-
readonly name: "ThrottlingException";
|
|
940
|
-
readonly $fault: "client";
|
|
941
|
-
/**
|
|
942
|
-
* @internal
|
|
943
|
-
*/
|
|
944
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
945
|
-
}
|
|
946
689
|
/**
|
|
947
690
|
* <p>The input failed to meet the constraints specified by Amazon Q Business in a specified field.</p>
|
|
948
691
|
* @public
|
|
@@ -959,41 +702,6 @@ export interface ValidationExceptionField {
|
|
|
959
702
|
*/
|
|
960
703
|
message: string | undefined;
|
|
961
704
|
}
|
|
962
|
-
/**
|
|
963
|
-
* @public
|
|
964
|
-
* @enum
|
|
965
|
-
*/
|
|
966
|
-
export declare const ValidationExceptionReason: {
|
|
967
|
-
readonly CANNOT_PARSE: "CANNOT_PARSE";
|
|
968
|
-
readonly FIELD_VALIDATION_FAILED: "FIELD_VALIDATION_FAILED";
|
|
969
|
-
readonly UNKNOWN_OPERATION: "UNKNOWN_OPERATION";
|
|
970
|
-
};
|
|
971
|
-
/**
|
|
972
|
-
* @public
|
|
973
|
-
*/
|
|
974
|
-
export type ValidationExceptionReason = (typeof ValidationExceptionReason)[keyof typeof ValidationExceptionReason];
|
|
975
|
-
/**
|
|
976
|
-
* <p>The input doesn't meet the constraints set by the Amazon Q Business service. Provide the correct input and try again.</p>
|
|
977
|
-
* @public
|
|
978
|
-
*/
|
|
979
|
-
export declare class ValidationException extends __BaseException {
|
|
980
|
-
readonly name: "ValidationException";
|
|
981
|
-
readonly $fault: "client";
|
|
982
|
-
/**
|
|
983
|
-
* <p>The reason for the <code>ValidationException</code>.</p>
|
|
984
|
-
* @public
|
|
985
|
-
*/
|
|
986
|
-
reason: ValidationExceptionReason | undefined;
|
|
987
|
-
/**
|
|
988
|
-
* <p>The input field(s) that failed validation.</p>
|
|
989
|
-
* @public
|
|
990
|
-
*/
|
|
991
|
-
fields?: ValidationExceptionField[] | undefined;
|
|
992
|
-
/**
|
|
993
|
-
* @internal
|
|
994
|
-
*/
|
|
995
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
996
|
-
}
|
|
997
705
|
/**
|
|
998
706
|
* <p>Configuration details for IAM Identity Center Trusted Token Issuer (TTI) authentication.</p>
|
|
999
707
|
* @public
|
|
@@ -1038,18 +746,6 @@ export declare namespace DataAccessorAuthenticationConfiguration {
|
|
|
1038
746
|
_: (name: string, value: any) => T;
|
|
1039
747
|
}
|
|
1040
748
|
}
|
|
1041
|
-
/**
|
|
1042
|
-
* @public
|
|
1043
|
-
* @enum
|
|
1044
|
-
*/
|
|
1045
|
-
export declare const DataAccessorAuthenticationType: {
|
|
1046
|
-
readonly AWS_IAM_IDC_AUTH_CODE: "AWS_IAM_IDC_AUTH_CODE";
|
|
1047
|
-
readonly AWS_IAM_IDC_TTI: "AWS_IAM_IDC_TTI";
|
|
1048
|
-
};
|
|
1049
|
-
/**
|
|
1050
|
-
* @public
|
|
1051
|
-
*/
|
|
1052
|
-
export type DataAccessorAuthenticationType = (typeof DataAccessorAuthenticationType)[keyof typeof DataAccessorAuthenticationType];
|
|
1053
749
|
/**
|
|
1054
750
|
* <p>Contains the authentication configuration details for a data accessor. This structure defines how the ISV authenticates when accessing data through the data accessor.</p>
|
|
1055
751
|
* @public
|
|
@@ -1248,30 +944,6 @@ export interface AppliedAttachmentsConfiguration {
|
|
|
1248
944
|
*/
|
|
1249
945
|
attachmentsControlMode?: AttachmentsControlMode | undefined;
|
|
1250
946
|
}
|
|
1251
|
-
/**
|
|
1252
|
-
* @public
|
|
1253
|
-
* @enum
|
|
1254
|
-
*/
|
|
1255
|
-
export declare const AutoSubscriptionStatus: {
|
|
1256
|
-
readonly DISABLED: "DISABLED";
|
|
1257
|
-
readonly ENABLED: "ENABLED";
|
|
1258
|
-
};
|
|
1259
|
-
/**
|
|
1260
|
-
* @public
|
|
1261
|
-
*/
|
|
1262
|
-
export type AutoSubscriptionStatus = (typeof AutoSubscriptionStatus)[keyof typeof AutoSubscriptionStatus];
|
|
1263
|
-
/**
|
|
1264
|
-
* @public
|
|
1265
|
-
* @enum
|
|
1266
|
-
*/
|
|
1267
|
-
export declare const SubscriptionType: {
|
|
1268
|
-
readonly Q_BUSINESS: "Q_BUSINESS";
|
|
1269
|
-
readonly Q_LITE: "Q_LITE";
|
|
1270
|
-
};
|
|
1271
|
-
/**
|
|
1272
|
-
* @public
|
|
1273
|
-
*/
|
|
1274
|
-
export type SubscriptionType = (typeof SubscriptionType)[keyof typeof SubscriptionType];
|
|
1275
947
|
/**
|
|
1276
948
|
* <p>Subscription configuration information for an Amazon Q Business application using IAM identity federation for user management. </p>
|
|
1277
949
|
* @public
|
|
@@ -1288,20 +960,6 @@ export interface AutoSubscriptionConfiguration {
|
|
|
1288
960
|
*/
|
|
1289
961
|
defaultSubscriptionType?: SubscriptionType | undefined;
|
|
1290
962
|
}
|
|
1291
|
-
/**
|
|
1292
|
-
* @public
|
|
1293
|
-
* @enum
|
|
1294
|
-
*/
|
|
1295
|
-
export declare const ErrorCode: {
|
|
1296
|
-
readonly INTERNAL_ERROR: "InternalError";
|
|
1297
|
-
readonly INVALID_REQUEST: "InvalidRequest";
|
|
1298
|
-
readonly RESOURCE_INACTIVE: "ResourceInactive";
|
|
1299
|
-
readonly RESOURCE_NOT_FOUND: "ResourceNotFound";
|
|
1300
|
-
};
|
|
1301
|
-
/**
|
|
1302
|
-
* @public
|
|
1303
|
-
*/
|
|
1304
|
-
export type ErrorCode = (typeof ErrorCode)[keyof typeof ErrorCode];
|
|
1305
963
|
/**
|
|
1306
964
|
* <p>Provides information about a Amazon Q Business request error.</p>
|
|
1307
965
|
* @public
|
|
@@ -1429,18 +1087,6 @@ export interface IndexCapacityConfiguration {
|
|
|
1429
1087
|
*/
|
|
1430
1088
|
units?: number | undefined;
|
|
1431
1089
|
}
|
|
1432
|
-
/**
|
|
1433
|
-
* @public
|
|
1434
|
-
* @enum
|
|
1435
|
-
*/
|
|
1436
|
-
export declare const IndexType: {
|
|
1437
|
-
readonly ENTERPRISE: "ENTERPRISE";
|
|
1438
|
-
readonly STARTER: "STARTER";
|
|
1439
|
-
};
|
|
1440
|
-
/**
|
|
1441
|
-
* @public
|
|
1442
|
-
*/
|
|
1443
|
-
export type IndexType = (typeof IndexType)[keyof typeof IndexType];
|
|
1444
1090
|
/**
|
|
1445
1091
|
* @public
|
|
1446
1092
|
*/
|
|
@@ -1496,27 +1142,6 @@ export interface CreateIndexResponse {
|
|
|
1496
1142
|
*/
|
|
1497
1143
|
indexArn?: string | undefined;
|
|
1498
1144
|
}
|
|
1499
|
-
/**
|
|
1500
|
-
* @public
|
|
1501
|
-
* @enum
|
|
1502
|
-
*/
|
|
1503
|
-
export declare const DocumentEnrichmentConditionOperator: {
|
|
1504
|
-
readonly BEGINS_WITH: "BEGINS_WITH";
|
|
1505
|
-
readonly CONTAINS: "CONTAINS";
|
|
1506
|
-
readonly EQUALS: "EQUALS";
|
|
1507
|
-
readonly EXISTS: "EXISTS";
|
|
1508
|
-
readonly GREATER_THAN: "GREATER_THAN";
|
|
1509
|
-
readonly GREATER_THAN_OR_EQUALS: "GREATER_THAN_OR_EQUALS";
|
|
1510
|
-
readonly LESS_THAN: "LESS_THAN";
|
|
1511
|
-
readonly LESS_THAN_OR_EQUALS: "LESS_THAN_OR_EQUALS";
|
|
1512
|
-
readonly NOT_CONTAINS: "NOT_CONTAINS";
|
|
1513
|
-
readonly NOT_EQUALS: "NOT_EQUALS";
|
|
1514
|
-
readonly NOT_EXISTS: "NOT_EXISTS";
|
|
1515
|
-
};
|
|
1516
|
-
/**
|
|
1517
|
-
* @public
|
|
1518
|
-
*/
|
|
1519
|
-
export type DocumentEnrichmentConditionOperator = (typeof DocumentEnrichmentConditionOperator)[keyof typeof DocumentEnrichmentConditionOperator];
|
|
1520
1145
|
/**
|
|
1521
1146
|
* <p>The condition used for the target document attribute or metadata field when ingesting documents into Amazon Q Business. You use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html"> <code>DocumentAttributeTarget</code> </a> to apply the condition.</p> <p>For example, you can create the 'Department' target field and have it prefill department names associated with the documents based on information in the 'Source_URI' field. Set the condition that if the 'Source_URI' field contains 'financial' in its URI value, then prefill the target field 'Department' with the target value 'Finance' for the document.</p> <p>Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using <code>DocumentAttributeTarget</code>. Amazon Q Business then will map your newly created metadata field to your index field.</p>
|
|
1522
1147
|
* @public
|
|
@@ -1538,28 +1163,6 @@ export interface DocumentAttributeCondition {
|
|
|
1538
1163
|
*/
|
|
1539
1164
|
value?: DocumentAttributeValue | undefined;
|
|
1540
1165
|
}
|
|
1541
|
-
/**
|
|
1542
|
-
* @public
|
|
1543
|
-
* @enum
|
|
1544
|
-
*/
|
|
1545
|
-
export declare const DocumentContentOperator: {
|
|
1546
|
-
readonly DELETE: "DELETE";
|
|
1547
|
-
};
|
|
1548
|
-
/**
|
|
1549
|
-
* @public
|
|
1550
|
-
*/
|
|
1551
|
-
export type DocumentContentOperator = (typeof DocumentContentOperator)[keyof typeof DocumentContentOperator];
|
|
1552
|
-
/**
|
|
1553
|
-
* @public
|
|
1554
|
-
* @enum
|
|
1555
|
-
*/
|
|
1556
|
-
export declare const AttributeValueOperator: {
|
|
1557
|
-
readonly DELETE: "DELETE";
|
|
1558
|
-
};
|
|
1559
|
-
/**
|
|
1560
|
-
* @public
|
|
1561
|
-
*/
|
|
1562
|
-
export type AttributeValueOperator = (typeof AttributeValueOperator)[keyof typeof AttributeValueOperator];
|
|
1563
1166
|
/**
|
|
1564
1167
|
* <p>The target document attribute or metadata field you want to alter when ingesting documents into Amazon Q Business.</p> <p>For example, you can delete all customer identification numbers associated with the documents, stored in the document metadata field called 'Customer_ID' by setting the target key as 'Customer_ID' and the deletion flag to <code>TRUE</code>. This removes all customer ID values in the field 'Customer_ID'. This would scrub personally identifiable information from each document's metadata.</p> <p>Amazon Q Business can't create a target field if it has not already been created as an index field. After you create your index field, you can create a document metadata field using <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeTarget.html"> <code>DocumentAttributeTarget</code> </a>. Amazon Q Business will then map your newly created document attribute to your index field.</p> <p>You can also use this with <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeCondition.html"> <code>DocumentAttributeCondition</code> </a>.</p>
|
|
1565
1168
|
* @public
|
|
@@ -1649,18 +1252,6 @@ export interface DocumentEnrichmentConfiguration {
|
|
|
1649
1252
|
*/
|
|
1650
1253
|
postExtractionHookConfiguration?: HookConfiguration | undefined;
|
|
1651
1254
|
}
|
|
1652
|
-
/**
|
|
1653
|
-
* @public
|
|
1654
|
-
* @enum
|
|
1655
|
-
*/
|
|
1656
|
-
export declare const AudioExtractionStatus: {
|
|
1657
|
-
readonly DISABLED: "DISABLED";
|
|
1658
|
-
readonly ENABLED: "ENABLED";
|
|
1659
|
-
};
|
|
1660
|
-
/**
|
|
1661
|
-
* @public
|
|
1662
|
-
*/
|
|
1663
|
-
export type AudioExtractionStatus = (typeof AudioExtractionStatus)[keyof typeof AudioExtractionStatus];
|
|
1664
1255
|
/**
|
|
1665
1256
|
* <p>Configuration settings for audio content extraction and processing.</p>
|
|
1666
1257
|
* @public
|
|
@@ -1672,18 +1263,6 @@ export interface AudioExtractionConfiguration {
|
|
|
1672
1263
|
*/
|
|
1673
1264
|
audioExtractionStatus: AudioExtractionStatus | undefined;
|
|
1674
1265
|
}
|
|
1675
|
-
/**
|
|
1676
|
-
* @public
|
|
1677
|
-
* @enum
|
|
1678
|
-
*/
|
|
1679
|
-
export declare const ImageExtractionStatus: {
|
|
1680
|
-
readonly DISABLED: "DISABLED";
|
|
1681
|
-
readonly ENABLED: "ENABLED";
|
|
1682
|
-
};
|
|
1683
|
-
/**
|
|
1684
|
-
* @public
|
|
1685
|
-
*/
|
|
1686
|
-
export type ImageExtractionStatus = (typeof ImageExtractionStatus)[keyof typeof ImageExtractionStatus];
|
|
1687
1266
|
/**
|
|
1688
1267
|
* <p>The configuration for extracting semantic meaning from images in documents. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/extracting-meaning-from-images.html">Extracting semantic meaning from images and visuals</a>.</p>
|
|
1689
1268
|
* @public
|
|
@@ -1695,18 +1274,6 @@ export interface ImageExtractionConfiguration {
|
|
|
1695
1274
|
*/
|
|
1696
1275
|
imageExtractionStatus: ImageExtractionStatus | undefined;
|
|
1697
1276
|
}
|
|
1698
|
-
/**
|
|
1699
|
-
* @public
|
|
1700
|
-
* @enum
|
|
1701
|
-
*/
|
|
1702
|
-
export declare const VideoExtractionStatus: {
|
|
1703
|
-
readonly DISABLED: "DISABLED";
|
|
1704
|
-
readonly ENABLED: "ENABLED";
|
|
1705
|
-
};
|
|
1706
|
-
/**
|
|
1707
|
-
* @public
|
|
1708
|
-
*/
|
|
1709
|
-
export type VideoExtractionStatus = (typeof VideoExtractionStatus)[keyof typeof VideoExtractionStatus];
|
|
1710
1277
|
/**
|
|
1711
1278
|
* <p>Configuration settings for video content extraction and processing.</p>
|
|
1712
1279
|
* @public
|
|
@@ -1880,22 +1447,6 @@ export interface GetDataSourceRequest {
|
|
|
1880
1447
|
*/
|
|
1881
1448
|
dataSourceId: string | undefined;
|
|
1882
1449
|
}
|
|
1883
|
-
/**
|
|
1884
|
-
* @public
|
|
1885
|
-
* @enum
|
|
1886
|
-
*/
|
|
1887
|
-
export declare const DataSourceStatus: {
|
|
1888
|
-
readonly ACTIVE: "ACTIVE";
|
|
1889
|
-
readonly CREATING: "CREATING";
|
|
1890
|
-
readonly DELETING: "DELETING";
|
|
1891
|
-
readonly FAILED: "FAILED";
|
|
1892
|
-
readonly PENDING_CREATION: "PENDING_CREATION";
|
|
1893
|
-
readonly UPDATING: "UPDATING";
|
|
1894
|
-
};
|
|
1895
|
-
/**
|
|
1896
|
-
* @public
|
|
1897
|
-
*/
|
|
1898
|
-
export type DataSourceStatus = (typeof DataSourceStatus)[keyof typeof DataSourceStatus];
|
|
1899
1450
|
/**
|
|
1900
1451
|
* @public
|
|
1901
1452
|
*/
|
|
@@ -2162,32 +1713,6 @@ export interface GetIndexRequest {
|
|
|
2162
1713
|
*/
|
|
2163
1714
|
indexId: string | undefined;
|
|
2164
1715
|
}
|
|
2165
|
-
/**
|
|
2166
|
-
* @public
|
|
2167
|
-
* @enum
|
|
2168
|
-
*/
|
|
2169
|
-
export declare const Status: {
|
|
2170
|
-
readonly DISABLED: "DISABLED";
|
|
2171
|
-
readonly ENABLED: "ENABLED";
|
|
2172
|
-
};
|
|
2173
|
-
/**
|
|
2174
|
-
* @public
|
|
2175
|
-
*/
|
|
2176
|
-
export type Status = (typeof Status)[keyof typeof Status];
|
|
2177
|
-
/**
|
|
2178
|
-
* @public
|
|
2179
|
-
* @enum
|
|
2180
|
-
*/
|
|
2181
|
-
export declare const AttributeType: {
|
|
2182
|
-
readonly DATE: "DATE";
|
|
2183
|
-
readonly NUMBER: "NUMBER";
|
|
2184
|
-
readonly STRING: "STRING";
|
|
2185
|
-
readonly STRING_LIST: "STRING_LIST";
|
|
2186
|
-
};
|
|
2187
|
-
/**
|
|
2188
|
-
* @public
|
|
2189
|
-
*/
|
|
2190
|
-
export type AttributeType = (typeof AttributeType)[keyof typeof AttributeType];
|
|
2191
1716
|
/**
|
|
2192
1717
|
* <p>Configuration information for document attributes. Document attributes are metadata or fields associated with your documents. For example, the company department name associated with each document.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/doc-attributes.html">Understanding document attributes</a>.</p>
|
|
2193
1718
|
* @public
|
|
@@ -2236,21 +1761,6 @@ export interface IndexStatistics {
|
|
|
2236
1761
|
*/
|
|
2237
1762
|
textDocumentStatistics?: TextDocumentStatistics | undefined;
|
|
2238
1763
|
}
|
|
2239
|
-
/**
|
|
2240
|
-
* @public
|
|
2241
|
-
* @enum
|
|
2242
|
-
*/
|
|
2243
|
-
export declare const IndexStatus: {
|
|
2244
|
-
readonly ACTIVE: "ACTIVE";
|
|
2245
|
-
readonly CREATING: "CREATING";
|
|
2246
|
-
readonly DELETING: "DELETING";
|
|
2247
|
-
readonly FAILED: "FAILED";
|
|
2248
|
-
readonly UPDATING: "UPDATING";
|
|
2249
|
-
};
|
|
2250
|
-
/**
|
|
2251
|
-
* @public
|
|
2252
|
-
*/
|
|
2253
|
-
export type IndexStatus = (typeof IndexStatus)[keyof typeof IndexStatus];
|
|
2254
1764
|
/**
|
|
2255
1765
|
* @public
|
|
2256
1766
|
*/
|
|
@@ -2662,23 +2172,6 @@ export interface CreatePluginRequest {
|
|
|
2662
2172
|
*/
|
|
2663
2173
|
clientToken?: string | undefined;
|
|
2664
2174
|
}
|
|
2665
|
-
/**
|
|
2666
|
-
* @public
|
|
2667
|
-
* @enum
|
|
2668
|
-
*/
|
|
2669
|
-
export declare const PluginBuildStatus: {
|
|
2670
|
-
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
2671
|
-
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
2672
|
-
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
2673
|
-
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
2674
|
-
readonly READY: "READY";
|
|
2675
|
-
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
2676
|
-
readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
|
|
2677
|
-
};
|
|
2678
|
-
/**
|
|
2679
|
-
* @public
|
|
2680
|
-
*/
|
|
2681
|
-
export type PluginBuildStatus = (typeof PluginBuildStatus)[keyof typeof PluginBuildStatus];
|
|
2682
2175
|
/**
|
|
2683
2176
|
* @public
|
|
2684
2177
|
*/
|
|
@@ -2734,18 +2227,6 @@ export interface GetPluginRequest {
|
|
|
2734
2227
|
*/
|
|
2735
2228
|
pluginId: string | undefined;
|
|
2736
2229
|
}
|
|
2737
|
-
/**
|
|
2738
|
-
* @public
|
|
2739
|
-
* @enum
|
|
2740
|
-
*/
|
|
2741
|
-
export declare const PluginState: {
|
|
2742
|
-
readonly DISABLED: "DISABLED";
|
|
2743
|
-
readonly ENABLED: "ENABLED";
|
|
2744
|
-
};
|
|
2745
|
-
/**
|
|
2746
|
-
* @public
|
|
2747
|
-
*/
|
|
2748
|
-
export type PluginState = (typeof PluginState)[keyof typeof PluginState];
|
|
2749
2230
|
/**
|
|
2750
2231
|
* @public
|
|
2751
2232
|
*/
|
|
@@ -2948,23 +2429,6 @@ export interface KendraIndexConfiguration {
|
|
|
2948
2429
|
*/
|
|
2949
2430
|
indexId: string | undefined;
|
|
2950
2431
|
}
|
|
2951
|
-
/**
|
|
2952
|
-
* @public
|
|
2953
|
-
* @enum
|
|
2954
|
-
*/
|
|
2955
|
-
export declare const DocumentAttributeBoostingLevel: {
|
|
2956
|
-
readonly HIGH: "HIGH";
|
|
2957
|
-
readonly LOW: "LOW";
|
|
2958
|
-
readonly MEDIUM: "MEDIUM";
|
|
2959
|
-
readonly NONE: "NONE";
|
|
2960
|
-
readonly ONE: "ONE";
|
|
2961
|
-
readonly TWO: "TWO";
|
|
2962
|
-
readonly VERY_HIGH: "VERY_HIGH";
|
|
2963
|
-
};
|
|
2964
|
-
/**
|
|
2965
|
-
* @public
|
|
2966
|
-
*/
|
|
2967
|
-
export type DocumentAttributeBoostingLevel = (typeof DocumentAttributeBoostingLevel)[keyof typeof DocumentAttributeBoostingLevel];
|
|
2968
2432
|
/**
|
|
2969
2433
|
* <p>Provides information on boosting <code>DATE</code> type document attributes.</p> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2970
2434
|
* @public
|
|
@@ -2981,18 +2445,6 @@ export interface DateAttributeBoostingConfiguration {
|
|
|
2981
2445
|
*/
|
|
2982
2446
|
boostingDurationInSeconds?: number | undefined;
|
|
2983
2447
|
}
|
|
2984
|
-
/**
|
|
2985
|
-
* @public
|
|
2986
|
-
* @enum
|
|
2987
|
-
*/
|
|
2988
|
-
export declare const NumberAttributeBoostingType: {
|
|
2989
|
-
readonly PRIORITIZE_LARGER_VALUES: "PRIORITIZE_LARGER_VALUES";
|
|
2990
|
-
readonly PRIORITIZE_SMALLER_VALUES: "PRIORITIZE_SMALLER_VALUES";
|
|
2991
|
-
};
|
|
2992
|
-
/**
|
|
2993
|
-
* @public
|
|
2994
|
-
*/
|
|
2995
|
-
export type NumberAttributeBoostingType = (typeof NumberAttributeBoostingType)[keyof typeof NumberAttributeBoostingType];
|
|
2996
2448
|
/**
|
|
2997
2449
|
* <p>Provides information on boosting <code>NUMBER</code> type document attributes.</p> <p>In the current boosting implementation, boosting focuses primarily on <code>DATE</code> attributes for recency and <code>STRING</code> attributes for source prioritization. <code>NUMBER</code> attributes can serve as additional boosting factors when needed, but are not supported when using <code>NativeIndexConfiguration</code> version 2.</p> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
2998
2450
|
* @public
|
|
@@ -3009,25 +2461,6 @@ export interface NumberAttributeBoostingConfiguration {
|
|
|
3009
2461
|
*/
|
|
3010
2462
|
boostingType?: NumberAttributeBoostingType | undefined;
|
|
3011
2463
|
}
|
|
3012
|
-
/**
|
|
3013
|
-
* @public
|
|
3014
|
-
* @enum
|
|
3015
|
-
*/
|
|
3016
|
-
export declare const StringAttributeValueBoostingLevel: {
|
|
3017
|
-
readonly FIVE: "FIVE";
|
|
3018
|
-
readonly FOUR: "FOUR";
|
|
3019
|
-
readonly HIGH: "HIGH";
|
|
3020
|
-
readonly LOW: "LOW";
|
|
3021
|
-
readonly MEDIUM: "MEDIUM";
|
|
3022
|
-
readonly ONE: "ONE";
|
|
3023
|
-
readonly THREE: "THREE";
|
|
3024
|
-
readonly TWO: "TWO";
|
|
3025
|
-
readonly VERY_HIGH: "VERY_HIGH";
|
|
3026
|
-
};
|
|
3027
|
-
/**
|
|
3028
|
-
* @public
|
|
3029
|
-
*/
|
|
3030
|
-
export type StringAttributeValueBoostingLevel = (typeof StringAttributeValueBoostingLevel)[keyof typeof StringAttributeValueBoostingLevel];
|
|
3031
2464
|
/**
|
|
3032
2465
|
* <p>Provides information on boosting <code>STRING</code> type document attributes.</p> <note> <p>For <code>STRING</code> and <code>STRING_LIST</code> type document attributes to be used for boosting on the console and the API, they must be enabled for search using the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeConfiguration.html">DocumentAttributeConfiguration</a> object of the <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_UpdateIndex.html">UpdateIndex</a> API. If you haven't enabled searching on these attributes, you can't boost attributes of these data types on either the console or the API.</p> </note> <p>For more information on how boosting document attributes work in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/metadata-boosting.html">Boosting using document attributes</a>.</p>
|
|
3033
2466
|
* @public
|
|
@@ -3196,18 +2629,6 @@ export declare namespace RetrieverConfiguration {
|
|
|
3196
2629
|
_: (name: string, value: any) => T;
|
|
3197
2630
|
}
|
|
3198
2631
|
}
|
|
3199
|
-
/**
|
|
3200
|
-
* @public
|
|
3201
|
-
* @enum
|
|
3202
|
-
*/
|
|
3203
|
-
export declare const RetrieverType: {
|
|
3204
|
-
readonly KENDRA_INDEX: "KENDRA_INDEX";
|
|
3205
|
-
readonly NATIVE_INDEX: "NATIVE_INDEX";
|
|
3206
|
-
};
|
|
3207
|
-
/**
|
|
3208
|
-
* @public
|
|
3209
|
-
*/
|
|
3210
|
-
export type RetrieverType = (typeof RetrieverType)[keyof typeof RetrieverType];
|
|
3211
2632
|
/**
|
|
3212
2633
|
* @public
|
|
3213
2634
|
*/
|
|
@@ -3298,19 +2719,6 @@ export interface GetRetrieverRequest {
|
|
|
3298
2719
|
*/
|
|
3299
2720
|
retrieverId: string | undefined;
|
|
3300
2721
|
}
|
|
3301
|
-
/**
|
|
3302
|
-
* @public
|
|
3303
|
-
* @enum
|
|
3304
|
-
*/
|
|
3305
|
-
export declare const RetrieverStatus: {
|
|
3306
|
-
readonly ACTIVE: "ACTIVE";
|
|
3307
|
-
readonly CREATING: "CREATING";
|
|
3308
|
-
readonly FAILED: "FAILED";
|
|
3309
|
-
};
|
|
3310
|
-
/**
|
|
3311
|
-
* @public
|
|
3312
|
-
*/
|
|
3313
|
-
export type RetrieverStatus = (typeof RetrieverStatus)[keyof typeof RetrieverStatus];
|
|
3314
2722
|
/**
|
|
3315
2723
|
* @public
|
|
3316
2724
|
*/
|
|
@@ -3643,18 +3051,6 @@ export declare namespace IdentityProviderConfiguration {
|
|
|
3643
3051
|
_: (name: string, value: any) => T;
|
|
3644
3052
|
}
|
|
3645
3053
|
}
|
|
3646
|
-
/**
|
|
3647
|
-
* @public
|
|
3648
|
-
* @enum
|
|
3649
|
-
*/
|
|
3650
|
-
export declare const WebExperienceSamplePromptsControlMode: {
|
|
3651
|
-
readonly DISABLED: "DISABLED";
|
|
3652
|
-
readonly ENABLED: "ENABLED";
|
|
3653
|
-
};
|
|
3654
|
-
/**
|
|
3655
|
-
* @public
|
|
3656
|
-
*/
|
|
3657
|
-
export type WebExperienceSamplePromptsControlMode = (typeof WebExperienceSamplePromptsControlMode)[keyof typeof WebExperienceSamplePromptsControlMode];
|
|
3658
3054
|
/**
|
|
3659
3055
|
* @public
|
|
3660
3056
|
*/
|
|
@@ -3829,21 +3225,6 @@ export declare namespace WebExperienceAuthConfiguration {
|
|
|
3829
3225
|
_: (name: string, value: any) => T;
|
|
3830
3226
|
}
|
|
3831
3227
|
}
|
|
3832
|
-
/**
|
|
3833
|
-
* @public
|
|
3834
|
-
* @enum
|
|
3835
|
-
*/
|
|
3836
|
-
export declare const WebExperienceStatus: {
|
|
3837
|
-
readonly ACTIVE: "ACTIVE";
|
|
3838
|
-
readonly CREATING: "CREATING";
|
|
3839
|
-
readonly DELETING: "DELETING";
|
|
3840
|
-
readonly FAILED: "FAILED";
|
|
3841
|
-
readonly PENDING_AUTH_CONFIG: "PENDING_AUTH_CONFIG";
|
|
3842
|
-
};
|
|
3843
|
-
/**
|
|
3844
|
-
* @public
|
|
3845
|
-
*/
|
|
3846
|
-
export type WebExperienceStatus = (typeof WebExperienceStatus)[keyof typeof WebExperienceStatus];
|
|
3847
3228
|
/**
|
|
3848
3229
|
* @public
|
|
3849
3230
|
*/
|
|
@@ -4079,18 +3460,6 @@ export interface UpdateWebExperienceRequest {
|
|
|
4079
3460
|
*/
|
|
4080
3461
|
export interface UpdateWebExperienceResponse {
|
|
4081
3462
|
}
|
|
4082
|
-
/**
|
|
4083
|
-
* @public
|
|
4084
|
-
* @enum
|
|
4085
|
-
*/
|
|
4086
|
-
export declare const CreatorModeControl: {
|
|
4087
|
-
readonly DISABLED: "DISABLED";
|
|
4088
|
-
readonly ENABLED: "ENABLED";
|
|
4089
|
-
};
|
|
4090
|
-
/**
|
|
4091
|
-
* @public
|
|
4092
|
-
*/
|
|
4093
|
-
export type CreatorModeControl = (typeof CreatorModeControl)[keyof typeof CreatorModeControl];
|
|
4094
3463
|
/**
|
|
4095
3464
|
* <p>The creator mode specific admin controls configured for an Amazon Q Business application. Determines whether an end user can generate LLM-only responses when they use the web experience.</p> <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>
|
|
4096
3465
|
* @public
|
|
@@ -4102,18 +3471,6 @@ export interface AppliedCreatorModeConfiguration {
|
|
|
4102
3471
|
*/
|
|
4103
3472
|
creatorModeControl: CreatorModeControl | undefined;
|
|
4104
3473
|
}
|
|
4105
|
-
/**
|
|
4106
|
-
* @public
|
|
4107
|
-
* @enum
|
|
4108
|
-
*/
|
|
4109
|
-
export declare const OrchestrationControl: {
|
|
4110
|
-
readonly DISABLED: "DISABLED";
|
|
4111
|
-
readonly ENABLED: "ENABLED";
|
|
4112
|
-
};
|
|
4113
|
-
/**
|
|
4114
|
-
* @public
|
|
4115
|
-
*/
|
|
4116
|
-
export type OrchestrationControl = (typeof OrchestrationControl)[keyof typeof OrchestrationControl];
|
|
4117
3474
|
/**
|
|
4118
3475
|
* <p>The chat orchestration specific admin controls configured for an Amazon Q Business application. Determines whether Amazon Q Business automatically routes chat requests across configured plugins and data sources in your Amazon Q Business application.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails-global-controls.html#guardrails-global-orchestration">Chat orchestration settings</a>.</p>
|
|
4119
3476
|
* @public
|
|
@@ -4157,17 +3514,6 @@ export interface AssociatedUser {
|
|
|
4157
3514
|
*/
|
|
4158
3515
|
type?: MembershipType | undefined;
|
|
4159
3516
|
}
|
|
4160
|
-
/**
|
|
4161
|
-
* @public
|
|
4162
|
-
* @enum
|
|
4163
|
-
*/
|
|
4164
|
-
export declare const PermissionConditionOperator: {
|
|
4165
|
-
readonly STRING_EQUALS: "StringEquals";
|
|
4166
|
-
};
|
|
4167
|
-
/**
|
|
4168
|
-
* @public
|
|
4169
|
-
*/
|
|
4170
|
-
export type PermissionConditionOperator = (typeof PermissionConditionOperator)[keyof typeof PermissionConditionOperator];
|
|
4171
3517
|
/**
|
|
4172
3518
|
* <p>Defines a condition that restricts when a permission is effective. Conditions allow you to control access based on specific attributes of the request.</p>
|
|
4173
3519
|
* @public
|
|
@@ -4278,18 +3624,6 @@ export declare namespace CopyFromSource {
|
|
|
4278
3624
|
_: (name: string, value: any) => T;
|
|
4279
3625
|
}
|
|
4280
3626
|
}
|
|
4281
|
-
/**
|
|
4282
|
-
* @public
|
|
4283
|
-
* @enum
|
|
4284
|
-
*/
|
|
4285
|
-
export declare const AttachmentStatus: {
|
|
4286
|
-
readonly FAILED: "FAILED";
|
|
4287
|
-
readonly SUCCESS: "SUCCESS";
|
|
4288
|
-
};
|
|
4289
|
-
/**
|
|
4290
|
-
* @public
|
|
4291
|
-
*/
|
|
4292
|
-
export type AttachmentStatus = (typeof AttachmentStatus)[keyof typeof AttachmentStatus];
|
|
4293
3627
|
/**
|
|
4294
3628
|
* <p>An attachment in an Amazon Q Business conversation.</p>
|
|
4295
3629
|
* @public
|
|
@@ -4409,18 +3743,6 @@ export interface AttachmentOutput {
|
|
|
4409
3743
|
*/
|
|
4410
3744
|
conversationId?: string | undefined;
|
|
4411
3745
|
}
|
|
4412
|
-
/**
|
|
4413
|
-
* @public
|
|
4414
|
-
* @enum
|
|
4415
|
-
*/
|
|
4416
|
-
export declare const AudioExtractionType: {
|
|
4417
|
-
readonly SUMMARY: "SUMMARY";
|
|
4418
|
-
readonly TRANSCRIPT: "TRANSCRIPT";
|
|
4419
|
-
};
|
|
4420
|
-
/**
|
|
4421
|
-
* @public
|
|
4422
|
-
*/
|
|
4423
|
-
export type AudioExtractionType = (typeof AudioExtractionType)[keyof typeof AudioExtractionType];
|
|
4424
3746
|
/**
|
|
4425
3747
|
* <p>Details about an audio source, including its identifier, format, and time information.</p>
|
|
4426
3748
|
* @public
|
|
@@ -4608,28 +3930,6 @@ export declare namespace DocumentContent {
|
|
|
4608
3930
|
_: (name: string, value: any) => T;
|
|
4609
3931
|
}
|
|
4610
3932
|
}
|
|
4611
|
-
/**
|
|
4612
|
-
* @public
|
|
4613
|
-
* @enum
|
|
4614
|
-
*/
|
|
4615
|
-
export declare const ContentType: {
|
|
4616
|
-
readonly CSV: "CSV";
|
|
4617
|
-
readonly HTML: "HTML";
|
|
4618
|
-
readonly JSON: "JSON";
|
|
4619
|
-
readonly MD: "MD";
|
|
4620
|
-
readonly MS_EXCEL: "MS_EXCEL";
|
|
4621
|
-
readonly MS_WORD: "MS_WORD";
|
|
4622
|
-
readonly PDF: "PDF";
|
|
4623
|
-
readonly PLAIN_TEXT: "PLAIN_TEXT";
|
|
4624
|
-
readonly PPT: "PPT";
|
|
4625
|
-
readonly RTF: "RTF";
|
|
4626
|
-
readonly XML: "XML";
|
|
4627
|
-
readonly XSLT: "XSLT";
|
|
4628
|
-
};
|
|
4629
|
-
/**
|
|
4630
|
-
* @public
|
|
4631
|
-
*/
|
|
4632
|
-
export type ContentType = (typeof ContentType)[keyof typeof ContentType];
|
|
4633
3933
|
/**
|
|
4634
3934
|
* <p>A document in an Amazon Q Business application.</p>
|
|
4635
3935
|
* @public
|
|
@@ -4799,19 +4099,6 @@ export interface CancelSubscriptionResponse {
|
|
|
4799
4099
|
*/
|
|
4800
4100
|
nextSubscription?: SubscriptionDetails | undefined;
|
|
4801
4101
|
}
|
|
4802
|
-
/**
|
|
4803
|
-
* @public
|
|
4804
|
-
* @enum
|
|
4805
|
-
*/
|
|
4806
|
-
export declare const ChatMode: {
|
|
4807
|
-
readonly CREATOR_MODE: "CREATOR_MODE";
|
|
4808
|
-
readonly PLUGIN_MODE: "PLUGIN_MODE";
|
|
4809
|
-
readonly RETRIEVAL_MODE: "RETRIEVAL_MODE";
|
|
4810
|
-
};
|
|
4811
|
-
/**
|
|
4812
|
-
* @public
|
|
4813
|
-
*/
|
|
4814
|
-
export type ChatMode = (typeof ChatMode)[keyof typeof ChatMode];
|
|
4815
4102
|
/**
|
|
4816
4103
|
* <p>Configuration information required to invoke chat in <code>PLUGIN_MODE</code>.</p> <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>, and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
4817
4104
|
* @public
|
|
@@ -4926,18 +4213,6 @@ export interface ImageSourceDetails {
|
|
|
4926
4213
|
*/
|
|
4927
4214
|
mediaMimeType?: string | undefined;
|
|
4928
4215
|
}
|
|
4929
|
-
/**
|
|
4930
|
-
* @public
|
|
4931
|
-
* @enum
|
|
4932
|
-
*/
|
|
4933
|
-
export declare const VideoExtractionType: {
|
|
4934
|
-
readonly SUMMARY: "SUMMARY";
|
|
4935
|
-
readonly TRANSCRIPT: "TRANSCRIPT";
|
|
4936
|
-
};
|
|
4937
|
-
/**
|
|
4938
|
-
* @public
|
|
4939
|
-
*/
|
|
4940
|
-
export type VideoExtractionType = (typeof VideoExtractionType)[keyof typeof VideoExtractionType];
|
|
4941
4216
|
/**
|
|
4942
4217
|
* <p>Details about a video source, including its identifier, format, and time information.</p>
|
|
4943
4218
|
* @public
|
|
@@ -5150,18 +4425,6 @@ export interface MetadataEvent {
|
|
|
5150
4425
|
*/
|
|
5151
4426
|
finalTextMessage?: string | undefined;
|
|
5152
4427
|
}
|
|
5153
|
-
/**
|
|
5154
|
-
* @public
|
|
5155
|
-
* @enum
|
|
5156
|
-
*/
|
|
5157
|
-
export declare const SystemMessageType: {
|
|
5158
|
-
readonly GROUNDED_RESPONSE: "GROUNDED_RESPONSE";
|
|
5159
|
-
readonly RESPONSE: "RESPONSE";
|
|
5160
|
-
};
|
|
5161
|
-
/**
|
|
5162
|
-
* @public
|
|
5163
|
-
*/
|
|
5164
|
-
export type SystemMessageType = (typeof SystemMessageType)[keyof typeof SystemMessageType];
|
|
5165
4428
|
/**
|
|
5166
4429
|
* <p>An output event for an AI-generated response in an Amazon Q Business web experience.</p>
|
|
5167
4430
|
* @public
|
|
@@ -5296,44 +4559,6 @@ export interface ChatOutput {
|
|
|
5296
4559
|
*/
|
|
5297
4560
|
outputStream?: AsyncIterable<ChatOutputStream> | undefined;
|
|
5298
4561
|
}
|
|
5299
|
-
/**
|
|
5300
|
-
* <p>An external resource that you configured with your application is returning errors and preventing this operation from succeeding. Fix those errors and try again. </p>
|
|
5301
|
-
* @public
|
|
5302
|
-
*/
|
|
5303
|
-
export declare class ExternalResourceException extends __BaseException {
|
|
5304
|
-
readonly name: "ExternalResourceException";
|
|
5305
|
-
readonly $fault: "client";
|
|
5306
|
-
/**
|
|
5307
|
-
* @internal
|
|
5308
|
-
*/
|
|
5309
|
-
constructor(opts: __ExceptionOptionType<ExternalResourceException, __BaseException>);
|
|
5310
|
-
}
|
|
5311
|
-
/**
|
|
5312
|
-
* <p>You don't have permissions to perform the action because your license is inactive. Ask your admin to activate your license and try again after your licence is active.</p>
|
|
5313
|
-
* @public
|
|
5314
|
-
*/
|
|
5315
|
-
export declare class LicenseNotFoundException extends __BaseException {
|
|
5316
|
-
readonly name: "LicenseNotFoundException";
|
|
5317
|
-
readonly $fault: "client";
|
|
5318
|
-
/**
|
|
5319
|
-
* @internal
|
|
5320
|
-
*/
|
|
5321
|
-
constructor(opts: __ExceptionOptionType<LicenseNotFoundException, __BaseException>);
|
|
5322
|
-
}
|
|
5323
|
-
/**
|
|
5324
|
-
* @public
|
|
5325
|
-
* @enum
|
|
5326
|
-
*/
|
|
5327
|
-
export declare const ChatResponseConfigurationStatus: {
|
|
5328
|
-
readonly ACTIVE: "ACTIVE";
|
|
5329
|
-
readonly CREATING: "CREATING";
|
|
5330
|
-
readonly FAILED: "FAILED";
|
|
5331
|
-
readonly UPDATING: "UPDATING";
|
|
5332
|
-
};
|
|
5333
|
-
/**
|
|
5334
|
-
* @public
|
|
5335
|
-
*/
|
|
5336
|
-
export type ChatResponseConfigurationStatus = (typeof ChatResponseConfigurationStatus)[keyof typeof ChatResponseConfigurationStatus];
|
|
5337
4562
|
/**
|
|
5338
4563
|
* <p>Configuration details that define how Amazon Q Business generates and formats responses to user queries in chat interactions. This configuration allows administrators to customize response characteristics to meet specific organizational needs and communication standards.</p>
|
|
5339
4564
|
* @public
|
|
@@ -5375,17 +4600,6 @@ export interface ChatResponseConfiguration {
|
|
|
5375
4600
|
*/
|
|
5376
4601
|
updatedAt?: Date | undefined;
|
|
5377
4602
|
}
|
|
5378
|
-
/**
|
|
5379
|
-
* @public
|
|
5380
|
-
* @enum
|
|
5381
|
-
*/
|
|
5382
|
-
export declare const ResponseConfigurationType: {
|
|
5383
|
-
readonly ALL: "ALL";
|
|
5384
|
-
};
|
|
5385
|
-
/**
|
|
5386
|
-
* @public
|
|
5387
|
-
*/
|
|
5388
|
-
export type ResponseConfigurationType = (typeof ResponseConfigurationType)[keyof typeof ResponseConfigurationType];
|
|
5389
4603
|
/**
|
|
5390
4604
|
* <p>A set of instructions that define how Amazon Q Business should generate and format responses to user queries. This collection includes parameters for controlling response characteristics such as length, audience targeting, perspective, style, identity, tone, and custom instructions.</p>
|
|
5391
4605
|
* @public
|
|
@@ -6025,23 +5239,6 @@ export interface DataSourceSyncJobMetrics {
|
|
|
6025
5239
|
*/
|
|
6026
5240
|
documentsScanned?: string | undefined;
|
|
6027
5241
|
}
|
|
6028
|
-
/**
|
|
6029
|
-
* @public
|
|
6030
|
-
* @enum
|
|
6031
|
-
*/
|
|
6032
|
-
export declare const DataSourceSyncJobStatus: {
|
|
6033
|
-
readonly ABORTED: "ABORTED";
|
|
6034
|
-
readonly FAILED: "FAILED";
|
|
6035
|
-
readonly INCOMPLETE: "INCOMPLETE";
|
|
6036
|
-
readonly STOPPING: "STOPPING";
|
|
6037
|
-
readonly SUCCEEDED: "SUCCEEDED";
|
|
6038
|
-
readonly SYNCING: "SYNCING";
|
|
6039
|
-
readonly SYNCING_INDEXING: "SYNCING_INDEXING";
|
|
6040
|
-
};
|
|
6041
|
-
/**
|
|
6042
|
-
* @public
|
|
6043
|
-
*/
|
|
6044
|
-
export type DataSourceSyncJobStatus = (typeof DataSourceSyncJobStatus)[keyof typeof DataSourceSyncJobStatus];
|
|
6045
5242
|
/**
|
|
6046
5243
|
* <p>Provides information about an Amazon Q Business data source connector synchronization job.</p>
|
|
6047
5244
|
* @public
|
|
@@ -6243,24 +5440,6 @@ export interface DisassociatePermissionRequest {
|
|
|
6243
5440
|
*/
|
|
6244
5441
|
export interface DisassociatePermissionResponse {
|
|
6245
5442
|
}
|
|
6246
|
-
/**
|
|
6247
|
-
* @public
|
|
6248
|
-
* @enum
|
|
6249
|
-
*/
|
|
6250
|
-
export declare const DocumentStatus: {
|
|
6251
|
-
readonly DELETED: "DELETED";
|
|
6252
|
-
readonly DELETING: "DELETING";
|
|
6253
|
-
readonly DOCUMENT_FAILED_TO_INDEX: "DOCUMENT_FAILED_TO_INDEX";
|
|
6254
|
-
readonly FAILED: "FAILED";
|
|
6255
|
-
readonly INDEXED: "INDEXED";
|
|
6256
|
-
readonly PROCESSING: "PROCESSING";
|
|
6257
|
-
readonly RECEIVED: "RECEIVED";
|
|
6258
|
-
readonly UPDATED: "UPDATED";
|
|
6259
|
-
};
|
|
6260
|
-
/**
|
|
6261
|
-
* @public
|
|
6262
|
-
*/
|
|
6263
|
-
export type DocumentStatus = (typeof DocumentStatus)[keyof typeof DocumentStatus];
|
|
6264
5443
|
/**
|
|
6265
5444
|
* <p>The details of a document within an Amazon Q Business index.</p>
|
|
6266
5445
|
* @public
|
|
@@ -6312,18 +5491,6 @@ export interface GetChatControlsConfigurationRequest {
|
|
|
6312
5491
|
*/
|
|
6313
5492
|
nextToken?: string | undefined;
|
|
6314
5493
|
}
|
|
6315
|
-
/**
|
|
6316
|
-
* @public
|
|
6317
|
-
* @enum
|
|
6318
|
-
*/
|
|
6319
|
-
export declare const HallucinationReductionControl: {
|
|
6320
|
-
readonly DISABLED: "DISABLED";
|
|
6321
|
-
readonly ENABLED: "ENABLED";
|
|
6322
|
-
};
|
|
6323
|
-
/**
|
|
6324
|
-
* @public
|
|
6325
|
-
*/
|
|
6326
|
-
export type HallucinationReductionControl = (typeof HallucinationReductionControl)[keyof typeof HallucinationReductionControl];
|
|
6327
5494
|
/**
|
|
6328
5495
|
* <p>Configuration information required to setup hallucination reduction. For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/hallucination-reduction.html"> hallucination reduction</a>.</p> <note> <p>The hallucination reduction feature won't work if chat orchestration controls are enabled for your application.</p> </note>
|
|
6329
5496
|
* @public
|
|
@@ -6335,18 +5502,6 @@ export interface HallucinationReductionConfiguration {
|
|
|
6335
5502
|
*/
|
|
6336
5503
|
hallucinationReductionControl?: HallucinationReductionControl | undefined;
|
|
6337
5504
|
}
|
|
6338
|
-
/**
|
|
6339
|
-
* @public
|
|
6340
|
-
* @enum
|
|
6341
|
-
*/
|
|
6342
|
-
export declare const ResponseScope: {
|
|
6343
|
-
readonly ENTERPRISE_CONTENT_ONLY: "ENTERPRISE_CONTENT_ONLY";
|
|
6344
|
-
readonly EXTENDED_KNOWLEDGE_ENABLED: "EXTENDED_KNOWLEDGE_ENABLED";
|
|
6345
|
-
};
|
|
6346
|
-
/**
|
|
6347
|
-
* @public
|
|
6348
|
-
*/
|
|
6349
|
-
export type ResponseScope = (typeof ResponseScope)[keyof typeof ResponseScope];
|
|
6350
5505
|
/**
|
|
6351
5506
|
* <p>Provides information about users and group names associated with a topic control rule.</p>
|
|
6352
5507
|
* @public
|
|
@@ -6408,18 +5563,6 @@ export declare namespace RuleConfiguration {
|
|
|
6408
5563
|
_: (name: string, value: any) => T;
|
|
6409
5564
|
}
|
|
6410
5565
|
}
|
|
6411
|
-
/**
|
|
6412
|
-
* @public
|
|
6413
|
-
* @enum
|
|
6414
|
-
*/
|
|
6415
|
-
export declare const RuleType: {
|
|
6416
|
-
readonly CONTENT_BLOCKER_RULE: "CONTENT_BLOCKER_RULE";
|
|
6417
|
-
readonly CONTENT_RETRIEVAL_RULE: "CONTENT_RETRIEVAL_RULE";
|
|
6418
|
-
};
|
|
6419
|
-
/**
|
|
6420
|
-
* @public
|
|
6421
|
-
*/
|
|
6422
|
-
export type RuleType = (typeof RuleType)[keyof typeof RuleType];
|
|
6423
5566
|
/**
|
|
6424
5567
|
* <p>Guardrail rules for an Amazon Q Business application. Amazon Q Business supports only one rule at a time.</p>
|
|
6425
5568
|
* @public
|
|
@@ -6512,3 +5655,1210 @@ export interface GetChatControlsConfigurationResponse {
|
|
|
6512
5655
|
*/
|
|
6513
5656
|
hallucinationReductionConfiguration?: HallucinationReductionConfiguration | undefined;
|
|
6514
5657
|
}
|
|
5658
|
+
/**
|
|
5659
|
+
* @public
|
|
5660
|
+
*/
|
|
5661
|
+
export interface GetChatResponseConfigurationRequest {
|
|
5662
|
+
/**
|
|
5663
|
+
* <p>The unique identifier of the Amazon Q Business application containing the chat response configuration to retrieve.</p>
|
|
5664
|
+
* @public
|
|
5665
|
+
*/
|
|
5666
|
+
applicationId: string | undefined;
|
|
5667
|
+
/**
|
|
5668
|
+
* <p>The unique identifier of the chat response configuration to retrieve from the specified application.</p>
|
|
5669
|
+
* @public
|
|
5670
|
+
*/
|
|
5671
|
+
chatResponseConfigurationId: string | undefined;
|
|
5672
|
+
}
|
|
5673
|
+
/**
|
|
5674
|
+
* @public
|
|
5675
|
+
*/
|
|
5676
|
+
export interface GetChatResponseConfigurationResponse {
|
|
5677
|
+
/**
|
|
5678
|
+
* <p>The unique identifier of the retrieved chat response configuration.</p>
|
|
5679
|
+
* @public
|
|
5680
|
+
*/
|
|
5681
|
+
chatResponseConfigurationId?: string | undefined;
|
|
5682
|
+
/**
|
|
5683
|
+
* <p>The Amazon Resource Name (ARN) of the retrieved chat response configuration, which uniquely identifies the resource across all Amazon Web Services services. </p>
|
|
5684
|
+
* @public
|
|
5685
|
+
*/
|
|
5686
|
+
chatResponseConfigurationArn?: string | undefined;
|
|
5687
|
+
/**
|
|
5688
|
+
* <p>The human-readable name of the retrieved chat response configuration, making it easier to identify among multiple configurations.</p>
|
|
5689
|
+
* @public
|
|
5690
|
+
*/
|
|
5691
|
+
displayName?: string | undefined;
|
|
5692
|
+
/**
|
|
5693
|
+
* <p>The timestamp indicating when the chat response configuration was initially created.</p>
|
|
5694
|
+
* @public
|
|
5695
|
+
*/
|
|
5696
|
+
createdAt?: Date | undefined;
|
|
5697
|
+
/**
|
|
5698
|
+
* <p>The currently active configuration settings that are being used to generate responses in the Amazon Q Business application.</p>
|
|
5699
|
+
* @public
|
|
5700
|
+
*/
|
|
5701
|
+
inUseConfiguration?: ChatResponseConfigurationDetail | undefined;
|
|
5702
|
+
/**
|
|
5703
|
+
* <p>Information about the most recent update to the configuration, including timestamp and modification details.</p>
|
|
5704
|
+
* @public
|
|
5705
|
+
*/
|
|
5706
|
+
lastUpdateConfiguration?: ChatResponseConfigurationDetail | undefined;
|
|
5707
|
+
}
|
|
5708
|
+
/**
|
|
5709
|
+
* @public
|
|
5710
|
+
*/
|
|
5711
|
+
export interface GetDocumentContentRequest {
|
|
5712
|
+
/**
|
|
5713
|
+
* <p>The unique identifier of the Amazon Q Business application containing the document. This ensures the request is scoped to the correct application environment and its associated security policies.</p>
|
|
5714
|
+
* @public
|
|
5715
|
+
*/
|
|
5716
|
+
applicationId: string | undefined;
|
|
5717
|
+
/**
|
|
5718
|
+
* <p>The identifier of the index where documents are indexed.</p>
|
|
5719
|
+
* @public
|
|
5720
|
+
*/
|
|
5721
|
+
indexId: string | undefined;
|
|
5722
|
+
/**
|
|
5723
|
+
* <p>The identifier of the data source from which the document was ingested. This field is not present if the document is ingested by directly calling the BatchPutDocument API. If the document is from a file-upload data source, the datasource will be "uploaded-docs-file-stat-datasourceid".</p>
|
|
5724
|
+
* @public
|
|
5725
|
+
*/
|
|
5726
|
+
dataSourceId?: string | undefined;
|
|
5727
|
+
/**
|
|
5728
|
+
* <p>The unique identifier of the document that is indexed via BatchPutDocument API or file-upload or connector sync. It is also found in chat or chatSync response.</p>
|
|
5729
|
+
* @public
|
|
5730
|
+
*/
|
|
5731
|
+
documentId: string | undefined;
|
|
5732
|
+
/**
|
|
5733
|
+
* <p>Document outputFormat. Defaults to RAW if not selected.</p>
|
|
5734
|
+
* @public
|
|
5735
|
+
*/
|
|
5736
|
+
outputFormat?: OutputFormat | undefined;
|
|
5737
|
+
}
|
|
5738
|
+
/**
|
|
5739
|
+
* @public
|
|
5740
|
+
*/
|
|
5741
|
+
export interface GetDocumentContentResponse {
|
|
5742
|
+
/**
|
|
5743
|
+
* <p>A pre-signed URL that provides temporary access to download the document content directly from Amazon Q Business. The URL expires after 5 minutes for security purposes. This URL is generated only after successful ACL validation.</p>
|
|
5744
|
+
* @public
|
|
5745
|
+
*/
|
|
5746
|
+
presignedUrl: string | undefined;
|
|
5747
|
+
/**
|
|
5748
|
+
* <p>The MIME type of the document content. When outputFormat is RAW, this corresponds to the original document's MIME type (e.g., application/pdf, text/plain, application/vnd.openxmlformats-officedocument.wordprocessingml.document). When outputFormat is EXTRACTED, the MIME type is always application/json.</p>
|
|
5749
|
+
* @public
|
|
5750
|
+
*/
|
|
5751
|
+
mimeType: string | undefined;
|
|
5752
|
+
}
|
|
5753
|
+
/**
|
|
5754
|
+
* @public
|
|
5755
|
+
*/
|
|
5756
|
+
export interface GetGroupRequest {
|
|
5757
|
+
/**
|
|
5758
|
+
* <p>The identifier of the application id the group is attached to.</p>
|
|
5759
|
+
* @public
|
|
5760
|
+
*/
|
|
5761
|
+
applicationId: string | undefined;
|
|
5762
|
+
/**
|
|
5763
|
+
* <p>The identifier of the index the group is attached to.</p>
|
|
5764
|
+
* @public
|
|
5765
|
+
*/
|
|
5766
|
+
indexId: string | undefined;
|
|
5767
|
+
/**
|
|
5768
|
+
* <p>The name of the group.</p>
|
|
5769
|
+
* @public
|
|
5770
|
+
*/
|
|
5771
|
+
groupName: string | undefined;
|
|
5772
|
+
/**
|
|
5773
|
+
* <p>The identifier of the data source the group is attached to.</p>
|
|
5774
|
+
* @public
|
|
5775
|
+
*/
|
|
5776
|
+
dataSourceId?: string | undefined;
|
|
5777
|
+
}
|
|
5778
|
+
/**
|
|
5779
|
+
* <p>Provides the details of a group's status.</p>
|
|
5780
|
+
* @public
|
|
5781
|
+
*/
|
|
5782
|
+
export interface GroupStatusDetail {
|
|
5783
|
+
/**
|
|
5784
|
+
* <p>The status of a group.</p>
|
|
5785
|
+
* @public
|
|
5786
|
+
*/
|
|
5787
|
+
status?: GroupStatus | undefined;
|
|
5788
|
+
/**
|
|
5789
|
+
* <p>The Unix timestamp when the Amazon Q Business application was last updated.</p>
|
|
5790
|
+
* @public
|
|
5791
|
+
*/
|
|
5792
|
+
lastUpdatedAt?: Date | undefined;
|
|
5793
|
+
/**
|
|
5794
|
+
* <p>The details of an error associated a group status.</p>
|
|
5795
|
+
* @public
|
|
5796
|
+
*/
|
|
5797
|
+
errorDetail?: ErrorDetail | undefined;
|
|
5798
|
+
}
|
|
5799
|
+
/**
|
|
5800
|
+
* @public
|
|
5801
|
+
*/
|
|
5802
|
+
export interface GetGroupResponse {
|
|
5803
|
+
/**
|
|
5804
|
+
* <p>The current status of the group.</p>
|
|
5805
|
+
* @public
|
|
5806
|
+
*/
|
|
5807
|
+
status?: GroupStatusDetail | undefined;
|
|
5808
|
+
/**
|
|
5809
|
+
* <p>The status history of the group.</p>
|
|
5810
|
+
* @public
|
|
5811
|
+
*/
|
|
5812
|
+
statusHistory?: GroupStatusDetail[] | undefined;
|
|
5813
|
+
}
|
|
5814
|
+
/**
|
|
5815
|
+
* @public
|
|
5816
|
+
*/
|
|
5817
|
+
export interface GetMediaRequest {
|
|
5818
|
+
/**
|
|
5819
|
+
* <p>The identifier of the Amazon Q Business which contains the media object.</p>
|
|
5820
|
+
* @public
|
|
5821
|
+
*/
|
|
5822
|
+
applicationId: string | undefined;
|
|
5823
|
+
/**
|
|
5824
|
+
* <p>The identifier of the Amazon Q Business conversation.</p>
|
|
5825
|
+
* @public
|
|
5826
|
+
*/
|
|
5827
|
+
conversationId: string | undefined;
|
|
5828
|
+
/**
|
|
5829
|
+
* <p>The identifier of the Amazon Q Business message.</p>
|
|
5830
|
+
* @public
|
|
5831
|
+
*/
|
|
5832
|
+
messageId: string | undefined;
|
|
5833
|
+
/**
|
|
5834
|
+
* <p>The identifier of the media object. You can find this in the <code>sourceAttributions</code> returned by the <code>Chat</code>, <code>ChatSync</code>, and <code>ListMessages</code> API responses.</p>
|
|
5835
|
+
* @public
|
|
5836
|
+
*/
|
|
5837
|
+
mediaId: string | undefined;
|
|
5838
|
+
}
|
|
5839
|
+
/**
|
|
5840
|
+
* @public
|
|
5841
|
+
*/
|
|
5842
|
+
export interface GetMediaResponse {
|
|
5843
|
+
/**
|
|
5844
|
+
* <p>The base64-encoded bytes of the media object.</p>
|
|
5845
|
+
* @public
|
|
5846
|
+
*/
|
|
5847
|
+
mediaBytes?: Uint8Array | undefined;
|
|
5848
|
+
/**
|
|
5849
|
+
* <p>The MIME type of the media object (image/png).</p>
|
|
5850
|
+
* @public
|
|
5851
|
+
*/
|
|
5852
|
+
mediaMimeType?: string | undefined;
|
|
5853
|
+
}
|
|
5854
|
+
/**
|
|
5855
|
+
* @public
|
|
5856
|
+
*/
|
|
5857
|
+
export interface GetPolicyRequest {
|
|
5858
|
+
/**
|
|
5859
|
+
* <p>The unique identifier of the Amazon Q Business application.</p>
|
|
5860
|
+
* @public
|
|
5861
|
+
*/
|
|
5862
|
+
applicationId: string | undefined;
|
|
5863
|
+
}
|
|
5864
|
+
/**
|
|
5865
|
+
* @public
|
|
5866
|
+
*/
|
|
5867
|
+
export interface GetPolicyResponse {
|
|
5868
|
+
/**
|
|
5869
|
+
* <p>The JSON representation of the permission policy.</p>
|
|
5870
|
+
* @public
|
|
5871
|
+
*/
|
|
5872
|
+
policy?: string | undefined;
|
|
5873
|
+
}
|
|
5874
|
+
/**
|
|
5875
|
+
* @public
|
|
5876
|
+
*/
|
|
5877
|
+
export interface GetUserRequest {
|
|
5878
|
+
/**
|
|
5879
|
+
* <p>The identifier of the application connected to the user.</p>
|
|
5880
|
+
* @public
|
|
5881
|
+
*/
|
|
5882
|
+
applicationId: string | undefined;
|
|
5883
|
+
/**
|
|
5884
|
+
* <p>The user email address attached to the user.</p>
|
|
5885
|
+
* @public
|
|
5886
|
+
*/
|
|
5887
|
+
userId: string | undefined;
|
|
5888
|
+
}
|
|
5889
|
+
/**
|
|
5890
|
+
* @public
|
|
5891
|
+
*/
|
|
5892
|
+
export interface GetUserResponse {
|
|
5893
|
+
/**
|
|
5894
|
+
* <p>A list of user aliases attached to a user.</p>
|
|
5895
|
+
* @public
|
|
5896
|
+
*/
|
|
5897
|
+
userAliases?: UserAlias[] | undefined;
|
|
5898
|
+
}
|
|
5899
|
+
/**
|
|
5900
|
+
* @public
|
|
5901
|
+
*/
|
|
5902
|
+
export interface ListAttachmentsRequest {
|
|
5903
|
+
/**
|
|
5904
|
+
* <p>The unique identifier for the Amazon Q Business application.</p>
|
|
5905
|
+
* @public
|
|
5906
|
+
*/
|
|
5907
|
+
applicationId: string | undefined;
|
|
5908
|
+
/**
|
|
5909
|
+
* <p>The unique identifier of the Amazon Q Business web experience conversation.</p>
|
|
5910
|
+
* @public
|
|
5911
|
+
*/
|
|
5912
|
+
conversationId?: string | undefined;
|
|
5913
|
+
/**
|
|
5914
|
+
* <p>The unique identifier of the user involved in the Amazon Q Business web experience conversation.</p>
|
|
5915
|
+
* @public
|
|
5916
|
+
*/
|
|
5917
|
+
userId?: string | undefined;
|
|
5918
|
+
/**
|
|
5919
|
+
* <p>If the number of attachments returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of attachments.</p>
|
|
5920
|
+
* @public
|
|
5921
|
+
*/
|
|
5922
|
+
nextToken?: string | undefined;
|
|
5923
|
+
/**
|
|
5924
|
+
* <p>The maximum number of attachements to return.</p>
|
|
5925
|
+
* @public
|
|
5926
|
+
*/
|
|
5927
|
+
maxResults?: number | undefined;
|
|
5928
|
+
}
|
|
5929
|
+
/**
|
|
5930
|
+
* @public
|
|
5931
|
+
*/
|
|
5932
|
+
export interface ListAttachmentsResponse {
|
|
5933
|
+
/**
|
|
5934
|
+
* <p>An array of information on one or more attachments.</p>
|
|
5935
|
+
* @public
|
|
5936
|
+
*/
|
|
5937
|
+
attachments?: Attachment[] | undefined;
|
|
5938
|
+
/**
|
|
5939
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of attachments.</p>
|
|
5940
|
+
* @public
|
|
5941
|
+
*/
|
|
5942
|
+
nextToken?: string | undefined;
|
|
5943
|
+
}
|
|
5944
|
+
/**
|
|
5945
|
+
* @public
|
|
5946
|
+
*/
|
|
5947
|
+
export interface ListChatResponseConfigurationsRequest {
|
|
5948
|
+
/**
|
|
5949
|
+
* <p>The unique identifier of the Amazon Q Business application for which to list available chat response configurations.</p>
|
|
5950
|
+
* @public
|
|
5951
|
+
*/
|
|
5952
|
+
applicationId: string | undefined;
|
|
5953
|
+
/**
|
|
5954
|
+
* <p>The maximum number of chat response configurations to return in a single response. This parameter helps control pagination of results when many configurations exist.</p>
|
|
5955
|
+
* @public
|
|
5956
|
+
*/
|
|
5957
|
+
maxResults?: number | undefined;
|
|
5958
|
+
/**
|
|
5959
|
+
* <p>A pagination token used to retrieve the next set of results when the number of configurations exceeds the specified <code>maxResults</code> value.</p>
|
|
5960
|
+
* @public
|
|
5961
|
+
*/
|
|
5962
|
+
nextToken?: string | undefined;
|
|
5963
|
+
}
|
|
5964
|
+
/**
|
|
5965
|
+
* @public
|
|
5966
|
+
*/
|
|
5967
|
+
export interface ListChatResponseConfigurationsResponse {
|
|
5968
|
+
/**
|
|
5969
|
+
* <p>A list of chat response configuration summaries, each containing key information about an available configuration in the specified application.</p>
|
|
5970
|
+
* @public
|
|
5971
|
+
*/
|
|
5972
|
+
chatResponseConfigurations?: ChatResponseConfiguration[] | undefined;
|
|
5973
|
+
/**
|
|
5974
|
+
* <p>A pagination token that can be used in a subsequent request to retrieve additional chat response configurations if the results were truncated due to the <code>maxResults</code> parameter.</p>
|
|
5975
|
+
* @public
|
|
5976
|
+
*/
|
|
5977
|
+
nextToken?: string | undefined;
|
|
5978
|
+
}
|
|
5979
|
+
/**
|
|
5980
|
+
* @public
|
|
5981
|
+
*/
|
|
5982
|
+
export interface ListConversationsRequest {
|
|
5983
|
+
/**
|
|
5984
|
+
* <p>The identifier of the Amazon Q Business application.</p>
|
|
5985
|
+
* @public
|
|
5986
|
+
*/
|
|
5987
|
+
applicationId: string | undefined;
|
|
5988
|
+
/**
|
|
5989
|
+
* <p>The identifier of the user involved in the Amazon Q Business web experience conversation. </p>
|
|
5990
|
+
* @public
|
|
5991
|
+
*/
|
|
5992
|
+
userId?: string | undefined;
|
|
5993
|
+
/**
|
|
5994
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business conversations.</p>
|
|
5995
|
+
* @public
|
|
5996
|
+
*/
|
|
5997
|
+
nextToken?: string | undefined;
|
|
5998
|
+
/**
|
|
5999
|
+
* <p>The maximum number of Amazon Q Business conversations to return.</p>
|
|
6000
|
+
* @public
|
|
6001
|
+
*/
|
|
6002
|
+
maxResults?: number | undefined;
|
|
6003
|
+
}
|
|
6004
|
+
/**
|
|
6005
|
+
* @public
|
|
6006
|
+
*/
|
|
6007
|
+
export interface ListConversationsResponse {
|
|
6008
|
+
/**
|
|
6009
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.</p>
|
|
6010
|
+
* @public
|
|
6011
|
+
*/
|
|
6012
|
+
nextToken?: string | undefined;
|
|
6013
|
+
/**
|
|
6014
|
+
* <p>An array of summary information on the configuration of one or more Amazon Q Business web experiences.</p>
|
|
6015
|
+
* @public
|
|
6016
|
+
*/
|
|
6017
|
+
conversations?: Conversation[] | undefined;
|
|
6018
|
+
}
|
|
6019
|
+
/**
|
|
6020
|
+
* @public
|
|
6021
|
+
*/
|
|
6022
|
+
export interface ListDataSourceSyncJobsRequest {
|
|
6023
|
+
/**
|
|
6024
|
+
* <p> The identifier of the data source connector.</p>
|
|
6025
|
+
* @public
|
|
6026
|
+
*/
|
|
6027
|
+
dataSourceId: string | undefined;
|
|
6028
|
+
/**
|
|
6029
|
+
* <p>The identifier of the Amazon Q Business application connected to the data source.</p>
|
|
6030
|
+
* @public
|
|
6031
|
+
*/
|
|
6032
|
+
applicationId: string | undefined;
|
|
6033
|
+
/**
|
|
6034
|
+
* <p>The identifier of the index used with the Amazon Q Business data source connector.</p>
|
|
6035
|
+
* @public
|
|
6036
|
+
*/
|
|
6037
|
+
indexId: string | undefined;
|
|
6038
|
+
/**
|
|
6039
|
+
* <p>If the <code>maxResults</code> response was incpmplete because there is more data to retriever, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of responses.</p>
|
|
6040
|
+
* @public
|
|
6041
|
+
*/
|
|
6042
|
+
nextToken?: string | undefined;
|
|
6043
|
+
/**
|
|
6044
|
+
* <p>The maximum number of synchronization jobs to return in the response.</p>
|
|
6045
|
+
* @public
|
|
6046
|
+
*/
|
|
6047
|
+
maxResults?: number | undefined;
|
|
6048
|
+
/**
|
|
6049
|
+
* <p> The start time of the data source connector sync. </p>
|
|
6050
|
+
* @public
|
|
6051
|
+
*/
|
|
6052
|
+
startTime?: Date | undefined;
|
|
6053
|
+
/**
|
|
6054
|
+
* <p> The end time of the data source connector sync.</p>
|
|
6055
|
+
* @public
|
|
6056
|
+
*/
|
|
6057
|
+
endTime?: Date | undefined;
|
|
6058
|
+
/**
|
|
6059
|
+
* <p>Only returns synchronization jobs with the <code>Status</code> field equal to the specified status.</p>
|
|
6060
|
+
* @public
|
|
6061
|
+
*/
|
|
6062
|
+
statusFilter?: DataSourceSyncJobStatus | undefined;
|
|
6063
|
+
}
|
|
6064
|
+
/**
|
|
6065
|
+
* @public
|
|
6066
|
+
*/
|
|
6067
|
+
export interface ListDataSourceSyncJobsResponse {
|
|
6068
|
+
/**
|
|
6069
|
+
* <p>A history of synchronization jobs for the data source connector.</p>
|
|
6070
|
+
* @public
|
|
6071
|
+
*/
|
|
6072
|
+
history?: DataSourceSyncJob[] | undefined;
|
|
6073
|
+
/**
|
|
6074
|
+
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token in any subsequent request to retrieve the next set of jobs.</p>
|
|
6075
|
+
* @public
|
|
6076
|
+
*/
|
|
6077
|
+
nextToken?: string | undefined;
|
|
6078
|
+
}
|
|
6079
|
+
/**
|
|
6080
|
+
* @public
|
|
6081
|
+
*/
|
|
6082
|
+
export interface ListDocumentsRequest {
|
|
6083
|
+
/**
|
|
6084
|
+
* <p>The identifier of the application id the documents are attached to.</p>
|
|
6085
|
+
* @public
|
|
6086
|
+
*/
|
|
6087
|
+
applicationId: string | undefined;
|
|
6088
|
+
/**
|
|
6089
|
+
* <p>The identifier of the index the documents are attached to.</p>
|
|
6090
|
+
* @public
|
|
6091
|
+
*/
|
|
6092
|
+
indexId: string | undefined;
|
|
6093
|
+
/**
|
|
6094
|
+
* <p>The identifier of the data sources the documents are attached to.</p>
|
|
6095
|
+
* @public
|
|
6096
|
+
*/
|
|
6097
|
+
dataSourceIds?: string[] | undefined;
|
|
6098
|
+
/**
|
|
6099
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.</p>
|
|
6100
|
+
* @public
|
|
6101
|
+
*/
|
|
6102
|
+
nextToken?: string | undefined;
|
|
6103
|
+
/**
|
|
6104
|
+
* <p>The maximum number of documents to return.</p>
|
|
6105
|
+
* @public
|
|
6106
|
+
*/
|
|
6107
|
+
maxResults?: number | undefined;
|
|
6108
|
+
}
|
|
6109
|
+
/**
|
|
6110
|
+
* @public
|
|
6111
|
+
*/
|
|
6112
|
+
export interface ListDocumentsResponse {
|
|
6113
|
+
/**
|
|
6114
|
+
* <p>A list of document details.</p>
|
|
6115
|
+
* @public
|
|
6116
|
+
*/
|
|
6117
|
+
documentDetailList?: DocumentDetails[] | undefined;
|
|
6118
|
+
/**
|
|
6119
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.</p>
|
|
6120
|
+
* @public
|
|
6121
|
+
*/
|
|
6122
|
+
nextToken?: string | undefined;
|
|
6123
|
+
}
|
|
6124
|
+
/**
|
|
6125
|
+
* @public
|
|
6126
|
+
*/
|
|
6127
|
+
export interface ListGroupsRequest {
|
|
6128
|
+
/**
|
|
6129
|
+
* <p>The identifier of the application for getting a list of groups mapped to users.</p>
|
|
6130
|
+
* @public
|
|
6131
|
+
*/
|
|
6132
|
+
applicationId: string | undefined;
|
|
6133
|
+
/**
|
|
6134
|
+
* <p>The identifier of the index for getting a list of groups mapped to users.</p>
|
|
6135
|
+
* @public
|
|
6136
|
+
*/
|
|
6137
|
+
indexId: string | undefined;
|
|
6138
|
+
/**
|
|
6139
|
+
* <p>The timestamp identifier used for the latest <code>PUT</code> or <code>DELETE</code> action for mapping users to their groups.</p>
|
|
6140
|
+
* @public
|
|
6141
|
+
*/
|
|
6142
|
+
updatedEarlierThan: Date | undefined;
|
|
6143
|
+
/**
|
|
6144
|
+
* <p>The identifier of the data source for getting a list of groups mapped to users.</p>
|
|
6145
|
+
* @public
|
|
6146
|
+
*/
|
|
6147
|
+
dataSourceId?: string | undefined;
|
|
6148
|
+
/**
|
|
6149
|
+
* <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.</p>
|
|
6150
|
+
* @public
|
|
6151
|
+
*/
|
|
6152
|
+
nextToken?: string | undefined;
|
|
6153
|
+
/**
|
|
6154
|
+
* <p>The maximum number of returned groups that are mapped to users.</p>
|
|
6155
|
+
* @public
|
|
6156
|
+
*/
|
|
6157
|
+
maxResults?: number | undefined;
|
|
6158
|
+
}
|
|
6159
|
+
/**
|
|
6160
|
+
* <p>Summary information for groups.</p>
|
|
6161
|
+
* @public
|
|
6162
|
+
*/
|
|
6163
|
+
export interface GroupSummary {
|
|
6164
|
+
/**
|
|
6165
|
+
* <p>The name of the group the summary information is for.</p>
|
|
6166
|
+
* @public
|
|
6167
|
+
*/
|
|
6168
|
+
groupName?: string | undefined;
|
|
6169
|
+
}
|
|
6170
|
+
/**
|
|
6171
|
+
* @public
|
|
6172
|
+
*/
|
|
6173
|
+
export interface ListGroupsResponse {
|
|
6174
|
+
/**
|
|
6175
|
+
* <p>If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.</p>
|
|
6176
|
+
* @public
|
|
6177
|
+
*/
|
|
6178
|
+
nextToken?: string | undefined;
|
|
6179
|
+
/**
|
|
6180
|
+
* <p>Summary information for list of groups that are mapped to users.</p>
|
|
6181
|
+
* @public
|
|
6182
|
+
*/
|
|
6183
|
+
items?: GroupSummary[] | undefined;
|
|
6184
|
+
}
|
|
6185
|
+
/**
|
|
6186
|
+
* @public
|
|
6187
|
+
*/
|
|
6188
|
+
export interface ListMessagesRequest {
|
|
6189
|
+
/**
|
|
6190
|
+
* <p>The identifier of the Amazon Q Business web experience conversation.</p>
|
|
6191
|
+
* @public
|
|
6192
|
+
*/
|
|
6193
|
+
conversationId: string | undefined;
|
|
6194
|
+
/**
|
|
6195
|
+
* <p>The identifier for the Amazon Q Business application.</p>
|
|
6196
|
+
* @public
|
|
6197
|
+
*/
|
|
6198
|
+
applicationId: string | undefined;
|
|
6199
|
+
/**
|
|
6200
|
+
* <p>The identifier of the user involved in the Amazon Q Business web experience conversation.</p>
|
|
6201
|
+
* @public
|
|
6202
|
+
*/
|
|
6203
|
+
userId?: string | undefined;
|
|
6204
|
+
/**
|
|
6205
|
+
* <p>If the number of messages returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.</p>
|
|
6206
|
+
* @public
|
|
6207
|
+
*/
|
|
6208
|
+
nextToken?: string | undefined;
|
|
6209
|
+
/**
|
|
6210
|
+
* <p>The maximum number of messages to return.</p>
|
|
6211
|
+
* @public
|
|
6212
|
+
*/
|
|
6213
|
+
maxResults?: number | undefined;
|
|
6214
|
+
}
|
|
6215
|
+
/**
|
|
6216
|
+
* <p>A message in an Amazon Q Business web experience.</p>
|
|
6217
|
+
* @public
|
|
6218
|
+
*/
|
|
6219
|
+
export interface Message {
|
|
6220
|
+
/**
|
|
6221
|
+
* <p>The identifier of the Amazon Q Business web experience message.</p>
|
|
6222
|
+
* @public
|
|
6223
|
+
*/
|
|
6224
|
+
messageId?: string | undefined;
|
|
6225
|
+
/**
|
|
6226
|
+
* <p>The content of the Amazon Q Business web experience message.</p>
|
|
6227
|
+
* @public
|
|
6228
|
+
*/
|
|
6229
|
+
body?: string | undefined;
|
|
6230
|
+
/**
|
|
6231
|
+
* <p>The timestamp of the first Amazon Q Business web experience message.</p>
|
|
6232
|
+
* @public
|
|
6233
|
+
*/
|
|
6234
|
+
time?: Date | undefined;
|
|
6235
|
+
/**
|
|
6236
|
+
* <p>The type of Amazon Q Business message, whether <code>HUMAN</code> or <code>AI</code> generated.</p>
|
|
6237
|
+
* @public
|
|
6238
|
+
*/
|
|
6239
|
+
type?: MessageType | undefined;
|
|
6240
|
+
/**
|
|
6241
|
+
* <p>A file directly uploaded into an Amazon Q Business web experience chat.</p>
|
|
6242
|
+
* @public
|
|
6243
|
+
*/
|
|
6244
|
+
attachments?: AttachmentOutput[] | undefined;
|
|
6245
|
+
/**
|
|
6246
|
+
* <p>The source documents used to generate Amazon Q Business web experience message.</p>
|
|
6247
|
+
* @public
|
|
6248
|
+
*/
|
|
6249
|
+
sourceAttribution?: SourceAttribution[] | undefined;
|
|
6250
|
+
/**
|
|
6251
|
+
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.</p>
|
|
6252
|
+
* @public
|
|
6253
|
+
*/
|
|
6254
|
+
actionReview?: ActionReview | undefined;
|
|
6255
|
+
/**
|
|
6256
|
+
* <p>Performs an Amazon Q Business plugin action during a non-streaming chat conversation.</p>
|
|
6257
|
+
* @public
|
|
6258
|
+
*/
|
|
6259
|
+
actionExecution?: ActionExecution | undefined;
|
|
6260
|
+
}
|
|
6261
|
+
/**
|
|
6262
|
+
* @public
|
|
6263
|
+
*/
|
|
6264
|
+
export interface ListMessagesResponse {
|
|
6265
|
+
/**
|
|
6266
|
+
* <p>An array of information on one or more messages.</p>
|
|
6267
|
+
* @public
|
|
6268
|
+
*/
|
|
6269
|
+
messages?: Message[] | undefined;
|
|
6270
|
+
/**
|
|
6271
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.</p>
|
|
6272
|
+
* @public
|
|
6273
|
+
*/
|
|
6274
|
+
nextToken?: string | undefined;
|
|
6275
|
+
}
|
|
6276
|
+
/**
|
|
6277
|
+
* @public
|
|
6278
|
+
*/
|
|
6279
|
+
export interface ListPluginActionsRequest {
|
|
6280
|
+
/**
|
|
6281
|
+
* <p>The identifier of the Amazon Q Business application the plugin is attached to.</p>
|
|
6282
|
+
* @public
|
|
6283
|
+
*/
|
|
6284
|
+
applicationId: string | undefined;
|
|
6285
|
+
/**
|
|
6286
|
+
* <p>The identifier of the Amazon Q Business plugin.</p>
|
|
6287
|
+
* @public
|
|
6288
|
+
*/
|
|
6289
|
+
pluginId: string | undefined;
|
|
6290
|
+
/**
|
|
6291
|
+
* <p>If the number of plugin actions returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugin actions.</p>
|
|
6292
|
+
* @public
|
|
6293
|
+
*/
|
|
6294
|
+
nextToken?: string | undefined;
|
|
6295
|
+
/**
|
|
6296
|
+
* <p>The maximum number of plugin actions to return.</p>
|
|
6297
|
+
* @public
|
|
6298
|
+
*/
|
|
6299
|
+
maxResults?: number | undefined;
|
|
6300
|
+
}
|
|
6301
|
+
/**
|
|
6302
|
+
* @public
|
|
6303
|
+
*/
|
|
6304
|
+
export interface ListPluginActionsResponse {
|
|
6305
|
+
/**
|
|
6306
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin actions.</p>
|
|
6307
|
+
* @public
|
|
6308
|
+
*/
|
|
6309
|
+
nextToken?: string | undefined;
|
|
6310
|
+
/**
|
|
6311
|
+
* <p>An array of information on one or more plugin actions.</p>
|
|
6312
|
+
* @public
|
|
6313
|
+
*/
|
|
6314
|
+
items?: ActionSummary[] | undefined;
|
|
6315
|
+
}
|
|
6316
|
+
/**
|
|
6317
|
+
* @public
|
|
6318
|
+
*/
|
|
6319
|
+
export interface ListPluginTypeActionsRequest {
|
|
6320
|
+
/**
|
|
6321
|
+
* <p>The type of the plugin.</p>
|
|
6322
|
+
* @public
|
|
6323
|
+
*/
|
|
6324
|
+
pluginType: PluginType | undefined;
|
|
6325
|
+
/**
|
|
6326
|
+
* <p>If the number of plugins returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugins.</p>
|
|
6327
|
+
* @public
|
|
6328
|
+
*/
|
|
6329
|
+
nextToken?: string | undefined;
|
|
6330
|
+
/**
|
|
6331
|
+
* <p>The maximum number of plugins to return.</p>
|
|
6332
|
+
* @public
|
|
6333
|
+
*/
|
|
6334
|
+
maxResults?: number | undefined;
|
|
6335
|
+
}
|
|
6336
|
+
/**
|
|
6337
|
+
* @public
|
|
6338
|
+
*/
|
|
6339
|
+
export interface ListPluginTypeActionsResponse {
|
|
6340
|
+
/**
|
|
6341
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugins.</p>
|
|
6342
|
+
* @public
|
|
6343
|
+
*/
|
|
6344
|
+
nextToken?: string | undefined;
|
|
6345
|
+
/**
|
|
6346
|
+
* <p>An array of information on one or more plugins.</p>
|
|
6347
|
+
* @public
|
|
6348
|
+
*/
|
|
6349
|
+
items?: ActionSummary[] | undefined;
|
|
6350
|
+
}
|
|
6351
|
+
/**
|
|
6352
|
+
* @public
|
|
6353
|
+
*/
|
|
6354
|
+
export interface ListPluginTypeMetadataRequest {
|
|
6355
|
+
/**
|
|
6356
|
+
* <p>If the metadata returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of metadata.</p>
|
|
6357
|
+
* @public
|
|
6358
|
+
*/
|
|
6359
|
+
nextToken?: string | undefined;
|
|
6360
|
+
/**
|
|
6361
|
+
* <p>The maximum number of plugin metadata items to return.</p>
|
|
6362
|
+
* @public
|
|
6363
|
+
*/
|
|
6364
|
+
maxResults?: number | undefined;
|
|
6365
|
+
}
|
|
6366
|
+
/**
|
|
6367
|
+
* <p>Summary metadata information for a Amazon Q Business plugin.</p>
|
|
6368
|
+
* @public
|
|
6369
|
+
*/
|
|
6370
|
+
export interface PluginTypeMetadataSummary {
|
|
6371
|
+
/**
|
|
6372
|
+
* <p>The type of the plugin.</p>
|
|
6373
|
+
* @public
|
|
6374
|
+
*/
|
|
6375
|
+
type?: PluginType | undefined;
|
|
6376
|
+
/**
|
|
6377
|
+
* <p>The category of the plugin type.</p>
|
|
6378
|
+
* @public
|
|
6379
|
+
*/
|
|
6380
|
+
category?: PluginTypeCategory | undefined;
|
|
6381
|
+
/**
|
|
6382
|
+
* <p>The description assigned by Amazon Q Business to a plugin. You can't modify this value.</p>
|
|
6383
|
+
* @public
|
|
6384
|
+
*/
|
|
6385
|
+
description?: string | undefined;
|
|
6386
|
+
}
|
|
6387
|
+
/**
|
|
6388
|
+
* @public
|
|
6389
|
+
*/
|
|
6390
|
+
export interface ListPluginTypeMetadataResponse {
|
|
6391
|
+
/**
|
|
6392
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin metadata.</p>
|
|
6393
|
+
* @public
|
|
6394
|
+
*/
|
|
6395
|
+
nextToken?: string | undefined;
|
|
6396
|
+
/**
|
|
6397
|
+
* <p>An array of information on plugin metadata.</p>
|
|
6398
|
+
* @public
|
|
6399
|
+
*/
|
|
6400
|
+
items?: PluginTypeMetadataSummary[] | undefined;
|
|
6401
|
+
}
|
|
6402
|
+
/**
|
|
6403
|
+
* @public
|
|
6404
|
+
*/
|
|
6405
|
+
export interface ListSubscriptionsRequest {
|
|
6406
|
+
/**
|
|
6407
|
+
* <p>The identifier of the Amazon Q Business application linked to the subscription.</p>
|
|
6408
|
+
* @public
|
|
6409
|
+
*/
|
|
6410
|
+
applicationId: string | undefined;
|
|
6411
|
+
/**
|
|
6412
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business subscriptions.</p>
|
|
6413
|
+
* @public
|
|
6414
|
+
*/
|
|
6415
|
+
nextToken?: string | undefined;
|
|
6416
|
+
/**
|
|
6417
|
+
* <p>The maximum number of Amazon Q Business subscriptions to return.</p>
|
|
6418
|
+
* @public
|
|
6419
|
+
*/
|
|
6420
|
+
maxResults?: number | undefined;
|
|
6421
|
+
}
|
|
6422
|
+
/**
|
|
6423
|
+
* <p>Information about an Amazon Q Business subscription.</p> <p>Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application.</p> <p>Amazon Q Business offers two subscription tiers: <code>Q_LITE</code> and <code>Q_BUSINESS</code>. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business pricing</a>.</p>
|
|
6424
|
+
* @public
|
|
6425
|
+
*/
|
|
6426
|
+
export interface Subscription {
|
|
6427
|
+
/**
|
|
6428
|
+
* <p>The identifier of the Amazon Q Business subscription to be updated.</p>
|
|
6429
|
+
* @public
|
|
6430
|
+
*/
|
|
6431
|
+
subscriptionId?: string | undefined;
|
|
6432
|
+
/**
|
|
6433
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.</p>
|
|
6434
|
+
* @public
|
|
6435
|
+
*/
|
|
6436
|
+
subscriptionArn?: string | undefined;
|
|
6437
|
+
/**
|
|
6438
|
+
* <p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
|
|
6439
|
+
* @public
|
|
6440
|
+
*/
|
|
6441
|
+
principal?: SubscriptionPrincipal | undefined;
|
|
6442
|
+
/**
|
|
6443
|
+
* <p>The type of your current Amazon Q Business subscription.</p>
|
|
6444
|
+
* @public
|
|
6445
|
+
*/
|
|
6446
|
+
currentSubscription?: SubscriptionDetails | undefined;
|
|
6447
|
+
/**
|
|
6448
|
+
* <p>The type of the Amazon Q Business subscription for the next month.</p>
|
|
6449
|
+
* @public
|
|
6450
|
+
*/
|
|
6451
|
+
nextSubscription?: SubscriptionDetails | undefined;
|
|
6452
|
+
}
|
|
6453
|
+
/**
|
|
6454
|
+
* @public
|
|
6455
|
+
*/
|
|
6456
|
+
export interface ListSubscriptionsResponse {
|
|
6457
|
+
/**
|
|
6458
|
+
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of subscriptions.</p>
|
|
6459
|
+
* @public
|
|
6460
|
+
*/
|
|
6461
|
+
nextToken?: string | undefined;
|
|
6462
|
+
/**
|
|
6463
|
+
* <p>An array of summary information on the subscriptions configured for an Amazon Q Business application.</p>
|
|
6464
|
+
* @public
|
|
6465
|
+
*/
|
|
6466
|
+
subscriptions?: Subscription[] | undefined;
|
|
6467
|
+
}
|
|
6468
|
+
/**
|
|
6469
|
+
* @public
|
|
6470
|
+
*/
|
|
6471
|
+
export interface ListTagsForResourceRequest {
|
|
6472
|
+
/**
|
|
6473
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.</p>
|
|
6474
|
+
* @public
|
|
6475
|
+
*/
|
|
6476
|
+
resourceARN: string | undefined;
|
|
6477
|
+
}
|
|
6478
|
+
/**
|
|
6479
|
+
* @public
|
|
6480
|
+
*/
|
|
6481
|
+
export interface ListTagsForResourceResponse {
|
|
6482
|
+
/**
|
|
6483
|
+
* <p>A list of tags associated with the Amazon Q Business application or data source.</p>
|
|
6484
|
+
* @public
|
|
6485
|
+
*/
|
|
6486
|
+
tags?: Tag[] | undefined;
|
|
6487
|
+
}
|
|
6488
|
+
/**
|
|
6489
|
+
* <p>End user feedback on an AI-generated web experience chat message usefulness.</p>
|
|
6490
|
+
* @public
|
|
6491
|
+
*/
|
|
6492
|
+
export interface MessageUsefulnessFeedback {
|
|
6493
|
+
/**
|
|
6494
|
+
* <p>The usefulness value assigned by an end user to a message.</p>
|
|
6495
|
+
* @public
|
|
6496
|
+
*/
|
|
6497
|
+
usefulness: MessageUsefulness | undefined;
|
|
6498
|
+
/**
|
|
6499
|
+
* <p>The reason for a usefulness rating.</p>
|
|
6500
|
+
* @public
|
|
6501
|
+
*/
|
|
6502
|
+
reason?: MessageUsefulnessReason | undefined;
|
|
6503
|
+
/**
|
|
6504
|
+
* <p>A comment given by an end user on the usefulness of an AI-generated chat message.</p>
|
|
6505
|
+
* @public
|
|
6506
|
+
*/
|
|
6507
|
+
comment?: string | undefined;
|
|
6508
|
+
/**
|
|
6509
|
+
* <p>The timestamp for when the feedback was submitted.</p>
|
|
6510
|
+
* @public
|
|
6511
|
+
*/
|
|
6512
|
+
submittedAt: Date | undefined;
|
|
6513
|
+
}
|
|
6514
|
+
/**
|
|
6515
|
+
* @public
|
|
6516
|
+
*/
|
|
6517
|
+
export interface PutFeedbackRequest {
|
|
6518
|
+
/**
|
|
6519
|
+
* <p>The identifier of the application associated with the feedback.</p>
|
|
6520
|
+
* @public
|
|
6521
|
+
*/
|
|
6522
|
+
applicationId: string | undefined;
|
|
6523
|
+
/**
|
|
6524
|
+
* <p>The identifier of the user giving the feedback.</p>
|
|
6525
|
+
* @public
|
|
6526
|
+
*/
|
|
6527
|
+
userId?: string | undefined;
|
|
6528
|
+
/**
|
|
6529
|
+
* <p>The identifier of the conversation the feedback is attached to.</p>
|
|
6530
|
+
* @public
|
|
6531
|
+
*/
|
|
6532
|
+
conversationId: string | undefined;
|
|
6533
|
+
/**
|
|
6534
|
+
* <p>The identifier of the chat message that the feedback was given for.</p>
|
|
6535
|
+
* @public
|
|
6536
|
+
*/
|
|
6537
|
+
messageId: string | undefined;
|
|
6538
|
+
/**
|
|
6539
|
+
* <p>The timestamp for when the feedback was recorded.</p>
|
|
6540
|
+
* @public
|
|
6541
|
+
*/
|
|
6542
|
+
messageCopiedAt?: Date | undefined;
|
|
6543
|
+
/**
|
|
6544
|
+
* <p>The feedback usefulness value given by the user to the chat message.</p>
|
|
6545
|
+
* @public
|
|
6546
|
+
*/
|
|
6547
|
+
messageUsefulness?: MessageUsefulnessFeedback | undefined;
|
|
6548
|
+
}
|
|
6549
|
+
/**
|
|
6550
|
+
* <p>The sub groups that belong to a group.</p>
|
|
6551
|
+
* @public
|
|
6552
|
+
*/
|
|
6553
|
+
export interface MemberGroup {
|
|
6554
|
+
/**
|
|
6555
|
+
* <p>The name of the sub group.</p>
|
|
6556
|
+
* @public
|
|
6557
|
+
*/
|
|
6558
|
+
groupName: string | undefined;
|
|
6559
|
+
/**
|
|
6560
|
+
* <p>The type of the sub group.</p>
|
|
6561
|
+
* @public
|
|
6562
|
+
*/
|
|
6563
|
+
type?: MembershipType | undefined;
|
|
6564
|
+
}
|
|
6565
|
+
/**
|
|
6566
|
+
* <p>The users that belong to a group.</p>
|
|
6567
|
+
* @public
|
|
6568
|
+
*/
|
|
6569
|
+
export interface MemberUser {
|
|
6570
|
+
/**
|
|
6571
|
+
* <p>The identifier of the user you want to map to a group.</p>
|
|
6572
|
+
* @public
|
|
6573
|
+
*/
|
|
6574
|
+
userId: string | undefined;
|
|
6575
|
+
/**
|
|
6576
|
+
* <p>The type of the user.</p>
|
|
6577
|
+
* @public
|
|
6578
|
+
*/
|
|
6579
|
+
type?: MembershipType | undefined;
|
|
6580
|
+
}
|
|
6581
|
+
/**
|
|
6582
|
+
* <p>A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.</p>
|
|
6583
|
+
* @public
|
|
6584
|
+
*/
|
|
6585
|
+
export interface GroupMembers {
|
|
6586
|
+
/**
|
|
6587
|
+
* <p>A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".</p>
|
|
6588
|
+
* @public
|
|
6589
|
+
*/
|
|
6590
|
+
memberGroups?: MemberGroup[] | undefined;
|
|
6591
|
+
/**
|
|
6592
|
+
* <p>A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.</p>
|
|
6593
|
+
* @public
|
|
6594
|
+
*/
|
|
6595
|
+
memberUsers?: MemberUser[] | undefined;
|
|
6596
|
+
/**
|
|
6597
|
+
* <p>Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.</p>
|
|
6598
|
+
* @public
|
|
6599
|
+
*/
|
|
6600
|
+
s3PathForGroupMembers?: S3 | undefined;
|
|
6601
|
+
}
|
|
6602
|
+
/**
|
|
6603
|
+
* @public
|
|
6604
|
+
*/
|
|
6605
|
+
export interface PutGroupRequest {
|
|
6606
|
+
/**
|
|
6607
|
+
* <p>The identifier of the application in which the user and group mapping belongs.</p>
|
|
6608
|
+
* @public
|
|
6609
|
+
*/
|
|
6610
|
+
applicationId: string | undefined;
|
|
6611
|
+
/**
|
|
6612
|
+
* <p>The identifier of the index in which you want to map users to their groups.</p>
|
|
6613
|
+
* @public
|
|
6614
|
+
*/
|
|
6615
|
+
indexId: string | undefined;
|
|
6616
|
+
/**
|
|
6617
|
+
* <p>The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".</p>
|
|
6618
|
+
* @public
|
|
6619
|
+
*/
|
|
6620
|
+
groupName: string | undefined;
|
|
6621
|
+
/**
|
|
6622
|
+
* <p>The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.</p>
|
|
6623
|
+
* @public
|
|
6624
|
+
*/
|
|
6625
|
+
dataSourceId?: string | undefined;
|
|
6626
|
+
/**
|
|
6627
|
+
* <p>The type of the group.</p>
|
|
6628
|
+
* @public
|
|
6629
|
+
*/
|
|
6630
|
+
type: MembershipType | undefined;
|
|
6631
|
+
/**
|
|
6632
|
+
* <p>A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.</p>
|
|
6633
|
+
* @public
|
|
6634
|
+
*/
|
|
6635
|
+
groupMembers: GroupMembers | undefined;
|
|
6636
|
+
/**
|
|
6637
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.</p>
|
|
6638
|
+
* @public
|
|
6639
|
+
*/
|
|
6640
|
+
roleArn?: string | undefined;
|
|
6641
|
+
}
|
|
6642
|
+
/**
|
|
6643
|
+
* @public
|
|
6644
|
+
*/
|
|
6645
|
+
export interface PutGroupResponse {
|
|
6646
|
+
}
|
|
6647
|
+
/**
|
|
6648
|
+
* <p>Provides information about the relevance score of content.</p>
|
|
6649
|
+
* @public
|
|
6650
|
+
*/
|
|
6651
|
+
export interface ScoreAttributes {
|
|
6652
|
+
/**
|
|
6653
|
+
* <p>The confidence level of the relevance score.</p>
|
|
6654
|
+
* @public
|
|
6655
|
+
*/
|
|
6656
|
+
scoreConfidence?: ScoreConfidence | undefined;
|
|
6657
|
+
}
|
|
6658
|
+
/**
|
|
6659
|
+
* <p>Represents a piece of content that is relevant to a search query.</p>
|
|
6660
|
+
* @public
|
|
6661
|
+
*/
|
|
6662
|
+
export interface RelevantContent {
|
|
6663
|
+
/**
|
|
6664
|
+
* <p>The actual content of the relevant item.</p>
|
|
6665
|
+
* @public
|
|
6666
|
+
*/
|
|
6667
|
+
content?: string | undefined;
|
|
6668
|
+
/**
|
|
6669
|
+
* <p>The unique identifier of the document containing the relevant content.</p>
|
|
6670
|
+
* @public
|
|
6671
|
+
*/
|
|
6672
|
+
documentId?: string | undefined;
|
|
6673
|
+
/**
|
|
6674
|
+
* <p>The title of the document containing the relevant content.</p>
|
|
6675
|
+
* @public
|
|
6676
|
+
*/
|
|
6677
|
+
documentTitle?: string | undefined;
|
|
6678
|
+
/**
|
|
6679
|
+
* <p>The URI of the document containing the relevant content.</p>
|
|
6680
|
+
* @public
|
|
6681
|
+
*/
|
|
6682
|
+
documentUri?: string | undefined;
|
|
6683
|
+
/**
|
|
6684
|
+
* <p>Additional attributes of the document containing the relevant content.</p>
|
|
6685
|
+
* @public
|
|
6686
|
+
*/
|
|
6687
|
+
documentAttributes?: DocumentAttribute[] | undefined;
|
|
6688
|
+
/**
|
|
6689
|
+
* <p>Attributes related to the relevance score of the content.</p>
|
|
6690
|
+
* @public
|
|
6691
|
+
*/
|
|
6692
|
+
scoreAttributes?: ScoreAttributes | undefined;
|
|
6693
|
+
}
|
|
6694
|
+
/**
|
|
6695
|
+
* @public
|
|
6696
|
+
*/
|
|
6697
|
+
export interface SearchRelevantContentResponse {
|
|
6698
|
+
/**
|
|
6699
|
+
* <p>The list of relevant content items found.</p>
|
|
6700
|
+
* @public
|
|
6701
|
+
*/
|
|
6702
|
+
relevantContent?: RelevantContent[] | undefined;
|
|
6703
|
+
/**
|
|
6704
|
+
* <p>The token to use to retrieve the next set of results, if there are any.</p>
|
|
6705
|
+
* @public
|
|
6706
|
+
*/
|
|
6707
|
+
nextToken?: string | undefined;
|
|
6708
|
+
}
|
|
6709
|
+
/**
|
|
6710
|
+
* @public
|
|
6711
|
+
*/
|
|
6712
|
+
export interface StartDataSourceSyncJobRequest {
|
|
6713
|
+
/**
|
|
6714
|
+
* <p> The identifier of the data source connector. </p>
|
|
6715
|
+
* @public
|
|
6716
|
+
*/
|
|
6717
|
+
dataSourceId: string | undefined;
|
|
6718
|
+
/**
|
|
6719
|
+
* <p>The identifier of Amazon Q Business application the data source is connected to.</p>
|
|
6720
|
+
* @public
|
|
6721
|
+
*/
|
|
6722
|
+
applicationId: string | undefined;
|
|
6723
|
+
/**
|
|
6724
|
+
* <p>The identifier of the index used with the data source connector.</p>
|
|
6725
|
+
* @public
|
|
6726
|
+
*/
|
|
6727
|
+
indexId: string | undefined;
|
|
6728
|
+
}
|
|
6729
|
+
/**
|
|
6730
|
+
* @public
|
|
6731
|
+
*/
|
|
6732
|
+
export interface StartDataSourceSyncJobResponse {
|
|
6733
|
+
/**
|
|
6734
|
+
* <p>The identifier for a particular synchronization job.</p>
|
|
6735
|
+
* @public
|
|
6736
|
+
*/
|
|
6737
|
+
executionId?: string | undefined;
|
|
6738
|
+
}
|
|
6739
|
+
/**
|
|
6740
|
+
* @public
|
|
6741
|
+
*/
|
|
6742
|
+
export interface StopDataSourceSyncJobRequest {
|
|
6743
|
+
/**
|
|
6744
|
+
* <p> The identifier of the data source connector. </p>
|
|
6745
|
+
* @public
|
|
6746
|
+
*/
|
|
6747
|
+
dataSourceId: string | undefined;
|
|
6748
|
+
/**
|
|
6749
|
+
* <p>The identifier of the Amazon Q Business application that the data source is connected to.</p>
|
|
6750
|
+
* @public
|
|
6751
|
+
*/
|
|
6752
|
+
applicationId: string | undefined;
|
|
6753
|
+
/**
|
|
6754
|
+
* <p>The identifier of the index used with the Amazon Q Business data source connector.</p>
|
|
6755
|
+
* @public
|
|
6756
|
+
*/
|
|
6757
|
+
indexId: string | undefined;
|
|
6758
|
+
}
|
|
6759
|
+
/**
|
|
6760
|
+
* @public
|
|
6761
|
+
*/
|
|
6762
|
+
export interface StopDataSourceSyncJobResponse {
|
|
6763
|
+
}
|
|
6764
|
+
/**
|
|
6765
|
+
* @public
|
|
6766
|
+
*/
|
|
6767
|
+
export interface TagResourceRequest {
|
|
6768
|
+
/**
|
|
6769
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.</p>
|
|
6770
|
+
* @public
|
|
6771
|
+
*/
|
|
6772
|
+
resourceARN: string | undefined;
|
|
6773
|
+
/**
|
|
6774
|
+
* <p>A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.</p>
|
|
6775
|
+
* @public
|
|
6776
|
+
*/
|
|
6777
|
+
tags: Tag[] | undefined;
|
|
6778
|
+
}
|
|
6779
|
+
/**
|
|
6780
|
+
* @public
|
|
6781
|
+
*/
|
|
6782
|
+
export interface TagResourceResponse {
|
|
6783
|
+
}
|
|
6784
|
+
/**
|
|
6785
|
+
* @public
|
|
6786
|
+
*/
|
|
6787
|
+
export interface UntagResourceRequest {
|
|
6788
|
+
/**
|
|
6789
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.</p>
|
|
6790
|
+
* @public
|
|
6791
|
+
*/
|
|
6792
|
+
resourceARN: string | undefined;
|
|
6793
|
+
/**
|
|
6794
|
+
* <p>A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.</p>
|
|
6795
|
+
* @public
|
|
6796
|
+
*/
|
|
6797
|
+
tagKeys: string[] | undefined;
|
|
6798
|
+
}
|
|
6799
|
+
/**
|
|
6800
|
+
* @public
|
|
6801
|
+
*/
|
|
6802
|
+
export interface UntagResourceResponse {
|
|
6803
|
+
}
|
|
6804
|
+
/**
|
|
6805
|
+
* <p>Configuration information required to enable chat orchestration for your Amazon Q Business application.</p> <note> <p>Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html">Supported languages</a>.</p> </note>
|
|
6806
|
+
* @public
|
|
6807
|
+
*/
|
|
6808
|
+
export interface OrchestrationConfiguration {
|
|
6809
|
+
/**
|
|
6810
|
+
* <p> Status information about whether chat orchestration is activated or deactivated for your Amazon Q Business application.</p>
|
|
6811
|
+
* @public
|
|
6812
|
+
*/
|
|
6813
|
+
control: OrchestrationControl | undefined;
|
|
6814
|
+
}
|
|
6815
|
+
/**
|
|
6816
|
+
* @public
|
|
6817
|
+
*/
|
|
6818
|
+
export interface UpdateChatControlsConfigurationRequest {
|
|
6819
|
+
/**
|
|
6820
|
+
* <p>The identifier of the application for which the chat controls are configured.</p>
|
|
6821
|
+
* @public
|
|
6822
|
+
*/
|
|
6823
|
+
applicationId: string | undefined;
|
|
6824
|
+
/**
|
|
6825
|
+
* <p>A token that you provide to identify the request to update a Amazon Q Business application chat configuration.</p>
|
|
6826
|
+
* @public
|
|
6827
|
+
*/
|
|
6828
|
+
clientToken?: string | undefined;
|
|
6829
|
+
/**
|
|
6830
|
+
* <p>The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.</p>
|
|
6831
|
+
* @public
|
|
6832
|
+
*/
|
|
6833
|
+
responseScope?: ResponseScope | undefined;
|
|
6834
|
+
/**
|
|
6835
|
+
* <p> The chat response orchestration settings for your application.</p>
|
|
6836
|
+
* @public
|
|
6837
|
+
*/
|
|
6838
|
+
orchestrationConfiguration?: OrchestrationConfiguration | undefined;
|
|
6839
|
+
/**
|
|
6840
|
+
* <p>The phrases blocked from chat by your chat control configuration.</p>
|
|
6841
|
+
* @public
|
|
6842
|
+
*/
|
|
6843
|
+
blockedPhrasesConfigurationUpdate?: BlockedPhrasesConfigurationUpdate | undefined;
|
|
6844
|
+
/**
|
|
6845
|
+
* <p>The configured topic specific chat controls you want to update.</p>
|
|
6846
|
+
* @public
|
|
6847
|
+
*/
|
|
6848
|
+
topicConfigurationsToCreateOrUpdate?: TopicConfiguration[] | undefined;
|
|
6849
|
+
/**
|
|
6850
|
+
* <p>The configured topic specific chat controls you want to delete.</p>
|
|
6851
|
+
* @public
|
|
6852
|
+
*/
|
|
6853
|
+
topicConfigurationsToDelete?: TopicConfiguration[] | undefined;
|
|
6854
|
+
/**
|
|
6855
|
+
* <p>The configuration details for <code>CREATOR_MODE</code>.</p>
|
|
6856
|
+
* @public
|
|
6857
|
+
*/
|
|
6858
|
+
creatorModeConfiguration?: CreatorModeConfiguration | undefined;
|
|
6859
|
+
/**
|
|
6860
|
+
* <p> The hallucination reduction settings for your application.</p>
|
|
6861
|
+
* @public
|
|
6862
|
+
*/
|
|
6863
|
+
hallucinationReductionConfiguration?: HallucinationReductionConfiguration | undefined;
|
|
6864
|
+
}
|