@aws-sdk/client-qconnect 3.686.0 → 3.691.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-types/models/models_0.d.ts +347 -347
- package/dist-types/ts3.4/models/models_0.d.ts +373 -347
- package/package.json +7 -7
|
@@ -41,7 +41,7 @@ export interface TagCondition {
|
|
|
41
41
|
* <p>The tag value in the tag condition.</p>
|
|
42
42
|
* @public
|
|
43
43
|
*/
|
|
44
|
-
value?: string;
|
|
44
|
+
value?: string | undefined;
|
|
45
45
|
}
|
|
46
46
|
/**
|
|
47
47
|
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
@@ -167,19 +167,19 @@ export interface KnowledgeBaseAssociationConfigurationData {
|
|
|
167
167
|
* <p>An object that can be used to specify Tag conditions.</p>
|
|
168
168
|
* @public
|
|
169
169
|
*/
|
|
170
|
-
contentTagFilter?: TagFilter;
|
|
170
|
+
contentTagFilter?: TagFilter | undefined;
|
|
171
171
|
/**
|
|
172
172
|
* <p>The maximum number of results to return per page.</p>
|
|
173
173
|
* @public
|
|
174
174
|
*/
|
|
175
|
-
maxResults?: number;
|
|
175
|
+
maxResults?: number | undefined;
|
|
176
176
|
/**
|
|
177
177
|
* <p>The search type to be used against the Knowledge Base for this request. The values can be
|
|
178
178
|
* <code>SEMANTIC</code> which uses vector embeddings or <code>HYBRID</code> which use vector
|
|
179
179
|
* embeddings and raw text</p>
|
|
180
180
|
* @public
|
|
181
181
|
*/
|
|
182
|
-
overrideKnowledgeBaseSearchType?: KnowledgeBaseSearchType;
|
|
182
|
+
overrideKnowledgeBaseSearchType?: KnowledgeBaseSearchType | undefined;
|
|
183
183
|
}
|
|
184
184
|
/**
|
|
185
185
|
* <p>A typed union of the data of the configuration for an Amazon Q in Connect Assistant
|
|
@@ -233,17 +233,17 @@ export interface AssociationConfiguration {
|
|
|
233
233
|
* <p>The identifier of the association for this Association Configuration.</p>
|
|
234
234
|
* @public
|
|
235
235
|
*/
|
|
236
|
-
associationId?: string;
|
|
236
|
+
associationId?: string | undefined;
|
|
237
237
|
/**
|
|
238
238
|
* <p>The type of the association for this Association Configuration.</p>
|
|
239
239
|
* @public
|
|
240
240
|
*/
|
|
241
|
-
associationType?: AIAgentAssociationConfigurationType;
|
|
241
|
+
associationType?: AIAgentAssociationConfigurationType | undefined;
|
|
242
242
|
/**
|
|
243
243
|
* <p>The data of the configuration for an Amazon Q in Connect Assistant Association.</p>
|
|
244
244
|
* @public
|
|
245
245
|
*/
|
|
246
|
-
associationConfigurationData?: AssociationConfigurationData;
|
|
246
|
+
associationConfigurationData?: AssociationConfigurationData | undefined;
|
|
247
247
|
}
|
|
248
248
|
/**
|
|
249
249
|
* <p>The configuration for the <code>ANSWER_RECOMMENDATION</code> AI Agent type.</p>
|
|
@@ -255,24 +255,24 @@ export interface AnswerRecommendationAIAgentConfiguration {
|
|
|
255
255
|
* <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
|
|
256
256
|
* @public
|
|
257
257
|
*/
|
|
258
|
-
intentLabelingGenerationAIPromptId?: string;
|
|
258
|
+
intentLabelingGenerationAIPromptId?: string | undefined;
|
|
259
259
|
/**
|
|
260
260
|
* <p>The AI Prompt identifier for the Query Reformulation prompt used by the
|
|
261
261
|
* <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
|
|
262
262
|
* @public
|
|
263
263
|
*/
|
|
264
|
-
queryReformulationAIPromptId?: string;
|
|
264
|
+
queryReformulationAIPromptId?: string | undefined;
|
|
265
265
|
/**
|
|
266
266
|
* <p>The AI Prompt identifier for the Answer Generation prompt used by the
|
|
267
267
|
* <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
|
|
268
268
|
* @public
|
|
269
269
|
*/
|
|
270
|
-
answerGenerationAIPromptId?: string;
|
|
270
|
+
answerGenerationAIPromptId?: string | undefined;
|
|
271
271
|
/**
|
|
272
272
|
* <p>The association configurations for overriding behavior on this AI Agent.</p>
|
|
273
273
|
* @public
|
|
274
274
|
*/
|
|
275
|
-
associationConfigurations?: AssociationConfiguration[];
|
|
275
|
+
associationConfigurations?: AssociationConfiguration[] | undefined;
|
|
276
276
|
}
|
|
277
277
|
/**
|
|
278
278
|
* <p>The configuration for the <code>MANUAL_SEARCH</code> AI Agent type.</p>
|
|
@@ -284,12 +284,12 @@ export interface ManualSearchAIAgentConfiguration {
|
|
|
284
284
|
* Agent.</p>
|
|
285
285
|
* @public
|
|
286
286
|
*/
|
|
287
|
-
answerGenerationAIPromptId?: string;
|
|
287
|
+
answerGenerationAIPromptId?: string | undefined;
|
|
288
288
|
/**
|
|
289
289
|
* <p>The association configurations for overriding behavior on this AI Agent.</p>
|
|
290
290
|
* @public
|
|
291
291
|
*/
|
|
292
|
-
associationConfigurations?: AssociationConfiguration[];
|
|
292
|
+
associationConfigurations?: AssociationConfiguration[] | undefined;
|
|
293
293
|
}
|
|
294
294
|
/**
|
|
295
295
|
* <p>A typed union that specifies the configuration based on the type of AI Agent.</p>
|
|
@@ -367,7 +367,7 @@ export interface CreateAIAgentRequest {
|
|
|
367
367
|
* idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
368
368
|
* @public
|
|
369
369
|
*/
|
|
370
|
-
clientToken?: string;
|
|
370
|
+
clientToken?: string | undefined;
|
|
371
371
|
/**
|
|
372
372
|
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
373
373
|
* cannot contain the ARN.</p>
|
|
@@ -398,12 +398,12 @@ export interface CreateAIAgentRequest {
|
|
|
398
398
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
399
399
|
* @public
|
|
400
400
|
*/
|
|
401
|
-
tags?: Record<string, string
|
|
401
|
+
tags?: Record<string, string> | undefined;
|
|
402
402
|
/**
|
|
403
403
|
* <p>The description of the AI Agent.</p>
|
|
404
404
|
* @public
|
|
405
405
|
*/
|
|
406
|
-
description?: string;
|
|
406
|
+
description?: string | undefined;
|
|
407
407
|
}
|
|
408
408
|
/**
|
|
409
409
|
* @public
|
|
@@ -478,12 +478,12 @@ export interface AIAgentData {
|
|
|
478
478
|
* <p>The time the AI Agent was last modified.</p>
|
|
479
479
|
* @public
|
|
480
480
|
*/
|
|
481
|
-
modifiedTime?: Date;
|
|
481
|
+
modifiedTime?: Date | undefined;
|
|
482
482
|
/**
|
|
483
483
|
* <p>The description of the AI Agent.</p>
|
|
484
484
|
* @public
|
|
485
485
|
*/
|
|
486
|
-
description?: string;
|
|
486
|
+
description?: string | undefined;
|
|
487
487
|
/**
|
|
488
488
|
* <p>The visibility status of the AI Agent.</p>
|
|
489
489
|
* @public
|
|
@@ -493,19 +493,19 @@ export interface AIAgentData {
|
|
|
493
493
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
494
494
|
* @public
|
|
495
495
|
*/
|
|
496
|
-
tags?: Record<string, string
|
|
496
|
+
tags?: Record<string, string> | undefined;
|
|
497
497
|
/**
|
|
498
498
|
* <p>Specifies the origin of the AI Agent. <code>SYSTEM</code> for a default AI Agent created
|
|
499
499
|
* by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation
|
|
500
500
|
* APIs. </p>
|
|
501
501
|
* @public
|
|
502
502
|
*/
|
|
503
|
-
origin?: Origin;
|
|
503
|
+
origin?: Origin | undefined;
|
|
504
504
|
/**
|
|
505
505
|
* <p>The status of the AI Agent.</p>
|
|
506
506
|
* @public
|
|
507
507
|
*/
|
|
508
|
-
status?: Status;
|
|
508
|
+
status?: Status | undefined;
|
|
509
509
|
}
|
|
510
510
|
/**
|
|
511
511
|
* @public
|
|
@@ -515,7 +515,7 @@ export interface CreateAIAgentResponse {
|
|
|
515
515
|
* <p>The data of the created AI Agent.</p>
|
|
516
516
|
* @public
|
|
517
517
|
*/
|
|
518
|
-
aiAgent?: AIAgentData;
|
|
518
|
+
aiAgent?: AIAgentData | undefined;
|
|
519
519
|
}
|
|
520
520
|
/**
|
|
521
521
|
* <p>The specified resource does not exist.</p>
|
|
@@ -528,7 +528,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
528
528
|
* <p>The specified resource name.</p>
|
|
529
529
|
* @public
|
|
530
530
|
*/
|
|
531
|
-
resourceName?: string;
|
|
531
|
+
resourceName?: string | undefined;
|
|
532
532
|
/**
|
|
533
533
|
* @internal
|
|
534
534
|
*/
|
|
@@ -595,14 +595,14 @@ export interface CreateAIAgentVersionRequest {
|
|
|
595
595
|
* specified modification time has been made.</p>
|
|
596
596
|
* @public
|
|
597
597
|
*/
|
|
598
|
-
modifiedTime?: Date;
|
|
598
|
+
modifiedTime?: Date | undefined;
|
|
599
599
|
/**
|
|
600
600
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
601
601
|
* request. If not provided, the AWS SDK populates this field. For more information about
|
|
602
602
|
* idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
603
603
|
* @public
|
|
604
604
|
*/
|
|
605
|
-
clientToken?: string;
|
|
605
|
+
clientToken?: string | undefined;
|
|
606
606
|
}
|
|
607
607
|
/**
|
|
608
608
|
* @public
|
|
@@ -612,12 +612,12 @@ export interface CreateAIAgentVersionResponse {
|
|
|
612
612
|
* <p>The data of the AI Agent version.</p>
|
|
613
613
|
* @public
|
|
614
614
|
*/
|
|
615
|
-
aiAgent?: AIAgentData;
|
|
615
|
+
aiAgent?: AIAgentData | undefined;
|
|
616
616
|
/**
|
|
617
617
|
* <p>The version number of the AI Agent version.</p>
|
|
618
618
|
* @public
|
|
619
619
|
*/
|
|
620
|
-
versionNumber?: number;
|
|
620
|
+
versionNumber?: number | undefined;
|
|
621
621
|
}
|
|
622
622
|
/**
|
|
623
623
|
* @public
|
|
@@ -693,13 +693,13 @@ export interface GetAIAgentResponse {
|
|
|
693
693
|
* <p>The data of the AI Agent.</p>
|
|
694
694
|
* @public
|
|
695
695
|
*/
|
|
696
|
-
aiAgent?: AIAgentData;
|
|
696
|
+
aiAgent?: AIAgentData | undefined;
|
|
697
697
|
/**
|
|
698
698
|
* <p>The version number of the AI Agent version (returned if an AI Agent version was specified
|
|
699
699
|
* via use of a qualifier for the <code>aiAgentId</code> on the request). </p>
|
|
700
700
|
* @public
|
|
701
701
|
*/
|
|
702
|
-
versionNumber?: number;
|
|
702
|
+
versionNumber?: number | undefined;
|
|
703
703
|
}
|
|
704
704
|
/**
|
|
705
705
|
* @public
|
|
@@ -716,19 +716,19 @@ export interface ListAIAgentsRequest {
|
|
|
716
716
|
* the next request to retrieve the next set of results.</p>
|
|
717
717
|
* @public
|
|
718
718
|
*/
|
|
719
|
-
nextToken?: string;
|
|
719
|
+
nextToken?: string | undefined;
|
|
720
720
|
/**
|
|
721
721
|
* <p>The maximum number of results to return per page.</p>
|
|
722
722
|
* @public
|
|
723
723
|
*/
|
|
724
|
-
maxResults?: number;
|
|
724
|
+
maxResults?: number | undefined;
|
|
725
725
|
/**
|
|
726
726
|
* <p>The origin of the AI Agents to be listed. <code>SYSTEM</code> for a default AI Agent
|
|
727
727
|
* created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent
|
|
728
728
|
* creation APIs. </p>
|
|
729
729
|
* @public
|
|
730
730
|
*/
|
|
731
|
-
origin?: Origin;
|
|
731
|
+
origin?: Origin | undefined;
|
|
732
732
|
}
|
|
733
733
|
/**
|
|
734
734
|
* <p>The summary of the AI Agent.</p>
|
|
@@ -770,7 +770,7 @@ export interface AIAgentSummary {
|
|
|
770
770
|
* <p>The time the AI Agent was last modified.</p>
|
|
771
771
|
* @public
|
|
772
772
|
*/
|
|
773
|
-
modifiedTime?: Date;
|
|
773
|
+
modifiedTime?: Date | undefined;
|
|
774
774
|
/**
|
|
775
775
|
* <p>The visibility status of the AI Agent.</p>
|
|
776
776
|
* @public
|
|
@@ -780,29 +780,29 @@ export interface AIAgentSummary {
|
|
|
780
780
|
* <p>The configuration for the AI Agent.</p>
|
|
781
781
|
* @public
|
|
782
782
|
*/
|
|
783
|
-
configuration?: AIAgentConfiguration;
|
|
783
|
+
configuration?: AIAgentConfiguration | undefined;
|
|
784
784
|
/**
|
|
785
785
|
* <p>The origin of the AI Agent. <code>SYSTEM</code> for a default AI Agent created by Q in
|
|
786
786
|
* Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation
|
|
787
787
|
* APIs.</p>
|
|
788
788
|
* @public
|
|
789
789
|
*/
|
|
790
|
-
origin?: Origin;
|
|
790
|
+
origin?: Origin | undefined;
|
|
791
791
|
/**
|
|
792
792
|
* <p>The description of the AI Agent.</p>
|
|
793
793
|
* @public
|
|
794
794
|
*/
|
|
795
|
-
description?: string;
|
|
795
|
+
description?: string | undefined;
|
|
796
796
|
/**
|
|
797
797
|
* <p>The status of the AI Agent.</p>
|
|
798
798
|
* @public
|
|
799
799
|
*/
|
|
800
|
-
status?: Status;
|
|
800
|
+
status?: Status | undefined;
|
|
801
801
|
/**
|
|
802
802
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
803
803
|
* @public
|
|
804
804
|
*/
|
|
805
|
-
tags?: Record<string, string
|
|
805
|
+
tags?: Record<string, string> | undefined;
|
|
806
806
|
}
|
|
807
807
|
/**
|
|
808
808
|
* @public
|
|
@@ -818,7 +818,7 @@ export interface ListAIAgentsResponse {
|
|
|
818
818
|
* the next request to retrieve the next set of results.</p>
|
|
819
819
|
* @public
|
|
820
820
|
*/
|
|
821
|
-
nextToken?: string;
|
|
821
|
+
nextToken?: string | undefined;
|
|
822
822
|
}
|
|
823
823
|
/**
|
|
824
824
|
* @public
|
|
@@ -841,19 +841,19 @@ export interface ListAIAgentVersionsRequest {
|
|
|
841
841
|
* the next request to retrieve the next set of results.</p>
|
|
842
842
|
* @public
|
|
843
843
|
*/
|
|
844
|
-
nextToken?: string;
|
|
844
|
+
nextToken?: string | undefined;
|
|
845
845
|
/**
|
|
846
846
|
* <p>The maximum number of results to return per page.</p>
|
|
847
847
|
* @public
|
|
848
848
|
*/
|
|
849
|
-
maxResults?: number;
|
|
849
|
+
maxResults?: number | undefined;
|
|
850
850
|
/**
|
|
851
851
|
* <p>The origin of the AI Agent versions to be listed. <code>SYSTEM</code> for a default AI
|
|
852
852
|
* Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI
|
|
853
853
|
* Agent creation APIs. </p>
|
|
854
854
|
* @public
|
|
855
855
|
*/
|
|
856
|
-
origin?: Origin;
|
|
856
|
+
origin?: Origin | undefined;
|
|
857
857
|
}
|
|
858
858
|
/**
|
|
859
859
|
* <p>The summary of the AI Agent version.</p>
|
|
@@ -864,12 +864,12 @@ export interface AIAgentVersionSummary {
|
|
|
864
864
|
* <p>The data for the summary of the AI Agent version.</p>
|
|
865
865
|
* @public
|
|
866
866
|
*/
|
|
867
|
-
aiAgentSummary?: AIAgentSummary;
|
|
867
|
+
aiAgentSummary?: AIAgentSummary | undefined;
|
|
868
868
|
/**
|
|
869
869
|
* <p>The version number for this AI Agent version.</p>
|
|
870
870
|
* @public
|
|
871
871
|
*/
|
|
872
|
-
versionNumber?: number;
|
|
872
|
+
versionNumber?: number | undefined;
|
|
873
873
|
}
|
|
874
874
|
/**
|
|
875
875
|
* @public
|
|
@@ -885,7 +885,7 @@ export interface ListAIAgentVersionsResponse {
|
|
|
885
885
|
* the next request to retrieve the next set of results.</p>
|
|
886
886
|
* @public
|
|
887
887
|
*/
|
|
888
|
-
nextToken?: string;
|
|
888
|
+
nextToken?: string | undefined;
|
|
889
889
|
}
|
|
890
890
|
/**
|
|
891
891
|
* @public
|
|
@@ -897,7 +897,7 @@ export interface UpdateAIAgentRequest {
|
|
|
897
897
|
* idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
898
898
|
* @public
|
|
899
899
|
*/
|
|
900
|
-
clientToken?: string;
|
|
900
|
+
clientToken?: string | undefined;
|
|
901
901
|
/**
|
|
902
902
|
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
903
903
|
* cannot contain the ARN.</p>
|
|
@@ -918,12 +918,12 @@ export interface UpdateAIAgentRequest {
|
|
|
918
918
|
* <p>The configuration of the Amazon Q in Connect AI Agent.</p>
|
|
919
919
|
* @public
|
|
920
920
|
*/
|
|
921
|
-
configuration?: AIAgentConfiguration;
|
|
921
|
+
configuration?: AIAgentConfiguration | undefined;
|
|
922
922
|
/**
|
|
923
923
|
* <p>The description of the Amazon Q in Connect AI Agent.</p>
|
|
924
924
|
* @public
|
|
925
925
|
*/
|
|
926
|
-
description?: string;
|
|
926
|
+
description?: string | undefined;
|
|
927
927
|
}
|
|
928
928
|
/**
|
|
929
929
|
* @public
|
|
@@ -933,7 +933,7 @@ export interface UpdateAIAgentResponse {
|
|
|
933
933
|
* <p>The data of the updated Amazon Q in Connect AI Agent.</p>
|
|
934
934
|
* @public
|
|
935
935
|
*/
|
|
936
|
-
aiAgent?: AIAgentData;
|
|
936
|
+
aiAgent?: AIAgentData | undefined;
|
|
937
937
|
}
|
|
938
938
|
/**
|
|
939
939
|
* <p>A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be
|
|
@@ -1037,7 +1037,7 @@ export interface CreateAIPromptRequest {
|
|
|
1037
1037
|
* idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1038
1038
|
* @public
|
|
1039
1039
|
*/
|
|
1040
|
-
clientToken?: string;
|
|
1040
|
+
clientToken?: string | undefined;
|
|
1041
1041
|
/**
|
|
1042
1042
|
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1043
1043
|
* cannot contain the ARN.</p>
|
|
@@ -1085,12 +1085,12 @@ export interface CreateAIPromptRequest {
|
|
|
1085
1085
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1086
1086
|
* @public
|
|
1087
1087
|
*/
|
|
1088
|
-
tags?: Record<string, string
|
|
1088
|
+
tags?: Record<string, string> | undefined;
|
|
1089
1089
|
/**
|
|
1090
1090
|
* <p>The description of the AI Prompt.</p>
|
|
1091
1091
|
* @public
|
|
1092
1092
|
*/
|
|
1093
|
-
description?: string;
|
|
1093
|
+
description?: string | undefined;
|
|
1094
1094
|
}
|
|
1095
1095
|
/**
|
|
1096
1096
|
* <p>The data for the AI Prompt</p>
|
|
@@ -1153,12 +1153,12 @@ export interface AIPromptData {
|
|
|
1153
1153
|
* <p>The time the AI Prompt was last modified.</p>
|
|
1154
1154
|
* @public
|
|
1155
1155
|
*/
|
|
1156
|
-
modifiedTime?: Date;
|
|
1156
|
+
modifiedTime?: Date | undefined;
|
|
1157
1157
|
/**
|
|
1158
1158
|
* <p>The description of the AI Prompt.</p>
|
|
1159
1159
|
* @public
|
|
1160
1160
|
*/
|
|
1161
|
-
description?: string;
|
|
1161
|
+
description?: string | undefined;
|
|
1162
1162
|
/**
|
|
1163
1163
|
* <p>The visibility status of the AI Prompt.</p>
|
|
1164
1164
|
* @public
|
|
@@ -1168,19 +1168,19 @@ export interface AIPromptData {
|
|
|
1168
1168
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1169
1169
|
* @public
|
|
1170
1170
|
*/
|
|
1171
|
-
tags?: Record<string, string
|
|
1171
|
+
tags?: Record<string, string> | undefined;
|
|
1172
1172
|
/**
|
|
1173
1173
|
* <p>The origin of the AI Prompt. <code>SYSTEM</code> for a default AI Prompt created by Q in
|
|
1174
1174
|
* Connect or <code>CUSTOMER</code> for an AI Prompt created by calling AI Prompt creation APIs.
|
|
1175
1175
|
* </p>
|
|
1176
1176
|
* @public
|
|
1177
1177
|
*/
|
|
1178
|
-
origin?: Origin;
|
|
1178
|
+
origin?: Origin | undefined;
|
|
1179
1179
|
/**
|
|
1180
1180
|
* <p>The status of the AI Prompt.</p>
|
|
1181
1181
|
* @public
|
|
1182
1182
|
*/
|
|
1183
|
-
status?: Status;
|
|
1183
|
+
status?: Status | undefined;
|
|
1184
1184
|
}
|
|
1185
1185
|
/**
|
|
1186
1186
|
* @public
|
|
@@ -1190,7 +1190,7 @@ export interface CreateAIPromptResponse {
|
|
|
1190
1190
|
* <p>The data of the AI Prompt.</p>
|
|
1191
1191
|
* @public
|
|
1192
1192
|
*/
|
|
1193
|
-
aiPrompt?: AIPromptData;
|
|
1193
|
+
aiPrompt?: AIPromptData | undefined;
|
|
1194
1194
|
}
|
|
1195
1195
|
/**
|
|
1196
1196
|
* @public
|
|
@@ -1211,14 +1211,14 @@ export interface CreateAIPromptVersionRequest {
|
|
|
1211
1211
|
* <p>The time the AI Prompt was last modified.</p>
|
|
1212
1212
|
* @public
|
|
1213
1213
|
*/
|
|
1214
|
-
modifiedTime?: Date;
|
|
1214
|
+
modifiedTime?: Date | undefined;
|
|
1215
1215
|
/**
|
|
1216
1216
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1217
1217
|
* request. If not provided, the AWS SDK populates this field. For more information about
|
|
1218
1218
|
* idempotency, see <a href="http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1219
1219
|
* @public
|
|
1220
1220
|
*/
|
|
1221
|
-
clientToken?: string;
|
|
1221
|
+
clientToken?: string | undefined;
|
|
1222
1222
|
}
|
|
1223
1223
|
/**
|
|
1224
1224
|
* @public
|
|
@@ -1228,12 +1228,12 @@ export interface CreateAIPromptVersionResponse {
|
|
|
1228
1228
|
* <p>The data of the AI Prompt version.</p>
|
|
1229
1229
|
* @public
|
|
1230
1230
|
*/
|
|
1231
|
-
aiPrompt?: AIPromptData;
|
|
1231
|
+
aiPrompt?: AIPromptData | undefined;
|
|
1232
1232
|
/**
|
|
1233
1233
|
* <p>The version number of the AI Prompt version.</p>
|
|
1234
1234
|
* @public
|
|
1235
1235
|
*/
|
|
1236
|
-
versionNumber?: number;
|
|
1236
|
+
versionNumber?: number | undefined;
|
|
1237
1237
|
}
|
|
1238
1238
|
/**
|
|
1239
1239
|
* @public
|
|
@@ -1307,13 +1307,13 @@ export interface GetAIPromptResponse {
|
|
|
1307
1307
|
* <p>The data of the AI Prompt.</p>
|
|
1308
1308
|
* @public
|
|
1309
1309
|
*/
|
|
1310
|
-
aiPrompt?: AIPromptData;
|
|
1310
|
+
aiPrompt?: AIPromptData | undefined;
|
|
1311
1311
|
/**
|
|
1312
1312
|
* <p>The version number of the AI Prompt version (returned if an AI Prompt version was
|
|
1313
1313
|
* specified via use of a qualifier for the <code>aiPromptId</code> on the request). </p>
|
|
1314
1314
|
* @public
|
|
1315
1315
|
*/
|
|
1316
|
-
versionNumber?: number;
|
|
1316
|
+
versionNumber?: number | undefined;
|
|
1317
1317
|
}
|
|
1318
1318
|
/**
|
|
1319
1319
|
* @public
|
|
@@ -1330,19 +1330,19 @@ export interface ListAIPromptsRequest {
|
|
|
1330
1330
|
* the next request to retrieve the next set of results.</p>
|
|
1331
1331
|
* @public
|
|
1332
1332
|
*/
|
|
1333
|
-
nextToken?: string;
|
|
1333
|
+
nextToken?: string | undefined;
|
|
1334
1334
|
/**
|
|
1335
1335
|
* <p>The maximum number of results to return per page.</p>
|
|
1336
1336
|
* @public
|
|
1337
1337
|
*/
|
|
1338
|
-
maxResults?: number;
|
|
1338
|
+
maxResults?: number | undefined;
|
|
1339
1339
|
/**
|
|
1340
1340
|
* <p>The origin of the AI Prompts to be listed. <code>SYSTEM</code> for a default AI Agent
|
|
1341
1341
|
* created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent
|
|
1342
1342
|
* creation APIs. </p>
|
|
1343
1343
|
* @public
|
|
1344
1344
|
*/
|
|
1345
|
-
origin?: Origin;
|
|
1345
|
+
origin?: Origin | undefined;
|
|
1346
1346
|
}
|
|
1347
1347
|
/**
|
|
1348
1348
|
* <p>The summary of the AI Prompt.</p>
|
|
@@ -1384,7 +1384,7 @@ export interface AIPromptSummary {
|
|
|
1384
1384
|
* <p>The time the AI Prompt was last modified.</p>
|
|
1385
1385
|
* @public
|
|
1386
1386
|
*/
|
|
1387
|
-
modifiedTime?: Date;
|
|
1387
|
+
modifiedTime?: Date | undefined;
|
|
1388
1388
|
/**
|
|
1389
1389
|
* <p>The type of the prompt template for this AI Prompt.</p>
|
|
1390
1390
|
* @public
|
|
@@ -1412,22 +1412,22 @@ export interface AIPromptSummary {
|
|
|
1412
1412
|
* </p>
|
|
1413
1413
|
* @public
|
|
1414
1414
|
*/
|
|
1415
|
-
origin?: Origin;
|
|
1415
|
+
origin?: Origin | undefined;
|
|
1416
1416
|
/**
|
|
1417
1417
|
* <p>The description of the AI Prompt.</p>
|
|
1418
1418
|
* @public
|
|
1419
1419
|
*/
|
|
1420
|
-
description?: string;
|
|
1420
|
+
description?: string | undefined;
|
|
1421
1421
|
/**
|
|
1422
1422
|
* <p>The status of the AI Prompt.</p>
|
|
1423
1423
|
* @public
|
|
1424
1424
|
*/
|
|
1425
|
-
status?: Status;
|
|
1425
|
+
status?: Status | undefined;
|
|
1426
1426
|
/**
|
|
1427
1427
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1428
1428
|
* @public
|
|
1429
1429
|
*/
|
|
1430
|
-
tags?: Record<string, string
|
|
1430
|
+
tags?: Record<string, string> | undefined;
|
|
1431
1431
|
}
|
|
1432
1432
|
/**
|
|
1433
1433
|
* @public
|
|
@@ -1443,7 +1443,7 @@ export interface ListAIPromptsResponse {
|
|
|
1443
1443
|
* the next request to retrieve the next set of results.</p>
|
|
1444
1444
|
* @public
|
|
1445
1445
|
*/
|
|
1446
|
-
nextToken?: string;
|
|
1446
|
+
nextToken?: string | undefined;
|
|
1447
1447
|
}
|
|
1448
1448
|
/**
|
|
1449
1449
|
* @public
|
|
@@ -1466,19 +1466,19 @@ export interface ListAIPromptVersionsRequest {
|
|
|
1466
1466
|
* the next request to retrieve the next set of results.</p>
|
|
1467
1467
|
* @public
|
|
1468
1468
|
*/
|
|
1469
|
-
nextToken?: string;
|
|
1469
|
+
nextToken?: string | undefined;
|
|
1470
1470
|
/**
|
|
1471
1471
|
* <p>The maximum number of results to return per page.</p>
|
|
1472
1472
|
* @public
|
|
1473
1473
|
*/
|
|
1474
|
-
maxResults?: number;
|
|
1474
|
+
maxResults?: number | undefined;
|
|
1475
1475
|
/**
|
|
1476
1476
|
* <p>The origin of the AI Prompt versions to be listed. <code>SYSTEM</code> for a default AI
|
|
1477
1477
|
* Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI
|
|
1478
1478
|
* Agent creation APIs. </p>
|
|
1479
1479
|
* @public
|
|
1480
1480
|
*/
|
|
1481
|
-
origin?: Origin;
|
|
1481
|
+
origin?: Origin | undefined;
|
|
1482
1482
|
}
|
|
1483
1483
|
/**
|
|
1484
1484
|
* <p>The summary of the AI Prompt version.</p>
|
|
@@ -1489,12 +1489,12 @@ export interface AIPromptVersionSummary {
|
|
|
1489
1489
|
* <p>The date for the summary of the AI Prompt version.</p>
|
|
1490
1490
|
* @public
|
|
1491
1491
|
*/
|
|
1492
|
-
aiPromptSummary?: AIPromptSummary;
|
|
1492
|
+
aiPromptSummary?: AIPromptSummary | undefined;
|
|
1493
1493
|
/**
|
|
1494
1494
|
* <p>The version number for this AI Prompt version.</p>
|
|
1495
1495
|
* @public
|
|
1496
1496
|
*/
|
|
1497
|
-
versionNumber?: number;
|
|
1497
|
+
versionNumber?: number | undefined;
|
|
1498
1498
|
}
|
|
1499
1499
|
/**
|
|
1500
1500
|
* @public
|
|
@@ -1510,7 +1510,7 @@ export interface ListAIPromptVersionsResponse {
|
|
|
1510
1510
|
* the next request to retrieve the next set of results.</p>
|
|
1511
1511
|
* @public
|
|
1512
1512
|
*/
|
|
1513
|
-
nextToken?: string;
|
|
1513
|
+
nextToken?: string | undefined;
|
|
1514
1514
|
}
|
|
1515
1515
|
/**
|
|
1516
1516
|
* @public
|
|
@@ -1522,7 +1522,7 @@ export interface UpdateAIPromptRequest {
|
|
|
1522
1522
|
* idempotency, see <a href="http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1523
1523
|
* @public
|
|
1524
1524
|
*/
|
|
1525
|
-
clientToken?: string;
|
|
1525
|
+
clientToken?: string | undefined;
|
|
1526
1526
|
/**
|
|
1527
1527
|
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1528
1528
|
* cannot contain the ARN.</p>
|
|
@@ -1543,12 +1543,12 @@ export interface UpdateAIPromptRequest {
|
|
|
1543
1543
|
* <p>The configuration of the prompt template for this AI Prompt.</p>
|
|
1544
1544
|
* @public
|
|
1545
1545
|
*/
|
|
1546
|
-
templateConfiguration?: AIPromptTemplateConfiguration;
|
|
1546
|
+
templateConfiguration?: AIPromptTemplateConfiguration | undefined;
|
|
1547
1547
|
/**
|
|
1548
1548
|
* <p>The description of the Amazon Q in Connect AI Prompt.</p>
|
|
1549
1549
|
* @public
|
|
1550
1550
|
*/
|
|
1551
|
-
description?: string;
|
|
1551
|
+
description?: string | undefined;
|
|
1552
1552
|
}
|
|
1553
1553
|
/**
|
|
1554
1554
|
* @public
|
|
@@ -1558,7 +1558,7 @@ export interface UpdateAIPromptResponse {
|
|
|
1558
1558
|
* <p>The data of the updated Amazon Q in Connect AI Prompt.</p>
|
|
1559
1559
|
* @public
|
|
1560
1560
|
*/
|
|
1561
|
-
aiPrompt?: AIPromptData;
|
|
1561
|
+
aiPrompt?: AIPromptData | undefined;
|
|
1562
1562
|
}
|
|
1563
1563
|
/**
|
|
1564
1564
|
* <p>Content association data for a <a href="https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html">step-by-step
|
|
@@ -1570,7 +1570,7 @@ export interface AmazonConnectGuideAssociationData {
|
|
|
1570
1570
|
* <p> The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.</p>
|
|
1571
1571
|
* @public
|
|
1572
1572
|
*/
|
|
1573
|
-
flowId?: string;
|
|
1573
|
+
flowId?: string | undefined;
|
|
1574
1574
|
}
|
|
1575
1575
|
/**
|
|
1576
1576
|
* <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
|
|
@@ -1644,7 +1644,7 @@ export interface AppIntegrationsConfiguration {
|
|
|
1644
1644
|
* recommendations. </p>
|
|
1645
1645
|
* @public
|
|
1646
1646
|
*/
|
|
1647
|
-
objectFields?: string[];
|
|
1647
|
+
objectFields?: string[] | undefined;
|
|
1648
1648
|
}
|
|
1649
1649
|
/**
|
|
1650
1650
|
* <p>The data that is input into Amazon Q in Connect as a result of the assistant association.</p>
|
|
@@ -1713,12 +1713,12 @@ export interface CreateAssistantAssociationRequest {
|
|
|
1713
1713
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1714
1714
|
* @public
|
|
1715
1715
|
*/
|
|
1716
|
-
clientToken?: string;
|
|
1716
|
+
clientToken?: string | undefined;
|
|
1717
1717
|
/**
|
|
1718
1718
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1719
1719
|
* @public
|
|
1720
1720
|
*/
|
|
1721
|
-
tags?: Record<string, string
|
|
1721
|
+
tags?: Record<string, string> | undefined;
|
|
1722
1722
|
}
|
|
1723
1723
|
/**
|
|
1724
1724
|
* <p>Association information about the knowledge base.</p>
|
|
@@ -1729,12 +1729,12 @@ export interface KnowledgeBaseAssociationData {
|
|
|
1729
1729
|
* <p>The identifier of the knowledge base.</p>
|
|
1730
1730
|
* @public
|
|
1731
1731
|
*/
|
|
1732
|
-
knowledgeBaseId?: string;
|
|
1732
|
+
knowledgeBaseId?: string | undefined;
|
|
1733
1733
|
/**
|
|
1734
1734
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1735
1735
|
* @public
|
|
1736
1736
|
*/
|
|
1737
|
-
knowledgeBaseArn?: string;
|
|
1737
|
+
knowledgeBaseArn?: string | undefined;
|
|
1738
1738
|
}
|
|
1739
1739
|
/**
|
|
1740
1740
|
* <p>The data that is output as a result of the assistant association.</p>
|
|
@@ -1805,7 +1805,7 @@ export interface AssistantAssociationData {
|
|
|
1805
1805
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1806
1806
|
* @public
|
|
1807
1807
|
*/
|
|
1808
|
-
tags?: Record<string, string
|
|
1808
|
+
tags?: Record<string, string> | undefined;
|
|
1809
1809
|
}
|
|
1810
1810
|
/**
|
|
1811
1811
|
* @public
|
|
@@ -1815,7 +1815,7 @@ export interface CreateAssistantAssociationResponse {
|
|
|
1815
1815
|
* <p>The assistant association.</p>
|
|
1816
1816
|
* @public
|
|
1817
1817
|
*/
|
|
1818
|
-
assistantAssociation?: AssistantAssociationData;
|
|
1818
|
+
assistantAssociation?: AssistantAssociationData | undefined;
|
|
1819
1819
|
}
|
|
1820
1820
|
/**
|
|
1821
1821
|
* @public
|
|
@@ -1860,7 +1860,7 @@ export interface GetAssistantAssociationResponse {
|
|
|
1860
1860
|
* <p>The assistant association.</p>
|
|
1861
1861
|
* @public
|
|
1862
1862
|
*/
|
|
1863
|
-
assistantAssociation?: AssistantAssociationData;
|
|
1863
|
+
assistantAssociation?: AssistantAssociationData | undefined;
|
|
1864
1864
|
}
|
|
1865
1865
|
/**
|
|
1866
1866
|
* @public
|
|
@@ -1871,12 +1871,12 @@ export interface ListAssistantAssociationsRequest {
|
|
|
1871
1871
|
* response in the next request to retrieve the next set of results.</p>
|
|
1872
1872
|
* @public
|
|
1873
1873
|
*/
|
|
1874
|
-
nextToken?: string;
|
|
1874
|
+
nextToken?: string | undefined;
|
|
1875
1875
|
/**
|
|
1876
1876
|
* <p>The maximum number of results to return per page.</p>
|
|
1877
1877
|
* @public
|
|
1878
1878
|
*/
|
|
1879
|
-
maxResults?: number;
|
|
1879
|
+
maxResults?: number | undefined;
|
|
1880
1880
|
/**
|
|
1881
1881
|
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1882
1882
|
* @public
|
|
@@ -1922,7 +1922,7 @@ export interface AssistantAssociationSummary {
|
|
|
1922
1922
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1923
1923
|
* @public
|
|
1924
1924
|
*/
|
|
1925
|
-
tags?: Record<string, string
|
|
1925
|
+
tags?: Record<string, string> | undefined;
|
|
1926
1926
|
}
|
|
1927
1927
|
/**
|
|
1928
1928
|
* @public
|
|
@@ -1937,7 +1937,7 @@ export interface ListAssistantAssociationsResponse {
|
|
|
1937
1937
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1938
1938
|
* @public
|
|
1939
1939
|
*/
|
|
1940
|
-
nextToken?: string;
|
|
1940
|
+
nextToken?: string | undefined;
|
|
1941
1941
|
}
|
|
1942
1942
|
/**
|
|
1943
1943
|
* <p>The configuration information for the customer managed key used for encryption.</p>
|
|
@@ -1950,7 +1950,7 @@ export interface ServerSideEncryptionConfiguration {
|
|
|
1950
1950
|
* For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a>.</p>
|
|
1951
1951
|
* @public
|
|
1952
1952
|
*/
|
|
1953
|
-
kmsKeyId?: string;
|
|
1953
|
+
kmsKeyId?: string | undefined;
|
|
1954
1954
|
}
|
|
1955
1955
|
/**
|
|
1956
1956
|
* @public
|
|
@@ -1974,7 +1974,7 @@ export interface CreateAssistantRequest {
|
|
|
1974
1974
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1975
1975
|
* @public
|
|
1976
1976
|
*/
|
|
1977
|
-
clientToken?: string;
|
|
1977
|
+
clientToken?: string | undefined;
|
|
1978
1978
|
/**
|
|
1979
1979
|
* <p>The name of the assistant.</p>
|
|
1980
1980
|
* @public
|
|
@@ -1989,12 +1989,12 @@ export interface CreateAssistantRequest {
|
|
|
1989
1989
|
* <p>The description of the assistant.</p>
|
|
1990
1990
|
* @public
|
|
1991
1991
|
*/
|
|
1992
|
-
description?: string;
|
|
1992
|
+
description?: string | undefined;
|
|
1993
1993
|
/**
|
|
1994
1994
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1995
1995
|
* @public
|
|
1996
1996
|
*/
|
|
1997
|
-
tags?: Record<string, string
|
|
1997
|
+
tags?: Record<string, string> | undefined;
|
|
1998
1998
|
/**
|
|
1999
1999
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
2000
2000
|
* <p>The customer managed key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
@@ -2008,7 +2008,7 @@ export interface CreateAssistantRequest {
|
|
|
2008
2008
|
* your instance</a>.</p>
|
|
2009
2009
|
* @public
|
|
2010
2010
|
*/
|
|
2011
|
-
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
2011
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
2012
2012
|
}
|
|
2013
2013
|
/**
|
|
2014
2014
|
* @public
|
|
@@ -2031,7 +2031,7 @@ export interface AssistantCapabilityConfiguration {
|
|
|
2031
2031
|
* <p>The type of Amazon Q in Connect assistant capability. </p>
|
|
2032
2032
|
* @public
|
|
2033
2033
|
*/
|
|
2034
|
-
type?: AssistantCapabilityType;
|
|
2034
|
+
type?: AssistantCapabilityType | undefined;
|
|
2035
2035
|
}
|
|
2036
2036
|
/**
|
|
2037
2037
|
* <p>The configuration information for the Amazon Q in Connect assistant integration.</p>
|
|
@@ -2042,7 +2042,7 @@ export interface AssistantIntegrationConfiguration {
|
|
|
2042
2042
|
* <p>The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.</p>
|
|
2043
2043
|
* @public
|
|
2044
2044
|
*/
|
|
2045
|
-
topicIntegrationArn?: string;
|
|
2045
|
+
topicIntegrationArn?: string | undefined;
|
|
2046
2046
|
}
|
|
2047
2047
|
/**
|
|
2048
2048
|
* @public
|
|
@@ -2094,12 +2094,12 @@ export interface AssistantData {
|
|
|
2094
2094
|
* <p>The description.</p>
|
|
2095
2095
|
* @public
|
|
2096
2096
|
*/
|
|
2097
|
-
description?: string;
|
|
2097
|
+
description?: string | undefined;
|
|
2098
2098
|
/**
|
|
2099
2099
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2100
2100
|
* @public
|
|
2101
2101
|
*/
|
|
2102
|
-
tags?: Record<string, string
|
|
2102
|
+
tags?: Record<string, string> | undefined;
|
|
2103
2103
|
/**
|
|
2104
2104
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
2105
2105
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
@@ -2113,23 +2113,23 @@ export interface AssistantData {
|
|
|
2113
2113
|
* your instance</a>.</p>
|
|
2114
2114
|
* @public
|
|
2115
2115
|
*/
|
|
2116
|
-
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
2116
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
2117
2117
|
/**
|
|
2118
2118
|
* <p>The configuration information for the Amazon Q in Connect assistant integration.</p>
|
|
2119
2119
|
* @public
|
|
2120
2120
|
*/
|
|
2121
|
-
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
2121
|
+
integrationConfiguration?: AssistantIntegrationConfiguration | undefined;
|
|
2122
2122
|
/**
|
|
2123
2123
|
* <p>The configuration information for the Amazon Q in Connect assistant capability. </p>
|
|
2124
2124
|
* @public
|
|
2125
2125
|
*/
|
|
2126
|
-
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
|
2126
|
+
capabilityConfiguration?: AssistantCapabilityConfiguration | undefined;
|
|
2127
2127
|
/**
|
|
2128
2128
|
* <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is
|
|
2129
2129
|
* set on the Amazon Q in Connect Assistant.</p>
|
|
2130
2130
|
* @public
|
|
2131
2131
|
*/
|
|
2132
|
-
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData
|
|
2132
|
+
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
|
|
2133
2133
|
}
|
|
2134
2134
|
/**
|
|
2135
2135
|
* @public
|
|
@@ -2139,7 +2139,7 @@ export interface CreateAssistantResponse {
|
|
|
2139
2139
|
* <p>Information about the assistant.</p>
|
|
2140
2140
|
* @public
|
|
2141
2141
|
*/
|
|
2142
|
-
assistant?: AssistantData;
|
|
2142
|
+
assistant?: AssistantData | undefined;
|
|
2143
2143
|
}
|
|
2144
2144
|
/**
|
|
2145
2145
|
* @public
|
|
@@ -2174,7 +2174,7 @@ export interface GetAssistantResponse {
|
|
|
2174
2174
|
* <p>Information about the assistant.</p>
|
|
2175
2175
|
* @public
|
|
2176
2176
|
*/
|
|
2177
|
-
assistant?: AssistantData;
|
|
2177
|
+
assistant?: AssistantData | undefined;
|
|
2178
2178
|
}
|
|
2179
2179
|
/**
|
|
2180
2180
|
* @public
|
|
@@ -2194,7 +2194,7 @@ export interface GetRecommendationsRequest {
|
|
|
2194
2194
|
* <p>The maximum number of results to return per page.</p>
|
|
2195
2195
|
* @public
|
|
2196
2196
|
*/
|
|
2197
|
-
maxResults?: number;
|
|
2197
|
+
maxResults?: number | undefined;
|
|
2198
2198
|
/**
|
|
2199
2199
|
* <p>The duration (in seconds) for which the call waits for a recommendation to be made
|
|
2200
2200
|
* available before returning. If a recommendation is available, the call returns sooner than
|
|
@@ -2202,7 +2202,7 @@ export interface GetRecommendationsRequest {
|
|
|
2202
2202
|
* call returns successfully with an empty list.</p>
|
|
2203
2203
|
* @public
|
|
2204
2204
|
*/
|
|
2205
|
-
waitTimeSeconds?: number;
|
|
2205
|
+
waitTimeSeconds?: number | undefined;
|
|
2206
2206
|
}
|
|
2207
2207
|
/**
|
|
2208
2208
|
* @public
|
|
@@ -2226,12 +2226,12 @@ export interface RankingData {
|
|
|
2226
2226
|
* <p>The relevance level of the recommendation.</p>
|
|
2227
2227
|
* @public
|
|
2228
2228
|
*/
|
|
2229
|
-
relevanceScore?: number;
|
|
2229
|
+
relevanceScore?: number | undefined;
|
|
2230
2230
|
/**
|
|
2231
2231
|
* <p>The relevance score of the content.</p>
|
|
2232
2232
|
* @public
|
|
2233
2233
|
*/
|
|
2234
|
-
relevanceLevel?: RelevanceLevel;
|
|
2234
|
+
relevanceLevel?: RelevanceLevel | undefined;
|
|
2235
2235
|
}
|
|
2236
2236
|
/**
|
|
2237
2237
|
* <p>Offset specification to describe highlighting of document excerpts for rendering search
|
|
@@ -2243,12 +2243,12 @@ export interface Highlight {
|
|
|
2243
2243
|
* <p>The offset for the start of the highlight.</p>
|
|
2244
2244
|
* @public
|
|
2245
2245
|
*/
|
|
2246
|
-
beginOffsetInclusive?: number;
|
|
2246
|
+
beginOffsetInclusive?: number | undefined;
|
|
2247
2247
|
/**
|
|
2248
2248
|
* <p>The offset for the end of the highlight.</p>
|
|
2249
2249
|
* @public
|
|
2250
2250
|
*/
|
|
2251
|
-
endOffsetExclusive?: number;
|
|
2251
|
+
endOffsetExclusive?: number | undefined;
|
|
2252
2252
|
}
|
|
2253
2253
|
/**
|
|
2254
2254
|
* <p>The text of the document.</p>
|
|
@@ -2259,12 +2259,12 @@ export interface DocumentText {
|
|
|
2259
2259
|
* <p>Text in the document.</p>
|
|
2260
2260
|
* @public
|
|
2261
2261
|
*/
|
|
2262
|
-
text?: string;
|
|
2262
|
+
text?: string | undefined;
|
|
2263
2263
|
/**
|
|
2264
2264
|
* <p>Highlights in the document text.</p>
|
|
2265
2265
|
* @public
|
|
2266
2266
|
*/
|
|
2267
|
-
highlights?: Highlight[];
|
|
2267
|
+
highlights?: Highlight[] | undefined;
|
|
2268
2268
|
}
|
|
2269
2269
|
/**
|
|
2270
2270
|
* <p>Details about the source content text data.</p>
|
|
@@ -2275,12 +2275,12 @@ export interface TextData {
|
|
|
2275
2275
|
* <p>The text of the document.</p>
|
|
2276
2276
|
* @public
|
|
2277
2277
|
*/
|
|
2278
|
-
title?: DocumentText;
|
|
2278
|
+
title?: DocumentText | undefined;
|
|
2279
2279
|
/**
|
|
2280
2280
|
* <p>The text of the document.</p>
|
|
2281
2281
|
* @public
|
|
2282
2282
|
*/
|
|
2283
|
-
excerpt?: DocumentText;
|
|
2283
|
+
excerpt?: DocumentText | undefined;
|
|
2284
2284
|
}
|
|
2285
2285
|
/**
|
|
2286
2286
|
* <p>Details about the content data.</p>
|
|
@@ -2324,12 +2324,12 @@ export interface CitationSpan {
|
|
|
2324
2324
|
* <p>Where the text with a citation starts in the generated output.</p>
|
|
2325
2325
|
* @public
|
|
2326
2326
|
*/
|
|
2327
|
-
beginOffsetInclusive?: number;
|
|
2327
|
+
beginOffsetInclusive?: number | undefined;
|
|
2328
2328
|
/**
|
|
2329
2329
|
* <p>Where the text with a citation ends in the generated output.</p>
|
|
2330
2330
|
* @public
|
|
2331
2331
|
*/
|
|
2332
|
-
endOffsetExclusive?: number;
|
|
2332
|
+
endOffsetExclusive?: number | undefined;
|
|
2333
2333
|
}
|
|
2334
2334
|
/**
|
|
2335
2335
|
* @public
|
|
@@ -2371,7 +2371,7 @@ export interface SourceContentDataDetails {
|
|
|
2371
2371
|
* <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
|
|
2372
2372
|
* @public
|
|
2373
2373
|
*/
|
|
2374
|
-
citationSpan?: CitationSpan;
|
|
2374
|
+
citationSpan?: CitationSpan | undefined;
|
|
2375
2375
|
}
|
|
2376
2376
|
/**
|
|
2377
2377
|
* @public
|
|
@@ -2394,32 +2394,32 @@ export interface ContentReference {
|
|
|
2394
2394
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
2395
2395
|
* @public
|
|
2396
2396
|
*/
|
|
2397
|
-
knowledgeBaseArn?: string;
|
|
2397
|
+
knowledgeBaseArn?: string | undefined;
|
|
2398
2398
|
/**
|
|
2399
2399
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base.</p>
|
|
2400
2400
|
* @public
|
|
2401
2401
|
*/
|
|
2402
|
-
knowledgeBaseId?: string;
|
|
2402
|
+
knowledgeBaseId?: string | undefined;
|
|
2403
2403
|
/**
|
|
2404
2404
|
* <p>The Amazon Resource Name (ARN) of the content.</p>
|
|
2405
2405
|
* @public
|
|
2406
2406
|
*/
|
|
2407
|
-
contentArn?: string;
|
|
2407
|
+
contentArn?: string | undefined;
|
|
2408
2408
|
/**
|
|
2409
2409
|
* <p>The identifier of the content.</p>
|
|
2410
2410
|
* @public
|
|
2411
2411
|
*/
|
|
2412
|
-
contentId?: string;
|
|
2412
|
+
contentId?: string | undefined;
|
|
2413
2413
|
/**
|
|
2414
2414
|
* <p>The web URL of the source content.</p>
|
|
2415
2415
|
* @public
|
|
2416
2416
|
*/
|
|
2417
|
-
sourceURL?: string;
|
|
2417
|
+
sourceURL?: string | undefined;
|
|
2418
2418
|
/**
|
|
2419
2419
|
* <p>The type of reference content.</p>
|
|
2420
2420
|
* @public
|
|
2421
2421
|
*/
|
|
2422
|
-
referenceType?: ReferenceType;
|
|
2422
|
+
referenceType?: ReferenceType | undefined;
|
|
2423
2423
|
}
|
|
2424
2424
|
/**
|
|
2425
2425
|
* <p>Reference information about generative content.</p>
|
|
@@ -2430,12 +2430,12 @@ export interface GenerativeReference {
|
|
|
2430
2430
|
* <p>The identifier of the LLM model. </p>
|
|
2431
2431
|
* @public
|
|
2432
2432
|
*/
|
|
2433
|
-
modelId?: string;
|
|
2433
|
+
modelId?: string | undefined;
|
|
2434
2434
|
/**
|
|
2435
2435
|
* <p> The identifier of the LLM model. </p>
|
|
2436
2436
|
* @public
|
|
2437
2437
|
*/
|
|
2438
|
-
generationId?: string;
|
|
2438
|
+
generationId?: string | undefined;
|
|
2439
2439
|
}
|
|
2440
2440
|
/**
|
|
2441
2441
|
* <p>Reference data.</p>
|
|
@@ -2493,12 +2493,12 @@ export interface Document {
|
|
|
2493
2493
|
* <p>The title of the document.</p>
|
|
2494
2494
|
* @public
|
|
2495
2495
|
*/
|
|
2496
|
-
title?: DocumentText;
|
|
2496
|
+
title?: DocumentText | undefined;
|
|
2497
2497
|
/**
|
|
2498
2498
|
* <p>The excerpt from the document.</p>
|
|
2499
2499
|
* @public
|
|
2500
2500
|
*/
|
|
2501
|
-
excerpt?: DocumentText;
|
|
2501
|
+
excerpt?: DocumentText | undefined;
|
|
2502
2502
|
}
|
|
2503
2503
|
/**
|
|
2504
2504
|
* @public
|
|
@@ -2523,7 +2523,7 @@ export interface QueryRecommendationTriggerData {
|
|
|
2523
2523
|
* <p>The text associated with the recommendation trigger.</p>
|
|
2524
2524
|
* @public
|
|
2525
2525
|
*/
|
|
2526
|
-
text?: string;
|
|
2526
|
+
text?: string | undefined;
|
|
2527
2527
|
}
|
|
2528
2528
|
/**
|
|
2529
2529
|
* <p>A union type containing information related to the trigger.</p>
|
|
@@ -2632,12 +2632,12 @@ export interface ListAssistantsRequest {
|
|
|
2632
2632
|
* response in the next request to retrieve the next set of results.</p>
|
|
2633
2633
|
* @public
|
|
2634
2634
|
*/
|
|
2635
|
-
nextToken?: string;
|
|
2635
|
+
nextToken?: string | undefined;
|
|
2636
2636
|
/**
|
|
2637
2637
|
* <p>The maximum number of results to return per page.</p>
|
|
2638
2638
|
* @public
|
|
2639
2639
|
*/
|
|
2640
|
-
maxResults?: number;
|
|
2640
|
+
maxResults?: number | undefined;
|
|
2641
2641
|
}
|
|
2642
2642
|
/**
|
|
2643
2643
|
* <p>Summary information about the assistant.</p>
|
|
@@ -2673,12 +2673,12 @@ export interface AssistantSummary {
|
|
|
2673
2673
|
* <p>The description of the assistant.</p>
|
|
2674
2674
|
* @public
|
|
2675
2675
|
*/
|
|
2676
|
-
description?: string;
|
|
2676
|
+
description?: string | undefined;
|
|
2677
2677
|
/**
|
|
2678
2678
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2679
2679
|
* @public
|
|
2680
2680
|
*/
|
|
2681
|
-
tags?: Record<string, string
|
|
2681
|
+
tags?: Record<string, string> | undefined;
|
|
2682
2682
|
/**
|
|
2683
2683
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
2684
2684
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
@@ -2692,23 +2692,23 @@ export interface AssistantSummary {
|
|
|
2692
2692
|
* your instance</a>.</p>
|
|
2693
2693
|
* @public
|
|
2694
2694
|
*/
|
|
2695
|
-
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
2695
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
2696
2696
|
/**
|
|
2697
2697
|
* <p>The configuration information for the Amazon Q in Connect assistant integration.</p>
|
|
2698
2698
|
* @public
|
|
2699
2699
|
*/
|
|
2700
|
-
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
2700
|
+
integrationConfiguration?: AssistantIntegrationConfiguration | undefined;
|
|
2701
2701
|
/**
|
|
2702
2702
|
* <p>The configuration information for the Amazon Q in Connect assistant capability. </p>
|
|
2703
2703
|
* @public
|
|
2704
2704
|
*/
|
|
2705
|
-
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
|
2705
|
+
capabilityConfiguration?: AssistantCapabilityConfiguration | undefined;
|
|
2706
2706
|
/**
|
|
2707
2707
|
* <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is
|
|
2708
2708
|
* set on the Amazon Q in Connect Assistant.</p>
|
|
2709
2709
|
* @public
|
|
2710
2710
|
*/
|
|
2711
|
-
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData
|
|
2711
|
+
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
|
|
2712
2712
|
}
|
|
2713
2713
|
/**
|
|
2714
2714
|
* @public
|
|
@@ -2723,7 +2723,7 @@ export interface ListAssistantsResponse {
|
|
|
2723
2723
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
2724
2724
|
* @public
|
|
2725
2725
|
*/
|
|
2726
|
-
nextToken?: string;
|
|
2726
|
+
nextToken?: string | undefined;
|
|
2727
2727
|
}
|
|
2728
2728
|
/**
|
|
2729
2729
|
* @public
|
|
@@ -2754,12 +2754,12 @@ export interface NotifyRecommendationsReceivedError {
|
|
|
2754
2754
|
* <p>The identifier of the recommendation that is in error.</p>
|
|
2755
2755
|
* @public
|
|
2756
2756
|
*/
|
|
2757
|
-
recommendationId?: string;
|
|
2757
|
+
recommendationId?: string | undefined;
|
|
2758
2758
|
/**
|
|
2759
2759
|
* <p>A recommendation is causing an error.</p>
|
|
2760
2760
|
* @public
|
|
2761
2761
|
*/
|
|
2762
|
-
message?: string;
|
|
2762
|
+
message?: string | undefined;
|
|
2763
2763
|
}
|
|
2764
2764
|
/**
|
|
2765
2765
|
* @public
|
|
@@ -2769,12 +2769,12 @@ export interface NotifyRecommendationsReceivedResponse {
|
|
|
2769
2769
|
* <p>The identifiers of the recommendations.</p>
|
|
2770
2770
|
* @public
|
|
2771
2771
|
*/
|
|
2772
|
-
recommendationIds?: string[];
|
|
2772
|
+
recommendationIds?: string[] | undefined;
|
|
2773
2773
|
/**
|
|
2774
2774
|
* <p>The identifiers of recommendations that are causing errors.</p>
|
|
2775
2775
|
* @public
|
|
2776
2776
|
*/
|
|
2777
|
-
errors?: NotifyRecommendationsReceivedError[];
|
|
2777
|
+
errors?: NotifyRecommendationsReceivedError[] | undefined;
|
|
2778
2778
|
}
|
|
2779
2779
|
/**
|
|
2780
2780
|
* @public
|
|
@@ -3046,41 +3046,41 @@ export interface QueryAssistantRequest {
|
|
|
3046
3046
|
* <p>The text to search for.</p>
|
|
3047
3047
|
* @public
|
|
3048
3048
|
*/
|
|
3049
|
-
queryText?: string;
|
|
3049
|
+
queryText?: string | undefined;
|
|
3050
3050
|
/**
|
|
3051
3051
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3052
3052
|
* response in the next request to retrieve the next set of results.</p>
|
|
3053
3053
|
* @public
|
|
3054
3054
|
*/
|
|
3055
|
-
nextToken?: string;
|
|
3055
|
+
nextToken?: string | undefined;
|
|
3056
3056
|
/**
|
|
3057
3057
|
* <p>The maximum number of results to return per page.</p>
|
|
3058
3058
|
* @public
|
|
3059
3059
|
*/
|
|
3060
|
-
maxResults?: number;
|
|
3060
|
+
maxResults?: number | undefined;
|
|
3061
3061
|
/**
|
|
3062
3062
|
* <p>The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot
|
|
3063
3063
|
* contain the ARN.</p>
|
|
3064
3064
|
* @public
|
|
3065
3065
|
*/
|
|
3066
|
-
sessionId?: string;
|
|
3066
|
+
sessionId?: string | undefined;
|
|
3067
3067
|
/**
|
|
3068
3068
|
* <p>Information about how to query content.</p>
|
|
3069
3069
|
* @public
|
|
3070
3070
|
*/
|
|
3071
|
-
queryCondition?: QueryCondition[];
|
|
3071
|
+
queryCondition?: QueryCondition[] | undefined;
|
|
3072
3072
|
/**
|
|
3073
3073
|
* <p>Information about the query.</p>
|
|
3074
3074
|
* @public
|
|
3075
3075
|
*/
|
|
3076
|
-
queryInputData?: QueryInputData;
|
|
3076
|
+
queryInputData?: QueryInputData | undefined;
|
|
3077
3077
|
/**
|
|
3078
3078
|
* <p>The search type to be used against the Knowledge Base for this request. The values can be
|
|
3079
3079
|
* <code>SEMANTIC</code> which uses vector embeddings or <code>HYBRID</code> which use vector
|
|
3080
3080
|
* embeddings and raw text.</p>
|
|
3081
3081
|
* @public
|
|
3082
3082
|
*/
|
|
3083
|
-
overrideKnowledgeBaseSearchType?: KnowledgeBaseSearchType;
|
|
3083
|
+
overrideKnowledgeBaseSearchType?: KnowledgeBaseSearchType | undefined;
|
|
3084
3084
|
}
|
|
3085
3085
|
/**
|
|
3086
3086
|
* @public
|
|
@@ -3195,12 +3195,12 @@ export interface SearchSessionsRequest {
|
|
|
3195
3195
|
* response in the next request to retrieve the next set of results.</p>
|
|
3196
3196
|
* @public
|
|
3197
3197
|
*/
|
|
3198
|
-
nextToken?: string;
|
|
3198
|
+
nextToken?: string | undefined;
|
|
3199
3199
|
/**
|
|
3200
3200
|
* <p>The maximum number of results to return per page.</p>
|
|
3201
3201
|
* @public
|
|
3202
3202
|
*/
|
|
3203
|
-
maxResults?: number;
|
|
3203
|
+
maxResults?: number | undefined;
|
|
3204
3204
|
/**
|
|
3205
3205
|
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3206
3206
|
* @public
|
|
@@ -3251,7 +3251,7 @@ export interface SearchSessionsResponse {
|
|
|
3251
3251
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
3252
3252
|
* @public
|
|
3253
3253
|
*/
|
|
3254
|
-
nextToken?: string;
|
|
3254
|
+
nextToken?: string | undefined;
|
|
3255
3255
|
}
|
|
3256
3256
|
/**
|
|
3257
3257
|
* @public
|
|
@@ -3264,7 +3264,7 @@ export interface CreateSessionRequest {
|
|
|
3264
3264
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3265
3265
|
* @public
|
|
3266
3266
|
*/
|
|
3267
|
-
clientToken?: string;
|
|
3267
|
+
clientToken?: string | undefined;
|
|
3268
3268
|
/**
|
|
3269
3269
|
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3270
3270
|
* @public
|
|
@@ -3279,23 +3279,23 @@ export interface CreateSessionRequest {
|
|
|
3279
3279
|
* <p>The description.</p>
|
|
3280
3280
|
* @public
|
|
3281
3281
|
*/
|
|
3282
|
-
description?: string;
|
|
3282
|
+
description?: string | undefined;
|
|
3283
3283
|
/**
|
|
3284
3284
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3285
3285
|
* @public
|
|
3286
3286
|
*/
|
|
3287
|
-
tags?: Record<string, string
|
|
3287
|
+
tags?: Record<string, string> | undefined;
|
|
3288
3288
|
/**
|
|
3289
3289
|
* <p>An object that can be used to specify Tag conditions. </p>
|
|
3290
3290
|
* @public
|
|
3291
3291
|
*/
|
|
3292
|
-
tagFilter?: TagFilter;
|
|
3292
|
+
tagFilter?: TagFilter | undefined;
|
|
3293
3293
|
/**
|
|
3294
3294
|
* <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that
|
|
3295
3295
|
* should be used by Amazon Q in Connect for this Session.</p>
|
|
3296
3296
|
* @public
|
|
3297
3297
|
*/
|
|
3298
|
-
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData
|
|
3298
|
+
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
|
|
3299
3299
|
}
|
|
3300
3300
|
/**
|
|
3301
3301
|
* <p>The configuration information for the session integration.</p>
|
|
@@ -3306,7 +3306,7 @@ export interface SessionIntegrationConfiguration {
|
|
|
3306
3306
|
* <p>The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.</p>
|
|
3307
3307
|
* @public
|
|
3308
3308
|
*/
|
|
3309
|
-
topicIntegrationArn?: string;
|
|
3309
|
+
topicIntegrationArn?: string | undefined;
|
|
3310
3310
|
}
|
|
3311
3311
|
/**
|
|
3312
3312
|
* <p>Information about the session.</p>
|
|
@@ -3332,28 +3332,28 @@ export interface SessionData {
|
|
|
3332
3332
|
* <p>The description of the session.</p>
|
|
3333
3333
|
* @public
|
|
3334
3334
|
*/
|
|
3335
|
-
description?: string;
|
|
3335
|
+
description?: string | undefined;
|
|
3336
3336
|
/**
|
|
3337
3337
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3338
3338
|
* @public
|
|
3339
3339
|
*/
|
|
3340
|
-
tags?: Record<string, string
|
|
3340
|
+
tags?: Record<string, string> | undefined;
|
|
3341
3341
|
/**
|
|
3342
3342
|
* <p>The configuration information for the session integration.</p>
|
|
3343
3343
|
* @public
|
|
3344
3344
|
*/
|
|
3345
|
-
integrationConfiguration?: SessionIntegrationConfiguration;
|
|
3345
|
+
integrationConfiguration?: SessionIntegrationConfiguration | undefined;
|
|
3346
3346
|
/**
|
|
3347
3347
|
* <p>An object that can be used to specify Tag conditions.</p>
|
|
3348
3348
|
* @public
|
|
3349
3349
|
*/
|
|
3350
|
-
tagFilter?: TagFilter;
|
|
3350
|
+
tagFilter?: TagFilter | undefined;
|
|
3351
3351
|
/**
|
|
3352
3352
|
* <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that
|
|
3353
3353
|
* should be used by Amazon Q in Connect for this Session.</p>
|
|
3354
3354
|
* @public
|
|
3355
3355
|
*/
|
|
3356
|
-
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData
|
|
3356
|
+
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
|
|
3357
3357
|
}
|
|
3358
3358
|
/**
|
|
3359
3359
|
* @public
|
|
@@ -3363,7 +3363,7 @@ export interface CreateSessionResponse {
|
|
|
3363
3363
|
* <p>The session.</p>
|
|
3364
3364
|
* @public
|
|
3365
3365
|
*/
|
|
3366
|
-
session?: SessionData;
|
|
3366
|
+
session?: SessionData | undefined;
|
|
3367
3367
|
}
|
|
3368
3368
|
/**
|
|
3369
3369
|
* @public
|
|
@@ -3388,7 +3388,7 @@ export interface GetSessionResponse {
|
|
|
3388
3388
|
* <p>The session.</p>
|
|
3389
3389
|
* @public
|
|
3390
3390
|
*/
|
|
3391
|
-
session?: SessionData;
|
|
3391
|
+
session?: SessionData | undefined;
|
|
3392
3392
|
}
|
|
3393
3393
|
/**
|
|
3394
3394
|
* @public
|
|
@@ -3408,18 +3408,18 @@ export interface UpdateSessionRequest {
|
|
|
3408
3408
|
* <p>The description.</p>
|
|
3409
3409
|
* @public
|
|
3410
3410
|
*/
|
|
3411
|
-
description?: string;
|
|
3411
|
+
description?: string | undefined;
|
|
3412
3412
|
/**
|
|
3413
3413
|
* <p>An object that can be used to specify Tag conditions.</p>
|
|
3414
3414
|
* @public
|
|
3415
3415
|
*/
|
|
3416
|
-
tagFilter?: TagFilter;
|
|
3416
|
+
tagFilter?: TagFilter | undefined;
|
|
3417
3417
|
/**
|
|
3418
3418
|
* <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that
|
|
3419
3419
|
* should be used by Amazon Q in Connect for this Session.</p>
|
|
3420
3420
|
* @public
|
|
3421
3421
|
*/
|
|
3422
|
-
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData
|
|
3422
|
+
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
|
|
3423
3423
|
}
|
|
3424
3424
|
/**
|
|
3425
3425
|
* @public
|
|
@@ -3429,7 +3429,7 @@ export interface UpdateSessionResponse {
|
|
|
3429
3429
|
* <p>Information about the session.</p>
|
|
3430
3430
|
* @public
|
|
3431
3431
|
*/
|
|
3432
|
-
session?: SessionData;
|
|
3432
|
+
session?: SessionData | undefined;
|
|
3433
3433
|
}
|
|
3434
3434
|
/**
|
|
3435
3435
|
* <p>A union type that specifies the data stored on the session.</p>
|
|
@@ -3509,7 +3509,7 @@ export interface UpdateSessionDataRequest {
|
|
|
3509
3509
|
* Custom</p>
|
|
3510
3510
|
* @public
|
|
3511
3511
|
*/
|
|
3512
|
-
namespace?: SessionDataNamespace;
|
|
3512
|
+
namespace?: SessionDataNamespace | undefined;
|
|
3513
3513
|
/**
|
|
3514
3514
|
* <p>The data stored on the Amazon Q in Connect Session.</p>
|
|
3515
3515
|
* @public
|
|
@@ -3573,7 +3573,7 @@ export interface UpdateAssistantAIAgentResponse {
|
|
|
3573
3573
|
* <p>The assistant data.</p>
|
|
3574
3574
|
* @public
|
|
3575
3575
|
*/
|
|
3576
|
-
assistant?: AssistantData;
|
|
3576
|
+
assistant?: AssistantData | undefined;
|
|
3577
3577
|
}
|
|
3578
3578
|
/**
|
|
3579
3579
|
* <p>Instructions for interpreting the contents of a document.</p>
|
|
@@ -3600,7 +3600,7 @@ export interface BedrockFoundationModelConfigurationForParsing {
|
|
|
3600
3600
|
* <p>Instructions for interpreting the contents of a document.</p>
|
|
3601
3601
|
* @public
|
|
3602
3602
|
*/
|
|
3603
|
-
parsingPrompt?: ParsingPrompt;
|
|
3603
|
+
parsingPrompt?: ParsingPrompt | undefined;
|
|
3604
3604
|
}
|
|
3605
3605
|
/**
|
|
3606
3606
|
* @public
|
|
@@ -3706,21 +3706,21 @@ export interface ChunkingConfiguration {
|
|
|
3706
3706
|
* <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
|
|
3707
3707
|
* @public
|
|
3708
3708
|
*/
|
|
3709
|
-
fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration;
|
|
3709
|
+
fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration | undefined;
|
|
3710
3710
|
/**
|
|
3711
3711
|
* <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking
|
|
3712
3712
|
* splits documents into layers of chunks where the first layer contains large chunks, and the
|
|
3713
3713
|
* second layer contains smaller chunks derived from the first layer.</p>
|
|
3714
3714
|
* @public
|
|
3715
3715
|
*/
|
|
3716
|
-
hierarchicalChunkingConfiguration?: HierarchicalChunkingConfiguration;
|
|
3716
|
+
hierarchicalChunkingConfiguration?: HierarchicalChunkingConfiguration | undefined;
|
|
3717
3717
|
/**
|
|
3718
3718
|
* <p>Settings for semantic document chunking for a data source. Semantic chunking splits a
|
|
3719
3719
|
* document into smaller documents based on groups of similar content derived from the text with
|
|
3720
3720
|
* natural language processing.</p>
|
|
3721
3721
|
* @public
|
|
3722
3722
|
*/
|
|
3723
|
-
semanticChunkingConfiguration?: SemanticChunkingConfiguration;
|
|
3723
|
+
semanticChunkingConfiguration?: SemanticChunkingConfiguration | undefined;
|
|
3724
3724
|
}
|
|
3725
3725
|
/**
|
|
3726
3726
|
* <p>The configuration information of the Amazon Connect data source.</p>
|
|
@@ -3731,7 +3731,7 @@ export interface ConnectConfiguration {
|
|
|
3731
3731
|
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
3732
3732
|
* @public
|
|
3733
3733
|
*/
|
|
3734
|
-
instanceId?: string;
|
|
3734
|
+
instanceId?: string | undefined;
|
|
3735
3735
|
}
|
|
3736
3736
|
/**
|
|
3737
3737
|
* <p>The configuration information of the external data source.</p>
|
|
@@ -3815,7 +3815,7 @@ export interface CreateContentAssociationRequest {
|
|
|
3815
3815
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3816
3816
|
* @public
|
|
3817
3817
|
*/
|
|
3818
|
-
clientToken?: string;
|
|
3818
|
+
clientToken?: string | undefined;
|
|
3819
3819
|
/**
|
|
3820
3820
|
* <p>The identifier of the knowledge base.</p>
|
|
3821
3821
|
* @public
|
|
@@ -3840,7 +3840,7 @@ export interface CreateContentAssociationRequest {
|
|
|
3840
3840
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3841
3841
|
* @public
|
|
3842
3842
|
*/
|
|
3843
|
-
tags?: Record<string, string
|
|
3843
|
+
tags?: Record<string, string> | undefined;
|
|
3844
3844
|
}
|
|
3845
3845
|
/**
|
|
3846
3846
|
* <p>Information about the content association.</p>
|
|
@@ -3891,7 +3891,7 @@ export interface ContentAssociationData {
|
|
|
3891
3891
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3892
3892
|
* @public
|
|
3893
3893
|
*/
|
|
3894
|
-
tags?: Record<string, string
|
|
3894
|
+
tags?: Record<string, string> | undefined;
|
|
3895
3895
|
}
|
|
3896
3896
|
/**
|
|
3897
3897
|
* @public
|
|
@@ -3901,7 +3901,7 @@ export interface CreateContentAssociationResponse {
|
|
|
3901
3901
|
* <p>The association between Amazon Q in Connect content and another resource.</p>
|
|
3902
3902
|
* @public
|
|
3903
3903
|
*/
|
|
3904
|
-
contentAssociation?: ContentAssociationData;
|
|
3904
|
+
contentAssociation?: ContentAssociationData | undefined;
|
|
3905
3905
|
}
|
|
3906
3906
|
/**
|
|
3907
3907
|
* @public
|
|
@@ -3956,7 +3956,7 @@ export interface GetContentAssociationResponse {
|
|
|
3956
3956
|
* <p>The association between Amazon Q in Connect content and another resource.</p>
|
|
3957
3957
|
* @public
|
|
3958
3958
|
*/
|
|
3959
|
-
contentAssociation?: ContentAssociationData;
|
|
3959
|
+
contentAssociation?: ContentAssociationData | undefined;
|
|
3960
3960
|
}
|
|
3961
3961
|
/**
|
|
3962
3962
|
* @public
|
|
@@ -3967,12 +3967,12 @@ export interface ListContentAssociationsRequest {
|
|
|
3967
3967
|
* response in the next request to retrieve the next set of results.</p>
|
|
3968
3968
|
* @public
|
|
3969
3969
|
*/
|
|
3970
|
-
nextToken?: string;
|
|
3970
|
+
nextToken?: string | undefined;
|
|
3971
3971
|
/**
|
|
3972
3972
|
* <p>The maximum number of results to return per page.</p>
|
|
3973
3973
|
* @public
|
|
3974
3974
|
*/
|
|
3975
|
-
maxResults?: number;
|
|
3975
|
+
maxResults?: number | undefined;
|
|
3976
3976
|
/**
|
|
3977
3977
|
* <p>The identifier of the knowledge base.</p>
|
|
3978
3978
|
* @public
|
|
@@ -4033,7 +4033,7 @@ export interface ContentAssociationSummary {
|
|
|
4033
4033
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4034
4034
|
* @public
|
|
4035
4035
|
*/
|
|
4036
|
-
tags?: Record<string, string
|
|
4036
|
+
tags?: Record<string, string> | undefined;
|
|
4037
4037
|
}
|
|
4038
4038
|
/**
|
|
4039
4039
|
* @public
|
|
@@ -4048,7 +4048,7 @@ export interface ListContentAssociationsResponse {
|
|
|
4048
4048
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
4049
4049
|
* @public
|
|
4050
4050
|
*/
|
|
4051
|
-
nextToken?: string;
|
|
4051
|
+
nextToken?: string | undefined;
|
|
4052
4052
|
}
|
|
4053
4053
|
/**
|
|
4054
4054
|
* @public
|
|
@@ -4071,19 +4071,19 @@ export interface CreateContentRequest {
|
|
|
4071
4071
|
* <p>The title of the content. If not set, the title is equal to the name.</p>
|
|
4072
4072
|
* @public
|
|
4073
4073
|
*/
|
|
4074
|
-
title?: string;
|
|
4074
|
+
title?: string | undefined;
|
|
4075
4075
|
/**
|
|
4076
4076
|
* <p>The URI you want to use for the article. If the knowledge base has a templateUri, setting
|
|
4077
4077
|
* this argument overrides it for this piece of content.</p>
|
|
4078
4078
|
* @public
|
|
4079
4079
|
*/
|
|
4080
|
-
overrideLinkOutUri?: string;
|
|
4080
|
+
overrideLinkOutUri?: string | undefined;
|
|
4081
4081
|
/**
|
|
4082
4082
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
4083
4083
|
* For example, when synchronizing data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata to utilize for determining drift.</p>
|
|
4084
4084
|
* @public
|
|
4085
4085
|
*/
|
|
4086
|
-
metadata?: Record<string, string
|
|
4086
|
+
metadata?: Record<string, string> | undefined;
|
|
4087
4087
|
/**
|
|
4088
4088
|
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
|
|
4089
4089
|
* @public
|
|
@@ -4096,12 +4096,12 @@ export interface CreateContentRequest {
|
|
|
4096
4096
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
4097
4097
|
* @public
|
|
4098
4098
|
*/
|
|
4099
|
-
clientToken?: string;
|
|
4099
|
+
clientToken?: string | undefined;
|
|
4100
4100
|
/**
|
|
4101
4101
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4102
4102
|
* @public
|
|
4103
4103
|
*/
|
|
4104
|
-
tags?: Record<string, string
|
|
4104
|
+
tags?: Record<string, string> | undefined;
|
|
4105
4105
|
}
|
|
4106
4106
|
/**
|
|
4107
4107
|
* @public
|
|
@@ -4180,12 +4180,12 @@ export interface ContentData {
|
|
|
4180
4180
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4181
4181
|
* @public
|
|
4182
4182
|
*/
|
|
4183
|
-
tags?: Record<string, string
|
|
4183
|
+
tags?: Record<string, string> | undefined;
|
|
4184
4184
|
/**
|
|
4185
4185
|
* <p>The URI of the content.</p>
|
|
4186
4186
|
* @public
|
|
4187
4187
|
*/
|
|
4188
|
-
linkOutUri?: string;
|
|
4188
|
+
linkOutUri?: string | undefined;
|
|
4189
4189
|
/**
|
|
4190
4190
|
* <p>The URL of the content.</p>
|
|
4191
4191
|
* @public
|
|
@@ -4205,7 +4205,7 @@ export interface CreateContentResponse {
|
|
|
4205
4205
|
* <p>The content.</p>
|
|
4206
4206
|
* @public
|
|
4207
4207
|
*/
|
|
4208
|
-
content?: ContentData;
|
|
4208
|
+
content?: ContentData | undefined;
|
|
4209
4209
|
}
|
|
4210
4210
|
/**
|
|
4211
4211
|
* @public
|
|
@@ -4250,7 +4250,7 @@ export interface GetContentResponse {
|
|
|
4250
4250
|
* <p>The content.</p>
|
|
4251
4251
|
* @public
|
|
4252
4252
|
*/
|
|
4253
|
-
content?: ContentData;
|
|
4253
|
+
content?: ContentData | undefined;
|
|
4254
4254
|
}
|
|
4255
4255
|
/**
|
|
4256
4256
|
* @public
|
|
@@ -4327,7 +4327,7 @@ export interface ContentSummary {
|
|
|
4327
4327
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4328
4328
|
* @public
|
|
4329
4329
|
*/
|
|
4330
|
-
tags?: Record<string, string
|
|
4330
|
+
tags?: Record<string, string> | undefined;
|
|
4331
4331
|
}
|
|
4332
4332
|
/**
|
|
4333
4333
|
* @public
|
|
@@ -4337,7 +4337,7 @@ export interface GetContentSummaryResponse {
|
|
|
4337
4337
|
* <p>The content summary.</p>
|
|
4338
4338
|
* @public
|
|
4339
4339
|
*/
|
|
4340
|
-
contentSummary?: ContentSummary;
|
|
4340
|
+
contentSummary?: ContentSummary | undefined;
|
|
4341
4341
|
}
|
|
4342
4342
|
/**
|
|
4343
4343
|
* @public
|
|
@@ -4348,12 +4348,12 @@ export interface ListContentsRequest {
|
|
|
4348
4348
|
* response in the next request to retrieve the next set of results.</p>
|
|
4349
4349
|
* @public
|
|
4350
4350
|
*/
|
|
4351
|
-
nextToken?: string;
|
|
4351
|
+
nextToken?: string | undefined;
|
|
4352
4352
|
/**
|
|
4353
4353
|
* <p>The maximum number of results to return per page.</p>
|
|
4354
4354
|
* @public
|
|
4355
4355
|
*/
|
|
4356
|
-
maxResults?: number;
|
|
4356
|
+
maxResults?: number | undefined;
|
|
4357
4357
|
/**
|
|
4358
4358
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
4359
4359
|
* @public
|
|
@@ -4373,7 +4373,7 @@ export interface ListContentsResponse {
|
|
|
4373
4373
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
4374
4374
|
* @public
|
|
4375
4375
|
*/
|
|
4376
|
-
nextToken?: string;
|
|
4376
|
+
nextToken?: string | undefined;
|
|
4377
4377
|
}
|
|
4378
4378
|
/**
|
|
4379
4379
|
* <p>The provided <code>revisionId</code> does not match, indicating the content has been
|
|
@@ -4410,36 +4410,36 @@ export interface UpdateContentRequest {
|
|
|
4410
4410
|
* <code>PreconditionFailedException</code>.</p>
|
|
4411
4411
|
* @public
|
|
4412
4412
|
*/
|
|
4413
|
-
revisionId?: string;
|
|
4413
|
+
revisionId?: string | undefined;
|
|
4414
4414
|
/**
|
|
4415
4415
|
* <p>The title of the content.</p>
|
|
4416
4416
|
* @public
|
|
4417
4417
|
*/
|
|
4418
|
-
title?: string;
|
|
4418
|
+
title?: string | undefined;
|
|
4419
4419
|
/**
|
|
4420
4420
|
* <p>The URI for the article. If the knowledge base has a templateUri, setting this argument
|
|
4421
4421
|
* overrides it for this piece of content. To remove an existing <code>overrideLinkOurUri</code>,
|
|
4422
4422
|
* exclude this argument and set <code>removeOverrideLinkOutUri</code> to true.</p>
|
|
4423
4423
|
* @public
|
|
4424
4424
|
*/
|
|
4425
|
-
overrideLinkOutUri?: string;
|
|
4425
|
+
overrideLinkOutUri?: string | undefined;
|
|
4426
4426
|
/**
|
|
4427
4427
|
* <p>Unset the existing <code>overrideLinkOutUri</code> if it exists.</p>
|
|
4428
4428
|
* @public
|
|
4429
4429
|
*/
|
|
4430
|
-
removeOverrideLinkOutUri?: boolean;
|
|
4430
|
+
removeOverrideLinkOutUri?: boolean | undefined;
|
|
4431
4431
|
/**
|
|
4432
4432
|
* <p>A key/value map to store attributes without affecting tagging or recommendations. For
|
|
4433
4433
|
* example, when synchronizing data between an external system and Amazon Q in Connect, you can store an
|
|
4434
4434
|
* external version identifier as metadata to utilize for determining drift.</p>
|
|
4435
4435
|
* @public
|
|
4436
4436
|
*/
|
|
4437
|
-
metadata?: Record<string, string
|
|
4437
|
+
metadata?: Record<string, string> | undefined;
|
|
4438
4438
|
/**
|
|
4439
4439
|
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>. </p>
|
|
4440
4440
|
* @public
|
|
4441
4441
|
*/
|
|
4442
|
-
uploadId?: string;
|
|
4442
|
+
uploadId?: string | undefined;
|
|
4443
4443
|
}
|
|
4444
4444
|
/**
|
|
4445
4445
|
* @public
|
|
@@ -4449,7 +4449,7 @@ export interface UpdateContentResponse {
|
|
|
4449
4449
|
* <p>The content.</p>
|
|
4450
4450
|
* @public
|
|
4451
4451
|
*/
|
|
4452
|
-
content?: ContentData;
|
|
4452
|
+
content?: ContentData | undefined;
|
|
4453
4453
|
}
|
|
4454
4454
|
/**
|
|
4455
4455
|
* @public
|
|
@@ -4495,7 +4495,7 @@ export interface RenderingConfiguration {
|
|
|
4495
4495
|
* <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
|
|
4496
4496
|
* @public
|
|
4497
4497
|
*/
|
|
4498
|
-
templateUri?: string;
|
|
4498
|
+
templateUri?: string | undefined;
|
|
4499
4499
|
}
|
|
4500
4500
|
/**
|
|
4501
4501
|
* <p>The configuration of crawl limits for the web URLs.</p>
|
|
@@ -4506,7 +4506,7 @@ export interface WebCrawlerLimits {
|
|
|
4506
4506
|
* <p>Rate of web URLs retrieved per minute.</p>
|
|
4507
4507
|
* @public
|
|
4508
4508
|
*/
|
|
4509
|
-
rateLimit?: number;
|
|
4509
|
+
rateLimit?: number | undefined;
|
|
4510
4510
|
}
|
|
4511
4511
|
/**
|
|
4512
4512
|
* @public
|
|
@@ -4529,7 +4529,7 @@ export interface SeedUrl {
|
|
|
4529
4529
|
* <p>URL for crawling</p>
|
|
4530
4530
|
* @public
|
|
4531
4531
|
*/
|
|
4532
|
-
url?: string;
|
|
4532
|
+
url?: string | undefined;
|
|
4533
4533
|
}
|
|
4534
4534
|
/**
|
|
4535
4535
|
* <p>The configuration of the URL/URLs for the web content that you want to crawl. You should
|
|
@@ -4541,7 +4541,7 @@ export interface UrlConfiguration {
|
|
|
4541
4541
|
* <p>List of URLs for crawling.</p>
|
|
4542
4542
|
* @public
|
|
4543
4543
|
*/
|
|
4544
|
-
seedUrls?: SeedUrl[];
|
|
4544
|
+
seedUrls?: SeedUrl[] | undefined;
|
|
4545
4545
|
}
|
|
4546
4546
|
/**
|
|
4547
4547
|
* <p>The configuration details for the web data source.</p>
|
|
@@ -4558,21 +4558,21 @@ export interface WebCrawlerConfiguration {
|
|
|
4558
4558
|
* <p>The configuration of crawl limits for the web URLs.</p>
|
|
4559
4559
|
* @public
|
|
4560
4560
|
*/
|
|
4561
|
-
crawlerLimits?: WebCrawlerLimits;
|
|
4561
|
+
crawlerLimits?: WebCrawlerLimits | undefined;
|
|
4562
4562
|
/**
|
|
4563
4563
|
* <p>A list of one or more inclusion regular expression patterns to include certain URLs. If
|
|
4564
4564
|
* you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion
|
|
4565
4565
|
* filter takes precedence and the web content of the URL isn’t crawled.</p>
|
|
4566
4566
|
* @public
|
|
4567
4567
|
*/
|
|
4568
|
-
inclusionFilters?: string[];
|
|
4568
|
+
inclusionFilters?: string[] | undefined;
|
|
4569
4569
|
/**
|
|
4570
4570
|
* <p>A list of one or more exclusion regular expression patterns to exclude certain URLs. If
|
|
4571
4571
|
* you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion
|
|
4572
4572
|
* filter takes precedence and the web content of the URL isn’t crawled.</p>
|
|
4573
4573
|
* @public
|
|
4574
4574
|
*/
|
|
4575
|
-
exclusionFilters?: string[];
|
|
4575
|
+
exclusionFilters?: string[] | undefined;
|
|
4576
4576
|
/**
|
|
4577
4577
|
* <p>The scope of what is crawled for your URLs. You can choose to crawl only web pages that
|
|
4578
4578
|
* belong to the same host or primary domain. For example, only web pages that contain the seed
|
|
@@ -4582,7 +4582,7 @@ export interface WebCrawlerConfiguration {
|
|
|
4582
4582
|
* <code>docs.aws.amazon.com</code>.</p>
|
|
4583
4583
|
* @public
|
|
4584
4584
|
*/
|
|
4585
|
-
scope?: WebScopeType;
|
|
4585
|
+
scope?: WebScopeType | undefined;
|
|
4586
4586
|
}
|
|
4587
4587
|
/**
|
|
4588
4588
|
* <p>Source configuration for managed resources.</p>
|
|
@@ -4684,7 +4684,7 @@ export interface ParsingConfiguration {
|
|
|
4684
4684
|
* <p>Settings for a foundation model used to parse documents for a data source.</p>
|
|
4685
4685
|
* @public
|
|
4686
4686
|
*/
|
|
4687
|
-
bedrockFoundationModelConfiguration?: BedrockFoundationModelConfigurationForParsing;
|
|
4687
|
+
bedrockFoundationModelConfiguration?: BedrockFoundationModelConfigurationForParsing | undefined;
|
|
4688
4688
|
}
|
|
4689
4689
|
/**
|
|
4690
4690
|
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
@@ -4697,12 +4697,12 @@ export interface VectorIngestionConfiguration {
|
|
|
4697
4697
|
* queried.</p>
|
|
4698
4698
|
* @public
|
|
4699
4699
|
*/
|
|
4700
|
-
chunkingConfiguration?: ChunkingConfiguration;
|
|
4700
|
+
chunkingConfiguration?: ChunkingConfiguration | undefined;
|
|
4701
4701
|
/**
|
|
4702
4702
|
* <p>A custom parser for data source documents.</p>
|
|
4703
4703
|
* @public
|
|
4704
4704
|
*/
|
|
4705
|
-
parsingConfiguration?: ParsingConfiguration;
|
|
4705
|
+
parsingConfiguration?: ParsingConfiguration | undefined;
|
|
4706
4706
|
}
|
|
4707
4707
|
/**
|
|
4708
4708
|
* @public
|
|
@@ -4715,7 +4715,7 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
4715
4715
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
4716
4716
|
* @public
|
|
4717
4717
|
*/
|
|
4718
|
-
clientToken?: string;
|
|
4718
|
+
clientToken?: string | undefined;
|
|
4719
4719
|
/**
|
|
4720
4720
|
* <p>The name of the knowledge base.</p>
|
|
4721
4721
|
* @public
|
|
@@ -4733,17 +4733,17 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
4733
4733
|
* bases.</p>
|
|
4734
4734
|
* @public
|
|
4735
4735
|
*/
|
|
4736
|
-
sourceConfiguration?: SourceConfiguration;
|
|
4736
|
+
sourceConfiguration?: SourceConfiguration | undefined;
|
|
4737
4737
|
/**
|
|
4738
4738
|
* <p>Information about how to render the content.</p>
|
|
4739
4739
|
* @public
|
|
4740
4740
|
*/
|
|
4741
|
-
renderingConfiguration?: RenderingConfiguration;
|
|
4741
|
+
renderingConfiguration?: RenderingConfiguration | undefined;
|
|
4742
4742
|
/**
|
|
4743
4743
|
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
4744
4744
|
* @public
|
|
4745
4745
|
*/
|
|
4746
|
-
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
4746
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
4747
4747
|
/**
|
|
4748
4748
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
4749
4749
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
@@ -4754,17 +4754,17 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
4754
4754
|
* your instance</a>.</p>
|
|
4755
4755
|
* @public
|
|
4756
4756
|
*/
|
|
4757
|
-
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
4757
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
4758
4758
|
/**
|
|
4759
4759
|
* <p>The description.</p>
|
|
4760
4760
|
* @public
|
|
4761
4761
|
*/
|
|
4762
|
-
description?: string;
|
|
4762
|
+
description?: string | undefined;
|
|
4763
4763
|
/**
|
|
4764
4764
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4765
4765
|
* @public
|
|
4766
4766
|
*/
|
|
4767
|
-
tags?: Record<string, string
|
|
4767
|
+
tags?: Record<string, string> | undefined;
|
|
4768
4768
|
}
|
|
4769
4769
|
/**
|
|
4770
4770
|
* @public
|
|
@@ -4831,22 +4831,22 @@ export interface KnowledgeBaseData {
|
|
|
4831
4831
|
* base. If no content exists in a knowledge base, this value is unset.</p>
|
|
4832
4832
|
* @public
|
|
4833
4833
|
*/
|
|
4834
|
-
lastContentModificationTime?: Date;
|
|
4834
|
+
lastContentModificationTime?: Date | undefined;
|
|
4835
4835
|
/**
|
|
4836
4836
|
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
4837
4837
|
* @public
|
|
4838
4838
|
*/
|
|
4839
|
-
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
4839
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
4840
4840
|
/**
|
|
4841
4841
|
* <p>Source configuration information about the knowledge base.</p>
|
|
4842
4842
|
* @public
|
|
4843
4843
|
*/
|
|
4844
|
-
sourceConfiguration?: SourceConfiguration;
|
|
4844
|
+
sourceConfiguration?: SourceConfiguration | undefined;
|
|
4845
4845
|
/**
|
|
4846
4846
|
* <p>Information about how to render the content.</p>
|
|
4847
4847
|
* @public
|
|
4848
4848
|
*/
|
|
4849
|
-
renderingConfiguration?: RenderingConfiguration;
|
|
4849
|
+
renderingConfiguration?: RenderingConfiguration | undefined;
|
|
4850
4850
|
/**
|
|
4851
4851
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
4852
4852
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
@@ -4857,27 +4857,27 @@ export interface KnowledgeBaseData {
|
|
|
4857
4857
|
* your instance</a>.</p>
|
|
4858
4858
|
* @public
|
|
4859
4859
|
*/
|
|
4860
|
-
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
4860
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
4861
4861
|
/**
|
|
4862
4862
|
* <p>The description.</p>
|
|
4863
4863
|
* @public
|
|
4864
4864
|
*/
|
|
4865
|
-
description?: string;
|
|
4865
|
+
description?: string | undefined;
|
|
4866
4866
|
/**
|
|
4867
4867
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
4868
4868
|
* @public
|
|
4869
4869
|
*/
|
|
4870
|
-
tags?: Record<string, string
|
|
4870
|
+
tags?: Record<string, string> | undefined;
|
|
4871
4871
|
/**
|
|
4872
4872
|
* <p>Status of ingestion on data source.</p>
|
|
4873
4873
|
* @public
|
|
4874
4874
|
*/
|
|
4875
|
-
ingestionStatus?: SyncStatus;
|
|
4875
|
+
ingestionStatus?: SyncStatus | undefined;
|
|
4876
4876
|
/**
|
|
4877
4877
|
* <p>List of failure reasons on ingestion per file.</p>
|
|
4878
4878
|
* @public
|
|
4879
4879
|
*/
|
|
4880
|
-
ingestionFailureReasons?: string[];
|
|
4880
|
+
ingestionFailureReasons?: string[] | undefined;
|
|
4881
4881
|
}
|
|
4882
4882
|
/**
|
|
4883
4883
|
* @public
|
|
@@ -4887,7 +4887,7 @@ export interface CreateKnowledgeBaseResponse {
|
|
|
4887
4887
|
* <p>The knowledge base.</p>
|
|
4888
4888
|
* @public
|
|
4889
4889
|
*/
|
|
4890
|
-
knowledgeBase?: KnowledgeBaseData;
|
|
4890
|
+
knowledgeBase?: KnowledgeBaseData | undefined;
|
|
4891
4891
|
}
|
|
4892
4892
|
/**
|
|
4893
4893
|
* <p>The container of quick response data.</p>
|
|
@@ -4936,7 +4936,7 @@ export interface GroupingConfiguration {
|
|
|
4936
4936
|
* </ul>
|
|
4937
4937
|
* @public
|
|
4938
4938
|
*/
|
|
4939
|
-
criteria?: string;
|
|
4939
|
+
criteria?: string | undefined;
|
|
4940
4940
|
/**
|
|
4941
4941
|
* <p>The list of values that define different groups of Amazon Q in Connect users.</p>
|
|
4942
4942
|
* <ul>
|
|
@@ -4948,7 +4948,7 @@ export interface GroupingConfiguration {
|
|
|
4948
4948
|
* </ul>
|
|
4949
4949
|
* @public
|
|
4950
4950
|
*/
|
|
4951
|
-
values?: string[];
|
|
4951
|
+
values?: string[] | undefined;
|
|
4952
4952
|
}
|
|
4953
4953
|
/**
|
|
4954
4954
|
* @public
|
|
@@ -4983,34 +4983,34 @@ export interface CreateQuickResponseRequest {
|
|
|
4983
4983
|
* </ul>
|
|
4984
4984
|
* @public
|
|
4985
4985
|
*/
|
|
4986
|
-
contentType?: string;
|
|
4986
|
+
contentType?: string | undefined;
|
|
4987
4987
|
/**
|
|
4988
4988
|
* <p>The configuration information of the user groups that the quick response is accessible
|
|
4989
4989
|
* to.</p>
|
|
4990
4990
|
* @public
|
|
4991
4991
|
*/
|
|
4992
|
-
groupingConfiguration?: GroupingConfiguration;
|
|
4992
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
4993
4993
|
/**
|
|
4994
4994
|
* <p>The description of the quick response.</p>
|
|
4995
4995
|
* @public
|
|
4996
4996
|
*/
|
|
4997
|
-
description?: string;
|
|
4997
|
+
description?: string | undefined;
|
|
4998
4998
|
/**
|
|
4999
4999
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
5000
5000
|
* knowledge base. </p>
|
|
5001
5001
|
* @public
|
|
5002
5002
|
*/
|
|
5003
|
-
shortcutKey?: string;
|
|
5003
|
+
shortcutKey?: string | undefined;
|
|
5004
5004
|
/**
|
|
5005
5005
|
* <p>Whether the quick response is active.</p>
|
|
5006
5006
|
* @public
|
|
5007
5007
|
*/
|
|
5008
|
-
isActive?: boolean;
|
|
5008
|
+
isActive?: boolean | undefined;
|
|
5009
5009
|
/**
|
|
5010
5010
|
* <p>The Amazon Connect channels this quick response applies to.</p>
|
|
5011
5011
|
* @public
|
|
5012
5012
|
*/
|
|
5013
|
-
channels?: string[];
|
|
5013
|
+
channels?: string[] | undefined;
|
|
5014
5014
|
/**
|
|
5015
5015
|
* <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
|
|
5016
5016
|
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
@@ -5018,7 +5018,7 @@ export interface CreateQuickResponseRequest {
|
|
|
5018
5018
|
* </p>
|
|
5019
5019
|
* @public
|
|
5020
5020
|
*/
|
|
5021
|
-
language?: string;
|
|
5021
|
+
language?: string | undefined;
|
|
5022
5022
|
/**
|
|
5023
5023
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
5024
5024
|
* request. If not provided, the Amazon Web Services
|
|
@@ -5026,12 +5026,12 @@ export interface CreateQuickResponseRequest {
|
|
|
5026
5026
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
5027
5027
|
* @public
|
|
5028
5028
|
*/
|
|
5029
|
-
clientToken?: string;
|
|
5029
|
+
clientToken?: string | undefined;
|
|
5030
5030
|
/**
|
|
5031
5031
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
5032
5032
|
* @public
|
|
5033
5033
|
*/
|
|
5034
|
-
tags?: Record<string, string
|
|
5034
|
+
tags?: Record<string, string> | undefined;
|
|
5035
5035
|
}
|
|
5036
5036
|
/**
|
|
5037
5037
|
* <p>The container quick response content.</p>
|
|
@@ -5072,12 +5072,12 @@ export interface QuickResponseContents {
|
|
|
5072
5072
|
* <p>The container quick response content.</p>
|
|
5073
5073
|
* @public
|
|
5074
5074
|
*/
|
|
5075
|
-
plainText?: QuickResponseContentProvider;
|
|
5075
|
+
plainText?: QuickResponseContentProvider | undefined;
|
|
5076
5076
|
/**
|
|
5077
5077
|
* <p>The container quick response content.</p>
|
|
5078
5078
|
* @public
|
|
5079
5079
|
*/
|
|
5080
|
-
markdown?: QuickResponseContentProvider;
|
|
5080
|
+
markdown?: QuickResponseContentProvider | undefined;
|
|
5081
5081
|
}
|
|
5082
5082
|
/**
|
|
5083
5083
|
* @public
|
|
@@ -5161,51 +5161,51 @@ export interface QuickResponseData {
|
|
|
5161
5161
|
* <p>The contents of the quick response.</p>
|
|
5162
5162
|
* @public
|
|
5163
5163
|
*/
|
|
5164
|
-
contents?: QuickResponseContents;
|
|
5164
|
+
contents?: QuickResponseContents | undefined;
|
|
5165
5165
|
/**
|
|
5166
5166
|
* <p>The description of the quick response.</p>
|
|
5167
5167
|
* @public
|
|
5168
5168
|
*/
|
|
5169
|
-
description?: string;
|
|
5169
|
+
description?: string | undefined;
|
|
5170
5170
|
/**
|
|
5171
5171
|
* <p>The configuration information of the user groups that the quick response is accessible
|
|
5172
5172
|
* to.</p>
|
|
5173
5173
|
* @public
|
|
5174
5174
|
*/
|
|
5175
|
-
groupingConfiguration?: GroupingConfiguration;
|
|
5175
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
5176
5176
|
/**
|
|
5177
5177
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
5178
5178
|
* knowledge base.</p>
|
|
5179
5179
|
* @public
|
|
5180
5180
|
*/
|
|
5181
|
-
shortcutKey?: string;
|
|
5181
|
+
shortcutKey?: string | undefined;
|
|
5182
5182
|
/**
|
|
5183
5183
|
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
|
|
5184
5184
|
* data.</p>
|
|
5185
5185
|
* @public
|
|
5186
5186
|
*/
|
|
5187
|
-
lastModifiedBy?: string;
|
|
5187
|
+
lastModifiedBy?: string | undefined;
|
|
5188
5188
|
/**
|
|
5189
5189
|
* <p>Whether the quick response is active.</p>
|
|
5190
5190
|
* @public
|
|
5191
5191
|
*/
|
|
5192
|
-
isActive?: boolean;
|
|
5192
|
+
isActive?: boolean | undefined;
|
|
5193
5193
|
/**
|
|
5194
5194
|
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
5195
5195
|
* The supported contact channel types include <code>Chat</code>.</p>
|
|
5196
5196
|
* @public
|
|
5197
5197
|
*/
|
|
5198
|
-
channels?: string[];
|
|
5198
|
+
channels?: string[] | undefined;
|
|
5199
5199
|
/**
|
|
5200
5200
|
* <p>The language code value for the language in which the quick response is written.</p>
|
|
5201
5201
|
* @public
|
|
5202
5202
|
*/
|
|
5203
|
-
language?: string;
|
|
5203
|
+
language?: string | undefined;
|
|
5204
5204
|
/**
|
|
5205
5205
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
5206
5206
|
* @public
|
|
5207
5207
|
*/
|
|
5208
|
-
tags?: Record<string, string
|
|
5208
|
+
tags?: Record<string, string> | undefined;
|
|
5209
5209
|
}
|
|
5210
5210
|
/**
|
|
5211
5211
|
* @public
|
|
@@ -5215,7 +5215,7 @@ export interface CreateQuickResponseResponse {
|
|
|
5215
5215
|
* <p>The quick response.</p>
|
|
5216
5216
|
* @public
|
|
5217
5217
|
*/
|
|
5218
|
-
quickResponse?: QuickResponseData;
|
|
5218
|
+
quickResponse?: QuickResponseData | undefined;
|
|
5219
5219
|
}
|
|
5220
5220
|
/**
|
|
5221
5221
|
* @public
|
|
@@ -5385,7 +5385,7 @@ export interface ImportJobData {
|
|
|
5385
5385
|
* <p>The link to download the information of resource data that failed to be imported.</p>
|
|
5386
5386
|
* @public
|
|
5387
5387
|
*/
|
|
5388
|
-
failedRecordReport?: string;
|
|
5388
|
+
failedRecordReport?: string | undefined;
|
|
5389
5389
|
/**
|
|
5390
5390
|
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
5391
5391
|
* @public
|
|
@@ -5405,12 +5405,12 @@ export interface ImportJobData {
|
|
|
5405
5405
|
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
5406
5406
|
* @public
|
|
5407
5407
|
*/
|
|
5408
|
-
metadata?: Record<string, string
|
|
5408
|
+
metadata?: Record<string, string> | undefined;
|
|
5409
5409
|
/**
|
|
5410
5410
|
* <p>The configuration information of the external data source.</p>
|
|
5411
5411
|
* @public
|
|
5412
5412
|
*/
|
|
5413
|
-
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
5413
|
+
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
5414
5414
|
}
|
|
5415
5415
|
/**
|
|
5416
5416
|
* @public
|
|
@@ -5420,7 +5420,7 @@ export interface GetImportJobResponse {
|
|
|
5420
5420
|
* <p>The import job.</p>
|
|
5421
5421
|
* @public
|
|
5422
5422
|
*/
|
|
5423
|
-
importJob?: ImportJobData;
|
|
5423
|
+
importJob?: ImportJobData | undefined;
|
|
5424
5424
|
}
|
|
5425
5425
|
/**
|
|
5426
5426
|
* @public
|
|
@@ -5440,7 +5440,7 @@ export interface GetKnowledgeBaseResponse {
|
|
|
5440
5440
|
* <p>The knowledge base.</p>
|
|
5441
5441
|
* @public
|
|
5442
5442
|
*/
|
|
5443
|
-
knowledgeBase?: KnowledgeBaseData;
|
|
5443
|
+
knowledgeBase?: KnowledgeBaseData | undefined;
|
|
5444
5444
|
}
|
|
5445
5445
|
/**
|
|
5446
5446
|
* @public
|
|
@@ -5465,7 +5465,7 @@ export interface GetQuickResponseResponse {
|
|
|
5465
5465
|
* <p>The quick response.</p>
|
|
5466
5466
|
* @public
|
|
5467
5467
|
*/
|
|
5468
|
-
quickResponse?: QuickResponseData;
|
|
5468
|
+
quickResponse?: QuickResponseData | undefined;
|
|
5469
5469
|
}
|
|
5470
5470
|
/**
|
|
5471
5471
|
* <p>Summary information about the import job.</p>
|
|
@@ -5516,13 +5516,13 @@ export interface ImportJobSummary {
|
|
|
5516
5516
|
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
5517
5517
|
* @public
|
|
5518
5518
|
*/
|
|
5519
|
-
metadata?: Record<string, string
|
|
5519
|
+
metadata?: Record<string, string> | undefined;
|
|
5520
5520
|
/**
|
|
5521
5521
|
* <p>The configuration information of the external source that the resource data are imported
|
|
5522
5522
|
* from.</p>
|
|
5523
5523
|
* @public
|
|
5524
5524
|
*/
|
|
5525
|
-
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
5525
|
+
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
5526
5526
|
}
|
|
5527
5527
|
/**
|
|
5528
5528
|
* @public
|
|
@@ -5533,12 +5533,12 @@ export interface ListImportJobsRequest {
|
|
|
5533
5533
|
* response in the next request to retrieve the next set of results.</p>
|
|
5534
5534
|
* @public
|
|
5535
5535
|
*/
|
|
5536
|
-
nextToken?: string;
|
|
5536
|
+
nextToken?: string | undefined;
|
|
5537
5537
|
/**
|
|
5538
5538
|
* <p>The maximum number of results to return per page.</p>
|
|
5539
5539
|
* @public
|
|
5540
5540
|
*/
|
|
5541
|
-
maxResults?: number;
|
|
5541
|
+
maxResults?: number | undefined;
|
|
5542
5542
|
/**
|
|
5543
5543
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
5544
5544
|
* @public
|
|
@@ -5559,7 +5559,7 @@ export interface ListImportJobsResponse {
|
|
|
5559
5559
|
* response in the next request to retrieve the next set of results.</p>
|
|
5560
5560
|
* @public
|
|
5561
5561
|
*/
|
|
5562
|
-
nextToken?: string;
|
|
5562
|
+
nextToken?: string | undefined;
|
|
5563
5563
|
}
|
|
5564
5564
|
/**
|
|
5565
5565
|
* @public
|
|
@@ -5570,12 +5570,12 @@ export interface ListKnowledgeBasesRequest {
|
|
|
5570
5570
|
* response in the next request to retrieve the next set of results.</p>
|
|
5571
5571
|
* @public
|
|
5572
5572
|
*/
|
|
5573
|
-
nextToken?: string;
|
|
5573
|
+
nextToken?: string | undefined;
|
|
5574
5574
|
/**
|
|
5575
5575
|
* <p>The maximum number of results to return per page.</p>
|
|
5576
5576
|
* @public
|
|
5577
5577
|
*/
|
|
5578
|
-
maxResults?: number;
|
|
5578
|
+
maxResults?: number | undefined;
|
|
5579
5579
|
}
|
|
5580
5580
|
/**
|
|
5581
5581
|
* <p>Summary information about the knowledge base.</p>
|
|
@@ -5611,17 +5611,17 @@ export interface KnowledgeBaseSummary {
|
|
|
5611
5611
|
* <p>Configuration information about the external data source.</p>
|
|
5612
5612
|
* @public
|
|
5613
5613
|
*/
|
|
5614
|
-
sourceConfiguration?: SourceConfiguration;
|
|
5614
|
+
sourceConfiguration?: SourceConfiguration | undefined;
|
|
5615
5615
|
/**
|
|
5616
5616
|
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
5617
5617
|
* @public
|
|
5618
5618
|
*/
|
|
5619
|
-
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
5619
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
5620
5620
|
/**
|
|
5621
5621
|
* <p>Information about how to render the content.</p>
|
|
5622
5622
|
* @public
|
|
5623
5623
|
*/
|
|
5624
|
-
renderingConfiguration?: RenderingConfiguration;
|
|
5624
|
+
renderingConfiguration?: RenderingConfiguration | undefined;
|
|
5625
5625
|
/**
|
|
5626
5626
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
5627
5627
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
@@ -5632,17 +5632,17 @@ export interface KnowledgeBaseSummary {
|
|
|
5632
5632
|
* your instance</a>.</p>
|
|
5633
5633
|
* @public
|
|
5634
5634
|
*/
|
|
5635
|
-
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
5635
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
5636
5636
|
/**
|
|
5637
5637
|
* <p>The description of the knowledge base.</p>
|
|
5638
5638
|
* @public
|
|
5639
5639
|
*/
|
|
5640
|
-
description?: string;
|
|
5640
|
+
description?: string | undefined;
|
|
5641
5641
|
/**
|
|
5642
5642
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
5643
5643
|
* @public
|
|
5644
5644
|
*/
|
|
5645
|
-
tags?: Record<string, string
|
|
5645
|
+
tags?: Record<string, string> | undefined;
|
|
5646
5646
|
}
|
|
5647
5647
|
/**
|
|
5648
5648
|
* @public
|
|
@@ -5657,7 +5657,7 @@ export interface ListKnowledgeBasesResponse {
|
|
|
5657
5657
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
5658
5658
|
* @public
|
|
5659
5659
|
*/
|
|
5660
|
-
nextToken?: string;
|
|
5660
|
+
nextToken?: string | undefined;
|
|
5661
5661
|
}
|
|
5662
5662
|
/**
|
|
5663
5663
|
* @public
|
|
@@ -5668,12 +5668,12 @@ export interface ListQuickResponsesRequest {
|
|
|
5668
5668
|
* response in the next request to retrieve the next set of results.</p>
|
|
5669
5669
|
* @public
|
|
5670
5670
|
*/
|
|
5671
|
-
nextToken?: string;
|
|
5671
|
+
nextToken?: string | undefined;
|
|
5672
5672
|
/**
|
|
5673
5673
|
* <p>The maximum number of results to return per page.</p>
|
|
5674
5674
|
* @public
|
|
5675
5675
|
*/
|
|
5676
|
-
maxResults?: number;
|
|
5676
|
+
maxResults?: number | undefined;
|
|
5677
5677
|
/**
|
|
5678
5678
|
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
5679
5679
|
* @public
|
|
@@ -5744,29 +5744,29 @@ export interface QuickResponseSummary {
|
|
|
5744
5744
|
* <p>The description of the quick response.</p>
|
|
5745
5745
|
* @public
|
|
5746
5746
|
*/
|
|
5747
|
-
description?: string;
|
|
5747
|
+
description?: string | undefined;
|
|
5748
5748
|
/**
|
|
5749
5749
|
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
|
|
5750
5750
|
* data.</p>
|
|
5751
5751
|
* @public
|
|
5752
5752
|
*/
|
|
5753
|
-
lastModifiedBy?: string;
|
|
5753
|
+
lastModifiedBy?: string | undefined;
|
|
5754
5754
|
/**
|
|
5755
5755
|
* <p>Whether the quick response is active.</p>
|
|
5756
5756
|
* @public
|
|
5757
5757
|
*/
|
|
5758
|
-
isActive?: boolean;
|
|
5758
|
+
isActive?: boolean | undefined;
|
|
5759
5759
|
/**
|
|
5760
5760
|
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
5761
5761
|
* The supported contact channel types include <code>Chat</code>.</p>
|
|
5762
5762
|
* @public
|
|
5763
5763
|
*/
|
|
5764
|
-
channels?: string[];
|
|
5764
|
+
channels?: string[] | undefined;
|
|
5765
5765
|
/**
|
|
5766
5766
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
5767
5767
|
* @public
|
|
5768
5768
|
*/
|
|
5769
|
-
tags?: Record<string, string
|
|
5769
|
+
tags?: Record<string, string> | undefined;
|
|
5770
5770
|
}
|
|
5771
5771
|
/**
|
|
5772
5772
|
* @public
|
|
@@ -5782,7 +5782,7 @@ export interface ListQuickResponsesResponse {
|
|
|
5782
5782
|
* response in the next request to retrieve the next set of results.</p>
|
|
5783
5783
|
* @public
|
|
5784
5784
|
*/
|
|
5785
|
-
nextToken?: string;
|
|
5785
|
+
nextToken?: string | undefined;
|
|
5786
5786
|
}
|
|
5787
5787
|
/**
|
|
5788
5788
|
* @public
|
|
@@ -5802,12 +5802,12 @@ export interface UpdateQuickResponseRequest {
|
|
|
5802
5802
|
* <p>The name of the quick response.</p>
|
|
5803
5803
|
* @public
|
|
5804
5804
|
*/
|
|
5805
|
-
name?: string;
|
|
5805
|
+
name?: string | undefined;
|
|
5806
5806
|
/**
|
|
5807
5807
|
* <p>The updated content of the quick response.</p>
|
|
5808
5808
|
* @public
|
|
5809
5809
|
*/
|
|
5810
|
-
content?: QuickResponseDataProvider;
|
|
5810
|
+
content?: QuickResponseDataProvider | undefined;
|
|
5811
5811
|
/**
|
|
5812
5812
|
* <p>The media type of the quick response content.</p>
|
|
5813
5813
|
* <ul>
|
|
@@ -5822,49 +5822,49 @@ export interface UpdateQuickResponseRequest {
|
|
|
5822
5822
|
* </ul>
|
|
5823
5823
|
* @public
|
|
5824
5824
|
*/
|
|
5825
|
-
contentType?: string;
|
|
5825
|
+
contentType?: string | undefined;
|
|
5826
5826
|
/**
|
|
5827
5827
|
* <p>The updated grouping configuration of the quick response.</p>
|
|
5828
5828
|
* @public
|
|
5829
5829
|
*/
|
|
5830
|
-
groupingConfiguration?: GroupingConfiguration;
|
|
5830
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
5831
5831
|
/**
|
|
5832
5832
|
* <p>Whether to remove the grouping configuration of the quick response.</p>
|
|
5833
5833
|
* @public
|
|
5834
5834
|
*/
|
|
5835
|
-
removeGroupingConfiguration?: boolean;
|
|
5835
|
+
removeGroupingConfiguration?: boolean | undefined;
|
|
5836
5836
|
/**
|
|
5837
5837
|
* <p>The updated description of the quick response.</p>
|
|
5838
5838
|
* @public
|
|
5839
5839
|
*/
|
|
5840
|
-
description?: string;
|
|
5840
|
+
description?: string | undefined;
|
|
5841
5841
|
/**
|
|
5842
5842
|
* <p>Whether to remove the description from the quick response.</p>
|
|
5843
5843
|
* @public
|
|
5844
5844
|
*/
|
|
5845
|
-
removeDescription?: boolean;
|
|
5845
|
+
removeDescription?: boolean | undefined;
|
|
5846
5846
|
/**
|
|
5847
5847
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
5848
5848
|
* knowledge base.</p>
|
|
5849
5849
|
* @public
|
|
5850
5850
|
*/
|
|
5851
|
-
shortcutKey?: string;
|
|
5851
|
+
shortcutKey?: string | undefined;
|
|
5852
5852
|
/**
|
|
5853
5853
|
* <p>Whether to remove the shortcut key of the quick response.</p>
|
|
5854
5854
|
* @public
|
|
5855
5855
|
*/
|
|
5856
|
-
removeShortcutKey?: boolean;
|
|
5856
|
+
removeShortcutKey?: boolean | undefined;
|
|
5857
5857
|
/**
|
|
5858
5858
|
* <p>Whether the quick response is active. </p>
|
|
5859
5859
|
* @public
|
|
5860
5860
|
*/
|
|
5861
|
-
isActive?: boolean;
|
|
5861
|
+
isActive?: boolean | undefined;
|
|
5862
5862
|
/**
|
|
5863
5863
|
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
5864
5864
|
* The supported contact channel types include <code>Chat</code>.</p>
|
|
5865
5865
|
* @public
|
|
5866
5866
|
*/
|
|
5867
|
-
channels?: string[];
|
|
5867
|
+
channels?: string[] | undefined;
|
|
5868
5868
|
/**
|
|
5869
5869
|
* <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
|
|
5870
5870
|
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
@@ -5872,7 +5872,7 @@ export interface UpdateQuickResponseRequest {
|
|
|
5872
5872
|
* </p>
|
|
5873
5873
|
* @public
|
|
5874
5874
|
*/
|
|
5875
|
-
language?: string;
|
|
5875
|
+
language?: string | undefined;
|
|
5876
5876
|
}
|
|
5877
5877
|
/**
|
|
5878
5878
|
* @public
|
|
@@ -5882,7 +5882,7 @@ export interface UpdateQuickResponseResponse {
|
|
|
5882
5882
|
* <p>The quick response.</p>
|
|
5883
5883
|
* @public
|
|
5884
5884
|
*/
|
|
5885
|
-
quickResponse?: QuickResponseData;
|
|
5885
|
+
quickResponse?: QuickResponseData | undefined;
|
|
5886
5886
|
}
|
|
5887
5887
|
/**
|
|
5888
5888
|
* @public
|
|
@@ -5908,12 +5908,12 @@ export interface SearchContentRequest {
|
|
|
5908
5908
|
* response in the next request to retrieve the next set of results.</p>
|
|
5909
5909
|
* @public
|
|
5910
5910
|
*/
|
|
5911
|
-
nextToken?: string;
|
|
5911
|
+
nextToken?: string | undefined;
|
|
5912
5912
|
/**
|
|
5913
5913
|
* <p>The maximum number of results to return per page.</p>
|
|
5914
5914
|
* @public
|
|
5915
5915
|
*/
|
|
5916
|
-
maxResults?: number;
|
|
5916
|
+
maxResults?: number | undefined;
|
|
5917
5917
|
/**
|
|
5918
5918
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
5919
5919
|
* @public
|
|
@@ -5938,7 +5938,7 @@ export interface SearchContentResponse {
|
|
|
5938
5938
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
5939
5939
|
* @public
|
|
5940
5940
|
*/
|
|
5941
|
-
nextToken?: string;
|
|
5941
|
+
nextToken?: string | undefined;
|
|
5942
5942
|
}
|
|
5943
5943
|
/**
|
|
5944
5944
|
* @public
|
|
@@ -6005,7 +6005,7 @@ export interface QuickResponseFilterField {
|
|
|
6005
6005
|
* <p>The values of attribute field to filter the quick response by.</p>
|
|
6006
6006
|
* @public
|
|
6007
6007
|
*/
|
|
6008
|
-
values?: string[];
|
|
6008
|
+
values?: string[] | undefined;
|
|
6009
6009
|
/**
|
|
6010
6010
|
* <p>The operator to use for filtering.</p>
|
|
6011
6011
|
* @public
|
|
@@ -6015,7 +6015,7 @@ export interface QuickResponseFilterField {
|
|
|
6015
6015
|
* <p>Whether to treat null value as a match for the attribute field.</p>
|
|
6016
6016
|
* @public
|
|
6017
6017
|
*/
|
|
6018
|
-
includeNoExistence?: boolean;
|
|
6018
|
+
includeNoExistence?: boolean | undefined;
|
|
6019
6019
|
}
|
|
6020
6020
|
/**
|
|
6021
6021
|
* @public
|
|
@@ -6082,7 +6082,7 @@ export interface QuickResponseOrderField {
|
|
|
6082
6082
|
* <p>The order at which the quick responses are sorted by.</p>
|
|
6083
6083
|
* @public
|
|
6084
6084
|
*/
|
|
6085
|
-
order?: Order;
|
|
6085
|
+
order?: Order | undefined;
|
|
6086
6086
|
}
|
|
6087
6087
|
/**
|
|
6088
6088
|
* @public
|
|
@@ -6149,13 +6149,13 @@ export interface QuickResponseQueryField {
|
|
|
6149
6149
|
* the query will only include exact matches if this parameter is set to false.</p>
|
|
6150
6150
|
* @public
|
|
6151
6151
|
*/
|
|
6152
|
-
allowFuzziness?: boolean;
|
|
6152
|
+
allowFuzziness?: boolean | undefined;
|
|
6153
6153
|
/**
|
|
6154
6154
|
* <p>The importance of the attribute field when calculating query result relevancy scores. The
|
|
6155
6155
|
* value set for this parameter affects the ordering of search results.</p>
|
|
6156
6156
|
* @public
|
|
6157
6157
|
*/
|
|
6158
|
-
priority?: Priority;
|
|
6158
|
+
priority?: Priority | undefined;
|
|
6159
6159
|
}
|
|
6160
6160
|
/**
|
|
6161
6161
|
* <p>Information about the import job.</p>
|
|
@@ -6166,17 +6166,17 @@ export interface QuickResponseSearchExpression {
|
|
|
6166
6166
|
* <p>The quick response query expressions.</p>
|
|
6167
6167
|
* @public
|
|
6168
6168
|
*/
|
|
6169
|
-
queries?: QuickResponseQueryField[];
|
|
6169
|
+
queries?: QuickResponseQueryField[] | undefined;
|
|
6170
6170
|
/**
|
|
6171
6171
|
* <p>The configuration of filtering rules applied to quick response query results.</p>
|
|
6172
6172
|
* @public
|
|
6173
6173
|
*/
|
|
6174
|
-
filters?: QuickResponseFilterField[];
|
|
6174
|
+
filters?: QuickResponseFilterField[] | undefined;
|
|
6175
6175
|
/**
|
|
6176
6176
|
* <p>The quick response attribute fields on which the query results are ordered.</p>
|
|
6177
6177
|
* @public
|
|
6178
6178
|
*/
|
|
6179
|
-
orderOnField?: QuickResponseOrderField;
|
|
6179
|
+
orderOnField?: QuickResponseOrderField | undefined;
|
|
6180
6180
|
}
|
|
6181
6181
|
/**
|
|
6182
6182
|
* @public
|
|
@@ -6197,18 +6197,18 @@ export interface SearchQuickResponsesRequest {
|
|
|
6197
6197
|
* response in the next request to retrieve the next set of results.</p>
|
|
6198
6198
|
* @public
|
|
6199
6199
|
*/
|
|
6200
|
-
nextToken?: string;
|
|
6200
|
+
nextToken?: string | undefined;
|
|
6201
6201
|
/**
|
|
6202
6202
|
* <p>The maximum number of results to return per page.</p>
|
|
6203
6203
|
* @public
|
|
6204
6204
|
*/
|
|
6205
|
-
maxResults?: number;
|
|
6205
|
+
maxResults?: number | undefined;
|
|
6206
6206
|
/**
|
|
6207
6207
|
* <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search
|
|
6208
6208
|
* results are returned.</p>
|
|
6209
6209
|
* @public
|
|
6210
6210
|
*/
|
|
6211
|
-
attributes?: Record<string, string
|
|
6211
|
+
attributes?: Record<string, string> | undefined;
|
|
6212
6212
|
}
|
|
6213
6213
|
/**
|
|
6214
6214
|
* <p>The result of quick response search.</p>
|
|
@@ -6284,53 +6284,53 @@ export interface QuickResponseSearchResultData {
|
|
|
6284
6284
|
* <p>The description of the quick response.</p>
|
|
6285
6285
|
* @public
|
|
6286
6286
|
*/
|
|
6287
|
-
description?: string;
|
|
6287
|
+
description?: string | undefined;
|
|
6288
6288
|
/**
|
|
6289
6289
|
* <p>The configuration information of the user groups that the quick response is accessible
|
|
6290
6290
|
* to.</p>
|
|
6291
6291
|
* @public
|
|
6292
6292
|
*/
|
|
6293
|
-
groupingConfiguration?: GroupingConfiguration;
|
|
6293
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
6294
6294
|
/**
|
|
6295
6295
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
6296
6296
|
* knowledge base.</p>
|
|
6297
6297
|
* @public
|
|
6298
6298
|
*/
|
|
6299
|
-
shortcutKey?: string;
|
|
6299
|
+
shortcutKey?: string | undefined;
|
|
6300
6300
|
/**
|
|
6301
6301
|
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response search
|
|
6302
6302
|
* result data.</p>
|
|
6303
6303
|
* @public
|
|
6304
6304
|
*/
|
|
6305
|
-
lastModifiedBy?: string;
|
|
6305
|
+
lastModifiedBy?: string | undefined;
|
|
6306
6306
|
/**
|
|
6307
6307
|
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
6308
6308
|
* The supported contact channel types include <code>Chat</code>.</p>
|
|
6309
6309
|
* @public
|
|
6310
6310
|
*/
|
|
6311
|
-
channels?: string[];
|
|
6311
|
+
channels?: string[] | undefined;
|
|
6312
6312
|
/**
|
|
6313
6313
|
* <p>The language code value for the language in which the quick response is written.</p>
|
|
6314
6314
|
* @public
|
|
6315
6315
|
*/
|
|
6316
|
-
language?: string;
|
|
6316
|
+
language?: string | undefined;
|
|
6317
6317
|
/**
|
|
6318
6318
|
* <p>The user defined contact attributes that are not resolved when the search result is
|
|
6319
6319
|
* returned.</p>
|
|
6320
6320
|
* @public
|
|
6321
6321
|
*/
|
|
6322
|
-
attributesNotInterpolated?: string[];
|
|
6322
|
+
attributesNotInterpolated?: string[] | undefined;
|
|
6323
6323
|
/**
|
|
6324
6324
|
* <p>The user defined contact attributes that are resolved when the search result is
|
|
6325
6325
|
* returned.</p>
|
|
6326
6326
|
* @public
|
|
6327
6327
|
*/
|
|
6328
|
-
attributesInterpolated?: string[];
|
|
6328
|
+
attributesInterpolated?: string[] | undefined;
|
|
6329
6329
|
/**
|
|
6330
6330
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
6331
6331
|
* @public
|
|
6332
6332
|
*/
|
|
6333
|
-
tags?: Record<string, string
|
|
6333
|
+
tags?: Record<string, string> | undefined;
|
|
6334
6334
|
}
|
|
6335
6335
|
/**
|
|
6336
6336
|
* @public
|
|
@@ -6346,7 +6346,7 @@ export interface SearchQuickResponsesResponse {
|
|
|
6346
6346
|
* response in the next request to retrieve the next set of results.</p>
|
|
6347
6347
|
* @public
|
|
6348
6348
|
*/
|
|
6349
|
-
nextToken?: string;
|
|
6349
|
+
nextToken?: string | undefined;
|
|
6350
6350
|
}
|
|
6351
6351
|
/**
|
|
6352
6352
|
* @public
|
|
@@ -6366,7 +6366,7 @@ export interface StartContentUploadRequest {
|
|
|
6366
6366
|
* <p>The expected expiration time of the generated presigned URL, specified in minutes.</p>
|
|
6367
6367
|
* @public
|
|
6368
6368
|
*/
|
|
6369
|
-
presignedUrlTimeToLive?: number;
|
|
6369
|
+
presignedUrlTimeToLive?: number | undefined;
|
|
6370
6370
|
}
|
|
6371
6371
|
/**
|
|
6372
6372
|
* @public
|
|
@@ -6428,18 +6428,18 @@ export interface StartImportJobRequest {
|
|
|
6428
6428
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
6429
6429
|
* @public
|
|
6430
6430
|
*/
|
|
6431
|
-
clientToken?: string;
|
|
6431
|
+
clientToken?: string | undefined;
|
|
6432
6432
|
/**
|
|
6433
6433
|
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
6434
6434
|
* @public
|
|
6435
6435
|
*/
|
|
6436
|
-
metadata?: Record<string, string
|
|
6436
|
+
metadata?: Record<string, string> | undefined;
|
|
6437
6437
|
/**
|
|
6438
6438
|
* <p>The configuration information of the external source that the resource data are imported
|
|
6439
6439
|
* from.</p>
|
|
6440
6440
|
* @public
|
|
6441
6441
|
*/
|
|
6442
|
-
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
6442
|
+
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
6443
6443
|
}
|
|
6444
6444
|
/**
|
|
6445
6445
|
* @public
|
|
@@ -6449,7 +6449,7 @@ export interface StartImportJobResponse {
|
|
|
6449
6449
|
* <p>The import job.</p>
|
|
6450
6450
|
* @public
|
|
6451
6451
|
*/
|
|
6452
|
-
importJob?: ImportJobData;
|
|
6452
|
+
importJob?: ImportJobData | undefined;
|
|
6453
6453
|
}
|
|
6454
6454
|
/**
|
|
6455
6455
|
* @public
|
|
@@ -6474,7 +6474,7 @@ export interface UpdateKnowledgeBaseTemplateUriResponse {
|
|
|
6474
6474
|
* <p>The knowledge base to update.</p>
|
|
6475
6475
|
* @public
|
|
6476
6476
|
*/
|
|
6477
|
-
knowledgeBase?: KnowledgeBaseData;
|
|
6477
|
+
knowledgeBase?: KnowledgeBaseData | undefined;
|
|
6478
6478
|
}
|
|
6479
6479
|
/**
|
|
6480
6480
|
* @public
|
|
@@ -6494,7 +6494,7 @@ export interface ListTagsForResourceResponse {
|
|
|
6494
6494
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
6495
6495
|
* @public
|
|
6496
6496
|
*/
|
|
6497
|
-
tags?: Record<string, string
|
|
6497
|
+
tags?: Record<string, string> | undefined;
|
|
6498
6498
|
}
|
|
6499
6499
|
/**
|
|
6500
6500
|
* @public
|
|
@@ -6527,7 +6527,7 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
6527
6527
|
* <p>The specified resource name.</p>
|
|
6528
6528
|
* @public
|
|
6529
6529
|
*/
|
|
6530
|
-
resourceName?: string;
|
|
6530
|
+
resourceName?: string | undefined;
|
|
6531
6531
|
/**
|
|
6532
6532
|
* @internal
|
|
6533
6533
|
*/
|
|
@@ -6676,27 +6676,27 @@ export interface RecommendationData {
|
|
|
6676
6676
|
* <p>The recommended document.</p>
|
|
6677
6677
|
* @public
|
|
6678
6678
|
*/
|
|
6679
|
-
document?: Document;
|
|
6679
|
+
document?: Document | undefined;
|
|
6680
6680
|
/**
|
|
6681
6681
|
* <p>The relevance score of the recommendation.</p>
|
|
6682
6682
|
* @public
|
|
6683
6683
|
*/
|
|
6684
|
-
relevanceScore?: number;
|
|
6684
|
+
relevanceScore?: number | undefined;
|
|
6685
6685
|
/**
|
|
6686
6686
|
* <p>The relevance level of the recommendation.</p>
|
|
6687
6687
|
* @public
|
|
6688
6688
|
*/
|
|
6689
|
-
relevanceLevel?: RelevanceLevel;
|
|
6689
|
+
relevanceLevel?: RelevanceLevel | undefined;
|
|
6690
6690
|
/**
|
|
6691
6691
|
* <p>The type of recommendation.</p>
|
|
6692
6692
|
* @public
|
|
6693
6693
|
*/
|
|
6694
|
-
type?: RecommendationType;
|
|
6694
|
+
type?: RecommendationType | undefined;
|
|
6695
6695
|
/**
|
|
6696
6696
|
* <p> Summary of the recommended content.</p>
|
|
6697
6697
|
* @public
|
|
6698
6698
|
*/
|
|
6699
|
-
data?: DataSummary;
|
|
6699
|
+
data?: DataSummary | undefined;
|
|
6700
6700
|
}
|
|
6701
6701
|
/**
|
|
6702
6702
|
* <p>Information about the result.</p>
|
|
@@ -6712,22 +6712,22 @@ export interface ResultData {
|
|
|
6712
6712
|
* <p>The document.</p>
|
|
6713
6713
|
* @public
|
|
6714
6714
|
*/
|
|
6715
|
-
document?: Document;
|
|
6715
|
+
document?: Document | undefined;
|
|
6716
6716
|
/**
|
|
6717
6717
|
* <p>The relevance score of the results.</p>
|
|
6718
6718
|
* @public
|
|
6719
6719
|
*/
|
|
6720
|
-
relevanceScore?: number;
|
|
6720
|
+
relevanceScore?: number | undefined;
|
|
6721
6721
|
/**
|
|
6722
6722
|
* <p> Summary of the recommended content.</p>
|
|
6723
6723
|
* @public
|
|
6724
6724
|
*/
|
|
6725
|
-
data?: DataSummary;
|
|
6725
|
+
data?: DataSummary | undefined;
|
|
6726
6726
|
/**
|
|
6727
6727
|
* <p>The type of the query result.</p>
|
|
6728
6728
|
* @public
|
|
6729
6729
|
*/
|
|
6730
|
-
type?: QueryResultType;
|
|
6730
|
+
type?: QueryResultType | undefined;
|
|
6731
6731
|
}
|
|
6732
6732
|
/**
|
|
6733
6733
|
* @public
|
|
@@ -6742,7 +6742,7 @@ export interface GetRecommendationsResponse {
|
|
|
6742
6742
|
* <p>The triggers corresponding to recommendations.</p>
|
|
6743
6743
|
* @public
|
|
6744
6744
|
*/
|
|
6745
|
-
triggers?: RecommendationTrigger[];
|
|
6745
|
+
triggers?: RecommendationTrigger[] | undefined;
|
|
6746
6746
|
}
|
|
6747
6747
|
/**
|
|
6748
6748
|
* @public
|
|
@@ -6757,7 +6757,7 @@ export interface QueryAssistantResponse {
|
|
|
6757
6757
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
6758
6758
|
* @public
|
|
6759
6759
|
*/
|
|
6760
|
-
nextToken?: string;
|
|
6760
|
+
nextToken?: string | undefined;
|
|
6761
6761
|
}
|
|
6762
6762
|
/**
|
|
6763
6763
|
* @internal
|