From bf8166eeab769cf21d96a00746ac08a8ba3a19e7 Mon Sep 17 00:00:00 2001
From: WFH Brian <brian@plexm.com>
Date: Tue, 16 Apr 2024 16:16:29 -0400
Subject: [PATCH] smart_chat jsdocs

---
 docs/AnthropicAdapter.html                    |    2 +-
 docs/CohereAdapter.html                       |    2 +-
 docs/Collection.html                          |    2 +-
 docs/CollectionItem.html                      |    2 +-
 docs/GeminiAdapter.html                       |    2 +-
 docs/ObsAJSON.html                            |    2 +-
 docs/ObsMultiAJSON.html                       |    2 +-
 docs/ObsidianAJSON.html                       |    2 +-
 docs/SmartChat.html                           | 2570 ++++++++++++++++-
 docs/SmartChatModel.html                      |    2 +-
 docs/SmartChats.html                          |    2 +-
 docs/SmartEmbed.html                          |    2 +-
 docs/SmartMarkdown.html                       |    2 +-
 docs/SmartSocket.html                         |    2 +-
 docs/global.html                              |    2 +-
 docs/index.html                               |    2 +-
 ...mart-chat-model_adapters_anthropic.js.html |    2 +-
 docs/smart-chat-model_adapters_cohere.js.html |    2 +-
 ...rt-chat-model_adapters_cohere.test.js.html |    2 +-
 docs/smart-chat-model_adapters_gemini.js.html |    2 +-
 ...at-model_dist_smart_chat_model_web.js.html |    2 +-
 .../smart-chat-model_smart_chat_model.js.html |    2 +-
 docs/smart-chat-model_streamer.js.html        |    2 +-
 ...hat-model_utils_is_valid_tool_call.js.html |    2 +-
 docs/smart-chats_smart_chat.js.html           |  143 +-
 docs/smart-chats_smart_chat_md.js.html        |    2 +-
 docs/smart-chats_smart_chats.js.html          |    2 +-
 docs/smart-chunks_SmartMarkdown.js.html       |    2 +-
 docs/smart-collections_Collection.js.html     |    2 +-
 docs/smart-collections_CollectionItem.js.html |    2 +-
 docs/smart-collections_ObsAJSON.js.html       |    2 +-
 docs/smart-collections_ObsMultiAJSON.js.html  |    2 +-
 docs/smart-collections_ObsidianAJSON.js.html  |    2 +-
 docs/smart-collections_helpers.js.html        |    2 +-
 docs/smart-embed_SmartEmbed.js.html           |    2 +-
 docs/smart-embed_smart_socket.js.html         |    2 +-
 smart-chats/smart_chat.js                     |  141 +-
 37 files changed, 2859 insertions(+), 63 deletions(-)

diff --git a/docs/AnthropicAdapter.html b/docs/AnthropicAdapter.html
index 110debee..68d940c3 100644
--- a/docs/AnthropicAdapter.html
+++ b/docs/AnthropicAdapter.html
@@ -1453,7 +1453,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/CohereAdapter.html b/docs/CohereAdapter.html
index 1e49174f..75a5bc7f 100644
--- a/docs/CohereAdapter.html
+++ b/docs/CohereAdapter.html
@@ -803,7 +803,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/Collection.html b/docs/Collection.html
index 78608cd8..34189f24 100644
--- a/docs/Collection.html
+++ b/docs/Collection.html
@@ -3098,7 +3098,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/CollectionItem.html b/docs/CollectionItem.html
index 6c2be25b..ac1646b9 100644
--- a/docs/CollectionItem.html
+++ b/docs/CollectionItem.html
@@ -1855,7 +1855,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/GeminiAdapter.html b/docs/GeminiAdapter.html
index 61487bb7..6b26f69b 100644
--- a/docs/GeminiAdapter.html
+++ b/docs/GeminiAdapter.html
@@ -1796,7 +1796,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/ObsAJSON.html b/docs/ObsAJSON.html
index addedb09..5fe6bd8d 100644
--- a/docs/ObsAJSON.html
+++ b/docs/ObsAJSON.html
@@ -649,7 +649,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/ObsMultiAJSON.html b/docs/ObsMultiAJSON.html
index b3b7d657..c968f631 100644
--- a/docs/ObsMultiAJSON.html
+++ b/docs/ObsMultiAJSON.html
@@ -803,7 +803,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/ObsidianAJSON.html b/docs/ObsidianAJSON.html
index 51170475..a9346ff5 100644
--- a/docs/ObsidianAJSON.html
+++ b/docs/ObsidianAJSON.html
@@ -622,7 +622,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/SmartChat.html b/docs/SmartChat.html
index c51318d8..120aa4ad 100644
--- a/docs/SmartChat.html
+++ b/docs/SmartChat.html
@@ -28,12 +28,10 @@ <h1 class="page-title">Class: SmartChat</h1>
 
 <header>
     
