deploy: 11fba23f1f

build_with_arch/agent.html

@@ -155,13 +155,13 @@
 <span id="arch-agent-guide"></span><h1>Agentic Workflow<a @click.prevent="window.navigator.clipboard.writeText($el.href); $el.setAttribute('data-tooltip', 'Copied!'); setTimeout(() =&gt; $el.setAttribute('data-tooltip', 'Copy link to this element'), 2000)" aria-label="Copy link to this element" class="headerlink" data-tooltip="Copy link to this element" href="#agentic-workflow"><svg height="1em" viewbox="0 0 24 24" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"></path></svg></a></h1>
 <p>Arch helps you easily personalize your applications by calling application-specific (API) functions
 via user prompts. This involves any predefined functions or APIs you want to expose to users to perform tasks,
-gather information, or manipulate data. This capability is generally referred to as <strong>function calling</strong>, where
+gather information, or manipulate data. This capability is generally referred to as <a class="reference internal" href="../guides/function_calling.html#function-calling"><span class="std std-ref">function calling</span></a>, where
 you have the flexibility to support “agentic” apps tailored to specific use cases - from updating insurance
 claims to creating ad campaigns - via prompts.</p>
 <p>Arch analyzes prompts, extracts critical information from prompts, engages in lightweight conversation with
 the user to gather any missing parameters and makes API calls so that you can focus on writing business logic.
-Arch does this via its purpose-built <a class="reference internal" href="../guides/function_calling.html#function-calling"><span class="std std-ref">Arch-Function</span></a> - the fastest (200ms p90 - 10x faser than GPT-4o)
-and cheapest (100x than GPT-40) function-calling LLM that matches performance with frontier models.</p>
+Arch does this via its purpose-built <a class="reference external" href="https://huggingface.co/collections/katanemo/arch-function-66f209a693ea8df14317ad68" rel="nofollow noopener">Arch-Function<svg fill="currentColor" height="1em" stroke="none" viewbox="0 96 960 960" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M188 868q-11-11-11-28t11-28l436-436H400q-17 0-28.5-11.5T360 336q0-17 11.5-28.5T400 296h320q17 0 28.5 11.5T760 336v320q0 17-11.5 28.5T720 696q-17 0-28.5-11.5T680 656V432L244 868q-11 11-28 11t-28-11Z"></path></svg></a> - the fastest (200ms p90 - 10x faser than GPT-4o)
+and cheapest (100x than GPT-4o) function calling LLM that matches performance with frontier models.</p>
 <a class="reference internal image-reference" href="../_images/function-calling-flow.jpg"><img alt="../_images/function-calling-flow.jpg" class="align-center" src="../_images/function-calling-flow.jpg" style="width: 100%;"/>
 </a>
 <section id="single-function-call">
@@ -191,9 +191,9 @@ is how you would go about enabling this scenario with Arch:</p>
 </span><span id="line-16"><span class="linenos">16</span><span class="nt">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
 </span><span id="line-17"><span class="linenos">17</span><span class="w">  </span><span class="no">You are a network assistant that just offers facts; not advice on manufacturers or purchasing decisions.</span>
 </span><span id="line-18"><span class="linenos">18</span>
-</span><span id="line-19"><span class="linenos">19</span><span class="nt">prompt_targets</span><span class="p">:</span>
-</span><span id="line-20"><span class="linenos">20</span><span class="w">    </span><span class="p p-Indicator">-</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">network_qa</span>
-</span><span id="line-21"><mark><span class="linenos">21</span><span class="w">      </span><span class="nt">endpoint</span><span class="p">:</span>
+</span><span id="line-19"><mark><span class="linenos">19</span><span class="nt">prompt_targets</span><span class="p">:</span>
+</mark></span><span id="line-20"><mark><span class="linenos">20</span><span class="w">    </span><span class="p p-Indicator">-</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">network_qa</span>
+</mark></span><span id="line-21"><mark><span class="linenos">21</span><span class="w">      </span><span class="nt">endpoint</span><span class="p">:</span>
 </mark></span><span id="line-22"><mark><span class="linenos">22</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">app_server</span>
 </mark></span><span id="line-23"><mark><span class="linenos">23</span><span class="w">        </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/agent/network_summary</span>
 </mark></span><span id="line-24"><mark><span class="linenos">24</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">Handle general Q/A related to networking.</span>
@@ -207,22 +207,22 @@ is how you would go about enabling this scenario with Arch:</p>
 </mark></span><span id="line-32"><mark><span class="linenos">32</span><span class="w">        </span><span class="p p-Indicator">-</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">device_ids</span>
 </mark></span><span id="line-33"><mark><span class="linenos">33</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">list</span>
 </mark></span><span id="line-34"><mark><span class="linenos">34</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">A list of device identifiers (IDs) to reboot.</span>
