@aws-sdk/client-qconnect 3.461.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 (283) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +545 -0
  3. package/dist-cjs/QConnect.js +93 -0
  4. package/dist-cjs/QConnectClient.js +43 -0
  5. package/dist-cjs/commands/CreateAssistantAssociationCommand.js +51 -0
  6. package/dist-cjs/commands/CreateAssistantCommand.js +51 -0
  7. package/dist-cjs/commands/CreateContentCommand.js +52 -0
  8. package/dist-cjs/commands/CreateKnowledgeBaseCommand.js +51 -0
  9. package/dist-cjs/commands/CreateQuickResponseCommand.js +52 -0
  10. package/dist-cjs/commands/CreateSessionCommand.js +51 -0
  11. package/dist-cjs/commands/DeleteAssistantAssociationCommand.js +51 -0
  12. package/dist-cjs/commands/DeleteAssistantCommand.js +51 -0
  13. package/dist-cjs/commands/DeleteContentCommand.js +51 -0
  14. package/dist-cjs/commands/DeleteImportJobCommand.js +51 -0
  15. package/dist-cjs/commands/DeleteKnowledgeBaseCommand.js +51 -0
  16. package/dist-cjs/commands/DeleteQuickResponseCommand.js +51 -0
  17. package/dist-cjs/commands/GetAssistantAssociationCommand.js +51 -0
  18. package/dist-cjs/commands/GetAssistantCommand.js +51 -0
  19. package/dist-cjs/commands/GetContentCommand.js +52 -0
  20. package/dist-cjs/commands/GetContentSummaryCommand.js +51 -0
  21. package/dist-cjs/commands/GetImportJobCommand.js +52 -0
  22. package/dist-cjs/commands/GetKnowledgeBaseCommand.js +51 -0
  23. package/dist-cjs/commands/GetQuickResponseCommand.js +52 -0
  24. package/dist-cjs/commands/GetRecommendationsCommand.js +52 -0
  25. package/dist-cjs/commands/GetSessionCommand.js +51 -0
  26. package/dist-cjs/commands/ListAssistantAssociationsCommand.js +51 -0
  27. package/dist-cjs/commands/ListAssistantsCommand.js +51 -0
  28. package/dist-cjs/commands/ListContentsCommand.js +51 -0
  29. package/dist-cjs/commands/ListImportJobsCommand.js +51 -0
  30. package/dist-cjs/commands/ListKnowledgeBasesCommand.js +51 -0
  31. package/dist-cjs/commands/ListQuickResponsesCommand.js +52 -0
  32. package/dist-cjs/commands/ListTagsForResourceCommand.js +51 -0
  33. package/dist-cjs/commands/NotifyRecommendationsReceivedCommand.js +51 -0
  34. package/dist-cjs/commands/QueryAssistantCommand.js +52 -0
  35. package/dist-cjs/commands/RemoveKnowledgeBaseTemplateUriCommand.js +51 -0
  36. package/dist-cjs/commands/SearchContentCommand.js +51 -0
  37. package/dist-cjs/commands/SearchQuickResponsesCommand.js +52 -0
  38. package/dist-cjs/commands/SearchSessionsCommand.js +51 -0
  39. package/dist-cjs/commands/StartContentUploadCommand.js +52 -0
  40. package/dist-cjs/commands/StartImportJobCommand.js +52 -0
  41. package/dist-cjs/commands/TagResourceCommand.js +51 -0
  42. package/dist-cjs/commands/UntagResourceCommand.js +51 -0
  43. package/dist-cjs/commands/UpdateContentCommand.js +52 -0
  44. package/dist-cjs/commands/UpdateKnowledgeBaseTemplateUriCommand.js +51 -0
  45. package/dist-cjs/commands/UpdateQuickResponseCommand.js +52 -0
  46. package/dist-cjs/commands/index.js +44 -0
  47. package/dist-cjs/endpoint/EndpointParameters.js +12 -0
  48. package/dist-cjs/endpoint/endpointResolver.js +12 -0
  49. package/dist-cjs/endpoint/ruleset.js +7 -0
  50. package/dist-cjs/extensionConfiguration.js +2 -0
  51. package/dist-cjs/index.js +12 -0
  52. package/dist-cjs/models/QConnectServiceException.js +12 -0
  53. package/dist-cjs/models/index.js +4 -0
  54. package/dist-cjs/models/models_0.js +559 -0
  55. package/dist-cjs/pagination/Interfaces.js +2 -0
  56. package/dist-cjs/pagination/ListAssistantAssociationsPaginator.js +29 -0
  57. package/dist-cjs/pagination/ListAssistantsPaginator.js +29 -0
  58. package/dist-cjs/pagination/ListContentsPaginator.js +29 -0
  59. package/dist-cjs/pagination/ListImportJobsPaginator.js +29 -0
  60. package/dist-cjs/pagination/ListKnowledgeBasesPaginator.js +29 -0
  61. package/dist-cjs/pagination/ListQuickResponsesPaginator.js +29 -0
  62. package/dist-cjs/pagination/QueryAssistantPaginator.js +29 -0
  63. package/dist-cjs/pagination/SearchContentPaginator.js +29 -0
  64. package/dist-cjs/pagination/SearchQuickResponsesPaginator.js +29 -0
  65. package/dist-cjs/pagination/SearchSessionsPaginator.js +29 -0
  66. package/dist-cjs/pagination/index.js +14 -0
  67. package/dist-cjs/protocols/Aws_restJson1.js +2993 -0
  68. package/dist-cjs/runtimeConfig.browser.js +39 -0
  69. package/dist-cjs/runtimeConfig.js +50 -0
  70. package/dist-cjs/runtimeConfig.native.js +15 -0
  71. package/dist-cjs/runtimeConfig.shared.js +24 -0
  72. package/dist-cjs/runtimeExtensions.js +22 -0
  73. package/dist-es/QConnect.js +89 -0
  74. package/dist-es/QConnectClient.js +39 -0
  75. package/dist-es/commands/CreateAssistantAssociationCommand.js +47 -0
  76. package/dist-es/commands/CreateAssistantCommand.js +47 -0
  77. package/dist-es/commands/CreateContentCommand.js +48 -0
  78. package/dist-es/commands/CreateKnowledgeBaseCommand.js +47 -0
  79. package/dist-es/commands/CreateQuickResponseCommand.js +48 -0
  80. package/dist-es/commands/CreateSessionCommand.js +47 -0
  81. package/dist-es/commands/DeleteAssistantAssociationCommand.js +47 -0
  82. package/dist-es/commands/DeleteAssistantCommand.js +47 -0
  83. package/dist-es/commands/DeleteContentCommand.js +47 -0
  84. package/dist-es/commands/DeleteImportJobCommand.js +47 -0
  85. package/dist-es/commands/DeleteKnowledgeBaseCommand.js +47 -0
  86. package/dist-es/commands/DeleteQuickResponseCommand.js +47 -0
  87. package/dist-es/commands/GetAssistantAssociationCommand.js +47 -0
  88. package/dist-es/commands/GetAssistantCommand.js +47 -0
  89. package/dist-es/commands/GetContentCommand.js +48 -0
  90. package/dist-es/commands/GetContentSummaryCommand.js +47 -0
  91. package/dist-es/commands/GetImportJobCommand.js +48 -0
  92. package/dist-es/commands/GetKnowledgeBaseCommand.js +47 -0
  93. package/dist-es/commands/GetQuickResponseCommand.js +48 -0
  94. package/dist-es/commands/GetRecommendationsCommand.js +48 -0
  95. package/dist-es/commands/GetSessionCommand.js +47 -0
  96. package/dist-es/commands/ListAssistantAssociationsCommand.js +47 -0
  97. package/dist-es/commands/ListAssistantsCommand.js +47 -0
  98. package/dist-es/commands/ListContentsCommand.js +47 -0
  99. package/dist-es/commands/ListImportJobsCommand.js +47 -0
  100. package/dist-es/commands/ListKnowledgeBasesCommand.js +47 -0
  101. package/dist-es/commands/ListQuickResponsesCommand.js +48 -0
  102. package/dist-es/commands/ListTagsForResourceCommand.js +47 -0
  103. package/dist-es/commands/NotifyRecommendationsReceivedCommand.js +47 -0
  104. package/dist-es/commands/QueryAssistantCommand.js +48 -0
  105. package/dist-es/commands/RemoveKnowledgeBaseTemplateUriCommand.js +47 -0
  106. package/dist-es/commands/SearchContentCommand.js +47 -0
  107. package/dist-es/commands/SearchQuickResponsesCommand.js +48 -0
  108. package/dist-es/commands/SearchSessionsCommand.js +47 -0
  109. package/dist-es/commands/StartContentUploadCommand.js +48 -0
  110. package/dist-es/commands/StartImportJobCommand.js +48 -0
  111. package/dist-es/commands/TagResourceCommand.js +47 -0
  112. package/dist-es/commands/UntagResourceCommand.js +47 -0
  113. package/dist-es/commands/UpdateContentCommand.js +48 -0
  114. package/dist-es/commands/UpdateKnowledgeBaseTemplateUriCommand.js +47 -0
  115. package/dist-es/commands/UpdateQuickResponseCommand.js +48 -0
  116. package/dist-es/commands/index.js +41 -0
  117. package/dist-es/endpoint/EndpointParameters.js +8 -0
  118. package/dist-es/endpoint/endpointResolver.js +8 -0
  119. package/dist-es/endpoint/ruleset.js +4 -0
  120. package/dist-es/extensionConfiguration.js +1 -0
  121. package/dist-es/index.js +7 -0
  122. package/dist-es/models/QConnectServiceException.js +8 -0
  123. package/dist-es/models/index.js +1 -0
  124. package/dist-es/models/models_0.js +508 -0
  125. package/dist-es/pagination/Interfaces.js +1 -0
  126. package/dist-es/pagination/ListAssistantAssociationsPaginator.js +25 -0
  127. package/dist-es/pagination/ListAssistantsPaginator.js +25 -0
  128. package/dist-es/pagination/ListContentsPaginator.js +25 -0
  129. package/dist-es/pagination/ListImportJobsPaginator.js +25 -0
  130. package/dist-es/pagination/ListKnowledgeBasesPaginator.js +25 -0
  131. package/dist-es/pagination/ListQuickResponsesPaginator.js +25 -0
  132. package/dist-es/pagination/QueryAssistantPaginator.js +25 -0
  133. package/dist-es/pagination/SearchContentPaginator.js +25 -0
  134. package/dist-es/pagination/SearchQuickResponsesPaginator.js +25 -0
  135. package/dist-es/pagination/SearchSessionsPaginator.js +25 -0
  136. package/dist-es/pagination/index.js +11 -0
  137. package/dist-es/protocols/Aws_restJson1.js +2907 -0
  138. package/dist-es/runtimeConfig.browser.js +34 -0
  139. package/dist-es/runtimeConfig.js +45 -0
  140. package/dist-es/runtimeConfig.native.js +11 -0
  141. package/dist-es/runtimeConfig.shared.js +20 -0
  142. package/dist-es/runtimeExtensions.js +18 -0
  143. package/dist-types/QConnect.d.ts +309 -0
  144. package/dist-types/QConnectClient.d.ts +222 -0
  145. package/dist-types/commands/CreateAssistantAssociationCommand.d.ts +117 -0
  146. package/dist-types/commands/CreateAssistantCommand.d.ts +117 -0
  147. package/dist-types/commands/CreateContentCommand.d.ts +123 -0
  148. package/dist-types/commands/CreateKnowledgeBaseCommand.d.ts +157 -0
  149. package/dist-types/commands/CreateQuickResponseCommand.d.ts +149 -0
  150. package/dist-types/commands/CreateSessionCommand.d.ts +104 -0
  151. package/dist-types/commands/DeleteAssistantAssociationCommand.d.ts +81 -0
  152. package/dist-types/commands/DeleteAssistantCommand.d.ts +80 -0
  153. package/dist-types/commands/DeleteContentCommand.d.ts +81 -0
  154. package/dist-types/commands/DeleteImportJobCommand.d.ts +87 -0
  155. package/dist-types/commands/DeleteKnowledgeBaseCommand.d.ts +94 -0
  156. package/dist-types/commands/DeleteQuickResponseCommand.d.ts +81 -0
  157. package/dist-types/commands/GetAssistantAssociationCommand.d.ts +98 -0
  158. package/dist-types/commands/GetAssistantCommand.d.ts +101 -0
  159. package/dist-types/commands/GetContentCommand.d.ts +102 -0
  160. package/dist-types/commands/GetContentSummaryCommand.d.ts +99 -0
  161. package/dist-types/commands/GetImportJobCommand.d.ts +106 -0
  162. package/dist-types/commands/GetKnowledgeBaseCommand.d.ts +107 -0
  163. package/dist-types/commands/GetQuickResponseCommand.d.ts +118 -0
  164. package/dist-types/commands/GetRecommendationsCommand.d.ts +239 -0
  165. package/dist-types/commands/GetSessionCommand.d.ts +94 -0
  166. package/dist-types/commands/ListAssistantAssociationsCommand.d.ts +102 -0
  167. package/dist-types/commands/ListAssistantsCommand.d.ts +102 -0
  168. package/dist-types/commands/ListContentsCommand.d.ts +103 -0
  169. package/dist-types/commands/ListImportJobsCommand.d.ts +104 -0
  170. package/dist-types/commands/ListKnowledgeBasesCommand.d.ts +107 -0
  171. package/dist-types/commands/ListQuickResponsesCommand.d.ts +106 -0
  172. package/dist-types/commands/ListTagsForResourceCommand.d.ts +78 -0
  173. package/dist-types/commands/NotifyRecommendationsReceivedCommand.d.ts +96 -0
  174. package/dist-types/commands/QueryAssistantCommand.d.ts +238 -0
  175. package/dist-types/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +80 -0
  176. package/dist-types/commands/SearchContentCommand.d.ts +113 -0
  177. package/dist-types/commands/SearchQuickResponsesCommand.d.ts +163 -0
  178. package/dist-types/commands/SearchSessionsCommand.d.ts +101 -0
  179. package/dist-types/commands/StartContentUploadCommand.d.ts +92 -0
  180. package/dist-types/commands/StartImportJobCommand.d.ts +135 -0
  181. package/dist-types/commands/TagResourceCommand.d.ts +80 -0
  182. package/dist-types/commands/UntagResourceCommand.d.ts +77 -0
  183. package/dist-types/commands/UpdateContentCommand.d.ts +114 -0
  184. package/dist-types/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +113 -0
  185. package/dist-types/commands/UpdateQuickResponseCommand.d.ts +149 -0
  186. package/dist-types/commands/index.d.ts +41 -0
  187. package/dist-types/endpoint/EndpointParameters.d.ts +22 -0
  188. package/dist-types/endpoint/endpointResolver.d.ts +5 -0
  189. package/dist-types/endpoint/ruleset.d.ts +2 -0
  190. package/dist-types/extensionConfiguration.d.ts +8 -0
  191. package/dist-types/index.d.ts +27 -0
  192. package/dist-types/models/QConnectServiceException.d.ts +13 -0
  193. package/dist-types/models/index.d.ts +1 -0
  194. package/dist-types/models/models_0.d.ts +4249 -0
  195. package/dist-types/pagination/Interfaces.d.ts +8 -0
  196. package/dist-types/pagination/ListAssistantAssociationsPaginator.d.ts +7 -0
  197. package/dist-types/pagination/ListAssistantsPaginator.d.ts +7 -0
  198. package/dist-types/pagination/ListContentsPaginator.d.ts +7 -0
  199. package/dist-types/pagination/ListImportJobsPaginator.d.ts +7 -0
  200. package/dist-types/pagination/ListKnowledgeBasesPaginator.d.ts +7 -0
  201. package/dist-types/pagination/ListQuickResponsesPaginator.d.ts +7 -0
  202. package/dist-types/pagination/QueryAssistantPaginator.d.ts +7 -0
  203. package/dist-types/pagination/SearchContentPaginator.d.ts +7 -0
  204. package/dist-types/pagination/SearchQuickResponsesPaginator.d.ts +7 -0
  205. package/dist-types/pagination/SearchSessionsPaginator.d.ts +7 -0
  206. package/dist-types/pagination/index.d.ts +11 -0
  207. package/dist-types/protocols/Aws_restJson1.d.ts +371 -0
  208. package/dist-types/runtimeConfig.browser.d.ts +46 -0
  209. package/dist-types/runtimeConfig.d.ts +46 -0
  210. package/dist-types/runtimeConfig.native.d.ts +45 -0
  211. package/dist-types/runtimeConfig.shared.d.ts +19 -0
  212. package/dist-types/runtimeExtensions.d.ts +17 -0
  213. package/dist-types/ts3.4/QConnect.d.ts +702 -0
  214. package/dist-types/ts3.4/QConnectClient.d.ts +364 -0
  215. package/dist-types/ts3.4/commands/CreateAssistantAssociationCommand.d.ts +42 -0
  216. package/dist-types/ts3.4/commands/CreateAssistantCommand.d.ts +38 -0
  217. package/dist-types/ts3.4/commands/CreateContentCommand.d.ts +38 -0
  218. package/dist-types/ts3.4/commands/CreateKnowledgeBaseCommand.d.ts +39 -0
  219. package/dist-types/ts3.4/commands/CreateQuickResponseCommand.d.ts +39 -0
  220. package/dist-types/ts3.4/commands/CreateSessionCommand.d.ts +38 -0
  221. package/dist-types/ts3.4/commands/DeleteAssistantAssociationCommand.d.ts +42 -0
  222. package/dist-types/ts3.4/commands/DeleteAssistantCommand.d.ts +38 -0
  223. package/dist-types/ts3.4/commands/DeleteContentCommand.d.ts +38 -0
  224. package/dist-types/ts3.4/commands/DeleteImportJobCommand.d.ts +38 -0
  225. package/dist-types/ts3.4/commands/DeleteKnowledgeBaseCommand.d.ts +39 -0
  226. package/dist-types/ts3.4/commands/DeleteQuickResponseCommand.d.ts +39 -0
  227. package/dist-types/ts3.4/commands/GetAssistantAssociationCommand.d.ts +42 -0
  228. package/dist-types/ts3.4/commands/GetAssistantCommand.d.ts +35 -0
  229. package/dist-types/ts3.4/commands/GetContentCommand.d.ts +35 -0
  230. package/dist-types/ts3.4/commands/GetContentSummaryCommand.d.ts +39 -0
  231. package/dist-types/ts3.4/commands/GetImportJobCommand.d.ts +35 -0
  232. package/dist-types/ts3.4/commands/GetKnowledgeBaseCommand.d.ts +38 -0
  233. package/dist-types/ts3.4/commands/GetQuickResponseCommand.d.ts +38 -0
  234. package/dist-types/ts3.4/commands/GetRecommendationsCommand.d.ts +39 -0
  235. package/dist-types/ts3.4/commands/GetSessionCommand.d.ts +35 -0
  236. package/dist-types/ts3.4/commands/ListAssistantAssociationsCommand.d.ts +42 -0
  237. package/dist-types/ts3.4/commands/ListAssistantsCommand.d.ts +38 -0
  238. package/dist-types/ts3.4/commands/ListContentsCommand.d.ts +35 -0
  239. package/dist-types/ts3.4/commands/ListImportJobsCommand.d.ts +38 -0
  240. package/dist-types/ts3.4/commands/ListKnowledgeBasesCommand.d.ts +39 -0
  241. package/dist-types/ts3.4/commands/ListQuickResponsesCommand.d.ts +39 -0
  242. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +39 -0
  243. package/dist-types/ts3.4/commands/NotifyRecommendationsReceivedCommand.d.ts +42 -0
  244. package/dist-types/ts3.4/commands/QueryAssistantCommand.d.ts +38 -0
  245. package/dist-types/ts3.4/commands/RemoveKnowledgeBaseTemplateUriCommand.d.ts +42 -0
  246. package/dist-types/ts3.4/commands/SearchContentCommand.d.ts +38 -0
  247. package/dist-types/ts3.4/commands/SearchQuickResponsesCommand.d.ts +42 -0
  248. package/dist-types/ts3.4/commands/SearchSessionsCommand.d.ts +38 -0
  249. package/dist-types/ts3.4/commands/StartContentUploadCommand.d.ts +39 -0
  250. package/dist-types/ts3.4/commands/StartImportJobCommand.d.ts +38 -0
  251. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +35 -0
  252. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +38 -0
  253. package/dist-types/ts3.4/commands/UpdateContentCommand.d.ts +38 -0
  254. package/dist-types/ts3.4/commands/UpdateKnowledgeBaseTemplateUriCommand.d.ts +42 -0
  255. package/dist-types/ts3.4/commands/UpdateQuickResponseCommand.d.ts +39 -0
  256. package/dist-types/ts3.4/commands/index.d.ts +41 -0
  257. package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +33 -0
  258. package/dist-types/ts3.4/endpoint/endpointResolver.d.ts +8 -0
  259. package/dist-types/ts3.4/endpoint/ruleset.d.ts +2 -0
  260. package/dist-types/ts3.4/extensionConfiguration.d.ts +7 -0
  261. package/dist-types/ts3.4/index.d.ts +10 -0
  262. package/dist-types/ts3.4/models/QConnectServiceException.d.ts +8 -0
  263. package/dist-types/ts3.4/models/index.d.ts +1 -0
  264. package/dist-types/ts3.4/models/models_0.d.ts +1241 -0
  265. package/dist-types/ts3.4/pagination/Interfaces.d.ts +6 -0
  266. package/dist-types/ts3.4/pagination/ListAssistantAssociationsPaginator.d.ts +11 -0
  267. package/dist-types/ts3.4/pagination/ListAssistantsPaginator.d.ts +11 -0
  268. package/dist-types/ts3.4/pagination/ListContentsPaginator.d.ts +11 -0
  269. package/dist-types/ts3.4/pagination/ListImportJobsPaginator.d.ts +11 -0
  270. package/dist-types/ts3.4/pagination/ListKnowledgeBasesPaginator.d.ts +11 -0
  271. package/dist-types/ts3.4/pagination/ListQuickResponsesPaginator.d.ts +11 -0
  272. package/dist-types/ts3.4/pagination/QueryAssistantPaginator.d.ts +11 -0
  273. package/dist-types/ts3.4/pagination/SearchContentPaginator.d.ts +11 -0
  274. package/dist-types/ts3.4/pagination/SearchQuickResponsesPaginator.d.ts +11 -0
  275. package/dist-types/ts3.4/pagination/SearchSessionsPaginator.d.ts +11 -0
  276. package/dist-types/ts3.4/pagination/index.d.ts +11 -0
  277. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +497 -0
  278. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +97 -0
  279. package/dist-types/ts3.4/runtimeConfig.d.ts +97 -0
  280. package/dist-types/ts3.4/runtimeConfig.native.d.ts +88 -0
  281. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +19 -0
  282. package/dist-types/ts3.4/runtimeExtensions.d.ts +11 -0
  283. package/package.json +104 -0
