@carbon/ai-chat 0.3.0 → 0.3.2-0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/dist/docs/carbon-chat-docs.js +1 -1
  2. package/dist/docs/carbon-chat.html +1 -1
  3. package/dist/docs/carbon-tsdocs/assets/hierarchy.js +1 -1
  4. package/dist/docs/carbon-tsdocs/assets/navigation.js +1 -1
  5. package/dist/docs/carbon-tsdocs/assets/search.js +1 -1
  6. package/dist/docs/carbon-tsdocs/enums/WidthOptions.html +7 -0
  7. package/dist/docs/carbon-tsdocs/hierarchy.html +1 -1
  8. package/dist/docs/carbon-tsdocs/index.html +1 -1
  9. package/dist/docs/carbon-tsdocs/interfaces/ChatInstance.html +7 -3
  10. package/dist/docs/carbon-tsdocs/interfaces/Chunk.html +1 -1
  11. package/dist/docs/carbon-tsdocs/interfaces/CompleteItemChunk.html +1 -1
  12. package/dist/docs/carbon-tsdocs/interfaces/ConnectToAgentItem.html +1 -1
  13. package/dist/docs/carbon-tsdocs/interfaces/ConnectingErrorInfo.html +1 -1
  14. package/dist/docs/carbon-tsdocs/interfaces/ConversationalSearchItem.html +1 -1
  15. package/dist/docs/carbon-tsdocs/interfaces/CustomPanelConfigOptions.html +1 -1
  16. package/dist/docs/carbon-tsdocs/interfaces/DisconnectedErrorInfo.html +1 -1
  17. package/dist/docs/carbon-tsdocs/interfaces/EventHandlers.html +1 -1
  18. package/dist/docs/carbon-tsdocs/interfaces/EventInput.html +1 -1
  19. package/dist/docs/carbon-tsdocs/interfaces/EventInputData.html +1 -1
  20. package/dist/docs/carbon-tsdocs/interfaces/GenericItem.html +1 -1
  21. package/dist/docs/carbon-tsdocs/interfaces/GridItem.html +6 -3
  22. package/dist/docs/carbon-tsdocs/interfaces/HomeScreenConfig.html +6 -3
  23. package/dist/docs/carbon-tsdocs/interfaces/IFrameItem.html +1 -1
  24. package/dist/docs/carbon-tsdocs/interfaces/InlineErrorItem.html +1 -1
  25. package/dist/docs/carbon-tsdocs/interfaces/MediaItem.html +1 -1
  26. package/dist/docs/carbon-tsdocs/interfaces/MessageInput.html +1 -1
  27. package/dist/docs/carbon-tsdocs/interfaces/MessageItemPanelInfo.html +1 -1
  28. package/dist/docs/carbon-tsdocs/interfaces/OptionItem.html +1 -1
  29. package/dist/docs/carbon-tsdocs/interfaces/PartialItemChunk.html +1 -1
  30. package/dist/docs/carbon-tsdocs/interfaces/PauseItem.html +1 -1
  31. package/dist/docs/carbon-tsdocs/interfaces/PublicConfigMessaging.html +1 -1
  32. package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskCapabilities.html +1 -1
  33. package/dist/docs/carbon-tsdocs/interfaces/TableItem.html +1 -1
  34. package/dist/docs/carbon-tsdocs/interfaces/TextItem.html +1 -1
  35. package/dist/docs/carbon-tsdocs/interfaces/TourStepGenericItem.html +1 -1
  36. package/dist/docs/carbon-tsdocs/interfaces/UpdateHistoryEvent.html +1 -1
  37. package/dist/docs/carbon-tsdocs/interfaces/UserDefinedItem.html +1 -1
  38. package/dist/docs/carbon-tsdocs/interfaces/UserMessageErrorInfo.html +1 -1
  39. package/dist/docs/carbon-tsdocs/interfaces/WithBodyAndFooter.html +1 -1
  40. package/dist/docs/carbon-tsdocs/interfaces/WithWidthOptions.html +4 -0
  41. package/dist/docs/carbon-tsdocs/types/CardItem.html +1 -1
  42. package/dist/es/AppContainer.js +119 -117
  43. package/dist/es/Carousel.js +2 -2
  44. package/dist/es/GenesysMessengerServiceDesk.js +2 -2
  45. package/dist/es/HumanAgentServiceImpl.js +2 -2
  46. package/dist/es/NiceDFOServiceDesk.js +2 -2
  47. package/dist/es/PDFViewerContainer.js +2 -2
  48. package/dist/es/ReactPlayer.js +2 -2
  49. package/dist/es/SFServiceDesk.js +2 -2
  50. package/dist/es/ServiceDeskImpl.js +2 -2
  51. package/dist/es/ZendeskServiceDesk.js +2 -2
  52. package/dist/es/_node-resolve_empty.js +2 -2
  53. package/dist/es/aiChatEntry.js +2 -2
  54. package/dist/es/ar-dz.js +2 -2
  55. package/dist/es/ar-kw.js +2 -2
  56. package/dist/es/ar-ly.js +2 -2
  57. package/dist/es/ar-ma.js +2 -2
  58. package/dist/es/ar-sa.js +2 -2
  59. package/dist/es/ar-tn.js +2 -2
  60. package/dist/es/ar.js +2 -2
  61. package/dist/es/ar2.js +2 -2
  62. package/dist/es/cds-aichat-container.js +2 -2
  63. package/dist/es/cds-aichat-custom-element.js +2 -2
  64. package/dist/es/cs.js +2 -2
  65. package/dist/es/cs2.js +2 -2
  66. package/dist/es/customElement.js +2 -2
  67. package/dist/es/de-at.js +2 -2
  68. package/dist/es/de-ch.js +2 -2
  69. package/dist/es/de.js +2 -2
  70. package/dist/es/de2.js +2 -2
  71. package/dist/es/en-au.js +2 -2
  72. package/dist/es/en-ca.js +2 -2
  73. package/dist/es/en-gb.js +2 -2
  74. package/dist/es/en-ie.js +2 -2
  75. package/dist/es/en-il.js +2 -2
  76. package/dist/es/en-nz.js +2 -2
  77. package/dist/es/es-do.js +2 -2
  78. package/dist/es/es-us.js +2 -2
  79. package/dist/es/es.js +2 -2
  80. package/dist/es/es2.js +2 -2
  81. package/dist/es/export.carbon.js +2 -2
  82. package/dist/es/export.js +2 -2
  83. package/dist/es/export.legacy.carbon.js +2 -2
  84. package/dist/es/export.legacy.js +3 -3
  85. package/dist/es/fr-ca.js +2 -2
  86. package/dist/es/fr-ch.js +2 -2
  87. package/dist/es/fr.js +2 -2
  88. package/dist/es/fr2.js +2 -2
  89. package/dist/es/it-ch.js +2 -2
  90. package/dist/es/it.js +2 -2
  91. package/dist/es/it2.js +2 -2
  92. package/dist/es/ja.js +2 -2
  93. package/dist/es/ja2.js +2 -2
  94. package/dist/es/ko.js +2 -2
  95. package/dist/es/ko2.js +2 -2
  96. package/dist/es/mockServiceDesk.js +2 -2
  97. package/dist/es/nl.js +2 -2
  98. package/dist/es/nl2.js +2 -2
  99. package/dist/es/pt-br.js +2 -2
  100. package/dist/es/pt-br2.js +2 -2
  101. package/dist/es/pt.js +2 -2
  102. package/dist/es/scriptRender.js +6 -4
  103. package/dist/es/zh-cn.js +2 -2
  104. package/dist/es/zh-tw.js +2 -2
  105. package/dist/es/zh-tw2.js +2 -2
  106. package/dist/es/zh.js +2 -2
  107. package/dist/types/aiChatEntry.d.ts +1 -1
  108. package/package.json +1 -1