-</mark></span><span id="line-35"><span class="linenos">35</span><span class="w">          </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-</span><span id="line-36"><span class="linenos">36</span><span class="w">    </span><span class="p p-Indicator">-</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">device_summary</span>
-</span><span id="line-37"><span class="linenos">37</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">Retrieve statistics for specific devices within a time range</span>
-</span><span id="line-38"><span class="linenos">38</span><span class="w">      </span><span class="nt">endpoint</span><span class="p">:</span>
-</span><span id="line-39"><span class="linenos">39</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">app_server</span>
-</span><span id="line-40"><span class="linenos">40</span><span class="w">        </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/agent/device_summary</span>
-</span><span id="line-41"><span class="linenos">41</span><span class="w">      </span><span class="nt">parameters</span><span class="p">:</span>
-</span><span id="line-42"><span class="linenos">42</span><span class="w">        </span><span class="p p-Indicator">-</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">device_ids</span>
-</span><span id="line-43"><span class="linenos">43</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">list</span>
-</span><span id="line-44"><span class="linenos">44</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">A list of device identifiers (IDs) to retrieve statistics for.</span>
-</span><span id="line-45"><span class="linenos">45</span><span class="w">          </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w">  </span><span class="c1"># device_ids are required to get device statistics</span>
-</span><span id="line-46"><span class="linenos">46</span><span class="w">        </span><span class="p p-Indicator">-</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">time_range</span>
-</span><span id="line-47"><span class="linenos">47</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">int</span>
-</span><span id="line-48"><span class="linenos">48</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">Time range in days for which to gather device statistics. Defaults to 7.</span>
-</span><span id="line-49"><span class="linenos">49</span><span class="w">          </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="s">"7"</span>
-</span><span id="line-50"><span class="linenos">50</span>
+</mark></span><span id="line-35"><mark><span class="linenos">35</span><span class="w">          </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
+</mark></span><span id="line-36"><mark><span class="linenos">36</span><span class="w">    </span><span class="p p-Indicator">-</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">device_summary</span>
+</mark></span><span id="line-37"><mark><span class="linenos">37</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">Retrieve statistics for specific devices within a time range</span>
+</mark></span><span id="line-38"><mark><span class="linenos">38</span><span class="w">      </span><span class="nt">endpoint</span><span class="p">:</span>
+</mark></span><span id="line-39"><mark><span class="linenos">39</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">app_server</span>
+</mark></span><span id="line-40"><mark><span class="linenos">40</span><span class="w">        </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/agent/device_summary</span>
+</mark></span><span id="line-41"><mark><span class="linenos">41</span><span class="w">      </span><span class="nt">parameters</span><span class="p">:</span>
+</mark></span><span id="line-42"><mark><span class="linenos">42</span><span class="w">        </span><span class="p p-Indicator">-</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">device_ids</span>
+</mark></span><span id="line-43"><mark><span class="linenos">43</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">list</span>
+</mark></span><span id="line-44"><mark><span class="linenos">44</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">A list of device identifiers (IDs) to retrieve statistics for.</span>
+</mark></span><span id="line-45"><mark><span class="linenos">45</span><span class="w">          </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w">  </span><span class="c1"># device_ids are required to get device statistics</span>
+</mark></span><span id="line-46"><mark><span class="linenos">46</span><span class="w">        </span><span class="p p-Indicator">-</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">time_range</span>
+</mark></span><span id="line-47"><mark><span class="linenos">47</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">int</span>
+</mark></span><span id="line-48"><mark><span class="linenos">48</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">Time range in days for which to gather device statistics. Defaults to 7.</span>
+</mark></span><span id="line-49"><mark><span class="linenos">49</span><span class="w">          </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">7</span>
+</mark></span><span id="line-50"><span class="linenos">50</span>
 </span><span id="line-51"><span class="linenos">51</span><span class="c1"># Arch creates a round-robin load balancing between different endpoints, managed via the cluster subsystem.</span>
 </span><span id="line-52"><span class="linenos">52</span><span class="nt">endpoints</span><span class="p">:</span>
 </span><span id="line-53"><span class="linenos">53</span><span class="w">  </span><span class="nt">app_server</span><span class="p">:</span>
@@ -324,9 +324,9 @@ the user’s intent.</p>
 </span><span id="line-16"><span class="linenos">16</span><span class="nt">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
 </span><span id="line-17"><span class="linenos">17</span><span class="w">  </span><span class="no">You are a network assistant that just offers facts; not advice on manufacturers or purchasing decisions.</span>
 </span><span id="line-18"><span class="linenos">18</span>
-</span><span id="line-19"><span class="linenos">19</span><span class="nt">prompt_targets</span><span class="p">:</span>
-</span><span id="line-20"><span class="linenos">20</span><span class="w">    </span><span class="p p-Indicator">-</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">network_qa</span>
-</span><span id="line-21"><mark><span class="linenos">21</span><span class="w">      </span><span class="nt">endpoint</span><span class="p">:</span>
+</span><span id="line-19"><mark><span class="linenos">19</span><span class="nt">prompt_targets</span><span class="p">:</span>
+</mark></span><span id="line-20"><mark><span class="linenos">20</span><span class="w">    </span><span class="p p-Indicator">-</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">network_qa</span>
+</mark></span><span id="line-21"><mark><span class="linenos">21</span><span class="w">      </span><span class="nt">endpoint</span><span class="p">:</span>
 </mark></span><span id="line-22"><mark><span class="linenos">22</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">app_server</span>
 </mark></span><span id="line-23"><mark><span class="linenos">23</span><span class="w">        </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/agent/network_summary</span>
 </mark></span><span id="line-24"><mark><span class="linenos">24</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">Handle general Q/A related to networking.</span>
