@aws-sdk/client-qbusiness 3.782.0 → 3.793.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 +9 -39
- package/dist-cjs/index.js +69 -5
- package/dist-es/QBusiness.js +2 -0
- package/dist-es/commands/CheckDocumentAccessCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +8 -4
- package/dist-es/models/models_1.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +34 -0
- package/dist-types/QBusiness.d.ts +8 -39
- package/dist-types/QBusinessClient.d.ts +4 -41
- package/dist-types/commands/AssociatePermissionCommand.d.ts +7 -15
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +7 -16
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +7 -29
- package/dist-types/commands/CancelSubscriptionCommand.d.ts +6 -13
- package/dist-types/commands/ChatCommand.d.ts +9 -17
- package/dist-types/commands/ChatSyncCommand.d.ts +8 -17
- package/dist-types/commands/CheckDocumentAccessCommand.d.ts +145 -0
- package/dist-types/commands/CreateApplicationCommand.d.ts +7 -27
- package/dist-types/commands/CreateDataAccessorCommand.d.ts +7 -18
- package/dist-types/commands/CreateDataSourceCommand.d.ts +7 -16
- package/dist-types/commands/CreateIndexCommand.d.ts +7 -21
- package/dist-types/commands/CreatePluginCommand.d.ts +6 -12
- package/dist-types/commands/CreateRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/CreateSubscriptionCommand.d.ts +7 -18
- package/dist-types/commands/CreateUserCommand.d.ts +7 -14
- package/dist-types/commands/CreateWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/DeleteApplicationCommand.d.ts +6 -12
- package/dist-types/commands/DeleteAttachmentCommand.d.ts +6 -12
- package/dist-types/commands/DeleteChatControlsConfigurationCommand.d.ts +5 -10
- package/dist-types/commands/DeleteConversationCommand.d.ts +6 -12
- package/dist-types/commands/DeleteDataAccessorCommand.d.ts +7 -14
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +7 -15
- package/dist-types/commands/DeleteGroupCommand.d.ts +7 -21
- package/dist-types/commands/DeleteIndexCommand.d.ts +6 -12
- package/dist-types/commands/DeletePluginCommand.d.ts +6 -12
- package/dist-types/commands/DeleteRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/DeleteUserCommand.d.ts +6 -12
- package/dist-types/commands/DeleteWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/DisassociatePermissionCommand.d.ts +7 -14
- package/dist-types/commands/GetApplicationCommand.d.ts +5 -10
- package/dist-types/commands/GetChatControlsConfigurationCommand.d.ts +9 -12
- package/dist-types/commands/GetDataAccessorCommand.d.ts +6 -14
- package/dist-types/commands/GetDataSourceCommand.d.ts +5 -10
- package/dist-types/commands/GetGroupCommand.d.ts +6 -12
- package/dist-types/commands/GetIndexCommand.d.ts +5 -10
- package/dist-types/commands/GetMediaCommand.d.ts +7 -16
- package/dist-types/commands/GetPluginCommand.d.ts +5 -10
- package/dist-types/commands/GetPolicyCommand.d.ts +6 -12
- package/dist-types/commands/GetRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/GetUserCommand.d.ts +7 -14
- package/dist-types/commands/GetWebExperienceCommand.d.ts +5 -10
- package/dist-types/commands/ListApplicationsCommand.d.ts +5 -15
- package/dist-types/commands/ListAttachmentsCommand.d.ts +6 -12
- package/dist-types/commands/ListConversationsCommand.d.ts +6 -12
- package/dist-types/commands/ListDataAccessorsCommand.d.ts +6 -13
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +6 -12
- package/dist-types/commands/ListDataSourcesCommand.d.ts +5 -10
- package/dist-types/commands/ListDocumentsCommand.d.ts +7 -11
- package/dist-types/commands/ListGroupsCommand.d.ts +7 -13
- package/dist-types/commands/ListIndicesCommand.d.ts +5 -10
- package/dist-types/commands/ListMessagesCommand.d.ts +7 -13
- package/dist-types/commands/ListPluginActionsCommand.d.ts +6 -11
- package/dist-types/commands/ListPluginTypeActionsCommand.d.ts +6 -11
- package/dist-types/commands/ListPluginTypeMetadataCommand.d.ts +4 -8
- package/dist-types/commands/ListPluginsCommand.d.ts +5 -10
- package/dist-types/commands/ListRetrieversCommand.d.ts +5 -10
- package/dist-types/commands/ListSubscriptionsCommand.d.ts +6 -12
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +6 -12
- package/dist-types/commands/ListWebExperiencesCommand.d.ts +5 -10
- package/dist-types/commands/PutFeedbackCommand.d.ts +6 -12
- package/dist-types/commands/PutGroupCommand.d.ts +7 -23
- package/dist-types/commands/SearchRelevantContentCommand.d.ts +7 -18
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +7 -14
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +7 -14
- package/dist-types/commands/TagResourceCommand.d.ts +7 -15
- package/dist-types/commands/UntagResourceCommand.d.ts +5 -10
- package/dist-types/commands/UpdateApplicationCommand.d.ts +7 -25
- package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +10 -14
- package/dist-types/commands/UpdateDataAccessorCommand.d.ts +7 -15
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +6 -12
- package/dist-types/commands/UpdateIndexCommand.d.ts +6 -12
- package/dist-types/commands/UpdatePluginCommand.d.ts +6 -12
- package/dist-types/commands/UpdateRetrieverCommand.d.ts +6 -12
- package/dist-types/commands/UpdateSubscriptionCommand.d.ts +7 -16
- package/dist-types/commands/UpdateUserCommand.d.ts +8 -10
- package/dist-types/commands/UpdateWebExperienceCommand.d.ts +6 -12
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +1 -39
- package/dist-types/models/models_0.d.ts +542 -1258
- package/dist-types/models/models_1.d.ts +309 -175
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/QBusiness.d.ts +17 -0
- package/dist-types/ts3.4/QBusinessClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/CheckDocumentAccessCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListDocumentsCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListGroupsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMessagesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPluginActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPluginTypeActionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +61 -64
- package/dist-types/ts3.4/models/models_1.d.ts +73 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +5 -5
|
@@ -1,11 +1,264 @@
|
|
|
1
|
-
import { ActionExecution, ActionExecutionEvent, AttachmentInput, AttachmentInputEvent, AuthChallengeResponse, AuthChallengeResponseEvent, BlockedPhrasesConfigurationUpdate, ChatMode, ChatModeConfiguration, ContentSource, CreatorModeConfiguration, DocumentAttribute, EndOfInputEvent, MembershipType, OrchestrationControl, PluginType, ResponseScope, S3, SubscriptionDetails, SubscriptionPrincipal, SubscriptionType, Tag, TextInputEvent, TopicConfiguration, UserAlias } from "./models_0";
|
|
1
|
+
import { ActionExecution, ActionExecutionEvent, ActionReview, ActionSummary, AttachmentInput, AttachmentInputEvent, AttachmentOutput, AuthChallengeResponse, AuthChallengeResponseEvent, BlockedPhrasesConfigurationUpdate, ChatMode, ChatModeConfiguration, ContentSource, CreatorModeConfiguration, DocumentAttribute, DocumentDetails, EndOfInputEvent, HallucinationReductionConfiguration, MembershipType, OrchestrationControl, PluginType, ResponseScope, S3, SourceAttribution, SubscriptionDetails, SubscriptionPrincipal, SubscriptionType, Tag, TextInputEvent, TopicConfiguration, UserAlias } from "./models_0";
|
|
2
|
+
/**
|
|
3
|
+
* @public
|
|
4
|
+
*/
|
|
5
|
+
export interface ListDocumentsResponse {
|
|
6
|
+
/**
|
|
7
|
+
* <p>A list of document details.</p>
|
|
8
|
+
* @public
|
|
9
|
+
*/
|
|
10
|
+
documentDetailList?: DocumentDetails[] | undefined;
|
|
11
|
+
/**
|
|
12
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.</p>
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
nextToken?: string | undefined;
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
export interface ListGroupsRequest {
|
|
21
|
+
/**
|
|
22
|
+
* <p>The identifier of the application for getting a list of groups mapped to users.</p>
|
|
23
|
+
* @public
|
|
24
|
+
*/
|
|
25
|
+
applicationId: string | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* <p>The identifier of the index for getting a list of groups mapped to users.</p>
|
|
28
|
+
* @public
|
|
29
|
+
*/
|
|
30
|
+
indexId: string | undefined;
|
|
31
|
+
/**
|
|
32
|
+
* <p>The timestamp identifier used for the latest <code>PUT</code> or <code>DELETE</code> action for mapping users to their groups.</p>
|
|
33
|
+
* @public
|
|
34
|
+
*/
|
|
35
|
+
updatedEarlierThan: Date | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* <p>The identifier of the data source for getting a list of groups mapped to users.</p>
|
|
38
|
+
* @public
|
|
39
|
+
*/
|
|
40
|
+
dataSourceId?: string | undefined;
|
|
41
|
+
/**
|
|
42
|
+
* <p>If the previous response was incomplete (because there is more data to retrieve), Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users.</p>
|
|
43
|
+
* @public
|
|
44
|
+
*/
|
|
45
|
+
nextToken?: string | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* <p>The maximum number of returned groups that are mapped to users.</p>
|
|
48
|
+
* @public
|
|
49
|
+
*/
|
|
50
|
+
maxResults?: number | undefined;
|
|
51
|
+
}
|
|
52
|
+
/**
|
|
53
|
+
* <p>Summary information for groups.</p>
|
|
54
|
+
* @public
|
|
55
|
+
*/
|
|
56
|
+
export interface GroupSummary {
|
|
57
|
+
/**
|
|
58
|
+
* <p>The name of the group the summary information is for.</p>
|
|
59
|
+
* @public
|
|
60
|
+
*/
|
|
61
|
+
groupName?: string | undefined;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* @public
|
|
65
|
+
*/
|
|
66
|
+
export interface ListGroupsResponse {
|
|
67
|
+
/**
|
|
68
|
+
* <p>If the response is truncated, Amazon Q Business returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users.</p>
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
nextToken?: string | undefined;
|
|
72
|
+
/**
|
|
73
|
+
* <p>Summary information for list of groups that are mapped to users.</p>
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
items?: GroupSummary[] | undefined;
|
|
77
|
+
}
|
|
78
|
+
/**
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
export interface ListMessagesRequest {
|
|
82
|
+
/**
|
|
83
|
+
* <p>The identifier of the Amazon Q Business web experience conversation.</p>
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
conversationId: string | undefined;
|
|
87
|
+
/**
|
|
88
|
+
* <p>The identifier for the Amazon Q Business application.</p>
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
applicationId: string | undefined;
|
|
92
|
+
/**
|
|
93
|
+
* <p>The identifier of the user involved in the Amazon Q Business web experience conversation.</p>
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
userId?: string | undefined;
|
|
97
|
+
/**
|
|
98
|
+
* <p>If the number of messages returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.</p>
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
nextToken?: string | undefined;
|
|
102
|
+
/**
|
|
103
|
+
* <p>The maximum number of messages to return.</p>
|
|
104
|
+
* @public
|
|
105
|
+
*/
|
|
106
|
+
maxResults?: number | undefined;
|
|
107
|
+
}
|
|
108
|
+
/**
|
|
109
|
+
* @public
|
|
110
|
+
* @enum
|
|
111
|
+
*/
|
|
112
|
+
export declare const MessageType: {
|
|
113
|
+
readonly SYSTEM: "SYSTEM";
|
|
114
|
+
readonly USER: "USER";
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* @public
|
|
118
|
+
*/
|
|
119
|
+
export type MessageType = (typeof MessageType)[keyof typeof MessageType];
|
|
120
|
+
/**
|
|
121
|
+
* <p>A message in an Amazon Q Business web experience.</p>
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
export interface Message {
|
|
125
|
+
/**
|
|
126
|
+
* <p>The identifier of the Amazon Q Business web experience message.</p>
|
|
127
|
+
* @public
|
|
128
|
+
*/
|
|
129
|
+
messageId?: string | undefined;
|
|
130
|
+
/**
|
|
131
|
+
* <p>The content of the Amazon Q Business web experience message.</p>
|
|
132
|
+
* @public
|
|
133
|
+
*/
|
|
134
|
+
body?: string | undefined;
|
|
135
|
+
/**
|
|
136
|
+
* <p>The timestamp of the first Amazon Q Business web experience message.</p>
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
time?: Date | undefined;
|
|
140
|
+
/**
|
|
141
|
+
* <p>The type of Amazon Q Business message, whether <code>HUMAN</code> or <code>AI</code> generated.</p>
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
type?: MessageType | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* <p>A file directly uploaded into an Amazon Q Business web experience chat.</p>
|
|
147
|
+
* @public
|
|
148
|
+
*/
|
|
149
|
+
attachments?: AttachmentOutput[] | undefined;
|
|
150
|
+
/**
|
|
151
|
+
* <p>The source documents used to generate Amazon Q Business web experience message.</p>
|
|
152
|
+
* @public
|
|
153
|
+
*/
|
|
154
|
+
sourceAttribution?: SourceAttribution[] | undefined;
|
|
155
|
+
/**
|
|
156
|
+
* <p>An output event that Amazon Q Business returns to an user who wants to perform a plugin action during a non-streaming chat conversation. It contains information about the selected action with a list of possible user input fields, some pre-populated by Amazon Q Business.</p>
|
|
157
|
+
* @public
|
|
158
|
+
*/
|
|
159
|
+
actionReview?: ActionReview | undefined;
|
|
160
|
+
/**
|
|
161
|
+
* <p>Performs an Amazon Q Business plugin action during a non-streaming chat conversation.</p>
|
|
162
|
+
* @public
|
|
163
|
+
*/
|
|
164
|
+
actionExecution?: ActionExecution | undefined;
|
|
165
|
+
}
|
|
166
|
+
/**
|
|
167
|
+
* @public
|
|
168
|
+
*/
|
|
169
|
+
export interface ListMessagesResponse {
|
|
170
|
+
/**
|
|
171
|
+
* <p>An array of information on one or more messages.</p>
|
|
172
|
+
* @public
|
|
173
|
+
*/
|
|
174
|
+
messages?: Message[] | undefined;
|
|
175
|
+
/**
|
|
176
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of messages.</p>
|
|
177
|
+
* @public
|
|
178
|
+
*/
|
|
179
|
+
nextToken?: string | undefined;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* @public
|
|
183
|
+
*/
|
|
184
|
+
export interface ListPluginActionsRequest {
|
|
185
|
+
/**
|
|
186
|
+
* <p>The identifier of the Amazon Q Business application the plugin is attached to.</p>
|
|
187
|
+
* @public
|
|
188
|
+
*/
|
|
189
|
+
applicationId: string | undefined;
|
|
190
|
+
/**
|
|
191
|
+
* <p>The identifier of the Amazon Q Business plugin.</p>
|
|
192
|
+
* @public
|
|
193
|
+
*/
|
|
194
|
+
pluginId: string | undefined;
|
|
195
|
+
/**
|
|
196
|
+
* <p>If the number of plugin actions returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugin actions.</p>
|
|
197
|
+
* @public
|
|
198
|
+
*/
|
|
199
|
+
nextToken?: string | undefined;
|
|
200
|
+
/**
|
|
201
|
+
* <p>The maximum number of plugin actions to return.</p>
|
|
202
|
+
* @public
|
|
203
|
+
*/
|
|
204
|
+
maxResults?: number | undefined;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
export interface ListPluginActionsResponse {
|
|
210
|
+
/**
|
|
211
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin actions.</p>
|
|
212
|
+
* @public
|
|
213
|
+
*/
|
|
214
|
+
nextToken?: string | undefined;
|
|
215
|
+
/**
|
|
216
|
+
* <p>An array of information on one or more plugin actions.</p>
|
|
217
|
+
* @public
|
|
218
|
+
*/
|
|
219
|
+
items?: ActionSummary[] | undefined;
|
|
220
|
+
}
|
|
221
|
+
/**
|
|
222
|
+
* @public
|
|
223
|
+
*/
|
|
224
|
+
export interface ListPluginTypeActionsRequest {
|
|
225
|
+
/**
|
|
226
|
+
* <p>The type of the plugin.</p>
|
|
227
|
+
* @public
|
|
228
|
+
*/
|
|
229
|
+
pluginType: PluginType | undefined;
|
|
230
|
+
/**
|
|
231
|
+
* <p>If the number of plugins returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of plugins.</p>
|
|
232
|
+
* @public
|
|
233
|
+
*/
|
|
234
|
+
nextToken?: string | undefined;
|
|
235
|
+
/**
|
|
236
|
+
* <p>The maximum number of plugins to return.</p>
|
|
237
|
+
* @public
|
|
238
|
+
*/
|
|
239
|
+
maxResults?: number | undefined;
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* @public
|
|
243
|
+
*/
|
|
244
|
+
export interface ListPluginTypeActionsResponse {
|
|
245
|
+
/**
|
|
246
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugins.</p>
|
|
247
|
+
* @public
|
|
248
|
+
*/
|
|
249
|
+
nextToken?: string | undefined;
|
|
250
|
+
/**
|
|
251
|
+
* <p>An array of information on one or more plugins.</p>
|
|
252
|
+
* @public
|
|
253
|
+
*/
|
|
254
|
+
items?: ActionSummary[] | undefined;
|
|
255
|
+
}
|
|
2
256
|
/**
|
|
3
257
|
* @public
|
|
4
258
|
*/
|
|
5
259
|
export interface ListPluginTypeMetadataRequest {
|
|
6
260
|
/**
|
|
7
|
-
* <p>If the metadata returned exceeds <code>maxResults</code>, Amazon Q Business
|
|
8
|
-
* returns a next token as a pagination token to retrieve the next set of metadata.</p>
|
|
261
|
+
* <p>If the metadata returned exceeds <code>maxResults</code>, Amazon Q Business returns a next token as a pagination token to retrieve the next set of metadata.</p>
|
|
9
262
|
* @public
|
|
10
263
|
*/
|
|
11
264
|
nextToken?: string | undefined;
|
|
@@ -46,8 +299,7 @@ export interface PluginTypeMetadataSummary {
|
|
|
46
299
|
*/
|
|
47
300
|
category?: PluginTypeCategory | undefined;
|
|
48
301
|
/**
|
|
49
|
-
* <p>The description assigned by Amazon Q Business to a plugin. You can't
|
|
50
|
-
* modify this value.</p>
|
|
302
|
+
* <p>The description assigned by Amazon Q Business to a plugin. You can't modify this value.</p>
|
|
51
303
|
* @public
|
|
52
304
|
*/
|
|
53
305
|
description?: string | undefined;
|
|
@@ -57,8 +309,7 @@ export interface PluginTypeMetadataSummary {
|
|
|
57
309
|
*/
|
|
58
310
|
export interface ListPluginTypeMetadataResponse {
|
|
59
311
|
/**
|
|
60
|
-
* <p>If the response is truncated, Amazon Q Business returns this token, which you
|
|
61
|
-
* can use in a later request to list the next set of plugin metadata.</p>
|
|
312
|
+
* <p>If the response is truncated, Amazon Q Business returns this token, which you can use in a later request to list the next set of plugin metadata.</p>
|
|
62
313
|
* @public
|
|
63
314
|
*/
|
|
64
315
|
nextToken?: string | undefined;
|
|
@@ -78,9 +329,7 @@ export interface ListSubscriptionsRequest {
|
|
|
78
329
|
*/
|
|
79
330
|
applicationId: string | undefined;
|
|
80
331
|
/**
|
|
81
|
-
* <p>If the <code>maxResults</code> response was incomplete because there is more data to
|
|
82
|
-
* retrieve, Amazon Q Business returns a pagination token in the response. You can use this
|
|
83
|
-
* pagination token to retrieve the next set of Amazon Q Business subscriptions.</p>
|
|
332
|
+
* <p>If the <code>maxResults</code> response was incomplete because there is more data to retrieve, Amazon Q Business returns a pagination token in the response. You can use this pagination token to retrieve the next set of Amazon Q Business subscriptions.</p>
|
|
84
333
|
* @public
|
|
85
334
|
*/
|
|
86
335
|
nextToken?: string | undefined;
|
|
@@ -91,13 +340,7 @@ export interface ListSubscriptionsRequest {
|
|
|
91
340
|
maxResults?: number | undefined;
|
|
92
341
|
}
|
|
93
342
|
/**
|
|
94
|
-
* <p>Information about an Amazon Q Business subscription.</p>
|
|
95
|
-
* <p>Subscriptions are used to provide access for an IAM Identity Center user or a group to
|
|
96
|
-
* an Amazon Q Business application.</p>
|
|
97
|
-
* <p>Amazon Q Business offers two subscription tiers: <code>Q_LITE</code> and
|
|
98
|
-
* <code>Q_BUSINESS</code>. Subscription tier determines feature access for the user.
|
|
99
|
-
* For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business
|
|
100
|
-
* pricing</a>.</p>
|
|
343
|
+
* <p>Information about an Amazon Q Business subscription.</p> <p>Subscriptions are used to provide access for an IAM Identity Center user or a group to an Amazon Q Business application.</p> <p>Amazon Q Business offers two subscription tiers: <code>Q_LITE</code> and <code>Q_BUSINESS</code>. Subscription tier determines feature access for the user. For more information on subscriptions and pricing tiers, see <a href="https://aws.amazon.com/q/business/pricing/">Amazon Q Business pricing</a>.</p>
|
|
101
344
|
* @public
|
|
102
345
|
*/
|
|
103
346
|
export interface Subscription {
|
|
@@ -107,14 +350,12 @@ export interface Subscription {
|
|
|
107
350
|
*/
|
|
108
351
|
subscriptionId?: string | undefined;
|
|
109
352
|
/**
|
|
110
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was
|
|
111
|
-
* updated.</p>
|
|
353
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.</p>
|
|
112
354
|
* @public
|
|
113
355
|
*/
|
|
114
356
|
subscriptionArn?: string | undefined;
|
|
115
357
|
/**
|
|
116
|
-
* <p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group
|
|
117
|
-
* in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
|
|
358
|
+
* <p>The IAM Identity Center <code>UserId</code> or <code>GroupId</code> of a user or group in the IAM Identity Center instance connected to the Amazon Q Business application.</p>
|
|
118
359
|
* @public
|
|
119
360
|
*/
|
|
120
361
|
principal?: SubscriptionPrincipal | undefined;
|
|
@@ -134,14 +375,12 @@ export interface Subscription {
|
|
|
134
375
|
*/
|
|
135
376
|
export interface ListSubscriptionsResponse {
|
|
136
377
|
/**
|
|
137
|
-
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token
|
|
138
|
-
* in a subsequent request to retrieve the next set of subscriptions.</p>
|
|
378
|
+
* <p>If the response is truncated, Amazon Q Business returns this token. You can use this token in a subsequent request to retrieve the next set of subscriptions.</p>
|
|
139
379
|
* @public
|
|
140
380
|
*/
|
|
141
381
|
nextToken?: string | undefined;
|
|
142
382
|
/**
|
|
143
|
-
* <p>An array of summary information on the subscriptions configured for an Amazon Q Business
|
|
144
|
-
* application.</p>
|
|
383
|
+
* <p>An array of summary information on the subscriptions configured for an Amazon Q Business application.</p>
|
|
145
384
|
* @public
|
|
146
385
|
*/
|
|
147
386
|
subscriptions?: Subscription[] | undefined;
|
|
@@ -151,8 +390,7 @@ export interface ListSubscriptionsResponse {
|
|
|
151
390
|
*/
|
|
152
391
|
export interface ListTagsForResourceRequest {
|
|
153
392
|
/**
|
|
154
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get
|
|
155
|
-
* a list of tags for.</p>
|
|
393
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to get a list of tags for.</p>
|
|
156
394
|
* @public
|
|
157
395
|
*/
|
|
158
396
|
resourceARN: string | undefined;
|
|
@@ -217,8 +455,7 @@ export interface MessageUsefulnessFeedback {
|
|
|
217
455
|
*/
|
|
218
456
|
reason?: MessageUsefulnessReason | undefined;
|
|
219
457
|
/**
|
|
220
|
-
* <p>A comment given by an end user on the usefulness of an AI-generated chat
|
|
221
|
-
* message.</p>
|
|
458
|
+
* <p>A comment given by an end user on the usefulness of an AI-generated chat message.</p>
|
|
222
459
|
* @public
|
|
223
460
|
*/
|
|
224
461
|
comment?: string | undefined;
|
|
@@ -296,26 +533,22 @@ export interface MemberUser {
|
|
|
296
533
|
type?: MembershipType | undefined;
|
|
297
534
|
}
|
|
298
535
|
/**
|
|
299
|
-
* <p>A list of users or sub groups that belong to a group. This is for generating
|
|
300
|
-
* Amazon Q Business chat results only from document a user has access to.</p>
|
|
536
|
+
* <p>A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.</p>
|
|
301
537
|
* @public
|
|
302
538
|
*/
|
|
303
539
|
export interface GroupMembers {
|
|
304
540
|
/**
|
|
305
|
-
* <p>A list of sub groups that belong to a group. For example, the sub groups "Research",
|
|
306
|
-
* "Engineering", and "Sales and Marketing" all belong to the group "Company".</p>
|
|
541
|
+
* <p>A list of sub groups that belong to a group. For example, the sub groups "Research", "Engineering", and "Sales and Marketing" all belong to the group "Company".</p>
|
|
307
542
|
* @public
|
|
308
543
|
*/
|
|
309
544
|
memberGroups?: MemberGroup[] | undefined;
|
|
310
545
|
/**
|
|
311
|
-
* <p>A list of users that belong to a group. For example, a list of interns all belong to
|
|
312
|
-
* the "Interns" group.</p>
|
|
546
|
+
* <p>A list of users that belong to a group. For example, a list of interns all belong to the "Interns" group.</p>
|
|
313
547
|
* @public
|
|
314
548
|
*/
|
|
315
549
|
memberUsers?: MemberUser[] | undefined;
|
|
316
550
|
/**
|
|
317
|
-
* <p>Information required for Amazon Q Business to find a specific file in an Amazon S3
|
|
318
|
-
* bucket.</p>
|
|
551
|
+
* <p>Information required for Amazon Q Business to find a specific file in an Amazon S3 bucket.</p>
|
|
319
552
|
* @public
|
|
320
553
|
*/
|
|
321
554
|
s3PathForGroupMembers?: S3 | undefined;
|
|
@@ -335,19 +568,12 @@ export interface PutGroupRequest {
|
|
|
335
568
|
*/
|
|
336
569
|
indexId: string | undefined;
|
|
337
570
|
/**
|
|
338
|
-
* <p>The list that contains your users or sub groups that belong the same group. For
|
|
339
|
-
* example, the group "Company" includes the user "CEO" and the sub groups "Research",
|
|
340
|
-
* "Engineering", and "Sales and Marketing".</p>
|
|
571
|
+
* <p>The list that contains your users or sub groups that belong the same group. For example, the group "Company" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".</p>
|
|
341
572
|
* @public
|
|
342
573
|
*/
|
|
343
574
|
groupName: string | undefined;
|
|
344
575
|
/**
|
|
345
|
-
* <p>The identifier of the data source for which you want to map users to their groups.
|
|
346
|
-
* This is useful if a group is tied to multiple data sources, but you only want the group
|
|
347
|
-
* to access documents of a certain data source. For example, the groups "Research",
|
|
348
|
-
* "Engineering", and "Sales and Marketing" are all tied to the company's documents stored
|
|
349
|
-
* in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only
|
|
350
|
-
* needs access to customer-related documents stored in Salesforce.</p>
|
|
576
|
+
* <p>The identifier of the data source for which you want to map users to their groups. This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.</p>
|
|
351
577
|
* @public
|
|
352
578
|
*/
|
|
353
579
|
dataSourceId?: string | undefined;
|
|
@@ -357,14 +583,12 @@ export interface PutGroupRequest {
|
|
|
357
583
|
*/
|
|
358
584
|
type: MembershipType | undefined;
|
|
359
585
|
/**
|
|
360
|
-
* <p>A list of users or sub groups that belong to a group. This is for generating
|
|
361
|
-
* Amazon Q Business chat results only from document a user has access to.</p>
|
|
586
|
+
* <p>A list of users or sub groups that belong to a group. This is for generating Amazon Q Business chat results only from document a user has access to.</p>
|
|
362
587
|
* @public
|
|
363
588
|
*/
|
|
364
589
|
groupMembers: GroupMembers | undefined;
|
|
365
590
|
/**
|
|
366
|
-
* <p>The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains
|
|
367
|
-
* your list of users that belong to a group.</p>
|
|
591
|
+
* <p>The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.</p>
|
|
368
592
|
* @public
|
|
369
593
|
*/
|
|
370
594
|
roleArn?: string | undefined;
|
|
@@ -491,8 +715,7 @@ export interface StopDataSourceSyncJobRequest {
|
|
|
491
715
|
*/
|
|
492
716
|
dataSourceId: string | undefined;
|
|
493
717
|
/**
|
|
494
|
-
* <p>The identifier of the Amazon Q Business application that the data source is connected
|
|
495
|
-
* to.</p>
|
|
718
|
+
* <p>The identifier of the Amazon Q Business application that the data source is connected to.</p>
|
|
496
719
|
* @public
|
|
497
720
|
*/
|
|
498
721
|
applicationId: string | undefined;
|
|
@@ -512,14 +735,12 @@ export interface StopDataSourceSyncJobResponse {
|
|
|
512
735
|
*/
|
|
513
736
|
export interface TagResourceRequest {
|
|
514
737
|
/**
|
|
515
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to
|
|
516
|
-
* tag.</p>
|
|
738
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to tag.</p>
|
|
517
739
|
* @public
|
|
518
740
|
*/
|
|
519
741
|
resourceARN: string | undefined;
|
|
520
742
|
/**
|
|
521
|
-
* <p>A list of tag keys to add to the Amazon Q Business application or data source. If a tag
|
|
522
|
-
* already exists, the existing value is replaced with the new value.</p>
|
|
743
|
+
* <p>A list of tag keys to add to the Amazon Q Business application or data source. If a tag already exists, the existing value is replaced with the new value.</p>
|
|
523
744
|
* @public
|
|
524
745
|
*/
|
|
525
746
|
tags: Tag[] | undefined;
|
|
@@ -534,14 +755,12 @@ export interface TagResourceResponse {
|
|
|
534
755
|
*/
|
|
535
756
|
export interface UntagResourceRequest {
|
|
536
757
|
/**
|
|
537
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to
|
|
538
|
-
* remove the tag from.</p>
|
|
758
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to remove the tag from.</p>
|
|
539
759
|
* @public
|
|
540
760
|
*/
|
|
541
761
|
resourceARN: string | undefined;
|
|
542
762
|
/**
|
|
543
|
-
* <p>A list of tag keys to remove from the Amazon Q Business application or data source. If a
|
|
544
|
-
* tag key does not exist on the resource, it is ignored.</p>
|
|
763
|
+
* <p>A list of tag keys to remove from the Amazon Q Business application or data source. If a tag key does not exist on the resource, it is ignored.</p>
|
|
545
764
|
* @public
|
|
546
765
|
*/
|
|
547
766
|
tagKeys: string[] | undefined;
|
|
@@ -552,18 +771,12 @@ export interface UntagResourceRequest {
|
|
|
552
771
|
export interface UntagResourceResponse {
|
|
553
772
|
}
|
|
554
773
|
/**
|
|
555
|
-
* <p>Configuration information required to enable chat orchestration for your Amazon Q Business
|
|
556
|
-
* application.</p>
|
|
557
|
-
* <note>
|
|
558
|
-
* <p>Chat orchestration is optimized to work for English language content. For more
|
|
559
|
-
* details on language support in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html">Supported languages</a>.</p>
|
|
560
|
-
* </note>
|
|
774
|
+
* <p>Configuration information required to enable chat orchestration for your Amazon Q Business application.</p> <note> <p>Chat orchestration is optimized to work for English language content. For more details on language support in Amazon Q Business, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/supported-languages.html">Supported languages</a>.</p> </note>
|
|
561
775
|
* @public
|
|
562
776
|
*/
|
|
563
777
|
export interface OrchestrationConfiguration {
|
|
564
778
|
/**
|
|
565
|
-
* <p> Status information about whether chat orchestration is activated or deactivated for
|
|
566
|
-
* your Amazon Q Business application.</p>
|
|
779
|
+
* <p> Status information about whether chat orchestration is activated or deactivated for your Amazon Q Business application.</p>
|
|
567
780
|
* @public
|
|
568
781
|
*/
|
|
569
782
|
control: OrchestrationControl | undefined;
|
|
@@ -578,16 +791,12 @@ export interface UpdateChatControlsConfigurationRequest {
|
|
|
578
791
|
*/
|
|
579
792
|
applicationId: string | undefined;
|
|
580
793
|
/**
|
|
581
|
-
* <p>A token that you provide to identify the request to update a Amazon Q Business application
|
|
582
|
-
* chat configuration.</p>
|
|
794
|
+
* <p>A token that you provide to identify the request to update a Amazon Q Business application chat configuration.</p>
|
|
583
795
|
* @public
|
|
584
796
|
*/
|
|
585
797
|
clientToken?: string | undefined;
|
|
586
798
|
/**
|
|
587
|
-
* <p>The response scope configured for your application. This determines whether your
|
|
588
|
-
* application uses its retrieval augmented generation (RAG) system to generate answers
|
|
589
|
-
* only from your enterprise data, or also uses the large language models (LLM) knowledge
|
|
590
|
-
* to respons to end user questions in chat.</p>
|
|
799
|
+
* <p>The response scope configured for your application. This determines whether your application uses its retrieval augmented generation (RAG) system to generate answers only from your enterprise data, or also uses the large language models (LLM) knowledge to respons to end user questions in chat.</p>
|
|
591
800
|
* @public
|
|
592
801
|
*/
|
|
593
802
|
responseScope?: ResponseScope | undefined;
|
|
@@ -616,6 +825,11 @@ export interface UpdateChatControlsConfigurationRequest {
|
|
|
616
825
|
* @public
|
|
617
826
|
*/
|
|
618
827
|
creatorModeConfiguration?: CreatorModeConfiguration | undefined;
|
|
828
|
+
/**
|
|
829
|
+
* <p> The hallucination reduction settings for your application.</p>
|
|
830
|
+
* @public
|
|
831
|
+
*/
|
|
832
|
+
hallucinationReductionConfiguration?: HallucinationReductionConfiguration | undefined;
|
|
619
833
|
}
|
|
620
834
|
/**
|
|
621
835
|
* @public
|
|
@@ -627,8 +841,7 @@ export interface UpdateChatControlsConfigurationResponse {
|
|
|
627
841
|
*/
|
|
628
842
|
export interface UpdateSubscriptionRequest {
|
|
629
843
|
/**
|
|
630
|
-
* <p>The identifier of the Amazon Q Business application where the subscription update should
|
|
631
|
-
* take effect.</p>
|
|
844
|
+
* <p>The identifier of the Amazon Q Business application where the subscription update should take effect.</p>
|
|
632
845
|
* @public
|
|
633
846
|
*/
|
|
634
847
|
applicationId: string | undefined;
|
|
@@ -648,8 +861,7 @@ export interface UpdateSubscriptionRequest {
|
|
|
648
861
|
*/
|
|
649
862
|
export interface UpdateSubscriptionResponse {
|
|
650
863
|
/**
|
|
651
|
-
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was
|
|
652
|
-
* updated.</p>
|
|
864
|
+
* <p>The Amazon Resource Name (ARN) of the Amazon Q Business subscription that was updated.</p>
|
|
653
865
|
* @public
|
|
654
866
|
*/
|
|
655
867
|
subscriptionArn?: string | undefined;
|
|
@@ -730,52 +942,37 @@ export interface AttributeFilter {
|
|
|
730
942
|
*/
|
|
731
943
|
notFilter?: AttributeFilter | undefined;
|
|
732
944
|
/**
|
|
733
|
-
* <p>Performs an equals operation on two document attributes or metadata fields. Supported
|
|
734
|
-
* for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>,
|
|
735
|
-
* <code>longValue</code>, <code>stringListValue</code> and
|
|
736
|
-
* <code>stringValue</code>.</p>
|
|
945
|
+
* <p>Performs an equals operation on two document attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>, <code>longValue</code>, <code>stringListValue</code> and <code>stringValue</code>.</p>
|
|
737
946
|
* @public
|
|
738
947
|
*/
|
|
739
948
|
equalsTo?: DocumentAttribute | undefined;
|
|
740
949
|
/**
|
|
741
|
-
* <p>Returns <code>true</code> when a document contains all the specified document
|
|
742
|
-
* attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
|
|
743
|
-
* <code>stringListValue</code>.</p>
|
|
950
|
+
* <p>Returns <code>true</code> when a document contains all the specified document attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>stringListValue</code>.</p>
|
|
744
951
|
* @public
|
|
745
952
|
*/
|
|
746
953
|
containsAll?: DocumentAttribute | undefined;
|
|
747
954
|
/**
|
|
748
|
-
* <p>Returns <code>true</code> when a document contains any of the specified document
|
|
749
|
-
* attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>:
|
|
750
|
-
* <code>stringListValue</code>.</p>
|
|
955
|
+
* <p>Returns <code>true</code> when a document contains any of the specified document attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>stringListValue</code>.</p>
|
|
751
956
|
* @public
|
|
752
957
|
*/
|
|
753
958
|
containsAny?: DocumentAttribute | undefined;
|
|
754
959
|
/**
|
|
755
|
-
* <p>Performs a greater than operation on two document attributes or metadata fields.
|
|
756
|
-
* Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
|
|
757
|
-
* and <code>longValue</code>.</p>
|
|
960
|
+
* <p>Performs a greater than operation on two document attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code> and <code>longValue</code>.</p>
|
|
758
961
|
* @public
|
|
759
962
|
*/
|
|
760
963
|
greaterThan?: DocumentAttribute | undefined;
|
|
761
964
|
/**
|
|
762
|
-
* <p>Performs a greater or equals than operation on two document attributes or metadata
|
|
763
|
-
* fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
|
|
764
|
-
* and <code>longValue</code>. </p>
|
|
965
|
+
* <p>Performs a greater or equals than operation on two document attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code> and <code>longValue</code>. </p>
|
|
765
966
|
* @public
|
|
766
967
|
*/
|
|
767
968
|
greaterThanOrEquals?: DocumentAttribute | undefined;
|
|
768
969
|
/**
|
|
769
|
-
* <p>Performs a less than operation on two document attributes or metadata fields.
|
|
770
|
-
* Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code>
|
|
771
|
-
* and <code>longValue</code>.</p>
|
|
970
|
+
* <p>Performs a less than operation on two document attributes or metadata fields. Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value types</a>: <code>dateValue</code> and <code>longValue</code>.</p>
|
|
772
971
|
* @public
|
|
773
972
|
*/
|
|
774
973
|
lessThan?: DocumentAttribute | undefined;
|
|
775
974
|
/**
|
|
776
|
-
* <p>Performs a less than or equals operation on two document attributes or metadata
|
|
777
|
-
* fields.Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value type</a>: <code>dateValue</code>
|
|
778
|
-
* and <code>longValue</code>. </p>
|
|
975
|
+
* <p>Performs a less than or equals operation on two document attributes or metadata fields.Supported for the following <a href="https://docs.aws.amazon.com/amazonq/latest/api-reference/API_DocumentAttributeValue.html">document attribute value type</a>: <code>dateValue</code> and <code>longValue</code>. </p>
|
|
779
976
|
* @public
|
|
780
977
|
*/
|
|
781
978
|
lessThanOrEquals?: DocumentAttribute | undefined;
|
|
@@ -796,8 +993,7 @@ export interface ActionFilterConfiguration {
|
|
|
796
993
|
*/
|
|
797
994
|
export interface ChatSyncInput {
|
|
798
995
|
/**
|
|
799
|
-
* <p>The identifier of the Amazon Q Business application linked to the Amazon Q Business
|
|
800
|
-
* conversation.</p>
|
|
996
|
+
* <p>The identifier of the Amazon Q Business application linked to the Amazon Q Business conversation.</p>
|
|
801
997
|
* @public
|
|
802
998
|
*/
|
|
803
999
|
applicationId: string | undefined;
|
|
@@ -817,8 +1013,7 @@ export interface ChatSyncInput {
|
|
|
817
1013
|
*/
|
|
818
1014
|
userMessage?: string | undefined;
|
|
819
1015
|
/**
|
|
820
|
-
* <p>A list of files uploaded directly during chat. You can upload a maximum of 5 files of
|
|
821
|
-
* upto 10 MB each.</p>
|
|
1016
|
+
* <p>A list of files uploaded directly during chat. You can upload a maximum of 5 files of upto 10 MB each.</p>
|
|
822
1017
|
* @public
|
|
823
1018
|
*/
|
|
824
1019
|
attachments?: AttachmentInput[] | undefined;
|
|
@@ -828,8 +1023,7 @@ export interface ChatSyncInput {
|
|
|
828
1023
|
*/
|
|
829
1024
|
actionExecution?: ActionExecution | undefined;
|
|
830
1025
|
/**
|
|
831
|
-
* <p>An authentication verification event response by a third party authentication server
|
|
832
|
-
* to Amazon Q Business.</p>
|
|
1026
|
+
* <p>An authentication verification event response by a third party authentication server to Amazon Q Business.</p>
|
|
833
1027
|
* @public
|
|
834
1028
|
*/
|
|
835
1029
|
authChallengeResponse?: AuthChallengeResponse | undefined;
|
|
@@ -844,44 +1038,12 @@ export interface ChatSyncInput {
|
|
|
844
1038
|
*/
|
|
845
1039
|
parentMessageId?: string | undefined;
|
|
846
1040
|
/**
|
|
847
|
-
* <p>Enables filtering of Amazon Q Business web experience responses based on document
|
|
848
|
-
* attributes or metadata fields.</p>
|
|
1041
|
+
* <p>Enables filtering of Amazon Q Business web experience responses based on document attributes or metadata fields.</p>
|
|
849
1042
|
* @public
|
|
850
1043
|
*/
|
|
851
1044
|
attributeFilter?: AttributeFilter | undefined;
|
|
852
1045
|
/**
|
|
853
|
-
* <p>The <code>chatMode</code> parameter determines the chat modes available to
|
|
854
|
-
* Amazon Q Business users:</p>
|
|
855
|
-
* <ul>
|
|
856
|
-
* <li>
|
|
857
|
-
* <p>
|
|
858
|
-
* <code>RETRIEVAL_MODE</code> - If you choose this mode, Amazon Q generates responses solely from the data sources connected and
|
|
859
|
-
* indexed by the application. If an answer is not found in the data sources or
|
|
860
|
-
* there are no data sources available, Amazon Q will respond with a
|
|
861
|
-
* "<i>No Answer Found</i>" message, unless LLM knowledge has
|
|
862
|
-
* been enabled. In that case, Amazon Q will generate a response from
|
|
863
|
-
* the LLM knowledge</p>
|
|
864
|
-
* </li>
|
|
865
|
-
* <li>
|
|
866
|
-
* <p>
|
|
867
|
-
* <code>CREATOR_MODE</code> - By selecting this mode, you can choose to generate
|
|
868
|
-
* responses only from the LLM knowledge. You can also attach files and have Amazon Q
|
|
869
|
-
* generate a response based on the data in those files.
|
|
870
|
-
* If the attached files do not contain an answer for the query, Amazon Q
|
|
871
|
-
* will automatically fall back to generating a response from the LLM knowledge.</p>
|
|
872
|
-
* </li>
|
|
873
|
-
* <li>
|
|
874
|
-
* <p>
|
|
875
|
-
* <code>PLUGIN_MODE</code> - By selecting this mode, users can choose to
|
|
876
|
-
* use plugins in chat to get their responses.</p>
|
|
877
|
-
* </li>
|
|
878
|
-
* </ul>
|
|
879
|
-
* <note>
|
|
880
|
-
* <p>If none of the modes are selected, Amazon Q will only respond using the information
|
|
881
|
-
* from the attached files.</p>
|
|
882
|
-
* </note>
|
|
883
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>,
|
|
884
|
-
* and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Response sources</a>.</p>
|
|
1046
|
+
* <p>The <code>chatMode</code> parameter determines the chat modes available to Amazon Q Business users:</p> <ul> <li> <p> <code>RETRIEVAL_MODE</code> - If you choose this mode, Amazon Q generates responses solely from the data sources connected and indexed by the application. If an answer is not found in the data sources or there are no data sources available, Amazon Q will respond with a "<i>No Answer Found</i>" message, unless LLM knowledge has been enabled. In that case, Amazon Q will generate a response from the LLM knowledge</p> </li> <li> <p> <code>CREATOR_MODE</code> - By selecting this mode, you can choose to generate responses only from the LLM knowledge. You can also attach files and have Amazon Q generate a response based on the data in those files. If the attached files do not contain an answer for the query, Amazon Q will automatically fall back to generating a response from the LLM knowledge.</p> </li> <li> <p> <code>PLUGIN_MODE</code> - By selecting this mode, users can choose to use plugins in chat to get their responses.</p> </li> </ul> <note> <p>If none of the modes are selected, Amazon Q will only respond using the information from the attached files.</p> </note> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>, and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Response sources</a>.</p>
|
|
885
1047
|
* @public
|
|
886
1048
|
*/
|
|
887
1049
|
chatMode?: ChatMode | undefined;
|
|
@@ -897,41 +1059,17 @@ export interface ChatSyncInput {
|
|
|
897
1059
|
clientToken?: string | undefined;
|
|
898
1060
|
}
|
|
899
1061
|
/**
|
|
900
|
-
* <p>A configuration event activated by an end user request to select a specific chat
|
|
901
|
-
* mode.</p>
|
|
1062
|
+
* <p>A configuration event activated by an end user request to select a specific chat mode.</p>
|
|
902
1063
|
* @public
|
|
903
1064
|
*/
|
|
904
1065
|
export interface ConfigurationEvent {
|
|
905
1066
|
/**
|
|
906
|
-
* <p>The chat modes available to an Amazon Q Business end user.</p>
|
|
907
|
-
* <ul>
|
|
908
|
-
* <li>
|
|
909
|
-
* <p>
|
|
910
|
-
* <code>RETRIEVAL_MODE</code> - The default chat mode for an
|
|
911
|
-
* Amazon Q Business application. When this mode is enabled, Amazon Q Business generates
|
|
912
|
-
* responses only from data sources connected to an Amazon Q Business
|
|
913
|
-
* application.</p>
|
|
914
|
-
* </li>
|
|
915
|
-
* <li>
|
|
916
|
-
* <p>
|
|
917
|
-
* <code>CREATOR_MODE</code> - By selecting this mode, users can choose to
|
|
918
|
-
* generate responses only from the LLM knowledge, without consulting connected
|
|
919
|
-
* data sources, for a chat request.</p>
|
|
920
|
-
* </li>
|
|
921
|
-
* <li>
|
|
922
|
-
* <p>
|
|
923
|
-
* <code>PLUGIN_MODE</code> - By selecting this mode, users can choose to
|
|
924
|
-
* use plugins in chat.</p>
|
|
925
|
-
* </li>
|
|
926
|
-
* </ul>
|
|
927
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>,
|
|
928
|
-
* and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
1067
|
+
* <p>The chat modes available to an Amazon Q Business end user.</p> <ul> <li> <p> <code>RETRIEVAL_MODE</code> - The default chat mode for an Amazon Q Business application. When this mode is enabled, Amazon Q Business generates responses only from data sources connected to an Amazon Q Business application.</p> </li> <li> <p> <code>CREATOR_MODE</code> - By selecting this mode, users can choose to generate responses only from the LLM knowledge, without consulting connected data sources, for a chat request.</p> </li> <li> <p> <code>PLUGIN_MODE</code> - By selecting this mode, users can choose to use plugins in chat.</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a>, <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/plugins.html">Plugins</a>, and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
929
1068
|
* @public
|
|
930
1069
|
*/
|
|
931
1070
|
chatMode?: ChatMode | undefined;
|
|
932
1071
|
/**
|
|
933
|
-
* <p>Configuration information for Amazon Q Business conversation modes.</p>
|
|
934
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
1072
|
+
* <p>Configuration information for Amazon Q Business conversation modes.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/guardrails.html">Admin controls and guardrails</a> and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
|
|
935
1073
|
* @public
|
|
936
1074
|
*/
|
|
937
1075
|
chatModeConfiguration?: ChatModeConfiguration | undefined;
|
|
@@ -1002,8 +1140,7 @@ export type ChatInputStream = ChatInputStream.ActionExecutionEventMember | ChatI
|
|
|
1002
1140
|
*/
|
|
1003
1141
|
export declare namespace ChatInputStream {
|
|
1004
1142
|
/**
|
|
1005
|
-
* <p>A configuration event activated by an end user request to select a specific chat
|
|
1006
|
-
* mode.</p>
|
|
1143
|
+
* <p>A configuration event activated by an end user request to select a specific chat mode.</p>
|
|
1007
1144
|
* @public
|
|
1008
1145
|
*/
|
|
1009
1146
|
interface ConfigurationEventMember {
|
|
@@ -1016,8 +1153,7 @@ export declare namespace ChatInputStream {
|
|
|
1016
1153
|
$unknown?: never;
|
|
1017
1154
|
}
|
|
1018
1155
|
/**
|
|
1019
|
-
* <p>Information about the payload of the <code>ChatInputStream</code> event containing the
|
|
1020
|
-
* end user message input.</p>
|
|
1156
|
+
* <p>Information about the payload of the <code>ChatInputStream</code> event containing the end user message input.</p>
|
|
1021
1157
|
* @public
|
|
1022
1158
|
*/
|
|
1023
1159
|
interface TextEventMember {
|
|
@@ -1069,8 +1205,7 @@ export declare namespace ChatInputStream {
|
|
|
1069
1205
|
$unknown?: never;
|
|
1070
1206
|
}
|
|
1071
1207
|
/**
|
|
1072
|
-
* <p>An authentication verification event response by a third party authentication server
|
|
1073
|
-
* to Amazon Q Business.</p>
|
|
1208
|
+
* <p>An authentication verification event response by a third party authentication server to Amazon Q Business.</p>
|
|
1074
1209
|
* @public
|
|
1075
1210
|
*/
|
|
1076
1211
|
interface AuthChallengeResponseEventMember {
|
|
@@ -1110,8 +1245,7 @@ export declare namespace ChatInputStream {
|
|
|
1110
1245
|
*/
|
|
1111
1246
|
export interface ChatInput {
|
|
1112
1247
|
/**
|
|
1113
|
-
* <p>The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business
|
|
1114
|
-
* conversation.</p>
|
|
1248
|
+
* <p>The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business conversation.</p>
|
|
1115
1249
|
* @public
|
|
1116
1250
|
*/
|
|
1117
1251
|
applicationId: string | undefined;
|