@carbon/ai-chat 0.2.0-1 → 0.2.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 (273) hide show
  1. package/dist/docs/carbon-chat-docs.js +2 -0
  2. package/dist/docs/carbon-chat-docs.js.LICENSE.txt +118 -0
  3. package/dist/docs/carbon-chat.html +8 -0
  4. package/dist/docs/carbon-tsdocs/.nojekyll +1 -0
  5. package/dist/docs/carbon-tsdocs/assets/hierarchy.js +1 -0
  6. package/dist/docs/carbon-tsdocs/assets/highlight.css +22 -0
  7. package/dist/docs/carbon-tsdocs/assets/icons.js +18 -0
  8. package/dist/docs/carbon-tsdocs/assets/icons.svg +1 -0
  9. package/dist/docs/carbon-tsdocs/assets/main.js +60 -0
  10. package/dist/docs/carbon-tsdocs/assets/navigation.js +1 -0
  11. package/dist/docs/carbon-tsdocs/assets/search.js +1 -0
  12. package/dist/docs/carbon-tsdocs/assets/style.css +1611 -0
  13. package/dist/docs/carbon-tsdocs/enums/AgentMessageType.html +20 -0
  14. package/dist/docs/carbon-tsdocs/enums/AgentsOnlineStatus.html +9 -0
  15. package/dist/docs/carbon-tsdocs/enums/BusEventType.html +67 -0
  16. package/dist/docs/carbon-tsdocs/enums/ButtonItemKind.html +6 -0
  17. package/dist/docs/carbon-tsdocs/enums/ButtonItemType.html +5 -0
  18. package/dist/docs/carbon-tsdocs/enums/CarbonTheme.html +7 -0
  19. package/dist/docs/carbon-tsdocs/enums/CatastrophicErrorType.html +11 -0
  20. package/dist/docs/carbon-tsdocs/enums/ChainOfThoughtStepStatus.html +5 -0
  21. package/dist/docs/carbon-tsdocs/enums/ChatHeaderObjectType.html +6 -0
  22. package/dist/docs/carbon-tsdocs/enums/CornersType.html +4 -0
  23. package/dist/docs/carbon-tsdocs/enums/CustomEventType.html +3 -0
  24. package/dist/docs/carbon-tsdocs/enums/ErrorType.html +12 -0
  25. package/dist/docs/carbon-tsdocs/enums/FeedbackInteractionType.html +10 -0
  26. package/dist/docs/carbon-tsdocs/enums/FileStatusValue.html +6 -0
  27. package/dist/docs/carbon-tsdocs/enums/HomeScreenBackgroundType.html +6 -0
  28. package/dist/docs/carbon-tsdocs/enums/IFrameItemDisplayOption.html +6 -0
  29. package/dist/docs/carbon-tsdocs/enums/LauncherType.html +6 -0
  30. package/dist/docs/carbon-tsdocs/enums/MessageInputType.html +8 -0
  31. package/dist/docs/carbon-tsdocs/enums/MessageResponseTypes.html +36 -0
  32. package/dist/docs/carbon-tsdocs/enums/MessageSendSource.html +45 -0
  33. package/dist/docs/carbon-tsdocs/enums/MinimizeButtonIconType.html +9 -0
  34. package/dist/docs/carbon-tsdocs/enums/OnErrorType.html +27 -0
  35. package/dist/docs/carbon-tsdocs/enums/OptionItemPreference.html +6 -0
  36. package/dist/docs/carbon-tsdocs/enums/ScreenShareState.html +10 -0
  37. package/dist/docs/carbon-tsdocs/enums/TourEndReason.html +5 -0
  38. package/dist/docs/carbon-tsdocs/enums/TourStartReason.html +9 -0
  39. package/dist/docs/carbon-tsdocs/enums/ViewChangeReason.html +47 -0
  40. package/dist/docs/carbon-tsdocs/enums/ViewType.html +10 -0
  41. package/dist/docs/carbon-tsdocs/enums/WriteableElementName.html +16 -0
  42. package/dist/docs/carbon-tsdocs/functions/ChatContainer.html +10 -0
  43. package/dist/docs/carbon-tsdocs/functions/ChatCustomElement.html +8 -0
  44. package/dist/docs/carbon-tsdocs/hierarchy.html +1 -0
  45. package/dist/docs/carbon-tsdocs/index.html +1 -0
  46. package/dist/docs/carbon-tsdocs/interfaces/AdditionalDataToAgent.html +5 -0
  47. package/dist/docs/carbon-tsdocs/interfaces/AgentAppConfig.html +8 -0
  48. package/dist/docs/carbon-tsdocs/interfaces/AgentAppInfo.html +6 -0
  49. package/dist/docs/carbon-tsdocs/interfaces/AgentAvailability.html +12 -0
  50. package/dist/docs/carbon-tsdocs/interfaces/AgentProfile.html +12 -0
  51. package/dist/docs/carbon-tsdocs/interfaces/BaseMessageInput.html +3 -0
  52. package/dist/docs/carbon-tsdocs/interfaces/BusEvent.html +3 -0
  53. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentAreAnyAgentsOnline.html +8 -0
  54. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentEndChat.html +10 -0
  55. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreEndChat.html +12 -0
  56. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreReceive.html +5 -0
  57. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreSend.html +5 -0
  58. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreSessionHistory.html +8 -0
  59. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreStartChat.html +13 -0
  60. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentReceive.html +5 -0
  61. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentSend.html +5 -0
  62. package/dist/docs/carbon-tsdocs/interfaces/BusEventChatReady.html +3 -0
  63. package/dist/docs/carbon-tsdocs/interfaces/BusEventChunkUserDefinedResponse.html +39 -0
  64. package/dist/docs/carbon-tsdocs/interfaces/BusEventClosePanelButtonClicked.html +4 -0
  65. package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelClose.html +3 -0
  66. package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelOpen.html +3 -0
  67. package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelPreClose.html +3 -0
  68. package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelPreOpen.html +3 -0
  69. package/dist/docs/carbon-tsdocs/interfaces/BusEventFeedback.html +17 -0
  70. package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerAuthError.html +5 -0
  71. package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerAuthProvider.html +5 -0
  72. package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerGetAuthCode.html +5 -0
  73. package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerLoggedOut.html +5 -0
  74. package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerReauthenticate.html +5 -0
  75. package/dist/docs/carbon-tsdocs/interfaces/BusEventHistoryBegin.html +15 -0
  76. package/dist/docs/carbon-tsdocs/interfaces/BusEventHistoryEnd.html +11 -0
  77. package/dist/docs/carbon-tsdocs/interfaces/BusEventMessageItemCustom.html +11 -0
  78. package/dist/docs/carbon-tsdocs/interfaces/BusEventNiceDFOGetAuthCode.html +7 -0
  79. package/dist/docs/carbon-tsdocs/interfaces/BusEventPreReceive.html +11 -0
  80. package/dist/docs/carbon-tsdocs/interfaces/BusEventPreReset.html +3 -0
  81. package/dist/docs/carbon-tsdocs/interfaces/BusEventPreSend.html +8 -0
  82. package/dist/docs/carbon-tsdocs/interfaces/BusEventReceive.html +4 -0
  83. package/dist/docs/carbon-tsdocs/interfaces/BusEventReset.html +3 -0
  84. package/dist/docs/carbon-tsdocs/interfaces/BusEventSend.html +8 -0
  85. package/dist/docs/carbon-tsdocs/interfaces/BusEventTourEnd.html +7 -0
  86. package/dist/docs/carbon-tsdocs/interfaces/BusEventTourStart.html +8 -0
  87. package/dist/docs/carbon-tsdocs/interfaces/BusEventTourStep.html +8 -0
  88. package/dist/docs/carbon-tsdocs/interfaces/BusEventUserDefinedResponse.html +10 -0
  89. package/dist/docs/carbon-tsdocs/interfaces/BusEventViewChange.html +13 -0
  90. package/dist/docs/carbon-tsdocs/interfaces/BusEventViewPreChange.html +12 -0
  91. package/dist/docs/carbon-tsdocs/interfaces/ButtonItem.html +34 -0
  92. package/dist/docs/carbon-tsdocs/interfaces/CarouselItem.html +15 -0
  93. package/dist/docs/carbon-tsdocs/interfaces/ChainOfThoughtStep.html +20 -0
  94. package/dist/docs/carbon-tsdocs/interfaces/ChatContainerProps.html +14 -0
  95. package/dist/docs/carbon-tsdocs/interfaces/ChatCustomElementProps.html +31 -0
  96. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderAvatarConfig.html +6 -0
  97. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderButton.html +8 -0
  98. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderConfig.html +9 -0
  99. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderGroupMenu.html +13 -0
  100. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderGroupMenuItem.html +8 -0
  101. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderLink.html +10 -0
  102. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderMenu.html +9 -0
  103. package/dist/docs/carbon-tsdocs/interfaces/ChatInstance.html +146 -0
  104. package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceMessaging.html +16 -0
  105. package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceNotifications.html +7 -0
  106. package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceServiceDeskActions.html +13 -0
  107. package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceTours.html +13 -0
  108. package/dist/docs/carbon-tsdocs/interfaces/Chunk.html +5 -0
  109. package/dist/docs/carbon-tsdocs/interfaces/CompleteItemChunk.html +9 -0
  110. package/dist/docs/carbon-tsdocs/interfaces/ConnectToAgentItem.html +24 -0
  111. package/dist/docs/carbon-tsdocs/interfaces/ConnectToAgentItemTransferInfo.html +9 -0
  112. package/dist/docs/carbon-tsdocs/interfaces/ConnectingErrorInfo.html +12 -0
  113. package/dist/docs/carbon-tsdocs/interfaces/ConversationalSearchItem.html +22 -0
  114. package/dist/docs/carbon-tsdocs/interfaces/ConversationalSearchItemCitation.html +18 -0
  115. package/dist/docs/carbon-tsdocs/interfaces/CustomMenuOption.html +6 -0
  116. package/dist/docs/carbon-tsdocs/interfaces/CustomPanelConfigOptions.html +29 -0
  117. package/dist/docs/carbon-tsdocs/interfaces/CustomPanelInstance.html +9 -0
  118. package/dist/docs/carbon-tsdocs/interfaces/CustomPanels.html +4 -0
  119. package/dist/docs/carbon-tsdocs/interfaces/CustomSendMessageOptions.html +3 -0
  120. package/dist/docs/carbon-tsdocs/interfaces/DisclaimerPublicConfig.html +5 -0
  121. package/dist/docs/carbon-tsdocs/interfaces/DisconnectedErrorInfo.html +11 -0
  122. package/dist/docs/carbon-tsdocs/interfaces/EndChatInfo.html +8 -0
  123. package/dist/docs/carbon-tsdocs/interfaces/EventHandlers.html +16 -0
  124. package/dist/docs/carbon-tsdocs/interfaces/EventInput.html +6 -0
  125. package/dist/docs/carbon-tsdocs/interfaces/EventInputData.html +6 -0
  126. package/dist/docs/carbon-tsdocs/interfaces/FileUpload.html +12 -0
  127. package/dist/docs/carbon-tsdocs/interfaces/FinalResponseChunk.html +6 -0
  128. package/dist/docs/carbon-tsdocs/interfaces/GenericItem.html +14 -0
  129. package/dist/docs/carbon-tsdocs/interfaces/GenericItemMessageFeedbackOptions.html +27 -0
  130. package/dist/docs/carbon-tsdocs/interfaces/GenericItemMessageOptions.html +6 -0
  131. package/dist/docs/carbon-tsdocs/interfaces/GenesysMessengerConfig.html +8 -0
  132. package/dist/docs/carbon-tsdocs/interfaces/GridItem.html +23 -0
  133. package/dist/docs/carbon-tsdocs/interfaces/HasAddRemoveClassName.html +6 -0
  134. package/dist/docs/carbon-tsdocs/interfaces/HeaderConfig.html +9 -0
  135. package/dist/docs/carbon-tsdocs/interfaces/HistoryItem.html +6 -0
  136. package/dist/docs/carbon-tsdocs/interfaces/HomeScreenConfig.html +14 -0
  137. package/dist/docs/carbon-tsdocs/interfaces/HomeScreenStarterButton.html +7 -0
  138. package/dist/docs/carbon-tsdocs/interfaces/HomeScreenStarterButtons.html +4 -0
  139. package/dist/docs/carbon-tsdocs/interfaces/IFrameItem.html +27 -0
  140. package/dist/docs/carbon-tsdocs/interfaces/InlineErrorItem.html +22 -0
  141. package/dist/docs/carbon-tsdocs/interfaces/InstanceElements.html +8 -0
  142. package/dist/docs/carbon-tsdocs/interfaces/InstanceInputElement.html +13 -0
  143. package/dist/docs/carbon-tsdocs/interfaces/ItemStreamingMetadata.html +12 -0
  144. package/dist/docs/carbon-tsdocs/interfaces/LayoutConfig.html +7 -0
  145. package/dist/docs/carbon-tsdocs/interfaces/MediaItem.html +27 -0
  146. package/dist/docs/carbon-tsdocs/interfaces/MediaItemDimensions.html +6 -0
  147. package/dist/docs/carbon-tsdocs/interfaces/MessageContext.html +9 -0
  148. package/dist/docs/carbon-tsdocs/interfaces/MessageGlobalContext.html +3 -0
  149. package/dist/docs/carbon-tsdocs/interfaces/MessageHistory.html +18 -0
  150. package/dist/docs/carbon-tsdocs/interfaces/MessageInput.html +11 -0
  151. package/dist/docs/carbon-tsdocs/interfaces/MessageItemPanelInfo.html +11 -0
  152. package/dist/docs/carbon-tsdocs/interfaces/MessageOutput.html +4 -0
  153. package/dist/docs/carbon-tsdocs/interfaces/MessageRequest.html +12 -0
  154. package/dist/docs/carbon-tsdocs/interfaces/MessageResponse.html +12 -0
  155. package/dist/docs/carbon-tsdocs/interfaces/MessageSkillContext.html +3 -0
  156. package/dist/docs/carbon-tsdocs/interfaces/MessageSystemContext.html +5 -0
  157. package/dist/docs/carbon-tsdocs/interfaces/NiceDFOConfig.html +14 -0
  158. package/dist/docs/carbon-tsdocs/interfaces/NotificationMessage.html +15 -0
  159. package/dist/docs/carbon-tsdocs/interfaces/OnErrorData.html +13 -0
  160. package/dist/docs/carbon-tsdocs/interfaces/Option.html +7 -0
  161. package/dist/docs/carbon-tsdocs/interfaces/OptionItem.html +23 -0
  162. package/dist/docs/carbon-tsdocs/interfaces/PageLinkConfig.html +6 -0
  163. package/dist/docs/carbon-tsdocs/interfaces/PageLinkIDConfig.html +5 -0
  164. package/dist/docs/carbon-tsdocs/interfaces/PartialItemChunk.html +38 -0
  165. package/dist/docs/carbon-tsdocs/interfaces/PauseItem.html +18 -0
  166. package/dist/docs/carbon-tsdocs/interfaces/PublicConfig.html +80 -0
  167. package/dist/docs/carbon-tsdocs/interfaces/PublicConfigMessaging.html +24 -0
  168. package/dist/docs/carbon-tsdocs/interfaces/PublicWebChatServiceDeskState.html +8 -0
  169. package/dist/docs/carbon-tsdocs/interfaces/PublicWebChatState.html +21 -0
  170. package/dist/docs/carbon-tsdocs/interfaces/RenderUserDefinedState.html +41 -0
  171. package/dist/docs/carbon-tsdocs/interfaces/SendOptions.html +10 -0
  172. package/dist/docs/carbon-tsdocs/interfaces/ServiceDesk.html +74 -0
  173. package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskCallback.html +81 -0
  174. package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskCapabilities.html +9 -0
  175. package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskFactoryParameters.html +8 -0
  176. package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskPublicConfig.html +25 -0
  177. package/dist/docs/carbon-tsdocs/interfaces/StartChatOptions.html +6 -0
  178. package/dist/docs/carbon-tsdocs/interfaces/TableItem.html +22 -0
  179. package/dist/docs/carbon-tsdocs/interfaces/TableItemRow.html +5 -0
  180. package/dist/docs/carbon-tsdocs/interfaces/TextItem.html +19 -0
  181. package/dist/docs/carbon-tsdocs/interfaces/ThemeConfig.html +6 -0
  182. package/dist/docs/carbon-tsdocs/interfaces/TourStepGenericItem.html +17 -0
  183. package/dist/docs/carbon-tsdocs/interfaces/TypeAndHandler.html +6 -0
  184. package/dist/docs/carbon-tsdocs/interfaces/UpdateHistoryEvent.html +10 -0
  185. package/dist/docs/carbon-tsdocs/interfaces/UserDefinedItem.html +13 -0
  186. package/dist/docs/carbon-tsdocs/interfaces/UserMessageErrorInfo.html +8 -0
  187. package/dist/docs/carbon-tsdocs/interfaces/ViewState.html +8 -0
  188. package/dist/docs/carbon-tsdocs/interfaces/WithBodyAndFooter.html +5 -0
  189. package/dist/docs/carbon-tsdocs/types/AudioItem.html +2 -0
  190. package/dist/docs/carbon-tsdocs/types/CardItem.html +1 -0
  191. package/dist/docs/carbon-tsdocs/types/ChangeFunction.html +1 -0
  192. package/dist/docs/carbon-tsdocs/types/ChatHeaderMenuItemTypes.html +2 -0
  193. package/dist/docs/carbon-tsdocs/types/ChatHeaderObjectTypes.html +2 -0
  194. package/dist/docs/carbon-tsdocs/types/DateItem.html +3 -0
  195. package/dist/docs/carbon-tsdocs/types/EventBusHandler.html +3 -0
  196. package/dist/docs/carbon-tsdocs/types/HorizontalCellAlignment.html +1 -0
  197. package/dist/docs/carbon-tsdocs/types/ImageItem.html +2 -0
  198. package/dist/docs/carbon-tsdocs/types/IncreaseOrDecrease.html +1 -0
  199. package/dist/docs/carbon-tsdocs/types/Message.html +2 -0
  200. package/dist/docs/carbon-tsdocs/types/PartialOrCompleteItemChunk.html +1 -0
  201. package/dist/docs/carbon-tsdocs/types/RenderUserDefinedResponse.html +6 -0
  202. package/dist/docs/carbon-tsdocs/types/RenderWriteableElementResponse.html +2 -0
  203. package/dist/docs/carbon-tsdocs/types/ServiceDeskErrorInfo.html +3 -0
  204. package/dist/docs/carbon-tsdocs/types/StreamChunk.html +1 -0
  205. package/dist/docs/carbon-tsdocs/types/TableItemCell.html +1 -0
  206. package/dist/docs/carbon-tsdocs/types/TableItemRowExpandableSectionItem.html +1 -0
  207. package/dist/docs/carbon-tsdocs/types/VerticalCellAlignment.html +1 -0
  208. package/dist/docs/carbon-tsdocs/types/VideoItem.html +2 -0
  209. package/dist/docs/carbon-tsdocs/types/WriteableElements.html +3 -0
  210. package/dist/es/AppContainer.js +54 -34
  211. package/dist/es/Carousel.js +2 -2
  212. package/dist/es/GenesysMessengerServiceDesk.js +2 -2
  213. package/dist/es/HumanAgentServiceImpl.js +2 -2
  214. package/dist/es/NiceDFOServiceDesk.js +2 -2
  215. package/dist/es/PDFViewerContainer.js +2 -2
  216. package/dist/es/ReactPlayer.js +2 -2
  217. package/dist/es/SFServiceDesk.js +2 -2
  218. package/dist/es/ServiceDeskImpl.js +2 -2
  219. package/dist/es/Table.js +2 -2
  220. package/dist/es/ZendeskServiceDesk.js +2 -2
  221. package/dist/es/_node-resolve_empty.js +2 -2
  222. package/dist/es/aiChatEntry.js +2 -2
  223. package/dist/es/ar-dz.js +2 -2
  224. package/dist/es/ar-kw.js +2 -2
  225. package/dist/es/ar-ly.js +2 -2
  226. package/dist/es/ar-ma.js +2 -2
  227. package/dist/es/ar-sa.js +2 -2
  228. package/dist/es/ar-tn.js +2 -2
  229. package/dist/es/ar.js +2 -2
  230. package/dist/es/ar2.js +2 -2
  231. package/dist/es/cds-aichat-container.js +2 -2
  232. package/dist/es/cds-aichat-custom-element.js +2 -2
  233. package/dist/es/cs.js +2 -2
  234. package/dist/es/cs2.js +2 -2
  235. package/dist/es/de-at.js +2 -2
  236. package/dist/es/de-ch.js +2 -2
  237. package/dist/es/de.js +2 -2
  238. package/dist/es/de2.js +2 -2
  239. package/dist/es/en-au.js +2 -2
  240. package/dist/es/en-ca.js +2 -2
  241. package/dist/es/en-gb.js +2 -2
  242. package/dist/es/en-ie.js +2 -2
  243. package/dist/es/en-il.js +2 -2
  244. package/dist/es/en-nz.js +2 -2
  245. package/dist/es/es-do.js +2 -2
  246. package/dist/es/es-us.js +2 -2
  247. package/dist/es/es.js +2 -2
  248. package/dist/es/es2.js +2 -2
  249. package/dist/es/export.js +2 -2
  250. package/dist/es/export.legacy.js +2 -2
  251. package/dist/es/fr-ca.js +2 -2
  252. package/dist/es/fr-ch.js +2 -2
  253. package/dist/es/fr.js +2 -2
  254. package/dist/es/fr2.js +2 -2
  255. package/dist/es/it-ch.js +2 -2
  256. package/dist/es/it.js +2 -2
  257. package/dist/es/it2.js +2 -2
  258. package/dist/es/ja.js +2 -2
  259. package/dist/es/ja2.js +2 -2
  260. package/dist/es/ko.js +2 -2
  261. package/dist/es/ko2.js +2 -2
  262. package/dist/es/mockServiceDesk.js +2 -2
  263. package/dist/es/nl.js +2 -2
  264. package/dist/es/nl2.js +2 -2
  265. package/dist/es/pt-br.js +2 -2
  266. package/dist/es/pt-br2.js +2 -2
  267. package/dist/es/pt.js +2 -2
  268. package/dist/es/scriptRender.js +2 -2
  269. package/dist/es/zh-cn.js +2 -2
  270. package/dist/es/zh-tw.js +2 -2
  271. package/dist/es/zh-tw2.js +2 -2
  272. package/dist/es/zh.js +2 -2
  273. package/package.json +1 -1