package/dist/docs/carbon-tsdocs/interfaces/GridItem.html CHANGED
@@ -1,8 +1,9 @@
1
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>GridItem | 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="GridItem.html">GridItem</a></li></ul><h1>Interface GridItem&lt;TUserDefinedType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The basic class for items returned from a back-end as part of a message response. These are the items contained
2
2
  in the <a href="MessageOutput.html#generic" class="tsd-kind-property">MessageOutput.generic</a> array.</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">GridItem</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="GridItem.html#tuserdefinedtype">TUserDefinedType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="GridItem.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="GridItem.html#columns">columns</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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="GridItem.html#horizontal_alignment">horizontal_alignment</a><span class="tsd-signature-symbol">?:</span> <a href="../types/HorizontalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">HorizontalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="GridItem.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="GridItem.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="GridItem.html#rows">rows</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">cells</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>            <span class="tsd-kind-property">horizontal_alignment</span><span class="tsd-signature-symbol">?:</span> <a href="../types/HorizontalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">HorizontalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">vertical_alignment</span><span class="tsd-signature-symbol">?:</span> <a href="../types/VerticalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">VerticalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <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="GridItem.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="GridItem.html#user_defined">user_defined</a><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="GridItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="GridItem.html#vertical_alignment">vertical_alignment</a><span class="tsd-signature-symbol">?:</span> <a href="../types/VerticalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">VerticalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tuserdefinedtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TUserDefinedType</span> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="1082"><h4>Hierarchy (<a href="../hierarchy.html#GridItem">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="GridItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">GridItem</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="GridItem.html#agent_message_type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent_<wbr/>message_<wbr/>type?</span></a>
