@aws-sdk/client-qbusiness 3.703.0 → 3.707.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.
Files changed (144) hide show
  1. package/README.md +96 -0
  2. package/dist-cjs/index.js +797 -42
  3. package/dist-es/QBusiness.js +24 -0
  4. package/dist-es/commands/AssociatePermissionCommand.js +22 -0
  5. package/dist-es/commands/ChatCommand.js +2 -1
  6. package/dist-es/commands/CreateDataAccessorCommand.js +23 -0
  7. package/dist-es/commands/DeleteDataAccessorCommand.js +22 -0
  8. package/dist-es/commands/DisassociatePermissionCommand.js +22 -0
  9. package/dist-es/commands/GetDataAccessorCommand.js +23 -0
  10. package/dist-es/commands/GetPolicyCommand.js +22 -0
  11. package/dist-es/commands/ListDataAccessorsCommand.js +23 -0
  12. package/dist-es/commands/ListPluginActionsCommand.js +22 -0
  13. package/dist-es/commands/ListPluginTypeActionsCommand.js +22 -0
  14. package/dist-es/commands/ListPluginTypeMetadataCommand.js +22 -0
  15. package/dist-es/commands/SearchRelevantContentCommand.js +22 -0
  16. package/dist-es/commands/UpdateDataAccessorCommand.js +23 -0
  17. package/dist-es/commands/index.js +12 -0
  18. package/dist-es/models/index.js +1 -0
  19. package/dist-es/models/models_0.js +59 -52
  20. package/dist-es/models/models_1.js +54 -0
  21. package/dist-es/pagination/ListDataAccessorsPaginator.js +4 -0
  22. package/dist-es/pagination/ListPluginActionsPaginator.js +4 -0
  23. package/dist-es/pagination/ListPluginTypeActionsPaginator.js +4 -0
  24. package/dist-es/pagination/ListPluginTypeMetadataPaginator.js +4 -0
  25. package/dist-es/pagination/SearchRelevantContentPaginator.js +4 -0
  26. package/dist-es/pagination/index.js +5 -0
  27. package/dist-es/protocols/Aws_restJson1.js +451 -4
  28. package/dist-types/QBusiness.d.ts +85 -0
  29. package/dist-types/QBusinessClient.d.ts +14 -2
  30. package/dist-types/commands/AssociatePermissionCommand.d.ts +105 -0
  31. package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +2 -2
  32. package/dist-types/commands/BatchPutDocumentCommand.d.ts +2 -2
  33. package/dist-types/commands/ChatCommand.d.ts +5 -4
  34. package/dist-types/commands/ChatSyncCommand.d.ts +5 -4
  35. package/dist-types/commands/CreateApplicationCommand.d.ts +6 -3
  36. package/dist-types/commands/CreateDataAccessorCommand.d.ts +203 -0
  37. package/dist-types/commands/CreateDataSourceCommand.d.ts +2 -2
  38. package/dist-types/commands/CreateIndexCommand.d.ts +2 -2
  39. package/dist-types/commands/CreatePluginCommand.d.ts +9 -3
  40. package/dist-types/commands/CreateRetrieverCommand.d.ts +2 -2
  41. package/dist-types/commands/CreateUserCommand.d.ts +2 -2
  42. package/dist-types/commands/CreateWebExperienceCommand.d.ts +8 -2
  43. package/dist-types/commands/DeleteApplicationCommand.d.ts +2 -2
  44. package/dist-types/commands/DeleteChatControlsConfigurationCommand.d.ts +2 -2
  45. package/dist-types/commands/DeleteConversationCommand.d.ts +2 -2
  46. package/dist-types/commands/DeleteDataAccessorCommand.d.ts +95 -0
  47. package/dist-types/commands/DeleteDataSourceCommand.d.ts +2 -2
  48. package/dist-types/commands/DeleteGroupCommand.d.ts +2 -2
  49. package/dist-types/commands/DeleteIndexCommand.d.ts +2 -2
  50. package/dist-types/commands/DeletePluginCommand.d.ts +2 -2
  51. package/dist-types/commands/DeleteRetrieverCommand.d.ts +2 -2
  52. package/dist-types/commands/DeleteUserCommand.d.ts +2 -2
  53. package/dist-types/commands/DeleteWebExperienceCommand.d.ts +2 -2
  54. package/dist-types/commands/DisassociatePermissionCommand.d.ts +95 -0
  55. package/dist-types/commands/GetApplicationCommand.d.ts +6 -3
  56. package/dist-types/commands/GetChatControlsConfigurationCommand.d.ts +2 -2
  57. package/dist-types/commands/GetDataAccessorCommand.d.ts +191 -0
  58. package/dist-types/commands/GetDataSourceCommand.d.ts +2 -2
  59. package/dist-types/commands/GetGroupCommand.d.ts +2 -2
  60. package/dist-types/commands/GetIndexCommand.d.ts +2 -2
  61. package/dist-types/commands/GetMediaCommand.d.ts +2 -2
  62. package/dist-types/commands/GetPluginCommand.d.ts +9 -3
  63. package/dist-types/commands/GetPolicyCommand.d.ts +92 -0
  64. package/dist-types/commands/GetRetrieverCommand.d.ts +2 -2
  65. package/dist-types/commands/GetUserCommand.d.ts +2 -2
  66. package/dist-types/commands/GetWebExperienceCommand.d.ts +8 -2
  67. package/dist-types/commands/ListApplicationsCommand.d.ts +4 -1
  68. package/dist-types/commands/ListAttachmentsCommand.d.ts +2 -2
  69. package/dist-types/commands/ListConversationsCommand.d.ts +2 -2
  70. package/dist-types/commands/ListDataAccessorsCommand.d.ts +106 -0
  71. package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +2 -2
  72. package/dist-types/commands/ListDataSourcesCommand.d.ts +2 -2
  73. package/dist-types/commands/ListDocumentsCommand.d.ts +2 -2
  74. package/dist-types/commands/ListGroupsCommand.d.ts +2 -2
  75. package/dist-types/commands/ListIndicesCommand.d.ts +2 -2
  76. package/dist-types/commands/ListMessagesCommand.d.ts +3 -3
  77. package/dist-types/commands/ListPluginActionsCommand.d.ts +102 -0
  78. package/dist-types/commands/ListPluginTypeActionsCommand.d.ts +98 -0
  79. package/dist-types/commands/ListPluginTypeMetadataCommand.d.ts +95 -0
  80. package/dist-types/commands/ListPluginsCommand.d.ts +3 -3
  81. package/dist-types/commands/ListRetrieversCommand.d.ts +3 -3
  82. package/dist-types/commands/ListTagsForResourceCommand.d.ts +2 -2
  83. package/dist-types/commands/ListWebExperiencesCommand.d.ts +2 -2
  84. package/dist-types/commands/PutFeedbackCommand.d.ts +2 -2
  85. package/dist-types/commands/PutGroupCommand.d.ts +2 -2
  86. package/dist-types/commands/SearchRelevantContentCommand.d.ts +214 -0
  87. package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +4 -3
  88. package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +3 -3
  89. package/dist-types/commands/TagResourceCommand.d.ts +3 -3
  90. package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
  91. package/dist-types/commands/UpdateApplicationCommand.d.ts +2 -2
  92. package/dist-types/commands/UpdateChatControlsConfigurationCommand.d.ts +3 -3
  93. package/dist-types/commands/UpdateDataAccessorCommand.d.ts +186 -0
  94. package/dist-types/commands/UpdateDataSourceCommand.d.ts +2 -2
  95. package/dist-types/commands/UpdateIndexCommand.d.ts +2 -2
  96. package/dist-types/commands/UpdatePluginCommand.d.ts +8 -2
  97. package/dist-types/commands/UpdateRetrieverCommand.d.ts +2 -2
  98. package/dist-types/commands/UpdateUserCommand.d.ts +3 -3
  99. package/dist-types/commands/UpdateWebExperienceCommand.d.ts +8 -2
  100. package/dist-types/commands/index.d.ts +12 -0
  101. package/dist-types/models/index.d.ts +1 -0
  102. package/dist-types/models/models_0.d.ts +735 -636
  103. package/dist-types/models/models_1.d.ts +742 -0
  104. package/dist-types/pagination/ListDataAccessorsPaginator.d.ts +7 -0
  105. package/dist-types/pagination/ListPluginActionsPaginator.d.ts +7 -0
  106. package/dist-types/pagination/ListPluginTypeActionsPaginator.d.ts +7 -0
  107. package/dist-types/pagination/ListPluginTypeMetadataPaginator.d.ts +7 -0
  108. package/dist-types/pagination/SearchRelevantContentPaginator.d.ts +7 -0
  109. package/dist-types/pagination/index.d.ts +5 -0
  110. package/dist-types/protocols/Aws_restJson1.d.ts +108 -0
  111. package/dist-types/ts3.4/QBusiness.d.ts +205 -0
  112. package/dist-types/ts3.4/QBusinessClient.d.ts +72 -0
  113. package/dist-types/ts3.4/commands/AssociatePermissionCommand.d.ts +51 -0
  114. package/dist-types/ts3.4/commands/ChatCommand.d.ts +2 -1
  115. package/dist-types/ts3.4/commands/ChatSyncCommand.d.ts +2 -1
  116. package/dist-types/ts3.4/commands/CreateDataAccessorCommand.d.ts +49 -0
  117. package/dist-types/ts3.4/commands/DeleteDataAccessorCommand.d.ts +51 -0
  118. package/dist-types/ts3.4/commands/DisassociatePermissionCommand.d.ts +51 -0
  119. package/dist-types/ts3.4/commands/GetDataAccessorCommand.d.ts +48 -0
  120. package/dist-types/ts3.4/commands/GetPolicyCommand.d.ts +47 -0
  121. package/dist-types/ts3.4/commands/ListDataAccessorsCommand.d.ts +51 -0
  122. package/dist-types/ts3.4/commands/ListPluginActionsCommand.d.ts +51 -0
  123. package/dist-types/ts3.4/commands/ListPluginTypeActionsCommand.d.ts +51 -0
  124. package/dist-types/ts3.4/commands/ListPluginTypeMetadataCommand.d.ts +51 -0
  125. package/dist-types/ts3.4/commands/SearchRelevantContentCommand.d.ts +49 -0
  126. package/dist-types/ts3.4/commands/StartDataSourceSyncJobCommand.d.ts +2 -4
  127. package/dist-types/ts3.4/commands/StopDataSourceSyncJobCommand.d.ts +1 -1
  128. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
  129. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
  130. package/dist-types/ts3.4/commands/UpdateChatControlsConfigurationCommand.d.ts +1 -1
  131. package/dist-types/ts3.4/commands/UpdateDataAccessorCommand.d.ts +49 -0
  132. package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +1 -1
  133. package/dist-types/ts3.4/commands/index.d.ts +12 -0
  134. package/dist-types/ts3.4/models/index.d.ts +1 -0
  135. package/dist-types/ts3.4/models/models_0.d.ts +250 -224
  136. package/dist-types/ts3.4/models/models_1.d.ts +239 -0
  137. package/dist-types/ts3.4/pagination/ListDataAccessorsPaginator.d.ts +11 -0
  138. package/dist-types/ts3.4/pagination/ListPluginActionsPaginator.d.ts +11 -0
  139. package/dist-types/ts3.4/pagination/ListPluginTypeActionsPaginator.d.ts +11 -0
  140. package/dist-types/ts3.4/pagination/ListPluginTypeMetadataPaginator.d.ts +11 -0
  141. package/dist-types/ts3.4/pagination/SearchRelevantContentPaginator.d.ts +11 -0
  142. package/dist-types/ts3.4/pagination/index.d.ts +5 -0
  143. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +144 -0
  144. package/package.json +1 -1
