Deployed b18c976 to 0.3 with MkDocs 1.6.1 and mike 2.1.3

0.3/tutorials/giphy/index.html

@@ -204,11 +204,11 @@
 <a id=__codelineno-13-3 name=__codelineno-13-3 href=#__codelineno-13-3></a>
 <a id=__codelineno-13-4 name=__codelineno-13-4 href=#__codelineno-13-4></a><span class=kn>from</span> <span class=nn>..workflow</span> <span class=kn>import</span> <span class=n>wf</span>
 <a id=__codelineno-13-5 name=__codelineno-13-5 href=#__codelineno-13-5></a>
-<a id=__codelineno-13-6 name=__codelineno-13-6 href=#__codelineno-13-6></a><span class=n>app</span> <span class=o>=</span> <span class=n>FastAgency</span><span class=p>(</span>
-<a id=__codelineno-13-7 name=__codelineno-13-7 href=#__codelineno-13-7></a>    <span class=n>provider</span><span class=o>=</span><span class=n>wf</span><span class=p>,</span>
-<a id=__codelineno-13-8 name=__codelineno-13-8 href=#__codelineno-13-8></a>    <span class=n>ui</span><span class=o>=</span><span class=n>MesopUI</span><span class=p>(),</span>
-<a id=__codelineno-13-9 name=__codelineno-13-9 href=#__codelineno-13-9></a>    <span class=n>title</span><span class=o>=</span><span class=s2>&quot;My FastAgency App&quot;</span><span class=p>,</span>
-<a id=__codelineno-13-10 name=__codelineno-13-10 href=#__codelineno-13-10></a><span class=p>)</span>
+<a id=__codelineno-13-6 name=__codelineno-13-6 href=#__codelineno-13-6></a><span class=n>ui</span> <span class=o>=</span> <span class=n>MesopUI</span><span class=p>()</span>
+<a id=__codelineno-13-7 name=__codelineno-13-7 href=#__codelineno-13-7></a>
+<a id=__codelineno-13-8 name=__codelineno-13-8 href=#__codelineno-13-8></a>
+<a id=__codelineno-13-9 name=__codelineno-13-9 href=#__codelineno-13-9></a><span class=n>app</span> <span class=o>=</span> <span class=n>FastAgency</span><span class=p>(</span>
+<a id=__codelineno-13-10 name=__codelineno-13-10 href=#__codelineno-13-10></a>    <span class=n>provider</span><span class=o>=</span><span class=n>wf</span><span class=p>,</span>
 </code></pre></div> </details> <h2 id=code-walkthrough>Code Walkthrough<a class=headerlink href=#code-walkthrough title="Permanent link">#</a></h2> <p>Now we will go over each key part of the code, explaining its function and purpose within the FastAgency framework. Understanding these components is crucial for building a dynamic interaction between the user, the <a href=../../api/fastagency/runtimes/autogen/agents/websurfer/WebSurferAgent/ ><strong><code>WebSurferAgent</code></strong></a>, and the <strong>Giphy agent</strong>.</p> <h3 id=creating-the-giphy-api-instance>Creating the Giphy API Instance<a class=headerlink href=#creating-the-giphy-api-instance title="Permanent link">#</a></h3> <p>The following lines shows hot to initializes the Giphy API by loading the OpenAPI specification from a URL. The OpenAPI spec defines how to interact with the Giphy API, including endpoints, parameters, and security details.</p> <p>Also, we configure the <strong>Giphy API</strong> with the <strong><em>GIPHY_API_KEY</em></strong> using <strong><em>set_security_params</em></strong> to authenticate our requests. <div class=highlight><pre><span></span><code><a id=__codelineno-14-1 name=__codelineno-14-1 href=#__codelineno-14-1></a><span class=n>openapi_url</span> <span class=o>=</span> <span class=s2>&quot;https://raw.githubusercontent.com/airtai/fastagency/refs/heads/main/examples/openapi/giphy_openapi.json&quot;</span>
 <a id=__codelineno-14-2 name=__codelineno-14-2 href=#__codelineno-14-2></a><span class=n>giphy_api</span> <span class=o>=</span> <span class=n>OpenAPI</span><span class=o>.</span><span class=n>create</span><span class=p>(</span><span class=n>openapi_url</span><span class=o>=</span><span class=n>openapi_url</span><span class=p>)</span>
 <a id=__codelineno-14-3 name=__codelineno-14-3 href=#__codelineno-14-3></a>