3
+ </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">GridItem</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="GridItem.html#tuserdefinedtype">TUserDefinedType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="GridItem.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="GridItem.html#columns">columns</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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="GridItem.html#horizontal_alignment">horizontal_alignment</a><span class="tsd-signature-symbol">?:</span> <a href="../types/HorizontalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">HorizontalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="GridItem.html#max_width">max_width</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/WidthOptions.html" class="tsd-signature-type tsd-kind-enum">WidthOptions</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="GridItem.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="GridItem.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="GridItem.html#rows">rows</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">cells</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>            <span class="tsd-kind-property">horizontal_alignment</span><span class="tsd-signature-symbol">?:</span> <a href="../types/HorizontalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">HorizontalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">vertical_alignment</span><span class="tsd-signature-symbol">?:</span> <a href="../types/VerticalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">VerticalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <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="GridItem.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="GridItem.html#user_defined">user_defined</a><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="GridItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="GridItem.html#vertical_alignment">vertical_alignment</a><span class="tsd-signature-symbol">?:</span> <a href="../types/VerticalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">VerticalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tuserdefinedtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TUserDefinedType</span> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="1086"><h4>Hierarchy (<a href="../hierarchy.html#GridItem">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="GridItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">&gt;</span></li><li class="tsd-hierarchy-item"><a href="WithWidthOptions.html" class="tsd-signature-type tsd-kind-interface">WithWidthOptions</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">GridItem</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="GridItem.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>
4
4
  <a href="GridItem.html#columns" 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>columns</span></a>
5
5
  <a href="GridItem.html#horizontal_alignment" 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>horizontal_<wbr/>alignment?</span></a>
6
+ <a href="GridItem.html#max_width" 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>max_<wbr/>width?</span></a>
6
7
  <a href="GridItem.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
8
  <a href="GridItem.html#response_type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response_<wbr/>type</span></a>
8
9
  <a href="GridItem.html#rows" 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>rows</span></a>
