@carbon/ai-chat 0.1.7-test-no-cjs → 0.2.0-0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/carbon-chat-docs.js +2 -0
- package/dist/docs/carbon-chat-docs.js.LICENSE.txt +118 -0
- package/dist/docs/carbon-chat.html +8 -0
- package/dist/docs/carbon-tsdocs/.nojekyll +1 -0
- package/dist/docs/carbon-tsdocs/assets/hierarchy.js +1 -0
- package/dist/docs/carbon-tsdocs/assets/highlight.css +22 -0
- package/dist/docs/carbon-tsdocs/assets/icons.js +18 -0
- package/dist/docs/carbon-tsdocs/assets/icons.svg +1 -0
- package/dist/docs/carbon-tsdocs/assets/main.js +60 -0
- package/dist/docs/carbon-tsdocs/assets/navigation.js +1 -0
- package/dist/docs/carbon-tsdocs/assets/search.js +1 -0
- package/dist/docs/carbon-tsdocs/assets/style.css +1611 -0
- package/dist/docs/carbon-tsdocs/enums/AgentMessageType.html +20 -0
- package/dist/docs/carbon-tsdocs/enums/AgentsOnlineStatus.html +9 -0
- package/dist/docs/carbon-tsdocs/enums/BusEventType.html +67 -0
- package/dist/docs/carbon-tsdocs/enums/ButtonItemKind.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/ButtonItemType.html +5 -0
- package/dist/docs/carbon-tsdocs/enums/CarbonTheme.html +7 -0
- package/dist/docs/carbon-tsdocs/enums/CatastrophicErrorType.html +11 -0
- package/dist/docs/carbon-tsdocs/enums/ChainOfThoughtStepStatus.html +5 -0
- package/dist/docs/carbon-tsdocs/enums/ChatHeaderObjectType.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/CornersType.html +4 -0
- package/dist/docs/carbon-tsdocs/enums/CustomEventType.html +3 -0
- package/dist/docs/carbon-tsdocs/enums/ErrorType.html +12 -0
- package/dist/docs/carbon-tsdocs/enums/FeedbackInteractionType.html +10 -0
- package/dist/docs/carbon-tsdocs/enums/FileStatusValue.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/HomeScreenBackgroundType.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/IFrameItemDisplayOption.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/LauncherType.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/MessageInputType.html +8 -0
- package/dist/docs/carbon-tsdocs/enums/MessageResponseTypes.html +36 -0
- package/dist/docs/carbon-tsdocs/enums/MessageSendSource.html +45 -0
- package/dist/docs/carbon-tsdocs/enums/MinimizeButtonIconType.html +9 -0
- package/dist/docs/carbon-tsdocs/enums/OnErrorType.html +27 -0
- package/dist/docs/carbon-tsdocs/enums/OptionItemPreference.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/ScreenShareState.html +10 -0
- package/dist/docs/carbon-tsdocs/enums/TourEndReason.html +5 -0
- package/dist/docs/carbon-tsdocs/enums/TourStartReason.html +9 -0
- package/dist/docs/carbon-tsdocs/enums/ViewChangeReason.html +47 -0
- package/dist/docs/carbon-tsdocs/enums/ViewType.html +10 -0
- package/dist/docs/carbon-tsdocs/enums/WriteableElementName.html +16 -0
- package/dist/docs/carbon-tsdocs/functions/ChatContainer.html +10 -0
- package/dist/docs/carbon-tsdocs/functions/ChatCustomElement.html +8 -0
- package/dist/docs/carbon-tsdocs/hierarchy.html +1 -0
- package/dist/docs/carbon-tsdocs/index.html +1 -0
- package/dist/docs/carbon-tsdocs/interfaces/AdditionalDataToAgent.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/AgentAppConfig.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/AgentAppInfo.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/AgentAvailability.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/AgentProfile.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/BaseMessageInput.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEvent.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentAreAnyAgentsOnline.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentEndChat.html +10 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreEndChat.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreReceive.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreSend.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreSessionHistory.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreStartChat.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentReceive.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentSend.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventChatReady.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventChunkUserDefinedResponse.html +39 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventClosePanelButtonClicked.html +4 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelClose.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelOpen.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelPreClose.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelPreOpen.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventFeedback.html +17 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerAuthError.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerAuthProvider.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerGetAuthCode.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerLoggedOut.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerReauthenticate.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventHistoryBegin.html +15 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventHistoryEnd.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventMessageItemCustom.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventNiceDFOGetAuthCode.html +7 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventPreReceive.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventPreReset.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventPreSend.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventReceive.html +4 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventReset.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventSend.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventTourEnd.html +7 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventTourStart.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventTourStep.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventUserDefinedResponse.html +10 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventViewChange.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventViewPreChange.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/ButtonItem.html +34 -0
- package/dist/docs/carbon-tsdocs/interfaces/CarouselItem.html +15 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChainOfThoughtStep.html +20 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatContainerProps.html +14 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatCustomElementProps.html +31 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderAvatarConfig.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderButton.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderConfig.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderGroupMenu.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderGroupMenuItem.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderLink.html +10 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderMenu.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatInstance.html +146 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceMessaging.html +16 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceNotifications.html +7 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceServiceDeskActions.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceTours.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/Chunk.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/CompleteItemChunk.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/ConnectToAgentItem.html +24 -0
- package/dist/docs/carbon-tsdocs/interfaces/ConnectToAgentItemTransferInfo.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/ConnectingErrorInfo.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/ConversationalSearchItem.html +22 -0
- package/dist/docs/carbon-tsdocs/interfaces/ConversationalSearchItemCitation.html +18 -0
- package/dist/docs/carbon-tsdocs/interfaces/CustomMenuOption.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/CustomPanelConfigOptions.html +29 -0
- package/dist/docs/carbon-tsdocs/interfaces/CustomPanelInstance.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/CustomPanels.html +4 -0
- package/dist/docs/carbon-tsdocs/interfaces/CustomSendMessageOptions.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/DisclaimerPublicConfig.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/DisconnectedErrorInfo.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/EndChatInfo.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/EventHandlers.html +16 -0
- package/dist/docs/carbon-tsdocs/interfaces/EventInput.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/EventInputData.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/FileUpload.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/FinalResponseChunk.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/GenericItem.html +14 -0
- package/dist/docs/carbon-tsdocs/interfaces/GenericItemMessageFeedbackOptions.html +27 -0
- package/dist/docs/carbon-tsdocs/interfaces/GenericItemMessageOptions.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/GenesysMessengerConfig.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/GridItem.html +23 -0
- package/dist/docs/carbon-tsdocs/interfaces/HasAddRemoveClassName.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/HeaderConfig.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/HistoryItem.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/HomeScreenConfig.html +17 -0
- package/dist/docs/carbon-tsdocs/interfaces/HomeScreenStarterButton.html +7 -0
- package/dist/docs/carbon-tsdocs/interfaces/HomeScreenStarterButtons.html +4 -0
- package/dist/docs/carbon-tsdocs/interfaces/IFrameItem.html +27 -0
- package/dist/docs/carbon-tsdocs/interfaces/InlineErrorItem.html +22 -0
- package/dist/docs/carbon-tsdocs/interfaces/InstanceElements.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/InstanceInputElement.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/ItemStreamingMetadata.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/LayoutConfig.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/MediaItem.html +27 -0
- package/dist/docs/carbon-tsdocs/interfaces/MediaItemDimensions.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageContext.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageGlobalContext.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageHistory.html +18 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageInput.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageItemPanelInfo.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageOutput.html +4 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageRequest.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageResponse.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageSkillContext.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageSystemContext.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/NiceDFOConfig.html +14 -0
- package/dist/docs/carbon-tsdocs/interfaces/NotificationMessage.html +15 -0
- package/dist/docs/carbon-tsdocs/interfaces/OnErrorData.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/Option.html +7 -0
- package/dist/docs/carbon-tsdocs/interfaces/OptionItem.html +23 -0
- package/dist/docs/carbon-tsdocs/interfaces/PageLinkConfig.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/PageLinkIDConfig.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/PartialItemChunk.html +38 -0
- package/dist/docs/carbon-tsdocs/interfaces/PauseItem.html +18 -0
- package/dist/docs/carbon-tsdocs/interfaces/PublicConfig.html +75 -0
- package/dist/docs/carbon-tsdocs/interfaces/PublicConfigMessaging.html +24 -0
- package/dist/docs/carbon-tsdocs/interfaces/PublicWebChatServiceDeskState.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/PublicWebChatState.html +21 -0
- package/dist/docs/carbon-tsdocs/interfaces/RenderUserDefinedState.html +41 -0
- package/dist/docs/carbon-tsdocs/interfaces/SendOptions.html +10 -0
- package/dist/docs/carbon-tsdocs/interfaces/ServiceDesk.html +74 -0
- package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskCallback.html +81 -0
- package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskCapabilities.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskFactoryParameters.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskPublicConfig.html +25 -0
- package/dist/docs/carbon-tsdocs/interfaces/StartChatOptions.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/TableItem.html +22 -0
- package/dist/docs/carbon-tsdocs/interfaces/TableItemRow.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/TextItem.html +19 -0
- package/dist/docs/carbon-tsdocs/interfaces/ThemeConfig.html +16 -0
- package/dist/docs/carbon-tsdocs/interfaces/TourStepGenericItem.html +17 -0
- package/dist/docs/carbon-tsdocs/interfaces/TypeAndHandler.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/UpdateHistoryEvent.html +10 -0
- package/dist/docs/carbon-tsdocs/interfaces/UserDefinedItem.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/UserMessageErrorInfo.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/ViewState.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/WithBodyAndFooter.html +5 -0
- package/dist/docs/carbon-tsdocs/types/AudioItem.html +2 -0
- package/dist/docs/carbon-tsdocs/types/CardItem.html +1 -0
- package/dist/docs/carbon-tsdocs/types/ChangeFunction.html +1 -0
- package/dist/docs/carbon-tsdocs/types/ChatHeaderMenuItemTypes.html +2 -0
- package/dist/docs/carbon-tsdocs/types/ChatHeaderObjectTypes.html +2 -0
- package/dist/docs/carbon-tsdocs/types/DateItem.html +3 -0
- package/dist/docs/carbon-tsdocs/types/EventBusHandler.html +3 -0
- package/dist/docs/carbon-tsdocs/types/HorizontalCellAlignment.html +1 -0
- package/dist/docs/carbon-tsdocs/types/ImageItem.html +2 -0
- package/dist/docs/carbon-tsdocs/types/IncreaseOrDecrease.html +1 -0
- package/dist/docs/carbon-tsdocs/types/Message.html +2 -0
- package/dist/docs/carbon-tsdocs/types/PartialOrCompleteItemChunk.html +1 -0
- package/dist/docs/carbon-tsdocs/types/RenderUserDefinedResponse.html +6 -0
- package/dist/docs/carbon-tsdocs/types/RenderWriteableElementResponse.html +2 -0
- package/dist/docs/carbon-tsdocs/types/ServiceDeskErrorInfo.html +3 -0
- package/dist/docs/carbon-tsdocs/types/StreamChunk.html +1 -0
- package/dist/docs/carbon-tsdocs/types/TableItemCell.html +1 -0
- package/dist/docs/carbon-tsdocs/types/TableItemRowExpandableSectionItem.html +1 -0
- package/dist/docs/carbon-tsdocs/types/VerticalCellAlignment.html +1 -0
- package/dist/docs/carbon-tsdocs/types/VideoItem.html +2 -0
- package/dist/docs/carbon-tsdocs/types/WriteableElements.html +3 -0
- package/dist/es/AppContainer.js +1670 -6105
- package/dist/es/Carousel.js +23 -36
- package/dist/es/GenesysMessengerServiceDesk.js +23 -36
- package/dist/es/HumanAgentServiceImpl.js +45 -70
- package/dist/es/NiceDFOServiceDesk.js +23 -50
- package/dist/es/PDFViewerContainer.js +23 -64
- package/dist/es/ReactPlayer.js +21 -35
- package/dist/es/SFServiceDesk.js +23 -37
- package/dist/es/ServiceDeskImpl.js +21 -35
- package/dist/es/Table.js +26 -97
- package/dist/es/ZendeskServiceDesk.js +23 -53
- package/dist/es/_node-resolve_empty.js +21 -21
- package/dist/es/aiChatEntry.js +24 -75
- package/dist/es/ar-dz.js +22 -22
- package/dist/es/ar-kw.js +22 -22
- package/dist/es/ar-ly.js +22 -22
- package/dist/es/ar-ma.js +22 -22
- package/dist/es/ar-sa.js +22 -22
- package/dist/es/ar-tn.js +22 -22
- package/dist/es/ar.js +22 -22
- package/dist/es/ar2.js +46 -24
- package/dist/es/cds-aichat-container.js +23 -50
- package/dist/es/cds-aichat-custom-element.js +22 -35
- package/dist/es/cs.js +22 -22
- package/dist/es/cs2.js +45 -23
- package/dist/es/de-at.js +22 -22
- package/dist/es/de-ch.js +22 -22
- package/dist/es/de.js +22 -22
- package/dist/es/de2.js +45 -23
- package/dist/es/en-au.js +22 -22
- package/dist/es/en-ca.js +22 -22
- package/dist/es/en-gb.js +22 -22
- package/dist/es/en-ie.js +22 -22
- package/dist/es/en-il.js +22 -22
- package/dist/es/en-nz.js +22 -22
- package/dist/es/es-do.js +22 -22
- package/dist/es/es-us.js +22 -22
- package/dist/es/es.js +22 -22
- package/dist/es/es2.js +45 -23
- package/dist/es/export.js +58 -23
- package/dist/es/export.legacy.js +58 -23
- package/dist/es/fr-ca.js +22 -22
- package/dist/es/fr-ch.js +22 -22
- package/dist/es/fr.js +22 -22
- package/dist/es/fr2.js +45 -23
- package/dist/es/it-ch.js +22 -22
- package/dist/es/it.js +22 -22
- package/dist/es/it2.js +45 -23
- package/dist/es/ja.js +22 -22
- package/dist/es/ja2.js +45 -23
- package/dist/es/ko.js +22 -22
- package/dist/es/ko2.js +45 -23
- package/dist/es/mockServiceDesk.js +23 -36
- package/dist/es/nl.js +22 -22
- package/dist/es/nl2.js +45 -23
- package/dist/es/pt-br.js +22 -22
- package/dist/es/pt-br2.js +45 -23
- package/dist/es/pt.js +22 -22
- package/dist/es/{fontUtils.js → scriptRender.js} +87 -35
- package/dist/es/zh-cn.js +22 -22
- package/dist/es/zh-tw.js +22 -22
- package/dist/es/zh-tw2.js +45 -23
- package/dist/es/zh.js +45 -23
- package/dist/types/aiChatEntry.d.ts +39 -10
- package/package.json +24 -7
- package/dist/es/render.js +0 -105
|
@@ -0,0 +1,14 @@
|
|
|
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>NiceDFOConfig | 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="NiceDFOConfig.html">NiceDFOConfig</a></li></ul><h1>Interface NiceDFOConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The configuration in the main config that is needed to initialize the SDK.</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">NiceDFOConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="NiceDFOConfig.html#brandid">brandID</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="NiceDFOConfig.html#channelid">channelID</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="NiceDFOConfig.html#environment">environment</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="NiceDFOConfig.html#usewebchatuserid">useWebChatUserID</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="NiceDFOConfig.html#brandid" 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>brandID</span></a>
|
|
3
|
+
<a href="NiceDFOConfig.html#channelid" 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>channelID</span></a>
|
|
4
|
+
<a href="NiceDFOConfig.html#environment" 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>environment</span></a>
|
|
5
|
+
<a href="NiceDFOConfig.html#usewebchatuserid" 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>use<wbr/>Web<wbr/>Chat<wbr/>UserID?</span></a>
|
|
6
|
+
</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="brandid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>brandID</span><a href="#brandid" 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">brandID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The brand ID from the Nice embed code.</p>
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="channelid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>channelID</span><a href="#channelid" 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">channelID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The channel ID from the Nice embed code.</p>
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="environment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>environment</span><a href="#environment" 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">environment</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The Nice environment where the account is hosted.</p>
|
|
9
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="usewebchatuserid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>use<wbr/>Web<wbr/>Chat<wbr/>UserID</span><a href="#usewebchatuserid" 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">useWebChatUserID</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 web chat user ID should be used. By default, if web chat is using a web chat generated
|
|
10
|
+
anonymous ID, then a new unique ID is generated for the user on each interaction with Nice. If web chat is
|
|
11
|
+
using a user ID provided by the host page, then that ID will be used instead. This value can be used to
|
|
12
|
+
override that behavior. If this value is true, then the web chat user ID will be used even if it's for an
|
|
13
|
+
anonymous user. If this value is false, then a new unique ID will be generated instead.</p>
|
|
14
|
+
</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="#brandid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>brandID</span></a><a href="#channelid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>channelID</span></a><a href="#environment" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>environment</span></a><a href="#usewebchatuserid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>use<wbr/>Web<wbr/>Chat<wbr/>UserID</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>
|
|
@@ -0,0 +1,15 @@
|
|
|
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>NotificationMessage | 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="NotificationMessage.html">NotificationMessage</a></li></ul><h1>Interface NotificationMessage</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A record of a notification to be shown in the UI.</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">NotificationMessage</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="NotificationMessage.html#actionbuttonlabel">actionButtonLabel</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="NotificationMessage.html#groupid">groupID</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="NotificationMessage.html#kind">kind</a><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"error"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"info"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"success"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"info-square"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"warning"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"warning-alt"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="NotificationMessage.html#message">message</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="NotificationMessage.html#onactionbuttonclick">onActionButtonClick</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="NotificationMessage.html#onclosebuttonclick">onCloseButtonClick</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="NotificationMessage.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-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="NotificationMessage.html#actionbuttonlabel" 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>action<wbr/>Button<wbr/>Label?</span></a>
|
|
3
|
+
<a href="NotificationMessage.html#groupid" 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>groupID?</span></a>
|
|
4
|
+
<a href="NotificationMessage.html#kind" 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>kind</span></a>
|
|
5
|
+
<a href="NotificationMessage.html#message" 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>message</span></a>
|
|
6
|
+
<a href="NotificationMessage.html#onactionbuttonclick" 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>on<wbr/>Action<wbr/>Button<wbr/>Click?</span></a>
|
|
7
|
+
<a href="NotificationMessage.html#onclosebuttonclick" 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>on<wbr/>Close<wbr/>Button<wbr/>Click?</span></a>
|
|
8
|
+
<a href="NotificationMessage.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>
|
|
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="actionbuttonlabel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>action<wbr/>Button<wbr/>Label</span><a href="#actionbuttonlabel" 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">actionButtonLabel</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>An optional action button that a user can click. If there is an action button, we will not auto dismiss.</p>
|
|
10
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="groupid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>groupID</span><a href="#groupid" 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">groupID</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The group id that associates notifications together. This can be used to remove the notification later.</p>
|
|
11
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="kind" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>kind</span><a href="#kind" 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">kind</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"error"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"info"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"success"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"info-square"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"warning"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"warning-alt"</span></div></section><section class="tsd-panel tsd-member"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" 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</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The message to show.</p>
|
|
12
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="onactionbuttonclick" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Action<wbr/>Button<wbr/>Click</span><a href="#onactionbuttonclick" 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">onActionButtonClick</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>The callback called when someone clicks on the action button.</p>
|
|
13
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="onclosebuttonclick" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Close<wbr/>Button<wbr/>Click</span><a href="#onclosebuttonclick" 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">onCloseButtonClick</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>The callback called when someone clicks on the close button.</p>
|
|
14
|
+
</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"><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 title to show in the message.</p>
|
|
15
|
+
</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="#actionbuttonlabel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>action<wbr/>Button<wbr/>Label</span></a><a href="#groupid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>groupID</span></a><a href="#kind" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>kind</span></a><a href="#message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#onactionbuttonclick" class=""><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/>Action<wbr/>Button<wbr/>Click</span></a><a href="#onclosebuttonclick" class=""><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/>Close<wbr/>Button<wbr/>Click</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></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>
|
|
@@ -0,0 +1,13 @@
|
|
|
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>OnErrorData | 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="OnErrorData.html">OnErrorData</a></li></ul><h1>Interface OnErrorData</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">OnErrorData</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="OnErrorData.html#catastrophicerrortype">catastrophicErrorType</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/CatastrophicErrorType.html" class="tsd-signature-type tsd-kind-enum">CatastrophicErrorType</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="OnErrorData.html#errorcode">errorCode</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="OnErrorData.html#errortype">errorType</a><span class="tsd-signature-symbol">:</span> <a href="../enums/OnErrorType.html" class="tsd-signature-type tsd-kind-enum">OnErrorType</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="OnErrorData.html#message">message</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="OnErrorData.html#otherdata">otherData</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="OnErrorData.html#transactionid">transactionID</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="OnErrorData.html#catastrophicerrortype" 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>catastrophic<wbr/>Error<wbr/>Type?</span></a>
|
|
2
|
+
<a href="OnErrorData.html#errorcode" 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>error<wbr/>Code?</span></a>
|
|
3
|
+
<a href="OnErrorData.html#errortype" 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>error<wbr/>Type</span></a>
|
|
4
|
+
<a href="OnErrorData.html#message" 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>message</span></a>
|
|
5
|
+
<a href="OnErrorData.html#otherdata" 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>other<wbr/>Data?</span></a>
|
|
6
|
+
<a href="OnErrorData.html#transactionid" 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>transactionID?</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="catastrophicerrortype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>catastrophic<wbr/>Error<wbr/>Type</span><a href="#catastrophicerrortype" 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">catastrophicErrorType</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/CatastrophicErrorType.html" class="tsd-signature-type tsd-kind-enum">CatastrophicErrorType</a></div><div class="tsd-comment tsd-typography"><p>If the error is of the severity that requires a whole restart of web chat.</p>
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="errorcode" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>error<wbr/>Code</span><a href="#errorcode" 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">errorCode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>A possible error code associated with this error. The meaning of this value may vary based on the error type.</p>
|
|
9
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="errortype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>error<wbr/>Type</span><a href="#errortype" 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">errorType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/OnErrorType.html" class="tsd-signature-type tsd-kind-enum">OnErrorType</a></div><div class="tsd-comment tsd-typography"><p>The type of error that occurred.</p>
|
|
10
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>message</span><a href="#message" 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</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A message associated with the error.</p>
|
|
11
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="otherdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>other<wbr/>Data</span><a href="#otherdata" 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">otherData</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>An extra blob of data associated with the error. This may be a stack trace for thrown errors.</p>
|
|
12
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="transactionid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>transactionID</span><a href="#transactionid" 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">transactionID</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>An optional transaction ID to associate with the error.</p>
|
|
13
|
+
</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="#catastrophicerrortype" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>catastrophic<wbr/>Error<wbr/>Type</span></a><a href="#errorcode" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error<wbr/>Code</span></a><a href="#errortype" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>error<wbr/>Type</span></a><a href="#message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#otherdata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>other<wbr/>Data</span></a><a href="#transactionid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>transactionID</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>
|
|
@@ -0,0 +1,7 @@
|
|
|
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>Option | 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="Option.html">Option</a></li></ul><h1>Interface Option</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an individual option that is part of an "options" response.</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">Option</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="Option.html#label">label</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="Option.html#value">value</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">input</span><span class="tsd-signature-symbol">:</span> <a href="MessageInput.html" class="tsd-signature-type tsd-kind-interface">MessageInput</a> <span class="tsd-signature-symbol">}</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="Option.html#label" 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>label</span></a>
|
|
3
|
+
<a href="Option.html#value" 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>value</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="label" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>label</span><a href="#label" 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">label</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The user-facing label for the option or disambiguation suggestion. This label is taken from the user_label property
|
|
5
|
+
of the corresponding dialog node.</p>
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="value" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>value</span><a href="#value" 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">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">input</span><span class="tsd-signature-symbol">:</span> <a href="MessageInput.html" class="tsd-signature-type tsd-kind-interface">MessageInput</a> <span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">input</span><span class="tsd-signature-symbol">: </span><a href="MessageInput.html" class="tsd-signature-type tsd-kind-interface">MessageInput</a></h5><div class="tsd-comment tsd-typography"><p>An input object that should be sent back to the assistant when this option is chosen by a user.</p>
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></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="#label" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>label</span></a><a href="#value" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>value</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>
|
|
@@ -0,0 +1,23 @@
|
|
|
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>OptionItem | 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="OptionItem.html">OptionItem</a></li></ul><h1>Interface OptionItem<TUserDefinedType></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An option item returned in a message response from a back-end. This response type is used when displaying a list
|
|
2
|
+
of options to the user. How the options are displayed is up to the client but is often displayed in either a
|
|
3
|
+
drop-down or as a list of buttons.</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">OptionItem</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OptionItem.html#tuserdefinedtype">TUserDefinedType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</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">></span><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="OptionItem.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="OptionItem.html#description">description</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="OptionItem.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="OptionItem.html#options">options</a><span class="tsd-signature-symbol">:</span> <a href="Option.html" class="tsd-signature-type tsd-kind-interface">Option</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="OptionItem.html#preference">preference</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/OptionItemPreference.html" class="tsd-signature-type tsd-kind-enum">OptionItemPreference</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="OptionItem.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="OptionItem.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="OptionItem.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="OptionItem.html#user_defined">user_defined</a><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="OptionItem.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"><</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">></span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="1359"><h4>Hierarchy (<a href="../hierarchy.html#OptionItem">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"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="OptionItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">></span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">OptionItem</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="OptionItem.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>
|
|
5
|
+
<a href="OptionItem.html#description" 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>description?</span></a>
|
|
6
|
+
<a href="OptionItem.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="OptionItem.html#options" 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>options</span></a>
|
|
8
|
+
<a href="OptionItem.html#preference" 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>preference?</span></a>
|
|
9
|
+
<a href="OptionItem.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>
|
|
10
|
+
<a href="OptionItem.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>
|
|
11
|
+
<a href="OptionItem.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>
|
|
12
|
+
<a href="OptionItem.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>
|
|
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 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>
|
|
14
|
+
</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="description" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>description</span><a href="#description" 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">description</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>An optional description to be shown alongside the options.</p>
|
|
15
|
+
</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>
|
|
16
|
+
</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"><a id="options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>options</span><a href="#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">options</span><span class="tsd-signature-symbol">:</span> <a href="Option.html" class="tsd-signature-type tsd-kind-interface">Option</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>An array of objects describing the options from which the user can choose.</p>
|
|
17
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="preference" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>preference</span><a href="#preference" 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">preference</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/OptionItemPreference.html" class="tsd-signature-type tsd-kind-enum">OptionItemPreference</a></div><div class="tsd-comment tsd-typography"><p>The preferred type of control to display.</p>
|
|
18
|
+
</div><div class="tsd-comment tsd-typography"></div></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>
|
|
19
|
+
</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
|
|
20
|
+
for a specific item.</p>
|
|
21
|
+
</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="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>An optional title to be shown alongside the options.</p>
|
|
22
|
+
</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="OptionItem.html#tuserdefinedtype">TUserDefinedType</a></div><div class="tsd-comment tsd-typography"><p>An optional buckets of additional user defined properties for this item.</p>
|
|
23
|
+
</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="#description" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>description</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="#options" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#preference" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>preference</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="#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="#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>
|
|
@@ -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>PageLinkConfig | 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="PageLinkConfig.html">PageLinkConfig</a></li></ul><h1>Interface PageLinkConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The configuration that defines how web chat responds to link page requests (where there's a link reference in the
|
|
2
|
+
URL).</p>
|
|
3
|
+
</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">PageLinkConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="PageLinkConfig.html#linkids">linkIDs</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="PageLinkIDConfig.html" class="tsd-signature-type tsd-kind-interface">PageLinkIDConfig</a><span class="tsd-signature-symbol">></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="PageLinkConfig.html#linkids" 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>linkIDs</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="linkids" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>linkIDs</span><a href="#linkids" 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">linkIDs</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="PageLinkIDConfig.html" class="tsd-signature-type tsd-kind-interface">PageLinkIDConfig</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>The configuration for all the link IDs. The keys are the link IDs and the values are the configurations
|
|
5
|
+
specific to each link ID.</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="#linkids" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>linkIDs</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>
|
|
@@ -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>PageLinkIDConfig | 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="PageLinkIDConfig.html">PageLinkIDConfig</a></li></ul><h1>Interface PageLinkIDConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The link configuration for a specific link ID.</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">PageLinkIDConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="PageLinkIDConfig.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="PageLinkIDConfig.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>
|
|
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="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 of the utterance that will be sent to the assistant when the page is loaded and the given link ID is
|
|
4
|
+
found.</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="#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>
|