@@ -268,11 +268,11 @@
 <a id=__codelineno-20-6 name=__codelineno-20-6 href=#__codelineno-20-6></a>    <span class=p>)</span>
 <a id=__codelineno-20-7 name=__codelineno-20-7 href=#__codelineno-20-7></a>
 <a id=__codelineno-20-8 name=__codelineno-20-8 href=#__codelineno-20-8></a>    <span class=k>return</span> <span class=n>chat_result</span><span class=o>.</span><span class=n>summary</span>  <span class=c1># type: ignore[no-any-return]</span>
-</code></pre></div> <h3 id=starting-the-application>Starting the Application<a class=headerlink href=#starting-the-application title="Permanent link">#</a></h3> <p>The FastAgency app is created, using the registered workflows (<strong><code>wf</code></strong>) and web-based user interface (<a href=../../api/fastagency/ui/mesop/MesopUI/ ><strong><code>MesopUI</code></strong></a>). This makes the conversation between agents and the user interactive.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-21-1 name=__codelineno-21-1 href=#__codelineno-21-1></a><span class=n>app</span> <span class=o>=</span> <span class=n>FastAgency</span><span class=p>(</span>
-<a id=__codelineno-21-2 name=__codelineno-21-2 href=#__codelineno-21-2></a>    <span class=n>provider</span><span class=o>=</span><span class=n>wf</span><span class=p>,</span>
-<a id=__codelineno-21-3 name=__codelineno-21-3 href=#__codelineno-21-3></a>    <span class=n>ui</span><span class=o>=</span><span class=n>MesopUI</span><span class=p>(),</span>
-<a id=__codelineno-21-4 name=__codelineno-21-4 href=#__codelineno-21-4></a>    <span class=n>title</span><span class=o>=</span><span class=s2>&quot;My FastAgency App&quot;</span><span class=p>,</span>
-<a id=__codelineno-21-5 name=__codelineno-21-5 href=#__codelineno-21-5></a><span class=p>)</span>
+</code></pre></div> <h3 id=starting-the-application>Starting the Application<a class=headerlink href=#starting-the-application title="Permanent link">#</a></h3> <p>The FastAgency app is created, using the registered workflows (<strong><code>wf</code></strong>) and web-based user interface (<a href=../../api/fastagency/ui/mesop/MesopUI/ ><strong><code>MesopUI</code></strong></a>). This makes the conversation between agents and the user interactive.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-21-1 name=__codelineno-21-1 href=#__codelineno-21-1></a><span class=n>ui</span> <span class=o>=</span> <span class=n>MesopUI</span><span class=p>()</span>
+<a id=__codelineno-21-2 name=__codelineno-21-2 href=#__codelineno-21-2></a>
+<a id=__codelineno-21-3 name=__codelineno-21-3 href=#__codelineno-21-3></a>
+<a id=__codelineno-21-4 name=__codelineno-21-4 href=#__codelineno-21-4></a><span class=n>app</span> <span class=o>=</span> <span class=n>FastAgency</span><span class=p>(</span>
+<a id=__codelineno-21-5 name=__codelineno-21-5 href=#__codelineno-21-5></a>    <span class=n>provider</span><span class=o>=</span><span class=n>wf</span><span class=p>,</span>
 </code></pre></div> <p>For more information, visit <a href=../../user-guide/ui/mesop/basics/ target=_blank><strong>Mesop User Guide</strong></a>.</p> <h2 id=running-the-application>Running the Application<a class=headerlink href=#running-the-application title="Permanent link">#</a></h2> <p>The preferred way to run the <a href=https://google.github.io/mesop/ target=_blank><strong>Mesop</strong></a> application is using a Python WSGI HTTP server like <a href=https://gunicorn.org/ target=_blank><strong>Gunicorn</strong></a> on Linux and Mac or <a href=https://docs.pylonsproject.org/projects/waitress/en/stable/ target=_blank><strong>Waitress</strong></a> on Windows.</p> <div class="tabbed-set tabbed-alternate" data-tabs=5:2><input checked=checked id=cookiecutter_3 name=__tabbed_5 type=radio><input id=env--pip_3 name=__tabbed_5 type=radio><div class=tabbed-labels><label for=cookiecutter_3>Cookiecutter</label><label for=env--pip_3>env + pip</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class="admonition note"> <p class=admonition-title>Terminal</p> <div class=highlight><pre><span></span><code><a id=__codelineno-22-1 name=__codelineno-22-1 href=#__codelineno-22-1></a><span class=go>gunicorn my_fastagency_app.deployment.main:app</span>
 </code></pre></div> </div> </div> <div class=tabbed-block> <p>First, install the package using package manager such as <code>pip</code> and then run it:</p> <div class="tabbed-set tabbed-alternate" data-tabs=6:2><input checked=checked id=linuxmacos_1 name=__tabbed_6 type=radio><input id=windows_1 name=__tabbed_6 type=radio><div class=tabbed-labels><label for=linuxmacos_1>Linux/MacOS</label><label for=windows_1>Windows</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class="admonition note"> <p class=admonition-title>Terminal</p> <div class=highlight><pre><span></span><code><a id=__codelineno-23-1 name=__codelineno-23-1 href=#__codelineno-23-1></a><span class=go>pip install gunicorn</span>
 <a id=__codelineno-23-2 name=__codelineno-23-2 href=#__codelineno-23-2></a><span class=go>gunicorn deployment.main:app</span>