@@ -12,7 +13,9 @@ in the <a href="MessageOutput.html#generic" class="tsd-kind-property">MessageOut
12
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>
13
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="columns" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>columns</span><a href="#columns" 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">columns</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The list of columns specifications. This will determine the maximum number of columns that can be rendered.</p>
14
15
  </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="horizontal_alignment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>horizontal_<wbr/>alignment</span><a href="#horizontal_alignment" 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">horizontal_alignment</span><span class="tsd-signature-symbol">?:</span> <a href="../types/HorizontalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">HorizontalCellAlignment</a></div><div class="tsd-comment tsd-typography"><p>Determines the horizontal alignment of all items in the grid.</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></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="max_width" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>max_<wbr/>width</span><a href="#max_width" 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">max_width</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/WidthOptions.html" class="tsd-signature-type tsd-kind-enum">WidthOptions</a></div><div class="tsd-comment tsd-typography"><p>Sets an optional max width of the component. Options are small, medium and large.
17
+ By default, the component will be 100% width of the container.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="WithWidthOptions.html">WithWidthOptions</a>.<a href="WithWidthOptions.html#max_width">max_width</a></p></aside></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
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#message_options">message_options</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="response_type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>response_<wbr/>type</span><a href="#response_type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">response_type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MessageResponseTypes.html" class="tsd-signature-type tsd-kind-enum">MessageResponseTypes</a></div><div class="tsd-comment tsd-typography"><p>The response type of this message item.</p>
17
20
  </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GenericItem.html">GenericItem</a>.<a href="GenericItem.html#response_type">response_type</a></p></aside></section><section class="tsd-panel tsd-member"><a id="rows" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rows</span><a href="#rows" 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">rows</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">cells</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">horizontal_alignment</span><span class="tsd-signature-symbol">?:</span> <a href="../types/HorizontalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">HorizontalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">vertical_alignment</span><span class="tsd-signature-symbol">?:</span> <a href="../types/VerticalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">VerticalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A list of rows to render.</p>
18
21
  </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">cells</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{</span><br/>    <span class="tsd-kind-property">horizontal_alignment</span><span class="tsd-signature-symbol">?:</span> <a href="../types/HorizontalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">HorizontalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">items</span><span class="tsd-signature-symbol">:</span> <a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-kind-property">vertical_alignment</span><span class="tsd-signature-symbol">?:</span> <a href="../types/VerticalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">VerticalCellAlignment</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>A list of cells to render in a row.</p>
@@ -20,4 +23,4 @@ in the <a href="MessageOutput.html#generic" class="tsd-kind-property">MessageOut
20
23
  for a specific item.</p>
21
24
  </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 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="GridItem.html#tuserdefinedtype">TUserDefinedType</a></div><div class="tsd-comment tsd-typography"><p>An optional buckets of additional user defined properties for this item.</p>
22
25
  </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 class="tsd-panel tsd-member"><a id="vertical_alignment" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>vertical_<wbr/>alignment</span><a href="#vertical_alignment" 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">vertical_alignment</span><span class="tsd-signature-symbol">?:</span> <a href="../types/VerticalCellAlignment.html" class="tsd-signature-type tsd-kind-type-alias">VerticalCellAlignment</a></div><div class="tsd-comment tsd-typography"><p>Determines the vertical alignment of all items in the grid.</p>
