@aws-sdk/client-qconnect 3.940.0 → 3.943.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -0
- package/dist-cjs/index.js +879 -101
- package/dist-es/QConnect.js +4 -0
- package/dist-es/commands/ListSpansCommand.js +16 -0
- package/dist-es/commands/RetrieveCommand.js +16 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/enums.js +61 -12
- package/dist-es/models/errors.js +12 -0
- package/dist-es/pagination/ListSpansPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +774 -90
- package/dist-types/QConnect.d.ts +14 -0
- package/dist-types/QConnectClient.d.ts +4 -2
- package/dist-types/commands/CreateAIAgentCommand.d.ts +126 -0
- package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +63 -0
- package/dist-types/commands/CreateAIPromptCommand.d.ts +16 -0
- package/dist-types/commands/CreateAIPromptVersionCommand.d.ts +8 -0
- package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +8 -0
- package/dist-types/commands/CreateAssistantCommand.d.ts +6 -0
- package/dist-types/commands/CreateSessionCommand.d.ts +14 -1
- package/dist-types/commands/DeleteImportJobCommand.d.ts +1 -1
- package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/DeleteQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/GetAIAgentCommand.d.ts +63 -0
- package/dist-types/commands/GetAIPromptCommand.d.ts +8 -0
- package/dist-types/commands/GetAssistantAssociationCommand.d.ts +4 -0
- package/dist-types/commands/GetAssistantCommand.d.ts +6 -0
- package/dist-types/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/commands/GetMessageTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetNextMessageCommand.d.ts +26 -0
- package/dist-types/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/commands/GetRecommendationsCommand.d.ts +39 -0
- package/dist-types/commands/GetSessionCommand.d.ts +6 -0
- package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +63 -0
- package/dist-types/commands/ListAIAgentsCommand.d.ts +63 -0
- package/dist-types/commands/ListAssistantAssociationsCommand.d.ts +4 -0
- package/dist-types/commands/ListAssistantsCommand.d.ts +6 -0
- package/dist-types/commands/ListImportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/commands/ListMessageTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListMessageTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListMessagesCommand.d.ts +23 -0
- package/dist-types/commands/ListSpansCommand.d.ts +207 -0
- package/dist-types/commands/QueryAssistantCommand.d.ts +41 -0
- package/dist-types/commands/RemoveAssistantAIAgentCommand.d.ts +1 -0
- package/dist-types/commands/RenderMessageTemplateCommand.d.ts +1 -2
- package/dist-types/commands/RetrieveCommand.d.ts +168 -0
- package/dist-types/commands/SendMessageCommand.d.ts +37 -1
- package/dist-types/commands/UpdateAIAgentCommand.d.ts +126 -0
- package/dist-types/commands/UpdateAIPromptCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAssistantAIAgentCommand.d.ts +12 -0
- package/dist-types/commands/UpdateSessionCommand.d.ts +13 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/enums.d.ts +110 -21
- package/dist-types/models/errors.d.ts +13 -1
- package/dist-types/models/models_0.d.ts +996 -723
- package/dist-types/models/models_1.d.ts +1563 -48
- package/dist-types/pagination/ListSpansPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +64 -0
- package/dist-types/ts3.4/QConnect.d.ts +34 -0
- package/dist-types/ts3.4/QConnectClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/DeleteImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMessageTemplateAttachmentCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeleteQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetKnowledgeBaseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMessageTemplateCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListImportJobsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessageTemplateVersionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessageTemplatesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSpansCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/RenderMessageTemplateCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/RetrieveCommand.d.ts +48 -0
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/enums.d.ts +71 -15
- package/dist-types/ts3.4/models/errors.d.ts +7 -0
- package/dist-types/ts3.4/models/models_0.d.ts +354 -172
- package/dist-types/ts3.4/models/models_1.d.ts +663 -2
- package/dist-types/ts3.4/pagination/ListSpansPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +64 -0
- package/package.json +5 -5
|
@@ -1,5 +1,691 @@
|
|
|
1
|
-
import { ChannelSubtype, ImportJobType, MessageTemplateFilterOperator, MessageTemplateQueryOperator, Order, Priority, QueryResultType, QuickResponseFilterOperator, QuickResponseQueryOperator, QuickResponseStatus, RecommendationType, RelevanceLevel } from "./enums";
|
|
2
|
-
import { ContentDataDetails, ContentSummary, DataReference, Document, EmailOverviewChunkDataDetails, EmailResponseChunkDataDetails,
|
|
1
|
+
import { AIAgentType, AIPromptType, ChannelSubtype, ExternalSource, ImportJobStatus, ImportJobType, KnowledgeBaseSearchType, KnowledgeBaseStatus, KnowledgeBaseType, MessageTemplateFilterOperator, MessageTemplateQueryOperator, Order, Participant, Priority, QueryResultType, QuickResponseFilterOperator, QuickResponseQueryOperator, QuickResponseStatus, RecommendationType, RelevanceLevel, SpanStatus, SpanType } from "./enums";
|
|
2
|
+
import { CaseSummarizationChunkDataDetails, Configuration, ContentDataDetails, ContentSummary, DataReference, Document, EmailOverviewChunkDataDetails, EmailResponseChunkDataDetails, ExtendedMessageTemplateData, FilterAttribute, GroupingConfiguration, IntentDetectedDataDetails, KnowledgeBaseData, KnowledgeSource, MessageTemplateAttachment, MessageTemplateAttributes, MessageTemplateContentProvider, MessageTemplateData, MessageTemplateSourceConfiguration, MessageTemplateSourceConfigurationSummary, NotesChunkDataDetails, NotesDataDetails, QuickResponseContents, QuickResponseData, QuickResponseDataProvider, RankingData, RecommendationTrigger, RenderingConfiguration, SearchExpression, ServerSideEncryptionConfiguration, SourceConfiguration, SourceContentDataDetails, SpanTextValue, SpanToolUseValue, SuggestedMessageDataDetails, VectorIngestionConfiguration } from "./models_0";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
*/
|
|
6
|
+
export interface DeleteImportJobRequest {
|
|
7
|
+
/**
|
|
8
|
+
* <p>The identifier of the knowledge base.</p>
|
|
9
|
+
* @public
|
|
10
|
+
*/
|
|
11
|
+
knowledgeBaseId: string | undefined;
|
|
12
|
+
/**
|
|
13
|
+
* <p>The identifier of the import job to be deleted.</p>
|
|
14
|
+
* @public
|
|
15
|
+
*/
|
|
16
|
+
importJobId: string | undefined;
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* @public
|
|
20
|
+
*/
|
|
21
|
+
export interface DeleteImportJobResponse {
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* @public
|
|
25
|
+
*/
|
|
26
|
+
export interface DeleteKnowledgeBaseRequest {
|
|
27
|
+
/**
|
|
28
|
+
* <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
29
|
+
* @public
|
|
30
|
+
*/
|
|
31
|
+
knowledgeBaseId: string | undefined;
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* @public
|
|
35
|
+
*/
|
|
36
|
+
export interface DeleteKnowledgeBaseResponse {
|
|
37
|
+
}
|
|
38
|
+
/**
|
|
39
|
+
* @public
|
|
40
|
+
*/
|
|
41
|
+
export interface DeleteMessageTemplateRequest {
|
|
42
|
+
/**
|
|
43
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
44
|
+
* @public
|
|
45
|
+
*/
|
|
46
|
+
knowledgeBaseId: string | undefined;
|
|
47
|
+
/**
|
|
48
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
messageTemplateId: string | undefined;
|
|
52
|
+
}
|
|
53
|
+
/**
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
export interface DeleteMessageTemplateResponse {
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
export interface DeleteMessageTemplateAttachmentRequest {
|
|
62
|
+
/**
|
|
63
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
knowledgeBaseId: string | undefined;
|
|
67
|
+
/**
|
|
68
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
messageTemplateId: string | undefined;
|
|
72
|
+
/**
|
|
73
|
+
* <p>The identifier of the attachment file.</p>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
attachmentId: string | undefined;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export interface DeleteMessageTemplateAttachmentResponse {
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export interface DeleteQuickResponseRequest {
|
|
87
|
+
/**
|
|
88
|
+
* <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base.</p>
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
knowledgeBaseId: string | undefined;
|
|
92
|
+
/**
|
|
93
|
+
* <p>The identifier of the quick response to delete.</p>
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
quickResponseId: string | undefined;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export interface DeleteQuickResponseResponse {
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* <p>The configuration information of the external data source.</p>
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export interface ExternalSourceConfiguration {
|
|
108
|
+
/**
|
|
109
|
+
* <p>The type of the external data source.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
source: ExternalSource | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* <p>The configuration information of the external data source.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
configuration: Configuration | undefined;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
export interface GetImportJobRequest {
|
|
123
|
+
/**
|
|
124
|
+
* <p>The identifier of the import job to retrieve.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
importJobId: string | undefined;
|
|
128
|
+
/**
|
|
129
|
+
* <p>The identifier of the knowledge base that the import job belongs to.</p>
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
knowledgeBaseId: string | undefined;
|
|
133
|
+
}
|
|
134
|
+
/**
|
|
135
|
+
* <p>Summary information about the import job.</p>
|
|
136
|
+
* @public
|
|
137
|
+
*/
|
|
138
|
+
export interface ImportJobData {
|
|
139
|
+
/**
|
|
140
|
+
* <p>The identifier of the import job.</p>
|
|
141
|
+
* @public
|
|
142
|
+
*/
|
|
143
|
+
importJobId: string | undefined;
|
|
144
|
+
/**
|
|
145
|
+
* <p>The identifier of the knowledge base.</p>
|
|
146
|
+
* @public
|
|
147
|
+
*/
|
|
148
|
+
knowledgeBaseId: string | undefined;
|
|
149
|
+
/**
|
|
150
|
+
* <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>
|
|
151
|
+
* @public
|
|
152
|
+
*/
|
|
153
|
+
uploadId: string | undefined;
|
|
154
|
+
/**
|
|
155
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
156
|
+
* @public
|
|
157
|
+
*/
|
|
158
|
+
knowledgeBaseArn: string | undefined;
|
|
159
|
+
/**
|
|
160
|
+
* <p>The type of the import job.</p>
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
importJobType: ImportJobType | undefined;
|
|
164
|
+
/**
|
|
165
|
+
* <p>The status of the import job.</p>
|
|
166
|
+
* @public
|
|
167
|
+
*/
|
|
168
|
+
status: ImportJobStatus | undefined;
|
|
169
|
+
/**
|
|
170
|
+
* <p>The download link to the resource file that is uploaded to the import job.</p>
|
|
171
|
+
* @public
|
|
172
|
+
*/
|
|
173
|
+
url: string | undefined;
|
|
174
|
+
/**
|
|
175
|
+
* <p>The link to download the information of resource data that failed to be imported.</p>
|
|
176
|
+
* @public
|
|
177
|
+
*/
|
|
178
|
+
failedRecordReport?: string | undefined;
|
|
179
|
+
/**
|
|
180
|
+
* <p>The expiration time of the URL as an epoch timestamp.</p>
|
|
181
|
+
* @public
|
|
182
|
+
*/
|
|
183
|
+
urlExpiry: Date | undefined;
|
|
184
|
+
/**
|
|
185
|
+
* <p>The timestamp when the import job was created.</p>
|
|
186
|
+
* @public
|
|
187
|
+
*/
|
|
188
|
+
createdTime: Date | undefined;
|
|
189
|
+
/**
|
|
190
|
+
* <p>The timestamp when the import job data was last modified.</p>
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
193
|
+
lastModifiedTime: Date | undefined;
|
|
194
|
+
/**
|
|
195
|
+
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
196
|
+
* @public
|
|
197
|
+
*/
|
|
198
|
+
metadata?: Record<string, string> | undefined;
|
|
199
|
+
/**
|
|
200
|
+
* <p>The configuration information of the external data source.</p>
|
|
201
|
+
* @public
|
|
202
|
+
*/
|
|
203
|
+
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
204
|
+
}
|
|
205
|
+
/**
|
|
206
|
+
* @public
|
|
207
|
+
*/
|
|
208
|
+
export interface GetImportJobResponse {
|
|
209
|
+
/**
|
|
210
|
+
* <p>The import job.</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
importJob?: ImportJobData | undefined;
|
|
214
|
+
}
|
|
215
|
+
/**
|
|
216
|
+
* @public
|
|
217
|
+
*/
|
|
218
|
+
export interface GetKnowledgeBaseRequest {
|
|
219
|
+
/**
|
|
220
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
221
|
+
* @public
|
|
222
|
+
*/
|
|
223
|
+
knowledgeBaseId: string | undefined;
|
|
224
|
+
}
|
|
225
|
+
/**
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
export interface GetKnowledgeBaseResponse {
|
|
229
|
+
/**
|
|
230
|
+
* <p>The knowledge base.</p>
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
knowledgeBase?: KnowledgeBaseData | undefined;
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
export interface GetMessageTemplateRequest {
|
|
239
|
+
/**
|
|
240
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
241
|
+
* @public
|
|
242
|
+
*/
|
|
243
|
+
messageTemplateId: string | undefined;
|
|
244
|
+
/**
|
|
245
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
246
|
+
* @public
|
|
247
|
+
*/
|
|
248
|
+
knowledgeBaseId: string | undefined;
|
|
249
|
+
}
|
|
250
|
+
/**
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
export interface GetMessageTemplateResponse {
|
|
254
|
+
/**
|
|
255
|
+
* <p>The message template.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
messageTemplate?: ExtendedMessageTemplateData | undefined;
|
|
259
|
+
}
|
|
260
|
+
/**
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
export interface GetQuickResponseRequest {
|
|
264
|
+
/**
|
|
265
|
+
* <p>The identifier of the quick response.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
quickResponseId: string | undefined;
|
|
269
|
+
/**
|
|
270
|
+
* <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</p>
|
|
271
|
+
* @public
|
|
272
|
+
*/
|
|
273
|
+
knowledgeBaseId: string | undefined;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* @public
|
|
277
|
+
*/
|
|
278
|
+
export interface GetQuickResponseResponse {
|
|
279
|
+
/**
|
|
280
|
+
* <p>The quick response.</p>
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
quickResponse?: QuickResponseData | undefined;
|
|
284
|
+
}
|
|
285
|
+
/**
|
|
286
|
+
* <p>Summary information about the import job.</p>
|
|
287
|
+
* @public
|
|
288
|
+
*/
|
|
289
|
+
export interface ImportJobSummary {
|
|
290
|
+
/**
|
|
291
|
+
* <p>The identifier of the import job.</p>
|
|
292
|
+
* @public
|
|
293
|
+
*/
|
|
294
|
+
importJobId: string | undefined;
|
|
295
|
+
/**
|
|
296
|
+
* <p>The identifier of the knowledge base.</p>
|
|
297
|
+
* @public
|
|
298
|
+
*/
|
|
299
|
+
knowledgeBaseId: string | undefined;
|
|
300
|
+
/**
|
|
301
|
+
* <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>
|
|
302
|
+
* @public
|
|
303
|
+
*/
|
|
304
|
+
uploadId: string | undefined;
|
|
305
|
+
/**
|
|
306
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
307
|
+
* @public
|
|
308
|
+
*/
|
|
309
|
+
knowledgeBaseArn: string | undefined;
|
|
310
|
+
/**
|
|
311
|
+
* <p>The type of import job.</p>
|
|
312
|
+
* @public
|
|
313
|
+
*/
|
|
314
|
+
importJobType: ImportJobType | undefined;
|
|
315
|
+
/**
|
|
316
|
+
* <p>The status of the import job.</p>
|
|
317
|
+
* @public
|
|
318
|
+
*/
|
|
319
|
+
status: ImportJobStatus | undefined;
|
|
320
|
+
/**
|
|
321
|
+
* <p>The timestamp when the import job was created.</p>
|
|
322
|
+
* @public
|
|
323
|
+
*/
|
|
324
|
+
createdTime: Date | undefined;
|
|
325
|
+
/**
|
|
326
|
+
* <p>The timestamp when the import job was last modified.</p>
|
|
327
|
+
* @public
|
|
328
|
+
*/
|
|
329
|
+
lastModifiedTime: Date | undefined;
|
|
330
|
+
/**
|
|
331
|
+
* <p>The metadata fields of the imported Amazon Q in Connect resources.</p>
|
|
332
|
+
* @public
|
|
333
|
+
*/
|
|
334
|
+
metadata?: Record<string, string> | undefined;
|
|
335
|
+
/**
|
|
336
|
+
* <p>The configuration information of the external source that the resource data are imported from.</p>
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
339
|
+
externalSourceConfiguration?: ExternalSourceConfiguration | undefined;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* @public
|
|
343
|
+
*/
|
|
344
|
+
export interface ListImportJobsRequest {
|
|
345
|
+
/**
|
|
346
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
347
|
+
* @public
|
|
348
|
+
*/
|
|
349
|
+
nextToken?: string | undefined;
|
|
350
|
+
/**
|
|
351
|
+
* <p>The maximum number of results to return per page.</p>
|
|
352
|
+
* @public
|
|
353
|
+
*/
|
|
354
|
+
maxResults?: number | undefined;
|
|
355
|
+
/**
|
|
356
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
knowledgeBaseId: string | undefined;
|
|
360
|
+
}
|
|
361
|
+
/**
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
export interface ListImportJobsResponse {
|
|
365
|
+
/**
|
|
366
|
+
* <p>Summary information about the import jobs.</p>
|
|
367
|
+
* @public
|
|
368
|
+
*/
|
|
369
|
+
importJobSummaries: ImportJobSummary[] | undefined;
|
|
370
|
+
/**
|
|
371
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
372
|
+
* @public
|
|
373
|
+
*/
|
|
374
|
+
nextToken?: string | undefined;
|
|
375
|
+
}
|
|
376
|
+
/**
|
|
377
|
+
* @public
|
|
378
|
+
*/
|
|
379
|
+
export interface ListKnowledgeBasesRequest {
|
|
380
|
+
/**
|
|
381
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
nextToken?: string | undefined;
|
|
385
|
+
/**
|
|
386
|
+
* <p>The maximum number of results to return per page.</p>
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
maxResults?: number | undefined;
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* <p>Summary information about the knowledge base.</p>
|
|
393
|
+
* @public
|
|
394
|
+
*/
|
|
395
|
+
export interface KnowledgeBaseSummary {
|
|
396
|
+
/**
|
|
397
|
+
* <p>The identifier of the knowledge base.</p>
|
|
398
|
+
* @public
|
|
399
|
+
*/
|
|
400
|
+
knowledgeBaseId: string | undefined;
|
|
401
|
+
/**
|
|
402
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
403
|
+
* @public
|
|
404
|
+
*/
|
|
405
|
+
knowledgeBaseArn: string | undefined;
|
|
406
|
+
/**
|
|
407
|
+
* <p>The name of the knowledge base.</p>
|
|
408
|
+
* @public
|
|
409
|
+
*/
|
|
410
|
+
name: string | undefined;
|
|
411
|
+
/**
|
|
412
|
+
* <p>The type of knowledge base.</p>
|
|
413
|
+
* @public
|
|
414
|
+
*/
|
|
415
|
+
knowledgeBaseType: KnowledgeBaseType | undefined;
|
|
416
|
+
/**
|
|
417
|
+
* <p>The status of the knowledge base summary.</p>
|
|
418
|
+
* @public
|
|
419
|
+
*/
|
|
420
|
+
status: KnowledgeBaseStatus | undefined;
|
|
421
|
+
/**
|
|
422
|
+
* <p>Configuration information about the external data source.</p>
|
|
423
|
+
* @public
|
|
424
|
+
*/
|
|
425
|
+
sourceConfiguration?: SourceConfiguration | undefined;
|
|
426
|
+
/**
|
|
427
|
+
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
428
|
+
* @public
|
|
429
|
+
*/
|
|
430
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration | undefined;
|
|
431
|
+
/**
|
|
432
|
+
* <p>Information about how to render the content.</p>
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
renderingConfiguration?: RenderingConfiguration | undefined;
|
|
436
|
+
/**
|
|
437
|
+
* <p>The configuration information for the customer managed key used for encryption. </p> <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>, <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the key to invoke Amazon Q in Connect. </p> <p>For more information about setting up a customer managed key for Amazon Q in Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.</p>
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration | undefined;
|
|
441
|
+
/**
|
|
442
|
+
* <p>The description of the knowledge base.</p>
|
|
443
|
+
* @public
|
|
444
|
+
*/
|
|
445
|
+
description?: string | undefined;
|
|
446
|
+
/**
|
|
447
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
448
|
+
* @public
|
|
449
|
+
*/
|
|
450
|
+
tags?: Record<string, string> | undefined;
|
|
451
|
+
}
|
|
452
|
+
/**
|
|
453
|
+
* @public
|
|
454
|
+
*/
|
|
455
|
+
export interface ListKnowledgeBasesResponse {
|
|
456
|
+
/**
|
|
457
|
+
* <p>Information about the knowledge bases.</p>
|
|
458
|
+
* @public
|
|
459
|
+
*/
|
|
460
|
+
knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
|
|
461
|
+
/**
|
|
462
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
463
|
+
* @public
|
|
464
|
+
*/
|
|
465
|
+
nextToken?: string | undefined;
|
|
466
|
+
}
|
|
467
|
+
/**
|
|
468
|
+
* @public
|
|
469
|
+
*/
|
|
470
|
+
export interface ListMessageTemplatesRequest {
|
|
471
|
+
/**
|
|
472
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
473
|
+
* @public
|
|
474
|
+
*/
|
|
475
|
+
nextToken?: string | undefined;
|
|
476
|
+
/**
|
|
477
|
+
* <p>The maximum number of results to return per page.</p>
|
|
478
|
+
* @public
|
|
479
|
+
*/
|
|
480
|
+
maxResults?: number | undefined;
|
|
481
|
+
/**
|
|
482
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
knowledgeBaseId: string | undefined;
|
|
486
|
+
}
|
|
487
|
+
/**
|
|
488
|
+
* <p>The summary of the message template.</p>
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
export interface MessageTemplateSummary {
|
|
492
|
+
/**
|
|
493
|
+
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
494
|
+
* @public
|
|
495
|
+
*/
|
|
496
|
+
messageTemplateArn: string | undefined;
|
|
497
|
+
/**
|
|
498
|
+
* <p>The identifier of the message template.</p>
|
|
499
|
+
* @public
|
|
500
|
+
*/
|
|
501
|
+
messageTemplateId: string | undefined;
|
|
502
|
+
/**
|
|
503
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
504
|
+
* @public
|
|
505
|
+
*/
|
|
506
|
+
knowledgeBaseArn: string | undefined;
|
|
507
|
+
/**
|
|
508
|
+
* <p>The identifier of the knowledge base.</p>
|
|
509
|
+
* @public
|
|
510
|
+
*/
|
|
511
|
+
knowledgeBaseId: string | undefined;
|
|
512
|
+
/**
|
|
513
|
+
* <p>The name of the message template.</p>
|
|
514
|
+
* @public
|
|
515
|
+
*/
|
|
516
|
+
name: string | undefined;
|
|
517
|
+
/**
|
|
518
|
+
* <p>The channel this message template applies to.</p>
|
|
519
|
+
* @public
|
|
520
|
+
*/
|
|
521
|
+
channel?: string | undefined;
|
|
522
|
+
/**
|
|
523
|
+
* <p>The channel subtype this message template applies to.</p>
|
|
524
|
+
* @public
|
|
525
|
+
*/
|
|
526
|
+
channelSubtype: ChannelSubtype | undefined;
|
|
527
|
+
/**
|
|
528
|
+
* <p>The timestamp when the message template was created.</p>
|
|
529
|
+
* @public
|
|
530
|
+
*/
|
|
531
|
+
createdTime: Date | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* <p>The timestamp when the message template data was last modified.</p>
|
|
534
|
+
* @public
|
|
535
|
+
*/
|
|
536
|
+
lastModifiedTime: Date | undefined;
|
|
537
|
+
/**
|
|
538
|
+
* <p>The Amazon Resource Name (ARN) of the user who last updated the message template data.</p>
|
|
539
|
+
* @public
|
|
540
|
+
*/
|
|
541
|
+
lastModifiedBy: string | undefined;
|
|
542
|
+
/**
|
|
543
|
+
* <p>The container of message template source configuration.</p>
|
|
544
|
+
* @public
|
|
545
|
+
*/
|
|
546
|
+
sourceConfiguration?: MessageTemplateSourceConfiguration | undefined;
|
|
547
|
+
/**
|
|
548
|
+
* <p>The version number of the message template version that is activated.</p>
|
|
549
|
+
* @public
|
|
550
|
+
*/
|
|
551
|
+
activeVersionNumber?: number | undefined;
|
|
552
|
+
/**
|
|
553
|
+
* <p>The description of the message template.</p>
|
|
554
|
+
* @public
|
|
555
|
+
*/
|
|
556
|
+
description?: string | undefined;
|
|
557
|
+
/**
|
|
558
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
tags?: Record<string, string> | undefined;
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
export interface ListMessageTemplatesResponse {
|
|
567
|
+
/**
|
|
568
|
+
* <p>Summary information about the message template.</p>
|
|
569
|
+
* @public
|
|
570
|
+
*/
|
|
571
|
+
messageTemplateSummaries: MessageTemplateSummary[] | undefined;
|
|
572
|
+
/**
|
|
573
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
nextToken?: string | undefined;
|
|
577
|
+
}
|
|
578
|
+
/**
|
|
579
|
+
* @public
|
|
580
|
+
*/
|
|
581
|
+
export interface ListMessageTemplateVersionsRequest {
|
|
582
|
+
/**
|
|
583
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
584
|
+
* @public
|
|
585
|
+
*/
|
|
586
|
+
knowledgeBaseId: string | undefined;
|
|
587
|
+
/**
|
|
588
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN. It cannot contain any qualifier.</p>
|
|
589
|
+
* @public
|
|
590
|
+
*/
|
|
591
|
+
messageTemplateId: string | undefined;
|
|
592
|
+
/**
|
|
593
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.</p>
|
|
594
|
+
* @public
|
|
595
|
+
*/
|
|
596
|
+
nextToken?: string | undefined;
|
|
597
|
+
/**
|
|
598
|
+
* <p>The maximum number of results to return per page.</p>
|
|
599
|
+
* @public
|
|
600
|
+
*/
|
|
601
|
+
maxResults?: number | undefined;
|
|
602
|
+
}
|
|
603
|
+
/**
|
|
604
|
+
* <p>The summary of the message template version.</p>
|
|
605
|
+
* @public
|
|
606
|
+
*/
|
|
607
|
+
export interface MessageTemplateVersionSummary {
|
|
608
|
+
/**
|
|
609
|
+
* <p>The Amazon Resource Name (ARN) of the message template.</p>
|
|
610
|
+
* @public
|
|
611
|
+
*/
|
|
612
|
+
messageTemplateArn: string | undefined;
|
|
613
|
+
/**
|
|
614
|
+
* <p>The identifier of the message template.</p>
|
|
615
|
+
* @public
|
|
616
|
+
*/
|
|
617
|
+
messageTemplateId: string | undefined;
|
|
618
|
+
/**
|
|
619
|
+
* <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
|
|
620
|
+
* @public
|
|
621
|
+
*/
|
|
622
|
+
knowledgeBaseArn: string | undefined;
|
|
623
|
+
/**
|
|
624
|
+
* <p>The identifier of the knowledge base.</p>
|
|
625
|
+
* @public
|
|
626
|
+
*/
|
|
627
|
+
knowledgeBaseId: string | undefined;
|
|
628
|
+
/**
|
|
629
|
+
* <p>The name of the message template.</p>
|
|
630
|
+
* @public
|
|
631
|
+
*/
|
|
632
|
+
name: string | undefined;
|
|
633
|
+
/**
|
|
634
|
+
* <p>The channel of the message template.</p>
|
|
635
|
+
* @public
|
|
636
|
+
*/
|
|
637
|
+
channel?: string | undefined;
|
|
638
|
+
/**
|
|
639
|
+
* <p>The channel subtype this message template applies to.</p>
|
|
640
|
+
* @public
|
|
641
|
+
*/
|
|
642
|
+
channelSubtype: ChannelSubtype | undefined;
|
|
643
|
+
/**
|
|
644
|
+
* <p>Whether the version of the message template is activated.</p>
|
|
645
|
+
* @public
|
|
646
|
+
*/
|
|
647
|
+
isActive: boolean | undefined;
|
|
648
|
+
/**
|
|
649
|
+
* <p>The version number of the message template version.</p>
|
|
650
|
+
* @public
|
|
651
|
+
*/
|
|
652
|
+
versionNumber: number | undefined;
|
|
653
|
+
}
|
|
654
|
+
/**
|
|
655
|
+
* @public
|
|
656
|
+
*/
|
|
657
|
+
export interface ListMessageTemplateVersionsResponse {
|
|
658
|
+
/**
|
|
659
|
+
* <p>Summary information about the versions of a message template.</p>
|
|
660
|
+
* @public
|
|
661
|
+
*/
|
|
662
|
+
messageTemplateVersionSummaries: MessageTemplateVersionSummary[] | undefined;
|
|
663
|
+
/**
|
|
664
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
665
|
+
* @public
|
|
666
|
+
*/
|
|
667
|
+
nextToken?: string | undefined;
|
|
668
|
+
}
|
|
669
|
+
/**
|
|
670
|
+
* @public
|
|
671
|
+
*/
|
|
672
|
+
export interface RenderMessageTemplateRequest {
|
|
673
|
+
/**
|
|
674
|
+
* <p>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
675
|
+
* @public
|
|
676
|
+
*/
|
|
677
|
+
knowledgeBaseId: string | undefined;
|
|
678
|
+
/**
|
|
679
|
+
* <p>The identifier of the message template. Can be either the ID or the ARN.</p>
|
|
680
|
+
* @public
|
|
681
|
+
*/
|
|
682
|
+
messageTemplateId: string | undefined;
|
|
683
|
+
/**
|
|
684
|
+
* <p>An object that specifies the values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the value for that variable.</p>
|
|
685
|
+
* @public
|
|
686
|
+
*/
|
|
687
|
+
attributes: MessageTemplateAttributes | undefined;
|
|
688
|
+
}
|
|
3
689
|
/**
|
|
4
690
|
* @public
|
|
5
691
|
*/
|
|
@@ -926,91 +1612,552 @@ export interface StartImportJobResponse {
|
|
|
926
1612
|
*/
|
|
927
1613
|
export interface UpdateKnowledgeBaseTemplateUriRequest {
|
|
928
1614
|
/**
|
|
929
|
-
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1615
|
+
* <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1616
|
+
* @public
|
|
1617
|
+
*/
|
|
1618
|
+
knowledgeBaseId: string | undefined;
|
|
1619
|
+
/**
|
|
1620
|
+
* <p>The template URI to update.</p>
|
|
1621
|
+
* @public
|
|
1622
|
+
*/
|
|
1623
|
+
templateUri: string | undefined;
|
|
1624
|
+
}
|
|
1625
|
+
/**
|
|
1626
|
+
* @public
|
|
1627
|
+
*/
|
|
1628
|
+
export interface UpdateKnowledgeBaseTemplateUriResponse {
|
|
1629
|
+
/**
|
|
1630
|
+
* <p>The knowledge base to update.</p>
|
|
1631
|
+
* @public
|
|
1632
|
+
*/
|
|
1633
|
+
knowledgeBase?: KnowledgeBaseData | undefined;
|
|
1634
|
+
}
|
|
1635
|
+
/**
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
export interface ListTagsForResourceRequest {
|
|
1639
|
+
/**
|
|
1640
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1641
|
+
* @public
|
|
1642
|
+
*/
|
|
1643
|
+
resourceArn: string | undefined;
|
|
1644
|
+
}
|
|
1645
|
+
/**
|
|
1646
|
+
* @public
|
|
1647
|
+
*/
|
|
1648
|
+
export interface ListTagsForResourceResponse {
|
|
1649
|
+
/**
|
|
1650
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1651
|
+
* @public
|
|
1652
|
+
*/
|
|
1653
|
+
tags?: Record<string, string> | undefined;
|
|
1654
|
+
}
|
|
1655
|
+
/**
|
|
1656
|
+
* @public
|
|
1657
|
+
*/
|
|
1658
|
+
export interface TagResourceRequest {
|
|
1659
|
+
/**
|
|
1660
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1661
|
+
* @public
|
|
1662
|
+
*/
|
|
1663
|
+
resourceArn: string | undefined;
|
|
1664
|
+
/**
|
|
1665
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1666
|
+
* @public
|
|
1667
|
+
*/
|
|
1668
|
+
tags: Record<string, string> | undefined;
|
|
1669
|
+
}
|
|
1670
|
+
/**
|
|
1671
|
+
* @public
|
|
1672
|
+
*/
|
|
1673
|
+
export interface TagResourceResponse {
|
|
1674
|
+
}
|
|
1675
|
+
/**
|
|
1676
|
+
* @public
|
|
1677
|
+
*/
|
|
1678
|
+
export interface UntagResourceRequest {
|
|
1679
|
+
/**
|
|
1680
|
+
* <p>The Amazon Resource Name (ARN) of the resource.</p>
|
|
1681
|
+
* @public
|
|
1682
|
+
*/
|
|
1683
|
+
resourceArn: string | undefined;
|
|
1684
|
+
/**
|
|
1685
|
+
* <p>The tag keys.</p>
|
|
1686
|
+
* @public
|
|
1687
|
+
*/
|
|
1688
|
+
tagKeys: string[] | undefined;
|
|
1689
|
+
}
|
|
1690
|
+
/**
|
|
1691
|
+
* @public
|
|
1692
|
+
*/
|
|
1693
|
+
export interface UntagResourceResponse {
|
|
1694
|
+
}
|
|
1695
|
+
/**
|
|
1696
|
+
* <p>Message content value - can be text, tool invocation, or tool result</p>
|
|
1697
|
+
* @public
|
|
1698
|
+
*/
|
|
1699
|
+
export type SpanMessageValue = SpanMessageValue.TextMember | SpanMessageValue.ToolResultMember | SpanMessageValue.ToolUseMember | SpanMessageValue.$UnknownMember;
|
|
1700
|
+
/**
|
|
1701
|
+
* @public
|
|
1702
|
+
*/
|
|
1703
|
+
export declare namespace SpanMessageValue {
|
|
1704
|
+
/**
|
|
1705
|
+
* <p>Text message content</p>
|
|
1706
|
+
* @public
|
|
1707
|
+
*/
|
|
1708
|
+
interface TextMember {
|
|
1709
|
+
text: SpanTextValue;
|
|
1710
|
+
toolUse?: never;
|
|
1711
|
+
toolResult?: never;
|
|
1712
|
+
$unknown?: never;
|
|
1713
|
+
}
|
|
1714
|
+
/**
|
|
1715
|
+
* <p>Tool invocation message content</p>
|
|
1716
|
+
* @public
|
|
1717
|
+
*/
|
|
1718
|
+
interface ToolUseMember {
|
|
1719
|
+
text?: never;
|
|
1720
|
+
toolUse: SpanToolUseValue;
|
|
1721
|
+
toolResult?: never;
|
|
1722
|
+
$unknown?: never;
|
|
1723
|
+
}
|
|
1724
|
+
/**
|
|
1725
|
+
* <p>Tool result message content</p>
|
|
1726
|
+
* @public
|
|
1727
|
+
*/
|
|
1728
|
+
interface ToolResultMember {
|
|
1729
|
+
text?: never;
|
|
1730
|
+
toolUse?: never;
|
|
1731
|
+
toolResult: SpanToolResultValue;
|
|
1732
|
+
$unknown?: never;
|
|
1733
|
+
}
|
|
1734
|
+
/**
|
|
1735
|
+
* @public
|
|
1736
|
+
*/
|
|
1737
|
+
interface $UnknownMember {
|
|
1738
|
+
text?: never;
|
|
1739
|
+
toolUse?: never;
|
|
1740
|
+
toolResult?: never;
|
|
1741
|
+
$unknown: [string, any];
|
|
1742
|
+
}
|
|
1743
|
+
/**
|
|
1744
|
+
* @deprecated unused in schema-serde mode.
|
|
1745
|
+
*
|
|
1746
|
+
*/
|
|
1747
|
+
interface Visitor<T> {
|
|
1748
|
+
text: (value: SpanTextValue) => T;
|
|
1749
|
+
toolUse: (value: SpanToolUseValue) => T;
|
|
1750
|
+
toolResult: (value: SpanToolResultValue) => T;
|
|
1751
|
+
_: (name: string, value: any) => T;
|
|
1752
|
+
}
|
|
1753
|
+
}
|
|
1754
|
+
/**
|
|
1755
|
+
* <p>Tool result message content</p>
|
|
1756
|
+
* @public
|
|
1757
|
+
*/
|
|
1758
|
+
export interface SpanToolResultValue {
|
|
1759
|
+
/**
|
|
1760
|
+
* <p>Relates this result back to the tool invocation</p>
|
|
1761
|
+
* @public
|
|
1762
|
+
*/
|
|
1763
|
+
toolUseId: string | undefined;
|
|
1764
|
+
/**
|
|
1765
|
+
* <p>The tool results</p>
|
|
1766
|
+
* @public
|
|
1767
|
+
*/
|
|
1768
|
+
values: SpanMessageValue[] | undefined;
|
|
1769
|
+
/**
|
|
1770
|
+
* <p>The tool invocation error if failed</p>
|
|
1771
|
+
* @public
|
|
1772
|
+
*/
|
|
1773
|
+
error?: string | undefined;
|
|
1774
|
+
}
|
|
1775
|
+
/**
|
|
1776
|
+
* <p>Configuration for filtering content during retrieval operations.</p>
|
|
1777
|
+
* @public
|
|
1778
|
+
*/
|
|
1779
|
+
export type RetrievalFilterConfiguration = RetrievalFilterConfiguration.AndAllMember | RetrievalFilterConfiguration.EqualsMember | RetrievalFilterConfiguration.GreaterThanMember | RetrievalFilterConfiguration.GreaterThanOrEqualsMember | RetrievalFilterConfiguration.InMember | RetrievalFilterConfiguration.LessThanMember | RetrievalFilterConfiguration.LessThanOrEqualsMember | RetrievalFilterConfiguration.ListContainsMember | RetrievalFilterConfiguration.NotEqualsMember | RetrievalFilterConfiguration.NotInMember | RetrievalFilterConfiguration.OrAllMember | RetrievalFilterConfiguration.StartsWithMember | RetrievalFilterConfiguration.StringContainsMember | RetrievalFilterConfiguration.$UnknownMember;
|
|
1780
|
+
/**
|
|
1781
|
+
* @public
|
|
1782
|
+
*/
|
|
1783
|
+
export declare namespace RetrievalFilterConfiguration {
|
|
1784
|
+
/**
|
|
1785
|
+
* <p>Filter configuration that requires all conditions to be met.</p>
|
|
1786
|
+
* @public
|
|
1787
|
+
*/
|
|
1788
|
+
interface AndAllMember {
|
|
1789
|
+
andAll: RetrievalFilterConfiguration[];
|
|
1790
|
+
equals?: never;
|
|
1791
|
+
greaterThan?: never;
|
|
1792
|
+
greaterThanOrEquals?: never;
|
|
1793
|
+
in?: never;
|
|
1794
|
+
lessThan?: never;
|
|
1795
|
+
lessThanOrEquals?: never;
|
|
1796
|
+
listContains?: never;
|
|
1797
|
+
notEquals?: never;
|
|
1798
|
+
notIn?: never;
|
|
1799
|
+
orAll?: never;
|
|
1800
|
+
startsWith?: never;
|
|
1801
|
+
stringContains?: never;
|
|
1802
|
+
$unknown?: never;
|
|
1803
|
+
}
|
|
1804
|
+
/**
|
|
1805
|
+
* <p>Filter configuration for exact equality matching.</p>
|
|
1806
|
+
* @public
|
|
1807
|
+
*/
|
|
1808
|
+
interface EqualsMember {
|
|
1809
|
+
andAll?: never;
|
|
1810
|
+
equals: FilterAttribute;
|
|
1811
|
+
greaterThan?: never;
|
|
1812
|
+
greaterThanOrEquals?: never;
|
|
1813
|
+
in?: never;
|
|
1814
|
+
lessThan?: never;
|
|
1815
|
+
lessThanOrEquals?: never;
|
|
1816
|
+
listContains?: never;
|
|
1817
|
+
notEquals?: never;
|
|
1818
|
+
notIn?: never;
|
|
1819
|
+
orAll?: never;
|
|
1820
|
+
startsWith?: never;
|
|
1821
|
+
stringContains?: never;
|
|
1822
|
+
$unknown?: never;
|
|
1823
|
+
}
|
|
1824
|
+
/**
|
|
1825
|
+
* <p>Filter configuration for greater than comparison.</p>
|
|
1826
|
+
* @public
|
|
1827
|
+
*/
|
|
1828
|
+
interface GreaterThanMember {
|
|
1829
|
+
andAll?: never;
|
|
1830
|
+
equals?: never;
|
|
1831
|
+
greaterThan: FilterAttribute;
|
|
1832
|
+
greaterThanOrEquals?: never;
|
|
1833
|
+
in?: never;
|
|
1834
|
+
lessThan?: never;
|
|
1835
|
+
lessThanOrEquals?: never;
|
|
1836
|
+
listContains?: never;
|
|
1837
|
+
notEquals?: never;
|
|
1838
|
+
notIn?: never;
|
|
1839
|
+
orAll?: never;
|
|
1840
|
+
startsWith?: never;
|
|
1841
|
+
stringContains?: never;
|
|
1842
|
+
$unknown?: never;
|
|
1843
|
+
}
|
|
1844
|
+
/**
|
|
1845
|
+
* <p>Filter configuration for greater than or equal comparison.</p>
|
|
1846
|
+
* @public
|
|
1847
|
+
*/
|
|
1848
|
+
interface GreaterThanOrEqualsMember {
|
|
1849
|
+
andAll?: never;
|
|
1850
|
+
equals?: never;
|
|
1851
|
+
greaterThan?: never;
|
|
1852
|
+
greaterThanOrEquals: FilterAttribute;
|
|
1853
|
+
in?: never;
|
|
1854
|
+
lessThan?: never;
|
|
1855
|
+
lessThanOrEquals?: never;
|
|
1856
|
+
listContains?: never;
|
|
1857
|
+
notEquals?: never;
|
|
1858
|
+
notIn?: never;
|
|
1859
|
+
orAll?: never;
|
|
1860
|
+
startsWith?: never;
|
|
1861
|
+
stringContains?: never;
|
|
1862
|
+
$unknown?: never;
|
|
1863
|
+
}
|
|
1864
|
+
/**
|
|
1865
|
+
* <p>Filter configuration for membership in a set of values.</p>
|
|
1866
|
+
* @public
|
|
1867
|
+
*/
|
|
1868
|
+
interface InMember {
|
|
1869
|
+
andAll?: never;
|
|
1870
|
+
equals?: never;
|
|
1871
|
+
greaterThan?: never;
|
|
1872
|
+
greaterThanOrEquals?: never;
|
|
1873
|
+
in: FilterAttribute;
|
|
1874
|
+
lessThan?: never;
|
|
1875
|
+
lessThanOrEquals?: never;
|
|
1876
|
+
listContains?: never;
|
|
1877
|
+
notEquals?: never;
|
|
1878
|
+
notIn?: never;
|
|
1879
|
+
orAll?: never;
|
|
1880
|
+
startsWith?: never;
|
|
1881
|
+
stringContains?: never;
|
|
1882
|
+
$unknown?: never;
|
|
1883
|
+
}
|
|
1884
|
+
/**
|
|
1885
|
+
* <p>Filter configuration for less than comparison.</p>
|
|
1886
|
+
* @public
|
|
1887
|
+
*/
|
|
1888
|
+
interface LessThanMember {
|
|
1889
|
+
andAll?: never;
|
|
1890
|
+
equals?: never;
|
|
1891
|
+
greaterThan?: never;
|
|
1892
|
+
greaterThanOrEquals?: never;
|
|
1893
|
+
in?: never;
|
|
1894
|
+
lessThan: FilterAttribute;
|
|
1895
|
+
lessThanOrEquals?: never;
|
|
1896
|
+
listContains?: never;
|
|
1897
|
+
notEquals?: never;
|
|
1898
|
+
notIn?: never;
|
|
1899
|
+
orAll?: never;
|
|
1900
|
+
startsWith?: never;
|
|
1901
|
+
stringContains?: never;
|
|
1902
|
+
$unknown?: never;
|
|
1903
|
+
}
|
|
1904
|
+
/**
|
|
1905
|
+
* <p>Filter configuration for less than or equal comparison.</p>
|
|
1906
|
+
* @public
|
|
1907
|
+
*/
|
|
1908
|
+
interface LessThanOrEqualsMember {
|
|
1909
|
+
andAll?: never;
|
|
1910
|
+
equals?: never;
|
|
1911
|
+
greaterThan?: never;
|
|
1912
|
+
greaterThanOrEquals?: never;
|
|
1913
|
+
in?: never;
|
|
1914
|
+
lessThan?: never;
|
|
1915
|
+
lessThanOrEquals: FilterAttribute;
|
|
1916
|
+
listContains?: never;
|
|
1917
|
+
notEquals?: never;
|
|
1918
|
+
notIn?: never;
|
|
1919
|
+
orAll?: never;
|
|
1920
|
+
startsWith?: never;
|
|
1921
|
+
stringContains?: never;
|
|
1922
|
+
$unknown?: never;
|
|
1923
|
+
}
|
|
1924
|
+
/**
|
|
1925
|
+
* <p>Filter configuration for checking if a list contains a value.</p>
|
|
1926
|
+
* @public
|
|
1927
|
+
*/
|
|
1928
|
+
interface ListContainsMember {
|
|
1929
|
+
andAll?: never;
|
|
1930
|
+
equals?: never;
|
|
1931
|
+
greaterThan?: never;
|
|
1932
|
+
greaterThanOrEquals?: never;
|
|
1933
|
+
in?: never;
|
|
1934
|
+
lessThan?: never;
|
|
1935
|
+
lessThanOrEquals?: never;
|
|
1936
|
+
listContains: FilterAttribute;
|
|
1937
|
+
notEquals?: never;
|
|
1938
|
+
notIn?: never;
|
|
1939
|
+
orAll?: never;
|
|
1940
|
+
startsWith?: never;
|
|
1941
|
+
stringContains?: never;
|
|
1942
|
+
$unknown?: never;
|
|
1943
|
+
}
|
|
1944
|
+
/**
|
|
1945
|
+
* <p>Filter configuration for inequality matching.</p>
|
|
1946
|
+
* @public
|
|
1947
|
+
*/
|
|
1948
|
+
interface NotEqualsMember {
|
|
1949
|
+
andAll?: never;
|
|
1950
|
+
equals?: never;
|
|
1951
|
+
greaterThan?: never;
|
|
1952
|
+
greaterThanOrEquals?: never;
|
|
1953
|
+
in?: never;
|
|
1954
|
+
lessThan?: never;
|
|
1955
|
+
lessThanOrEquals?: never;
|
|
1956
|
+
listContains?: never;
|
|
1957
|
+
notEquals: FilterAttribute;
|
|
1958
|
+
notIn?: never;
|
|
1959
|
+
orAll?: never;
|
|
1960
|
+
startsWith?: never;
|
|
1961
|
+
stringContains?: never;
|
|
1962
|
+
$unknown?: never;
|
|
1963
|
+
}
|
|
1964
|
+
/**
|
|
1965
|
+
* <p>Filter configuration for exclusion from a set of values.</p>
|
|
1966
|
+
* @public
|
|
1967
|
+
*/
|
|
1968
|
+
interface NotInMember {
|
|
1969
|
+
andAll?: never;
|
|
1970
|
+
equals?: never;
|
|
1971
|
+
greaterThan?: never;
|
|
1972
|
+
greaterThanOrEquals?: never;
|
|
1973
|
+
in?: never;
|
|
1974
|
+
lessThan?: never;
|
|
1975
|
+
lessThanOrEquals?: never;
|
|
1976
|
+
listContains?: never;
|
|
1977
|
+
notEquals?: never;
|
|
1978
|
+
notIn: FilterAttribute;
|
|
1979
|
+
orAll?: never;
|
|
1980
|
+
startsWith?: never;
|
|
1981
|
+
stringContains?: never;
|
|
1982
|
+
$unknown?: never;
|
|
1983
|
+
}
|
|
1984
|
+
/**
|
|
1985
|
+
* <p>Filter configuration where any condition can be met.</p>
|
|
1986
|
+
* @public
|
|
1987
|
+
*/
|
|
1988
|
+
interface OrAllMember {
|
|
1989
|
+
andAll?: never;
|
|
1990
|
+
equals?: never;
|
|
1991
|
+
greaterThan?: never;
|
|
1992
|
+
greaterThanOrEquals?: never;
|
|
1993
|
+
in?: never;
|
|
1994
|
+
lessThan?: never;
|
|
1995
|
+
lessThanOrEquals?: never;
|
|
1996
|
+
listContains?: never;
|
|
1997
|
+
notEquals?: never;
|
|
1998
|
+
notIn?: never;
|
|
1999
|
+
orAll: RetrievalFilterConfiguration[];
|
|
2000
|
+
startsWith?: never;
|
|
2001
|
+
stringContains?: never;
|
|
2002
|
+
$unknown?: never;
|
|
2003
|
+
}
|
|
2004
|
+
/**
|
|
2005
|
+
* <p>Filter configuration for prefix matching.</p>
|
|
2006
|
+
* @public
|
|
2007
|
+
*/
|
|
2008
|
+
interface StartsWithMember {
|
|
2009
|
+
andAll?: never;
|
|
2010
|
+
equals?: never;
|
|
2011
|
+
greaterThan?: never;
|
|
2012
|
+
greaterThanOrEquals?: never;
|
|
2013
|
+
in?: never;
|
|
2014
|
+
lessThan?: never;
|
|
2015
|
+
lessThanOrEquals?: never;
|
|
2016
|
+
listContains?: never;
|
|
2017
|
+
notEquals?: never;
|
|
2018
|
+
notIn?: never;
|
|
2019
|
+
orAll?: never;
|
|
2020
|
+
startsWith: FilterAttribute;
|
|
2021
|
+
stringContains?: never;
|
|
2022
|
+
$unknown?: never;
|
|
2023
|
+
}
|
|
2024
|
+
/**
|
|
2025
|
+
* <p>Filter configuration for substring matching.</p>
|
|
2026
|
+
* @public
|
|
2027
|
+
*/
|
|
2028
|
+
interface StringContainsMember {
|
|
2029
|
+
andAll?: never;
|
|
2030
|
+
equals?: never;
|
|
2031
|
+
greaterThan?: never;
|
|
2032
|
+
greaterThanOrEquals?: never;
|
|
2033
|
+
in?: never;
|
|
2034
|
+
lessThan?: never;
|
|
2035
|
+
lessThanOrEquals?: never;
|
|
2036
|
+
listContains?: never;
|
|
2037
|
+
notEquals?: never;
|
|
2038
|
+
notIn?: never;
|
|
2039
|
+
orAll?: never;
|
|
2040
|
+
startsWith?: never;
|
|
2041
|
+
stringContains: FilterAttribute;
|
|
2042
|
+
$unknown?: never;
|
|
2043
|
+
}
|
|
2044
|
+
/**
|
|
2045
|
+
* @public
|
|
2046
|
+
*/
|
|
2047
|
+
interface $UnknownMember {
|
|
2048
|
+
andAll?: never;
|
|
2049
|
+
equals?: never;
|
|
2050
|
+
greaterThan?: never;
|
|
2051
|
+
greaterThanOrEquals?: never;
|
|
2052
|
+
in?: never;
|
|
2053
|
+
lessThan?: never;
|
|
2054
|
+
lessThanOrEquals?: never;
|
|
2055
|
+
listContains?: never;
|
|
2056
|
+
notEquals?: never;
|
|
2057
|
+
notIn?: never;
|
|
2058
|
+
orAll?: never;
|
|
2059
|
+
startsWith?: never;
|
|
2060
|
+
stringContains?: never;
|
|
2061
|
+
$unknown: [string, any];
|
|
2062
|
+
}
|
|
2063
|
+
/**
|
|
2064
|
+
* @deprecated unused in schema-serde mode.
|
|
2065
|
+
*
|
|
2066
|
+
*/
|
|
2067
|
+
interface Visitor<T> {
|
|
2068
|
+
andAll: (value: RetrievalFilterConfiguration[]) => T;
|
|
2069
|
+
equals: (value: FilterAttribute) => T;
|
|
2070
|
+
greaterThan: (value: FilterAttribute) => T;
|
|
2071
|
+
greaterThanOrEquals: (value: FilterAttribute) => T;
|
|
2072
|
+
in: (value: FilterAttribute) => T;
|
|
2073
|
+
lessThan: (value: FilterAttribute) => T;
|
|
2074
|
+
lessThanOrEquals: (value: FilterAttribute) => T;
|
|
2075
|
+
listContains: (value: FilterAttribute) => T;
|
|
2076
|
+
notEquals: (value: FilterAttribute) => T;
|
|
2077
|
+
notIn: (value: FilterAttribute) => T;
|
|
2078
|
+
orAll: (value: RetrievalFilterConfiguration[]) => T;
|
|
2079
|
+
startsWith: (value: FilterAttribute) => T;
|
|
2080
|
+
stringContains: (value: FilterAttribute) => T;
|
|
2081
|
+
_: (name: string, value: any) => T;
|
|
2082
|
+
}
|
|
2083
|
+
}
|
|
2084
|
+
/**
|
|
2085
|
+
* <p>A message in the conversation history with participant role and content values</p>
|
|
2086
|
+
* @public
|
|
2087
|
+
*/
|
|
2088
|
+
export interface SpanMessage {
|
|
2089
|
+
/**
|
|
2090
|
+
* <p>Unique message identifier</p>
|
|
2091
|
+
* @public
|
|
2092
|
+
*/
|
|
2093
|
+
messageId: string | undefined;
|
|
2094
|
+
/**
|
|
2095
|
+
* <p>Message source role</p>
|
|
930
2096
|
* @public
|
|
931
2097
|
*/
|
|
932
|
-
|
|
2098
|
+
participant: Participant | undefined;
|
|
933
2099
|
/**
|
|
934
|
-
* <p>
|
|
2100
|
+
* <p>Message timestamp</p>
|
|
935
2101
|
* @public
|
|
936
2102
|
*/
|
|
937
|
-
|
|
938
|
-
}
|
|
939
|
-
/**
|
|
940
|
-
* @public
|
|
941
|
-
*/
|
|
942
|
-
export interface UpdateKnowledgeBaseTemplateUriResponse {
|
|
2103
|
+
timestamp: Date | undefined;
|
|
943
2104
|
/**
|
|
944
|
-
* <p>
|
|
2105
|
+
* <p>Message content values (text, tool use, tool result)</p>
|
|
945
2106
|
* @public
|
|
946
2107
|
*/
|
|
947
|
-
|
|
2108
|
+
values: SpanMessageValue[] | undefined;
|
|
948
2109
|
}
|
|
949
2110
|
/**
|
|
2111
|
+
* <p>Configuration for content retrieval operations.</p>
|
|
950
2112
|
* @public
|
|
951
2113
|
*/
|
|
952
|
-
export interface
|
|
2114
|
+
export interface RetrievalConfiguration {
|
|
953
2115
|
/**
|
|
954
|
-
* <p>The
|
|
2116
|
+
* <p>The knowledge source configuration for content retrieval.</p>
|
|
955
2117
|
* @public
|
|
956
2118
|
*/
|
|
957
|
-
|
|
958
|
-
}
|
|
959
|
-
/**
|
|
960
|
-
* @public
|
|
961
|
-
*/
|
|
962
|
-
export interface ListTagsForResourceResponse {
|
|
2119
|
+
knowledgeSource: KnowledgeSource | undefined;
|
|
963
2120
|
/**
|
|
964
|
-
* <p>The
|
|
2121
|
+
* <p>The filter configuration for content retrieval.</p>
|
|
965
2122
|
* @public
|
|
966
2123
|
*/
|
|
967
|
-
|
|
968
|
-
}
|
|
969
|
-
/**
|
|
970
|
-
* @public
|
|
971
|
-
*/
|
|
972
|
-
export interface TagResourceRequest {
|
|
2124
|
+
filter?: RetrievalFilterConfiguration | undefined;
|
|
973
2125
|
/**
|
|
974
|
-
* <p>The
|
|
2126
|
+
* <p>The number of results to retrieve.</p>
|
|
975
2127
|
* @public
|
|
976
2128
|
*/
|
|
977
|
-
|
|
2129
|
+
numberOfResults?: number | undefined;
|
|
978
2130
|
/**
|
|
979
|
-
* <p>
|
|
2131
|
+
* <p>Override setting for the knowledge base search type during retrieval.</p>
|
|
980
2132
|
* @public
|
|
981
2133
|
*/
|
|
982
|
-
|
|
2134
|
+
overrideKnowledgeBaseSearchType?: KnowledgeBaseSearchType | undefined;
|
|
983
2135
|
}
|
|
984
2136
|
/**
|
|
985
2137
|
* @public
|
|
986
2138
|
*/
|
|
987
|
-
export interface
|
|
988
|
-
}
|
|
989
|
-
/**
|
|
990
|
-
* @public
|
|
991
|
-
*/
|
|
992
|
-
export interface UntagResourceRequest {
|
|
2139
|
+
export interface RetrieveRequest {
|
|
993
2140
|
/**
|
|
994
|
-
* <p>The Amazon
|
|
2141
|
+
* <p>The identifier of the Amazon Q in Connect assistant for content retrieval.</p>
|
|
995
2142
|
* @public
|
|
996
2143
|
*/
|
|
997
|
-
|
|
2144
|
+
assistantId: string | undefined;
|
|
998
2145
|
/**
|
|
999
|
-
* <p>The
|
|
2146
|
+
* <p>The configuration for the content retrieval operation.</p>
|
|
1000
2147
|
* @public
|
|
1001
2148
|
*/
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
2149
|
+
retrievalConfiguration: RetrievalConfiguration | undefined;
|
|
2150
|
+
/**
|
|
2151
|
+
* <p>The query for content retrieval.</p>
|
|
2152
|
+
* @public
|
|
2153
|
+
*/
|
|
2154
|
+
retrievalQuery: string | undefined;
|
|
1008
2155
|
}
|
|
1009
2156
|
/**
|
|
1010
2157
|
* <p>Details about the data.</p>
|
|
1011
2158
|
* @public
|
|
1012
2159
|
*/
|
|
1013
|
-
export type DataDetails = DataDetails.ContentDataMember | DataDetails.EmailGenerativeAnswerChunkDataMember | DataDetails.EmailOverviewChunkDataMember | DataDetails.EmailResponseChunkDataMember | DataDetails.GenerativeChunkDataMember | DataDetails.GenerativeDataMember | DataDetails.IntentDetectedDataMember | DataDetails.SourceContentDataMember | DataDetails.$UnknownMember;
|
|
2160
|
+
export type DataDetails = DataDetails.CaseSummarizationChunkDataMember | DataDetails.ContentDataMember | DataDetails.EmailGenerativeAnswerChunkDataMember | DataDetails.EmailOverviewChunkDataMember | DataDetails.EmailResponseChunkDataMember | DataDetails.GenerativeChunkDataMember | DataDetails.GenerativeDataMember | DataDetails.IntentDetectedDataMember | DataDetails.NotesChunkDataMember | DataDetails.NotesDataMember | DataDetails.SourceContentDataMember | DataDetails.SuggestedMessageDataMember | DataDetails.$UnknownMember;
|
|
1014
2161
|
/**
|
|
1015
2162
|
* @public
|
|
1016
2163
|
*/
|
|
@@ -1028,6 +2175,10 @@ export declare namespace DataDetails {
|
|
|
1028
2175
|
emailResponseChunkData?: never;
|
|
1029
2176
|
emailOverviewChunkData?: never;
|
|
1030
2177
|
emailGenerativeAnswerChunkData?: never;
|
|
2178
|
+
caseSummarizationChunkData?: never;
|
|
2179
|
+
suggestedMessageData?: never;
|
|
2180
|
+
notesData?: never;
|
|
2181
|
+
notesChunkData?: never;
|
|
1031
2182
|
$unknown?: never;
|
|
1032
2183
|
}
|
|
1033
2184
|
/**
|
|
@@ -1043,6 +2194,10 @@ export declare namespace DataDetails {
|
|
|
1043
2194
|
emailResponseChunkData?: never;
|
|
1044
2195
|
emailOverviewChunkData?: never;
|
|
1045
2196
|
emailGenerativeAnswerChunkData?: never;
|
|
2197
|
+
caseSummarizationChunkData?: never;
|
|
2198
|
+
suggestedMessageData?: never;
|
|
2199
|
+
notesData?: never;
|
|
2200
|
+
notesChunkData?: never;
|
|
1046
2201
|
$unknown?: never;
|
|
1047
2202
|
}
|
|
1048
2203
|
/**
|
|
@@ -1058,6 +2213,10 @@ export declare namespace DataDetails {
|
|
|
1058
2213
|
emailResponseChunkData?: never;
|
|
1059
2214
|
emailOverviewChunkData?: never;
|
|
1060
2215
|
emailGenerativeAnswerChunkData?: never;
|
|
2216
|
+
caseSummarizationChunkData?: never;
|
|
2217
|
+
suggestedMessageData?: never;
|
|
2218
|
+
notesData?: never;
|
|
2219
|
+
notesChunkData?: never;
|
|
1061
2220
|
$unknown?: never;
|
|
1062
2221
|
}
|
|
1063
2222
|
/**
|
|
@@ -1073,6 +2232,10 @@ export declare namespace DataDetails {
|
|
|
1073
2232
|
emailResponseChunkData?: never;
|
|
1074
2233
|
emailOverviewChunkData?: never;
|
|
1075
2234
|
emailGenerativeAnswerChunkData?: never;
|
|
2235
|
+
caseSummarizationChunkData?: never;
|
|
2236
|
+
suggestedMessageData?: never;
|
|
2237
|
+
notesData?: never;
|
|
2238
|
+
notesChunkData?: never;
|
|
1076
2239
|
$unknown?: never;
|
|
1077
2240
|
}
|
|
1078
2241
|
/**
|
|
@@ -1088,6 +2251,10 @@ export declare namespace DataDetails {
|
|
|
1088
2251
|
emailResponseChunkData?: never;
|
|
1089
2252
|
emailOverviewChunkData?: never;
|
|
1090
2253
|
emailGenerativeAnswerChunkData?: never;
|
|
2254
|
+
caseSummarizationChunkData?: never;
|
|
2255
|
+
suggestedMessageData?: never;
|
|
2256
|
+
notesData?: never;
|
|
2257
|
+
notesChunkData?: never;
|
|
1091
2258
|
$unknown?: never;
|
|
1092
2259
|
}
|
|
1093
2260
|
/**
|
|
@@ -1103,6 +2270,10 @@ export declare namespace DataDetails {
|
|
|
1103
2270
|
emailResponseChunkData: EmailResponseChunkDataDetails;
|
|
1104
2271
|
emailOverviewChunkData?: never;
|
|
1105
2272
|
emailGenerativeAnswerChunkData?: never;
|
|
2273
|
+
caseSummarizationChunkData?: never;
|
|
2274
|
+
suggestedMessageData?: never;
|
|
2275
|
+
notesData?: never;
|
|
2276
|
+
notesChunkData?: never;
|
|
1106
2277
|
$unknown?: never;
|
|
1107
2278
|
}
|
|
1108
2279
|
/**
|
|
@@ -1118,6 +2289,10 @@ export declare namespace DataDetails {
|
|
|
1118
2289
|
emailResponseChunkData?: never;
|
|
1119
2290
|
emailOverviewChunkData: EmailOverviewChunkDataDetails;
|
|
1120
2291
|
emailGenerativeAnswerChunkData?: never;
|
|
2292
|
+
caseSummarizationChunkData?: never;
|
|
2293
|
+
suggestedMessageData?: never;
|
|
2294
|
+
notesData?: never;
|
|
2295
|
+
notesChunkData?: never;
|
|
1121
2296
|
$unknown?: never;
|
|
1122
2297
|
}
|
|
1123
2298
|
/**
|
|
@@ -1133,6 +2308,86 @@ export declare namespace DataDetails {
|
|
|
1133
2308
|
emailResponseChunkData?: never;
|
|
1134
2309
|
emailOverviewChunkData?: never;
|
|
1135
2310
|
emailGenerativeAnswerChunkData: EmailGenerativeAnswerChunkDataDetails;
|
|
2311
|
+
caseSummarizationChunkData?: never;
|
|
2312
|
+
suggestedMessageData?: never;
|
|
2313
|
+
notesData?: never;
|
|
2314
|
+
notesChunkData?: never;
|
|
2315
|
+
$unknown?: never;
|
|
2316
|
+
}
|
|
2317
|
+
/**
|
|
2318
|
+
* <p>Details about case summarization chunk data.</p>
|
|
2319
|
+
* @public
|
|
2320
|
+
*/
|
|
2321
|
+
interface CaseSummarizationChunkDataMember {
|
|
2322
|
+
contentData?: never;
|
|
2323
|
+
generativeData?: never;
|
|
2324
|
+
intentDetectedData?: never;
|
|
2325
|
+
sourceContentData?: never;
|
|
2326
|
+
generativeChunkData?: never;
|
|
2327
|
+
emailResponseChunkData?: never;
|
|
2328
|
+
emailOverviewChunkData?: never;
|
|
2329
|
+
emailGenerativeAnswerChunkData?: never;
|
|
2330
|
+
caseSummarizationChunkData: CaseSummarizationChunkDataDetails;
|
|
2331
|
+
suggestedMessageData?: never;
|
|
2332
|
+
notesData?: never;
|
|
2333
|
+
notesChunkData?: never;
|
|
2334
|
+
$unknown?: never;
|
|
2335
|
+
}
|
|
2336
|
+
/**
|
|
2337
|
+
* <p>Details about suggested message data.</p>
|
|
2338
|
+
* @public
|
|
2339
|
+
*/
|
|
2340
|
+
interface SuggestedMessageDataMember {
|
|
2341
|
+
contentData?: never;
|
|
2342
|
+
generativeData?: never;
|
|
2343
|
+
intentDetectedData?: never;
|
|
2344
|
+
sourceContentData?: never;
|
|
2345
|
+
generativeChunkData?: never;
|
|
2346
|
+
emailResponseChunkData?: never;
|
|
2347
|
+
emailOverviewChunkData?: never;
|
|
2348
|
+
emailGenerativeAnswerChunkData?: never;
|
|
2349
|
+
caseSummarizationChunkData?: never;
|
|
2350
|
+
suggestedMessageData: SuggestedMessageDataDetails;
|
|
2351
|
+
notesData?: never;
|
|
2352
|
+
notesChunkData?: never;
|
|
2353
|
+
$unknown?: never;
|
|
2354
|
+
}
|
|
2355
|
+
/**
|
|
2356
|
+
* <p>Details about notes data.</p>
|
|
2357
|
+
* @public
|
|
2358
|
+
*/
|
|
2359
|
+
interface NotesDataMember {
|
|
2360
|
+
contentData?: never;
|
|
2361
|
+
generativeData?: never;
|
|
2362
|
+
intentDetectedData?: never;
|
|
2363
|
+
sourceContentData?: never;
|
|
2364
|
+
generativeChunkData?: never;
|
|
2365
|
+
emailResponseChunkData?: never;
|
|
2366
|
+
emailOverviewChunkData?: never;
|
|
2367
|
+
emailGenerativeAnswerChunkData?: never;
|
|
2368
|
+
caseSummarizationChunkData?: never;
|
|
2369
|
+
suggestedMessageData?: never;
|
|
2370
|
+
notesData: NotesDataDetails;
|
|
2371
|
+
notesChunkData?: never;
|
|
2372
|
+
$unknown?: never;
|
|
2373
|
+
}
|
|
2374
|
+
/**
|
|
2375
|
+
* <p>Details about notes chunk data.</p>
|
|
2376
|
+
* @public
|
|
2377
|
+
*/
|
|
2378
|
+
interface NotesChunkDataMember {
|
|
2379
|
+
contentData?: never;
|
|
2380
|
+
generativeData?: never;
|
|
2381
|
+
intentDetectedData?: never;
|
|
2382
|
+
sourceContentData?: never;
|
|
2383
|
+
generativeChunkData?: never;
|
|
2384
|
+
emailResponseChunkData?: never;
|
|
2385
|
+
emailOverviewChunkData?: never;
|
|
2386
|
+
emailGenerativeAnswerChunkData?: never;
|
|
2387
|
+
caseSummarizationChunkData?: never;
|
|
2388
|
+
suggestedMessageData?: never;
|
|
2389
|
+
notesData?: never;
|
|
2390
|
+
notesChunkData: NotesChunkDataDetails;
|
|
1136
2391
|
$unknown?: never;
|
|
1137
2392
|
}
|
|
1138
2393
|
/**
|
|
@@ -1147,6 +2402,10 @@ export declare namespace DataDetails {
|
|
|
1147
2402
|
emailResponseChunkData?: never;
|
|
1148
2403
|
emailOverviewChunkData?: never;
|
|
1149
2404
|
emailGenerativeAnswerChunkData?: never;
|
|
2405
|
+
caseSummarizationChunkData?: never;
|
|
2406
|
+
suggestedMessageData?: never;
|
|
2407
|
+
notesData?: never;
|
|
2408
|
+
notesChunkData?: never;
|
|
1150
2409
|
$unknown: [string, any];
|
|
1151
2410
|
}
|
|
1152
2411
|
/**
|
|
@@ -1162,6 +2421,10 @@ export declare namespace DataDetails {
|
|
|
1162
2421
|
emailResponseChunkData: (value: EmailResponseChunkDataDetails) => T;
|
|
1163
2422
|
emailOverviewChunkData: (value: EmailOverviewChunkDataDetails) => T;
|
|
1164
2423
|
emailGenerativeAnswerChunkData: (value: EmailGenerativeAnswerChunkDataDetails) => T;
|
|
2424
|
+
caseSummarizationChunkData: (value: CaseSummarizationChunkDataDetails) => T;
|
|
2425
|
+
suggestedMessageData: (value: SuggestedMessageDataDetails) => T;
|
|
2426
|
+
notesData: (value: NotesDataDetails) => T;
|
|
2427
|
+
notesChunkData: (value: NotesChunkDataDetails) => T;
|
|
1165
2428
|
_: (name: string, value: any) => T;
|
|
1166
2429
|
}
|
|
1167
2430
|
}
|
|
@@ -1311,6 +2574,243 @@ export interface ResultData {
|
|
|
1311
2574
|
*/
|
|
1312
2575
|
type?: QueryResultType | undefined;
|
|
1313
2576
|
}
|
|
2577
|
+
/**
|
|
2578
|
+
* <p>Contextual attributes capturing operation details, LLM configuration, usage metrics, and conversation data</p>
|
|
2579
|
+
* @public
|
|
2580
|
+
*/
|
|
2581
|
+
export interface SpanAttributes {
|
|
2582
|
+
/**
|
|
2583
|
+
* <p>Action being performed</p>
|
|
2584
|
+
* @public
|
|
2585
|
+
*/
|
|
2586
|
+
operationName?: string | undefined;
|
|
2587
|
+
/**
|
|
2588
|
+
* <p>Model provider identifier (e.g., aws.bedrock)</p>
|
|
2589
|
+
* @public
|
|
2590
|
+
*/
|
|
2591
|
+
providerName?: string | undefined;
|
|
2592
|
+
/**
|
|
2593
|
+
* <p>Error classification if span failed (e.g., throttle, timeout)</p>
|
|
2594
|
+
* @public
|
|
2595
|
+
*/
|
|
2596
|
+
errorType?: string | undefined;
|
|
2597
|
+
/**
|
|
2598
|
+
* <p>Amazon Connect agent ID</p>
|
|
2599
|
+
* @public
|
|
2600
|
+
*/
|
|
2601
|
+
agentId?: string | undefined;
|
|
2602
|
+
/**
|
|
2603
|
+
* <p>Amazon Connect instance ARN</p>
|
|
2604
|
+
* @public
|
|
2605
|
+
*/
|
|
2606
|
+
instanceArn?: string | undefined;
|
|
2607
|
+
/**
|
|
2608
|
+
* <p>Amazon Connect contact identifier</p>
|
|
2609
|
+
* @public
|
|
2610
|
+
*/
|
|
2611
|
+
contactId?: string | undefined;
|
|
2612
|
+
/**
|
|
2613
|
+
* <p>Amazon Connect contact identifier</p>
|
|
2614
|
+
* @public
|
|
2615
|
+
*/
|
|
2616
|
+
initialContactId?: string | undefined;
|
|
2617
|
+
/**
|
|
2618
|
+
* <p>Session name</p>
|
|
2619
|
+
* @public
|
|
2620
|
+
*/
|
|
2621
|
+
sessionName?: string | undefined;
|
|
2622
|
+
/**
|
|
2623
|
+
* <p>AI agent ARN</p>
|
|
2624
|
+
* @public
|
|
2625
|
+
*/
|
|
2626
|
+
aiAgentArn?: string | undefined;
|
|
2627
|
+
/**
|
|
2628
|
+
* <p>AI agent type</p>
|
|
2629
|
+
* @public
|
|
2630
|
+
*/
|
|
2631
|
+
aiAgentType?: AIAgentType | undefined;
|
|
2632
|
+
/**
|
|
2633
|
+
* <p>AI agent name</p>
|
|
2634
|
+
* @public
|
|
2635
|
+
*/
|
|
2636
|
+
aiAgentName?: string | undefined;
|
|
2637
|
+
/**
|
|
2638
|
+
* <p>AI agent identifier</p>
|
|
2639
|
+
* @public
|
|
2640
|
+
*/
|
|
2641
|
+
aiAgentId?: string | undefined;
|
|
2642
|
+
/**
|
|
2643
|
+
* <p>AI agent version number</p>
|
|
2644
|
+
* @public
|
|
2645
|
+
*/
|
|
2646
|
+
aiAgentVersion?: number | undefined;
|
|
2647
|
+
/**
|
|
2648
|
+
* <p>Entity that invoked the AI agent</p>
|
|
2649
|
+
* @public
|
|
2650
|
+
*/
|
|
2651
|
+
aiAgentInvoker?: string | undefined;
|
|
2652
|
+
/**
|
|
2653
|
+
* <p>AI agent orchestrator use case</p>
|
|
2654
|
+
* @public
|
|
2655
|
+
*/
|
|
2656
|
+
aiAgentOrchestratorUseCase?: string | undefined;
|
|
2657
|
+
/**
|
|
2658
|
+
* <p>LLM model ID for request (e.g., anthropic.claude-3-sonnet)</p>
|
|
2659
|
+
* @public
|
|
2660
|
+
*/
|
|
2661
|
+
requestModel?: string | undefined;
|
|
2662
|
+
/**
|
|
2663
|
+
* <p>Maximum tokens configured for generation</p>
|
|
2664
|
+
* @public
|
|
2665
|
+
*/
|
|
2666
|
+
requestMaxTokens?: number | undefined;
|
|
2667
|
+
/**
|
|
2668
|
+
* <p>Sampling temperature for generation</p>
|
|
2669
|
+
* @public
|
|
2670
|
+
*/
|
|
2671
|
+
temperature?: number | undefined;
|
|
2672
|
+
/**
|
|
2673
|
+
* <p>Top-p sampling parameter for generation</p>
|
|
2674
|
+
* @public
|
|
2675
|
+
*/
|
|
2676
|
+
topP?: number | undefined;
|
|
2677
|
+
/**
|
|
2678
|
+
* <p>Actual model used for response (usually matches requestModel)</p>
|
|
2679
|
+
* @public
|
|
2680
|
+
*/
|
|
2681
|
+
responseModel?: string | undefined;
|
|
2682
|
+
/**
|
|
2683
|
+
* <p>Generation termination reasons (e.g., stop, max_tokens)</p>
|
|
2684
|
+
* @public
|
|
2685
|
+
*/
|
|
2686
|
+
responseFinishReasons?: string[] | undefined;
|
|
2687
|
+
/**
|
|
2688
|
+
* <p>Number of input tokens in prompt</p>
|
|
2689
|
+
* @public
|
|
2690
|
+
*/
|
|
2691
|
+
usageInputTokens?: number | undefined;
|
|
2692
|
+
/**
|
|
2693
|
+
* <p>Number of output tokens in response</p>
|
|
2694
|
+
* @public
|
|
2695
|
+
*/
|
|
2696
|
+
usageOutputTokens?: number | undefined;
|
|
2697
|
+
/**
|
|
2698
|
+
* <p>Total tokens consumed (input + output)</p>
|
|
2699
|
+
* @public
|
|
2700
|
+
*/
|
|
2701
|
+
usageTotalTokens?: number | undefined;
|
|
2702
|
+
/**
|
|
2703
|
+
* <p>Number of input tokens that were retrieved from cache</p>
|
|
2704
|
+
* @public
|
|
2705
|
+
*/
|
|
2706
|
+
cacheReadInputTokens?: number | undefined;
|
|
2707
|
+
/**
|
|
2708
|
+
* <p>Number of input tokens that were written to cache in this request</p>
|
|
2709
|
+
* @public
|
|
2710
|
+
*/
|
|
2711
|
+
cacheWriteInputTokens?: number | undefined;
|
|
2712
|
+
/**
|
|
2713
|
+
* <p>Input message collection sent to LLM</p>
|
|
2714
|
+
* @public
|
|
2715
|
+
*/
|
|
2716
|
+
inputMessages?: SpanMessage[] | undefined;
|
|
2717
|
+
/**
|
|
2718
|
+
* <p>Output message collection received from LLM</p>
|
|
2719
|
+
* @public
|
|
2720
|
+
*/
|
|
2721
|
+
outputMessages?: SpanMessage[] | undefined;
|
|
2722
|
+
/**
|
|
2723
|
+
* <p>System prompt instructions</p>
|
|
2724
|
+
* @public
|
|
2725
|
+
*/
|
|
2726
|
+
systemInstructions?: SpanMessageValue[] | undefined;
|
|
2727
|
+
/**
|
|
2728
|
+
* <p>AI prompt ARN</p>
|
|
2729
|
+
* @public
|
|
2730
|
+
*/
|
|
2731
|
+
promptArn?: string | undefined;
|
|
2732
|
+
/**
|
|
2733
|
+
* <p>AI prompt identifier</p>
|
|
2734
|
+
* @public
|
|
2735
|
+
*/
|
|
2736
|
+
promptId?: string | undefined;
|
|
2737
|
+
/**
|
|
2738
|
+
* <p>AI prompt type</p>
|
|
2739
|
+
* @public
|
|
2740
|
+
*/
|
|
2741
|
+
promptType?: AIPromptType | undefined;
|
|
2742
|
+
/**
|
|
2743
|
+
* <p>AI prompt name</p>
|
|
2744
|
+
* @public
|
|
2745
|
+
*/
|
|
2746
|
+
promptName?: string | undefined;
|
|
2747
|
+
/**
|
|
2748
|
+
* <p>AI prompt version number</p>
|
|
2749
|
+
* @public
|
|
2750
|
+
*/
|
|
2751
|
+
promptVersion?: number | undefined;
|
|
2752
|
+
}
|
|
2753
|
+
/**
|
|
2754
|
+
* <p>A span represents a unit of work during AI agent execution, capturing timing, status, and contextual attributes.</p>
|
|
2755
|
+
* @public
|
|
2756
|
+
*/
|
|
2757
|
+
export interface Span {
|
|
2758
|
+
/**
|
|
2759
|
+
* <p>Unique span identifier</p>
|
|
2760
|
+
* @public
|
|
2761
|
+
*/
|
|
2762
|
+
spanId: string | undefined;
|
|
2763
|
+
/**
|
|
2764
|
+
* <p>UUID of the Connect AI Assistant resource</p>
|
|
2765
|
+
* @public
|
|
2766
|
+
*/
|
|
2767
|
+
assistantId: string | undefined;
|
|
2768
|
+
/**
|
|
2769
|
+
* <p>UUID of the Connect AI Session resource</p>
|
|
2770
|
+
* @public
|
|
2771
|
+
*/
|
|
2772
|
+
sessionId: string | undefined;
|
|
2773
|
+
/**
|
|
2774
|
+
* <p>Parent span identifier for hierarchy. Null for root spans.</p>
|
|
2775
|
+
* @public
|
|
2776
|
+
*/
|
|
2777
|
+
parentSpanId?: string | undefined;
|
|
2778
|
+
/**
|
|
2779
|
+
* <p>Service-defined operation name</p>
|
|
2780
|
+
* @public
|
|
2781
|
+
*/
|
|
2782
|
+
spanName: string | undefined;
|
|
2783
|
+
/**
|
|
2784
|
+
* <p>Operation relationship type</p>
|
|
2785
|
+
* @public
|
|
2786
|
+
*/
|
|
2787
|
+
spanType: SpanType | undefined;
|
|
2788
|
+
/**
|
|
2789
|
+
* <p>Operation start time in milliseconds since epoch</p>
|
|
2790
|
+
* @public
|
|
2791
|
+
*/
|
|
2792
|
+
startTimestamp: Date | undefined;
|
|
2793
|
+
/**
|
|
2794
|
+
* <p>Operation end time in milliseconds since epoch</p>
|
|
2795
|
+
* @public
|
|
2796
|
+
*/
|
|
2797
|
+
endTimestamp: Date | undefined;
|
|
2798
|
+
/**
|
|
2799
|
+
* <p>Span completion status</p>
|
|
2800
|
+
* @public
|
|
2801
|
+
*/
|
|
2802
|
+
status: SpanStatus | undefined;
|
|
2803
|
+
/**
|
|
2804
|
+
* <p>The service request ID that initiated the operation</p>
|
|
2805
|
+
* @public
|
|
2806
|
+
*/
|
|
2807
|
+
requestId: string | undefined;
|
|
2808
|
+
/**
|
|
2809
|
+
* <p>Span-specific contextual attributes</p>
|
|
2810
|
+
* @public
|
|
2811
|
+
*/
|
|
2812
|
+
attributes: SpanAttributes | undefined;
|
|
2813
|
+
}
|
|
1314
2814
|
/**
|
|
1315
2815
|
* @public
|
|
1316
2816
|
*/
|
|
@@ -1341,3 +2841,18 @@ export interface QueryAssistantResponse {
|
|
|
1341
2841
|
*/
|
|
1342
2842
|
nextToken?: string | undefined;
|
|
1343
2843
|
}
|
|
2844
|
+
/**
|
|
2845
|
+
* @public
|
|
2846
|
+
*/
|
|
2847
|
+
export interface ListSpansResponse {
|
|
2848
|
+
/**
|
|
2849
|
+
* <p>Array of span objects for the session</p>
|
|
2850
|
+
* @public
|
|
2851
|
+
*/
|
|
2852
|
+
spans: Span[] | undefined;
|
|
2853
|
+
/**
|
|
2854
|
+
* <p>Pagination token for retrieving additional results</p>
|
|
2855
|
+
* @public
|
|
2856
|
+
*/
|
|
2857
|
+
nextToken?: string | undefined;
|
|
2858
|
+
}
|