@burtson-labs/bandit-engine 2.0.8

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 (184) hide show
  1. package/LICENSE +43 -0
  2. package/README.md +1235 -0
  3. package/dist/aiProviderStore-YWJHSWFA.mjs +9 -0
  4. package/dist/aiProviderStore-YWJHSWFA.mjs.map +1 -0
  5. package/dist/chat-QXB526NZ.mjs +11 -0
  6. package/dist/chat-QXB526NZ.mjs.map +1 -0
  7. package/dist/chunk-AVC6IZJQ.mjs +2157 -0
  8. package/dist/chunk-AVC6IZJQ.mjs.map +1 -0
  9. package/dist/chunk-BIPELT57.mjs +24183 -0
  10. package/dist/chunk-BIPELT57.mjs.map +1 -0
  11. package/dist/chunk-BJTO5JO5.mjs +11 -0
  12. package/dist/chunk-BJTO5JO5.mjs.map +1 -0
  13. package/dist/chunk-IXIM7BNO.mjs +39 -0
  14. package/dist/chunk-IXIM7BNO.mjs.map +1 -0
  15. package/dist/chunk-KCI46M23.mjs +106 -0
  16. package/dist/chunk-KCI46M23.mjs.map +1 -0
  17. package/dist/chunk-WYS5CZVG.mjs +843 -0
  18. package/dist/chunk-WYS5CZVG.mjs.map +1 -0
  19. package/dist/cli/cli.js +1808 -0
  20. package/dist/cli/cli.js.map +1 -0
  21. package/dist/index.d.mts +1636 -0
  22. package/dist/index.d.ts +1636 -0
  23. package/dist/index.js +40601 -0
  24. package/dist/index.js.map +1 -0
  25. package/dist/index.mjs +12477 -0
  26. package/dist/index.mjs.map +1 -0
  27. package/dist/memoryUtils-33TZKHSQ.mjs +223 -0
  28. package/dist/memoryUtils-33TZKHSQ.mjs.map +1 -0
  29. package/dist/modelStore-Y3LZWRQC.mjs +9 -0
  30. package/dist/modelStore-Y3LZWRQC.mjs.map +1 -0
  31. package/dist/shared/custom-element.js +73 -0
  32. package/dist/shared/custom-element.js.map +1 -0
  33. package/dist/shared/custom-element.mjs +8 -0
  34. package/dist/shared/custom-element.mjs.map +1 -0
  35. package/docs/00_intro.md +26 -0
  36. package/docs/01_quickstart.md +54 -0
  37. package/docs/02_gateway_api.md +64 -0
  38. package/docs/03_provider_integration.md +38 -0
  39. package/docs/04_local_dev.md +43 -0
  40. package/docs/05_cli_quickstart.md +89 -0
  41. package/docs/05_contributing.md +33 -0
  42. package/docs/06_busl_licensing.md +25 -0
  43. package/docs/README.md +9 -0
  44. package/docs/api_reference/.nojekyll +1 -0
  45. package/docs/api_reference/assets/highlight.css +141 -0
  46. package/docs/api_reference/assets/icons.js +18 -0
  47. package/docs/api_reference/assets/icons.svg +1 -0
  48. package/docs/api_reference/assets/main.js +60 -0
  49. package/docs/api_reference/assets/navigation.js +1 -0
  50. package/docs/api_reference/assets/search.js +1 -0
  51. package/docs/api_reference/assets/style.css +1493 -0
  52. package/docs/api_reference/classes/DebugLogger.html +29 -0
  53. package/docs/api_reference/classes/FeatureFlagService.html +28 -0
  54. package/docs/api_reference/classes/NotificationService.html +21 -0
  55. package/docs/api_reference/classes/StreamingTTSClient.html +19 -0
  56. package/docs/api_reference/classes/VectorDatabaseService.html +63 -0
  57. package/docs/api_reference/classes/VectorMigrationService.html +27 -0
  58. package/docs/api_reference/classes/VoiceService.html +4 -0
  59. package/docs/api_reference/enums/TTSState.html +6 -0
  60. package/docs/api_reference/functions/Chat.html +1 -0
  61. package/docs/api_reference/functions/ChatModal.html +29 -0
  62. package/docs/api_reference/functions/ChatProvider.html +29 -0
  63. package/docs/api_reference/functions/FeatureFlagProvider.html +30 -0
  64. package/docs/api_reference/functions/FeedbackButton.html +29 -0
  65. package/docs/api_reference/functions/FeedbackModal.html +29 -0
  66. package/docs/api_reference/functions/Management.html +1 -0
  67. package/docs/api_reference/functions/NotificationProvider.html +29 -0
  68. package/docs/api_reference/functions/SubscriptionExpiredGuard.html +31 -0
  69. package/docs/api_reference/functions/SubscriptionExpiredModal.html +31 -0
  70. package/docs/api_reference/functions/defineCustomElement.html +1 -0
  71. package/docs/api_reference/functions/getCriticalConfig.html +1 -0
  72. package/docs/api_reference/functions/getFeatureMatrix.html +1 -0
  73. package/docs/api_reference/functions/getStreamingTTSClient.html +1 -0
  74. package/docs/api_reference/functions/getSystemConstants.html +1 -0
  75. package/docs/api_reference/functions/getTTSState.html +1 -0
  76. package/docs/api_reference/functions/handleHttpError.html +2 -0
  77. package/docs/api_reference/functions/handleSubscriptionUpgrade.html +1 -0
  78. package/docs/api_reference/functions/handleValidationError.html +2 -0
  79. package/docs/api_reference/functions/initializeCoreSystem.html +1 -0
  80. package/docs/api_reference/functions/pauseTTS.html +1 -0
  81. package/docs/api_reference/functions/previewTierUpgrade.html +1 -0
  82. package/docs/api_reference/functions/resumeTTS.html +1 -0
  83. package/docs/api_reference/functions/showInfoNotification.html +2 -0
  84. package/docs/api_reference/functions/showSuccessNotification.html +2 -0
  85. package/docs/api_reference/functions/speakWithStreaming.html +1 -0
  86. package/docs/api_reference/functions/stopTTS.html +1 -0
  87. package/docs/api_reference/functions/syncSubscriptionWithAPI.html +1 -0
  88. package/docs/api_reference/functions/updateSubscriptionTier.html +2 -0
  89. package/docs/api_reference/functions/useFeatureFlag.html +2 -0
  90. package/docs/api_reference/functions/useFeatureVisibility.html +2 -0
  91. package/docs/api_reference/functions/useFeatures.html +2 -0
  92. package/docs/api_reference/functions/useGatewayHealth.html +1 -0
  93. package/docs/api_reference/functions/useGatewayMemory.html +1 -0
  94. package/docs/api_reference/functions/useGatewayModels.html +1 -0
  95. package/docs/api_reference/functions/useGlobalTTS.html +2 -0
  96. package/docs/api_reference/functions/useNotification.html +1 -0
  97. package/docs/api_reference/functions/useNotificationService.html +6 -0
  98. package/docs/api_reference/functions/useTTS.html +2 -0
  99. package/docs/api_reference/functions/useVectorStore.html +13 -0
  100. package/docs/api_reference/functions/useVoiceStore.html +8 -0
  101. package/docs/api_reference/functions/useVoices.html +3 -0
  102. package/docs/api_reference/functions/validateEnvironment.html +1 -0
  103. package/docs/api_reference/functions/validateSystemIntegrity.html +1 -0
  104. package/docs/api_reference/index.html +756 -0
  105. package/docs/api_reference/interfaces/AIChatRequest.html +8 -0
  106. package/docs/api_reference/interfaces/AIChatResponse.html +3 -0
  107. package/docs/api_reference/interfaces/AIGenerateRequest.html +5 -0
  108. package/docs/api_reference/interfaces/AIGenerateResponse.html +3 -0
  109. package/docs/api_reference/interfaces/AIMessage.html +4 -0
  110. package/docs/api_reference/interfaces/AIModel.html +6 -0
  111. package/docs/api_reference/interfaces/AIProviderConfig.html +9 -0
  112. package/docs/api_reference/interfaces/ChatConfig.html +5 -0
  113. package/docs/api_reference/interfaces/CreateMemoryOptions.html +7 -0
  114. package/docs/api_reference/interfaces/FeatureEvaluation.html +14 -0
  115. package/docs/api_reference/interfaces/FeatureFlagConfig.html +18 -0
  116. package/docs/api_reference/interfaces/FeatureFlagContextValue.html +16 -0
  117. package/docs/api_reference/interfaces/FeatureFlagProviderProps.html +4 -0
  118. package/docs/api_reference/interfaces/FeedbackButtonProps.html +19 -0
  119. package/docs/api_reference/interfaces/FeedbackCategories.html +6 -0
  120. package/docs/api_reference/interfaces/FeedbackModalProps.html +4 -0
  121. package/docs/api_reference/interfaces/FeedbackPriorities.html +5 -0
  122. package/docs/api_reference/interfaces/FeedbackRequest.html +12 -0
  123. package/docs/api_reference/interfaces/FeedbackResponse.html +7 -0
  124. package/docs/api_reference/interfaces/FileUploadResult.html +4 -0
  125. package/docs/api_reference/interfaces/GatewayChatRequest.html +12 -0
  126. package/docs/api_reference/interfaces/GatewayChatResponse.html +7 -0
  127. package/docs/api_reference/interfaces/GatewayContract.html +4 -0
  128. package/docs/api_reference/interfaces/GatewayGenerateRequest.html +8 -0
  129. package/docs/api_reference/interfaces/GatewayGenerateResponse.html +12 -0
  130. package/docs/api_reference/interfaces/GatewayHealthResponse.html +5 -0
  131. package/docs/api_reference/interfaces/GatewayMemoryRecord.html +7 -0
  132. package/docs/api_reference/interfaces/GatewayMemoryResponse.html +4 -0
  133. package/docs/api_reference/interfaces/GatewayMessage.html +5 -0
  134. package/docs/api_reference/interfaces/GatewayMessageContent.html +4 -0
  135. package/docs/api_reference/interfaces/GatewayModel.html +9 -0
  136. package/docs/api_reference/interfaces/GatewayModelsResponse.html +2 -0
  137. package/docs/api_reference/interfaces/MemorySearchFilters.html +5 -0
  138. package/docs/api_reference/interfaces/MigrationProgress.html +6 -0
  139. package/docs/api_reference/interfaces/MigrationStatus.html +7 -0
  140. package/docs/api_reference/interfaces/NotificationConfig.html +5 -0
  141. package/docs/api_reference/interfaces/NotificationContextType.html +6 -0
  142. package/docs/api_reference/interfaces/NotificationProviderProps.html +4 -0
  143. package/docs/api_reference/interfaces/PackageSettings.html +11 -0
  144. package/docs/api_reference/interfaces/SearchOptions.html +6 -0
  145. package/docs/api_reference/interfaces/SearchResult.html +5 -0
  146. package/docs/api_reference/interfaces/SubscriptionExpiredGuardProps.html +7 -0
  147. package/docs/api_reference/interfaces/SubscriptionExpiredModalProps.html +6 -0
  148. package/docs/api_reference/interfaces/TTSOptions.html +5 -0
  149. package/docs/api_reference/interfaces/TTSProgress.html +6 -0
  150. package/docs/api_reference/interfaces/TrialUsage.html +6 -0
  151. package/docs/api_reference/interfaces/UploadRequest.html +9 -0
  152. package/docs/api_reference/interfaces/UseTTSReturn.html +14 -0
  153. package/docs/api_reference/interfaces/VectorDocument.html +11 -0
  154. package/docs/api_reference/interfaces/VectorMemory.html +12 -0
  155. package/docs/api_reference/interfaces/VectorMemoryMetadata.html +7 -0
  156. package/docs/api_reference/interfaces/VectorStoreStatus.html +7 -0
  157. package/docs/api_reference/interfaces/VoiceModelsResponse.html +4 -0
  158. package/docs/api_reference/interfaces/VoiceState.html +12 -0
  159. package/docs/api_reference/media/02_gateway_api.md +64 -0
  160. package/docs/api_reference/media/05_cli_quickstart.md +89 -0
  161. package/docs/api_reference/media/LICENSE +43 -0
  162. package/docs/api_reference/media/PRE-PUSH-CHECKLIST.md +10 -0
  163. package/docs/api_reference/media/PROTECTION-NOTICE.md +60 -0
  164. package/docs/api_reference/media/PROTECTION-README.md +41 -0
  165. package/docs/api_reference/media/README-1.md +23 -0
  166. package/docs/api_reference/media/README.md +9 -0
  167. package/docs/api_reference/modules.html +123 -0
  168. package/docs/api_reference/types/FeatureKey.html +2 -0
  169. package/docs/api_reference/types/FeatureMatrix.html +2 -0
  170. package/docs/api_reference/types/GatewayQueryOptions.html +1 -0
  171. package/docs/api_reference/types/LogContext.html +14 -0
  172. package/docs/api_reference/types/SubscriptionTier.html +2 -0
  173. package/docs/api_reference/variables/DEFAULT_TIER_FEATURES.html +2 -0
  174. package/docs/api_reference/variables/FeatureFlagContext.html +1 -0
  175. package/docs/api_reference/variables/OSS_DEFAULT_FEATURES.html +2 -0
  176. package/docs/api_reference/variables/SYSTEM_FLAGS.html +1 -0
  177. package/docs/api_reference/variables/authenticationService.html +1 -0
  178. package/docs/api_reference/variables/debugLogger-1.html +1 -0
  179. package/docs/api_reference/variables/featureFlagService-1.html +2 -0
  180. package/docs/api_reference/variables/notificationService-1.html +1 -0
  181. package/docs/api_reference/variables/vectorDatabaseService-1.html +1 -0
  182. package/docs/api_reference/variables/vectorMigrationService-1.html +1 -0
  183. package/docs/api_reference/variables/voiceService-1.html +1 -0
  184. package/package.json +103 -0