23
- </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="#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="#columns" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>columns</span></a><a href="#horizontal_alignment" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>horizontal_<wbr/>alignment</span></a><a href="#message_options" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message_<wbr/>options</span></a><a href="#response_type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response_<wbr/>type</span></a><a href="#rows" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rows</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="#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><a href="#vertical_alignment" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vertical_<wbr/>alignment</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>
26
+ </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="#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="#columns" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>columns</span></a><a href="#horizontal_alignment" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>horizontal_<wbr/>alignment</span></a><a href="#max_width" 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>max_<wbr/>width</span></a><a href="#message_options" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message_<wbr/>options</span></a><a href="#response_type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response_<wbr/>type</span></a><a href="#rows" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>rows</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="#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><a href="#vertical_alignment" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>vertical_<wbr/>alignment</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/carbon-tsdocs/interfaces/HomeScreenConfig.html CHANGED
@@ -1,14 +1,17 @@
1
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>HomeScreenConfig | 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="HomeScreenConfig.html">HomeScreenConfig</a></li></ul><h1>Interface HomeScreenConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Configuration for the optional home screen that appears before the bot chat window.</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">HomeScreenConfig</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="HomeScreenConfig.html#background">background</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/HomeScreenBackgroundType.html" class="tsd-signature-type tsd-kind-enum">HomeScreenBackgroundType</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="HomeScreenConfig.html#bot_avatar_url">bot_avatar_url</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="HomeScreenConfig.html#custom_content_only">custom_content_only</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="HomeScreenConfig.html#greeting">greeting</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="HomeScreenConfig.html#is_on">is_on</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="HomeScreenConfig.html#starters">starters</a><span class="tsd-signature-symbol">?:</span> <a href="HomeScreenStarterButtons.html" class="tsd-signature-type tsd-kind-interface">HomeScreenStarterButtons</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="HomeScreenConfig.html#background" 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>background?</span></a>
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">HomeScreenConfig</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="HomeScreenConfig.html#allow_return">allow_return</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="HomeScreenConfig.html#background">background</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/HomeScreenBackgroundType.html" class="tsd-signature-type tsd-kind-enum">HomeScreenBackgroundType</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="HomeScreenConfig.html#bot_avatar_url">bot_avatar_url</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="HomeScreenConfig.html#custom_content_only">custom_content_only</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="HomeScreenConfig.html#greeting">greeting</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="HomeScreenConfig.html#is_on">is_on</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="HomeScreenConfig.html#starters">starters</a><span class="tsd-signature-symbol">?:</span> <a href="HomeScreenStarterButtons.html" class="tsd-signature-type tsd-kind-interface">HomeScreenStarterButtons</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="HomeScreenConfig.html#allow_return" 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>allow_<wbr/>return?</span></a>
3
+ <a href="HomeScreenConfig.html#background" 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>background?</span></a>
3
4
  <a href="HomeScreenConfig.html#bot_avatar_url" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bot_<wbr/>avatar_<wbr/>url?</span></a>
4
5
  <a href="HomeScreenConfig.html#custom_content_only" 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>custom_<wbr/>content_<wbr/>only?</span></a>
5
6
  <a href="HomeScreenConfig.html#greeting" 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>greeting?</span></a>
6
7
  <a href="HomeScreenConfig.html#is_on" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>on?</span></a>
7
8
  <a href="HomeScreenConfig.html#starters" 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>starters?</span></a>
8
- </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="background" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>background</span><a href="#background" 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">background</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/HomeScreenBackgroundType.html" class="tsd-signature-type tsd-kind-enum">HomeScreenBackgroundType</a></div><div class="tsd-comment tsd-typography"><p>The type of home screen background to render.</p>
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="allow_return" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>allow_<wbr/>return</span><a href="#allow_return" 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">allow_return</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Defaults to true. If enabled, a user can navigate back to the home screen after they have sent a message to the
10
+ assistant. If false, the home screen disappears forever after a message is sent.</p>
11
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="background" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>background</span><a href="#background" 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">background</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/HomeScreenBackgroundType.html" class="tsd-signature-type tsd-kind-enum">HomeScreenBackgroundType</a></div><div class="tsd-comment tsd-typography"><p>The type of home screen background to render.</p>
9
12
  </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="bot_avatar_url" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>bot_<wbr/>avatar_<wbr/>url</span><a href="#bot_avatar_url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">bot_avatar_url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>An image url that will override the bot avatar displayed in home screen.</p>
10
13
  </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="custom_content_only" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>custom_<wbr/>content_<wbr/>only</span><a href="#custom_content_only" 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">custom_content_only</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Do not show the greeting, starters, or avatar url.</p>
11
14
  </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="greeting" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>greeting</span><a href="#greeting" 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">greeting</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The greeting to show to the user to prompt them to start a conversation.</p>
12
15
  </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="is_on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>is_<wbr/>on</span><a href="#is_on" 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">is_on</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If the home page is turned on via config or remote config.</p>
