@aws-sdk/client-qconnect 3.899.0 → 3.903.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/endpoint/ruleset.js +1 -1
- package/dist-cjs/index.js +165 -33
- package/dist-es/commands/CreateMessageTemplateAttachmentCommand.js +1 -1
- package/dist-es/commands/CreateMessageTemplateCommand.js +2 -1
- package/dist-es/endpoint/ruleset.js +1 -1
- package/dist-es/models/models_0.js +39 -28
- package/dist-es/models/models_1.js +48 -1
- package/dist-es/protocols/Aws_restJson1.js +58 -1
- package/dist-types/commands/CreateAIAgentCommand.d.ts +116 -0
- package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +58 -0
- package/dist-types/commands/CreateAIPromptCommand.d.ts +1 -1
- package/dist-types/commands/CreateMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/commands/CreateMessageTemplateCommand.d.ts +2 -1
- package/dist-types/commands/CreateMessageTemplateVersionCommand.d.ts +1 -2
- package/dist-types/commands/CreateSessionCommand.d.ts +4 -0
- package/dist-types/commands/GetAIAgentCommand.d.ts +58 -0
- package/dist-types/commands/GetRecommendationsCommand.d.ts +28 -0
- package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +58 -0
- package/dist-types/commands/ListAIAgentsCommand.d.ts +58 -0
- package/dist-types/commands/QueryAssistantCommand.d.ts +28 -0
- package/dist-types/commands/UpdateAIAgentCommand.d.ts +116 -0
- package/dist-types/models/models_0.d.ts +195 -225
- package/dist-types/models/models_1.d.ts +315 -2
- package/dist-types/ts3.4/commands/CreateMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/CreateMessageTemplateCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/CreateMessageTemplateVersionCommand.d.ts +4 -2
- package/dist-types/ts3.4/models/models_0.d.ts +102 -61
- package/dist-types/ts3.4/models/models_1.d.ts +131 -2
- package/package.json +38 -38
|
@@ -141,6 +141,64 @@ declare const UpdateAIAgentCommand_base: {
|
|
|
141
141
|
* },
|
|
142
142
|
* ],
|
|
143
143
|
* },
|
|
144
|
+
* emailResponseAIAgentConfiguration: { // EmailResponseAIAgentConfiguration
|
|
145
|
+
* emailResponseAIPromptId: "STRING_VALUE",
|
|
146
|
+
* emailQueryReformulationAIPromptId: "STRING_VALUE",
|
|
147
|
+
* locale: "STRING_VALUE",
|
|
148
|
+
* associationConfigurations: [
|
|
149
|
+
* {
|
|
150
|
+
* associationId: "STRING_VALUE",
|
|
151
|
+
* associationType: "STRING_VALUE",
|
|
152
|
+
* associationConfigurationData: {// Union: only one key present
|
|
153
|
+
* knowledgeBaseAssociationConfigurationData: {
|
|
154
|
+
* contentTagFilter: {// Union: only one key present
|
|
155
|
+
* tagCondition: "<TagCondition>",
|
|
156
|
+
* andConditions: "<AndConditions>",
|
|
157
|
+
* orConditions: [
|
|
158
|
+
* {// Union: only one key present
|
|
159
|
+
* andConditions: "<AndConditions>",
|
|
160
|
+
* tagCondition: "<TagCondition>",
|
|
161
|
+
* },
|
|
162
|
+
* ],
|
|
163
|
+
* },
|
|
164
|
+
* maxResults: Number("int"),
|
|
165
|
+
* overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
166
|
+
* },
|
|
167
|
+
* },
|
|
168
|
+
* },
|
|
169
|
+
* ],
|
|
170
|
+
* },
|
|
171
|
+
* emailOverviewAIAgentConfiguration: { // EmailOverviewAIAgentConfiguration
|
|
172
|
+
* emailOverviewAIPromptId: "STRING_VALUE",
|
|
173
|
+
* locale: "STRING_VALUE",
|
|
174
|
+
* },
|
|
175
|
+
* emailGenerativeAnswerAIAgentConfiguration: { // EmailGenerativeAnswerAIAgentConfiguration
|
|
176
|
+
* emailGenerativeAnswerAIPromptId: "STRING_VALUE",
|
|
177
|
+
* emailQueryReformulationAIPromptId: "STRING_VALUE",
|
|
178
|
+
* locale: "STRING_VALUE",
|
|
179
|
+
* associationConfigurations: [
|
|
180
|
+
* {
|
|
181
|
+
* associationId: "STRING_VALUE",
|
|
182
|
+
* associationType: "STRING_VALUE",
|
|
183
|
+
* associationConfigurationData: {// Union: only one key present
|
|
184
|
+
* knowledgeBaseAssociationConfigurationData: {
|
|
185
|
+
* contentTagFilter: {// Union: only one key present
|
|
186
|
+
* tagCondition: "<TagCondition>",
|
|
187
|
+
* andConditions: "<AndConditions>",
|
|
188
|
+
* orConditions: [
|
|
189
|
+
* {// Union: only one key present
|
|
190
|
+
* andConditions: "<AndConditions>",
|
|
191
|
+
* tagCondition: "<TagCondition>",
|
|
192
|
+
* },
|
|
193
|
+
* ],
|
|
194
|
+
* },
|
|
195
|
+
* maxResults: Number("int"),
|
|
196
|
+
* overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
197
|
+
* },
|
|
198
|
+
* },
|
|
199
|
+
* },
|
|
200
|
+
* ],
|
|
201
|
+
* },
|
|
144
202
|
* },
|
|
145
203
|
* description: "STRING_VALUE",
|
|
146
204
|
* };
|
|
@@ -254,6 +312,64 @@ declare const UpdateAIAgentCommand_base: {
|
|
|
254
312
|
* // },
|
|
255
313
|
* // ],
|
|
256
314
|
* // },
|
|
315
|
+
* // emailResponseAIAgentConfiguration: { // EmailResponseAIAgentConfiguration
|
|
316
|
+
* // emailResponseAIPromptId: "STRING_VALUE",
|
|
317
|
+
* // emailQueryReformulationAIPromptId: "STRING_VALUE",
|
|
318
|
+
* // locale: "STRING_VALUE",
|
|
319
|
+
* // associationConfigurations: [
|
|
320
|
+
* // {
|
|
321
|
+
* // associationId: "STRING_VALUE",
|
|
322
|
+
* // associationType: "STRING_VALUE",
|
|
323
|
+
* // associationConfigurationData: {// Union: only one key present
|
|
324
|
+
* // knowledgeBaseAssociationConfigurationData: {
|
|
325
|
+
* // contentTagFilter: {// Union: only one key present
|
|
326
|
+
* // tagCondition: "<TagCondition>",
|
|
327
|
+
* // andConditions: "<AndConditions>",
|
|
328
|
+
* // orConditions: [
|
|
329
|
+
* // {// Union: only one key present
|
|
330
|
+
* // andConditions: "<AndConditions>",
|
|
331
|
+
* // tagCondition: "<TagCondition>",
|
|
332
|
+
* // },
|
|
333
|
+
* // ],
|
|
334
|
+
* // },
|
|
335
|
+
* // maxResults: Number("int"),
|
|
336
|
+
* // overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
337
|
+
* // },
|
|
338
|
+
* // },
|
|
339
|
+
* // },
|
|
340
|
+
* // ],
|
|
341
|
+
* // },
|
|
342
|
+
* // emailOverviewAIAgentConfiguration: { // EmailOverviewAIAgentConfiguration
|
|
343
|
+
* // emailOverviewAIPromptId: "STRING_VALUE",
|
|
344
|
+
* // locale: "STRING_VALUE",
|
|
345
|
+
* // },
|
|
346
|
+
* // emailGenerativeAnswerAIAgentConfiguration: { // EmailGenerativeAnswerAIAgentConfiguration
|
|
347
|
+
* // emailGenerativeAnswerAIPromptId: "STRING_VALUE",
|
|
348
|
+
* // emailQueryReformulationAIPromptId: "STRING_VALUE",
|
|
349
|
+
* // locale: "STRING_VALUE",
|
|
350
|
+
* // associationConfigurations: [
|
|
351
|
+
* // {
|
|
352
|
+
* // associationId: "STRING_VALUE",
|
|
353
|
+
* // associationType: "STRING_VALUE",
|
|
354
|
+
* // associationConfigurationData: {// Union: only one key present
|
|
355
|
+
* // knowledgeBaseAssociationConfigurationData: {
|
|
356
|
+
* // contentTagFilter: {// Union: only one key present
|
|
357
|
+
* // tagCondition: "<TagCondition>",
|
|
358
|
+
* // andConditions: "<AndConditions>",
|
|
359
|
+
* // orConditions: [
|
|
360
|
+
* // {// Union: only one key present
|
|
361
|
+
* // andConditions: "<AndConditions>",
|
|
362
|
+
* // tagCondition: "<TagCondition>",
|
|
363
|
+
* // },
|
|
364
|
+
* // ],
|
|
365
|
+
* // },
|
|
366
|
+
* // maxResults: Number("int"),
|
|
367
|
+
* // overrideKnowledgeBaseSearchType: "STRING_VALUE",
|
|
368
|
+
* // },
|
|
369
|
+
* // },
|
|
370
|
+
* // },
|
|
371
|
+
* // ],
|
|
372
|
+
* // },
|
|
257
373
|
* // },
|
|
258
374
|
* // modifiedTime: new Date("TIMESTAMP"),
|
|
259
375
|
* // description: "STRING_VALUE",
|
|
@@ -367,6 +367,74 @@ export interface AnswerRecommendationAIAgentConfiguration {
|
|
|
367
367
|
*/
|
|
368
368
|
locale?: string | undefined;
|
|
369
369
|
}
|
|
370
|
+
/**
|
|
371
|
+
* <p>Configuration settings for the EMAIL_GENERATIVE_ANSWER AI agent including prompts, locale, and knowledge base associations.</p>
|
|
372
|
+
* @public
|
|
373
|
+
*/
|
|
374
|
+
export interface EmailGenerativeAnswerAIAgentConfiguration {
|
|
375
|
+
/**
|
|
376
|
+
* <p>The ID of the System AI prompt used for generating comprehensive knowledge-based answers from email queries.</p>
|
|
377
|
+
* @public
|
|
378
|
+
*/
|
|
379
|
+
emailGenerativeAnswerAIPromptId?: string | undefined;
|
|
380
|
+
/**
|
|
381
|
+
* <p>The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search results.</p>
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
emailQueryReformulationAIPromptId?: string | undefined;
|
|
385
|
+
/**
|
|
386
|
+
* <p>The locale setting for language-specific email processing and response generation (for example, en_US, es_ES).</p>
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
locale?: string | undefined;
|
|
390
|
+
/**
|
|
391
|
+
* <p>Configuration settings for knowledge base associations used by the email generative answer agent.</p>
|
|
392
|
+
* @public
|
|
393
|
+
*/
|
|
394
|
+
associationConfigurations?: AssociationConfiguration[] | undefined;
|
|
395
|
+
}
|
|
396
|
+
/**
|
|
397
|
+
* <p>Configuration settings for the EMAIL_OVERVIEW AI agent including prompt ID and locale settings.</p>
|
|
398
|
+
* @public
|
|
399
|
+
*/
|
|
400
|
+
export interface EmailOverviewAIAgentConfiguration {
|
|
401
|
+
/**
|
|
402
|
+
* <p>The ID of the System AI prompt used for generating structured email conversation summaries.</p>
|
|
403
|
+
* @public
|
|
404
|
+
*/
|
|
405
|
+
emailOverviewAIPromptId?: string | undefined;
|
|
406
|
+
/**
|
|
407
|
+
* <p>The locale setting for language-specific email overview processing (for example, en_US, es_ES).</p>
|
|
408
|
+
* @public
|
|
409
|
+
*/
|
|
410
|
+
locale?: string | undefined;
|
|
411
|
+
}
|
|
412
|
+
/**
|
|
413
|
+
* <p>Configuration settings for the EMAIL_RESPONSE AI agent including prompts, locale, and knowledge base associations.</p>
|
|
414
|
+
* @public
|
|
415
|
+
*/
|
|
416
|
+
export interface EmailResponseAIAgentConfiguration {
|
|
417
|
+
/**
|
|
418
|
+
* <p>The ID of the System AI prompt used for generating professional email responses based on knowledge base content.</p>
|
|
419
|
+
* @public
|
|
420
|
+
*/
|
|
421
|
+
emailResponseAIPromptId?: string | undefined;
|
|
422
|
+
/**
|
|
423
|
+
* <p>The ID of the System AI prompt used for reformulating email queries to optimize knowledge base search for response generation.</p>
|
|
424
|
+
* @public
|
|
425
|
+
*/
|
|
426
|
+
emailQueryReformulationAIPromptId?: string | undefined;
|
|
427
|
+
/**
|
|
428
|
+
* <p>The locale setting for language-specific email response generation (for example, en_US, es_ES).</p>
|
|
429
|
+
* @public
|
|
430
|
+
*/
|
|
431
|
+
locale?: string | undefined;
|
|
432
|
+
/**
|
|
433
|
+
* <p>Configuration settings for knowledge base associations used by the email response agent.</p>
|
|
434
|
+
* @public
|
|
435
|
+
*/
|
|
436
|
+
associationConfigurations?: AssociationConfiguration[] | undefined;
|
|
437
|
+
}
|
|
370
438
|
/**
|
|
371
439
|
* <p>The configuration for the <code>MANUAL_SEARCH</code> AI Agent type.</p>
|
|
372
440
|
* @public
|
|
@@ -423,7 +491,7 @@ export interface SelfServiceAIAgentConfiguration {
|
|
|
423
491
|
* <p>A typed union that specifies the configuration based on the type of AI Agent.</p>
|
|
424
492
|
* @public
|
|
425
493
|
*/
|
|
426
|
-
export type AIAgentConfiguration = AIAgentConfiguration.AnswerRecommendationAIAgentConfigurationMember | AIAgentConfiguration.ManualSearchAIAgentConfigurationMember | AIAgentConfiguration.SelfServiceAIAgentConfigurationMember | AIAgentConfiguration.$UnknownMember;
|
|
494
|
+
export type AIAgentConfiguration = AIAgentConfiguration.AnswerRecommendationAIAgentConfigurationMember | AIAgentConfiguration.EmailGenerativeAnswerAIAgentConfigurationMember | AIAgentConfiguration.EmailOverviewAIAgentConfigurationMember | AIAgentConfiguration.EmailResponseAIAgentConfigurationMember | AIAgentConfiguration.ManualSearchAIAgentConfigurationMember | AIAgentConfiguration.SelfServiceAIAgentConfigurationMember | AIAgentConfiguration.$UnknownMember;
|
|
427
495
|
/**
|
|
428
496
|
* @public
|
|
429
497
|
*/
|
|
@@ -436,6 +504,9 @@ export declare namespace AIAgentConfiguration {
|
|
|
436
504
|
manualSearchAIAgentConfiguration: ManualSearchAIAgentConfiguration;
|
|
437
505
|
answerRecommendationAIAgentConfiguration?: never;
|
|
438
506
|
selfServiceAIAgentConfiguration?: never;
|
|
507
|
+
emailResponseAIAgentConfiguration?: never;
|
|
508
|
+
emailOverviewAIAgentConfiguration?: never;
|
|
509
|
+
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
439
510
|
$unknown?: never;
|
|
440
511
|
}
|
|
441
512
|
/**
|
|
@@ -446,6 +517,9 @@ export declare namespace AIAgentConfiguration {
|
|
|
446
517
|
manualSearchAIAgentConfiguration?: never;
|
|
447
518
|
answerRecommendationAIAgentConfiguration: AnswerRecommendationAIAgentConfiguration;
|
|
448
519
|
selfServiceAIAgentConfiguration?: never;
|
|
520
|
+
emailResponseAIAgentConfiguration?: never;
|
|
521
|
+
emailOverviewAIAgentConfiguration?: never;
|
|
522
|
+
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
449
523
|
$unknown?: never;
|
|
450
524
|
}
|
|
451
525
|
/**
|
|
@@ -456,6 +530,48 @@ export declare namespace AIAgentConfiguration {
|
|
|
456
530
|
manualSearchAIAgentConfiguration?: never;
|
|
457
531
|
answerRecommendationAIAgentConfiguration?: never;
|
|
458
532
|
selfServiceAIAgentConfiguration: SelfServiceAIAgentConfiguration;
|
|
533
|
+
emailResponseAIAgentConfiguration?: never;
|
|
534
|
+
emailOverviewAIAgentConfiguration?: never;
|
|
535
|
+
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
536
|
+
$unknown?: never;
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
* <p>Configuration for the EMAIL_RESPONSE AI agent that generates professional email responses using knowledge base content.</p>
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
interface EmailResponseAIAgentConfigurationMember {
|
|
543
|
+
manualSearchAIAgentConfiguration?: never;
|
|
544
|
+
answerRecommendationAIAgentConfiguration?: never;
|
|
545
|
+
selfServiceAIAgentConfiguration?: never;
|
|
546
|
+
emailResponseAIAgentConfiguration: EmailResponseAIAgentConfiguration;
|
|
547
|
+
emailOverviewAIAgentConfiguration?: never;
|
|
548
|
+
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
549
|
+
$unknown?: never;
|
|
550
|
+
}
|
|
551
|
+
/**
|
|
552
|
+
* <p>Configuration for the EMAIL_OVERVIEW AI agent that generates structured overview of email conversations.</p>
|
|
553
|
+
* @public
|
|
554
|
+
*/
|
|
555
|
+
interface EmailOverviewAIAgentConfigurationMember {
|
|
556
|
+
manualSearchAIAgentConfiguration?: never;
|
|
557
|
+
answerRecommendationAIAgentConfiguration?: never;
|
|
558
|
+
selfServiceAIAgentConfiguration?: never;
|
|
559
|
+
emailResponseAIAgentConfiguration?: never;
|
|
560
|
+
emailOverviewAIAgentConfiguration: EmailOverviewAIAgentConfiguration;
|
|
561
|
+
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
562
|
+
$unknown?: never;
|
|
563
|
+
}
|
|
564
|
+
/**
|
|
565
|
+
* <p>Configuration for the EMAIL_GENERATIVE_ANSWER AI agent that provides comprehensive knowledge-based answers for customer queries.</p>
|
|
566
|
+
* @public
|
|
567
|
+
*/
|
|
568
|
+
interface EmailGenerativeAnswerAIAgentConfigurationMember {
|
|
569
|
+
manualSearchAIAgentConfiguration?: never;
|
|
570
|
+
answerRecommendationAIAgentConfiguration?: never;
|
|
571
|
+
selfServiceAIAgentConfiguration?: never;
|
|
572
|
+
emailResponseAIAgentConfiguration?: never;
|
|
573
|
+
emailOverviewAIAgentConfiguration?: never;
|
|
574
|
+
emailGenerativeAnswerAIAgentConfiguration: EmailGenerativeAnswerAIAgentConfiguration;
|
|
459
575
|
$unknown?: never;
|
|
460
576
|
}
|
|
461
577
|
/**
|
|
@@ -465,12 +581,18 @@ export declare namespace AIAgentConfiguration {
|
|
|
465
581
|
manualSearchAIAgentConfiguration?: never;
|
|
466
582
|
answerRecommendationAIAgentConfiguration?: never;
|
|
467
583
|
selfServiceAIAgentConfiguration?: never;
|
|
584
|
+
emailResponseAIAgentConfiguration?: never;
|
|
585
|
+
emailOverviewAIAgentConfiguration?: never;
|
|
586
|
+
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
468
587
|
$unknown: [string, any];
|
|
469
588
|
}
|
|
470
589
|
interface Visitor<T> {
|
|
471
590
|
manualSearchAIAgentConfiguration: (value: ManualSearchAIAgentConfiguration) => T;
|
|
472
591
|
answerRecommendationAIAgentConfiguration: (value: AnswerRecommendationAIAgentConfiguration) => T;
|
|
473
592
|
selfServiceAIAgentConfiguration: (value: SelfServiceAIAgentConfiguration) => T;
|
|
593
|
+
emailResponseAIAgentConfiguration: (value: EmailResponseAIAgentConfiguration) => T;
|
|
594
|
+
emailOverviewAIAgentConfiguration: (value: EmailOverviewAIAgentConfiguration) => T;
|
|
595
|
+
emailGenerativeAnswerAIAgentConfiguration: (value: EmailGenerativeAnswerAIAgentConfiguration) => T;
|
|
474
596
|
_: (name: string, value: any) => T;
|
|
475
597
|
}
|
|
476
598
|
const visit: <T>(value: AIAgentConfiguration, visitor: Visitor<T>) => T;
|
|
@@ -481,6 +603,9 @@ export declare namespace AIAgentConfiguration {
|
|
|
481
603
|
*/
|
|
482
604
|
export declare const AIAgentType: {
|
|
483
605
|
readonly ANSWER_RECOMMENDATION: "ANSWER_RECOMMENDATION";
|
|
606
|
+
readonly EMAIL_GENERATIVE_ANSWER: "EMAIL_GENERATIVE_ANSWER";
|
|
607
|
+
readonly EMAIL_OVERVIEW: "EMAIL_OVERVIEW";
|
|
608
|
+
readonly EMAIL_RESPONSE: "EMAIL_RESPONSE";
|
|
484
609
|
readonly MANUAL_SEARCH: "MANUAL_SEARCH";
|
|
485
610
|
readonly SELF_SERVICE: "SELF_SERVICE";
|
|
486
611
|
};
|
|
@@ -1910,6 +2035,10 @@ export type AIPromptTemplateType = (typeof AIPromptTemplateType)[keyof typeof AI
|
|
|
1910
2035
|
*/
|
|
1911
2036
|
export declare const AIPromptType: {
|
|
1912
2037
|
readonly ANSWER_GENERATION: "ANSWER_GENERATION";
|
|
2038
|
+
readonly EMAIL_GENERATIVE_ANSWER: "EMAIL_GENERATIVE_ANSWER";
|
|
2039
|
+
readonly EMAIL_OVERVIEW: "EMAIL_OVERVIEW";
|
|
2040
|
+
readonly EMAIL_QUERY_REFORMULATION: "EMAIL_QUERY_REFORMULATION";
|
|
2041
|
+
readonly EMAIL_RESPONSE: "EMAIL_RESPONSE";
|
|
1913
2042
|
readonly INTENT_LABELING_GENERATION: "INTENT_LABELING_GENERATION";
|
|
1914
2043
|
readonly QUERY_REFORMULATION: "QUERY_REFORMULATION";
|
|
1915
2044
|
readonly SELF_SERVICE_ANSWER_GENERATION: "SELF_SERVICE_ANSWER_GENERATION";
|
|
@@ -1959,7 +2088,7 @@ export interface CreateAIPromptRequest {
|
|
|
1959
2088
|
*/
|
|
1960
2089
|
templateType: AIPromptTemplateType | undefined;
|
|
1961
2090
|
/**
|
|
1962
|
-
* <p>The identifier of the model used for this AI Prompt.</p>
|
|
2091
|
+
* <p>The identifier of the model used for this AI Prompt.</p> <note> <p>For information about which models are supported in each Amazon Web Services Region, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt">Supported models for system/custom prompts</a>.</p> </note>
|
|
1963
2092
|
* @public
|
|
1964
2093
|
*/
|
|
1965
2094
|
modelId: string | undefined;
|
|
@@ -2407,7 +2536,7 @@ export interface UpdateAIPromptRequest {
|
|
|
2407
2536
|
*/
|
|
2408
2537
|
description?: string | undefined;
|
|
2409
2538
|
/**
|
|
2410
|
-
* <p>The identifier of the model used for this AI Prompt.</p> <note> <p>For
|
|
2539
|
+
* <p>The identifier of the model used for this AI Prompt.</p> <note> <p>For information about which models are supported in each Amazon Web Services Region, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-ai-prompts.html#cli-create-aiprompt">Supported models for system/custom prompts</a>.</p> </note>
|
|
2411
2540
|
* @public
|
|
2412
2541
|
*/
|
|
2413
2542
|
modelId?: string | undefined;
|
|
@@ -3074,6 +3203,38 @@ export interface ContentDataDetails {
|
|
|
3074
3203
|
*/
|
|
3075
3204
|
rankingData: RankingData | undefined;
|
|
3076
3205
|
}
|
|
3206
|
+
/**
|
|
3207
|
+
* <p>Details of streaming chunk data for email overview including completion text and pagination tokens.</p>
|
|
3208
|
+
* @public
|
|
3209
|
+
*/
|
|
3210
|
+
export interface EmailOverviewChunkDataDetails {
|
|
3211
|
+
/**
|
|
3212
|
+
* <p>The partial or complete overview text content in structured HTML format with customer issues, resolutions, and next steps.</p>
|
|
3213
|
+
* @public
|
|
3214
|
+
*/
|
|
3215
|
+
completion?: string | undefined;
|
|
3216
|
+
/**
|
|
3217
|
+
* <p>Token for retrieving the next chunk of streaming overview data, if available.</p>
|
|
3218
|
+
* @public
|
|
3219
|
+
*/
|
|
3220
|
+
nextChunkToken?: string | undefined;
|
|
3221
|
+
}
|
|
3222
|
+
/**
|
|
3223
|
+
* <p>Details of streaming chunk data for email responses including completion text and pagination tokens.</p>
|
|
3224
|
+
* @public
|
|
3225
|
+
*/
|
|
3226
|
+
export interface EmailResponseChunkDataDetails {
|
|
3227
|
+
/**
|
|
3228
|
+
* <p>The partial or complete professional email response text with appropriate greetings and closings.</p>
|
|
3229
|
+
* @public
|
|
3230
|
+
*/
|
|
3231
|
+
completion?: string | undefined;
|
|
3232
|
+
/**
|
|
3233
|
+
* <p>Token for retrieving the next chunk of streaming response data, if available.</p>
|
|
3234
|
+
* @public
|
|
3235
|
+
*/
|
|
3236
|
+
nextChunkToken?: string | undefined;
|
|
3237
|
+
}
|
|
3077
3238
|
/**
|
|
3078
3239
|
* <p>Details about the detected intent.</p>
|
|
3079
3240
|
* @public
|
|
@@ -3283,6 +3444,9 @@ export declare const RecommendationType: {
|
|
|
3283
3444
|
readonly BLOCKED_GENERATIVE_ANSWER_CHUNK: "BLOCKED_GENERATIVE_ANSWER_CHUNK";
|
|
3284
3445
|
readonly BLOCKED_INTENT_ANSWER_CHUNK: "BLOCKED_INTENT_ANSWER_CHUNK";
|
|
3285
3446
|
readonly DETECTED_INTENT: "DETECTED_INTENT";
|
|
3447
|
+
readonly EMAIL_GENERATIVE_ANSWER_CHUNK: "EMAIL_GENERATIVE_ANSWER_CHUNK";
|
|
3448
|
+
readonly EMAIL_OVERVIEW_CHUNK: "EMAIL_OVERVIEW_CHUNK";
|
|
3449
|
+
readonly EMAIL_RESPONSE_CHUNK: "EMAIL_RESPONSE_CHUNK";
|
|
3286
3450
|
readonly GENERATIVE_ANSWER: "GENERATIVE_ANSWER";
|
|
3287
3451
|
readonly GENERATIVE_ANSWER_CHUNK: "GENERATIVE_ANSWER_CHUNK";
|
|
3288
3452
|
readonly GENERATIVE_RESPONSE: "GENERATIVE_RESPONSE";
|
|
@@ -3841,6 +4005,9 @@ export interface QueryAssistantRequest {
|
|
|
3841
4005
|
export declare const QueryResultType: {
|
|
3842
4006
|
readonly BLOCKED_GENERATIVE_ANSWER_CHUNK: "BLOCKED_GENERATIVE_ANSWER_CHUNK";
|
|
3843
4007
|
readonly BLOCKED_INTENT_ANSWER_CHUNK: "BLOCKED_INTENT_ANSWER_CHUNK";
|
|
4008
|
+
readonly EMAIL_GENERATIVE_ANSWER_CHUNK: "EMAIL_GENERATIVE_ANSWER_CHUNK";
|
|
4009
|
+
readonly EMAIL_OVERVIEW_CHUNK: "EMAIL_OVERVIEW_CHUNK";
|
|
4010
|
+
readonly EMAIL_RESPONSE_CHUNK: "EMAIL_RESPONSE_CHUNK";
|
|
3844
4011
|
readonly GENERATIVE_ANSWER: "GENERATIVE_ANSWER";
|
|
3845
4012
|
readonly GENERATIVE_ANSWER_CHUNK: "GENERATIVE_ANSWER_CHUNK";
|
|
3846
4013
|
readonly INTENT_ANSWER: "INTENT_ANSWER";
|
|
@@ -4043,6 +4210,11 @@ export interface CreateSessionRequest {
|
|
|
4043
4210
|
* @public
|
|
4044
4211
|
*/
|
|
4045
4212
|
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
|
|
4213
|
+
/**
|
|
4214
|
+
* <p>The Amazon Resource Name (ARN) of the email contact in Amazon Connect. Used to retrieve email content and establish session context for AI-powered email assistance.</p>
|
|
4215
|
+
* @public
|
|
4216
|
+
*/
|
|
4217
|
+
contactArn?: string | undefined;
|
|
4046
4218
|
}
|
|
4047
4219
|
/**
|
|
4048
4220
|
* <p>The configuration information for the session integration.</p>
|
|
@@ -4116,6 +4288,18 @@ export interface CreateSessionResponse {
|
|
|
4116
4288
|
*/
|
|
4117
4289
|
session?: SessionData | undefined;
|
|
4118
4290
|
}
|
|
4291
|
+
/**
|
|
4292
|
+
* <p>An error occurred while calling a dependency. For example, calling <code>connect:DecribeContact</code> as part of <code>CreateSession</code> with a contactArn.</p>
|
|
4293
|
+
* @public
|
|
4294
|
+
*/
|
|
4295
|
+
export declare class DependencyFailedException extends __BaseException {
|
|
4296
|
+
readonly name: "DependencyFailedException";
|
|
4297
|
+
readonly $fault: "client";
|
|
4298
|
+
/**
|
|
4299
|
+
* @internal
|
|
4300
|
+
*/
|
|
4301
|
+
constructor(opts: __ExceptionOptionType<DependencyFailedException, __BaseException>);
|
|
4302
|
+
}
|
|
4119
4303
|
/**
|
|
4120
4304
|
* @public
|
|
4121
4305
|
*/
|
|
@@ -6488,208 +6672,6 @@ export declare const MessageTemplateAttributeType: {
|
|
|
6488
6672
|
* @public
|
|
6489
6673
|
*/
|
|
6490
6674
|
export type MessageTemplateAttributeType = (typeof MessageTemplateAttributeType)[keyof typeof MessageTemplateAttributeType];
|
|
6491
|
-
/**
|
|
6492
|
-
* <p>The data of a message template.</p>
|
|
6493
|
-
* @public
|
|
6494
|
-
*/
|
|
6495
|
-
export interface MessageTemplateData {
|
|
6496
|
-
/**
|
|
6497
|
-
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
6498
|
-
* @public
|
|
6499
|
-
*/
|
|
6500
|
-
messageTemplateArn: string | undefined;
|
|
6501
|
-
/**
|
|
6502
|
-
* <p>The identifier of the message template.</p>
|
|
6503
|
-
* @public
|
|
6504
|
-
*/
|
|
6505
|
-
messageTemplateId: string | undefined;
|
|
6506
|
-
/**
|
|
6507
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
6508
|
-
* @public
|
|
6509
|
-
*/
|
|
6510
|
-
knowledgeBaseArn: string | undefined;
|
|
6511
|
-
/**
|
|
6512
|
-
* <p>The identifier of the knowledge base.</p>
|
|
6513
|
-
* @public
|
|
6514
|
-
*/
|
|
6515
|
-
knowledgeBaseId: string | undefined;
|
|
6516
|
-
/**
|
|
6517
|
-
* <p>The name of the message template.</p>
|
|
6518
|
-
* @public
|
|
6519
|
-
*/
|
|
6520
|
-
name: string | undefined;
|
|
6521
|
-
/**
|
|
6522
|
-
* <p>The channel subtype this message template applies to.</p>
|
|
6523
|
-
* @public
|
|
6524
|
-
*/
|
|
6525
|
-
channelSubtype: ChannelSubtype | undefined;
|
|
6526
|
-
/**
|
|
6527
|
-
* <p>The timestamp when the message template was created.</p>
|
|
6528
|
-
* @public
|
|
6529
|
-
*/
|
|
6530
|
-
createdTime: Date | undefined;
|
|
6531
|
-
/**
|
|
6532
|
-
* <p>The timestamp when the message template data was last modified.</p>
|
|
6533
|
-
* @public
|
|
6534
|
-
*/
|
|
6535
|
-
lastModifiedTime: Date | undefined;
|
|
6536
|
-
/**
|
|
6537
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
6538
|
-
* @public
|
|
6539
|
-
*/
|
|
6540
|
-
lastModifiedBy: string | undefined;
|
|
6541
|
-
/**
|
|
6542
|
-
* <p>The content of the message template.</p>
|
|
6543
|
-
* @public
|
|
6544
|
-
*/
|
|
6545
|
-
content: MessageTemplateContentProvider | undefined;
|
|
6546
|
-
/**
|
|
6547
|
-
* <p>The description of the message template.</p>
|
|
6548
|
-
* @public
|
|
6549
|
-
*/
|
|
6550
|
-
description?: string | undefined;
|
|
6551
|
-
/**
|
|
6552
|
-
* <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>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>
|
|
6553
|
-
* @public
|
|
6554
|
-
*/
|
|
6555
|
-
language?: string | undefined;
|
|
6556
|
-
/**
|
|
6557
|
-
* <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
|
|
6558
|
-
* @public
|
|
6559
|
-
*/
|
|
6560
|
-
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
6561
|
-
/**
|
|
6562
|
-
* <p>An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.</p>
|
|
6563
|
-
* @public
|
|
6564
|
-
*/
|
|
6565
|
-
defaultAttributes?: MessageTemplateAttributes | undefined;
|
|
6566
|
-
/**
|
|
6567
|
-
* <p>The types of attributes that the message template contains.</p>
|
|
6568
|
-
* @public
|
|
6569
|
-
*/
|
|
6570
|
-
attributeTypes?: MessageTemplateAttributeType[] | undefined;
|
|
6571
|
-
/**
|
|
6572
|
-
* <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
|
|
6573
|
-
* @public
|
|
6574
|
-
*/
|
|
6575
|
-
messageTemplateContentSha256: string | undefined;
|
|
6576
|
-
/**
|
|
6577
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
6578
|
-
* @public
|
|
6579
|
-
*/
|
|
6580
|
-
tags?: Record<string, string> | undefined;
|
|
6581
|
-
}
|
|
6582
|
-
/**
|
|
6583
|
-
* @public
|
|
6584
|
-
*/
|
|
6585
|
-
export interface CreateMessageTemplateResponse {
|
|
6586
|
-
/**
|
|
6587
|
-
* <p>The message template.</p>
|
|
6588
|
-
* @public
|
|
6589
|
-
*/
|
|
6590
|
-
messageTemplate?: MessageTemplateData | undefined;
|
|
6591
|
-
}
|
|
6592
|
-
/**
|
|
6593
|
-
* @public
|
|
6594
|
-
*/
|
|
6595
|
-
export interface CreateMessageTemplateAttachmentRequest {
|
|
6596
|
-
/**
|
|
6597
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
6598
|
-
* @public
|
|
6599
|
-
*/
|
|
6600
|
-
knowledgeBaseId: string | undefined;
|
|
6601
|
-
/**
|
|
6602
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
6603
|
-
* @public
|
|
6604
|
-
*/
|
|
6605
|
-
messageTemplateId: string | undefined;
|
|
6606
|
-
/**
|
|
6607
|
-
* <p>The presentation information for the attachment file.</p>
|
|
6608
|
-
* @public
|
|
6609
|
-
*/
|
|
6610
|
-
contentDisposition: ContentDisposition | undefined;
|
|
6611
|
-
/**
|
|
6612
|
-
* <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
|
|
6613
|
-
* @public
|
|
6614
|
-
*/
|
|
6615
|
-
name: string | undefined;
|
|
6616
|
-
/**
|
|
6617
|
-
* <p>The body of the attachment file being uploaded. It should be encoded using base64 encoding.</p>
|
|
6618
|
-
* @public
|
|
6619
|
-
*/
|
|
6620
|
-
body: string | undefined;
|
|
6621
|
-
/**
|
|
6622
|
-
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
6623
|
-
* @public
|
|
6624
|
-
*/
|
|
6625
|
-
clientToken?: string | undefined;
|
|
6626
|
-
}
|
|
6627
|
-
/**
|
|
6628
|
-
* <p>Information about the message template attachment.</p>
|
|
6629
|
-
* @public
|
|
6630
|
-
*/
|
|
6631
|
-
export interface MessageTemplateAttachment {
|
|
6632
|
-
/**
|
|
6633
|
-
* <p>The presentation information for the attachment file.</p>
|
|
6634
|
-
* @public
|
|
6635
|
-
*/
|
|
6636
|
-
contentDisposition: ContentDisposition | undefined;
|
|
6637
|
-
/**
|
|
6638
|
-
* <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
|
|
6639
|
-
* @public
|
|
6640
|
-
*/
|
|
6641
|
-
name: string | undefined;
|
|
6642
|
-
/**
|
|
6643
|
-
* <p>The timestamp when the attachment file was uploaded.</p>
|
|
6644
|
-
* @public
|
|
6645
|
-
*/
|
|
6646
|
-
uploadedTime: Date | undefined;
|
|
6647
|
-
/**
|
|
6648
|
-
* <p>A pre-signed Amazon S3 URL that can be used to download the attachment file.</p>
|
|
6649
|
-
* @public
|
|
6650
|
-
*/
|
|
6651
|
-
url: string | undefined;
|
|
6652
|
-
/**
|
|
6653
|
-
* <p>The expiration time of the pre-signed Amazon S3 URL.</p>
|
|
6654
|
-
* @public
|
|
6655
|
-
*/
|
|
6656
|
-
urlExpiry: Date | undefined;
|
|
6657
|
-
/**
|
|
6658
|
-
* <p>The identifier of the attachment file.</p>
|
|
6659
|
-
* @public
|
|
6660
|
-
*/
|
|
6661
|
-
attachmentId: string | undefined;
|
|
6662
|
-
}
|
|
6663
|
-
/**
|
|
6664
|
-
* @public
|
|
6665
|
-
*/
|
|
6666
|
-
export interface CreateMessageTemplateAttachmentResponse {
|
|
6667
|
-
/**
|
|
6668
|
-
* <p>The message template attachment.</p>
|
|
6669
|
-
* @public
|
|
6670
|
-
*/
|
|
6671
|
-
attachment?: MessageTemplateAttachment | undefined;
|
|
6672
|
-
}
|
|
6673
|
-
/**
|
|
6674
|
-
* @public
|
|
6675
|
-
*/
|
|
6676
|
-
export interface CreateMessageTemplateVersionRequest {
|
|
6677
|
-
/**
|
|
6678
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
6679
|
-
* @public
|
|
6680
|
-
*/
|
|
6681
|
-
knowledgeBaseId: string | undefined;
|
|
6682
|
-
/**
|
|
6683
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
6684
|
-
* @public
|
|
6685
|
-
*/
|
|
6686
|
-
messageTemplateId: string | undefined;
|
|
6687
|
-
/**
|
|
6688
|
-
* <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the <code>$LATEST</code> qualifier by default.</p>
|
|
6689
|
-
* @public
|
|
6690
|
-
*/
|
|
6691
|
-
messageTemplateContentSha256?: string | undefined;
|
|
6692
|
-
}
|
|
6693
6675
|
/**
|
|
6694
6676
|
* @internal
|
|
6695
6677
|
*/
|
|
@@ -6834,6 +6816,14 @@ export declare const TextDataFilterSensitiveLog: (obj: TextData) => any;
|
|
|
6834
6816
|
* @internal
|
|
6835
6817
|
*/
|
|
6836
6818
|
export declare const ContentDataDetailsFilterSensitiveLog: (obj: ContentDataDetails) => any;
|
|
6819
|
+
/**
|
|
6820
|
+
* @internal
|
|
6821
|
+
*/
|
|
6822
|
+
export declare const EmailOverviewChunkDataDetailsFilterSensitiveLog: (obj: EmailOverviewChunkDataDetails) => any;
|
|
6823
|
+
/**
|
|
6824
|
+
* @internal
|
|
6825
|
+
*/
|
|
6826
|
+
export declare const EmailResponseChunkDataDetailsFilterSensitiveLog: (obj: EmailResponseChunkDataDetails) => any;
|
|
6837
6827
|
/**
|
|
6838
6828
|
* @internal
|
|
6839
6829
|
*/
|
|
@@ -7014,23 +7004,3 @@ export declare const GroupingConfigurationFilterSensitiveLog: (obj: GroupingConf
|
|
|
7014
7004
|
* @internal
|
|
7015
7005
|
*/
|
|
7016
7006
|
export declare const CreateMessageTemplateRequestFilterSensitiveLog: (obj: CreateMessageTemplateRequest) => any;
|
|
7017
|
-
/**
|
|
7018
|
-
* @internal
|
|
7019
|
-
*/
|
|
7020
|
-
export declare const MessageTemplateDataFilterSensitiveLog: (obj: MessageTemplateData) => any;
|
|
7021
|
-
/**
|
|
7022
|
-
* @internal
|
|
7023
|
-
*/
|
|
7024
|
-
export declare const CreateMessageTemplateResponseFilterSensitiveLog: (obj: CreateMessageTemplateResponse) => any;
|
|
7025
|
-
/**
|
|
7026
|
-
* @internal
|
|
7027
|
-
*/
|
|
7028
|
-
export declare const CreateMessageTemplateAttachmentRequestFilterSensitiveLog: (obj: CreateMessageTemplateAttachmentRequest) => any;
|
|
7029
|
-
/**
|
|
7030
|
-
* @internal
|
|
7031
|
-
*/
|
|
7032
|
-
export declare const MessageTemplateAttachmentFilterSensitiveLog: (obj: MessageTemplateAttachment) => any;
|
|
7033
|
-
/**
|
|
7034
|
-
* @internal
|
|
7035
|
-
*/
|
|
7036
|
-
export declare const CreateMessageTemplateAttachmentResponseFilterSensitiveLog: (obj: CreateMessageTemplateAttachmentResponse) => any;
|