@aws-sdk/client-qconnect 3.533.0 → 3.536.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/QConnect.d.ts +3 -1
- package/dist-types/QConnectClient.d.ts +1 -1
- package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +2 -1
- package/dist-types/commands/CreateAssistantCommand.d.ts +2 -1
- package/dist-types/commands/CreateContentCommand.d.ts +2 -1
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +2 -1
- package/dist-types/commands/CreateQuickResponseCommand.d.ts +2 -1
- package/dist-types/commands/CreateSessionCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAssistantAssociationCommand.d.ts +2 -1
- package/dist-types/commands/DeleteAssistantCommand.d.ts +2 -1
- package/dist-types/commands/DeleteContentCommand.d.ts +2 -1
- package/dist-types/commands/DeleteImportJobCommand.d.ts +2 -1
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +2 -1
- package/dist-types/commands/DeleteQuickResponseCommand.d.ts +2 -1
- package/dist-types/commands/GetAssistantAssociationCommand.d.ts +2 -1
- package/dist-types/commands/GetAssistantCommand.d.ts +2 -1
- package/dist-types/commands/GetContentCommand.d.ts +2 -1
- package/dist-types/commands/GetContentSummaryCommand.d.ts +2 -1
- package/dist-types/commands/GetImportJobCommand.d.ts +2 -1
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +2 -1
- package/dist-types/commands/GetQuickResponseCommand.d.ts +2 -1
- package/dist-types/commands/GetRecommendationsCommand.d.ts +4 -3
- package/dist-types/commands/GetSessionCommand.d.ts +2 -1
- package/dist-types/commands/ListAssistantAssociationsCommand.d.ts +2 -1
- package/dist-types/commands/ListAssistantsCommand.d.ts +2 -1
- package/dist-types/commands/ListContentsCommand.d.ts +2 -1
- package/dist-types/commands/ListImportJobsCommand.d.ts +2 -1
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +2 -1
- package/dist-types/commands/ListQuickResponsesCommand.d.ts +2 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -1
- package/dist-types/commands/NotifyRecommendationsReceivedCommand.d.ts +2 -1
- package/dist-types/commands/PutFeedbackCommand.d.ts +2 -1
- package/dist-types/commands/QueryAssistantCommand.d.ts +4 -3
- package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +2 -1
- package/dist-types/commands/SearchContentCommand.d.ts +2 -1
- package/dist-types/commands/SearchQuickResponsesCommand.d.ts +2 -1
- package/dist-types/commands/SearchSessionsCommand.d.ts +2 -1
- package/dist-types/commands/StartContentUploadCommand.d.ts +2 -1
- package/dist-types/commands/StartImportJobCommand.d.ts +2 -1
- package/dist-types/commands/TagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +2 -1
- package/dist-types/commands/UpdateContentCommand.d.ts +2 -1
- package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +2 -1
- package/dist-types/commands/UpdateQuickResponseCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +540 -540
- package/dist-types/ts3.4/QConnect.d.ts +2 -0
- package/dist-types/ts3.4/commands/CreateAssistantAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateAssistantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateKnowledgeBaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAssistantAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteAssistantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteImportJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/DeleteQuickResponseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAssistantAssociationCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetAssistantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetContentSummaryCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetKnowledgeBaseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetRecommendationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAssistantAssociationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListAssistantsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListContentsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListImportJobsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListQuickResponsesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/NotifyRecommendationsReceivedCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/PutFeedbackCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/QueryAssistantCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchQuickResponsesCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/SearchSessionsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartContentUploadCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/StartImportJobCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateContentCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/UpdateQuickResponseCommand.d.ts +9 -0
- package/package.json +40 -40
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { QConnectServiceException as __BaseException } from "./QConnectServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>You do not have sufficient access to perform this action.</p>
|
|
5
|
+
* @public
|
|
6
6
|
*/
|
|
7
7
|
export declare class AccessDeniedException extends __BaseException {
|
|
8
8
|
readonly name: "AccessDeniedException";
|
|
@@ -13,12 +13,11 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* @public
|
|
17
16
|
* <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
|
|
17
|
+
* @public
|
|
18
18
|
*/
|
|
19
19
|
export interface AppIntegrationsConfiguration {
|
|
20
20
|
/**
|
|
21
|
-
* @public
|
|
22
21
|
* <p>The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.</p>
|
|
23
22
|
* <ul>
|
|
24
23
|
* <li>
|
|
@@ -58,10 +57,10 @@ export interface AppIntegrationsConfiguration {
|
|
|
58
57
|
* </important>
|
|
59
58
|
* </li>
|
|
60
59
|
* </ul>
|
|
60
|
+
* @public
|
|
61
61
|
*/
|
|
62
62
|
appIntegrationArn: string | undefined;
|
|
63
63
|
/**
|
|
64
|
-
* @public
|
|
65
64
|
* <p>The fields from the source that are made available to your agents in Amazon Q. Optional if
|
|
66
65
|
* ObjectConfiguration is included in the provided DataIntegration. </p>
|
|
67
66
|
* <ul>
|
|
@@ -83,15 +82,16 @@ export interface AppIntegrationsConfiguration {
|
|
|
83
82
|
* </ul>
|
|
84
83
|
* <p>Make sure to include additional fields. These fields are indexed and used to source
|
|
85
84
|
* recommendations. </p>
|
|
85
|
+
* @public
|
|
86
86
|
*/
|
|
87
87
|
objectFields?: string[];
|
|
88
88
|
}
|
|
89
89
|
/**
|
|
90
|
-
* @public
|
|
91
90
|
* <p>The request could not be processed because of conflict in the current state of the
|
|
92
91
|
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
93
92
|
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
94
93
|
* same name) is being created or mutated.</p>
|
|
94
|
+
* @public
|
|
95
95
|
*/
|
|
96
96
|
export declare class ConflictException extends __BaseException {
|
|
97
97
|
readonly name: "ConflictException";
|
|
@@ -102,8 +102,8 @@ export declare class ConflictException extends __BaseException {
|
|
|
102
102
|
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
103
103
|
}
|
|
104
104
|
/**
|
|
105
|
-
* @public
|
|
106
105
|
* <p>The data that is input into Amazon Q as a result of the assistant association.</p>
|
|
106
|
+
* @public
|
|
107
107
|
*/
|
|
108
108
|
export type AssistantAssociationInputData = AssistantAssociationInputData.KnowledgeBaseIdMember | AssistantAssociationInputData.$UnknownMember;
|
|
109
109
|
/**
|
|
@@ -111,9 +111,9 @@ export type AssistantAssociationInputData = AssistantAssociationInputData.Knowle
|
|
|
111
111
|
*/
|
|
112
112
|
export declare namespace AssistantAssociationInputData {
|
|
113
113
|
/**
|
|
114
|
-
* @public
|
|
115
114
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
116
115
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
116
|
+
* @public
|
|
117
117
|
*/
|
|
118
118
|
interface KnowledgeBaseIdMember {
|
|
119
119
|
knowledgeBaseId: string;
|
|
@@ -148,54 +148,54 @@ export type AssociationType = (typeof AssociationType)[keyof typeof AssociationT
|
|
|
148
148
|
*/
|
|
149
149
|
export interface CreateAssistantAssociationRequest {
|
|
150
150
|
/**
|
|
151
|
-
* @public
|
|
152
151
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
152
|
+
* @public
|
|
153
153
|
*/
|
|
154
154
|
assistantId: string | undefined;
|
|
155
155
|
/**
|
|
156
|
-
* @public
|
|
157
156
|
* <p>The type of association.</p>
|
|
157
|
+
* @public
|
|
158
158
|
*/
|
|
159
159
|
associationType: AssociationType | undefined;
|
|
160
160
|
/**
|
|
161
|
-
* @public
|
|
162
161
|
* <p>The identifier of the associated resource.</p>
|
|
162
|
+
* @public
|
|
163
163
|
*/
|
|
164
164
|
association: AssistantAssociationInputData | undefined;
|
|
165
165
|
/**
|
|
166
|
-
* @public
|
|
167
166
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
168
167
|
* request. If not provided, the Amazon Web Services
|
|
169
168
|
* SDK populates this field. For more information about idempotency, see
|
|
170
169
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
170
|
+
* @public
|
|
171
171
|
*/
|
|
172
172
|
clientToken?: string;
|
|
173
173
|
/**
|
|
174
|
-
* @public
|
|
175
174
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
175
|
+
* @public
|
|
176
176
|
*/
|
|
177
177
|
tags?: Record<string, string>;
|
|
178
178
|
}
|
|
179
179
|
/**
|
|
180
|
-
* @public
|
|
181
180
|
* <p>Association information about the knowledge base.</p>
|
|
181
|
+
* @public
|
|
182
182
|
*/
|
|
183
183
|
export interface KnowledgeBaseAssociationData {
|
|
184
184
|
/**
|
|
185
|
-
* @public
|
|
186
185
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
187
186
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
187
|
+
* @public
|
|
188
188
|
*/
|
|
189
189
|
knowledgeBaseId?: string;
|
|
190
190
|
/**
|
|
191
|
-
* @public
|
|
192
191
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
192
|
+
* @public
|
|
193
193
|
*/
|
|
194
194
|
knowledgeBaseArn?: string;
|
|
195
195
|
}
|
|
196
196
|
/**
|
|
197
|
-
* @public
|
|
198
197
|
* <p>The data that is output as a result of the assistant association.</p>
|
|
198
|
+
* @public
|
|
199
199
|
*/
|
|
200
200
|
export type AssistantAssociationOutputData = AssistantAssociationOutputData.KnowledgeBaseAssociationMember | AssistantAssociationOutputData.$UnknownMember;
|
|
201
201
|
/**
|
|
@@ -203,8 +203,8 @@ export type AssistantAssociationOutputData = AssistantAssociationOutputData.Know
|
|
|
203
203
|
*/
|
|
204
204
|
export declare namespace AssistantAssociationOutputData {
|
|
205
205
|
/**
|
|
206
|
-
* @public
|
|
207
206
|
* <p>The knowledge base where output data is sent.</p>
|
|
207
|
+
* @public
|
|
208
208
|
*/
|
|
209
209
|
interface KnowledgeBaseAssociationMember {
|
|
210
210
|
knowledgeBaseAssociation: KnowledgeBaseAssociationData;
|
|
@@ -224,43 +224,43 @@ export declare namespace AssistantAssociationOutputData {
|
|
|
224
224
|
const visit: <T>(value: AssistantAssociationOutputData, visitor: Visitor<T>) => T;
|
|
225
225
|
}
|
|
226
226
|
/**
|
|
227
|
-
* @public
|
|
228
227
|
* <p>Information about the assistant association.</p>
|
|
228
|
+
* @public
|
|
229
229
|
*/
|
|
230
230
|
export interface AssistantAssociationData {
|
|
231
231
|
/**
|
|
232
|
-
* @public
|
|
233
232
|
* <p>The identifier of the assistant association.</p>
|
|
233
|
+
* @public
|
|
234
234
|
*/
|
|
235
235
|
assistantAssociationId: string | undefined;
|
|
236
236
|
/**
|
|
237
|
-
* @public
|
|
238
237
|
* <p>The Amazon Resource Name (ARN) of the assistant association.</p>
|
|
238
|
+
* @public
|
|
239
239
|
*/
|
|
240
240
|
assistantAssociationArn: string | undefined;
|
|
241
241
|
/**
|
|
242
|
-
* @public
|
|
243
242
|
* <p>The identifier of the Amazon Q assistant.</p>
|
|
243
|
+
* @public
|
|
244
244
|
*/
|
|
245
245
|
assistantId: string | undefined;
|
|
246
246
|
/**
|
|
247
|
-
* @public
|
|
248
247
|
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
248
|
+
* @public
|
|
249
249
|
*/
|
|
250
250
|
assistantArn: string | undefined;
|
|
251
251
|
/**
|
|
252
|
-
* @public
|
|
253
252
|
* <p>The type of association.</p>
|
|
253
|
+
* @public
|
|
254
254
|
*/
|
|
255
255
|
associationType: AssociationType | undefined;
|
|
256
256
|
/**
|
|
257
|
-
* @public
|
|
258
257
|
* <p>A union type that currently has a single argument, the knowledge base ID.</p>
|
|
258
|
+
* @public
|
|
259
259
|
*/
|
|
260
260
|
associationData: AssistantAssociationOutputData | undefined;
|
|
261
261
|
/**
|
|
262
|
-
* @public
|
|
263
262
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
263
|
+
* @public
|
|
264
264
|
*/
|
|
265
265
|
tags?: Record<string, string>;
|
|
266
266
|
}
|
|
@@ -269,21 +269,21 @@ export interface AssistantAssociationData {
|
|
|
269
269
|
*/
|
|
270
270
|
export interface CreateAssistantAssociationResponse {
|
|
271
271
|
/**
|
|
272
|
-
* @public
|
|
273
272
|
* <p>The assistant association.</p>
|
|
273
|
+
* @public
|
|
274
274
|
*/
|
|
275
275
|
assistantAssociation?: AssistantAssociationData;
|
|
276
276
|
}
|
|
277
277
|
/**
|
|
278
|
-
* @public
|
|
279
278
|
* <p>The specified resource does not exist.</p>
|
|
279
|
+
* @public
|
|
280
280
|
*/
|
|
281
281
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
282
282
|
readonly name: "ResourceNotFoundException";
|
|
283
283
|
readonly $fault: "client";
|
|
284
284
|
/**
|
|
285
|
-
* @public
|
|
286
285
|
* <p>The specified resource name.</p>
|
|
286
|
+
* @public
|
|
287
287
|
*/
|
|
288
288
|
resourceName?: string;
|
|
289
289
|
/**
|
|
@@ -292,9 +292,9 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
292
292
|
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
293
293
|
}
|
|
294
294
|
/**
|
|
295
|
-
* @public
|
|
296
295
|
* <p>You've exceeded your service quota. To perform the requested action, remove some of the
|
|
297
296
|
* relevant resources, or use service quotas to request a service quota increase.</p>
|
|
297
|
+
* @public
|
|
298
298
|
*/
|
|
299
299
|
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
300
300
|
readonly name: "ServiceQuotaExceededException";
|
|
@@ -305,8 +305,8 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
305
305
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
306
306
|
}
|
|
307
307
|
/**
|
|
308
|
-
* @public
|
|
309
308
|
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
309
|
+
* @public
|
|
310
310
|
*/
|
|
311
311
|
export declare class ValidationException extends __BaseException {
|
|
312
312
|
readonly name: "ValidationException";
|
|
@@ -321,13 +321,13 @@ export declare class ValidationException extends __BaseException {
|
|
|
321
321
|
*/
|
|
322
322
|
export interface DeleteAssistantAssociationRequest {
|
|
323
323
|
/**
|
|
324
|
-
* @public
|
|
325
324
|
* <p>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
325
|
+
* @public
|
|
326
326
|
*/
|
|
327
327
|
assistantAssociationId: string | undefined;
|
|
328
328
|
/**
|
|
329
|
-
* @public
|
|
330
329
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
330
|
+
* @public
|
|
331
331
|
*/
|
|
332
332
|
assistantId: string | undefined;
|
|
333
333
|
}
|
|
@@ -341,13 +341,13 @@ export interface DeleteAssistantAssociationResponse {
|
|
|
341
341
|
*/
|
|
342
342
|
export interface GetAssistantAssociationRequest {
|
|
343
343
|
/**
|
|
344
|
-
* @public
|
|
345
344
|
* <p>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
345
|
+
* @public
|
|
346
346
|
*/
|
|
347
347
|
assistantAssociationId: string | undefined;
|
|
348
348
|
/**
|
|
349
|
-
* @public
|
|
350
349
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
350
|
+
* @public
|
|
351
351
|
*/
|
|
352
352
|
assistantId: string | undefined;
|
|
353
353
|
}
|
|
@@ -356,8 +356,8 @@ export interface GetAssistantAssociationRequest {
|
|
|
356
356
|
*/
|
|
357
357
|
export interface GetAssistantAssociationResponse {
|
|
358
358
|
/**
|
|
359
|
-
* @public
|
|
360
359
|
* <p>The assistant association.</p>
|
|
360
|
+
* @public
|
|
361
361
|
*/
|
|
362
362
|
assistantAssociation?: AssistantAssociationData;
|
|
363
363
|
}
|
|
@@ -366,60 +366,60 @@ export interface GetAssistantAssociationResponse {
|
|
|
366
366
|
*/
|
|
367
367
|
export interface ListAssistantAssociationsRequest {
|
|
368
368
|
/**
|
|
369
|
-
* @public
|
|
370
369
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
371
370
|
* response in the next request to retrieve the next set of results.</p>
|
|
371
|
+
* @public
|
|
372
372
|
*/
|
|
373
373
|
nextToken?: string;
|
|
374
374
|
/**
|
|
375
|
-
* @public
|
|
376
375
|
* <p>The maximum number of results to return per page.</p>
|
|
376
|
+
* @public
|
|
377
377
|
*/
|
|
378
378
|
maxResults?: number;
|
|
379
379
|
/**
|
|
380
|
-
* @public
|
|
381
380
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
381
|
+
* @public
|
|
382
382
|
*/
|
|
383
383
|
assistantId: string | undefined;
|
|
384
384
|
}
|
|
385
385
|
/**
|
|
386
|
-
* @public
|
|
387
386
|
* <p>Summary information about the assistant association.</p>
|
|
387
|
+
* @public
|
|
388
388
|
*/
|
|
389
389
|
export interface AssistantAssociationSummary {
|
|
390
390
|
/**
|
|
391
|
-
* @public
|
|
392
391
|
* <p>The identifier of the assistant association.</p>
|
|
392
|
+
* @public
|
|
393
393
|
*/
|
|
394
394
|
assistantAssociationId: string | undefined;
|
|
395
395
|
/**
|
|
396
|
-
* @public
|
|
397
396
|
* <p>The Amazon Resource Name (ARN) of the assistant association.</p>
|
|
397
|
+
* @public
|
|
398
398
|
*/
|
|
399
399
|
assistantAssociationArn: string | undefined;
|
|
400
400
|
/**
|
|
401
|
-
* @public
|
|
402
401
|
* <p>The identifier of the Amazon Q assistant.</p>
|
|
402
|
+
* @public
|
|
403
403
|
*/
|
|
404
404
|
assistantId: string | undefined;
|
|
405
405
|
/**
|
|
406
|
-
* @public
|
|
407
406
|
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
407
|
+
* @public
|
|
408
408
|
*/
|
|
409
409
|
assistantArn: string | undefined;
|
|
410
410
|
/**
|
|
411
|
-
* @public
|
|
412
411
|
* <p>The type of association.</p>
|
|
412
|
+
* @public
|
|
413
413
|
*/
|
|
414
414
|
associationType: AssociationType | undefined;
|
|
415
415
|
/**
|
|
416
|
-
* @public
|
|
417
416
|
* <p>The association data.</p>
|
|
417
|
+
* @public
|
|
418
418
|
*/
|
|
419
419
|
associationData: AssistantAssociationOutputData | undefined;
|
|
420
420
|
/**
|
|
421
|
-
* @public
|
|
422
421
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
422
|
+
* @public
|
|
423
423
|
*/
|
|
424
424
|
tags?: Record<string, string>;
|
|
425
425
|
}
|
|
@@ -428,26 +428,26 @@ export interface AssistantAssociationSummary {
|
|
|
428
428
|
*/
|
|
429
429
|
export interface ListAssistantAssociationsResponse {
|
|
430
430
|
/**
|
|
431
|
-
* @public
|
|
432
431
|
* <p>Summary information about assistant associations.</p>
|
|
432
|
+
* @public
|
|
433
433
|
*/
|
|
434
434
|
assistantAssociationSummaries: AssistantAssociationSummary[] | undefined;
|
|
435
435
|
/**
|
|
436
|
-
* @public
|
|
437
436
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
437
|
+
* @public
|
|
438
438
|
*/
|
|
439
439
|
nextToken?: string;
|
|
440
440
|
}
|
|
441
441
|
/**
|
|
442
|
-
* @public
|
|
443
442
|
* <p>The configuration information for the customer managed key used for encryption.</p>
|
|
443
|
+
* @public
|
|
444
444
|
*/
|
|
445
445
|
export interface ServerSideEncryptionConfiguration {
|
|
446
446
|
/**
|
|
447
|
-
* @public
|
|
448
447
|
* <p>The customer managed key used for encryption. For more information about setting up a
|
|
449
448
|
* customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.
|
|
450
449
|
* For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a>.</p>
|
|
450
|
+
* @public
|
|
451
451
|
*/
|
|
452
452
|
kmsKeyId?: string;
|
|
453
453
|
}
|
|
@@ -467,35 +467,34 @@ export type AssistantType = (typeof AssistantType)[keyof typeof AssistantType];
|
|
|
467
467
|
*/
|
|
468
468
|
export interface CreateAssistantRequest {
|
|
469
469
|
/**
|
|
470
|
-
* @public
|
|
471
470
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
472
471
|
* request. If not provided, the Amazon Web Services
|
|
473
472
|
* SDK populates this field. For more information about idempotency, see
|
|
474
473
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
474
|
+
* @public
|
|
475
475
|
*/
|
|
476
476
|
clientToken?: string;
|
|
477
477
|
/**
|
|
478
|
-
* @public
|
|
479
478
|
* <p>The name of the assistant.</p>
|
|
479
|
+
* @public
|
|
480
480
|
*/
|
|
481
481
|
name: string | undefined;
|
|
482
482
|
/**
|
|
483
|
-
* @public
|
|
484
483
|
* <p>The type of assistant.</p>
|
|
484
|
+
* @public
|
|
485
485
|
*/
|
|
486
486
|
type: AssistantType | undefined;
|
|
487
487
|
/**
|
|
488
|
-
* @public
|
|
489
488
|
* <p>The description of the assistant.</p>
|
|
489
|
+
* @public
|
|
490
490
|
*/
|
|
491
491
|
description?: string;
|
|
492
492
|
/**
|
|
493
|
-
* @public
|
|
494
493
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
494
|
+
* @public
|
|
495
495
|
*/
|
|
496
496
|
tags?: Record<string, string>;
|
|
497
497
|
/**
|
|
498
|
-
* @public
|
|
499
498
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
500
499
|
* <p>The customer managed key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
501
500
|
* <code> kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
@@ -506,6 +505,7 @@ export interface CreateAssistantRequest {
|
|
|
506
505
|
* principal. </p>
|
|
507
506
|
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
508
507
|
* your instance</a>.</p>
|
|
508
|
+
* @public
|
|
509
509
|
*/
|
|
510
510
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
511
511
|
}
|
|
@@ -522,24 +522,24 @@ export declare const AssistantCapabilityType: {
|
|
|
522
522
|
*/
|
|
523
523
|
export type AssistantCapabilityType = (typeof AssistantCapabilityType)[keyof typeof AssistantCapabilityType];
|
|
524
524
|
/**
|
|
525
|
-
* @public
|
|
526
525
|
* <p>The capability configuration for an Amazon Q assistant. </p>
|
|
526
|
+
* @public
|
|
527
527
|
*/
|
|
528
528
|
export interface AssistantCapabilityConfiguration {
|
|
529
529
|
/**
|
|
530
|
-
* @public
|
|
531
530
|
* <p>The type of Amazon Q assistant capability. </p>
|
|
531
|
+
* @public
|
|
532
532
|
*/
|
|
533
533
|
type?: AssistantCapabilityType;
|
|
534
534
|
}
|
|
535
535
|
/**
|
|
536
|
-
* @public
|
|
537
536
|
* <p>The configuration information for the Amazon Q assistant integration.</p>
|
|
537
|
+
* @public
|
|
538
538
|
*/
|
|
539
539
|
export interface AssistantIntegrationConfiguration {
|
|
540
540
|
/**
|
|
541
|
-
* @public
|
|
542
541
|
* <p>The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.</p>
|
|
542
|
+
* @public
|
|
543
543
|
*/
|
|
544
544
|
topicIntegrationArn?: string;
|
|
545
545
|
}
|
|
@@ -560,47 +560,46 @@ export declare const AssistantStatus: {
|
|
|
560
560
|
*/
|
|
561
561
|
export type AssistantStatus = (typeof AssistantStatus)[keyof typeof AssistantStatus];
|
|
562
562
|
/**
|
|
563
|
-
* @public
|
|
564
563
|
* <p>The assistant data.</p>
|
|
564
|
+
* @public
|
|
565
565
|
*/
|
|
566
566
|
export interface AssistantData {
|
|
567
567
|
/**
|
|
568
|
-
* @public
|
|
569
568
|
* <p>The identifier of the Amazon Q assistant.</p>
|
|
569
|
+
* @public
|
|
570
570
|
*/
|
|
571
571
|
assistantId: string | undefined;
|
|
572
572
|
/**
|
|
573
|
-
* @public
|
|
574
573
|
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
574
|
+
* @public
|
|
575
575
|
*/
|
|
576
576
|
assistantArn: string | undefined;
|
|
577
577
|
/**
|
|
578
|
-
* @public
|
|
579
578
|
* <p>The name.</p>
|
|
579
|
+
* @public
|
|
580
580
|
*/
|
|
581
581
|
name: string | undefined;
|
|
582
582
|
/**
|
|
583
|
-
* @public
|
|
584
583
|
* <p>The type of assistant.</p>
|
|
584
|
+
* @public
|
|
585
585
|
*/
|
|
586
586
|
type: AssistantType | undefined;
|
|
587
587
|
/**
|
|
588
|
-
* @public
|
|
589
588
|
* <p>The status of the assistant.</p>
|
|
589
|
+
* @public
|
|
590
590
|
*/
|
|
591
591
|
status: AssistantStatus | undefined;
|
|
592
592
|
/**
|
|
593
|
-
* @public
|
|
594
593
|
* <p>The description.</p>
|
|
594
|
+
* @public
|
|
595
595
|
*/
|
|
596
596
|
description?: string;
|
|
597
597
|
/**
|
|
598
|
-
* @public
|
|
599
598
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
599
|
+
* @public
|
|
600
600
|
*/
|
|
601
601
|
tags?: Record<string, string>;
|
|
602
602
|
/**
|
|
603
|
-
* @public
|
|
604
603
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
605
604
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
606
605
|
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
@@ -611,16 +610,17 @@ export interface AssistantData {
|
|
|
611
610
|
* principal. </p>
|
|
612
611
|
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
613
612
|
* your instance</a>.</p>
|
|
613
|
+
* @public
|
|
614
614
|
*/
|
|
615
615
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
616
616
|
/**
|
|
617
|
-
* @public
|
|
618
617
|
* <p>The configuration information for the Amazon Q assistant integration.</p>
|
|
618
|
+
* @public
|
|
619
619
|
*/
|
|
620
620
|
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
621
621
|
/**
|
|
622
|
-
* @public
|
|
623
622
|
* <p>The configuration information for the Amazon Q assistant capability. </p>
|
|
623
|
+
* @public
|
|
624
624
|
*/
|
|
625
625
|
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
|
626
626
|
}
|
|
@@ -629,8 +629,8 @@ export interface AssistantData {
|
|
|
629
629
|
*/
|
|
630
630
|
export interface CreateAssistantResponse {
|
|
631
631
|
/**
|
|
632
|
-
* @public
|
|
633
632
|
* <p>Information about the assistant.</p>
|
|
633
|
+
* @public
|
|
634
634
|
*/
|
|
635
635
|
assistant?: AssistantData;
|
|
636
636
|
}
|
|
@@ -639,8 +639,8 @@ export interface CreateAssistantResponse {
|
|
|
639
639
|
*/
|
|
640
640
|
export interface DeleteAssistantRequest {
|
|
641
641
|
/**
|
|
642
|
-
* @public
|
|
643
642
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
643
|
+
* @public
|
|
644
644
|
*/
|
|
645
645
|
assistantId: string | undefined;
|
|
646
646
|
}
|
|
@@ -654,8 +654,8 @@ export interface DeleteAssistantResponse {
|
|
|
654
654
|
*/
|
|
655
655
|
export interface GetAssistantRequest {
|
|
656
656
|
/**
|
|
657
|
-
* @public
|
|
658
657
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
658
|
+
* @public
|
|
659
659
|
*/
|
|
660
660
|
assistantId: string | undefined;
|
|
661
661
|
}
|
|
@@ -664,8 +664,8 @@ export interface GetAssistantRequest {
|
|
|
664
664
|
*/
|
|
665
665
|
export interface GetAssistantResponse {
|
|
666
666
|
/**
|
|
667
|
-
* @public
|
|
668
667
|
* <p>Information about the assistant.</p>
|
|
668
|
+
* @public
|
|
669
669
|
*/
|
|
670
670
|
assistant?: AssistantData;
|
|
671
671
|
}
|
|
@@ -674,26 +674,26 @@ export interface GetAssistantResponse {
|
|
|
674
674
|
*/
|
|
675
675
|
export interface GetRecommendationsRequest {
|
|
676
676
|
/**
|
|
677
|
-
* @public
|
|
678
677
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
678
|
+
* @public
|
|
679
679
|
*/
|
|
680
680
|
assistantId: string | undefined;
|
|
681
681
|
/**
|
|
682
|
-
* @public
|
|
683
682
|
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
683
|
+
* @public
|
|
684
684
|
*/
|
|
685
685
|
sessionId: string | undefined;
|
|
686
686
|
/**
|
|
687
|
-
* @public
|
|
688
687
|
* <p>The maximum number of results to return per page.</p>
|
|
688
|
+
* @public
|
|
689
689
|
*/
|
|
690
690
|
maxResults?: number;
|
|
691
691
|
/**
|
|
692
|
-
* @public
|
|
693
692
|
* <p>The duration (in seconds) for which the call waits for a recommendation to be made
|
|
694
693
|
* available before returning. If a recommendation is available, the call returns sooner than
|
|
695
694
|
* <code>WaitTimeSeconds</code>. If no messages are available and the wait time expires, the
|
|
696
695
|
* call returns successfully with an empty list.</p>
|
|
696
|
+
* @public
|
|
697
697
|
*/
|
|
698
698
|
waitTimeSeconds?: number;
|
|
699
699
|
}
|
|
@@ -711,83 +711,83 @@ export declare const RelevanceLevel: {
|
|
|
711
711
|
*/
|
|
712
712
|
export type RelevanceLevel = (typeof RelevanceLevel)[keyof typeof RelevanceLevel];
|
|
713
713
|
/**
|
|
714
|
-
* @public
|
|
715
714
|
* <p>Details about the source content ranking data.</p>
|
|
715
|
+
* @public
|
|
716
716
|
*/
|
|
717
717
|
export interface RankingData {
|
|
718
718
|
/**
|
|
719
|
-
* @public
|
|
720
719
|
* <p>The relevance level of the recommendation.</p>
|
|
720
|
+
* @public
|
|
721
721
|
*/
|
|
722
722
|
relevanceScore?: number;
|
|
723
723
|
/**
|
|
724
|
-
* @public
|
|
725
724
|
* <p>The relevance score of the content.</p>
|
|
725
|
+
* @public
|
|
726
726
|
*/
|
|
727
727
|
relevanceLevel?: RelevanceLevel;
|
|
728
728
|
}
|
|
729
729
|
/**
|
|
730
|
-
* @public
|
|
731
730
|
* <p>Offset specification to describe highlighting of document excerpts for rendering search
|
|
732
731
|
* results and recommendations.</p>
|
|
732
|
+
* @public
|
|
733
733
|
*/
|
|
734
734
|
export interface Highlight {
|
|
735
735
|
/**
|
|
736
|
-
* @public
|
|
737
736
|
* <p>The offset for the start of the highlight.</p>
|
|
737
|
+
* @public
|
|
738
738
|
*/
|
|
739
739
|
beginOffsetInclusive?: number;
|
|
740
740
|
/**
|
|
741
|
-
* @public
|
|
742
741
|
* <p>The offset for the end of the highlight.</p>
|
|
742
|
+
* @public
|
|
743
743
|
*/
|
|
744
744
|
endOffsetExclusive?: number;
|
|
745
745
|
}
|
|
746
746
|
/**
|
|
747
|
-
* @public
|
|
748
747
|
* <p>The text of the document.</p>
|
|
748
|
+
* @public
|
|
749
749
|
*/
|
|
750
750
|
export interface DocumentText {
|
|
751
751
|
/**
|
|
752
|
-
* @public
|
|
753
752
|
* <p>Text in the document.</p>
|
|
753
|
+
* @public
|
|
754
754
|
*/
|
|
755
755
|
text?: string;
|
|
756
756
|
/**
|
|
757
|
-
* @public
|
|
758
757
|
* <p>Highlights in the document text.</p>
|
|
758
|
+
* @public
|
|
759
759
|
*/
|
|
760
760
|
highlights?: Highlight[];
|
|
761
761
|
}
|
|
762
762
|
/**
|
|
763
|
-
* @public
|
|
764
763
|
* <p>Details about the source content text data.</p>
|
|
764
|
+
* @public
|
|
765
765
|
*/
|
|
766
766
|
export interface TextData {
|
|
767
767
|
/**
|
|
768
|
-
* @public
|
|
769
768
|
* <p>The text of the document.</p>
|
|
769
|
+
* @public
|
|
770
770
|
*/
|
|
771
771
|
title?: DocumentText;
|
|
772
772
|
/**
|
|
773
|
-
* @public
|
|
774
773
|
* <p>The text of the document.</p>
|
|
774
|
+
* @public
|
|
775
775
|
*/
|
|
776
776
|
excerpt?: DocumentText;
|
|
777
777
|
}
|
|
778
778
|
/**
|
|
779
|
-
* @public
|
|
780
779
|
* <p>Details about the content data.</p>
|
|
780
|
+
* @public
|
|
781
781
|
*/
|
|
782
782
|
export interface ContentDataDetails {
|
|
783
783
|
/**
|
|
784
|
-
* @public
|
|
785
784
|
* <p>Details about the content text data.</p>
|
|
785
|
+
* @public
|
|
786
786
|
*/
|
|
787
787
|
textData: TextData | undefined;
|
|
788
788
|
/**
|
|
789
|
-
* @public
|
|
790
789
|
* <p>Details about the content ranking data.</p>
|
|
790
|
+
* @public
|
|
791
791
|
*/
|
|
792
792
|
rankingData: RankingData | undefined;
|
|
793
793
|
}
|
|
@@ -803,77 +803,77 @@ export declare const SourceContentType: {
|
|
|
803
803
|
*/
|
|
804
804
|
export type SourceContentType = (typeof SourceContentType)[keyof typeof SourceContentType];
|
|
805
805
|
/**
|
|
806
|
-
* @public
|
|
807
806
|
* <p>Details about the source content data.</p>
|
|
807
|
+
* @public
|
|
808
808
|
*/
|
|
809
809
|
export interface SourceContentDataDetails {
|
|
810
810
|
/**
|
|
811
|
-
* @public
|
|
812
811
|
* <p>The identifier of the source content.</p>
|
|
812
|
+
* @public
|
|
813
813
|
*/
|
|
814
814
|
id: string | undefined;
|
|
815
815
|
/**
|
|
816
|
-
* @public
|
|
817
816
|
* <p>The type of the source content.</p>
|
|
817
|
+
* @public
|
|
818
818
|
*/
|
|
819
819
|
type: SourceContentType | undefined;
|
|
820
820
|
/**
|
|
821
|
-
* @public
|
|
822
821
|
* <p> Details about the source content text data.</p>
|
|
822
|
+
* @public
|
|
823
823
|
*/
|
|
824
824
|
textData: TextData | undefined;
|
|
825
825
|
/**
|
|
826
|
-
* @public
|
|
827
826
|
* <p>Details about the source content ranking data.</p>
|
|
827
|
+
* @public
|
|
828
828
|
*/
|
|
829
829
|
rankingData: RankingData | undefined;
|
|
830
830
|
}
|
|
831
831
|
/**
|
|
832
|
-
* @public
|
|
833
832
|
* <p>Reference information about the content.</p>
|
|
833
|
+
* @public
|
|
834
834
|
*/
|
|
835
835
|
export interface ContentReference {
|
|
836
836
|
/**
|
|
837
|
-
* @public
|
|
838
837
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
838
|
+
* @public
|
|
839
839
|
*/
|
|
840
840
|
knowledgeBaseArn?: string;
|
|
841
841
|
/**
|
|
842
|
-
* @public
|
|
843
842
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
844
843
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
844
|
+
* @public
|
|
845
845
|
*/
|
|
846
846
|
knowledgeBaseId?: string;
|
|
847
847
|
/**
|
|
848
|
-
* @public
|
|
849
848
|
* <p>The Amazon Resource Name (ARN) of the content.</p>
|
|
849
|
+
* @public
|
|
850
850
|
*/
|
|
851
851
|
contentArn?: string;
|
|
852
852
|
/**
|
|
853
|
-
* @public
|
|
854
853
|
* <p>The identifier of the content.</p>
|
|
854
|
+
* @public
|
|
855
855
|
*/
|
|
856
856
|
contentId?: string;
|
|
857
857
|
}
|
|
858
858
|
/**
|
|
859
|
-
* @public
|
|
860
859
|
* <p>Reference information about generative content.</p>
|
|
860
|
+
* @public
|
|
861
861
|
*/
|
|
862
862
|
export interface GenerativeReference {
|
|
863
863
|
/**
|
|
864
|
-
* @public
|
|
865
864
|
* <p>The identifier of the LLM model. </p>
|
|
865
|
+
* @public
|
|
866
866
|
*/
|
|
867
867
|
modelId?: string;
|
|
868
868
|
/**
|
|
869
|
-
* @public
|
|
870
869
|
* <p> The identifier of the LLM model. </p>
|
|
870
|
+
* @public
|
|
871
871
|
*/
|
|
872
872
|
generationId?: string;
|
|
873
873
|
}
|
|
874
874
|
/**
|
|
875
|
-
* @public
|
|
876
875
|
* <p>Reference data.</p>
|
|
876
|
+
* @public
|
|
877
877
|
*/
|
|
878
878
|
export type DataReference = DataReference.ContentReferenceMember | DataReference.GenerativeReferenceMember | DataReference.$UnknownMember;
|
|
879
879
|
/**
|
|
@@ -881,8 +881,8 @@ export type DataReference = DataReference.ContentReferenceMember | DataReference
|
|
|
881
881
|
*/
|
|
882
882
|
export declare namespace DataReference {
|
|
883
883
|
/**
|
|
884
|
-
* @public
|
|
885
884
|
* <p>Reference information about the content.</p>
|
|
885
|
+
* @public
|
|
886
886
|
*/
|
|
887
887
|
interface ContentReferenceMember {
|
|
888
888
|
contentReference: ContentReference;
|
|
@@ -890,8 +890,8 @@ export declare namespace DataReference {
|
|
|
890
890
|
$unknown?: never;
|
|
891
891
|
}
|
|
892
892
|
/**
|
|
893
|
-
* @public
|
|
894
893
|
* <p>Reference information about the generative content.</p>
|
|
894
|
+
* @public
|
|
895
895
|
*/
|
|
896
896
|
interface GenerativeReferenceMember {
|
|
897
897
|
contentReference?: never;
|
|
@@ -914,23 +914,23 @@ export declare namespace DataReference {
|
|
|
914
914
|
const visit: <T>(value: DataReference, visitor: Visitor<T>) => T;
|
|
915
915
|
}
|
|
916
916
|
/**
|
|
917
|
-
* @public
|
|
918
917
|
* <p>The document.</p>
|
|
918
|
+
* @public
|
|
919
919
|
*/
|
|
920
920
|
export interface Document {
|
|
921
921
|
/**
|
|
922
|
-
* @public
|
|
923
922
|
* <p>A reference to the content resource.</p>
|
|
923
|
+
* @public
|
|
924
924
|
*/
|
|
925
925
|
contentReference: ContentReference | undefined;
|
|
926
926
|
/**
|
|
927
|
-
* @public
|
|
928
927
|
* <p>The title of the document.</p>
|
|
928
|
+
* @public
|
|
929
929
|
*/
|
|
930
930
|
title?: DocumentText;
|
|
931
931
|
/**
|
|
932
|
-
* @public
|
|
933
932
|
* <p>The excerpt from the document.</p>
|
|
933
|
+
* @public
|
|
934
934
|
*/
|
|
935
935
|
excerpt?: DocumentText;
|
|
936
936
|
}
|
|
@@ -948,19 +948,19 @@ export declare const RecommendationType: {
|
|
|
948
948
|
*/
|
|
949
949
|
export type RecommendationType = (typeof RecommendationType)[keyof typeof RecommendationType];
|
|
950
950
|
/**
|
|
951
|
-
* @public
|
|
952
951
|
* <p>Data associated with the QUERY RecommendationTriggerType.</p>
|
|
952
|
+
* @public
|
|
953
953
|
*/
|
|
954
954
|
export interface QueryRecommendationTriggerData {
|
|
955
955
|
/**
|
|
956
|
-
* @public
|
|
957
956
|
* <p>The text associated with the recommendation trigger.</p>
|
|
957
|
+
* @public
|
|
958
958
|
*/
|
|
959
959
|
text?: string;
|
|
960
960
|
}
|
|
961
961
|
/**
|
|
962
|
-
* @public
|
|
963
962
|
* <p>A union type containing information related to the trigger.</p>
|
|
963
|
+
* @public
|
|
964
964
|
*/
|
|
965
965
|
export type RecommendationTriggerData = RecommendationTriggerData.QueryMember | RecommendationTriggerData.$UnknownMember;
|
|
966
966
|
/**
|
|
@@ -968,8 +968,8 @@ export type RecommendationTriggerData = RecommendationTriggerData.QueryMember |
|
|
|
968
968
|
*/
|
|
969
969
|
export declare namespace RecommendationTriggerData {
|
|
970
970
|
/**
|
|
971
|
-
* @public
|
|
972
971
|
* <p>Data associated with the QUERY RecommendationTriggerType.</p>
|
|
972
|
+
* @public
|
|
973
973
|
*/
|
|
974
974
|
interface QueryMember {
|
|
975
975
|
query: QueryRecommendationTriggerData;
|
|
@@ -1014,24 +1014,23 @@ export declare const RecommendationTriggerType: {
|
|
|
1014
1014
|
*/
|
|
1015
1015
|
export type RecommendationTriggerType = (typeof RecommendationTriggerType)[keyof typeof RecommendationTriggerType];
|
|
1016
1016
|
/**
|
|
1017
|
-
* @public
|
|
1018
1017
|
* <p>A recommendation trigger provides context on the event that produced the referenced
|
|
1019
1018
|
* recommendations. Recommendations are only referenced in <code>recommendationIds</code> by a
|
|
1020
1019
|
* single RecommendationTrigger.</p>
|
|
1020
|
+
* @public
|
|
1021
1021
|
*/
|
|
1022
1022
|
export interface RecommendationTrigger {
|
|
1023
1023
|
/**
|
|
1024
|
-
* @public
|
|
1025
1024
|
* <p>The identifier of the recommendation trigger.</p>
|
|
1025
|
+
* @public
|
|
1026
1026
|
*/
|
|
1027
1027
|
id: string | undefined;
|
|
1028
1028
|
/**
|
|
1029
|
-
* @public
|
|
1030
1029
|
* <p>The type of recommendation trigger.</p>
|
|
1030
|
+
* @public
|
|
1031
1031
|
*/
|
|
1032
1032
|
type: RecommendationTriggerType | undefined;
|
|
1033
1033
|
/**
|
|
1034
|
-
* @public
|
|
1035
1034
|
* <p>The source of the recommendation trigger.</p>
|
|
1036
1035
|
* <ul>
|
|
1037
1036
|
* <li>
|
|
@@ -1043,16 +1042,17 @@ export interface RecommendationTrigger {
|
|
|
1043
1042
|
* rule.</p>
|
|
1044
1043
|
* </li>
|
|
1045
1044
|
* </ul>
|
|
1045
|
+
* @public
|
|
1046
1046
|
*/
|
|
1047
1047
|
source: RecommendationSourceType | undefined;
|
|
1048
1048
|
/**
|
|
1049
|
-
* @public
|
|
1050
1049
|
* <p>A union type containing information related to the trigger.</p>
|
|
1050
|
+
* @public
|
|
1051
1051
|
*/
|
|
1052
1052
|
data: RecommendationTriggerData | undefined;
|
|
1053
1053
|
/**
|
|
1054
|
-
* @public
|
|
1055
1054
|
* <p>The identifiers of the recommendations.</p>
|
|
1055
|
+
* @public
|
|
1056
1056
|
*/
|
|
1057
1057
|
recommendationIds: string[] | undefined;
|
|
1058
1058
|
}
|
|
@@ -1061,59 +1061,58 @@ export interface RecommendationTrigger {
|
|
|
1061
1061
|
*/
|
|
1062
1062
|
export interface ListAssistantsRequest {
|
|
1063
1063
|
/**
|
|
1064
|
-
* @public
|
|
1065
1064
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1066
1065
|
* response in the next request to retrieve the next set of results.</p>
|
|
1066
|
+
* @public
|
|
1067
1067
|
*/
|
|
1068
1068
|
nextToken?: string;
|
|
1069
1069
|
/**
|
|
1070
|
-
* @public
|
|
1071
1070
|
* <p>The maximum number of results to return per page.</p>
|
|
1071
|
+
* @public
|
|
1072
1072
|
*/
|
|
1073
1073
|
maxResults?: number;
|
|
1074
1074
|
}
|
|
1075
1075
|
/**
|
|
1076
|
-
* @public
|
|
1077
1076
|
* <p>Summary information about the assistant.</p>
|
|
1077
|
+
* @public
|
|
1078
1078
|
*/
|
|
1079
1079
|
export interface AssistantSummary {
|
|
1080
1080
|
/**
|
|
1081
|
-
* @public
|
|
1082
1081
|
* <p>The identifier of the Amazon Q assistant.</p>
|
|
1082
|
+
* @public
|
|
1083
1083
|
*/
|
|
1084
1084
|
assistantId: string | undefined;
|
|
1085
1085
|
/**
|
|
1086
|
-
* @public
|
|
1087
1086
|
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
1087
|
+
* @public
|
|
1088
1088
|
*/
|
|
1089
1089
|
assistantArn: string | undefined;
|
|
1090
1090
|
/**
|
|
1091
|
-
* @public
|
|
1092
1091
|
* <p>The name of the assistant.</p>
|
|
1092
|
+
* @public
|
|
1093
1093
|
*/
|
|
1094
1094
|
name: string | undefined;
|
|
1095
1095
|
/**
|
|
1096
|
-
* @public
|
|
1097
1096
|
* <p>The type of the assistant.</p>
|
|
1097
|
+
* @public
|
|
1098
1098
|
*/
|
|
1099
1099
|
type: AssistantType | undefined;
|
|
1100
1100
|
/**
|
|
1101
|
-
* @public
|
|
1102
1101
|
* <p>The status of the assistant.</p>
|
|
1102
|
+
* @public
|
|
1103
1103
|
*/
|
|
1104
1104
|
status: AssistantStatus | undefined;
|
|
1105
1105
|
/**
|
|
1106
|
-
* @public
|
|
1107
1106
|
* <p>The description of the assistant.</p>
|
|
1107
|
+
* @public
|
|
1108
1108
|
*/
|
|
1109
1109
|
description?: string;
|
|
1110
1110
|
/**
|
|
1111
|
-
* @public
|
|
1112
1111
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1112
|
+
* @public
|
|
1113
1113
|
*/
|
|
1114
1114
|
tags?: Record<string, string>;
|
|
1115
1115
|
/**
|
|
1116
|
-
* @public
|
|
1117
1116
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
1118
1117
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
1119
1118
|
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
@@ -1124,16 +1123,17 @@ export interface AssistantSummary {
|
|
|
1124
1123
|
* principal. </p>
|
|
1125
1124
|
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
1126
1125
|
* your instance</a>.</p>
|
|
1126
|
+
* @public
|
|
1127
1127
|
*/
|
|
1128
1128
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
1129
1129
|
/**
|
|
1130
|
-
* @public
|
|
1131
1130
|
* <p>The configuration information for the Amazon Q assistant integration.</p>
|
|
1131
|
+
* @public
|
|
1132
1132
|
*/
|
|
1133
1133
|
integrationConfiguration?: AssistantIntegrationConfiguration;
|
|
1134
1134
|
/**
|
|
1135
|
-
* @public
|
|
1136
1135
|
* <p>The configuration information for the Amazon Q assistant capability. </p>
|
|
1136
|
+
* @public
|
|
1137
1137
|
*/
|
|
1138
1138
|
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
|
1139
1139
|
}
|
|
@@ -1142,13 +1142,13 @@ export interface AssistantSummary {
|
|
|
1142
1142
|
*/
|
|
1143
1143
|
export interface ListAssistantsResponse {
|
|
1144
1144
|
/**
|
|
1145
|
-
* @public
|
|
1146
1145
|
* <p>Information about the assistants.</p>
|
|
1146
|
+
* @public
|
|
1147
1147
|
*/
|
|
1148
1148
|
assistantSummaries: AssistantSummary[] | undefined;
|
|
1149
1149
|
/**
|
|
1150
|
-
* @public
|
|
1151
1150
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1151
|
+
* @public
|
|
1152
1152
|
*/
|
|
1153
1153
|
nextToken?: string;
|
|
1154
1154
|
}
|
|
@@ -1157,34 +1157,34 @@ export interface ListAssistantsResponse {
|
|
|
1157
1157
|
*/
|
|
1158
1158
|
export interface NotifyRecommendationsReceivedRequest {
|
|
1159
1159
|
/**
|
|
1160
|
-
* @public
|
|
1161
1160
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1161
|
+
* @public
|
|
1162
1162
|
*/
|
|
1163
1163
|
assistantId: string | undefined;
|
|
1164
1164
|
/**
|
|
1165
|
-
* @public
|
|
1166
1165
|
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1166
|
+
* @public
|
|
1167
1167
|
*/
|
|
1168
1168
|
sessionId: string | undefined;
|
|
1169
1169
|
/**
|
|
1170
|
-
* @public
|
|
1171
1170
|
* <p>The identifiers of the recommendations.</p>
|
|
1171
|
+
* @public
|
|
1172
1172
|
*/
|
|
1173
1173
|
recommendationIds: string[] | undefined;
|
|
1174
1174
|
}
|
|
1175
1175
|
/**
|
|
1176
|
-
* @public
|
|
1177
1176
|
* <p>An error occurred when creating a recommendation.</p>
|
|
1177
|
+
* @public
|
|
1178
1178
|
*/
|
|
1179
1179
|
export interface NotifyRecommendationsReceivedError {
|
|
1180
1180
|
/**
|
|
1181
|
-
* @public
|
|
1182
1181
|
* <p>The identifier of the recommendation that is in error.</p>
|
|
1182
|
+
* @public
|
|
1183
1183
|
*/
|
|
1184
1184
|
recommendationId?: string;
|
|
1185
1185
|
/**
|
|
1186
|
-
* @public
|
|
1187
1186
|
* <p>A recommendation is causing an error.</p>
|
|
1187
|
+
* @public
|
|
1188
1188
|
*/
|
|
1189
1189
|
message?: string;
|
|
1190
1190
|
}
|
|
@@ -1193,13 +1193,13 @@ export interface NotifyRecommendationsReceivedError {
|
|
|
1193
1193
|
*/
|
|
1194
1194
|
export interface NotifyRecommendationsReceivedResponse {
|
|
1195
1195
|
/**
|
|
1196
|
-
* @public
|
|
1197
1196
|
* <p>The identifiers of the recommendations.</p>
|
|
1197
|
+
* @public
|
|
1198
1198
|
*/
|
|
1199
1199
|
recommendationIds?: string[];
|
|
1200
1200
|
/**
|
|
1201
|
-
* @public
|
|
1202
1201
|
* <p>The identifiers of recommendations that are causing errors.</p>
|
|
1202
|
+
* @public
|
|
1203
1203
|
*/
|
|
1204
1204
|
errors?: NotifyRecommendationsReceivedError[];
|
|
1205
1205
|
}
|
|
@@ -1216,19 +1216,19 @@ export declare const Relevance: {
|
|
|
1216
1216
|
*/
|
|
1217
1217
|
export type Relevance = (typeof Relevance)[keyof typeof Relevance];
|
|
1218
1218
|
/**
|
|
1219
|
-
* @public
|
|
1220
1219
|
* <p>The feedback information for a generative target type.</p>
|
|
1220
|
+
* @public
|
|
1221
1221
|
*/
|
|
1222
1222
|
export interface GenerativeContentFeedbackData {
|
|
1223
1223
|
/**
|
|
1224
|
-
* @public
|
|
1225
1224
|
* <p>The relevance of the feedback.</p>
|
|
1225
|
+
* @public
|
|
1226
1226
|
*/
|
|
1227
1227
|
relevance: Relevance | undefined;
|
|
1228
1228
|
}
|
|
1229
1229
|
/**
|
|
1230
|
-
* @public
|
|
1231
1230
|
* <p>Information about the feedback.</p>
|
|
1231
|
+
* @public
|
|
1232
1232
|
*/
|
|
1233
1233
|
export type ContentFeedbackData = ContentFeedbackData.GenerativeContentFeedbackDataMember | ContentFeedbackData.$UnknownMember;
|
|
1234
1234
|
/**
|
|
@@ -1236,8 +1236,8 @@ export type ContentFeedbackData = ContentFeedbackData.GenerativeContentFeedbackD
|
|
|
1236
1236
|
*/
|
|
1237
1237
|
export declare namespace ContentFeedbackData {
|
|
1238
1238
|
/**
|
|
1239
|
-
* @public
|
|
1240
1239
|
* <p>Information about the feedback for a generative target type.</p>
|
|
1240
|
+
* @public
|
|
1241
1241
|
*/
|
|
1242
1242
|
interface GenerativeContentFeedbackDataMember {
|
|
1243
1243
|
generativeContentFeedbackData: GenerativeContentFeedbackData;
|
|
@@ -1273,23 +1273,23 @@ export type TargetType = (typeof TargetType)[keyof typeof TargetType];
|
|
|
1273
1273
|
*/
|
|
1274
1274
|
export interface PutFeedbackRequest {
|
|
1275
1275
|
/**
|
|
1276
|
-
* @public
|
|
1277
1276
|
* <p>The identifier of the Amazon Q assistant.</p>
|
|
1277
|
+
* @public
|
|
1278
1278
|
*/
|
|
1279
1279
|
assistantId: string | undefined;
|
|
1280
1280
|
/**
|
|
1281
|
-
* @public
|
|
1282
1281
|
* <p>The identifier of the feedback target.</p>
|
|
1282
|
+
* @public
|
|
1283
1283
|
*/
|
|
1284
1284
|
targetId: string | undefined;
|
|
1285
1285
|
/**
|
|
1286
|
-
* @public
|
|
1287
1286
|
* <p>The type of the feedback target.</p>
|
|
1287
|
+
* @public
|
|
1288
1288
|
*/
|
|
1289
1289
|
targetType: TargetType | undefined;
|
|
1290
1290
|
/**
|
|
1291
|
-
* @public
|
|
1292
1291
|
* <p>Information about the feedback provided.</p>
|
|
1292
|
+
* @public
|
|
1293
1293
|
*/
|
|
1294
1294
|
contentFeedback: ContentFeedbackData | undefined;
|
|
1295
1295
|
}
|
|
@@ -1298,28 +1298,28 @@ export interface PutFeedbackRequest {
|
|
|
1298
1298
|
*/
|
|
1299
1299
|
export interface PutFeedbackResponse {
|
|
1300
1300
|
/**
|
|
1301
|
-
* @public
|
|
1302
1301
|
* <p>The identifier of the Amazon Q assistant.</p>
|
|
1302
|
+
* @public
|
|
1303
1303
|
*/
|
|
1304
1304
|
assistantId: string | undefined;
|
|
1305
1305
|
/**
|
|
1306
|
-
* @public
|
|
1307
1306
|
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
1307
|
+
* @public
|
|
1308
1308
|
*/
|
|
1309
1309
|
assistantArn: string | undefined;
|
|
1310
1310
|
/**
|
|
1311
|
-
* @public
|
|
1312
1311
|
* <p>The identifier of the feedback target.</p>
|
|
1312
|
+
* @public
|
|
1313
1313
|
*/
|
|
1314
1314
|
targetId: string | undefined;
|
|
1315
1315
|
/**
|
|
1316
|
-
* @public
|
|
1317
1316
|
* <p>The type of the feedback target.</p>
|
|
1317
|
+
* @public
|
|
1318
1318
|
*/
|
|
1319
1319
|
targetType: TargetType | undefined;
|
|
1320
1320
|
/**
|
|
1321
|
-
* @public
|
|
1322
1321
|
* <p>Information about the feedback provided.</p>
|
|
1322
|
+
* @public
|
|
1323
1323
|
*/
|
|
1324
1324
|
contentFeedback: ContentFeedbackData | undefined;
|
|
1325
1325
|
}
|
|
@@ -1346,29 +1346,29 @@ export declare const QueryConditionFieldName: {
|
|
|
1346
1346
|
*/
|
|
1347
1347
|
export type QueryConditionFieldName = (typeof QueryConditionFieldName)[keyof typeof QueryConditionFieldName];
|
|
1348
1348
|
/**
|
|
1349
|
-
* @public
|
|
1350
1349
|
* <p>The condition for the query.</p>
|
|
1350
|
+
* @public
|
|
1351
1351
|
*/
|
|
1352
1352
|
export interface QueryConditionItem {
|
|
1353
1353
|
/**
|
|
1354
|
-
* @public
|
|
1355
1354
|
* <p> The name of the field for query condition to query on.</p>
|
|
1355
|
+
* @public
|
|
1356
1356
|
*/
|
|
1357
1357
|
field: QueryConditionFieldName | undefined;
|
|
1358
1358
|
/**
|
|
1359
|
-
* @public
|
|
1360
1359
|
* <p>The comparison operator for query condition to query on.</p>
|
|
1360
|
+
* @public
|
|
1361
1361
|
*/
|
|
1362
1362
|
comparator: QueryConditionComparisonOperator | undefined;
|
|
1363
1363
|
/**
|
|
1364
|
-
* @public
|
|
1365
1364
|
* <p>The value for the query condition to query on.</p>
|
|
1365
|
+
* @public
|
|
1366
1366
|
*/
|
|
1367
1367
|
value: string | undefined;
|
|
1368
1368
|
}
|
|
1369
1369
|
/**
|
|
1370
|
-
* @public
|
|
1371
1370
|
* <p>Information about how to query content.</p>
|
|
1371
|
+
* @public
|
|
1372
1372
|
*/
|
|
1373
1373
|
export type QueryCondition = QueryCondition.SingleMember | QueryCondition.$UnknownMember;
|
|
1374
1374
|
/**
|
|
@@ -1376,8 +1376,8 @@ export type QueryCondition = QueryCondition.SingleMember | QueryCondition.$Unkno
|
|
|
1376
1376
|
*/
|
|
1377
1377
|
export declare namespace QueryCondition {
|
|
1378
1378
|
/**
|
|
1379
|
-
* @public
|
|
1380
1379
|
* <p>The condition for the query.</p>
|
|
1380
|
+
* @public
|
|
1381
1381
|
*/
|
|
1382
1382
|
interface SingleMember {
|
|
1383
1383
|
single: QueryConditionItem;
|
|
@@ -1401,35 +1401,35 @@ export declare namespace QueryCondition {
|
|
|
1401
1401
|
*/
|
|
1402
1402
|
export interface QueryAssistantRequest {
|
|
1403
1403
|
/**
|
|
1404
|
-
* @public
|
|
1405
1404
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1405
|
+
* @public
|
|
1406
1406
|
*/
|
|
1407
1407
|
assistantId: string | undefined;
|
|
1408
1408
|
/**
|
|
1409
|
-
* @public
|
|
1410
1409
|
* <p>The text to search for.</p>
|
|
1410
|
+
* @public
|
|
1411
1411
|
*/
|
|
1412
1412
|
queryText: string | undefined;
|
|
1413
1413
|
/**
|
|
1414
|
-
* @public
|
|
1415
1414
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1416
1415
|
* response in the next request to retrieve the next set of results.</p>
|
|
1416
|
+
* @public
|
|
1417
1417
|
*/
|
|
1418
1418
|
nextToken?: string;
|
|
1419
1419
|
/**
|
|
1420
|
-
* @public
|
|
1421
1420
|
* <p>The maximum number of results to return per page.</p>
|
|
1421
|
+
* @public
|
|
1422
1422
|
*/
|
|
1423
1423
|
maxResults?: number;
|
|
1424
1424
|
/**
|
|
1425
|
-
* @public
|
|
1426
1425
|
* <p>The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot
|
|
1427
1426
|
* contain the ARN.</p>
|
|
1427
|
+
* @public
|
|
1428
1428
|
*/
|
|
1429
1429
|
sessionId?: string;
|
|
1430
1430
|
/**
|
|
1431
|
-
* @public
|
|
1432
1431
|
* <p>Information about how to query content.</p>
|
|
1432
|
+
* @public
|
|
1433
1433
|
*/
|
|
1434
1434
|
queryCondition?: QueryCondition[];
|
|
1435
1435
|
}
|
|
@@ -1446,10 +1446,10 @@ export declare const QueryResultType: {
|
|
|
1446
1446
|
*/
|
|
1447
1447
|
export type QueryResultType = (typeof QueryResultType)[keyof typeof QueryResultType];
|
|
1448
1448
|
/**
|
|
1449
|
-
* @public
|
|
1450
1449
|
* <p>The request reached the service more than 15 minutes after the date stamp on the request
|
|
1451
1450
|
* or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or
|
|
1452
1451
|
* the date stamp on the request is more than 15 minutes in the future.</p>
|
|
1452
|
+
* @public
|
|
1453
1453
|
*/
|
|
1454
1454
|
export declare class RequestTimeoutException extends __BaseException {
|
|
1455
1455
|
readonly name: "RequestTimeoutException";
|
|
@@ -1483,34 +1483,34 @@ export declare const FilterOperator: {
|
|
|
1483
1483
|
*/
|
|
1484
1484
|
export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator];
|
|
1485
1485
|
/**
|
|
1486
|
-
* @public
|
|
1487
1486
|
* <p>A search filter.</p>
|
|
1487
|
+
* @public
|
|
1488
1488
|
*/
|
|
1489
1489
|
export interface Filter {
|
|
1490
1490
|
/**
|
|
1491
|
-
* @public
|
|
1492
1491
|
* <p>The field on which to filter.</p>
|
|
1492
|
+
* @public
|
|
1493
1493
|
*/
|
|
1494
1494
|
field: FilterField | undefined;
|
|
1495
1495
|
/**
|
|
1496
|
-
* @public
|
|
1497
1496
|
* <p>The operator to use for comparing the field’s value with the provided value.</p>
|
|
1497
|
+
* @public
|
|
1498
1498
|
*/
|
|
1499
1499
|
operator: FilterOperator | undefined;
|
|
1500
1500
|
/**
|
|
1501
|
-
* @public
|
|
1502
1501
|
* <p>The desired field value on which to filter.</p>
|
|
1502
|
+
* @public
|
|
1503
1503
|
*/
|
|
1504
1504
|
value: string | undefined;
|
|
1505
1505
|
}
|
|
1506
1506
|
/**
|
|
1507
|
-
* @public
|
|
1508
1507
|
* <p>The search expression.</p>
|
|
1508
|
+
* @public
|
|
1509
1509
|
*/
|
|
1510
1510
|
export interface SearchExpression {
|
|
1511
1511
|
/**
|
|
1512
|
-
* @public
|
|
1513
1512
|
* <p>The search expression filters.</p>
|
|
1513
|
+
* @public
|
|
1514
1514
|
*/
|
|
1515
1515
|
filters: Filter[] | undefined;
|
|
1516
1516
|
}
|
|
@@ -1519,50 +1519,50 @@ export interface SearchExpression {
|
|
|
1519
1519
|
*/
|
|
1520
1520
|
export interface SearchSessionsRequest {
|
|
1521
1521
|
/**
|
|
1522
|
-
* @public
|
|
1523
1522
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1524
1523
|
* response in the next request to retrieve the next set of results.</p>
|
|
1524
|
+
* @public
|
|
1525
1525
|
*/
|
|
1526
1526
|
nextToken?: string;
|
|
1527
1527
|
/**
|
|
1528
|
-
* @public
|
|
1529
1528
|
* <p>The maximum number of results to return per page.</p>
|
|
1529
|
+
* @public
|
|
1530
1530
|
*/
|
|
1531
1531
|
maxResults?: number;
|
|
1532
1532
|
/**
|
|
1533
|
-
* @public
|
|
1534
1533
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1534
|
+
* @public
|
|
1535
1535
|
*/
|
|
1536
1536
|
assistantId: string | undefined;
|
|
1537
1537
|
/**
|
|
1538
|
-
* @public
|
|
1539
1538
|
* <p>The search expression to filter results.</p>
|
|
1539
|
+
* @public
|
|
1540
1540
|
*/
|
|
1541
1541
|
searchExpression: SearchExpression | undefined;
|
|
1542
1542
|
}
|
|
1543
1543
|
/**
|
|
1544
|
-
* @public
|
|
1545
1544
|
* <p>Summary information about the session.</p>
|
|
1545
|
+
* @public
|
|
1546
1546
|
*/
|
|
1547
1547
|
export interface SessionSummary {
|
|
1548
1548
|
/**
|
|
1549
|
-
* @public
|
|
1550
1549
|
* <p>The identifier of the session.</p>
|
|
1550
|
+
* @public
|
|
1551
1551
|
*/
|
|
1552
1552
|
sessionId: string | undefined;
|
|
1553
1553
|
/**
|
|
1554
|
-
* @public
|
|
1555
1554
|
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
1555
|
+
* @public
|
|
1556
1556
|
*/
|
|
1557
1557
|
sessionArn: string | undefined;
|
|
1558
1558
|
/**
|
|
1559
|
-
* @public
|
|
1560
1559
|
* <p>The identifier of the Amazon Q assistant.</p>
|
|
1560
|
+
* @public
|
|
1561
1561
|
*/
|
|
1562
1562
|
assistantId: string | undefined;
|
|
1563
1563
|
/**
|
|
1564
|
-
* @public
|
|
1565
1564
|
* <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
|
|
1565
|
+
* @public
|
|
1566
1566
|
*/
|
|
1567
1567
|
assistantArn: string | undefined;
|
|
1568
1568
|
}
|
|
@@ -1571,13 +1571,13 @@ export interface SessionSummary {
|
|
|
1571
1571
|
*/
|
|
1572
1572
|
export interface SearchSessionsResponse {
|
|
1573
1573
|
/**
|
|
1574
|
-
* @public
|
|
1575
1574
|
* <p>Summary information about the sessions.</p>
|
|
1575
|
+
* @public
|
|
1576
1576
|
*/
|
|
1577
1577
|
sessionSummaries: SessionSummary[] | undefined;
|
|
1578
1578
|
/**
|
|
1579
|
-
* @public
|
|
1580
1579
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
1580
|
+
* @public
|
|
1581
1581
|
*/
|
|
1582
1582
|
nextToken?: string;
|
|
1583
1583
|
}
|
|
@@ -1586,78 +1586,78 @@ export interface SearchSessionsResponse {
|
|
|
1586
1586
|
*/
|
|
1587
1587
|
export interface CreateSessionRequest {
|
|
1588
1588
|
/**
|
|
1589
|
-
* @public
|
|
1590
1589
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1591
1590
|
* request. If not provided, the Amazon Web Services
|
|
1592
1591
|
* SDK populates this field. For more information about idempotency, see
|
|
1593
1592
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1593
|
+
* @public
|
|
1594
1594
|
*/
|
|
1595
1595
|
clientToken?: string;
|
|
1596
1596
|
/**
|
|
1597
|
-
* @public
|
|
1598
1597
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1598
|
+
* @public
|
|
1599
1599
|
*/
|
|
1600
1600
|
assistantId: string | undefined;
|
|
1601
1601
|
/**
|
|
1602
|
-
* @public
|
|
1603
1602
|
* <p>The name of the session.</p>
|
|
1603
|
+
* @public
|
|
1604
1604
|
*/
|
|
1605
1605
|
name: string | undefined;
|
|
1606
1606
|
/**
|
|
1607
|
-
* @public
|
|
1608
1607
|
* <p>The description.</p>
|
|
1608
|
+
* @public
|
|
1609
1609
|
*/
|
|
1610
1610
|
description?: string;
|
|
1611
1611
|
/**
|
|
1612
|
-
* @public
|
|
1613
1612
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1613
|
+
* @public
|
|
1614
1614
|
*/
|
|
1615
1615
|
tags?: Record<string, string>;
|
|
1616
1616
|
}
|
|
1617
1617
|
/**
|
|
1618
|
-
* @public
|
|
1619
1618
|
* <p>The configuration information for the session integration.</p>
|
|
1619
|
+
* @public
|
|
1620
1620
|
*/
|
|
1621
1621
|
export interface SessionIntegrationConfiguration {
|
|
1622
1622
|
/**
|
|
1623
|
-
* @public
|
|
1624
1623
|
* <p>The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.</p>
|
|
1624
|
+
* @public
|
|
1625
1625
|
*/
|
|
1626
1626
|
topicIntegrationArn?: string;
|
|
1627
1627
|
}
|
|
1628
1628
|
/**
|
|
1629
|
-
* @public
|
|
1630
1629
|
* <p>Information about the session.</p>
|
|
1630
|
+
* @public
|
|
1631
1631
|
*/
|
|
1632
1632
|
export interface SessionData {
|
|
1633
1633
|
/**
|
|
1634
|
-
* @public
|
|
1635
1634
|
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
1635
|
+
* @public
|
|
1636
1636
|
*/
|
|
1637
1637
|
sessionArn: string | undefined;
|
|
1638
1638
|
/**
|
|
1639
|
-
* @public
|
|
1640
1639
|
* <p>The identifier of the session.</p>
|
|
1640
|
+
* @public
|
|
1641
1641
|
*/
|
|
1642
1642
|
sessionId: string | undefined;
|
|
1643
1643
|
/**
|
|
1644
|
-
* @public
|
|
1645
1644
|
* <p>The name of the session.</p>
|
|
1645
|
+
* @public
|
|
1646
1646
|
*/
|
|
1647
1647
|
name: string | undefined;
|
|
1648
1648
|
/**
|
|
1649
|
-
* @public
|
|
1650
1649
|
* <p>The description of the session.</p>
|
|
1650
|
+
* @public
|
|
1651
1651
|
*/
|
|
1652
1652
|
description?: string;
|
|
1653
1653
|
/**
|
|
1654
|
-
* @public
|
|
1655
1654
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1655
|
+
* @public
|
|
1656
1656
|
*/
|
|
1657
1657
|
tags?: Record<string, string>;
|
|
1658
1658
|
/**
|
|
1659
|
-
* @public
|
|
1660
1659
|
* <p>The configuration information for the session integration.</p>
|
|
1660
|
+
* @public
|
|
1661
1661
|
*/
|
|
1662
1662
|
integrationConfiguration?: SessionIntegrationConfiguration;
|
|
1663
1663
|
}
|
|
@@ -1666,8 +1666,8 @@ export interface SessionData {
|
|
|
1666
1666
|
*/
|
|
1667
1667
|
export interface CreateSessionResponse {
|
|
1668
1668
|
/**
|
|
1669
|
-
* @public
|
|
1670
1669
|
* <p>The session.</p>
|
|
1670
|
+
* @public
|
|
1671
1671
|
*/
|
|
1672
1672
|
session?: SessionData;
|
|
1673
1673
|
}
|
|
@@ -1676,13 +1676,13 @@ export interface CreateSessionResponse {
|
|
|
1676
1676
|
*/
|
|
1677
1677
|
export interface GetSessionRequest {
|
|
1678
1678
|
/**
|
|
1679
|
-
* @public
|
|
1680
1679
|
* <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1680
|
+
* @public
|
|
1681
1681
|
*/
|
|
1682
1682
|
assistantId: string | undefined;
|
|
1683
1683
|
/**
|
|
1684
|
-
* @public
|
|
1685
1684
|
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1685
|
+
* @public
|
|
1686
1686
|
*/
|
|
1687
1687
|
sessionId: string | undefined;
|
|
1688
1688
|
}
|
|
@@ -1691,25 +1691,25 @@ export interface GetSessionRequest {
|
|
|
1691
1691
|
*/
|
|
1692
1692
|
export interface GetSessionResponse {
|
|
1693
1693
|
/**
|
|
1694
|
-
* @public
|
|
1695
1694
|
* <p>The session.</p>
|
|
1695
|
+
* @public
|
|
1696
1696
|
*/
|
|
1697
1697
|
session?: SessionData;
|
|
1698
1698
|
}
|
|
1699
1699
|
/**
|
|
1700
|
-
* @public
|
|
1701
1700
|
* <p>The configuration information of the Amazon Connect data source.</p>
|
|
1701
|
+
* @public
|
|
1702
1702
|
*/
|
|
1703
1703
|
export interface ConnectConfiguration {
|
|
1704
1704
|
/**
|
|
1705
|
-
* @public
|
|
1706
1705
|
* <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
|
|
1706
|
+
* @public
|
|
1707
1707
|
*/
|
|
1708
1708
|
instanceId?: string;
|
|
1709
1709
|
}
|
|
1710
1710
|
/**
|
|
1711
|
-
* @public
|
|
1712
1711
|
* <p>The configuration information of the external data source.</p>
|
|
1712
|
+
* @public
|
|
1713
1713
|
*/
|
|
1714
1714
|
export type Configuration = Configuration.ConnectConfigurationMember | Configuration.$UnknownMember;
|
|
1715
1715
|
/**
|
|
@@ -1717,8 +1717,8 @@ export type Configuration = Configuration.ConnectConfigurationMember | Configura
|
|
|
1717
1717
|
*/
|
|
1718
1718
|
export declare namespace Configuration {
|
|
1719
1719
|
/**
|
|
1720
|
-
* @public
|
|
1721
1720
|
* <p>The configuration information of the Amazon Connect data source.</p>
|
|
1721
|
+
* @public
|
|
1722
1722
|
*/
|
|
1723
1723
|
interface ConnectConfigurationMember {
|
|
1724
1724
|
connectConfiguration: ConnectConfiguration;
|
|
@@ -1742,51 +1742,51 @@ export declare namespace Configuration {
|
|
|
1742
1742
|
*/
|
|
1743
1743
|
export interface CreateContentRequest {
|
|
1744
1744
|
/**
|
|
1745
|
-
* @public
|
|
1746
1745
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1747
1746
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1747
|
+
* @public
|
|
1748
1748
|
*/
|
|
1749
1749
|
knowledgeBaseId: string | undefined;
|
|
1750
1750
|
/**
|
|
1751
|
-
* @public
|
|
1752
1751
|
* <p>The name of the content. Each piece of content in a knowledge base must have a unique
|
|
1753
1752
|
* name. You can retrieve a piece of content using only its knowledge base and its name with the
|
|
1754
1753
|
* <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html">SearchContent</a> API.</p>
|
|
1754
|
+
* @public
|
|
1755
1755
|
*/
|
|
1756
1756
|
name: string | undefined;
|
|
1757
1757
|
/**
|
|
1758
|
-
* @public
|
|
1759
1758
|
* <p>The title of the content. If not set, the title is equal to the name.</p>
|
|
1759
|
+
* @public
|
|
1760
1760
|
*/
|
|
1761
1761
|
title?: string;
|
|
1762
1762
|
/**
|
|
1763
|
-
* @public
|
|
1764
1763
|
* <p>The URI you want to use for the article. If the knowledge base has a templateUri, setting
|
|
1765
1764
|
* this argument overrides it for this piece of content.</p>
|
|
1765
|
+
* @public
|
|
1766
1766
|
*/
|
|
1767
1767
|
overrideLinkOutUri?: string;
|
|
1768
1768
|
/**
|
|
1769
|
-
* @public
|
|
1770
1769
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
1771
1770
|
* For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.</p>
|
|
1771
|
+
* @public
|
|
1772
1772
|
*/
|
|
1773
1773
|
metadata?: Record<string, string>;
|
|
1774
1774
|
/**
|
|
1775
|
-
* @public
|
|
1776
1775
|
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
|
|
1776
|
+
* @public
|
|
1777
1777
|
*/
|
|
1778
1778
|
uploadId: string | undefined;
|
|
1779
1779
|
/**
|
|
1780
|
-
* @public
|
|
1781
1780
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1782
1781
|
* request. If not provided, the Amazon Web Services
|
|
1783
1782
|
* SDK populates this field. For more information about idempotency, see
|
|
1784
1783
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1784
|
+
* @public
|
|
1785
1785
|
*/
|
|
1786
1786
|
clientToken?: string;
|
|
1787
1787
|
/**
|
|
1788
|
-
* @public
|
|
1789
1788
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1789
|
+
* @public
|
|
1790
1790
|
*/
|
|
1791
1791
|
tags?: Record<string, string>;
|
|
1792
1792
|
}
|
|
@@ -1808,80 +1808,80 @@ export declare const ContentStatus: {
|
|
|
1808
1808
|
*/
|
|
1809
1809
|
export type ContentStatus = (typeof ContentStatus)[keyof typeof ContentStatus];
|
|
1810
1810
|
/**
|
|
1811
|
-
* @public
|
|
1812
1811
|
* <p>Information about the content.</p>
|
|
1812
|
+
* @public
|
|
1813
1813
|
*/
|
|
1814
1814
|
export interface ContentData {
|
|
1815
1815
|
/**
|
|
1816
|
-
* @public
|
|
1817
1816
|
* <p>The Amazon Resource Name (ARN) of the content.</p>
|
|
1817
|
+
* @public
|
|
1818
1818
|
*/
|
|
1819
1819
|
contentArn: string | undefined;
|
|
1820
1820
|
/**
|
|
1821
|
-
* @public
|
|
1822
1821
|
* <p>The identifier of the content.</p>
|
|
1822
|
+
* @public
|
|
1823
1823
|
*/
|
|
1824
1824
|
contentId: string | undefined;
|
|
1825
1825
|
/**
|
|
1826
|
-
* @public
|
|
1827
1826
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1827
|
+
* @public
|
|
1828
1828
|
*/
|
|
1829
1829
|
knowledgeBaseArn: string | undefined;
|
|
1830
1830
|
/**
|
|
1831
|
-
* @public
|
|
1832
1831
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1833
1832
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
1833
|
+
* @public
|
|
1834
1834
|
*/
|
|
1835
1835
|
knowledgeBaseId: string | undefined;
|
|
1836
1836
|
/**
|
|
1837
|
-
* @public
|
|
1838
1837
|
* <p>The name of the content.</p>
|
|
1838
|
+
* @public
|
|
1839
1839
|
*/
|
|
1840
1840
|
name: string | undefined;
|
|
1841
1841
|
/**
|
|
1842
|
-
* @public
|
|
1843
1842
|
* <p>The identifier of the content revision.</p>
|
|
1843
|
+
* @public
|
|
1844
1844
|
*/
|
|
1845
1845
|
revisionId: string | undefined;
|
|
1846
1846
|
/**
|
|
1847
|
-
* @public
|
|
1848
1847
|
* <p>The title of the content.</p>
|
|
1848
|
+
* @public
|
|
1849
1849
|
*/
|
|
1850
1850
|
title: string | undefined;
|
|
1851
1851
|
/**
|
|
1852
|
-
* @public
|
|
1853
1852
|
* <p>The media type of the content.</p>
|
|
1853
|
+
* @public
|
|
1854
1854
|
*/
|
|
1855
1855
|
contentType: string | undefined;
|
|
1856
1856
|
/**
|
|
1857
|
-
* @public
|
|
1858
1857
|
* <p>The status of the content.</p>
|
|
1858
|
+
* @public
|
|
1859
1859
|
*/
|
|
1860
1860
|
status: ContentStatus | undefined;
|
|
1861
1861
|
/**
|
|
1862
|
-
* @public
|
|
1863
1862
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
1864
1863
|
* For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.</p>
|
|
1864
|
+
* @public
|
|
1865
1865
|
*/
|
|
1866
1866
|
metadata: Record<string, string> | undefined;
|
|
1867
1867
|
/**
|
|
1868
|
-
* @public
|
|
1869
1868
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1869
|
+
* @public
|
|
1870
1870
|
*/
|
|
1871
1871
|
tags?: Record<string, string>;
|
|
1872
1872
|
/**
|
|
1873
|
-
* @public
|
|
1874
1873
|
* <p>The URI of the content.</p>
|
|
1874
|
+
* @public
|
|
1875
1875
|
*/
|
|
1876
1876
|
linkOutUri?: string;
|
|
1877
1877
|
/**
|
|
1878
|
-
* @public
|
|
1879
1878
|
* <p>The URL of the content.</p>
|
|
1879
|
+
* @public
|
|
1880
1880
|
*/
|
|
1881
1881
|
url: string | undefined;
|
|
1882
1882
|
/**
|
|
1883
|
-
* @public
|
|
1884
1883
|
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
1884
|
+
* @public
|
|
1885
1885
|
*/
|
|
1886
1886
|
urlExpiry: Date | undefined;
|
|
1887
1887
|
}
|
|
@@ -1890,8 +1890,8 @@ export interface ContentData {
|
|
|
1890
1890
|
*/
|
|
1891
1891
|
export interface CreateContentResponse {
|
|
1892
1892
|
/**
|
|
1893
|
-
* @public
|
|
1894
1893
|
* <p>The content.</p>
|
|
1894
|
+
* @public
|
|
1895
1895
|
*/
|
|
1896
1896
|
content?: ContentData;
|
|
1897
1897
|
}
|
|
@@ -1900,14 +1900,14 @@ export interface CreateContentResponse {
|
|
|
1900
1900
|
*/
|
|
1901
1901
|
export interface DeleteContentRequest {
|
|
1902
1902
|
/**
|
|
1903
|
-
* @public
|
|
1904
1903
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1905
1904
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1905
|
+
* @public
|
|
1906
1906
|
*/
|
|
1907
1907
|
knowledgeBaseId: string | undefined;
|
|
1908
1908
|
/**
|
|
1909
|
-
* @public
|
|
1910
1909
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1910
|
+
* @public
|
|
1911
1911
|
*/
|
|
1912
1912
|
contentId: string | undefined;
|
|
1913
1913
|
}
|
|
@@ -1921,14 +1921,14 @@ export interface DeleteContentResponse {
|
|
|
1921
1921
|
*/
|
|
1922
1922
|
export interface GetContentRequest {
|
|
1923
1923
|
/**
|
|
1924
|
-
* @public
|
|
1925
1924
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1925
|
+
* @public
|
|
1926
1926
|
*/
|
|
1927
1927
|
contentId: string | undefined;
|
|
1928
1928
|
/**
|
|
1929
|
-
* @public
|
|
1930
1929
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1931
1930
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1931
|
+
* @public
|
|
1932
1932
|
*/
|
|
1933
1933
|
knowledgeBaseId: string | undefined;
|
|
1934
1934
|
}
|
|
@@ -1937,8 +1937,8 @@ export interface GetContentRequest {
|
|
|
1937
1937
|
*/
|
|
1938
1938
|
export interface GetContentResponse {
|
|
1939
1939
|
/**
|
|
1940
|
-
* @public
|
|
1941
1940
|
* <p>The content.</p>
|
|
1941
|
+
* @public
|
|
1942
1942
|
*/
|
|
1943
1943
|
content?: ContentData;
|
|
1944
1944
|
}
|
|
@@ -1947,77 +1947,77 @@ export interface GetContentResponse {
|
|
|
1947
1947
|
*/
|
|
1948
1948
|
export interface GetContentSummaryRequest {
|
|
1949
1949
|
/**
|
|
1950
|
-
* @public
|
|
1951
1950
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1951
|
+
* @public
|
|
1952
1952
|
*/
|
|
1953
1953
|
contentId: string | undefined;
|
|
1954
1954
|
/**
|
|
1955
|
-
* @public
|
|
1956
1955
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1957
1956
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1957
|
+
* @public
|
|
1958
1958
|
*/
|
|
1959
1959
|
knowledgeBaseId: string | undefined;
|
|
1960
1960
|
}
|
|
1961
1961
|
/**
|
|
1962
|
-
* @public
|
|
1963
1962
|
* <p>Summary information about the content.</p>
|
|
1963
|
+
* @public
|
|
1964
1964
|
*/
|
|
1965
1965
|
export interface ContentSummary {
|
|
1966
1966
|
/**
|
|
1967
|
-
* @public
|
|
1968
1967
|
* <p>The Amazon Resource Name (ARN) of the content.</p>
|
|
1968
|
+
* @public
|
|
1969
1969
|
*/
|
|
1970
1970
|
contentArn: string | undefined;
|
|
1971
1971
|
/**
|
|
1972
|
-
* @public
|
|
1973
1972
|
* <p>The identifier of the content.</p>
|
|
1973
|
+
* @public
|
|
1974
1974
|
*/
|
|
1975
1975
|
contentId: string | undefined;
|
|
1976
1976
|
/**
|
|
1977
|
-
* @public
|
|
1978
1977
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
1978
|
+
* @public
|
|
1979
1979
|
*/
|
|
1980
1980
|
knowledgeBaseArn: string | undefined;
|
|
1981
1981
|
/**
|
|
1982
|
-
* @public
|
|
1983
1982
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
1984
1983
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
1984
|
+
* @public
|
|
1985
1985
|
*/
|
|
1986
1986
|
knowledgeBaseId: string | undefined;
|
|
1987
1987
|
/**
|
|
1988
|
-
* @public
|
|
1989
1988
|
* <p>The name of the content.</p>
|
|
1989
|
+
* @public
|
|
1990
1990
|
*/
|
|
1991
1991
|
name: string | undefined;
|
|
1992
1992
|
/**
|
|
1993
|
-
* @public
|
|
1994
1993
|
* <p>The identifier of the revision of the content.</p>
|
|
1994
|
+
* @public
|
|
1995
1995
|
*/
|
|
1996
1996
|
revisionId: string | undefined;
|
|
1997
1997
|
/**
|
|
1998
|
-
* @public
|
|
1999
1998
|
* <p>The title of the content.</p>
|
|
1999
|
+
* @public
|
|
2000
2000
|
*/
|
|
2001
2001
|
title: string | undefined;
|
|
2002
2002
|
/**
|
|
2003
|
-
* @public
|
|
2004
2003
|
* <p>The media type of the content.</p>
|
|
2004
|
+
* @public
|
|
2005
2005
|
*/
|
|
2006
2006
|
contentType: string | undefined;
|
|
2007
2007
|
/**
|
|
2008
|
-
* @public
|
|
2009
2008
|
* <p>The status of the content.</p>
|
|
2009
|
+
* @public
|
|
2010
2010
|
*/
|
|
2011
2011
|
status: ContentStatus | undefined;
|
|
2012
2012
|
/**
|
|
2013
|
-
* @public
|
|
2014
2013
|
* <p>A key/value map to store attributes without affecting tagging or recommendations.
|
|
2015
2014
|
* For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.</p>
|
|
2015
|
+
* @public
|
|
2016
2016
|
*/
|
|
2017
2017
|
metadata: Record<string, string> | undefined;
|
|
2018
2018
|
/**
|
|
2019
|
-
* @public
|
|
2020
2019
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2020
|
+
* @public
|
|
2021
2021
|
*/
|
|
2022
2022
|
tags?: Record<string, string>;
|
|
2023
2023
|
}
|
|
@@ -2026,8 +2026,8 @@ export interface ContentSummary {
|
|
|
2026
2026
|
*/
|
|
2027
2027
|
export interface GetContentSummaryResponse {
|
|
2028
2028
|
/**
|
|
2029
|
-
* @public
|
|
2030
2029
|
* <p>The content summary.</p>
|
|
2030
|
+
* @public
|
|
2031
2031
|
*/
|
|
2032
2032
|
contentSummary?: ContentSummary;
|
|
2033
2033
|
}
|
|
@@ -2036,20 +2036,20 @@ export interface GetContentSummaryResponse {
|
|
|
2036
2036
|
*/
|
|
2037
2037
|
export interface ListContentsRequest {
|
|
2038
2038
|
/**
|
|
2039
|
-
* @public
|
|
2040
2039
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
2041
2040
|
* response in the next request to retrieve the next set of results.</p>
|
|
2041
|
+
* @public
|
|
2042
2042
|
*/
|
|
2043
2043
|
nextToken?: string;
|
|
2044
2044
|
/**
|
|
2045
|
-
* @public
|
|
2046
2045
|
* <p>The maximum number of results to return per page.</p>
|
|
2046
|
+
* @public
|
|
2047
2047
|
*/
|
|
2048
2048
|
maxResults?: number;
|
|
2049
2049
|
/**
|
|
2050
|
-
* @public
|
|
2051
2050
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2052
2051
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2052
|
+
* @public
|
|
2053
2053
|
*/
|
|
2054
2054
|
knowledgeBaseId: string | undefined;
|
|
2055
2055
|
}
|
|
@@ -2058,20 +2058,20 @@ export interface ListContentsRequest {
|
|
|
2058
2058
|
*/
|
|
2059
2059
|
export interface ListContentsResponse {
|
|
2060
2060
|
/**
|
|
2061
|
-
* @public
|
|
2062
2061
|
* <p>Information about the content.</p>
|
|
2062
|
+
* @public
|
|
2063
2063
|
*/
|
|
2064
2064
|
contentSummaries: ContentSummary[] | undefined;
|
|
2065
2065
|
/**
|
|
2066
|
-
* @public
|
|
2067
2066
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
2067
|
+
* @public
|
|
2068
2068
|
*/
|
|
2069
2069
|
nextToken?: string;
|
|
2070
2070
|
}
|
|
2071
2071
|
/**
|
|
2072
|
-
* @public
|
|
2073
2072
|
* <p>The provided <code>revisionId</code> does not match, indicating the content has been
|
|
2074
2073
|
* modified since it was last read.</p>
|
|
2074
|
+
* @public
|
|
2075
2075
|
*/
|
|
2076
2076
|
export declare class PreconditionFailedException extends __BaseException {
|
|
2077
2077
|
readonly name: "PreconditionFailedException";
|
|
@@ -2086,53 +2086,53 @@ export declare class PreconditionFailedException extends __BaseException {
|
|
|
2086
2086
|
*/
|
|
2087
2087
|
export interface UpdateContentRequest {
|
|
2088
2088
|
/**
|
|
2089
|
-
* @public
|
|
2090
2089
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2091
2090
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN</p>
|
|
2091
|
+
* @public
|
|
2092
2092
|
*/
|
|
2093
2093
|
knowledgeBaseId: string | undefined;
|
|
2094
2094
|
/**
|
|
2095
|
-
* @public
|
|
2096
2095
|
* <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2096
|
+
* @public
|
|
2097
2097
|
*/
|
|
2098
2098
|
contentId: string | undefined;
|
|
2099
2099
|
/**
|
|
2100
|
-
* @public
|
|
2101
2100
|
* <p>The <code>revisionId</code> of the content resource to update, taken from an earlier call
|
|
2102
2101
|
* to <code>GetContent</code>, <code>GetContentSummary</code>, <code>SearchContent</code>, or
|
|
2103
2102
|
* <code>ListContents</code>. If included, this argument acts as an optimistic lock to ensure
|
|
2104
2103
|
* content was not modified since it was last read. If it has been modified, this API throws a
|
|
2105
2104
|
* <code>PreconditionFailedException</code>.</p>
|
|
2105
|
+
* @public
|
|
2106
2106
|
*/
|
|
2107
2107
|
revisionId?: string;
|
|
2108
2108
|
/**
|
|
2109
|
-
* @public
|
|
2110
2109
|
* <p>The title of the content.</p>
|
|
2110
|
+
* @public
|
|
2111
2111
|
*/
|
|
2112
2112
|
title?: string;
|
|
2113
2113
|
/**
|
|
2114
|
-
* @public
|
|
2115
2114
|
* <p>The URI for the article. If the knowledge base has a templateUri, setting this argument
|
|
2116
2115
|
* overrides it for this piece of content. To remove an existing <code>overrideLinkOurUri</code>,
|
|
2117
2116
|
* exclude this argument and set <code>removeOverrideLinkOutUri</code> to true.</p>
|
|
2117
|
+
* @public
|
|
2118
2118
|
*/
|
|
2119
2119
|
overrideLinkOutUri?: string;
|
|
2120
2120
|
/**
|
|
2121
|
-
* @public
|
|
2122
2121
|
* <p>Unset the existing <code>overrideLinkOutUri</code> if it exists.</p>
|
|
2122
|
+
* @public
|
|
2123
2123
|
*/
|
|
2124
2124
|
removeOverrideLinkOutUri?: boolean;
|
|
2125
2125
|
/**
|
|
2126
|
-
* @public
|
|
2127
2126
|
* <p>A key/value map to store attributes without affecting tagging or recommendations. For
|
|
2128
2127
|
* example, when synchronizing data between an external system and Amazon Q, you can store an
|
|
2129
2128
|
* external version identifier as metadata to utilize for determining drift.</p>
|
|
2129
|
+
* @public
|
|
2130
2130
|
*/
|
|
2131
2131
|
metadata?: Record<string, string>;
|
|
2132
2132
|
/**
|
|
2133
|
-
* @public
|
|
2134
2133
|
* <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.
|
|
2135
2134
|
* </p>
|
|
2135
|
+
* @public
|
|
2136
2136
|
*/
|
|
2137
2137
|
uploadId?: string;
|
|
2138
2138
|
}
|
|
@@ -2141,8 +2141,8 @@ export interface UpdateContentRequest {
|
|
|
2141
2141
|
*/
|
|
2142
2142
|
export interface UpdateContentResponse {
|
|
2143
2143
|
/**
|
|
2144
|
-
* @public
|
|
2145
2144
|
* <p>The content.</p>
|
|
2145
|
+
* @public
|
|
2146
2146
|
*/
|
|
2147
2147
|
content?: ContentData;
|
|
2148
2148
|
}
|
|
@@ -2160,12 +2160,11 @@ export declare const KnowledgeBaseType: {
|
|
|
2160
2160
|
*/
|
|
2161
2161
|
export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];
|
|
2162
2162
|
/**
|
|
2163
|
-
* @public
|
|
2164
2163
|
* <p>Information about how to render the content.</p>
|
|
2164
|
+
* @public
|
|
2165
2165
|
*/
|
|
2166
2166
|
export interface RenderingConfiguration {
|
|
2167
2167
|
/**
|
|
2168
|
-
* @public
|
|
2169
2168
|
* <p>A URI template containing exactly one variable in <code>$\{variableName\} </code>format.
|
|
2170
2169
|
* This can only be set for <code>EXTERNAL</code> knowledge bases. For Salesforce, ServiceNow,
|
|
2171
2170
|
* and Zendesk, the variable must be one of the following:</p>
|
|
@@ -2187,12 +2186,13 @@ export interface RenderingConfiguration {
|
|
|
2187
2186
|
* </li>
|
|
2188
2187
|
* </ul>
|
|
2189
2188
|
* <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
|
|
2189
|
+
* @public
|
|
2190
2190
|
*/
|
|
2191
2191
|
templateUri?: string;
|
|
2192
2192
|
}
|
|
2193
2193
|
/**
|
|
2194
|
-
* @public
|
|
2195
2194
|
* <p>Configuration information about the external data source.</p>
|
|
2195
|
+
* @public
|
|
2196
2196
|
*/
|
|
2197
2197
|
export type SourceConfiguration = SourceConfiguration.AppIntegrationsMember | SourceConfiguration.$UnknownMember;
|
|
2198
2198
|
/**
|
|
@@ -2200,8 +2200,8 @@ export type SourceConfiguration = SourceConfiguration.AppIntegrationsMember | So
|
|
|
2200
2200
|
*/
|
|
2201
2201
|
export declare namespace SourceConfiguration {
|
|
2202
2202
|
/**
|
|
2203
|
-
* @public
|
|
2204
2203
|
* <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
|
|
2204
|
+
* @public
|
|
2205
2205
|
*/
|
|
2206
2206
|
interface AppIntegrationsMember {
|
|
2207
2207
|
appIntegrations: AppIntegrationsConfiguration;
|
|
@@ -2225,38 +2225,37 @@ export declare namespace SourceConfiguration {
|
|
|
2225
2225
|
*/
|
|
2226
2226
|
export interface CreateKnowledgeBaseRequest {
|
|
2227
2227
|
/**
|
|
2228
|
-
* @public
|
|
2229
2228
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2230
2229
|
* request. If not provided, the Amazon Web Services
|
|
2231
2230
|
* SDK populates this field. For more information about idempotency, see
|
|
2232
2231
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2232
|
+
* @public
|
|
2233
2233
|
*/
|
|
2234
2234
|
clientToken?: string;
|
|
2235
2235
|
/**
|
|
2236
|
-
* @public
|
|
2237
2236
|
* <p>The name of the knowledge base.</p>
|
|
2237
|
+
* @public
|
|
2238
2238
|
*/
|
|
2239
2239
|
name: string | undefined;
|
|
2240
2240
|
/**
|
|
2241
|
-
* @public
|
|
2242
2241
|
* <p>The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content.
|
|
2243
2242
|
* EXTERNAL knowledge bases support integrations with third-party systems whose content is
|
|
2244
2243
|
* synchronized automatically. </p>
|
|
2244
|
+
* @public
|
|
2245
2245
|
*/
|
|
2246
2246
|
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
2247
2247
|
/**
|
|
2248
|
-
* @public
|
|
2249
2248
|
* <p>The source of the knowledge base content. Only set this argument for EXTERNAL knowledge
|
|
2250
2249
|
* bases.</p>
|
|
2250
|
+
* @public
|
|
2251
2251
|
*/
|
|
2252
2252
|
sourceConfiguration?: SourceConfiguration;
|
|
2253
2253
|
/**
|
|
2254
|
-
* @public
|
|
2255
2254
|
* <p>Information about how to render the content.</p>
|
|
2255
|
+
* @public
|
|
2256
2256
|
*/
|
|
2257
2257
|
renderingConfiguration?: RenderingConfiguration;
|
|
2258
2258
|
/**
|
|
2259
|
-
* @public
|
|
2260
2259
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
2261
2260
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
2262
2261
|
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
@@ -2264,16 +2263,17 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
2264
2263
|
* key to invoke Amazon Q.</p>
|
|
2265
2264
|
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
2266
2265
|
* your instance</a>.</p>
|
|
2266
|
+
* @public
|
|
2267
2267
|
*/
|
|
2268
2268
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
2269
2269
|
/**
|
|
2270
|
-
* @public
|
|
2271
2270
|
* <p>The description.</p>
|
|
2271
|
+
* @public
|
|
2272
2272
|
*/
|
|
2273
2273
|
description?: string;
|
|
2274
2274
|
/**
|
|
2275
|
-
* @public
|
|
2276
2275
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2276
|
+
* @public
|
|
2277
2277
|
*/
|
|
2278
2278
|
tags?: Record<string, string>;
|
|
2279
2279
|
}
|
|
@@ -2294,54 +2294,53 @@ export declare const KnowledgeBaseStatus: {
|
|
|
2294
2294
|
*/
|
|
2295
2295
|
export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
|
|
2296
2296
|
/**
|
|
2297
|
-
* @public
|
|
2298
2297
|
* <p>Information about the knowledge base.</p>
|
|
2298
|
+
* @public
|
|
2299
2299
|
*/
|
|
2300
2300
|
export interface KnowledgeBaseData {
|
|
2301
2301
|
/**
|
|
2302
|
-
* @public
|
|
2303
2302
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2304
2303
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
2304
|
+
* @public
|
|
2305
2305
|
*/
|
|
2306
2306
|
knowledgeBaseId: string | undefined;
|
|
2307
2307
|
/**
|
|
2308
|
-
* @public
|
|
2309
2308
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
2309
|
+
* @public
|
|
2310
2310
|
*/
|
|
2311
2311
|
knowledgeBaseArn: string | undefined;
|
|
2312
2312
|
/**
|
|
2313
|
-
* @public
|
|
2314
2313
|
* <p>The name of the knowledge base.</p>
|
|
2314
|
+
* @public
|
|
2315
2315
|
*/
|
|
2316
2316
|
name: string | undefined;
|
|
2317
2317
|
/**
|
|
2318
|
-
* @public
|
|
2319
2318
|
* <p>The type of knowledge base.</p>
|
|
2319
|
+
* @public
|
|
2320
2320
|
*/
|
|
2321
2321
|
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
2322
2322
|
/**
|
|
2323
|
-
* @public
|
|
2324
2323
|
* <p>The status of the knowledge base.</p>
|
|
2324
|
+
* @public
|
|
2325
2325
|
*/
|
|
2326
2326
|
status: KnowledgeBaseStatus | undefined;
|
|
2327
2327
|
/**
|
|
2328
|
-
* @public
|
|
2329
2328
|
* <p>An epoch timestamp indicating the most recent content modification inside the knowledge
|
|
2330
2329
|
* base. If no content exists in a knowledge base, this value is unset.</p>
|
|
2330
|
+
* @public
|
|
2331
2331
|
*/
|
|
2332
2332
|
lastContentModificationTime?: Date;
|
|
2333
2333
|
/**
|
|
2334
|
-
* @public
|
|
2335
2334
|
* <p>Source configuration information about the knowledge base.</p>
|
|
2335
|
+
* @public
|
|
2336
2336
|
*/
|
|
2337
2337
|
sourceConfiguration?: SourceConfiguration;
|
|
2338
2338
|
/**
|
|
2339
|
-
* @public
|
|
2340
2339
|
* <p>Information about how to render the content.</p>
|
|
2340
|
+
* @public
|
|
2341
2341
|
*/
|
|
2342
2342
|
renderingConfiguration?: RenderingConfiguration;
|
|
2343
2343
|
/**
|
|
2344
|
-
* @public
|
|
2345
2344
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
2346
2345
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
2347
2346
|
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
@@ -2349,16 +2348,17 @@ export interface KnowledgeBaseData {
|
|
|
2349
2348
|
* key to invoke Amazon Q. </p>
|
|
2350
2349
|
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
2351
2350
|
* your instance</a>.</p>
|
|
2351
|
+
* @public
|
|
2352
2352
|
*/
|
|
2353
2353
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
2354
2354
|
/**
|
|
2355
|
-
* @public
|
|
2356
2355
|
* <p>The description.</p>
|
|
2356
|
+
* @public
|
|
2357
2357
|
*/
|
|
2358
2358
|
description?: string;
|
|
2359
2359
|
/**
|
|
2360
|
-
* @public
|
|
2361
2360
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2361
|
+
* @public
|
|
2362
2362
|
*/
|
|
2363
2363
|
tags?: Record<string, string>;
|
|
2364
2364
|
}
|
|
@@ -2367,14 +2367,14 @@ export interface KnowledgeBaseData {
|
|
|
2367
2367
|
*/
|
|
2368
2368
|
export interface CreateKnowledgeBaseResponse {
|
|
2369
2369
|
/**
|
|
2370
|
-
* @public
|
|
2371
2370
|
* <p>The knowledge base.</p>
|
|
2371
|
+
* @public
|
|
2372
2372
|
*/
|
|
2373
2373
|
knowledgeBase?: KnowledgeBaseData;
|
|
2374
2374
|
}
|
|
2375
2375
|
/**
|
|
2376
|
-
* @public
|
|
2377
2376
|
* <p>The container of quick response data.</p>
|
|
2377
|
+
* @public
|
|
2378
2378
|
*/
|
|
2379
2379
|
export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember | QuickResponseDataProvider.$UnknownMember;
|
|
2380
2380
|
/**
|
|
@@ -2382,8 +2382,8 @@ export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember
|
|
|
2382
2382
|
*/
|
|
2383
2383
|
export declare namespace QuickResponseDataProvider {
|
|
2384
2384
|
/**
|
|
2385
|
-
* @public
|
|
2386
2385
|
* <p>The content of the quick response.</p>
|
|
2386
|
+
* @public
|
|
2387
2387
|
*/
|
|
2388
2388
|
interface ContentMember {
|
|
2389
2389
|
content: string;
|
|
@@ -2403,12 +2403,11 @@ export declare namespace QuickResponseDataProvider {
|
|
|
2403
2403
|
const visit: <T>(value: QuickResponseDataProvider, visitor: Visitor<T>) => T;
|
|
2404
2404
|
}
|
|
2405
2405
|
/**
|
|
2406
|
-
* @public
|
|
2407
2406
|
* <p>The configuration information of the grouping of Amazon Q users.</p>
|
|
2407
|
+
* @public
|
|
2408
2408
|
*/
|
|
2409
2409
|
export interface GroupingConfiguration {
|
|
2410
2410
|
/**
|
|
2411
|
-
* @public
|
|
2412
2411
|
* <p>The criteria used for grouping Amazon Q users.</p>
|
|
2413
2412
|
* <p>The following is the list of supported criteria values.</p>
|
|
2414
2413
|
* <ul>
|
|
@@ -2418,10 +2417,10 @@ export interface GroupingConfiguration {
|
|
|
2418
2417
|
* <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> permissions when setting criteria to this value.</p>
|
|
2419
2418
|
* </li>
|
|
2420
2419
|
* </ul>
|
|
2420
|
+
* @public
|
|
2421
2421
|
*/
|
|
2422
2422
|
criteria?: string;
|
|
2423
2423
|
/**
|
|
2424
|
-
* @public
|
|
2425
2424
|
* <p>The list of values that define different groups of Amazon Q users.</p>
|
|
2426
2425
|
* <ul>
|
|
2427
2426
|
* <li>
|
|
@@ -2429,6 +2428,7 @@ export interface GroupingConfiguration {
|
|
|
2429
2428
|
* ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profiles</a> as values of this parameter.</p>
|
|
2430
2429
|
* </li>
|
|
2431
2430
|
* </ul>
|
|
2431
|
+
* @public
|
|
2432
2432
|
*/
|
|
2433
2433
|
values?: string[];
|
|
2434
2434
|
}
|
|
@@ -2437,23 +2437,22 @@ export interface GroupingConfiguration {
|
|
|
2437
2437
|
*/
|
|
2438
2438
|
export interface CreateQuickResponseRequest {
|
|
2439
2439
|
/**
|
|
2440
|
-
* @public
|
|
2441
2440
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2442
2441
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2442
|
+
* @public
|
|
2443
2443
|
*/
|
|
2444
2444
|
knowledgeBaseId: string | undefined;
|
|
2445
2445
|
/**
|
|
2446
|
-
* @public
|
|
2447
2446
|
* <p>The name of the quick response.</p>
|
|
2447
|
+
* @public
|
|
2448
2448
|
*/
|
|
2449
2449
|
name: string | undefined;
|
|
2450
2450
|
/**
|
|
2451
|
-
* @public
|
|
2452
2451
|
* <p>The content of the quick response.</p>
|
|
2452
|
+
* @public
|
|
2453
2453
|
*/
|
|
2454
2454
|
content: QuickResponseDataProvider | undefined;
|
|
2455
2455
|
/**
|
|
2456
|
-
* @public
|
|
2457
2456
|
* <p>The media type of the quick response content.</p>
|
|
2458
2457
|
* <ul>
|
|
2459
2458
|
* <li>
|
|
@@ -2463,60 +2462,61 @@ export interface CreateQuickResponseRequest {
|
|
|
2463
2462
|
* <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response written in richtext.</p>
|
|
2464
2463
|
* </li>
|
|
2465
2464
|
* </ul>
|
|
2465
|
+
* @public
|
|
2466
2466
|
*/
|
|
2467
2467
|
contentType?: string;
|
|
2468
2468
|
/**
|
|
2469
|
-
* @public
|
|
2470
2469
|
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
2470
|
+
* @public
|
|
2471
2471
|
*/
|
|
2472
2472
|
groupingConfiguration?: GroupingConfiguration;
|
|
2473
2473
|
/**
|
|
2474
|
-
* @public
|
|
2475
2474
|
* <p>The description of the quick response.</p>
|
|
2475
|
+
* @public
|
|
2476
2476
|
*/
|
|
2477
2477
|
description?: string;
|
|
2478
2478
|
/**
|
|
2479
|
-
* @public
|
|
2480
2479
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
2481
2480
|
* knowledge base.
|
|
2482
2481
|
* </p>
|
|
2482
|
+
* @public
|
|
2483
2483
|
*/
|
|
2484
2484
|
shortcutKey?: string;
|
|
2485
2485
|
/**
|
|
2486
|
-
* @public
|
|
2487
2486
|
* <p>Whether the quick response is active.</p>
|
|
2487
|
+
* @public
|
|
2488
2488
|
*/
|
|
2489
2489
|
isActive?: boolean;
|
|
2490
2490
|
/**
|
|
2491
|
-
* @public
|
|
2492
2491
|
* <p>The Amazon Connect channels this quick response applies to.</p>
|
|
2492
|
+
* @public
|
|
2493
2493
|
*/
|
|
2494
2494
|
channels?: string[];
|
|
2495
2495
|
/**
|
|
2496
|
-
* @public
|
|
2497
2496
|
* <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>,
|
|
2498
2497
|
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
2499
2498
|
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
2500
2499
|
* </p>
|
|
2500
|
+
* @public
|
|
2501
2501
|
*/
|
|
2502
2502
|
language?: string;
|
|
2503
2503
|
/**
|
|
2504
|
-
* @public
|
|
2505
2504
|
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
2506
2505
|
* request. If not provided, the Amazon Web Services
|
|
2507
2506
|
* SDK populates this field. For more information about idempotency, see
|
|
2508
2507
|
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
2508
|
+
* @public
|
|
2509
2509
|
*/
|
|
2510
2510
|
clientToken?: string;
|
|
2511
2511
|
/**
|
|
2512
|
-
* @public
|
|
2513
2512
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2513
|
+
* @public
|
|
2514
2514
|
*/
|
|
2515
2515
|
tags?: Record<string, string>;
|
|
2516
2516
|
}
|
|
2517
2517
|
/**
|
|
2518
|
-
* @public
|
|
2519
2518
|
* <p>The container quick response content.</p>
|
|
2519
|
+
* @public
|
|
2520
2520
|
*/
|
|
2521
2521
|
export type QuickResponseContentProvider = QuickResponseContentProvider.ContentMember | QuickResponseContentProvider.$UnknownMember;
|
|
2522
2522
|
/**
|
|
@@ -2524,8 +2524,8 @@ export type QuickResponseContentProvider = QuickResponseContentProvider.ContentM
|
|
|
2524
2524
|
*/
|
|
2525
2525
|
export declare namespace QuickResponseContentProvider {
|
|
2526
2526
|
/**
|
|
2527
|
-
* @public
|
|
2528
2527
|
* <p>The content of the quick response.</p>
|
|
2528
|
+
* @public
|
|
2529
2529
|
*/
|
|
2530
2530
|
interface ContentMember {
|
|
2531
2531
|
content: string;
|
|
@@ -2545,18 +2545,18 @@ export declare namespace QuickResponseContentProvider {
|
|
|
2545
2545
|
const visit: <T>(value: QuickResponseContentProvider, visitor: Visitor<T>) => T;
|
|
2546
2546
|
}
|
|
2547
2547
|
/**
|
|
2548
|
-
* @public
|
|
2549
2548
|
* <p>The content of the quick response stored in different media types.</p>
|
|
2549
|
+
* @public
|
|
2550
2550
|
*/
|
|
2551
2551
|
export interface QuickResponseContents {
|
|
2552
2552
|
/**
|
|
2553
|
-
* @public
|
|
2554
2553
|
* <p>The container quick response content.</p>
|
|
2554
|
+
* @public
|
|
2555
2555
|
*/
|
|
2556
2556
|
plainText?: QuickResponseContentProvider;
|
|
2557
2557
|
/**
|
|
2558
|
-
* @public
|
|
2559
2558
|
* <p>The container quick response content.</p>
|
|
2559
|
+
* @public
|
|
2560
2560
|
*/
|
|
2561
2561
|
markdown?: QuickResponseContentProvider;
|
|
2562
2562
|
}
|
|
@@ -2579,38 +2579,37 @@ export declare const QuickResponseStatus: {
|
|
|
2579
2579
|
*/
|
|
2580
2580
|
export type QuickResponseStatus = (typeof QuickResponseStatus)[keyof typeof QuickResponseStatus];
|
|
2581
2581
|
/**
|
|
2582
|
-
* @public
|
|
2583
2582
|
* <p>Information about the quick response.</p>
|
|
2583
|
+
* @public
|
|
2584
2584
|
*/
|
|
2585
2585
|
export interface QuickResponseData {
|
|
2586
2586
|
/**
|
|
2587
|
-
* @public
|
|
2588
2587
|
* <p>The Amazon Resource Name (ARN) of the quick response.</p>
|
|
2588
|
+
* @public
|
|
2589
2589
|
*/
|
|
2590
2590
|
quickResponseArn: string | undefined;
|
|
2591
2591
|
/**
|
|
2592
|
-
* @public
|
|
2593
2592
|
* <p>The identifier of the quick response.</p>
|
|
2593
|
+
* @public
|
|
2594
2594
|
*/
|
|
2595
2595
|
quickResponseId: string | undefined;
|
|
2596
2596
|
/**
|
|
2597
|
-
* @public
|
|
2598
2597
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
2598
|
+
* @public
|
|
2599
2599
|
*/
|
|
2600
2600
|
knowledgeBaseArn: string | undefined;
|
|
2601
2601
|
/**
|
|
2602
|
-
* @public
|
|
2603
2602
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2604
2603
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2604
|
+
* @public
|
|
2605
2605
|
*/
|
|
2606
2606
|
knowledgeBaseId: string | undefined;
|
|
2607
2607
|
/**
|
|
2608
|
-
* @public
|
|
2609
2608
|
* <p>The name of the quick response.</p>
|
|
2609
|
+
* @public
|
|
2610
2610
|
*/
|
|
2611
2611
|
name: string | undefined;
|
|
2612
2612
|
/**
|
|
2613
|
-
* @public
|
|
2614
2613
|
* <p>The media type of the quick response content.</p>
|
|
2615
2614
|
* <ul>
|
|
2616
2615
|
* <li>
|
|
@@ -2620,67 +2619,68 @@ export interface QuickResponseData {
|
|
|
2620
2619
|
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
|
|
2621
2620
|
* </li>
|
|
2622
2621
|
* </ul>
|
|
2622
|
+
* @public
|
|
2623
2623
|
*/
|
|
2624
2624
|
contentType: string | undefined;
|
|
2625
2625
|
/**
|
|
2626
|
-
* @public
|
|
2627
2626
|
* <p>The status of the quick response data.</p>
|
|
2627
|
+
* @public
|
|
2628
2628
|
*/
|
|
2629
2629
|
status: QuickResponseStatus | undefined;
|
|
2630
2630
|
/**
|
|
2631
|
-
* @public
|
|
2632
2631
|
* <p>The timestamp when the quick response was created.</p>
|
|
2632
|
+
* @public
|
|
2633
2633
|
*/
|
|
2634
2634
|
createdTime: Date | undefined;
|
|
2635
2635
|
/**
|
|
2636
|
-
* @public
|
|
2637
2636
|
* <p>The timestamp when the quick response data was last modified.</p>
|
|
2637
|
+
* @public
|
|
2638
2638
|
*/
|
|
2639
2639
|
lastModifiedTime: Date | undefined;
|
|
2640
2640
|
/**
|
|
2641
|
-
* @public
|
|
2642
2641
|
* <p>The contents of the quick response.</p>
|
|
2642
|
+
* @public
|
|
2643
2643
|
*/
|
|
2644
2644
|
contents?: QuickResponseContents;
|
|
2645
2645
|
/**
|
|
2646
|
-
* @public
|
|
2647
2646
|
* <p>The description of the quick response.</p>
|
|
2647
|
+
* @public
|
|
2648
2648
|
*/
|
|
2649
2649
|
description?: string;
|
|
2650
2650
|
/**
|
|
2651
|
-
* @public
|
|
2652
2651
|
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
2652
|
+
* @public
|
|
2653
2653
|
*/
|
|
2654
2654
|
groupingConfiguration?: GroupingConfiguration;
|
|
2655
2655
|
/**
|
|
2656
|
-
* @public
|
|
2657
2656
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
2658
2657
|
* knowledge base.</p>
|
|
2658
|
+
* @public
|
|
2659
2659
|
*/
|
|
2660
2660
|
shortcutKey?: string;
|
|
2661
2661
|
/**
|
|
2662
|
-
* @public
|
|
2663
2662
|
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
|
|
2663
|
+
* @public
|
|
2664
2664
|
*/
|
|
2665
2665
|
lastModifiedBy?: string;
|
|
2666
2666
|
/**
|
|
2667
|
-
* @public
|
|
2668
2667
|
* <p>Whether the quick response is active.</p>
|
|
2668
|
+
* @public
|
|
2669
2669
|
*/
|
|
2670
2670
|
isActive?: boolean;
|
|
2671
2671
|
/**
|
|
2672
|
-
* @public
|
|
2673
2672
|
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
2673
|
+
* @public
|
|
2674
2674
|
*/
|
|
2675
2675
|
channels?: string[];
|
|
2676
2676
|
/**
|
|
2677
|
-
* @public
|
|
2678
2677
|
* <p>The language code value for the language in which the quick response is written.</p>
|
|
2678
|
+
* @public
|
|
2679
2679
|
*/
|
|
2680
2680
|
language?: string;
|
|
2681
2681
|
/**
|
|
2682
|
-
* @public
|
|
2683
2682
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
2683
|
+
* @public
|
|
2684
2684
|
*/
|
|
2685
2685
|
tags?: Record<string, string>;
|
|
2686
2686
|
}
|
|
@@ -2689,8 +2689,8 @@ export interface QuickResponseData {
|
|
|
2689
2689
|
*/
|
|
2690
2690
|
export interface CreateQuickResponseResponse {
|
|
2691
2691
|
/**
|
|
2692
|
-
* @public
|
|
2693
2692
|
* <p>The quick response.</p>
|
|
2693
|
+
* @public
|
|
2694
2694
|
*/
|
|
2695
2695
|
quickResponse?: QuickResponseData;
|
|
2696
2696
|
}
|
|
@@ -2699,14 +2699,14 @@ export interface CreateQuickResponseResponse {
|
|
|
2699
2699
|
*/
|
|
2700
2700
|
export interface DeleteImportJobRequest {
|
|
2701
2701
|
/**
|
|
2702
|
-
* @public
|
|
2703
2702
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2704
2703
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
2704
|
+
* @public
|
|
2705
2705
|
*/
|
|
2706
2706
|
knowledgeBaseId: string | undefined;
|
|
2707
2707
|
/**
|
|
2708
|
-
* @public
|
|
2709
2708
|
* <p>The identifier of the import job to be deleted.</p>
|
|
2709
|
+
* @public
|
|
2710
2710
|
*/
|
|
2711
2711
|
importJobId: string | undefined;
|
|
2712
2712
|
}
|
|
@@ -2720,8 +2720,8 @@ export interface DeleteImportJobResponse {
|
|
|
2720
2720
|
*/
|
|
2721
2721
|
export interface DeleteKnowledgeBaseRequest {
|
|
2722
2722
|
/**
|
|
2723
|
-
* @public
|
|
2724
2723
|
* <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2724
|
+
* @public
|
|
2725
2725
|
*/
|
|
2726
2726
|
knowledgeBaseId: string | undefined;
|
|
2727
2727
|
}
|
|
@@ -2735,14 +2735,14 @@ export interface DeleteKnowledgeBaseResponse {
|
|
|
2735
2735
|
*/
|
|
2736
2736
|
export interface DeleteQuickResponseRequest {
|
|
2737
2737
|
/**
|
|
2738
|
-
* @public
|
|
2739
2738
|
* <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2740
2739
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
2740
|
+
* @public
|
|
2741
2741
|
*/
|
|
2742
2742
|
knowledgeBaseId: string | undefined;
|
|
2743
2743
|
/**
|
|
2744
|
-
* @public
|
|
2745
2744
|
* <p>The identifier of the quick response to delete.</p>
|
|
2745
|
+
* @public
|
|
2746
2746
|
*/
|
|
2747
2747
|
quickResponseId: string | undefined;
|
|
2748
2748
|
}
|
|
@@ -2763,18 +2763,18 @@ export declare const ExternalSource: {
|
|
|
2763
2763
|
*/
|
|
2764
2764
|
export type ExternalSource = (typeof ExternalSource)[keyof typeof ExternalSource];
|
|
2765
2765
|
/**
|
|
2766
|
-
* @public
|
|
2767
2766
|
* <p>The configuration information of the external data source.</p>
|
|
2767
|
+
* @public
|
|
2768
2768
|
*/
|
|
2769
2769
|
export interface ExternalSourceConfiguration {
|
|
2770
2770
|
/**
|
|
2771
|
-
* @public
|
|
2772
2771
|
* <p>The type of the external data source.</p>
|
|
2772
|
+
* @public
|
|
2773
2773
|
*/
|
|
2774
2774
|
source: ExternalSource | undefined;
|
|
2775
2775
|
/**
|
|
2776
|
-
* @public
|
|
2777
2776
|
* <p>The configuration information of the external data source.</p>
|
|
2777
|
+
* @public
|
|
2778
2778
|
*/
|
|
2779
2779
|
configuration: Configuration | undefined;
|
|
2780
2780
|
}
|
|
@@ -2783,13 +2783,13 @@ export interface ExternalSourceConfiguration {
|
|
|
2783
2783
|
*/
|
|
2784
2784
|
export interface GetImportJobRequest {
|
|
2785
2785
|
/**
|
|
2786
|
-
* @public
|
|
2787
2786
|
* <p>The identifier of the import job to retrieve.</p>
|
|
2787
|
+
* @public
|
|
2788
2788
|
*/
|
|
2789
2789
|
importJobId: string | undefined;
|
|
2790
2790
|
/**
|
|
2791
|
-
* @public
|
|
2792
2791
|
* <p>The identifier of the knowledge base that the import job belongs to.</p>
|
|
2792
|
+
* @public
|
|
2793
2793
|
*/
|
|
2794
2794
|
knowledgeBaseId: string | undefined;
|
|
2795
2795
|
}
|
|
@@ -2821,74 +2821,74 @@ export declare const ImportJobStatus: {
|
|
|
2821
2821
|
*/
|
|
2822
2822
|
export type ImportJobStatus = (typeof ImportJobStatus)[keyof typeof ImportJobStatus];
|
|
2823
2823
|
/**
|
|
2824
|
-
* @public
|
|
2825
2824
|
* <p>Summary information about the import job.</p>
|
|
2825
|
+
* @public
|
|
2826
2826
|
*/
|
|
2827
2827
|
export interface ImportJobData {
|
|
2828
2828
|
/**
|
|
2829
|
-
* @public
|
|
2830
2829
|
* <p>The identifier of the import job.</p>
|
|
2830
|
+
* @public
|
|
2831
2831
|
*/
|
|
2832
2832
|
importJobId: string | undefined;
|
|
2833
2833
|
/**
|
|
2834
|
-
* @public
|
|
2835
2834
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2836
2835
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
2836
|
+
* @public
|
|
2837
2837
|
*/
|
|
2838
2838
|
knowledgeBaseId: string | undefined;
|
|
2839
2839
|
/**
|
|
2840
|
-
* @public
|
|
2841
2840
|
* <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>
|
|
2841
|
+
* @public
|
|
2842
2842
|
*/
|
|
2843
2843
|
uploadId: string | undefined;
|
|
2844
2844
|
/**
|
|
2845
|
-
* @public
|
|
2846
2845
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
2846
|
+
* @public
|
|
2847
2847
|
*/
|
|
2848
2848
|
knowledgeBaseArn: string | undefined;
|
|
2849
2849
|
/**
|
|
2850
|
-
* @public
|
|
2851
2850
|
* <p>The type of the import job.</p>
|
|
2851
|
+
* @public
|
|
2852
2852
|
*/
|
|
2853
2853
|
importJobType: ImportJobType | undefined;
|
|
2854
2854
|
/**
|
|
2855
|
-
* @public
|
|
2856
2855
|
* <p>The status of the import job.</p>
|
|
2856
|
+
* @public
|
|
2857
2857
|
*/
|
|
2858
2858
|
status: ImportJobStatus | undefined;
|
|
2859
2859
|
/**
|
|
2860
|
-
* @public
|
|
2861
2860
|
* <p>The download link to the resource file that is uploaded to the import job.</p>
|
|
2861
|
+
* @public
|
|
2862
2862
|
*/
|
|
2863
2863
|
url: string | undefined;
|
|
2864
2864
|
/**
|
|
2865
|
-
* @public
|
|
2866
2865
|
* <p>The link to donwload the information of resource data that failed to be imported.</p>
|
|
2866
|
+
* @public
|
|
2867
2867
|
*/
|
|
2868
2868
|
failedRecordReport?: string;
|
|
2869
2869
|
/**
|
|
2870
|
-
* @public
|
|
2871
2870
|
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
2871
|
+
* @public
|
|
2872
2872
|
*/
|
|
2873
2873
|
urlExpiry: Date | undefined;
|
|
2874
2874
|
/**
|
|
2875
|
-
* @public
|
|
2876
2875
|
* <p>The timestamp when the import job was created.</p>
|
|
2876
|
+
* @public
|
|
2877
2877
|
*/
|
|
2878
2878
|
createdTime: Date | undefined;
|
|
2879
2879
|
/**
|
|
2880
|
-
* @public
|
|
2881
2880
|
* <p>The timestamp when the import job data was last modified.</p>
|
|
2881
|
+
* @public
|
|
2882
2882
|
*/
|
|
2883
2883
|
lastModifiedTime: Date | undefined;
|
|
2884
2884
|
/**
|
|
2885
|
-
* @public
|
|
2886
2885
|
* <p>The metadata fields of the imported Amazon Q resources.</p>
|
|
2886
|
+
* @public
|
|
2887
2887
|
*/
|
|
2888
2888
|
metadata?: Record<string, string>;
|
|
2889
2889
|
/**
|
|
2890
|
-
* @public
|
|
2891
2890
|
* <p>The configuration information of the external data source.</p>
|
|
2891
|
+
* @public
|
|
2892
2892
|
*/
|
|
2893
2893
|
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
2894
2894
|
}
|
|
@@ -2897,8 +2897,8 @@ export interface ImportJobData {
|
|
|
2897
2897
|
*/
|
|
2898
2898
|
export interface GetImportJobResponse {
|
|
2899
2899
|
/**
|
|
2900
|
-
* @public
|
|
2901
2900
|
* <p>The import job.</p>
|
|
2901
|
+
* @public
|
|
2902
2902
|
*/
|
|
2903
2903
|
importJob?: ImportJobData;
|
|
2904
2904
|
}
|
|
@@ -2907,9 +2907,9 @@ export interface GetImportJobResponse {
|
|
|
2907
2907
|
*/
|
|
2908
2908
|
export interface GetKnowledgeBaseRequest {
|
|
2909
2909
|
/**
|
|
2910
|
-
* @public
|
|
2911
2910
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2912
2911
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
2912
|
+
* @public
|
|
2913
2913
|
*/
|
|
2914
2914
|
knowledgeBaseId: string | undefined;
|
|
2915
2915
|
}
|
|
@@ -2918,8 +2918,8 @@ export interface GetKnowledgeBaseRequest {
|
|
|
2918
2918
|
*/
|
|
2919
2919
|
export interface GetKnowledgeBaseResponse {
|
|
2920
2920
|
/**
|
|
2921
|
-
* @public
|
|
2922
2921
|
* <p>The knowledge base.</p>
|
|
2922
|
+
* @public
|
|
2923
2923
|
*/
|
|
2924
2924
|
knowledgeBase?: KnowledgeBaseData;
|
|
2925
2925
|
}
|
|
@@ -2928,13 +2928,13 @@ export interface GetKnowledgeBaseResponse {
|
|
|
2928
2928
|
*/
|
|
2929
2929
|
export interface GetQuickResponseRequest {
|
|
2930
2930
|
/**
|
|
2931
|
-
* @public
|
|
2932
2931
|
* <p>The identifier of the quick response.</p>
|
|
2932
|
+
* @public
|
|
2933
2933
|
*/
|
|
2934
2934
|
quickResponseId: string | undefined;
|
|
2935
2935
|
/**
|
|
2936
|
-
* @public
|
|
2937
2936
|
* <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</p>
|
|
2937
|
+
* @public
|
|
2938
2938
|
*/
|
|
2939
2939
|
knowledgeBaseId: string | undefined;
|
|
2940
2940
|
}
|
|
@@ -2943,65 +2943,65 @@ export interface GetQuickResponseRequest {
|
|
|
2943
2943
|
*/
|
|
2944
2944
|
export interface GetQuickResponseResponse {
|
|
2945
2945
|
/**
|
|
2946
|
-
* @public
|
|
2947
2946
|
* <p>The quick response.</p>
|
|
2947
|
+
* @public
|
|
2948
2948
|
*/
|
|
2949
2949
|
quickResponse?: QuickResponseData;
|
|
2950
2950
|
}
|
|
2951
2951
|
/**
|
|
2952
|
-
* @public
|
|
2953
2952
|
* <p>Summary information about the import job.</p>
|
|
2953
|
+
* @public
|
|
2954
2954
|
*/
|
|
2955
2955
|
export interface ImportJobSummary {
|
|
2956
2956
|
/**
|
|
2957
|
-
* @public
|
|
2958
2957
|
* <p>The identifier of the import job.</p>
|
|
2958
|
+
* @public
|
|
2959
2959
|
*/
|
|
2960
2960
|
importJobId: string | undefined;
|
|
2961
2961
|
/**
|
|
2962
|
-
* @public
|
|
2963
2962
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
2964
2963
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
2964
|
+
* @public
|
|
2965
2965
|
*/
|
|
2966
2966
|
knowledgeBaseId: string | undefined;
|
|
2967
2967
|
/**
|
|
2968
|
-
* @public
|
|
2969
2968
|
* <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>
|
|
2969
|
+
* @public
|
|
2970
2970
|
*/
|
|
2971
2971
|
uploadId: string | undefined;
|
|
2972
2972
|
/**
|
|
2973
|
-
* @public
|
|
2974
2973
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
2974
|
+
* @public
|
|
2975
2975
|
*/
|
|
2976
2976
|
knowledgeBaseArn: string | undefined;
|
|
2977
2977
|
/**
|
|
2978
|
-
* @public
|
|
2979
2978
|
* <p>The type of import job.</p>
|
|
2979
|
+
* @public
|
|
2980
2980
|
*/
|
|
2981
2981
|
importJobType: ImportJobType | undefined;
|
|
2982
2982
|
/**
|
|
2983
|
-
* @public
|
|
2984
2983
|
* <p>The status of the import job.</p>
|
|
2984
|
+
* @public
|
|
2985
2985
|
*/
|
|
2986
2986
|
status: ImportJobStatus | undefined;
|
|
2987
2987
|
/**
|
|
2988
|
-
* @public
|
|
2989
2988
|
* <p>The timestamp when the import job was created.</p>
|
|
2989
|
+
* @public
|
|
2990
2990
|
*/
|
|
2991
2991
|
createdTime: Date | undefined;
|
|
2992
2992
|
/**
|
|
2993
|
-
* @public
|
|
2994
2993
|
* <p>The timestamp when the import job was last modified.</p>
|
|
2994
|
+
* @public
|
|
2995
2995
|
*/
|
|
2996
2996
|
lastModifiedTime: Date | undefined;
|
|
2997
2997
|
/**
|
|
2998
|
-
* @public
|
|
2999
2998
|
* <p>The metadata fields of the imported Amazon Q resources.</p>
|
|
2999
|
+
* @public
|
|
3000
3000
|
*/
|
|
3001
3001
|
metadata?: Record<string, string>;
|
|
3002
3002
|
/**
|
|
3003
|
-
* @public
|
|
3004
3003
|
* <p>The configuration information of the external source that the resource data are imported from.</p>
|
|
3004
|
+
* @public
|
|
3005
3005
|
*/
|
|
3006
3006
|
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
3007
3007
|
}
|
|
@@ -3010,20 +3010,20 @@ export interface ImportJobSummary {
|
|
|
3010
3010
|
*/
|
|
3011
3011
|
export interface ListImportJobsRequest {
|
|
3012
3012
|
/**
|
|
3013
|
-
* @public
|
|
3014
3013
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3015
3014
|
* response in the next request to retrieve the next set of results.</p>
|
|
3015
|
+
* @public
|
|
3016
3016
|
*/
|
|
3017
3017
|
nextToken?: string;
|
|
3018
3018
|
/**
|
|
3019
|
-
* @public
|
|
3020
3019
|
* <p>The maximum number of results to return per page.</p>
|
|
3020
|
+
* @public
|
|
3021
3021
|
*/
|
|
3022
3022
|
maxResults?: number;
|
|
3023
3023
|
/**
|
|
3024
|
-
* @public
|
|
3025
3024
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3026
3025
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3026
|
+
* @public
|
|
3027
3027
|
*/
|
|
3028
3028
|
knowledgeBaseId: string | undefined;
|
|
3029
3029
|
}
|
|
@@ -3032,14 +3032,14 @@ export interface ListImportJobsRequest {
|
|
|
3032
3032
|
*/
|
|
3033
3033
|
export interface ListImportJobsResponse {
|
|
3034
3034
|
/**
|
|
3035
|
-
* @public
|
|
3036
3035
|
* <p>Summary information about the import jobs.</p>
|
|
3036
|
+
* @public
|
|
3037
3037
|
*/
|
|
3038
3038
|
importJobSummaries: ImportJobSummary[] | undefined;
|
|
3039
3039
|
/**
|
|
3040
|
-
* @public
|
|
3041
3040
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3042
3041
|
* response in the next request to retrieve the next set of results.</p>
|
|
3042
|
+
* @public
|
|
3043
3043
|
*/
|
|
3044
3044
|
nextToken?: string;
|
|
3045
3045
|
}
|
|
@@ -3048,60 +3048,59 @@ export interface ListImportJobsResponse {
|
|
|
3048
3048
|
*/
|
|
3049
3049
|
export interface ListKnowledgeBasesRequest {
|
|
3050
3050
|
/**
|
|
3051
|
-
* @public
|
|
3052
3051
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3053
3052
|
* response in the next request to retrieve the next set of results.</p>
|
|
3053
|
+
* @public
|
|
3054
3054
|
*/
|
|
3055
3055
|
nextToken?: string;
|
|
3056
3056
|
/**
|
|
3057
|
-
* @public
|
|
3058
3057
|
* <p>The maximum number of results to return per page.</p>
|
|
3058
|
+
* @public
|
|
3059
3059
|
*/
|
|
3060
3060
|
maxResults?: number;
|
|
3061
3061
|
}
|
|
3062
3062
|
/**
|
|
3063
|
-
* @public
|
|
3064
3063
|
* <p>Summary information about the knowledge base.</p>
|
|
3064
|
+
* @public
|
|
3065
3065
|
*/
|
|
3066
3066
|
export interface KnowledgeBaseSummary {
|
|
3067
3067
|
/**
|
|
3068
|
-
* @public
|
|
3069
3068
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3070
3069
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
3070
|
+
* @public
|
|
3071
3071
|
*/
|
|
3072
3072
|
knowledgeBaseId: string | undefined;
|
|
3073
3073
|
/**
|
|
3074
|
-
* @public
|
|
3075
3074
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
3075
|
+
* @public
|
|
3076
3076
|
*/
|
|
3077
3077
|
knowledgeBaseArn: string | undefined;
|
|
3078
3078
|
/**
|
|
3079
|
-
* @public
|
|
3080
3079
|
* <p>The name of the knowledge base.</p>
|
|
3080
|
+
* @public
|
|
3081
3081
|
*/
|
|
3082
3082
|
name: string | undefined;
|
|
3083
3083
|
/**
|
|
3084
|
-
* @public
|
|
3085
3084
|
* <p>The type of knowledge base.</p>
|
|
3085
|
+
* @public
|
|
3086
3086
|
*/
|
|
3087
3087
|
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
3088
3088
|
/**
|
|
3089
|
-
* @public
|
|
3090
3089
|
* <p>The status of the knowledge base summary.</p>
|
|
3090
|
+
* @public
|
|
3091
3091
|
*/
|
|
3092
3092
|
status: KnowledgeBaseStatus | undefined;
|
|
3093
3093
|
/**
|
|
3094
|
-
* @public
|
|
3095
3094
|
* <p>Configuration information about the external data source.</p>
|
|
3095
|
+
* @public
|
|
3096
3096
|
*/
|
|
3097
3097
|
sourceConfiguration?: SourceConfiguration;
|
|
3098
3098
|
/**
|
|
3099
|
-
* @public
|
|
3100
3099
|
* <p>Information about how to render the content.</p>
|
|
3100
|
+
* @public
|
|
3101
3101
|
*/
|
|
3102
3102
|
renderingConfiguration?: RenderingConfiguration;
|
|
3103
3103
|
/**
|
|
3104
|
-
* @public
|
|
3105
3104
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
3106
3105
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
3107
3106
|
* <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
|
|
@@ -3109,16 +3108,17 @@ export interface KnowledgeBaseSummary {
|
|
|
3109
3108
|
* key to invoke Amazon Q. </p>
|
|
3110
3109
|
* <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
|
|
3111
3110
|
* your instance</a>.</p>
|
|
3111
|
+
* @public
|
|
3112
3112
|
*/
|
|
3113
3113
|
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
|
|
3114
3114
|
/**
|
|
3115
|
-
* @public
|
|
3116
3115
|
* <p>The description of the knowledge base.</p>
|
|
3116
|
+
* @public
|
|
3117
3117
|
*/
|
|
3118
3118
|
description?: string;
|
|
3119
3119
|
/**
|
|
3120
|
-
* @public
|
|
3121
3120
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3121
|
+
* @public
|
|
3122
3122
|
*/
|
|
3123
3123
|
tags?: Record<string, string>;
|
|
3124
3124
|
}
|
|
@@ -3127,13 +3127,13 @@ export interface KnowledgeBaseSummary {
|
|
|
3127
3127
|
*/
|
|
3128
3128
|
export interface ListKnowledgeBasesResponse {
|
|
3129
3129
|
/**
|
|
3130
|
-
* @public
|
|
3131
3130
|
* <p>Information about the knowledge bases.</p>
|
|
3131
|
+
* @public
|
|
3132
3132
|
*/
|
|
3133
3133
|
knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
3134
3134
|
/**
|
|
3135
|
-
* @public
|
|
3136
3135
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
3136
|
+
* @public
|
|
3137
3137
|
*/
|
|
3138
3138
|
nextToken?: string;
|
|
3139
3139
|
}
|
|
@@ -3142,56 +3142,55 @@ export interface ListKnowledgeBasesResponse {
|
|
|
3142
3142
|
*/
|
|
3143
3143
|
export interface ListQuickResponsesRequest {
|
|
3144
3144
|
/**
|
|
3145
|
-
* @public
|
|
3146
3145
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3147
3146
|
* response in the next request to retrieve the next set of results.</p>
|
|
3147
|
+
* @public
|
|
3148
3148
|
*/
|
|
3149
3149
|
nextToken?: string;
|
|
3150
3150
|
/**
|
|
3151
|
-
* @public
|
|
3152
3151
|
* <p>The maximum number of results to return per page.</p>
|
|
3152
|
+
* @public
|
|
3153
3153
|
*/
|
|
3154
3154
|
maxResults?: number;
|
|
3155
3155
|
/**
|
|
3156
|
-
* @public
|
|
3157
3156
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3158
3157
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3158
|
+
* @public
|
|
3159
3159
|
*/
|
|
3160
3160
|
knowledgeBaseId: string | undefined;
|
|
3161
3161
|
}
|
|
3162
3162
|
/**
|
|
3163
|
-
* @public
|
|
3164
3163
|
* <p>The summary information about the quick response.</p>
|
|
3164
|
+
* @public
|
|
3165
3165
|
*/
|
|
3166
3166
|
export interface QuickResponseSummary {
|
|
3167
3167
|
/**
|
|
3168
|
-
* @public
|
|
3169
3168
|
* <p>The Amazon Resource Name (ARN) of the quick response.</p>
|
|
3169
|
+
* @public
|
|
3170
3170
|
*/
|
|
3171
3171
|
quickResponseArn: string | undefined;
|
|
3172
3172
|
/**
|
|
3173
|
-
* @public
|
|
3174
3173
|
* <p>The identifier of the quick response.</p>
|
|
3174
|
+
* @public
|
|
3175
3175
|
*/
|
|
3176
3176
|
quickResponseId: string | undefined;
|
|
3177
3177
|
/**
|
|
3178
|
-
* @public
|
|
3179
3178
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
3179
|
+
* @public
|
|
3180
3180
|
*/
|
|
3181
3181
|
knowledgeBaseArn: string | undefined;
|
|
3182
3182
|
/**
|
|
3183
|
-
* @public
|
|
3184
3183
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3185
3184
|
* base if you're storing Amazon Q Content resource to it.</p>
|
|
3185
|
+
* @public
|
|
3186
3186
|
*/
|
|
3187
3187
|
knowledgeBaseId: string | undefined;
|
|
3188
3188
|
/**
|
|
3189
|
-
* @public
|
|
3190
3189
|
* <p>The name of the quick response.</p>
|
|
3190
|
+
* @public
|
|
3191
3191
|
*/
|
|
3192
3192
|
name: string | undefined;
|
|
3193
3193
|
/**
|
|
3194
|
-
* @public
|
|
3195
3194
|
* <p>The media type of the quick response content.</p>
|
|
3196
3195
|
* <ul>
|
|
3197
3196
|
* <li>
|
|
@@ -3201,46 +3200,47 @@ export interface QuickResponseSummary {
|
|
|
3201
3200
|
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
|
|
3202
3201
|
* </li>
|
|
3203
3202
|
* </ul>
|
|
3203
|
+
* @public
|
|
3204
3204
|
*/
|
|
3205
3205
|
contentType: string | undefined;
|
|
3206
3206
|
/**
|
|
3207
|
-
* @public
|
|
3208
3207
|
* <p>The resource status of the quick response.</p>
|
|
3208
|
+
* @public
|
|
3209
3209
|
*/
|
|
3210
3210
|
status: QuickResponseStatus | undefined;
|
|
3211
3211
|
/**
|
|
3212
|
-
* @public
|
|
3213
3212
|
* <p>The timestamp when the quick response was created.</p>
|
|
3213
|
+
* @public
|
|
3214
3214
|
*/
|
|
3215
3215
|
createdTime: Date | undefined;
|
|
3216
3216
|
/**
|
|
3217
|
-
* @public
|
|
3218
3217
|
* <p>The timestamp when the quick response summary was last modified.</p>
|
|
3218
|
+
* @public
|
|
3219
3219
|
*/
|
|
3220
3220
|
lastModifiedTime: Date | undefined;
|
|
3221
3221
|
/**
|
|
3222
|
-
* @public
|
|
3223
3222
|
* <p>The description of the quick response.</p>
|
|
3223
|
+
* @public
|
|
3224
3224
|
*/
|
|
3225
3225
|
description?: string;
|
|
3226
3226
|
/**
|
|
3227
|
-
* @public
|
|
3228
3227
|
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
|
|
3228
|
+
* @public
|
|
3229
3229
|
*/
|
|
3230
3230
|
lastModifiedBy?: string;
|
|
3231
3231
|
/**
|
|
3232
|
-
* @public
|
|
3233
3232
|
* <p>Whether the quick response is active.</p>
|
|
3233
|
+
* @public
|
|
3234
3234
|
*/
|
|
3235
3235
|
isActive?: boolean;
|
|
3236
3236
|
/**
|
|
3237
|
-
* @public
|
|
3238
3237
|
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
3238
|
+
* @public
|
|
3239
3239
|
*/
|
|
3240
3240
|
channels?: string[];
|
|
3241
3241
|
/**
|
|
3242
|
-
* @public
|
|
3243
3242
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3243
|
+
* @public
|
|
3244
3244
|
*/
|
|
3245
3245
|
tags?: Record<string, string>;
|
|
3246
3246
|
}
|
|
@@ -3249,14 +3249,14 @@ export interface QuickResponseSummary {
|
|
|
3249
3249
|
*/
|
|
3250
3250
|
export interface ListQuickResponsesResponse {
|
|
3251
3251
|
/**
|
|
3252
|
-
* @public
|
|
3253
3252
|
* <p>Summary information about the quick responses.</p>
|
|
3253
|
+
* @public
|
|
3254
3254
|
*/
|
|
3255
3255
|
quickResponseSummaries: QuickResponseSummary[] | undefined;
|
|
3256
3256
|
/**
|
|
3257
|
-
* @public
|
|
3258
3257
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3259
3258
|
* response in the next request to retrieve the next set of results.</p>
|
|
3259
|
+
* @public
|
|
3260
3260
|
*/
|
|
3261
3261
|
nextToken?: string;
|
|
3262
3262
|
}
|
|
@@ -3265,28 +3265,27 @@ export interface ListQuickResponsesResponse {
|
|
|
3265
3265
|
*/
|
|
3266
3266
|
export interface UpdateQuickResponseRequest {
|
|
3267
3267
|
/**
|
|
3268
|
-
* @public
|
|
3269
3268
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3270
3269
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3270
|
+
* @public
|
|
3271
3271
|
*/
|
|
3272
3272
|
knowledgeBaseId: string | undefined;
|
|
3273
3273
|
/**
|
|
3274
|
-
* @public
|
|
3275
3274
|
* <p>The identifier of the quick response.</p>
|
|
3275
|
+
* @public
|
|
3276
3276
|
*/
|
|
3277
3277
|
quickResponseId: string | undefined;
|
|
3278
3278
|
/**
|
|
3279
|
-
* @public
|
|
3280
3279
|
* <p>The name of the quick response.</p>
|
|
3280
|
+
* @public
|
|
3281
3281
|
*/
|
|
3282
3282
|
name?: string;
|
|
3283
3283
|
/**
|
|
3284
|
-
* @public
|
|
3285
3284
|
* <p>The updated content of the quick response.</p>
|
|
3285
|
+
* @public
|
|
3286
3286
|
*/
|
|
3287
3287
|
content?: QuickResponseDataProvider;
|
|
3288
3288
|
/**
|
|
3289
|
-
* @public
|
|
3290
3289
|
* <p>The media type of the quick response content.</p>
|
|
3291
3290
|
* <ul>
|
|
3292
3291
|
* <li>
|
|
@@ -3296,55 +3295,56 @@ export interface UpdateQuickResponseRequest {
|
|
|
3296
3295
|
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
|
|
3297
3296
|
* </li>
|
|
3298
3297
|
* </ul>
|
|
3298
|
+
* @public
|
|
3299
3299
|
*/
|
|
3300
3300
|
contentType?: string;
|
|
3301
3301
|
/**
|
|
3302
|
-
* @public
|
|
3303
3302
|
* <p>The updated grouping configuration of the quick response.</p>
|
|
3303
|
+
* @public
|
|
3304
3304
|
*/
|
|
3305
3305
|
groupingConfiguration?: GroupingConfiguration;
|
|
3306
3306
|
/**
|
|
3307
|
-
* @public
|
|
3308
3307
|
* <p>Whether to remove the grouping configuration of the quick response.</p>
|
|
3308
|
+
* @public
|
|
3309
3309
|
*/
|
|
3310
3310
|
removeGroupingConfiguration?: boolean;
|
|
3311
3311
|
/**
|
|
3312
|
-
* @public
|
|
3313
3312
|
* <p>The updated description of the quick response.</p>
|
|
3313
|
+
* @public
|
|
3314
3314
|
*/
|
|
3315
3315
|
description?: string;
|
|
3316
3316
|
/**
|
|
3317
|
-
* @public
|
|
3318
3317
|
* <p>Whether to remove the description from the quick response.</p>
|
|
3318
|
+
* @public
|
|
3319
3319
|
*/
|
|
3320
3320
|
removeDescription?: boolean;
|
|
3321
3321
|
/**
|
|
3322
|
-
* @public
|
|
3323
3322
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
3324
3323
|
* knowledge base.</p>
|
|
3324
|
+
* @public
|
|
3325
3325
|
*/
|
|
3326
3326
|
shortcutKey?: string;
|
|
3327
3327
|
/**
|
|
3328
|
-
* @public
|
|
3329
3328
|
* <p>Whether to remove the shortcut key of the quick response.</p>
|
|
3329
|
+
* @public
|
|
3330
3330
|
*/
|
|
3331
3331
|
removeShortcutKey?: boolean;
|
|
3332
3332
|
/**
|
|
3333
|
-
* @public
|
|
3334
3333
|
* <p>Whether the quick response is active. </p>
|
|
3334
|
+
* @public
|
|
3335
3335
|
*/
|
|
3336
3336
|
isActive?: boolean;
|
|
3337
3337
|
/**
|
|
3338
|
-
* @public
|
|
3339
3338
|
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
3339
|
+
* @public
|
|
3340
3340
|
*/
|
|
3341
3341
|
channels?: string[];
|
|
3342
3342
|
/**
|
|
3343
|
-
* @public
|
|
3344
3343
|
* <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>,
|
|
3345
3344
|
* <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
|
|
3346
3345
|
* <code>zh_CN</code>, <code>zh_TW</code>
|
|
3347
3346
|
* </p>
|
|
3347
|
+
* @public
|
|
3348
3348
|
*/
|
|
3349
3349
|
language?: string;
|
|
3350
3350
|
}
|
|
@@ -3353,8 +3353,8 @@ export interface UpdateQuickResponseRequest {
|
|
|
3353
3353
|
*/
|
|
3354
3354
|
export interface UpdateQuickResponseResponse {
|
|
3355
3355
|
/**
|
|
3356
|
-
* @public
|
|
3357
3356
|
* <p>The quick response.</p>
|
|
3357
|
+
* @public
|
|
3358
3358
|
*/
|
|
3359
3359
|
quickResponse?: QuickResponseData;
|
|
3360
3360
|
}
|
|
@@ -3363,9 +3363,9 @@ export interface UpdateQuickResponseResponse {
|
|
|
3363
3363
|
*/
|
|
3364
3364
|
export interface RemoveKnowledgeBaseTemplateUriRequest {
|
|
3365
3365
|
/**
|
|
3366
|
-
* @public
|
|
3367
3366
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3368
3367
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3368
|
+
* @public
|
|
3369
3369
|
*/
|
|
3370
3370
|
knowledgeBaseId: string | undefined;
|
|
3371
3371
|
}
|
|
@@ -3379,25 +3379,25 @@ export interface RemoveKnowledgeBaseTemplateUriResponse {
|
|
|
3379
3379
|
*/
|
|
3380
3380
|
export interface SearchContentRequest {
|
|
3381
3381
|
/**
|
|
3382
|
-
* @public
|
|
3383
3382
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3384
3383
|
* response in the next request to retrieve the next set of results.</p>
|
|
3384
|
+
* @public
|
|
3385
3385
|
*/
|
|
3386
3386
|
nextToken?: string;
|
|
3387
3387
|
/**
|
|
3388
|
-
* @public
|
|
3389
3388
|
* <p>The maximum number of results to return per page.</p>
|
|
3389
|
+
* @public
|
|
3390
3390
|
*/
|
|
3391
3391
|
maxResults?: number;
|
|
3392
3392
|
/**
|
|
3393
|
-
* @public
|
|
3394
3393
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3395
3394
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3395
|
+
* @public
|
|
3396
3396
|
*/
|
|
3397
3397
|
knowledgeBaseId: string | undefined;
|
|
3398
3398
|
/**
|
|
3399
|
-
* @public
|
|
3400
3399
|
* <p>The search expression to filter results.</p>
|
|
3400
|
+
* @public
|
|
3401
3401
|
*/
|
|
3402
3402
|
searchExpression: SearchExpression | undefined;
|
|
3403
3403
|
}
|
|
@@ -3406,13 +3406,13 @@ export interface SearchContentRequest {
|
|
|
3406
3406
|
*/
|
|
3407
3407
|
export interface SearchContentResponse {
|
|
3408
3408
|
/**
|
|
3409
|
-
* @public
|
|
3410
3409
|
* <p>Summary information about the content.</p>
|
|
3410
|
+
* @public
|
|
3411
3411
|
*/
|
|
3412
3412
|
contentSummaries: ContentSummary[] | undefined;
|
|
3413
3413
|
/**
|
|
3414
|
-
* @public
|
|
3415
3414
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
3415
|
+
* @public
|
|
3416
3416
|
*/
|
|
3417
3417
|
nextToken?: string;
|
|
3418
3418
|
}
|
|
@@ -3429,7 +3429,6 @@ export declare const QuickResponseFilterOperator: {
|
|
|
3429
3429
|
*/
|
|
3430
3430
|
export type QuickResponseFilterOperator = (typeof QuickResponseFilterOperator)[keyof typeof QuickResponseFilterOperator];
|
|
3431
3431
|
/**
|
|
3432
|
-
* @public
|
|
3433
3432
|
* <p>The quick response fields to filter the quick response query results by.</p>
|
|
3434
3433
|
* <p>The following is the list of supported field names.</p>
|
|
3435
3434
|
* <ul>
|
|
@@ -3470,26 +3469,27 @@ export type QuickResponseFilterOperator = (typeof QuickResponseFilterOperator)[k
|
|
|
3470
3469
|
* <p>groupingConfiguration.values</p>
|
|
3471
3470
|
* </li>
|
|
3472
3471
|
* </ul>
|
|
3472
|
+
* @public
|
|
3473
3473
|
*/
|
|
3474
3474
|
export interface QuickResponseFilterField {
|
|
3475
3475
|
/**
|
|
3476
|
-
* @public
|
|
3477
3476
|
* <p>The name of the attribute field to filter the quick responses by.</p>
|
|
3477
|
+
* @public
|
|
3478
3478
|
*/
|
|
3479
3479
|
name: string | undefined;
|
|
3480
3480
|
/**
|
|
3481
|
-
* @public
|
|
3482
3481
|
* <p>The values of attribute field to filter the quick response by.</p>
|
|
3482
|
+
* @public
|
|
3483
3483
|
*/
|
|
3484
3484
|
values?: string[];
|
|
3485
3485
|
/**
|
|
3486
|
-
* @public
|
|
3487
3486
|
* <p>The operator to use for filtering.</p>
|
|
3487
|
+
* @public
|
|
3488
3488
|
*/
|
|
3489
3489
|
operator: QuickResponseFilterOperator | undefined;
|
|
3490
3490
|
/**
|
|
3491
|
-
* @public
|
|
3492
3491
|
* <p>Whether to treat null value as a match for the attribute field.</p>
|
|
3492
|
+
* @public
|
|
3493
3493
|
*/
|
|
3494
3494
|
includeNoExistence?: boolean;
|
|
3495
3495
|
}
|
|
@@ -3506,7 +3506,6 @@ export declare const Order: {
|
|
|
3506
3506
|
*/
|
|
3507
3507
|
export type Order = (typeof Order)[keyof typeof Order];
|
|
3508
3508
|
/**
|
|
3509
|
-
* @public
|
|
3510
3509
|
* <p>The quick response fields to order the quick response query results by.</p>
|
|
3511
3510
|
* <p>The following is the list of supported field names.</p>
|
|
3512
3511
|
* <ul>
|
|
@@ -3547,16 +3546,17 @@ export type Order = (typeof Order)[keyof typeof Order];
|
|
|
3547
3546
|
* <p>groupingConfiguration.values</p>
|
|
3548
3547
|
* </li>
|
|
3549
3548
|
* </ul>
|
|
3549
|
+
* @public
|
|
3550
3550
|
*/
|
|
3551
3551
|
export interface QuickResponseOrderField {
|
|
3552
3552
|
/**
|
|
3553
|
-
* @public
|
|
3554
3553
|
* <p>The name of the attribute to order the quick response query results by.</p>
|
|
3554
|
+
* @public
|
|
3555
3555
|
*/
|
|
3556
3556
|
name: string | undefined;
|
|
3557
3557
|
/**
|
|
3558
|
-
* @public
|
|
3559
3558
|
* <p>The order at which the quick responses are sorted by.</p>
|
|
3559
|
+
* @public
|
|
3560
3560
|
*/
|
|
3561
3561
|
order?: Order;
|
|
3562
3562
|
}
|
|
@@ -3586,7 +3586,6 @@ export declare const Priority: {
|
|
|
3586
3586
|
*/
|
|
3587
3587
|
export type Priority = (typeof Priority)[keyof typeof Priority];
|
|
3588
3588
|
/**
|
|
3589
|
-
* @public
|
|
3590
3589
|
* <p>The quick response fields to query quick responses by.</p>
|
|
3591
3590
|
* <p>The following is the list of supported field names.</p>
|
|
3592
3591
|
* <ul>
|
|
@@ -3603,53 +3602,54 @@ export type Priority = (typeof Priority)[keyof typeof Priority];
|
|
|
3603
3602
|
* <p>shortcutKey</p>
|
|
3604
3603
|
* </li>
|
|
3605
3604
|
* </ul>
|
|
3605
|
+
* @public
|
|
3606
3606
|
*/
|
|
3607
3607
|
export interface QuickResponseQueryField {
|
|
3608
3608
|
/**
|
|
3609
|
-
* @public
|
|
3610
3609
|
* <p>The name of the attribute to query the quick responses by.</p>
|
|
3610
|
+
* @public
|
|
3611
3611
|
*/
|
|
3612
3612
|
name: string | undefined;
|
|
3613
3613
|
/**
|
|
3614
|
-
* @public
|
|
3615
3614
|
* <p>The values of the attribute to query the quick responses by.</p>
|
|
3615
|
+
* @public
|
|
3616
3616
|
*/
|
|
3617
3617
|
values: string[] | undefined;
|
|
3618
3618
|
/**
|
|
3619
|
-
* @public
|
|
3620
3619
|
* <p>The operator to use for matching attribute field values in the query.</p>
|
|
3620
|
+
* @public
|
|
3621
3621
|
*/
|
|
3622
3622
|
operator: QuickResponseQueryOperator | undefined;
|
|
3623
3623
|
/**
|
|
3624
|
-
* @public
|
|
3625
3624
|
* <p>Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.</p>
|
|
3625
|
+
* @public
|
|
3626
3626
|
*/
|
|
3627
3627
|
allowFuzziness?: boolean;
|
|
3628
3628
|
/**
|
|
3629
|
-
* @public
|
|
3630
3629
|
* <p>The importance of the attribute field when calculating query result relevancy scores.
|
|
3631
3630
|
* The value set for this parameter affects the ordering of search results.</p>
|
|
3631
|
+
* @public
|
|
3632
3632
|
*/
|
|
3633
3633
|
priority?: Priority;
|
|
3634
3634
|
}
|
|
3635
3635
|
/**
|
|
3636
|
-
* @public
|
|
3637
3636
|
* <p>Information about the import job.</p>
|
|
3637
|
+
* @public
|
|
3638
3638
|
*/
|
|
3639
3639
|
export interface QuickResponseSearchExpression {
|
|
3640
3640
|
/**
|
|
3641
|
-
* @public
|
|
3642
3641
|
* <p>The quick response query expressions.</p>
|
|
3642
|
+
* @public
|
|
3643
3643
|
*/
|
|
3644
3644
|
queries?: QuickResponseQueryField[];
|
|
3645
3645
|
/**
|
|
3646
|
-
* @public
|
|
3647
3646
|
* <p>The configuration of filtering rules applied to quick response query results.</p>
|
|
3647
|
+
* @public
|
|
3648
3648
|
*/
|
|
3649
3649
|
filters?: QuickResponseFilterField[];
|
|
3650
3650
|
/**
|
|
3651
|
-
* @public
|
|
3652
3651
|
* <p>The quick response attribute fields on which the query results are ordered.</p>
|
|
3652
|
+
* @public
|
|
3653
3653
|
*/
|
|
3654
3654
|
orderOnField?: QuickResponseOrderField;
|
|
3655
3655
|
}
|
|
@@ -3658,65 +3658,64 @@ export interface QuickResponseSearchExpression {
|
|
|
3658
3658
|
*/
|
|
3659
3659
|
export interface SearchQuickResponsesRequest {
|
|
3660
3660
|
/**
|
|
3661
|
-
* @public
|
|
3662
3661
|
* <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3662
|
+
* @public
|
|
3663
3663
|
*/
|
|
3664
3664
|
knowledgeBaseId: string | undefined;
|
|
3665
3665
|
/**
|
|
3666
|
-
* @public
|
|
3667
3666
|
* <p>The search expression for querying the quick response.</p>
|
|
3667
|
+
* @public
|
|
3668
3668
|
*/
|
|
3669
3669
|
searchExpression: QuickResponseSearchExpression | undefined;
|
|
3670
3670
|
/**
|
|
3671
|
-
* @public
|
|
3672
3671
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3673
3672
|
* response in the next request to retrieve the next set of results.</p>
|
|
3673
|
+
* @public
|
|
3674
3674
|
*/
|
|
3675
3675
|
nextToken?: string;
|
|
3676
3676
|
/**
|
|
3677
|
-
* @public
|
|
3678
3677
|
* <p>The maximum number of results to return per page.</p>
|
|
3678
|
+
* @public
|
|
3679
3679
|
*/
|
|
3680
3680
|
maxResults?: number;
|
|
3681
3681
|
/**
|
|
3682
|
-
* @public
|
|
3683
3682
|
* <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search results are returned.</p>
|
|
3683
|
+
* @public
|
|
3684
3684
|
*/
|
|
3685
3685
|
attributes?: Record<string, string>;
|
|
3686
3686
|
}
|
|
3687
3687
|
/**
|
|
3688
|
-
* @public
|
|
3689
3688
|
* <p>The result of quick response search.</p>
|
|
3689
|
+
* @public
|
|
3690
3690
|
*/
|
|
3691
3691
|
export interface QuickResponseSearchResultData {
|
|
3692
3692
|
/**
|
|
3693
|
-
* @public
|
|
3694
3693
|
* <p>The Amazon Resource Name (ARN) of the quick response.</p>
|
|
3694
|
+
* @public
|
|
3695
3695
|
*/
|
|
3696
3696
|
quickResponseArn: string | undefined;
|
|
3697
3697
|
/**
|
|
3698
|
-
* @public
|
|
3699
3698
|
* <p>The identifier of the quick response.</p>
|
|
3699
|
+
* @public
|
|
3700
3700
|
*/
|
|
3701
3701
|
quickResponseId: string | undefined;
|
|
3702
3702
|
/**
|
|
3703
|
-
* @public
|
|
3704
3703
|
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
3704
|
+
* @public
|
|
3705
3705
|
*/
|
|
3706
3706
|
knowledgeBaseArn: string | undefined;
|
|
3707
3707
|
/**
|
|
3708
|
-
* @public
|
|
3709
3708
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3710
3709
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3710
|
+
* @public
|
|
3711
3711
|
*/
|
|
3712
3712
|
knowledgeBaseId: string | undefined;
|
|
3713
3713
|
/**
|
|
3714
|
-
* @public
|
|
3715
3714
|
* <p>The name of the quick response.</p>
|
|
3715
|
+
* @public
|
|
3716
3716
|
*/
|
|
3717
3717
|
name: string | undefined;
|
|
3718
3718
|
/**
|
|
3719
|
-
* @public
|
|
3720
3719
|
* <p>The media type of the quick response content.</p>
|
|
3721
3720
|
* <ul>
|
|
3722
3721
|
* <li>
|
|
@@ -3726,77 +3725,78 @@ export interface QuickResponseSearchResultData {
|
|
|
3726
3725
|
* <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
|
|
3727
3726
|
* </li>
|
|
3728
3727
|
* </ul>
|
|
3728
|
+
* @public
|
|
3729
3729
|
*/
|
|
3730
3730
|
contentType: string | undefined;
|
|
3731
3731
|
/**
|
|
3732
|
-
* @public
|
|
3733
3732
|
* <p>The resource status of the quick response.</p>
|
|
3733
|
+
* @public
|
|
3734
3734
|
*/
|
|
3735
3735
|
status: QuickResponseStatus | undefined;
|
|
3736
3736
|
/**
|
|
3737
|
-
* @public
|
|
3738
3737
|
* <p>The contents of the quick response.</p>
|
|
3738
|
+
* @public
|
|
3739
3739
|
*/
|
|
3740
3740
|
contents: QuickResponseContents | undefined;
|
|
3741
3741
|
/**
|
|
3742
|
-
* @public
|
|
3743
3742
|
* <p>The timestamp when the quick response was created.</p>
|
|
3743
|
+
* @public
|
|
3744
3744
|
*/
|
|
3745
3745
|
createdTime: Date | undefined;
|
|
3746
3746
|
/**
|
|
3747
|
-
* @public
|
|
3748
3747
|
* <p>The timestamp when the quick response search result data was last modified.</p>
|
|
3748
|
+
* @public
|
|
3749
3749
|
*/
|
|
3750
3750
|
lastModifiedTime: Date | undefined;
|
|
3751
3751
|
/**
|
|
3752
|
-
* @public
|
|
3753
3752
|
* <p>Whether the quick response is active.</p>
|
|
3753
|
+
* @public
|
|
3754
3754
|
*/
|
|
3755
3755
|
isActive: boolean | undefined;
|
|
3756
3756
|
/**
|
|
3757
|
-
* @public
|
|
3758
3757
|
* <p>The description of the quick response.</p>
|
|
3758
|
+
* @public
|
|
3759
3759
|
*/
|
|
3760
3760
|
description?: string;
|
|
3761
3761
|
/**
|
|
3762
|
-
* @public
|
|
3763
3762
|
* <p>The configuration information of the user groups that the quick response is accessible to.</p>
|
|
3763
|
+
* @public
|
|
3764
3764
|
*/
|
|
3765
3765
|
groupingConfiguration?: GroupingConfiguration;
|
|
3766
3766
|
/**
|
|
3767
|
-
* @public
|
|
3768
3767
|
* <p>The shortcut key of the quick response. The value should be unique across the
|
|
3769
3768
|
* knowledge base.</p>
|
|
3769
|
+
* @public
|
|
3770
3770
|
*/
|
|
3771
3771
|
shortcutKey?: string;
|
|
3772
3772
|
/**
|
|
3773
|
-
* @public
|
|
3774
3773
|
* <p>The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.</p>
|
|
3774
|
+
* @public
|
|
3775
3775
|
*/
|
|
3776
3776
|
lastModifiedBy?: string;
|
|
3777
3777
|
/**
|
|
3778
|
-
* @public
|
|
3779
3778
|
* <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
|
|
3779
|
+
* @public
|
|
3780
3780
|
*/
|
|
3781
3781
|
channels?: string[];
|
|
3782
3782
|
/**
|
|
3783
|
-
* @public
|
|
3784
3783
|
* <p>The language code value for the language in which the quick response is written.</p>
|
|
3784
|
+
* @public
|
|
3785
3785
|
*/
|
|
3786
3786
|
language?: string;
|
|
3787
3787
|
/**
|
|
3788
|
-
* @public
|
|
3789
3788
|
* <p>The user defined contact attributes that are not resolved when the search result is returned.</p>
|
|
3789
|
+
* @public
|
|
3790
3790
|
*/
|
|
3791
3791
|
attributesNotInterpolated?: string[];
|
|
3792
3792
|
/**
|
|
3793
|
-
* @public
|
|
3794
3793
|
* <p>The user defined contact attributes that are resolved when the search result is returned.</p>
|
|
3794
|
+
* @public
|
|
3795
3795
|
*/
|
|
3796
3796
|
attributesInterpolated?: string[];
|
|
3797
3797
|
/**
|
|
3798
|
-
* @public
|
|
3799
3798
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3799
|
+
* @public
|
|
3800
3800
|
*/
|
|
3801
3801
|
tags?: Record<string, string>;
|
|
3802
3802
|
}
|
|
@@ -3805,14 +3805,14 @@ export interface QuickResponseSearchResultData {
|
|
|
3805
3805
|
*/
|
|
3806
3806
|
export interface SearchQuickResponsesResponse {
|
|
3807
3807
|
/**
|
|
3808
|
-
* @public
|
|
3809
3808
|
* <p>The results of the quick response search.</p>
|
|
3809
|
+
* @public
|
|
3810
3810
|
*/
|
|
3811
3811
|
results: QuickResponseSearchResultData[] | undefined;
|
|
3812
3812
|
/**
|
|
3813
|
-
* @public
|
|
3814
3813
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3815
3814
|
* response in the next request to retrieve the next set of results.</p>
|
|
3815
|
+
* @public
|
|
3816
3816
|
*/
|
|
3817
3817
|
nextToken?: string;
|
|
3818
3818
|
}
|
|
@@ -3821,19 +3821,19 @@ export interface SearchQuickResponsesResponse {
|
|
|
3821
3821
|
*/
|
|
3822
3822
|
export interface StartContentUploadRequest {
|
|
3823
3823
|
/**
|
|
3824
|
-
* @public
|
|
3825
3824
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3826
3825
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3826
|
+
* @public
|
|
3827
3827
|
*/
|
|
3828
3828
|
knowledgeBaseId: string | undefined;
|
|
3829
3829
|
/**
|
|
3830
|
-
* @public
|
|
3831
3830
|
* <p>The type of content to upload.</p>
|
|
3831
|
+
* @public
|
|
3832
3832
|
*/
|
|
3833
3833
|
contentType: string | undefined;
|
|
3834
3834
|
/**
|
|
3835
|
-
* @public
|
|
3836
3835
|
* <p>The expected expiration time of the generated presigned URL, specified in minutes.</p>
|
|
3836
|
+
* @public
|
|
3837
3837
|
*/
|
|
3838
3838
|
presignedUrlTimeToLive?: number;
|
|
3839
3839
|
}
|
|
@@ -3842,23 +3842,23 @@ export interface StartContentUploadRequest {
|
|
|
3842
3842
|
*/
|
|
3843
3843
|
export interface StartContentUploadResponse {
|
|
3844
3844
|
/**
|
|
3845
|
-
* @public
|
|
3846
3845
|
* <p>The identifier of the upload.</p>
|
|
3846
|
+
* @public
|
|
3847
3847
|
*/
|
|
3848
3848
|
uploadId: string | undefined;
|
|
3849
3849
|
/**
|
|
3850
|
-
* @public
|
|
3851
3850
|
* <p>The URL of the upload.</p>
|
|
3851
|
+
* @public
|
|
3852
3852
|
*/
|
|
3853
3853
|
url: string | undefined;
|
|
3854
3854
|
/**
|
|
3855
|
-
* @public
|
|
3856
3855
|
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
3856
|
+
* @public
|
|
3857
3857
|
*/
|
|
3858
3858
|
urlExpiry: Date | undefined;
|
|
3859
3859
|
/**
|
|
3860
|
-
* @public
|
|
3861
3860
|
* <p>The headers to include in the upload.</p>
|
|
3861
|
+
* @public
|
|
3862
3862
|
*/
|
|
3863
3863
|
headersToInclude: Record<string, string> | undefined;
|
|
3864
3864
|
}
|
|
@@ -3867,7 +3867,6 @@ export interface StartContentUploadResponse {
|
|
|
3867
3867
|
*/
|
|
3868
3868
|
export interface StartImportJobRequest {
|
|
3869
3869
|
/**
|
|
3870
|
-
* @public
|
|
3871
3870
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3872
3871
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3873
3872
|
* <ul>
|
|
@@ -3875,36 +3874,37 @@ export interface StartImportJobRequest {
|
|
|
3875
3874
|
* <p>For importing Amazon Q quick responses, this should be a <code>QUICK_RESPONSES</code> type knowledge base.</p>
|
|
3876
3875
|
* </li>
|
|
3877
3876
|
* </ul>
|
|
3877
|
+
* @public
|
|
3878
3878
|
*/
|
|
3879
3879
|
knowledgeBaseId: string | undefined;
|
|
3880
3880
|
/**
|
|
3881
|
-
* @public
|
|
3882
3881
|
* <p>The type of the import job.</p>
|
|
3883
3882
|
* <ul>
|
|
3884
3883
|
* <li>
|
|
3885
3884
|
* <p>For importing quick response resource, set the value to <code>QUICK_RESPONSES</code>.</p>
|
|
3886
3885
|
* </li>
|
|
3887
3886
|
* </ul>
|
|
3887
|
+
* @public
|
|
3888
3888
|
*/
|
|
3889
3889
|
importJobType: ImportJobType | undefined;
|
|
3890
3890
|
/**
|
|
3891
|
-
* @public
|
|
3892
3891
|
* <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>
|
|
3892
|
+
* @public
|
|
3893
3893
|
*/
|
|
3894
3894
|
uploadId: string | undefined;
|
|
3895
3895
|
/**
|
|
3896
|
-
* @public
|
|
3897
3896
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3897
|
+
* @public
|
|
3898
3898
|
*/
|
|
3899
3899
|
clientToken?: string;
|
|
3900
3900
|
/**
|
|
3901
|
-
* @public
|
|
3902
3901
|
* <p>The metadata fields of the imported Amazon Q resources.</p>
|
|
3902
|
+
* @public
|
|
3903
3903
|
*/
|
|
3904
3904
|
metadata?: Record<string, string>;
|
|
3905
3905
|
/**
|
|
3906
|
-
* @public
|
|
3907
3906
|
* <p>The configuration information of the external source that the resource data are imported from.</p>
|
|
3907
|
+
* @public
|
|
3908
3908
|
*/
|
|
3909
3909
|
externalSourceConfiguration?: ExternalSourceConfiguration;
|
|
3910
3910
|
}
|
|
@@ -3913,8 +3913,8 @@ export interface StartImportJobRequest {
|
|
|
3913
3913
|
*/
|
|
3914
3914
|
export interface StartImportJobResponse {
|
|
3915
3915
|
/**
|
|
3916
|
-
* @public
|
|
3917
3916
|
* <p>The import job.</p>
|
|
3917
|
+
* @public
|
|
3918
3918
|
*/
|
|
3919
3919
|
importJob?: ImportJobData;
|
|
3920
3920
|
}
|
|
@@ -3923,14 +3923,14 @@ export interface StartImportJobResponse {
|
|
|
3923
3923
|
*/
|
|
3924
3924
|
export interface UpdateKnowledgeBaseTemplateUriRequest {
|
|
3925
3925
|
/**
|
|
3926
|
-
* @public
|
|
3927
3926
|
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
|
|
3928
3927
|
* base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3928
|
+
* @public
|
|
3929
3929
|
*/
|
|
3930
3930
|
knowledgeBaseId: string | undefined;
|
|
3931
3931
|
/**
|
|
3932
|
-
* @public
|
|
3933
3932
|
* <p>The template URI to update.</p>
|
|
3933
|
+
* @public
|
|
3934
3934
|
*/
|
|
3935
3935
|
templateUri: string | undefined;
|
|
3936
3936
|
}
|
|
@@ -3939,8 +3939,8 @@ export interface UpdateKnowledgeBaseTemplateUriRequest {
|
|
|
3939
3939
|
*/
|
|
3940
3940
|
export interface UpdateKnowledgeBaseTemplateUriResponse {
|
|
3941
3941
|
/**
|
|
3942
|
-
* @public
|
|
3943
3942
|
* <p>The knowledge base to update.</p>
|
|
3943
|
+
* @public
|
|
3944
3944
|
*/
|
|
3945
3945
|
knowledgeBase?: KnowledgeBaseData;
|
|
3946
3946
|
}
|
|
@@ -3949,8 +3949,8 @@ export interface UpdateKnowledgeBaseTemplateUriResponse {
|
|
|
3949
3949
|
*/
|
|
3950
3950
|
export interface ListTagsForResourceRequest {
|
|
3951
3951
|
/**
|
|
3952
|
-
* @public
|
|
3953
3952
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
3953
|
+
* @public
|
|
3954
3954
|
*/
|
|
3955
3955
|
resourceArn: string | undefined;
|
|
3956
3956
|
}
|
|
@@ -3959,8 +3959,8 @@ export interface ListTagsForResourceRequest {
|
|
|
3959
3959
|
*/
|
|
3960
3960
|
export interface ListTagsForResourceResponse {
|
|
3961
3961
|
/**
|
|
3962
|
-
* @public
|
|
3963
3962
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3963
|
+
* @public
|
|
3964
3964
|
*/
|
|
3965
3965
|
tags?: Record<string, string>;
|
|
3966
3966
|
}
|
|
@@ -3969,13 +3969,13 @@ export interface ListTagsForResourceResponse {
|
|
|
3969
3969
|
*/
|
|
3970
3970
|
export interface TagResourceRequest {
|
|
3971
3971
|
/**
|
|
3972
|
-
* @public
|
|
3973
3972
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
3973
|
+
* @public
|
|
3974
3974
|
*/
|
|
3975
3975
|
resourceArn: string | undefined;
|
|
3976
3976
|
/**
|
|
3977
|
-
* @public
|
|
3978
3977
|
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3978
|
+
* @public
|
|
3979
3979
|
*/
|
|
3980
3980
|
tags: Record<string, string> | undefined;
|
|
3981
3981
|
}
|
|
@@ -3985,15 +3985,15 @@ export interface TagResourceRequest {
|
|
|
3985
3985
|
export interface TagResourceResponse {
|
|
3986
3986
|
}
|
|
3987
3987
|
/**
|
|
3988
|
-
* @public
|
|
3989
3988
|
* <p>Amazon Q in Connect throws this exception if you have too many tags in your tag set.</p>
|
|
3989
|
+
* @public
|
|
3990
3990
|
*/
|
|
3991
3991
|
export declare class TooManyTagsException extends __BaseException {
|
|
3992
3992
|
readonly name: "TooManyTagsException";
|
|
3993
3993
|
readonly $fault: "client";
|
|
3994
3994
|
/**
|
|
3995
|
-
* @public
|
|
3996
3995
|
* <p>The specified resource name.</p>
|
|
3996
|
+
* @public
|
|
3997
3997
|
*/
|
|
3998
3998
|
resourceName?: string;
|
|
3999
3999
|
/**
|
|
@@ -4006,13 +4006,13 @@ export declare class TooManyTagsException extends __BaseException {
|
|
|
4006
4006
|
*/
|
|
4007
4007
|
export interface UntagResourceRequest {
|
|
4008
4008
|
/**
|
|
4009
|
-
* @public
|
|
4010
4009
|
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
4010
|
+
* @public
|
|
4011
4011
|
*/
|
|
4012
4012
|
resourceArn: string | undefined;
|
|
4013
4013
|
/**
|
|
4014
|
-
* @public
|
|
4015
4014
|
* <p>The tag keys.</p>
|
|
4015
|
+
* @public
|
|
4016
4016
|
*/
|
|
4017
4017
|
tagKeys: string[] | undefined;
|
|
4018
4018
|
}
|
|
@@ -4022,8 +4022,8 @@ export interface UntagResourceRequest {
|
|
|
4022
4022
|
export interface UntagResourceResponse {
|
|
4023
4023
|
}
|
|
4024
4024
|
/**
|
|
4025
|
-
* @public
|
|
4026
4025
|
* <p>Details about the data.</p>
|
|
4026
|
+
* @public
|
|
4027
4027
|
*/
|
|
4028
4028
|
export type DataDetails = DataDetails.ContentDataMember | DataDetails.GenerativeDataMember | DataDetails.SourceContentDataMember | DataDetails.$UnknownMember;
|
|
4029
4029
|
/**
|
|
@@ -4031,8 +4031,8 @@ export type DataDetails = DataDetails.ContentDataMember | DataDetails.Generative
|
|
|
4031
4031
|
*/
|
|
4032
4032
|
export declare namespace DataDetails {
|
|
4033
4033
|
/**
|
|
4034
|
-
* @public
|
|
4035
4034
|
* <p>Details about the content data.</p>
|
|
4035
|
+
* @public
|
|
4036
4036
|
*/
|
|
4037
4037
|
interface ContentDataMember {
|
|
4038
4038
|
contentData: ContentDataDetails;
|
|
@@ -4041,8 +4041,8 @@ export declare namespace DataDetails {
|
|
|
4041
4041
|
$unknown?: never;
|
|
4042
4042
|
}
|
|
4043
4043
|
/**
|
|
4044
|
-
* @public
|
|
4045
4044
|
* <p> Details about the generative data.</p>
|
|
4045
|
+
* @public
|
|
4046
4046
|
*/
|
|
4047
4047
|
interface GenerativeDataMember {
|
|
4048
4048
|
contentData?: never;
|
|
@@ -4051,8 +4051,8 @@ export declare namespace DataDetails {
|
|
|
4051
4051
|
$unknown?: never;
|
|
4052
4052
|
}
|
|
4053
4053
|
/**
|
|
4054
|
-
* @public
|
|
4055
4054
|
* <p>Details about the content data.</p>
|
|
4055
|
+
* @public
|
|
4056
4056
|
*/
|
|
4057
4057
|
interface SourceContentDataMember {
|
|
4058
4058
|
contentData?: never;
|
|
@@ -4078,106 +4078,106 @@ export declare namespace DataDetails {
|
|
|
4078
4078
|
const visit: <T>(value: DataDetails, visitor: Visitor<T>) => T;
|
|
4079
4079
|
}
|
|
4080
4080
|
/**
|
|
4081
|
-
* @public
|
|
4082
4081
|
* <p>Summary of the data.</p>
|
|
4082
|
+
* @public
|
|
4083
4083
|
*/
|
|
4084
4084
|
export interface DataSummary {
|
|
4085
4085
|
/**
|
|
4086
|
-
* @public
|
|
4087
4086
|
* <p>Reference information about the content.</p>
|
|
4087
|
+
* @public
|
|
4088
4088
|
*/
|
|
4089
4089
|
reference: DataReference | undefined;
|
|
4090
4090
|
/**
|
|
4091
|
-
* @public
|
|
4092
4091
|
* <p>Details about the data.</p>
|
|
4092
|
+
* @public
|
|
4093
4093
|
*/
|
|
4094
4094
|
details: DataDetails | undefined;
|
|
4095
4095
|
}
|
|
4096
4096
|
/**
|
|
4097
|
-
* @public
|
|
4098
4097
|
* <p>Details about generative data.</p>
|
|
4098
|
+
* @public
|
|
4099
4099
|
*/
|
|
4100
4100
|
export interface GenerativeDataDetails {
|
|
4101
4101
|
/**
|
|
4102
|
-
* @public
|
|
4103
4102
|
* <p>The LLM response.</p>
|
|
4103
|
+
* @public
|
|
4104
4104
|
*/
|
|
4105
4105
|
completion: string | undefined;
|
|
4106
4106
|
/**
|
|
4107
|
-
* @public
|
|
4108
4107
|
* <p>The references used to generative the LLM response.</p>
|
|
4108
|
+
* @public
|
|
4109
4109
|
*/
|
|
4110
4110
|
references: DataSummary[] | undefined;
|
|
4111
4111
|
/**
|
|
4112
|
-
* @public
|
|
4113
4112
|
* <p>Details about the generative content ranking data.</p>
|
|
4113
|
+
* @public
|
|
4114
4114
|
*/
|
|
4115
4115
|
rankingData: RankingData | undefined;
|
|
4116
4116
|
}
|
|
4117
4117
|
/**
|
|
4118
|
-
* @public
|
|
4119
4118
|
* <p>Information about the recommendation.</p>
|
|
4119
|
+
* @public
|
|
4120
4120
|
*/
|
|
4121
4121
|
export interface RecommendationData {
|
|
4122
4122
|
/**
|
|
4123
|
-
* @public
|
|
4124
4123
|
* <p>The identifier of the recommendation.</p>
|
|
4124
|
+
* @public
|
|
4125
4125
|
*/
|
|
4126
4126
|
recommendationId: string | undefined;
|
|
4127
4127
|
/**
|
|
4128
|
-
* @public
|
|
4129
4128
|
* <p>The recommended document.</p>
|
|
4129
|
+
* @public
|
|
4130
4130
|
*/
|
|
4131
4131
|
document?: Document;
|
|
4132
4132
|
/**
|
|
4133
|
-
* @public
|
|
4134
4133
|
* <p>The relevance score of the recommendation.</p>
|
|
4134
|
+
* @public
|
|
4135
4135
|
*/
|
|
4136
4136
|
relevanceScore?: number;
|
|
4137
4137
|
/**
|
|
4138
|
-
* @public
|
|
4139
4138
|
* <p>The relevance level of the recommendation.</p>
|
|
4139
|
+
* @public
|
|
4140
4140
|
*/
|
|
4141
4141
|
relevanceLevel?: RelevanceLevel;
|
|
4142
4142
|
/**
|
|
4143
|
-
* @public
|
|
4144
4143
|
* <p>The type of recommendation.</p>
|
|
4144
|
+
* @public
|
|
4145
4145
|
*/
|
|
4146
4146
|
type?: RecommendationType;
|
|
4147
4147
|
/**
|
|
4148
|
-
* @public
|
|
4149
4148
|
* <p> Summary of the recommended content.</p>
|
|
4149
|
+
* @public
|
|
4150
4150
|
*/
|
|
4151
4151
|
data?: DataSummary;
|
|
4152
4152
|
}
|
|
4153
4153
|
/**
|
|
4154
|
-
* @public
|
|
4155
4154
|
* <p>Information about the result.</p>
|
|
4155
|
+
* @public
|
|
4156
4156
|
*/
|
|
4157
4157
|
export interface ResultData {
|
|
4158
4158
|
/**
|
|
4159
|
-
* @public
|
|
4160
4159
|
* <p>The identifier of the result data.</p>
|
|
4160
|
+
* @public
|
|
4161
4161
|
*/
|
|
4162
4162
|
resultId: string | undefined;
|
|
4163
4163
|
/**
|
|
4164
|
-
* @public
|
|
4165
4164
|
* <p>The document.</p>
|
|
4165
|
+
* @public
|
|
4166
4166
|
*/
|
|
4167
4167
|
document?: Document;
|
|
4168
4168
|
/**
|
|
4169
|
-
* @public
|
|
4170
4169
|
* <p>The relevance score of the results.</p>
|
|
4170
|
+
* @public
|
|
4171
4171
|
*/
|
|
4172
4172
|
relevanceScore?: number;
|
|
4173
4173
|
/**
|
|
4174
|
-
* @public
|
|
4175
4174
|
* <p> Summary of the recommended content.</p>
|
|
4175
|
+
* @public
|
|
4176
4176
|
*/
|
|
4177
4177
|
data?: DataSummary;
|
|
4178
4178
|
/**
|
|
4179
|
-
* @public
|
|
4180
4179
|
* <p>The type of the query result.</p>
|
|
4180
|
+
* @public
|
|
4181
4181
|
*/
|
|
4182
4182
|
type?: QueryResultType;
|
|
4183
4183
|
}
|
|
@@ -4186,13 +4186,13 @@ export interface ResultData {
|
|
|
4186
4186
|
*/
|
|
4187
4187
|
export interface GetRecommendationsResponse {
|
|
4188
4188
|
/**
|
|
4189
|
-
* @public
|
|
4190
4189
|
* <p>The recommendations.</p>
|
|
4190
|
+
* @public
|
|
4191
4191
|
*/
|
|
4192
4192
|
recommendations: RecommendationData[] | undefined;
|
|
4193
4193
|
/**
|
|
4194
|
-
* @public
|
|
4195
4194
|
* <p>The triggers corresponding to recommendations.</p>
|
|
4195
|
+
* @public
|
|
4196
4196
|
*/
|
|
4197
4197
|
triggers?: RecommendationTrigger[];
|
|
4198
4198
|
}
|
|
@@ -4201,13 +4201,13 @@ export interface GetRecommendationsResponse {
|
|
|
4201
4201
|
*/
|
|
4202
4202
|
export interface QueryAssistantResponse {
|
|
4203
4203
|
/**
|
|
4204
|
-
* @public
|
|
4205
4204
|
* <p>The results of the query.</p>
|
|
4205
|
+
* @public
|
|
4206
4206
|
*/
|
|
4207
4207
|
results: ResultData[] | undefined;
|
|
4208
4208
|
/**
|
|
4209
|
-
* @public
|
|
4210
4209
|
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
4210
|
+
* @public
|
|
4211
4211
|
*/
|
|
4212
4212
|
nextToken?: string;
|
|
4213
4213
|
}
|