Deployed 2e5aff2 to dev with MkDocs 1.6.1 and mike 2.1.3

vintasoftware · Nov 19, 2024 · 17fe536 · 17fe536
1 parent 5585d56
commit 17fe536
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 28 deletions.
diff --git a/dev/reference/assistants-ref/index.html b/dev/reference/assistants-ref/index.html
@@ -2040,7 +2040,9 @@ <h2 id="django_ai_assistant.helpers.assistants.AIAssistant" class="doc doc-headi
 <span class="normal">597</span>
 <span class="normal">598</span>
 <span class="normal">599</span>
-<span class="normal">600</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">AIAssistant</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>  <span class="c1"># noqa: F821</span>
+<span class="normal">600</span>
+<span class="normal">601</span>
+<span class="normal">602</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">AIAssistant</span><span class="p">(</span><span class="n">abc</span><span class="o">.</span><span class="n">ABC</span><span class="p">):</span>  <span class="c1"># noqa: F821</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Base class for AI Assistants. Subclasses must define at least the following attributes:</span>
 
 <span class="sd">    * id: str</span>
@@ -2454,7 +2456,9 @@ <h2 id="django_ai_assistant.helpers.assistants.AIAssistant" class="doc doc-headi
             <span class="c1"># This is necessary for compatibility with Anthropic</span>
             <span class="n">messages_to_summarize</span> <span class="o">=</span> <span class="n">state</span><span class="p">[</span><span class="s2">&quot;messages&quot;</span><span class="p">][</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
             <span class="n">input_message</span> <span class="o">=</span> <span class="n">state</span><span class="p">[</span><span class="s2">&quot;messages&quot;</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
-            <span class="n">docs</span> <span class="o">=</span> <span class="n">retriever</span><span class="o">.</span><span class="n">invoke</span><span class="p">({</span><span class="s2">&quot;input&quot;</span><span class="p">:</span> <span class="n">input_message</span><span class="p">,</span> <span class="s2">&quot;history&quot;</span><span class="p">:</span> <span class="n">messages_to_summarize</span><span class="p">})</span>
+            <span class="n">docs</span> <span class="o">=</span> <span class="n">retriever</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span>
+                <span class="p">{</span><span class="s2">&quot;input&quot;</span><span class="p">:</span> <span class="n">input_message</span><span class="o">.</span><span class="n">content</span><span class="p">,</span> <span class="s2">&quot;history&quot;</span><span class="p">:</span> <span class="n">messages_to_summarize</span><span class="p">}</span>
+            <span class="p">)</span>
 
             <span class="n">document_separator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_document_separator</span><span class="p">()</span>
             <span class="n">document_prompt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_document_prompt</span><span class="p">()</span>
@@ -4336,7 +4340,9 @@ <h3 id="django_ai_assistant.helpers.assistants.AIAssistant.as_graph" class="doc
 <span class="normal">533</span>
 <span class="normal">534</span>
 <span class="normal">535</span>
-<span class="normal">536</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@with_cast_id</span>
+<span class="normal">536</span>
+<span class="normal">537</span>
+<span class="normal">538</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@with_cast_id</span>
 <span class="k">def</span> <span class="nf">as_graph</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">thread_id</span><span class="p">:</span> <span class="n">Any</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Runnable</span><span class="p">[</span><span class="nb">dict</span><span class="p">,</span> <span class="nb">dict</span><span class="p">]:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Create the LangGraph graph for the assistant.\n</span>
 <span class="sd">    This graph is an agent that supports chat history, tool calling, and RAG (if `has_rag=True`).\n</span>
@@ -4394,7 +4400,9 @@ <h3 id="django_ai_assistant.helpers.assistants.AIAssistant.as_graph" class="doc
         <span class="c1"># This is necessary for compatibility with Anthropic</span>
         <span class="n">messages_to_summarize</span> <span class="o">=</span> <span class="n">state</span><span class="p">[</span><span class="s2">&quot;messages&quot;</span><span class="p">][</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
         <span class="n">input_message</span> <span class="o">=</span> <span class="n">state</span><span class="p">[</span><span class="s2">&quot;messages&quot;</span><span class="p">][</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
-        <span class="n">docs</span> <span class="o">=</span> <span class="n">retriever</span><span class="o">.</span><span class="n">invoke</span><span class="p">({</span><span class="s2">&quot;input&quot;</span><span class="p">:</span> <span class="n">input_message</span><span class="p">,</span> <span class="s2">&quot;history&quot;</span><span class="p">:</span> <span class="n">messages_to_summarize</span><span class="p">})</span>
+        <span class="n">docs</span> <span class="o">=</span> <span class="n">retriever</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span>
+            <span class="p">{</span><span class="s2">&quot;input&quot;</span><span class="p">:</span> <span class="n">input_message</span><span class="o">.</span><span class="n">content</span><span class="p">,</span> <span class="s2">&quot;history&quot;</span><span class="p">:</span> <span class="n">messages_to_summarize</span><span class="p">}</span>
+        <span class="p">)</span>
 
         <span class="n">document_separator</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_document_separator</span><span class="p">()</span>
         <span class="n">document_prompt</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_document_prompt</span><span class="p">()</span>
@@ -4576,9 +4584,7 @@ <h3 id="django_ai_assistant.helpers.assistants.AIAssistant.invoke" class="doc do
 
             <details class="quote">
               <summary>Source code in <code>django_ai_assistant/helpers/assistants.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">538</span>
-<span class="normal">539</span>
-<span class="normal">540</span>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">540</span>
 <span class="normal">541</span>
 <span class="normal">542</span>
 <span class="normal">543</span>
@@ -4597,7 +4603,9 @@ <h3 id="django_ai_assistant.helpers.assistants.AIAssistant.invoke" class="doc do
 <span class="normal">556</span>
 <span class="normal">557</span>
 <span class="normal">558</span>
-<span class="normal">559</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@with_cast_id</span>
+<span class="normal">559</span>
+<span class="normal">560</span>
+<span class="normal">561</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@with_cast_id</span>
 <span class="k">def</span> <span class="nf">invoke</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">thread_id</span><span class="p">:</span> <span class="n">Any</span> <span class="o">|</span> <span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">dict</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Invoke the assistant LangChain graph with the given arguments and keyword arguments.\n</span>
 <span class="sd">    This is the lower-level method to run the assistant.\n</span>
@@ -4722,9 +4730,7 @@ <h3 id="django_ai_assistant.helpers.assistants.AIAssistant.run" class="doc doc-h
 
             <details class="quote">
               <summary>Source code in <code>django_ai_assistant/helpers/assistants.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">561</span>
-<span class="normal">562</span>
-<span class="normal">563</span>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">563</span>
 <span class="normal">564</span>
 <span class="normal">565</span>
 <span class="normal">566</span>
@@ -4742,7 +4748,9 @@ <h3 id="django_ai_assistant.helpers.assistants.AIAssistant.run" class="doc doc-h
 <span class="normal">578</span>
 <span class="normal">579</span>
 <span class="normal">580</span>
-<span class="normal">581</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@with_cast_id</span>
+<span class="normal">581</span>
+<span class="normal">582</span>
+<span class="normal">583</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@with_cast_id</span>
 <span class="k">def</span> <span class="nf">run</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="n">thread_id</span><span class="p">:</span> <span class="n">Any</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Any</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Run the assistant with the given message and thread ID.\n</span>
 <span class="sd">    This is the higher-level method to run the assistant.\n</span>
@@ -4837,9 +4845,7 @@ <h3 id="django_ai_assistant.helpers.assistants.AIAssistant.as_tool" class="doc d
 
             <details class="quote">
               <summary>Source code in <code>django_ai_assistant/helpers/assistants.py</code></summary>
-              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">586</span>
-<span class="normal">587</span>
-<span class="normal">588</span>
+              <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">588</span>
 <span class="normal">589</span>
 <span class="normal">590</span>
 <span class="normal">591</span>
@@ -4851,7 +4857,9 @@ <h3 id="django_ai_assistant.helpers.assistants.AIAssistant.as_tool" class="doc d
 <span class="normal">597</span>
 <span class="normal">598</span>
 <span class="normal">599</span>
-<span class="normal">600</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">as_tool</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">description</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">BaseTool</span><span class="p">:</span>
+<span class="normal">600</span>
+<span class="normal">601</span>
+<span class="normal">602</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">def</span> <span class="nf">as_tool</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">description</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">BaseTool</span><span class="p">:</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Create a tool from the assistant.\n</span>
 <span class="sd">    This is useful to compose assistants.\n</span>
 

diff --git a/dev/search/search_index.json b/dev/search/search_index.json
diff --git a/dev/sitemap.xml b/dev/sitemap.xml
@@ -2,46 +2,46 @@
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     <url>
          <loc>https://vintasoftware.github.io/django-ai-assistant/dev/</loc>
-         <lastmod>2024-10-11</lastmod>
+         <lastmod>2024-11-19</lastmod>
     </url>
     <url>
          <loc>https://vintasoftware.github.io/django-ai-assistant/dev/changelog/</loc>
-         <lastmod>2024-10-11</lastmod>
+         <lastmod>2024-11-19</lastmod>
     </url>
     <url>
          <loc>https://vintasoftware.github.io/django-ai-assistant/dev/contributing/</loc>
-         <lastmod>2024-10-11</lastmod>
+         <lastmod>2024-11-19</lastmod>
     </url>
     <url>
          <loc>https://vintasoftware.github.io/django-ai-assistant/dev/frontend/</loc>
-         <lastmod>2024-10-11</lastmod>
+         <lastmod>2024-11-19</lastmod>
     </url>
     <url>
          <loc>https://vintasoftware.github.io/django-ai-assistant/dev/get-started/</loc>
-         <lastmod>2024-10-11</lastmod>
+         <lastmod>2024-11-19</lastmod>
     </url>
     <url>
          <loc>https://vintasoftware.github.io/django-ai-assistant/dev/support/</loc>
-         <lastmod>2024-10-11</lastmod>
+         <lastmod>2024-11-19</lastmod>
     </url>
     <url>
          <loc>https://vintasoftware.github.io/django-ai-assistant/dev/tutorial/</loc>
-         <lastmod>2024-10-11</lastmod>
+         <lastmod>2024-11-19</lastmod>
     </url>
     <url>
          <loc>https://vintasoftware.github.io/django-ai-assistant/dev/reference/</loc>
-         <lastmod>2024-10-11</lastmod>
+         <lastmod>2024-11-19</lastmod>
     </url>
     <url>
          <loc>https://vintasoftware.github.io/django-ai-assistant/dev/reference/assistants-ref/</loc>
-         <lastmod>2024-10-11</lastmod>
+         <lastmod>2024-11-19</lastmod>
     </url>
     <url>
          <loc>https://vintasoftware.github.io/django-ai-assistant/dev/reference/models-ref/</loc>
-         <lastmod>2024-10-11</lastmod>
+         <lastmod>2024-11-19</lastmod>
     </url>
     <url>
          <loc>https://vintasoftware.github.io/django-ai-assistant/dev/reference/use-cases-ref/</loc>
-         <lastmod>2024-10-11</lastmod>
+         <lastmod>2024-11-19</lastmod>
     </url>
 </urlset>
diff --git a/dev/sitemap.xml.gz b/dev/sitemap.xml.gz