package/dist/docs/carbon-tsdocs/interfaces/ConversationalSearchItem.html ADDED
@@ -0,0 +1,22 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ConversationalSearchItem | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="ConversationalSearchItem.html">ConversationalSearchItem</a></li></ul><h1>Interface ConversationalSearchItem&lt;TUserDefinedType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A text response generated by AI with an optional list of citations for where the information came from.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ConversationalSearchItem</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ConversationalSearchItem.html#tuserdefinedtype">TUserDefinedType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItem.html#agent_message_type">agent_message_type</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/AgentMessageType.html" class="tsd-signature-type tsd-kind-enum">AgentMessageType</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItem.html#citations">citations</a><span class="tsd-signature-symbol">?:</span> <a href="ConversationalSearchItemCitation.html" class="tsd-signature-type tsd-kind-interface">ConversationalSearchItemCitation</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItem.html#citations_title">citations_title</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItem.html#disclaimer">disclaimer</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItem.html#message_options">message_options</a><span class="tsd-signature-symbol">?:</span> <a href="GenericItemMessageOptions.html" class="tsd-signature-type tsd-kind-interface">GenericItemMessageOptions</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItem.html#response_type">response_type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/MessageResponseTypes.html" class="tsd-signature-type tsd-kind-enum">MessageResponseTypes</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItem.html#streaming_metadata">streaming_metadata</a><span class="tsd-signature-symbol">?:</span> <a href="ItemStreamingMetadata.html" class="tsd-signature-type tsd-kind-interface">ItemStreamingMetadata</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItem.html#text">text</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItem.html#user_defined">user_defined</a><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="ConversationalSearchItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tuserdefinedtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TUserDefinedType</span> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="931"><h4>Hierarchy (<a href="../hierarchy.html#ConversationalSearchItem">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ConversationalSearchItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ConversationalSearchItem</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ConversationalSearchItem.html#agent_message_type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent_<wbr/>message_<wbr/>type?</span></a>
3
+ <a href="ConversationalSearchItem.html#citations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>citations?</span></a>
4
+ <a href="ConversationalSearchItem.html#citations_title" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>citations_<wbr/>title</span></a>
5
+ <a href="ConversationalSearchItem.html#disclaimer" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disclaimer</span></a>
6
+ <a href="ConversationalSearchItem.html#message_options" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message_<wbr/>options?</span></a>
7
+ <a href="ConversationalSearchItem.html#response_type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response_<wbr/>type</span></a>
8
+ <a href="ConversationalSearchItem.html#streaming_metadata" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>streaming_<wbr/>metadata?</span></a>
9
+ <a href="ConversationalSearchItem.html#text" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a>
10
+ <a href="ConversationalSearchItem.html#user_defined" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>user_<wbr/>defined?</span></a>
11
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="agent_message_type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>agent_<wbr/>message_<wbr/>type</span><a href="#agent_message_type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">agent_message_type</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/AgentMessageType.html" class="tsd-signature-type tsd-kind-enum">AgentMessageType</a></div><div class="tsd-comment tsd-typography"><p>For messages that are sent between the user and a human agent, we assign an agent type to the message to distinguish what type it is.</p>
12
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GenericItem.html">GenericItem</a>.<a href="GenericItem.html#agent_message_type">agent_message_type</a></p></aside></section><section class="tsd-panel tsd-member"><a id="citations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>citations</span><a href="#citations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">citations</span><span class="tsd-signature-symbol">?:</span> <a href="ConversationalSearchItemCitation.html" class="tsd-signature-type tsd-kind-interface">ConversationalSearchItemCitation</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Citations are used to connect specific text within a conversational search response with the relevant documents
13
+ returned by the backend.</p>
14
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="citations_title" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>citations_<wbr/>title</span><a href="#citations_title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">citations_title</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A title to display above the citation list, default set to &quot;How do we know?&quot;.</p>
15
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="disclaimer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disclaimer</span><a href="#disclaimer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disclaimer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A string to explain that these results are generated, default set to &quot;Accuracy of generated answers may vary.&quot;.</p>
16
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="message_options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>message_<wbr/>options</span><a href="#message_options" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">message_options</span><span class="tsd-signature-symbol">?:</span> <a href="GenericItemMessageOptions.html" class="tsd-signature-type tsd-kind-interface">GenericItemMessageOptions</a></div><div class="tsd-comment tsd-typography"><p>Options that control additional features available for a message item.</p>
17
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GenericItem.html">GenericItem</a>.<a href="GenericItem.html#message_options">message_options</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="response_type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>response_<wbr/>type</span><a href="#response_type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response_type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MessageResponseTypes.html" class="tsd-signature-type tsd-kind-enum">MessageResponseTypes</a></div><div class="tsd-comment tsd-typography"><p>The response type of this message item.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GenericItem.html">GenericItem</a>.<a href="GenericItem.html#response_type">response_type</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="streaming_metadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>streaming_<wbr/>metadata</span><a href="#streaming_metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">streaming_metadata</span><span class="tsd-signature-symbol">?:</span> <a href="ItemStreamingMetadata.html" class="tsd-signature-type tsd-kind-interface">ItemStreamingMetadata</a></div><div class="tsd-comment tsd-typography"><p>Metadata used identify a generic item within the context of a stream in order to correlate any updates meant
19
+ for a specific item.</p>
20
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GenericItem.html">GenericItem</a>.<a href="GenericItem.html#streaming_metadata">streaming_metadata</a></p></aside></section><section class="tsd-panel tsd-member"><a id="text" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>text</span><a href="#text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The returned conversational text. Any HTML/Markdown will be ignored.</p>
21
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="user_defined" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>user_<wbr/>defined</span><a href="#user_defined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">user_defined</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="ConversationalSearchItem.html#tuserdefinedtype">TUserDefinedType</a></div><div class="tsd-comment tsd-typography"><p>An optional buckets of additional user defined properties for this item.</p>
22
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GenericItem.html">GenericItem</a>.<a href="GenericItem.html#user_defined">user_defined</a></p></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#agent_message_type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent_<wbr/>message_<wbr/>type</span></a><a href="#citations" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>citations</span></a><a href="#citations_title" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>citations_<wbr/>title</span></a><a href="#disclaimer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disclaimer</span></a><a href="#message_options" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message_<wbr/>options</span></a><a href="#response_type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response_<wbr/>type</span></a><a href="#streaming_metadata" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>streaming_<wbr/>metadata</span></a><a href="#text" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a><a href="#user_defined" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>user_<wbr/>defined</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/carbon-tsdocs/interfaces/ConversationalSearchItemCitation.html ADDED
@@ -0,0 +1,18 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ConversationalSearchItemCitation | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="ConversationalSearchItemCitation.html">ConversationalSearchItemCitation</a></li></ul><h1>Interface ConversationalSearchItemCitation</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Citations for text generated by an AI to provide the user with relevant source information and context.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ConversationalSearchItemCitation</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItemCitation.html#range_end">range_end</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItemCitation.html#range_start">range_start</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItemCitation.html#ranges">ranges</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItemCitation.html#search_result_idx">search_result_idx</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItemCitation.html#text">text</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItemCitation.html#title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ConversationalSearchItemCitation.html#url">url</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="ConversationalSearchItemCitation.html#range_end" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>range_<wbr/>end?</span></a>
3
+ <a href="ConversationalSearchItemCitation.html#range_start" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>range_<wbr/>start?</span></a>
4
+ <a href="ConversationalSearchItemCitation.html#ranges" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ranges?</span></a>
5
+ <a href="ConversationalSearchItemCitation.html#search_result_idx" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>search_<wbr/>result_<wbr/>idx?</span></a>
6
+ <a href="ConversationalSearchItemCitation.html#text" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text?</span></a>
7
+ <a href="ConversationalSearchItemCitation.html#title" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title?</span></a>
8
+ <a href="ConversationalSearchItemCitation.html#url" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>url?</span></a>
9
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="range_end" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>range_<wbr/>end</span><a href="#range_end" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">range_end</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Optional zero index based integer indicating where in `text`` the citation ends at. Exclusive.
10
+ So the word &quot;hi&quot;, would have the range_start of 0 and range_end of 2.</p>
11
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="range_start" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>range_<wbr/>start</span><a href="#range_start" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">range_start</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Optional zero index based integer indicating where in <code>text</code> the citation starts from.</p>
12
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="ranges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>ranges</span><a href="#ranges" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">ranges</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">start</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Optional array of ranges indicating where in <code>text</code> the citation is located.</p>
13
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="search_result_idx" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>search_<wbr/>result_<wbr/>idx</span><a href="#search_result_idx" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">search_result_idx</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>A number corresponding to the index of the matching search result. This can be used to gather extra info about a
14
+ specific citation from the matching search result.</p>
15
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="text" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>text</span><a href="#text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">text</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Optional explanation text for the citation.</p>
16
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="title" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>title</span><a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Optional title of the citation URL.</p>
17
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="url" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>url</span><a href="#url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Optional url of the citation. May not be a valid URL.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#range_end" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>range_<wbr/>end</span></a><a href="#range_start" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>range_<wbr/>start</span></a><a href="#ranges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ranges</span></a><a href="#search_result_idx" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>search_<wbr/>result_<wbr/>idx</span></a><a href="#text" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a><a href="#title" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title</span></a><a href="#url" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>url</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/carbon-tsdocs/interfaces/CustomMenuOption.html ADDED
@@ -0,0 +1,6 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CustomMenuOption | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="CustomMenuOption.html">CustomMenuOption</a></li></ul><h1>Interface CustomMenuOption</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A single menu option.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CustomMenuOption</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="CustomMenuOption.html#handler">handler</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomMenuOption.html#text">text</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CustomMenuOption.html#handler" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handler</span></a>
3
+ <a href="CustomMenuOption.html#text" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a>
4
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="handler" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>handler</span><a href="#handler" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">handler</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>The callback handler to call when the option is selected.</p>
5
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="text" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>text</span><a href="#text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The text to display for the menu option.</p>
6
+ </div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#handler" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>handler</span></a><a href="#text" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/carbon-tsdocs/interfaces/CustomPanelConfigOptions.html ADDED
@@ -0,0 +1,29 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CustomPanelConfigOptions | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="CustomPanelConfigOptions.html">CustomPanelConfigOptions</a></li></ul><h1>Interface CustomPanelConfigOptions</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Options that change how the custom panel looks.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CustomPanelConfigOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="CustomPanelConfigOptions.html#disableanimation">disableAnimation</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelConfigOptions.html#disabledefaultcloseaction">disableDefaultCloseAction</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelConfigOptions.html#hidebackbutton">hideBackButton</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelConfigOptions.html#hidecloseandrestartbutton">hideCloseAndRestartButton</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelConfigOptions.html#hideclosebutton">hideCloseButton</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelConfigOptions.html#hidepanelheader">hidePanelHeader</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelConfigOptions.html#onclickback">onClickBack</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelConfigOptions.html#onclickclose">onClickClose</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelConfigOptions.html#onclickcloseandrestart">onClickCloseAndRestart</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelConfigOptions.html#onclickrestart">onClickRestart</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelConfigOptions.html#title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="963"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">BasePanelConfigOptions</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">CustomPanelConfigOptions</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CustomPanelConfigOptions.html#disableanimation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Animation?</span></a>
3
+ <a href="CustomPanelConfigOptions.html#disabledefaultcloseaction" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Default<wbr/>Close<wbr/>Action?</span></a>
4
+ <a href="CustomPanelConfigOptions.html#hidebackbutton" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Back<wbr/>Button?</span></a>
5
+ <a href="CustomPanelConfigOptions.html#hidecloseandrestartbutton" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Close<wbr/>And<wbr/>Restart<wbr/>Button?</span></a>
6
+ <a href="CustomPanelConfigOptions.html#hideclosebutton" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Close<wbr/>Button?</span></a>
7
+ <a href="CustomPanelConfigOptions.html#hidepanelheader" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Panel<wbr/>Header?</span></a>
8
+ <a href="CustomPanelConfigOptions.html#onclickback" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Click<wbr/>Back?</span></a>
9
+ <a href="CustomPanelConfigOptions.html#onclickclose" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Click<wbr/>Close?</span></a>
10
+ <a href="CustomPanelConfigOptions.html#onclickcloseandrestart" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Click<wbr/>Close<wbr/>And<wbr/>Restart?</span></a>
11
+ <a href="CustomPanelConfigOptions.html#onclickrestart" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Click<wbr/>Restart?</span></a>
12
+ <a href="CustomPanelConfigOptions.html#title" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title?</span></a>
13
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="disableanimation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disable<wbr/>Animation</span><a href="#disableanimation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disableAnimation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Determines if the panel open/close animation should be turned off.</p>
14
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="disabledefaultcloseaction" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disable<wbr/>Default<wbr/>Close<wbr/>Action</span><a href="#disabledefaultcloseaction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disableDefaultCloseAction</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Disables the default action that is taken when the close or close-and-restart buttons are clicked. The default
15
+ action closes web chat and disabling this will cause the button to not do anything. You can override the button
16
+ behavior by using the <a href="CustomPanelConfigOptions.html#onclickclose" class="tsd-kind-property">onClickClose</a> or <a href="CustomPanelConfigOptions.html#onclickcloseandrestart" class="tsd-kind-property">onClickCloseAndRestart</a> callback.</p>
17
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="hidebackbutton" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>hide<wbr/>Back<wbr/>Button</span><a href="#hidebackbutton" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hideBackButton</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the back button in the custom panel should be hidden.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BasePanelConfigOptions.hideBackButton</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="hidecloseandrestartbutton" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>hide<wbr/>Close<wbr/>And<wbr/>Restart<wbr/>Button</span><a href="#hidecloseandrestartbutton" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hideCloseAndRestartButton</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the close-and-restart (X) button in the custom panel should be hidden. This value only applies if
19
+ the close-and-restart button is enabled.</p>
20
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BasePanelConfigOptions.hideCloseAndRestartButton</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="hideclosebutton" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>hide<wbr/>Close<wbr/>Button</span><a href="#hideclosebutton" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hideCloseButton</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the close button in the custom panel should be hidden.</p>
21
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BasePanelConfigOptions.hideCloseButton</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="hidepanelheader" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>hide<wbr/>Panel<wbr/>Header</span><a href="#hidepanelheader" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hidePanelHeader</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the panel header should be hidden.</p>
22
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BasePanelConfigOptions.hidePanelHeader</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="onclickback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Click<wbr/>Back</span><a href="#onclickback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onClickBack</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>This callback is called when the back button is clicked.</p>
23
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BasePanelConfigOptions.onClickBack</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="onclickclose" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Click<wbr/>Close</span><a href="#onclickclose" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onClickClose</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>This callback is called when the close button is clicked. This is called even if <a href="CustomPanelConfigOptions.html#disabledefaultcloseaction" class="tsd-kind-property">disableDefaultCloseAction</a>
24
+ is set to true.</p>
25
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BasePanelConfigOptions.onClickClose</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="onclickcloseandrestart" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Click<wbr/>Close<wbr/>And<wbr/>Restart</span><a href="#onclickcloseandrestart" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onClickCloseAndRestart</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>This callback is called when the close-and-restart button is clicked. This is called even if <a href="CustomPanelConfigOptions.html#disabledefaultcloseaction" class="tsd-kind-property">disableDefaultCloseAction</a>
26
+ is set to true.</p>
27
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BasePanelConfigOptions.onClickCloseAndRestart</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="onclickrestart" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Click<wbr/>Restart</span><a href="#onclickrestart" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">onClickRestart</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Called when the restart button is clicked.</p>
28
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BasePanelConfigOptions.onClickRestart</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="title" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>title</span><a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The panel title which is left blank by default.</p>
29
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BasePanelConfigOptions.title</p></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#disableanimation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Animation</span></a><a href="#disabledefaultcloseaction" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Default<wbr/>Close<wbr/>Action</span></a><a href="#hidebackbutton" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Back<wbr/>Button</span></a><a href="#hidecloseandrestartbutton" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Close<wbr/>And<wbr/>Restart<wbr/>Button</span></a><a href="#hideclosebutton" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Close<wbr/>Button</span></a><a href="#hidepanelheader" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hide<wbr/>Panel<wbr/>Header</span></a><a href="#onclickback" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Click<wbr/>Back</span></a><a href="#onclickclose" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Click<wbr/>Close</span></a><a href="#onclickcloseandrestart" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Click<wbr/>Close<wbr/>And<wbr/>Restart</span></a><a href="#onclickrestart" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Click<wbr/>Restart</span></a><a href="#title" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/carbon-tsdocs/interfaces/CustomPanelInstance.html ADDED
@@ -0,0 +1,9 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CustomPanelInstance | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="CustomPanelInstance.html">CustomPanelInstance</a></li></ul><h1>Interface CustomPanelInstance</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The custom panel instance for controlling and manipulating a custom panel in web chat.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CustomPanelInstance</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="CustomPanelInstance.html#close">close</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelInstance.html#hostelement">hostElement</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLDivElement</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="CustomPanelInstance.html#open">open</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="CustomPanelConfigOptions.html" class="tsd-signature-type tsd-kind-interface">CustomPanelConfigOptions</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CustomPanelInstance.html#close" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>close</span></a>
3
+ <a href="CustomPanelInstance.html#hostelement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host<wbr/>Element</span></a>
4
+ <a href="CustomPanelInstance.html#open" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>open</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="close" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>close</span><a href="#close" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">close</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Closes the custom panel.</p>
6
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="hostelement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>host<wbr/>Element</span><a href="#hostelement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hostElement</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLDivElement</span></div><div class="tsd-comment tsd-typography"><p>The custom panel hostElement.</p>
7
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="open" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>open</span><a href="#open" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">open</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="CustomPanelConfigOptions.html" class="tsd-signature-type tsd-kind-interface">CustomPanelConfigOptions</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Opens the custom panel.</p>
8
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="CustomPanelConfigOptions.html" class="tsd-signature-type tsd-kind-interface">CustomPanelConfigOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="CustomPanelConfigOptions.html" class="tsd-signature-type tsd-kind-interface">CustomPanelConfigOptions</a></span><div class="tsd-comment tsd-typography"><p>Custom panel options.</p>
9
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#close" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>close</span></a><a href="#hostelement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>host<wbr/>Element</span></a><a href="#open" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>open</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/carbon-tsdocs/interfaces/CustomPanels.html ADDED
@@ -0,0 +1,4 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CustomPanels | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="CustomPanels.html">CustomPanels</a></li></ul><h1>Interface CustomPanels</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This manager handles fetching an instance for manipulating the custom panel.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CustomPanels</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="CustomPanels.html#getpanel">getPanel</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="CustomPanelInstance.html" class="tsd-signature-type tsd-kind-interface">CustomPanelInstance</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CustomPanels.html#getpanel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Panel</span></a>
3
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="getpanel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Panel</span><a href="#getpanel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getPanel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="CustomPanelInstance.html" class="tsd-signature-type tsd-kind-interface">CustomPanelInstance</a></div><div class="tsd-comment tsd-typography"><p>Gets a custom panel instance.</p>
4
+ </div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#getpanel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>get<wbr/>Panel</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/carbon-tsdocs/interfaces/CustomSendMessageOptions.html ADDED
@@ -0,0 +1,3 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CustomSendMessageOptions | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="CustomSendMessageOptions.html">CustomSendMessageOptions</a></li></ul><h1>Interface CustomSendMessageOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">CustomSendMessageOptions</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="CustomSendMessageOptions.html#signal">signal</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CustomSendMessageOptions.html#signal" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signal</span></a>
2
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="signal" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>signal</span><a href="#signal" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AbortSignal</span></div><div class="tsd-comment tsd-typography"><p>A signal to let customSendMessage to cancel a request if it has exceeded web chat's timeout.</p>
3
+ </div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#signal" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>signal</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/carbon-tsdocs/interfaces/DisclaimerPublicConfig.html ADDED
@@ -0,0 +1,5 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DisclaimerPublicConfig | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="DisclaimerPublicConfig.html">DisclaimerPublicConfig</a></li></ul><h1>Interface DisclaimerPublicConfig</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DisclaimerPublicConfig</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="DisclaimerPublicConfig.html#disclaimerhtml">disclaimerHTML</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="DisclaimerPublicConfig.html#ison">isOn</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="DisclaimerPublicConfig.html#disclaimerhtml" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disclaimerHTML</span></a>
2
+ <a href="DisclaimerPublicConfig.html#ison" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>On</span></a>
3
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="disclaimerhtml" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disclaimerHTML</span><a href="#disclaimerhtml" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">disclaimerHTML</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>HTML content to show in disclaimer.</p>
4
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="ison" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>On</span><a href="#ison" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">isOn</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If the disclaimer is turned on.</p>
5
+ </div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#disclaimerhtml" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disclaimerHTML</span></a><a href="#ison" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>On</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/carbon-tsdocs/interfaces/DisconnectedErrorInfo.html ADDED
@@ -0,0 +1,11 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>DisconnectedErrorInfo | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="DisconnectedErrorInfo.html">DisconnectedErrorInfo</a></li></ul><h1>Interface DisconnectedErrorInfo</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This is used to indicate the state of errors that can happen any time during a chat where the service desk
2
+ implementation has lost a connection to the back-end. If this error occurs while the user is waiting for an
3
+ agent to join, it will be treated as a CONNECTING error instead.</p>
4
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">DisconnectedErrorInfo</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="DisconnectedErrorInfo.html#isdisconnected">isDisconnected</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="DisconnectedErrorInfo.html#loginfo">logInfo</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="DisconnectedErrorInfo.html#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/ErrorType.html#disconnected" class="tsd-signature-type tsd-kind-enum-member">DISCONNECTED</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="1002"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">BaseErrorInfo</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">DisconnectedErrorInfo</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="DisconnectedErrorInfo.html#isdisconnected" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Disconnected</span></a>
5
+ <a href="DisconnectedErrorInfo.html#loginfo" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>log<wbr/>Info?</span></a>
6
+ <a href="DisconnectedErrorInfo.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
7
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="isdisconnected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Disconnected</span><a href="#isdisconnected" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">isDisconnected</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the service desk has become disconnected. A value of true can be passed that will indicate that a
8
+ previous disconnection is over and the service desk is now connected again.</p>
9
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="loginfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>log<wbr/>Info</span><a href="#loginfo" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">logInfo</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>An optional value that will be logged to the console as an error.</p>
10
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from BaseErrorInfo.logInfo</p></aside></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/ErrorType.html#disconnected" class="tsd-signature-type tsd-kind-enum-member">DISCONNECTED</a></div><div class="tsd-comment tsd-typography"><p>The discriminating value for this type.</p>
11
+ </div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#isdisconnected" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Disconnected</span></a><a href="#loginfo" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>log<wbr/>Info</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>