-        <h2><span class="attribs"><span class="type-signature"></span></span>SmartChat<span class="signature">(env, conversation_id, data)</span><span class="type-signature"></span></h2>
+        <h2><span class="attribs"><span class="type-signature"></span></span>SmartChat<span class="signature">(env, key, data<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
         
-            <div class="class-description"><h2>A chat session in a SmartChat environment.</h2>
-<p>Base class format follows ChatML JSON spec.
-Subclasses should override to_chatml, from_chatml, and parse_user_message to
-provide file-type specific parsing and formatting.</p></div>
+            <div class="class-description"><p>Represents a chat session within a SmartChat environment, handling the creation,
+manipulation, and storage of chat data in a structured format (ChatML).</p></div>
         
     
 </header>
@@ -48,7 +46,7 @@ <h2>Constructor</h2>
     
 
     
-    <h4 class="name" id="SmartChat"><span class="type-signature"></span>new SmartChat<span class="signature">(env, conversation_id, data)</span><span class="type-signature"></span></h4>
+    <h4 class="name" id="SmartChat"><span class="type-signature"></span>new SmartChat<span class="signature">(env, key, data<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
     
 
     
@@ -76,8 +74,12 @@ <h5>Parameters:</h5>
         <th>Type</th>
 
         
+        <th>Attributes</th>
+        
 
         
+        <th>Default</th>
+        
 
         <th class="last">Description</th>
     </tr>
@@ -101,17 +103,29 @@ <h5>Parameters:</h5>
             </td>
 
             
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
 
             
+                <td class="default">
+                
+                </td>
+            
 
-            <td class="description last"><p>The SmartChat environment.</p></td>
+            <td class="description last"><p>The SmartChat environment object which provides context and utilities.</p></td>
         </tr>
 
     
 
         <tr>
             
-                <td class="name"><code>conversation_id</code></td>
+                <td class="name"><code>key</code></td>
             
 
             <td class="type">
@@ -124,10 +138,22 @@ <h5>Parameters:</h5>
             </td>
 
             
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
 
             
+                <td class="default">
+                
+                </td>
+            
 
-            <td class="description last"><p>The ID of the conversation.</p></td>
+            <td class="description last"><p>The unique identifier for the chat session.</p></td>
         </tr>
 
     
@@ -147,10 +173,26 @@ <h5>Parameters:</h5>
             </td>
 
             
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
 
             
+                <td class="default">
+                
+                    ''
+                
+                </td>
+            
 
-            <td class="description last"><p>The data of the conversation.</p></td>
+            <td class="description last"><p>Initial data for the chat session, typically in a structured format.</p></td>
         </tr>
 
     
@@ -191,7 +233,7 @@ <h5>Parameters:</h5>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line12">line 12</a>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line10">line 10</a>
     </li></ul></dd>
     
 
@@ -237,10 +279,2514 @@ <h5>Parameters:</h5>
     
 
     
+        <h3 class="subsection-title">Members</h3>
+
+        
+            
+<h4 class="name" id="file_path"><span class="type-signature"></span>file_path<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    <p>Computes the file path for the current chat session based on its key and file type.</p>
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line41">line 41</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="file_type"><span class="type-signature"></span>file_type<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    <p>Returns the file type for the chat session, used in file operations.</p>
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line189">line 189</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+        
+            
+<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"></span></h4>
+
+
+
+
+<div class="description">
+    <p>Returns the name (key) of the chat session.</p>
+</div>
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line48">line 48</a>
+    </li></ul></dd>
+    
+
+    
 
     
 
     
+</dl>
+
+
+
+
+
+
+        
+    
+
+    
+        <h3 class="subsection-title">Methods</h3>
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="add_message"><span class="type-signature">(async) </span>add_message<span class="signature">(msg<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Adds a new message to the chat session.</p>
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+        <th>Attributes</th>
+        
+
+        
+        <th>Default</th>
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>msg</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Object</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                    {}
+                
+                </td>
+            
+
+            <td class="description last"><p>The message object to add.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line87">line 87</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;void></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="add_tool_output"><span class="type-signature">(async) </span>add_tool_output<span class="signature">(tool_name, tool_output)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Adds output from a tool to the chat session as a message.</p>
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>tool_name</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The name of the tool.</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>tool_output</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">*</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The output from the tool.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line100">line 100</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;void></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="delete"><span class="type-signature">(async) </span>delete<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Deletes the chat session file from the file system.</p>
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line132">line 132</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;void></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="exists"><span class="type-signature">(async) </span>exists<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;boolean>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Checks if the chat session file exists in the file system.</p>
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line139">line 139</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>True if the file exists, false otherwise.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;boolean></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="from_chatml"><span class="type-signature"></span>from_chatml<span class="signature">(data)</span><span class="type-signature"> &rarr; {string}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Converts a ChatML object back into a string or suitable format for storage. This method should be overridden in subclasses.</p>
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>data</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Object</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The ChatML object to convert.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line205">line 205</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>The string or formatted data.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">string</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="get_chat_ml"><span class="type-signature">(async) </span>get_chat_ml<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Object>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Retrieves the ChatML object from the current session data.</p>
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line156">line 156</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>The ChatML object.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;Object></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="get_messages"><span class="type-signature">(async) </span>get_messages<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;Array>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Retrieves all messages from the ChatML object of the current session.</p>
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line167">line 167</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>An array of message objects.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;Array></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="get_messages_html"><span class="type-signature">(async) </span>get_messages_html<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;string>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Retrieves all messages from the chat session and converts them to HTML format.</p>
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line71">line 71</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>A string containing all messages in HTML format.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;string></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="load"><span class="type-signature">(async) </span>load<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;string>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Loads the chat session data from the file system.</p>
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line146">line 146</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>The loaded data.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;string></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="new_user_message"><span class="type-signature">(async) </span>new_user_message<span class="signature">(content)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Processes a new user message, updates UI/UX, and adds it to the chat session.</p>
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>content</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The content of the user message.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line175">line 175</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;void></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="parse_user_message"><span class="type-signature">(async) </span>parse_user_message<span class="signature">(content)</span><span class="type-signature"> &rarr; {Promise.&lt;string>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Parses the user message content before adding it to the chat. This method can be overridden to include custom parsing logic.</p>
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>content</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The content to parse.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line213">line 213</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>The parsed content.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;string></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="rename"><span class="type-signature">(async) </span>rename<span class="signature">(new_id)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Renames the current chat session and updates the storage references.</p>
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>new_id</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The new identifier for the chat session.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line56">line 56</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;void></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="save"><span class="type-signature">(async) </span>save<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Saves the current chat session data to the file system.</p>
+</div>
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line125">line 125</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;void></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="to_chatml"><span class="type-signature"></span>to_chatml<span class="signature">(data)</span><span class="type-signature"> &rarr; {Object}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Converts the provided data into a ChatML object. This method should be overridden in subclasses.</p>
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>data</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The data to convert.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line197">line 197</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>The ChatML object.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Object</span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id="update"><span class="type-signature">(async) </span>update<span class="signature">(chat_ml)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Updates the chat session data with the provided ChatML object and saves it.</p>
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>chat_ml</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Object</span>
+
+
+            
+            </td>
+
+            
+
+            
+
+            <td class="description last"><p>The ChatML object to update the session with.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line115">line 115</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type">Promise.&lt;void></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+            
+
+    
+
+    
+    <h4 class="name" id=".create"><span class="type-signature">(static) </span>create<span class="signature">(env, key<span class="signature-attributes">opt</span>, data<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {<a href="SmartChat.html">SmartChat</a>}</span></h4>
+    
+
+    
+
+
+
+<div class="description">
+    <p>Factory method to create a new SmartChat instance with a unique key or a default one.</p>
+</div>
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Name</th>
+        
+
+        <th>Type</th>
+
+        
+        <th>Attributes</th>
+        
+
+        
+        <th>Default</th>
+        
+
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+
+    <tbody>
+    
+
+        <tr>
+            
+                <td class="name"><code>env</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">SmartEnv</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                </td>
+            
+
+            <td class="description last"><p>The SmartChat environment object.</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>key</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                    null
+                
+                </td>
+            
+
+            <td class="description last"><p>Optional key for the chat session. If not provided, a default is generated.</p></td>
+        </tr>
+
+    
+
+        <tr>
+            
+                <td class="name"><code>data</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">string</span>
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                    ''
+                
+                </td>
+            
+
+            <td class="description last"><p>Initial data for the chat session.</p></td>
+        </tr>
+
+    
+    </tbody>
+</table>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source"><ul class="dummy"><li>
+        <a href="smart-chats_smart_chat.js.html">smart-chats/smart_chat.js</a>, <a href="smart-chats_smart_chat.js.html#line30">line 30</a>
+    </li></ul></dd>
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<h5>Returns:</h5>
+
+        
+<div class="param-desc">
+    <p>A new instance of SmartChat.</p>
+</div>
+
+
+
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+        
+<span class="param-type"><a href="SmartChat.html">SmartChat</a></span>
+
+
+    </dd>
+</dl>
+
+    
+
+
+
+
+
+        
+    
+
+    
 
     
 </article>
@@ -259,7 +2805,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/SmartChatModel.html b/docs/SmartChatModel.html
index a0728b68..a406039c 100644
--- a/docs/SmartChatModel.html
+++ b/docs/SmartChatModel.html
@@ -1422,7 +1422,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/SmartChats.html b/docs/SmartChats.html
index 08309c1c..78dfba3d 100644
--- a/docs/SmartChats.html
+++ b/docs/SmartChats.html
@@ -787,7 +787,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/SmartEmbed.html b/docs/SmartEmbed.html
index 2d5ee336..698a688c 100644
--- a/docs/SmartEmbed.html
+++ b/docs/SmartEmbed.html
@@ -1240,7 +1240,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/SmartMarkdown.html b/docs/SmartMarkdown.html
index 295a16e7..21609875 100644
--- a/docs/SmartMarkdown.html
+++ b/docs/SmartMarkdown.html
@@ -2144,7 +2144,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/SmartSocket.html b/docs/SmartSocket.html
index fdd38215..5c68ddd8 100644
--- a/docs/SmartSocket.html
+++ b/docs/SmartSocket.html
@@ -1585,7 +1585,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/global.html b/docs/global.html
index ea30cfc6..46a7cdce 100644
--- a/docs/global.html
+++ b/docs/global.html
@@ -2570,7 +2570,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/index.html b/docs/index.html
index 9d851baf..1ad3c87e 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -56,7 +56,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chat-model_adapters_anthropic.js.html b/docs/smart-chat-model_adapters_anthropic.js.html
index f2b07705..3270d21b 100644
--- a/docs/smart-chat-model_adapters_anthropic.js.html
+++ b/docs/smart-chat-model_adapters_anthropic.js.html
@@ -153,7 +153,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chat-model_adapters_cohere.js.html b/docs/smart-chat-model_adapters_cohere.js.html
index fd977b3b..9fe11e7b 100644
--- a/docs/smart-chat-model_adapters_cohere.js.html
+++ b/docs/smart-chat-model_adapters_cohere.js.html
@@ -131,7 +131,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chat-model_adapters_cohere.test.js.html b/docs/smart-chat-model_adapters_cohere.test.js.html
index 63c6a984..201056d4 100644
--- a/docs/smart-chat-model_adapters_cohere.test.js.html
+++ b/docs/smart-chat-model_adapters_cohere.test.js.html
@@ -151,7 +151,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chat-model_adapters_gemini.js.html b/docs/smart-chat-model_adapters_gemini.js.html
index cb383b59..af9b4efb 100644
--- a/docs/smart-chat-model_adapters_gemini.js.html
+++ b/docs/smart-chat-model_adapters_gemini.js.html
@@ -224,7 +224,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chat-model_dist_smart_chat_model_web.js.html b/docs/smart-chat-model_dist_smart_chat_model_web.js.html
index 3697286d..12841763 100644
--- a/docs/smart-chat-model_dist_smart_chat_model_web.js.html
+++ b/docs/smart-chat-model_dist_smart_chat_model_web.js.html
@@ -991,7 +991,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chat-model_smart_chat_model.js.html b/docs/smart-chat-model_smart_chat_model.js.html
index b084b680..ee23cdaf 100644
--- a/docs/smart-chat-model_smart_chat_model.js.html
+++ b/docs/smart-chat-model_smart_chat_model.js.html
@@ -387,7 +387,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chat-model_streamer.js.html b/docs/smart-chat-model_streamer.js.html
index 2ae8c57f..7078ac57 100644
--- a/docs/smart-chat-model_streamer.js.html
+++ b/docs/smart-chat-model_streamer.js.html
@@ -223,7 +223,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chat-model_utils_is_valid_tool_call.js.html b/docs/smart-chat-model_utils_is_valid_tool_call.js.html
index 13321da7..7ab5cdb8 100644
--- a/docs/smart-chat-model_utils_is_valid_tool_call.js.html
+++ b/docs/smart-chat-model_utils_is_valid_tool_call.js.html
@@ -118,7 +118,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chats_smart_chat.js.html b/docs/smart-chats_smart_chat.js.html
index a56da253..ff70c5d2 100644
--- a/docs/smart-chats_smart_chat.js.html
+++ b/docs/smart-chats_smart_chat.js.html
@@ -27,15 +27,13 @@ <h1 class="page-title">Source: smart-chats/smart_chat.js</h1>
     <section>
         <article>
             <pre class="prettyprint source linenums"><code>/**
- * A chat session in a SmartChat environment.
- * ---
- * Base class format follows ChatML JSON spec.
- * Subclasses should override to_chatml, from_chatml, and parse_user_message to 
- * provide file-type specific parsing and formatting.
+ * Represents a chat session within a SmartChat environment, handling the creation,
+ * manipulation, and storage of chat data in a structured format (ChatML).
  * 
- * @param {SmartEnv} env - The SmartChat environment.
- * @param {string} conversation_id - The ID of the conversation.
- * @param {string} data - The data of the conversation.
+ * @class
+ * @param {SmartEnv} env - The SmartChat environment object which provides context and utilities.
+ * @param {string} key - The unique identifier for the chat session.
+ * @param {string} [data=''] - Initial data for the chat session, typically in a structured format.
  */
 class SmartChat {
   constructor(env, key, data='') {
@@ -47,13 +45,42 @@ <h1 class="page-title">Source: smart-chats/smart_chat.js</h1>
     // exported for convenience (unnecessary??? may load the chats directly)
     if(this.chats) this.chats.items[this.key] = this;
   }
+
+  /**
+   * Factory method to create a new SmartChat instance with a unique key or a default one.
+   * 
+   * @static
+   * @param {SmartEnv} env - The SmartChat environment object.
+   * @param {string} [key=null] - Optional key for the chat session. If not provided, a default is generated.
+   * @param {string} [data=''] - Initial data for the chat session.
+   * @returns {SmartChat} A new instance of SmartChat.
+   */
   static create(env, key=null, data='') {
     if(!key) key = 'UNTITLED CHAT ' + get_file_date_string();
     const chat = new this(env, key, data);
     return chat;
   }
+
+  /**
+   * Computes the file path for the current chat session based on its key and file type.
+   * 
+   * @returns {string} The file path for the chat session.
+   */
   get file_path() { return `${this.chats.folder}/${this.key}.${this.file_type}`; }
+
+  /**
+   * Returns the name (key) of the chat session.
+   * 
+   * @returns {string} The key of the chat session.
+   */
   get name() { return this.key; }
+
+  /**
+   * Renames the current chat session and updates the storage references.
+   * 
+   * @param {string} new_id - The new identifier for the chat session.
+   * @returns {Promise&lt;void>}
+   */
   async rename(new_id) {
     // console.log('renaming', this.key, new_id);
     if (this.key === new_id) return;
@@ -63,6 +90,12 @@ <h1 class="page-title">Source: smart-chats/smart_chat.js</h1>
     this.chats.items[this.key] = this;
     await this.save();
   }
+
+  /**
+   * Retrieves all messages from the chat session and converts them to HTML format.
+   * 
+   * @returns {Promise&lt;string>} A string containing all messages in HTML format.
+   */
   async get_messages_html(){
     const messages = await this.get_messages();
     const html = await Promise.all(messages.map(async msg => {
@@ -72,11 +105,26 @@ <h1 class="page-title">Source: smart-chats/smart_chat.js</h1>
     }));
     return html.join('');
   }
+
+  /**
+   * Adds a new message to the chat session.
+   * 
+   * @param {Object} [msg={}] - The message object to add.
+   * @returns {Promise&lt;void>}
+   */
   async add_message(msg={}){
     const chat_ml = await this.get_chat_ml();
     chat_ml.messages.push(msg);
     await this.update(chat_ml);
   }
+
+  /**
+   * Adds output from a tool to the chat session as a message.
+   * 
+   * @param {string} tool_name - The name of the tool.
+   * @param {*} tool_output - The output from the tool.
+   * @returns {Promise&lt;void>}
+   */
   async add_tool_output(tool_name, tool_output){
     if(typeof this.env.actions.parse_tool_output === 'function'){
       const message = await this.env.actions.parse_tool_output(tool_name, tool_output);
@@ -84,24 +132,74 @@ <h1 class="page-title">Source: smart-chats/smart_chat.js</h1>
     }
     await this.add_message({role: 'tool', tool_call_id: tool_name, content: JSON.stringify(tool_output)});
   }
+
   // file-type specific parsing and formatting overrides
+  /**
+   * Updates the chat session data with the provided ChatML object and saves it.
+   * 
+   * @param {Object} chat_ml - The ChatML object to update the session with.
+   * @returns {Promise&lt;void>}
+   */
   async update(chat_ml){
     this.data = this.from_chatml(chat_ml);
     await this.save();
   }
+
+  /**
+   * Saves the current chat session data to the file system.
+   * 
+   * @returns {Promise&lt;void>}
+   */
   async save() { return await this.chats.save(this.file_path, this.data); }
+
+  /**
+   * Deletes the chat session file from the file system.
+   * 
+   * @returns {Promise&lt;void>}
+   */
   async delete() { return await this.chats.delete(this.file_path); }
+
+  /**
+   * Checks if the chat session file exists in the file system.
+   * 
+   * @returns {Promise&lt;boolean>} True if the file exists, false otherwise.
+   */
   async exists() { return await this.chats.exists(this.file_path); }
+
+  /**
+   * Loads the chat session data from the file system.
+   * 
+   * @returns {Promise&lt;string>} The loaded data.
+   */
   async load() {
     if(!await this.exists()) return this.data = '';
     return this.data = await this.chats.read(this.file_path);
   }
+
+  /**
+   * Retrieves the ChatML object from the current session data.
+   * 
+   * @returns {Promise&lt;Object>} The ChatML object.
+   */
   async get_chat_ml() {
     await this.load();
     const chat_ml = this.to_chatml(this.data);
     return chat_ml;
   }
+
+  /**
+   * Retrieves all messages from the ChatML object of the current session.
+   * 
+   * @returns {Promise&lt;Array>} An array of message objects.
+   */
   async get_messages() { return (await this.get_chat_ml()).messages; }
+
+  /**
+   * Processes a new user message, updates UI/UX, and adds it to the chat session.
+   * 
+   * @param {string} content - The content of the user message.
+   * @returns {Promise&lt;void>}
+   */
   async new_user_message(content){
     content = await this.parse_user_message(content);
     if(typeof this.env?.chat_ui?.new_user_message === 'function') await this.env.chat_ui.new_user_message(content); // UI/UX
@@ -109,10 +207,37 @@ <h1 class="page-title">Source: smart-chats/smart_chat.js</h1>
     await this.add_message({role: 'user', content});
     await this.env.chat_model.complete({});
   }
+
   // Override these for file-type specific parsing and formatting in subclasses
+  /**
+   * Returns the file type for the chat session, used in file operations.
+   * 
+   * @returns {string} The file type, default is 'json'.
+   */
   get file_type() { return 'json'; }
+
+  /**
+   * Converts the provided data into a ChatML object. This method should be overridden in subclasses.
+   * 
+   * @param {string} data - The data to convert.
+   * @returns {Object} The ChatML object.
+   */
   to_chatml(data) { return data; }
+
+  /**
+   * Converts a ChatML object back into a string or suitable format for storage. This method should be overridden in subclasses.
+   * 
+   * @param {Object} data - The ChatML object to convert.
+   * @returns {string} The string or formatted data.
+   */
   from_chatml(data) { return data; }
+
+  /**
+   * Parses the user message content before adding it to the chat. This method can be overridden to include custom parsing logic.
+   * 
+   * @param {string} content - The content to parse.
+   * @returns {Promise&lt;string>} The parsed content.
+   */
   async parse_user_message(content) { return content; }
 }
 function get_file_date_string() { return new Date().toISOString().replace(/(T|:|\..*)/g, " ").trim(); }
@@ -132,7 +257,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chats_smart_chat_md.js.html b/docs/smart-chats_smart_chat_md.js.html
index fad39820..2bf96a36 100644
--- a/docs/smart-chats_smart_chat_md.js.html
+++ b/docs/smart-chats_smart_chat_md.js.html
@@ -202,7 +202,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chats_smart_chats.js.html b/docs/smart-chats_smart_chats.js.html
index 8723f8d0..3f8fd9f4 100644
--- a/docs/smart-chats_smart_chats.js.html
+++ b/docs/smart-chats_smart_chats.js.html
@@ -164,7 +164,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-chunks_SmartMarkdown.js.html b/docs/smart-chunks_SmartMarkdown.js.html
index e1c27029..b4719adf 100644
--- a/docs/smart-chunks_SmartMarkdown.js.html
+++ b/docs/smart-chunks_SmartMarkdown.js.html
@@ -316,7 +316,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-collections_Collection.js.html b/docs/smart-collections_Collection.js.html
index 6081ced6..2a0bd74e 100644
--- a/docs/smart-collections_Collection.js.html
+++ b/docs/smart-collections_Collection.js.html
@@ -296,7 +296,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-collections_CollectionItem.js.html b/docs/smart-collections_CollectionItem.js.html
index ab7d0c27..b5bb030e 100644
--- a/docs/smart-collections_CollectionItem.js.html
+++ b/docs/smart-collections_CollectionItem.js.html
@@ -223,7 +223,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-collections_ObsAJSON.js.html b/docs/smart-collections_ObsAJSON.js.html
index 6ae65b3b..fa725485 100644
--- a/docs/smart-collections_ObsAJSON.js.html
+++ b/docs/smart-collections_ObsAJSON.js.html
@@ -169,7 +169,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-collections_ObsMultiAJSON.js.html b/docs/smart-collections_ObsMultiAJSON.js.html
index 045d0323..952acfd7 100644
--- a/docs/smart-collections_ObsMultiAJSON.js.html
+++ b/docs/smart-collections_ObsMultiAJSON.js.html
@@ -154,7 +154,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-collections_ObsidianAJSON.js.html b/docs/smart-collections_ObsidianAJSON.js.html
index c3e366f8..8cde4d6e 100644
--- a/docs/smart-collections_ObsidianAJSON.js.html
+++ b/docs/smart-collections_ObsidianAJSON.js.html
@@ -136,7 +136,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-collections_helpers.js.html b/docs/smart-collections_helpers.js.html
index e2e970d4..4de82f8e 100644
--- a/docs/smart-collections_helpers.js.html
+++ b/docs/smart-collections_helpers.js.html
@@ -133,7 +133,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-embed_SmartEmbed.js.html b/docs/smart-embed_SmartEmbed.js.html
index 90f6027b..cfed59f3 100644
--- a/docs/smart-embed_SmartEmbed.js.html
+++ b/docs/smart-embed_SmartEmbed.js.html
@@ -128,7 +128,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/docs/smart-embed_smart_socket.js.html b/docs/smart-embed_smart_socket.js.html
index e48dad20..51608317 100644
--- a/docs/smart-embed_smart_socket.js.html
+++ b/docs/smart-embed_smart_socket.js.html
@@ -237,7 +237,7 @@ <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Anthropic
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:09:25 GMT-0400 (Eastern Daylight Time)
+    Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Apr 16 2024 16:16:21 GMT-0400 (Eastern Daylight Time)
 </footer>
 
 <script> prettyPrint(); </script>
diff --git a/smart-chats/smart_chat.js b/smart-chats/smart_chat.js
index 4cf8fae4..664c7605 100644
--- a/smart-chats/smart_chat.js
+++ b/smart-chats/smart_chat.js
@@ -1,13 +1,11 @@
 /**
- * A chat session in a SmartChat environment.
- * ---
- * Base class format follows ChatML JSON spec.
- * Subclasses should override to_chatml, from_chatml, and parse_user_message to 
- * provide file-type specific parsing and formatting.
+ * Represents a chat session within a SmartChat environment, handling the creation,
+ * manipulation, and storage of chat data in a structured format (ChatML).
  * 
- * @param {SmartEnv} env - The SmartChat environment.
- * @param {string} conversation_id - The ID of the conversation.
- * @param {string} data - The data of the conversation.
+ * @class
+ * @param {SmartEnv} env - The SmartChat environment object which provides context and utilities.
+ * @param {string} key - The unique identifier for the chat session.
+ * @param {string} [data=''] - Initial data for the chat session, typically in a structured format.
  */
 class SmartChat {
   constructor(env, key, data='') {
@@ -19,13 +17,42 @@ class SmartChat {
     // exported for convenience (unnecessary??? may load the chats directly)
     if(this.chats) this.chats.items[this.key] = this;
   }
+
+  /**
+   * Factory method to create a new SmartChat instance with a unique key or a default one.
+   * 
+   * @static
+   * @param {SmartEnv} env - The SmartChat environment object.
+   * @param {string} [key=null] - Optional key for the chat session. If not provided, a default is generated.
+   * @param {string} [data=''] - Initial data for the chat session.
+   * @returns {SmartChat} A new instance of SmartChat.
+   */
   static create(env, key=null, data='') {
     if(!key) key = 'UNTITLED CHAT ' + get_file_date_string();
     const chat = new this(env, key, data);
     return chat;
   }
+
+  /**
+   * Computes the file path for the current chat session based on its key and file type.
+   * 
+   * @returns {string} The file path for the chat session.
+   */
   get file_path() { return `${this.chats.folder}/${this.key}.${this.file_type}`; }
+
+  /**
+   * Returns the name (key) of the chat session.
+   * 
+   * @returns {string} The key of the chat session.
+   */
   get name() { return this.key; }
+
+  /**
+   * Renames the current chat session and updates the storage references.
+   * 
+   * @param {string} new_id - The new identifier for the chat session.
+   * @returns {Promise<void>}
+   */
   async rename(new_id) {
     // console.log('renaming', this.key, new_id);
     if (this.key === new_id) return;
@@ -35,6 +62,12 @@ class SmartChat {
     this.chats.items[this.key] = this;
     await this.save();
   }
+
+  /**
+   * Retrieves all messages from the chat session and converts them to HTML format.
+   * 
+   * @returns {Promise<string>} A string containing all messages in HTML format.
+   */
   async get_messages_html(){
     const messages = await this.get_messages();
     const html = await Promise.all(messages.map(async msg => {
@@ -44,11 +77,26 @@ class SmartChat {
     }));
     return html.join('');
   }
+
+  /**
+   * Adds a new message to the chat session.
+   * 
+   * @param {Object} [msg={}] - The message object to add.
+   * @returns {Promise<void>}
+   */
   async add_message(msg={}){
     const chat_ml = await this.get_chat_ml();
     chat_ml.messages.push(msg);
     await this.update(chat_ml);
   }
+
+  /**
+   * Adds output from a tool to the chat session as a message.
+   * 
+   * @param {string} tool_name - The name of the tool.
+   * @param {*} tool_output - The output from the tool.
+   * @returns {Promise<void>}
+   */
   async add_tool_output(tool_name, tool_output){
     if(typeof this.env.actions.parse_tool_output === 'function'){
       const message = await this.env.actions.parse_tool_output(tool_name, tool_output);
@@ -56,24 +104,74 @@ class SmartChat {
     }
     await this.add_message({role: 'tool', tool_call_id: tool_name, content: JSON.stringify(tool_output)});
   }
+
   // file-type specific parsing and formatting overrides
+  /**
+   * Updates the chat session data with the provided ChatML object and saves it.
+   * 
+   * @param {Object} chat_ml - The ChatML object to update the session with.
+   * @returns {Promise<void>}
+   */
   async update(chat_ml){
     this.data = this.from_chatml(chat_ml);
     await this.save();
   }
+
+  /**
+   * Saves the current chat session data to the file system.
+   * 
+   * @returns {Promise<void>}
+   */
   async save() { return await this.chats.save(this.file_path, this.data); }
+
+  /**
+   * Deletes the chat session file from the file system.
+   * 
+   * @returns {Promise<void>}
+   */
   async delete() { return await this.chats.delete(this.file_path); }
+
+  /**
+   * Checks if the chat session file exists in the file system.
+   * 
+   * @returns {Promise<boolean>} True if the file exists, false otherwise.
+   */
   async exists() { return await this.chats.exists(this.file_path); }
+
+  /**
+   * Loads the chat session data from the file system.
+   * 
+   * @returns {Promise<string>} The loaded data.
+   */
   async load() {
     if(!await this.exists()) return this.data = '';
     return this.data = await this.chats.read(this.file_path);
   }
+
+  /**
+   * Retrieves the ChatML object from the current session data.
+   * 
+   * @returns {Promise<Object>} The ChatML object.
+   */
   async get_chat_ml() {
     await this.load();
     const chat_ml = this.to_chatml(this.data);
     return chat_ml;
   }
+
+  /**
+   * Retrieves all messages from the ChatML object of the current session.
+   * 
+   * @returns {Promise<Array>} An array of message objects.
+   */
   async get_messages() { return (await this.get_chat_ml()).messages; }
+
+  /**
+   * Processes a new user message, updates UI/UX, and adds it to the chat session.
+   * 
+   * @param {string} content - The content of the user message.
+   * @returns {Promise<void>}
+   */
   async new_user_message(content){
     content = await this.parse_user_message(content);
     if(typeof this.env?.chat_ui?.new_user_message === 'function') await this.env.chat_ui.new_user_message(content); // UI/UX
@@ -81,10 +179,37 @@ class SmartChat {
     await this.add_message({role: 'user', content});
     await this.env.chat_model.complete({});
   }
+
   // Override these for file-type specific parsing and formatting in subclasses
+  /**
+   * Returns the file type for the chat session, used in file operations.
+   * 
+   * @returns {string} The file type, default is 'json'.
+   */
   get file_type() { return 'json'; }
+
+  /**
+   * Converts the provided data into a ChatML object. This method should be overridden in subclasses.
+   * 
+   * @param {string} data - The data to convert.
+   * @returns {Object} The ChatML object.
+   */
   to_chatml(data) { return data; }
+
+  /**
+   * Converts a ChatML object back into a string or suitable format for storage. This method should be overridden in subclasses.
+   * 
+   * @param {Object} data - The ChatML object to convert.
+   * @returns {string} The string or formatted data.
+   */
   from_chatml(data) { return data; }
+
+  /**
+   * Parses the user message content before adding it to the chat. This method can be overridden to include custom parsing logic.
+   * 
+   * @param {string} content - The content to parse.
+   * @returns {Promise<string>} The parsed content.
+   */
   async parse_user_message(content) { return content; }
 }
 function get_file_date_string() { return new Date().toISOString().replace(/(T|:|\..*)/g, " ").trim(); }