@aws-sdk/client-qconnect 3.940.0 → 3.943.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/dist-cjs/index.js +879 -101
- package/dist-es/QConnect.js +4 -0
- package/dist-es/commands/ListSpansCommand.js +16 -0
- package/dist-es/commands/RetrieveCommand.js +16 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/enums.js +61 -12
- package/dist-es/models/errors.js +12 -0
- package/dist-es/pagination/ListSpansPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +774 -90
- package/dist-types/QConnect.d.ts +14 -0
- package/dist-types/QConnectClient.d.ts +4 -2
- package/dist-types/commands/CreateAIAgentCommand.d.ts +126 -0
- package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +63 -0
- package/dist-types/commands/CreateAIPromptCommand.d.ts +16 -0
- package/dist-types/commands/CreateAIPromptVersionCommand.d.ts +8 -0
- package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +8 -0
- package/dist-types/commands/CreateAssistantCommand.d.ts +6 -0
- package/dist-types/commands/CreateSessionCommand.d.ts +14 -1
- package/dist-types/commands/DeleteImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/GetAIAgentCommand.d.ts +63 -0
- package/dist-types/commands/GetAIPromptCommand.d.ts +8 -0
- package/dist-types/commands/GetAssistantAssociationCommand.d.ts +4 -0
- package/dist-types/commands/GetAssistantCommand.d.ts +6 -0
- package/dist-types/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/GetMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetNextMessageCommand.d.ts +26 -0
- package/dist-types/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/GetRecommendationsCommand.d.ts +39 -0
- package/dist-types/commands/GetSessionCommand.d.ts +6 -0
- package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +63 -0
- package/dist-types/commands/ListAIAgentsCommand.d.ts +63 -0
- package/dist-types/commands/ListAssistantAssociationsCommand.d.ts +4 -0
- package/dist-types/commands/ListAssistantsCommand.d.ts +6 -0
- package/dist-types/commands/ListImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListMessageTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListMessagesCommand.d.ts +23 -0
- package/dist-types/commands/ListSpansCommand.d.ts +207 -0
- package/dist-types/commands/QueryAssistantCommand.d.ts +41 -0
- package/dist-types/commands/RemoveAssistantAIAgentCommand.d.ts +1 -0
- package/dist-types/commands/RenderMessageTemplateCommand.d.ts +1 -2
- package/dist-types/commands/RetrieveCommand.d.ts +168 -0
- package/dist-types/commands/SendMessageCommand.d.ts +37 -1
- package/dist-types/commands/UpdateAIAgentCommand.d.ts +126 -0
- package/dist-types/commands/UpdateAIPromptCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAssistantAIAgentCommand.d.ts +12 -0
- package/dist-types/commands/UpdateSessionCommand.d.ts +13 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/enums.d.ts +110 -21
- package/dist-types/models/errors.d.ts +13 -1
- package/dist-types/models/models_0.d.ts +996 -723
- package/dist-types/models/models_1.d.ts +1563 -48
- package/dist-types/pagination/ListSpansPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +64 -0
- package/dist-types/ts3.4/QConnect.d.ts +34 -0
- package/dist-types/ts3.4/QConnectClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/DeleteImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListImportJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessageTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessageTemplatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSpansCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/RenderMessageTemplateCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/enums.d.ts +71 -15
- package/dist-types/ts3.4/models/errors.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +354 -172
- package/dist-types/ts3.4/models/models_1.d.ts +663 -2
- package/dist-types/ts3.4/pagination/ListSpansPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +64 -0
- package/package.json +5 -5
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
2
|
+
import { AIAgentAssociationConfigurationType, AIAgentType, AIPromptAPIFormat, AIPromptTemplateType, AIPromptType, AssistantCapabilityType, AssistantStatus, AssistantType, AssociationType, ChannelSubtype, ChunkingStrategy, ContentAssociationType, ContentDisposition, ContentStatus, ConversationStatus, ConversationStatusReason, FilterField, FilterOperator, GuardrailContentFilterType, GuardrailContextualGroundingFilterType, GuardrailFilterStrength, GuardrailManagedWordsType, GuardrailPiiEntityType, GuardrailSensitiveInformationAction, GuardrailTopicType, KnowledgeBaseSearchType, KnowledgeBaseStatus, KnowledgeBaseType, MessageFilterType, MessageTemplateAttributeType, MessageType, Origin, ParsingStrategy, Participant, PushMessageAction, QueryConditionComparisonOperator, QueryConditionFieldName, QuickResponseStatus, RecommendationSourceType, RecommendationTriggerType, RecommendationType, ReferenceType, Relevance, RelevanceLevel, SessionDataNamespace, SourceContentType, Status, SyncStatus, TargetType, ToolOverrideInputValueType, ToolType, VisibilityStatus, WebScopeType, WhatsAppSourceConfigurationStatus } from "./enums";
|
|
2
3
|
/**
|
|
3
4
|
* @public
|
|
4
5
|
*/
|
|
@@ -285,6 +286,32 @@ export interface AnswerRecommendationAIAgentConfiguration {
|
|
|
285
286
|
* @public
|
|
286
287
|
*/
|
|
287
288
|
locale?: string | undefined;
|
|
289
|
+
/**
|
|
290
|
+
* <p>The suggested messages configuration for the Answer Recommendation AI Agent.</p>
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
suggestedMessages?: string[] | undefined;
|
|
294
|
+
}
|
|
295
|
+
/**
|
|
296
|
+
* <p>The configuration for AI Agents of type <code>CASE_SUMMARIZATION</code>.</p>
|
|
297
|
+
* @public
|
|
298
|
+
*/
|
|
299
|
+
export interface CaseSummarizationAIAgentConfiguration {
|
|
300
|
+
/**
|
|
301
|
+
* <p>The AI Prompt identifier used by the Case Summarization AI Agent.</p>
|
|
302
|
+
* @public
|
|
303
|
+
*/
|
|
304
|
+
caseSummarizationAIPromptId?: string | undefined;
|
|
305
|
+
/**
|
|
306
|
+
* <p>The AI Guardrail identifier used by the Case Summarization AI Agent.</p>
|
|
307
|
+
* @public
|
|
308
|
+
*/
|
|
309
|
+
caseSummarizationAIGuardrailId?: string | undefined;
|
|
310
|
+
/**
|
|
311
|
+
* <p>The locale setting for the Case Summarization AI Agent.</p>
|
|
312
|
+
* @public
|
|
313
|
+
*/
|
|
314
|
+
locale?: string | undefined;
|
|
288
315
|
}
|
|
289
316
|
/**
|
|
290
317
|
* <p>Configuration settings for the EMAIL_GENERATIVE_ANSWER AI agent including prompts, locale, and knowledge base associations.</p>
|
|
@@ -380,6 +407,264 @@ export interface ManualSearchAIAgentConfiguration {
|
|
|
380
407
|
*/
|
|
381
408
|
locale?: string | undefined;
|
|
382
409
|
}
|
|
410
|
+
/**
|
|
411
|
+
* <p>The configuration for AI Agents of type <code>NOTE_TAKING</code>.</p>
|
|
412
|
+
* @public
|
|
413
|
+
*/
|
|
414
|
+
export interface NoteTakingAIAgentConfiguration {
|
|
415
|
+
/**
|
|
416
|
+
* <p>The AI Prompt identifier used by the Note Taking AI Agent.</p>
|
|
417
|
+
* @public
|
|
418
|
+
*/
|
|
419
|
+
noteTakingAIPromptId?: string | undefined;
|
|
420
|
+
/**
|
|
421
|
+
* <p>The AI Guardrail identifier used by the Note Taking AI Agent.</p>
|
|
422
|
+
* @public
|
|
423
|
+
*/
|
|
424
|
+
noteTakingAIGuardrailId?: string | undefined;
|
|
425
|
+
/**
|
|
426
|
+
* <p>The locale setting for language-specific case summarization generation (for example, en_US, es_ES).</p>
|
|
427
|
+
* @public
|
|
428
|
+
*/
|
|
429
|
+
locale?: string | undefined;
|
|
430
|
+
}
|
|
431
|
+
/**
|
|
432
|
+
* <p>An annotation that provides additional context or metadata.</p>
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
export interface Annotation {
|
|
436
|
+
/**
|
|
437
|
+
* <p>The title of the annotation.</p>
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
title?: string | undefined;
|
|
441
|
+
/**
|
|
442
|
+
* <p>A hint indicating that the annotation contains potentially destructive content.</p>
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
destructiveHint?: boolean | undefined;
|
|
446
|
+
}
|
|
447
|
+
/**
|
|
448
|
+
* <p>Instructions for using a tool.</p>
|
|
449
|
+
* @public
|
|
450
|
+
*/
|
|
451
|
+
export interface ToolInstruction {
|
|
452
|
+
/**
|
|
453
|
+
* <p>The instruction text for the tool.</p>
|
|
454
|
+
* @public
|
|
455
|
+
*/
|
|
456
|
+
instruction?: string | undefined;
|
|
457
|
+
/**
|
|
458
|
+
* <p>Examples for using the tool.</p>
|
|
459
|
+
* @public
|
|
460
|
+
*/
|
|
461
|
+
examples?: string[] | undefined;
|
|
462
|
+
}
|
|
463
|
+
/**
|
|
464
|
+
* <p>Configuration for tool output handling.</p>
|
|
465
|
+
* @public
|
|
466
|
+
*/
|
|
467
|
+
export interface ToolOutputConfiguration {
|
|
468
|
+
/**
|
|
469
|
+
* <p>Override the tool output results to different variable name.</p>
|
|
470
|
+
* @public
|
|
471
|
+
*/
|
|
472
|
+
outputVariableNameOverride?: string | undefined;
|
|
473
|
+
/**
|
|
474
|
+
* <p>The session data namespace for tool output.</p>
|
|
475
|
+
* @public
|
|
476
|
+
*/
|
|
477
|
+
sessionDataNamespace?: string | undefined;
|
|
478
|
+
}
|
|
479
|
+
/**
|
|
480
|
+
* <p>Filter configuration for tool output.</p>
|
|
481
|
+
* @public
|
|
482
|
+
*/
|
|
483
|
+
export interface ToolOutputFilter {
|
|
484
|
+
/**
|
|
485
|
+
* <p>The JSON path for filtering tool output.</p>
|
|
486
|
+
* @public
|
|
487
|
+
*/
|
|
488
|
+
jsonPath: string | undefined;
|
|
489
|
+
/**
|
|
490
|
+
* <p>The output configuration for the filter.</p>
|
|
491
|
+
* @public
|
|
492
|
+
*/
|
|
493
|
+
outputConfiguration?: ToolOutputConfiguration | undefined;
|
|
494
|
+
}
|
|
495
|
+
/**
|
|
496
|
+
* <p>A constant input value for tool override.</p>
|
|
497
|
+
* @public
|
|
498
|
+
*/
|
|
499
|
+
export interface ToolOverrideConstantInputValue {
|
|
500
|
+
/**
|
|
501
|
+
* <p>Override tool input value with constant values</p>
|
|
502
|
+
* @public
|
|
503
|
+
*/
|
|
504
|
+
type: ToolOverrideInputValueType | undefined;
|
|
505
|
+
/**
|
|
506
|
+
* <p>The constant input override value.</p>
|
|
507
|
+
* @public
|
|
508
|
+
*/
|
|
509
|
+
value: string | undefined;
|
|
510
|
+
}
|
|
511
|
+
/**
|
|
512
|
+
* <p>Configuration for overriding tool input values.</p>
|
|
513
|
+
* @public
|
|
514
|
+
*/
|
|
515
|
+
export type ToolOverrideInputValueConfiguration = ToolOverrideInputValueConfiguration.ConstantMember | ToolOverrideInputValueConfiguration.$UnknownMember;
|
|
516
|
+
/**
|
|
517
|
+
* @public
|
|
518
|
+
*/
|
|
519
|
+
export declare namespace ToolOverrideInputValueConfiguration {
|
|
520
|
+
/**
|
|
521
|
+
* <p>Constant input value configuration for tool override.</p>
|
|
522
|
+
* @public
|
|
523
|
+
*/
|
|
524
|
+
interface ConstantMember {
|
|
525
|
+
constant: ToolOverrideConstantInputValue;
|
|
526
|
+
$unknown?: never;
|
|
527
|
+
}
|
|
528
|
+
/**
|
|
529
|
+
* @public
|
|
530
|
+
*/
|
|
531
|
+
interface $UnknownMember {
|
|
532
|
+
constant?: never;
|
|
533
|
+
$unknown: [string, any];
|
|
534
|
+
}
|
|
535
|
+
/**
|
|
536
|
+
* @deprecated unused in schema-serde mode.
|
|
537
|
+
*
|
|
538
|
+
*/
|
|
539
|
+
interface Visitor<T> {
|
|
540
|
+
constant: (value: ToolOverrideConstantInputValue) => T;
|
|
541
|
+
_: (name: string, value: any) => T;
|
|
542
|
+
}
|
|
543
|
+
}
|
|
544
|
+
/**
|
|
545
|
+
* <p>An input value override for tools.</p>
|
|
546
|
+
* @public
|
|
547
|
+
*/
|
|
548
|
+
export interface ToolOverrideInputValue {
|
|
549
|
+
/**
|
|
550
|
+
* <p>The JSON path for the input value override.</p>
|
|
551
|
+
* @public
|
|
552
|
+
*/
|
|
553
|
+
jsonPath: string | undefined;
|
|
554
|
+
/**
|
|
555
|
+
* <p>The override input value.</p>
|
|
556
|
+
* @public
|
|
557
|
+
*/
|
|
558
|
+
value: ToolOverrideInputValueConfiguration | undefined;
|
|
559
|
+
}
|
|
560
|
+
/**
|
|
561
|
+
* <p>Configuration for user interaction settings.</p>
|
|
562
|
+
* @public
|
|
563
|
+
*/
|
|
564
|
+
export interface UserInteractionConfiguration {
|
|
565
|
+
/**
|
|
566
|
+
* <p>Indicates whether user confirmation is required for the interaction.</p>
|
|
567
|
+
* @public
|
|
568
|
+
*/
|
|
569
|
+
isUserConfirmationRequired?: boolean | undefined;
|
|
570
|
+
}
|
|
571
|
+
/**
|
|
572
|
+
* <p>Configuration settings for a tool used by AI Agents.</p>
|
|
573
|
+
* @public
|
|
574
|
+
*/
|
|
575
|
+
export interface ToolConfiguration {
|
|
576
|
+
/**
|
|
577
|
+
* <p>The name of the tool.</p>
|
|
578
|
+
* @public
|
|
579
|
+
*/
|
|
580
|
+
toolName: string | undefined;
|
|
581
|
+
/**
|
|
582
|
+
* <p>The type of the tool.</p>
|
|
583
|
+
* @public
|
|
584
|
+
*/
|
|
585
|
+
toolType: ToolType | undefined;
|
|
586
|
+
/**
|
|
587
|
+
* <p>The title of the tool configuration.</p>
|
|
588
|
+
* @public
|
|
589
|
+
*/
|
|
590
|
+
title?: string | undefined;
|
|
591
|
+
/**
|
|
592
|
+
* <p>The identifier of the tool, for example toolName from Model Context Provider server.</p>
|
|
593
|
+
* @public
|
|
594
|
+
*/
|
|
595
|
+
toolId?: string | undefined;
|
|
596
|
+
/**
|
|
597
|
+
* <p>The description of the tool configuration.</p>
|
|
598
|
+
* @public
|
|
599
|
+
*/
|
|
600
|
+
description?: string | undefined;
|
|
601
|
+
/**
|
|
602
|
+
* <p>Instructions for using the tool.</p>
|
|
603
|
+
* @public
|
|
604
|
+
*/
|
|
605
|
+
instruction?: ToolInstruction | undefined;
|
|
606
|
+
/**
|
|
607
|
+
* <p>Override input values for the tool configuration.</p>
|
|
608
|
+
* @public
|
|
609
|
+
*/
|
|
610
|
+
overrideInputValues?: ToolOverrideInputValue[] | undefined;
|
|
611
|
+
/**
|
|
612
|
+
* <p>Output filters applies to the tool result.</p>
|
|
613
|
+
* @public
|
|
614
|
+
*/
|
|
615
|
+
outputFilters?: ToolOutputFilter[] | undefined;
|
|
616
|
+
/**
|
|
617
|
+
* <p>The input schema for the tool configuration.</p>
|
|
618
|
+
* @public
|
|
619
|
+
*/
|
|
620
|
+
inputSchema?: __DocumentType | undefined;
|
|
621
|
+
/**
|
|
622
|
+
* <p>The output schema for the tool configuration.</p>
|
|
623
|
+
* @public
|
|
624
|
+
*/
|
|
625
|
+
outputSchema?: __DocumentType | undefined;
|
|
626
|
+
/**
|
|
627
|
+
* <p>Annotations for the tool configuration.</p>
|
|
628
|
+
* @public
|
|
629
|
+
*/
|
|
630
|
+
annotations?: Annotation | undefined;
|
|
631
|
+
/**
|
|
632
|
+
* <p>Configuration for user interaction with the tool.</p>
|
|
633
|
+
* @public
|
|
634
|
+
*/
|
|
635
|
+
userInteractionConfiguration?: UserInteractionConfiguration | undefined;
|
|
636
|
+
}
|
|
637
|
+
/**
|
|
638
|
+
* <p>The configuration for AI Agents of type <code>ORCHESTRATION</code>.</p>
|
|
639
|
+
* @public
|
|
640
|
+
*/
|
|
641
|
+
export interface OrchestrationAIAgentConfiguration {
|
|
642
|
+
/**
|
|
643
|
+
* <p>The AI Prompt identifier used by the Orchestration AI Agent.</p>
|
|
644
|
+
* @public
|
|
645
|
+
*/
|
|
646
|
+
orchestrationAIPromptId: string | undefined;
|
|
647
|
+
/**
|
|
648
|
+
* <p>The AI Guardrail identifier used by the Orchestration AI Agent.</p>
|
|
649
|
+
* @public
|
|
650
|
+
*/
|
|
651
|
+
orchestrationAIGuardrailId?: string | undefined;
|
|
652
|
+
/**
|
|
653
|
+
* <p>The tool configurations used by the Orchestration AI Agent.</p>
|
|
654
|
+
* @public
|
|
655
|
+
*/
|
|
656
|
+
toolConfigurations?: ToolConfiguration[] | undefined;
|
|
657
|
+
/**
|
|
658
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Connect instance used by the Orchestration AI Agent.</p>
|
|
659
|
+
* @public
|
|
660
|
+
*/
|
|
661
|
+
connectInstanceArn?: string | undefined;
|
|
662
|
+
/**
|
|
663
|
+
* <p>The locale setting for the Orchestration AI Agent.</p>
|
|
664
|
+
* @public
|
|
665
|
+
*/
|
|
666
|
+
locale?: string | undefined;
|
|
667
|
+
}
|
|
383
668
|
/**
|
|
384
669
|
* <p>The configuration for AI Agents of type SELF_SERVICE.</p>
|
|
385
670
|
* @public
|
|
@@ -410,7 +695,7 @@ export interface SelfServiceAIAgentConfiguration {
|
|
|
410
695
|
* <p>A typed union that specifies the configuration based on the type of AI Agent.</p>
|
|
411
696
|
* @public
|
|
412
697
|
*/
|
|
413
|
-
export type AIAgentConfiguration = AIAgentConfiguration.AnswerRecommendationAIAgentConfigurationMember | AIAgentConfiguration.EmailGenerativeAnswerAIAgentConfigurationMember | AIAgentConfiguration.EmailOverviewAIAgentConfigurationMember | AIAgentConfiguration.EmailResponseAIAgentConfigurationMember | AIAgentConfiguration.ManualSearchAIAgentConfigurationMember | AIAgentConfiguration.SelfServiceAIAgentConfigurationMember | AIAgentConfiguration.$UnknownMember;
|
|
698
|
+
export type AIAgentConfiguration = AIAgentConfiguration.AnswerRecommendationAIAgentConfigurationMember | AIAgentConfiguration.CaseSummarizationAIAgentConfigurationMember | AIAgentConfiguration.EmailGenerativeAnswerAIAgentConfigurationMember | AIAgentConfiguration.EmailOverviewAIAgentConfigurationMember | AIAgentConfiguration.EmailResponseAIAgentConfigurationMember | AIAgentConfiguration.ManualSearchAIAgentConfigurationMember | AIAgentConfiguration.NoteTakingAIAgentConfigurationMember | AIAgentConfiguration.OrchestrationAIAgentConfigurationMember | AIAgentConfiguration.SelfServiceAIAgentConfigurationMember | AIAgentConfiguration.$UnknownMember;
|
|
414
699
|
/**
|
|
415
700
|
* @public
|
|
416
701
|
*/
|
|
@@ -426,6 +711,9 @@ export declare namespace AIAgentConfiguration {
|
|
|
426
711
|
emailResponseAIAgentConfiguration?: never;
|
|
427
712
|
emailOverviewAIAgentConfiguration?: never;
|
|
428
713
|
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
714
|
+
orchestrationAIAgentConfiguration?: never;
|
|
715
|
+
noteTakingAIAgentConfiguration?: never;
|
|
716
|
+
caseSummarizationAIAgentConfiguration?: never;
|
|
429
717
|
$unknown?: never;
|
|
430
718
|
}
|
|
431
719
|
/**
|
|
@@ -439,6 +727,9 @@ export declare namespace AIAgentConfiguration {
|
|
|
439
727
|
emailResponseAIAgentConfiguration?: never;
|
|
440
728
|
emailOverviewAIAgentConfiguration?: never;
|
|
441
729
|
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
730
|
+
orchestrationAIAgentConfiguration?: never;
|
|
731
|
+
noteTakingAIAgentConfiguration?: never;
|
|
732
|
+
caseSummarizationAIAgentConfiguration?: never;
|
|
442
733
|
$unknown?: never;
|
|
443
734
|
}
|
|
444
735
|
/**
|
|
@@ -452,6 +743,9 @@ export declare namespace AIAgentConfiguration {
|
|
|
452
743
|
emailResponseAIAgentConfiguration?: never;
|
|
453
744
|
emailOverviewAIAgentConfiguration?: never;
|
|
454
745
|
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
746
|
+
orchestrationAIAgentConfiguration?: never;
|
|
747
|
+
noteTakingAIAgentConfiguration?: never;
|
|
748
|
+
caseSummarizationAIAgentConfiguration?: never;
|
|
455
749
|
$unknown?: never;
|
|
456
750
|
}
|
|
457
751
|
/**
|
|
@@ -465,6 +759,9 @@ export declare namespace AIAgentConfiguration {
|
|
|
465
759
|
emailResponseAIAgentConfiguration: EmailResponseAIAgentConfiguration;
|
|
466
760
|
emailOverviewAIAgentConfiguration?: never;
|
|
467
761
|
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
762
|
+
orchestrationAIAgentConfiguration?: never;
|
|
763
|
+
noteTakingAIAgentConfiguration?: never;
|
|
764
|
+
caseSummarizationAIAgentConfiguration?: never;
|
|
468
765
|
$unknown?: never;
|
|
469
766
|
}
|
|
470
767
|
/**
|
|
@@ -478,6 +775,9 @@ export declare namespace AIAgentConfiguration {
|
|
|
478
775
|
emailResponseAIAgentConfiguration?: never;
|
|
479
776
|
emailOverviewAIAgentConfiguration: EmailOverviewAIAgentConfiguration;
|
|
480
777
|
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
778
|
+
orchestrationAIAgentConfiguration?: never;
|
|
779
|
+
noteTakingAIAgentConfiguration?: never;
|
|
780
|
+
caseSummarizationAIAgentConfiguration?: never;
|
|
481
781
|
$unknown?: never;
|
|
482
782
|
}
|
|
483
783
|
/**
|
|
@@ -491,6 +791,57 @@ export declare namespace AIAgentConfiguration {
|
|
|
491
791
|
emailResponseAIAgentConfiguration?: never;
|
|
492
792
|
emailOverviewAIAgentConfiguration?: never;
|
|
493
793
|
emailGenerativeAnswerAIAgentConfiguration: EmailGenerativeAnswerAIAgentConfiguration;
|
|
794
|
+
orchestrationAIAgentConfiguration?: never;
|
|
795
|
+
noteTakingAIAgentConfiguration?: never;
|
|
796
|
+
caseSummarizationAIAgentConfiguration?: never;
|
|
797
|
+
$unknown?: never;
|
|
798
|
+
}
|
|
799
|
+
/**
|
|
800
|
+
* <p>The configuration for AI Agents of type <code>ORCHESTRATION</code>.</p>
|
|
801
|
+
* @public
|
|
802
|
+
*/
|
|
803
|
+
interface OrchestrationAIAgentConfigurationMember {
|
|
804
|
+
manualSearchAIAgentConfiguration?: never;
|
|
805
|
+
answerRecommendationAIAgentConfiguration?: never;
|
|
806
|
+
selfServiceAIAgentConfiguration?: never;
|
|
807
|
+
emailResponseAIAgentConfiguration?: never;
|
|
808
|
+
emailOverviewAIAgentConfiguration?: never;
|
|
809
|
+
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
810
|
+
orchestrationAIAgentConfiguration: OrchestrationAIAgentConfiguration;
|
|
811
|
+
noteTakingAIAgentConfiguration?: never;
|
|
812
|
+
caseSummarizationAIAgentConfiguration?: never;
|
|
813
|
+
$unknown?: never;
|
|
814
|
+
}
|
|
815
|
+
/**
|
|
816
|
+
* <p>The configuration for AI Agents of type <code>NOTE_TAKING</code>.</p>
|
|
817
|
+
* @public
|
|
818
|
+
*/
|
|
819
|
+
interface NoteTakingAIAgentConfigurationMember {
|
|
820
|
+
manualSearchAIAgentConfiguration?: never;
|
|
821
|
+
answerRecommendationAIAgentConfiguration?: never;
|
|
822
|
+
selfServiceAIAgentConfiguration?: never;
|
|
823
|
+
emailResponseAIAgentConfiguration?: never;
|
|
824
|
+
emailOverviewAIAgentConfiguration?: never;
|
|
825
|
+
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
826
|
+
orchestrationAIAgentConfiguration?: never;
|
|
827
|
+
noteTakingAIAgentConfiguration: NoteTakingAIAgentConfiguration;
|
|
828
|
+
caseSummarizationAIAgentConfiguration?: never;
|
|
829
|
+
$unknown?: never;
|
|
830
|
+
}
|
|
831
|
+
/**
|
|
832
|
+
* <p>The configuration for AI Agents of type <code>CASE_SUMMARIZATION</code>.</p>
|
|
833
|
+
* @public
|
|
834
|
+
*/
|
|
835
|
+
interface CaseSummarizationAIAgentConfigurationMember {
|
|
836
|
+
manualSearchAIAgentConfiguration?: never;
|
|
837
|
+
answerRecommendationAIAgentConfiguration?: never;
|
|
838
|
+
selfServiceAIAgentConfiguration?: never;
|
|
839
|
+
emailResponseAIAgentConfiguration?: never;
|
|
840
|
+
emailOverviewAIAgentConfiguration?: never;
|
|
841
|
+
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
842
|
+
orchestrationAIAgentConfiguration?: never;
|
|
843
|
+
noteTakingAIAgentConfiguration?: never;
|
|
844
|
+
caseSummarizationAIAgentConfiguration: CaseSummarizationAIAgentConfiguration;
|
|
494
845
|
$unknown?: never;
|
|
495
846
|
}
|
|
496
847
|
/**
|
|
@@ -503,6 +854,9 @@ export declare namespace AIAgentConfiguration {
|
|
|
503
854
|
emailResponseAIAgentConfiguration?: never;
|
|
504
855
|
emailOverviewAIAgentConfiguration?: never;
|
|
505
856
|
emailGenerativeAnswerAIAgentConfiguration?: never;
|
|
857
|
+
orchestrationAIAgentConfiguration?: never;
|
|
858
|
+
noteTakingAIAgentConfiguration?: never;
|
|
859
|
+
caseSummarizationAIAgentConfiguration?: never;
|
|
506
860
|
$unknown: [string, any];
|
|
507
861
|
}
|
|
508
862
|
/**
|
|
@@ -516,6 +870,9 @@ export declare namespace AIAgentConfiguration {
|
|
|
516
870
|
emailResponseAIAgentConfiguration: (value: EmailResponseAIAgentConfiguration) => T;
|
|
517
871
|
emailOverviewAIAgentConfiguration: (value: EmailOverviewAIAgentConfiguration) => T;
|
|
518
872
|
emailGenerativeAnswerAIAgentConfiguration: (value: EmailGenerativeAnswerAIAgentConfiguration) => T;
|
|
873
|
+
orchestrationAIAgentConfiguration: (value: OrchestrationAIAgentConfiguration) => T;
|
|
874
|
+
noteTakingAIAgentConfiguration: (value: NoteTakingAIAgentConfiguration) => T;
|
|
875
|
+
caseSummarizationAIAgentConfiguration: (value: CaseSummarizationAIAgentConfiguration) => T;
|
|
519
876
|
_: (name: string, value: any) => T;
|
|
520
877
|
}
|
|
521
878
|
}
|
|
@@ -1689,38 +2046,64 @@ export interface UpdateAIGuardrailResponse {
|
|
|
1689
2046
|
aiGuardrail?: AIGuardrailData | undefined;
|
|
1690
2047
|
}
|
|
1691
2048
|
/**
|
|
1692
|
-
* <p>The
|
|
2049
|
+
* <p>The assessment information from the AI Guardrail.</p>
|
|
1693
2050
|
* @public
|
|
1694
2051
|
*/
|
|
1695
|
-
export interface
|
|
2052
|
+
export interface AIGuardrailAssessment {
|
|
1696
2053
|
/**
|
|
1697
|
-
* <p>
|
|
2054
|
+
* <p>Indicates whether the AI Guardrail blocked the content.</p>
|
|
1698
2055
|
* @public
|
|
1699
2056
|
*/
|
|
1700
|
-
|
|
2057
|
+
blocked: boolean | undefined;
|
|
1701
2058
|
}
|
|
1702
2059
|
/**
|
|
1703
|
-
* <p>
|
|
2060
|
+
* <p>Inference configuration for text-based AI Prompts.</p>
|
|
1704
2061
|
* @public
|
|
1705
2062
|
*/
|
|
1706
|
-
export
|
|
2063
|
+
export interface TextAIPromptInferenceConfiguration {
|
|
2064
|
+
/**
|
|
2065
|
+
* <p>The temperature setting for controlling randomness in the generated response.</p>
|
|
2066
|
+
* @public
|
|
2067
|
+
*/
|
|
2068
|
+
temperature?: number | undefined;
|
|
2069
|
+
/**
|
|
2070
|
+
* <p>The top-P sampling parameter for nucleus sampling.</p>
|
|
2071
|
+
* @public
|
|
2072
|
+
*/
|
|
2073
|
+
topP?: number | undefined;
|
|
2074
|
+
/**
|
|
2075
|
+
* <p>The top-K sampling parameter for token selection.</p>
|
|
2076
|
+
* @public
|
|
2077
|
+
*/
|
|
2078
|
+
topK?: number | undefined;
|
|
2079
|
+
/**
|
|
2080
|
+
* <p>The maximum number of tokens to generate in the response.</p>
|
|
2081
|
+
* @public
|
|
2082
|
+
*/
|
|
2083
|
+
maxTokensToSample?: number | undefined;
|
|
2084
|
+
}
|
|
1707
2085
|
/**
|
|
2086
|
+
* <p>The configuration for inference parameters when using AI Prompts.</p>
|
|
1708
2087
|
* @public
|
|
1709
2088
|
*/
|
|
1710
|
-
export
|
|
2089
|
+
export type AIPromptInferenceConfiguration = AIPromptInferenceConfiguration.TextAIPromptInferenceConfigurationMember | AIPromptInferenceConfiguration.$UnknownMember;
|
|
2090
|
+
/**
|
|
2091
|
+
* @public
|
|
2092
|
+
*/
|
|
2093
|
+
export declare namespace AIPromptInferenceConfiguration {
|
|
1711
2094
|
/**
|
|
1712
|
-
* <p>The configuration for
|
|
2095
|
+
* <p>The inference configuration for text-based AI Prompts.</p>
|
|
1713
2096
|
* @public
|
|
1714
2097
|
*/
|
|
1715
|
-
interface
|
|
1716
|
-
|
|
2098
|
+
interface TextAIPromptInferenceConfigurationMember {
|
|
2099
|
+
textAIPromptInferenceConfiguration: TextAIPromptInferenceConfiguration;
|
|
1717
2100
|
$unknown?: never;
|
|
1718
2101
|
}
|
|
1719
2102
|
/**
|
|
1720
2103
|
* @public
|
|
1721
2104
|
*/
|
|
1722
2105
|
interface $UnknownMember {
|
|
1723
|
-
|
|
2106
|
+
textAIPromptInferenceConfiguration?: never;
|
|
1724
2107
|
$unknown: [string, any];
|
|
1725
2108
|
}
|
|
1726
2109
|
/**
|
|
@@ -1728,20 +2111,64 @@ export declare namespace AIPromptTemplateConfiguration {
|
|
|
1728
2111
|
*
|
|
1729
2112
|
*/
|
|
1730
2113
|
interface Visitor<T> {
|
|
1731
|
-
|
|
2114
|
+
textAIPromptInferenceConfiguration: (value: TextAIPromptInferenceConfiguration) => T;
|
|
1732
2115
|
_: (name: string, value: any) => T;
|
|
1733
2116
|
}
|
|
1734
2117
|
}
|
|
1735
2118
|
/**
|
|
2119
|
+
* <p>The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.</p>
|
|
1736
2120
|
* @public
|
|
1737
2121
|
*/
|
|
1738
|
-
export interface
|
|
2122
|
+
export interface TextFullAIPromptEditTemplateConfiguration {
|
|
1739
2123
|
/**
|
|
1740
|
-
* <p>
|
|
2124
|
+
* <p>The YAML text for the AI Prompt template.</p>
|
|
1741
2125
|
* @public
|
|
1742
2126
|
*/
|
|
1743
|
-
|
|
1744
|
-
|
|
2127
|
+
text: string | undefined;
|
|
2128
|
+
}
|
|
2129
|
+
/**
|
|
2130
|
+
* <p>A typed union that specifies the configuration for a prompt template based on its type.</p>
|
|
2131
|
+
* @public
|
|
2132
|
+
*/
|
|
2133
|
+
export type AIPromptTemplateConfiguration = AIPromptTemplateConfiguration.TextFullAIPromptEditTemplateConfigurationMember | AIPromptTemplateConfiguration.$UnknownMember;
|
|
2134
|
+
/**
|
|
2135
|
+
* @public
|
|
2136
|
+
*/
|
|
2137
|
+
export declare namespace AIPromptTemplateConfiguration {
|
|
2138
|
+
/**
|
|
2139
|
+
* <p>The configuration for a prompt template that supports full textual prompt configuration using a YAML prompt.</p>
|
|
2140
|
+
* @public
|
|
2141
|
+
*/
|
|
2142
|
+
interface TextFullAIPromptEditTemplateConfigurationMember {
|
|
2143
|
+
textFullAIPromptEditTemplateConfiguration: TextFullAIPromptEditTemplateConfiguration;
|
|
2144
|
+
$unknown?: never;
|
|
2145
|
+
}
|
|
2146
|
+
/**
|
|
2147
|
+
* @public
|
|
2148
|
+
*/
|
|
2149
|
+
interface $UnknownMember {
|
|
2150
|
+
textFullAIPromptEditTemplateConfiguration?: never;
|
|
2151
|
+
$unknown: [string, any];
|
|
2152
|
+
}
|
|
2153
|
+
/**
|
|
2154
|
+
* @deprecated unused in schema-serde mode.
|
|
2155
|
+
*
|
|
2156
|
+
*/
|
|
2157
|
+
interface Visitor<T> {
|
|
2158
|
+
textFullAIPromptEditTemplateConfiguration: (value: TextFullAIPromptEditTemplateConfiguration) => T;
|
|
2159
|
+
_: (name: string, value: any) => T;
|
|
2160
|
+
}
|
|
2161
|
+
}
|
|
2162
|
+
/**
|
|
2163
|
+
* @public
|
|
2164
|
+
*/
|
|
2165
|
+
export interface CreateAIPromptRequest {
|
|
2166
|
+
/**
|
|
2167
|
+
* <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>
|
|
2168
|
+
* @public
|
|
2169
|
+
*/
|
|
2170
|
+
clientToken?: string | undefined;
|
|
2171
|
+
/**
|
|
1745
2172
|
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1746
2173
|
* @public
|
|
1747
2174
|
*/
|
|
@@ -1791,6 +2218,11 @@ export interface CreateAIPromptRequest {
|
|
|
1791
2218
|
* @public
|
|
1792
2219
|
*/
|
|
1793
2220
|
description?: string | undefined;
|
|
2221
|
+
/**
|
|
2222
|
+
* <p>The inference configuration for the AI Prompt being created.</p>
|
|
2223
|
+
* @public
|
|
2224
|
+
*/
|
|
2225
|
+
inferenceConfiguration?: AIPromptInferenceConfiguration | undefined;
|
|
1794
2226
|
}
|
|
1795
2227
|
/**
|
|
1796
2228
|
* <p>The data for the AI Prompt</p>
|
|
@@ -1847,6 +2279,11 @@ export interface AIPromptData {
|
|
|
1847
2279
|
* @public
|
|
1848
2280
|
*/
|
|
1849
2281
|
templateConfiguration: AIPromptTemplateConfiguration | undefined;
|
|
2282
|
+
/**
|
|
2283
|
+
* <p>The configuration for inference parameters when using the AI Prompt.</p>
|
|
2284
|
+
* @public
|
|
2285
|
+
*/
|
|
2286
|
+
inferenceConfiguration?: AIPromptInferenceConfiguration | undefined;
|
|
1850
2287
|
/**
|
|
1851
2288
|
* <p>The time the AI Prompt was last modified.</p>
|
|
1852
2289
|
* @public
|
|
@@ -2224,6 +2661,11 @@ export interface UpdateAIPromptRequest {
|
|
|
2224
2661
|
* @public
|
|
2225
2662
|
*/
|
|
2226
2663
|
modelId?: string | undefined;
|
|
2664
|
+
/**
|
|
2665
|
+
* <p>The updated inference configuration for the AI Prompt.</p>
|
|
2666
|
+
* @public
|
|
2667
|
+
*/
|
|
2668
|
+
inferenceConfiguration?: AIPromptInferenceConfiguration | undefined;
|
|
2227
2669
|
}
|
|
2228
2670
|
/**
|
|
2229
2671
|
* @public
|
|
@@ -2262,11 +2704,27 @@ export interface AppIntegrationsConfiguration {
|
|
|
2262
2704
|
*/
|
|
2263
2705
|
objectFields?: string[] | undefined;
|
|
2264
2706
|
}
|
|
2707
|
+
/**
|
|
2708
|
+
* <p>Configuration for an external Bedrock knowledge base.</p>
|
|
2709
|
+
* @public
|
|
2710
|
+
*/
|
|
2711
|
+
export interface ExternalBedrockKnowledgeBaseConfig {
|
|
2712
|
+
/**
|
|
2713
|
+
* <p>The Amazon Resource Name (ARN) of the external Bedrock knowledge base.</p>
|
|
2714
|
+
* @public
|
|
2715
|
+
*/
|
|
2716
|
+
bedrockKnowledgeBaseArn: string | undefined;
|
|
2717
|
+
/**
|
|
2718
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role used to access the external Bedrock knowledge base.</p>
|
|
2719
|
+
* @public
|
|
2720
|
+
*/
|
|
2721
|
+
accessRoleArn: string | undefined;
|
|
2722
|
+
}
|
|
2265
2723
|
/**
|
|
2266
2724
|
* <p>The data that is input into Amazon Q in Connect as a result of the assistant association.</p>
|
|
2267
2725
|
* @public
|
|
2268
2726
|
*/
|
|
2269
|
-
export type AssistantAssociationInputData = AssistantAssociationInputData.KnowledgeBaseIdMember | AssistantAssociationInputData.$UnknownMember;
|
|
2727
|
+
export type AssistantAssociationInputData = AssistantAssociationInputData.ExternalBedrockKnowledgeBaseConfigMember | AssistantAssociationInputData.KnowledgeBaseIdMember | AssistantAssociationInputData.$UnknownMember;
|
|
2270
2728
|
/**
|
|
2271
2729
|
* @public
|
|
2272
2730
|
*/
|
|
@@ -2277,6 +2735,16 @@ export declare namespace AssistantAssociationInputData {
|
|
|
2277
2735
|
*/
|
|
2278
2736
|
interface KnowledgeBaseIdMember {
|
|
2279
2737
|
knowledgeBaseId: string;
|
|
2738
|
+
externalBedrockKnowledgeBaseConfig?: never;
|
|
2739
|
+
$unknown?: never;
|
|
2740
|
+
}
|
|
2741
|
+
/**
|
|
2742
|
+
* <p>The configuration for an external Bedrock knowledge base association.</p>
|
|
2743
|
+
* @public
|
|
2744
|
+
*/
|
|
2745
|
+
interface ExternalBedrockKnowledgeBaseConfigMember {
|
|
2746
|
+
knowledgeBaseId?: never;
|
|
2747
|
+
externalBedrockKnowledgeBaseConfig: ExternalBedrockKnowledgeBaseConfig;
|
|
2280
2748
|
$unknown?: never;
|
|
2281
2749
|
}
|
|
2282
2750
|
/**
|
|
@@ -2284,6 +2752,7 @@ export declare namespace AssistantAssociationInputData {
|
|
|
2284
2752
|
*/
|
|
2285
2753
|
interface $UnknownMember {
|
|
2286
2754
|
knowledgeBaseId?: never;
|
|
2755
|
+
externalBedrockKnowledgeBaseConfig?: never;
|
|
2287
2756
|
$unknown: [string, any];
|
|
2288
2757
|
}
|
|
2289
2758
|
/**
|
|
@@ -2292,6 +2761,7 @@ export declare namespace AssistantAssociationInputData {
|
|
|
2292
2761
|
*/
|
|
2293
2762
|
interface Visitor<T> {
|
|
2294
2763
|
knowledgeBaseId: (value: string) => T;
|
|
2764
|
+
externalBedrockKnowledgeBaseConfig: (value: ExternalBedrockKnowledgeBaseConfig) => T;
|
|
2295
2765
|
_: (name: string, value: any) => T;
|
|
2296
2766
|
}
|
|
2297
2767
|
}
|
|
@@ -2345,7 +2815,7 @@ export interface KnowledgeBaseAssociationData {
|
|
|
2345
2815
|
* <p>The data that is output as a result of the assistant association.</p>
|
|
2346
2816
|
* @public
|
|
2347
2817
|
*/
|
|
2348
|
-
export type AssistantAssociationOutputData = AssistantAssociationOutputData.KnowledgeBaseAssociationMember | AssistantAssociationOutputData.$UnknownMember;
|
|
2818
|
+
export type AssistantAssociationOutputData = AssistantAssociationOutputData.ExternalBedrockKnowledgeBaseConfigMember | AssistantAssociationOutputData.KnowledgeBaseAssociationMember | AssistantAssociationOutputData.$UnknownMember;
|
|
2349
2819
|
/**
|
|
2350
2820
|
* @public
|
|
2351
2821
|
*/
|
|
@@ -2356,6 +2826,16 @@ export declare namespace AssistantAssociationOutputData {
|
|
|
2356
2826
|
*/
|
|
2357
2827
|
interface KnowledgeBaseAssociationMember {
|
|
2358
2828
|
knowledgeBaseAssociation: KnowledgeBaseAssociationData;
|
|
2829
|
+
externalBedrockKnowledgeBaseConfig?: never;
|
|
2830
|
+
$unknown?: never;
|
|
2831
|
+
}
|
|
2832
|
+
/**
|
|
2833
|
+
* <p>The configuration for an external Bedrock knowledge base association in the output data.</p>
|
|
2834
|
+
* @public
|
|
2835
|
+
*/
|
|
2836
|
+
interface ExternalBedrockKnowledgeBaseConfigMember {
|
|
2837
|
+
knowledgeBaseAssociation?: never;
|
|
2838
|
+
externalBedrockKnowledgeBaseConfig: ExternalBedrockKnowledgeBaseConfig;
|
|
2359
2839
|
$unknown?: never;
|
|
2360
2840
|
}
|
|
2361
2841
|
/**
|
|
@@ -2363,6 +2843,7 @@ export declare namespace AssistantAssociationOutputData {
|
|
|
2363
2843
|
*/
|
|
2364
2844
|
interface $UnknownMember {
|
|
2365
2845
|
knowledgeBaseAssociation?: never;
|
|
2846
|
+
externalBedrockKnowledgeBaseConfig?: never;
|
|
2366
2847
|
$unknown: [string, any];
|
|
2367
2848
|
}
|
|
2368
2849
|
/**
|
|
@@ -2371,6 +2852,7 @@ export declare namespace AssistantAssociationOutputData {
|
|
|
2371
2852
|
*/
|
|
2372
2853
|
interface Visitor<T> {
|
|
2373
2854
|
knowledgeBaseAssociation: (value: KnowledgeBaseAssociationData) => T;
|
|
2855
|
+
externalBedrockKnowledgeBaseConfig: (value: ExternalBedrockKnowledgeBaseConfig) => T;
|
|
2374
2856
|
_: (name: string, value: any) => T;
|
|
2375
2857
|
}
|
|
2376
2858
|
}
|
|
@@ -2614,6 +3096,22 @@ export interface AssistantIntegrationConfiguration {
|
|
|
2614
3096
|
*/
|
|
2615
3097
|
topicIntegrationArn?: string | undefined;
|
|
2616
3098
|
}
|
|
3099
|
+
/**
|
|
3100
|
+
* <p>An entry in the orchestrator configuration list.</p>
|
|
3101
|
+
* @public
|
|
3102
|
+
*/
|
|
3103
|
+
export interface OrchestratorConfigurationEntry {
|
|
3104
|
+
/**
|
|
3105
|
+
* <p>The identifier of the AI Agent in the orchestrator configuration.</p>
|
|
3106
|
+
* @public
|
|
3107
|
+
*/
|
|
3108
|
+
aiAgentId?: string | undefined;
|
|
3109
|
+
/**
|
|
3110
|
+
* <p>The use case for the orchestrator configuration. (for example Connect.SelfService, Connect.AgentAssistance)</p>
|
|
3111
|
+
* @public
|
|
3112
|
+
*/
|
|
3113
|
+
orchestratorUseCase: string | undefined;
|
|
3114
|
+
}
|
|
2617
3115
|
/**
|
|
2618
3116
|
* <p>The assistant data.</p>
|
|
2619
3117
|
* @public
|
|
@@ -2674,6 +3172,11 @@ export interface AssistantData {
|
|
|
2674
3172
|
* @public
|
|
2675
3173
|
*/
|
|
2676
3174
|
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
|
|
3175
|
+
/**
|
|
3176
|
+
* <p>The list of orchestrator configurations for the assistant.</p>
|
|
3177
|
+
* @public
|
|
3178
|
+
*/
|
|
3179
|
+
orchestratorConfigurationList?: OrchestratorConfigurationEntry[] | undefined;
|
|
2677
3180
|
}
|
|
2678
3181
|
/**
|
|
2679
3182
|
* @public
|
|
@@ -2749,6 +3252,27 @@ export interface GetRecommendationsRequest {
|
|
|
2749
3252
|
* @public
|
|
2750
3253
|
*/
|
|
2751
3254
|
nextChunkToken?: string | undefined;
|
|
3255
|
+
/**
|
|
3256
|
+
* <p>The type of recommendation being requested.</p>
|
|
3257
|
+
* @public
|
|
3258
|
+
*/
|
|
3259
|
+
recommendationType?: RecommendationType | undefined;
|
|
3260
|
+
}
|
|
3261
|
+
/**
|
|
3262
|
+
* <p>Details about case summarization chunk data.</p>
|
|
3263
|
+
* @public
|
|
3264
|
+
*/
|
|
3265
|
+
export interface CaseSummarizationChunkDataDetails {
|
|
3266
|
+
/**
|
|
3267
|
+
* <p>A chunk of the case summarization completion.</p>
|
|
3268
|
+
* @public
|
|
3269
|
+
*/
|
|
3270
|
+
completion?: string | undefined;
|
|
3271
|
+
/**
|
|
3272
|
+
* <p>Token for retrieving the next chunk of streaming summarization data, if available.</p>
|
|
3273
|
+
* @public
|
|
3274
|
+
*/
|
|
3275
|
+
nextChunkToken?: string | undefined;
|
|
2752
3276
|
}
|
|
2753
3277
|
/**
|
|
2754
3278
|
* <p>Details about the source content ranking data.</p>
|
|
@@ -2877,6 +3401,38 @@ export interface IntentDetectedDataDetails {
|
|
|
2877
3401
|
* @public
|
|
2878
3402
|
*/
|
|
2879
3403
|
intentId: string | undefined;
|
|
3404
|
+
/**
|
|
3405
|
+
* <p>The relevance level of the detected intent.</p>
|
|
3406
|
+
* @public
|
|
3407
|
+
*/
|
|
3408
|
+
relevanceLevel?: RelevanceLevel | undefined;
|
|
3409
|
+
}
|
|
3410
|
+
/**
|
|
3411
|
+
* <p>Details about notes chunk data.</p>
|
|
3412
|
+
* @public
|
|
3413
|
+
*/
|
|
3414
|
+
export interface NotesChunkDataDetails {
|
|
3415
|
+
/**
|
|
3416
|
+
* <p>A chunk of the notes completion.</p>
|
|
3417
|
+
* @public
|
|
3418
|
+
*/
|
|
3419
|
+
completion?: string | undefined;
|
|
3420
|
+
/**
|
|
3421
|
+
* <p>The token for the next chunk of notes data.</p>
|
|
3422
|
+
* @public
|
|
3423
|
+
*/
|
|
3424
|
+
nextChunkToken?: string | undefined;
|
|
3425
|
+
}
|
|
3426
|
+
/**
|
|
3427
|
+
* <p>Details about notes data.</p>
|
|
3428
|
+
* @public
|
|
3429
|
+
*/
|
|
3430
|
+
export interface NotesDataDetails {
|
|
3431
|
+
/**
|
|
3432
|
+
* <p>The completion data for notes.</p>
|
|
3433
|
+
* @public
|
|
3434
|
+
*/
|
|
3435
|
+
completion?: string | undefined;
|
|
2880
3436
|
}
|
|
2881
3437
|
/**
|
|
2882
3438
|
* <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
|
|
@@ -2925,6 +3481,17 @@ export interface SourceContentDataDetails {
|
|
|
2925
3481
|
*/
|
|
2926
3482
|
citationSpan?: CitationSpan | undefined;
|
|
2927
3483
|
}
|
|
3484
|
+
/**
|
|
3485
|
+
* <p>Details about suggested message data.</p>
|
|
3486
|
+
* @public
|
|
3487
|
+
*/
|
|
3488
|
+
export interface SuggestedMessageDataDetails {
|
|
3489
|
+
/**
|
|
3490
|
+
* <p>The text content of the suggested message.</p>
|
|
3491
|
+
* @public
|
|
3492
|
+
*/
|
|
3493
|
+
messageText: string | undefined;
|
|
3494
|
+
}
|
|
2928
3495
|
/**
|
|
2929
3496
|
* <p>Reference information about the content.</p>
|
|
2930
3497
|
* @public
|
|
@@ -2977,11 +3544,27 @@ export interface GenerativeReference {
|
|
|
2977
3544
|
*/
|
|
2978
3545
|
generationId?: string | undefined;
|
|
2979
3546
|
}
|
|
3547
|
+
/**
|
|
3548
|
+
* <p>Reference information for a suggested message.</p>
|
|
3549
|
+
* @public
|
|
3550
|
+
*/
|
|
3551
|
+
export interface SuggestedMessageReference {
|
|
3552
|
+
/**
|
|
3553
|
+
* <p>The identifier of the AI Agent that generated the suggested message.</p>
|
|
3554
|
+
* @public
|
|
3555
|
+
*/
|
|
3556
|
+
aiAgentId: string | undefined;
|
|
3557
|
+
/**
|
|
3558
|
+
* <p>The Amazon Resource Name (ARN) of the AI Agent that generated the suggested message.</p>
|
|
3559
|
+
* @public
|
|
3560
|
+
*/
|
|
3561
|
+
aiAgentArn: string | undefined;
|
|
3562
|
+
}
|
|
2980
3563
|
/**
|
|
2981
3564
|
* <p>Reference data.</p>
|
|
2982
3565
|
* @public
|
|
2983
3566
|
*/
|
|
2984
|
-
export type DataReference = DataReference.ContentReferenceMember | DataReference.GenerativeReferenceMember | DataReference.$UnknownMember;
|
|
3567
|
+
export type DataReference = DataReference.ContentReferenceMember | DataReference.GenerativeReferenceMember | DataReference.SuggestedMessageReferenceMember | DataReference.$UnknownMember;
|
|
2985
3568
|
/**
|
|
2986
3569
|
* @public
|
|
2987
3570
|
*/
|
|
@@ -2993,6 +3576,7 @@ export declare namespace DataReference {
|
|
|
2993
3576
|
interface ContentReferenceMember {
|
|
2994
3577
|
contentReference: ContentReference;
|
|
2995
3578
|
generativeReference?: never;
|
|
3579
|
+
suggestedMessageReference?: never;
|
|
2996
3580
|
$unknown?: never;
|
|
2997
3581
|
}
|
|
2998
3582
|
/**
|
|
@@ -3002,6 +3586,17 @@ export declare namespace DataReference {
|
|
|
3002
3586
|
interface GenerativeReferenceMember {
|
|
3003
3587
|
contentReference?: never;
|
|
3004
3588
|
generativeReference: GenerativeReference;
|
|
3589
|
+
suggestedMessageReference?: never;
|
|
3590
|
+
$unknown?: never;
|
|
3591
|
+
}
|
|
3592
|
+
/**
|
|
3593
|
+
* <p>Reference information for suggested messages.</p>
|
|
3594
|
+
* @public
|
|
3595
|
+
*/
|
|
3596
|
+
interface SuggestedMessageReferenceMember {
|
|
3597
|
+
contentReference?: never;
|
|
3598
|
+
generativeReference?: never;
|
|
3599
|
+
suggestedMessageReference: SuggestedMessageReference;
|
|
3005
3600
|
$unknown?: never;
|
|
3006
3601
|
}
|
|
3007
3602
|
/**
|
|
@@ -3010,6 +3605,7 @@ export declare namespace DataReference {
|
|
|
3010
3605
|
interface $UnknownMember {
|
|
3011
3606
|
contentReference?: never;
|
|
3012
3607
|
generativeReference?: never;
|
|
3608
|
+
suggestedMessageReference?: never;
|
|
3013
3609
|
$unknown: [string, any];
|
|
3014
3610
|
}
|
|
3015
3611
|
/**
|
|
@@ -3019,6 +3615,7 @@ export declare namespace DataReference {
|
|
|
3019
3615
|
interface Visitor<T> {
|
|
3020
3616
|
contentReference: (value: ContentReference) => T;
|
|
3021
3617
|
generativeReference: (value: GenerativeReference) => T;
|
|
3618
|
+
suggestedMessageReference: (value: SuggestedMessageReference) => T;
|
|
3022
3619
|
_: (name: string, value: any) => T;
|
|
3023
3620
|
}
|
|
3024
3621
|
}
|
|
@@ -3193,6 +3790,11 @@ export interface AssistantSummary {
|
|
|
3193
3790
|
* @public
|
|
3194
3791
|
*/
|
|
3195
3792
|
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
|
|
3793
|
+
/**
|
|
3794
|
+
* <p>The list of orchestrator configurations for the assistant.</p>
|
|
3795
|
+
* @public
|
|
3796
|
+
*/
|
|
3797
|
+
orchestratorConfigurationList?: OrchestratorConfigurationEntry[] | undefined;
|
|
3196
3798
|
}
|
|
3197
3799
|
/**
|
|
3198
3800
|
* @public
|
|
@@ -3413,6 +4015,17 @@ export declare namespace QueryCondition {
|
|
|
3413
4015
|
_: (name: string, value: any) => T;
|
|
3414
4016
|
}
|
|
3415
4017
|
}
|
|
4018
|
+
/**
|
|
4019
|
+
* <p>Input data for case summarization.</p>
|
|
4020
|
+
* @public
|
|
4021
|
+
*/
|
|
4022
|
+
export interface CaseSummarizationInputData {
|
|
4023
|
+
/**
|
|
4024
|
+
* <p>The Amazon Resource Name (ARN) of the case for summarization.</p>
|
|
4025
|
+
* @public
|
|
4026
|
+
*/
|
|
4027
|
+
caseArn: string | undefined;
|
|
4028
|
+
}
|
|
3416
4029
|
/**
|
|
3417
4030
|
* <p>Information about the Amazon Q intent.</p>
|
|
3418
4031
|
* @public
|
|
@@ -3439,7 +4052,7 @@ export interface QueryTextInputData {
|
|
|
3439
4052
|
* <p>Input information for the query.</p>
|
|
3440
4053
|
* @public
|
|
3441
4054
|
*/
|
|
3442
|
-
export type QueryInputData = QueryInputData.IntentInputDataMember | QueryInputData.QueryTextInputDataMember | QueryInputData.$UnknownMember;
|
|
4055
|
+
export type QueryInputData = QueryInputData.CaseSummarizationInputDataMember | QueryInputData.IntentInputDataMember | QueryInputData.QueryTextInputDataMember | QueryInputData.$UnknownMember;
|
|
3443
4056
|
/**
|
|
3444
4057
|
* @public
|
|
3445
4058
|
*/
|
|
@@ -3451,6 +4064,7 @@ export declare namespace QueryInputData {
|
|
|
3451
4064
|
interface QueryTextInputDataMember {
|
|
3452
4065
|
queryTextInputData: QueryTextInputData;
|
|
3453
4066
|
intentInputData?: never;
|
|
4067
|
+
caseSummarizationInputData?: never;
|
|
3454
4068
|
$unknown?: never;
|
|
3455
4069
|
}
|
|
3456
4070
|
/**
|
|
@@ -3460,6 +4074,17 @@ export declare namespace QueryInputData {
|
|
|
3460
4074
|
interface IntentInputDataMember {
|
|
3461
4075
|
queryTextInputData?: never;
|
|
3462
4076
|
intentInputData: IntentInputData;
|
|
4077
|
+
caseSummarizationInputData?: never;
|
|
4078
|
+
$unknown?: never;
|
|
4079
|
+
}
|
|
4080
|
+
/**
|
|
4081
|
+
* <p>Input data for case summarization queries.</p>
|
|
4082
|
+
* @public
|
|
4083
|
+
*/
|
|
4084
|
+
interface CaseSummarizationInputDataMember {
|
|
4085
|
+
queryTextInputData?: never;
|
|
4086
|
+
intentInputData?: never;
|
|
4087
|
+
caseSummarizationInputData: CaseSummarizationInputData;
|
|
3463
4088
|
$unknown?: never;
|
|
3464
4089
|
}
|
|
3465
4090
|
/**
|
|
@@ -3468,6 +4093,7 @@ export declare namespace QueryInputData {
|
|
|
3468
4093
|
interface $UnknownMember {
|
|
3469
4094
|
queryTextInputData?: never;
|
|
3470
4095
|
intentInputData?: never;
|
|
4096
|
+
caseSummarizationInputData?: never;
|
|
3471
4097
|
$unknown: [string, any];
|
|
3472
4098
|
}
|
|
3473
4099
|
/**
|
|
@@ -3477,6 +4103,7 @@ export declare namespace QueryInputData {
|
|
|
3477
4103
|
interface Visitor<T> {
|
|
3478
4104
|
queryTextInputData: (value: QueryTextInputData) => T;
|
|
3479
4105
|
intentInputData: (value: IntentInputData) => T;
|
|
4106
|
+
caseSummarizationInputData: (value: CaseSummarizationInputData) => T;
|
|
3480
4107
|
_: (name: string, value: any) => T;
|
|
3481
4108
|
}
|
|
3482
4109
|
}
|
|
@@ -3539,12 +4166,102 @@ export interface RemoveAssistantAIAgentRequest {
|
|
|
3539
4166
|
* @public
|
|
3540
4167
|
*/
|
|
3541
4168
|
aiAgentType: AIAgentType | undefined;
|
|
4169
|
+
/**
|
|
4170
|
+
* <p>The orchestrator use case for the AI Agent being removed.</p>
|
|
4171
|
+
* @public
|
|
4172
|
+
*/
|
|
4173
|
+
orchestratorUseCase?: string | undefined;
|
|
3542
4174
|
}
|
|
3543
4175
|
/**
|
|
3544
4176
|
* @public
|
|
3545
4177
|
*/
|
|
3546
4178
|
export interface RemoveAssistantAIAgentResponse {
|
|
3547
4179
|
}
|
|
4180
|
+
/**
|
|
4181
|
+
* <p>An attribute used for filtering.</p>
|
|
4182
|
+
* @public
|
|
4183
|
+
*/
|
|
4184
|
+
export interface FilterAttribute {
|
|
4185
|
+
/**
|
|
4186
|
+
* <p>The key of the filter attribute.</p>
|
|
4187
|
+
* @public
|
|
4188
|
+
*/
|
|
4189
|
+
key: string | undefined;
|
|
4190
|
+
/**
|
|
4191
|
+
* <p>The value of the filter attribute.</p>
|
|
4192
|
+
* @public
|
|
4193
|
+
*/
|
|
4194
|
+
value: __DocumentType | undefined;
|
|
4195
|
+
}
|
|
4196
|
+
/**
|
|
4197
|
+
* <p>A knowledge source that provides content for recommendations.</p>
|
|
4198
|
+
* @public
|
|
4199
|
+
*/
|
|
4200
|
+
export type KnowledgeSource = KnowledgeSource.AssistantAssociationIdsMember | KnowledgeSource.$UnknownMember;
|
|
4201
|
+
/**
|
|
4202
|
+
* @public
|
|
4203
|
+
*/
|
|
4204
|
+
export declare namespace KnowledgeSource {
|
|
4205
|
+
/**
|
|
4206
|
+
* <p>The list of assistant association identifiers for the knowledge source.</p>
|
|
4207
|
+
* @public
|
|
4208
|
+
*/
|
|
4209
|
+
interface AssistantAssociationIdsMember {
|
|
4210
|
+
assistantAssociationIds: string[];
|
|
4211
|
+
$unknown?: never;
|
|
4212
|
+
}
|
|
4213
|
+
/**
|
|
4214
|
+
* @public
|
|
4215
|
+
*/
|
|
4216
|
+
interface $UnknownMember {
|
|
4217
|
+
assistantAssociationIds?: never;
|
|
4218
|
+
$unknown: [string, any];
|
|
4219
|
+
}
|
|
4220
|
+
/**
|
|
4221
|
+
* @deprecated unused in schema-serde mode.
|
|
4222
|
+
*
|
|
4223
|
+
*/
|
|
4224
|
+
interface Visitor<T> {
|
|
4225
|
+
assistantAssociationIds: (value: string[]) => T;
|
|
4226
|
+
_: (name: string, value: any) => T;
|
|
4227
|
+
}
|
|
4228
|
+
}
|
|
4229
|
+
/**
|
|
4230
|
+
* <p>A single result from a content retrieval operation.</p>
|
|
4231
|
+
* @public
|
|
4232
|
+
*/
|
|
4233
|
+
export interface RetrieveResult {
|
|
4234
|
+
/**
|
|
4235
|
+
* <p>The identifier of the assistant association for the retrieved result.</p>
|
|
4236
|
+
* @public
|
|
4237
|
+
*/
|
|
4238
|
+
associationId: string | undefined;
|
|
4239
|
+
/**
|
|
4240
|
+
* <p>The URL, URI, or ID of the retrieved content when available, or a UUID when unavailable.</p>
|
|
4241
|
+
* @public
|
|
4242
|
+
*/
|
|
4243
|
+
sourceId: string | undefined;
|
|
4244
|
+
/**
|
|
4245
|
+
* <p>A type to define the KB origin of a retrieved content.</p>
|
|
4246
|
+
* @public
|
|
4247
|
+
*/
|
|
4248
|
+
referenceType: ReferenceType | undefined;
|
|
4249
|
+
/**
|
|
4250
|
+
* <p>The text content of the retrieved result.</p>
|
|
4251
|
+
* @public
|
|
4252
|
+
*/
|
|
4253
|
+
contentText: string | undefined;
|
|
4254
|
+
}
|
|
4255
|
+
/**
|
|
4256
|
+
* @public
|
|
4257
|
+
*/
|
|
4258
|
+
export interface RetrieveResponse {
|
|
4259
|
+
/**
|
|
4260
|
+
* <p>The results of the content retrieval operation.</p>
|
|
4261
|
+
* @public
|
|
4262
|
+
*/
|
|
4263
|
+
results: RetrieveResult[] | undefined;
|
|
4264
|
+
}
|
|
3548
4265
|
/**
|
|
3549
4266
|
* <p>A search filter.</p>
|
|
3550
4267
|
* @public
|
|
@@ -3687,6 +4404,16 @@ export interface CreateSessionRequest {
|
|
|
3687
4404
|
* @public
|
|
3688
4405
|
*/
|
|
3689
4406
|
contactArn?: string | undefined;
|
|
4407
|
+
/**
|
|
4408
|
+
* <p>The list of orchestrator configurations for the session being created.</p>
|
|
4409
|
+
* @public
|
|
4410
|
+
*/
|
|
4411
|
+
orchestratorConfigurationList?: OrchestratorConfigurationEntry[] | undefined;
|
|
4412
|
+
/**
|
|
4413
|
+
* <p>The list of orchestrator configurations to remove from the session.</p>
|
|
4414
|
+
* @public
|
|
4415
|
+
*/
|
|
4416
|
+
removeOrchestratorConfigurationList?: boolean | undefined;
|
|
3690
4417
|
}
|
|
3691
4418
|
/**
|
|
3692
4419
|
* <p>The configuration information for the session integration.</p>
|
|
@@ -3749,6 +4476,11 @@ export interface SessionData {
|
|
|
3749
4476
|
* @public
|
|
3750
4477
|
*/
|
|
3751
4478
|
origin?: Origin | undefined;
|
|
4479
|
+
/**
|
|
4480
|
+
* <p>The list of orchestrator configurations for the session.</p>
|
|
4481
|
+
* @public
|
|
4482
|
+
*/
|
|
4483
|
+
orchestratorConfigurationList?: OrchestratorConfigurationEntry[] | undefined;
|
|
3752
4484
|
}
|
|
3753
4485
|
/**
|
|
3754
4486
|
* @public
|
|
@@ -3846,31 +4578,113 @@ export interface ConversationState {
|
|
|
3846
4578
|
reason?: ConversationStatusReason | undefined;
|
|
3847
4579
|
}
|
|
3848
4580
|
/**
|
|
3849
|
-
* <p>
|
|
4581
|
+
* <p>A citation that references source content.</p>
|
|
3850
4582
|
* @public
|
|
3851
4583
|
*/
|
|
3852
|
-
export interface
|
|
4584
|
+
export interface Citation {
|
|
3853
4585
|
/**
|
|
3854
|
-
* <p>The
|
|
4586
|
+
* <p>The identifier of the content being cited.</p>
|
|
3855
4587
|
* @public
|
|
3856
4588
|
*/
|
|
3857
|
-
|
|
3858
|
-
|
|
3859
|
-
|
|
3860
|
-
|
|
3861
|
-
|
|
3862
|
-
|
|
3863
|
-
|
|
3864
|
-
|
|
3865
|
-
|
|
3866
|
-
|
|
3867
|
-
|
|
4589
|
+
contentId?: string | undefined;
|
|
4590
|
+
/**
|
|
4591
|
+
* <p>The title of the cited content.</p>
|
|
4592
|
+
* @public
|
|
4593
|
+
*/
|
|
4594
|
+
title?: string | undefined;
|
|
4595
|
+
/**
|
|
4596
|
+
* <p>The identifier of the knowledge base containing the cited content.</p>
|
|
4597
|
+
* @public
|
|
4598
|
+
*/
|
|
4599
|
+
knowledgeBaseId?: string | undefined;
|
|
4600
|
+
/**
|
|
4601
|
+
* <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
|
|
4602
|
+
* @public
|
|
4603
|
+
*/
|
|
4604
|
+
citationSpan: CitationSpan | undefined;
|
|
4605
|
+
/**
|
|
4606
|
+
* <p>The source URL for the citation.</p>
|
|
4607
|
+
* @public
|
|
4608
|
+
*/
|
|
4609
|
+
sourceURL?: string | undefined;
|
|
4610
|
+
/**
|
|
4611
|
+
* <p>A type to define the KB origin of a cited content</p>
|
|
4612
|
+
* @public
|
|
4613
|
+
*/
|
|
4614
|
+
referenceType: ReferenceType | undefined;
|
|
4615
|
+
}
|
|
4616
|
+
/**
|
|
4617
|
+
* <p>The message data in text type.</p>
|
|
4618
|
+
* @public
|
|
4619
|
+
*/
|
|
4620
|
+
export interface TextMessage {
|
|
4621
|
+
/**
|
|
4622
|
+
* <p>The value of the message data in text type.</p>
|
|
4623
|
+
* @public
|
|
4624
|
+
*/
|
|
4625
|
+
value?: string | undefined;
|
|
4626
|
+
/**
|
|
4627
|
+
* <p>The citations associated with the text message.</p>
|
|
4628
|
+
* @public
|
|
4629
|
+
*/
|
|
4630
|
+
citations?: Citation[] | undefined;
|
|
4631
|
+
/**
|
|
4632
|
+
* <p>The AI Guardrail assessment for the text message.</p>
|
|
4633
|
+
* @public
|
|
4634
|
+
*/
|
|
4635
|
+
aiGuardrailAssessment?: AIGuardrailAssessment | undefined;
|
|
4636
|
+
}
|
|
4637
|
+
/**
|
|
4638
|
+
* <p>Data about the result of tool usage.</p>
|
|
4639
|
+
* @public
|
|
4640
|
+
*/
|
|
4641
|
+
export interface ToolUseResultData {
|
|
4642
|
+
/**
|
|
4643
|
+
* <p>The identifier of the tool use instance.</p>
|
|
4644
|
+
* @public
|
|
4645
|
+
*/
|
|
4646
|
+
toolUseId: string | undefined;
|
|
4647
|
+
/**
|
|
4648
|
+
* <p>The name of the tool that was used.</p>
|
|
4649
|
+
* @public
|
|
4650
|
+
*/
|
|
4651
|
+
toolName: string | undefined;
|
|
4652
|
+
/**
|
|
4653
|
+
* <p>The result of the tool usage.</p>
|
|
4654
|
+
* @public
|
|
4655
|
+
*/
|
|
4656
|
+
toolResult: __DocumentType | undefined;
|
|
4657
|
+
/**
|
|
4658
|
+
* <p>The input schema for the tool use result.</p>
|
|
4659
|
+
* @public
|
|
4660
|
+
*/
|
|
4661
|
+
inputSchema?: __DocumentType | undefined;
|
|
4662
|
+
}
|
|
4663
|
+
/**
|
|
4664
|
+
* <p>The message data.</p>
|
|
4665
|
+
* @public
|
|
4666
|
+
*/
|
|
4667
|
+
export type MessageData = MessageData.TextMember | MessageData.ToolUseResultMember | MessageData.$UnknownMember;
|
|
4668
|
+
/**
|
|
4669
|
+
* @public
|
|
4670
|
+
*/
|
|
4671
|
+
export declare namespace MessageData {
|
|
3868
4672
|
/**
|
|
3869
4673
|
* <p>The message data in text type.</p>
|
|
3870
4674
|
* @public
|
|
3871
4675
|
*/
|
|
3872
4676
|
interface TextMember {
|
|
3873
4677
|
text: TextMessage;
|
|
4678
|
+
toolUseResult?: never;
|
|
4679
|
+
$unknown?: never;
|
|
4680
|
+
}
|
|
4681
|
+
/**
|
|
4682
|
+
* <p>The result of tool usage in the message.</p>
|
|
4683
|
+
* @public
|
|
4684
|
+
*/
|
|
4685
|
+
interface ToolUseResultMember {
|
|
4686
|
+
text?: never;
|
|
4687
|
+
toolUseResult: ToolUseResultData;
|
|
3874
4688
|
$unknown?: never;
|
|
3875
4689
|
}
|
|
3876
4690
|
/**
|
|
@@ -3878,6 +4692,7 @@ export declare namespace MessageData {
|
|
|
3878
4692
|
*/
|
|
3879
4693
|
interface $UnknownMember {
|
|
3880
4694
|
text?: never;
|
|
4695
|
+
toolUseResult?: never;
|
|
3881
4696
|
$unknown: [string, any];
|
|
3882
4697
|
}
|
|
3883
4698
|
/**
|
|
@@ -3886,6 +4701,7 @@ export declare namespace MessageData {
|
|
|
3886
4701
|
*/
|
|
3887
4702
|
interface Visitor<T> {
|
|
3888
4703
|
text: (value: TextMessage) => T;
|
|
4704
|
+
toolUseResult: (value: ToolUseResultData) => T;
|
|
3889
4705
|
_: (name: string, value: any) => T;
|
|
3890
4706
|
}
|
|
3891
4707
|
}
|
|
@@ -3949,6 +4765,11 @@ export interface GetNextMessageResponse {
|
|
|
3949
4765
|
* @public
|
|
3950
4766
|
*/
|
|
3951
4767
|
conversationSessionData?: RuntimeSessionData[] | undefined;
|
|
4768
|
+
/**
|
|
4769
|
+
* <p>Indicates whether the chunked response has been terminated.</p>
|
|
4770
|
+
* @public
|
|
4771
|
+
*/
|
|
4772
|
+
chunkedResponseTerminated?: boolean | undefined;
|
|
3952
4773
|
}
|
|
3953
4774
|
/**
|
|
3954
4775
|
* @public
|
|
@@ -3999,6 +4820,11 @@ export interface ListMessagesRequest {
|
|
|
3999
4820
|
* @public
|
|
4000
4821
|
*/
|
|
4001
4822
|
maxResults?: number | undefined;
|
|
4823
|
+
/**
|
|
4824
|
+
* <p>The filter criteria for listing messages.</p>
|
|
4825
|
+
* @public
|
|
4826
|
+
*/
|
|
4827
|
+
filter?: MessageFilterType | undefined;
|
|
4002
4828
|
}
|
|
4003
4829
|
/**
|
|
4004
4830
|
* @public
|
|
@@ -4015,6 +4841,99 @@ export interface ListMessagesResponse {
|
|
|
4015
4841
|
*/
|
|
4016
4842
|
nextToken?: string | undefined;
|
|
4017
4843
|
}
|
|
4844
|
+
/**
|
|
4845
|
+
* @public
|
|
4846
|
+
*/
|
|
4847
|
+
export interface ListSpansRequest {
|
|
4848
|
+
/**
|
|
4849
|
+
* <p>UUID or ARN of the Connect AI Assistant resource</p>
|
|
4850
|
+
* @public
|
|
4851
|
+
*/
|
|
4852
|
+
assistantId: string | undefined;
|
|
4853
|
+
/**
|
|
4854
|
+
* <p>UUID or ARN of the Connect AI Session resource</p>
|
|
4855
|
+
* @public
|
|
4856
|
+
*/
|
|
4857
|
+
sessionId: string | undefined;
|
|
4858
|
+
/**
|
|
4859
|
+
* <p>Pagination token for retrieving the next page of results</p>
|
|
4860
|
+
* @public
|
|
4861
|
+
*/
|
|
4862
|
+
nextToken?: string | undefined;
|
|
4863
|
+
/**
|
|
4864
|
+
* <p>Maximum number of spans to return per page</p>
|
|
4865
|
+
* @public
|
|
4866
|
+
*/
|
|
4867
|
+
maxResults?: number | undefined;
|
|
4868
|
+
}
|
|
4869
|
+
/**
|
|
4870
|
+
* <p>A citation that spans a specific range of text.</p>
|
|
4871
|
+
* @public
|
|
4872
|
+
*/
|
|
4873
|
+
export interface SpanCitation {
|
|
4874
|
+
/**
|
|
4875
|
+
* <p>The identifier of the content being cited in the span.</p>
|
|
4876
|
+
* @public
|
|
4877
|
+
*/
|
|
4878
|
+
contentId?: string | undefined;
|
|
4879
|
+
/**
|
|
4880
|
+
* <p>The title of the content being cited in the span.</p>
|
|
4881
|
+
* @public
|
|
4882
|
+
*/
|
|
4883
|
+
title?: string | undefined;
|
|
4884
|
+
/**
|
|
4885
|
+
* <p>The identifier of the knowledge base containing the cited content.</p>
|
|
4886
|
+
* @public
|
|
4887
|
+
*/
|
|
4888
|
+
knowledgeBaseId?: string | undefined;
|
|
4889
|
+
/**
|
|
4890
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base containing the cited content.</p>
|
|
4891
|
+
* @public
|
|
4892
|
+
*/
|
|
4893
|
+
knowledgeBaseArn?: string | undefined;
|
|
4894
|
+
}
|
|
4895
|
+
/**
|
|
4896
|
+
* <p>Text message content</p>
|
|
4897
|
+
* @public
|
|
4898
|
+
*/
|
|
4899
|
+
export interface SpanTextValue {
|
|
4900
|
+
/**
|
|
4901
|
+
* <p>String content of the message text</p>
|
|
4902
|
+
* @public
|
|
4903
|
+
*/
|
|
4904
|
+
value: string | undefined;
|
|
4905
|
+
/**
|
|
4906
|
+
* <p>The citations associated with the span text.</p>
|
|
4907
|
+
* @public
|
|
4908
|
+
*/
|
|
4909
|
+
citations?: SpanCitation[] | undefined;
|
|
4910
|
+
/**
|
|
4911
|
+
* <p>The AI Guardrail assessment for the span text.</p>
|
|
4912
|
+
* @public
|
|
4913
|
+
*/
|
|
4914
|
+
aiGuardrailAssessment?: AIGuardrailAssessment | undefined;
|
|
4915
|
+
}
|
|
4916
|
+
/**
|
|
4917
|
+
* <p>Tool invocation message content</p>
|
|
4918
|
+
* @public
|
|
4919
|
+
*/
|
|
4920
|
+
export interface SpanToolUseValue {
|
|
4921
|
+
/**
|
|
4922
|
+
* <p>Unique ID for this tool invocation</p>
|
|
4923
|
+
* @public
|
|
4924
|
+
*/
|
|
4925
|
+
toolUseId: string | undefined;
|
|
4926
|
+
/**
|
|
4927
|
+
* <p>The tool name</p>
|
|
4928
|
+
* @public
|
|
4929
|
+
*/
|
|
4930
|
+
name: string | undefined;
|
|
4931
|
+
/**
|
|
4932
|
+
* <p>The tool input arguments</p>
|
|
4933
|
+
* @public
|
|
4934
|
+
*/
|
|
4935
|
+
arguments: __DocumentType | undefined;
|
|
4936
|
+
}
|
|
4018
4937
|
/**
|
|
4019
4938
|
* <p>The configuration for a <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_amazon-q-connect_SendMessage.html">SendMessage</a> request.</p>
|
|
4020
4939
|
* @public
|
|
@@ -4025,6 +4944,11 @@ export interface MessageConfiguration {
|
|
|
4025
4944
|
* @public
|
|
4026
4945
|
*/
|
|
4027
4946
|
generateFillerMessage?: boolean | undefined;
|
|
4947
|
+
/**
|
|
4948
|
+
* <p>Configuration for generating chunked messages.</p>
|
|
4949
|
+
* @public
|
|
4950
|
+
*/
|
|
4951
|
+
generateChunkedMessage?: boolean | undefined;
|
|
4028
4952
|
}
|
|
4029
4953
|
/**
|
|
4030
4954
|
* <p>The conversation history data to included in conversation context data before the Amazon Q in Connect session.</p>
|
|
@@ -4035,7 +4959,7 @@ export interface SelfServiceConversationHistory {
|
|
|
4035
4959
|
* <p>The number of turn of the conversation history data.</p>
|
|
4036
4960
|
* @public
|
|
4037
4961
|
*/
|
|
4038
|
-
turnNumber
|
|
4962
|
+
turnNumber?: number | undefined;
|
|
4039
4963
|
/**
|
|
4040
4964
|
* <p>The input transcript of the conversation history data.</p>
|
|
4041
4965
|
* @public
|
|
@@ -4046,6 +4970,11 @@ export interface SelfServiceConversationHistory {
|
|
|
4046
4970
|
* @public
|
|
4047
4971
|
*/
|
|
4048
4972
|
botResponse?: string | undefined;
|
|
4973
|
+
/**
|
|
4974
|
+
* <p>The timestamp of the conversation history entry.</p>
|
|
4975
|
+
* @public
|
|
4976
|
+
*/
|
|
4977
|
+
timestamp?: Date | undefined;
|
|
4049
4978
|
}
|
|
4050
4979
|
/**
|
|
4051
4980
|
* <p>The conversation context to include in SendMessage.</p>
|
|
@@ -4093,6 +5022,11 @@ export interface SendMessageRequest {
|
|
|
4093
5022
|
* @public
|
|
4094
5023
|
*/
|
|
4095
5024
|
message: MessageInput | undefined;
|
|
5025
|
+
/**
|
|
5026
|
+
* <p>The identifier of the AI Agent to use for processing the message.</p>
|
|
5027
|
+
* @public
|
|
5028
|
+
*/
|
|
5029
|
+
aiAgentId?: string | undefined;
|
|
4096
5030
|
/**
|
|
4097
5031
|
* <p>The conversation context before the Amazon Q in Connect session.</p>
|
|
4098
5032
|
* @public
|
|
@@ -4108,6 +5042,16 @@ export interface SendMessageRequest {
|
|
|
4108
5042
|
* @public
|
|
4109
5043
|
*/
|
|
4110
5044
|
clientToken?: string | undefined;
|
|
5045
|
+
/**
|
|
5046
|
+
* <p>The orchestrator use case for message processing.</p>
|
|
5047
|
+
* @public
|
|
5048
|
+
*/
|
|
5049
|
+
orchestratorUseCase?: string | undefined;
|
|
5050
|
+
/**
|
|
5051
|
+
* <p>Additional metadata for the message.</p>
|
|
5052
|
+
* @public
|
|
5053
|
+
*/
|
|
5054
|
+
metadata?: Record<string, string> | undefined;
|
|
4111
5055
|
}
|
|
4112
5056
|
/**
|
|
4113
5057
|
* @public
|
|
@@ -4158,6 +5102,16 @@ export interface UpdateSessionRequest {
|
|
|
4158
5102
|
* @public
|
|
4159
5103
|
*/
|
|
4160
5104
|
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>> | undefined;
|
|
5105
|
+
/**
|
|
5106
|
+
* <p>The updated list of orchestrator configurations for the session.</p>
|
|
5107
|
+
* @public
|
|
5108
|
+
*/
|
|
5109
|
+
orchestratorConfigurationList?: OrchestratorConfigurationEntry[] | undefined;
|
|
5110
|
+
/**
|
|
5111
|
+
* <p>The list of orchestrator configurations to remove from the session.</p>
|
|
5112
|
+
* @public
|
|
5113
|
+
*/
|
|
5114
|
+
removeOrchestratorConfigurationList?: boolean | undefined;
|
|
4161
5115
|
}
|
|
4162
5116
|
/**
|
|
4163
5117
|
* @public
|
|
@@ -4238,6 +5192,11 @@ export interface UpdateAssistantAIAgentRequest {
|
|
|
4238
5192
|
* @public
|
|
4239
5193
|
*/
|
|
4240
5194
|
configuration: AIAgentConfigurationData | undefined;
|
|
5195
|
+
/**
|
|
5196
|
+
* <p>The updated list of orchestrator configurations for the assistant AI Agent.</p>
|
|
5197
|
+
* @public
|
|
5198
|
+
*/
|
|
5199
|
+
orchestratorConfigurationList?: OrchestratorConfigurationEntry[] | undefined;
|
|
4241
5200
|
}
|
|
4242
5201
|
/**
|
|
4243
5202
|
* @public
|
|
@@ -6961,689 +7920,3 @@ export interface DeactivateMessageTemplateResponse {
|
|
|
6961
7920
|
*/
|
|
6962
7921
|
versionNumber: number | undefined;
|
|
6963
7922
|
}
|
|
6964
|
-
/**
|
|
6965
|
-
* @public
|
|
6966
|
-
*/
|
|
6967
|
-
export interface DeleteImportJobRequest {
|
|
6968
|
-
/**
|
|
6969
|
-
* <p>The identifier of the knowledge base.</p>
|
|
6970
|
-
* @public
|
|
6971
|
-
*/
|
|
6972
|
-
knowledgeBaseId: string | undefined;
|
|
6973
|
-
/**
|
|
6974
|
-
* <p>The identifier of the import job to be deleted.</p>
|
|
6975
|
-
* @public
|
|
6976
|
-
*/
|
|
6977
|
-
importJobId: string | undefined;
|
|
6978
|
-
}
|
|
6979
|
-
/**
|
|
6980
|
-
* @public
|
|
6981
|
-
*/
|
|
6982
|
-
export interface DeleteImportJobResponse {
|
|
6983
|
-
}
|
|
6984
|
-
/**
|
|
6985
|
-
* @public
|
|
6986
|
-
*/
|
|
6987
|
-
export interface DeleteKnowledgeBaseRequest {
|
|
6988
|
-
/**
|
|
6989
|
-
* <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
6990
|
-
* @public
|
|
6991
|
-
*/
|
|
6992
|
-
knowledgeBaseId: string | undefined;
|
|
6993
|
-
}
|
|
6994
|
-
/**
|
|
6995
|
-
* @public
|
|
6996
|
-
*/
|
|
6997
|
-
export interface DeleteKnowledgeBaseResponse {
|
|
6998
|
-
}
|
|
6999
|
-
/**
|
|
7000
|
-
* @public
|
|
7001
|
-
*/
|
|
7002
|
-
export interface DeleteMessageTemplateRequest {
|
|
7003
|
-
/**
|
|
7004
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7005
|
-
* @public
|
|
7006
|
-
*/
|
|
7007
|
-
knowledgeBaseId: string | undefined;
|
|
7008
|
-
/**
|
|
7009
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
7010
|
-
* @public
|
|
7011
|
-
*/
|
|
7012
|
-
messageTemplateId: string | undefined;
|
|
7013
|
-
}
|
|
7014
|
-
/**
|
|
7015
|
-
* @public
|
|
7016
|
-
*/
|
|
7017
|
-
export interface DeleteMessageTemplateResponse {
|
|
7018
|
-
}
|
|
7019
|
-
/**
|
|
7020
|
-
* @public
|
|
7021
|
-
*/
|
|
7022
|
-
export interface DeleteMessageTemplateAttachmentRequest {
|
|
7023
|
-
/**
|
|
7024
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7025
|
-
* @public
|
|
7026
|
-
*/
|
|
7027
|
-
knowledgeBaseId: string | undefined;
|
|
7028
|
-
/**
|
|
7029
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
7030
|
-
* @public
|
|
7031
|
-
*/
|
|
7032
|
-
messageTemplateId: string | undefined;
|
|
7033
|
-
/**
|
|
7034
|
-
* <p>The identifier of the attachment file.</p>
|
|
7035
|
-
* @public
|
|
7036
|
-
*/
|
|
7037
|
-
attachmentId: string | undefined;
|
|
7038
|
-
}
|
|
7039
|
-
/**
|
|
7040
|
-
* @public
|
|
7041
|
-
*/
|
|
7042
|
-
export interface DeleteMessageTemplateAttachmentResponse {
|
|
7043
|
-
}
|
|
7044
|
-
/**
|
|
7045
|
-
* @public
|
|
7046
|
-
*/
|
|
7047
|
-
export interface DeleteQuickResponseRequest {
|
|
7048
|
-
/**
|
|
7049
|
-
* <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base.</p>
|
|
7050
|
-
* @public
|
|
7051
|
-
*/
|
|
7052
|
-
knowledgeBaseId: string | undefined;
|
|
7053
|
-
/**
|
|
7054
|
-
* <p>The identifier of the quick response to delete.</p>
|
|
7055
|
-
* @public
|
|
7056
|
-
*/
|
|
7057
|
-
quickResponseId: string | undefined;
|
|
7058
|
-
}
|
|
7059
|
-
/**
|
|
7060
|
-
* @public
|
|
7061
|
-
*/
|
|
7062
|
-
export interface DeleteQuickResponseResponse {
|
|
7063
|
-
}
|
|
7064
|
-
/**
|
|
7065
|
-
* <p>The configuration information of the external data source.</p>
|
|
7066
|
-
* @public
|
|
7067
|
-
*/
|
|
7068
|
-
export interface ExternalSourceConfiguration {
|
|
7069
|
-
/**
|
|
7070
|
-
* <p>The type of the external data source.</p>
|
|
7071
|
-
* @public
|
|
7072
|
-
*/
|
|
7073
|
-
source: ExternalSource | undefined;
|
|
7074
|
-
/**
|
|
7075
|
-
* <p>The configuration information of the external data source.</p>
|
|
7076
|
-
* @public
|
|
7077
|
-
*/
|
|
7078
|
-
configuration: Configuration | undefined;
|
|
7079
|
-
}
|
|
7080
|
-
/**
|
|
7081
|
-
* @public
|
|
7082
|
-
*/
|
|
7083
|
-
export interface GetImportJobRequest {
|
|
7084
|
-
/**
|
|
7085
|
-
* <p>The identifier of the import job to retrieve.</p>
|
|
7086
|
-
* @public
|
|
7087
|
-
*/
|
|
7088
|
-
importJobId: string | undefined;
|
|
7089
|
-
/**
|
|
7090
|
-
* <p>The identifier of the knowledge base that the import job belongs to.</p>
|
|
7091
|
-
* @public
|
|
7092
|
-
*/
|
|
7093
|
-
knowledgeBaseId: string | undefined;
|
|
7094
|
-
}
|
|
7095
|
-
/**
|
|
7096
|
-
* <p>Summary information about the import job.</p>
|
|
7097
|
-
* @public
|
|
7098
|
-
*/
|
|
7099
|
-
export interface ImportJobData {
|
|
7100
|
-
/**
|
|
7101
|
-
* <p>The identifier of the import job.</p>
|
|
7102
|
-
* @public
|
|
7103
|
-
*/
|
|
7104
|
-
importJobId: string | undefined;
|
|
7105
|
-
/**
|
|
7106
|
-
* <p>The identifier of the knowledge base.</p>
|
|
7107
|
-
* @public
|
|
7108
|
-
*/
|
|
7109
|
-
knowledgeBaseId: string | undefined;
|
|
7110
|
-
/**
|
|
7111
|
-
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
|
|
7112
|
-
* @public
|
|
7113
|
-
*/
|
|
7114
|
-
uploadId: string | undefined;
|
|
7115
|
-
/**
|
|
7116
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
7117
|
-
* @public
|
|
7118
|
-
*/
|
|
7119
|
-
knowledgeBaseArn: string | undefined;
|
|
7120
|
-
/**
|
|
7121
|
-
* <p>The type of the import job.</p>
|
|
7122
|
-
* @public
|
|
7123
|
-
*/
|
|
7124
|
-
importJobType: ImportJobType | undefined;
|
|
7125
|
-
/**
|
|
7126
|
-
* <p>The status of the import job.</p>
|
|
7127
|
-
* @public
|
|
7128
|
-
*/
|
|
7129
|
-
status: ImportJobStatus | undefined;
|
|
7130
|
-
/**
|
|
7131
|
-
* <p>The download link to the resource file that is uploaded to the import job.</p>
|
|
7132
|
-
* @public
|
|
7133
|
-
*/
|
|
7134
|
-
url: string | undefined;
|
|
7135
|
-
/**
|
|
7136
|
-
* <p>The link to download the information of resource data that failed to be imported.</p>
|
|
7137
|
-
* @public
|
|
7138
|
-
*/
|
|
7139
|
-
failedRecordReport?: string | undefined;
|
|
7140
|
-
/**
|
|
7141
|
-
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
7142
|
-
* @public
|
|
7143
|
-
*/
|
|
7144
|
-
urlExpiry: Date | undefined;
|
|
7145
|
-
/**
|
|
7146
|
-
* <p>The timestamp when the import job was created.</p>
|
|
7147
|
-
* @public
|
|
7148
|
-
*/
|
|
7149
|
-
createdTime: Date | undefined;
|
|
7150
|
-
/**
|
|
7151
|
-
* <p>The timestamp when the import job data was last modified.</p>
|
|
7152
|
-
* @public
|
|
7153
|
-
*/
|
|
7154
|
-
lastModifiedTime: Date | undefined;
|
|
7155
|
-
/**
|
|
7156
|
-
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
7157
|
-
* @public
|
|
7158
|
-
*/
|
|
7159
|
-
metadata?: Record<string, string> | undefined;
|
|
7160
|
-
/**
|
|
7161
|
-
* <p>The configuration information of the external data source.</p>
|
|
7162
|
-
* @public
|
|
7163
|
-
*/
|
|
7164
|
-
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
7165
|
-
}
|
|
7166
|
-
/**
|
|
7167
|
-
* @public
|
|
7168
|
-
*/
|
|
7169
|
-
export interface GetImportJobResponse {
|
|
7170
|
-
/**
|
|
7171
|
-
* <p>The import job.</p>
|
|
7172
|
-
* @public
|
|
7173
|
-
*/
|
|
7174
|
-
importJob?: ImportJobData | undefined;
|
|
7175
|
-
}
|
|
7176
|
-
/**
|
|
7177
|
-
* @public
|
|
7178
|
-
*/
|
|
7179
|
-
export interface GetKnowledgeBaseRequest {
|
|
7180
|
-
/**
|
|
7181
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7182
|
-
* @public
|
|
7183
|
-
*/
|
|
7184
|
-
knowledgeBaseId: string | undefined;
|
|
7185
|
-
}
|
|
7186
|
-
/**
|
|
7187
|
-
* @public
|
|
7188
|
-
*/
|
|
7189
|
-
export interface GetKnowledgeBaseResponse {
|
|
7190
|
-
/**
|
|
7191
|
-
* <p>The knowledge base.</p>
|
|
7192
|
-
* @public
|
|
7193
|
-
*/
|
|
7194
|
-
knowledgeBase?: KnowledgeBaseData | undefined;
|
|
7195
|
-
}
|
|
7196
|
-
/**
|
|
7197
|
-
* @public
|
|
7198
|
-
*/
|
|
7199
|
-
export interface GetMessageTemplateRequest {
|
|
7200
|
-
/**
|
|
7201
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
7202
|
-
* @public
|
|
7203
|
-
*/
|
|
7204
|
-
messageTemplateId: string | undefined;
|
|
7205
|
-
/**
|
|
7206
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7207
|
-
* @public
|
|
7208
|
-
*/
|
|
7209
|
-
knowledgeBaseId: string | undefined;
|
|
7210
|
-
}
|
|
7211
|
-
/**
|
|
7212
|
-
* @public
|
|
7213
|
-
*/
|
|
7214
|
-
export interface GetMessageTemplateResponse {
|
|
7215
|
-
/**
|
|
7216
|
-
* <p>The message template.</p>
|
|
7217
|
-
* @public
|
|
7218
|
-
*/
|
|
7219
|
-
messageTemplate?: ExtendedMessageTemplateData | undefined;
|
|
7220
|
-
}
|
|
7221
|
-
/**
|
|
7222
|
-
* @public
|
|
7223
|
-
*/
|
|
7224
|
-
export interface GetQuickResponseRequest {
|
|
7225
|
-
/**
|
|
7226
|
-
* <p>The identifier of the quick response.</p>
|
|
7227
|
-
* @public
|
|
7228
|
-
*/
|
|
7229
|
-
quickResponseId: string | undefined;
|
|
7230
|
-
/**
|
|
7231
|
-
* <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</p>
|
|
7232
|
-
* @public
|
|
7233
|
-
*/
|
|
7234
|
-
knowledgeBaseId: string | undefined;
|
|
7235
|
-
}
|
|
7236
|
-
/**
|
|
7237
|
-
* @public
|
|
7238
|
-
*/
|
|
7239
|
-
export interface GetQuickResponseResponse {
|
|
7240
|
-
/**
|
|
7241
|
-
* <p>The quick response.</p>
|
|
7242
|
-
* @public
|
|
7243
|
-
*/
|
|
7244
|
-
quickResponse?: QuickResponseData | undefined;
|
|
7245
|
-
}
|
|
7246
|
-
/**
|
|
7247
|
-
* <p>Summary information about the import job.</p>
|
|
7248
|
-
* @public
|
|
7249
|
-
*/
|
|
7250
|
-
export interface ImportJobSummary {
|
|
7251
|
-
/**
|
|
7252
|
-
* <p>The identifier of the import job.</p>
|
|
7253
|
-
* @public
|
|
7254
|
-
*/
|
|
7255
|
-
importJobId: string | undefined;
|
|
7256
|
-
/**
|
|
7257
|
-
* <p>The identifier of the knowledge base.</p>
|
|
7258
|
-
* @public
|
|
7259
|
-
*/
|
|
7260
|
-
knowledgeBaseId: string | undefined;
|
|
7261
|
-
/**
|
|
7262
|
-
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
|
|
7263
|
-
* @public
|
|
7264
|
-
*/
|
|
7265
|
-
uploadId: string | undefined;
|
|
7266
|
-
/**
|
|
7267
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
7268
|
-
* @public
|
|
7269
|
-
*/
|
|
7270
|
-
knowledgeBaseArn: string | undefined;
|
|
7271
|
-
/**
|
|
7272
|
-
* <p>The type of import job.</p>
|
|
7273
|
-
* @public
|
|
7274
|
-
*/
|
|
7275
|
-
importJobType: ImportJobType | undefined;
|
|
7276
|
-
/**
|
|
7277
|
-
* <p>The status of the import job.</p>
|
|
7278
|
-
* @public
|
|
7279
|
-
*/
|
|
7280
|
-
status: ImportJobStatus | undefined;
|
|
7281
|
-
/**
|
|
7282
|
-
* <p>The timestamp when the import job was created.</p>
|
|
7283
|
-
* @public
|
|
7284
|
-
*/
|
|
7285
|
-
createdTime: Date | undefined;
|
|
7286
|
-
/**
|
|
7287
|
-
* <p>The timestamp when the import job was last modified.</p>
|
|
7288
|
-
* @public
|
|
7289
|
-
*/
|
|
7290
|
-
lastModifiedTime: Date | undefined;
|
|
7291
|
-
/**
|
|
7292
|
-
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
7293
|
-
* @public
|
|
7294
|
-
*/
|
|
7295
|
-
metadata?: Record<string, string> | undefined;
|
|
7296
|
-
/**
|
|
7297
|
-
* <p>The configuration information of the external source that the resource data are imported from.</p>
|
|
7298
|
-
* @public
|
|
7299
|
-
*/
|
|
7300
|
-
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
7301
|
-
}
|
|
7302
|
-
/**
|
|
7303
|
-
* @public
|
|
7304
|
-
*/
|
|
7305
|
-
export interface ListImportJobsRequest {
|
|
7306
|
-
/**
|
|
7307
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
7308
|
-
* @public
|
|
7309
|
-
*/
|
|
7310
|
-
nextToken?: string | undefined;
|
|
7311
|
-
/**
|
|
7312
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7313
|
-
* @public
|
|
7314
|
-
*/
|
|
7315
|
-
maxResults?: number | undefined;
|
|
7316
|
-
/**
|
|
7317
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7318
|
-
* @public
|
|
7319
|
-
*/
|
|
7320
|
-
knowledgeBaseId: string | undefined;
|
|
7321
|
-
}
|
|
7322
|
-
/**
|
|
7323
|
-
* @public
|
|
7324
|
-
*/
|
|
7325
|
-
export interface ListImportJobsResponse {
|
|
7326
|
-
/**
|
|
7327
|
-
* <p>Summary information about the import jobs.</p>
|
|
7328
|
-
* @public
|
|
7329
|
-
*/
|
|
7330
|
-
importJobSummaries: ImportJobSummary[] | undefined;
|
|
7331
|
-
/**
|
|
7332
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
7333
|
-
* @public
|
|
7334
|
-
*/
|
|
7335
|
-
nextToken?: string | undefined;
|
|
7336
|
-
}
|
|
7337
|
-
/**
|
|
7338
|
-
* @public
|
|
7339
|
-
*/
|
|
7340
|
-
export interface ListKnowledgeBasesRequest {
|
|
7341
|
-
/**
|
|
7342
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
7343
|
-
* @public
|
|
7344
|
-
*/
|
|
7345
|
-
nextToken?: string | undefined;
|
|
7346
|
-
/**
|
|
7347
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7348
|
-
* @public
|
|
7349
|
-
*/
|
|
7350
|
-
maxResults?: number | undefined;
|
|
7351
|
-
}
|
|
7352
|
-
/**
|
|
7353
|
-
* <p>Summary information about the knowledge base.</p>
|
|
7354
|
-
* @public
|
|
7355
|
-
*/
|
|
7356
|
-
export interface KnowledgeBaseSummary {
|
|
7357
|
-
/**
|
|
7358
|
-
* <p>The identifier of the knowledge base.</p>
|
|
7359
|
-
* @public
|
|
7360
|
-
*/
|
|
7361
|
-
knowledgeBaseId: string | undefined;
|
|
7362
|
-
/**
|
|
7363
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
7364
|
-
* @public
|
|
7365
|
-
*/
|
|
7366
|
-
knowledgeBaseArn: string | undefined;
|
|
7367
|
-
/**
|
|
7368
|
-
* <p>The name of the knowledge base.</p>
|
|
7369
|
-
* @public
|
|
7370
|
-
*/
|
|
7371
|
-
name: string | undefined;
|
|
7372
|
-
/**
|
|
7373
|
-
* <p>The type of knowledge base.</p>
|
|
7374
|
-
* @public
|
|
7375
|
-
*/
|
|
7376
|
-
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
7377
|
-
/**
|
|
7378
|
-
* <p>The status of the knowledge base summary.</p>
|
|
7379
|
-
* @public
|
|
7380
|
-
*/
|
|
7381
|
-
status: KnowledgeBaseStatus | undefined;
|
|
7382
|
-
/**
|
|
7383
|
-
* <p>Configuration information about the external data source.</p>
|
|
7384
|
-
* @public
|
|
7385
|
-
*/
|
|
7386
|
-
sourceConfiguration?: SourceConfiguration | undefined;
|
|
7387
|
-
/**
|
|
7388
|
-
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
7389
|
-
* @public
|
|
7390
|
-
*/
|
|
7391
|
-
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
7392
|
-
/**
|
|
7393
|
-
* <p>Information about how to render the content.</p>
|
|
7394
|
-
* @public
|
|
7395
|
-
*/
|
|
7396
|
-
renderingConfiguration?: RenderingConfiguration | undefined;
|
|
7397
|
-
/**
|
|
7398
|
-
* <p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the key to invoke Amazon Q in Connect. </p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>
|
|
7399
|
-
* @public
|
|
7400
|
-
*/
|
|
7401
|
-
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
7402
|
-
/**
|
|
7403
|
-
* <p>The description of the knowledge base.</p>
|
|
7404
|
-
* @public
|
|
7405
|
-
*/
|
|
7406
|
-
description?: string | undefined;
|
|
7407
|
-
/**
|
|
7408
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7409
|
-
* @public
|
|
7410
|
-
*/
|
|
7411
|
-
tags?: Record<string, string> | undefined;
|
|
7412
|
-
}
|
|
7413
|
-
/**
|
|
7414
|
-
* @public
|
|
7415
|
-
*/
|
|
7416
|
-
export interface ListKnowledgeBasesResponse {
|
|
7417
|
-
/**
|
|
7418
|
-
* <p>Information about the knowledge bases.</p>
|
|
7419
|
-
* @public
|
|
7420
|
-
*/
|
|
7421
|
-
knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
7422
|
-
/**
|
|
7423
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7424
|
-
* @public
|
|
7425
|
-
*/
|
|
7426
|
-
nextToken?: string | undefined;
|
|
7427
|
-
}
|
|
7428
|
-
/**
|
|
7429
|
-
* @public
|
|
7430
|
-
*/
|
|
7431
|
-
export interface ListMessageTemplatesRequest {
|
|
7432
|
-
/**
|
|
7433
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
7434
|
-
* @public
|
|
7435
|
-
*/
|
|
7436
|
-
nextToken?: string | undefined;
|
|
7437
|
-
/**
|
|
7438
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7439
|
-
* @public
|
|
7440
|
-
*/
|
|
7441
|
-
maxResults?: number | undefined;
|
|
7442
|
-
/**
|
|
7443
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7444
|
-
* @public
|
|
7445
|
-
*/
|
|
7446
|
-
knowledgeBaseId: string | undefined;
|
|
7447
|
-
}
|
|
7448
|
-
/**
|
|
7449
|
-
* <p>The summary of the message template.</p>
|
|
7450
|
-
* @public
|
|
7451
|
-
*/
|
|
7452
|
-
export interface MessageTemplateSummary {
|
|
7453
|
-
/**
|
|
7454
|
-
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
7455
|
-
* @public
|
|
7456
|
-
*/
|
|
7457
|
-
messageTemplateArn: string | undefined;
|
|
7458
|
-
/**
|
|
7459
|
-
* <p>The identifier of the message template.</p>
|
|
7460
|
-
* @public
|
|
7461
|
-
*/
|
|
7462
|
-
messageTemplateId: string | undefined;
|
|
7463
|
-
/**
|
|
7464
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
7465
|
-
* @public
|
|
7466
|
-
*/
|
|
7467
|
-
knowledgeBaseArn: string | undefined;
|
|
7468
|
-
/**
|
|
7469
|
-
* <p>The identifier of the knowledge base.</p>
|
|
7470
|
-
* @public
|
|
7471
|
-
*/
|
|
7472
|
-
knowledgeBaseId: string | undefined;
|
|
7473
|
-
/**
|
|
7474
|
-
* <p>The name of the message template.</p>
|
|
7475
|
-
* @public
|
|
7476
|
-
*/
|
|
7477
|
-
name: string | undefined;
|
|
7478
|
-
/**
|
|
7479
|
-
* <p>The channel this message template applies to.</p>
|
|
7480
|
-
* @public
|
|
7481
|
-
*/
|
|
7482
|
-
channel?: string | undefined;
|
|
7483
|
-
/**
|
|
7484
|
-
* <p>The channel subtype this message template applies to.</p>
|
|
7485
|
-
* @public
|
|
7486
|
-
*/
|
|
7487
|
-
channelSubtype: ChannelSubtype | undefined;
|
|
7488
|
-
/**
|
|
7489
|
-
* <p>The timestamp when the message template was created.</p>
|
|
7490
|
-
* @public
|
|
7491
|
-
*/
|
|
7492
|
-
createdTime: Date | undefined;
|
|
7493
|
-
/**
|
|
7494
|
-
* <p>The timestamp when the message template data was last modified.</p>
|
|
7495
|
-
* @public
|
|
7496
|
-
*/
|
|
7497
|
-
lastModifiedTime: Date | undefined;
|
|
7498
|
-
/**
|
|
7499
|
-
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
7500
|
-
* @public
|
|
7501
|
-
*/
|
|
7502
|
-
lastModifiedBy: string | undefined;
|
|
7503
|
-
/**
|
|
7504
|
-
* <p>The container of message template source configuration.</p>
|
|
7505
|
-
* @public
|
|
7506
|
-
*/
|
|
7507
|
-
sourceConfiguration?: MessageTemplateSourceConfiguration | undefined;
|
|
7508
|
-
/**
|
|
7509
|
-
* <p>The version number of the message template version that is activated.</p>
|
|
7510
|
-
* @public
|
|
7511
|
-
*/
|
|
7512
|
-
activeVersionNumber?: number | undefined;
|
|
7513
|
-
/**
|
|
7514
|
-
* <p>The description of the message template.</p>
|
|
7515
|
-
* @public
|
|
7516
|
-
*/
|
|
7517
|
-
description?: string | undefined;
|
|
7518
|
-
/**
|
|
7519
|
-
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
7520
|
-
* @public
|
|
7521
|
-
*/
|
|
7522
|
-
tags?: Record<string, string> | undefined;
|
|
7523
|
-
}
|
|
7524
|
-
/**
|
|
7525
|
-
* @public
|
|
7526
|
-
*/
|
|
7527
|
-
export interface ListMessageTemplatesResponse {
|
|
7528
|
-
/**
|
|
7529
|
-
* <p>Summary information about the message template.</p>
|
|
7530
|
-
* @public
|
|
7531
|
-
*/
|
|
7532
|
-
messageTemplateSummaries: MessageTemplateSummary[] | undefined;
|
|
7533
|
-
/**
|
|
7534
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7535
|
-
* @public
|
|
7536
|
-
*/
|
|
7537
|
-
nextToken?: string | undefined;
|
|
7538
|
-
}
|
|
7539
|
-
/**
|
|
7540
|
-
* @public
|
|
7541
|
-
*/
|
|
7542
|
-
export interface ListMessageTemplateVersionsRequest {
|
|
7543
|
-
/**
|
|
7544
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7545
|
-
* @public
|
|
7546
|
-
*/
|
|
7547
|
-
knowledgeBaseId: string | undefined;
|
|
7548
|
-
/**
|
|
7549
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
7550
|
-
* @public
|
|
7551
|
-
*/
|
|
7552
|
-
messageTemplateId: string | undefined;
|
|
7553
|
-
/**
|
|
7554
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
7555
|
-
* @public
|
|
7556
|
-
*/
|
|
7557
|
-
nextToken?: string | undefined;
|
|
7558
|
-
/**
|
|
7559
|
-
* <p>The maximum number of results to return per page.</p>
|
|
7560
|
-
* @public
|
|
7561
|
-
*/
|
|
7562
|
-
maxResults?: number | undefined;
|
|
7563
|
-
}
|
|
7564
|
-
/**
|
|
7565
|
-
* <p>The summary of the message template version.</p>
|
|
7566
|
-
* @public
|
|
7567
|
-
*/
|
|
7568
|
-
export interface MessageTemplateVersionSummary {
|
|
7569
|
-
/**
|
|
7570
|
-
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
7571
|
-
* @public
|
|
7572
|
-
*/
|
|
7573
|
-
messageTemplateArn: string | undefined;
|
|
7574
|
-
/**
|
|
7575
|
-
* <p>The identifier of the message template.</p>
|
|
7576
|
-
* @public
|
|
7577
|
-
*/
|
|
7578
|
-
messageTemplateId: string | undefined;
|
|
7579
|
-
/**
|
|
7580
|
-
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
7581
|
-
* @public
|
|
7582
|
-
*/
|
|
7583
|
-
knowledgeBaseArn: string | undefined;
|
|
7584
|
-
/**
|
|
7585
|
-
* <p>The identifier of the knowledge base.</p>
|
|
7586
|
-
* @public
|
|
7587
|
-
*/
|
|
7588
|
-
knowledgeBaseId: string | undefined;
|
|
7589
|
-
/**
|
|
7590
|
-
* <p>The name of the message template.</p>
|
|
7591
|
-
* @public
|
|
7592
|
-
*/
|
|
7593
|
-
name: string | undefined;
|
|
7594
|
-
/**
|
|
7595
|
-
* <p>The channel of the message template.</p>
|
|
7596
|
-
* @public
|
|
7597
|
-
*/
|
|
7598
|
-
channel?: string | undefined;
|
|
7599
|
-
/**
|
|
7600
|
-
* <p>The channel subtype this message template applies to.</p>
|
|
7601
|
-
* @public
|
|
7602
|
-
*/
|
|
7603
|
-
channelSubtype: ChannelSubtype | undefined;
|
|
7604
|
-
/**
|
|
7605
|
-
* <p>Whether the version of the message template is activated.</p>
|
|
7606
|
-
* @public
|
|
7607
|
-
*/
|
|
7608
|
-
isActive: boolean | undefined;
|
|
7609
|
-
/**
|
|
7610
|
-
* <p>The version number of the message template version.</p>
|
|
7611
|
-
* @public
|
|
7612
|
-
*/
|
|
7613
|
-
versionNumber: number | undefined;
|
|
7614
|
-
}
|
|
7615
|
-
/**
|
|
7616
|
-
* @public
|
|
7617
|
-
*/
|
|
7618
|
-
export interface ListMessageTemplateVersionsResponse {
|
|
7619
|
-
/**
|
|
7620
|
-
* <p>Summary information about the versions of a message template.</p>
|
|
7621
|
-
* @public
|
|
7622
|
-
*/
|
|
7623
|
-
messageTemplateVersionSummaries: MessageTemplateVersionSummary[] | undefined;
|
|
7624
|
-
/**
|
|
7625
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
7626
|
-
* @public
|
|
7627
|
-
*/
|
|
7628
|
-
nextToken?: string | undefined;
|
|
7629
|
-
}
|
|
7630
|
-
/**
|
|
7631
|
-
* @public
|
|
7632
|
-
*/
|
|
7633
|
-
export interface RenderMessageTemplateRequest {
|
|
7634
|
-
/**
|
|
7635
|
-
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
7636
|
-
* @public
|
|
7637
|
-
*/
|
|
7638
|
-
knowledgeBaseId: string | undefined;
|
|
7639
|
-
/**
|
|
7640
|
-
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
7641
|
-
* @public
|
|
7642
|
-
*/
|
|
7643
|
-
messageTemplateId: string | undefined;
|
|
7644
|
-
/**
|
|
7645
|
-
* <p>An object that specifies the 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 value for that variable.</p>
|
|
7646
|
-
* @public
|
|
7647
|
-
*/
|
|
7648
|
-
attributes: MessageTemplateAttributes | undefined;
|
|
7649
|
-
}
|