mindroot 10.0.0__py3-none-any.whl → 10.3.0__py3-none-any.whl

mindroot/docs/_build/html/source/mindroot.lib.providers.backup.html

@@ -213,6 +213,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../chat_with_assistant.html">Chat with Assistant</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../install_plugins_with_tools.html">Install Plugins with Tools</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../programming_task.html">Give Assistant a Programming Task</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../embed_chat.html">Embed Agent Chat on Your Website</a></li>
 </ul>
 </li>
 </ul>

mindroot/docs/_build/html/source/mindroot.lib.providers.html

@@ -213,6 +213,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../chat_with_assistant.html">Chat with Assistant</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../install_plugins_with_tools.html">Install Plugins with Tools</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../programming_task.html">Give Assistant a Programming Task</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../embed_chat.html">Embed Agent Chat on Your Website</a></li>
 </ul>
 </li>
 </ul>

mindroot/docs/_build/html/source/mindroot.registry.html

@@ -213,6 +213,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../chat_with_assistant.html">Chat with Assistant</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../install_plugins_with_tools.html">Install Plugins with Tools</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../programming_task.html">Give Assistant a Programming Task</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../embed_chat.html">Embed Agent Chat on Your Website</a></li>
 </ul>
 </li>
 </ul>

mindroot/docs/_build/html/source/modules.html

@@ -213,6 +213,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../chat_with_assistant.html">Chat with Assistant</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../install_plugins_with_tools.html">Install Plugins with Tools</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../programming_task.html">Give Assistant a Programming Task</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../embed_chat.html">Embed Agent Chat on Your Website</a></li>
 </ul>
 </li>
 </ul>

mindroot/docs/_build/html/source/mr_agent_expert_instr.html

@@ -213,6 +213,7 @@
 <li class="toctree-l2"><a class="reference internal" href="../chat_with_assistant.html">Chat with Assistant</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../install_plugins_with_tools.html">Install Plugins with Tools</a></li>
 <li class="toctree-l2"><a class="reference internal" href="../programming_task.html">Give Assistant a Programming Task</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../embed_chat.html">Embed Agent Chat on Your Website</a></li>
 </ul>
 </li>
 </ul>

mindroot/docs/_build/html/starting_mindroot.html

@@ -213,6 +213,7 @@
 <li class="toctree-l2"><a class="reference internal" href="chat_with_assistant.html">Chat with Assistant</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install_plugins_with_tools.html">Install Plugins with Tools</a></li>
 <li class="toctree-l2"><a class="reference internal" href="programming_task.html">Give Assistant a Programming Task</a></li>
+<li class="toctree-l2"><a class="reference internal" href="embed_chat.html">Embed Agent Chat on Your Website</a></li>
 </ul>
 </li>
 </ul>

mindroot/docs/_build/html/user_documentation.html

@@ -213,6 +213,7 @@
 <li class="toctree-l2"><a class="reference internal" href="chat_with_assistant.html">Chat with Assistant</a></li>
 <li class="toctree-l2"><a class="reference internal" href="install_plugins_with_tools.html">Install Plugins with Tools</a></li>
 <li class="toctree-l2"><a class="reference internal" href="programming_task.html">Give Assistant a Programming Task</a></li>
+<li class="toctree-l2"><a class="reference internal" href="embed_chat.html">Embed Agent Chat on Your Website</a></li>
 </ul>
 </li>
 </ul>
@@ -262,6 +263,7 @@
           <section id="user-documentation">
 <h1>User Documentation<a class="headerlink" href="#user-documentation" title="Link to this heading">¶</a></h1>
 <p>This section covers everything you need to get started with MindRoot as a user.</p>
+<p>Test</p>
 <div class="toctree-wrapper compound">
 <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
@@ -272,6 +274,13 @@
 <li class="toctree-l1"><a class="reference internal" href="chat_with_assistant.html">Chat with Assistant</a></li>
 <li class="toctree-l1"><a class="reference internal" href="install_plugins_with_tools.html">Install Plugins with Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="programming_task.html">Give Assistant a Programming Task</a></li>
+<li class="toctree-l1"><a class="reference internal" href="embed_chat.html">Embed Agent Chat on Your Website</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="embed_chat.html#create-an-api-key">Create an API Key</a></li>
+<li class="toctree-l2"><a class="reference internal" href="embed_chat.html#disable-chat-avatar-on-left">Disable Chat Avatar on Left</a></li>
+<li class="toctree-l2"><a class="reference internal" href="embed_chat.html#get-chat-widget-embed-code">Get Chat Widget Embed Code</a></li>
+<li class="toctree-l2"><a class="reference internal" href="embed_chat.html#insert-into-html">Insert into HTML</a></li>
+</ul>
+</li>
 </ul>
 </div>
 </section>

mindroot/docs/embed_chat.rst

@@ -0,0 +1,54 @@
+Embed Agent Chat on Your Website
+=================================
+
+
+Create an API Key
+-----------------
+
+- Go to /admin | Advanced | API Keys
+
+- Enter a username and click Create New API Key
+
+- Note that the user must exist. 'admin' is OK for testing.
+
+.. image:: apikey.png
+
+Disable Chat Avatar on Left
+---------------------------
+
+- Go to /admin | Advanced | Plugins
+
+- Click on Core Plugins
+
+- Click the Disable button next to `chat_avatar`
+
+.. image:: disablechatavatar.png
+
+Get Chat Widget Embed Code
+--------------------------
+
+- Go to /admin | Advanced | Secure Chat Widget
+
+- Cick Create New Widget Token
+
+.. image:: widgetform.png
+
+- Select the agent, API key, and enter the URL of the MindRoot instance.
+
+- Click Create New Widget Token
+
+- Click on the Copy Embed Code button to copy the code to your clipboard.
+
+.. image:: chatwidgetx.png 
+
+
+Insert into HTML
+----------------
+
+Paste the `<script>` tag into your HTML page before the ending `</body>` tag.
+When you load the page, you should see the chat widget in the lower right corner.
+
+.. image:: widgetonpage.png
+
+
+

mindroot/docs/user_documentation.rst

@@ -3,6 +3,8 @@ User Documentation
 
 This section covers everything you need to get started with MindRoot as a user.
 
+Test
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
@@ -13,4 +15,7 @@ This section covers everything you need to get started with MindRoot as a user.
    llm_api_key
    chat_with_assistant
    install_plugins_with_tools
-   programming_task
+   programming_task
+   embed_chat 
+
+

{mindroot-10.0.0.dist-info → mindroot-10.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mindroot
-Version: 10.0.0
+Version: 10.3.0
 Summary: MindRoot AI Agent Framework
 Requires-Python: >=3.9
 License-File: LICENSE