@aws-sdk/client-qconnect 3.899.0 → 3.903.0

package/dist-types/models/models_1.d.ts

@@ -1,6 +1,208 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
-import { ChannelSubtype, Configuration, ContentDataDetails, ContentSummary, DataReference, Document, GroupingConfiguration, IntentDetectedDataDetails, KnowledgeBaseData, KnowledgeBaseStatus, KnowledgeBaseType, MessageTemplateAttachment, MessageTemplateAttributes, MessageTemplateAttributeType, MessageTemplateContentProvider, MessageTemplateData, QueryResultType, RankingData, RecommendationTrigger, RecommendationType, RelevanceLevel, RenderingConfiguration, SearchExpression, ServerSideEncryptionConfiguration, SourceConfiguration, SourceContentDataDetails, VectorIngestionConfiguration } from "./models_0";
+import { ChannelSubtype, Configuration, ContentDataDetails, ContentDisposition, ContentSummary, DataReference, Document, EmailOverviewChunkDataDetails, EmailResponseChunkDataDetails, GroupingConfiguration, IntentDetectedDataDetails, KnowledgeBaseData, KnowledgeBaseStatus, KnowledgeBaseType, MessageTemplateAttributes, MessageTemplateAttributeType, MessageTemplateContentProvider, QueryResultType, RankingData, RecommendationTrigger, RecommendationType, RelevanceLevel, RenderingConfiguration, SearchExpression, ServerSideEncryptionConfiguration, SourceConfiguration, SourceContentDataDetails, VectorIngestionConfiguration } from "./models_0";
 import { QConnectServiceException as __BaseException } from "./QConnectServiceException";