@@ -340,22 +340,22 @@ the user’s intent.</p>
 </mark></span><span id="line-32"><mark><span class="linenos">32</span><span class="w">        </span><span class="p p-Indicator">-</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">device_ids</span>
 </mark></span><span id="line-33"><mark><span class="linenos">33</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">list</span>
 </mark></span><span id="line-34"><mark><span class="linenos">34</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">A list of device identifiers (IDs) to reboot.</span>
-</mark></span><span id="line-35"><span class="linenos">35</span><span class="w">          </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-</span><span id="line-36"><span class="linenos">36</span><span class="w">    </span><span class="p p-Indicator">-</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">device_summary</span>
-</span><span id="line-37"><span class="linenos">37</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">Retrieve statistics for specific devices within a time range</span>
-</span><span id="line-38"><span class="linenos">38</span><span class="w">      </span><span class="nt">endpoint</span><span class="p">:</span>
-</span><span id="line-39"><span class="linenos">39</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">app_server</span>
-</span><span id="line-40"><span class="linenos">40</span><span class="w">        </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/agent/device_summary</span>
-</span><span id="line-41"><span class="linenos">41</span><span class="w">      </span><span class="nt">parameters</span><span class="p">:</span>
-</span><span id="line-42"><span class="linenos">42</span><span class="w">        </span><span class="p p-Indicator">-</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">device_ids</span>
-</span><span id="line-43"><span class="linenos">43</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">list</span>
-</span><span id="line-44"><span class="linenos">44</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">A list of device identifiers (IDs) to retrieve statistics for.</span>
-</span><span id="line-45"><span class="linenos">45</span><span class="w">          </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w">  </span><span class="c1"># device_ids are required to get device statistics</span>
-</span><span id="line-46"><span class="linenos">46</span><span class="w">        </span><span class="p p-Indicator">-</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">time_range</span>
-</span><span id="line-47"><span class="linenos">47</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">int</span>
-</span><span id="line-48"><span class="linenos">48</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">Time range in days for which to gather device statistics. Defaults to 7.</span>
-</span><span id="line-49"><span class="linenos">49</span><span class="w">          </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="s">"7"</span>
-</span><span id="line-50"><span class="linenos">50</span>
+</mark></span><span id="line-35"><mark><span class="linenos">35</span><span class="w">          </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
+</mark></span><span id="line-36"><mark><span class="linenos">36</span><span class="w">    </span><span class="p p-Indicator">-</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">device_summary</span>
+</mark></span><span id="line-37"><mark><span class="linenos">37</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">Retrieve statistics for specific devices within a time range</span>
+</mark></span><span id="line-38"><mark><span class="linenos">38</span><span class="w">      </span><span class="nt">endpoint</span><span class="p">:</span>
+</mark></span><span id="line-39"><mark><span class="linenos">39</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">app_server</span>
+</mark></span><span id="line-40"><mark><span class="linenos">40</span><span class="w">        </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/agent/device_summary</span>
+</mark></span><span id="line-41"><mark><span class="linenos">41</span><span class="w">      </span><span class="nt">parameters</span><span class="p">:</span>
+</mark></span><span id="line-42"><mark><span class="linenos">42</span><span class="w">        </span><span class="p p-Indicator">-</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">device_ids</span>
+</mark></span><span id="line-43"><mark><span class="linenos">43</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">list</span>
+</mark></span><span id="line-44"><mark><span class="linenos">44</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">A list of device identifiers (IDs) to retrieve statistics for.</span>
+</mark></span><span id="line-45"><mark><span class="linenos">45</span><span class="w">          </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w">  </span><span class="c1"># device_ids are required to get device statistics</span>
+</mark></span><span id="line-46"><mark><span class="linenos">46</span><span class="w">        </span><span class="p p-Indicator">-</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">time_range</span>
+</mark></span><span id="line-47"><mark><span class="linenos">47</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">int</span>
+</mark></span><span id="line-48"><mark><span class="linenos">48</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">Time range in days for which to gather device statistics. Defaults to 7.</span>
+</mark></span><span id="line-49"><mark><span class="linenos">49</span><span class="w">          </span><span class="nt">default</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">7</span>
+</mark></span><span id="line-50"><span class="linenos">50</span>
 </span><span id="line-51"><span class="linenos">51</span><span class="c1"># Arch creates a round-robin load balancing between different endpoints, managed via the cluster subsystem.</span>
 </span><span id="line-52"><span class="linenos">52</span><span class="nt">endpoints</span><span class="p">:</span>
 </span><span id="line-53"><span class="linenos">53</span><span class="w">  </span><span class="nt">app_server</span><span class="p">:</span>