package/docs/api_reference/interfaces/VectorMemory.html ADDED
@@ -0,0 +1,12 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VectorMemory | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><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></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" data-base=".."><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"><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">@burtson-labs/bandit-engine</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"><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="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="VectorMemory.html">VectorMemory</a></li></ul><h1>Interface VectorMemory</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">VectorMemory</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemory.html#content">content</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemory.html#id">id</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemory.html#lastReferencedAt">lastReferencedAt</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemory.html#metadata">metadata</a><span class="tsd-signature-symbol">?: </span><a href="VectorMemoryMetadata.html" class="tsd-signature-type tsd-kind-interface">VectorMemoryMetadata</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemory.html#pinned">pinned</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemory.html#score">score</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemory.html#source">source</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">&quot;auto&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;user&quot;</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemory.html#tags">tags</a><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><br/><span>    </span><a class="tsd-kind-property" href="VectorMemory.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>    </span><a class="tsd-kind-property" href="VectorMemory.html#uploadedAt">uploadedAt</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemory.html#uploadedBy">uploadedBy</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><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L21">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:21</a></li></ul></aside><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"><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="VectorMemory.html#content" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>content</span></a>
2
+ <a href="VectorMemory.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
3
+ <a href="VectorMemory.html#lastReferencedAt" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Referenced<wbr/>At?</span></a>
4
+ <a href="VectorMemory.html#metadata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>metadata?</span></a>
5
+ <a href="VectorMemory.html#pinned" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pinned?</span></a>
6
+ <a href="VectorMemory.html#score" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>score?</span></a>
7
+ <a href="VectorMemory.html#source" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>source?</span></a>
8
+ <a href="VectorMemory.html#tags" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tags?</span></a>
9
+ <a href="VectorMemory.html#title" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title?</span></a>
10
+ <a href="VectorMemory.html#uploadedAt" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uploaded<wbr/>At</span></a>
11
+ <a href="VectorMemory.html#uploadedBy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uploaded<wbr/>By</span></a>
12
+ </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"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="content" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>content</span><a href="#content" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">content</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L23">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:23</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L22">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:22</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lastReferencedAt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>last<wbr/>Referenced<wbr/>At</span><a href="#lastReferencedAt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">last<wbr/>Referenced<wbr/>At</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L31">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="metadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>metadata</span><a href="#metadata" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">metadata</span><span class="tsd-signature-symbol">?:</span> <a href="VectorMemoryMetadata.html" class="tsd-signature-type tsd-kind-interface">VectorMemoryMetadata</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L32">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="pinned" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>pinned</span><a href="#pinned" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">pinned</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L30">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="score" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>score</span><a href="#score" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">score</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L26">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="source" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>source</span><a href="#source" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">source</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">&quot;auto&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;user&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L29">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>tags</span><a href="#tags" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tags</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L25">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="title" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>title</span><a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L24">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:24</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="uploadedAt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>uploaded<wbr/>At</span><a href="#uploadedAt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">uploaded<wbr/>At</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L28">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="uploadedBy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>uploaded<wbr/>By</span><a href="#uploadedBy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">uploaded<wbr/>By</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L27">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:27</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><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"><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="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#content" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>content</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#lastReferencedAt" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Referenced<wbr/>At</span></a><a href="#metadata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>metadata</span></a><a href="#pinned" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pinned</span></a><a href="#score" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>score</span></a><a href="#source" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>source</span></a><a href="#tags" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tags</span></a><a href="#title" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>title</span></a><a href="#uploadedAt" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uploaded<wbr/>At</span></a><a href="#uploadedBy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>uploaded<wbr/>By</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@burtson-labs/bandit-engine</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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/docs/api_reference/interfaces/VectorMemoryMetadata.html ADDED
@@ -0,0 +1,7 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VectorMemoryMetadata | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><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></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" data-base=".."><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"><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">@burtson-labs/bandit-engine</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"><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="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="VectorMemoryMetadata.html">VectorMemoryMetadata</a></li></ul><h1>Interface VectorMemoryMetadata</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">VectorMemoryMetadata</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemoryMetadata.html#additionalProperties">additionalProperties</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">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemoryMetadata.html#engagement">engagement</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemoryMetadata.html#extractedFrom">extractedFrom</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemoryMetadata.html#personalConfidence">personalConfidence</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorMemoryMetadata.html#tags">tags</a><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><br/><span>    </span><a class="tsd-kind-property" href="VectorMemoryMetadata.html#topic">topic</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span>[<span class="tsd-kind-index-signature">key</span>: <span class="tsd-signature-type">string</span>]<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4 class="tsd-before-signature">Indexable</h4><ul class="tsd-signatures"><li class="tsd-index-signature"><div class="tsd-signature"><span class="tsd-signature-symbol">[</span><span class="tsd-kind-parameter">key</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">unknown</span></div></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L35">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:35</a></li></ul></aside><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"><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="VectorMemoryMetadata.html#additionalProperties" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>additional<wbr/>Properties?</span></a>
2
+ <a href="VectorMemoryMetadata.html#engagement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>engagement?</span></a>
3
+ <a href="VectorMemoryMetadata.html#extractedFrom" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extracted<wbr/>From?</span></a>
4
+ <a href="VectorMemoryMetadata.html#personalConfidence" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>personal<wbr/>Confidence?</span></a>
5
+ <a href="VectorMemoryMetadata.html#tags" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tags?</span></a>
6
+ <a href="VectorMemoryMetadata.html#topic" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>topic?</span></a>
7
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="additionalProperties" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>additional<wbr/>Properties</span><a href="#additionalProperties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">additional<wbr/>Properties</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></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L41">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:41</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="engagement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>engagement</span><a href="#engagement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">engagement</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L38">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="extractedFrom" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>extracted<wbr/>From</span><a href="#extractedFrom" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">extracted<wbr/>From</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L39">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:39</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="personalConfidence" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>personal<wbr/>Confidence</span><a href="#personalConfidence" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">personal<wbr/>Confidence</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L36">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="tags" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>tags</span><a href="#tags" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">tags</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L40">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:40</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="topic" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>topic</span><a href="#topic" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">topic</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts#L37">packages/bandit-engine/src/services/vectorDatabase/vectorDatabaseService.ts:37</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><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"><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="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#additionalProperties" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>additional<wbr/>Properties</span></a><a href="#engagement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>engagement</span></a><a href="#extractedFrom" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>extracted<wbr/>From</span></a><a href="#personalConfidence" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>personal<wbr/>Confidence</span></a><a href="#tags" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tags</span></a><a href="#topic" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>topic</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@burtson-labs/bandit-engine</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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/docs/api_reference/interfaces/VectorStoreStatus.html ADDED
@@ -0,0 +1,7 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VectorStoreStatus | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><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></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" data-base=".."><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"><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">@burtson-labs/bandit-engine</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"><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="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="VectorStoreStatus.html">VectorStoreStatus</a></li></ul><h1>Interface VectorStoreStatus</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">VectorStoreStatus</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="VectorStoreStatus.html#isAvailable">isAvailable</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorStoreStatus.html#isEnabled">isEnabled</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorStoreStatus.html#isMigrating">isMigrating</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorStoreStatus.html#lastError">lastError</a><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorStoreStatus.html#migrationProgress">migrationProgress</a><span class="tsd-signature-symbol">?: </span><a href="MigrationProgress.html" class="tsd-signature-type tsd-kind-interface">MigrationProgress</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VectorStoreStatus.html#migrationRequired">migrationRequired</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/hooks/useVectorStore.tsx#L32">packages/bandit-engine/src/hooks/useVectorStore.tsx:32</a></li></ul></aside><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"><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="VectorStoreStatus.html#isAvailable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Available</span></a>
2
+ <a href="VectorStoreStatus.html#isEnabled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Enabled</span></a>
3
+ <a href="VectorStoreStatus.html#isMigrating" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Migrating</span></a>
4
+ <a href="VectorStoreStatus.html#lastError" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Error?</span></a>
5
+ <a href="VectorStoreStatus.html#migrationProgress" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>migration<wbr/>Progress?</span></a>
6
+ <a href="VectorStoreStatus.html#migrationRequired" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>migration<wbr/>Required</span></a>
7
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="isAvailable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Available</span><a href="#isAvailable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Available</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/hooks/useVectorStore.tsx#L34">packages/bandit-engine/src/hooks/useVectorStore.tsx:34</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isEnabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Enabled</span><a href="#isEnabled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Enabled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/hooks/useVectorStore.tsx#L33">packages/bandit-engine/src/hooks/useVectorStore.tsx:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isMigrating" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Migrating</span><a href="#isMigrating" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Migrating</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/hooks/useVectorStore.tsx#L35">packages/bandit-engine/src/hooks/useVectorStore.tsx:35</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="lastError" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>last<wbr/>Error</span><a href="#lastError" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">last<wbr/>Error</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/hooks/useVectorStore.tsx#L38">packages/bandit-engine/src/hooks/useVectorStore.tsx:38</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="migrationProgress" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>migration<wbr/>Progress</span><a href="#migrationProgress" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">migration<wbr/>Progress</span><span class="tsd-signature-symbol">?:</span> <a href="MigrationProgress.html" class="tsd-signature-type tsd-kind-interface">MigrationProgress</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/hooks/useVectorStore.tsx#L37">packages/bandit-engine/src/hooks/useVectorStore.tsx:37</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="migrationRequired" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>migration<wbr/>Required</span><a href="#migrationRequired" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">migration<wbr/>Required</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/hooks/useVectorStore.tsx#L36">packages/bandit-engine/src/hooks/useVectorStore.tsx:36</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><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"><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="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#isAvailable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Available</span></a><a href="#isEnabled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Enabled</span></a><a href="#isMigrating" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Migrating</span></a><a href="#lastError" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>last<wbr/>Error</span></a><a href="#migrationProgress" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>migration<wbr/>Progress</span></a><a href="#migrationRequired" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>migration<wbr/>Required</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@burtson-labs/bandit-engine</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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/docs/api_reference/interfaces/VoiceModelsResponse.html ADDED
@@ -0,0 +1,4 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VoiceModelsResponse | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><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></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" data-base=".."><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"><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">@burtson-labs/bandit-engine</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"><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="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="VoiceModelsResponse.html">VoiceModelsResponse</a></li></ul><h1>Interface VoiceModelsResponse</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">VoiceModelsResponse</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceModelsResponse.html#defaultModel">defaultModel</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceModelsResponse.html#fallbackModel">fallbackModel</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceModelsResponse.html#models">models</a><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><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/tts/voiceService.ts#L23">packages/bandit-engine/src/services/tts/voiceService.ts:23</a></li></ul></aside><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"><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="VoiceModelsResponse.html#defaultModel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Model</span></a>
2
+ <a href="VoiceModelsResponse.html#fallbackModel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fallback<wbr/>Model</span></a>
3
+ <a href="VoiceModelsResponse.html#models" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>models</span></a>
4
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="defaultModel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>default<wbr/>Model</span><a href="#defaultModel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Model</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/tts/voiceService.ts#L25">packages/bandit-engine/src/services/tts/voiceService.ts:25</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fallbackModel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fallback<wbr/>Model</span><a href="#fallbackModel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fallback<wbr/>Model</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/tts/voiceService.ts#L26">packages/bandit-engine/src/services/tts/voiceService.ts:26</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="models" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>models</span><a href="#models" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">models</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/services/tts/voiceService.ts#L24">packages/bandit-engine/src/services/tts/voiceService.ts:24</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><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"><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="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#defaultModel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Model</span></a><a href="#fallbackModel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fallback<wbr/>Model</span></a><a href="#models" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>models</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@burtson-labs/bandit-engine</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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/docs/api_reference/interfaces/VoiceState.html ADDED
@@ -0,0 +1,12 @@
1
+ <!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VoiceState | @burtson-labs/bandit-engine</title><meta name="description" content="Documentation for @burtson-labs/bandit-engine"/><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></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" data-base=".."><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"><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">@burtson-labs/bandit-engine</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"><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="../modules.html">@burtson-labs/bandit-engine</a></li><li><a href="VoiceState.html">VoiceState</a></li></ul><h1>Interface VoiceState</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">VoiceState</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceState.html#availableVoices">availableVoices</a><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><br/><span>    </span><a class="tsd-kind-property" href="VoiceState.html#defaultVoice">defaultVoice</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceState.html#fallbackVoice">fallbackVoice</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceState.html#forceInitialize">forceInitialize</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceState.html#initialized">initialized</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceState.html#isLoading">isLoading</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceState.html#isServiceAvailable">isServiceAvailable</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceState.html#loadVoicesFromAPI">loadVoicesFromAPI</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceState.html#refreshVoices">refreshVoices</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceState.html#selectedVoice">selectedVoice</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><a class="tsd-kind-property" href="VoiceState.html#setSelectedVoice">setSelectedVoice</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">voice</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L27">packages/bandit-engine/src/store/voiceStore.ts:27</a></li></ul></aside><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"><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="VoiceState.html#availableVoices" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>available<wbr/>Voices</span></a>
2
+ <a href="VoiceState.html#defaultVoice" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Voice</span></a>
3
+ <a href="VoiceState.html#fallbackVoice" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fallback<wbr/>Voice</span></a>
4
+ <a href="VoiceState.html#forceInitialize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>force<wbr/>Initialize</span></a>
5
+ <a href="VoiceState.html#initialized" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>initialized</span></a>
6
+ <a href="VoiceState.html#isLoading" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Loading</span></a>
7
+ <a href="VoiceState.html#isServiceAvailable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Service<wbr/>Available</span></a>
8
+ <a href="VoiceState.html#loadVoicesFromAPI" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>load<wbr/>Voices<wbr/>FromAPI</span></a>
9
+ <a href="VoiceState.html#refreshVoices" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh<wbr/>Voices</span></a>
10
+ <a href="VoiceState.html#selectedVoice" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected<wbr/>Voice</span></a>
11
+ <a href="VoiceState.html#setSelectedVoice" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Selected<wbr/>Voice</span></a>
12
+ </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"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="availableVoices" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>available<wbr/>Voices</span><a href="#availableVoices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">available<wbr/>Voices</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L28">packages/bandit-engine/src/store/voiceStore.ts:28</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="defaultVoice" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>default<wbr/>Voice</span><a href="#defaultVoice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">default<wbr/>Voice</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L30">packages/bandit-engine/src/store/voiceStore.ts:30</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="fallbackVoice" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fallback<wbr/>Voice</span><a href="#fallbackVoice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">fallback<wbr/>Voice</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L31">packages/bandit-engine/src/store/voiceStore.ts:31</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="forceInitialize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>force<wbr/>Initialize</span><a href="#forceInitialize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">force<wbr/>Initialize</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L38">packages/bandit-engine/src/store/voiceStore.ts:38</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="initialized" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>initialized</span><a href="#initialized" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">initialized</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L34">packages/bandit-engine/src/store/voiceStore.ts:34</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isLoading" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Loading</span><a href="#isLoading" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Loading</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L32">packages/bandit-engine/src/store/voiceStore.ts:32</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="isServiceAvailable" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Service<wbr/>Available</span><a href="#isServiceAvailable" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">is<wbr/>Service<wbr/>Available</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L33">packages/bandit-engine/src/store/voiceStore.ts:33</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="loadVoicesFromAPI" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>load<wbr/>Voices<wbr/>FromAPI</span><a href="#loadVoicesFromAPI" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">load<wbr/>Voices<wbr/>FromAPI</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L36">packages/bandit-engine/src/store/voiceStore.ts:36</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="refreshVoices" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>refresh<wbr/>Voices</span><a href="#refreshVoices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">refresh<wbr/>Voices</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L37">packages/bandit-engine/src/store/voiceStore.ts:37</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="selectedVoice" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>selected<wbr/>Voice</span><a href="#selectedVoice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">selected<wbr/>Voice</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L29">packages/bandit-engine/src/store/voiceStore.ts:29</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="setSelectedVoice" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Selected<wbr/>Voice</span><a href="#setSelectedVoice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">set<wbr/>Selected<wbr/>Voice</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">voice</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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Burtson-Labs/bandit/blob/32fb833168530285448be3061b05dc43e4a8f3d2/packages/bandit-engine/src/store/voiceStore.ts#L35">packages/bandit-engine/src/store/voiceStore.ts:35</a></li></ul></aside></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><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"><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="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#availableVoices" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>available<wbr/>Voices</span></a><a href="#defaultVoice" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>default<wbr/>Voice</span></a><a href="#fallbackVoice" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fallback<wbr/>Voice</span></a><a href="#forceInitialize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>force<wbr/>Initialize</span></a><a href="#initialized" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>initialized</span></a><a href="#isLoading" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Loading</span></a><a href="#isServiceAvailable" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Service<wbr/>Available</span></a><a href="#loadVoicesFromAPI" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>load<wbr/>Voices<wbr/>FromAPI</span></a><a href="#refreshVoices" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>refresh<wbr/>Voices</span></a><a href="#selectedVoice" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected<wbr/>Voice</span></a><a href="#setSelectedVoice" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>set<wbr/>Selected<wbr/>Voice</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@burtson-labs/bandit-engine</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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/docs/api_reference/media/02_gateway_api.md ADDED
@@ -0,0 +1,64 @@
1
+ # Gateway API Contract
2
+ ## Overview
3
+ The gateway centralizes every provider integration behind a single authenticated endpoint. Bandit Engine forwards chat, generation, memory, and health requests without leaking provider credentials to the browser. This contract is language agnostic—implement it in Node.js, Python, Go, .NET, or any platform that can speak HTTP.
4
+
5
+ ## Endpoints / API Usage
6
+ | Endpoint | Method | Description |
7
+ | --- | --- | --- |
8
+ | `/api/health` | GET | Returns gateway uptime, provider availability, and semantic version. |
9
+ | `/api/models` | GET | Lists models available across providers with metadata consumed by the management UI. |
10
+ | `/api/memory` | GET | Optional endpoint that returns stored memory records for the active tenant. |
11
+ | `/api/chat/completions` | POST | Streams chat responses using Server-Sent Events or chunked JSON. |
12
+ | `/api/generate` | POST | Handles non-chat text generation and returns chunked JSON for streaming. |
13
+ | `/api/feedback` | POST | (Optional) Collects in-app feedback and attachments. |
14
+ | `/api/tts`, `/api/stt`, `/api/tts/available-models` | POST/GET | Optional voice endpoints for advanced deployments. |
15
+
16
+ Every request must include `Authorization: Bearer <token>`. Tokens are injected by Bandit Engine via Axios interceptors, so your gateway only needs to validate the credential and map it to your auth system.
17
+
18
+ ## Example Implementation
19
+ ```ts
20
+ import express from "express";
21
+ import fetch from "node-fetch";
22
+
23
+ const app = express();
24
+ app.use(express.json());
25
+
26
+ app.get("/api/health", (req, res) => {
27
+ res.json({
28
+ status: "healthy",
29
+ providers: ["openai", "ollama"],
30
+ version: "1.0.0"
31
+ });
32
+ });
33
+
34
+ app.post("/api/chat/completions", async (req, res) => {
35
+ const { provider, model, messages } = req.body;
36
+ const upstream = provider === "ollama"
37
+ ? `${process.env.OLLAMA_URL}/api/chat`
38
+ : "https://api.openai.com/v1/chat/completions";
39
+
40
+ const response = await fetch(upstream, {
41
+ method: "POST",
42
+ headers: {
43
+ "Content-Type": "application/json",
44
+ Authorization: provider === "ollama" ? undefined : `Bearer ${process.env.OPENAI_KEY}`
45
+ },
46
+ body: JSON.stringify({ model, messages })
47
+ });
48
+
49
+ res.status(response.status);
50
+ response.body?.pipe(res);
51
+ });
52
+ ```
53
+ See [`examples/gateway-node`](../examples/gateway-node) for a complete runnable server with environment configuration and npm scripts.
54
+
55
+ ## Integration Notes
56
+ - **Streaming**: Preserve chunked responses when proxying to providers. The client will parse each `data:` line.
57
+ - **Provider-specific routes**: Bandit Engine automatically swaps endpoints such as `/api/ollama/chat` or `/api/openai/chat/completions` when a provider is specified.
58
+ - **Error handling**: Return structured JSON with `message` and `details` to take advantage of the engine's notification system.
59
+ - **Security**: Perform rate limiting, audit logging, and token verification on the gateway—never in the browser.
60
+
61
+ ## Related Files
62
+ - [`src/services/gateway/gateway.service.ts`](../src/services/gateway/gateway.service.ts)
63
+ - [`src/types/gateway.ts`](../src/types/gateway.ts)
64
+ - [`docs/03_provider_integration.md`](./03_provider_integration.md)
package/docs/api_reference/media/05_cli_quickstart.md ADDED
@@ -0,0 +1,89 @@
1
+ # Bandit CLI Quick Start
2
+
3
+ The Bandit CLI ships with this package and scaffolds a ready-to-run playground complete with a Vite + React frontend, Bandit Engine wiring, and a lightweight Express gateway. Use it when you want to see the engine in action or hand teammates a reproducible starting point.
4
+
5
+ ## Requirements
6
+
7
+ - Node.js 18 or newer
8
+ - npm (or any package manager that can run npm scripts)
9
+
10
+ ## Create a project
11
+
12
+ ```bash
13
+ npx @burtson-labs/bandit-engine create my-bandit-app
14
+ ```
15
+
16
+ When the CLI finishes you will have a directory that contains:
17
+
18
+ - `src/` — a Vite + React app with `ChatProvider`, `Chat`, and a launchable modal
19
+ - `public/config.json` — branding + persona defaults that load at runtime
20
+ - `server/gateway.js` — Express proxy for OpenAI or Ollama
21
+ - `.env.example` — environment flags for the frontend and gateway
22
+ - `.npmrc` — points the `@burtson-labs` scope at GitHub Packages and pulls `GITHUB_NPM_TOKEN` from your environment
23
+
24
+ Run the following commands to start development:
25
+
26
+ ```bash
27
+ cd my-bandit-app
28
+ npm install
29
+ cp .env.example .env
30
+ npm run dev
31
+ ```
32
+
33
+ The script runs the gateway and the frontend concurrently. Visit `http://localhost:5183` and start chatting.
34
+
35
+ > **Authentication**
36
+ > Because the package is currently private, authenticate with GitHub Packages before installing dependencies.
37
+ > 1. Run `npm login --registry=https://npm.pkg.github.com --scope=@burtson-labs`, **or** set `export GITHUB_NPM_TOKEN=<your PAT>` in your shell.
38
+ > 2. The generated `.npmrc` reads `GITHUB_NPM_TOKEN` automatically, so `npm install` can pull `@burtson-labs` packages.
39
+
40
+ ## Common options
41
+
42
+ | Flag | Description |
43
+ | ---- | ----------- |
44
+ | `--branding-text <text>` | Sets the UI label for the assistant. |
45
+ | `--frontend-port <number>` | Changes the Vite dev server port (defaults to `5183`). |
46
+ | `--gateway-port <number>` | Changes the Express gateway port (defaults to `8080`). |
47
+ | `--yes` / `--skip-prompts` | Skips interactive questions and accepts defaults. |
48
+ | `--force` | Overwrites the target directory if it already contains files. |
49
+
50
+ Examples:
51
+
52
+ ```bash
53
+ npx @burtson-labs/bandit-engine create bandit-dashboard \
54
+ --branding-text "Bandit Ops" \
55
+ --frontend-port 5190 \
56
+ --gateway-port 9090
57
+ ```
58
+
59
+ The CLI validates the target directory (use `--force` to overwrite), seeds `public/config.json` with a branded display name, and writes the selected ports into `.env.example`. Adjust those values any time to suit your environment.
60
+
61
+ ## Configure .env for Ollama
62
+
63
+ Prefer Ollama over OpenAI? After copying `.env.example` to `.env`, replace the provider and model variables:
64
+
65
+ ```ini
66
+ VITE_GATEWAY_PROVIDER=ollama
67
+ VITE_DEFAULT_MODEL=llava:latest # or any model installed on your Ollama host
68
+ VITE_FALLBACK_MODEL=gemma2:9b-instruct # optional, useful for text-only fallbacks
69
+ OLLAMA_URL=http://localhost:11434
70
+ ```
71
+
72
+ Pull the models you reference with `ollama pull llava:latest`, `ollama pull gemma2:9b-instruct`, or any custom tags you maintain. Bandit automatically leverages multimodal Ollama builds (LLaVA, Gemma vision, Moondream, etc.), so image uploads are routed to models that understand them.
73
+
74
+ ## Gateway behaviour
75
+
76
+ The generated `server/gateway.js` demonstrates the minimal contract described in [`docs/02_gateway_api.md`](./02_gateway_api.md):
77
+
78
+ - `GET /api/health` responds with version and provider summary.
79
+ - `GET /api/models` returns the `BASE_GATEWAY_MODELS` entries for management UI usage.
80
+ - `POST /api/chat/completions` proxies to the selected provider (OpenAI or Ollama).
81
+ - `POST /api/generate` handles non-chat prompts.
82
+
83
+ Extend the gateway to add authentication, logging, or additional providers before shipping to production.
84
+
85
+ ## Next steps
86
+
87
+ - Update `.env` with an `OPENAI_API_KEY` or point `OLLAMA_URL` at your local server.
88
+ - Adjust `public/config.json` to fine-tune branding, default personas, or knowledge docs.
89
+ - Deploy the gateway somewhere secure and point `VITE_GATEWAY_URL` at it for production builds.
package/docs/api_reference/media/LICENSE ADDED
@@ -0,0 +1,43 @@
1
+ Business Source License 1.1
2
+
3
+ Copyright © 2025 Burtson Labs
4
+
5
+ Licensed for:
6
+ - Personal, educational, and non-commercial use
7
+ - 30-day commercial evaluation period (no production deployment)
8
+
9
+ NOT licensed for:
10
+ - Commercial use in production environments
11
+ - Integration in SaaS or client-facing products
12
+ - Rebranding, sublicensing, or redistribution
13
+
14
+ This license converts to Apache 2.0 after 2 years.
15
+
16
+ https://burtson.ai/license
17
+
18
+ ---
19
+
20
+ Parameters
21
+
22
+ Licensor: Burtson Labs LLC
23
+ Licensed Work: Bandit Engine AI Chat Application
24
+ The Licensed Work is © 2025 Burtson Labs
25
+ Additional Use Grant: You may make use of the Licensed Work, provided that you do not use
26
+ the Licensed Work for a Commercial Use. A "Commercial Use" means use of
27
+ the Licensed Work in production, or any other use that is primarily
28
+ intended for or directed toward commercial advantage or monetary
29
+ compensation.
30
+ Change Date: January 1, 2027
31
+ Change License: Apache License, Version 2.0
32
+
33
+ For information about alternative licensing arrangements for the Licensed Work,
34
+ please visit: https://burtson.ai/license
35
+
36
+ Notice
37
+
38
+ The Business Source License (this document, or the "License") is not an Open Source
39
+ license. However, the Licensed Work will eventually be made available under an Open
40
+ Source License, as stated in this License.
41
+
42
+ License text copyright © 2017 MariaDB Corporation Ab, All Rights Reserved.
43
+ "Business Source License" is a trademark of MariaDB Corporation Ab.
package/docs/api_reference/media/PRE-PUSH-CHECKLIST.md ADDED
@@ -0,0 +1,10 @@
1
+ # Bandit Engine Pre-Push Checklist
2
+
3
+ Run this sequence before pushing changes or cutting a release tag:
4
+
5
+ 1. `npm run lint` – top-level lint sweep with shared ESLint rules.
6
+ 2. `npm run test --workspace @burtson-labs/bandit-engine` – vitest suite.
7
+ 3. `npm run build --workspace @burtson-labs/bandit-engine` – tsup build for both module formats.
8
+ 4. `npm run docs --workspace @burtson-labs/bandit-engine` – regenerate TypeDoc HTML and commit updated output.
9
+ 5. `npm pack --dry-run --workspace @burtson-labs/bandit-engine` – verify the publish payload (no private app assets).
10
+ 6. `git status` – ensure only intentional files are staged; add release notes or docs as needed.