@aws-sdk/client-qconnect 3.699.0 → 3.709.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 +88 -0
- package/dist-cjs/index.js +1188 -127
- package/dist-es/QConnect.js +22 -0
- package/dist-es/commands/CreateAIGuardrailCommand.js +23 -0
- package/dist-es/commands/CreateAIGuardrailVersionCommand.js +23 -0
- package/dist-es/commands/CreateQuickResponseCommand.js +1 -1
- package/dist-es/commands/DeleteAIGuardrailCommand.js +22 -0
- package/dist-es/commands/DeleteAIGuardrailVersionCommand.js +22 -0
- package/dist-es/commands/GetAIGuardrailCommand.js +23 -0
- package/dist-es/commands/GetImportJobCommand.js +1 -1
- package/dist-es/commands/GetKnowledgeBaseCommand.js +1 -1
- package/dist-es/commands/GetMessageTemplateCommand.js +1 -1
- package/dist-es/commands/GetNextMessageCommand.js +23 -0
- package/dist-es/commands/GetQuickResponseCommand.js +1 -1
- package/dist-es/commands/ListAIGuardrailVersionsCommand.js +23 -0
- package/dist-es/commands/ListAIGuardrailsCommand.js +23 -0
- package/dist-es/commands/ListKnowledgeBasesCommand.js +1 -1
- package/dist-es/commands/ListMessagesCommand.js +23 -0
- package/dist-es/commands/ListQuickResponsesCommand.js +1 -1
- package/dist-es/commands/RenderMessageTemplateCommand.js +1 -1
- package/dist-es/commands/SendMessageCommand.js +23 -0
- package/dist-es/commands/UpdateAIGuardrailCommand.js +23 -0
- package/dist-es/commands/UpdateMessageTemplateCommand.js +1 -1
- package/dist-es/commands/UpdateMessageTemplateMetadataCommand.js +1 -1
- package/dist-es/commands/UpdateQuickResponseCommand.js +1 -1
- package/dist-es/commands/index.js +11 -0
- package/dist-es/models/models_0.js +310 -166
- package/dist-es/models/models_1.js +167 -1
- package/dist-es/pagination/ListAIGuardrailVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListAIGuardrailsPaginator.js +4 -0
- package/dist-es/pagination/ListMessagesPaginator.js +4 -0
- package/dist-es/pagination/index.js +3 -0
- package/dist-es/protocols/Aws_restJson1.js +443 -1
- package/dist-types/QConnect.d.ts +77 -0
- package/dist-types/QConnectClient.d.ts +13 -2
- package/dist-types/commands/CreateAIAgentCommand.d.ts +62 -0
- package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +31 -0
- package/dist-types/commands/CreateAIGuardrailCommand.d.ts +231 -0
- package/dist-types/commands/CreateAIGuardrailVersionCommand.d.ts +169 -0
- package/dist-types/commands/CreateQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/DeactivateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAIGuardrailCommand.d.ts +88 -0
- package/dist-types/commands/DeleteAIGuardrailVersionCommand.d.ts +89 -0
- 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 +31 -0
- package/dist-types/commands/GetAIGuardrailCommand.d.ts +157 -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 +4 -3
- package/dist-types/commands/GetNextMessageCommand.d.ts +106 -0
- package/dist-types/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +31 -0
- package/dist-types/commands/ListAIAgentsCommand.d.ts +31 -0
- package/dist-types/commands/ListAIGuardrailVersionsCommand.d.ts +105 -0
- package/dist-types/commands/ListAIGuardrailsCommand.d.ts +101 -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 +95 -0
- package/dist-types/commands/ListQuickResponsesCommand.d.ts +1 -1
- package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +1 -2
- package/dist-types/commands/RenderMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/SendMessageCommand.d.ts +114 -0
- package/dist-types/commands/UpdateAIAgentCommand.d.ts +62 -0
- package/dist-types/commands/UpdateAIGuardrailCommand.d.ts +224 -0
- package/dist-types/commands/UpdateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/UpdateMessageTemplateMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +11 -0
- package/dist-types/models/models_0.d.ts +3820 -3619
- package/dist-types/models/models_1.d.ts +1513 -1
- package/dist-types/pagination/ListAIGuardrailVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAIGuardrailsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListMessagesPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +3 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +99 -0
- package/dist-types/ts3.4/QConnect.d.ts +187 -0
- package/dist-types/ts3.4/QConnectClient.d.ts +66 -0
- package/dist-types/ts3.4/commands/CreateAIGuardrailCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateAIGuardrailVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeactivateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteAIGuardrailCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteAIGuardrailVersionCommand.d.ts +51 -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/GetAIGuardrailCommand.d.ts +50 -0
- 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/GetNextMessageCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAIGuardrailVersionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListAIGuardrailsCommand.d.ts +50 -0
- 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/ListMessagesCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListQuickResponsesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/RenderMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/SendMessageCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/UpdateAIGuardrailCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateMessageTemplateMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +11 -0
- package/dist-types/ts3.4/models/models_0.d.ts +482 -441
- package/dist-types/ts3.4/models/models_1.d.ts +437 -5
- package/dist-types/ts3.4/pagination/ListAIGuardrailVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAIGuardrailsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListMessagesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +3 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +132 -0
- package/package.json +35 -35
|
@@ -1,6 +1,1426 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
-
import { ChannelSubtype, ContentDataDetails, ContentSummary, DataReference, Document,
|
|
2
|
+
import { ChannelSubtype, Configuration, ContentDataDetails, ContentSummary, DataReference, Document, ExtendedMessageTemplateData, GroupingConfiguration, IntentDetectedDataDetails, KnowledgeBaseData, KnowledgeBaseStatus, KnowledgeBaseType, MessageTemplateAttachment, MessageTemplateAttributes, MessageTemplateContentProvider, MessageTemplateData, QueryResultType, RankingData, RecommendationTrigger, RecommendationType, RelevanceLevel, RenderingConfiguration, SearchExpression, ServerSideEncryptionConfiguration, SourceConfiguration, SourceContentDataDetails, VectorIngestionConfiguration } from "./models_0";
|
|
3
3
|
import { QConnectServiceException as __BaseException } from "./QConnectServiceException";
|
|
4
|
+
/**
|
|
5
|
+
* <p>The container of quick response data.</p>
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember | QuickResponseDataProvider.$UnknownMember;
|
|
9
|
+
/**
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
export declare namespace QuickResponseDataProvider {
|
|
13
|
+
/**
|
|
14
|
+
* <p>The content of the quick response.</p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
interface ContentMember {
|
|
18
|
+
content: string;
|
|
19
|
+
$unknown?: never;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
interface $UnknownMember {
|
|
25
|
+
content?: never;
|
|
26
|
+
$unknown: [string, any];
|
|
27
|
+
}
|
|
28
|
+
interface Visitor<T> {
|
|
29
|
+
content: (value: string) => T;
|
|
30
|
+
_: (name: string, value: any) => T;
|
|
31
|
+
}
|
|
32
|
+
const visit: <T>(value: QuickResponseDataProvider, visitor: Visitor<T>) => T;
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* @public
|
|
36
|
+
*/
|
|
37
|
+
export interface CreateQuickResponseRequest {
|
|
38
|
+
/**
|
|
39
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
40
|
+
* @public
|
|
41
|
+
*/
|
|
42
|
+
knowledgeBaseId: string | undefined;
|
|
43
|
+
/**
|
|
44
|
+
* <p>The name of the quick response.</p>
|
|
45
|
+
* @public
|
|
46
|
+
*/
|
|
47
|
+
name: string | undefined;
|
|
48
|
+
/**
|
|
49
|
+
* <p>The content of the quick response.</p>
|
|
50
|
+
* @public
|
|
51
|
+
*/
|
|
52
|
+
content: QuickResponseDataProvider | undefined;
|
|
53
|
+
/**
|
|
54
|
+
* <p>The media type of the quick response content.</p>
|
|
55
|
+
* <ul>
|
|
56
|
+
* <li>
|
|
57
|
+
* <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written
|
|
58
|
+
* in plain text.</p>
|
|
59
|
+
* </li>
|
|
60
|
+
* <li>
|
|
61
|
+
* <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response
|
|
62
|
+
* written in richtext.</p>
|
|
63
|
+
* </li>
|
|
64
|
+
* </ul>
|
|
65
|
+
* @public
|
|
66
|
+
*/
|
|
67
|
+
contentType?: string | undefined;
|
|
68
|
+
/**
|
|
69
|
+
* <p>The configuration information of the user groups that the quick response is accessible
|
|
70
|
+
* to.</p>
|
|
71
|
+
* @public
|
|
72
|
+
*/
|
|
73
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
74
|
+
/**
|
|
75
|
+
* <p>The description of the quick response.</p>
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
description?: string | undefined;
|
|
79
|
+
/**
|
|
80
|
+
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
81
|
+
* knowledge base. </p>
|
|
82
|
+
* @public
|
|
83
|
+
*/
|
|
84
|
+
shortcutKey?: string | undefined;
|
|
85
|
+
/**
|
|
86
|
+
* <p>Whether the quick response is active.</p>
|
|
87
|
+
* @public
|
|
88
|
+
*/
|
|
89
|
+
isActive?: boolean | undefined;
|
|
90
|
+
/**
|
|
91
|
+
* <p>The Amazon Connect channels this quick response applies to.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
channels?: string[] | undefined;
|
|
95
|
+
/**
|
|
96
|
+
* <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>,
|
|
97
|
+
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
98
|
+
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
99
|
+
* </p>
|
|
100
|
+
* @public
|
|
101
|
+
*/
|
|
102
|
+
language?: string | undefined;
|
|
103
|
+
/**
|
|
104
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
105
|
+
* request. If not provided, the Amazon Web Services
|
|
106
|
+
* SDK populates this field. For more information about idempotency, see
|
|
107
|
+
* <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
108
|
+
* @public
|
|
109
|
+
*/
|
|
110
|
+
clientToken?: string | undefined;
|
|
111
|
+
/**
|
|
112
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
113
|
+
* @public
|
|
114
|
+
*/
|
|
115
|
+
tags?: Record<string, string> | undefined;
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* <p>The container quick response content.</p>
|
|
119
|
+
* @public
|
|
120
|
+
*/
|
|
121
|
+
export type QuickResponseContentProvider = QuickResponseContentProvider.ContentMember | QuickResponseContentProvider.$UnknownMember;
|
|
122
|
+
/**
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
export declare namespace QuickResponseContentProvider {
|
|
126
|
+
/**
|
|
127
|
+
* <p>The content of the quick response.</p>
|
|
128
|
+
* @public
|
|
129
|
+
*/
|
|
130
|
+
interface ContentMember {
|
|
131
|
+
content: string;
|
|
132
|
+
$unknown?: never;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* @public
|
|
136
|
+
*/
|
|
137
|
+
interface $UnknownMember {
|
|
138
|
+
content?: never;
|
|
139
|
+
$unknown: [string, any];
|
|
140
|
+
}
|
|
141
|
+
interface Visitor<T> {
|
|
142
|
+
content: (value: string) => T;
|
|
143
|
+
_: (name: string, value: any) => T;
|
|
144
|
+
}
|
|
145
|
+
const visit: <T>(value: QuickResponseContentProvider, visitor: Visitor<T>) => T;
|
|
146
|
+
}
|
|
147
|
+
/**
|
|
148
|
+
* <p>The content of the quick response stored in different media types.</p>
|
|
149
|
+
* @public
|
|
150
|
+
*/
|
|
151
|
+
export interface QuickResponseContents {
|
|
152
|
+
/**
|
|
153
|
+
* <p>The container quick response content.</p>
|
|
154
|
+
* @public
|
|
155
|
+
*/
|
|
156
|
+
plainText?: QuickResponseContentProvider | undefined;
|
|
157
|
+
/**
|
|
158
|
+
* <p>The container quick response content.</p>
|
|
159
|
+
* @public
|
|
160
|
+
*/
|
|
161
|
+
markdown?: QuickResponseContentProvider | undefined;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* @public
|
|
165
|
+
* @enum
|
|
166
|
+
*/
|
|
167
|
+
export declare const QuickResponseStatus: {
|
|
168
|
+
readonly CREATED: "CREATED";
|
|
169
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
170
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
171
|
+
readonly DELETED: "DELETED";
|
|
172
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
173
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
174
|
+
readonly UPDATE_FAILED: "UPDATE_FAILED";
|
|
175
|
+
readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
|
|
176
|
+
};
|
|
177
|
+
/**
|
|
178
|
+
* @public
|
|
179
|
+
*/
|
|
180
|
+
export type QuickResponseStatus = (typeof QuickResponseStatus)[keyof typeof QuickResponseStatus];
|
|
181
|
+
/**
|
|
182
|
+
* <p>Information about the quick response.</p>
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
185
|
+
export interface QuickResponseData {
|
|
186
|
+
/**
|
|
187
|
+
* <p>The Amazon Resource Name (ARN) of the quick response.</p>
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
quickResponseArn: string | undefined;
|
|
191
|
+
/**
|
|
192
|
+
* <p>The identifier of the quick response.</p>
|
|
193
|
+
* @public
|
|
194
|
+
*/
|
|
195
|
+
quickResponseId: string | undefined;
|
|
196
|
+
/**
|
|
197
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
198
|
+
* @public
|
|
199
|
+
*/
|
|
200
|
+
knowledgeBaseArn: string | undefined;
|
|
201
|
+
/**
|
|
202
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
203
|
+
* @public
|
|
204
|
+
*/
|
|
205
|
+
knowledgeBaseId: string | undefined;
|
|
206
|
+
/**
|
|
207
|
+
* <p>The name of the quick response.</p>
|
|
208
|
+
* @public
|
|
209
|
+
*/
|
|
210
|
+
name: string | undefined;
|
|
211
|
+
/**
|
|
212
|
+
* <p>The media type of the quick response content.</p>
|
|
213
|
+
* <ul>
|
|
214
|
+
* <li>
|
|
215
|
+
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
216
|
+
* in plain text.</p>
|
|
217
|
+
* </li>
|
|
218
|
+
* <li>
|
|
219
|
+
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
220
|
+
* written in richtext.</p>
|
|
221
|
+
* </li>
|
|
222
|
+
* </ul>
|
|
223
|
+
* @public
|
|
224
|
+
*/
|
|
225
|
+
contentType: string | undefined;
|
|
226
|
+
/**
|
|
227
|
+
* <p>The status of the quick response data.</p>
|
|
228
|
+
* @public
|
|
229
|
+
*/
|
|
230
|
+
status: QuickResponseStatus | undefined;
|
|
231
|
+
/**
|
|
232
|
+
* <p>The timestamp when the quick response was created.</p>
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
235
|
+
createdTime: Date | undefined;
|
|
236
|
+
/**
|
|
237
|
+
* <p>The timestamp when the quick response data was last modified.</p>
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
240
|
+
lastModifiedTime: Date | undefined;
|
|
241
|
+
/**
|
|
242
|
+
* <p>The contents of the quick response.</p>
|
|
243
|
+
* @public
|
|
244
|
+
*/
|
|
245
|
+
contents?: QuickResponseContents | undefined;
|
|
246
|
+
/**
|
|
247
|
+
* <p>The description of the quick response.</p>
|
|
248
|
+
* @public
|
|
249
|
+
*/
|
|
250
|
+
description?: string | undefined;
|
|
251
|
+
/**
|
|
252
|
+
* <p>The configuration information of the user groups that the quick response is accessible
|
|
253
|
+
* to.</p>
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
257
|
+
/**
|
|
258
|
+
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
259
|
+
* knowledge base.</p>
|
|
260
|
+
* @public
|
|
261
|
+
*/
|
|
262
|
+
shortcutKey?: string | undefined;
|
|
263
|
+
/**
|
|
264
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
|
|
265
|
+
* data.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
lastModifiedBy?: string | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* <p>Whether the quick response is active.</p>
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
isActive?: boolean | undefined;
|
|
274
|
+
/**
|
|
275
|
+
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
276
|
+
* The supported contact channel types include <code>Chat</code>.</p>
|
|
277
|
+
* @public
|
|
278
|
+
*/
|
|
279
|
+
channels?: string[] | undefined;
|
|
280
|
+
/**
|
|
281
|
+
* <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>,
|
|
282
|
+
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
283
|
+
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
284
|
+
* </p>
|
|
285
|
+
* @public
|
|
286
|
+
*/
|
|
287
|
+
language?: string | undefined;
|
|
288
|
+
/**
|
|
289
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
290
|
+
* @public
|
|
291
|
+
*/
|
|
292
|
+
tags?: Record<string, string> | undefined;
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* @public
|
|
296
|
+
*/
|
|
297
|
+
export interface CreateQuickResponseResponse {
|
|
298
|
+
/**
|
|
299
|
+
* <p>The quick response.</p>
|
|
300
|
+
* @public
|
|
301
|
+
*/
|
|
302
|
+
quickResponse?: QuickResponseData | undefined;
|
|
303
|
+
}
|
|
304
|
+
/**
|
|
305
|
+
* @public
|
|
306
|
+
*/
|
|
307
|
+
export interface DeactivateMessageTemplateRequest {
|
|
308
|
+
/**
|
|
309
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
310
|
+
* the ARN.</p>
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
knowledgeBaseId: string | undefined;
|
|
314
|
+
/**
|
|
315
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
|
|
316
|
+
* any qualifier.</p>
|
|
317
|
+
* @public
|
|
318
|
+
*/
|
|
319
|
+
messageTemplateId: string | undefined;
|
|
320
|
+
/**
|
|
321
|
+
* <p>The version number of the message template version to deactivate.</p>
|
|
322
|
+
* @public
|
|
323
|
+
*/
|
|
324
|
+
versionNumber: number | undefined;
|
|
325
|
+
}
|
|
326
|
+
/**
|
|
327
|
+
* @public
|
|
328
|
+
*/
|
|
329
|
+
export interface DeactivateMessageTemplateResponse {
|
|
330
|
+
/**
|
|
331
|
+
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
332
|
+
* @public
|
|
333
|
+
*/
|
|
334
|
+
messageTemplateArn: string | undefined;
|
|
335
|
+
/**
|
|
336
|
+
* <p>The identifier of the message template.</p>
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
339
|
+
messageTemplateId: string | undefined;
|
|
340
|
+
/**
|
|
341
|
+
* <p>The version number of the message template version that has been deactivated.</p>
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
versionNumber: number | undefined;
|
|
345
|
+
}
|
|
346
|
+
/**
|
|
347
|
+
* @public
|
|
348
|
+
*/
|
|
349
|
+
export interface DeleteImportJobRequest {
|
|
350
|
+
/**
|
|
351
|
+
* <p>The identifier of the knowledge base.</p>
|
|
352
|
+
* @public
|
|
353
|
+
*/
|
|
354
|
+
knowledgeBaseId: string | undefined;
|
|
355
|
+
/**
|
|
356
|
+
* <p>The identifier of the import job to be deleted.</p>
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
importJobId: string | undefined;
|
|
360
|
+
}
|
|
361
|
+
/**
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
export interface DeleteImportJobResponse {
|
|
365
|
+
}
|
|
366
|
+
/**
|
|
367
|
+
* @public
|
|
368
|
+
*/
|
|
369
|
+
export interface DeleteKnowledgeBaseRequest {
|
|
370
|
+
/**
|
|
371
|
+
* <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
372
|
+
* @public
|
|
373
|
+
*/
|
|
374
|
+
knowledgeBaseId: string | undefined;
|
|
375
|
+
}
|
|
376
|
+
/**
|
|
377
|
+
* @public
|
|
378
|
+
*/
|
|
379
|
+
export interface DeleteKnowledgeBaseResponse {
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
export interface DeleteMessageTemplateRequest {
|
|
385
|
+
/**
|
|
386
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
387
|
+
* the ARN.</p>
|
|
388
|
+
* @public
|
|
389
|
+
*/
|
|
390
|
+
knowledgeBaseId: string | undefined;
|
|
391
|
+
/**
|
|
392
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
393
|
+
* @public
|
|
394
|
+
*/
|
|
395
|
+
messageTemplateId: string | undefined;
|
|
396
|
+
}
|
|
397
|
+
/**
|
|
398
|
+
* @public
|
|
399
|
+
*/
|
|
400
|
+
export interface DeleteMessageTemplateResponse {
|
|
401
|
+
}
|
|
402
|
+
/**
|
|
403
|
+
* @public
|
|
404
|
+
*/
|
|
405
|
+
export interface DeleteMessageTemplateAttachmentRequest {
|
|
406
|
+
/**
|
|
407
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
408
|
+
* the ARN.</p>
|
|
409
|
+
* @public
|
|
410
|
+
*/
|
|
411
|
+
knowledgeBaseId: string | undefined;
|
|
412
|
+
/**
|
|
413
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
|
|
414
|
+
* any qualifier.</p>
|
|
415
|
+
* @public
|
|
416
|
+
*/
|
|
417
|
+
messageTemplateId: string | undefined;
|
|
418
|
+
/**
|
|
419
|
+
* <p>The identifier of the attachment file.</p>
|
|
420
|
+
* @public
|
|
421
|
+
*/
|
|
422
|
+
attachmentId: string | undefined;
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* @public
|
|
426
|
+
*/
|
|
427
|
+
export interface DeleteMessageTemplateAttachmentResponse {
|
|
428
|
+
}
|
|
429
|
+
/**
|
|
430
|
+
* @public
|
|
431
|
+
*/
|
|
432
|
+
export interface DeleteQuickResponseRequest {
|
|
433
|
+
/**
|
|
434
|
+
* <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base.</p>
|
|
435
|
+
* @public
|
|
436
|
+
*/
|
|
437
|
+
knowledgeBaseId: string | undefined;
|
|
438
|
+
/**
|
|
439
|
+
* <p>The identifier of the quick response to delete.</p>
|
|
440
|
+
* @public
|
|
441
|
+
*/
|
|
442
|
+
quickResponseId: string | undefined;
|
|
443
|
+
}
|
|
444
|
+
/**
|
|
445
|
+
* @public
|
|
446
|
+
*/
|
|
447
|
+
export interface DeleteQuickResponseResponse {
|
|
448
|
+
}
|
|
449
|
+
/**
|
|
450
|
+
* @public
|
|
451
|
+
* @enum
|
|
452
|
+
*/
|
|
453
|
+
export declare const ExternalSource: {
|
|
454
|
+
readonly AMAZON_CONNECT: "AMAZON_CONNECT";
|
|
455
|
+
};
|
|
456
|
+
/**
|
|
457
|
+
* @public
|
|
458
|
+
*/
|
|
459
|
+
export type ExternalSource = (typeof ExternalSource)[keyof typeof ExternalSource];
|
|
460
|
+
/**
|
|
461
|
+
* <p>The configuration information of the external data source.</p>
|
|
462
|
+
* @public
|
|
463
|
+
*/
|
|
464
|
+
export interface ExternalSourceConfiguration {
|
|
465
|
+
/**
|
|
466
|
+
* <p>The type of the external data source.</p>
|
|
467
|
+
* @public
|
|
468
|
+
*/
|
|
469
|
+
source: ExternalSource | undefined;
|
|
470
|
+
/**
|
|
471
|
+
* <p>The configuration information of the external data source.</p>
|
|
472
|
+
* @public
|
|
473
|
+
*/
|
|
474
|
+
configuration: Configuration | undefined;
|
|
475
|
+
}
|
|
476
|
+
/**
|
|
477
|
+
* @public
|
|
478
|
+
*/
|
|
479
|
+
export interface GetImportJobRequest {
|
|
480
|
+
/**
|
|
481
|
+
* <p>The identifier of the import job to retrieve.</p>
|
|
482
|
+
* @public
|
|
483
|
+
*/
|
|
484
|
+
importJobId: string | undefined;
|
|
485
|
+
/**
|
|
486
|
+
* <p>The identifier of the knowledge base that the import job belongs to.</p>
|
|
487
|
+
* @public
|
|
488
|
+
*/
|
|
489
|
+
knowledgeBaseId: string | undefined;
|
|
490
|
+
}
|
|
491
|
+
/**
|
|
492
|
+
* @public
|
|
493
|
+
* @enum
|
|
494
|
+
*/
|
|
495
|
+
export declare const ImportJobType: {
|
|
496
|
+
readonly QUICK_RESPONSES: "QUICK_RESPONSES";
|
|
497
|
+
};
|
|
498
|
+
/**
|
|
499
|
+
* @public
|
|
500
|
+
*/
|
|
501
|
+
export type ImportJobType = (typeof ImportJobType)[keyof typeof ImportJobType];
|
|
502
|
+
/**
|
|
503
|
+
* @public
|
|
504
|
+
* @enum
|
|
505
|
+
*/
|
|
506
|
+
export declare const ImportJobStatus: {
|
|
507
|
+
readonly COMPLETE: "COMPLETE";
|
|
508
|
+
readonly DELETED: "DELETED";
|
|
509
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
510
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
511
|
+
readonly FAILED: "FAILED";
|
|
512
|
+
readonly START_IN_PROGRESS: "START_IN_PROGRESS";
|
|
513
|
+
};
|
|
514
|
+
/**
|
|
515
|
+
* @public
|
|
516
|
+
*/
|
|
517
|
+
export type ImportJobStatus = (typeof ImportJobStatus)[keyof typeof ImportJobStatus];
|
|
518
|
+
/**
|
|
519
|
+
* <p>Summary information about the import job.</p>
|
|
520
|
+
* @public
|
|
521
|
+
*/
|
|
522
|
+
export interface ImportJobData {
|
|
523
|
+
/**
|
|
524
|
+
* <p>The identifier of the import job.</p>
|
|
525
|
+
* @public
|
|
526
|
+
*/
|
|
527
|
+
importJobId: string | undefined;
|
|
528
|
+
/**
|
|
529
|
+
* <p>The identifier of the knowledge base.</p>
|
|
530
|
+
* @public
|
|
531
|
+
*/
|
|
532
|
+
knowledgeBaseId: string | undefined;
|
|
533
|
+
/**
|
|
534
|
+
* <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>
|
|
535
|
+
* @public
|
|
536
|
+
*/
|
|
537
|
+
uploadId: string | undefined;
|
|
538
|
+
/**
|
|
539
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
knowledgeBaseArn: string | undefined;
|
|
543
|
+
/**
|
|
544
|
+
* <p>The type of the import job.</p>
|
|
545
|
+
* @public
|
|
546
|
+
*/
|
|
547
|
+
importJobType: ImportJobType | undefined;
|
|
548
|
+
/**
|
|
549
|
+
* <p>The status of the import job.</p>
|
|
550
|
+
* @public
|
|
551
|
+
*/
|
|
552
|
+
status: ImportJobStatus | undefined;
|
|
553
|
+
/**
|
|
554
|
+
* <p>The download link to the resource file that is uploaded to the import job.</p>
|
|
555
|
+
* @public
|
|
556
|
+
*/
|
|
557
|
+
url: string | undefined;
|
|
558
|
+
/**
|
|
559
|
+
* <p>The link to download the information of resource data that failed to be imported.</p>
|
|
560
|
+
* @public
|
|
561
|
+
*/
|
|
562
|
+
failedRecordReport?: string | undefined;
|
|
563
|
+
/**
|
|
564
|
+
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
565
|
+
* @public
|
|
566
|
+
*/
|
|
567
|
+
urlExpiry: Date | undefined;
|
|
568
|
+
/**
|
|
569
|
+
* <p>The timestamp when the import job was created.</p>
|
|
570
|
+
* @public
|
|
571
|
+
*/
|
|
572
|
+
createdTime: Date | undefined;
|
|
573
|
+
/**
|
|
574
|
+
* <p>The timestamp when the import job data was last modified.</p>
|
|
575
|
+
* @public
|
|
576
|
+
*/
|
|
577
|
+
lastModifiedTime: Date | undefined;
|
|
578
|
+
/**
|
|
579
|
+
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
580
|
+
* @public
|
|
581
|
+
*/
|
|
582
|
+
metadata?: Record<string, string> | undefined;
|
|
583
|
+
/**
|
|
584
|
+
* <p>The configuration information of the external data source.</p>
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
588
|
+
}
|
|
589
|
+
/**
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
export interface GetImportJobResponse {
|
|
593
|
+
/**
|
|
594
|
+
* <p>The import job.</p>
|
|
595
|
+
* @public
|
|
596
|
+
*/
|
|
597
|
+
importJob?: ImportJobData | undefined;
|
|
598
|
+
}
|
|
599
|
+
/**
|
|
600
|
+
* @public
|
|
601
|
+
*/
|
|
602
|
+
export interface GetKnowledgeBaseRequest {
|
|
603
|
+
/**
|
|
604
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
605
|
+
* @public
|
|
606
|
+
*/
|
|
607
|
+
knowledgeBaseId: string | undefined;
|
|
608
|
+
}
|
|
609
|
+
/**
|
|
610
|
+
* @public
|
|
611
|
+
*/
|
|
612
|
+
export interface GetKnowledgeBaseResponse {
|
|
613
|
+
/**
|
|
614
|
+
* <p>The knowledge base.</p>
|
|
615
|
+
* @public
|
|
616
|
+
*/
|
|
617
|
+
knowledgeBase?: KnowledgeBaseData | undefined;
|
|
618
|
+
}
|
|
619
|
+
/**
|
|
620
|
+
* @public
|
|
621
|
+
*/
|
|
622
|
+
export interface GetMessageTemplateRequest {
|
|
623
|
+
/**
|
|
624
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
625
|
+
* @public
|
|
626
|
+
*/
|
|
627
|
+
messageTemplateId: string | undefined;
|
|
628
|
+
/**
|
|
629
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
630
|
+
* the ARN.</p>
|
|
631
|
+
* @public
|
|
632
|
+
*/
|
|
633
|
+
knowledgeBaseId: string | undefined;
|
|
634
|
+
}
|
|
635
|
+
/**
|
|
636
|
+
* @public
|
|
637
|
+
*/
|
|
638
|
+
export interface GetMessageTemplateResponse {
|
|
639
|
+
/**
|
|
640
|
+
* <p>The message template.</p>
|
|
641
|
+
* @public
|
|
642
|
+
*/
|
|
643
|
+
messageTemplate?: ExtendedMessageTemplateData | undefined;
|
|
644
|
+
}
|
|
645
|
+
/**
|
|
646
|
+
* @public
|
|
647
|
+
*/
|
|
648
|
+
export interface GetQuickResponseRequest {
|
|
649
|
+
/**
|
|
650
|
+
* <p>The identifier of the quick response.</p>
|
|
651
|
+
* @public
|
|
652
|
+
*/
|
|
653
|
+
quickResponseId: string | undefined;
|
|
654
|
+
/**
|
|
655
|
+
* <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</p>
|
|
656
|
+
* @public
|
|
657
|
+
*/
|
|
658
|
+
knowledgeBaseId: string | undefined;
|
|
659
|
+
}
|
|
660
|
+
/**
|
|
661
|
+
* @public
|
|
662
|
+
*/
|
|
663
|
+
export interface GetQuickResponseResponse {
|
|
664
|
+
/**
|
|
665
|
+
* <p>The quick response.</p>
|
|
666
|
+
* @public
|
|
667
|
+
*/
|
|
668
|
+
quickResponse?: QuickResponseData | undefined;
|
|
669
|
+
}
|
|
670
|
+
/**
|
|
671
|
+
* <p>Summary information about the import job.</p>
|
|
672
|
+
* @public
|
|
673
|
+
*/
|
|
674
|
+
export interface ImportJobSummary {
|
|
675
|
+
/**
|
|
676
|
+
* <p>The identifier of the import job.</p>
|
|
677
|
+
* @public
|
|
678
|
+
*/
|
|
679
|
+
importJobId: string | undefined;
|
|
680
|
+
/**
|
|
681
|
+
* <p>The identifier of the knowledge base.</p>
|
|
682
|
+
* @public
|
|
683
|
+
*/
|
|
684
|
+
knowledgeBaseId: string | undefined;
|
|
685
|
+
/**
|
|
686
|
+
* <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>
|
|
687
|
+
* @public
|
|
688
|
+
*/
|
|
689
|
+
uploadId: string | undefined;
|
|
690
|
+
/**
|
|
691
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
692
|
+
* @public
|
|
693
|
+
*/
|
|
694
|
+
knowledgeBaseArn: string | undefined;
|
|
695
|
+
/**
|
|
696
|
+
* <p>The type of import job.</p>
|
|
697
|
+
* @public
|
|
698
|
+
*/
|
|
699
|
+
importJobType: ImportJobType | undefined;
|
|
700
|
+
/**
|
|
701
|
+
* <p>The status of the import job.</p>
|
|
702
|
+
* @public
|
|
703
|
+
*/
|
|
704
|
+
status: ImportJobStatus | undefined;
|
|
705
|
+
/**
|
|
706
|
+
* <p>The timestamp when the import job was created.</p>
|
|
707
|
+
* @public
|
|
708
|
+
*/
|
|
709
|
+
createdTime: Date | undefined;
|
|
710
|
+
/**
|
|
711
|
+
* <p>The timestamp when the import job was last modified.</p>
|
|
712
|
+
* @public
|
|
713
|
+
*/
|
|
714
|
+
lastModifiedTime: Date | undefined;
|
|
715
|
+
/**
|
|
716
|
+
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
717
|
+
* @public
|
|
718
|
+
*/
|
|
719
|
+
metadata?: Record<string, string> | undefined;
|
|
720
|
+
/**
|
|
721
|
+
* <p>The configuration information of the external source that the resource data are imported
|
|
722
|
+
* from.</p>
|
|
723
|
+
* @public
|
|
724
|
+
*/
|
|
725
|
+
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
726
|
+
}
|
|
727
|
+
/**
|
|
728
|
+
* @public
|
|
729
|
+
*/
|
|
730
|
+
export interface ListImportJobsRequest {
|
|
731
|
+
/**
|
|
732
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
733
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
734
|
+
* @public
|
|
735
|
+
*/
|
|
736
|
+
nextToken?: string | undefined;
|
|
737
|
+
/**
|
|
738
|
+
* <p>The maximum number of results to return per page.</p>
|
|
739
|
+
* @public
|
|
740
|
+
*/
|
|
741
|
+
maxResults?: number | undefined;
|
|
742
|
+
/**
|
|
743
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
744
|
+
* @public
|
|
745
|
+
*/
|
|
746
|
+
knowledgeBaseId: string | undefined;
|
|
747
|
+
}
|
|
748
|
+
/**
|
|
749
|
+
* @public
|
|
750
|
+
*/
|
|
751
|
+
export interface ListImportJobsResponse {
|
|
752
|
+
/**
|
|
753
|
+
* <p>Summary information about the import jobs.</p>
|
|
754
|
+
* @public
|
|
755
|
+
*/
|
|
756
|
+
importJobSummaries: ImportJobSummary[] | undefined;
|
|
757
|
+
/**
|
|
758
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
759
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
760
|
+
* @public
|
|
761
|
+
*/
|
|
762
|
+
nextToken?: string | undefined;
|
|
763
|
+
}
|
|
764
|
+
/**
|
|
765
|
+
* @public
|
|
766
|
+
*/
|
|
767
|
+
export interface ListKnowledgeBasesRequest {
|
|
768
|
+
/**
|
|
769
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
770
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
771
|
+
* @public
|
|
772
|
+
*/
|
|
773
|
+
nextToken?: string | undefined;
|
|
774
|
+
/**
|
|
775
|
+
* <p>The maximum number of results to return per page.</p>
|
|
776
|
+
* @public
|
|
777
|
+
*/
|
|
778
|
+
maxResults?: number | undefined;
|
|
779
|
+
}
|
|
780
|
+
/**
|
|
781
|
+
* <p>Summary information about the knowledge base.</p>
|
|
782
|
+
* @public
|
|
783
|
+
*/
|
|
784
|
+
export interface KnowledgeBaseSummary {
|
|
785
|
+
/**
|
|
786
|
+
* <p>The identifier of the knowledge base.</p>
|
|
787
|
+
* @public
|
|
788
|
+
*/
|
|
789
|
+
knowledgeBaseId: string | undefined;
|
|
790
|
+
/**
|
|
791
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
792
|
+
* @public
|
|
793
|
+
*/
|
|
794
|
+
knowledgeBaseArn: string | undefined;
|
|
795
|
+
/**
|
|
796
|
+
* <p>The name of the knowledge base.</p>
|
|
797
|
+
* @public
|
|
798
|
+
*/
|
|
799
|
+
name: string | undefined;
|
|
800
|
+
/**
|
|
801
|
+
* <p>The type of knowledge base.</p>
|
|
802
|
+
* @public
|
|
803
|
+
*/
|
|
804
|
+
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
805
|
+
/**
|
|
806
|
+
* <p>The status of the knowledge base summary.</p>
|
|
807
|
+
* @public
|
|
808
|
+
*/
|
|
809
|
+
status: KnowledgeBaseStatus | undefined;
|
|
810
|
+
/**
|
|
811
|
+
* <p>Configuration information about the external data source.</p>
|
|
812
|
+
* @public
|
|
813
|
+
*/
|
|
814
|
+
sourceConfiguration?: SourceConfiguration | undefined;
|
|
815
|
+
/**
|
|
816
|
+
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
817
|
+
* @public
|
|
818
|
+
*/
|
|
819
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
820
|
+
/**
|
|
821
|
+
* <p>Information about how to render the content.</p>
|
|
822
|
+
* @public
|
|
823
|
+
*/
|
|
824
|
+
renderingConfiguration?: RenderingConfiguration | undefined;
|
|
825
|
+
/**
|
|
826
|
+
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
827
|
+
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
828
|
+
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
829
|
+
* <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
|
|
830
|
+
* key to invoke Amazon Q in Connect. </p>
|
|
831
|
+
* <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
|
|
832
|
+
* your instance</a>.</p>
|
|
833
|
+
* @public
|
|
834
|
+
*/
|
|
835
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
836
|
+
/**
|
|
837
|
+
* <p>The description of the knowledge base.</p>
|
|
838
|
+
* @public
|
|
839
|
+
*/
|
|
840
|
+
description?: string | undefined;
|
|
841
|
+
/**
|
|
842
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
843
|
+
* @public
|
|
844
|
+
*/
|
|
845
|
+
tags?: Record<string, string> | undefined;
|
|
846
|
+
}
|
|
847
|
+
/**
|
|
848
|
+
* @public
|
|
849
|
+
*/
|
|
850
|
+
export interface ListKnowledgeBasesResponse {
|
|
851
|
+
/**
|
|
852
|
+
* <p>Information about the knowledge bases.</p>
|
|
853
|
+
* @public
|
|
854
|
+
*/
|
|
855
|
+
knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
856
|
+
/**
|
|
857
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
858
|
+
* @public
|
|
859
|
+
*/
|
|
860
|
+
nextToken?: string | undefined;
|
|
861
|
+
}
|
|
862
|
+
/**
|
|
863
|
+
* @public
|
|
864
|
+
*/
|
|
865
|
+
export interface ListMessageTemplatesRequest {
|
|
866
|
+
/**
|
|
867
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
868
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
869
|
+
* @public
|
|
870
|
+
*/
|
|
871
|
+
nextToken?: string | undefined;
|
|
872
|
+
/**
|
|
873
|
+
* <p>The maximum number of results to return per page.</p>
|
|
874
|
+
* @public
|
|
875
|
+
*/
|
|
876
|
+
maxResults?: number | undefined;
|
|
877
|
+
/**
|
|
878
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
879
|
+
* the ARN.</p>
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
knowledgeBaseId: string | undefined;
|
|
883
|
+
}
|
|
884
|
+
/**
|
|
885
|
+
* <p>The summary of the message template.</p>
|
|
886
|
+
* @public
|
|
887
|
+
*/
|
|
888
|
+
export interface MessageTemplateSummary {
|
|
889
|
+
/**
|
|
890
|
+
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
891
|
+
* @public
|
|
892
|
+
*/
|
|
893
|
+
messageTemplateArn: string | undefined;
|
|
894
|
+
/**
|
|
895
|
+
* <p>The identifier of the message template.</p>
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
messageTemplateId: string | undefined;
|
|
899
|
+
/**
|
|
900
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
901
|
+
* @public
|
|
902
|
+
*/
|
|
903
|
+
knowledgeBaseArn: string | undefined;
|
|
904
|
+
/**
|
|
905
|
+
* <p>The identifier of the knowledge base.</p>
|
|
906
|
+
* @public
|
|
907
|
+
*/
|
|
908
|
+
knowledgeBaseId: string | undefined;
|
|
909
|
+
/**
|
|
910
|
+
* <p>The name of the message template.</p>
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
913
|
+
name: string | undefined;
|
|
914
|
+
/**
|
|
915
|
+
* <p>The channel subtype this message template applies to.</p>
|
|
916
|
+
* @public
|
|
917
|
+
*/
|
|
918
|
+
channelSubtype: ChannelSubtype | undefined;
|
|
919
|
+
/**
|
|
920
|
+
* <p>The timestamp when the message template was created.</p>
|
|
921
|
+
* @public
|
|
922
|
+
*/
|
|
923
|
+
createdTime: Date | undefined;
|
|
924
|
+
/**
|
|
925
|
+
* <p>The timestamp when the message template data was last modified.</p>
|
|
926
|
+
* @public
|
|
927
|
+
*/
|
|
928
|
+
lastModifiedTime: Date | undefined;
|
|
929
|
+
/**
|
|
930
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template
|
|
931
|
+
* data.</p>
|
|
932
|
+
* @public
|
|
933
|
+
*/
|
|
934
|
+
lastModifiedBy: string | undefined;
|
|
935
|
+
/**
|
|
936
|
+
* <p>The version number of the message template version that is activated.</p>
|
|
937
|
+
* @public
|
|
938
|
+
*/
|
|
939
|
+
activeVersionNumber?: number | undefined;
|
|
940
|
+
/**
|
|
941
|
+
* <p>The description of the message template.</p>
|
|
942
|
+
* @public
|
|
943
|
+
*/
|
|
944
|
+
description?: string | undefined;
|
|
945
|
+
/**
|
|
946
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
947
|
+
* @public
|
|
948
|
+
*/
|
|
949
|
+
tags?: Record<string, string> | undefined;
|
|
950
|
+
}
|
|
951
|
+
/**
|
|
952
|
+
* @public
|
|
953
|
+
*/
|
|
954
|
+
export interface ListMessageTemplatesResponse {
|
|
955
|
+
/**
|
|
956
|
+
* <p>Summary information about the message template.</p>
|
|
957
|
+
* @public
|
|
958
|
+
*/
|
|
959
|
+
messageTemplateSummaries: MessageTemplateSummary[] | undefined;
|
|
960
|
+
/**
|
|
961
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
962
|
+
* @public
|
|
963
|
+
*/
|
|
964
|
+
nextToken?: string | undefined;
|
|
965
|
+
}
|
|
966
|
+
/**
|
|
967
|
+
* @public
|
|
968
|
+
*/
|
|
969
|
+
export interface ListMessageTemplateVersionsRequest {
|
|
970
|
+
/**
|
|
971
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
972
|
+
* the ARN.</p>
|
|
973
|
+
* @public
|
|
974
|
+
*/
|
|
975
|
+
knowledgeBaseId: string | undefined;
|
|
976
|
+
/**
|
|
977
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
|
|
978
|
+
* any qualifier.</p>
|
|
979
|
+
* @public
|
|
980
|
+
*/
|
|
981
|
+
messageTemplateId: string | undefined;
|
|
982
|
+
/**
|
|
983
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
984
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
985
|
+
* @public
|
|
986
|
+
*/
|
|
987
|
+
nextToken?: string | undefined;
|
|
988
|
+
/**
|
|
989
|
+
* <p>The maximum number of results to return per page.</p>
|
|
990
|
+
* @public
|
|
991
|
+
*/
|
|
992
|
+
maxResults?: number | undefined;
|
|
993
|
+
}
|
|
994
|
+
/**
|
|
995
|
+
* <p>The summary of the message template version.</p>
|
|
996
|
+
* @public
|
|
997
|
+
*/
|
|
998
|
+
export interface MessageTemplateVersionSummary {
|
|
999
|
+
/**
|
|
1000
|
+
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
1001
|
+
* @public
|
|
1002
|
+
*/
|
|
1003
|
+
messageTemplateArn: string | undefined;
|
|
1004
|
+
/**
|
|
1005
|
+
* <p>The identifier of the message template.</p>
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
messageTemplateId: string | undefined;
|
|
1009
|
+
/**
|
|
1010
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1011
|
+
* @public
|
|
1012
|
+
*/
|
|
1013
|
+
knowledgeBaseArn: string | undefined;
|
|
1014
|
+
/**
|
|
1015
|
+
* <p>The identifier of the knowledge base.</p>
|
|
1016
|
+
* @public
|
|
1017
|
+
*/
|
|
1018
|
+
knowledgeBaseId: string | undefined;
|
|
1019
|
+
/**
|
|
1020
|
+
* <p>The name of the message template.</p>
|
|
1021
|
+
* @public
|
|
1022
|
+
*/
|
|
1023
|
+
name: string | undefined;
|
|
1024
|
+
/**
|
|
1025
|
+
* <p>The channel subtype this message template applies to.</p>
|
|
1026
|
+
* @public
|
|
1027
|
+
*/
|
|
1028
|
+
channelSubtype: ChannelSubtype | undefined;
|
|
1029
|
+
/**
|
|
1030
|
+
* <p>Whether the version of the message template is activated.</p>
|
|
1031
|
+
* @public
|
|
1032
|
+
*/
|
|
1033
|
+
isActive: boolean | undefined;
|
|
1034
|
+
/**
|
|
1035
|
+
* <p>The version number of the message template version.</p>
|
|
1036
|
+
* @public
|
|
1037
|
+
*/
|
|
1038
|
+
versionNumber: number | undefined;
|
|
1039
|
+
}
|
|
1040
|
+
/**
|
|
1041
|
+
* @public
|
|
1042
|
+
*/
|
|
1043
|
+
export interface ListMessageTemplateVersionsResponse {
|
|
1044
|
+
/**
|
|
1045
|
+
* <p>Summary information about the versions of a message template.</p>
|
|
1046
|
+
* @public
|
|
1047
|
+
*/
|
|
1048
|
+
messageTemplateVersionSummaries: MessageTemplateVersionSummary[] | undefined;
|
|
1049
|
+
/**
|
|
1050
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1051
|
+
* @public
|
|
1052
|
+
*/
|
|
1053
|
+
nextToken?: string | undefined;
|
|
1054
|
+
}
|
|
1055
|
+
/**
|
|
1056
|
+
* @public
|
|
1057
|
+
*/
|
|
1058
|
+
export interface RenderMessageTemplateRequest {
|
|
1059
|
+
/**
|
|
1060
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
1061
|
+
* the ARN.</p>
|
|
1062
|
+
* @public
|
|
1063
|
+
*/
|
|
1064
|
+
knowledgeBaseId: string | undefined;
|
|
1065
|
+
/**
|
|
1066
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
1067
|
+
* @public
|
|
1068
|
+
*/
|
|
1069
|
+
messageTemplateId: string | undefined;
|
|
1070
|
+
/**
|
|
1071
|
+
* <p>An object that specifies the values to use for variables in the message template. This
|
|
1072
|
+
* object contains different categories of key-value pairs. Each key defines a variable or
|
|
1073
|
+
* placeholder in the message template. The corresponding value defines the value for that
|
|
1074
|
+
* variable.</p>
|
|
1075
|
+
* @public
|
|
1076
|
+
*/
|
|
1077
|
+
attributes: MessageTemplateAttributes | undefined;
|
|
1078
|
+
}
|
|
1079
|
+
/**
|
|
1080
|
+
* @public
|
|
1081
|
+
*/
|
|
1082
|
+
export interface RenderMessageTemplateResponse {
|
|
1083
|
+
/**
|
|
1084
|
+
* <p>The content of the message template.</p>
|
|
1085
|
+
* @public
|
|
1086
|
+
*/
|
|
1087
|
+
content: MessageTemplateContentProvider | undefined;
|
|
1088
|
+
/**
|
|
1089
|
+
* <p>The attribute keys that are not resolved.</p>
|
|
1090
|
+
* @public
|
|
1091
|
+
*/
|
|
1092
|
+
attributesNotInterpolated?: string[] | undefined;
|
|
1093
|
+
/**
|
|
1094
|
+
* <p>The message template attachments.</p>
|
|
1095
|
+
* @public
|
|
1096
|
+
*/
|
|
1097
|
+
attachments?: MessageTemplateAttachment[] | undefined;
|
|
1098
|
+
}
|
|
1099
|
+
/**
|
|
1100
|
+
* @public
|
|
1101
|
+
*/
|
|
1102
|
+
export interface UpdateMessageTemplateRequest {
|
|
1103
|
+
/**
|
|
1104
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
1105
|
+
* the ARN.</p>
|
|
1106
|
+
* @public
|
|
1107
|
+
*/
|
|
1108
|
+
knowledgeBaseId: string | undefined;
|
|
1109
|
+
/**
|
|
1110
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
|
|
1111
|
+
* any qualifier.</p>
|
|
1112
|
+
* @public
|
|
1113
|
+
*/
|
|
1114
|
+
messageTemplateId: string | undefined;
|
|
1115
|
+
/**
|
|
1116
|
+
* <p>The content of the message template.</p>
|
|
1117
|
+
* @public
|
|
1118
|
+
*/
|
|
1119
|
+
content?: MessageTemplateContentProvider | undefined;
|
|
1120
|
+
/**
|
|
1121
|
+
* <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>,
|
|
1122
|
+
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
1123
|
+
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
1124
|
+
* </p>
|
|
1125
|
+
* @public
|
|
1126
|
+
*/
|
|
1127
|
+
language?: string | undefined;
|
|
1128
|
+
/**
|
|
1129
|
+
* <p>An object that specifies the default values to use for variables in the message template.
|
|
1130
|
+
* This object contains different categories of key-value pairs. Each key defines a variable or
|
|
1131
|
+
* placeholder in the message template. The corresponding value defines the default value for
|
|
1132
|
+
* that variable.</p>
|
|
1133
|
+
* @public
|
|
1134
|
+
*/
|
|
1135
|
+
defaultAttributes?: MessageTemplateAttributes | undefined;
|
|
1136
|
+
}
|
|
1137
|
+
/**
|
|
1138
|
+
* @public
|
|
1139
|
+
*/
|
|
1140
|
+
export interface UpdateMessageTemplateResponse {
|
|
1141
|
+
/**
|
|
1142
|
+
* <p>The message template.</p>
|
|
1143
|
+
* @public
|
|
1144
|
+
*/
|
|
1145
|
+
messageTemplate?: MessageTemplateData | undefined;
|
|
1146
|
+
}
|
|
1147
|
+
/**
|
|
1148
|
+
* @public
|
|
1149
|
+
*/
|
|
1150
|
+
export interface UpdateMessageTemplateMetadataRequest {
|
|
1151
|
+
/**
|
|
1152
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain
|
|
1153
|
+
* the ARN.</p>
|
|
1154
|
+
* @public
|
|
1155
|
+
*/
|
|
1156
|
+
knowledgeBaseId: string | undefined;
|
|
1157
|
+
/**
|
|
1158
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain
|
|
1159
|
+
* any qualifier.</p>
|
|
1160
|
+
* @public
|
|
1161
|
+
*/
|
|
1162
|
+
messageTemplateId: string | undefined;
|
|
1163
|
+
/**
|
|
1164
|
+
* <p>The name of the message template.</p>
|
|
1165
|
+
* @public
|
|
1166
|
+
*/
|
|
1167
|
+
name?: string | undefined;
|
|
1168
|
+
/**
|
|
1169
|
+
* <p>The description of the message template.</p>
|
|
1170
|
+
* @public
|
|
1171
|
+
*/
|
|
1172
|
+
description?: string | undefined;
|
|
1173
|
+
/**
|
|
1174
|
+
* <p>The configuration information of the grouping of Amazon Q in Connect users.</p>
|
|
1175
|
+
* @public
|
|
1176
|
+
*/
|
|
1177
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
1178
|
+
}
|
|
1179
|
+
/**
|
|
1180
|
+
* @public
|
|
1181
|
+
*/
|
|
1182
|
+
export interface UpdateMessageTemplateMetadataResponse {
|
|
1183
|
+
/**
|
|
1184
|
+
* <p>The message template.</p>
|
|
1185
|
+
* @public
|
|
1186
|
+
*/
|
|
1187
|
+
messageTemplate?: MessageTemplateData | undefined;
|
|
1188
|
+
}
|
|
1189
|
+
/**
|
|
1190
|
+
* @public
|
|
1191
|
+
*/
|
|
1192
|
+
export interface ListQuickResponsesRequest {
|
|
1193
|
+
/**
|
|
1194
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1195
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
1196
|
+
* @public
|
|
1197
|
+
*/
|
|
1198
|
+
nextToken?: string | undefined;
|
|
1199
|
+
/**
|
|
1200
|
+
* <p>The maximum number of results to return per page.</p>
|
|
1201
|
+
* @public
|
|
1202
|
+
*/
|
|
1203
|
+
maxResults?: number | undefined;
|
|
1204
|
+
/**
|
|
1205
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1206
|
+
* @public
|
|
1207
|
+
*/
|
|
1208
|
+
knowledgeBaseId: string | undefined;
|
|
1209
|
+
}
|
|
1210
|
+
/**
|
|
1211
|
+
* <p>The summary information about the quick response.</p>
|
|
1212
|
+
* @public
|
|
1213
|
+
*/
|
|
1214
|
+
export interface QuickResponseSummary {
|
|
1215
|
+
/**
|
|
1216
|
+
* <p>The Amazon Resource Name (ARN) of the quick response.</p>
|
|
1217
|
+
* @public
|
|
1218
|
+
*/
|
|
1219
|
+
quickResponseArn: string | undefined;
|
|
1220
|
+
/**
|
|
1221
|
+
* <p>The identifier of the quick response.</p>
|
|
1222
|
+
* @public
|
|
1223
|
+
*/
|
|
1224
|
+
quickResponseId: string | undefined;
|
|
1225
|
+
/**
|
|
1226
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1227
|
+
* @public
|
|
1228
|
+
*/
|
|
1229
|
+
knowledgeBaseArn: string | undefined;
|
|
1230
|
+
/**
|
|
1231
|
+
* <p>The identifier of the knowledge base.</p>
|
|
1232
|
+
* @public
|
|
1233
|
+
*/
|
|
1234
|
+
knowledgeBaseId: string | undefined;
|
|
1235
|
+
/**
|
|
1236
|
+
* <p>The name of the quick response.</p>
|
|
1237
|
+
* @public
|
|
1238
|
+
*/
|
|
1239
|
+
name: string | undefined;
|
|
1240
|
+
/**
|
|
1241
|
+
* <p>The media type of the quick response content.</p>
|
|
1242
|
+
* <ul>
|
|
1243
|
+
* <li>
|
|
1244
|
+
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
1245
|
+
* in plain text.</p>
|
|
1246
|
+
* </li>
|
|
1247
|
+
* <li>
|
|
1248
|
+
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
1249
|
+
* written in richtext.</p>
|
|
1250
|
+
* </li>
|
|
1251
|
+
* </ul>
|
|
1252
|
+
* @public
|
|
1253
|
+
*/
|
|
1254
|
+
contentType: string | undefined;
|
|
1255
|
+
/**
|
|
1256
|
+
* <p>The resource status of the quick response.</p>
|
|
1257
|
+
* @public
|
|
1258
|
+
*/
|
|
1259
|
+
status: QuickResponseStatus | undefined;
|
|
1260
|
+
/**
|
|
1261
|
+
* <p>The timestamp when the quick response was created.</p>
|
|
1262
|
+
* @public
|
|
1263
|
+
*/
|
|
1264
|
+
createdTime: Date | undefined;
|
|
1265
|
+
/**
|
|
1266
|
+
* <p>The timestamp when the quick response summary was last modified.</p>
|
|
1267
|
+
* @public
|
|
1268
|
+
*/
|
|
1269
|
+
lastModifiedTime: Date | undefined;
|
|
1270
|
+
/**
|
|
1271
|
+
* <p>The description of the quick response.</p>
|
|
1272
|
+
* @public
|
|
1273
|
+
*/
|
|
1274
|
+
description?: string | undefined;
|
|
1275
|
+
/**
|
|
1276
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response
|
|
1277
|
+
* data.</p>
|
|
1278
|
+
* @public
|
|
1279
|
+
*/
|
|
1280
|
+
lastModifiedBy?: string | undefined;
|
|
1281
|
+
/**
|
|
1282
|
+
* <p>Whether the quick response is active.</p>
|
|
1283
|
+
* @public
|
|
1284
|
+
*/
|
|
1285
|
+
isActive?: boolean | undefined;
|
|
1286
|
+
/**
|
|
1287
|
+
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
1288
|
+
* The supported contact channel types include <code>Chat</code>.</p>
|
|
1289
|
+
* @public
|
|
1290
|
+
*/
|
|
1291
|
+
channels?: string[] | undefined;
|
|
1292
|
+
/**
|
|
1293
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1294
|
+
* @public
|
|
1295
|
+
*/
|
|
1296
|
+
tags?: Record<string, string> | undefined;
|
|
1297
|
+
}
|
|
1298
|
+
/**
|
|
1299
|
+
* @public
|
|
1300
|
+
*/
|
|
1301
|
+
export interface ListQuickResponsesResponse {
|
|
1302
|
+
/**
|
|
1303
|
+
* <p>Summary information about the quick responses.</p>
|
|
1304
|
+
* @public
|
|
1305
|
+
*/
|
|
1306
|
+
quickResponseSummaries: QuickResponseSummary[] | undefined;
|
|
1307
|
+
/**
|
|
1308
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1309
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
1310
|
+
* @public
|
|
1311
|
+
*/
|
|
1312
|
+
nextToken?: string | undefined;
|
|
1313
|
+
}
|
|
1314
|
+
/**
|
|
1315
|
+
* @public
|
|
1316
|
+
*/
|
|
1317
|
+
export interface UpdateQuickResponseRequest {
|
|
1318
|
+
/**
|
|
1319
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1320
|
+
* @public
|
|
1321
|
+
*/
|
|
1322
|
+
knowledgeBaseId: string | undefined;
|
|
1323
|
+
/**
|
|
1324
|
+
* <p>The identifier of the quick response.</p>
|
|
1325
|
+
* @public
|
|
1326
|
+
*/
|
|
1327
|
+
quickResponseId: string | undefined;
|
|
1328
|
+
/**
|
|
1329
|
+
* <p>The name of the quick response.</p>
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
name?: string | undefined;
|
|
1333
|
+
/**
|
|
1334
|
+
* <p>The updated content of the quick response.</p>
|
|
1335
|
+
* @public
|
|
1336
|
+
*/
|
|
1337
|
+
content?: QuickResponseDataProvider | undefined;
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>The media type of the quick response content.</p>
|
|
1340
|
+
* <ul>
|
|
1341
|
+
* <li>
|
|
1342
|
+
* <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written
|
|
1343
|
+
* in plain text.</p>
|
|
1344
|
+
* </li>
|
|
1345
|
+
* <li>
|
|
1346
|
+
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response
|
|
1347
|
+
* written in richtext.</p>
|
|
1348
|
+
* </li>
|
|
1349
|
+
* </ul>
|
|
1350
|
+
* @public
|
|
1351
|
+
*/
|
|
1352
|
+
contentType?: string | undefined;
|
|
1353
|
+
/**
|
|
1354
|
+
* <p>The updated grouping configuration of the quick response.</p>
|
|
1355
|
+
* @public
|
|
1356
|
+
*/
|
|
1357
|
+
groupingConfiguration?: GroupingConfiguration | undefined;
|
|
1358
|
+
/**
|
|
1359
|
+
* <p>Whether to remove the grouping configuration of the quick response.</p>
|
|
1360
|
+
* @public
|
|
1361
|
+
*/
|
|
1362
|
+
removeGroupingConfiguration?: boolean | undefined;
|
|
1363
|
+
/**
|
|
1364
|
+
* <p>The updated description of the quick response.</p>
|
|
1365
|
+
* @public
|
|
1366
|
+
*/
|
|
1367
|
+
description?: string | undefined;
|
|
1368
|
+
/**
|
|
1369
|
+
* <p>Whether to remove the description from the quick response.</p>
|
|
1370
|
+
* @public
|
|
1371
|
+
*/
|
|
1372
|
+
removeDescription?: boolean | undefined;
|
|
1373
|
+
/**
|
|
1374
|
+
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
1375
|
+
* knowledge base.</p>
|
|
1376
|
+
* @public
|
|
1377
|
+
*/
|
|
1378
|
+
shortcutKey?: string | undefined;
|
|
1379
|
+
/**
|
|
1380
|
+
* <p>Whether to remove the shortcut key of the quick response.</p>
|
|
1381
|
+
* @public
|
|
1382
|
+
*/
|
|
1383
|
+
removeShortcutKey?: boolean | undefined;
|
|
1384
|
+
/**
|
|
1385
|
+
* <p>Whether the quick response is active. </p>
|
|
1386
|
+
* @public
|
|
1387
|
+
*/
|
|
1388
|
+
isActive?: boolean | undefined;
|
|
1389
|
+
/**
|
|
1390
|
+
* <p>The Amazon Connect contact channels this quick response applies to.
|
|
1391
|
+
* The supported contact channel types include <code>Chat</code>.</p>
|
|
1392
|
+
* @public
|
|
1393
|
+
*/
|
|
1394
|
+
channels?: string[] | undefined;
|
|
1395
|
+
/**
|
|
1396
|
+
* <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>,
|
|
1397
|
+
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
1398
|
+
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
1399
|
+
* </p>
|
|
1400
|
+
* @public
|
|
1401
|
+
*/
|
|
1402
|
+
language?: string | undefined;
|
|
1403
|
+
}
|
|
1404
|
+
/**
|
|
1405
|
+
* @public
|
|
1406
|
+
*/
|
|
1407
|
+
export interface UpdateQuickResponseResponse {
|
|
1408
|
+
/**
|
|
1409
|
+
* <p>The quick response.</p>
|
|
1410
|
+
* @public
|
|
1411
|
+
*/
|
|
1412
|
+
quickResponse?: QuickResponseData | undefined;
|
|
1413
|
+
}
|
|
1414
|
+
/**
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1417
|
+
export interface RemoveKnowledgeBaseTemplateUriRequest {
|
|
1418
|
+
/**
|
|
1419
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1420
|
+
* @public
|
|
1421
|
+
*/
|
|
1422
|
+
knowledgeBaseId: string | undefined;
|
|
1423
|
+
}
|
|
4
1424
|
/**
|
|
5
1425
|
* @public
|
|
6
1426
|
*/
|
|
@@ -1194,6 +2614,98 @@ export interface QueryAssistantResponse {
|
|
|
1194
2614
|
*/
|
|
1195
2615
|
nextToken?: string | undefined;
|
|
1196
2616
|
}
|
|
2617
|
+
/**
|
|
2618
|
+
* @internal
|
|
2619
|
+
*/
|
|
2620
|
+
export declare const QuickResponseDataProviderFilterSensitiveLog: (obj: QuickResponseDataProvider) => any;
|
|
2621
|
+
/**
|
|
2622
|
+
* @internal
|
|
2623
|
+
*/
|
|
2624
|
+
export declare const CreateQuickResponseRequestFilterSensitiveLog: (obj: CreateQuickResponseRequest) => any;
|
|
2625
|
+
/**
|
|
2626
|
+
* @internal
|
|
2627
|
+
*/
|
|
2628
|
+
export declare const QuickResponseContentProviderFilterSensitiveLog: (obj: QuickResponseContentProvider) => any;
|
|
2629
|
+
/**
|
|
2630
|
+
* @internal
|
|
2631
|
+
*/
|
|
2632
|
+
export declare const QuickResponseContentsFilterSensitiveLog: (obj: QuickResponseContents) => any;
|
|
2633
|
+
/**
|
|
2634
|
+
* @internal
|
|
2635
|
+
*/
|
|
2636
|
+
export declare const QuickResponseDataFilterSensitiveLog: (obj: QuickResponseData) => any;
|
|
2637
|
+
/**
|
|
2638
|
+
* @internal
|
|
2639
|
+
*/
|
|
2640
|
+
export declare const CreateQuickResponseResponseFilterSensitiveLog: (obj: CreateQuickResponseResponse) => any;
|
|
2641
|
+
/**
|
|
2642
|
+
* @internal
|
|
2643
|
+
*/
|
|
2644
|
+
export declare const ImportJobDataFilterSensitiveLog: (obj: ImportJobData) => any;
|
|
2645
|
+
/**
|
|
2646
|
+
* @internal
|
|
2647
|
+
*/
|
|
2648
|
+
export declare const GetImportJobResponseFilterSensitiveLog: (obj: GetImportJobResponse) => any;
|
|
2649
|
+
/**
|
|
2650
|
+
* @internal
|
|
2651
|
+
*/
|
|
2652
|
+
export declare const GetKnowledgeBaseResponseFilterSensitiveLog: (obj: GetKnowledgeBaseResponse) => any;
|
|
2653
|
+
/**
|
|
2654
|
+
* @internal
|
|
2655
|
+
*/
|
|
2656
|
+
export declare const GetMessageTemplateResponseFilterSensitiveLog: (obj: GetMessageTemplateResponse) => any;
|
|
2657
|
+
/**
|
|
2658
|
+
* @internal
|
|
2659
|
+
*/
|
|
2660
|
+
export declare const GetQuickResponseResponseFilterSensitiveLog: (obj: GetQuickResponseResponse) => any;
|
|
2661
|
+
/**
|
|
2662
|
+
* @internal
|
|
2663
|
+
*/
|
|
2664
|
+
export declare const KnowledgeBaseSummaryFilterSensitiveLog: (obj: KnowledgeBaseSummary) => any;
|
|
2665
|
+
/**
|
|
2666
|
+
* @internal
|
|
2667
|
+
*/
|
|
2668
|
+
export declare const ListKnowledgeBasesResponseFilterSensitiveLog: (obj: ListKnowledgeBasesResponse) => any;
|
|
2669
|
+
/**
|
|
2670
|
+
* @internal
|
|
2671
|
+
*/
|
|
2672
|
+
export declare const RenderMessageTemplateRequestFilterSensitiveLog: (obj: RenderMessageTemplateRequest) => any;
|
|
2673
|
+
/**
|
|
2674
|
+
* @internal
|
|
2675
|
+
*/
|
|
2676
|
+
export declare const RenderMessageTemplateResponseFilterSensitiveLog: (obj: RenderMessageTemplateResponse) => any;
|
|
2677
|
+
/**
|
|
2678
|
+
* @internal
|
|
2679
|
+
*/
|
|
2680
|
+
export declare const UpdateMessageTemplateRequestFilterSensitiveLog: (obj: UpdateMessageTemplateRequest) => any;
|
|
2681
|
+
/**
|
|
2682
|
+
* @internal
|
|
2683
|
+
*/
|
|
2684
|
+
export declare const UpdateMessageTemplateResponseFilterSensitiveLog: (obj: UpdateMessageTemplateResponse) => any;
|
|
2685
|
+
/**
|
|
2686
|
+
* @internal
|
|
2687
|
+
*/
|
|
2688
|
+
export declare const UpdateMessageTemplateMetadataRequestFilterSensitiveLog: (obj: UpdateMessageTemplateMetadataRequest) => any;
|
|
2689
|
+
/**
|
|
2690
|
+
* @internal
|
|
2691
|
+
*/
|
|
2692
|
+
export declare const UpdateMessageTemplateMetadataResponseFilterSensitiveLog: (obj: UpdateMessageTemplateMetadataResponse) => any;
|
|
2693
|
+
/**
|
|
2694
|
+
* @internal
|
|
2695
|
+
*/
|
|
2696
|
+
export declare const QuickResponseSummaryFilterSensitiveLog: (obj: QuickResponseSummary) => any;
|
|
2697
|
+
/**
|
|
2698
|
+
* @internal
|
|
2699
|
+
*/
|
|
2700
|
+
export declare const ListQuickResponsesResponseFilterSensitiveLog: (obj: ListQuickResponsesResponse) => any;
|
|
2701
|
+
/**
|
|
2702
|
+
* @internal
|
|
2703
|
+
*/
|
|
2704
|
+
export declare const UpdateQuickResponseRequestFilterSensitiveLog: (obj: UpdateQuickResponseRequest) => any;
|
|
2705
|
+
/**
|
|
2706
|
+
* @internal
|
|
2707
|
+
*/
|
|
2708
|
+
export declare const UpdateQuickResponseResponseFilterSensitiveLog: (obj: UpdateQuickResponseResponse) => any;
|
|
1197
2709
|
/**
|
|
1198
2710
|
* @internal
|
|
1199
2711
|
*/
|