Init Github Pages - Sphinx

gedasv · Aug 5, 2024 · 69b35d6 · 69b35d6
commit 69b35d6
Show file tree

Hide file tree

Showing 76 changed files with 7,628 additions and 0 deletions.
diff --git a/.env b/.env
@@ -0,0 +1,2 @@
+GROQ_API_KEY=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
+MODEL_NAME=llama3-8b-8192
diff --git a/.nojekyll b/.nojekyll
diff --git a/_modules/app/api/chat_routes.html b/_modules/app/api/chat_routes.html
diff --git a/_modules/app/services/chat_service.html b/_modules/app/services/chat_service.html
diff --git a/_modules/app/services/llm_service.html b/_modules/app/services/llm_service.html
diff --git a/_modules/app/utils/context_manager.html b/_modules/app/utils/context_manager.html
@@ -0,0 +1,201 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>app.utils.context_manager &mdash; chatbot-windows  documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../../../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../../../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../../../_static/documentation_options.js?v=5929fcd5"></script>
+        <script src="../../../_static/doctools.js?v=9a2dae69"></script>
+        <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../../../index.html" class="icon icon-home">
+            chatbot-windows
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../chat_service.html">Chat Service</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../llm_service.html">LLM Service</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../chat_routes.html">Chat Routes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../../context_manager.html">Context Manager</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../index.html">chatbot-windows</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">app.utils.context_manager</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for app.utils.context_manager</h1><div class="highlight"><pre>
+<span></span><span class="c1"># app/utils/context_manager.py</span>
+<span class="kn">from</span> <span class="nn">collections</span> <span class="kn">import</span> <span class="n">deque</span>
+<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span>
+
+<div class="viewcode-block" id="ContextManager">
+<a class="viewcode-back" href="../../../context_manager.html#app.utils.context_manager.ContextManager">[docs]</a>
+<span class="k">class</span> <span class="nc">ContextManager</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Manages conversation context using a fixed-size circular buffer.</span>
+
+<span class="sd">    This class provides methods to add, retrieve, and manipulate the conversation context.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">max_context_length</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">10</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Initialize the ContextManager with a fixed-size circular buffer.</span>
+
+<span class="sd">        :param max_context_length: Maximum number of messages to keep in context.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">max_context_length</span> <span class="o">=</span> <span class="n">max_context_length</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">context</span> <span class="o">=</span> <span class="n">deque</span><span class="p">(</span><span class="n">maxlen</span><span class="o">=</span><span class="n">max_context_length</span><span class="p">)</span>
+
+<div class="viewcode-block" id="ContextManager.add_to_context">
+<a class="viewcode-back" href="../../../context_manager.html#app.utils.context_manager.ContextManager.add_to_context">[docs]</a>
+    <span class="k">def</span> <span class="nf">add_to_context</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">message</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Add a message to the context.</span>
+
+<span class="sd">        :param message: The message to add to the context.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">message</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="ContextManager.get_context">
+<a class="viewcode-back" href="../../../context_manager.html#app.utils.context_manager.ContextManager.get_context">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_context</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Retrieve the current context as a list of messages.</span>
+
+<span class="sd">        :return: The current context messages.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="ContextManager.get_context_string">
+<a class="viewcode-back" href="../../../context_manager.html#app.utils.context_manager.ContextManager.get_context_string">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_context_string</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">separator</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Retrieve the current context as a single string.</span>
+
+<span class="sd">        :param separator: The string to use for joining context messages.</span>
+<span class="sd">        :return: The current context as a single string.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="n">separator</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="ContextManager.clear_context">
+<a class="viewcode-back" href="../../../context_manager.html#app.utils.context_manager.ContextManager.clear_context">[docs]</a>
+    <span class="k">def</span> <span class="nf">clear_context</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Clear all messages from the context.&quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span></div>
+
+
+<div class="viewcode-block" id="ContextManager.get_context_length">
+<a class="viewcode-back" href="../../../context_manager.html#app.utils.context_manager.ContextManager.get_context_length">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_context_length</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get the current number of messages in the context.</span>
+
+<span class="sd">        :return: The number of messages in the context.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">)</span></div>
+
+
+<div class="viewcode-block" id="ContextManager.get_last_message">
+<a class="viewcode-back" href="../../../context_manager.html#app.utils.context_manager.ContextManager.get_last_message">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_last_message</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get the last message added to the context.</span>
+
+<span class="sd">        :return: The last message, or None if the context is empty.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span> <span class="k">else</span> <span class="kc">None</span></div>
+
+
+<div class="viewcode-block" id="ContextManager.get_max_context_length">
+<a class="viewcode-back" href="../../../context_manager.html#app.utils.context_manager.ContextManager.get_max_context_length">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_max_context_length</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Get the maximum number of messages that can be stored in the context.</span>
+
+<span class="sd">        :return: The maximum context length.</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">max_context_length</span></div>
+</div>
+
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Gediminas Vasiliauskas.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_modules/index.html b/_modules/index.html
@@ -0,0 +1,109 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; chatbot-windows  documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../_static/documentation_options.js?v=5929fcd5"></script>
+        <script src="../_static/doctools.js?v=9a2dae69"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            chatbot-windows
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../chat_service.html">Chat Service</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../llm_service.html">LLM Service</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../chat_routes.html">Chat Routes</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../context_manager.html">Context Manager</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">chatbot-windows</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="app/api/chat_routes.html">app.api.chat_routes</a></li>
+<li><a href="app/services/chat_service.html">app.services.chat_service</a></li>
+<li><a href="app/services/llm_service.html">app.services.llm_service</a></li>
+<li><a href="app/utils/context_manager.html">app.utils.context_manager</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, Gediminas Vasiliauskas.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_sources/chat_routes.rst.txt b/_sources/chat_routes.rst.txt
@@ -0,0 +1,7 @@
+Chat Routes
+===========
+
+.. automodule:: app.api.chat_routes
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/chat_service.rst.txt b/_sources/chat_service.rst.txt
@@ -0,0 +1,7 @@
+Chat Service
+============
+
+.. automodule:: app.services.chat_service
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/context_manager.rst.txt b/_sources/context_manager.rst.txt
@@ -0,0 +1,7 @@
+Context Manager
+===============
+
+.. automodule:: app.utils.context_manager
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,20 @@
+chatbot-windows documentation
+=============================
+
+Welcome to the documentation for the Windows Manufacturing Chatbot.
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   chat_service
+   llm_service
+   chat_routes
+   context_manager
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/_sources/llm_service.rst.txt b/_sources/llm_service.rst.txt
@@ -0,0 +1,7 @@
+LLM Service
+===========
+
+.. automodule:: app.services.llm_service
+   :members:
+   :undoc-members:
+   :show-inheritance:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		GROQ_API_KEY=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
		MODEL_NAME=llama3-8b-8192