deploy: d3145f5

_sources/case/gaia.rst.txt

@@ -42,5 +42,5 @@ With everything in place, it's time to start the GAIA benchmark.
 
     python scripts/gaia/test_gaia.py --level <level_in_gaia> --max_workers <thread_number>
 
-- Replace `<level_in_gaia>` with your chosen difficulty (1, 2, or 3).
-- Set `<thread_number>` to decide how many tasks the team handles simultaneously.
+- Replace :code:`<level_in_gaia>` with your chosen difficulty (1, 2, or 3).
+- Set :code:`<thread_number>` to decide how many tasks the team handles simultaneously.

_sources/customize/goal_submission.rst.txt

@@ -13,7 +13,7 @@ The full URL :code:`url: "http://127.0.0.1:5050/launch_goal"` is used to send a
 
    import requests 
    goal = "task descrpition" 
-   "(e.g. goal = I want to know the annual revenue of Microsoft from 2014 to 2020. Please generate a figure in text format showing the trend of the annual revenue, and give me a analysis report.)"
+   # e.g. goal = I want to know the annual revenue of Microsoft from 2014 to 2020. Please generate a figure in text format showing the trend of the annual revenue, and give me a analysis report. 
    response = requests.post(
       "http://127.0.0.1:5050/launch_goal",
       json={

_sources/customize/integrate_thirdparty_agent.rst.txt

@@ -59,7 +59,7 @@ Open Interpreter Docker Startup
 
       docker build -f dockerfiles/tool_agents/open_interpreter.Dockerfile -t open_interpreter:latest .
   
-  * Then, start the server and multiple communication agents by running:
+  * Then, start the server and communication agents by running:
 
     .. code-block:: bash
 

_sources/customize/tool_creation.rst.txt

@@ -23,16 +23,16 @@ Tool with required parameters
 .. code-block:: yaml
 
     - function:
-        description: your function description 
+        description: function description 
         name: function name
         parameters:
           properties:
             parameters_1:
-              description:  your parameters_1 description 
+              description:  parameters_1 description 
               type: string / number / boolean 
-              enum: ["It's necessary if your parameter is set by Literal type OR specified parameter"] 
-            parameters_2:  # It's necessary if there are more than 1 parameter in your function
-              description:  your parameters_2 description 
+              enum: ["It's necessary if parameter is set by Literal type OR specified parameter"] 
+            parameters_2:  # It's necessary if there are more than 1 parameter in function
+              description:  parameters_2 description 
               type: string / number / boolean 
           required:
           - parameters_1
@@ -48,7 +48,7 @@ Tool without required parameters
 .. code-block:: yaml
 
     - function:
-        description: your function description 
+        description: function description 
         name: function name
         parameters:
           properties: {} 

_sources/distributed_service/config.rst.txt

@@ -111,8 +111,8 @@ This guide explains how to configure and run the IoA framework across multiple d
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 Open two ports on your server:
 
-- <SERVER_PORT> (default: 7788) for the IoA server
-- <FRONTEND_PORT> (default: 80) for the web frontend
+- :code:`<SERVER_PORT>` (default: 7788) for the IoA server
+- :code:`<FRONTEND_PORT>` (default: 80) for the web frontend
 
 .. note:: If the default ports are occupied, choose alternative available ports.
 
@@ -141,7 +141,7 @@ Launch the IoA server:
 
    docker-compose -f dockerfiles/compose/server_only.yaml up
 
-.. note:: If using custom ports, modify the `server_only.yaml` file:
+.. note:: If using custom ports, modify the :code:`server_only.yaml` file:
 
    .. code-block:: yaml
 
@@ -155,7 +155,7 @@ Launch the IoA server:
 
 4. Access the Frontend
 ^^^^^^^^^^^^^^^^^^^^^^
-Open `http://<SERVER_IP>:<FRONTEND_PORT>` in a web browser to view the agents' communication interface.
+Open :code:`http://<SERVER_IP>:<FRONTEND_PORT>` in a web browser to view the agents' communication interface.
 
 💻 Client Setup
 ---------------
@@ -199,7 +199,7 @@ Start your client with the configured agent. For example:
 
    docker-compose -f dockerfiles/compose/example.yaml up
 
-.. note:: Ensure you've updated `configs/client_configs/case/example/bob.yaml` with the correct <SERVER_PORT> and <SERVER_IP>.
+.. note:: Ensure you've updated :code:`configs/client_configs/case/example/bob.yaml` with the correct :code:`<SERVER_PORT>` and :code:`<SERVER_IP>`.
 
 ❓ Troubleshooting
 -------------------

_sources/high_level_concepts/mechanism.rst.txt

@@ -9,7 +9,7 @@ This mechanism allows agents to join the IoA ecosystem and find suitable collabo
 
 * **Agent Registration**: When a new agent joins IoA, it registers with the server by providing a comprehensive description of its capabilities, skills, and expertise. This information is stored in the Agent Registry Block of the server's Data Layer.
 
-* **Agent Discovery**: Agents can search for collaborators using the `search_client` tool provided by the server's Agent Query Block. This tool leverages the information in the Agent Registry to match agents based on desired characteristics or capabilities.
+* **Agent Discovery**: Agents can search for collaborators using the :code:`search_client` tool provided by the server's Agent Query Block. This tool leverages the information in the Agent Registry to match agents based on desired characteristics or capabilities.
 
 🤝 Autonomous Nested Team Formation
 -----------------------------------
@@ -18,7 +18,7 @@ This mechanism enables dynamic and flexible team creation, allowing agents to fo
 .. figure:: ../_static/nested-team-up.png
    :class: custom-img
 
-* **Team Formation Process**: When assigned a task, an agent initiates team formation using the `search_client` and `launch_group_chat` tools. It can recursively form sub-teams as needed for multi-faceted tasks.
+* **Team Formation Process**: When assigned a task, an agent initiates team formation using the :code:`search_client` and :code:`launch_group_chat` tools. It can recursively form sub-teams as needed for multi-faceted tasks.
 
 * **Nested Team Structure**: This hierarchical approach reduces communication complexity and enhances collaboration efficiency, especially for complex tasks requiring diverse skills.
 

case/gaia.html

@@ -319,8 +319,8 @@ <h3>3. Let the Games Begin!<a class="headerlink" href="#let-the-games-begin" tit
 </pre></div>
 </div>
 <ul class="simple">
-<li><p>Replace <cite>&lt;level_in_gaia&gt;</cite> with your chosen difficulty (1, 2, or 3).</p></li>
-<li><p>Set <cite>&lt;thread_number&gt;</cite> to decide how many tasks the team handles simultaneously.</p></li>
+<li><p>Replace <code class="code docutils literal notranslate"><span class="pre">&lt;level_in_gaia&gt;</span></code> with your chosen difficulty (1, 2, or 3).</p></li>
+<li><p>Set <code class="code docutils literal notranslate"><span class="pre">&lt;thread_number&gt;</span></code> to decide how many tasks the team handles simultaneously.</p></li>
 </ul>
 </section>
 </section>

customize/goal_submission.html

@@ -297,7 +297,7 @@ <h2>Goal<a class="headerlink" href="#goal" title="Link to this heading">¶</a></
 The full URL <code class="code docutils literal notranslate"><span class="pre">url:</span> <span class="pre">&quot;http://127.0.0.1:5050/launch_goal&quot;</span></code> is used to send a POST request to the local server to initiate a goal. This request includes a JSON payload specifying the details of the goal, such as the goal description, maximum turns, and team member names and so on. The server at this endpoint processes the request and sets the specified goal for the IoA to accomplish.</p>
 <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">requests</span>
 <span class="n">goal</span> <span class="o">=</span> <span class="s2">&quot;task descrpition&quot;</span>
-<span class="s2">&quot;(e.g. goal = I want to know the annual revenue of Microsoft from 2014 to 2020. Please generate a figure in text format showing the trend of the annual revenue, and give me a analysis report.)&quot;</span>
+<span class="c1"># e.g. goal = I want to know the annual revenue of Microsoft from 2014 to 2020. Please generate a figure in text format showing the trend of the annual revenue, and give me a analysis report.</span>
 <span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">post</span><span class="p">(</span>
    <span class="s2">&quot;http://127.0.0.1:5050/launch_goal&quot;</span><span class="p">,</span>
    <span class="n">json</span><span class="o">=</span><span class="p">{</span>

customize/integrate_thirdparty_agent.html

@@ -356,7 +356,7 @@ <h2>Open Interpreter Docker Startup<a class="headerlink" href="#open-interpreter
 </pre></div>
 </div>
 </li>
-<li><p>Then, start the server and multiple communication agents by running:</p>
+<li><p>Then, start the server and communication agents by running:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>docker-compose<span class="w"> </span>-f<span class="w"> </span>dockerfiles/open_interpreter.yml<span class="w"> </span>up
 </pre></div>
 </div>

customize/tool_creation.html

@@ -304,16 +304,16 @@ <h1>Tool Creation<a class="headerlink" href="#tool-creation" title="Link to this
 <section id="tool-with-required-parameters">
 <h2>Tool with required parameters<a class="headerlink" href="#tool-with-required-parameters" title="Link to this heading">¶</a></h2>
 <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">function</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">your function description</span>
+<span class="w">    </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">function description</span>
 <span class="w">    </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">function name</span>
 <span class="w">    </span><span class="nt">parameters</span><span class="p">:</span>
 <span class="w">      </span><span class="nt">properties</span><span class="p">:</span>
 <span class="w">        </span><span class="nt">parameters_1</span><span class="p">:</span>
-<span class="w">          </span><span class="nt">description</span><span class="p">:</span><span class="w">  </span><span class="l l-Scalar l-Scalar-Plain">your parameters_1 description</span>
+<span class="w">          </span><span class="nt">description</span><span class="p">:</span><span class="w">  </span><span class="l l-Scalar l-Scalar-Plain">parameters_1 description</span>
 <span class="w">          </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">string / number / boolean</span>
-<span class="w">          </span><span class="nt">enum</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">&quot;It&#39;s</span><span class="nv"> </span><span class="s">necessary</span><span class="nv"> </span><span class="s">if</span><span class="nv"> </span><span class="s">your</span><span class="nv"> </span><span class="s">parameter</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">set</span><span class="nv"> </span><span class="s">by</span><span class="nv"> </span><span class="s">Literal</span><span class="nv"> </span><span class="s">type</span><span class="nv"> </span><span class="s">OR</span><span class="nv"> </span><span class="s">specified</span><span class="nv"> </span><span class="s">parameter&quot;</span><span class="p p-Indicator">]</span>
-<span class="w">        </span><span class="nt">parameters_2</span><span class="p">:</span><span class="w">  </span><span class="c1"># It&#39;s necessary if there are more than 1 parameter in your function</span>
-<span class="w">          </span><span class="nt">description</span><span class="p">:</span><span class="w">  </span><span class="l l-Scalar l-Scalar-Plain">your parameters_2 description</span>
+<span class="w">          </span><span class="nt">enum</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">&quot;It&#39;s</span><span class="nv"> </span><span class="s">necessary</span><span class="nv"> </span><span class="s">if</span><span class="nv"> </span><span class="s">parameter</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">set</span><span class="nv"> </span><span class="s">by</span><span class="nv"> </span><span class="s">Literal</span><span class="nv"> </span><span class="s">type</span><span class="nv"> </span><span class="s">OR</span><span class="nv"> </span><span class="s">specified</span><span class="nv"> </span><span class="s">parameter&quot;</span><span class="p p-Indicator">]</span>
+<span class="w">        </span><span class="nt">parameters_2</span><span class="p">:</span><span class="w">  </span><span class="c1"># It&#39;s necessary if there are more than 1 parameter in function</span>
+<span class="w">          </span><span class="nt">description</span><span class="p">:</span><span class="w">  </span><span class="l l-Scalar l-Scalar-Plain">parameters_2 description</span>
 <span class="w">          </span><span class="nt">type</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">string / number / boolean</span>
 <span class="w">      </span><span class="nt">required</span><span class="p">:</span>
 <span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">parameters_1</span>
@@ -329,7 +329,7 @@ <h2>Tool with required parameters<a class="headerlink" href="#tool-with-required
 <section id="tool-without-required-parameters">
 <h2>Tool without required parameters<a class="headerlink" href="#tool-without-required-parameters" title="Link to this heading">¶</a></h2>
 <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">function</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">your function description</span>
+<span class="w">    </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">function description</span>
 <span class="w">    </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">function name</span>
 <span class="w">    </span><span class="nt">parameters</span><span class="p">:</span>
 <span class="w">      </span><span class="nt">properties</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{}</span>

distributed_service/config.html

@@ -294,8 +294,8 @@ <h2>🗄️ Server Setup<a class="headerlink" href="#server-setup" title="Link t
 <h3>1. Configure Network Access<a class="headerlink" href="#configure-network-access" title="Link to this heading">¶</a></h3>
 <p>Open two ports on your server:</p>
 <ul class="simple">
-<li><p>&lt;SERVER_PORT&gt; (default: 7788) for the IoA server</p></li>
-<li><p>&lt;FRONTEND_PORT&gt; (default: 80) for the web frontend</p></li>
+<li><p><code class="code docutils literal notranslate"><span class="pre">&lt;SERVER_PORT&gt;</span></code> (default: 7788) for the IoA server</p></li>
+<li><p><code class="code docutils literal notranslate"><span class="pre">&lt;FRONTEND_PORT&gt;</span></code> (default: 80) for the web frontend</p></li>
 </ul>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
@@ -324,7 +324,7 @@ <h3>3. Launch Services<a class="headerlink" href="#launch-services" title="Link
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>If using custom ports, modify the <cite>server_only.yaml</cite> file:</p>
+<p>If using custom ports, modify the <code class="code docutils literal notranslate"><span class="pre">server_only.yaml</span></code> file:</p>
 <div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">Server</span><span class="p">:</span>
 <span class="w">   </span><span class="nt">ports</span><span class="p">:</span>
 <span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">&lt;SERVER_PORT&gt;:7788</span>
@@ -338,7 +338,7 @@ <h3>3. Launch Services<a class="headerlink" href="#launch-services" title="Link
 </section>
 <section id="access-the-frontend">
 <h3>4. Access the Frontend<a class="headerlink" href="#access-the-frontend" title="Link to this heading">¶</a></h3>
-<p>Open <cite>http://&lt;SERVER_IP&gt;:&lt;FRONTEND_PORT&gt;</cite> in a web browser to view the agents’ communication interface.</p>
+<p>Open <code class="code docutils literal notranslate"><span class="pre">http://&lt;SERVER_IP&gt;:&lt;FRONTEND_PORT&gt;</span></code> in a web browser to view the agents’ communication interface.</p>
 </section>
 </section>
 <section id="client-setup">
@@ -379,7 +379,7 @@ <h3>4. Launch Client<a class="headerlink" href="#launch-client" title="Link to t
 </div>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>Ensure you’ve updated <cite>configs/client_configs/case/example/bob.yaml</cite> with the correct &lt;SERVER_PORT&gt; and &lt;SERVER_IP&gt;.</p>
+<p>Ensure you’ve updated <code class="code docutils literal notranslate"><span class="pre">configs/client_configs/case/example/bob.yaml</span></code> with the correct <code class="code docutils literal notranslate"><span class="pre">&lt;SERVER_PORT&gt;</span></code> and <code class="code docutils literal notranslate"><span class="pre">&lt;SERVER_IP&gt;</span></code>.</p>
 </div>
 </section>
 </section>

high_level_concepts/mechanism.html

@@ -293,7 +293,7 @@ <h2>🔍 Agent Registration and Discovery<a class="headerlink" href="#agent-regi
 <p>This mechanism allows agents to join the IoA ecosystem and find suitable collaborators for specific tasks.</p>
 <ul class="simple">
 <li><p><strong>Agent Registration</strong>: When a new agent joins IoA, it registers with the server by providing a comprehensive description of its capabilities, skills, and expertise. This information is stored in the Agent Registry Block of the server’s Data Layer.</p></li>
-<li><p><strong>Agent Discovery</strong>: Agents can search for collaborators using the <cite>search_client</cite> tool provided by the server’s Agent Query Block. This tool leverages the information in the Agent Registry to match agents based on desired characteristics or capabilities.</p></li>
+<li><p><strong>Agent Discovery</strong>: Agents can search for collaborators using the <code class="code docutils literal notranslate"><span class="pre">search_client</span></code> tool provided by the server’s Agent Query Block. This tool leverages the information in the Agent Registry to match agents based on desired characteristics or capabilities.</p></li>
 </ul>
 </section>
 <section id="autonomous-nested-team-formation">
@@ -303,7 +303,7 @@ <h2>🤝 Autonomous Nested Team Formation<a class="headerlink" href="#autonomous
 <img alt="../_images/nested-team-up.png" class="custom-img" src="../_images/nested-team-up.png" />
 </figure>
 <ul class="simple">
-<li><p><strong>Team Formation Process</strong>: When assigned a task, an agent initiates team formation using the <cite>search_client</cite> and <cite>launch_group_chat</cite> tools. It can recursively form sub-teams as needed for multi-faceted tasks.</p></li>
+<li><p><strong>Team Formation Process</strong>: When assigned a task, an agent initiates team formation using the <code class="code docutils literal notranslate"><span class="pre">search_client</span></code> and <code class="code docutils literal notranslate"><span class="pre">launch_group_chat</span></code> tools. It can recursively form sub-teams as needed for multi-faceted tasks.</p></li>
 <li><p><strong>Nested Team Structure</strong>: This hierarchical approach reduces communication complexity and enhances collaboration efficiency, especially for complex tasks requiring diverse skills.</p></li>
 </ul>
 </section>