0.3/tutorials/mesop_template/index.html

@@ -78,16 +78,16 @@
 <a id=__codelineno-10-3 name=__codelineno-10-3 href=#__codelineno-10-3></a>
 <a id=__codelineno-10-4 name=__codelineno-10-4 href=#__codelineno-10-4></a><span class=kn>from</span> <span class=nn>..workflow</span> <span class=kn>import</span> <span class=n>wf</span>
 <a id=__codelineno-10-5 name=__codelineno-10-5 href=#__codelineno-10-5></a>
-<a id=__codelineno-10-6 name=__codelineno-10-6 href=#__codelineno-10-6></a><span class=n>app</span> <span class=o>=</span> <span class=n>FastAgency</span><span class=p>(</span>
-<a id=__codelineno-10-7 name=__codelineno-10-7 href=#__codelineno-10-7></a>    <span class=n>provider</span><span class=o>=</span><span class=n>wf</span><span class=p>,</span>
-<a id=__codelineno-10-8 name=__codelineno-10-8 href=#__codelineno-10-8></a>    <span class=n>ui</span><span class=o>=</span><span class=n>MesopUI</span><span class=p>(),</span>
-<a id=__codelineno-10-9 name=__codelineno-10-9 href=#__codelineno-10-9></a>    <span class=n>title</span><span class=o>=</span><span class=s2>&quot;My FastAgency App&quot;</span><span class=p>,</span>
-<a id=__codelineno-10-10 name=__codelineno-10-10 href=#__codelineno-10-10></a><span class=p>)</span>
-</code></pre></div> </details> <h2 id=starting-the-application>Starting the Application<a class=headerlink href=#starting-the-application title="Permanent link">#</a></h2> <p>The FastAgency app is created, using the registered workflows (<strong><code>wf</code></strong>) and web-based user interface (<a href=../../api/fastagency/ui/mesop/MesopUI/ ><strong><code>MesopUI</code></strong></a>). This makes the conversation between agents and the user interactive.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a><span class=n>app</span> <span class=o>=</span> <span class=n>FastAgency</span><span class=p>(</span>
-<a id=__codelineno-11-2 name=__codelineno-11-2 href=#__codelineno-11-2></a>    <span class=n>provider</span><span class=o>=</span><span class=n>wf</span><span class=p>,</span>
-<a id=__codelineno-11-3 name=__codelineno-11-3 href=#__codelineno-11-3></a>    <span class=n>ui</span><span class=o>=</span><span class=n>MesopUI</span><span class=p>(),</span>
-<a id=__codelineno-11-4 name=__codelineno-11-4 href=#__codelineno-11-4></a>    <span class=n>title</span><span class=o>=</span><span class=s2>&quot;My FastAgency App&quot;</span><span class=p>,</span>
-<a id=__codelineno-11-5 name=__codelineno-11-5 href=#__codelineno-11-5></a><span class=p>)</span>
+<a id=__codelineno-10-6 name=__codelineno-10-6 href=#__codelineno-10-6></a><span class=n>ui</span> <span class=o>=</span> <span class=n>MesopUI</span><span class=p>()</span>
+<a id=__codelineno-10-7 name=__codelineno-10-7 href=#__codelineno-10-7></a>
+<a id=__codelineno-10-8 name=__codelineno-10-8 href=#__codelineno-10-8></a>
+<a id=__codelineno-10-9 name=__codelineno-10-9 href=#__codelineno-10-9></a><span class=n>app</span> <span class=o>=</span> <span class=n>FastAgency</span><span class=p>(</span>
+<a id=__codelineno-10-10 name=__codelineno-10-10 href=#__codelineno-10-10></a>    <span class=n>provider</span><span class=o>=</span><span class=n>wf</span><span class=p>,</span>
+</code></pre></div> </details> <h2 id=starting-the-application>Starting the Application<a class=headerlink href=#starting-the-application title="Permanent link">#</a></h2> <p>The FastAgency app is created, using the registered workflows (<strong><code>wf</code></strong>) and web-based user interface (<a href=../../api/fastagency/ui/mesop/MesopUI/ ><strong><code>MesopUI</code></strong></a>). This makes the conversation between agents and the user interactive.</p> <div class=highlight><pre><span></span><code><a id=__codelineno-11-1 name=__codelineno-11-1 href=#__codelineno-11-1></a><span class=n>ui</span> <span class=o>=</span> <span class=n>MesopUI</span><span class=p>()</span>
+<a id=__codelineno-11-2 name=__codelineno-11-2 href=#__codelineno-11-2></a>
+<a id=__codelineno-11-3 name=__codelineno-11-3 href=#__codelineno-11-3></a>
+<a id=__codelineno-11-4 name=__codelineno-11-4 href=#__codelineno-11-4></a><span class=n>app</span> <span class=o>=</span> <span class=n>FastAgency</span><span class=p>(</span>
+<a id=__codelineno-11-5 name=__codelineno-11-5 href=#__codelineno-11-5></a>    <span class=n>provider</span><span class=o>=</span><span class=n>wf</span><span class=p>,</span>
 </code></pre></div> <p>For more information, visit <a href=../../user-guide/ui/mesop/basics/ target=_blank><strong>Mesop User Guide</strong></a>.</p> <h2 id=running-the-application>Running the Application<a class=headerlink href=#running-the-application title="Permanent link">#</a></h2> <p>The preferred way to run the <a href=https://google.github.io/mesop/ target=_blank><strong>Mesop</strong></a> application is using a Python WSGI HTTP server like <a href=https://gunicorn.org/ target=_blank><strong>Gunicorn</strong></a> on Linux and Mac or <a href=https://docs.pylonsproject.org/projects/waitress/en/stable/ target=_blank><strong>Waitress</strong></a> on Windows.</p> <div class="tabbed-set tabbed-alternate" data-tabs=4:2><input checked=checked id=cookiecutter_3 name=__tabbed_4 type=radio><input id=env--pip_3 name=__tabbed_4 type=radio><div class=tabbed-labels><label for=cookiecutter_3>Cookiecutter</label><label for=env--pip_3>env + pip</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class="admonition note"> <p class=admonition-title>Terminal</p> <div class=highlight><pre><span></span><code><a id=__codelineno-12-1 name=__codelineno-12-1 href=#__codelineno-12-1></a><span class=go>gunicorn my_fastagency_app.deployment.main:app</span>
 </code></pre></div> </div> </div> <div class=tabbed-block> <p>First, install the package using package manager such as <code>pip</code> and then run it:</p> <div class="tabbed-set tabbed-alternate" data-tabs=5:2><input checked=checked id=linuxmacos name=__tabbed_5 type=radio><input id=windows name=__tabbed_5 type=radio><div class=tabbed-labels><label for=linuxmacos>Linux/MacOS</label><label for=windows>Windows</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class="admonition note"> <p class=admonition-title>Terminal</p> <div class=highlight><pre><span></span><code><a id=__codelineno-13-1 name=__codelineno-13-1 href=#__codelineno-13-1></a><span class=go>pip install gunicorn</span>
 <a id=__codelineno-13-2 name=__codelineno-13-2 href=#__codelineno-13-2></a><span class=go>gunicorn deployment.main:app</span>