+/**
+ * <p>The data of a message template.</p>
+ * @public
+ */
+export interface MessageTemplateData {
+    /**
+     * <p>The Amazon Resource Name (ARN) of the message template.</p>
+     * @public
+     */
+    messageTemplateArn: string | undefined;
+    /**
+     * <p>The identifier of the message template.</p>
+     * @public
+     */
+    messageTemplateId: string | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
+     * @public
+     */
+    knowledgeBaseArn: string | undefined;
+    /**
+     * <p>The identifier of the knowledge base.</p>
+     * @public
+     */
+    knowledgeBaseId: string | undefined;
+    /**
+     * <p>The name of the message template.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The channel subtype this message template applies to.</p>
+     * @public
+     */
+    channelSubtype: ChannelSubtype | undefined;
+    /**
+     * <p>The timestamp when the message template was created.</p>
+     * @public
+     */
+    createdTime: Date | undefined;
+    /**
+     * <p>The timestamp when the message template data was last modified.</p>
+     * @public
+     */
+    lastModifiedTime: Date | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
+     * @public
+     */
+    lastModifiedBy: string | undefined;
+    /**
+     * <p>The content of the message template.</p>
+     * @public
+     */
+    content: MessageTemplateContentProvider | undefined;
+    /**
+     * <p>The description of the message template.</p>
+     * @public
+     */
+    description?: string | undefined;
+    /**
+     * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>, <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>, <code>zh_CN</code>, <code>zh_TW</code> </p>
+     * @public
+     */
+    language?: string | undefined;
+    /**
+     * <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
+     * @public
+     */
+    groupingConfiguration?: GroupingConfiguration | undefined;
+    /**
+     * <p>An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.</p>
+     * @public
+     */
+    defaultAttributes?: MessageTemplateAttributes | undefined;
+    /**
+     * <p>The types of attributes that the message template contains.</p>
+     * @public
+     */
+    attributeTypes?: MessageTemplateAttributeType[] | undefined;
+    /**
+     * <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template.</p>
+     * @public
+     */
+    messageTemplateContentSha256: string | undefined;
+    /**
+     * <p>The tags used to organize, track, or control access for this resource.</p>
+     * @public
+     */
+    tags?: Record<string, string> | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateMessageTemplateResponse {
+    /**
+     * <p>The message template.</p>
+     * @public
+     */
+    messageTemplate?: MessageTemplateData | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateMessageTemplateAttachmentRequest {
+    /**
+     * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
+     * @public
+     */
+    knowledgeBaseId: string | undefined;
+    /**
+     * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
+     * @public
+     */
+    messageTemplateId: string | undefined;
+    /**
+     * <p>The presentation information for the attachment file.</p>
+     * @public
+     */
+    contentDisposition: ContentDisposition | undefined;
+    /**
+     * <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The body of the attachment file being uploaded. It should be encoded using base64 encoding.</p>
+     * @public
+     */
+    body: string | undefined;
+    /**
+     * <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>
+     * @public
+     */
+    clientToken?: string | undefined;
+}
+/**
+ * <p>Information about the message template attachment.</p>
+ * @public
+ */
+export interface MessageTemplateAttachment {
+    /**
+     * <p>The presentation information for the attachment file.</p>
+     * @public
+     */
+    contentDisposition: ContentDisposition | undefined;
+    /**
+     * <p>The name of the attachment file being uploaded. The name should include the file extension.</p>
+     * @public
+     */
+    name: string | undefined;
+    /**
+     * <p>The timestamp when the attachment file was uploaded.</p>
+     * @public
+     */
+    uploadedTime: Date | undefined;
+    /**
+     * <p>A pre-signed Amazon S3 URL that can be used to download the attachment file.</p>
+     * @public
+     */
+    url: string | undefined;
+    /**
+     * <p>The expiration time of the pre-signed Amazon S3 URL.</p>
+     * @public
+     */
+    urlExpiry: Date | undefined;
+    /**
+     * <p>The identifier of the attachment file.</p>
+     * @public
+     */
+    attachmentId: string | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateMessageTemplateAttachmentResponse {
+    /**
+     * <p>The message template attachment.</p>
+     * @public
+     */
+    attachment?: MessageTemplateAttachment | undefined;
+}
+/**
+ * @public
+ */
+export interface CreateMessageTemplateVersionRequest {
+    /**
+     * <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
+     * @public
+     */
+    knowledgeBaseId: string | undefined;
+    /**
+     * <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
+     * @public
+     */
+    messageTemplateId: string | undefined;
+    /**
+     * <p>The checksum value of the message template content that is referenced by the <code>$LATEST</code> qualifier. It can be returned in <code>MessageTemplateData</code> or <code>ExtendedMessageTemplateData</code>. It’s calculated by content, language, <code>defaultAttributes</code> and <code>Attachments</code> of the message template. If not supplied, the message template version will be created based on the message template content that is referenced by the <code>$LATEST</code> qualifier by default.</p>
+     * @public
+     */
+    messageTemplateContentSha256?: string | undefined;
+}
 /**
  * <p>The extended data of a message template.</p>
  * @public
@@ -2211,7 +2413,7 @@ export interface UntagResourceResponse {
  * <p>Details about the data.</p>
  * @public
  */
-export type DataDetails = DataDetails.ContentDataMember | DataDetails.GenerativeChunkDataMember | DataDetails.GenerativeDataMember | DataDetails.IntentDetectedDataMember | DataDetails.SourceContentDataMember | DataDetails.$UnknownMember;
+export type DataDetails = DataDetails.ContentDataMember | DataDetails.EmailGenerativeAnswerChunkDataMember | DataDetails.EmailOverviewChunkDataMember | DataDetails.EmailResponseChunkDataMember | DataDetails.GenerativeChunkDataMember | DataDetails.GenerativeDataMember | DataDetails.IntentDetectedDataMember | DataDetails.SourceContentDataMember | DataDetails.$UnknownMember;
 /**
  * @public
  */
@@ -2226,6 +2428,9 @@ export declare namespace DataDetails {
         intentDetectedData?: never;
         sourceContentData?: never;
         generativeChunkData?: never;
+        emailResponseChunkData?: never;
+        emailOverviewChunkData?: never;
+        emailGenerativeAnswerChunkData?: never;
         $unknown?: never;
     }
     /**
@@ -2238,6 +2443,9 @@ export declare namespace DataDetails {
         intentDetectedData?: never;
         sourceContentData?: never;
         generativeChunkData?: never;
+        emailResponseChunkData?: never;
+        emailOverviewChunkData?: never;
+        emailGenerativeAnswerChunkData?: never;
         $unknown?: never;
     }
     /**
@@ -2250,6 +2458,9 @@ export declare namespace DataDetails {
         intentDetectedData: IntentDetectedDataDetails;
         sourceContentData?: never;
         generativeChunkData?: never;
+        emailResponseChunkData?: never;
+        emailOverviewChunkData?: never;
+        emailGenerativeAnswerChunkData?: never;
         $unknown?: never;
     }
     /**
@@ -2262,6 +2473,9 @@ export declare namespace DataDetails {
         intentDetectedData?: never;
         sourceContentData: SourceContentDataDetails;
         generativeChunkData?: never;
+        emailResponseChunkData?: never;
+        emailOverviewChunkData?: never;
+        emailGenerativeAnswerChunkData?: never;
         $unknown?: never;
     }
     /**
@@ -2274,6 +2488,54 @@ export declare namespace DataDetails {
         intentDetectedData?: never;
         sourceContentData?: never;
         generativeChunkData: GenerativeChunkDataDetails;
+        emailResponseChunkData?: never;
+        emailOverviewChunkData?: never;
+        emailGenerativeAnswerChunkData?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Streaming chunk data for email response generation containing partial response content.</p>
+     * @public
+     */
+    interface EmailResponseChunkDataMember {
+        contentData?: never;
+        generativeData?: never;
+        intentDetectedData?: never;
+        sourceContentData?: never;
+        generativeChunkData?: never;
+        emailResponseChunkData: EmailResponseChunkDataDetails;
+        emailOverviewChunkData?: never;
+        emailGenerativeAnswerChunkData?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Streaming chunk data for email overview containing partial overview content.</p>
+     * @public
+     */
+    interface EmailOverviewChunkDataMember {
+        contentData?: never;
+        generativeData?: never;
+        intentDetectedData?: never;
+        sourceContentData?: never;
+        generativeChunkData?: never;
+        emailResponseChunkData?: never;
+        emailOverviewChunkData: EmailOverviewChunkDataDetails;
+        emailGenerativeAnswerChunkData?: never;
+        $unknown?: never;
+    }
+    /**
+     * <p>Streaming chunk data for email generative answers containing partial knowledge-based response content.</p>
+     * @public
+     */
+    interface EmailGenerativeAnswerChunkDataMember {
+        contentData?: never;
+        generativeData?: never;
+        intentDetectedData?: never;
+        sourceContentData?: never;
+        generativeChunkData?: never;
+        emailResponseChunkData?: never;
+        emailOverviewChunkData?: never;
+        emailGenerativeAnswerChunkData: EmailGenerativeAnswerChunkDataDetails;
         $unknown?: never;
     }
     /**
@@ -2285,6 +2547,9 @@ export declare namespace DataDetails {
         intentDetectedData?: never;
         sourceContentData?: never;
         generativeChunkData?: never;
+        emailResponseChunkData?: never;
+        emailOverviewChunkData?: never;
+        emailGenerativeAnswerChunkData?: never;
         $unknown: [string, any];
     }
     interface Visitor<T> {
@@ -2293,6 +2558,9 @@ export declare namespace DataDetails {
         intentDetectedData: (value: IntentDetectedDataDetails) => T;
         sourceContentData: (value: SourceContentDataDetails) => T;
         generativeChunkData: (value: GenerativeChunkDataDetails) => T;
+        emailResponseChunkData: (value: EmailResponseChunkDataDetails) => T;
+        emailOverviewChunkData: (value: EmailOverviewChunkDataDetails) => T;
+        emailGenerativeAnswerChunkData: (value: EmailGenerativeAnswerChunkDataDetails) => T;
         _: (name: string, value: any) => T;
     }
     const visit: <T>(value: DataDetails, visitor: Visitor<T>) => T;
@@ -2313,6 +2581,27 @@ export interface DataSummary {
      */
     details: DataDetails | undefined;
 }
+/**
+ * <p>Details of streaming chunk data for email generative answers including completion text and references.</p>
+ * @public
+ */
+export interface EmailGenerativeAnswerChunkDataDetails {
+    /**
+     * <p>The partial or complete text content of the generative answer response.</p>
+     * @public
+     */
+    completion?: string | undefined;
+    /**
+     * <p>Source references and citations from knowledge base articles used to generate the answer.</p>
+     * @public
+     */
+    references?: DataSummary[] | undefined;
+    /**
+     * <p>Token for retrieving the next chunk of streaming response data, if available.</p>
+     * @public
+     */
+    nextChunkToken?: string | undefined;
+}
 /**
  * <p>Details about the generative chunk data.</p>
  * @public
@@ -2452,6 +2741,26 @@ export interface QueryAssistantResponse {
      */
     nextToken?: string | undefined;
 }
+/**
+ * @internal
+ */
+export declare const MessageTemplateDataFilterSensitiveLog: (obj: MessageTemplateData) => any;
+/**
+ * @internal
+ */
+export declare const CreateMessageTemplateResponseFilterSensitiveLog: (obj: CreateMessageTemplateResponse) => any;
+/**
+ * @internal
+ */
+export declare const CreateMessageTemplateAttachmentRequestFilterSensitiveLog: (obj: CreateMessageTemplateAttachmentRequest) => any;
+/**
+ * @internal
+ */
+export declare const MessageTemplateAttachmentFilterSensitiveLog: (obj: MessageTemplateAttachment) => any;
+/**
+ * @internal
+ */
+export declare const CreateMessageTemplateAttachmentResponseFilterSensitiveLog: (obj: CreateMessageTemplateAttachmentResponse) => any;
 /**
  * @internal
  */
@@ -2592,6 +2901,10 @@ export declare const DataDetailsFilterSensitiveLog: (obj: DataDetails) => any;
  * @internal
  */
 export declare const DataSummaryFilterSensitiveLog: (obj: DataSummary) => any;
+/**
+ * @internal
+ */
+export declare const EmailGenerativeAnswerChunkDataDetailsFilterSensitiveLog: (obj: EmailGenerativeAnswerChunkDataDetails) => any;
 /**
  * @internal
  */

package/dist-types/ts3.4/commands/CreateMessageTemplateAttachmentCommand.d.ts

@@ -3,7 +3,7 @@ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
 import {
   CreateMessageTemplateAttachmentRequest,
   CreateMessageTemplateAttachmentResponse,
-} from "../models/models_0";
+} from "../models/models_1";
 import {
   QConnectClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/CreateMessageTemplateCommand.d.ts

@@ -1,9 +1,7 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import {
-  CreateMessageTemplateRequest,
-  CreateMessageTemplateResponse,
-} from "../models/models_0";
+import { CreateMessageTemplateRequest } from "../models/models_0";
+import { CreateMessageTemplateResponse } from "../models/models_1";
 import {
   QConnectClientResolvedConfig,
   ServiceInputTypes,

package/dist-types/ts3.4/commands/CreateMessageTemplateVersionCommand.d.ts

@@ -1,7 +1,9 @@
 import { Command as $Command } from "@smithy/smithy-client";
 import { MetadataBearer as __MetadataBearer } from "@smithy/types";
-import { CreateMessageTemplateVersionRequest } from "../models/models_0";
-import { CreateMessageTemplateVersionResponse } from "../models/models_1";
+import {
+  CreateMessageTemplateVersionRequest,
+  CreateMessageTemplateVersionResponse,
+} from "../models/models_1";
 import {
   QConnectClientResolvedConfig,
   ServiceInputTypes,