@aws-sdk/client-qconnect 3.665.0 → 3.666.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 +166 -0
- package/dist-cjs/index.js +1501 -102
- package/dist-es/QConnect.js +38 -0
- package/dist-es/commands/CreateAIAgentCommand.js +22 -0
- package/dist-es/commands/CreateAIAgentVersionCommand.js +22 -0
- package/dist-es/commands/CreateAIPromptCommand.js +23 -0
- package/dist-es/commands/CreateAIPromptVersionCommand.js +23 -0
- package/dist-es/commands/CreateKnowledgeBaseCommand.js +2 -1
- package/dist-es/commands/DeleteAIAgentCommand.js +22 -0
- package/dist-es/commands/DeleteAIAgentVersionCommand.js +22 -0
- package/dist-es/commands/DeleteAIPromptCommand.js +22 -0
- package/dist-es/commands/DeleteAIPromptVersionCommand.js +22 -0
- package/dist-es/commands/GetAIAgentCommand.js +22 -0
- package/dist-es/commands/GetAIPromptCommand.js +23 -0
- package/dist-es/commands/GetKnowledgeBaseCommand.js +2 -1
- package/dist-es/commands/ListAIAgentVersionsCommand.js +22 -0
- package/dist-es/commands/ListAIAgentsCommand.js +22 -0
- package/dist-es/commands/ListAIPromptVersionsCommand.js +22 -0
- package/dist-es/commands/ListAIPromptsCommand.js +22 -0
- package/dist-es/commands/ListKnowledgeBasesCommand.js +2 -1
- package/dist-es/commands/RemoveAssistantAIAgentCommand.js +22 -0
- package/dist-es/commands/UpdateAIAgentCommand.js +22 -0
- package/dist-es/commands/UpdateAIPromptCommand.js +23 -0
- package/dist-es/commands/UpdateAssistantAIAgentCommand.js +22 -0
- package/dist-es/commands/UpdateKnowledgeBaseTemplateUriCommand.js +2 -1
- package/dist-es/commands/UpdateSessionDataCommand.js +23 -0
- package/dist-es/commands/index.js +19 -0
- package/dist-es/models/models_0.js +310 -46
- package/dist-es/pagination/ListAIAgentVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListAIAgentsPaginator.js +4 -0
- package/dist-es/pagination/ListAIPromptVersionsPaginator.js +4 -0
- package/dist-es/pagination/ListAIPromptsPaginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +692 -8
- package/dist-types/QConnect.d.ts +148 -1
- package/dist-types/QConnectClient.d.ts +36 -3
- package/dist-types/commands/CreateAIAgentCommand.d.ts +252 -0
- package/dist-types/commands/CreateAIAgentVersionCommand.d.ts +180 -0
- package/dist-types/commands/CreateAIPromptCommand.d.ts +132 -0
- package/dist-types/commands/CreateAIPromptVersionCommand.d.ts +120 -0
- package/dist-types/commands/CreateAssistantCommand.d.ts +5 -0
- package/dist-types/commands/CreateContentAssociationCommand.d.ts +5 -6
- package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +108 -0
- package/dist-types/commands/CreateSessionCommand.d.ts +10 -0
- package/dist-types/commands/DeleteAIAgentCommand.d.ts +82 -0
- package/dist-types/commands/DeleteAIAgentVersionCommand.d.ts +89 -0
- package/dist-types/commands/DeleteAIPromptCommand.d.ts +82 -0
- package/dist-types/commands/DeleteAIPromptVersionCommand.d.ts +89 -0
- package/dist-types/commands/GetAIAgentCommand.d.ts +168 -0
- package/dist-types/commands/GetAIPromptCommand.d.ts +108 -0
- package/dist-types/commands/GetAssistantCommand.d.ts +5 -0
- package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +56 -0
- package/dist-types/commands/GetRecommendationsCommand.d.ts +20 -0
- package/dist-types/commands/GetSessionCommand.d.ts +5 -0
- package/dist-types/commands/ListAIAgentVersionsCommand.d.ts +176 -0
- package/dist-types/commands/ListAIAgentsCommand.d.ts +172 -0
- package/dist-types/commands/ListAIPromptVersionsCommand.d.ts +111 -0
- package/dist-types/commands/ListAIPromptsCommand.d.ts +107 -0
- package/dist-types/commands/ListAssistantsCommand.d.ts +5 -0
- package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +52 -0
- package/dist-types/commands/QueryAssistantCommand.d.ts +30 -1
- package/dist-types/commands/RemoveAssistantAIAgentCommand.d.ts +83 -0
- package/dist-types/commands/UpdateAIAgentCommand.d.ts +244 -0
- package/dist-types/commands/UpdateAIPromptCommand.d.ts +121 -0
- package/dist-types/commands/UpdateAssistantAIAgentCommand.d.ts +112 -0
- package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +56 -0
- package/dist-types/commands/UpdateSessionCommand.d.ts +10 -0
- package/dist-types/commands/UpdateSessionDataCommand.d.ts +100 -0
- package/dist-types/commands/index.d.ts +19 -0
- package/dist-types/index.d.ts +15 -1
- package/dist-types/models/models_0.d.ts +2454 -275
- package/dist-types/pagination/ListAIAgentVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAIAgentsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAIPromptVersionsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListAIPromptsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +171 -0
- package/dist-types/ts3.4/QConnect.d.ts +323 -0
- package/dist-types/ts3.4/QConnectClient.d.ts +116 -2
- package/dist-types/ts3.4/commands/CreateAIAgentCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateAIAgentVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateAIPromptCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/CreateAIPromptVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteAIAgentCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteAIAgentVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteAIPromptCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteAIPromptVersionCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetAIAgentCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/GetAIPromptCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListAIAgentVersionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListAIAgentsCommand.d.ts +47 -0
- package/dist-types/ts3.4/commands/ListAIPromptVersionsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListAIPromptsCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/RemoveAssistantAIAgentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateAIAgentCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateAIPromptCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/UpdateAssistantAIAgentCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateSessionDataCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +19 -0
- package/dist-types/ts3.4/models/models_0.d.ts +794 -103
- package/dist-types/ts3.4/pagination/ListAIAgentVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAIAgentsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAIPromptVersionsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAIPromptsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +228 -0
- package/package.json +12 -12
|
@@ -13,32 +13,1564 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
13
13
|
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
14
14
|
}
|
|
15
15
|
/**
|
|
16
|
-
* <p>
|
|
17
|
-
*
|
|
16
|
+
* <p>The request could not be processed because of conflict in the current state of the
|
|
17
|
+
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
18
|
+
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
19
|
+
* same name) is being created or mutated.</p>
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
export declare class ConflictException extends __BaseException {
|
|
23
|
+
readonly name: "ConflictException";
|
|
24
|
+
readonly $fault: "client";
|
|
25
|
+
/**
|
|
26
|
+
* @internal
|
|
27
|
+
*/
|
|
28
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* <p>A leaf node condition which can be used to specify a tag condition. </p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
export interface TagCondition {
|
|
35
|
+
/**
|
|
36
|
+
* <p>The tag key in the tag condition.</p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
key: string | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* <p>The tag value in the tag condition.</p>
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
value?: string;
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
48
|
+
* condition.</p>
|
|
49
|
+
* @public
|
|
50
|
+
*/
|
|
51
|
+
export type OrCondition = OrCondition.AndConditionsMember | OrCondition.TagConditionMember | OrCondition.$UnknownMember;
|
|
52
|
+
/**
|
|
53
|
+
* @public
|
|
54
|
+
*/
|
|
55
|
+
export declare namespace OrCondition {
|
|
56
|
+
/**
|
|
57
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code>
|
|
58
|
+
* condition.</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
interface AndConditionsMember {
|
|
62
|
+
andConditions: TagCondition[];
|
|
63
|
+
tagCondition?: never;
|
|
64
|
+
$unknown?: never;
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* <p>A leaf node condition which can be used to specify a tag condition.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
interface TagConditionMember {
|
|
71
|
+
andConditions?: never;
|
|
72
|
+
tagCondition: TagCondition;
|
|
73
|
+
$unknown?: never;
|
|
74
|
+
}
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
78
|
+
interface $UnknownMember {
|
|
79
|
+
andConditions?: never;
|
|
80
|
+
tagCondition?: never;
|
|
81
|
+
$unknown: [string, any];
|
|
82
|
+
}
|
|
83
|
+
interface Visitor<T> {
|
|
84
|
+
andConditions: (value: TagCondition[]) => T;
|
|
85
|
+
tagCondition: (value: TagCondition) => T;
|
|
86
|
+
_: (name: string, value: any) => T;
|
|
87
|
+
}
|
|
88
|
+
const visit: <T>(value: OrCondition, visitor: Visitor<T>) => T;
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* <p>An object that can be used to specify Tag conditions.</p>
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
export type TagFilter = TagFilter.AndConditionsMember | TagFilter.OrConditionsMember | TagFilter.TagConditionMember | TagFilter.$UnknownMember;
|
|
95
|
+
/**
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export declare namespace TagFilter {
|
|
99
|
+
/**
|
|
100
|
+
* <p>A leaf node condition which can be used to specify a tag condition.</p>
|
|
101
|
+
* @public
|
|
102
|
+
*/
|
|
103
|
+
interface TagConditionMember {
|
|
104
|
+
tagCondition: TagCondition;
|
|
105
|
+
andConditions?: never;
|
|
106
|
+
orConditions?: never;
|
|
107
|
+
$unknown?: never;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* <p>A list of conditions which would be applied together with an <code>AND</code>
|
|
111
|
+
* condition.</p>
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
interface AndConditionsMember {
|
|
115
|
+
tagCondition?: never;
|
|
116
|
+
andConditions: TagCondition[];
|
|
117
|
+
orConditions?: never;
|
|
118
|
+
$unknown?: never;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* <p>A list of conditions which would be applied together with an <code>OR</code>
|
|
122
|
+
* condition.</p>
|
|
123
|
+
* @public
|
|
124
|
+
*/
|
|
125
|
+
interface OrConditionsMember {
|
|
126
|
+
tagCondition?: never;
|
|
127
|
+
andConditions?: never;
|
|
128
|
+
orConditions: OrCondition[];
|
|
129
|
+
$unknown?: never;
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
interface $UnknownMember {
|
|
135
|
+
tagCondition?: never;
|
|
136
|
+
andConditions?: never;
|
|
137
|
+
orConditions?: never;
|
|
138
|
+
$unknown: [string, any];
|
|
139
|
+
}
|
|
140
|
+
interface Visitor<T> {
|
|
141
|
+
tagCondition: (value: TagCondition) => T;
|
|
142
|
+
andConditions: (value: TagCondition[]) => T;
|
|
143
|
+
orConditions: (value: OrCondition[]) => T;
|
|
144
|
+
_: (name: string, value: any) => T;
|
|
145
|
+
}
|
|
146
|
+
const visit: <T>(value: TagFilter, visitor: Visitor<T>) => T;
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* @public
|
|
150
|
+
* @enum
|
|
151
|
+
*/
|
|
152
|
+
export declare const KnowledgeBaseSearchType: {
|
|
153
|
+
readonly HYBRID: "HYBRID";
|
|
154
|
+
readonly SEMANTIC: "SEMANTIC";
|
|
155
|
+
};
|
|
156
|
+
/**
|
|
157
|
+
* @public
|
|
158
|
+
*/
|
|
159
|
+
export type KnowledgeBaseSearchType = (typeof KnowledgeBaseSearchType)[keyof typeof KnowledgeBaseSearchType];
|
|
160
|
+
/**
|
|
161
|
+
* <p>The data of the configuration for a <code>KNOWLEDGE_BASE</code> type Amazon Q in Connect
|
|
162
|
+
* Assistant Association.</p>
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
export interface KnowledgeBaseAssociationConfigurationData {
|
|
166
|
+
/**
|
|
167
|
+
* <p>An object that can be used to specify Tag conditions.</p>
|
|
168
|
+
* @public
|
|
169
|
+
*/
|
|
170
|
+
contentTagFilter?: TagFilter;
|
|
171
|
+
/**
|
|
172
|
+
* <p>The maximum number of results to return per page.</p>
|
|
173
|
+
* @public
|
|
174
|
+
*/
|
|
175
|
+
maxResults?: number;
|
|
176
|
+
/**
|
|
177
|
+
* <p>The search type to be used against the Knowledge Base for this request. The values can be
|
|
178
|
+
* <code>SEMANTIC</code> which uses vector embeddings or <code>HYBRID</code> which use vector
|
|
179
|
+
* embeddings and raw text</p>
|
|
180
|
+
* @public
|
|
181
|
+
*/
|
|
182
|
+
overrideKnowledgeBaseSearchType?: KnowledgeBaseSearchType;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* <p>A typed union of the data of the configuration for an Amazon Q in Connect Assistant
|
|
186
|
+
* Association.</p>
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
export type AssociationConfigurationData = AssociationConfigurationData.KnowledgeBaseAssociationConfigurationDataMember | AssociationConfigurationData.$UnknownMember;
|
|
190
|
+
/**
|
|
191
|
+
* @public
|
|
192
|
+
*/
|
|
193
|
+
export declare namespace AssociationConfigurationData {
|
|
194
|
+
/**
|
|
195
|
+
* <p>The data of the configuration for a <code>KNOWLEDGE_BASE</code> type Amazon Q in Connect Assistant
|
|
196
|
+
* Association.</p>
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
interface KnowledgeBaseAssociationConfigurationDataMember {
|
|
200
|
+
knowledgeBaseAssociationConfigurationData: KnowledgeBaseAssociationConfigurationData;
|
|
201
|
+
$unknown?: never;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* @public
|
|
205
|
+
*/
|
|
206
|
+
interface $UnknownMember {
|
|
207
|
+
knowledgeBaseAssociationConfigurationData?: never;
|
|
208
|
+
$unknown: [string, any];
|
|
209
|
+
}
|
|
210
|
+
interface Visitor<T> {
|
|
211
|
+
knowledgeBaseAssociationConfigurationData: (value: KnowledgeBaseAssociationConfigurationData) => T;
|
|
212
|
+
_: (name: string, value: any) => T;
|
|
213
|
+
}
|
|
214
|
+
const visit: <T>(value: AssociationConfigurationData, visitor: Visitor<T>) => T;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* @public
|
|
218
|
+
* @enum
|
|
219
|
+
*/
|
|
220
|
+
export declare const AIAgentAssociationConfigurationType: {
|
|
221
|
+
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
222
|
+
};
|
|
223
|
+
/**
|
|
224
|
+
* @public
|
|
225
|
+
*/
|
|
226
|
+
export type AIAgentAssociationConfigurationType = (typeof AIAgentAssociationConfigurationType)[keyof typeof AIAgentAssociationConfigurationType];
|
|
227
|
+
/**
|
|
228
|
+
* <p>The configuration for an Amazon Q in Connect Assistant Association.</p>
|
|
229
|
+
* @public
|
|
230
|
+
*/
|
|
231
|
+
export interface AssociationConfiguration {
|
|
232
|
+
/**
|
|
233
|
+
* <p>The identifier of the association for this Association Configuration.</p>
|
|
234
|
+
* @public
|
|
235
|
+
*/
|
|
236
|
+
associationId?: string;
|
|
237
|
+
/**
|
|
238
|
+
* <p>The type of the association for this Association Configuration.</p>
|
|
239
|
+
* @public
|
|
240
|
+
*/
|
|
241
|
+
associationType?: AIAgentAssociationConfigurationType;
|
|
242
|
+
/**
|
|
243
|
+
* <p>The data of the configuration for an Amazon Q in Connect Assistant Association.</p>
|
|
244
|
+
* @public
|
|
245
|
+
*/
|
|
246
|
+
associationConfigurationData?: AssociationConfigurationData;
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* <p>The configuration for the <code>ANSWER_RECOMMENDATION</code> AI Agent type.</p>
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
252
|
+
export interface AnswerRecommendationAIAgentConfiguration {
|
|
253
|
+
/**
|
|
254
|
+
* <p>The AI Prompt identifier for the Intent Labeling prompt used by the
|
|
255
|
+
* <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
|
|
256
|
+
* @public
|
|
257
|
+
*/
|
|
258
|
+
intentLabelingGenerationAIPromptId?: string;
|
|
259
|
+
/**
|
|
260
|
+
* <p>The AI Prompt identifier for the Query Reformulation prompt used by the
|
|
261
|
+
* <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
|
|
262
|
+
* @public
|
|
263
|
+
*/
|
|
264
|
+
queryReformulationAIPromptId?: string;
|
|
265
|
+
/**
|
|
266
|
+
* <p>The AI Prompt identifier for the Answer Generation prompt used by the
|
|
267
|
+
* <code>ANSWER_RECOMMENDATION</code> AI Agent.</p>
|
|
268
|
+
* @public
|
|
269
|
+
*/
|
|
270
|
+
answerGenerationAIPromptId?: string;
|
|
271
|
+
/**
|
|
272
|
+
* <p>The association configurations for overriding behavior on this AI Agent.</p>
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
associationConfigurations?: AssociationConfiguration[];
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* <p>The configuration for the <code>MANUAL_SEARCH</code> AI Agent type.</p>
|
|
279
|
+
* @public
|
|
280
|
+
*/
|
|
281
|
+
export interface ManualSearchAIAgentConfiguration {
|
|
282
|
+
/**
|
|
283
|
+
* <p>The AI Prompt identifier for the Answer Generation prompt used by the MANUAL_SEARCH AI
|
|
284
|
+
* Agent.</p>
|
|
285
|
+
* @public
|
|
286
|
+
*/
|
|
287
|
+
answerGenerationAIPromptId?: string;
|
|
288
|
+
/**
|
|
289
|
+
* <p>The association configurations for overriding behavior on this AI Agent.</p>
|
|
290
|
+
* @public
|
|
291
|
+
*/
|
|
292
|
+
associationConfigurations?: AssociationConfiguration[];
|
|
293
|
+
}
|
|
294
|
+
/**
|
|
295
|
+
* <p>A typed union that specifies the configuration based on the type of AI Agent.</p>
|
|
296
|
+
* @public
|
|
297
|
+
*/
|
|
298
|
+
export type AIAgentConfiguration = AIAgentConfiguration.AnswerRecommendationAIAgentConfigurationMember | AIAgentConfiguration.ManualSearchAIAgentConfigurationMember | AIAgentConfiguration.$UnknownMember;
|
|
299
|
+
/**
|
|
300
|
+
* @public
|
|
301
|
+
*/
|
|
302
|
+
export declare namespace AIAgentConfiguration {
|
|
303
|
+
/**
|
|
304
|
+
* <p>The configuration for AI Agents of type <code>MANUAL_SEARCH</code>.</p>
|
|
305
|
+
* @public
|
|
306
|
+
*/
|
|
307
|
+
interface ManualSearchAIAgentConfigurationMember {
|
|
308
|
+
manualSearchAIAgentConfiguration: ManualSearchAIAgentConfiguration;
|
|
309
|
+
answerRecommendationAIAgentConfiguration?: never;
|
|
310
|
+
$unknown?: never;
|
|
311
|
+
}
|
|
312
|
+
/**
|
|
313
|
+
* <p>The configuration for AI Agents of type <code>ANSWER_RECOMMENDATION</code>.</p>
|
|
314
|
+
* @public
|
|
315
|
+
*/
|
|
316
|
+
interface AnswerRecommendationAIAgentConfigurationMember {
|
|
317
|
+
manualSearchAIAgentConfiguration?: never;
|
|
318
|
+
answerRecommendationAIAgentConfiguration: AnswerRecommendationAIAgentConfiguration;
|
|
319
|
+
$unknown?: never;
|
|
320
|
+
}
|
|
321
|
+
/**
|
|
322
|
+
* @public
|
|
323
|
+
*/
|
|
324
|
+
interface $UnknownMember {
|
|
325
|
+
manualSearchAIAgentConfiguration?: never;
|
|
326
|
+
answerRecommendationAIAgentConfiguration?: never;
|
|
327
|
+
$unknown: [string, any];
|
|
328
|
+
}
|
|
329
|
+
interface Visitor<T> {
|
|
330
|
+
manualSearchAIAgentConfiguration: (value: ManualSearchAIAgentConfiguration) => T;
|
|
331
|
+
answerRecommendationAIAgentConfiguration: (value: AnswerRecommendationAIAgentConfiguration) => T;
|
|
332
|
+
_: (name: string, value: any) => T;
|
|
333
|
+
}
|
|
334
|
+
const visit: <T>(value: AIAgentConfiguration, visitor: Visitor<T>) => T;
|
|
335
|
+
}
|
|
336
|
+
/**
|
|
337
|
+
* @public
|
|
338
|
+
* @enum
|
|
339
|
+
*/
|
|
340
|
+
export declare const AIAgentType: {
|
|
341
|
+
readonly ANSWER_RECOMMENDATION: "ANSWER_RECOMMENDATION";
|
|
342
|
+
readonly MANUAL_SEARCH: "MANUAL_SEARCH";
|
|
343
|
+
};
|
|
344
|
+
/**
|
|
345
|
+
* @public
|
|
346
|
+
*/
|
|
347
|
+
export type AIAgentType = (typeof AIAgentType)[keyof typeof AIAgentType];
|
|
348
|
+
/**
|
|
349
|
+
* @public
|
|
350
|
+
* @enum
|
|
351
|
+
*/
|
|
352
|
+
export declare const VisibilityStatus: {
|
|
353
|
+
readonly PUBLISHED: "PUBLISHED";
|
|
354
|
+
readonly SAVED: "SAVED";
|
|
355
|
+
};
|
|
356
|
+
/**
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
export type VisibilityStatus = (typeof VisibilityStatus)[keyof typeof VisibilityStatus];
|
|
360
|
+
/**
|
|
361
|
+
* @public
|
|
362
|
+
*/
|
|
363
|
+
export interface CreateAIAgentRequest {
|
|
364
|
+
/**
|
|
365
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
366
|
+
* request. If not provided, the AWS SDK populates this field. For more information about
|
|
367
|
+
* idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
368
|
+
* @public
|
|
369
|
+
*/
|
|
370
|
+
clientToken?: string;
|
|
371
|
+
/**
|
|
372
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
373
|
+
* cannot contain the ARN.</p>
|
|
374
|
+
* @public
|
|
375
|
+
*/
|
|
376
|
+
assistantId: string | undefined;
|
|
377
|
+
/**
|
|
378
|
+
* <p>The name of the AI Agent.</p>
|
|
379
|
+
* @public
|
|
380
|
+
*/
|
|
381
|
+
name: string | undefined;
|
|
382
|
+
/**
|
|
383
|
+
* <p>The type of the AI Agent.</p>
|
|
384
|
+
* @public
|
|
385
|
+
*/
|
|
386
|
+
type: AIAgentType | undefined;
|
|
387
|
+
/**
|
|
388
|
+
* <p>The configuration of the AI Agent.</p>
|
|
389
|
+
* @public
|
|
390
|
+
*/
|
|
391
|
+
configuration: AIAgentConfiguration | undefined;
|
|
392
|
+
/**
|
|
393
|
+
* <p>The visibility status of the AI Agent.</p>
|
|
394
|
+
* @public
|
|
395
|
+
*/
|
|
396
|
+
visibilityStatus: VisibilityStatus | undefined;
|
|
397
|
+
/**
|
|
398
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
399
|
+
* @public
|
|
400
|
+
*/
|
|
401
|
+
tags?: Record<string, string>;
|
|
402
|
+
/**
|
|
403
|
+
* <p>The description of the AI Agent.</p>
|
|
404
|
+
* @public
|
|
405
|
+
*/
|
|
406
|
+
description?: string;
|
|
407
|
+
}
|
|
408
|
+
/**
|
|
409
|
+
* @public
|
|
410
|
+
* @enum
|
|
411
|
+
*/
|
|
412
|
+
export declare const Origin: {
|
|
413
|
+
readonly CUSTOMER: "CUSTOMER";
|
|
414
|
+
readonly SYSTEM: "SYSTEM";
|
|
415
|
+
};
|
|
416
|
+
/**
|
|
417
|
+
* @public
|
|
418
|
+
*/
|
|
419
|
+
export type Origin = (typeof Origin)[keyof typeof Origin];
|
|
420
|
+
/**
|
|
421
|
+
* @public
|
|
422
|
+
* @enum
|
|
423
|
+
*/
|
|
424
|
+
export declare const Status: {
|
|
425
|
+
readonly ACTIVE: "ACTIVE";
|
|
426
|
+
readonly CREATE_FAILED: "CREATE_FAILED";
|
|
427
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
428
|
+
readonly DELETED: "DELETED";
|
|
429
|
+
readonly DELETE_FAILED: "DELETE_FAILED";
|
|
430
|
+
readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
|
|
431
|
+
};
|
|
432
|
+
/**
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
export type Status = (typeof Status)[keyof typeof Status];
|
|
436
|
+
/**
|
|
437
|
+
* <p>The data for the AI Agent.</p>
|
|
438
|
+
* @public
|
|
439
|
+
*/
|
|
440
|
+
export interface AIAgentData {
|
|
441
|
+
/**
|
|
442
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
443
|
+
* cannot contain the ARN.</p>
|
|
444
|
+
* @public
|
|
445
|
+
*/
|
|
446
|
+
assistantId: string | undefined;
|
|
447
|
+
/**
|
|
448
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>
|
|
449
|
+
* @public
|
|
450
|
+
*/
|
|
451
|
+
assistantArn: string | undefined;
|
|
452
|
+
/**
|
|
453
|
+
* <p>The identifier of the AI Agent.</p>
|
|
454
|
+
* @public
|
|
455
|
+
*/
|
|
456
|
+
aiAgentId: string | undefined;
|
|
457
|
+
/**
|
|
458
|
+
* <p>The Amazon Resource Name (ARN) of the AI agent.</p>
|
|
459
|
+
* @public
|
|
460
|
+
*/
|
|
461
|
+
aiAgentArn: string | undefined;
|
|
462
|
+
/**
|
|
463
|
+
* <p>The name of the AI Agent.</p>
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
466
|
+
name: string | undefined;
|
|
467
|
+
/**
|
|
468
|
+
* <p>The type of the AI Agent.</p>
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
type: AIAgentType | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* <p>Configuration for the AI Agent.</p>
|
|
474
|
+
* @public
|
|
475
|
+
*/
|
|
476
|
+
configuration: AIAgentConfiguration | undefined;
|
|
477
|
+
/**
|
|
478
|
+
* <p>The time the AI Agent was last modified.</p>
|
|
479
|
+
* @public
|
|
480
|
+
*/
|
|
481
|
+
modifiedTime?: Date;
|
|
482
|
+
/**
|
|
483
|
+
* <p>The description of the AI Agent.</p>
|
|
484
|
+
* @public
|
|
485
|
+
*/
|
|
486
|
+
description?: string;
|
|
487
|
+
/**
|
|
488
|
+
* <p>The visibility status of the AI Agent.</p>
|
|
489
|
+
* @public
|
|
490
|
+
*/
|
|
491
|
+
visibilityStatus: VisibilityStatus | undefined;
|
|
492
|
+
/**
|
|
493
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
494
|
+
* @public
|
|
495
|
+
*/
|
|
496
|
+
tags?: Record<string, string>;
|
|
497
|
+
/**
|
|
498
|
+
* <p>Specifies the origin of the AI Agent. <code>SYSTEM</code> for a default AI Agent created
|
|
499
|
+
* by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation
|
|
500
|
+
* APIs. </p>
|
|
501
|
+
* @public
|
|
502
|
+
*/
|
|
503
|
+
origin?: Origin;
|
|
504
|
+
/**
|
|
505
|
+
* <p>The status of the AI Agent.</p>
|
|
506
|
+
* @public
|
|
507
|
+
*/
|
|
508
|
+
status?: Status;
|
|
509
|
+
}
|
|
510
|
+
/**
|
|
511
|
+
* @public
|
|
512
|
+
*/
|
|
513
|
+
export interface CreateAIAgentResponse {
|
|
514
|
+
/**
|
|
515
|
+
* <p>The data of the created AI Agent.</p>
|
|
516
|
+
* @public
|
|
517
|
+
*/
|
|
518
|
+
aiAgent?: AIAgentData;
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* <p>The specified resource does not exist.</p>
|
|
522
|
+
* @public
|
|
523
|
+
*/
|
|
524
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
525
|
+
readonly name: "ResourceNotFoundException";
|
|
526
|
+
readonly $fault: "client";
|
|
527
|
+
/**
|
|
528
|
+
* <p>The specified resource name.</p>
|
|
529
|
+
* @public
|
|
530
|
+
*/
|
|
531
|
+
resourceName?: string;
|
|
532
|
+
/**
|
|
533
|
+
* @internal
|
|
534
|
+
*/
|
|
535
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
536
|
+
}
|
|
537
|
+
/**
|
|
538
|
+
* <p>You've exceeded your service quota. To perform the requested action, remove some of the
|
|
539
|
+
* relevant resources, or use service quotas to request a service quota increase.</p>
|
|
540
|
+
* @public
|
|
541
|
+
*/
|
|
542
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
543
|
+
readonly name: "ServiceQuotaExceededException";
|
|
544
|
+
readonly $fault: "client";
|
|
545
|
+
/**
|
|
546
|
+
* @internal
|
|
547
|
+
*/
|
|
548
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
549
|
+
}
|
|
550
|
+
/**
|
|
551
|
+
* <p>The throttling limit has been exceeded.</p>
|
|
552
|
+
* @public
|
|
553
|
+
*/
|
|
554
|
+
export declare class ThrottlingException extends __BaseException {
|
|
555
|
+
readonly name: "ThrottlingException";
|
|
556
|
+
readonly $fault: "client";
|
|
557
|
+
$retryable: {};
|
|
558
|
+
/**
|
|
559
|
+
* @internal
|
|
560
|
+
*/
|
|
561
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
565
|
+
* @public
|
|
566
|
+
*/
|
|
567
|
+
export declare class ValidationException extends __BaseException {
|
|
568
|
+
readonly name: "ValidationException";
|
|
569
|
+
readonly $fault: "client";
|
|
570
|
+
/**
|
|
571
|
+
* @internal
|
|
572
|
+
*/
|
|
573
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
574
|
+
}
|
|
575
|
+
/**
|
|
576
|
+
* @public
|
|
577
|
+
*/
|
|
578
|
+
export interface CreateAIAgentVersionRequest {
|
|
579
|
+
/**
|
|
580
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
581
|
+
* cannot contain the ARN.</p>
|
|
582
|
+
* @public
|
|
583
|
+
*/
|
|
584
|
+
assistantId: string | undefined;
|
|
585
|
+
/**
|
|
586
|
+
* <p>The identifier of the Amazon Q in Connect AI Agent.</p>
|
|
587
|
+
* @public
|
|
588
|
+
*/
|
|
589
|
+
aiAgentId: string | undefined;
|
|
590
|
+
/**
|
|
591
|
+
* <p>The modification time of the AI Agent should be tracked for version creation. This field
|
|
592
|
+
* should be specified to avoid version creation when simultaneous update to the underlying AI
|
|
593
|
+
* Agent are possible. The value should be the modifiedTime returned from the request to create
|
|
594
|
+
* or update an AI Agent so that version creation can fail if an update to the AI Agent post the
|
|
595
|
+
* specified modification time has been made.</p>
|
|
596
|
+
* @public
|
|
597
|
+
*/
|
|
598
|
+
modifiedTime?: Date;
|
|
599
|
+
/**
|
|
600
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
601
|
+
* request. If not provided, the AWS SDK populates this field. For more information about
|
|
602
|
+
* idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
603
|
+
* @public
|
|
604
|
+
*/
|
|
605
|
+
clientToken?: string;
|
|
606
|
+
}
|
|
607
|
+
/**
|
|
608
|
+
* @public
|
|
609
|
+
*/
|
|
610
|
+
export interface CreateAIAgentVersionResponse {
|
|
611
|
+
/**
|
|
612
|
+
* <p>The data of the AI Agent version.</p>
|
|
613
|
+
* @public
|
|
614
|
+
*/
|
|
615
|
+
aiAgent?: AIAgentData;
|
|
616
|
+
/**
|
|
617
|
+
* <p>The version number of the AI Agent version.</p>
|
|
618
|
+
* @public
|
|
619
|
+
*/
|
|
620
|
+
versionNumber?: number;
|
|
621
|
+
}
|
|
622
|
+
/**
|
|
623
|
+
* @public
|
|
624
|
+
*/
|
|
625
|
+
export interface DeleteAIAgentRequest {
|
|
626
|
+
/**
|
|
627
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
628
|
+
* cannot contain the ARN.</p>
|
|
629
|
+
* @public
|
|
630
|
+
*/
|
|
631
|
+
assistantId: string | undefined;
|
|
632
|
+
/**
|
|
633
|
+
* <p>The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs
|
|
634
|
+
* cannot contain the ARN.</p>
|
|
635
|
+
* @public
|
|
636
|
+
*/
|
|
637
|
+
aiAgentId: string | undefined;
|
|
638
|
+
}
|
|
639
|
+
/**
|
|
640
|
+
* @public
|
|
641
|
+
*/
|
|
642
|
+
export interface DeleteAIAgentResponse {
|
|
643
|
+
}
|
|
644
|
+
/**
|
|
645
|
+
* @public
|
|
646
|
+
*/
|
|
647
|
+
export interface DeleteAIAgentVersionRequest {
|
|
648
|
+
/**
|
|
649
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
650
|
+
* cannot contain the ARN.</p>
|
|
651
|
+
* @public
|
|
652
|
+
*/
|
|
653
|
+
assistantId: string | undefined;
|
|
654
|
+
/**
|
|
655
|
+
* <p>The identifier of the Amazon Q in Connect AI Agent. Can be either the ID or the ARN. URLs
|
|
656
|
+
* cannot contain the ARN.</p>
|
|
657
|
+
* @public
|
|
658
|
+
*/
|
|
659
|
+
aiAgentId: string | undefined;
|
|
660
|
+
/**
|
|
661
|
+
* <p>The version number of the AI Agent version.</p>
|
|
662
|
+
* @public
|
|
663
|
+
*/
|
|
664
|
+
versionNumber: number | undefined;
|
|
665
|
+
}
|
|
666
|
+
/**
|
|
667
|
+
* @public
|
|
668
|
+
*/
|
|
669
|
+
export interface DeleteAIAgentVersionResponse {
|
|
670
|
+
}
|
|
671
|
+
/**
|
|
672
|
+
* @public
|
|
673
|
+
*/
|
|
674
|
+
export interface GetAIAgentRequest {
|
|
675
|
+
/**
|
|
676
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
677
|
+
* cannot contain the ARN.</p>
|
|
678
|
+
* @public
|
|
679
|
+
*/
|
|
680
|
+
assistantId: string | undefined;
|
|
681
|
+
/**
|
|
682
|
+
* <p>The identifier of the Amazon Q in Connect AI Agent (with or without a version qualifier).
|
|
683
|
+
* Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
684
|
+
* @public
|
|
685
|
+
*/
|
|
686
|
+
aiAgentId: string | undefined;
|
|
687
|
+
}
|
|
688
|
+
/**
|
|
689
|
+
* @public
|
|
690
|
+
*/
|
|
691
|
+
export interface GetAIAgentResponse {
|
|
692
|
+
/**
|
|
693
|
+
* <p>The data of the AI Agent.</p>
|
|
694
|
+
* @public
|
|
695
|
+
*/
|
|
696
|
+
aiAgent?: AIAgentData;
|
|
697
|
+
/**
|
|
698
|
+
* <p>The version number of the AI Agent version (returned if an AI Agent version was specified
|
|
699
|
+
* via use of a qualifier for the <code>aiAgentId</code> on the request). </p>
|
|
700
|
+
* @public
|
|
701
|
+
*/
|
|
702
|
+
versionNumber?: number;
|
|
703
|
+
}
|
|
704
|
+
/**
|
|
705
|
+
* @public
|
|
706
|
+
*/
|
|
707
|
+
export interface ListAIAgentsRequest {
|
|
708
|
+
/**
|
|
709
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
710
|
+
* cannot contain the ARN.</p>
|
|
711
|
+
* @public
|
|
712
|
+
*/
|
|
713
|
+
assistantId: string | undefined;
|
|
714
|
+
/**
|
|
715
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
716
|
+
* the next request to retrieve the next set of results.</p>
|
|
717
|
+
* @public
|
|
718
|
+
*/
|
|
719
|
+
nextToken?: string;
|
|
720
|
+
/**
|
|
721
|
+
* <p>The maximum number of results to return per page.</p>
|
|
722
|
+
* @public
|
|
723
|
+
*/
|
|
724
|
+
maxResults?: number;
|
|
725
|
+
/**
|
|
726
|
+
* <p>The origin of the AI Agents to be listed. <code>SYSTEM</code> for a default AI Agent
|
|
727
|
+
* created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent
|
|
728
|
+
* creation APIs. </p>
|
|
729
|
+
* @public
|
|
730
|
+
*/
|
|
731
|
+
origin?: Origin;
|
|
732
|
+
}
|
|
733
|
+
/**
|
|
734
|
+
* <p>The summary of the AI Agent.</p>
|
|
735
|
+
* @public
|
|
736
|
+
*/
|
|
737
|
+
export interface AIAgentSummary {
|
|
738
|
+
/**
|
|
739
|
+
* <p>The name of the AI Agent.</p>
|
|
740
|
+
* @public
|
|
741
|
+
*/
|
|
742
|
+
name: string | undefined;
|
|
743
|
+
/**
|
|
744
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
745
|
+
* cannot contain the ARN.</p>
|
|
746
|
+
* @public
|
|
747
|
+
*/
|
|
748
|
+
assistantId: string | undefined;
|
|
749
|
+
/**
|
|
750
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>
|
|
751
|
+
* @public
|
|
752
|
+
*/
|
|
753
|
+
assistantArn: string | undefined;
|
|
754
|
+
/**
|
|
755
|
+
* <p>The identifier of the AI Agent.</p>
|
|
756
|
+
* @public
|
|
757
|
+
*/
|
|
758
|
+
aiAgentId: string | undefined;
|
|
759
|
+
/**
|
|
760
|
+
* <p>The type of the AI Agent.</p>
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
type: AIAgentType | undefined;
|
|
764
|
+
/**
|
|
765
|
+
* <p>The Amazon Resource Name (ARN) of the AI agent.</p>
|
|
766
|
+
* @public
|
|
767
|
+
*/
|
|
768
|
+
aiAgentArn: string | undefined;
|
|
769
|
+
/**
|
|
770
|
+
* <p>The time the AI Agent was last modified.</p>
|
|
771
|
+
* @public
|
|
772
|
+
*/
|
|
773
|
+
modifiedTime?: Date;
|
|
774
|
+
/**
|
|
775
|
+
* <p>The visibility status of the AI Agent.</p>
|
|
776
|
+
* @public
|
|
777
|
+
*/
|
|
778
|
+
visibilityStatus: VisibilityStatus | undefined;
|
|
779
|
+
/**
|
|
780
|
+
* <p>The configuration for the AI Agent.</p>
|
|
781
|
+
* @public
|
|
782
|
+
*/
|
|
783
|
+
configuration?: AIAgentConfiguration;
|
|
784
|
+
/**
|
|
785
|
+
* <p>The origin of the AI Agent. <code>SYSTEM</code> for a default AI Agent created by Q in
|
|
786
|
+
* Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent creation
|
|
787
|
+
* APIs.</p>
|
|
788
|
+
* @public
|
|
789
|
+
*/
|
|
790
|
+
origin?: Origin;
|
|
791
|
+
/**
|
|
792
|
+
* <p>The description of the AI Agent.</p>
|
|
793
|
+
* @public
|
|
794
|
+
*/
|
|
795
|
+
description?: string;
|
|
796
|
+
/**
|
|
797
|
+
* <p>The status of the AI Agent.</p>
|
|
798
|
+
* @public
|
|
799
|
+
*/
|
|
800
|
+
status?: Status;
|
|
801
|
+
/**
|
|
802
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
803
|
+
* @public
|
|
804
|
+
*/
|
|
805
|
+
tags?: Record<string, string>;
|
|
806
|
+
}
|
|
807
|
+
/**
|
|
808
|
+
* @public
|
|
809
|
+
*/
|
|
810
|
+
export interface ListAIAgentsResponse {
|
|
811
|
+
/**
|
|
812
|
+
* <p>The summaries of AI Agents.</p>
|
|
813
|
+
* @public
|
|
814
|
+
*/
|
|
815
|
+
aiAgentSummaries: AIAgentSummary[] | undefined;
|
|
816
|
+
/**
|
|
817
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
818
|
+
* the next request to retrieve the next set of results.</p>
|
|
819
|
+
* @public
|
|
820
|
+
*/
|
|
821
|
+
nextToken?: string;
|
|
822
|
+
}
|
|
823
|
+
/**
|
|
824
|
+
* @public
|
|
825
|
+
*/
|
|
826
|
+
export interface ListAIAgentVersionsRequest {
|
|
827
|
+
/**
|
|
828
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
829
|
+
* cannot contain the ARN.</p>
|
|
830
|
+
* @public
|
|
831
|
+
*/
|
|
832
|
+
assistantId: string | undefined;
|
|
833
|
+
/**
|
|
834
|
+
* <p>The identifier of the Amazon Q in Connect AI Agent for which versions are to be
|
|
835
|
+
* listed.</p>
|
|
836
|
+
* @public
|
|
837
|
+
*/
|
|
838
|
+
aiAgentId: string | undefined;
|
|
839
|
+
/**
|
|
840
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
841
|
+
* the next request to retrieve the next set of results.</p>
|
|
842
|
+
* @public
|
|
843
|
+
*/
|
|
844
|
+
nextToken?: string;
|
|
845
|
+
/**
|
|
846
|
+
* <p>The maximum number of results to return per page.</p>
|
|
847
|
+
* @public
|
|
848
|
+
*/
|
|
849
|
+
maxResults?: number;
|
|
850
|
+
/**
|
|
851
|
+
* <p>The origin of the AI Agent versions to be listed. <code>SYSTEM</code> for a default AI
|
|
852
|
+
* Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI
|
|
853
|
+
* Agent creation APIs. </p>
|
|
854
|
+
* @public
|
|
855
|
+
*/
|
|
856
|
+
origin?: Origin;
|
|
857
|
+
}
|
|
858
|
+
/**
|
|
859
|
+
* <p>The summary of the AI Agent version.</p>
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
export interface AIAgentVersionSummary {
|
|
863
|
+
/**
|
|
864
|
+
* <p>The data for the summary of the AI Agent version.</p>
|
|
865
|
+
* @public
|
|
866
|
+
*/
|
|
867
|
+
aiAgentSummary?: AIAgentSummary;
|
|
868
|
+
/**
|
|
869
|
+
* <p>The version number for this AI Agent version.</p>
|
|
870
|
+
* @public
|
|
871
|
+
*/
|
|
872
|
+
versionNumber?: number;
|
|
873
|
+
}
|
|
874
|
+
/**
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
export interface ListAIAgentVersionsResponse {
|
|
878
|
+
/**
|
|
879
|
+
* <p>The summaries of AI Agent versions.</p>
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
aiAgentVersionSummaries: AIAgentVersionSummary[] | undefined;
|
|
883
|
+
/**
|
|
884
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
885
|
+
* the next request to retrieve the next set of results.</p>
|
|
886
|
+
* @public
|
|
887
|
+
*/
|
|
888
|
+
nextToken?: string;
|
|
889
|
+
}
|
|
890
|
+
/**
|
|
891
|
+
* @public
|
|
892
|
+
*/
|
|
893
|
+
export interface UpdateAIAgentRequest {
|
|
894
|
+
/**
|
|
895
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
896
|
+
* request. If not provided, the AWS SDK populates this field. For more information about
|
|
897
|
+
* idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
898
|
+
* @public
|
|
899
|
+
*/
|
|
900
|
+
clientToken?: string;
|
|
901
|
+
/**
|
|
902
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
903
|
+
* cannot contain the ARN.</p>
|
|
904
|
+
* @public
|
|
905
|
+
*/
|
|
906
|
+
assistantId: string | undefined;
|
|
907
|
+
/**
|
|
908
|
+
* <p>The identifier of the Amazon Q in Connect AI Agent.</p>
|
|
909
|
+
* @public
|
|
910
|
+
*/
|
|
911
|
+
aiAgentId: string | undefined;
|
|
912
|
+
/**
|
|
913
|
+
* <p>The visbility status of the Amazon Q in Connect AI Agent.</p>
|
|
914
|
+
* @public
|
|
915
|
+
*/
|
|
916
|
+
visibilityStatus: VisibilityStatus | undefined;
|
|
917
|
+
/**
|
|
918
|
+
* <p>The configuration of the Amazon Q in Connect AI Agent.</p>
|
|
919
|
+
* @public
|
|
920
|
+
*/
|
|
921
|
+
configuration?: AIAgentConfiguration;
|
|
922
|
+
/**
|
|
923
|
+
* <p>The description of the Amazon Q in Connect AI Agent.</p>
|
|
924
|
+
* @public
|
|
925
|
+
*/
|
|
926
|
+
description?: string;
|
|
927
|
+
}
|
|
928
|
+
/**
|
|
929
|
+
* @public
|
|
930
|
+
*/
|
|
931
|
+
export interface UpdateAIAgentResponse {
|
|
932
|
+
/**
|
|
933
|
+
* <p>The data of the updated Amazon Q in Connect AI Agent.</p>
|
|
934
|
+
* @public
|
|
935
|
+
*/
|
|
936
|
+
aiAgent?: AIAgentData;
|
|
937
|
+
}
|
|
938
|
+
/**
|
|
939
|
+
* <p>A type that specifies the AI Agent ID configuration data when mapping an AI Agents to be
|
|
940
|
+
* used for an AI Agent type on a session or assistant.</p>
|
|
941
|
+
* @public
|
|
942
|
+
*/
|
|
943
|
+
export interface AIAgentConfigurationData {
|
|
944
|
+
/**
|
|
945
|
+
* <p>The ID of the AI Agent to be configured.</p>
|
|
946
|
+
* @public
|
|
947
|
+
*/
|
|
948
|
+
aiAgentId: string | undefined;
|
|
949
|
+
}
|
|
950
|
+
/**
|
|
951
|
+
* @public
|
|
952
|
+
* @enum
|
|
953
|
+
*/
|
|
954
|
+
export declare const AIPromptAPIFormat: {
|
|
955
|
+
readonly ANTHROPIC_CLAUDE_MESSAGES: "ANTHROPIC_CLAUDE_MESSAGES";
|
|
956
|
+
readonly ANTHROPIC_CLAUDE_TEXT_COMPLETIONS: "ANTHROPIC_CLAUDE_TEXT_COMPLETIONS";
|
|
957
|
+
};
|
|
958
|
+
/**
|
|
959
|
+
* @public
|
|
960
|
+
*/
|
|
961
|
+
export type AIPromptAPIFormat = (typeof AIPromptAPIFormat)[keyof typeof AIPromptAPIFormat];
|
|
962
|
+
/**
|
|
963
|
+
* <p>The configuration for a prompt template that supports full textual prompt configuration
|
|
964
|
+
* using a YAML prompt.</p>
|
|
965
|
+
* @public
|
|
966
|
+
*/
|
|
967
|
+
export interface TextFullAIPromptEditTemplateConfiguration {
|
|
968
|
+
/**
|
|
969
|
+
* <p>The YAML text for the AI Prompt template.</p>
|
|
970
|
+
* @public
|
|
971
|
+
*/
|
|
972
|
+
text: string | undefined;
|
|
973
|
+
}
|
|
974
|
+
/**
|
|
975
|
+
* <p>A typed union that specifies the configuration for a prompt template based on its
|
|
976
|
+
* type.</p>
|
|
977
|
+
* @public
|
|
978
|
+
*/
|
|
979
|
+
export type AIPromptTemplateConfiguration = AIPromptTemplateConfiguration.TextFullAIPromptEditTemplateConfigurationMember | AIPromptTemplateConfiguration.$UnknownMember;
|
|
980
|
+
/**
|
|
981
|
+
* @public
|
|
982
|
+
*/
|
|
983
|
+
export declare namespace AIPromptTemplateConfiguration {
|
|
984
|
+
/**
|
|
985
|
+
* <p>The configuration for a prompt template that supports full textual prompt configuration
|
|
986
|
+
* using a YAML prompt.</p>
|
|
987
|
+
* @public
|
|
988
|
+
*/
|
|
989
|
+
interface TextFullAIPromptEditTemplateConfigurationMember {
|
|
990
|
+
textFullAIPromptEditTemplateConfiguration: TextFullAIPromptEditTemplateConfiguration;
|
|
991
|
+
$unknown?: never;
|
|
992
|
+
}
|
|
993
|
+
/**
|
|
994
|
+
* @public
|
|
995
|
+
*/
|
|
996
|
+
interface $UnknownMember {
|
|
997
|
+
textFullAIPromptEditTemplateConfiguration?: never;
|
|
998
|
+
$unknown: [string, any];
|
|
999
|
+
}
|
|
1000
|
+
interface Visitor<T> {
|
|
1001
|
+
textFullAIPromptEditTemplateConfiguration: (value: TextFullAIPromptEditTemplateConfiguration) => T;
|
|
1002
|
+
_: (name: string, value: any) => T;
|
|
1003
|
+
}
|
|
1004
|
+
const visit: <T>(value: AIPromptTemplateConfiguration, visitor: Visitor<T>) => T;
|
|
1005
|
+
}
|
|
1006
|
+
/**
|
|
1007
|
+
* @public
|
|
1008
|
+
* @enum
|
|
1009
|
+
*/
|
|
1010
|
+
export declare const AIPromptTemplateType: {
|
|
1011
|
+
readonly TEXT: "TEXT";
|
|
1012
|
+
};
|
|
1013
|
+
/**
|
|
1014
|
+
* @public
|
|
1015
|
+
*/
|
|
1016
|
+
export type AIPromptTemplateType = (typeof AIPromptTemplateType)[keyof typeof AIPromptTemplateType];
|
|
1017
|
+
/**
|
|
1018
|
+
* @public
|
|
1019
|
+
* @enum
|
|
1020
|
+
*/
|
|
1021
|
+
export declare const AIPromptType: {
|
|
1022
|
+
readonly ANSWER_GENERATION: "ANSWER_GENERATION";
|
|
1023
|
+
readonly INTENT_LABELING_GENERATION: "INTENT_LABELING_GENERATION";
|
|
1024
|
+
readonly QUERY_REFORMULATION: "QUERY_REFORMULATION";
|
|
1025
|
+
};
|
|
1026
|
+
/**
|
|
1027
|
+
* @public
|
|
1028
|
+
*/
|
|
1029
|
+
export type AIPromptType = (typeof AIPromptType)[keyof typeof AIPromptType];
|
|
1030
|
+
/**
|
|
1031
|
+
* @public
|
|
1032
|
+
*/
|
|
1033
|
+
export interface CreateAIPromptRequest {
|
|
1034
|
+
/**
|
|
1035
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1036
|
+
* request. If not provided, the AWS SDK populates this field. For more information about
|
|
1037
|
+
* idempotency, see <a href="http://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1038
|
+
* @public
|
|
1039
|
+
*/
|
|
1040
|
+
clientToken?: string;
|
|
1041
|
+
/**
|
|
1042
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1043
|
+
* cannot contain the ARN.</p>
|
|
1044
|
+
* @public
|
|
1045
|
+
*/
|
|
1046
|
+
assistantId: string | undefined;
|
|
1047
|
+
/**
|
|
1048
|
+
* <p>The name of the AI Prompt.</p>
|
|
1049
|
+
* @public
|
|
1050
|
+
*/
|
|
1051
|
+
name: string | undefined;
|
|
1052
|
+
/**
|
|
1053
|
+
* <p>The type of this AI Prompt.</p>
|
|
1054
|
+
* @public
|
|
1055
|
+
*/
|
|
1056
|
+
type: AIPromptType | undefined;
|
|
1057
|
+
/**
|
|
1058
|
+
* <p>The configuration of the prompt template for this AI Prompt.</p>
|
|
1059
|
+
* @public
|
|
1060
|
+
*/
|
|
1061
|
+
templateConfiguration: AIPromptTemplateConfiguration | undefined;
|
|
1062
|
+
/**
|
|
1063
|
+
* <p>The visibility status of the AI Prompt.</p>
|
|
1064
|
+
* @public
|
|
1065
|
+
*/
|
|
1066
|
+
visibilityStatus: VisibilityStatus | undefined;
|
|
1067
|
+
/**
|
|
1068
|
+
* <p>The type of the prompt template for this AI Prompt.</p>
|
|
1069
|
+
* @public
|
|
1070
|
+
*/
|
|
1071
|
+
templateType: AIPromptTemplateType | undefined;
|
|
1072
|
+
/**
|
|
1073
|
+
* <p>The identifier of the model used for this AI Prompt. Model Ids supported are:
|
|
1074
|
+
* <code>CLAUDE_3_HAIKU_20240307_V1</code>
|
|
1075
|
+
* </p>
|
|
1076
|
+
* @public
|
|
1077
|
+
*/
|
|
1078
|
+
modelId: string | undefined;
|
|
1079
|
+
/**
|
|
1080
|
+
* <p>The API Format of the AI Prompt.</p>
|
|
1081
|
+
* @public
|
|
1082
|
+
*/
|
|
1083
|
+
apiFormat: AIPromptAPIFormat | undefined;
|
|
1084
|
+
/**
|
|
1085
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1086
|
+
* @public
|
|
1087
|
+
*/
|
|
1088
|
+
tags?: Record<string, string>;
|
|
1089
|
+
/**
|
|
1090
|
+
* <p>The description of the AI Prompt.</p>
|
|
1091
|
+
* @public
|
|
1092
|
+
*/
|
|
1093
|
+
description?: string;
|
|
1094
|
+
}
|
|
1095
|
+
/**
|
|
1096
|
+
* <p>The data for the AI Prompt</p>
|
|
1097
|
+
* @public
|
|
1098
|
+
*/
|
|
1099
|
+
export interface AIPromptData {
|
|
1100
|
+
/**
|
|
1101
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1102
|
+
* cannot contain the ARN.</p>
|
|
1103
|
+
* @public
|
|
1104
|
+
*/
|
|
1105
|
+
assistantId: string | undefined;
|
|
1106
|
+
/**
|
|
1107
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>
|
|
1108
|
+
* @public
|
|
1109
|
+
*/
|
|
1110
|
+
assistantArn: string | undefined;
|
|
1111
|
+
/**
|
|
1112
|
+
* <p>The identifier of the Amazon Q in Connect AI prompt.</p>
|
|
1113
|
+
* @public
|
|
1114
|
+
*/
|
|
1115
|
+
aiPromptId: string | undefined;
|
|
1116
|
+
/**
|
|
1117
|
+
* <p>The Amazon Resource Name (ARN) of the AI Prompt.</p>
|
|
1118
|
+
* @public
|
|
1119
|
+
*/
|
|
1120
|
+
aiPromptArn: string | undefined;
|
|
1121
|
+
/**
|
|
1122
|
+
* <p>The name of the AI Prompt</p>
|
|
1123
|
+
* @public
|
|
1124
|
+
*/
|
|
1125
|
+
name: string | undefined;
|
|
1126
|
+
/**
|
|
1127
|
+
* <p>The type of this AI Prompt.</p>
|
|
1128
|
+
* @public
|
|
1129
|
+
*/
|
|
1130
|
+
type: AIPromptType | undefined;
|
|
1131
|
+
/**
|
|
1132
|
+
* <p>The type of the prompt template for this AI Prompt.</p>
|
|
1133
|
+
* @public
|
|
1134
|
+
*/
|
|
1135
|
+
templateType: AIPromptTemplateType | undefined;
|
|
1136
|
+
/**
|
|
1137
|
+
* <p>The identifier of the model used for this AI Prompt. Model Ids supported are:
|
|
1138
|
+
* <code>CLAUDE_3_HAIKU_20240307_V1</code>.</p>
|
|
1139
|
+
* @public
|
|
1140
|
+
*/
|
|
1141
|
+
modelId: string | undefined;
|
|
1142
|
+
/**
|
|
1143
|
+
* <p>The API format used for this AI Prompt.</p>
|
|
1144
|
+
* @public
|
|
1145
|
+
*/
|
|
1146
|
+
apiFormat: AIPromptAPIFormat | undefined;
|
|
1147
|
+
/**
|
|
1148
|
+
* <p>The configuration of the prompt template for this AI Prompt.</p>
|
|
1149
|
+
* @public
|
|
1150
|
+
*/
|
|
1151
|
+
templateConfiguration: AIPromptTemplateConfiguration | undefined;
|
|
1152
|
+
/**
|
|
1153
|
+
* <p>The time the AI Prompt was last modified.</p>
|
|
1154
|
+
* @public
|
|
1155
|
+
*/
|
|
1156
|
+
modifiedTime?: Date;
|
|
1157
|
+
/**
|
|
1158
|
+
* <p>The description of the AI Prompt.</p>
|
|
1159
|
+
* @public
|
|
1160
|
+
*/
|
|
1161
|
+
description?: string;
|
|
1162
|
+
/**
|
|
1163
|
+
* <p>The visibility status of the AI Prompt.</p>
|
|
1164
|
+
* @public
|
|
1165
|
+
*/
|
|
1166
|
+
visibilityStatus: VisibilityStatus | undefined;
|
|
1167
|
+
/**
|
|
1168
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1169
|
+
* @public
|
|
1170
|
+
*/
|
|
1171
|
+
tags?: Record<string, string>;
|
|
1172
|
+
/**
|
|
1173
|
+
* <p>The origin of the AI Prompt. <code>SYSTEM</code> for a default AI Prompt created by Q in
|
|
1174
|
+
* Connect or <code>CUSTOMER</code> for an AI Prompt created by calling AI Prompt creation APIs.
|
|
1175
|
+
* </p>
|
|
1176
|
+
* @public
|
|
1177
|
+
*/
|
|
1178
|
+
origin?: Origin;
|
|
1179
|
+
/**
|
|
1180
|
+
* <p>The status of the AI Prompt.</p>
|
|
1181
|
+
* @public
|
|
1182
|
+
*/
|
|
1183
|
+
status?: Status;
|
|
1184
|
+
}
|
|
1185
|
+
/**
|
|
1186
|
+
* @public
|
|
1187
|
+
*/
|
|
1188
|
+
export interface CreateAIPromptResponse {
|
|
1189
|
+
/**
|
|
1190
|
+
* <p>The data of the AI Prompt.</p>
|
|
1191
|
+
* @public
|
|
1192
|
+
*/
|
|
1193
|
+
aiPrompt?: AIPromptData;
|
|
1194
|
+
}
|
|
1195
|
+
/**
|
|
1196
|
+
* @public
|
|
1197
|
+
*/
|
|
1198
|
+
export interface CreateAIPromptVersionRequest {
|
|
1199
|
+
/**
|
|
1200
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1201
|
+
* cannot contain the ARN.</p>
|
|
1202
|
+
* @public
|
|
1203
|
+
*/
|
|
1204
|
+
assistantId: string | undefined;
|
|
1205
|
+
/**
|
|
1206
|
+
* <p>The identifier of the Amazon Q in Connect AI prompt.</p>
|
|
1207
|
+
* @public
|
|
1208
|
+
*/
|
|
1209
|
+
aiPromptId: string | undefined;
|
|
1210
|
+
/**
|
|
1211
|
+
* <p>The time the AI Prompt was last modified.</p>
|
|
1212
|
+
* @public
|
|
1213
|
+
*/
|
|
1214
|
+
modifiedTime?: Date;
|
|
1215
|
+
/**
|
|
1216
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1217
|
+
* request. If not provided, the AWS SDK populates this field. For more information about
|
|
1218
|
+
* idempotency, see <a href="http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1219
|
+
* @public
|
|
1220
|
+
*/
|
|
1221
|
+
clientToken?: string;
|
|
1222
|
+
}
|
|
1223
|
+
/**
|
|
1224
|
+
* @public
|
|
1225
|
+
*/
|
|
1226
|
+
export interface CreateAIPromptVersionResponse {
|
|
1227
|
+
/**
|
|
1228
|
+
* <p>The data of the AI Prompt version.</p>
|
|
1229
|
+
* @public
|
|
1230
|
+
*/
|
|
1231
|
+
aiPrompt?: AIPromptData;
|
|
1232
|
+
/**
|
|
1233
|
+
* <p>The version number of the AI Prompt version.</p>
|
|
1234
|
+
* @public
|
|
1235
|
+
*/
|
|
1236
|
+
versionNumber?: number;
|
|
1237
|
+
}
|
|
1238
|
+
/**
|
|
1239
|
+
* @public
|
|
1240
|
+
*/
|
|
1241
|
+
export interface DeleteAIPromptRequest {
|
|
1242
|
+
/**
|
|
1243
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1244
|
+
* cannot contain the ARN.</p>
|
|
1245
|
+
* @public
|
|
1246
|
+
*/
|
|
1247
|
+
assistantId: string | undefined;
|
|
1248
|
+
/**
|
|
1249
|
+
* <p>The identifier of the Amazon Q in Connect AI prompt. Can be either the ID or the ARN. URLs
|
|
1250
|
+
* cannot contain the ARN.</p>
|
|
1251
|
+
* @public
|
|
1252
|
+
*/
|
|
1253
|
+
aiPromptId: string | undefined;
|
|
1254
|
+
}
|
|
1255
|
+
/**
|
|
1256
|
+
* @public
|
|
1257
|
+
*/
|
|
1258
|
+
export interface DeleteAIPromptResponse {
|
|
1259
|
+
}
|
|
1260
|
+
/**
|
|
1261
|
+
* @public
|
|
1262
|
+
*/
|
|
1263
|
+
export interface DeleteAIPromptVersionRequest {
|
|
1264
|
+
/**
|
|
1265
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1266
|
+
* cannot contain the ARN.</p>
|
|
1267
|
+
* @public
|
|
1268
|
+
*/
|
|
1269
|
+
assistantId: string | undefined;
|
|
1270
|
+
/**
|
|
1271
|
+
* <p>The identifier of the Amazon Q in Connect AI prompt.</p>
|
|
1272
|
+
* @public
|
|
1273
|
+
*/
|
|
1274
|
+
aiPromptId: string | undefined;
|
|
1275
|
+
/**
|
|
1276
|
+
* <p>The version number of the AI Prompt version to be deleted.</p>
|
|
1277
|
+
* @public
|
|
1278
|
+
*/
|
|
1279
|
+
versionNumber: number | undefined;
|
|
1280
|
+
}
|
|
1281
|
+
/**
|
|
1282
|
+
* @public
|
|
1283
|
+
*/
|
|
1284
|
+
export interface DeleteAIPromptVersionResponse {
|
|
1285
|
+
}
|
|
1286
|
+
/**
|
|
1287
|
+
* @public
|
|
1288
|
+
*/
|
|
1289
|
+
export interface GetAIPromptRequest {
|
|
1290
|
+
/**
|
|
1291
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1292
|
+
* cannot contain the ARN.</p>
|
|
1293
|
+
* @public
|
|
1294
|
+
*/
|
|
1295
|
+
assistantId: string | undefined;
|
|
1296
|
+
/**
|
|
1297
|
+
* <p>The identifier of the Amazon Q in Connect AI prompt.</p>
|
|
1298
|
+
* @public
|
|
1299
|
+
*/
|
|
1300
|
+
aiPromptId: string | undefined;
|
|
1301
|
+
}
|
|
1302
|
+
/**
|
|
1303
|
+
* @public
|
|
1304
|
+
*/
|
|
1305
|
+
export interface GetAIPromptResponse {
|
|
1306
|
+
/**
|
|
1307
|
+
* <p>The data of the AI Prompt.</p>
|
|
1308
|
+
* @public
|
|
1309
|
+
*/
|
|
1310
|
+
aiPrompt?: AIPromptData;
|
|
1311
|
+
/**
|
|
1312
|
+
* <p>The version number of the AI Prompt version (returned if an AI Prompt version was
|
|
1313
|
+
* specified via use of a qualifier for the <code>aiPromptId</code> on the request). </p>
|
|
1314
|
+
* @public
|
|
1315
|
+
*/
|
|
1316
|
+
versionNumber?: number;
|
|
1317
|
+
}
|
|
1318
|
+
/**
|
|
1319
|
+
* @public
|
|
1320
|
+
*/
|
|
1321
|
+
export interface ListAIPromptsRequest {
|
|
1322
|
+
/**
|
|
1323
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1324
|
+
* cannot contain the ARN.</p>
|
|
1325
|
+
* @public
|
|
1326
|
+
*/
|
|
1327
|
+
assistantId: string | undefined;
|
|
1328
|
+
/**
|
|
1329
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
1330
|
+
* the next request to retrieve the next set of results.</p>
|
|
1331
|
+
* @public
|
|
1332
|
+
*/
|
|
1333
|
+
nextToken?: string;
|
|
1334
|
+
/**
|
|
1335
|
+
* <p>The maximum number of results to return per page.</p>
|
|
1336
|
+
* @public
|
|
1337
|
+
*/
|
|
1338
|
+
maxResults?: number;
|
|
1339
|
+
/**
|
|
1340
|
+
* <p>The origin of the AI Prompts to be listed. <code>SYSTEM</code> for a default AI Agent
|
|
1341
|
+
* created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI Agent
|
|
1342
|
+
* creation APIs. </p>
|
|
1343
|
+
* @public
|
|
1344
|
+
*/
|
|
1345
|
+
origin?: Origin;
|
|
1346
|
+
}
|
|
1347
|
+
/**
|
|
1348
|
+
* <p>The summary of the AI Prompt.</p>
|
|
18
1349
|
* @public
|
|
19
1350
|
*/
|
|
20
|
-
export interface
|
|
1351
|
+
export interface AIPromptSummary {
|
|
21
1352
|
/**
|
|
22
|
-
* <p>
|
|
1353
|
+
* <p>The name of the AI Prompt.</p>
|
|
23
1354
|
* @public
|
|
24
1355
|
*/
|
|
25
|
-
|
|
1356
|
+
name: string | undefined;
|
|
1357
|
+
/**
|
|
1358
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1359
|
+
* cannot contain the ARN.</p>
|
|
1360
|
+
* @public
|
|
1361
|
+
*/
|
|
1362
|
+
assistantId: string | undefined;
|
|
1363
|
+
/**
|
|
1364
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>
|
|
1365
|
+
* @public
|
|
1366
|
+
*/
|
|
1367
|
+
assistantArn: string | undefined;
|
|
1368
|
+
/**
|
|
1369
|
+
* <p>The identifier of the Amazon Q in Connect AI prompt.</p>
|
|
1370
|
+
* @public
|
|
1371
|
+
*/
|
|
1372
|
+
aiPromptId: string | undefined;
|
|
1373
|
+
/**
|
|
1374
|
+
* <p>The type of this AI Prompt.</p>
|
|
1375
|
+
* @public
|
|
1376
|
+
*/
|
|
1377
|
+
type: AIPromptType | undefined;
|
|
1378
|
+
/**
|
|
1379
|
+
* <p>The Amazon Resource Name (ARN) of the AI Prompt.</p>
|
|
1380
|
+
* @public
|
|
1381
|
+
*/
|
|
1382
|
+
aiPromptArn: string | undefined;
|
|
1383
|
+
/**
|
|
1384
|
+
* <p>The time the AI Prompt was last modified.</p>
|
|
1385
|
+
* @public
|
|
1386
|
+
*/
|
|
1387
|
+
modifiedTime?: Date;
|
|
1388
|
+
/**
|
|
1389
|
+
* <p>The type of the prompt template for this AI Prompt.</p>
|
|
1390
|
+
* @public
|
|
1391
|
+
*/
|
|
1392
|
+
templateType: AIPromptTemplateType | undefined;
|
|
1393
|
+
/**
|
|
1394
|
+
* <p>The identifier of the model used for this AI Prompt. Model Ids supported are:
|
|
1395
|
+
* <code>CLAUDE_3_HAIKU_20240307_V1</code>.</p>
|
|
1396
|
+
* @public
|
|
1397
|
+
*/
|
|
1398
|
+
modelId: string | undefined;
|
|
1399
|
+
/**
|
|
1400
|
+
* <p>The API format used for this AI Prompt.</p>
|
|
1401
|
+
* @public
|
|
1402
|
+
*/
|
|
1403
|
+
apiFormat: AIPromptAPIFormat | undefined;
|
|
1404
|
+
/**
|
|
1405
|
+
* <p>The visibility status of the AI Prompt.</p>
|
|
1406
|
+
* @public
|
|
1407
|
+
*/
|
|
1408
|
+
visibilityStatus: VisibilityStatus | undefined;
|
|
1409
|
+
/**
|
|
1410
|
+
* <p>The origin of the AI Prompt. <code>SYSTEM</code> for a default AI Prompt created by Q in
|
|
1411
|
+
* Connect or <code>CUSTOMER</code> for an AI Prompt created by calling AI Prompt creation APIs.
|
|
1412
|
+
* </p>
|
|
1413
|
+
* @public
|
|
1414
|
+
*/
|
|
1415
|
+
origin?: Origin;
|
|
1416
|
+
/**
|
|
1417
|
+
* <p>The description of the AI Prompt.</p>
|
|
1418
|
+
* @public
|
|
1419
|
+
*/
|
|
1420
|
+
description?: string;
|
|
1421
|
+
/**
|
|
1422
|
+
* <p>The status of the AI Prompt.</p>
|
|
1423
|
+
* @public
|
|
1424
|
+
*/
|
|
1425
|
+
status?: Status;
|
|
1426
|
+
/**
|
|
1427
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1428
|
+
* @public
|
|
1429
|
+
*/
|
|
1430
|
+
tags?: Record<string, string>;
|
|
26
1431
|
}
|
|
27
1432
|
/**
|
|
28
|
-
* <p>A leaf node condition which can be used to specify a tag condition. </p>
|
|
29
1433
|
* @public
|
|
30
1434
|
*/
|
|
31
|
-
export interface
|
|
1435
|
+
export interface ListAIPromptsResponse {
|
|
32
1436
|
/**
|
|
33
|
-
* <p>The
|
|
1437
|
+
* <p>The summaries of the AI Prompts.</p>
|
|
34
1438
|
* @public
|
|
35
1439
|
*/
|
|
36
|
-
|
|
1440
|
+
aiPromptSummaries: AIPromptSummary[] | undefined;
|
|
37
1441
|
/**
|
|
38
|
-
* <p>The
|
|
1442
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
1443
|
+
* the next request to retrieve the next set of results.</p>
|
|
39
1444
|
* @public
|
|
40
1445
|
*/
|
|
41
|
-
|
|
1446
|
+
nextToken?: string;
|
|
1447
|
+
}
|
|
1448
|
+
/**
|
|
1449
|
+
* @public
|
|
1450
|
+
*/
|
|
1451
|
+
export interface ListAIPromptVersionsRequest {
|
|
1452
|
+
/**
|
|
1453
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1454
|
+
* cannot contain the ARN.</p>
|
|
1455
|
+
* @public
|
|
1456
|
+
*/
|
|
1457
|
+
assistantId: string | undefined;
|
|
1458
|
+
/**
|
|
1459
|
+
* <p>The identifier of the Amazon Q in Connect AI prompt for which versions are to be
|
|
1460
|
+
* listed.</p>
|
|
1461
|
+
* @public
|
|
1462
|
+
*/
|
|
1463
|
+
aiPromptId: string | undefined;
|
|
1464
|
+
/**
|
|
1465
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
1466
|
+
* the next request to retrieve the next set of results.</p>
|
|
1467
|
+
* @public
|
|
1468
|
+
*/
|
|
1469
|
+
nextToken?: string;
|
|
1470
|
+
/**
|
|
1471
|
+
* <p>The maximum number of results to return per page.</p>
|
|
1472
|
+
* @public
|
|
1473
|
+
*/
|
|
1474
|
+
maxResults?: number;
|
|
1475
|
+
/**
|
|
1476
|
+
* <p>The origin of the AI Prompt versions to be listed. <code>SYSTEM</code> for a default AI
|
|
1477
|
+
* Agent created by Q in Connect or <code>CUSTOMER</code> for an AI Agent created by calling AI
|
|
1478
|
+
* Agent creation APIs. </p>
|
|
1479
|
+
* @public
|
|
1480
|
+
*/
|
|
1481
|
+
origin?: Origin;
|
|
1482
|
+
}
|
|
1483
|
+
/**
|
|
1484
|
+
* <p>The summary of the AI Prompt version.</p>
|
|
1485
|
+
* @public
|
|
1486
|
+
*/
|
|
1487
|
+
export interface AIPromptVersionSummary {
|
|
1488
|
+
/**
|
|
1489
|
+
* <p>The date for the summary of the AI Prompt version.</p>
|
|
1490
|
+
* @public
|
|
1491
|
+
*/
|
|
1492
|
+
aiPromptSummary?: AIPromptSummary;
|
|
1493
|
+
/**
|
|
1494
|
+
* <p>The version number for this AI Prompt version.</p>
|
|
1495
|
+
* @public
|
|
1496
|
+
*/
|
|
1497
|
+
versionNumber?: number;
|
|
1498
|
+
}
|
|
1499
|
+
/**
|
|
1500
|
+
* @public
|
|
1501
|
+
*/
|
|
1502
|
+
export interface ListAIPromptVersionsResponse {
|
|
1503
|
+
/**
|
|
1504
|
+
* <p>The summaries of the AI Prompt versions.</p>
|
|
1505
|
+
* @public
|
|
1506
|
+
*/
|
|
1507
|
+
aiPromptVersionSummaries: AIPromptVersionSummary[] | undefined;
|
|
1508
|
+
/**
|
|
1509
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
1510
|
+
* the next request to retrieve the next set of results.</p>
|
|
1511
|
+
* @public
|
|
1512
|
+
*/
|
|
1513
|
+
nextToken?: string;
|
|
1514
|
+
}
|
|
1515
|
+
/**
|
|
1516
|
+
* @public
|
|
1517
|
+
*/
|
|
1518
|
+
export interface UpdateAIPromptRequest {
|
|
1519
|
+
/**
|
|
1520
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
1521
|
+
* request. If not provided, the AWS SDK populates this field. For more information about
|
|
1522
|
+
* idempotency, see <a href="http://aws.amazon.com/https:/aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
1523
|
+
* @public
|
|
1524
|
+
*/
|
|
1525
|
+
clientToken?: string;
|
|
1526
|
+
/**
|
|
1527
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
1528
|
+
* cannot contain the ARN.</p>
|
|
1529
|
+
* @public
|
|
1530
|
+
*/
|
|
1531
|
+
assistantId: string | undefined;
|
|
1532
|
+
/**
|
|
1533
|
+
* <p>The identifier of the Amazon Q in Connect AI Prompt.</p>
|
|
1534
|
+
* @public
|
|
1535
|
+
*/
|
|
1536
|
+
aiPromptId: string | undefined;
|
|
1537
|
+
/**
|
|
1538
|
+
* <p>The visibility status of the Amazon Q in Connect AI prompt.</p>
|
|
1539
|
+
* @public
|
|
1540
|
+
*/
|
|
1541
|
+
visibilityStatus: VisibilityStatus | undefined;
|
|
1542
|
+
/**
|
|
1543
|
+
* <p>The configuration of the prompt template for this AI Prompt.</p>
|
|
1544
|
+
* @public
|
|
1545
|
+
*/
|
|
1546
|
+
templateConfiguration?: AIPromptTemplateConfiguration;
|
|
1547
|
+
/**
|
|
1548
|
+
* <p>The description of the Amazon Q in Connect AI Prompt.</p>
|
|
1549
|
+
* @public
|
|
1550
|
+
*/
|
|
1551
|
+
description?: string;
|
|
1552
|
+
}
|
|
1553
|
+
/**
|
|
1554
|
+
* @public
|
|
1555
|
+
*/
|
|
1556
|
+
export interface UpdateAIPromptResponse {
|
|
1557
|
+
/**
|
|
1558
|
+
* <p>The data of the updated Amazon Q in Connect AI Prompt.</p>
|
|
1559
|
+
* @public
|
|
1560
|
+
*/
|
|
1561
|
+
aiPrompt?: AIPromptData;
|
|
1562
|
+
}
|
|
1563
|
+
/**
|
|
1564
|
+
* <p>Content association data for a <a href="https://docs.aws.amazon.com/connect/latest/adminguide/step-by-step-guided-experiences.html">step-by-step
|
|
1565
|
+
* guide</a>.</p>
|
|
1566
|
+
* @public
|
|
1567
|
+
*/
|
|
1568
|
+
export interface AmazonConnectGuideAssociationData {
|
|
1569
|
+
/**
|
|
1570
|
+
* <p> The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.</p>
|
|
1571
|
+
* @public
|
|
1572
|
+
*/
|
|
1573
|
+
flowId?: string;
|
|
42
1574
|
}
|
|
43
1575
|
/**
|
|
44
1576
|
* <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
|
|
@@ -73,7 +1605,7 @@ export interface AppIntegrationsConfiguration {
|
|
|
73
1605
|
* <code>html</code>, <code>htm</code>, and <code>txt</code>. </p>
|
|
74
1606
|
* </li>
|
|
75
1607
|
* <li>
|
|
76
|
-
* <p> For <a href="
|
|
1608
|
+
* <p> For <a href="http://aws.amazon.com/s3/">Amazon S3</a>, the
|
|
77
1609
|
* ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null.
|
|
78
1610
|
* The <code>SourceURI</code> of your DataIntegration must use the following format:
|
|
79
1611
|
* <code>s3://your_s3_bucket_name</code>.</p>
|
|
@@ -114,21 +1646,6 @@ export interface AppIntegrationsConfiguration {
|
|
|
114
1646
|
*/
|
|
115
1647
|
objectFields?: string[];
|
|
116
1648
|
}
|
|
117
|
-
/**
|
|
118
|
-
* <p>The request could not be processed because of conflict in the current state of the
|
|
119
|
-
* resource. For example, if you're using a <code>Create</code> API (such as
|
|
120
|
-
* <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
|
|
121
|
-
* same name) is being created or mutated.</p>
|
|
122
|
-
* @public
|
|
123
|
-
*/
|
|
124
|
-
export declare class ConflictException extends __BaseException {
|
|
125
|
-
readonly name: "ConflictException";
|
|
126
|
-
readonly $fault: "client";
|
|
127
|
-
/**
|
|
128
|
-
* @internal
|
|
129
|
-
*/
|
|
130
|
-
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
131
|
-
}
|
|
132
1649
|
/**
|
|
133
1650
|
* <p>The data that is input into Amazon Q in Connect as a result of the assistant association.</p>
|
|
134
1651
|
* @public
|
|
@@ -300,48 +1817,6 @@ export interface CreateAssistantAssociationResponse {
|
|
|
300
1817
|
*/
|
|
301
1818
|
assistantAssociation?: AssistantAssociationData;
|
|
302
1819
|
}
|
|
303
|
-
/**
|
|
304
|
-
* <p>The specified resource does not exist.</p>
|
|
305
|
-
* @public
|
|
306
|
-
*/
|
|
307
|
-
export declare class ResourceNotFoundException extends __BaseException {
|
|
308
|
-
readonly name: "ResourceNotFoundException";
|
|
309
|
-
readonly $fault: "client";
|
|
310
|
-
/**
|
|
311
|
-
* <p>The specified resource name.</p>
|
|
312
|
-
* @public
|
|
313
|
-
*/
|
|
314
|
-
resourceName?: string;
|
|
315
|
-
/**
|
|
316
|
-
* @internal
|
|
317
|
-
*/
|
|
318
|
-
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
319
|
-
}
|
|
320
|
-
/**
|
|
321
|
-
* <p>You've exceeded your service quota. To perform the requested action, remove some of the
|
|
322
|
-
* relevant resources, or use service quotas to request a service quota increase.</p>
|
|
323
|
-
* @public
|
|
324
|
-
*/
|
|
325
|
-
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
326
|
-
readonly name: "ServiceQuotaExceededException";
|
|
327
|
-
readonly $fault: "client";
|
|
328
|
-
/**
|
|
329
|
-
* @internal
|
|
330
|
-
*/
|
|
331
|
-
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
332
|
-
}
|
|
333
|
-
/**
|
|
334
|
-
* <p>The input fails to satisfy the constraints specified by a service.</p>
|
|
335
|
-
* @public
|
|
336
|
-
*/
|
|
337
|
-
export declare class ValidationException extends __BaseException {
|
|
338
|
-
readonly name: "ValidationException";
|
|
339
|
-
readonly $fault: "client";
|
|
340
|
-
/**
|
|
341
|
-
* @internal
|
|
342
|
-
*/
|
|
343
|
-
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
344
|
-
}
|
|
345
1820
|
/**
|
|
346
1821
|
* @public
|
|
347
1822
|
*/
|
|
@@ -649,6 +2124,12 @@ export interface AssistantData {
|
|
|
649
2124
|
* @public
|
|
650
2125
|
*/
|
|
651
2126
|
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
|
2127
|
+
/**
|
|
2128
|
+
* <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is
|
|
2129
|
+
* set on the Amazon Q in Connect Assistant.</p>
|
|
2130
|
+
* @public
|
|
2131
|
+
*/
|
|
2132
|
+
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>>;
|
|
652
2133
|
}
|
|
653
2134
|
/**
|
|
654
2135
|
* @public
|
|
@@ -789,33 +2270,66 @@ export interface DocumentText {
|
|
|
789
2270
|
* <p>Details about the source content text data.</p>
|
|
790
2271
|
* @public
|
|
791
2272
|
*/
|
|
792
|
-
export interface TextData {
|
|
2273
|
+
export interface TextData {
|
|
2274
|
+
/**
|
|
2275
|
+
* <p>The text of the document.</p>
|
|
2276
|
+
* @public
|
|
2277
|
+
*/
|
|
2278
|
+
title?: DocumentText;
|
|
2279
|
+
/**
|
|
2280
|
+
* <p>The text of the document.</p>
|
|
2281
|
+
* @public
|
|
2282
|
+
*/
|
|
2283
|
+
excerpt?: DocumentText;
|
|
2284
|
+
}
|
|
2285
|
+
/**
|
|
2286
|
+
* <p>Details about the content data.</p>
|
|
2287
|
+
* @public
|
|
2288
|
+
*/
|
|
2289
|
+
export interface ContentDataDetails {
|
|
2290
|
+
/**
|
|
2291
|
+
* <p>Details about the content text data.</p>
|
|
2292
|
+
* @public
|
|
2293
|
+
*/
|
|
2294
|
+
textData: TextData | undefined;
|
|
2295
|
+
/**
|
|
2296
|
+
* <p>Details about the content ranking data.</p>
|
|
2297
|
+
* @public
|
|
2298
|
+
*/
|
|
2299
|
+
rankingData: RankingData | undefined;
|
|
2300
|
+
}
|
|
2301
|
+
/**
|
|
2302
|
+
* <p>Details about the detected intent.</p>
|
|
2303
|
+
* @public
|
|
2304
|
+
*/
|
|
2305
|
+
export interface IntentDetectedDataDetails {
|
|
793
2306
|
/**
|
|
794
|
-
* <p>The
|
|
2307
|
+
* <p>The detected intent.</p>
|
|
795
2308
|
* @public
|
|
796
2309
|
*/
|
|
797
|
-
|
|
2310
|
+
intent: string | undefined;
|
|
798
2311
|
/**
|
|
799
|
-
* <p>The
|
|
2312
|
+
* <p>The identifier of the detected intent.</p>
|
|
800
2313
|
* @public
|
|
801
2314
|
*/
|
|
802
|
-
|
|
2315
|
+
intentId: string | undefined;
|
|
803
2316
|
}
|
|
804
2317
|
/**
|
|
805
|
-
* <p>
|
|
2318
|
+
* <p>Contains information about where the text with a citation begins and ends in the generated
|
|
2319
|
+
* output.</p>
|
|
806
2320
|
* @public
|
|
807
2321
|
*/
|
|
808
|
-
export interface
|
|
2322
|
+
export interface CitationSpan {
|
|
809
2323
|
/**
|
|
810
|
-
* <p>
|
|
2324
|
+
* <p>Where the text with a citation starts in the generated output.</p>
|
|
811
2325
|
* @public
|
|
812
2326
|
*/
|
|
813
|
-
|
|
2327
|
+
beginOffsetInclusive?: number;
|
|
814
2328
|
/**
|
|
815
|
-
* <p>
|
|
2329
|
+
* <p>Where the text with a citation ends in the generated output.</p>
|
|
816
2330
|
* @public
|
|
817
2331
|
*/
|
|
818
|
-
|
|
2332
|
+
endOffsetExclusive?: number;
|
|
819
2333
|
}
|
|
820
2334
|
/**
|
|
821
2335
|
* @public
|
|
@@ -853,7 +2367,24 @@ export interface SourceContentDataDetails {
|
|
|
853
2367
|
* @public
|
|
854
2368
|
*/
|
|
855
2369
|
rankingData: RankingData | undefined;
|
|
2370
|
+
/**
|
|
2371
|
+
* <p>Contains information about where the text with a citation begins and ends in the generated output.</p>
|
|
2372
|
+
* @public
|
|
2373
|
+
*/
|
|
2374
|
+
citationSpan?: CitationSpan;
|
|
856
2375
|
}
|
|
2376
|
+
/**
|
|
2377
|
+
* @public
|
|
2378
|
+
* @enum
|
|
2379
|
+
*/
|
|
2380
|
+
export declare const ReferenceType: {
|
|
2381
|
+
readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
|
|
2382
|
+
readonly WEB_CRAWLER: "WEB_CRAWLER";
|
|
2383
|
+
};
|
|
2384
|
+
/**
|
|
2385
|
+
* @public
|
|
2386
|
+
*/
|
|
2387
|
+
export type ReferenceType = (typeof ReferenceType)[keyof typeof ReferenceType];
|
|
857
2388
|
/**
|
|
858
2389
|
* <p>Reference information about the content.</p>
|
|
859
2390
|
* @public
|
|
@@ -879,6 +2410,16 @@ export interface ContentReference {
|
|
|
879
2410
|
* @public
|
|
880
2411
|
*/
|
|
881
2412
|
contentId?: string;
|
|
2413
|
+
/**
|
|
2414
|
+
* <p>The web URL of the source content.</p>
|
|
2415
|
+
* @public
|
|
2416
|
+
*/
|
|
2417
|
+
sourceURL?: string;
|
|
2418
|
+
/**
|
|
2419
|
+
* <p>The type of reference content.</p>
|
|
2420
|
+
* @public
|
|
2421
|
+
*/
|
|
2422
|
+
referenceType?: ReferenceType;
|
|
882
2423
|
}
|
|
883
2424
|
/**
|
|
884
2425
|
* <p>Reference information about generative content.</p>
|
|
@@ -964,6 +2505,7 @@ export interface Document {
|
|
|
964
2505
|
* @enum
|
|
965
2506
|
*/
|
|
966
2507
|
export declare const RecommendationType: {
|
|
2508
|
+
readonly DETECTED_INTENT: "DETECTED_INTENT";
|
|
967
2509
|
readonly GENERATIVE_ANSWER: "GENERATIVE_ANSWER";
|
|
968
2510
|
readonly GENERATIVE_RESPONSE: "GENERATIVE_RESPONSE";
|
|
969
2511
|
readonly KNOWLEDGE_CONTENT: "KNOWLEDGE_CONTENT";
|
|
@@ -1161,6 +2703,12 @@ export interface AssistantSummary {
|
|
|
1161
2703
|
* @public
|
|
1162
2704
|
*/
|
|
1163
2705
|
capabilityConfiguration?: AssistantCapabilityConfiguration;
|
|
2706
|
+
/**
|
|
2707
|
+
* <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that is
|
|
2708
|
+
* set on the Amazon Q in Connect Assistant.</p>
|
|
2709
|
+
* @public
|
|
2710
|
+
*/
|
|
2711
|
+
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>>;
|
|
1164
2712
|
}
|
|
1165
2713
|
/**
|
|
1166
2714
|
* @public
|
|
@@ -1421,6 +2969,70 @@ export declare namespace QueryCondition {
|
|
|
1421
2969
|
}
|
|
1422
2970
|
const visit: <T>(value: QueryCondition, visitor: Visitor<T>) => T;
|
|
1423
2971
|
}
|
|
2972
|
+
/**
|
|
2973
|
+
* <p>Information about the Amazon Q intent.</p>
|
|
2974
|
+
* @public
|
|
2975
|
+
*/
|
|
2976
|
+
export interface IntentInputData {
|
|
2977
|
+
/**
|
|
2978
|
+
* <p>The identifier of the Amazon Q intent.</p>
|
|
2979
|
+
* @public
|
|
2980
|
+
*/
|
|
2981
|
+
intentId: string | undefined;
|
|
2982
|
+
}
|
|
2983
|
+
/**
|
|
2984
|
+
* <p>Information about the text to search for.</p>
|
|
2985
|
+
* @public
|
|
2986
|
+
*/
|
|
2987
|
+
export interface QueryTextInputData {
|
|
2988
|
+
/**
|
|
2989
|
+
* <p>The text to search for.</p>
|
|
2990
|
+
* @public
|
|
2991
|
+
*/
|
|
2992
|
+
text: string | undefined;
|
|
2993
|
+
}
|
|
2994
|
+
/**
|
|
2995
|
+
* <p>Input information for the query.</p>
|
|
2996
|
+
* @public
|
|
2997
|
+
*/
|
|
2998
|
+
export type QueryInputData = QueryInputData.IntentInputDataMember | QueryInputData.QueryTextInputDataMember | QueryInputData.$UnknownMember;
|
|
2999
|
+
/**
|
|
3000
|
+
* @public
|
|
3001
|
+
*/
|
|
3002
|
+
export declare namespace QueryInputData {
|
|
3003
|
+
/**
|
|
3004
|
+
* <p>Input information for the query.</p>
|
|
3005
|
+
* @public
|
|
3006
|
+
*/
|
|
3007
|
+
interface QueryTextInputDataMember {
|
|
3008
|
+
queryTextInputData: QueryTextInputData;
|
|
3009
|
+
intentInputData?: never;
|
|
3010
|
+
$unknown?: never;
|
|
3011
|
+
}
|
|
3012
|
+
/**
|
|
3013
|
+
* <p>Input information for the intent.</p>
|
|
3014
|
+
* @public
|
|
3015
|
+
*/
|
|
3016
|
+
interface IntentInputDataMember {
|
|
3017
|
+
queryTextInputData?: never;
|
|
3018
|
+
intentInputData: IntentInputData;
|
|
3019
|
+
$unknown?: never;
|
|
3020
|
+
}
|
|
3021
|
+
/**
|
|
3022
|
+
* @public
|
|
3023
|
+
*/
|
|
3024
|
+
interface $UnknownMember {
|
|
3025
|
+
queryTextInputData?: never;
|
|
3026
|
+
intentInputData?: never;
|
|
3027
|
+
$unknown: [string, any];
|
|
3028
|
+
}
|
|
3029
|
+
interface Visitor<T> {
|
|
3030
|
+
queryTextInputData: (value: QueryTextInputData) => T;
|
|
3031
|
+
intentInputData: (value: IntentInputData) => T;
|
|
3032
|
+
_: (name: string, value: any) => T;
|
|
3033
|
+
}
|
|
3034
|
+
const visit: <T>(value: QueryInputData, visitor: Visitor<T>) => T;
|
|
3035
|
+
}
|
|
1424
3036
|
/**
|
|
1425
3037
|
* @public
|
|
1426
3038
|
*/
|
|
@@ -1434,7 +3046,7 @@ export interface QueryAssistantRequest {
|
|
|
1434
3046
|
* <p>The text to search for.</p>
|
|
1435
3047
|
* @public
|
|
1436
3048
|
*/
|
|
1437
|
-
queryText
|
|
3049
|
+
queryText?: string;
|
|
1438
3050
|
/**
|
|
1439
3051
|
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1440
3052
|
* response in the next request to retrieve the next set of results.</p>
|
|
@@ -1457,6 +3069,18 @@ export interface QueryAssistantRequest {
|
|
|
1457
3069
|
* @public
|
|
1458
3070
|
*/
|
|
1459
3071
|
queryCondition?: QueryCondition[];
|
|
3072
|
+
/**
|
|
3073
|
+
* <p>Information about the query.</p>
|
|
3074
|
+
* @public
|
|
3075
|
+
*/
|
|
3076
|
+
queryInputData?: QueryInputData;
|
|
3077
|
+
/**
|
|
3078
|
+
* <p>The search type to be used against the Knowledge Base for this request. The values can be
|
|
3079
|
+
* <code>SEMANTIC</code> which uses vector embeddings or <code>HYBRID</code> which use vector
|
|
3080
|
+
* embeddings and raw text.</p>
|
|
3081
|
+
* @public
|
|
3082
|
+
*/
|
|
3083
|
+
overrideKnowledgeBaseSearchType?: KnowledgeBaseSearchType;
|
|
1460
3084
|
}
|
|
1461
3085
|
/**
|
|
1462
3086
|
* @public
|
|
@@ -1464,6 +3088,7 @@ export interface QueryAssistantRequest {
|
|
|
1464
3088
|
*/
|
|
1465
3089
|
export declare const QueryResultType: {
|
|
1466
3090
|
readonly GENERATIVE_ANSWER: "GENERATIVE_ANSWER";
|
|
3091
|
+
readonly INTENT_ANSWER: "INTENT_ANSWER";
|
|
1467
3092
|
readonly KNOWLEDGE_CONTENT: "KNOWLEDGE_CONTENT";
|
|
1468
3093
|
};
|
|
1469
3094
|
/**
|
|
@@ -1485,6 +3110,28 @@ export declare class RequestTimeoutException extends __BaseException {
|
|
|
1485
3110
|
*/
|
|
1486
3111
|
constructor(opts: __ExceptionOptionType<RequestTimeoutException, __BaseException>);
|
|
1487
3112
|
}
|
|
3113
|
+
/**
|
|
3114
|
+
* @public
|
|
3115
|
+
*/
|
|
3116
|
+
export interface RemoveAssistantAIAgentRequest {
|
|
3117
|
+
/**
|
|
3118
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
3119
|
+
* cannot contain the ARN.</p>
|
|
3120
|
+
* @public
|
|
3121
|
+
*/
|
|
3122
|
+
assistantId: string | undefined;
|
|
3123
|
+
/**
|
|
3124
|
+
* <p>The type of the AI Agent being removed for use by default from the Amazon Q in Connect
|
|
3125
|
+
* Assistant.</p>
|
|
3126
|
+
* @public
|
|
3127
|
+
*/
|
|
3128
|
+
aiAgentType: AIAgentType | undefined;
|
|
3129
|
+
}
|
|
3130
|
+
/**
|
|
3131
|
+
* @public
|
|
3132
|
+
*/
|
|
3133
|
+
export interface RemoveAssistantAIAgentResponse {
|
|
3134
|
+
}
|
|
1488
3135
|
/**
|
|
1489
3136
|
* @public
|
|
1490
3137
|
* @enum
|
|
@@ -1513,360 +3160,567 @@ export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator
|
|
|
1513
3160
|
*/
|
|
1514
3161
|
export interface Filter {
|
|
1515
3162
|
/**
|
|
1516
|
-
* <p>The field on which to filter.</p>
|
|
3163
|
+
* <p>The field on which to filter.</p>
|
|
3164
|
+
* @public
|
|
3165
|
+
*/
|
|
3166
|
+
field: FilterField | undefined;
|
|
3167
|
+
/**
|
|
3168
|
+
* <p>The operator to use for comparing the field’s value with the provided value.</p>
|
|
3169
|
+
* @public
|
|
3170
|
+
*/
|
|
3171
|
+
operator: FilterOperator | undefined;
|
|
3172
|
+
/**
|
|
3173
|
+
* <p>The desired field value on which to filter.</p>
|
|
3174
|
+
* @public
|
|
3175
|
+
*/
|
|
3176
|
+
value: string | undefined;
|
|
3177
|
+
}
|
|
3178
|
+
/**
|
|
3179
|
+
* <p>The search expression.</p>
|
|
3180
|
+
* @public
|
|
3181
|
+
*/
|
|
3182
|
+
export interface SearchExpression {
|
|
3183
|
+
/**
|
|
3184
|
+
* <p>The search expression filters.</p>
|
|
3185
|
+
* @public
|
|
3186
|
+
*/
|
|
3187
|
+
filters: Filter[] | undefined;
|
|
3188
|
+
}
|
|
3189
|
+
/**
|
|
3190
|
+
* @public
|
|
3191
|
+
*/
|
|
3192
|
+
export interface SearchSessionsRequest {
|
|
3193
|
+
/**
|
|
3194
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
3195
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
3196
|
+
* @public
|
|
3197
|
+
*/
|
|
3198
|
+
nextToken?: string;
|
|
3199
|
+
/**
|
|
3200
|
+
* <p>The maximum number of results to return per page.</p>
|
|
3201
|
+
* @public
|
|
3202
|
+
*/
|
|
3203
|
+
maxResults?: number;
|
|
3204
|
+
/**
|
|
3205
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3206
|
+
* @public
|
|
3207
|
+
*/
|
|
3208
|
+
assistantId: string | undefined;
|
|
3209
|
+
/**
|
|
3210
|
+
* <p>The search expression to filter results.</p>
|
|
3211
|
+
* @public
|
|
3212
|
+
*/
|
|
3213
|
+
searchExpression: SearchExpression | undefined;
|
|
3214
|
+
}
|
|
3215
|
+
/**
|
|
3216
|
+
* <p>Summary information about the session.</p>
|
|
3217
|
+
* @public
|
|
3218
|
+
*/
|
|
3219
|
+
export interface SessionSummary {
|
|
3220
|
+
/**
|
|
3221
|
+
* <p>The identifier of the session.</p>
|
|
3222
|
+
* @public
|
|
3223
|
+
*/
|
|
3224
|
+
sessionId: string | undefined;
|
|
3225
|
+
/**
|
|
3226
|
+
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
3227
|
+
* @public
|
|
3228
|
+
*/
|
|
3229
|
+
sessionArn: string | undefined;
|
|
3230
|
+
/**
|
|
3231
|
+
* <p>The identifier of the Amazon Q in Connect assistant.</p>
|
|
3232
|
+
* @public
|
|
3233
|
+
*/
|
|
3234
|
+
assistantId: string | undefined;
|
|
3235
|
+
/**
|
|
3236
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.</p>
|
|
3237
|
+
* @public
|
|
3238
|
+
*/
|
|
3239
|
+
assistantArn: string | undefined;
|
|
3240
|
+
}
|
|
3241
|
+
/**
|
|
3242
|
+
* @public
|
|
3243
|
+
*/
|
|
3244
|
+
export interface SearchSessionsResponse {
|
|
3245
|
+
/**
|
|
3246
|
+
* <p>Summary information about the sessions.</p>
|
|
3247
|
+
* @public
|
|
3248
|
+
*/
|
|
3249
|
+
sessionSummaries: SessionSummary[] | undefined;
|
|
3250
|
+
/**
|
|
3251
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
3252
|
+
* @public
|
|
3253
|
+
*/
|
|
3254
|
+
nextToken?: string;
|
|
3255
|
+
}
|
|
3256
|
+
/**
|
|
3257
|
+
* @public
|
|
3258
|
+
*/
|
|
3259
|
+
export interface CreateSessionRequest {
|
|
3260
|
+
/**
|
|
3261
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3262
|
+
* request. If not provided, the Amazon Web Services
|
|
3263
|
+
* SDK populates this field. For more information about idempotency, see
|
|
3264
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3265
|
+
* @public
|
|
3266
|
+
*/
|
|
3267
|
+
clientToken?: string;
|
|
3268
|
+
/**
|
|
3269
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3270
|
+
* @public
|
|
3271
|
+
*/
|
|
3272
|
+
assistantId: string | undefined;
|
|
3273
|
+
/**
|
|
3274
|
+
* <p>The name of the session.</p>
|
|
3275
|
+
* @public
|
|
3276
|
+
*/
|
|
3277
|
+
name: string | undefined;
|
|
3278
|
+
/**
|
|
3279
|
+
* <p>The description.</p>
|
|
3280
|
+
* @public
|
|
3281
|
+
*/
|
|
3282
|
+
description?: string;
|
|
3283
|
+
/**
|
|
3284
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
3285
|
+
* @public
|
|
3286
|
+
*/
|
|
3287
|
+
tags?: Record<string, string>;
|
|
3288
|
+
/**
|
|
3289
|
+
* <p>An object that can be used to specify Tag conditions. </p>
|
|
3290
|
+
* @public
|
|
3291
|
+
*/
|
|
3292
|
+
tagFilter?: TagFilter;
|
|
3293
|
+
/**
|
|
3294
|
+
* <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that
|
|
3295
|
+
* should be used by Amazon Q in Connect for this Session.</p>
|
|
3296
|
+
* @public
|
|
3297
|
+
*/
|
|
3298
|
+
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>>;
|
|
3299
|
+
}
|
|
3300
|
+
/**
|
|
3301
|
+
* <p>The configuration information for the session integration.</p>
|
|
3302
|
+
* @public
|
|
3303
|
+
*/
|
|
3304
|
+
export interface SessionIntegrationConfiguration {
|
|
3305
|
+
/**
|
|
3306
|
+
* <p>The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.</p>
|
|
3307
|
+
* @public
|
|
3308
|
+
*/
|
|
3309
|
+
topicIntegrationArn?: string;
|
|
3310
|
+
}
|
|
3311
|
+
/**
|
|
3312
|
+
* <p>Information about the session.</p>
|
|
3313
|
+
* @public
|
|
3314
|
+
*/
|
|
3315
|
+
export interface SessionData {
|
|
3316
|
+
/**
|
|
3317
|
+
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
3318
|
+
* @public
|
|
3319
|
+
*/
|
|
3320
|
+
sessionArn: string | undefined;
|
|
3321
|
+
/**
|
|
3322
|
+
* <p>The identifier of the session.</p>
|
|
3323
|
+
* @public
|
|
3324
|
+
*/
|
|
3325
|
+
sessionId: string | undefined;
|
|
3326
|
+
/**
|
|
3327
|
+
* <p>The name of the session.</p>
|
|
1517
3328
|
* @public
|
|
1518
3329
|
*/
|
|
1519
|
-
|
|
3330
|
+
name: string | undefined;
|
|
1520
3331
|
/**
|
|
1521
|
-
* <p>The
|
|
3332
|
+
* <p>The description of the session.</p>
|
|
1522
3333
|
* @public
|
|
1523
3334
|
*/
|
|
1524
|
-
|
|
3335
|
+
description?: string;
|
|
1525
3336
|
/**
|
|
1526
|
-
* <p>The
|
|
3337
|
+
* <p>The tags used to organize, track, or control access for this resource.</p>
|
|
1527
3338
|
* @public
|
|
1528
3339
|
*/
|
|
1529
|
-
|
|
3340
|
+
tags?: Record<string, string>;
|
|
3341
|
+
/**
|
|
3342
|
+
* <p>The configuration information for the session integration.</p>
|
|
3343
|
+
* @public
|
|
3344
|
+
*/
|
|
3345
|
+
integrationConfiguration?: SessionIntegrationConfiguration;
|
|
3346
|
+
/**
|
|
3347
|
+
* <p>An object that can be used to specify Tag conditions.</p>
|
|
3348
|
+
* @public
|
|
3349
|
+
*/
|
|
3350
|
+
tagFilter?: TagFilter;
|
|
3351
|
+
/**
|
|
3352
|
+
* <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that
|
|
3353
|
+
* should be used by Amazon Q in Connect for this Session.</p>
|
|
3354
|
+
* @public
|
|
3355
|
+
*/
|
|
3356
|
+
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>>;
|
|
1530
3357
|
}
|
|
1531
3358
|
/**
|
|
1532
|
-
* <p>The search expression.</p>
|
|
1533
3359
|
* @public
|
|
1534
3360
|
*/
|
|
1535
|
-
export interface
|
|
3361
|
+
export interface CreateSessionResponse {
|
|
1536
3362
|
/**
|
|
1537
|
-
* <p>The
|
|
3363
|
+
* <p>The session.</p>
|
|
1538
3364
|
* @public
|
|
1539
3365
|
*/
|
|
1540
|
-
|
|
3366
|
+
session?: SessionData;
|
|
1541
3367
|
}
|
|
1542
3368
|
/**
|
|
1543
3369
|
* @public
|
|
1544
3370
|
*/
|
|
1545
|
-
export interface
|
|
1546
|
-
/**
|
|
1547
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
1548
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
1549
|
-
* @public
|
|
1550
|
-
*/
|
|
1551
|
-
nextToken?: string;
|
|
3371
|
+
export interface GetSessionRequest {
|
|
1552
3372
|
/**
|
|
1553
|
-
* <p>The
|
|
3373
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1554
3374
|
* @public
|
|
1555
3375
|
*/
|
|
1556
|
-
|
|
3376
|
+
assistantId: string | undefined;
|
|
1557
3377
|
/**
|
|
1558
|
-
* <p>The identifier of the
|
|
3378
|
+
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1559
3379
|
* @public
|
|
1560
3380
|
*/
|
|
1561
|
-
|
|
3381
|
+
sessionId: string | undefined;
|
|
3382
|
+
}
|
|
3383
|
+
/**
|
|
3384
|
+
* @public
|
|
3385
|
+
*/
|
|
3386
|
+
export interface GetSessionResponse {
|
|
1562
3387
|
/**
|
|
1563
|
-
* <p>The
|
|
3388
|
+
* <p>The session.</p>
|
|
1564
3389
|
* @public
|
|
1565
3390
|
*/
|
|
1566
|
-
|
|
3391
|
+
session?: SessionData;
|
|
1567
3392
|
}
|
|
1568
3393
|
/**
|
|
1569
|
-
* <p>Summary information about the session.</p>
|
|
1570
3394
|
* @public
|
|
1571
3395
|
*/
|
|
1572
|
-
export interface
|
|
3396
|
+
export interface UpdateSessionRequest {
|
|
1573
3397
|
/**
|
|
1574
|
-
* <p>The identifier of the
|
|
3398
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
3399
|
+
* @public
|
|
3400
|
+
*/
|
|
3401
|
+
assistantId: string | undefined;
|
|
3402
|
+
/**
|
|
3403
|
+
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1575
3404
|
* @public
|
|
1576
3405
|
*/
|
|
1577
3406
|
sessionId: string | undefined;
|
|
1578
3407
|
/**
|
|
1579
|
-
* <p>The
|
|
3408
|
+
* <p>The description.</p>
|
|
1580
3409
|
* @public
|
|
1581
3410
|
*/
|
|
1582
|
-
|
|
3411
|
+
description?: string;
|
|
1583
3412
|
/**
|
|
1584
|
-
* <p>
|
|
3413
|
+
* <p>An object that can be used to specify Tag conditions.</p>
|
|
1585
3414
|
* @public
|
|
1586
3415
|
*/
|
|
1587
|
-
|
|
3416
|
+
tagFilter?: TagFilter;
|
|
1588
3417
|
/**
|
|
1589
|
-
* <p>The
|
|
3418
|
+
* <p>The configuration of the AI Agents (mapped by AI Agent Type to AI Agent version) that
|
|
3419
|
+
* should be used by Amazon Q in Connect for this Session.</p>
|
|
1590
3420
|
* @public
|
|
1591
3421
|
*/
|
|
1592
|
-
|
|
3422
|
+
aiAgentConfiguration?: Partial<Record<AIAgentType, AIAgentConfigurationData>>;
|
|
1593
3423
|
}
|
|
1594
3424
|
/**
|
|
1595
3425
|
* @public
|
|
1596
3426
|
*/
|
|
1597
|
-
export interface
|
|
1598
|
-
/**
|
|
1599
|
-
* <p>Summary information about the sessions.</p>
|
|
1600
|
-
* @public
|
|
1601
|
-
*/
|
|
1602
|
-
sessionSummaries: SessionSummary[] | undefined;
|
|
3427
|
+
export interface UpdateSessionResponse {
|
|
1603
3428
|
/**
|
|
1604
|
-
* <p>
|
|
3429
|
+
* <p>Information about the session.</p>
|
|
1605
3430
|
* @public
|
|
1606
3431
|
*/
|
|
1607
|
-
|
|
3432
|
+
session?: SessionData;
|
|
1608
3433
|
}
|
|
1609
3434
|
/**
|
|
1610
|
-
* <p>A
|
|
1611
|
-
* condition.</p>
|
|
3435
|
+
* <p>A union type that specifies the data stored on the session.</p>
|
|
1612
3436
|
* @public
|
|
1613
3437
|
*/
|
|
1614
|
-
export type
|
|
3438
|
+
export type RuntimeSessionDataValue = RuntimeSessionDataValue.StringValueMember | RuntimeSessionDataValue.$UnknownMember;
|
|
1615
3439
|
/**
|
|
1616
3440
|
* @public
|
|
1617
3441
|
*/
|
|
1618
|
-
export declare namespace
|
|
1619
|
-
/**
|
|
1620
|
-
* <p>A list of conditions which would be applied together with an <code>AND</code>
|
|
1621
|
-
* condition.</p>
|
|
1622
|
-
* @public
|
|
1623
|
-
*/
|
|
1624
|
-
interface AndConditionsMember {
|
|
1625
|
-
andConditions: TagCondition[];
|
|
1626
|
-
tagCondition?: never;
|
|
1627
|
-
$unknown?: never;
|
|
1628
|
-
}
|
|
3442
|
+
export declare namespace RuntimeSessionDataValue {
|
|
1629
3443
|
/**
|
|
1630
|
-
* <p>
|
|
3444
|
+
* <p>The string value of the data stored on the session.</p>
|
|
1631
3445
|
* @public
|
|
1632
3446
|
*/
|
|
1633
|
-
interface
|
|
1634
|
-
|
|
1635
|
-
tagCondition: TagCondition;
|
|
3447
|
+
interface StringValueMember {
|
|
3448
|
+
stringValue: string;
|
|
1636
3449
|
$unknown?: never;
|
|
1637
3450
|
}
|
|
1638
3451
|
/**
|
|
1639
3452
|
* @public
|
|
1640
3453
|
*/
|
|
1641
3454
|
interface $UnknownMember {
|
|
1642
|
-
|
|
1643
|
-
tagCondition?: never;
|
|
3455
|
+
stringValue?: never;
|
|
1644
3456
|
$unknown: [string, any];
|
|
1645
3457
|
}
|
|
1646
3458
|
interface Visitor<T> {
|
|
1647
|
-
|
|
1648
|
-
tagCondition: (value: TagCondition) => T;
|
|
3459
|
+
stringValue: (value: string) => T;
|
|
1649
3460
|
_: (name: string, value: any) => T;
|
|
1650
3461
|
}
|
|
1651
|
-
const visit: <T>(value:
|
|
3462
|
+
const visit: <T>(value: RuntimeSessionDataValue, visitor: Visitor<T>) => T;
|
|
1652
3463
|
}
|
|
1653
3464
|
/**
|
|
1654
|
-
* <p>
|
|
3465
|
+
* <p>The list of key-value pairs that are stored on the session.</p>
|
|
1655
3466
|
* @public
|
|
1656
3467
|
*/
|
|
1657
|
-
export
|
|
3468
|
+
export interface RuntimeSessionData {
|
|
3469
|
+
/**
|
|
3470
|
+
* <p>The key of the data stored on the session.</p>
|
|
3471
|
+
* @public
|
|
3472
|
+
*/
|
|
3473
|
+
key: string | undefined;
|
|
3474
|
+
/**
|
|
3475
|
+
* <p>The value of the data stored on the session.</p>
|
|
3476
|
+
* @public
|
|
3477
|
+
*/
|
|
3478
|
+
value: RuntimeSessionDataValue | undefined;
|
|
3479
|
+
}
|
|
1658
3480
|
/**
|
|
1659
3481
|
* @public
|
|
3482
|
+
* @enum
|
|
1660
3483
|
*/
|
|
1661
|
-
export declare
|
|
3484
|
+
export declare const SessionDataNamespace: {
|
|
3485
|
+
readonly Custom: "Custom";
|
|
3486
|
+
};
|
|
3487
|
+
/**
|
|
3488
|
+
* @public
|
|
3489
|
+
*/
|
|
3490
|
+
export type SessionDataNamespace = (typeof SessionDataNamespace)[keyof typeof SessionDataNamespace];
|
|
3491
|
+
/**
|
|
3492
|
+
* @public
|
|
3493
|
+
*/
|
|
3494
|
+
export interface UpdateSessionDataRequest {
|
|
1662
3495
|
/**
|
|
1663
|
-
* <p>
|
|
3496
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
3497
|
+
* cannot contain the ARN.</p>
|
|
1664
3498
|
* @public
|
|
1665
3499
|
*/
|
|
1666
|
-
|
|
1667
|
-
tagCondition: TagCondition;
|
|
1668
|
-
andConditions?: never;
|
|
1669
|
-
orConditions?: never;
|
|
1670
|
-
$unknown?: never;
|
|
1671
|
-
}
|
|
3500
|
+
assistantId: string | undefined;
|
|
1672
3501
|
/**
|
|
1673
|
-
* <p>
|
|
1674
|
-
*
|
|
3502
|
+
* <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the
|
|
3503
|
+
* ARN.</p>
|
|
1675
3504
|
* @public
|
|
1676
3505
|
*/
|
|
1677
|
-
|
|
1678
|
-
tagCondition?: never;
|
|
1679
|
-
andConditions: TagCondition[];
|
|
1680
|
-
orConditions?: never;
|
|
1681
|
-
$unknown?: never;
|
|
1682
|
-
}
|
|
3506
|
+
sessionId: string | undefined;
|
|
1683
3507
|
/**
|
|
1684
|
-
* <p>
|
|
1685
|
-
*
|
|
3508
|
+
* <p>The namespace into which the session data is stored. Supported namespaces are:
|
|
3509
|
+
* Custom</p>
|
|
1686
3510
|
* @public
|
|
1687
3511
|
*/
|
|
1688
|
-
|
|
1689
|
-
tagCondition?: never;
|
|
1690
|
-
andConditions?: never;
|
|
1691
|
-
orConditions: OrCondition[];
|
|
1692
|
-
$unknown?: never;
|
|
1693
|
-
}
|
|
3512
|
+
namespace?: SessionDataNamespace;
|
|
1694
3513
|
/**
|
|
3514
|
+
* <p>The data stored on the Amazon Q in Connect Session.</p>
|
|
1695
3515
|
* @public
|
|
1696
3516
|
*/
|
|
1697
|
-
|
|
1698
|
-
tagCondition?: never;
|
|
1699
|
-
andConditions?: never;
|
|
1700
|
-
orConditions?: never;
|
|
1701
|
-
$unknown: [string, any];
|
|
1702
|
-
}
|
|
1703
|
-
interface Visitor<T> {
|
|
1704
|
-
tagCondition: (value: TagCondition) => T;
|
|
1705
|
-
andConditions: (value: TagCondition[]) => T;
|
|
1706
|
-
orConditions: (value: OrCondition[]) => T;
|
|
1707
|
-
_: (name: string, value: any) => T;
|
|
1708
|
-
}
|
|
1709
|
-
const visit: <T>(value: TagFilter, visitor: Visitor<T>) => T;
|
|
3517
|
+
data: RuntimeSessionData[] | undefined;
|
|
1710
3518
|
}
|
|
1711
3519
|
/**
|
|
1712
3520
|
* @public
|
|
1713
3521
|
*/
|
|
1714
|
-
export interface
|
|
3522
|
+
export interface UpdateSessionDataResponse {
|
|
1715
3523
|
/**
|
|
1716
|
-
* <p>
|
|
1717
|
-
* request. If not provided, the Amazon Web Services
|
|
1718
|
-
* SDK populates this field. For more information about idempotency, see
|
|
1719
|
-
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3524
|
+
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
1720
3525
|
* @public
|
|
1721
3526
|
*/
|
|
1722
|
-
|
|
3527
|
+
sessionArn: string | undefined;
|
|
1723
3528
|
/**
|
|
1724
|
-
* <p>The identifier of the
|
|
3529
|
+
* <p>The identifier of the session.</p>
|
|
1725
3530
|
* @public
|
|
1726
3531
|
*/
|
|
1727
|
-
|
|
3532
|
+
sessionId: string | undefined;
|
|
1728
3533
|
/**
|
|
1729
|
-
* <p>The
|
|
3534
|
+
* <p>The namespace into which the session data is stored. Supported namespaces are:
|
|
3535
|
+
* Custom</p>
|
|
1730
3536
|
* @public
|
|
1731
3537
|
*/
|
|
1732
|
-
|
|
3538
|
+
namespace: SessionDataNamespace | undefined;
|
|
1733
3539
|
/**
|
|
1734
|
-
* <p>
|
|
3540
|
+
* <p>Data stored in the session.</p>
|
|
1735
3541
|
* @public
|
|
1736
3542
|
*/
|
|
1737
|
-
|
|
3543
|
+
data: RuntimeSessionData[] | undefined;
|
|
3544
|
+
}
|
|
3545
|
+
/**
|
|
3546
|
+
* @public
|
|
3547
|
+
*/
|
|
3548
|
+
export interface UpdateAssistantAIAgentRequest {
|
|
1738
3549
|
/**
|
|
1739
|
-
* <p>The
|
|
3550
|
+
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs
|
|
3551
|
+
* cannot contain the ARN.</p>
|
|
1740
3552
|
* @public
|
|
1741
3553
|
*/
|
|
1742
|
-
|
|
3554
|
+
assistantId: string | undefined;
|
|
1743
3555
|
/**
|
|
1744
|
-
* <p>
|
|
3556
|
+
* <p>The type of the AI Agent being updated for use by default on the Amazon Q in Connect
|
|
3557
|
+
* Assistant.</p>
|
|
1745
3558
|
* @public
|
|
1746
3559
|
*/
|
|
1747
|
-
|
|
3560
|
+
aiAgentType: AIAgentType | undefined;
|
|
3561
|
+
/**
|
|
3562
|
+
* <p>The configuration of the AI Agent being updated for use by default on the Amazon Q in
|
|
3563
|
+
* Connect Assistant.</p>
|
|
3564
|
+
* @public
|
|
3565
|
+
*/
|
|
3566
|
+
configuration: AIAgentConfigurationData | undefined;
|
|
1748
3567
|
}
|
|
1749
3568
|
/**
|
|
1750
|
-
* <p>The configuration information for the session integration.</p>
|
|
1751
3569
|
* @public
|
|
1752
3570
|
*/
|
|
1753
|
-
export interface
|
|
3571
|
+
export interface UpdateAssistantAIAgentResponse {
|
|
1754
3572
|
/**
|
|
1755
|
-
* <p>The
|
|
3573
|
+
* <p>The assistant data.</p>
|
|
1756
3574
|
* @public
|
|
1757
3575
|
*/
|
|
1758
|
-
|
|
3576
|
+
assistant?: AssistantData;
|
|
1759
3577
|
}
|
|
1760
3578
|
/**
|
|
1761
|
-
* <p>
|
|
3579
|
+
* <p>Instructions for interpreting the contents of a document.</p>
|
|
1762
3580
|
* @public
|
|
1763
3581
|
*/
|
|
1764
|
-
export interface
|
|
1765
|
-
/**
|
|
1766
|
-
* <p>The Amazon Resource Name (ARN) of the session.</p>
|
|
1767
|
-
* @public
|
|
1768
|
-
*/
|
|
1769
|
-
sessionArn: string | undefined;
|
|
1770
|
-
/**
|
|
1771
|
-
* <p>The identifier of the session.</p>
|
|
1772
|
-
* @public
|
|
1773
|
-
*/
|
|
1774
|
-
sessionId: string | undefined;
|
|
1775
|
-
/**
|
|
1776
|
-
* <p>The name of the session.</p>
|
|
1777
|
-
* @public
|
|
1778
|
-
*/
|
|
1779
|
-
name: string | undefined;
|
|
1780
|
-
/**
|
|
1781
|
-
* <p>The description of the session.</p>
|
|
1782
|
-
* @public
|
|
1783
|
-
*/
|
|
1784
|
-
description?: string;
|
|
3582
|
+
export interface ParsingPrompt {
|
|
1785
3583
|
/**
|
|
1786
|
-
* <p>
|
|
3584
|
+
* <p>Instructions for interpreting the contents of a document.</p>
|
|
1787
3585
|
* @public
|
|
1788
3586
|
*/
|
|
1789
|
-
|
|
3587
|
+
parsingPromptText: string | undefined;
|
|
3588
|
+
}
|
|
3589
|
+
/**
|
|
3590
|
+
* <p>Settings for a foundation model used to parse documents for a data source.</p>
|
|
3591
|
+
* @public
|
|
3592
|
+
*/
|
|
3593
|
+
export interface BedrockFoundationModelConfigurationForParsing {
|
|
1790
3594
|
/**
|
|
1791
|
-
* <p>The
|
|
3595
|
+
* <p>The ARN of the foundation model.</p>
|
|
1792
3596
|
* @public
|
|
1793
3597
|
*/
|
|
1794
|
-
|
|
3598
|
+
modelArn: string | undefined;
|
|
1795
3599
|
/**
|
|
1796
|
-
* <p>
|
|
3600
|
+
* <p>Instructions for interpreting the contents of a document.</p>
|
|
1797
3601
|
* @public
|
|
1798
3602
|
*/
|
|
1799
|
-
|
|
3603
|
+
parsingPrompt?: ParsingPrompt;
|
|
1800
3604
|
}
|
|
1801
3605
|
/**
|
|
1802
3606
|
* @public
|
|
3607
|
+
* @enum
|
|
1803
3608
|
*/
|
|
1804
|
-
export
|
|
3609
|
+
export declare const ChunkingStrategy: {
|
|
3610
|
+
readonly FIXED_SIZE: "FIXED_SIZE";
|
|
3611
|
+
readonly HIERARCHICAL: "HIERARCHICAL";
|
|
3612
|
+
readonly NONE: "NONE";
|
|
3613
|
+
readonly SEMANTIC: "SEMANTIC";
|
|
3614
|
+
};
|
|
3615
|
+
/**
|
|
3616
|
+
* @public
|
|
3617
|
+
*/
|
|
3618
|
+
export type ChunkingStrategy = (typeof ChunkingStrategy)[keyof typeof ChunkingStrategy];
|
|
3619
|
+
/**
|
|
3620
|
+
* <p>Configurations for when you choose fixed-size chunking. If you set the
|
|
3621
|
+
* <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
|
|
3622
|
+
* @public
|
|
3623
|
+
*/
|
|
3624
|
+
export interface FixedSizeChunkingConfiguration {
|
|
1805
3625
|
/**
|
|
1806
|
-
* <p>The
|
|
3626
|
+
* <p>The maximum number of tokens to include in a chunk.</p>
|
|
1807
3627
|
* @public
|
|
1808
3628
|
*/
|
|
1809
|
-
|
|
3629
|
+
maxTokens: number | undefined;
|
|
3630
|
+
/**
|
|
3631
|
+
* <p>The percentage of overlap between adjacent chunks of a data source.</p>
|
|
3632
|
+
* @public
|
|
3633
|
+
*/
|
|
3634
|
+
overlapPercentage: number | undefined;
|
|
1810
3635
|
}
|
|
1811
3636
|
/**
|
|
3637
|
+
* <p>Token settings for each layer.</p>
|
|
1812
3638
|
* @public
|
|
1813
3639
|
*/
|
|
1814
|
-
export interface
|
|
1815
|
-
/**
|
|
1816
|
-
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1817
|
-
* @public
|
|
1818
|
-
*/
|
|
1819
|
-
assistantId: string | undefined;
|
|
3640
|
+
export interface HierarchicalChunkingLevelConfiguration {
|
|
1820
3641
|
/**
|
|
1821
|
-
* <p>The
|
|
3642
|
+
* <p>The maximum number of tokens that a chunk can contain in this layer.</p>
|
|
1822
3643
|
* @public
|
|
1823
3644
|
*/
|
|
1824
|
-
|
|
3645
|
+
maxTokens: number | undefined;
|
|
1825
3646
|
}
|
|
1826
3647
|
/**
|
|
3648
|
+
* <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking
|
|
3649
|
+
* splits documents into layers of chunks where the first layer contains large chunks, and the
|
|
3650
|
+
* second layer contains smaller chunks derived from the first layer.</p>
|
|
1827
3651
|
* @public
|
|
1828
3652
|
*/
|
|
1829
|
-
export interface
|
|
3653
|
+
export interface HierarchicalChunkingConfiguration {
|
|
1830
3654
|
/**
|
|
1831
|
-
* <p>
|
|
3655
|
+
* <p>Token settings for each layer.</p>
|
|
1832
3656
|
* @public
|
|
1833
3657
|
*/
|
|
1834
|
-
|
|
3658
|
+
levelConfigurations: HierarchicalChunkingLevelConfiguration[] | undefined;
|
|
3659
|
+
/**
|
|
3660
|
+
* <p>The number of tokens to repeat across chunks in the same layer.</p>
|
|
3661
|
+
* @public
|
|
3662
|
+
*/
|
|
3663
|
+
overlapTokens: number | undefined;
|
|
1835
3664
|
}
|
|
1836
3665
|
/**
|
|
3666
|
+
* <p>Settings for semantic document chunking for a data source. Semantic chunking splits a
|
|
3667
|
+
* document into smaller documents based on groups of similar content derived from the text with
|
|
3668
|
+
* natural language processing.</p>
|
|
1837
3669
|
* @public
|
|
1838
3670
|
*/
|
|
1839
|
-
export interface
|
|
1840
|
-
/**
|
|
1841
|
-
* <p>The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
|
|
1842
|
-
* @public
|
|
1843
|
-
*/
|
|
1844
|
-
assistantId: string | undefined;
|
|
3671
|
+
export interface SemanticChunkingConfiguration {
|
|
1845
3672
|
/**
|
|
1846
|
-
* <p>The
|
|
3673
|
+
* <p>The maximum number of tokens that a chunk can contain.</p>
|
|
1847
3674
|
* @public
|
|
1848
3675
|
*/
|
|
1849
|
-
|
|
3676
|
+
maxTokens: number | undefined;
|
|
1850
3677
|
/**
|
|
1851
|
-
* <p>The
|
|
3678
|
+
* <p>The buffer size.</p>
|
|
1852
3679
|
* @public
|
|
1853
3680
|
*/
|
|
1854
|
-
|
|
3681
|
+
bufferSize: number | undefined;
|
|
1855
3682
|
/**
|
|
1856
|
-
* <p>
|
|
3683
|
+
* <p>The dissimilarity threshold for splitting chunks.</p>
|
|
1857
3684
|
* @public
|
|
1858
3685
|
*/
|
|
1859
|
-
|
|
3686
|
+
breakpointPercentileThreshold: number | undefined;
|
|
1860
3687
|
}
|
|
1861
3688
|
/**
|
|
3689
|
+
* <p>Details about how to chunk the documents in the data source. A chunk refers to an excerpt
|
|
3690
|
+
* from a data source that is returned when the knowledge base that it belongs to is
|
|
3691
|
+
* queried.</p>
|
|
1862
3692
|
* @public
|
|
1863
3693
|
*/
|
|
1864
|
-
export interface
|
|
3694
|
+
export interface ChunkingConfiguration {
|
|
1865
3695
|
/**
|
|
1866
|
-
* <p>
|
|
3696
|
+
* <p>Knowledge base can split your source data into chunks. A chunk refers to an excerpt from a
|
|
3697
|
+
* data source that is returned when the knowledge base that it belongs to is queried. You have
|
|
3698
|
+
* the following options for chunking your data. If you opt for <code>NONE</code>, then you may
|
|
3699
|
+
* want to pre-process your files by splitting them up such that each file corresponds to a
|
|
3700
|
+
* chunk.</p>
|
|
1867
3701
|
* @public
|
|
1868
3702
|
*/
|
|
1869
|
-
|
|
3703
|
+
chunkingStrategy: ChunkingStrategy | undefined;
|
|
3704
|
+
/**
|
|
3705
|
+
* <p>Configurations for when you choose fixed-size chunking. If you set the
|
|
3706
|
+
* <code>chunkingStrategy</code> as <code>NONE</code>, exclude this field.</p>
|
|
3707
|
+
* @public
|
|
3708
|
+
*/
|
|
3709
|
+
fixedSizeChunkingConfiguration?: FixedSizeChunkingConfiguration;
|
|
3710
|
+
/**
|
|
3711
|
+
* <p>Settings for hierarchical document chunking for a data source. Hierarchical chunking
|
|
3712
|
+
* splits documents into layers of chunks where the first layer contains large chunks, and the
|
|
3713
|
+
* second layer contains smaller chunks derived from the first layer.</p>
|
|
3714
|
+
* @public
|
|
3715
|
+
*/
|
|
3716
|
+
hierarchicalChunkingConfiguration?: HierarchicalChunkingConfiguration;
|
|
3717
|
+
/**
|
|
3718
|
+
* <p>Settings for semantic document chunking for a data source. Semantic chunking splits a
|
|
3719
|
+
* document into smaller documents based on groups of similar content derived from the text with
|
|
3720
|
+
* natural language processing.</p>
|
|
3721
|
+
* @public
|
|
3722
|
+
*/
|
|
3723
|
+
semanticChunkingConfiguration?: SemanticChunkingConfiguration;
|
|
1870
3724
|
}
|
|
1871
3725
|
/**
|
|
1872
3726
|
* <p>The configuration information of the Amazon Connect data source.</p>
|
|
@@ -2049,19 +3903,6 @@ export interface CreateContentAssociationResponse {
|
|
|
2049
3903
|
*/
|
|
2050
3904
|
contentAssociation?: ContentAssociationData;
|
|
2051
3905
|
}
|
|
2052
|
-
/**
|
|
2053
|
-
* <p>The throttling limit has been exceeded.</p>
|
|
2054
|
-
* @public
|
|
2055
|
-
*/
|
|
2056
|
-
export declare class ThrottlingException extends __BaseException {
|
|
2057
|
-
readonly name: "ThrottlingException";
|
|
2058
|
-
readonly $fault: "client";
|
|
2059
|
-
$retryable: {};
|
|
2060
|
-
/**
|
|
2061
|
-
* @internal
|
|
2062
|
-
*/
|
|
2063
|
-
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
2064
|
-
}
|
|
2065
3906
|
/**
|
|
2066
3907
|
* @public
|
|
2067
3908
|
*/
|
|
@@ -2617,6 +4458,8 @@ export interface UpdateContentResponse {
|
|
|
2617
4458
|
export declare const KnowledgeBaseType: {
|
|
2618
4459
|
readonly CUSTOM: "CUSTOM";
|
|
2619
4460
|
readonly EXTERNAL: "EXTERNAL";
|
|
4461
|
+
readonly MANAGED: "MANAGED";
|
|
4462
|
+
readonly MESSAGE_TEMPLATES: "MESSAGE_TEMPLATES";
|
|
2620
4463
|
readonly QUICK_RESPONSES: "QUICK_RESPONSES";
|
|
2621
4464
|
};
|
|
2622
4465
|
/**
|
|
@@ -2654,11 +4497,128 @@ export interface RenderingConfiguration {
|
|
|
2654
4497
|
*/
|
|
2655
4498
|
templateUri?: string;
|
|
2656
4499
|
}
|
|
4500
|
+
/**
|
|
4501
|
+
* <p>The configuration of crawl limits for the web URLs.</p>
|
|
4502
|
+
* @public
|
|
4503
|
+
*/
|
|
4504
|
+
export interface WebCrawlerLimits {
|
|
4505
|
+
/**
|
|
4506
|
+
* <p>Rate of web URLs retrieved per minute.</p>
|
|
4507
|
+
* @public
|
|
4508
|
+
*/
|
|
4509
|
+
rateLimit?: number;
|
|
4510
|
+
}
|
|
4511
|
+
/**
|
|
4512
|
+
* @public
|
|
4513
|
+
* @enum
|
|
4514
|
+
*/
|
|
4515
|
+
export declare const WebScopeType: {
|
|
4516
|
+
readonly HOST_ONLY: "HOST_ONLY";
|
|
4517
|
+
readonly SUBDOMAINS: "SUBDOMAINS";
|
|
4518
|
+
};
|
|
4519
|
+
/**
|
|
4520
|
+
* @public
|
|
4521
|
+
*/
|
|
4522
|
+
export type WebScopeType = (typeof WebScopeType)[keyof typeof WebScopeType];
|
|
4523
|
+
/**
|
|
4524
|
+
* <p>A URL for crawling.</p>
|
|
4525
|
+
* @public
|
|
4526
|
+
*/
|
|
4527
|
+
export interface SeedUrl {
|
|
4528
|
+
/**
|
|
4529
|
+
* <p>URL for crawling</p>
|
|
4530
|
+
* @public
|
|
4531
|
+
*/
|
|
4532
|
+
url?: string;
|
|
4533
|
+
}
|
|
4534
|
+
/**
|
|
4535
|
+
* <p>The configuration of the URL/URLs for the web content that you want to crawl. You should
|
|
4536
|
+
* be authorized to crawl the URLs.</p>
|
|
4537
|
+
* @public
|
|
4538
|
+
*/
|
|
4539
|
+
export interface UrlConfiguration {
|
|
4540
|
+
/**
|
|
4541
|
+
* <p>List of URLs for crawling.</p>
|
|
4542
|
+
* @public
|
|
4543
|
+
*/
|
|
4544
|
+
seedUrls?: SeedUrl[];
|
|
4545
|
+
}
|
|
4546
|
+
/**
|
|
4547
|
+
* <p>The configuration details for the web data source.</p>
|
|
4548
|
+
* @public
|
|
4549
|
+
*/
|
|
4550
|
+
export interface WebCrawlerConfiguration {
|
|
4551
|
+
/**
|
|
4552
|
+
* <p>The configuration of the URL/URLs for the web content that you want to crawl. You should
|
|
4553
|
+
* be authorized to crawl the URLs.</p>
|
|
4554
|
+
* @public
|
|
4555
|
+
*/
|
|
4556
|
+
urlConfiguration: UrlConfiguration | undefined;
|
|
4557
|
+
/**
|
|
4558
|
+
* <p>The configuration of crawl limits for the web URLs.</p>
|
|
4559
|
+
* @public
|
|
4560
|
+
*/
|
|
4561
|
+
crawlerLimits?: WebCrawlerLimits;
|
|
4562
|
+
/**
|
|
4563
|
+
* <p>A list of one or more inclusion regular expression patterns to include certain URLs. If
|
|
4564
|
+
* you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion
|
|
4565
|
+
* filter takes precedence and the web content of the URL isn’t crawled.</p>
|
|
4566
|
+
* @public
|
|
4567
|
+
*/
|
|
4568
|
+
inclusionFilters?: string[];
|
|
4569
|
+
/**
|
|
4570
|
+
* <p>A list of one or more exclusion regular expression patterns to exclude certain URLs. If
|
|
4571
|
+
* you specify an inclusion and exclusion filter/pattern and both match a URL, the exclusion
|
|
4572
|
+
* filter takes precedence and the web content of the URL isn’t crawled.</p>
|
|
4573
|
+
* @public
|
|
4574
|
+
*/
|
|
4575
|
+
exclusionFilters?: string[];
|
|
4576
|
+
/**
|
|
4577
|
+
* <p>The scope of what is crawled for your URLs. You can choose to crawl only web pages that
|
|
4578
|
+
* belong to the same host or primary domain. For example, only web pages that contain the seed
|
|
4579
|
+
* URL <code>https://docs.aws.amazon.com/bedrock/latest/userguide/</code> and no other domains.
|
|
4580
|
+
* You can choose to include sub domains in addition to the host or primary domain. For example,
|
|
4581
|
+
* web pages that contain <code>aws.amazon.com</code> can also include sub domain
|
|
4582
|
+
* <code>docs.aws.amazon.com</code>.</p>
|
|
4583
|
+
* @public
|
|
4584
|
+
*/
|
|
4585
|
+
scope?: WebScopeType;
|
|
4586
|
+
}
|
|
4587
|
+
/**
|
|
4588
|
+
* <p>Source configuration for managed resources.</p>
|
|
4589
|
+
* @public
|
|
4590
|
+
*/
|
|
4591
|
+
export type ManagedSourceConfiguration = ManagedSourceConfiguration.WebCrawlerConfigurationMember | ManagedSourceConfiguration.$UnknownMember;
|
|
4592
|
+
/**
|
|
4593
|
+
* @public
|
|
4594
|
+
*/
|
|
4595
|
+
export declare namespace ManagedSourceConfiguration {
|
|
4596
|
+
/**
|
|
4597
|
+
* <p>Configuration data for web crawler data source.</p>
|
|
4598
|
+
* @public
|
|
4599
|
+
*/
|
|
4600
|
+
interface WebCrawlerConfigurationMember {
|
|
4601
|
+
webCrawlerConfiguration: WebCrawlerConfiguration;
|
|
4602
|
+
$unknown?: never;
|
|
4603
|
+
}
|
|
4604
|
+
/**
|
|
4605
|
+
* @public
|
|
4606
|
+
*/
|
|
4607
|
+
interface $UnknownMember {
|
|
4608
|
+
webCrawlerConfiguration?: never;
|
|
4609
|
+
$unknown: [string, any];
|
|
4610
|
+
}
|
|
4611
|
+
interface Visitor<T> {
|
|
4612
|
+
webCrawlerConfiguration: (value: WebCrawlerConfiguration) => T;
|
|
4613
|
+
_: (name: string, value: any) => T;
|
|
4614
|
+
}
|
|
4615
|
+
const visit: <T>(value: ManagedSourceConfiguration, visitor: Visitor<T>) => T;
|
|
4616
|
+
}
|
|
2657
4617
|
/**
|
|
2658
4618
|
* <p>Configuration information about the external data source.</p>
|
|
2659
4619
|
* @public
|
|
2660
4620
|
*/
|
|
2661
|
-
export type SourceConfiguration = SourceConfiguration.AppIntegrationsMember | SourceConfiguration.$UnknownMember;
|
|
4621
|
+
export type SourceConfiguration = SourceConfiguration.AppIntegrationsMember | SourceConfiguration.ManagedSourceConfigurationMember | SourceConfiguration.$UnknownMember;
|
|
2662
4622
|
/**
|
|
2663
4623
|
* @public
|
|
2664
4624
|
*/
|
|
@@ -2669,6 +4629,16 @@ export declare namespace SourceConfiguration {
|
|
|
2669
4629
|
*/
|
|
2670
4630
|
interface AppIntegrationsMember {
|
|
2671
4631
|
appIntegrations: AppIntegrationsConfiguration;
|
|
4632
|
+
managedSourceConfiguration?: never;
|
|
4633
|
+
$unknown?: never;
|
|
4634
|
+
}
|
|
4635
|
+
/**
|
|
4636
|
+
* <p>Source configuration for managed resources.</p>
|
|
4637
|
+
* @public
|
|
4638
|
+
*/
|
|
4639
|
+
interface ManagedSourceConfigurationMember {
|
|
4640
|
+
appIntegrations?: never;
|
|
4641
|
+
managedSourceConfiguration: ManagedSourceConfiguration;
|
|
2672
4642
|
$unknown?: never;
|
|
2673
4643
|
}
|
|
2674
4644
|
/**
|
|
@@ -2676,14 +4646,64 @@ export declare namespace SourceConfiguration {
|
|
|
2676
4646
|
*/
|
|
2677
4647
|
interface $UnknownMember {
|
|
2678
4648
|
appIntegrations?: never;
|
|
4649
|
+
managedSourceConfiguration?: never;
|
|
2679
4650
|
$unknown: [string, any];
|
|
2680
4651
|
}
|
|
2681
4652
|
interface Visitor<T> {
|
|
2682
4653
|
appIntegrations: (value: AppIntegrationsConfiguration) => T;
|
|
4654
|
+
managedSourceConfiguration: (value: ManagedSourceConfiguration) => T;
|
|
2683
4655
|
_: (name: string, value: any) => T;
|
|
2684
4656
|
}
|
|
2685
4657
|
const visit: <T>(value: SourceConfiguration, visitor: Visitor<T>) => T;
|
|
2686
4658
|
}
|
|
4659
|
+
/**
|
|
4660
|
+
* @public
|
|
4661
|
+
* @enum
|
|
4662
|
+
*/
|
|
4663
|
+
export declare const ParsingStrategy: {
|
|
4664
|
+
readonly BEDROCK_FOUNDATION_MODEL: "BEDROCK_FOUNDATION_MODEL";
|
|
4665
|
+
};
|
|
4666
|
+
/**
|
|
4667
|
+
* @public
|
|
4668
|
+
*/
|
|
4669
|
+
export type ParsingStrategy = (typeof ParsingStrategy)[keyof typeof ParsingStrategy];
|
|
4670
|
+
/**
|
|
4671
|
+
* <p>Settings for parsing document contents. By default, the service converts the contents of
|
|
4672
|
+
* each document into text before splitting it into chunks. To improve processing of PDF files
|
|
4673
|
+
* with tables and images, you can configure the data source to convert the pages of text into
|
|
4674
|
+
* images and use a model to describe the contents of each page.</p>
|
|
4675
|
+
* @public
|
|
4676
|
+
*/
|
|
4677
|
+
export interface ParsingConfiguration {
|
|
4678
|
+
/**
|
|
4679
|
+
* <p>The parsing strategy for the data source.</p>
|
|
4680
|
+
* @public
|
|
4681
|
+
*/
|
|
4682
|
+
parsingStrategy: ParsingStrategy | undefined;
|
|
4683
|
+
/**
|
|
4684
|
+
* <p>Settings for a foundation model used to parse documents for a data source.</p>
|
|
4685
|
+
* @public
|
|
4686
|
+
*/
|
|
4687
|
+
bedrockFoundationModelConfiguration?: BedrockFoundationModelConfigurationForParsing;
|
|
4688
|
+
}
|
|
4689
|
+
/**
|
|
4690
|
+
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
4691
|
+
* @public
|
|
4692
|
+
*/
|
|
4693
|
+
export interface VectorIngestionConfiguration {
|
|
4694
|
+
/**
|
|
4695
|
+
* <p>Details about how to chunk the documents in the data source. A chunk refers to an excerpt
|
|
4696
|
+
* from a data source that is returned when the knowledge base that it belongs to is
|
|
4697
|
+
* queried.</p>
|
|
4698
|
+
* @public
|
|
4699
|
+
*/
|
|
4700
|
+
chunkingConfiguration?: ChunkingConfiguration;
|
|
4701
|
+
/**
|
|
4702
|
+
* <p>A custom parser for data source documents.</p>
|
|
4703
|
+
* @public
|
|
4704
|
+
*/
|
|
4705
|
+
parsingConfiguration?: ParsingConfiguration;
|
|
4706
|
+
}
|
|
2687
4707
|
/**
|
|
2688
4708
|
* @public
|
|
2689
4709
|
*/
|
|
@@ -2719,6 +4739,11 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
2719
4739
|
* @public
|
|
2720
4740
|
*/
|
|
2721
4741
|
renderingConfiguration?: RenderingConfiguration;
|
|
4742
|
+
/**
|
|
4743
|
+
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
4744
|
+
* @public
|
|
4745
|
+
*/
|
|
4746
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
2722
4747
|
/**
|
|
2723
4748
|
* <p>The configuration information for the customer managed key used for encryption. </p>
|
|
2724
4749
|
* <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
|
|
@@ -2741,6 +4766,20 @@ export interface CreateKnowledgeBaseRequest {
|
|
|
2741
4766
|
*/
|
|
2742
4767
|
tags?: Record<string, string>;
|
|
2743
4768
|
}
|
|
4769
|
+
/**
|
|
4770
|
+
* @public
|
|
4771
|
+
* @enum
|
|
4772
|
+
*/
|
|
4773
|
+
export declare const SyncStatus: {
|
|
4774
|
+
readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
|
|
4775
|
+
readonly SYNCING_IN_PROGRESS: "SYNCING_IN_PROGRESS";
|
|
4776
|
+
readonly SYNC_FAILED: "SYNC_FAILED";
|
|
4777
|
+
readonly SYNC_SUCCESS: "SYNC_SUCCESS";
|
|
4778
|
+
};
|
|
4779
|
+
/**
|
|
4780
|
+
* @public
|
|
4781
|
+
*/
|
|
4782
|
+
export type SyncStatus = (typeof SyncStatus)[keyof typeof SyncStatus];
|
|
2744
4783
|
/**
|
|
2745
4784
|
* @public
|
|
2746
4785
|
* @enum
|
|
@@ -2793,6 +4832,11 @@ export interface KnowledgeBaseData {
|
|
|
2793
4832
|
* @public
|
|
2794
4833
|
*/
|
|
2795
4834
|
lastContentModificationTime?: Date;
|
|
4835
|
+
/**
|
|
4836
|
+
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
4837
|
+
* @public
|
|
4838
|
+
*/
|
|
4839
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
2796
4840
|
/**
|
|
2797
4841
|
* <p>Source configuration information about the knowledge base.</p>
|
|
2798
4842
|
* @public
|
|
@@ -2824,6 +4868,16 @@ export interface KnowledgeBaseData {
|
|
|
2824
4868
|
* @public
|
|
2825
4869
|
*/
|
|
2826
4870
|
tags?: Record<string, string>;
|
|
4871
|
+
/**
|
|
4872
|
+
* <p>Status of ingestion on data source.</p>
|
|
4873
|
+
* @public
|
|
4874
|
+
*/
|
|
4875
|
+
ingestionStatus?: SyncStatus;
|
|
4876
|
+
/**
|
|
4877
|
+
* <p>List of failure reasons on ingestion per file.</p>
|
|
4878
|
+
* @public
|
|
4879
|
+
*/
|
|
4880
|
+
ingestionFailureReasons?: string[];
|
|
2827
4881
|
}
|
|
2828
4882
|
/**
|
|
2829
4883
|
* @public
|
|
@@ -3558,6 +5612,11 @@ export interface KnowledgeBaseSummary {
|
|
|
3558
5612
|
* @public
|
|
3559
5613
|
*/
|
|
3560
5614
|
sourceConfiguration?: SourceConfiguration;
|
|
5615
|
+
/**
|
|
5616
|
+
* <p>Contains details about how to ingest the documents in a data source.</p>
|
|
5617
|
+
* @public
|
|
5618
|
+
*/
|
|
5619
|
+
vectorIngestionConfiguration?: VectorIngestionConfiguration;
|
|
3561
5620
|
/**
|
|
3562
5621
|
* <p>Information about how to render the content.</p>
|
|
3563
5622
|
* @public
|
|
@@ -4498,7 +6557,7 @@ export interface UntagResourceResponse {
|
|
|
4498
6557
|
* <p>Details about the data.</p>
|
|
4499
6558
|
* @public
|
|
4500
6559
|
*/
|
|
4501
|
-
export type DataDetails = DataDetails.ContentDataMember | DataDetails.GenerativeDataMember | DataDetails.SourceContentDataMember | DataDetails.$UnknownMember;
|
|
6560
|
+
export type DataDetails = DataDetails.ContentDataMember | DataDetails.GenerativeDataMember | DataDetails.IntentDetectedDataMember | DataDetails.SourceContentDataMember | DataDetails.$UnknownMember;
|
|
4502
6561
|
/**
|
|
4503
6562
|
* @public
|
|
4504
6563
|
*/
|
|
@@ -4510,6 +6569,7 @@ export declare namespace DataDetails {
|
|
|
4510
6569
|
interface ContentDataMember {
|
|
4511
6570
|
contentData: ContentDataDetails;
|
|
4512
6571
|
generativeData?: never;
|
|
6572
|
+
intentDetectedData?: never;
|
|
4513
6573
|
sourceContentData?: never;
|
|
4514
6574
|
$unknown?: never;
|
|
4515
6575
|
}
|
|
@@ -4520,6 +6580,18 @@ export declare namespace DataDetails {
|
|
|
4520
6580
|
interface GenerativeDataMember {
|
|
4521
6581
|
contentData?: never;
|
|
4522
6582
|
generativeData: GenerativeDataDetails;
|
|
6583
|
+
intentDetectedData?: never;
|
|
6584
|
+
sourceContentData?: never;
|
|
6585
|
+
$unknown?: never;
|
|
6586
|
+
}
|
|
6587
|
+
/**
|
|
6588
|
+
* <p>Details about the intent data.</p>
|
|
6589
|
+
* @public
|
|
6590
|
+
*/
|
|
6591
|
+
interface IntentDetectedDataMember {
|
|
6592
|
+
contentData?: never;
|
|
6593
|
+
generativeData?: never;
|
|
6594
|
+
intentDetectedData: IntentDetectedDataDetails;
|
|
4523
6595
|
sourceContentData?: never;
|
|
4524
6596
|
$unknown?: never;
|
|
4525
6597
|
}
|
|
@@ -4530,6 +6602,7 @@ export declare namespace DataDetails {
|
|
|
4530
6602
|
interface SourceContentDataMember {
|
|
4531
6603
|
contentData?: never;
|
|
4532
6604
|
generativeData?: never;
|
|
6605
|
+
intentDetectedData?: never;
|
|
4533
6606
|
sourceContentData: SourceContentDataDetails;
|
|
4534
6607
|
$unknown?: never;
|
|
4535
6608
|
}
|
|
@@ -4539,12 +6612,14 @@ export declare namespace DataDetails {
|
|
|
4539
6612
|
interface $UnknownMember {
|
|
4540
6613
|
contentData?: never;
|
|
4541
6614
|
generativeData?: never;
|
|
6615
|
+
intentDetectedData?: never;
|
|
4542
6616
|
sourceContentData?: never;
|
|
4543
6617
|
$unknown: [string, any];
|
|
4544
6618
|
}
|
|
4545
6619
|
interface Visitor<T> {
|
|
4546
6620
|
contentData: (value: ContentDataDetails) => T;
|
|
4547
6621
|
generativeData: (value: GenerativeDataDetails) => T;
|
|
6622
|
+
intentDetectedData: (value: IntentDetectedDataDetails) => T;
|
|
4548
6623
|
sourceContentData: (value: SourceContentDataDetails) => T;
|
|
4549
6624
|
_: (name: string, value: any) => T;
|
|
4550
6625
|
}
|
|
@@ -4684,6 +6759,42 @@ export interface QueryAssistantResponse {
|
|
|
4684
6759
|
*/
|
|
4685
6760
|
nextToken?: string;
|
|
4686
6761
|
}
|
|
6762
|
+
/**
|
|
6763
|
+
* @internal
|
|
6764
|
+
*/
|
|
6765
|
+
export declare const TextFullAIPromptEditTemplateConfigurationFilterSensitiveLog: (obj: TextFullAIPromptEditTemplateConfiguration) => any;
|
|
6766
|
+
/**
|
|
6767
|
+
* @internal
|
|
6768
|
+
*/
|
|
6769
|
+
export declare const AIPromptTemplateConfigurationFilterSensitiveLog: (obj: AIPromptTemplateConfiguration) => any;
|
|
6770
|
+
/**
|
|
6771
|
+
* @internal
|
|
6772
|
+
*/
|
|
6773
|
+
export declare const CreateAIPromptRequestFilterSensitiveLog: (obj: CreateAIPromptRequest) => any;
|
|
6774
|
+
/**
|
|
6775
|
+
* @internal
|
|
6776
|
+
*/
|
|
6777
|
+
export declare const AIPromptDataFilterSensitiveLog: (obj: AIPromptData) => any;
|
|
6778
|
+
/**
|
|
6779
|
+
* @internal
|
|
6780
|
+
*/
|
|
6781
|
+
export declare const CreateAIPromptResponseFilterSensitiveLog: (obj: CreateAIPromptResponse) => any;
|
|
6782
|
+
/**
|
|
6783
|
+
* @internal
|
|
6784
|
+
*/
|
|
6785
|
+
export declare const CreateAIPromptVersionResponseFilterSensitiveLog: (obj: CreateAIPromptVersionResponse) => any;
|
|
6786
|
+
/**
|
|
6787
|
+
* @internal
|
|
6788
|
+
*/
|
|
6789
|
+
export declare const GetAIPromptResponseFilterSensitiveLog: (obj: GetAIPromptResponse) => any;
|
|
6790
|
+
/**
|
|
6791
|
+
* @internal
|
|
6792
|
+
*/
|
|
6793
|
+
export declare const UpdateAIPromptRequestFilterSensitiveLog: (obj: UpdateAIPromptRequest) => any;
|
|
6794
|
+
/**
|
|
6795
|
+
* @internal
|
|
6796
|
+
*/
|
|
6797
|
+
export declare const UpdateAIPromptResponseFilterSensitiveLog: (obj: UpdateAIPromptResponse) => any;
|
|
4687
6798
|
/**
|
|
4688
6799
|
* @internal
|
|
4689
6800
|
*/
|
|
@@ -4696,6 +6807,10 @@ export declare const TextDataFilterSensitiveLog: (obj: TextData) => any;
|
|
|
4696
6807
|
* @internal
|
|
4697
6808
|
*/
|
|
4698
6809
|
export declare const ContentDataDetailsFilterSensitiveLog: (obj: ContentDataDetails) => any;
|
|
6810
|
+
/**
|
|
6811
|
+
* @internal
|
|
6812
|
+
*/
|
|
6813
|
+
export declare const IntentDetectedDataDetailsFilterSensitiveLog: (obj: IntentDetectedDataDetails) => any;
|
|
4699
6814
|
/**
|
|
4700
6815
|
* @internal
|
|
4701
6816
|
*/
|
|
@@ -4716,10 +6831,34 @@ export declare const RecommendationTriggerDataFilterSensitiveLog: (obj: Recommen
|
|
|
4716
6831
|
* @internal
|
|
4717
6832
|
*/
|
|
4718
6833
|
export declare const RecommendationTriggerFilterSensitiveLog: (obj: RecommendationTrigger) => any;
|
|
6834
|
+
/**
|
|
6835
|
+
* @internal
|
|
6836
|
+
*/
|
|
6837
|
+
export declare const QueryTextInputDataFilterSensitiveLog: (obj: QueryTextInputData) => any;
|
|
6838
|
+
/**
|
|
6839
|
+
* @internal
|
|
6840
|
+
*/
|
|
6841
|
+
export declare const QueryInputDataFilterSensitiveLog: (obj: QueryInputData) => any;
|
|
4719
6842
|
/**
|
|
4720
6843
|
* @internal
|
|
4721
6844
|
*/
|
|
4722
6845
|
export declare const QueryAssistantRequestFilterSensitiveLog: (obj: QueryAssistantRequest) => any;
|
|
6846
|
+
/**
|
|
6847
|
+
* @internal
|
|
6848
|
+
*/
|
|
6849
|
+
export declare const RuntimeSessionDataValueFilterSensitiveLog: (obj: RuntimeSessionDataValue) => any;
|
|
6850
|
+
/**
|
|
6851
|
+
* @internal
|
|
6852
|
+
*/
|
|
6853
|
+
export declare const RuntimeSessionDataFilterSensitiveLog: (obj: RuntimeSessionData) => any;
|
|
6854
|
+
/**
|
|
6855
|
+
* @internal
|
|
6856
|
+
*/
|
|
6857
|
+
export declare const UpdateSessionDataRequestFilterSensitiveLog: (obj: UpdateSessionDataRequest) => any;
|
|
6858
|
+
/**
|
|
6859
|
+
* @internal
|
|
6860
|
+
*/
|
|
6861
|
+
export declare const UpdateSessionDataResponseFilterSensitiveLog: (obj: UpdateSessionDataResponse) => any;
|
|
4723
6862
|
/**
|
|
4724
6863
|
* @internal
|
|
4725
6864
|
*/
|
|
@@ -4736,6 +6875,30 @@ export declare const GetContentResponseFilterSensitiveLog: (obj: GetContentRespo
|
|
|
4736
6875
|
* @internal
|
|
4737
6876
|
*/
|
|
4738
6877
|
export declare const UpdateContentResponseFilterSensitiveLog: (obj: UpdateContentResponse) => any;
|
|
6878
|
+
/**
|
|
6879
|
+
* @internal
|
|
6880
|
+
*/
|
|
6881
|
+
export declare const WebCrawlerConfigurationFilterSensitiveLog: (obj: WebCrawlerConfiguration) => any;
|
|
6882
|
+
/**
|
|
6883
|
+
* @internal
|
|
6884
|
+
*/
|
|
6885
|
+
export declare const ManagedSourceConfigurationFilterSensitiveLog: (obj: ManagedSourceConfiguration) => any;
|
|
6886
|
+
/**
|
|
6887
|
+
* @internal
|
|
6888
|
+
*/
|
|
6889
|
+
export declare const SourceConfigurationFilterSensitiveLog: (obj: SourceConfiguration) => any;
|
|
6890
|
+
/**
|
|
6891
|
+
* @internal
|
|
6892
|
+
*/
|
|
6893
|
+
export declare const CreateKnowledgeBaseRequestFilterSensitiveLog: (obj: CreateKnowledgeBaseRequest) => any;
|
|
6894
|
+
/**
|
|
6895
|
+
* @internal
|
|
6896
|
+
*/
|
|
6897
|
+
export declare const KnowledgeBaseDataFilterSensitiveLog: (obj: KnowledgeBaseData) => any;
|
|
6898
|
+
/**
|
|
6899
|
+
* @internal
|
|
6900
|
+
*/
|
|
6901
|
+
export declare const CreateKnowledgeBaseResponseFilterSensitiveLog: (obj: CreateKnowledgeBaseResponse) => any;
|
|
4739
6902
|
/**
|
|
4740
6903
|
* @internal
|
|
4741
6904
|
*/
|
|
@@ -4772,10 +6935,22 @@ export declare const ImportJobDataFilterSensitiveLog: (obj: ImportJobData) => an
|
|
|
4772
6935
|
* @internal
|
|
4773
6936
|
*/
|
|
4774
6937
|
export declare const GetImportJobResponseFilterSensitiveLog: (obj: GetImportJobResponse) => any;
|
|
6938
|
+
/**
|
|
6939
|
+
* @internal
|
|
6940
|
+
*/
|
|
6941
|
+
export declare const GetKnowledgeBaseResponseFilterSensitiveLog: (obj: GetKnowledgeBaseResponse) => any;
|
|
4775
6942
|
/**
|
|
4776
6943
|
* @internal
|
|
4777
6944
|
*/
|
|
4778
6945
|
export declare const GetQuickResponseResponseFilterSensitiveLog: (obj: GetQuickResponseResponse) => any;
|
|
6946
|
+
/**
|
|
6947
|
+
* @internal
|
|
6948
|
+
*/
|
|
6949
|
+
export declare const KnowledgeBaseSummaryFilterSensitiveLog: (obj: KnowledgeBaseSummary) => any;
|
|
6950
|
+
/**
|
|
6951
|
+
* @internal
|
|
6952
|
+
*/
|
|
6953
|
+
export declare const ListKnowledgeBasesResponseFilterSensitiveLog: (obj: ListKnowledgeBasesResponse) => any;
|
|
4779
6954
|
/**
|
|
4780
6955
|
* @internal
|
|
4781
6956
|
*/
|
|
@@ -4812,6 +6987,10 @@ export declare const StartContentUploadResponseFilterSensitiveLog: (obj: StartCo
|
|
|
4812
6987
|
* @internal
|
|
4813
6988
|
*/
|
|
4814
6989
|
export declare const StartImportJobResponseFilterSensitiveLog: (obj: StartImportJobResponse) => any;
|
|
6990
|
+
/**
|
|
6991
|
+
* @internal
|
|
6992
|
+
*/
|
|
6993
|
+
export declare const UpdateKnowledgeBaseTemplateUriResponseFilterSensitiveLog: (obj: UpdateKnowledgeBaseTemplateUriResponse) => any;
|
|
4815
6994
|
/**
|
|
4816
6995
|
* @internal
|
|
4817
6996
|
*/
|