@@ -0,0 +1,742 @@
1
+ import { ActionExecution, ActionExecutionEvent, AttachmentInput, AttachmentInputEvent, AuthChallengeResponse, AuthChallengeResponseEvent, BlockedPhrasesConfigurationUpdate, ChatMode, ChatModeConfiguration, ContentSource, CreatorModeConfiguration, DocumentAttribute, EndOfInputEvent, ResponseScope, Tag, TextInputEvent, TopicConfiguration, UserAlias } from "./models_0";
2
+ /**
3
+ * @public
4
+ */
5
+ export interface StartDataSourceSyncJobResponse {
6
+ /**
7
+ * <p>The identifier for a particular synchronization job.</p>
8
+ * @public
9
+ */
10
+ executionId?: string | undefined;
11
+ }
12
+ /**
13
+ * @public
14
+ */
15
+ export interface StopDataSourceSyncJobRequest {
16
+ /**
17
+ * <p> The identifier of the data source connector. </p>
18
+ * @public
19
+ */
20
+ dataSourceId: string | undefined;
21
+ /**
22
+ * <p>The identifier of the Amazon Q Business application that the data source is connected
23
+ * to.</p>
24
+ * @public
25
+ */
26
+ applicationId: string | undefined;
27
+ /**
28
+ * <p>The identifier of the index used with the Amazon Q Business data source connector.</p>
29
+ * @public
30
+ */
31
+ indexId: string | undefined;
32
+ }
33
+ /**
34
+ * @public
35
+ */
36
+ export interface StopDataSourceSyncJobResponse {
37
+ }
38
+ /**
39
+ * @public
40
+ */
41
+ export interface TagResourceRequest {
42
+ /**
43
+ * <p>The Amazon Resource Name (ARN) of the Amazon Q Business application or data source to
44
+ * tag.</p>
45
+ * @public
46
+ */
47
+ resourceARN: string | undefined;
48
+ /**
49
+ * <p>A list of tag keys to add to the Amazon Q Business application or data source. If a tag
50
+ * already exists, the existing value is replaced with the new value.</p>
51
+ * @public
52
+ */
53
+ tags: Tag[] | undefined;
54
+ }
55
+ /**
56
+ * @public
57
+ */
58
+ export interface TagResourceResponse {
59
+ }
60
+ /**
61
+ * @public
62
+ */
63
+ export interface UntagResourceRequest {
64
+ /**
65
+ * <p>The Amazon Resource Name (ARN) of the Amazon Q Business application, or data source to
66
+ * remove the tag from.</p>
67
+ * @public
68
+ */
69
+ resourceARN: string | undefined;
70
+ /**
71
+ * <p>A list of tag keys to remove from the Amazon Q Business application or data source. If a
72
+ * tag key does not exist on the resource, it is ignored.</p>
73
+ * @public
74
+ */
75
+ tagKeys: string[] | undefined;
76
+ }
77
+ /**
78
+ * @public
79
+ */
80
+ export interface UntagResourceResponse {
81
+ }
82
+ /**
83
+ * @public
84
+ */
85
+ export interface UpdateChatControlsConfigurationRequest {
86
+ /**
87
+ * <p>The identifier of the application for which the chat controls are configured.</p>
88
+ * @public
89
+ */
90
+ applicationId: string | undefined;
91
+ /**
92
+ * <p>A token that you provide to identify the request to update a Amazon Q Business application
93
+ * chat configuration.</p>
94
+ * @public
95
+ */
96
+ clientToken?: string | undefined;
97
+ /**
98
+ * <p>The response scope configured for your application. This determines whether your
99
+ * application uses its retrieval augmented generation (RAG) system to generate answers
100
+ * only from your enterprise data, or also uses the large language models (LLM) knowledge
101
+ * to respons to end user questions in chat.</p>
102
+ * @public
103
+ */
104
+ responseScope?: ResponseScope | undefined;
105
+ /**
106
+ * <p>The phrases blocked from chat by your chat control configuration.</p>
107
+ * @public
108
+ */
109
+ blockedPhrasesConfigurationUpdate?: BlockedPhrasesConfigurationUpdate | undefined;
110
+ /**
111
+ * <p>The configured topic specific chat controls you want to update.</p>
112
+ * @public
113
+ */
114
+ topicConfigurationsToCreateOrUpdate?: TopicConfiguration[] | undefined;
115
+ /**
116
+ * <p>The configured topic specific chat controls you want to delete.</p>
117
+ * @public
118
+ */
119
+ topicConfigurationsToDelete?: TopicConfiguration[] | undefined;
120
+ /**
121
+ * <p>The configuration details for <code>CREATOR_MODE</code>.</p>
122
+ * @public
123
+ */
124
+ creatorModeConfiguration?: CreatorModeConfiguration | undefined;
125
+ }
126
+ /**
127
+ * @public
128
+ */
129
+ export interface UpdateChatControlsConfigurationResponse {
130
+ }
131
+ /**
132
+ * @public
133
+ */
134
+ export interface UpdateUserRequest {
135
+ /**
136
+ * <p>The identifier of the application the user is attached to.</p>
137
+ * @public
138
+ */
139
+ applicationId: string | undefined;
140
+ /**
141
+ * <p>The email id attached to the user.</p>
142
+ * @public
143
+ */
144
+ userId: string | undefined;
145
+ /**
146
+ * <p>The user aliases attached to the user id that are to be updated.</p>
147
+ * @public
148
+ */
149
+ userAliasesToUpdate?: UserAlias[] | undefined;
150
+ /**
151
+ * <p>The user aliases attached to the user id that are to be deleted.</p>
152
+ * @public
153
+ */
154
+ userAliasesToDelete?: UserAlias[] | undefined;
155
+ }
156
+ /**
157
+ * @public
158
+ */
159
+ export interface UpdateUserResponse {
160
+ /**
161
+ * <p>The user aliases that have been to be added to a user id.</p>
162
+ * @public
163
+ */
164
+ userAliasesAdded?: UserAlias[] | undefined;
165
+ /**
166
+ * <p>The user aliases attached to a user id that have been updated.</p>
167
+ * @public
168
+ */
169
+ userAliasesUpdated?: UserAlias[] | undefined;
170
+ /**
171
+ * <p>The user aliases that have been deleted from a user id.</p>
172
+ * @public
173
+ */
174
+ userAliasesDeleted?: UserAlias[] | undefined;
175
+ }
176
+ /**
177
+ * <p>Enables filtering of responses based on document attributes or metadata fields.</p>
178
+ * @public
179
+ */
180
+ export interface AttributeFilter {
181
+ /**
182
+ * <p>Performs a logical <code>AND</code> operation on all supplied filters.</p>
183
+ * @public
184
+ */
185
+ andAllFilters?: AttributeFilter[] | undefined;
186
+ /**
187
+ * <p> Performs a logical <code>OR</code> operation on all supplied filters. </p>
188
+ * @public
189
+ */
190
+ orAllFilters?: AttributeFilter[] | undefined;
191
+ /**
192
+ * <p>Performs a logical <code>NOT</code> operation on all supplied filters. </p>
193
+ * @public
194
+ */
195
+ notFilter?: AttributeFilter | undefined;
196
+ /**
197
+ * <p>Performs an equals operation on two document attributes or metadata fields. Supported
198
+ * 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>,
199
+ * <code>longValue</code>, <code>stringListValue</code> and
200
+ * <code>stringValue</code>.</p>
201
+ * @public
202
+ */
203
+ equalsTo?: DocumentAttribute | undefined;
204
+ /**
205
+ * <p>Returns <code>true</code> when a document contains all the specified document
206
+ * 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>:
207
+ * <code>stringListValue</code>.</p>
208
+ * @public
209
+ */
210
+ containsAll?: DocumentAttribute | undefined;
211
+ /**
212
+ * <p>Returns <code>true</code> when a document contains any of the specified document
213
+ * 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>:
214
+ * <code>stringListValue</code>.</p>
215
+ * @public
216
+ */
217
+ containsAny?: DocumentAttribute | undefined;
218
+ /**
219
+ * <p>Performs a greater than operation on two document attributes or metadata fields.
220
+ * 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>
221
+ * and <code>longValue</code>.</p>
222
+ * @public
223
+ */
224
+ greaterThan?: DocumentAttribute | undefined;
225
+ /**
226
+ * <p>Performs a greater or equals than operation on two document attributes or metadata
227
+ * 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>
228
+ * and <code>longValue</code>. </p>
229
+ * @public
230
+ */
231
+ greaterThanOrEquals?: DocumentAttribute | undefined;
232
+ /**
233
+ * <p>Performs a less than operation on two document attributes or metadata fields.
234
+ * 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>
235
+ * and <code>longValue</code>.</p>
236
+ * @public
237
+ */
238
+ lessThan?: DocumentAttribute | undefined;
239
+ /**
240
+ * <p>Performs a less than or equals operation on two document attributes or metadata
241
+ * 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>
242
+ * and <code>longValue</code>. </p>
243
+ * @public
244
+ */
245
+ lessThanOrEquals?: DocumentAttribute | undefined;
246
+ }
247
+ /**
248
+ * <p>Specifies filters to apply to an allowed action.</p>
249
+ * @public
250
+ */
251
+ export interface ActionFilterConfiguration {
252
+ /**
253
+ * <p>Enables filtering of responses based on document attributes or metadata fields.</p>
254
+ * @public
255
+ */
256
+ documentAttributeFilter: AttributeFilter | undefined;
257
+ }
258
+ /**
259
+ * @public
260
+ */
261
+ export interface ChatSyncInput {
262
+ /**
263
+ * <p>The identifier of the Amazon Q Business application linked to the Amazon Q Business
264
+ * conversation.</p>
265
+ * @public
266
+ */
267
+ applicationId: string | undefined;
268
+ /**
269
+ * <p>The identifier of the user attached to the chat input.</p>
270
+ * @public
271
+ */
272
+ userId?: string | undefined;
273
+ /**
274
+ * <p>The group names that a user associated with the chat input belongs to.</p>
275
+ * @public
276
+ */
277
+ userGroups?: string[] | undefined;
278
+ /**
279
+ * <p>A end user message in a conversation.</p>
280
+ * @public
281
+ */
282
+ userMessage?: string | undefined;
283
+ /**
284
+ * <p>A list of files uploaded directly during chat. You can upload a maximum of 5 files of
285
+ * upto 10 MB each.</p>
286
+ * @public
287
+ */
288
+ attachments?: AttachmentInput[] | undefined;
289
+ /**
290
+ * <p>A request from an end user to perform an Amazon Q Business plugin action.</p>
291
+ * @public
292
+ */
293
+ actionExecution?: ActionExecution | undefined;
294
+ /**
295
+ * <p>An authentication verification event response by a third party authentication server
296
+ * to Amazon Q Business.</p>
297
+ * @public
298
+ */
299
+ authChallengeResponse?: AuthChallengeResponse | undefined;
300
+ /**
301
+ * <p>The identifier of the Amazon Q Business conversation.</p>
302
+ * @public
303
+ */
304
+ conversationId?: string | undefined;
305
+ /**
306
+ * <p>The identifier of the previous system message in a conversation.</p>
307
+ * @public
308
+ */
309
+ parentMessageId?: string | undefined;
310
+ /**
311
+ * <p>Enables filtering of Amazon Q Business web experience responses based on document
312
+ * attributes or metadata fields.</p>
313
+ * @public
314
+ */
315
+ attributeFilter?: AttributeFilter | undefined;
316
+ /**
317
+ * <p>The <code>chatMode</code> parameter determines the chat modes available to
318
+ * Amazon Q Business users:</p>
319
+ * <ul>
320
+ * <li>
321
+ * <p>
322
+ * <code>RETRIEVAL_MODE</code> - If you choose this mode, Amazon Q generates responses solely from the data sources connected and
323
+ * indexed by the application. If an answer is not found in the data sources or
324
+ * there are no data sources available, Amazon Q will respond with a
325
+ * "<i>No Answer Found</i>" message, unless LLM knowledge has
326
+ * been enabled. In that case, Amazon Q will generate a response from
327
+ * the LLM knowledge</p>
328
+ * </li>
329
+ * <li>
330
+ * <p>
331
+ * <code>CREATOR_MODE</code> - By selecting this mode, you can choose to generate
332
+ * responses only from the LLM knowledge. You can also attach files and have Amazon Q
333
+ * generate a response based on the data in those files.
334
+ * If the attached files do not contain an answer for the query, Amazon Q
335
+ * will automatically fall back to generating a response from the LLM knowledge.</p>
336
+ * </li>
337
+ * <li>
338
+ * <p>
339
+ * <code>PLUGIN_MODE</code> - By selecting this mode, users can choose to
340
+ * use plugins in chat to get their responses.</p>
341
+ * </li>
342
+ * </ul>
343
+ * <note>
344
+ * <p>If none of the modes are selected, Amazon Q will only respond using the information
345
+ * from the attached files.</p>
346
+ * </note>
347
+ * <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>,
348
+ * and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Response sources</a>.</p>
349
+ * @public
350
+ */
351
+ chatMode?: ChatMode | undefined;
352
+ /**
353
+ * <p>The chat mode configuration for an Amazon Q Business application.</p>
354
+ * @public
355
+ */
356
+ chatModeConfiguration?: ChatModeConfiguration | undefined;
357
+ /**
358
+ * <p>A token that you provide to identify a chat request.</p>
359
+ * @public
360
+ */
361
+ clientToken?: string | undefined;
362
+ }
363
+ /**
364
+ * <p>A configuration event activated by an end user request to select a specific chat
365
+ * mode.</p>
366
+ * @public
367
+ */
368
+ export interface ConfigurationEvent {
369
+ /**
370
+ * <p>The chat modes available to an Amazon Q Business end user.</p>
371
+ * <ul>
372
+ * <li>
373
+ * <p>
374
+ * <code>RETRIEVAL_MODE</code> - The default chat mode for an
375
+ * Amazon Q Business application. When this mode is enabled, Amazon Q Business generates
376
+ * responses only from data sources connected to an Amazon Q Business
377
+ * application.</p>
378
+ * </li>
379
+ * <li>
380
+ * <p>
381
+ * <code>CREATOR_MODE</code> - By selecting this mode, users can choose to
382
+ * generate responses only from the LLM knowledge, without consulting connected
383
+ * data sources, for a chat request.</p>
384
+ * </li>
385
+ * <li>
386
+ * <p>
387
+ * <code>PLUGIN_MODE</code> - By selecting this mode, users can choose to
388
+ * use plugins in chat.</p>
389
+ * </li>
390
+ * </ul>
391
+ * <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>,
392
+ * and <a href="https://docs.aws.amazon.com/amazonq/latest/business-use-dg/using-web-experience.html#chat-source-scope">Conversation settings</a>.</p>
393
+ * @public
394
+ */
395
+ chatMode?: ChatMode | undefined;
396
+ /**
397
+ * <p>Configuration information for Amazon Q Business conversation modes.</p>
398
+ * <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>
399
+ * @public
400
+ */
401
+ chatModeConfiguration?: ChatModeConfiguration | undefined;
402
+ /**
403
+ * <p>Enables filtering of responses based on document attributes or metadata fields.</p>
404
+ * @public
405
+ */
406
+ attributeFilter?: AttributeFilter | undefined;
407
+ }
408
+ /**
409
+ * @public
410
+ */
411
+ export interface SearchRelevantContentRequest {
412
+ /**
413
+ * <p>The unique identifier of the Q Business application to search.</p>
414
+ * @public
415
+ */
416
+ applicationId: string | undefined;
417
+ /**
418
+ * <p>The text to search for.</p>
419
+ * @public
420
+ */
421
+ queryText: string | undefined;
422
+ /**
423
+ * <p>The source of content to search in.</p>
424
+ * @public
425
+ */
426
+ contentSource: ContentSource | undefined;
427
+ /**
428
+ * <p>Enables filtering of responses based on document attributes or metadata fields.</p>
429
+ * @public
430
+ */
431
+ attributeFilter?: AttributeFilter | undefined;
432
+ /**
433
+ * <p>The maximum number of results to return.</p>
434
+ * @public
435
+ */
436
+ maxResults?: number | undefined;
437
+ /**
438
+ * <p>The token for the next set of results. (You received this token from a previous call.)</p>
439
+ * @public
440
+ */
441
+ nextToken?: string | undefined;
442
+ }
443
+ /**
444
+ * <p>Specifies an allowed action and its associated filter configuration.</p>
445
+ * @public
446
+ */
447
+ export interface ActionConfiguration {
448
+ /**
449
+ * <p>The Q Business action that is allowed.</p>
450
+ * @public
451
+ */
452
+ action: string | undefined;
453
+ /**
454
+ * <p>The filter configuration for the action, if any.</p>
455
+ * @public
456
+ */
457
+ filterConfiguration?: ActionFilterConfiguration | undefined;
458
+ }
459
+ /**
460
+ * <p>The streaming input for the <code>Chat</code> API.</p>
461
+ * @public
462
+ */
463
+ export type ChatInputStream = ChatInputStream.ActionExecutionEventMember | ChatInputStream.AttachmentEventMember | ChatInputStream.AuthChallengeResponseEventMember | ChatInputStream.ConfigurationEventMember | ChatInputStream.EndOfInputEventMember | ChatInputStream.TextEventMember | ChatInputStream.$UnknownMember;
464
+ /**
465
+ * @public
466
+ */
467
+ export declare namespace ChatInputStream {
468
+ /**
469
+ * <p>A configuration event activated by an end user request to select a specific chat
470
+ * mode.</p>
471
+ * @public
472
+ */
473
+ interface ConfigurationEventMember {
474
+ configurationEvent: ConfigurationEvent;
475
+ textEvent?: never;
476
+ attachmentEvent?: never;
477
+ actionExecutionEvent?: never;
478
+ endOfInputEvent?: never;
479
+ authChallengeResponseEvent?: never;
480
+ $unknown?: never;
481
+ }
482
+ /**
483
+ * <p>Information about the payload of the <code>ChatInputStream</code> event containing the
484
+ * end user message input.</p>
485
+ * @public
486
+ */
487
+ interface TextEventMember {
488
+ configurationEvent?: never;
489
+ textEvent: TextInputEvent;
490
+ attachmentEvent?: never;
491
+ actionExecutionEvent?: never;
492
+ endOfInputEvent?: never;
493
+ authChallengeResponseEvent?: never;
494
+ $unknown?: never;
495
+ }
496
+ /**
497
+ * <p>A request by an end user to upload a file during chat.</p>
498
+ * @public
499
+ */
500
+ interface AttachmentEventMember {
501
+ configurationEvent?: never;
502
+ textEvent?: never;
503
+ attachmentEvent: AttachmentInputEvent;
504
+ actionExecutionEvent?: never;
505
+ endOfInputEvent?: never;
506
+ authChallengeResponseEvent?: never;
507
+ $unknown?: never;
508
+ }
509
+ /**
510
+ * <p>A request from an end user to perform an Amazon Q Business plugin action.</p>
511
+ * @public
512
+ */
513
+ interface ActionExecutionEventMember {
514
+ configurationEvent?: never;
515
+ textEvent?: never;
516
+ attachmentEvent?: never;
517
+ actionExecutionEvent: ActionExecutionEvent;
518
+ endOfInputEvent?: never;
519
+ authChallengeResponseEvent?: never;
520
+ $unknown?: never;
521
+ }
522
+ /**
523
+ * <p>The end of the streaming input for the <code>Chat</code> API.</p>
524
+ * @public
525
+ */
526
+ interface EndOfInputEventMember {
527
+ configurationEvent?: never;
528
+ textEvent?: never;
529
+ attachmentEvent?: never;
530
+ actionExecutionEvent?: never;
531
+ endOfInputEvent: EndOfInputEvent;
532
+ authChallengeResponseEvent?: never;
533
+ $unknown?: never;
534
+ }
535
+ /**
536
+ * <p>An authentication verification event response by a third party authentication server
537
+ * to Amazon Q Business.</p>
538
+ * @public
539
+ */
540
+ interface AuthChallengeResponseEventMember {
541
+ configurationEvent?: never;
542
+ textEvent?: never;
543
+ attachmentEvent?: never;
544
+ actionExecutionEvent?: never;
545
+ endOfInputEvent?: never;
546
+ authChallengeResponseEvent: AuthChallengeResponseEvent;
547
+ $unknown?: never;
548
+ }
549
+ /**
550
+ * @public
551
+ */
552
+ interface $UnknownMember {
553
+ configurationEvent?: never;
554
+ textEvent?: never;
555
+ attachmentEvent?: never;
556
+ actionExecutionEvent?: never;
557
+ endOfInputEvent?: never;
558
+ authChallengeResponseEvent?: never;
559
+ $unknown: [string, any];
560
+ }
561
+ interface Visitor<T> {
562
+ configurationEvent: (value: ConfigurationEvent) => T;
563
+ textEvent: (value: TextInputEvent) => T;
564
+ attachmentEvent: (value: AttachmentInputEvent) => T;
565
+ actionExecutionEvent: (value: ActionExecutionEvent) => T;
566
+ endOfInputEvent: (value: EndOfInputEvent) => T;
567
+ authChallengeResponseEvent: (value: AuthChallengeResponseEvent) => T;
568
+ _: (name: string, value: any) => T;
569
+ }
570
+ const visit: <T>(value: ChatInputStream, visitor: Visitor<T>) => T;
571
+ }
572
+ /**
573
+ * @public
574
+ */
575
+ export interface ChatInput {
576
+ /**
577
+ * <p>The identifier of the Amazon Q Business application linked to a streaming Amazon Q Business
578
+ * conversation.</p>
579
+ * @public
580
+ */
581
+ applicationId: string | undefined;
582
+ /**
583
+ * <p>The identifier of the user attached to the chat input. </p>
584
+ * @public
585
+ */
586
+ userId?: string | undefined;
587
+ /**
588
+ * <p>The group names that a user associated with the chat input belongs to.</p>
589
+ * @public
590
+ */
591
+ userGroups?: string[] | undefined;
592
+ /**
593
+ * <p>The identifier of the Amazon Q Business conversation.</p>
594
+ * @public
595
+ */
596
+ conversationId?: string | undefined;
597
+ /**
598
+ * <p>The identifier used to associate a user message with a AI generated response.</p>
599
+ * @public
600
+ */
601
+ parentMessageId?: string | undefined;
602
+ /**
603
+ * <p>A token that you provide to identify the chat input.</p>
604
+ * @public
605
+ */
606
+ clientToken?: string | undefined;
607
+ /**
608
+ * <p>The streaming input for the <code>Chat</code> API.</p>
609
+ * @public
610
+ */
611
+ inputStream?: AsyncIterable<ChatInputStream> | undefined;
612
+ }
613
+ /**
614
+ * @public
615
+ */
616
+ export interface CreateDataAccessorRequest {
617
+ /**
618
+ * <p>The unique identifier of the Q Business application.</p>
619
+ * @public
620
+ */
621
+ applicationId: string | undefined;
622
+ /**
623
+ * <p>The Amazon Resource Name (ARN) of the IAM role for the ISV that will be accessing the data.</p>
624
+ * @public
625
+ */
626
+ principal: string | undefined;
627
+ /**
628
+ * <p>A list of action configurations specifying the allowed actions and any associated filters.</p>
629
+ * @public
630
+ */
631
+ actionConfigurations: ActionConfiguration[] | undefined;
632
+ /**
633
+ * <p>A unique, case-sensitive identifier you provide to ensure idempotency of the request.</p>
634
+ * @public
635
+ */
636
+ clientToken?: string | undefined;
637
+ /**
638
+ * <p>A friendly name for the data accessor.</p>
639
+ * @public
640
+ */
641
+ displayName: string | undefined;
642
+ /**
643
+ * <p>The tags to associate with the data accessor.</p>
644
+ * @public
645
+ */
646
+ tags?: Tag[] | undefined;
647
+ }
648
+ /**
649
+ * @public
650
+ */
651
+ export interface GetDataAccessorResponse {
652
+ /**
653
+ * <p>The friendly name of the data accessor.</p>
654
+ * @public
655
+ */
656
+ displayName?: string | undefined;
657
+ /**
658
+ * <p>The unique identifier of the data accessor.</p>
659
+ * @public
660
+ */
661
+ dataAccessorId?: string | undefined;
662
+ /**
663
+ * <p>The Amazon Resource Name (ARN) of the data accessor.</p>
664
+ * @public
665
+ */
666
+ dataAccessorArn?: string | undefined;
667
+ /**
668
+ * <p>The unique identifier of the Q Business application associated with this data accessor.</p>
669
+ * @public
670
+ */
671
+ applicationId?: string | undefined;
672
+ /**
673
+ * <p>The Amazon Resource Name (ARN) of the AWS IAM Identity Center application associated with this data accessor.</p>
674
+ * @public
675
+ */
676
+ idcApplicationArn?: string | undefined;
677
+ /**
678
+ * <p>The Amazon Resource Name (ARN) of the IAM role for the ISV associated with this data accessor.</p>
679
+ * @public
680
+ */
681
+ principal?: string | undefined;
682
+ /**
683
+ * <p>The list of action configurations specifying the allowed actions and any associated filters.</p>
684
+ * @public
685
+ */
686
+ actionConfigurations?: ActionConfiguration[] | undefined;
687
+ /**
688
+ * <p>The timestamp when the data accessor was created.</p>
689
+ * @public
690
+ */
691
+ createdAt?: Date | undefined;
692
+ /**
693
+ * <p>The timestamp when the data accessor was last updated.</p>
694
+ * @public
695
+ */
696
+ updatedAt?: Date | undefined;
697
+ }
698
+ /**
699
+ * @public
700
+ */
701
+ export interface UpdateDataAccessorRequest {
702
+ /**
703
+ * <p>The unique identifier of the Q Business application.</p>
704
+ * @public
705
+ */
706
+ applicationId: string | undefined;
707
+ /**
708
+ * <p>The unique identifier of the data accessor to update.</p>
709
+ * @public
710
+ */
711
+ dataAccessorId: string | undefined;
712
+ /**
713
+ * <p>The updated list of action configurations specifying the allowed actions and any associated filters.</p>
714
+ * @public
715
+ */
716
+ actionConfigurations: ActionConfiguration[] | undefined;
717
+ /**
718
+ * <p>The updated friendly name for the data accessor.</p>
719
+ * @public
720
+ */
721
+ displayName?: string | undefined;
722
+ }
723
+ /**
724
+ * @internal
725
+ */
726
+ export declare const ChatInputStreamFilterSensitiveLog: (obj: ChatInputStream) => any;
727
+ /**
728
+ * @internal
729
+ */
730
+ export declare const ChatInputFilterSensitiveLog: (obj: ChatInput) => any;
731
+ /**
732
+ * @internal
733
+ */
734
+ export declare const CreateDataAccessorRequestFilterSensitiveLog: (obj: CreateDataAccessorRequest) => any;
735
+ /**
736
+ * @internal
737
+ */
738
+ export declare const GetDataAccessorResponseFilterSensitiveLog: (obj: GetDataAccessorResponse) => any;
739
+ /**
740
+ * @internal
741
+ */
742
+ export declare const UpdateDataAccessorRequestFilterSensitiveLog: (obj: UpdateDataAccessorRequest) => any;