@@ -0,0 +1,4249 @@
1
+ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
2
+ import { QConnectServiceException as __BaseException } from "./QConnectServiceException";
3
+ /**
4
+ * @public
5
+ * <p>You do not have sufficient access to perform this action.</p>
6
+ */
7
+ export declare class AccessDeniedException extends __BaseException {
8
+ readonly name: "AccessDeniedException";
9
+ readonly $fault: "client";
10
+ /**
11
+ * @internal
12
+ */
13
+ constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
14
+ }
15
+ /**
16
+ * @public
17
+ * <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
18
+ */
19
+ export interface AppIntegrationsConfiguration {
20
+ /**
21
+ * @public
22
+ * <p>The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.</p>
23
+ * <ul>
24
+ * <li>
25
+ * <p> For <a href="https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm"> Salesforce</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if
26
+ * objectFields is not provided, including at least <code>Id</code>,
27
+ * <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>,
28
+ * <code>PublishStatus</code>, and <code>IsDeleted</code> as source fields. </p>
29
+ * </li>
30
+ * <li>
31
+ * <p> For <a href="https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api"> ServiceNow</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if
32
+ * objectFields is not provided, including at least <code>number</code>,
33
+ * <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>,
34
+ * and <code>active</code> as source fields. </p>
35
+ * </li>
36
+ * <li>
37
+ * <p> For <a href="https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/">
38
+ * Zendesk</a>, your AppIntegrations DataIntegration must have an ObjectConfiguration if
39
+ * <code>objectFields</code> is not provided, including at least <code>id</code>,
40
+ * <code>title</code>, <code>updated_at</code>, and <code>draft</code> as source fields.
41
+ * </p>
42
+ * </li>
43
+ * <li>
44
+ * <p> For <a href="https://learn.microsoft.com/en-us/sharepoint/dev/sp-add-ins/sharepoint-net-server-csom-jsom-and-rest-api-index">SharePoint</a>, your AppIntegrations DataIntegration must have a FileConfiguration,
45
+ * including only file extensions that are among <code>docx</code>, <code>pdf</code>,
46
+ * <code>html</code>, <code>htm</code>, and <code>txt</code>. </p>
47
+ * </li>
48
+ * <li>
49
+ * <p> For <a href="https://aws.amazon.com/s3/">Amazon S3</a>, the
50
+ * ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null.
51
+ * The <code>SourceURI</code> of your DataIntegration must use the following format:
52
+ * <code>s3://your_s3_bucket_name</code>.</p>
53
+ * <important>
54
+ * <p>The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services
55
+ * principal <code>app-integrations.amazonaws.com</code> to perform
56
+ * <code>s3:ListBucket</code>, <code>s3:GetObject</code>, and
57
+ * <code>s3:GetBucketLocation</code> against the bucket.</p>
58
+ * </important>
59
+ * </li>
60
+ * </ul>
61
+ */
62
+ appIntegrationArn: string | undefined;
63
+ /**
64
+ * @public
65
+ * <p>The fields from the source that are made available to your agents in Amazon Q. Optional if
66
+ * ObjectConfiguration is included in the provided DataIntegration. </p>
67
+ * <ul>
68
+ * <li>
69
+ * <p> For <a href="https://developer.salesforce.com/docs/atlas.en-us.knowledge_dev.meta/knowledge_dev/sforce_api_objects_knowledge__kav.htm"> Salesforce</a>, you must include at least <code>Id</code>,
70
+ * <code>ArticleNumber</code>, <code>VersionNumber</code>, <code>Title</code>,
71
+ * <code>PublishStatus</code>, and <code>IsDeleted</code>. </p>
72
+ * </li>
73
+ * <li>
74
+ * <p>For <a href="https://developer.servicenow.com/dev.do#!/reference/api/rome/rest/knowledge-management-api"> ServiceNow</a>, you must include at least <code>number</code>,
75
+ * <code>short_description</code>, <code>sys_mod_count</code>, <code>workflow_state</code>,
76
+ * and <code>active</code>. </p>
77
+ * </li>
78
+ * <li>
79
+ * <p>For <a href="https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/">
80
+ * Zendesk</a>, you must include at least <code>id</code>, <code>title</code>,
81
+ * <code>updated_at</code>, and <code>draft</code>. </p>
82
+ * </li>
83
+ * </ul>
84
+ * <p>Make sure to include additional fields. These fields are indexed and used to source
85
+ * recommendations. </p>
86
+ */
87
+ objectFields?: string[];
88
+ }
89
+ /**
90
+ * @public
91
+ * <p>The request could not be processed because of conflict in the current state of the
92
+ * resource. For example, if you're using a <code>Create</code> API (such as
93
+ * <code>CreateAssistant</code>) that accepts name, a conflicting resource (usually with the
94
+ * same name) is being created or mutated.</p>
95
+ */
96
+ export declare class ConflictException extends __BaseException {
97
+ readonly name: "ConflictException";
98
+ readonly $fault: "client";
99
+ /**
100
+ * @internal
101
+ */
102
+ constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
103
+ }
104
+ /**
105
+ * @public
106
+ * <p>The data that is input into Amazon Q as a result of the assistant association.</p>
107
+ */
108
+ export type AssistantAssociationInputData = AssistantAssociationInputData.KnowledgeBaseIdMember | AssistantAssociationInputData.$UnknownMember;
109
+ /**
110
+ * @public
111
+ */
112
+ export declare namespace AssistantAssociationInputData {
113
+ /**
114
+ * @public
115
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
116
+ * base if you're storing Amazon Q Content resource to it.</p>
117
+ */
118
+ interface KnowledgeBaseIdMember {
119
+ knowledgeBaseId: string;
120
+ $unknown?: never;
121
+ }
122
+ /**
123
+ * @public
124
+ */
125
+ interface $UnknownMember {
126
+ knowledgeBaseId?: never;
127
+ $unknown: [string, any];
128
+ }
129
+ interface Visitor<T> {
130
+ knowledgeBaseId: (value: string) => T;
131
+ _: (name: string, value: any) => T;
132
+ }
133
+ const visit: <T>(value: AssistantAssociationInputData, visitor: Visitor<T>) => T;
134
+ }
135
+ /**
136
+ * @public
137
+ * @enum
138
+ */
139
+ export declare const AssociationType: {
140
+ readonly KNOWLEDGE_BASE: "KNOWLEDGE_BASE";
141
+ };
142
+ /**
143
+ * @public
144
+ */
145
+ export type AssociationType = (typeof AssociationType)[keyof typeof AssociationType];
146
+ /**
147
+ * @public
148
+ */
149
+ export interface CreateAssistantAssociationRequest {
150
+ /**
151
+ * @public
152
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
153
+ */
154
+ assistantId: string | undefined;
155
+ /**
156
+ * @public
157
+ * <p>The type of association.</p>
158
+ */
159
+ associationType: AssociationType | undefined;
160
+ /**
161
+ * @public
162
+ * <p>The identifier of the associated resource.</p>
163
+ */
164
+ association: AssistantAssociationInputData | undefined;
165
+ /**
166
+ * @public
167
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
168
+ * request. If not provided, the Amazon Web Services
169
+ * SDK populates this field. For more information about idempotency, see
170
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
171
+ */
172
+ clientToken?: string;
173
+ /**
174
+ * @public
175
+ * <p>The tags used to organize, track, or control access for this resource.</p>
176
+ */
177
+ tags?: Record<string, string>;
178
+ }
179
+ /**
180
+ * @public
181
+ * <p>Association information about the knowledge base.</p>
182
+ */
183
+ export interface KnowledgeBaseAssociationData {
184
+ /**
185
+ * @public
186
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
187
+ * base if you're storing Amazon Q Content resource to it.</p>
188
+ */
189
+ knowledgeBaseId?: string;
190
+ /**
191
+ * @public
192
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
193
+ */
194
+ knowledgeBaseArn?: string;
195
+ }
196
+ /**
197
+ * @public
198
+ * <p>The data that is output as a result of the assistant association.</p>
199
+ */
200
+ export type AssistantAssociationOutputData = AssistantAssociationOutputData.KnowledgeBaseAssociationMember | AssistantAssociationOutputData.$UnknownMember;
201
+ /**
202
+ * @public
203
+ */
204
+ export declare namespace AssistantAssociationOutputData {
205
+ /**
206
+ * @public
207
+ * <p>The knowledge base where output data is sent.</p>
208
+ */
209
+ interface KnowledgeBaseAssociationMember {
210
+ knowledgeBaseAssociation: KnowledgeBaseAssociationData;
211
+ $unknown?: never;
212
+ }
213
+ /**
214
+ * @public
215
+ */
216
+ interface $UnknownMember {
217
+ knowledgeBaseAssociation?: never;
218
+ $unknown: [string, any];
219
+ }
220
+ interface Visitor<T> {
221
+ knowledgeBaseAssociation: (value: KnowledgeBaseAssociationData) => T;
222
+ _: (name: string, value: any) => T;
223
+ }
224
+ const visit: <T>(value: AssistantAssociationOutputData, visitor: Visitor<T>) => T;
225
+ }
226
+ /**
227
+ * @public
228
+ * <p>Information about the assistant association.</p>
229
+ */
230
+ export interface AssistantAssociationData {
231
+ /**
232
+ * @public
233
+ * <p>The identifier of the assistant association.</p>
234
+ */
235
+ assistantAssociationId: string | undefined;
236
+ /**
237
+ * @public
238
+ * <p>The Amazon Resource Name (ARN) of the assistant association.</p>
239
+ */
240
+ assistantAssociationArn: string | undefined;
241
+ /**
242
+ * @public
243
+ * <p>The identifier of the Amazon Q assistant.</p>
244
+ */
245
+ assistantId: string | undefined;
246
+ /**
247
+ * @public
248
+ * <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
249
+ */
250
+ assistantArn: string | undefined;
251
+ /**
252
+ * @public
253
+ * <p>The type of association.</p>
254
+ */
255
+ associationType: AssociationType | undefined;
256
+ /**
257
+ * @public
258
+ * <p>A union type that currently has a single argument, the knowledge base ID.</p>
259
+ */
260
+ associationData: AssistantAssociationOutputData | undefined;
261
+ /**
262
+ * @public
263
+ * <p>The tags used to organize, track, or control access for this resource.</p>
264
+ */
265
+ tags?: Record<string, string>;
266
+ }
267
+ /**
268
+ * @public
269
+ */
270
+ export interface CreateAssistantAssociationResponse {
271
+ /**
272
+ * @public
273
+ * <p>The assistant association.</p>
274
+ */
275
+ assistantAssociation?: AssistantAssociationData;
276
+ }
277
+ /**
278
+ * @public
279
+ * <p>The specified resource does not exist.</p>
280
+ */
281
+ export declare class ResourceNotFoundException extends __BaseException {
282
+ readonly name: "ResourceNotFoundException";
283
+ readonly $fault: "client";
284
+ /**
285
+ * @public
286
+ * <p>The specified resource name.</p>
287
+ */
288
+ resourceName?: string;
289
+ /**
290
+ * @internal
291
+ */
292
+ constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
293
+ }
294
+ /**
295
+ * @public
296
+ * <p>You've exceeded your service quota. To perform the requested action, remove some of the
297
+ * relevant resources, or use service quotas to request a service quota increase.</p>
298
+ */
299
+ export declare class ServiceQuotaExceededException extends __BaseException {
300
+ readonly name: "ServiceQuotaExceededException";
301
+ readonly $fault: "client";
302
+ /**
303
+ * @internal
304
+ */
305
+ constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
306
+ }
307
+ /**
308
+ * @public
309
+ * <p>The input fails to satisfy the constraints specified by a service.</p>
310
+ */
311
+ export declare class ValidationException extends __BaseException {
312
+ readonly name: "ValidationException";
313
+ readonly $fault: "client";
314
+ /**
315
+ * @internal
316
+ */
317
+ constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
318
+ }
319
+ /**
320
+ * @public
321
+ */
322
+ export interface DeleteAssistantAssociationRequest {
323
+ /**
324
+ * @public
325
+ * <p>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
326
+ */
327
+ assistantAssociationId: string | undefined;
328
+ /**
329
+ * @public
330
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
331
+ */
332
+ assistantId: string | undefined;
333
+ }
334
+ /**
335
+ * @public
336
+ */
337
+ export interface DeleteAssistantAssociationResponse {
338
+ }
339
+ /**
340
+ * @public
341
+ */
342
+ export interface GetAssistantAssociationRequest {
343
+ /**
344
+ * @public
345
+ * <p>The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
346
+ */
347
+ assistantAssociationId: string | undefined;
348
+ /**
349
+ * @public
350
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
351
+ */
352
+ assistantId: string | undefined;
353
+ }
354
+ /**
355
+ * @public
356
+ */
357
+ export interface GetAssistantAssociationResponse {
358
+ /**
359
+ * @public
360
+ * <p>The assistant association.</p>
361
+ */
362
+ assistantAssociation?: AssistantAssociationData;
363
+ }
364
+ /**
365
+ * @public
366
+ */
367
+ export interface ListAssistantAssociationsRequest {
368
+ /**
369
+ * @public
370
+ * <p>The token for the next set of results. Use the value returned in the previous
371
+ * response in the next request to retrieve the next set of results.</p>
372
+ */
373
+ nextToken?: string;
374
+ /**
375
+ * @public
376
+ * <p>The maximum number of results to return per page.</p>
377
+ */
378
+ maxResults?: number;
379
+ /**
380
+ * @public
381
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
382
+ */
383
+ assistantId: string | undefined;
384
+ }
385
+ /**
386
+ * @public
387
+ * <p>Summary information about the assistant association.</p>
388
+ */
389
+ export interface AssistantAssociationSummary {
390
+ /**
391
+ * @public
392
+ * <p>The identifier of the assistant association.</p>
393
+ */
394
+ assistantAssociationId: string | undefined;
395
+ /**
396
+ * @public
397
+ * <p>The Amazon Resource Name (ARN) of the assistant association.</p>
398
+ */
399
+ assistantAssociationArn: string | undefined;
400
+ /**
401
+ * @public
402
+ * <p>The identifier of the Amazon Q assistant.</p>
403
+ */
404
+ assistantId: string | undefined;
405
+ /**
406
+ * @public
407
+ * <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
408
+ */
409
+ assistantArn: string | undefined;
410
+ /**
411
+ * @public
412
+ * <p>The type of association.</p>
413
+ */
414
+ associationType: AssociationType | undefined;
415
+ /**
416
+ * @public
417
+ * <p>The association data.</p>
418
+ */
419
+ associationData: AssistantAssociationOutputData | undefined;
420
+ /**
421
+ * @public
422
+ * <p>The tags used to organize, track, or control access for this resource.</p>
423
+ */
424
+ tags?: Record<string, string>;
425
+ }
426
+ /**
427
+ * @public
428
+ */
429
+ export interface ListAssistantAssociationsResponse {
430
+ /**
431
+ * @public
432
+ * <p>Summary information about assistant associations.</p>
433
+ */
434
+ assistantAssociationSummaries: AssistantAssociationSummary[] | undefined;
435
+ /**
436
+ * @public
437
+ * <p>If there are additional results, this is the token for the next set of results.</p>
438
+ */
439
+ nextToken?: string;
440
+ }
441
+ /**
442
+ * @public
443
+ * <p>The configuration information for the customer managed key used for encryption.</p>
444
+ */
445
+ export interface ServerSideEncryptionConfiguration {
446
+ /**
447
+ * @public
448
+ * <p>The customer managed key used for encryption. For more information about setting up a
449
+ * customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for your instance</a>.
450
+ * For information about valid ID values, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id">Key identifiers (KeyId)</a>.</p>
451
+ */
452
+ kmsKeyId?: string;
453
+ }
454
+ /**
455
+ * @public
456
+ * @enum
457
+ */
458
+ export declare const AssistantType: {
459
+ readonly AGENT: "AGENT";
460
+ };
461
+ /**
462
+ * @public
463
+ */
464
+ export type AssistantType = (typeof AssistantType)[keyof typeof AssistantType];
465
+ /**
466
+ * @public
467
+ */
468
+ export interface CreateAssistantRequest {
469
+ /**
470
+ * @public
471
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
472
+ * request. If not provided, the Amazon Web Services
473
+ * SDK populates this field. For more information about idempotency, see
474
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
475
+ */
476
+ clientToken?: string;
477
+ /**
478
+ * @public
479
+ * <p>The name of the assistant.</p>
480
+ */
481
+ name: string | undefined;
482
+ /**
483
+ * @public
484
+ * <p>The type of assistant.</p>
485
+ */
486
+ type: AssistantType | undefined;
487
+ /**
488
+ * @public
489
+ * <p>The description of the assistant.</p>
490
+ */
491
+ description?: string;
492
+ /**
493
+ * @public
494
+ * <p>The tags used to organize, track, or control access for this resource.</p>
495
+ */
496
+ tags?: Record<string, string>;
497
+ /**
498
+ * @public
499
+ * <p>The configuration information for the customer managed key used for encryption. </p>
500
+ * <p>The customer managed key must have a policy that allows <code>kms:CreateGrant</code>,
501
+ * <code> kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
502
+ * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
503
+ * key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow
504
+ * <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
505
+ * <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
506
+ * principal. </p>
507
+ * <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
508
+ * your instance</a>.</p>
509
+ */
510
+ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
511
+ }
512
+ /**
513
+ * @public
514
+ * @enum
515
+ */
516
+ export declare const AssistantCapabilityType: {
517
+ readonly V1: "V1";
518
+ readonly V2: "V2";
519
+ };
520
+ /**
521
+ * @public
522
+ */
523
+ export type AssistantCapabilityType = (typeof AssistantCapabilityType)[keyof typeof AssistantCapabilityType];
524
+ /**
525
+ * @public
526
+ * <p>The capability configuration for a Amazon Q assistant. </p>
527
+ */
528
+ export interface AssistantCapabilityConfiguration {
529
+ /**
530
+ * @public
531
+ * <p>The type of Amazon Q assistant capability. </p>
532
+ */
533
+ type?: AssistantCapabilityType;
534
+ }
535
+ /**
536
+ * @public
537
+ * <p>The configuration information for the Amazon Q assistant integration.</p>
538
+ */
539
+ export interface AssistantIntegrationConfiguration {
540
+ /**
541
+ * @public
542
+ * <p>The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.</p>
543
+ */
544
+ topicIntegrationArn?: string;
545
+ }
546
+ /**
547
+ * @public
548
+ * @enum
549
+ */
550
+ export declare const AssistantStatus: {
551
+ readonly ACTIVE: "ACTIVE";
552
+ readonly CREATE_FAILED: "CREATE_FAILED";
553
+ readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
554
+ readonly DELETED: "DELETED";
555
+ readonly DELETE_FAILED: "DELETE_FAILED";
556
+ readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
557
+ };
558
+ /**
559
+ * @public
560
+ */
561
+ export type AssistantStatus = (typeof AssistantStatus)[keyof typeof AssistantStatus];
562
+ /**
563
+ * @public
564
+ * <p>The assistant data.</p>
565
+ */
566
+ export interface AssistantData {
567
+ /**
568
+ * @public
569
+ * <p>The identifier of the Amazon Q assistant.</p>
570
+ */
571
+ assistantId: string | undefined;
572
+ /**
573
+ * @public
574
+ * <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
575
+ */
576
+ assistantArn: string | undefined;
577
+ /**
578
+ * @public
579
+ * <p>The name.</p>
580
+ */
581
+ name: string | undefined;
582
+ /**
583
+ * @public
584
+ * <p>The type of assistant.</p>
585
+ */
586
+ type: AssistantType | undefined;
587
+ /**
588
+ * @public
589
+ * <p>The status of the assistant.</p>
590
+ */
591
+ status: AssistantStatus | undefined;
592
+ /**
593
+ * @public
594
+ * <p>The description.</p>
595
+ */
596
+ description?: string;
597
+ /**
598
+ * @public
599
+ * <p>The tags used to organize, track, or control access for this resource.</p>
600
+ */
601
+ tags?: Record<string, string>;
602
+ /**
603
+ * @public
604
+ * <p>The configuration information for the customer managed key used for encryption. </p>
605
+ * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
606
+ * <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
607
+ * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
608
+ * key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow
609
+ * <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
610
+ * <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
611
+ * principal. </p>
612
+ * <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
613
+ * your instance</a>.</p>
614
+ */
615
+ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
616
+ /**
617
+ * @public
618
+ * <p>The configuration information for the Amazon Q assistant integration.</p>
619
+ */
620
+ integrationConfiguration?: AssistantIntegrationConfiguration;
621
+ /**
622
+ * @public
623
+ * <p>The configuration information for the Amazon Q assistant capability. </p>
624
+ */
625
+ capabilityConfiguration?: AssistantCapabilityConfiguration;
626
+ }
627
+ /**
628
+ * @public
629
+ */
630
+ export interface CreateAssistantResponse {
631
+ /**
632
+ * @public
633
+ * <p>Information about the assistant.</p>
634
+ */
635
+ assistant?: AssistantData;
636
+ }
637
+ /**
638
+ * @public
639
+ */
640
+ export interface DeleteAssistantRequest {
641
+ /**
642
+ * @public
643
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
644
+ */
645
+ assistantId: string | undefined;
646
+ }
647
+ /**
648
+ * @public
649
+ */
650
+ export interface DeleteAssistantResponse {
651
+ }
652
+ /**
653
+ * @public
654
+ */
655
+ export interface GetAssistantRequest {
656
+ /**
657
+ * @public
658
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
659
+ */
660
+ assistantId: string | undefined;
661
+ }
662
+ /**
663
+ * @public
664
+ */
665
+ export interface GetAssistantResponse {
666
+ /**
667
+ * @public
668
+ * <p>Information about the assistant.</p>
669
+ */
670
+ assistant?: AssistantData;
671
+ }
672
+ /**
673
+ * @public
674
+ */
675
+ export interface GetRecommendationsRequest {
676
+ /**
677
+ * @public
678
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
679
+ */
680
+ assistantId: string | undefined;
681
+ /**
682
+ * @public
683
+ * <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
684
+ */
685
+ sessionId: string | undefined;
686
+ /**
687
+ * @public
688
+ * <p>The maximum number of results to return per page.</p>
689
+ */
690
+ maxResults?: number;
691
+ /**
692
+ * @public
693
+ * <p>The duration (in seconds) for which the call waits for a recommendation to be made
694
+ * available before returning. If a recommendation is available, the call returns sooner than
695
+ * <code>WaitTimeSeconds</code>. If no messages are available and the wait time expires, the
696
+ * call returns successfully with an empty list.</p>
697
+ */
698
+ waitTimeSeconds?: number;
699
+ }
700
+ /**
701
+ * @public
702
+ * @enum
703
+ */
704
+ export declare const RelevanceLevel: {
705
+ readonly HIGH: "HIGH";
706
+ readonly LOW: "LOW";
707
+ readonly MEDIUM: "MEDIUM";
708
+ };
709
+ /**
710
+ * @public
711
+ */
712
+ export type RelevanceLevel = (typeof RelevanceLevel)[keyof typeof RelevanceLevel];
713
+ /**
714
+ * @public
715
+ * <p>Details about the source content ranking data.</p>
716
+ */
717
+ export interface RankingData {
718
+ /**
719
+ * @public
720
+ * <p>The relevance level of the recommendation.</p>
721
+ */
722
+ relevanceScore?: number;
723
+ /**
724
+ * @public
725
+ * <p>The relevance score of the content.</p>
726
+ */
727
+ relevanceLevel?: RelevanceLevel;
728
+ }
729
+ /**
730
+ * @public
731
+ * <p>Offset specification to describe highlighting of document excerpts for rendering search
732
+ * results and recommendations.</p>
733
+ */
734
+ export interface Highlight {
735
+ /**
736
+ * @public
737
+ * <p>The offset for the start of the highlight.</p>
738
+ */
739
+ beginOffsetInclusive?: number;
740
+ /**
741
+ * @public
742
+ * <p>The offset for the end of the highlight.</p>
743
+ */
744
+ endOffsetExclusive?: number;
745
+ }
746
+ /**
747
+ * @public
748
+ * <p>The text of the document.</p>
749
+ */
750
+ export interface DocumentText {
751
+ /**
752
+ * @public
753
+ * <p>Text in the document.</p>
754
+ */
755
+ text?: string;
756
+ /**
757
+ * @public
758
+ * <p>Highlights in the document text.</p>
759
+ */
760
+ highlights?: Highlight[];
761
+ }
762
+ /**
763
+ * @public
764
+ * <p>Details about the source content text data.</p>
765
+ */
766
+ export interface TextData {
767
+ /**
768
+ * @public
769
+ * <p>The text of the document.</p>
770
+ */
771
+ title?: DocumentText;
772
+ /**
773
+ * @public
774
+ * <p>The text of the document.</p>
775
+ */
776
+ excerpt?: DocumentText;
777
+ }
778
+ /**
779
+ * @public
780
+ * <p>Details about the content data.</p>
781
+ */
782
+ export interface ContentDataDetails {
783
+ /**
784
+ * @public
785
+ * <p>Details about the content text data.</p>
786
+ */
787
+ textData: TextData | undefined;
788
+ /**
789
+ * @public
790
+ * <p>Details about the content ranking data.</p>
791
+ */
792
+ rankingData: RankingData | undefined;
793
+ }
794
+ /**
795
+ * @public
796
+ * @enum
797
+ */
798
+ export declare const SourceContentType: {
799
+ readonly KNOWLEDGE_CONTENT: "KNOWLEDGE_CONTENT";
800
+ };
801
+ /**
802
+ * @public
803
+ */
804
+ export type SourceContentType = (typeof SourceContentType)[keyof typeof SourceContentType];
805
+ /**
806
+ * @public
807
+ * <p>Details about the source content data.</p>
808
+ */
809
+ export interface SourceContentDataDetails {
810
+ /**
811
+ * @public
812
+ * <p>The identifier of the source content.</p>
813
+ */
814
+ id: string | undefined;
815
+ /**
816
+ * @public
817
+ * <p>The type of the source content.</p>
818
+ */
819
+ type: SourceContentType | undefined;
820
+ /**
821
+ * @public
822
+ * <p> Details about the source content text data.</p>
823
+ */
824
+ textData: TextData | undefined;
825
+ /**
826
+ * @public
827
+ * <p>Details about the source content ranking data.</p>
828
+ */
829
+ rankingData: RankingData | undefined;
830
+ }
831
+ /**
832
+ * @public
833
+ * <p>Reference information about the content.</p>
834
+ */
835
+ export interface ContentReference {
836
+ /**
837
+ * @public
838
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
839
+ */
840
+ knowledgeBaseArn?: string;
841
+ /**
842
+ * @public
843
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
844
+ * base if you're storing Amazon Q Content resource to it.</p>
845
+ */
846
+ knowledgeBaseId?: string;
847
+ /**
848
+ * @public
849
+ * <p>The Amazon Resource Name (ARN) of the content.</p>
850
+ */
851
+ contentArn?: string;
852
+ /**
853
+ * @public
854
+ * <p>The identifier of the content.</p>
855
+ */
856
+ contentId?: string;
857
+ }
858
+ /**
859
+ * @public
860
+ * <p>Reference information about generative content.</p>
861
+ */
862
+ export interface GenerativeReference {
863
+ /**
864
+ * @public
865
+ * <p>The identifier of the LLM model. </p>
866
+ */
867
+ modelId?: string;
868
+ /**
869
+ * @public
870
+ * <p> The identifier of the LLM model. </p>
871
+ */
872
+ generationId?: string;
873
+ }
874
+ /**
875
+ * @public
876
+ * <p>Reference data.</p>
877
+ */
878
+ export type DataReference = DataReference.ContentReferenceMember | DataReference.GenerativeReferenceMember | DataReference.$UnknownMember;
879
+ /**
880
+ * @public
881
+ */
882
+ export declare namespace DataReference {
883
+ /**
884
+ * @public
885
+ * <p>Reference information about the content.</p>
886
+ */
887
+ interface ContentReferenceMember {
888
+ contentReference: ContentReference;
889
+ generativeReference?: never;
890
+ $unknown?: never;
891
+ }
892
+ /**
893
+ * @public
894
+ * <p>Reference information about the generative content.</p>
895
+ */
896
+ interface GenerativeReferenceMember {
897
+ contentReference?: never;
898
+ generativeReference: GenerativeReference;
899
+ $unknown?: never;
900
+ }
901
+ /**
902
+ * @public
903
+ */
904
+ interface $UnknownMember {
905
+ contentReference?: never;
906
+ generativeReference?: never;
907
+ $unknown: [string, any];
908
+ }
909
+ interface Visitor<T> {
910
+ contentReference: (value: ContentReference) => T;
911
+ generativeReference: (value: GenerativeReference) => T;
912
+ _: (name: string, value: any) => T;
913
+ }
914
+ const visit: <T>(value: DataReference, visitor: Visitor<T>) => T;
915
+ }
916
+ /**
917
+ * @public
918
+ * <p>The document.</p>
919
+ */
920
+ export interface Document {
921
+ /**
922
+ * @public
923
+ * <p>A reference to the content resource.</p>
924
+ */
925
+ contentReference: ContentReference | undefined;
926
+ /**
927
+ * @public
928
+ * <p>The title of the document.</p>
929
+ */
930
+ title?: DocumentText;
931
+ /**
932
+ * @public
933
+ * <p>The excerpt from the document.</p>
934
+ */
935
+ excerpt?: DocumentText;
936
+ }
937
+ /**
938
+ * @public
939
+ * @enum
940
+ */
941
+ export declare const RecommendationType: {
942
+ readonly GENERATIVE_ANSWER: "GENERATIVE_ANSWER";
943
+ readonly GENERATIVE_RESPONSE: "GENERATIVE_RESPONSE";
944
+ readonly KNOWLEDGE_CONTENT: "KNOWLEDGE_CONTENT";
945
+ };
946
+ /**
947
+ * @public
948
+ */
949
+ export type RecommendationType = (typeof RecommendationType)[keyof typeof RecommendationType];
950
+ /**
951
+ * @public
952
+ * <p>Data associated with the QUERY RecommendationTriggerType.</p>
953
+ */
954
+ export interface QueryRecommendationTriggerData {
955
+ /**
956
+ * @public
957
+ * <p>The text associated with the recommendation trigger.</p>
958
+ */
959
+ text?: string;
960
+ }
961
+ /**
962
+ * @public
963
+ * <p>A union type containing information related to the trigger.</p>
964
+ */
965
+ export type RecommendationTriggerData = RecommendationTriggerData.QueryMember | RecommendationTriggerData.$UnknownMember;
966
+ /**
967
+ * @public
968
+ */
969
+ export declare namespace RecommendationTriggerData {
970
+ /**
971
+ * @public
972
+ * <p>Data associated with the QUERY RecommendationTriggerType.</p>
973
+ */
974
+ interface QueryMember {
975
+ query: QueryRecommendationTriggerData;
976
+ $unknown?: never;
977
+ }
978
+ /**
979
+ * @public
980
+ */
981
+ interface $UnknownMember {
982
+ query?: never;
983
+ $unknown: [string, any];
984
+ }
985
+ interface Visitor<T> {
986
+ query: (value: QueryRecommendationTriggerData) => T;
987
+ _: (name: string, value: any) => T;
988
+ }
989
+ const visit: <T>(value: RecommendationTriggerData, visitor: Visitor<T>) => T;
990
+ }
991
+ /**
992
+ * @public
993
+ * @enum
994
+ */
995
+ export declare const RecommendationSourceType: {
996
+ readonly ISSUE_DETECTION: "ISSUE_DETECTION";
997
+ readonly OTHER: "OTHER";
998
+ readonly RULE_EVALUATION: "RULE_EVALUATION";
999
+ };
1000
+ /**
1001
+ * @public
1002
+ */
1003
+ export type RecommendationSourceType = (typeof RecommendationSourceType)[keyof typeof RecommendationSourceType];
1004
+ /**
1005
+ * @public
1006
+ * @enum
1007
+ */
1008
+ export declare const RecommendationTriggerType: {
1009
+ readonly GENERATIVE: "GENERATIVE";
1010
+ readonly QUERY: "QUERY";
1011
+ };
1012
+ /**
1013
+ * @public
1014
+ */
1015
+ export type RecommendationTriggerType = (typeof RecommendationTriggerType)[keyof typeof RecommendationTriggerType];
1016
+ /**
1017
+ * @public
1018
+ * <p>A recommendation trigger provides context on the event that produced the referenced
1019
+ * recommendations. Recommendations are only referenced in <code>recommendationIds</code> by a
1020
+ * single RecommendationTrigger.</p>
1021
+ */
1022
+ export interface RecommendationTrigger {
1023
+ /**
1024
+ * @public
1025
+ * <p>The identifier of the recommendation trigger.</p>
1026
+ */
1027
+ id: string | undefined;
1028
+ /**
1029
+ * @public
1030
+ * <p>The type of recommendation trigger.</p>
1031
+ */
1032
+ type: RecommendationTriggerType | undefined;
1033
+ /**
1034
+ * @public
1035
+ * <p>The source of the recommendation trigger.</p>
1036
+ * <ul>
1037
+ * <li>
1038
+ * <p>ISSUE_DETECTION: The corresponding recommendations were triggered by a Contact Lens
1039
+ * issue.</p>
1040
+ * </li>
1041
+ * <li>
1042
+ * <p>RULE_EVALUATION: The corresponding recommendations were triggered by a Contact Lens
1043
+ * rule.</p>
1044
+ * </li>
1045
+ * </ul>
1046
+ */
1047
+ source: RecommendationSourceType | undefined;
1048
+ /**
1049
+ * @public
1050
+ * <p>A union type containing information related to the trigger.</p>
1051
+ */
1052
+ data: RecommendationTriggerData | undefined;
1053
+ /**
1054
+ * @public
1055
+ * <p>The identifiers of the recommendations.</p>
1056
+ */
1057
+ recommendationIds: string[] | undefined;
1058
+ }
1059
+ /**
1060
+ * @public
1061
+ */
1062
+ export interface ListAssistantsRequest {
1063
+ /**
1064
+ * @public
1065
+ * <p>The token for the next set of results. Use the value returned in the previous
1066
+ * response in the next request to retrieve the next set of results.</p>
1067
+ */
1068
+ nextToken?: string;
1069
+ /**
1070
+ * @public
1071
+ * <p>The maximum number of results to return per page.</p>
1072
+ */
1073
+ maxResults?: number;
1074
+ }
1075
+ /**
1076
+ * @public
1077
+ * <p>Summary information about the assistant.</p>
1078
+ */
1079
+ export interface AssistantSummary {
1080
+ /**
1081
+ * @public
1082
+ * <p>The identifier of the Amazon Q assistant.</p>
1083
+ */
1084
+ assistantId: string | undefined;
1085
+ /**
1086
+ * @public
1087
+ * <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
1088
+ */
1089
+ assistantArn: string | undefined;
1090
+ /**
1091
+ * @public
1092
+ * <p>The name of the assistant.</p>
1093
+ */
1094
+ name: string | undefined;
1095
+ /**
1096
+ * @public
1097
+ * <p>The type of the assistant.</p>
1098
+ */
1099
+ type: AssistantType | undefined;
1100
+ /**
1101
+ * @public
1102
+ * <p>The status of the assistant.</p>
1103
+ */
1104
+ status: AssistantStatus | undefined;
1105
+ /**
1106
+ * @public
1107
+ * <p>The description of the assistant.</p>
1108
+ */
1109
+ description?: string;
1110
+ /**
1111
+ * @public
1112
+ * <p>The tags used to organize, track, or control access for this resource.</p>
1113
+ */
1114
+ tags?: Record<string, string>;
1115
+ /**
1116
+ * @public
1117
+ * <p>The configuration information for the customer managed key used for encryption. </p>
1118
+ * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
1119
+ * <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
1120
+ * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
1121
+ * key to invoke Amazon Q. To use Amazon Q with chat, the key policy must also allow
1122
+ * <code>kms:Decrypt</code>, <code>kms:GenerateDataKey*</code>, and
1123
+ * <code>kms:DescribeKey</code> permissions to the <code>connect.amazonaws.com</code> service
1124
+ * principal. </p>
1125
+ * <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
1126
+ * your instance</a>.</p>
1127
+ */
1128
+ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
1129
+ /**
1130
+ * @public
1131
+ * <p>The configuration information for the Amazon Q assistant integration.</p>
1132
+ */
1133
+ integrationConfiguration?: AssistantIntegrationConfiguration;
1134
+ /**
1135
+ * @public
1136
+ * <p>The configuration information for the Amazon Q assistant capability. </p>
1137
+ */
1138
+ capabilityConfiguration?: AssistantCapabilityConfiguration;
1139
+ }
1140
+ /**
1141
+ * @public
1142
+ */
1143
+ export interface ListAssistantsResponse {
1144
+ /**
1145
+ * @public
1146
+ * <p>Information about the assistants.</p>
1147
+ */
1148
+ assistantSummaries: AssistantSummary[] | undefined;
1149
+ /**
1150
+ * @public
1151
+ * <p>If there are additional results, this is the token for the next set of results.</p>
1152
+ */
1153
+ nextToken?: string;
1154
+ }
1155
+ /**
1156
+ * @public
1157
+ */
1158
+ export interface NotifyRecommendationsReceivedRequest {
1159
+ /**
1160
+ * @public
1161
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1162
+ */
1163
+ assistantId: string | undefined;
1164
+ /**
1165
+ * @public
1166
+ * <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1167
+ */
1168
+ sessionId: string | undefined;
1169
+ /**
1170
+ * @public
1171
+ * <p>The identifiers of the recommendations.</p>
1172
+ */
1173
+ recommendationIds: string[] | undefined;
1174
+ }
1175
+ /**
1176
+ * @public
1177
+ * <p>An error occurred when creating a recommendation.</p>
1178
+ */
1179
+ export interface NotifyRecommendationsReceivedError {
1180
+ /**
1181
+ * @public
1182
+ * <p>The identifier of the recommendation that is in error.</p>
1183
+ */
1184
+ recommendationId?: string;
1185
+ /**
1186
+ * @public
1187
+ * <p>A recommendation is causing an error.</p>
1188
+ */
1189
+ message?: string;
1190
+ }
1191
+ /**
1192
+ * @public
1193
+ */
1194
+ export interface NotifyRecommendationsReceivedResponse {
1195
+ /**
1196
+ * @public
1197
+ * <p>The identifiers of the recommendations.</p>
1198
+ */
1199
+ recommendationIds?: string[];
1200
+ /**
1201
+ * @public
1202
+ * <p>The identifiers of recommendations that are causing errors.</p>
1203
+ */
1204
+ errors?: NotifyRecommendationsReceivedError[];
1205
+ }
1206
+ /**
1207
+ * @public
1208
+ * @enum
1209
+ */
1210
+ export declare const QueryConditionComparisonOperator: {
1211
+ readonly EQUALS: "EQUALS";
1212
+ };
1213
+ /**
1214
+ * @public
1215
+ */
1216
+ export type QueryConditionComparisonOperator = (typeof QueryConditionComparisonOperator)[keyof typeof QueryConditionComparisonOperator];
1217
+ /**
1218
+ * @public
1219
+ * @enum
1220
+ */
1221
+ export declare const QueryConditionFieldName: {
1222
+ readonly RESULT_TYPE: "RESULT_TYPE";
1223
+ };
1224
+ /**
1225
+ * @public
1226
+ */
1227
+ export type QueryConditionFieldName = (typeof QueryConditionFieldName)[keyof typeof QueryConditionFieldName];
1228
+ /**
1229
+ * @public
1230
+ * <p>The condition for the query.</p>
1231
+ */
1232
+ export interface QueryConditionItem {
1233
+ /**
1234
+ * @public
1235
+ * <p> The name of the field for query condition to query on.</p>
1236
+ */
1237
+ field: QueryConditionFieldName | undefined;
1238
+ /**
1239
+ * @public
1240
+ * <p>The comparison operator for query condition to query on.</p>
1241
+ */
1242
+ comparator: QueryConditionComparisonOperator | undefined;
1243
+ /**
1244
+ * @public
1245
+ * <p>The value for the query condition to query on.</p>
1246
+ */
1247
+ value: string | undefined;
1248
+ }
1249
+ /**
1250
+ * @public
1251
+ * <p>Information about how to query content.</p>
1252
+ */
1253
+ export type QueryCondition = QueryCondition.SingleMember | QueryCondition.$UnknownMember;
1254
+ /**
1255
+ * @public
1256
+ */
1257
+ export declare namespace QueryCondition {
1258
+ /**
1259
+ * @public
1260
+ * <p>The condition for the query.</p>
1261
+ */
1262
+ interface SingleMember {
1263
+ single: QueryConditionItem;
1264
+ $unknown?: never;
1265
+ }
1266
+ /**
1267
+ * @public
1268
+ */
1269
+ interface $UnknownMember {
1270
+ single?: never;
1271
+ $unknown: [string, any];
1272
+ }
1273
+ interface Visitor<T> {
1274
+ single: (value: QueryConditionItem) => T;
1275
+ _: (name: string, value: any) => T;
1276
+ }
1277
+ const visit: <T>(value: QueryCondition, visitor: Visitor<T>) => T;
1278
+ }
1279
+ /**
1280
+ * @public
1281
+ */
1282
+ export interface QueryAssistantRequest {
1283
+ /**
1284
+ * @public
1285
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1286
+ */
1287
+ assistantId: string | undefined;
1288
+ /**
1289
+ * @public
1290
+ * <p>The text to search for.</p>
1291
+ */
1292
+ queryText: string | undefined;
1293
+ /**
1294
+ * @public
1295
+ * <p>The token for the next set of results. Use the value returned in the previous
1296
+ * response in the next request to retrieve the next set of results.</p>
1297
+ */
1298
+ nextToken?: string;
1299
+ /**
1300
+ * @public
1301
+ * <p>The maximum number of results to return per page.</p>
1302
+ */
1303
+ maxResults?: number;
1304
+ /**
1305
+ * @public
1306
+ * <p>The identifier of the Amazon Q session. Can be either the ID or the ARN. URLs cannot
1307
+ * contain the ARN.</p>
1308
+ */
1309
+ sessionId?: string;
1310
+ /**
1311
+ * @public
1312
+ * <p>Information about how to query content.</p>
1313
+ */
1314
+ queryCondition?: QueryCondition[];
1315
+ }
1316
+ /**
1317
+ * @public
1318
+ * @enum
1319
+ */
1320
+ export declare const QueryResultType: {
1321
+ readonly GENERATIVE_ANSWER: "GENERATIVE_ANSWER";
1322
+ readonly KNOWLEDGE_CONTENT: "KNOWLEDGE_CONTENT";
1323
+ };
1324
+ /**
1325
+ * @public
1326
+ */
1327
+ export type QueryResultType = (typeof QueryResultType)[keyof typeof QueryResultType];
1328
+ /**
1329
+ * @public
1330
+ * <p>The request reached the service more than 15 minutes after the date stamp on the request
1331
+ * or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or
1332
+ * the date stamp on the request is more than 15 minutes in the future.</p>
1333
+ */
1334
+ export declare class RequestTimeoutException extends __BaseException {
1335
+ readonly name: "RequestTimeoutException";
1336
+ readonly $fault: "client";
1337
+ $retryable: {};
1338
+ /**
1339
+ * @internal
1340
+ */
1341
+ constructor(opts: __ExceptionOptionType<RequestTimeoutException, __BaseException>);
1342
+ }
1343
+ /**
1344
+ * @public
1345
+ * @enum
1346
+ */
1347
+ export declare const FilterField: {
1348
+ readonly NAME: "NAME";
1349
+ };
1350
+ /**
1351
+ * @public
1352
+ */
1353
+ export type FilterField = (typeof FilterField)[keyof typeof FilterField];
1354
+ /**
1355
+ * @public
1356
+ * @enum
1357
+ */
1358
+ export declare const FilterOperator: {
1359
+ readonly EQUALS: "EQUALS";
1360
+ };
1361
+ /**
1362
+ * @public
1363
+ */
1364
+ export type FilterOperator = (typeof FilterOperator)[keyof typeof FilterOperator];
1365
+ /**
1366
+ * @public
1367
+ * <p>A search filter.</p>
1368
+ */
1369
+ export interface Filter {
1370
+ /**
1371
+ * @public
1372
+ * <p>The field on which to filter.</p>
1373
+ */
1374
+ field: FilterField | undefined;
1375
+ /**
1376
+ * @public
1377
+ * <p>The operator to use for comparing the field’s value with the provided value.</p>
1378
+ */
1379
+ operator: FilterOperator | undefined;
1380
+ /**
1381
+ * @public
1382
+ * <p>The desired field value on which to filter.</p>
1383
+ */
1384
+ value: string | undefined;
1385
+ }
1386
+ /**
1387
+ * @public
1388
+ * <p>The search expression.</p>
1389
+ */
1390
+ export interface SearchExpression {
1391
+ /**
1392
+ * @public
1393
+ * <p>The search expression filters.</p>
1394
+ */
1395
+ filters: Filter[] | undefined;
1396
+ }
1397
+ /**
1398
+ * @public
1399
+ */
1400
+ export interface SearchSessionsRequest {
1401
+ /**
1402
+ * @public
1403
+ * <p>The token for the next set of results. Use the value returned in the previous
1404
+ * response in the next request to retrieve the next set of results.</p>
1405
+ */
1406
+ nextToken?: string;
1407
+ /**
1408
+ * @public
1409
+ * <p>The maximum number of results to return per page.</p>
1410
+ */
1411
+ maxResults?: number;
1412
+ /**
1413
+ * @public
1414
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1415
+ */
1416
+ assistantId: string | undefined;
1417
+ /**
1418
+ * @public
1419
+ * <p>The search expression to filter results.</p>
1420
+ */
1421
+ searchExpression: SearchExpression | undefined;
1422
+ }
1423
+ /**
1424
+ * @public
1425
+ * <p>Summary information about the session.</p>
1426
+ */
1427
+ export interface SessionSummary {
1428
+ /**
1429
+ * @public
1430
+ * <p>The identifier of the session.</p>
1431
+ */
1432
+ sessionId: string | undefined;
1433
+ /**
1434
+ * @public
1435
+ * <p>The Amazon Resource Name (ARN) of the session.</p>
1436
+ */
1437
+ sessionArn: string | undefined;
1438
+ /**
1439
+ * @public
1440
+ * <p>The identifier of the Amazon Q assistant.</p>
1441
+ */
1442
+ assistantId: string | undefined;
1443
+ /**
1444
+ * @public
1445
+ * <p>The Amazon Resource Name (ARN) of the Amazon Q assistant.</p>
1446
+ */
1447
+ assistantArn: string | undefined;
1448
+ }
1449
+ /**
1450
+ * @public
1451
+ */
1452
+ export interface SearchSessionsResponse {
1453
+ /**
1454
+ * @public
1455
+ * <p>Summary information about the sessions.</p>
1456
+ */
1457
+ sessionSummaries: SessionSummary[] | undefined;
1458
+ /**
1459
+ * @public
1460
+ * <p>If there are additional results, this is the token for the next set of results.</p>
1461
+ */
1462
+ nextToken?: string;
1463
+ }
1464
+ /**
1465
+ * @public
1466
+ */
1467
+ export interface CreateSessionRequest {
1468
+ /**
1469
+ * @public
1470
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1471
+ * request. If not provided, the Amazon Web Services
1472
+ * SDK populates this field. For more information about idempotency, see
1473
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1474
+ */
1475
+ clientToken?: string;
1476
+ /**
1477
+ * @public
1478
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1479
+ */
1480
+ assistantId: string | undefined;
1481
+ /**
1482
+ * @public
1483
+ * <p>The name of the session.</p>
1484
+ */
1485
+ name: string | undefined;
1486
+ /**
1487
+ * @public
1488
+ * <p>The description.</p>
1489
+ */
1490
+ description?: string;
1491
+ /**
1492
+ * @public
1493
+ * <p>The tags used to organize, track, or control access for this resource.</p>
1494
+ */
1495
+ tags?: Record<string, string>;
1496
+ }
1497
+ /**
1498
+ * @public
1499
+ * <p>The configuration information for the session integration.</p>
1500
+ */
1501
+ export interface SessionIntegrationConfiguration {
1502
+ /**
1503
+ * @public
1504
+ * <p>The Amazon Resource Name (ARN) of the integrated Amazon SNS topic used for streaming chat messages.</p>
1505
+ */
1506
+ topicIntegrationArn?: string;
1507
+ }
1508
+ /**
1509
+ * @public
1510
+ * <p>Information about the session.</p>
1511
+ */
1512
+ export interface SessionData {
1513
+ /**
1514
+ * @public
1515
+ * <p>The Amazon Resource Name (ARN) of the session.</p>
1516
+ */
1517
+ sessionArn: string | undefined;
1518
+ /**
1519
+ * @public
1520
+ * <p>The identifier of the session.</p>
1521
+ */
1522
+ sessionId: string | undefined;
1523
+ /**
1524
+ * @public
1525
+ * <p>The name of the session.</p>
1526
+ */
1527
+ name: string | undefined;
1528
+ /**
1529
+ * @public
1530
+ * <p>The description of the session.</p>
1531
+ */
1532
+ description?: string;
1533
+ /**
1534
+ * @public
1535
+ * <p>The tags used to organize, track, or control access for this resource.</p>
1536
+ */
1537
+ tags?: Record<string, string>;
1538
+ /**
1539
+ * @public
1540
+ * <p>The configuration information for the session integration.</p>
1541
+ */
1542
+ integrationConfiguration?: SessionIntegrationConfiguration;
1543
+ }
1544
+ /**
1545
+ * @public
1546
+ */
1547
+ export interface CreateSessionResponse {
1548
+ /**
1549
+ * @public
1550
+ * <p>The session.</p>
1551
+ */
1552
+ session?: SessionData;
1553
+ }
1554
+ /**
1555
+ * @public
1556
+ */
1557
+ export interface GetSessionRequest {
1558
+ /**
1559
+ * @public
1560
+ * <p>The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1561
+ */
1562
+ assistantId: string | undefined;
1563
+ /**
1564
+ * @public
1565
+ * <p>The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1566
+ */
1567
+ sessionId: string | undefined;
1568
+ }
1569
+ /**
1570
+ * @public
1571
+ */
1572
+ export interface GetSessionResponse {
1573
+ /**
1574
+ * @public
1575
+ * <p>The session.</p>
1576
+ */
1577
+ session?: SessionData;
1578
+ }
1579
+ /**
1580
+ * @public
1581
+ * <p>The configuration information of the Amazon Connect data source.</p>
1582
+ */
1583
+ export interface ConnectConfiguration {
1584
+ /**
1585
+ * @public
1586
+ * <p>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</p>
1587
+ */
1588
+ instanceId?: string;
1589
+ }
1590
+ /**
1591
+ * @public
1592
+ * <p>The configuration information of the external data source.</p>
1593
+ */
1594
+ export type Configuration = Configuration.ConnectConfigurationMember | Configuration.$UnknownMember;
1595
+ /**
1596
+ * @public
1597
+ */
1598
+ export declare namespace Configuration {
1599
+ /**
1600
+ * @public
1601
+ * <p>The configuration information of the Amazon Connect data source.</p>
1602
+ */
1603
+ interface ConnectConfigurationMember {
1604
+ connectConfiguration: ConnectConfiguration;
1605
+ $unknown?: never;
1606
+ }
1607
+ /**
1608
+ * @public
1609
+ */
1610
+ interface $UnknownMember {
1611
+ connectConfiguration?: never;
1612
+ $unknown: [string, any];
1613
+ }
1614
+ interface Visitor<T> {
1615
+ connectConfiguration: (value: ConnectConfiguration) => T;
1616
+ _: (name: string, value: any) => T;
1617
+ }
1618
+ const visit: <T>(value: Configuration, visitor: Visitor<T>) => T;
1619
+ }
1620
+ /**
1621
+ * @public
1622
+ */
1623
+ export interface CreateContentRequest {
1624
+ /**
1625
+ * @public
1626
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1627
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1628
+ */
1629
+ knowledgeBaseId: string | undefined;
1630
+ /**
1631
+ * @public
1632
+ * <p>The name of the content. Each piece of content in a knowledge base must have a unique
1633
+ * name. You can retrieve a piece of content using only its knowledge base and its name with the
1634
+ * <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_SearchContent.html">SearchContent</a> API.</p>
1635
+ */
1636
+ name: string | undefined;
1637
+ /**
1638
+ * @public
1639
+ * <p>The title of the content. If not set, the title is equal to the name.</p>
1640
+ */
1641
+ title?: string;
1642
+ /**
1643
+ * @public
1644
+ * <p>The URI you want to use for the article. If the knowledge base has a templateUri, setting
1645
+ * this argument overrides it for this piece of content.</p>
1646
+ */
1647
+ overrideLinkOutUri?: string;
1648
+ /**
1649
+ * @public
1650
+ * <p>A key/value map to store attributes without affecting tagging or recommendations.
1651
+ * For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.</p>
1652
+ */
1653
+ metadata?: Record<string, string>;
1654
+ /**
1655
+ * @public
1656
+ * <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
1657
+ */
1658
+ uploadId: string | undefined;
1659
+ /**
1660
+ * @public
1661
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
1662
+ * request. If not provided, the Amazon Web Services
1663
+ * SDK populates this field. For more information about idempotency, see
1664
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
1665
+ */
1666
+ clientToken?: string;
1667
+ /**
1668
+ * @public
1669
+ * <p>The tags used to organize, track, or control access for this resource.</p>
1670
+ */
1671
+ tags?: Record<string, string>;
1672
+ }
1673
+ /**
1674
+ * @public
1675
+ * @enum
1676
+ */
1677
+ export declare const ContentStatus: {
1678
+ readonly ACTIVE: "ACTIVE";
1679
+ readonly CREATE_FAILED: "CREATE_FAILED";
1680
+ readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
1681
+ readonly DELETED: "DELETED";
1682
+ readonly DELETE_FAILED: "DELETE_FAILED";
1683
+ readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
1684
+ readonly UPDATE_FAILED: "UPDATE_FAILED";
1685
+ };
1686
+ /**
1687
+ * @public
1688
+ */
1689
+ export type ContentStatus = (typeof ContentStatus)[keyof typeof ContentStatus];
1690
+ /**
1691
+ * @public
1692
+ * <p>Information about the content.</p>
1693
+ */
1694
+ export interface ContentData {
1695
+ /**
1696
+ * @public
1697
+ * <p>The Amazon Resource Name (ARN) of the content.</p>
1698
+ */
1699
+ contentArn: string | undefined;
1700
+ /**
1701
+ * @public
1702
+ * <p>The identifier of the content.</p>
1703
+ */
1704
+ contentId: string | undefined;
1705
+ /**
1706
+ * @public
1707
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
1708
+ */
1709
+ knowledgeBaseArn: string | undefined;
1710
+ /**
1711
+ * @public
1712
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1713
+ * base if you're storing Amazon Q Content resource to it.</p>
1714
+ */
1715
+ knowledgeBaseId: string | undefined;
1716
+ /**
1717
+ * @public
1718
+ * <p>The name of the content.</p>
1719
+ */
1720
+ name: string | undefined;
1721
+ /**
1722
+ * @public
1723
+ * <p>The identifier of the content revision.</p>
1724
+ */
1725
+ revisionId: string | undefined;
1726
+ /**
1727
+ * @public
1728
+ * <p>The title of the content.</p>
1729
+ */
1730
+ title: string | undefined;
1731
+ /**
1732
+ * @public
1733
+ * <p>The media type of the content.</p>
1734
+ */
1735
+ contentType: string | undefined;
1736
+ /**
1737
+ * @public
1738
+ * <p>The status of the content.</p>
1739
+ */
1740
+ status: ContentStatus | undefined;
1741
+ /**
1742
+ * @public
1743
+ * <p>A key/value map to store attributes without affecting tagging or recommendations.
1744
+ * For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.</p>
1745
+ */
1746
+ metadata: Record<string, string> | undefined;
1747
+ /**
1748
+ * @public
1749
+ * <p>The tags used to organize, track, or control access for this resource.</p>
1750
+ */
1751
+ tags?: Record<string, string>;
1752
+ /**
1753
+ * @public
1754
+ * <p>The URI of the content.</p>
1755
+ */
1756
+ linkOutUri?: string;
1757
+ /**
1758
+ * @public
1759
+ * <p>The URL of the content.</p>
1760
+ */
1761
+ url: string | undefined;
1762
+ /**
1763
+ * @public
1764
+ * <p>The expiration time of the URL as an epoch timestamp.</p>
1765
+ */
1766
+ urlExpiry: Date | undefined;
1767
+ }
1768
+ /**
1769
+ * @public
1770
+ */
1771
+ export interface CreateContentResponse {
1772
+ /**
1773
+ * @public
1774
+ * <p>The content.</p>
1775
+ */
1776
+ content?: ContentData;
1777
+ }
1778
+ /**
1779
+ * @public
1780
+ */
1781
+ export interface DeleteContentRequest {
1782
+ /**
1783
+ * @public
1784
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1785
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1786
+ */
1787
+ knowledgeBaseId: string | undefined;
1788
+ /**
1789
+ * @public
1790
+ * <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1791
+ */
1792
+ contentId: string | undefined;
1793
+ }
1794
+ /**
1795
+ * @public
1796
+ */
1797
+ export interface DeleteContentResponse {
1798
+ }
1799
+ /**
1800
+ * @public
1801
+ */
1802
+ export interface GetContentRequest {
1803
+ /**
1804
+ * @public
1805
+ * <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1806
+ */
1807
+ contentId: string | undefined;
1808
+ /**
1809
+ * @public
1810
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1811
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1812
+ */
1813
+ knowledgeBaseId: string | undefined;
1814
+ }
1815
+ /**
1816
+ * @public
1817
+ */
1818
+ export interface GetContentResponse {
1819
+ /**
1820
+ * @public
1821
+ * <p>The content.</p>
1822
+ */
1823
+ content?: ContentData;
1824
+ }
1825
+ /**
1826
+ * @public
1827
+ */
1828
+ export interface GetContentSummaryRequest {
1829
+ /**
1830
+ * @public
1831
+ * <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1832
+ */
1833
+ contentId: string | undefined;
1834
+ /**
1835
+ * @public
1836
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1837
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1838
+ */
1839
+ knowledgeBaseId: string | undefined;
1840
+ }
1841
+ /**
1842
+ * @public
1843
+ * <p>Summary information about the content.</p>
1844
+ */
1845
+ export interface ContentSummary {
1846
+ /**
1847
+ * @public
1848
+ * <p>The Amazon Resource Name (ARN) of the content.</p>
1849
+ */
1850
+ contentArn: string | undefined;
1851
+ /**
1852
+ * @public
1853
+ * <p>The identifier of the content.</p>
1854
+ */
1855
+ contentId: string | undefined;
1856
+ /**
1857
+ * @public
1858
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
1859
+ */
1860
+ knowledgeBaseArn: string | undefined;
1861
+ /**
1862
+ * @public
1863
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1864
+ * base if you're storing Amazon Q Content resource to it.</p>
1865
+ */
1866
+ knowledgeBaseId: string | undefined;
1867
+ /**
1868
+ * @public
1869
+ * <p>The name of the content.</p>
1870
+ */
1871
+ name: string | undefined;
1872
+ /**
1873
+ * @public
1874
+ * <p>The identifier of the revision of the content.</p>
1875
+ */
1876
+ revisionId: string | undefined;
1877
+ /**
1878
+ * @public
1879
+ * <p>The title of the content.</p>
1880
+ */
1881
+ title: string | undefined;
1882
+ /**
1883
+ * @public
1884
+ * <p>The media type of the content.</p>
1885
+ */
1886
+ contentType: string | undefined;
1887
+ /**
1888
+ * @public
1889
+ * <p>The status of the content.</p>
1890
+ */
1891
+ status: ContentStatus | undefined;
1892
+ /**
1893
+ * @public
1894
+ * <p>A key/value map to store attributes without affecting tagging or recommendations.
1895
+ * For example, when synchronizing data between an external system and Amazon Q, you can store an external version identifier as metadata to utilize for determining drift.</p>
1896
+ */
1897
+ metadata: Record<string, string> | undefined;
1898
+ /**
1899
+ * @public
1900
+ * <p>The tags used to organize, track, or control access for this resource.</p>
1901
+ */
1902
+ tags?: Record<string, string>;
1903
+ }
1904
+ /**
1905
+ * @public
1906
+ */
1907
+ export interface GetContentSummaryResponse {
1908
+ /**
1909
+ * @public
1910
+ * <p>The content summary.</p>
1911
+ */
1912
+ contentSummary?: ContentSummary;
1913
+ }
1914
+ /**
1915
+ * @public
1916
+ */
1917
+ export interface ListContentsRequest {
1918
+ /**
1919
+ * @public
1920
+ * <p>The token for the next set of results. Use the value returned in the previous
1921
+ * response in the next request to retrieve the next set of results.</p>
1922
+ */
1923
+ nextToken?: string;
1924
+ /**
1925
+ * @public
1926
+ * <p>The maximum number of results to return per page.</p>
1927
+ */
1928
+ maxResults?: number;
1929
+ /**
1930
+ * @public
1931
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1932
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1933
+ */
1934
+ knowledgeBaseId: string | undefined;
1935
+ }
1936
+ /**
1937
+ * @public
1938
+ */
1939
+ export interface ListContentsResponse {
1940
+ /**
1941
+ * @public
1942
+ * <p>Information about the content.</p>
1943
+ */
1944
+ contentSummaries: ContentSummary[] | undefined;
1945
+ /**
1946
+ * @public
1947
+ * <p>If there are additional results, this is the token for the next set of results.</p>
1948
+ */
1949
+ nextToken?: string;
1950
+ }
1951
+ /**
1952
+ * @public
1953
+ * <p>The provided <code>revisionId</code> does not match, indicating the content has been
1954
+ * modified since it was last read.</p>
1955
+ */
1956
+ export declare class PreconditionFailedException extends __BaseException {
1957
+ readonly name: "PreconditionFailedException";
1958
+ readonly $fault: "client";
1959
+ /**
1960
+ * @internal
1961
+ */
1962
+ constructor(opts: __ExceptionOptionType<PreconditionFailedException, __BaseException>);
1963
+ }
1964
+ /**
1965
+ * @public
1966
+ */
1967
+ export interface UpdateContentRequest {
1968
+ /**
1969
+ * @public
1970
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
1971
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN</p>
1972
+ */
1973
+ knowledgeBaseId: string | undefined;
1974
+ /**
1975
+ * @public
1976
+ * <p>The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
1977
+ */
1978
+ contentId: string | undefined;
1979
+ /**
1980
+ * @public
1981
+ * <p>The <code>revisionId</code> of the content resource to update, taken from an earlier call
1982
+ * to <code>GetContent</code>, <code>GetContentSummary</code>, <code>SearchContent</code>, or
1983
+ * <code>ListContents</code>. If included, this argument acts as an optimistic lock to ensure
1984
+ * content was not modified since it was last read. If it has been modified, this API throws a
1985
+ * <code>PreconditionFailedException</code>.</p>
1986
+ */
1987
+ revisionId?: string;
1988
+ /**
1989
+ * @public
1990
+ * <p>The title of the content.</p>
1991
+ */
1992
+ title?: string;
1993
+ /**
1994
+ * @public
1995
+ * <p>The URI for the article. If the knowledge base has a templateUri, setting this argument
1996
+ * overrides it for this piece of content. To remove an existing <code>overrideLinkOurUri</code>,
1997
+ * exclude this argument and set <code>removeOverrideLinkOutUri</code> to true.</p>
1998
+ */
1999
+ overrideLinkOutUri?: string;
2000
+ /**
2001
+ * @public
2002
+ * <p>Unset the existing <code>overrideLinkOutUri</code> if it exists.</p>
2003
+ */
2004
+ removeOverrideLinkOutUri?: boolean;
2005
+ /**
2006
+ * @public
2007
+ * <p>A key/value map to store attributes without affecting tagging or recommendations. For
2008
+ * example, when synchronizing data between an external system and Amazon Q, you can store an
2009
+ * external version identifier as metadata to utilize for determining drift.</p>
2010
+ */
2011
+ metadata?: Record<string, string>;
2012
+ /**
2013
+ * @public
2014
+ * <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.
2015
+ * </p>
2016
+ */
2017
+ uploadId?: string;
2018
+ }
2019
+ /**
2020
+ * @public
2021
+ */
2022
+ export interface UpdateContentResponse {
2023
+ /**
2024
+ * @public
2025
+ * <p>The content.</p>
2026
+ */
2027
+ content?: ContentData;
2028
+ }
2029
+ /**
2030
+ * @public
2031
+ * @enum
2032
+ */
2033
+ export declare const KnowledgeBaseType: {
2034
+ readonly CUSTOM: "CUSTOM";
2035
+ readonly EXTERNAL: "EXTERNAL";
2036
+ readonly QUICK_RESPONSES: "QUICK_RESPONSES";
2037
+ };
2038
+ /**
2039
+ * @public
2040
+ */
2041
+ export type KnowledgeBaseType = (typeof KnowledgeBaseType)[keyof typeof KnowledgeBaseType];
2042
+ /**
2043
+ * @public
2044
+ * <p>Information about how to render the content.</p>
2045
+ */
2046
+ export interface RenderingConfiguration {
2047
+ /**
2048
+ * @public
2049
+ * <p>A URI template containing exactly one variable in <code>$\{variableName\} </code>format.
2050
+ * This can only be set for <code>EXTERNAL</code> knowledge bases. For Salesforce, ServiceNow,
2051
+ * and Zendesk, the variable must be one of the following:</p>
2052
+ * <ul>
2053
+ * <li>
2054
+ * <p>Salesforce: <code>Id</code>, <code>ArticleNumber</code>, <code>VersionNumber</code>,
2055
+ * <code>Title</code>, <code>PublishStatus</code>, or <code>IsDeleted</code>
2056
+ * </p>
2057
+ * </li>
2058
+ * <li>
2059
+ * <p>ServiceNow: <code>number</code>, <code>short_description</code>,
2060
+ * <code>sys_mod_count</code>, <code>workflow_state</code>, or <code>active</code>
2061
+ * </p>
2062
+ * </li>
2063
+ * <li>
2064
+ * <p>Zendesk: <code>id</code>, <code>title</code>, <code>updated_at</code>, or
2065
+ * <code>draft</code>
2066
+ * </p>
2067
+ * </li>
2068
+ * </ul>
2069
+ * <p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/amazon-q-connect/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
2070
+ */
2071
+ templateUri?: string;
2072
+ }
2073
+ /**
2074
+ * @public
2075
+ * <p>Configuration information about the external data source.</p>
2076
+ */
2077
+ export type SourceConfiguration = SourceConfiguration.AppIntegrationsMember | SourceConfiguration.$UnknownMember;
2078
+ /**
2079
+ * @public
2080
+ */
2081
+ export declare namespace SourceConfiguration {
2082
+ /**
2083
+ * @public
2084
+ * <p>Configuration information for Amazon AppIntegrations to automatically ingest content.</p>
2085
+ */
2086
+ interface AppIntegrationsMember {
2087
+ appIntegrations: AppIntegrationsConfiguration;
2088
+ $unknown?: never;
2089
+ }
2090
+ /**
2091
+ * @public
2092
+ */
2093
+ interface $UnknownMember {
2094
+ appIntegrations?: never;
2095
+ $unknown: [string, any];
2096
+ }
2097
+ interface Visitor<T> {
2098
+ appIntegrations: (value: AppIntegrationsConfiguration) => T;
2099
+ _: (name: string, value: any) => T;
2100
+ }
2101
+ const visit: <T>(value: SourceConfiguration, visitor: Visitor<T>) => T;
2102
+ }
2103
+ /**
2104
+ * @public
2105
+ */
2106
+ export interface CreateKnowledgeBaseRequest {
2107
+ /**
2108
+ * @public
2109
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2110
+ * request. If not provided, the Amazon Web Services
2111
+ * SDK populates this field. For more information about idempotency, see
2112
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
2113
+ */
2114
+ clientToken?: string;
2115
+ /**
2116
+ * @public
2117
+ * <p>The name of the knowledge base.</p>
2118
+ */
2119
+ name: string | undefined;
2120
+ /**
2121
+ * @public
2122
+ * <p>The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content.
2123
+ * EXTERNAL knowledge bases support integrations with third-party systems whose content is
2124
+ * synchronized automatically. </p>
2125
+ */
2126
+ knowledgeBaseType: KnowledgeBaseType | undefined;
2127
+ /**
2128
+ * @public
2129
+ * <p>The source of the knowledge base content. Only set this argument for EXTERNAL knowledge
2130
+ * bases.</p>
2131
+ */
2132
+ sourceConfiguration?: SourceConfiguration;
2133
+ /**
2134
+ * @public
2135
+ * <p>Information about how to render the content.</p>
2136
+ */
2137
+ renderingConfiguration?: RenderingConfiguration;
2138
+ /**
2139
+ * @public
2140
+ * <p>The configuration information for the customer managed key used for encryption. </p>
2141
+ * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
2142
+ * <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
2143
+ * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
2144
+ * key to invoke Amazon Q.</p>
2145
+ * <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
2146
+ * your instance</a>.</p>
2147
+ */
2148
+ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
2149
+ /**
2150
+ * @public
2151
+ * <p>The description.</p>
2152
+ */
2153
+ description?: string;
2154
+ /**
2155
+ * @public
2156
+ * <p>The tags used to organize, track, or control access for this resource.</p>
2157
+ */
2158
+ tags?: Record<string, string>;
2159
+ }
2160
+ /**
2161
+ * @public
2162
+ * @enum
2163
+ */
2164
+ export declare const KnowledgeBaseStatus: {
2165
+ readonly ACTIVE: "ACTIVE";
2166
+ readonly CREATE_FAILED: "CREATE_FAILED";
2167
+ readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
2168
+ readonly DELETED: "DELETED";
2169
+ readonly DELETE_FAILED: "DELETE_FAILED";
2170
+ readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
2171
+ };
2172
+ /**
2173
+ * @public
2174
+ */
2175
+ export type KnowledgeBaseStatus = (typeof KnowledgeBaseStatus)[keyof typeof KnowledgeBaseStatus];
2176
+ /**
2177
+ * @public
2178
+ * <p>Information about the knowledge base.</p>
2179
+ */
2180
+ export interface KnowledgeBaseData {
2181
+ /**
2182
+ * @public
2183
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2184
+ * base if you're storing Amazon Q Content resource to it.</p>
2185
+ */
2186
+ knowledgeBaseId: string | undefined;
2187
+ /**
2188
+ * @public
2189
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
2190
+ */
2191
+ knowledgeBaseArn: string | undefined;
2192
+ /**
2193
+ * @public
2194
+ * <p>The name of the knowledge base.</p>
2195
+ */
2196
+ name: string | undefined;
2197
+ /**
2198
+ * @public
2199
+ * <p>The type of knowledge base.</p>
2200
+ */
2201
+ knowledgeBaseType: KnowledgeBaseType | undefined;
2202
+ /**
2203
+ * @public
2204
+ * <p>The status of the knowledge base.</p>
2205
+ */
2206
+ status: KnowledgeBaseStatus | undefined;
2207
+ /**
2208
+ * @public
2209
+ * <p>An epoch timestamp indicating the most recent content modification inside the knowledge
2210
+ * base. If no content exists in a knowledge base, this value is unset.</p>
2211
+ */
2212
+ lastContentModificationTime?: Date;
2213
+ /**
2214
+ * @public
2215
+ * <p>Source configuration information about the knowledge base.</p>
2216
+ */
2217
+ sourceConfiguration?: SourceConfiguration;
2218
+ /**
2219
+ * @public
2220
+ * <p>Information about how to render the content.</p>
2221
+ */
2222
+ renderingConfiguration?: RenderingConfiguration;
2223
+ /**
2224
+ * @public
2225
+ * <p>The configuration information for the customer managed key used for encryption. </p>
2226
+ * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
2227
+ * <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
2228
+ * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
2229
+ * key to invoke Amazon Q. </p>
2230
+ * <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
2231
+ * your instance</a>.</p>
2232
+ */
2233
+ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
2234
+ /**
2235
+ * @public
2236
+ * <p>The description.</p>
2237
+ */
2238
+ description?: string;
2239
+ /**
2240
+ * @public
2241
+ * <p>The tags used to organize, track, or control access for this resource.</p>
2242
+ */
2243
+ tags?: Record<string, string>;
2244
+ }
2245
+ /**
2246
+ * @public
2247
+ */
2248
+ export interface CreateKnowledgeBaseResponse {
2249
+ /**
2250
+ * @public
2251
+ * <p>The knowledge base.</p>
2252
+ */
2253
+ knowledgeBase?: KnowledgeBaseData;
2254
+ }
2255
+ /**
2256
+ * @public
2257
+ * <p>The container of quick response data.</p>
2258
+ */
2259
+ export type QuickResponseDataProvider = QuickResponseDataProvider.ContentMember | QuickResponseDataProvider.$UnknownMember;
2260
+ /**
2261
+ * @public
2262
+ */
2263
+ export declare namespace QuickResponseDataProvider {
2264
+ /**
2265
+ * @public
2266
+ * <p>The content of the quick response.</p>
2267
+ */
2268
+ interface ContentMember {
2269
+ content: string;
2270
+ $unknown?: never;
2271
+ }
2272
+ /**
2273
+ * @public
2274
+ */
2275
+ interface $UnknownMember {
2276
+ content?: never;
2277
+ $unknown: [string, any];
2278
+ }
2279
+ interface Visitor<T> {
2280
+ content: (value: string) => T;
2281
+ _: (name: string, value: any) => T;
2282
+ }
2283
+ const visit: <T>(value: QuickResponseDataProvider, visitor: Visitor<T>) => T;
2284
+ }
2285
+ /**
2286
+ * @public
2287
+ * <p>The configuration information of the grouping of Amazon Q users.</p>
2288
+ */
2289
+ export interface GroupingConfiguration {
2290
+ /**
2291
+ * @public
2292
+ * <p>The criteria used for grouping Amazon Q users.</p>
2293
+ * <p>The following is the list of supported criteria values.</p>
2294
+ * <ul>
2295
+ * <li>
2296
+ * <p>
2297
+ * <code>RoutingProfileArn</code>: Grouping the users by their <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profile ARN</a>. User should have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchRoutingProfiles.html">SearchRoutingProfile</a> and
2298
+ * <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeRoutingProfile.html">DescribeRoutingProfile</a> permissions when setting criteria to this value.</p>
2299
+ * </li>
2300
+ * </ul>
2301
+ */
2302
+ criteria?: string;
2303
+ /**
2304
+ * @public
2305
+ * <p>The list of values that define different groups of Amazon Q users.</p>
2306
+ * <ul>
2307
+ * <li>
2308
+ * <p>When setting <code>criteria</code> to <code>RoutingProfileArn</code>, you need to provide a list of
2309
+ * ARNs of <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_RoutingProfile.html">Amazon Connect routing profiles</a> as values of this parameter.</p>
2310
+ * </li>
2311
+ * </ul>
2312
+ */
2313
+ values?: string[];
2314
+ }
2315
+ /**
2316
+ * @public
2317
+ */
2318
+ export interface CreateQuickResponseRequest {
2319
+ /**
2320
+ * @public
2321
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2322
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2323
+ */
2324
+ knowledgeBaseId: string | undefined;
2325
+ /**
2326
+ * @public
2327
+ * <p>The name of the quick response.</p>
2328
+ */
2329
+ name: string | undefined;
2330
+ /**
2331
+ * @public
2332
+ * <p>The content of the quick response.</p>
2333
+ */
2334
+ content: QuickResponseDataProvider | undefined;
2335
+ /**
2336
+ * @public
2337
+ * <p>The media type of the quick response content.</p>
2338
+ * <ul>
2339
+ * <li>
2340
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for a quick response written in plain text.</p>
2341
+ * </li>
2342
+ * <li>
2343
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for a quick response written in richtext.</p>
2344
+ * </li>
2345
+ * </ul>
2346
+ */
2347
+ contentType?: string;
2348
+ /**
2349
+ * @public
2350
+ * <p>The configuration information of the user groups that the quick response is accessible to.</p>
2351
+ */
2352
+ groupingConfiguration?: GroupingConfiguration;
2353
+ /**
2354
+ * @public
2355
+ * <p>The description of the quick response.</p>
2356
+ */
2357
+ description?: string;
2358
+ /**
2359
+ * @public
2360
+ * <p>The shortcut key of the quick response. The value should be unique across the
2361
+ * knowledge base.
2362
+ * </p>
2363
+ */
2364
+ shortcutKey?: string;
2365
+ /**
2366
+ * @public
2367
+ * <p>Whether the quick response is active.</p>
2368
+ */
2369
+ isActive?: boolean;
2370
+ /**
2371
+ * @public
2372
+ * <p>The Amazon Connect channels this quick response applies to.</p>
2373
+ */
2374
+ channels?: string[];
2375
+ /**
2376
+ * @public
2377
+ * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
2378
+ * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
2379
+ * <code>zh_CN</code>, <code>zh_TW</code>
2380
+ * </p>
2381
+ */
2382
+ language?: string;
2383
+ /**
2384
+ * @public
2385
+ * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
2386
+ * request. If not provided, the Amazon Web Services
2387
+ * SDK populates this field. For more information about idempotency, see
2388
+ * <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
2389
+ */
2390
+ clientToken?: string;
2391
+ /**
2392
+ * @public
2393
+ * <p>The tags used to organize, track, or control access for this resource.</p>
2394
+ */
2395
+ tags?: Record<string, string>;
2396
+ }
2397
+ /**
2398
+ * @public
2399
+ * <p>The container quick response content.</p>
2400
+ */
2401
+ export type QuickResponseContentProvider = QuickResponseContentProvider.ContentMember | QuickResponseContentProvider.$UnknownMember;
2402
+ /**
2403
+ * @public
2404
+ */
2405
+ export declare namespace QuickResponseContentProvider {
2406
+ /**
2407
+ * @public
2408
+ * <p>The content of the quick response.</p>
2409
+ */
2410
+ interface ContentMember {
2411
+ content: string;
2412
+ $unknown?: never;
2413
+ }
2414
+ /**
2415
+ * @public
2416
+ */
2417
+ interface $UnknownMember {
2418
+ content?: never;
2419
+ $unknown: [string, any];
2420
+ }
2421
+ interface Visitor<T> {
2422
+ content: (value: string) => T;
2423
+ _: (name: string, value: any) => T;
2424
+ }
2425
+ const visit: <T>(value: QuickResponseContentProvider, visitor: Visitor<T>) => T;
2426
+ }
2427
+ /**
2428
+ * @public
2429
+ * <p>The content of the quick response stored in different media types.</p>
2430
+ */
2431
+ export interface QuickResponseContents {
2432
+ /**
2433
+ * @public
2434
+ * <p>The container quick response content.</p>
2435
+ */
2436
+ plainText?: QuickResponseContentProvider;
2437
+ /**
2438
+ * @public
2439
+ * <p>The container quick response content.</p>
2440
+ */
2441
+ markdown?: QuickResponseContentProvider;
2442
+ }
2443
+ /**
2444
+ * @public
2445
+ * @enum
2446
+ */
2447
+ export declare const QuickResponseStatus: {
2448
+ readonly CREATED: "CREATED";
2449
+ readonly CREATE_FAILED: "CREATE_FAILED";
2450
+ readonly CREATE_IN_PROGRESS: "CREATE_IN_PROGRESS";
2451
+ readonly DELETED: "DELETED";
2452
+ readonly DELETE_FAILED: "DELETE_FAILED";
2453
+ readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
2454
+ readonly UPDATE_FAILED: "UPDATE_FAILED";
2455
+ readonly UPDATE_IN_PROGRESS: "UPDATE_IN_PROGRESS";
2456
+ };
2457
+ /**
2458
+ * @public
2459
+ */
2460
+ export type QuickResponseStatus = (typeof QuickResponseStatus)[keyof typeof QuickResponseStatus];
2461
+ /**
2462
+ * @public
2463
+ * <p>Information about the quick response.</p>
2464
+ */
2465
+ export interface QuickResponseData {
2466
+ /**
2467
+ * @public
2468
+ * <p>The Amazon Resource Name (ARN) of the quick response.</p>
2469
+ */
2470
+ quickResponseArn: string | undefined;
2471
+ /**
2472
+ * @public
2473
+ * <p>The identifier of the quick response.</p>
2474
+ */
2475
+ quickResponseId: string | undefined;
2476
+ /**
2477
+ * @public
2478
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
2479
+ */
2480
+ knowledgeBaseArn: string | undefined;
2481
+ /**
2482
+ * @public
2483
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2484
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2485
+ */
2486
+ knowledgeBaseId: string | undefined;
2487
+ /**
2488
+ * @public
2489
+ * <p>The name of the quick response.</p>
2490
+ */
2491
+ name: string | undefined;
2492
+ /**
2493
+ * @public
2494
+ * <p>The media type of the quick response content.</p>
2495
+ * <ul>
2496
+ * <li>
2497
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p>
2498
+ * </li>
2499
+ * <li>
2500
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
2501
+ * </li>
2502
+ * </ul>
2503
+ */
2504
+ contentType: string | undefined;
2505
+ /**
2506
+ * @public
2507
+ * <p>The status of the quick response data.</p>
2508
+ */
2509
+ status: QuickResponseStatus | undefined;
2510
+ /**
2511
+ * @public
2512
+ * <p>The timestamp when the quick response was created.</p>
2513
+ */
2514
+ createdTime: Date | undefined;
2515
+ /**
2516
+ * @public
2517
+ * <p>The timestamp when the quick response data was last modified.</p>
2518
+ */
2519
+ lastModifiedTime: Date | undefined;
2520
+ /**
2521
+ * @public
2522
+ * <p>The contents of the quick response.</p>
2523
+ */
2524
+ contents?: QuickResponseContents;
2525
+ /**
2526
+ * @public
2527
+ * <p>The description of the quick response.</p>
2528
+ */
2529
+ description?: string;
2530
+ /**
2531
+ * @public
2532
+ * <p>The configuration information of the user groups that the quick response is accessible to.</p>
2533
+ */
2534
+ groupingConfiguration?: GroupingConfiguration;
2535
+ /**
2536
+ * @public
2537
+ * <p>The shortcut key of the quick response. The value should be unique across the
2538
+ * knowledge base.</p>
2539
+ */
2540
+ shortcutKey?: string;
2541
+ /**
2542
+ * @public
2543
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
2544
+ */
2545
+ lastModifiedBy?: string;
2546
+ /**
2547
+ * @public
2548
+ * <p>Whether the quick response is active.</p>
2549
+ */
2550
+ isActive?: boolean;
2551
+ /**
2552
+ * @public
2553
+ * <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
2554
+ */
2555
+ channels?: string[];
2556
+ /**
2557
+ * @public
2558
+ * <p>The language code value for the language in which the quick response is written.</p>
2559
+ */
2560
+ language?: string;
2561
+ /**
2562
+ * @public
2563
+ * <p>The tags used to organize, track, or control access for this resource.</p>
2564
+ */
2565
+ tags?: Record<string, string>;
2566
+ }
2567
+ /**
2568
+ * @public
2569
+ */
2570
+ export interface CreateQuickResponseResponse {
2571
+ /**
2572
+ * @public
2573
+ * <p>The quick response.</p>
2574
+ */
2575
+ quickResponse?: QuickResponseData;
2576
+ }
2577
+ /**
2578
+ * @public
2579
+ */
2580
+ export interface DeleteImportJobRequest {
2581
+ /**
2582
+ * @public
2583
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2584
+ * base if you're storing Amazon Q Content resource to it.</p>
2585
+ */
2586
+ knowledgeBaseId: string | undefined;
2587
+ /**
2588
+ * @public
2589
+ * <p>The identifier of the import job to be deleted.</p>
2590
+ */
2591
+ importJobId: string | undefined;
2592
+ }
2593
+ /**
2594
+ * @public
2595
+ */
2596
+ export interface DeleteImportJobResponse {
2597
+ }
2598
+ /**
2599
+ * @public
2600
+ */
2601
+ export interface DeleteKnowledgeBaseRequest {
2602
+ /**
2603
+ * @public
2604
+ * <p>The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2605
+ */
2606
+ knowledgeBaseId: string | undefined;
2607
+ }
2608
+ /**
2609
+ * @public
2610
+ */
2611
+ export interface DeleteKnowledgeBaseResponse {
2612
+ }
2613
+ /**
2614
+ * @public
2615
+ */
2616
+ export interface DeleteQuickResponseRequest {
2617
+ /**
2618
+ * @public
2619
+ * <p>The knowledge base from which the quick response is deleted. The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2620
+ * base if you're storing Amazon Q Content resource to it.</p>
2621
+ */
2622
+ knowledgeBaseId: string | undefined;
2623
+ /**
2624
+ * @public
2625
+ * <p>The identifier of the quick response to delete.</p>
2626
+ */
2627
+ quickResponseId: string | undefined;
2628
+ }
2629
+ /**
2630
+ * @public
2631
+ */
2632
+ export interface DeleteQuickResponseResponse {
2633
+ }
2634
+ /**
2635
+ * @public
2636
+ * @enum
2637
+ */
2638
+ export declare const ExternalSource: {
2639
+ readonly AMAZON_CONNECT: "AMAZON_CONNECT";
2640
+ };
2641
+ /**
2642
+ * @public
2643
+ */
2644
+ export type ExternalSource = (typeof ExternalSource)[keyof typeof ExternalSource];
2645
+ /**
2646
+ * @public
2647
+ * <p>The configuration information of the external data source.</p>
2648
+ */
2649
+ export interface ExternalSourceConfiguration {
2650
+ /**
2651
+ * @public
2652
+ * <p>The type of the external data source.</p>
2653
+ */
2654
+ source: ExternalSource | undefined;
2655
+ /**
2656
+ * @public
2657
+ * <p>The configuration information of the external data source.</p>
2658
+ */
2659
+ configuration: Configuration | undefined;
2660
+ }
2661
+ /**
2662
+ * @public
2663
+ */
2664
+ export interface GetImportJobRequest {
2665
+ /**
2666
+ * @public
2667
+ * <p>The identifier of the import job to retrieve.</p>
2668
+ */
2669
+ importJobId: string | undefined;
2670
+ /**
2671
+ * @public
2672
+ * <p>The identifier of the knowledge base that the import job belongs to.</p>
2673
+ */
2674
+ knowledgeBaseId: string | undefined;
2675
+ }
2676
+ /**
2677
+ * @public
2678
+ * @enum
2679
+ */
2680
+ export declare const ImportJobType: {
2681
+ readonly QUICK_RESPONSES: "QUICK_RESPONSES";
2682
+ };
2683
+ /**
2684
+ * @public
2685
+ */
2686
+ export type ImportJobType = (typeof ImportJobType)[keyof typeof ImportJobType];
2687
+ /**
2688
+ * @public
2689
+ * @enum
2690
+ */
2691
+ export declare const ImportJobStatus: {
2692
+ readonly COMPLETE: "COMPLETE";
2693
+ readonly DELETED: "DELETED";
2694
+ readonly DELETE_FAILED: "DELETE_FAILED";
2695
+ readonly DELETE_IN_PROGRESS: "DELETE_IN_PROGRESS";
2696
+ readonly FAILED: "FAILED";
2697
+ readonly START_IN_PROGRESS: "START_IN_PROGRESS";
2698
+ };
2699
+ /**
2700
+ * @public
2701
+ */
2702
+ export type ImportJobStatus = (typeof ImportJobStatus)[keyof typeof ImportJobStatus];
2703
+ /**
2704
+ * @public
2705
+ * <p>Summary information about the import job.</p>
2706
+ */
2707
+ export interface ImportJobData {
2708
+ /**
2709
+ * @public
2710
+ * <p>The identifier of the import job.</p>
2711
+ */
2712
+ importJobId: string | undefined;
2713
+ /**
2714
+ * @public
2715
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2716
+ * base if you're storing Amazon Q Content resource to it.</p>
2717
+ */
2718
+ knowledgeBaseId: string | undefined;
2719
+ /**
2720
+ * @public
2721
+ * <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
2722
+ */
2723
+ uploadId: string | undefined;
2724
+ /**
2725
+ * @public
2726
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
2727
+ */
2728
+ knowledgeBaseArn: string | undefined;
2729
+ /**
2730
+ * @public
2731
+ * <p>The type of the import job.</p>
2732
+ */
2733
+ importJobType: ImportJobType | undefined;
2734
+ /**
2735
+ * @public
2736
+ * <p>The status of the import job.</p>
2737
+ */
2738
+ status: ImportJobStatus | undefined;
2739
+ /**
2740
+ * @public
2741
+ * <p>The download link to the resource file that is uploaded to the import job.</p>
2742
+ */
2743
+ url: string | undefined;
2744
+ /**
2745
+ * @public
2746
+ * <p>The link to donwload the information of resource data that failed to be imported.</p>
2747
+ */
2748
+ failedRecordReport?: string;
2749
+ /**
2750
+ * @public
2751
+ * <p>The expiration time of the URL as an epoch timestamp.</p>
2752
+ */
2753
+ urlExpiry: Date | undefined;
2754
+ /**
2755
+ * @public
2756
+ * <p>The timestamp when the import job was created.</p>
2757
+ */
2758
+ createdTime: Date | undefined;
2759
+ /**
2760
+ * @public
2761
+ * <p>The timestamp when the import job data was last modified.</p>
2762
+ */
2763
+ lastModifiedTime: Date | undefined;
2764
+ /**
2765
+ * @public
2766
+ * <p>The metadata fields of the imported Amazon Q resources.</p>
2767
+ */
2768
+ metadata?: Record<string, string>;
2769
+ /**
2770
+ * @public
2771
+ * <p>The configuration information of the external data source.</p>
2772
+ */
2773
+ externalSourceConfiguration?: ExternalSourceConfiguration;
2774
+ }
2775
+ /**
2776
+ * @public
2777
+ */
2778
+ export interface GetImportJobResponse {
2779
+ /**
2780
+ * @public
2781
+ * <p>The import job.</p>
2782
+ */
2783
+ importJob?: ImportJobData;
2784
+ }
2785
+ /**
2786
+ * @public
2787
+ */
2788
+ export interface GetKnowledgeBaseRequest {
2789
+ /**
2790
+ * @public
2791
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2792
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2793
+ */
2794
+ knowledgeBaseId: string | undefined;
2795
+ }
2796
+ /**
2797
+ * @public
2798
+ */
2799
+ export interface GetKnowledgeBaseResponse {
2800
+ /**
2801
+ * @public
2802
+ * <p>The knowledge base.</p>
2803
+ */
2804
+ knowledgeBase?: KnowledgeBaseData;
2805
+ }
2806
+ /**
2807
+ * @public
2808
+ */
2809
+ export interface GetQuickResponseRequest {
2810
+ /**
2811
+ * @public
2812
+ * <p>The identifier of the quick response.</p>
2813
+ */
2814
+ quickResponseId: string | undefined;
2815
+ /**
2816
+ * @public
2817
+ * <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base.</p>
2818
+ */
2819
+ knowledgeBaseId: string | undefined;
2820
+ }
2821
+ /**
2822
+ * @public
2823
+ */
2824
+ export interface GetQuickResponseResponse {
2825
+ /**
2826
+ * @public
2827
+ * <p>The quick response.</p>
2828
+ */
2829
+ quickResponse?: QuickResponseData;
2830
+ }
2831
+ /**
2832
+ * @public
2833
+ * <p>Summary information about the import job.</p>
2834
+ */
2835
+ export interface ImportJobSummary {
2836
+ /**
2837
+ * @public
2838
+ * <p>The identifier of the import job.</p>
2839
+ */
2840
+ importJobId: string | undefined;
2841
+ /**
2842
+ * @public
2843
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2844
+ * base if you're storing Amazon Q Content resource to it.</p>
2845
+ */
2846
+ knowledgeBaseId: string | undefined;
2847
+ /**
2848
+ * @public
2849
+ * <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
2850
+ */
2851
+ uploadId: string | undefined;
2852
+ /**
2853
+ * @public
2854
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
2855
+ */
2856
+ knowledgeBaseArn: string | undefined;
2857
+ /**
2858
+ * @public
2859
+ * <p>The type of import job.</p>
2860
+ */
2861
+ importJobType: ImportJobType | undefined;
2862
+ /**
2863
+ * @public
2864
+ * <p>The status of the import job.</p>
2865
+ */
2866
+ status: ImportJobStatus | undefined;
2867
+ /**
2868
+ * @public
2869
+ * <p>The timestamp when the import job was created.</p>
2870
+ */
2871
+ createdTime: Date | undefined;
2872
+ /**
2873
+ * @public
2874
+ * <p>The timestamp when the import job was last modified.</p>
2875
+ */
2876
+ lastModifiedTime: Date | undefined;
2877
+ /**
2878
+ * @public
2879
+ * <p>The metadata fields of the imported Amazon Q resources.</p>
2880
+ */
2881
+ metadata?: Record<string, string>;
2882
+ /**
2883
+ * @public
2884
+ * <p>The configuration information of the external source that the resource data are imported from.</p>
2885
+ */
2886
+ externalSourceConfiguration?: ExternalSourceConfiguration;
2887
+ }
2888
+ /**
2889
+ * @public
2890
+ */
2891
+ export interface ListImportJobsRequest {
2892
+ /**
2893
+ * @public
2894
+ * <p>The token for the next set of results. Use the value returned in the previous
2895
+ * response in the next request to retrieve the next set of results.</p>
2896
+ */
2897
+ nextToken?: string;
2898
+ /**
2899
+ * @public
2900
+ * <p>The maximum number of results to return per page.</p>
2901
+ */
2902
+ maxResults?: number;
2903
+ /**
2904
+ * @public
2905
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2906
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
2907
+ */
2908
+ knowledgeBaseId: string | undefined;
2909
+ }
2910
+ /**
2911
+ * @public
2912
+ */
2913
+ export interface ListImportJobsResponse {
2914
+ /**
2915
+ * @public
2916
+ * <p>Summary information about the import jobs.</p>
2917
+ */
2918
+ importJobSummaries: ImportJobSummary[] | undefined;
2919
+ /**
2920
+ * @public
2921
+ * <p>The token for the next set of results. Use the value returned in the previous
2922
+ * response in the next request to retrieve the next set of results.</p>
2923
+ */
2924
+ nextToken?: string;
2925
+ }
2926
+ /**
2927
+ * @public
2928
+ */
2929
+ export interface ListKnowledgeBasesRequest {
2930
+ /**
2931
+ * @public
2932
+ * <p>The token for the next set of results. Use the value returned in the previous
2933
+ * response in the next request to retrieve the next set of results.</p>
2934
+ */
2935
+ nextToken?: string;
2936
+ /**
2937
+ * @public
2938
+ * <p>The maximum number of results to return per page.</p>
2939
+ */
2940
+ maxResults?: number;
2941
+ }
2942
+ /**
2943
+ * @public
2944
+ * <p>Summary information about the knowledge base.</p>
2945
+ */
2946
+ export interface KnowledgeBaseSummary {
2947
+ /**
2948
+ * @public
2949
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
2950
+ * base if you're storing Amazon Q Content resource to it.</p>
2951
+ */
2952
+ knowledgeBaseId: string | undefined;
2953
+ /**
2954
+ * @public
2955
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
2956
+ */
2957
+ knowledgeBaseArn: string | undefined;
2958
+ /**
2959
+ * @public
2960
+ * <p>The name of the knowledge base.</p>
2961
+ */
2962
+ name: string | undefined;
2963
+ /**
2964
+ * @public
2965
+ * <p>The type of knowledge base.</p>
2966
+ */
2967
+ knowledgeBaseType: KnowledgeBaseType | undefined;
2968
+ /**
2969
+ * @public
2970
+ * <p>The status of the knowledge base summary.</p>
2971
+ */
2972
+ status: KnowledgeBaseStatus | undefined;
2973
+ /**
2974
+ * @public
2975
+ * <p>Configuration information about the external data source.</p>
2976
+ */
2977
+ sourceConfiguration?: SourceConfiguration;
2978
+ /**
2979
+ * @public
2980
+ * <p>Information about how to render the content.</p>
2981
+ */
2982
+ renderingConfiguration?: RenderingConfiguration;
2983
+ /**
2984
+ * @public
2985
+ * <p>The configuration information for the customer managed key used for encryption. </p>
2986
+ * <p>This KMS key must have a policy that allows <code>kms:CreateGrant</code>,
2987
+ * <code>kms:DescribeKey</code>, <code>kms:Decrypt</code>, and
2988
+ * <code>kms:GenerateDataKey*</code> permissions to the IAM identity using the
2989
+ * key to invoke Amazon Q. </p>
2990
+ * <p>For more information about setting up a customer managed key for Amazon Q, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-q.html">Enable Amazon Q in Connect for
2991
+ * your instance</a>.</p>
2992
+ */
2993
+ serverSideEncryptionConfiguration?: ServerSideEncryptionConfiguration;
2994
+ /**
2995
+ * @public
2996
+ * <p>The description of the knowledge base.</p>
2997
+ */
2998
+ description?: string;
2999
+ /**
3000
+ * @public
3001
+ * <p>The tags used to organize, track, or control access for this resource.</p>
3002
+ */
3003
+ tags?: Record<string, string>;
3004
+ }
3005
+ /**
3006
+ * @public
3007
+ */
3008
+ export interface ListKnowledgeBasesResponse {
3009
+ /**
3010
+ * @public
3011
+ * <p>Information about the knowledge bases.</p>
3012
+ */
3013
+ knowledgeBaseSummaries: KnowledgeBaseSummary[] | undefined;
3014
+ /**
3015
+ * @public
3016
+ * <p>If there are additional results, this is the token for the next set of results.</p>
3017
+ */
3018
+ nextToken?: string;
3019
+ }
3020
+ /**
3021
+ * @public
3022
+ */
3023
+ export interface ListQuickResponsesRequest {
3024
+ /**
3025
+ * @public
3026
+ * <p>The token for the next set of results. Use the value returned in the previous
3027
+ * response in the next request to retrieve the next set of results.</p>
3028
+ */
3029
+ nextToken?: string;
3030
+ /**
3031
+ * @public
3032
+ * <p>The maximum number of results to return per page.</p>
3033
+ */
3034
+ maxResults?: number;
3035
+ /**
3036
+ * @public
3037
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3038
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3039
+ */
3040
+ knowledgeBaseId: string | undefined;
3041
+ }
3042
+ /**
3043
+ * @public
3044
+ * <p>The summary information about the quick response.</p>
3045
+ */
3046
+ export interface QuickResponseSummary {
3047
+ /**
3048
+ * @public
3049
+ * <p>The Amazon Resource Name (ARN) of the quick response.</p>
3050
+ */
3051
+ quickResponseArn: string | undefined;
3052
+ /**
3053
+ * @public
3054
+ * <p>The identifier of the quick response.</p>
3055
+ */
3056
+ quickResponseId: string | undefined;
3057
+ /**
3058
+ * @public
3059
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
3060
+ */
3061
+ knowledgeBaseArn: string | undefined;
3062
+ /**
3063
+ * @public
3064
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3065
+ * base if you're storing Amazon Q Content resource to it.</p>
3066
+ */
3067
+ knowledgeBaseId: string | undefined;
3068
+ /**
3069
+ * @public
3070
+ * <p>The name of the quick response.</p>
3071
+ */
3072
+ name: string | undefined;
3073
+ /**
3074
+ * @public
3075
+ * <p>The media type of the quick response content.</p>
3076
+ * <ul>
3077
+ * <li>
3078
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p>
3079
+ * </li>
3080
+ * <li>
3081
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
3082
+ * </li>
3083
+ * </ul>
3084
+ */
3085
+ contentType: string | undefined;
3086
+ /**
3087
+ * @public
3088
+ * <p>The resource status of the quick response.</p>
3089
+ */
3090
+ status: QuickResponseStatus | undefined;
3091
+ /**
3092
+ * @public
3093
+ * <p>The timestamp when the quick response was created.</p>
3094
+ */
3095
+ createdTime: Date | undefined;
3096
+ /**
3097
+ * @public
3098
+ * <p>The timestamp when the quick response summary was last modified.</p>
3099
+ */
3100
+ lastModifiedTime: Date | undefined;
3101
+ /**
3102
+ * @public
3103
+ * <p>The description of the quick response.</p>
3104
+ */
3105
+ description?: string;
3106
+ /**
3107
+ * @public
3108
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the quick response data.</p>
3109
+ */
3110
+ lastModifiedBy?: string;
3111
+ /**
3112
+ * @public
3113
+ * <p>Whether the quick response is active.</p>
3114
+ */
3115
+ isActive?: boolean;
3116
+ /**
3117
+ * @public
3118
+ * <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
3119
+ */
3120
+ channels?: string[];
3121
+ /**
3122
+ * @public
3123
+ * <p>The tags used to organize, track, or control access for this resource.</p>
3124
+ */
3125
+ tags?: Record<string, string>;
3126
+ }
3127
+ /**
3128
+ * @public
3129
+ */
3130
+ export interface ListQuickResponsesResponse {
3131
+ /**
3132
+ * @public
3133
+ * <p>Summary information about the quick responses.</p>
3134
+ */
3135
+ quickResponseSummaries: QuickResponseSummary[] | undefined;
3136
+ /**
3137
+ * @public
3138
+ * <p>The token for the next set of results. Use the value returned in the previous
3139
+ * response in the next request to retrieve the next set of results.</p>
3140
+ */
3141
+ nextToken?: string;
3142
+ }
3143
+ /**
3144
+ * @public
3145
+ */
3146
+ export interface UpdateQuickResponseRequest {
3147
+ /**
3148
+ * @public
3149
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3150
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3151
+ */
3152
+ knowledgeBaseId: string | undefined;
3153
+ /**
3154
+ * @public
3155
+ * <p>The identifier of the quick response.</p>
3156
+ */
3157
+ quickResponseId: string | undefined;
3158
+ /**
3159
+ * @public
3160
+ * <p>The name of the quick response.</p>
3161
+ */
3162
+ name?: string;
3163
+ /**
3164
+ * @public
3165
+ * <p>The updated content of the quick response.</p>
3166
+ */
3167
+ content?: QuickResponseDataProvider;
3168
+ /**
3169
+ * @public
3170
+ * <p>The media type of the quick response content.</p>
3171
+ * <ul>
3172
+ * <li>
3173
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p>
3174
+ * </li>
3175
+ * <li>
3176
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
3177
+ * </li>
3178
+ * </ul>
3179
+ */
3180
+ contentType?: string;
3181
+ /**
3182
+ * @public
3183
+ * <p>The updated grouping configuration of the quick response.</p>
3184
+ */
3185
+ groupingConfiguration?: GroupingConfiguration;
3186
+ /**
3187
+ * @public
3188
+ * <p>Whether to remove the grouping configuration of the quick response.</p>
3189
+ */
3190
+ removeGroupingConfiguration?: boolean;
3191
+ /**
3192
+ * @public
3193
+ * <p>The updated description of the quick response.</p>
3194
+ */
3195
+ description?: string;
3196
+ /**
3197
+ * @public
3198
+ * <p>Whether to remove the description from the quick response.</p>
3199
+ */
3200
+ removeDescription?: boolean;
3201
+ /**
3202
+ * @public
3203
+ * <p>The shortcut key of the quick response. The value should be unique across the
3204
+ * knowledge base.</p>
3205
+ */
3206
+ shortcutKey?: string;
3207
+ /**
3208
+ * @public
3209
+ * <p>Whether to remove the shortcut key of the quick response.</p>
3210
+ */
3211
+ removeShortcutKey?: boolean;
3212
+ /**
3213
+ * @public
3214
+ * <p>Whether the quick response is active. </p>
3215
+ */
3216
+ isActive?: boolean;
3217
+ /**
3218
+ * @public
3219
+ * <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
3220
+ */
3221
+ channels?: string[];
3222
+ /**
3223
+ * @public
3224
+ * <p>The language code value for the language in which the quick response is written. The supported language codes include <code>de_DE</code>, <code>en_US</code>, <code>es_ES</code>,
3225
+ * <code>fr_FR</code>, <code>id_ID</code>, <code>it_IT</code>, <code>ja_JP</code>, <code>ko_KR</code>, <code>pt_BR</code>,
3226
+ * <code>zh_CN</code>, <code>zh_TW</code>
3227
+ * </p>
3228
+ */
3229
+ language?: string;
3230
+ }
3231
+ /**
3232
+ * @public
3233
+ */
3234
+ export interface UpdateQuickResponseResponse {
3235
+ /**
3236
+ * @public
3237
+ * <p>The quick response.</p>
3238
+ */
3239
+ quickResponse?: QuickResponseData;
3240
+ }
3241
+ /**
3242
+ * @public
3243
+ */
3244
+ export interface RemoveKnowledgeBaseTemplateUriRequest {
3245
+ /**
3246
+ * @public
3247
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3248
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3249
+ */
3250
+ knowledgeBaseId: string | undefined;
3251
+ }
3252
+ /**
3253
+ * @public
3254
+ */
3255
+ export interface RemoveKnowledgeBaseTemplateUriResponse {
3256
+ }
3257
+ /**
3258
+ * @public
3259
+ */
3260
+ export interface SearchContentRequest {
3261
+ /**
3262
+ * @public
3263
+ * <p>The token for the next set of results. Use the value returned in the previous
3264
+ * response in the next request to retrieve the next set of results.</p>
3265
+ */
3266
+ nextToken?: string;
3267
+ /**
3268
+ * @public
3269
+ * <p>The maximum number of results to return per page.</p>
3270
+ */
3271
+ maxResults?: number;
3272
+ /**
3273
+ * @public
3274
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3275
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3276
+ */
3277
+ knowledgeBaseId: string | undefined;
3278
+ /**
3279
+ * @public
3280
+ * <p>The search expression to filter results.</p>
3281
+ */
3282
+ searchExpression: SearchExpression | undefined;
3283
+ }
3284
+ /**
3285
+ * @public
3286
+ */
3287
+ export interface SearchContentResponse {
3288
+ /**
3289
+ * @public
3290
+ * <p>Summary information about the content.</p>
3291
+ */
3292
+ contentSummaries: ContentSummary[] | undefined;
3293
+ /**
3294
+ * @public
3295
+ * <p>If there are additional results, this is the token for the next set of results.</p>
3296
+ */
3297
+ nextToken?: string;
3298
+ }
3299
+ /**
3300
+ * @public
3301
+ * @enum
3302
+ */
3303
+ export declare const QuickResponseFilterOperator: {
3304
+ readonly EQUALS: "EQUALS";
3305
+ readonly PREFIX: "PREFIX";
3306
+ };
3307
+ /**
3308
+ * @public
3309
+ */
3310
+ export type QuickResponseFilterOperator = (typeof QuickResponseFilterOperator)[keyof typeof QuickResponseFilterOperator];
3311
+ /**
3312
+ * @public
3313
+ * <p>The quick response fields to filter the quick response query results by.</p>
3314
+ * <p>The following is the list of supported field names.</p>
3315
+ * <ul>
3316
+ * <li>
3317
+ * <p>name</p>
3318
+ * </li>
3319
+ * <li>
3320
+ * <p>description</p>
3321
+ * </li>
3322
+ * <li>
3323
+ * <p>shortcutKey</p>
3324
+ * </li>
3325
+ * <li>
3326
+ * <p>isActive</p>
3327
+ * </li>
3328
+ * <li>
3329
+ * <p>channels</p>
3330
+ * </li>
3331
+ * <li>
3332
+ * <p>language</p>
3333
+ * </li>
3334
+ * <li>
3335
+ * <p>contentType</p>
3336
+ * </li>
3337
+ * <li>
3338
+ * <p>createdTime</p>
3339
+ * </li>
3340
+ * <li>
3341
+ * <p>lastModifiedTime</p>
3342
+ * </li>
3343
+ * <li>
3344
+ * <p>lastModifiedBy</p>
3345
+ * </li>
3346
+ * <li>
3347
+ * <p>groupingConfiguration.criteria</p>
3348
+ * </li>
3349
+ * <li>
3350
+ * <p>groupingConfiguration.values</p>
3351
+ * </li>
3352
+ * </ul>
3353
+ */
3354
+ export interface QuickResponseFilterField {
3355
+ /**
3356
+ * @public
3357
+ * <p>The name of the attribute field to filter the quick responses by.</p>
3358
+ */
3359
+ name: string | undefined;
3360
+ /**
3361
+ * @public
3362
+ * <p>The values of attribute field to filter the quick response by.</p>
3363
+ */
3364
+ values?: string[];
3365
+ /**
3366
+ * @public
3367
+ * <p>The operator to use for filtering.</p>
3368
+ */
3369
+ operator: QuickResponseFilterOperator | undefined;
3370
+ /**
3371
+ * @public
3372
+ * <p>Whether to treat null value as a match for the attribute field.</p>
3373
+ */
3374
+ includeNoExistence?: boolean;
3375
+ }
3376
+ /**
3377
+ * @public
3378
+ * @enum
3379
+ */
3380
+ export declare const Order: {
3381
+ readonly ASC: "ASC";
3382
+ readonly DESC: "DESC";
3383
+ };
3384
+ /**
3385
+ * @public
3386
+ */
3387
+ export type Order = (typeof Order)[keyof typeof Order];
3388
+ /**
3389
+ * @public
3390
+ * <p>The quick response fields to order the quick response query results by.</p>
3391
+ * <p>The following is the list of supported field names.</p>
3392
+ * <ul>
3393
+ * <li>
3394
+ * <p>name</p>
3395
+ * </li>
3396
+ * <li>
3397
+ * <p>description</p>
3398
+ * </li>
3399
+ * <li>
3400
+ * <p>shortcutKey</p>
3401
+ * </li>
3402
+ * <li>
3403
+ * <p>isActive</p>
3404
+ * </li>
3405
+ * <li>
3406
+ * <p>channels</p>
3407
+ * </li>
3408
+ * <li>
3409
+ * <p>language</p>
3410
+ * </li>
3411
+ * <li>
3412
+ * <p>contentType</p>
3413
+ * </li>
3414
+ * <li>
3415
+ * <p>createdTime</p>
3416
+ * </li>
3417
+ * <li>
3418
+ * <p>lastModifiedTime</p>
3419
+ * </li>
3420
+ * <li>
3421
+ * <p>lastModifiedBy</p>
3422
+ * </li>
3423
+ * <li>
3424
+ * <p>groupingConfiguration.criteria</p>
3425
+ * </li>
3426
+ * <li>
3427
+ * <p>groupingConfiguration.values</p>
3428
+ * </li>
3429
+ * </ul>
3430
+ */
3431
+ export interface QuickResponseOrderField {
3432
+ /**
3433
+ * @public
3434
+ * <p>The name of the attribute to order the quick response query results by.</p>
3435
+ */
3436
+ name: string | undefined;
3437
+ /**
3438
+ * @public
3439
+ * <p>The order at which the quick responses are sorted by.</p>
3440
+ */
3441
+ order?: Order;
3442
+ }
3443
+ /**
3444
+ * @public
3445
+ * @enum
3446
+ */
3447
+ export declare const QuickResponseQueryOperator: {
3448
+ readonly CONTAINS: "CONTAINS";
3449
+ readonly CONTAINS_AND_PREFIX: "CONTAINS_AND_PREFIX";
3450
+ };
3451
+ /**
3452
+ * @public
3453
+ */
3454
+ export type QuickResponseQueryOperator = (typeof QuickResponseQueryOperator)[keyof typeof QuickResponseQueryOperator];
3455
+ /**
3456
+ * @public
3457
+ * @enum
3458
+ */
3459
+ export declare const Priority: {
3460
+ readonly HIGH: "HIGH";
3461
+ readonly LOW: "LOW";
3462
+ readonly MEDIUM: "MEDIUM";
3463
+ };
3464
+ /**
3465
+ * @public
3466
+ */
3467
+ export type Priority = (typeof Priority)[keyof typeof Priority];
3468
+ /**
3469
+ * @public
3470
+ * <p>The quick response fields to query quick responses by.</p>
3471
+ * <p>The following is the list of supported field names.</p>
3472
+ * <ul>
3473
+ * <li>
3474
+ * <p>content</p>
3475
+ * </li>
3476
+ * <li>
3477
+ * <p>name</p>
3478
+ * </li>
3479
+ * <li>
3480
+ * <p>description</p>
3481
+ * </li>
3482
+ * <li>
3483
+ * <p>shortcutKey</p>
3484
+ * </li>
3485
+ * </ul>
3486
+ */
3487
+ export interface QuickResponseQueryField {
3488
+ /**
3489
+ * @public
3490
+ * <p>The name of the attribute to query the quick responses by.</p>
3491
+ */
3492
+ name: string | undefined;
3493
+ /**
3494
+ * @public
3495
+ * <p>The values of the attribute to query the quick responses by.</p>
3496
+ */
3497
+ values: string[] | undefined;
3498
+ /**
3499
+ * @public
3500
+ * <p>The operator to use for matching attribute field values in the query.</p>
3501
+ */
3502
+ operator: QuickResponseQueryOperator | undefined;
3503
+ /**
3504
+ * @public
3505
+ * <p>Whether the query expects only exact matches on the attribute field values. The results of the query will only include exact matches if this parameter is set to false.</p>
3506
+ */
3507
+ allowFuzziness?: boolean;
3508
+ /**
3509
+ * @public
3510
+ * <p>The importance of the attribute field when calculating query result relevancy scores.
3511
+ * The value set for this parameter affects the ordering of search results.</p>
3512
+ */
3513
+ priority?: Priority;
3514
+ }
3515
+ /**
3516
+ * @public
3517
+ * <p>Information about the import job.</p>
3518
+ */
3519
+ export interface QuickResponseSearchExpression {
3520
+ /**
3521
+ * @public
3522
+ * <p>The quick response query expressions.</p>
3523
+ */
3524
+ queries?: QuickResponseQueryField[];
3525
+ /**
3526
+ * @public
3527
+ * <p>The configuration of filtering rules applied to quick response query results.</p>
3528
+ */
3529
+ filters?: QuickResponseFilterField[];
3530
+ /**
3531
+ * @public
3532
+ * <p>The quick response attribute fields on which the query results are ordered.</p>
3533
+ */
3534
+ orderOnField?: QuickResponseOrderField;
3535
+ }
3536
+ /**
3537
+ * @public
3538
+ */
3539
+ export interface SearchQuickResponsesRequest {
3540
+ /**
3541
+ * @public
3542
+ * <p>The identifier of the knowledge base. This should be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3543
+ */
3544
+ knowledgeBaseId: string | undefined;
3545
+ /**
3546
+ * @public
3547
+ * <p>The search expression for querying the quick response.</p>
3548
+ */
3549
+ searchExpression: QuickResponseSearchExpression | undefined;
3550
+ /**
3551
+ * @public
3552
+ * <p>The token for the next set of results. Use the value returned in the previous
3553
+ * response in the next request to retrieve the next set of results.</p>
3554
+ */
3555
+ nextToken?: string;
3556
+ /**
3557
+ * @public
3558
+ * <p>The maximum number of results to return per page.</p>
3559
+ */
3560
+ maxResults?: number;
3561
+ /**
3562
+ * @public
3563
+ * <p>The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-attrib-list.html#user-defined-attributes">user-defined Amazon Connect contact attributes</a> to be resolved when search results are returned.</p>
3564
+ */
3565
+ attributes?: Record<string, string>;
3566
+ }
3567
+ /**
3568
+ * @public
3569
+ * <p>The result of quick response search.</p>
3570
+ */
3571
+ export interface QuickResponseSearchResultData {
3572
+ /**
3573
+ * @public
3574
+ * <p>The Amazon Resource Name (ARN) of the quick response.</p>
3575
+ */
3576
+ quickResponseArn: string | undefined;
3577
+ /**
3578
+ * @public
3579
+ * <p>The identifier of the quick response.</p>
3580
+ */
3581
+ quickResponseId: string | undefined;
3582
+ /**
3583
+ * @public
3584
+ * <p>The Amazon Resource Name (ARN) of the knowledge base.</p>
3585
+ */
3586
+ knowledgeBaseArn: string | undefined;
3587
+ /**
3588
+ * @public
3589
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3590
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3591
+ */
3592
+ knowledgeBaseId: string | undefined;
3593
+ /**
3594
+ * @public
3595
+ * <p>The name of the quick response.</p>
3596
+ */
3597
+ name: string | undefined;
3598
+ /**
3599
+ * @public
3600
+ * <p>The media type of the quick response content.</p>
3601
+ * <ul>
3602
+ * <li>
3603
+ * <p>Use <code>application/x.quickresponse;format=plain</code> for quick response written in plain text.</p>
3604
+ * </li>
3605
+ * <li>
3606
+ * <p>Use <code>application/x.quickresponse;format=markdown</code> for quick response written in richtext.</p>
3607
+ * </li>
3608
+ * </ul>
3609
+ */
3610
+ contentType: string | undefined;
3611
+ /**
3612
+ * @public
3613
+ * <p>The resource status of the quick response.</p>
3614
+ */
3615
+ status: QuickResponseStatus | undefined;
3616
+ /**
3617
+ * @public
3618
+ * <p>The contents of the quick response.</p>
3619
+ */
3620
+ contents: QuickResponseContents | undefined;
3621
+ /**
3622
+ * @public
3623
+ * <p>The timestamp when the quick response was created.</p>
3624
+ */
3625
+ createdTime: Date | undefined;
3626
+ /**
3627
+ * @public
3628
+ * <p>The timestamp when the quick response search result data was last modified.</p>
3629
+ */
3630
+ lastModifiedTime: Date | undefined;
3631
+ /**
3632
+ * @public
3633
+ * <p>Whether the quick response is active.</p>
3634
+ */
3635
+ isActive: boolean | undefined;
3636
+ /**
3637
+ * @public
3638
+ * <p>The description of the quick response.</p>
3639
+ */
3640
+ description?: string;
3641
+ /**
3642
+ * @public
3643
+ * <p>The configuration information of the user groups that the quick response is accessible to.</p>
3644
+ */
3645
+ groupingConfiguration?: GroupingConfiguration;
3646
+ /**
3647
+ * @public
3648
+ * <p>The shortcut key of the quick response. The value should be unique across the
3649
+ * knowledge base.</p>
3650
+ */
3651
+ shortcutKey?: string;
3652
+ /**
3653
+ * @public
3654
+ * <p>The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.</p>
3655
+ */
3656
+ lastModifiedBy?: string;
3657
+ /**
3658
+ * @public
3659
+ * <p>The Amazon Connect contact channels this quick response applies to. The supported contact channel types include <code>Chat</code>.</p>
3660
+ */
3661
+ channels?: string[];
3662
+ /**
3663
+ * @public
3664
+ * <p>The language code value for the language in which the quick response is written.</p>
3665
+ */
3666
+ language?: string;
3667
+ /**
3668
+ * @public
3669
+ * <p>The user defined contact attributes that are not resolved when the search result is returned.</p>
3670
+ */
3671
+ attributesNotInterpolated?: string[];
3672
+ /**
3673
+ * @public
3674
+ * <p>The user defined contact attributes that are resolved when the search result is returned.</p>
3675
+ */
3676
+ attributesInterpolated?: string[];
3677
+ /**
3678
+ * @public
3679
+ * <p>The tags used to organize, track, or control access for this resource.</p>
3680
+ */
3681
+ tags?: Record<string, string>;
3682
+ }
3683
+ /**
3684
+ * @public
3685
+ */
3686
+ export interface SearchQuickResponsesResponse {
3687
+ /**
3688
+ * @public
3689
+ * <p>The results of the quick response search.</p>
3690
+ */
3691
+ results: QuickResponseSearchResultData[] | undefined;
3692
+ /**
3693
+ * @public
3694
+ * <p>The token for the next set of results. Use the value returned in the previous
3695
+ * response in the next request to retrieve the next set of results.</p>
3696
+ */
3697
+ nextToken?: string;
3698
+ }
3699
+ /**
3700
+ * @public
3701
+ */
3702
+ export interface StartContentUploadRequest {
3703
+ /**
3704
+ * @public
3705
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3706
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3707
+ */
3708
+ knowledgeBaseId: string | undefined;
3709
+ /**
3710
+ * @public
3711
+ * <p>The type of content to upload.</p>
3712
+ */
3713
+ contentType: string | undefined;
3714
+ /**
3715
+ * @public
3716
+ * <p>The expected expiration time of the generated presigned URL, specified in minutes.</p>
3717
+ */
3718
+ presignedUrlTimeToLive?: number;
3719
+ }
3720
+ /**
3721
+ * @public
3722
+ */
3723
+ export interface StartContentUploadResponse {
3724
+ /**
3725
+ * @public
3726
+ * <p>The identifier of the upload.</p>
3727
+ */
3728
+ uploadId: string | undefined;
3729
+ /**
3730
+ * @public
3731
+ * <p>The URL of the upload.</p>
3732
+ */
3733
+ url: string | undefined;
3734
+ /**
3735
+ * @public
3736
+ * <p>The expiration time of the URL as an epoch timestamp.</p>
3737
+ */
3738
+ urlExpiry: Date | undefined;
3739
+ /**
3740
+ * @public
3741
+ * <p>The headers to include in the upload.</p>
3742
+ */
3743
+ headersToInclude: Record<string, string> | undefined;
3744
+ }
3745
+ /**
3746
+ * @public
3747
+ */
3748
+ export interface StartImportJobRequest {
3749
+ /**
3750
+ * @public
3751
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3752
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3753
+ * <ul>
3754
+ * <li>
3755
+ * <p>For importing Amazon Q quick responses, this should be a <code>QUICK_RESPONSES</code> type knowledge base.</p>
3756
+ * </li>
3757
+ * </ul>
3758
+ */
3759
+ knowledgeBaseId: string | undefined;
3760
+ /**
3761
+ * @public
3762
+ * <p>The type of the import job.</p>
3763
+ * <ul>
3764
+ * <li>
3765
+ * <p>For importing quick response resource, set the value to <code>QUICK_RESPONSES</code>.</p>
3766
+ * </li>
3767
+ * </ul>
3768
+ */
3769
+ importJobType: ImportJobType | undefined;
3770
+ /**
3771
+ * @public
3772
+ * <p>A pointer to the uploaded asset. This value is returned by <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html">StartContentUpload</a>.</p>
3773
+ */
3774
+ uploadId: string | undefined;
3775
+ /**
3776
+ * @public
3777
+ * <p>The tags used to organize, track, or control access for this resource.</p>
3778
+ */
3779
+ clientToken?: string;
3780
+ /**
3781
+ * @public
3782
+ * <p>The metadata fields of the imported Amazon Q resources.</p>
3783
+ */
3784
+ metadata?: Record<string, string>;
3785
+ /**
3786
+ * @public
3787
+ * <p>The configuration information of the external source that the resource data are imported from.</p>
3788
+ */
3789
+ externalSourceConfiguration?: ExternalSourceConfiguration;
3790
+ }
3791
+ /**
3792
+ * @public
3793
+ */
3794
+ export interface StartImportJobResponse {
3795
+ /**
3796
+ * @public
3797
+ * <p>The import job.</p>
3798
+ */
3799
+ importJob?: ImportJobData;
3800
+ }
3801
+ /**
3802
+ * @public
3803
+ */
3804
+ export interface UpdateKnowledgeBaseTemplateUriRequest {
3805
+ /**
3806
+ * @public
3807
+ * <p>The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge
3808
+ * base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.</p>
3809
+ */
3810
+ knowledgeBaseId: string | undefined;
3811
+ /**
3812
+ * @public
3813
+ * <p>The template URI to update.</p>
3814
+ */
3815
+ templateUri: string | undefined;
3816
+ }
3817
+ /**
3818
+ * @public
3819
+ */
3820
+ export interface UpdateKnowledgeBaseTemplateUriResponse {
3821
+ /**
3822
+ * @public
3823
+ * <p>The knowledge base to update.</p>
3824
+ */
3825
+ knowledgeBase?: KnowledgeBaseData;
3826
+ }
3827
+ /**
3828
+ * @public
3829
+ */
3830
+ export interface ListTagsForResourceRequest {
3831
+ /**
3832
+ * @public
3833
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
3834
+ */
3835
+ resourceArn: string | undefined;
3836
+ }
3837
+ /**
3838
+ * @public
3839
+ */
3840
+ export interface ListTagsForResourceResponse {
3841
+ /**
3842
+ * @public
3843
+ * <p>The tags used to organize, track, or control access for this resource.</p>
3844
+ */
3845
+ tags?: Record<string, string>;
3846
+ }
3847
+ /**
3848
+ * @public
3849
+ */
3850
+ export interface TagResourceRequest {
3851
+ /**
3852
+ * @public
3853
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
3854
+ */
3855
+ resourceArn: string | undefined;
3856
+ /**
3857
+ * @public
3858
+ * <p>The tags used to organize, track, or control access for this resource.</p>
3859
+ */
3860
+ tags: Record<string, string> | undefined;
3861
+ }
3862
+ /**
3863
+ * @public
3864
+ */
3865
+ export interface TagResourceResponse {
3866
+ }
3867
+ /**
3868
+ * @public
3869
+ * <p>Amazon Q in Connect throws this exception if you have too many tags in your tag set.</p>
3870
+ */
3871
+ export declare class TooManyTagsException extends __BaseException {
3872
+ readonly name: "TooManyTagsException";
3873
+ readonly $fault: "client";
3874
+ /**
3875
+ * @public
3876
+ * <p>The specified resource name.</p>
3877
+ */
3878
+ resourceName?: string;
3879
+ /**
3880
+ * @internal
3881
+ */
3882
+ constructor(opts: __ExceptionOptionType<TooManyTagsException, __BaseException>);
3883
+ }
3884
+ /**
3885
+ * @public
3886
+ */
3887
+ export interface UntagResourceRequest {
3888
+ /**
3889
+ * @public
3890
+ * <p>The Amazon Resource Name (ARN) of the resource.</p>
3891
+ */
3892
+ resourceArn: string | undefined;
3893
+ /**
3894
+ * @public
3895
+ * <p>The tag keys.</p>
3896
+ */
3897
+ tagKeys: string[] | undefined;
3898
+ }
3899
+ /**
3900
+ * @public
3901
+ */
3902
+ export interface UntagResourceResponse {
3903
+ }
3904
+ /**
3905
+ * @public
3906
+ * <p>Details about the data.</p>
3907
+ */
3908
+ export type DataDetails = DataDetails.ContentDataMember | DataDetails.GenerativeDataMember | DataDetails.SourceContentDataMember | DataDetails.$UnknownMember;
3909
+ /**
3910
+ * @public
3911
+ */
3912
+ export declare namespace DataDetails {
3913
+ /**
3914
+ * @public
3915
+ * <p>Details about the content data.</p>
3916
+ */
3917
+ interface ContentDataMember {
3918
+ contentData: ContentDataDetails;
3919
+ generativeData?: never;
3920
+ sourceContentData?: never;
3921
+ $unknown?: never;
3922
+ }
3923
+ /**
3924
+ * @public
3925
+ * <p> Details about the generative data.</p>
3926
+ */
3927
+ interface GenerativeDataMember {
3928
+ contentData?: never;
3929
+ generativeData: GenerativeDataDetails;
3930
+ sourceContentData?: never;
3931
+ $unknown?: never;
3932
+ }
3933
+ /**
3934
+ * @public
3935
+ * <p>Details about the content data.</p>
3936
+ */
3937
+ interface SourceContentDataMember {
3938
+ contentData?: never;
3939
+ generativeData?: never;
3940
+ sourceContentData: SourceContentDataDetails;
3941
+ $unknown?: never;
3942
+ }
3943
+ /**
3944
+ * @public
3945
+ */
3946
+ interface $UnknownMember {
3947
+ contentData?: never;
3948
+ generativeData?: never;
3949
+ sourceContentData?: never;
3950
+ $unknown: [string, any];
3951
+ }
3952
+ interface Visitor<T> {
3953
+ contentData: (value: ContentDataDetails) => T;
3954
+ generativeData: (value: GenerativeDataDetails) => T;
3955
+ sourceContentData: (value: SourceContentDataDetails) => T;
3956
+ _: (name: string, value: any) => T;
3957
+ }
3958
+ const visit: <T>(value: DataDetails, visitor: Visitor<T>) => T;
3959
+ }
3960
+ /**
3961
+ * @public
3962
+ * <p>Summary of the data.</p>
3963
+ */
3964
+ export interface DataSummary {
3965
+ /**
3966
+ * @public
3967
+ * <p>Reference information about the content.</p>
3968
+ */
3969
+ reference: DataReference | undefined;
3970
+ /**
3971
+ * @public
3972
+ * <p>Details about the data.</p>
3973
+ */
3974
+ details: DataDetails | undefined;
3975
+ }
3976
+ /**
3977
+ * @public
3978
+ * <p>Details about generative data.</p>
3979
+ */
3980
+ export interface GenerativeDataDetails {
3981
+ /**
3982
+ * @public
3983
+ * <p>The LLM response.</p>
3984
+ */
3985
+ completion: string | undefined;
3986
+ /**
3987
+ * @public
3988
+ * <p>The references used to generative the LLM response.</p>
3989
+ */
3990
+ references: DataSummary[] | undefined;
3991
+ /**
3992
+ * @public
3993
+ * <p>Details about the generative content ranking data.</p>
3994
+ */
3995
+ rankingData: RankingData | undefined;
3996
+ }
3997
+ /**
3998
+ * @public
3999
+ * <p>Information about the recommendation.</p>
4000
+ */
4001
+ export interface RecommendationData {
4002
+ /**
4003
+ * @public
4004
+ * <p>The identifier of the recommendation.</p>
4005
+ */
4006
+ recommendationId: string | undefined;
4007
+ /**
4008
+ * @public
4009
+ * <p>The recommended document.</p>
4010
+ */
4011
+ document?: Document;
4012
+ /**
4013
+ * @public
4014
+ * <p>The relevance score of the recommendation.</p>
4015
+ */
4016
+ relevanceScore?: number;
4017
+ /**
4018
+ * @public
4019
+ * <p>The relevance level of the recommendation.</p>
4020
+ */
4021
+ relevanceLevel?: RelevanceLevel;
4022
+ /**
4023
+ * @public
4024
+ * <p>The type of recommendation.</p>
4025
+ */
4026
+ type?: RecommendationType;
4027
+ /**
4028
+ * @public
4029
+ * <p> Summary of the recommended content.</p>
4030
+ */
4031
+ data?: DataSummary;
4032
+ }
4033
+ /**
4034
+ * @public
4035
+ * <p>Information about the result.</p>
4036
+ */
4037
+ export interface ResultData {
4038
+ /**
4039
+ * @public
4040
+ * <p>The identifier of the result data.</p>
4041
+ */
4042
+ resultId: string | undefined;
4043
+ /**
4044
+ * @public
4045
+ * <p>The document.</p>
4046
+ */
4047
+ document?: Document;
4048
+ /**
4049
+ * @public
4050
+ * <p>The relevance score of the results.</p>
4051
+ */
4052
+ relevanceScore?: number;
4053
+ /**
4054
+ * @public
4055
+ * <p> Summary of the recommended content.</p>
4056
+ */
4057
+ data?: DataSummary;
4058
+ /**
4059
+ * @public
4060
+ * <p>The type of the query result.</p>
4061
+ */
4062
+ type?: QueryResultType;
4063
+ }
4064
+ /**
4065
+ * @public
4066
+ */
4067
+ export interface GetRecommendationsResponse {
4068
+ /**
4069
+ * @public
4070
+ * <p>The recommendations.</p>
4071
+ */
4072
+ recommendations: RecommendationData[] | undefined;
4073
+ /**
4074
+ * @public
4075
+ * <p>The triggers corresponding to recommendations.</p>
4076
+ */
4077
+ triggers?: RecommendationTrigger[];
4078
+ }
4079
+ /**
4080
+ * @public
4081
+ */
4082
+ export interface QueryAssistantResponse {
4083
+ /**
4084
+ * @public
4085
+ * <p>The results of the query.</p>
4086
+ */
4087
+ results: ResultData[] | undefined;
4088
+ /**
4089
+ * @public
4090
+ * <p>If there are additional results, this is the token for the next set of results.</p>
4091
+ */
4092
+ nextToken?: string;
4093
+ }
4094
+ /**
4095
+ * @internal
4096
+ */
4097
+ export declare const DocumentTextFilterSensitiveLog: (obj: DocumentText) => any;
4098
+ /**
4099
+ * @internal
4100
+ */
4101
+ export declare const TextDataFilterSensitiveLog: (obj: TextData) => any;
4102
+ /**
4103
+ * @internal
4104
+ */
4105
+ export declare const ContentDataDetailsFilterSensitiveLog: (obj: ContentDataDetails) => any;
4106
+ /**
4107
+ * @internal
4108
+ */
4109
+ export declare const SourceContentDataDetailsFilterSensitiveLog: (obj: SourceContentDataDetails) => any;
4110
+ /**
4111
+ * @internal
4112
+ */
4113
+ export declare const DocumentFilterSensitiveLog: (obj: Document) => any;
4114
+ /**
4115
+ * @internal
4116
+ */
4117
+ export declare const QueryRecommendationTriggerDataFilterSensitiveLog: (obj: QueryRecommendationTriggerData) => any;
4118
+ /**
4119
+ * @internal
4120
+ */
4121
+ export declare const RecommendationTriggerDataFilterSensitiveLog: (obj: RecommendationTriggerData) => any;
4122
+ /**
4123
+ * @internal
4124
+ */
4125
+ export declare const RecommendationTriggerFilterSensitiveLog: (obj: RecommendationTrigger) => any;
4126
+ /**
4127
+ * @internal
4128
+ */
4129
+ export declare const QueryAssistantRequestFilterSensitiveLog: (obj: QueryAssistantRequest) => any;
4130
+ /**
4131
+ * @internal
4132
+ */
4133
+ export declare const ContentDataFilterSensitiveLog: (obj: ContentData) => any;
4134
+ /**
4135
+ * @internal
4136
+ */
4137
+ export declare const CreateContentResponseFilterSensitiveLog: (obj: CreateContentResponse) => any;
4138
+ /**
4139
+ * @internal
4140
+ */
4141
+ export declare const GetContentResponseFilterSensitiveLog: (obj: GetContentResponse) => any;
4142
+ /**
4143
+ * @internal
4144
+ */
4145
+ export declare const UpdateContentResponseFilterSensitiveLog: (obj: UpdateContentResponse) => any;
4146
+ /**
4147
+ * @internal
4148
+ */
4149
+ export declare const QuickResponseDataProviderFilterSensitiveLog: (obj: QuickResponseDataProvider) => any;
4150
+ /**
4151
+ * @internal
4152
+ */
4153
+ export declare const GroupingConfigurationFilterSensitiveLog: (obj: GroupingConfiguration) => any;
4154
+ /**
4155
+ * @internal
4156
+ */
4157
+ export declare const CreateQuickResponseRequestFilterSensitiveLog: (obj: CreateQuickResponseRequest) => any;
4158
+ /**
4159
+ * @internal
4160
+ */
4161
+ export declare const QuickResponseContentProviderFilterSensitiveLog: (obj: QuickResponseContentProvider) => any;
4162
+ /**
4163
+ * @internal
4164
+ */
4165
+ export declare const QuickResponseContentsFilterSensitiveLog: (obj: QuickResponseContents) => any;
4166
+ /**
4167
+ * @internal
4168
+ */
4169
+ export declare const QuickResponseDataFilterSensitiveLog: (obj: QuickResponseData) => any;
4170
+ /**
4171
+ * @internal
4172
+ */
4173
+ export declare const CreateQuickResponseResponseFilterSensitiveLog: (obj: CreateQuickResponseResponse) => any;
4174
+ /**
4175
+ * @internal
4176
+ */
4177
+ export declare const ImportJobDataFilterSensitiveLog: (obj: ImportJobData) => any;
4178
+ /**
4179
+ * @internal
4180
+ */
4181
+ export declare const GetImportJobResponseFilterSensitiveLog: (obj: GetImportJobResponse) => any;
4182
+ /**
4183
+ * @internal
4184
+ */
4185
+ export declare const GetQuickResponseResponseFilterSensitiveLog: (obj: GetQuickResponseResponse) => any;
4186
+ /**
4187
+ * @internal
4188
+ */
4189
+ export declare const QuickResponseSummaryFilterSensitiveLog: (obj: QuickResponseSummary) => any;
4190
+ /**
4191
+ * @internal
4192
+ */
4193
+ export declare const ListQuickResponsesResponseFilterSensitiveLog: (obj: ListQuickResponsesResponse) => any;
4194
+ /**
4195
+ * @internal
4196
+ */
4197
+ export declare const UpdateQuickResponseRequestFilterSensitiveLog: (obj: UpdateQuickResponseRequest) => any;
4198
+ /**
4199
+ * @internal
4200
+ */
4201
+ export declare const UpdateQuickResponseResponseFilterSensitiveLog: (obj: UpdateQuickResponseResponse) => any;
4202
+ /**
4203
+ * @internal
4204
+ */
4205
+ export declare const SearchQuickResponsesRequestFilterSensitiveLog: (obj: SearchQuickResponsesRequest) => any;
4206
+ /**
4207
+ * @internal
4208
+ */
4209
+ export declare const QuickResponseSearchResultDataFilterSensitiveLog: (obj: QuickResponseSearchResultData) => any;
4210
+ /**
4211
+ * @internal
4212
+ */
4213
+ export declare const SearchQuickResponsesResponseFilterSensitiveLog: (obj: SearchQuickResponsesResponse) => any;
4214
+ /**
4215
+ * @internal
4216
+ */
4217
+ export declare const StartContentUploadResponseFilterSensitiveLog: (obj: StartContentUploadResponse) => any;
4218
+ /**
4219
+ * @internal
4220
+ */
4221
+ export declare const StartImportJobResponseFilterSensitiveLog: (obj: StartImportJobResponse) => any;
4222
+ /**
4223
+ * @internal
4224
+ */
4225
+ export declare const DataDetailsFilterSensitiveLog: (obj: DataDetails) => any;
4226
+ /**
4227
+ * @internal
4228
+ */
4229
+ export declare const DataSummaryFilterSensitiveLog: (obj: DataSummary) => any;
4230
+ /**
4231
+ * @internal
4232
+ */
4233
+ export declare const GenerativeDataDetailsFilterSensitiveLog: (obj: GenerativeDataDetails) => any;
4234
+ /**
4235
+ * @internal
4236
+ */
4237
+ export declare const RecommendationDataFilterSensitiveLog: (obj: RecommendationData) => any;
4238
+ /**
4239
+ * @internal
4240
+ */
4241
+ export declare const ResultDataFilterSensitiveLog: (obj: ResultData) => any;
4242
+ /**
4243
+ * @internal
4244
+ */
4245
+ export declare const GetRecommendationsResponseFilterSensitiveLog: (obj: GetRecommendationsResponse) => any;
4246
+ /**
4247
+ * @internal
4248
+ */
4249
+ export declare const QueryAssistantResponseFilterSensitiveLog: (obj: QueryAssistantResponse) => any;