13
16
  </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="starters" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>starters</span><a href="#starters" 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">starters</span><span class="tsd-signature-symbol">?:</span> <a href="HomeScreenStarterButtons.html" class="tsd-signature-type tsd-kind-interface">HomeScreenStarterButtons</a></div><div class="tsd-comment tsd-typography"><p>Optional conversation starter utterances that are displayed as buttons.</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="#background" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>background</span></a><a href="#bot_avatar_url" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bot_<wbr/>avatar_<wbr/>url</span></a><a href="#custom_content_only" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom_<wbr/>content_<wbr/>only</span></a><a href="#greeting" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>greeting</span></a><a href="#is_on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>on</span></a><a href="#starters" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>starters</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>
17
+ </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="#allow_return" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow_<wbr/>return</span></a><a href="#background" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>background</span></a><a href="#bot_avatar_url" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>bot_<wbr/>avatar_<wbr/>url</span></a><a href="#custom_content_only" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom_<wbr/>content_<wbr/>only</span></a><a href="#greeting" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>greeting</span></a><a href="#is_on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>on</span></a><a href="#starters" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>starters</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
package/dist/docs/carbon-tsdocs/interfaces/IFrameItem.html CHANGED
@@ -1,6 +1,6 @@
1
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>IFrameItem | 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="IFrameItem.html">IFrameItem</a></li></ul><h1>Interface IFrameItem&lt;TUserDefinedType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The basic class for items returned from a back-end as part of a message response. These are the items contained
2
2
  in the <a href="MessageOutput.html#generic" class="tsd-kind-property">MessageOutput.generic</a> array.</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">IFrameItem</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="IFrameItem.html#tuserdefinedtype">TUserDefinedType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="IFrameItem.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="IFrameItem.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="IFrameItem.html#display">display</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/IFrameItemDisplayOption.html" class="tsd-signature-type tsd-kind-enum">IFrameItemDisplayOption</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="IFrameItem.html#image_url">image_url</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="IFrameItem.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="IFrameItem.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="IFrameItem.html#source">source</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="IFrameItem.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="IFrameItem.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="IFrameItem.html#user_defined">user_defined</a><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="IFrameItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tuserdefinedtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TUserDefinedType</span> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="1135"><h4>Hierarchy (<a href="../hierarchy.html#IFrameItem">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="IFrameItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">IFrameItem</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="IFrameItem.html#agent_message_type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent_<wbr/>message_<wbr/>type?</span></a>
3
+ </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">IFrameItem</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="IFrameItem.html#tuserdefinedtype">TUserDefinedType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="IFrameItem.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="IFrameItem.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="IFrameItem.html#display">display</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/IFrameItemDisplayOption.html" class="tsd-signature-type tsd-kind-enum">IFrameItemDisplayOption</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="IFrameItem.html#image_url">image_url</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="IFrameItem.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="IFrameItem.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="IFrameItem.html#source">source</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="IFrameItem.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="IFrameItem.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="IFrameItem.html#user_defined">user_defined</a><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="IFrameItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tuserdefinedtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TUserDefinedType</span> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="1141"><h4>Hierarchy (<a href="../hierarchy.html#IFrameItem">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="IFrameItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">IFrameItem</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="IFrameItem.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>
4
4
  <a href="IFrameItem.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>
5
5
  <a href="IFrameItem.html#display" 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>display?</span></a>
6
6
  <a href="IFrameItem.html#image_url" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>image_<wbr/>url?</span></a>
package/dist/docs/carbon-tsdocs/interfaces/InlineErrorItem.html CHANGED
@@ -1,5 +1,5 @@
1
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>InlineErrorItem | 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="InlineErrorItem.html">InlineErrorItem</a></li></ul><h1>Interface InlineErrorItem&lt;TUserDefinedType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>An inline error response generated by a conversational skill provider with a user-friendly text and developer debug info.</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">InlineErrorItem</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="InlineErrorItem.html#tuserdefinedtype">TUserDefinedType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="InlineErrorItem.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="InlineErrorItem.html#debug">debug</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">info</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">statusCode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">text</span><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><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="InlineErrorItem.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="InlineErrorItem.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="InlineErrorItem.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="InlineErrorItem.html#text">text</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="InlineErrorItem.html#user_defined">user_defined</a><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="InlineErrorItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tuserdefinedtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TUserDefinedType</span> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="1152"><h4>Hierarchy (<a href="../hierarchy.html#InlineErrorItem">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="InlineErrorItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">InlineErrorItem</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="InlineErrorItem.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>
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">InlineErrorItem</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="InlineErrorItem.html#tuserdefinedtype">TUserDefinedType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="InlineErrorItem.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="InlineErrorItem.html#debug">debug</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">info</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">statusCode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">text</span><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><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="InlineErrorItem.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="InlineErrorItem.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="InlineErrorItem.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="InlineErrorItem.html#text">text</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="InlineErrorItem.html#user_defined">user_defined</a><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="InlineErrorItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tuserdefinedtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TUserDefinedType</span> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="1158"><h4>Hierarchy (<a href="../hierarchy.html#InlineErrorItem">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="InlineErrorItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">InlineErrorItem</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="InlineErrorItem.html#agent_message_type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent_<wbr/>message_<wbr/>type?</span></a>
3
3
  <a href="InlineErrorItem.html#debug" 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>debug?</span></a>
4
4
  <a href="InlineErrorItem.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>
5
5
  <a href="InlineErrorItem.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>
package/dist/docs/carbon-tsdocs/interfaces/MediaItem.html CHANGED
@@ -1,6 +1,6 @@
1
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>MediaItem | 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="MediaItem.html">MediaItem</a></li></ul><h1>Interface MediaItem&lt;TUserDefinedType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A reusable media object that may need to display a title and description with an alt_text to label the item for
2
2
  accessibility purposes. This is used by the Audio, Video and Image response types.</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">MediaItem</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MediaItem.html#tuserdefinedtype">TUserDefinedType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="MediaItem.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="MediaItem.html#alt_text">alt_text</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MediaItem.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="MediaItem.html#dimensions">dimensions</a><span class="tsd-signature-symbol">?:</span> <a href="MediaItemDimensions.html" class="tsd-signature-type tsd-kind-interface">MediaItemDimensions</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MediaItem.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="MediaItem.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="MediaItem.html#source">source</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="MediaItem.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="MediaItem.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="MediaItem.html#user_defined">user_defined</a><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="MediaItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tuserdefinedtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TUserDefinedType</span> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="1205"><h4>Hierarchy (<a href="../hierarchy.html#MediaItem">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MediaItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">MediaItem</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="MediaItem.html#agent_message_type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent_<wbr/>message_<wbr/>type?</span></a>
3
+ </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">MediaItem</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MediaItem.html#tuserdefinedtype">TUserDefinedType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="MediaItem.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="MediaItem.html#alt_text">alt_text</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MediaItem.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="MediaItem.html#dimensions">dimensions</a><span class="tsd-signature-symbol">?:</span> <a href="MediaItemDimensions.html" class="tsd-signature-type tsd-kind-interface">MediaItemDimensions</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MediaItem.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="MediaItem.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="MediaItem.html#source">source</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="MediaItem.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="MediaItem.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="MediaItem.html#user_defined">user_defined</a><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="MediaItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tuserdefinedtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TUserDefinedType</span> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="1211"><h4>Hierarchy (<a href="../hierarchy.html#MediaItem">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="MediaItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">MediaItem</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="MediaItem.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>
4
4
  <a href="MediaItem.html#alt_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>alt_<wbr/>text?</span></a>
5
5
  <a href="MediaItem.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
6
  <a href="MediaItem.html#dimensions" 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>dimensions?</span></a>
package/dist/docs/carbon-tsdocs/interfaces/MessageInput.html CHANGED
@@ -1,6 +1,6 @@
1
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>MessageInput | 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="MessageInput.html">MessageInput</a></li></ul><h1>Interface MessageInput</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The default interface for message input that is sent to a back-end in a message request. This represents basic text
2
2
  input.</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">MessageInput</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="MessageInput.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="MessageInput.html#message_type">message_type</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/MessageInputType.html" class="tsd-signature-type tsd-kind-enum">MessageInputType</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageInput.html#skill_complete">skill_complete</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageInput.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 tsd-hierarchy" data-refl="1234"><h4>Hierarchy (<a href="../hierarchy.html#MessageInput">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BaseMessageInput.html" class="tsd-signature-type tsd-kind-interface">BaseMessageInput</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">MessageInput</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="MessageInput.html#agent_message_type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent_<wbr/>message_<wbr/>type?</span></a>
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">MessageInput</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="MessageInput.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="MessageInput.html#message_type">message_type</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/MessageInputType.html" class="tsd-signature-type tsd-kind-enum">MessageInputType</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageInput.html#skill_complete">skill_complete</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageInput.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 tsd-hierarchy" data-refl="1240"><h4>Hierarchy (<a href="../hierarchy.html#MessageInput">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BaseMessageInput.html" class="tsd-signature-type tsd-kind-interface">BaseMessageInput</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">MessageInput</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="MessageInput.html#agent_message_type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent_<wbr/>message_<wbr/>type?</span></a>
4
4
  <a href="MessageInput.html#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>message_<wbr/>type?</span></a>
5
5
  <a href="MessageInput.html#skill_complete" 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>skill_<wbr/>complete?</span></a>
6
6
  <a href="MessageInput.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>
package/dist/docs/carbon-tsdocs/interfaces/MessageItemPanelInfo.html CHANGED
@@ -1,4 +1,4 @@
1
- <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MessageItemPanelInfo | 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="MessageItemPanelInfo.html">MessageItemPanelInfo</a></li></ul><h1>Interface MessageItemPanelInfo</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MessageItemPanelInfo</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="MessageItemPanelInfo.html#body">body</a><span class="tsd-signature-symbol">?:</span> <a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageItemPanelInfo.html#footer">footer</a><span class="tsd-signature-symbol">?:</span> <a href="ButtonItem.html" class="tsd-signature-type tsd-kind-interface">ButtonItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageItemPanelInfo.html#show_animations">show_animations</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageItemPanelInfo.html#show_header">show_header</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageItemPanelInfo.html#title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="1243"><h4>Hierarchy (<a href="../hierarchy.html#MessageItemPanelInfo">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="WithBodyAndFooter.html" class="tsd-signature-type tsd-kind-interface">WithBodyAndFooter</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">MessageItemPanelInfo</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="MessageItemPanelInfo.html#body" 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>body?</span></a>
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>MessageItemPanelInfo | 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="MessageItemPanelInfo.html">MessageItemPanelInfo</a></li></ul><h1>Interface MessageItemPanelInfo</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">MessageItemPanelInfo</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="MessageItemPanelInfo.html#body">body</a><span class="tsd-signature-symbol">?:</span> <a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageItemPanelInfo.html#footer">footer</a><span class="tsd-signature-symbol">?:</span> <a href="ButtonItem.html" class="tsd-signature-type tsd-kind-interface">ButtonItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageItemPanelInfo.html#show_animations">show_animations</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageItemPanelInfo.html#show_header">show_header</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="MessageItemPanelInfo.html#title">title</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="1249"><h4>Hierarchy (<a href="../hierarchy.html#MessageItemPanelInfo">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="WithBodyAndFooter.html" class="tsd-signature-type tsd-kind-interface">WithBodyAndFooter</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">MessageItemPanelInfo</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="MessageItemPanelInfo.html#body" 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>body?</span></a>
2
2
  <a href="MessageItemPanelInfo.html#footer" 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>footer?</span></a>
3
3
  <a href="MessageItemPanelInfo.html#show_animations" 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>show_<wbr/>animations?</span></a>
4
4
  <a href="MessageItemPanelInfo.html#show_header" 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>show_<wbr/>header?</span></a>