You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
9468 lines
395 KiB
9468 lines
395 KiB
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<meta name="description" content="The Enterprise-Grade Production-Ready Multi-Agent Orchestration Framework">
|
|
|
|
|
|
<meta name="author" content="Swarms">
|
|
|
|
|
|
<link rel="canonical" href="https://docs.swarms.world/swarms_cloud/quickstart/">
|
|
|
|
|
|
<link rel="prev" href="../swarms_api/">
|
|
|
|
|
|
<link rel="next" href="../mcp/">
|
|
|
|
|
|
<link rel="icon" href="../../assets/images/favicon.png">
|
|
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.15">
|
|
|
|
|
|
|
|
<title>Quickstart - Swarms</title>
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/main.342714a4.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
<style>
|
|
/* Custom Footer Styling - Base */
|
|
.md-footer-custom {
|
|
padding: 2.4rem 0 1.2rem;
|
|
border-top: 0.05rem solid var(--md-default-fg-color--lightest);
|
|
}
|
|
|
|
.md-footer-custom__inner {
|
|
margin: 0 auto;
|
|
padding: 0 1.2rem;
|
|
}
|
|
|
|
.md-footer-links {
|
|
display: grid;
|
|
grid-template-columns: repeat(auto-fit, minmax(240px, 1fr));
|
|
gap: 2rem;
|
|
max-width: 1220px;
|
|
margin: 0 auto;
|
|
}
|
|
|
|
.md-footer-links__section {
|
|
min-width: 0;
|
|
}
|
|
|
|
.md-footer-links__title {
|
|
font-size: 0.64rem;
|
|
font-weight: 700;
|
|
margin: 0 0 1rem;
|
|
text-transform: uppercase;
|
|
letter-spacing: 0.1em;
|
|
padding-bottom: 0.4rem;
|
|
}
|
|
|
|
.md-footer-links__list {
|
|
list-style: none;
|
|
margin: 0;
|
|
padding: 0;
|
|
}
|
|
|
|
.md-footer-links__item {
|
|
margin: 0;
|
|
line-height: 1.8;
|
|
}
|
|
|
|
.md-footer-links__link {
|
|
text-decoration: none;
|
|
font-size: 0.7rem;
|
|
display: block;
|
|
padding: 0.1rem 0;
|
|
transition: color 125ms;
|
|
border-radius: 0.1rem;
|
|
}
|
|
|
|
.md-footer-links__link:hover,
|
|
.md-footer-links__link:focus {
|
|
color: var(--md-accent-fg-color);
|
|
}
|
|
|
|
/* Light Mode (Default) */
|
|
[data-md-color-scheme="default"] .md-footer-custom {
|
|
background: #ffffff;
|
|
border-top-color: #e1e5e9;
|
|
}
|
|
|
|
[data-md-color-scheme="default"] .md-footer-links__title {
|
|
color: #2e3440;
|
|
border-bottom: 0.05rem solid #e1e5e9;
|
|
}
|
|
|
|
[data-md-color-scheme="default"] .md-footer-links__link {
|
|
color: #636c76;
|
|
}
|
|
|
|
[data-md-color-scheme="default"] .md-footer-links__link:hover,
|
|
[data-md-color-scheme="default"] .md-footer-links__link:focus {
|
|
color: #1976d2;
|
|
}
|
|
|
|
/* Dark Mode (Slate) */
|
|
[data-md-color-scheme="slate"] .md-footer-custom {
|
|
background: #1F2129;
|
|
border-top-color: #404040;
|
|
}
|
|
|
|
[data-md-color-scheme="slate"] .md-footer-links__title {
|
|
color: #ffffff;
|
|
border-bottom: 0.05rem solid #404040;
|
|
}
|
|
|
|
[data-md-color-scheme="slate"] .md-footer-links__link {
|
|
color: #9ca3af;
|
|
}
|
|
|
|
[data-md-color-scheme="slate"] .md-footer-links__link:hover,
|
|
[data-md-color-scheme="slate"] .md-footer-links__link:focus {
|
|
color: #42a5f5;
|
|
}
|
|
|
|
/* Company Information Section - Base */
|
|
.md-footer-company {
|
|
padding: 1.5rem 0;
|
|
border-top: 0.05rem solid var(--md-default-fg-color--lightest);
|
|
}
|
|
|
|
.md-footer-company__inner {
|
|
margin: 0 auto;
|
|
padding: 0 1.2rem;
|
|
max-width: 1220px;
|
|
}
|
|
|
|
.md-footer-company__content {
|
|
display: flex;
|
|
justify-content: space-between;
|
|
align-items: center;
|
|
flex-wrap: wrap;
|
|
gap: 1rem;
|
|
}
|
|
|
|
.md-footer-company__brand {
|
|
flex: 1;
|
|
min-width: 200px;
|
|
}
|
|
|
|
.md-footer-company__name {
|
|
margin: 0 0 0.5rem 0;
|
|
font-size: 1.2rem;
|
|
font-weight: 700;
|
|
letter-spacing: 0.05em;
|
|
}
|
|
|
|
.md-footer-company__description {
|
|
margin: 0;
|
|
font-size: 0.8rem;
|
|
line-height: 1.4;
|
|
font-style: italic;
|
|
}
|
|
|
|
.md-footer-company__copyright {
|
|
text-align: right;
|
|
}
|
|
|
|
.md-footer-company__copyright p {
|
|
margin: 0;
|
|
font-size: 0.7rem;
|
|
opacity: 0.8;
|
|
}
|
|
|
|
/* Company Section - Light Mode */
|
|
[data-md-color-scheme="default"] .md-footer-company {
|
|
background: #f8f9fa;
|
|
border-top-color: #e1e5e9;
|
|
}
|
|
|
|
[data-md-color-scheme="default"] .md-footer-company__name {
|
|
color: #DC143C;
|
|
}
|
|
|
|
[data-md-color-scheme="default"] .md-footer-company__description {
|
|
color: #495057;
|
|
}
|
|
|
|
[data-md-color-scheme="default"] .md-footer-company__copyright p {
|
|
color: #6c757d;
|
|
}
|
|
|
|
/* Company Section - Dark Mode */
|
|
[data-md-color-scheme="slate"] .md-footer-company {
|
|
background: #1F2129;
|
|
border-top-color: #404040;
|
|
}
|
|
|
|
[data-md-color-scheme="slate"] .md-footer-company__name {
|
|
color: #DC143C;
|
|
}
|
|
|
|
[data-md-color-scheme="slate"] .md-footer-company__description {
|
|
color: #d1d5db;
|
|
}
|
|
|
|
[data-md-color-scheme="slate"] .md-footer-company__copyright p {
|
|
color: #9ca3af;
|
|
}
|
|
|
|
/* Responsive Design */
|
|
@media screen and (max-width: 76.1875em) {
|
|
.md-footer-links {
|
|
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
|
|
gap: 1.5rem;
|
|
}
|
|
|
|
.md-footer-custom {
|
|
padding: 2rem 0 1rem;
|
|
}
|
|
}
|
|
|
|
@media screen and (max-width: 59.9375em) {
|
|
.md-footer-links {
|
|
grid-template-columns: repeat(2, 1fr);
|
|
gap: 1.5rem;
|
|
}
|
|
}
|
|
|
|
@media screen and (max-width: 44.9375em) {
|
|
.md-footer-links {
|
|
grid-template-columns: 1fr;
|
|
gap: 1.5rem;
|
|
}
|
|
|
|
.md-footer-custom {
|
|
padding: 1.5rem 0 0.8rem;
|
|
}
|
|
|
|
.md-footer-custom__inner {
|
|
padding: 0 1rem;
|
|
}
|
|
|
|
/* Company section mobile styles */
|
|
.md-footer-company__content {
|
|
flex-direction: column;
|
|
text-align: center;
|
|
gap: 1rem;
|
|
}
|
|
|
|
.md-footer-company__brand {
|
|
min-width: auto;
|
|
}
|
|
|
|
.md-footer-company__copyright {
|
|
text-align: center;
|
|
}
|
|
|
|
.md-footer-company__inner {
|
|
padding: 0 1rem;
|
|
}
|
|
}
|
|
</style>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Fira+Sans:300,300i,400,400i,700,700i%7CFira+Code:400,400i,700,700i&display=fallback">
|
|
<style>:root{--md-text-font:"Fira Sans";--md-code-font:"Fira Code"}</style>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/_mkdocstrings.css">
|
|
|
|
<link rel="stylesheet" href="../../assets/css/extra.css">
|
|
|
|
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-MPE9C65596"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-MPE9C65596",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-MPE9C65596",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
|
|
|
|
<script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
|
|
|
|
|
|
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="white">
|
|
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#swarms-quickstart-guide" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
<aside class="md-banner">
|
|
<div class="md-banner__inner md-grid md-typeset">
|
|
|
|
<button class="md-banner__button md-icon" aria-label="Don't show this again">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
|
</button>
|
|
|
|
|
|
<div style="text-align:center">
|
|
<a href="https://github.com/kyegomez/swarms">Star and contribute</a> to Swarms on GitHub!
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<script>var el=document.querySelector("[data-md-component=announce]");if(el){var content=el.querySelector(".md-typeset");__md_hash(content.innerHTML)===__md_get("__announce")&&(el.hidden=!0)}</script>
|
|
|
|
</aside>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<header class="md-header" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href="../.." title="Swarms" class="md-header__button md-logo" aria-label="Swarms" data-md-component="logo">
|
|
|
|
<img src="../../assets/img/swarms-logo.png" alt="logo">
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
Swarms
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
Quickstart
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<form class="md-header__option" data-md-component="palette">
|
|
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="white" data-md-color-accent="white" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
|
|
</label>
|
|
|
|
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="black" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
|
|
</label>
|
|
|
|
|
|
</form>
|
|
|
|
|
|
|
|
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-header__button md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
</label>
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
|
</label>
|
|
<nav class="md-search__options" aria-label="Search">
|
|
|
|
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
|
</button>
|
|
</nav>
|
|
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list" role="presentation"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-header__source">
|
|
<a href="https://github.com/kyegomez/swarms" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
kyegomez/swarms
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
|
|
<div class="md-grid">
|
|
<ul class="md-tabs__list">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../.." class="md-tabs__link">
|
|
|
|
|
|
|
|
Home
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../examples/" class="md-tabs__link">
|
|
|
|
|
|
|
|
Examples
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item md-tabs__item--active">
|
|
<a href="../swarms_api/" class="md-tabs__link">
|
|
|
|
|
|
|
|
Swarms Cloud API
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../swarms_platform/" class="md-tabs__link">
|
|
|
|
|
|
|
|
Swarms Marketplace
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../swarms_rs/overview/" class="md-tabs__link">
|
|
|
|
|
|
|
|
Swarms Rust
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../contributors/main/" class="md-tabs__link">
|
|
|
|
|
|
|
|
Contributors
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-tabs__item">
|
|
<a href="../../swarms/concept/vision/" class="md-tabs__link">
|
|
|
|
|
|
|
|
About Swarms
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href="../.." title="Swarms" class="md-nav__button md-logo" aria-label="Swarms" data-md-component="logo">
|
|
|
|
<img src="../../assets/img/swarms-logo.png" alt="logo">
|
|
|
|
</a>
|
|
Swarms
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
<a href="https://github.com/kyegomez/swarms" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
kyegomez/swarms
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1" id="__nav_1_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Home
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Home
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../.." class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_2" id="__nav_1_2_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Onboarding
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Onboarding
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/install/install/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Installation
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/install/env/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Environment Configuration
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../quickstart/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Quickstart
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Multi-Agent Architectures
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/features/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Feature Set
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_3" id="__nav_1_3_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Agents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/framework/agents_explained/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/agent/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Reference
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/models/agent_and_models/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
LLM Providers
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/tools/tools_examples/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Tools and MCP
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/agent_multi_agent_communication/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Multi-Agent Helpers
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/create_agents_yaml/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Running Agents with YAML
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_3_8" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_3_8" id="__nav_1_3_8_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Additional Capabilities
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_1_3_8_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_3_8">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Additional Capabilities
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_3_8_1" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_3_8_1" id="__nav_1_3_8_1_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Tools Reference
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_1_3_8_1_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_3_8_1">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Tools Reference
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/tools/main/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/tools/build_tool/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
What are tools?
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/structured_outputs/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Structured Outputs
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/agent_mcp/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent MCP Integration
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_3_8_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_3_8_2" id="__nav_1_3_8_2_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Long Term Memory Reference
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_1_3_8_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_3_8_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Long Term Memory Reference
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/memory/diy_memory/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Integrating RAG with Agents
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_4" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_4" id="__nav_1_4_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Third-Party Agents
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_4_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Third-Party Agents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/new_agent/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Creating Custom Agents
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/openai_assistant/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenAI Assistant
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/external_party_agents/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Integrating External Agents from Griptape, Langchain, etc
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_5" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_5" id="__nav_1_5_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Reasoning Agents
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_5_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Reasoning Agents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/reasoning_agents_overview/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/consistency_agent/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Self Consistency Agent
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/iterative_agent/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
IRE Agent
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/reasoning_duo/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Reasoning Duo
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/reflexion_agent/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Reflexion Agent
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/gkp_agent/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
GKP Agent
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/agent_judge/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent Judge
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/agents/reasoning_agent_router/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Reasoning Agent Router
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_6" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_6" id="__nav_1_6_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Multi-Agent Architectures
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_6_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_6">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Multi-Agent Architectures
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/concept/swarm_architectures/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/concept/why/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Benefits
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/concept/how_to_choose_swarms/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Choosing Multi Agent Architecture
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_6_4" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_6_4" id="__nav_1_6_4_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Board of Directors
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_1_6_4_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_6_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Board of Directors
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/board_of_directors/board_of_directors_swarm/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
BoardOfDirectorsSwarm
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/board_of_directors/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/board_of_directors/board_of_directors_workflow/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Workflow
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/board_of_directors/board_of_directors_roles/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Roles & Responsibilities
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/board_of_directors/board_of_directors_decision_making/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Decision Making
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_6_5" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_6_5" id="__nav_1_6_5_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Documentation
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_1_6_5_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_6_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Documentation
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/overview/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/custom_swarm/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Custom Multi Agent Architectures
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/majorityvoting/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
MajorityVoting
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/round_robin_swarm/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
RoundRobin
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/moa/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Mixture of Agents
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/spreadsheet_swarm/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
SpreadSheetSwarm
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/forest_swarm/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
ForestSwarm
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/malt/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
MALT
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/various_execution_methods/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Various Execution Methods
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/deep_research_swarm/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Deep Research Swarm
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/council_of_judges/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Council of Judges
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/heavy_swarm/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Heavy Swarm
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_6_5_13" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_6_5_13" id="__nav_1_6_5_13_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Hiearchical Architectures
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_1_6_5_13_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_6_5_13">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Hiearchical Architectures
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/multi_swarm_orchestration/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/hierarchical_swarm/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
HierarchicalSwarm
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/auto_agent_builder/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Auto Agent Builder
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/hhcs/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Hybrid Hierarchical-Cluster Swarm
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/auto_swarm_builder/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Auto Swarm Builder
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/swarm_matcher/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Swarm Matcher
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_6_5_14" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_6_5_14" id="__nav_1_6_5_14_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Routers
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_1_6_5_14_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_6_5_14">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Routers
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/swarm_router/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
SwarmRouter
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/multi_agent_router/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
MultiAgentRouter
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/model_router/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
ModelRouter
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_6_5_15" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_6_5_15" id="__nav_1_6_5_15_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Configuration
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_1_6_5_15_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_6_5_15">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Configuration
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/config/board_config/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Board of Directors Configuration
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_6_5_16" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_6_5_16" id="__nav_1_6_5_16_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Rearrangers
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_1_6_5_16_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_6_5_16">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Rearrangers
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/swarm_rearrange/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
SwarmRearrange
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/agent_rearrange/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
AgentRearrange
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_6_5_17" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_6_5_17" id="__nav_1_6_5_17_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
GroupChats
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_1_6_5_17_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_6_5_17">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
GroupChats
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/group_chat/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
GroupChat
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/interactive_groupchat/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Interactive Group Chat
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_6_5_18" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_6_5_18" id="__nav_1_6_5_18_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Workflows
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_1_6_5_18_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_6_5_18">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Workflows
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/concurrentworkflow/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
ConcurrentWorkflow
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/sequential_workflow/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
SequentialWorkflow
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/graph_workflow/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
GraphWorkflow
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_6_5_19" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_6_5_19" id="__nav_1_6_5_19_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Storage
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_1_6_5_19_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_6_5_19">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Storage
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/agent_registry/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
AgentRegistry
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/structs/conversation/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Communication Structure
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_7" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_7" id="__nav_1_7_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Tools
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_7_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_7">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Tools
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_tools/overview/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/tools/base_tool/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
BaseTool Reference
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/tools/mcp_client_call/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
MCP Client Utils
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_7_4" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_7_4" id="__nav_1_7_4_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Vertical Tools
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_1_7_4_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_7_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Vertical Tools
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_tools/finance/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Finance
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_tools/search/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Search
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_7_4_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_7_4_3" id="__nav_1_7_4_3_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Social Media
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_1_7_4_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_7_4_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Social Media
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_tools/twitter/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Twitter
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_8" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_8" id="__nav_1_8_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Deployment Solutions
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_8_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_8">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Deployment Solutions
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../cloud_run/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Deploy on Google Cloud Run
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../phala_deploy/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Deploy on Phala
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1_9" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_1_9" id="__nav_1_9_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
More About Us
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_1_9_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_1_9">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
More About Us
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/ecosystem/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Swarms Ecosystem
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/support/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Technical Support
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Examples
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../examples/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../examples/cookbook_index/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
CookBook Index
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../examples/paper_implementations/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Paper Implementations
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../examples/templates/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Templates & Applications
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_5" id="__nav_2_5_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Basic Examples
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_2_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Basic Examples
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_5_1" id="__nav_2_5_1_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Individual Agents
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_1_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_2_5_1">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Individual Agents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/basic_agent/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Basic Agent
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_5_1_2" id="__nav_2_5_1_2_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Tool Usage
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_5_1_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_2_5_1_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Tool Usage
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/vision_tools/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents with Vision and Tool Usage
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/agent_with_tools/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents with Callable Tools
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/agent_structured_outputs/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent with Structured Outputs
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/agent_with_mcp.md" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent With MCP Integration
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_5_1_3" id="__nav_2_5_1_3_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Vision
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_5_1_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_2_5_1_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Vision
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/vision_processing/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents with Vision
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/multiple_images/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent with Multiple Images
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1_4" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_5_1_4" id="__nav_2_5_1_4_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Utils
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_5_1_4_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_2_5_1_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Utils
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../examples/agent_stream/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent with Streaming
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/agent_output_types/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agent Output Types
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/ui/main/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Gradio Chat Interface
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_1_5" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_5_1_5" id="__nav_2_5_1_5_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
LLM Providers
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_5_1_5_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_2_5_1_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
LLM Providers
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/model_providers/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/openai_example/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenAI
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/claude/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Anthropic
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/groq/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Groq
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/cohere/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Cohere
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/deepseek/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
DeepSeek
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/ollama/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Ollama
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/openrouter/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
OpenRouter
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/xai/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
XAI
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/vllm_integration/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
VLLM
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/llama4/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Llama4
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_6" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_6" id="__nav_2_6_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Advanced Examples
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_6_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_2_6">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Advanced Examples
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_6_1" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_6_1" id="__nav_2_6_1_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Multi-Agent Architectures
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_6_1_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_2_6_1">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Multi-Agent Architectures
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/hierarchical_swarm_example/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
HierarchicalSwarm Examples
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/board_of_directors_example.md" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Board of Directors Example
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/hhcs_examples/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Hybrid Hierarchical-Cluster Swarm Example
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/groupchat_example/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Group Chat Example
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/sequential_example/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Sequential Workflow Example
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/swarm_router/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
SwarmRouter Example
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/multi_agent_router_minimal/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
MultiAgentRouter Minimal Example
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/concurrent_workflow/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
ConcurrentWorkflow Example
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/moa_example/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Mixture of Agents Example
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/unique_swarms/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Unique Swarms
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/agents_as_tools/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents as Tools
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/aggregate/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Aggregate Multi-Agent Responses
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/igc_example/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Interactive GroupChat Example
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_6_1_14" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2_6_1_14" id="__nav_2_6_1_14_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Applications
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_2_6_1_14_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_2_6_1_14">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Applications
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/swarms_dao/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Swarms DAO
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/swarms_of_browser_agents/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Swarms of Browser Agents
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/vllm/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
ConcurrentWorkflow with VLLM Agents
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Swarms Cloud API
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
|
|
<label class="md-nav__title" for="__nav_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Swarms Cloud API
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../swarms_api/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Quickstart
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Quickstart
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#prerequisites" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Prerequisites
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#installation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Installation
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#authentication" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Authentication
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#single-agent-usage" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Single Agent Usage
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Single Agent Usage">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#health-check" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Health Check
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#basic-agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Basic Agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#agent-with-history" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Agent with History
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#multi-agent-swarms" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Multi-Agent Swarms
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Multi-Agent Swarms">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#sequential-workflow" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Sequential Workflow
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#concurrent-workflow" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Concurrent Workflow
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#batch-processing" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Batch Processing
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#advanced-features" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Advanced Features
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Advanced Features">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tools-integration" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Tools Integration
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#available-models" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Available Models
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#best-practices" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Best Practices
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#connect-with-us" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Connect With Us
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../mcp/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
MCP Server
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../rate_limits/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Rate Limits
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../best_practices/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Best Practices
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_6" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_6" id="__nav_3_6_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Capabilities
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_6_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_6">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Capabilities
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_6_1" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_6_1" id="__nav_3_6_1_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_6_1_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_6_1">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Agents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../agent_api/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Individual Agent Completions
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../swarms_api_tools/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Tools
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_6_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_6_2" id="__nav_3_6_2_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Multi-Agent
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="3" aria-labelledby="__nav_3_6_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_6_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Multi-Agent
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../swarm_types/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Multi Agent Architectures Available
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_6_2_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_6_2_2" id="__nav_3_6_2_2_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Examples
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="4" aria-labelledby="__nav_3_6_2_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_6_2_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Examples
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/swarms_api_medical/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Medical Swarm
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/examples/swarms_api_finance/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Finance Swarm
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_7" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_7" id="__nav_3_7_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Clients
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_7_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_7">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Clients
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../api_clients/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../python_client/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Python Client
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../rust_client/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Rust Client
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_8" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3_8" id="__nav_3_8_label" tabindex="">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Pricing
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_3_8_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_3_8">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Pricing
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../api_pricing/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Pricing
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../subscription_tiers/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Subscription Tiers
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Swarms Marketplace
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Swarms Marketplace
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_platform/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_2" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4_2" id="__nav_4_2_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Marketplace
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_2_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_4_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Marketplace
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_platform/share_and_discover/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Share and Discover Agents, Prompts, and Tools
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_platform/monetize/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Monetize Your Prompts, Agents, and Tools
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4_3" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4_3" id="__nav_4_3_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Platform
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_4_3_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_4_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Platform
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_platform/apps_page/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Customize Your Sidebar
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_platform/playground_page/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Playground
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_platform/apikeys/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
API Key Management
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_platform/account_management/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Account Management
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Swarms Rust
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Swarms Rust
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_rs/overview/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms_rs/agents/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Agents
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Contributors
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_6">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Contributors
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../contributors/main/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Overview
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../contributors/environment_setup/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Environment Setup
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../corporate/bounty_program/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Bounty Program
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_4" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_6_4" id="__nav_6_4_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Development Guides
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_4_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_6_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Development Guides
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/framework/code_cleanliness/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Code Style Guide & Best Practices
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/framework/test/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Adding Tests
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../contributors/docs/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Adding Documentation
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../contributors/tools/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
New Tools & Plugins
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_5" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_6_5" id="__nav_6_5_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Architecture & Design
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_5_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_6_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Architecture & Design
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/concept/framework_architecture/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Understanding Swarms Architecture
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/concept/philosophy/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Development Philosophy & Principles
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
About Swarms
|
|
|
|
</span>
|
|
|
|
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
|
|
<label class="md-nav__title" for="__nav_7">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
About Swarms
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/concept/vision/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Vision & Mission
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/concept/swarm_ecosystem/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Swarm Ecosystem
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../swarms/products/" class="md-nav__link">
|
|
|
|
|
|
|
|
<span class="md-ellipsis">
|
|
Products
|
|
|
|
</span>
|
|
|
|
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#prerequisites" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Prerequisites
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#installation" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Installation
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#authentication" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Authentication
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#single-agent-usage" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Single Agent Usage
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Single Agent Usage">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#health-check" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Health Check
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#basic-agent" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Basic Agent
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#agent-with-history" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Agent with History
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#multi-agent-swarms" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Multi-Agent Swarms
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Multi-Agent Swarms">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#sequential-workflow" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Sequential Workflow
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#concurrent-workflow" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Concurrent Workflow
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#batch-processing" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Batch Processing
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#advanced-features" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Advanced Features
|
|
</span>
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Advanced Features">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tools-integration" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Tools Integration
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#available-models" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Available Models
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#best-practices" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Best Practices
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#connect-with-us" class="md-nav__link">
|
|
<span class="md-ellipsis">
|
|
Connect With Us
|
|
</span>
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h1 id="swarms-quickstart-guide">Swarms Quickstart Guide<a class="headerlink" href="#swarms-quickstart-guide" title="Permanent link">¶</a></h1>
|
|
<p>This guide will help you get started with both single agent and multi-agent functionalities in Swarms API.</p>
|
|
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">¶</a></h2>
|
|
<div class="admonition info">
|
|
<p class="admonition-title">Requirements</p>
|
|
<ul>
|
|
<li>Python 3.7+</li>
|
|
<li>API key from <a href="https://swarms.world/platform/api-keys">Swarms Platform</a></li>
|
|
<li><code>requests</code> library for Python</li>
|
|
<li><code>axios</code> for TypeScript/JavaScript</li>
|
|
<li><code>curl</code> for shell commands</li>
|
|
</ul>
|
|
</div>
|
|
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">¶</a></h2>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="installation-pip" name="__tabbed_1" type="radio" /><input id="installation-npm" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="installation-pip">pip</label><label for="installation-npm">npm</label></div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block">
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>pip<span class="w"> </span>install<span class="w"> </span>requests<span class="w"> </span>python-dotenv
|
|
</span></code></pre></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-bash highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>npm<span class="w"> </span>install<span class="w"> </span>axios<span class="w"> </span>dotenv
|
|
</span></code></pre></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="authentication">Authentication<a class="headerlink" href="#authentication" title="Permanent link">¶</a></h2>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">API Key Security</p>
|
|
<p>Never hardcode your API key in your code. Always use environment variables or secure configuration management.</p>
|
|
</div>
|
|
<p>The API is accessible through two base URLs:</p>
|
|
<ul>
|
|
<li>Production: <code>https://api.swarms.world</code></li>
|
|
<li>Alternative: <code>https://swarms-api-285321057562.us-east1.run.app</code></li>
|
|
</ul>
|
|
<h2 id="single-agent-usage">Single Agent Usage<a class="headerlink" href="#single-agent-usage" title="Permanent link">¶</a></h2>
|
|
<h3 id="health-check">Health Check<a class="headerlink" href="#health-check" title="Permanent link">¶</a></h3>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="2:3"><input checked="checked" id="health-check-python" name="__tabbed_2" type="radio" /><input id="health-check-curl" name="__tabbed_2" type="radio" /><input id="health-check-typescript" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="health-check-python">Python</label><label for="health-check-curl">cURL</label><label for="health-check-typescript">TypeScript</label></div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block">
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">health_check.py</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-2-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-2-15">15</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1"></a><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
|
|
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2"></a><span class="kn">import</span><span class="w"> </span><span class="nn">requests</span>
|
|
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3"></a><span class="kn">from</span><span class="w"> </span><span class="nn">dotenv</span><span class="w"> </span><span class="kn">import</span> <span class="n">load_dotenv</span>
|
|
</span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4"></a>
|
|
</span><span id="__span-2-5"><a id="__codelineno-2-5" name="__codelineno-2-5"></a><span class="n">load_dotenv</span><span class="p">()</span>
|
|
</span><span id="__span-2-6"><a id="__codelineno-2-6" name="__codelineno-2-6"></a><span class="n">API_KEY</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">"SWARMS_API_KEY"</span><span class="p">)</span>
|
|
</span><span id="__span-2-7"><a id="__codelineno-2-7" name="__codelineno-2-7"></a><span class="n">BASE_URL</span> <span class="o">=</span> <span class="s2">"https://api.swarms.world"</span>
|
|
</span><span id="__span-2-8"><a id="__codelineno-2-8" name="__codelineno-2-8"></a>
|
|
</span><span id="__span-2-9"><a id="__codelineno-2-9" name="__codelineno-2-9"></a><span class="n">headers</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-2-10"><a id="__codelineno-2-10" name="__codelineno-2-10"></a> <span class="s2">"x-api-key"</span><span class="p">:</span> <span class="n">API_KEY</span><span class="p">,</span>
|
|
</span><span id="__span-2-11"><a id="__codelineno-2-11" name="__codelineno-2-11"></a> <span class="s2">"Content-Type"</span><span class="p">:</span> <span class="s2">"application/json"</span>
|
|
</span><span id="__span-2-12"><a id="__codelineno-2-12" name="__codelineno-2-12"></a><span class="p">}</span>
|
|
</span><span id="__span-2-13"><a id="__codelineno-2-13" name="__codelineno-2-13"></a>
|
|
</span><span id="__span-2-14"><a id="__codelineno-2-14" name="__codelineno-2-14"></a><span class="n">response</span> <span class="o">=</span> <span class="n">requests</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">BASE_URL</span><span class="si">}</span><span class="s2">/health"</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">)</span>
|
|
</span><span id="__span-2-15"><a id="__codelineno-2-15" name="__codelineno-2-15"></a><span class="nb">print</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">())</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-bash highlight"><span class="filename">health_check.sh</span><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>curl<span class="w"> </span>-X<span class="w"> </span>GET<span class="w"> </span><span class="s2">"https://api.swarms.world/health"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"x-api-key: </span><span class="nv">$SWARMS_API_KEY</span><span class="s2">"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span>
|
|
</span></code></pre></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-typescript highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">health_check.ts</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-4-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-4-22">22</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1"></a><span class="k">import</span><span class="w"> </span><span class="nx">axios</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">'axios'</span><span class="p">;</span>
|
|
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2"></a><span class="k">import</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="kr">as</span><span class="w"> </span><span class="nx">dotenv</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">'dotenv'</span><span class="p">;</span>
|
|
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3"></a>
|
|
</span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4"></a><span class="nx">dotenv</span><span class="p">.</span><span class="nx">config</span><span class="p">();</span>
|
|
</span><span id="__span-4-5"><a id="__codelineno-4-5" name="__codelineno-4-5"></a><span class="kd">const</span><span class="w"> </span><span class="nx">API_KEY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">SWARMS_API_KEY</span><span class="p">;</span>
|
|
</span><span id="__span-4-6"><a id="__codelineno-4-6" name="__codelineno-4-6"></a><span class="kd">const</span><span class="w"> </span><span class="nx">BASE_URL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'https://api.swarms.world'</span><span class="p">;</span>
|
|
</span><span id="__span-4-7"><a id="__codelineno-4-7" name="__codelineno-4-7"></a>
|
|
</span><span id="__span-4-8"><a id="__codelineno-4-8" name="__codelineno-4-8"></a><span class="k">async</span><span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">checkHealth</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-4-9"><a id="__codelineno-4-9" name="__codelineno-4-9"></a><span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-4-10"><a id="__codelineno-4-10" name="__codelineno-4-10"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">axios</span><span class="p">.</span><span class="nx">get</span><span class="p">(</span><span class="sb">`</span><span class="si">${</span><span class="nx">BASE_URL</span><span class="si">}</span><span class="sb">/health`</span><span class="p">,</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-4-11"><a id="__codelineno-4-11" name="__codelineno-4-11"></a><span class="w"> </span><span class="nx">headers</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-4-12"><a id="__codelineno-4-12" name="__codelineno-4-12"></a><span class="w"> </span><span class="s1">'x-api-key'</span><span class="o">:</span><span class="w"> </span><span class="nx">API_KEY</span><span class="p">,</span>
|
|
</span><span id="__span-4-13"><a id="__codelineno-4-13" name="__codelineno-4-13"></a><span class="w"> </span><span class="s1">'Content-Type'</span><span class="o">:</span><span class="w"> </span><span class="s1">'application/json'</span>
|
|
</span><span id="__span-4-14"><a id="__codelineno-4-14" name="__codelineno-4-14"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-4-15"><a id="__codelineno-4-15" name="__codelineno-4-15"></a><span class="w"> </span><span class="p">});</span>
|
|
</span><span id="__span-4-16"><a id="__codelineno-4-16" name="__codelineno-4-16"></a><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
</span><span id="__span-4-17"><a id="__codelineno-4-17" name="__codelineno-4-17"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="nx">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-4-18"><a id="__codelineno-4-18" name="__codelineno-4-18"></a><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s1">'Error:'</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="p">);</span>
|
|
</span><span id="__span-4-19"><a id="__codelineno-4-19" name="__codelineno-4-19"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-4-20"><a id="__codelineno-4-20" name="__codelineno-4-20"></a><span class="p">}</span>
|
|
</span><span id="__span-4-21"><a id="__codelineno-4-21" name="__codelineno-4-21"></a>
|
|
</span><span id="__span-4-22"><a id="__codelineno-4-22" name="__codelineno-4-22"></a><span class="nx">checkHealth</span><span class="p">();</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="basic-agent">Basic Agent<a class="headerlink" href="#basic-agent" title="Permanent link">¶</a></h3>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="3:3"><input checked="checked" id="basic-agent-python" name="__tabbed_3" type="radio" /><input id="basic-agent-curl" name="__tabbed_3" type="radio" /><input id="basic-agent-typescript" name="__tabbed_3" type="radio" /><div class="tabbed-labels"><label for="basic-agent-python">Python</label><label for="basic-agent-curl">cURL</label><label for="basic-agent-typescript">TypeScript</label></div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block">
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">single_agent.py</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-5-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-5-46">46</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1"></a><span class="kn">import</span><span class="w"> </span><span class="nn">os</span>
|
|
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2"></a><span class="kn">import</span><span class="w"> </span><span class="nn">requests</span>
|
|
</span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3"></a><span class="kn">from</span><span class="w"> </span><span class="nn">dotenv</span><span class="w"> </span><span class="kn">import</span> <span class="n">load_dotenv</span>
|
|
</span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4"></a>
|
|
</span><span id="__span-5-5"><a id="__codelineno-5-5" name="__codelineno-5-5"></a><span class="n">load_dotenv</span><span class="p">()</span>
|
|
</span><span id="__span-5-6"><a id="__codelineno-5-6" name="__codelineno-5-6"></a>
|
|
</span><span id="__span-5-7"><a id="__codelineno-5-7" name="__codelineno-5-7"></a><span class="n">API_KEY</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getenv</span><span class="p">(</span><span class="s2">"SWARMS_API_KEY"</span><span class="p">)</span> <span class="c1"># (1)</span>
|
|
</span><span id="__span-5-8"><a id="__codelineno-5-8" name="__codelineno-5-8"></a><span class="n">BASE_URL</span> <span class="o">=</span> <span class="s2">"https://api.swarms.world"</span>
|
|
</span><span id="__span-5-9"><a id="__codelineno-5-9" name="__codelineno-5-9"></a>
|
|
</span><span id="__span-5-10"><a id="__codelineno-5-10" name="__codelineno-5-10"></a><span class="n">headers</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-5-11"><a id="__codelineno-5-11" name="__codelineno-5-11"></a> <span class="s2">"x-api-key"</span><span class="p">:</span> <span class="n">API_KEY</span><span class="p">,</span>
|
|
</span><span id="__span-5-12"><a id="__codelineno-5-12" name="__codelineno-5-12"></a> <span class="s2">"Content-Type"</span><span class="p">:</span> <span class="s2">"application/json"</span>
|
|
</span><span id="__span-5-13"><a id="__codelineno-5-13" name="__codelineno-5-13"></a><span class="p">}</span>
|
|
</span><span id="__span-5-14"><a id="__codelineno-5-14" name="__codelineno-5-14"></a>
|
|
</span><span id="__span-5-15"><a id="__codelineno-5-15" name="__codelineno-5-15"></a><span class="k">def</span><span class="w"> </span><span class="nf">run_single_agent</span><span class="p">():</span>
|
|
</span><span id="__span-5-16"><a id="__codelineno-5-16" name="__codelineno-5-16"></a><span class="w"> </span><span class="sd">"""Run a single agent with the AgentCompletion format"""</span>
|
|
</span><span id="__span-5-17"><a id="__codelineno-5-17" name="__codelineno-5-17"></a> <span class="n">payload</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-5-18"><a id="__codelineno-5-18" name="__codelineno-5-18"></a> <span class="s2">"agent_config"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span id="__span-5-19"><a id="__codelineno-5-19" name="__codelineno-5-19"></a> <span class="s2">"agent_name"</span><span class="p">:</span> <span class="s2">"Research Analyst"</span><span class="p">,</span> <span class="c1"># (2)</span>
|
|
</span><span id="__span-5-20"><a id="__codelineno-5-20" name="__codelineno-5-20"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"An expert in analyzing and synthesizing research data"</span><span class="p">,</span>
|
|
</span><span id="__span-5-21"><a id="__codelineno-5-21" name="__codelineno-5-21"></a> <span class="s2">"system_prompt"</span><span class="p">:</span> <span class="p">(</span> <span class="c1"># (3)</span>
|
|
</span><span id="__span-5-22"><a id="__codelineno-5-22" name="__codelineno-5-22"></a> <span class="s2">"You are a Research Analyst with expertise in data analysis and synthesis. "</span>
|
|
</span><span id="__span-5-23"><a id="__codelineno-5-23" name="__codelineno-5-23"></a> <span class="s2">"Your role is to analyze provided information, identify key insights, "</span>
|
|
</span><span id="__span-5-24"><a id="__codelineno-5-24" name="__codelineno-5-24"></a> <span class="s2">"and present findings in a clear, structured format."</span>
|
|
</span><span id="__span-5-25"><a id="__codelineno-5-25" name="__codelineno-5-25"></a> <span class="p">),</span>
|
|
</span><span id="__span-5-26"><a id="__codelineno-5-26" name="__codelineno-5-26"></a> <span class="s2">"model_name"</span><span class="p">:</span> <span class="s2">"claude-3-5-sonnet-20240620"</span><span class="p">,</span> <span class="c1"># (4)</span>
|
|
</span><span id="__span-5-27"><a id="__codelineno-5-27" name="__codelineno-5-27"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-5-28"><a id="__codelineno-5-28" name="__codelineno-5-28"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-5-29"><a id="__codelineno-5-29" name="__codelineno-5-29"></a> <span class="s2">"max_tokens"</span><span class="p">:</span> <span class="mi">8192</span><span class="p">,</span>
|
|
</span><span id="__span-5-30"><a id="__codelineno-5-30" name="__codelineno-5-30"></a> <span class="s2">"temperature"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-5-31"><a id="__codelineno-5-31" name="__codelineno-5-31"></a> <span class="s2">"auto_generate_prompt"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
|
|
</span><span id="__span-5-32"><a id="__codelineno-5-32" name="__codelineno-5-32"></a> <span class="s2">"tools_list_dictionary"</span><span class="p">:</span> <span class="kc">None</span><span class="p">,</span>
|
|
</span><span id="__span-5-33"><a id="__codelineno-5-33" name="__codelineno-5-33"></a> <span class="p">},</span>
|
|
</span><span id="__span-5-34"><a id="__codelineno-5-34" name="__codelineno-5-34"></a> <span class="s2">"task"</span><span class="p">:</span> <span class="s2">"What are the key trends in renewable energy adoption?"</span><span class="p">,</span> <span class="c1"># (5)</span>
|
|
</span><span id="__span-5-35"><a id="__codelineno-5-35" name="__codelineno-5-35"></a> <span class="p">}</span>
|
|
</span><span id="__span-5-36"><a id="__codelineno-5-36" name="__codelineno-5-36"></a>
|
|
</span><span id="__span-5-37"><a id="__codelineno-5-37" name="__codelineno-5-37"></a> <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><span id="__span-5-38"><a id="__codelineno-5-38" name="__codelineno-5-38"></a> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">BASE_URL</span><span class="si">}</span><span class="s2">/v1/agent/completions"</span><span class="p">,</span>
|
|
</span><span id="__span-5-39"><a id="__codelineno-5-39" name="__codelineno-5-39"></a> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">,</span>
|
|
</span><span id="__span-5-40"><a id="__codelineno-5-40" name="__codelineno-5-40"></a> <span class="n">json</span><span class="o">=</span><span class="n">payload</span>
|
|
</span><span id="__span-5-41"><a id="__codelineno-5-41" name="__codelineno-5-41"></a> <span class="p">)</span>
|
|
</span><span id="__span-5-42"><a id="__codelineno-5-42" name="__codelineno-5-42"></a> <span class="k">return</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
|
</span><span id="__span-5-43"><a id="__codelineno-5-43" name="__codelineno-5-43"></a>
|
|
</span><span id="__span-5-44"><a id="__codelineno-5-44" name="__codelineno-5-44"></a><span class="c1"># Run the agent</span>
|
|
</span><span id="__span-5-45"><a id="__codelineno-5-45" name="__codelineno-5-45"></a><span class="n">result</span> <span class="o">=</span> <span class="n">run_single_agent</span><span class="p">()</span>
|
|
</span><span id="__span-5-46"><a id="__codelineno-5-46" name="__codelineno-5-46"></a><span class="nb">print</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
<ol>
|
|
<li>Load API key from environment variables</li>
|
|
<li>Give your agent a descriptive name</li>
|
|
<li>Define the agent's capabilities and role</li>
|
|
<li>Choose from available models</li>
|
|
<li>Specify the task for the agent</li>
|
|
</ol>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-bash highlight"><span class="filename">single_agent.sh</span><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s2">"https://api.swarms.world/v1/agent/completions"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"x-api-key: </span><span class="nv">$SWARMS_API_KEY</span><span class="s2">"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="w"> </span>-d<span class="w"> </span><span class="s1">'{</span>
|
|
</span><span id="__span-6-5"><a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="s1"> "agent_config": {</span>
|
|
</span><span id="__span-6-6"><a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="s1"> "agent_name": "Research Analyst",</span>
|
|
</span><span id="__span-6-7"><a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a><span class="s1"> "description": "An expert in analyzing and synthesizing research data",</span>
|
|
</span><span id="__span-6-8"><a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a><span class="s1"> "system_prompt": "You are a Research Analyst with expertise in data analysis and synthesis. Your role is to analyze provided information, identify key insights, and present findings in a clear, structured format.",</span>
|
|
</span><span id="__span-6-9"><a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a><span class="s1"> "model_name": "claude-3-5-sonnet-20240620",</span>
|
|
</span><span id="__span-6-10"><a id="__codelineno-6-10" name="__codelineno-6-10" href="#__codelineno-6-10"></a><span class="s1"> "role": "worker",</span>
|
|
</span><span id="__span-6-11"><a id="__codelineno-6-11" name="__codelineno-6-11" href="#__codelineno-6-11"></a><span class="s1"> "max_loops": 1,</span>
|
|
</span><span id="__span-6-12"><a id="__codelineno-6-12" name="__codelineno-6-12" href="#__codelineno-6-12"></a><span class="s1"> "max_tokens": 8192,</span>
|
|
</span><span id="__span-6-13"><a id="__codelineno-6-13" name="__codelineno-6-13" href="#__codelineno-6-13"></a><span class="s1"> "temperature": 1,</span>
|
|
</span><span id="__span-6-14"><a id="__codelineno-6-14" name="__codelineno-6-14" href="#__codelineno-6-14"></a><span class="s1"> "auto_generate_prompt": false,</span>
|
|
</span><span id="__span-6-15"><a id="__codelineno-6-15" name="__codelineno-6-15" href="#__codelineno-6-15"></a><span class="s1"> "tools_list_dictionary": null</span>
|
|
</span><span id="__span-6-16"><a id="__codelineno-6-16" name="__codelineno-6-16" href="#__codelineno-6-16"></a><span class="s1"> },</span>
|
|
</span><span id="__span-6-17"><a id="__codelineno-6-17" name="__codelineno-6-17" href="#__codelineno-6-17"></a><span class="s1"> "task": "What are the key trends in renewable energy adoption?"</span>
|
|
</span><span id="__span-6-18"><a id="__codelineno-6-18" name="__codelineno-6-18" href="#__codelineno-6-18"></a><span class="s1"> }'</span>
|
|
</span></code></pre></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-typescript highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">single_agent.ts</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-7-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-50">50</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-51">51</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-52">52</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-53">53</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-54">54</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-55">55</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-56">56</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-57">57</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-58">58</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-59">59</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-60">60</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-61">61</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-62">62</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-63">63</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-64">64</a></span>
|
|
<span class="normal"><a href="#__codelineno-7-65">65</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1"></a><span class="k">import</span><span class="w"> </span><span class="nx">axios</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">'axios'</span><span class="p">;</span>
|
|
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2"></a><span class="k">import</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="kr">as</span><span class="w"> </span><span class="nx">dotenv</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">'dotenv'</span><span class="p">;</span>
|
|
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3"></a>
|
|
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4"></a><span class="nx">dotenv</span><span class="p">.</span><span class="nx">config</span><span class="p">();</span>
|
|
</span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5"></a>
|
|
</span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6"></a><span class="kd">const</span><span class="w"> </span><span class="nx">API_KEY</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">process</span><span class="p">.</span><span class="nx">env</span><span class="p">.</span><span class="nx">SWARMS_API_KEY</span><span class="p">;</span>
|
|
</span><span id="__span-7-7"><a id="__codelineno-7-7" name="__codelineno-7-7"></a><span class="kd">const</span><span class="w"> </span><span class="nx">BASE_URL</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'https://api.swarms.world'</span><span class="p">;</span>
|
|
</span><span id="__span-7-8"><a id="__codelineno-7-8" name="__codelineno-7-8"></a>
|
|
</span><span id="__span-7-9"><a id="__codelineno-7-9" name="__codelineno-7-9"></a><span class="kd">interface</span><span class="w"> </span><span class="nx">AgentConfig</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-7-10"><a id="__codelineno-7-10" name="__codelineno-7-10"></a><span class="w"> </span><span class="nx">agent_name</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-7-11"><a id="__codelineno-7-11" name="__codelineno-7-11"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-7-12"><a id="__codelineno-7-12" name="__codelineno-7-12"></a><span class="w"> </span><span class="nx">system_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-7-13"><a id="__codelineno-7-13" name="__codelineno-7-13"></a><span class="w"> </span><span class="nx">model_name</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-7-14"><a id="__codelineno-7-14" name="__codelineno-7-14"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-7-15"><a id="__codelineno-7-15" name="__codelineno-7-15"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">number</span><span class="p">;</span>
|
|
</span><span id="__span-7-16"><a id="__codelineno-7-16" name="__codelineno-7-16"></a><span class="w"> </span><span class="nx">max_tokens</span><span class="o">:</span><span class="w"> </span><span class="kt">number</span><span class="p">;</span>
|
|
</span><span id="__span-7-17"><a id="__codelineno-7-17" name="__codelineno-7-17"></a><span class="w"> </span><span class="nx">temperature</span><span class="o">:</span><span class="w"> </span><span class="kt">number</span><span class="p">;</span>
|
|
</span><span id="__span-7-18"><a id="__codelineno-7-18" name="__codelineno-7-18"></a><span class="w"> </span><span class="nx">auto_generate_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">boolean</span><span class="p">;</span>
|
|
</span><span id="__span-7-19"><a id="__codelineno-7-19" name="__codelineno-7-19"></a><span class="w"> </span><span class="nx">tools_list_dictionary</span><span class="o">:</span><span class="w"> </span><span class="kt">null</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="nx">object</span><span class="p">[];</span>
|
|
</span><span id="__span-7-20"><a id="__codelineno-7-20" name="__codelineno-7-20"></a><span class="p">}</span>
|
|
</span><span id="__span-7-21"><a id="__codelineno-7-21" name="__codelineno-7-21"></a>
|
|
</span><span id="__span-7-22"><a id="__codelineno-7-22" name="__codelineno-7-22"></a><span class="kd">interface</span><span class="w"> </span><span class="nx">AgentPayload</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-7-23"><a id="__codelineno-7-23" name="__codelineno-7-23"></a><span class="w"> </span><span class="nx">agent_config</span><span class="o">:</span><span class="w"> </span><span class="kt">AgentConfig</span><span class="p">;</span>
|
|
</span><span id="__span-7-24"><a id="__codelineno-7-24" name="__codelineno-7-24"></a><span class="w"> </span><span class="nx">task</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-7-25"><a id="__codelineno-7-25" name="__codelineno-7-25"></a><span class="p">}</span>
|
|
</span><span id="__span-7-26"><a id="__codelineno-7-26" name="__codelineno-7-26"></a>
|
|
</span><span id="__span-7-27"><a id="__codelineno-7-27" name="__codelineno-7-27"></a><span class="k">async</span><span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">runSingleAgent</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-7-28"><a id="__codelineno-7-28" name="__codelineno-7-28"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">payload</span><span class="o">:</span><span class="w"> </span><span class="kt">AgentPayload</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-7-29"><a id="__codelineno-7-29" name="__codelineno-7-29"></a><span class="w"> </span><span class="nx">agent_config</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-7-30"><a id="__codelineno-7-30" name="__codelineno-7-30"></a><span class="w"> </span><span class="nx">agent_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Research Analyst"</span><span class="p">,</span>
|
|
</span><span id="__span-7-31"><a id="__codelineno-7-31" name="__codelineno-7-31"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"An expert in analyzing and synthesizing research data"</span><span class="p">,</span>
|
|
</span><span id="__span-7-32"><a id="__codelineno-7-32" name="__codelineno-7-32"></a><span class="w"> </span><span class="nx">system_prompt</span><span class="o">:</span><span class="w"> </span><span class="s2">"You are a Research Analyst with expertise in data analysis and synthesis."</span><span class="p">,</span>
|
|
</span><span id="__span-7-33"><a id="__codelineno-7-33" name="__codelineno-7-33"></a><span class="w"> </span><span class="nx">model_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"claude-3-5-sonnet-20240620"</span><span class="p">,</span>
|
|
</span><span id="__span-7-34"><a id="__codelineno-7-34" name="__codelineno-7-34"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-7-35"><a id="__codelineno-7-35" name="__codelineno-7-35"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-7-36"><a id="__codelineno-7-36" name="__codelineno-7-36"></a><span class="w"> </span><span class="nx">max_tokens</span><span class="o">:</span><span class="w"> </span><span class="kt">8192</span><span class="p">,</span>
|
|
</span><span id="__span-7-37"><a id="__codelineno-7-37" name="__codelineno-7-37"></a><span class="w"> </span><span class="nx">temperature</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-7-38"><a id="__codelineno-7-38" name="__codelineno-7-38"></a><span class="w"> </span><span class="nx">auto_generate_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span><span class="p">,</span>
|
|
</span><span id="__span-7-39"><a id="__codelineno-7-39" name="__codelineno-7-39"></a><span class="w"> </span><span class="nx">tools_list_dictionary</span><span class="o">:</span><span class="w"> </span><span class="kt">null</span>
|
|
</span><span id="__span-7-40"><a id="__codelineno-7-40" name="__codelineno-7-40"></a><span class="w"> </span><span class="p">},</span>
|
|
</span><span id="__span-7-41"><a id="__codelineno-7-41" name="__codelineno-7-41"></a><span class="w"> </span><span class="nx">task</span><span class="o">:</span><span class="w"> </span><span class="s2">"What are the key trends in renewable energy adoption?"</span>
|
|
</span><span id="__span-7-42"><a id="__codelineno-7-42" name="__codelineno-7-42"></a><span class="w"> </span><span class="p">};</span>
|
|
</span><span id="__span-7-43"><a id="__codelineno-7-43" name="__codelineno-7-43"></a>
|
|
</span><span id="__span-7-44"><a id="__codelineno-7-44" name="__codelineno-7-44"></a><span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-7-45"><a id="__codelineno-7-45" name="__codelineno-7-45"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">axios</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span>
|
|
</span><span id="__span-7-46"><a id="__codelineno-7-46" name="__codelineno-7-46"></a><span class="w"> </span><span class="sb">`</span><span class="si">${</span><span class="nx">BASE_URL</span><span class="si">}</span><span class="sb">/v1/agent/completions`</span><span class="p">,</span>
|
|
</span><span id="__span-7-47"><a id="__codelineno-7-47" name="__codelineno-7-47"></a><span class="w"> </span><span class="nx">payload</span><span class="p">,</span>
|
|
</span><span id="__span-7-48"><a id="__codelineno-7-48" name="__codelineno-7-48"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-7-49"><a id="__codelineno-7-49" name="__codelineno-7-49"></a><span class="w"> </span><span class="nx">headers</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-7-50"><a id="__codelineno-7-50" name="__codelineno-7-50"></a><span class="w"> </span><span class="s1">'x-api-key'</span><span class="o">:</span><span class="w"> </span><span class="nx">API_KEY</span><span class="p">,</span>
|
|
</span><span id="__span-7-51"><a id="__codelineno-7-51" name="__codelineno-7-51"></a><span class="w"> </span><span class="s1">'Content-Type'</span><span class="o">:</span><span class="w"> </span><span class="s1">'application/json'</span>
|
|
</span><span id="__span-7-52"><a id="__codelineno-7-52" name="__codelineno-7-52"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-7-53"><a id="__codelineno-7-53" name="__codelineno-7-53"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-7-54"><a id="__codelineno-7-54" name="__codelineno-7-54"></a><span class="w"> </span><span class="p">);</span>
|
|
</span><span id="__span-7-55"><a id="__codelineno-7-55" name="__codelineno-7-55"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">;</span>
|
|
</span><span id="__span-7-56"><a id="__codelineno-7-56" name="__codelineno-7-56"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="nx">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-7-57"><a id="__codelineno-7-57" name="__codelineno-7-57"></a><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s1">'Error:'</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="p">);</span>
|
|
</span><span id="__span-7-58"><a id="__codelineno-7-58" name="__codelineno-7-58"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="nx">error</span><span class="p">;</span>
|
|
</span><span id="__span-7-59"><a id="__codelineno-7-59" name="__codelineno-7-59"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-7-60"><a id="__codelineno-7-60" name="__codelineno-7-60"></a><span class="p">}</span>
|
|
</span><span id="__span-7-61"><a id="__codelineno-7-61" name="__codelineno-7-61"></a>
|
|
</span><span id="__span-7-62"><a id="__codelineno-7-62" name="__codelineno-7-62"></a><span class="c1">// Run the agent</span>
|
|
</span><span id="__span-7-63"><a id="__codelineno-7-63" name="__codelineno-7-63"></a><span class="nx">runSingleAgent</span><span class="p">()</span>
|
|
</span><span id="__span-7-64"><a id="__codelineno-7-64" name="__codelineno-7-64"></a><span class="w"> </span><span class="p">.</span><span class="nx">then</span><span class="p">(</span><span class="nx">result</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">result</span><span class="p">))</span>
|
|
</span><span id="__span-7-65"><a id="__codelineno-7-65" name="__codelineno-7-65"></a><span class="w"> </span><span class="p">.</span><span class="k">catch</span><span class="p">(</span><span class="nx">error</span><span class="w"> </span><span class="p">=></span><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="nx">error</span><span class="p">));</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="agent-with-history">Agent with History<a class="headerlink" href="#agent-with-history" title="Permanent link">¶</a></h3>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="4:3"><input checked="checked" id="agent-with-history-python" name="__tabbed_4" type="radio" /><input id="agent-with-history-curl" name="__tabbed_4" type="radio" /><input id="agent-with-history-typescript" name="__tabbed_4" type="radio" /><div class="tabbed-labels"><label for="agent-with-history-python">Python</label><label for="agent-with-history-curl">cURL</label><label for="agent-with-history-typescript">TypeScript</label></div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block">
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">agent_with_history.py</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-8-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-8-36">36</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">run_agent_with_history</span><span class="p">():</span>
|
|
</span><span id="__span-8-2"><a id="__codelineno-8-2" name="__codelineno-8-2"></a> <span class="n">payload</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-8-3"><a id="__codelineno-8-3" name="__codelineno-8-3"></a> <span class="s2">"agent_config"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span id="__span-8-4"><a id="__codelineno-8-4" name="__codelineno-8-4"></a> <span class="s2">"agent_name"</span><span class="p">:</span> <span class="s2">"Conversation Agent"</span><span class="p">,</span>
|
|
</span><span id="__span-8-5"><a id="__codelineno-8-5" name="__codelineno-8-5"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"An agent that maintains conversation context"</span><span class="p">,</span>
|
|
</span><span id="__span-8-6"><a id="__codelineno-8-6" name="__codelineno-8-6"></a> <span class="s2">"system_prompt"</span><span class="p">:</span> <span class="s2">"You are a helpful assistant that maintains context."</span><span class="p">,</span>
|
|
</span><span id="__span-8-7"><a id="__codelineno-8-7" name="__codelineno-8-7"></a> <span class="s2">"model_name"</span><span class="p">:</span> <span class="s2">"claude-3-5-sonnet-20240620"</span><span class="p">,</span>
|
|
</span><span id="__span-8-8"><a id="__codelineno-8-8" name="__codelineno-8-8"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-8-9"><a id="__codelineno-8-9" name="__codelineno-8-9"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-8-10"><a id="__codelineno-8-10" name="__codelineno-8-10"></a> <span class="s2">"max_tokens"</span><span class="p">:</span> <span class="mi">8192</span><span class="p">,</span>
|
|
</span><span id="__span-8-11"><a id="__codelineno-8-11" name="__codelineno-8-11"></a> <span class="s2">"temperature"</span><span class="p">:</span> <span class="mf">0.7</span><span class="p">,</span>
|
|
</span><span id="__span-8-12"><a id="__codelineno-8-12" name="__codelineno-8-12"></a> <span class="s2">"auto_generate_prompt"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
|
|
</span><span id="__span-8-13"><a id="__codelineno-8-13" name="__codelineno-8-13"></a> <span class="p">},</span>
|
|
</span><span id="__span-8-14"><a id="__codelineno-8-14" name="__codelineno-8-14"></a> <span class="s2">"task"</span><span class="p">:</span> <span class="s2">"What's the weather like?"</span><span class="p">,</span>
|
|
</span><span id="__span-8-15"><a id="__codelineno-8-15" name="__codelineno-8-15"></a> <span class="s2">"history"</span><span class="p">:</span> <span class="p">[</span> <span class="c1"># (1)</span>
|
|
</span><span id="__span-8-16"><a id="__codelineno-8-16" name="__codelineno-8-16"></a> <span class="p">{</span>
|
|
</span><span id="__span-8-17"><a id="__codelineno-8-17" name="__codelineno-8-17"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"user"</span><span class="p">,</span>
|
|
</span><span id="__span-8-18"><a id="__codelineno-8-18" name="__codelineno-8-18"></a> <span class="s2">"content"</span><span class="p">:</span> <span class="s2">"I'm planning a trip to New York."</span>
|
|
</span><span id="__span-8-19"><a id="__codelineno-8-19" name="__codelineno-8-19"></a> <span class="p">},</span>
|
|
</span><span id="__span-8-20"><a id="__codelineno-8-20" name="__codelineno-8-20"></a> <span class="p">{</span>
|
|
</span><span id="__span-8-21"><a id="__codelineno-8-21" name="__codelineno-8-21"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"assistant"</span><span class="p">,</span>
|
|
</span><span id="__span-8-22"><a id="__codelineno-8-22" name="__codelineno-8-22"></a> <span class="s2">"content"</span><span class="p">:</span> <span class="s2">"That's great! When are you planning to visit?"</span>
|
|
</span><span id="__span-8-23"><a id="__codelineno-8-23" name="__codelineno-8-23"></a> <span class="p">},</span>
|
|
</span><span id="__span-8-24"><a id="__codelineno-8-24" name="__codelineno-8-24"></a> <span class="p">{</span>
|
|
</span><span id="__span-8-25"><a id="__codelineno-8-25" name="__codelineno-8-25"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"user"</span><span class="p">,</span>
|
|
</span><span id="__span-8-26"><a id="__codelineno-8-26" name="__codelineno-8-26"></a> <span class="s2">"content"</span><span class="p">:</span> <span class="s2">"Next week."</span>
|
|
</span><span id="__span-8-27"><a id="__codelineno-8-27" name="__codelineno-8-27"></a> <span class="p">}</span>
|
|
</span><span id="__span-8-28"><a id="__codelineno-8-28" name="__codelineno-8-28"></a> <span class="p">]</span>
|
|
</span><span id="__span-8-29"><a id="__codelineno-8-29" name="__codelineno-8-29"></a> <span class="p">}</span>
|
|
</span><span id="__span-8-30"><a id="__codelineno-8-30" name="__codelineno-8-30"></a>
|
|
</span><span id="__span-8-31"><a id="__codelineno-8-31" name="__codelineno-8-31"></a> <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><span id="__span-8-32"><a id="__codelineno-8-32" name="__codelineno-8-32"></a> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">BASE_URL</span><span class="si">}</span><span class="s2">/v1/agent/completions"</span><span class="p">,</span>
|
|
</span><span id="__span-8-33"><a id="__codelineno-8-33" name="__codelineno-8-33"></a> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">,</span>
|
|
</span><span id="__span-8-34"><a id="__codelineno-8-34" name="__codelineno-8-34"></a> <span class="n">json</span><span class="o">=</span><span class="n">payload</span>
|
|
</span><span id="__span-8-35"><a id="__codelineno-8-35" name="__codelineno-8-35"></a> <span class="p">)</span>
|
|
</span><span id="__span-8-36"><a id="__codelineno-8-36" name="__codelineno-8-36"></a> <span class="k">return</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
<ol>
|
|
<li>Include conversation history for context</li>
|
|
</ol>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-bash highlight"><span class="filename">agent_with_history.sh</span><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s2">"https://api.swarms.world/v1/agent/completions"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"x-api-key: </span><span class="nv">$SWARMS_API_KEY</span><span class="s2">"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="w"> </span>-d<span class="w"> </span><span class="s1">'{</span>
|
|
</span><span id="__span-9-5"><a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="s1"> "agent_config": {</span>
|
|
</span><span id="__span-9-6"><a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="s1"> "agent_name": "Conversation Agent",</span>
|
|
</span><span id="__span-9-7"><a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="s1"> "description": "An agent that maintains conversation context",</span>
|
|
</span><span id="__span-9-8"><a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a><span class="s1"> "system_prompt": "You are a helpful assistant that maintains context.",</span>
|
|
</span><span id="__span-9-9"><a id="__codelineno-9-9" name="__codelineno-9-9" href="#__codelineno-9-9"></a><span class="s1"> "model_name": "claude-3-5-sonnet-20240620",</span>
|
|
</span><span id="__span-9-10"><a id="__codelineno-9-10" name="__codelineno-9-10" href="#__codelineno-9-10"></a><span class="s1"> "role": "worker",</span>
|
|
</span><span id="__span-9-11"><a id="__codelineno-9-11" name="__codelineno-9-11" href="#__codelineno-9-11"></a><span class="s1"> "max_loops": 1,</span>
|
|
</span><span id="__span-9-12"><a id="__codelineno-9-12" name="__codelineno-9-12" href="#__codelineno-9-12"></a><span class="s1"> "max_tokens": 8192,</span>
|
|
</span><span id="__span-9-13"><a id="__codelineno-9-13" name="__codelineno-9-13" href="#__codelineno-9-13"></a><span class="s1"> "temperature": 0.7,</span>
|
|
</span><span id="__span-9-14"><a id="__codelineno-9-14" name="__codelineno-9-14" href="#__codelineno-9-14"></a><span class="s1"> "auto_generate_prompt": false</span>
|
|
</span><span id="__span-9-15"><a id="__codelineno-9-15" name="__codelineno-9-15" href="#__codelineno-9-15"></a><span class="s1"> },</span>
|
|
</span><span id="__span-9-16"><a id="__codelineno-9-16" name="__codelineno-9-16" href="#__codelineno-9-16"></a><span class="s1"> "task": "What'</span><span class="se">\'</span><span class="s1">'s the weather like?",</span>
|
|
</span><span id="__span-9-17"><a id="__codelineno-9-17" name="__codelineno-9-17" href="#__codelineno-9-17"></a><span class="s1"> "history": [</span>
|
|
</span><span id="__span-9-18"><a id="__codelineno-9-18" name="__codelineno-9-18" href="#__codelineno-9-18"></a><span class="s1"> {</span>
|
|
</span><span id="__span-9-19"><a id="__codelineno-9-19" name="__codelineno-9-19" href="#__codelineno-9-19"></a><span class="s1"> "role": "user",</span>
|
|
</span><span id="__span-9-20"><a id="__codelineno-9-20" name="__codelineno-9-20" href="#__codelineno-9-20"></a><span class="s1"> "content": "I'</span><span class="se">\'</span><span class="s1">'m planning a trip to New York."</span>
|
|
</span><span id="__span-9-21"><a id="__codelineno-9-21" name="__codelineno-9-21" href="#__codelineno-9-21"></a><span class="s1"> },</span>
|
|
</span><span id="__span-9-22"><a id="__codelineno-9-22" name="__codelineno-9-22" href="#__codelineno-9-22"></a><span class="s1"> {</span>
|
|
</span><span id="__span-9-23"><a id="__codelineno-9-23" name="__codelineno-9-23" href="#__codelineno-9-23"></a><span class="s1"> "role": "assistant",</span>
|
|
</span><span id="__span-9-24"><a id="__codelineno-9-24" name="__codelineno-9-24" href="#__codelineno-9-24"></a><span class="s1"> "content": "That'</span><span class="se">\'</span><span class="s1">'s great! When are you planning to visit?"</span>
|
|
</span><span id="__span-9-25"><a id="__codelineno-9-25" name="__codelineno-9-25" href="#__codelineno-9-25"></a><span class="s1"> },</span>
|
|
</span><span id="__span-9-26"><a id="__codelineno-9-26" name="__codelineno-9-26" href="#__codelineno-9-26"></a><span class="s1"> {</span>
|
|
</span><span id="__span-9-27"><a id="__codelineno-9-27" name="__codelineno-9-27" href="#__codelineno-9-27"></a><span class="s1"> "role": "user",</span>
|
|
</span><span id="__span-9-28"><a id="__codelineno-9-28" name="__codelineno-9-28" href="#__codelineno-9-28"></a><span class="s1"> "content": "Next week."</span>
|
|
</span><span id="__span-9-29"><a id="__codelineno-9-29" name="__codelineno-9-29" href="#__codelineno-9-29"></a><span class="s1"> }</span>
|
|
</span><span id="__span-9-30"><a id="__codelineno-9-30" name="__codelineno-9-30" href="#__codelineno-9-30"></a><span class="s1"> ]</span>
|
|
</span><span id="__span-9-31"><a id="__codelineno-9-31" name="__codelineno-9-31" href="#__codelineno-9-31"></a><span class="s1"> }'</span>
|
|
</span></code></pre></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-typescript highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">agent_with_history.ts</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-10-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-50">50</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-51">51</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-52">52</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-53">53</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-54">54</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-55">55</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-56">56</a></span>
|
|
<span class="normal"><a href="#__codelineno-10-57">57</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1"></a><span class="kd">interface</span><span class="w"> </span><span class="nx">Message</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s1">'user'</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="s1">'assistant'</span><span class="p">;</span>
|
|
</span><span id="__span-10-3"><a id="__codelineno-10-3" name="__codelineno-10-3"></a><span class="w"> </span><span class="nx">content</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-10-4"><a id="__codelineno-10-4" name="__codelineno-10-4"></a><span class="p">}</span>
|
|
</span><span id="__span-10-5"><a id="__codelineno-10-5" name="__codelineno-10-5"></a>
|
|
</span><span id="__span-10-6"><a id="__codelineno-10-6" name="__codelineno-10-6"></a><span class="kd">interface</span><span class="w"> </span><span class="nx">AgentWithHistoryPayload</span><span class="w"> </span><span class="k">extends</span><span class="w"> </span><span class="nx">AgentPayload</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-7"><a id="__codelineno-10-7" name="__codelineno-10-7"></a><span class="w"> </span><span class="nx">history</span><span class="o">:</span><span class="w"> </span><span class="kt">Message</span><span class="p">[];</span>
|
|
</span><span id="__span-10-8"><a id="__codelineno-10-8" name="__codelineno-10-8"></a><span class="p">}</span>
|
|
</span><span id="__span-10-9"><a id="__codelineno-10-9" name="__codelineno-10-9"></a>
|
|
</span><span id="__span-10-10"><a id="__codelineno-10-10" name="__codelineno-10-10"></a><span class="k">async</span><span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">runAgentWithHistory</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-11"><a id="__codelineno-10-11" name="__codelineno-10-11"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">payload</span><span class="o">:</span><span class="w"> </span><span class="kt">AgentWithHistoryPayload</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-12"><a id="__codelineno-10-12" name="__codelineno-10-12"></a><span class="w"> </span><span class="nx">agent_config</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-13"><a id="__codelineno-10-13" name="__codelineno-10-13"></a><span class="w"> </span><span class="nx">agent_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Conversation Agent"</span><span class="p">,</span>
|
|
</span><span id="__span-10-14"><a id="__codelineno-10-14" name="__codelineno-10-14"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"An agent that maintains conversation context"</span><span class="p">,</span>
|
|
</span><span id="__span-10-15"><a id="__codelineno-10-15" name="__codelineno-10-15"></a><span class="w"> </span><span class="nx">system_prompt</span><span class="o">:</span><span class="w"> </span><span class="s2">"You are a helpful assistant that maintains context."</span><span class="p">,</span>
|
|
</span><span id="__span-10-16"><a id="__codelineno-10-16" name="__codelineno-10-16"></a><span class="w"> </span><span class="nx">model_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"claude-3-5-sonnet-20240620"</span><span class="p">,</span>
|
|
</span><span id="__span-10-17"><a id="__codelineno-10-17" name="__codelineno-10-17"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-10-18"><a id="__codelineno-10-18" name="__codelineno-10-18"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-10-19"><a id="__codelineno-10-19" name="__codelineno-10-19"></a><span class="w"> </span><span class="nx">max_tokens</span><span class="o">:</span><span class="w"> </span><span class="kt">8192</span><span class="p">,</span>
|
|
</span><span id="__span-10-20"><a id="__codelineno-10-20" name="__codelineno-10-20"></a><span class="w"> </span><span class="nx">temperature</span><span class="o">:</span><span class="w"> </span><span class="kt">0.7</span><span class="p">,</span>
|
|
</span><span id="__span-10-21"><a id="__codelineno-10-21" name="__codelineno-10-21"></a><span class="w"> </span><span class="nx">auto_generate_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span><span class="p">,</span>
|
|
</span><span id="__span-10-22"><a id="__codelineno-10-22" name="__codelineno-10-22"></a><span class="w"> </span><span class="nx">tools_list_dictionary</span><span class="o">:</span><span class="w"> </span><span class="kt">null</span>
|
|
</span><span id="__span-10-23"><a id="__codelineno-10-23" name="__codelineno-10-23"></a><span class="w"> </span><span class="p">},</span>
|
|
</span><span id="__span-10-24"><a id="__codelineno-10-24" name="__codelineno-10-24"></a><span class="w"> </span><span class="nx">task</span><span class="o">:</span><span class="w"> </span><span class="s2">"What's the weather like?"</span><span class="p">,</span>
|
|
</span><span id="__span-10-25"><a id="__codelineno-10-25" name="__codelineno-10-25"></a><span class="w"> </span><span class="nx">history</span><span class="o">:</span><span class="w"> </span><span class="p">[</span>
|
|
</span><span id="__span-10-26"><a id="__codelineno-10-26" name="__codelineno-10-26"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-27"><a id="__codelineno-10-27" name="__codelineno-10-27"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"user"</span><span class="p">,</span>
|
|
</span><span id="__span-10-28"><a id="__codelineno-10-28" name="__codelineno-10-28"></a><span class="w"> </span><span class="nx">content</span><span class="o">:</span><span class="w"> </span><span class="s2">"I'm planning a trip to New York."</span>
|
|
</span><span id="__span-10-29"><a id="__codelineno-10-29" name="__codelineno-10-29"></a><span class="w"> </span><span class="p">},</span>
|
|
</span><span id="__span-10-30"><a id="__codelineno-10-30" name="__codelineno-10-30"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-31"><a id="__codelineno-10-31" name="__codelineno-10-31"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"assistant"</span><span class="p">,</span>
|
|
</span><span id="__span-10-32"><a id="__codelineno-10-32" name="__codelineno-10-32"></a><span class="w"> </span><span class="nx">content</span><span class="o">:</span><span class="w"> </span><span class="s2">"That's great! When are you planning to visit?"</span>
|
|
</span><span id="__span-10-33"><a id="__codelineno-10-33" name="__codelineno-10-33"></a><span class="w"> </span><span class="p">},</span>
|
|
</span><span id="__span-10-34"><a id="__codelineno-10-34" name="__codelineno-10-34"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-35"><a id="__codelineno-10-35" name="__codelineno-10-35"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"user"</span><span class="p">,</span>
|
|
</span><span id="__span-10-36"><a id="__codelineno-10-36" name="__codelineno-10-36"></a><span class="w"> </span><span class="nx">content</span><span class="o">:</span><span class="w"> </span><span class="s2">"Next week."</span>
|
|
</span><span id="__span-10-37"><a id="__codelineno-10-37" name="__codelineno-10-37"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-10-38"><a id="__codelineno-10-38" name="__codelineno-10-38"></a><span class="w"> </span><span class="p">]</span>
|
|
</span><span id="__span-10-39"><a id="__codelineno-10-39" name="__codelineno-10-39"></a><span class="w"> </span><span class="p">};</span>
|
|
</span><span id="__span-10-40"><a id="__codelineno-10-40" name="__codelineno-10-40"></a>
|
|
</span><span id="__span-10-41"><a id="__codelineno-10-41" name="__codelineno-10-41"></a><span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-42"><a id="__codelineno-10-42" name="__codelineno-10-42"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">axios</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span>
|
|
</span><span id="__span-10-43"><a id="__codelineno-10-43" name="__codelineno-10-43"></a><span class="w"> </span><span class="sb">`</span><span class="si">${</span><span class="nx">BASE_URL</span><span class="si">}</span><span class="sb">/v1/agent/completions`</span><span class="p">,</span>
|
|
</span><span id="__span-10-44"><a id="__codelineno-10-44" name="__codelineno-10-44"></a><span class="w"> </span><span class="nx">payload</span><span class="p">,</span>
|
|
</span><span id="__span-10-45"><a id="__codelineno-10-45" name="__codelineno-10-45"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-46"><a id="__codelineno-10-46" name="__codelineno-10-46"></a><span class="w"> </span><span class="nx">headers</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-47"><a id="__codelineno-10-47" name="__codelineno-10-47"></a><span class="w"> </span><span class="s1">'x-api-key'</span><span class="o">:</span><span class="w"> </span><span class="nx">API_KEY</span><span class="p">,</span>
|
|
</span><span id="__span-10-48"><a id="__codelineno-10-48" name="__codelineno-10-48"></a><span class="w"> </span><span class="s1">'Content-Type'</span><span class="o">:</span><span class="w"> </span><span class="s1">'application/json'</span>
|
|
</span><span id="__span-10-49"><a id="__codelineno-10-49" name="__codelineno-10-49"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-10-50"><a id="__codelineno-10-50" name="__codelineno-10-50"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-10-51"><a id="__codelineno-10-51" name="__codelineno-10-51"></a><span class="w"> </span><span class="p">);</span>
|
|
</span><span id="__span-10-52"><a id="__codelineno-10-52" name="__codelineno-10-52"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">;</span>
|
|
</span><span id="__span-10-53"><a id="__codelineno-10-53" name="__codelineno-10-53"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="nx">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-10-54"><a id="__codelineno-10-54" name="__codelineno-10-54"></a><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s1">'Error:'</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="p">);</span>
|
|
</span><span id="__span-10-55"><a id="__codelineno-10-55" name="__codelineno-10-55"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="nx">error</span><span class="p">;</span>
|
|
</span><span id="__span-10-56"><a id="__codelineno-10-56" name="__codelineno-10-56"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-10-57"><a id="__codelineno-10-57" name="__codelineno-10-57"></a><span class="p">}</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="multi-agent-swarms">Multi-Agent Swarms<a class="headerlink" href="#multi-agent-swarms" title="Permanent link">¶</a></h2>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Swarm Types</p>
|
|
<p>Swarms API supports two types of agent workflows:</p>
|
|
<ol>
|
|
<li><code>SequentialWorkflow</code>: Agents work in sequence, each building on previous output</li>
|
|
<li><code>ConcurrentWorkflow</code>: Agents work in parallel on the same task</li>
|
|
</ol>
|
|
</div>
|
|
<h3 id="sequential-workflow">Sequential Workflow<a class="headerlink" href="#sequential-workflow" title="Permanent link">¶</a></h3>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="5:3"><input checked="checked" id="sequential-workflow-python" name="__tabbed_5" type="radio" /><input id="sequential-workflow-curl" name="__tabbed_5" type="radio" /><input id="sequential-workflow-typescript" name="__tabbed_5" type="radio" /><div class="tabbed-labels"><label for="sequential-workflow-python">Python</label><label for="sequential-workflow-curl">cURL</label><label for="sequential-workflow-typescript">TypeScript</label></div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block">
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">sequential_swarm.py</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-11-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-11-39">39</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">run_sequential_swarm</span><span class="p">():</span>
|
|
</span><span id="__span-11-2"><a id="__codelineno-11-2" name="__codelineno-11-2"></a> <span class="n">payload</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-11-3"><a id="__codelineno-11-3" name="__codelineno-11-3"></a> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Financial Analysis Swarm"</span><span class="p">,</span>
|
|
</span><span id="__span-11-4"><a id="__codelineno-11-4" name="__codelineno-11-4"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Market analysis swarm"</span><span class="p">,</span>
|
|
</span><span id="__span-11-5"><a id="__codelineno-11-5" name="__codelineno-11-5"></a> <span class="s2">"agents"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span><span id="__span-11-6"><a id="__codelineno-11-6" name="__codelineno-11-6"></a> <span class="p">{</span>
|
|
</span><span id="__span-11-7"><a id="__codelineno-11-7" name="__codelineno-11-7"></a> <span class="s2">"agent_name"</span><span class="p">:</span> <span class="s2">"Market Analyst"</span><span class="p">,</span> <span class="c1"># (1)</span>
|
|
</span><span id="__span-11-8"><a id="__codelineno-11-8" name="__codelineno-11-8"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Analyzes market trends"</span><span class="p">,</span>
|
|
</span><span id="__span-11-9"><a id="__codelineno-11-9" name="__codelineno-11-9"></a> <span class="s2">"system_prompt"</span><span class="p">:</span> <span class="s2">"You are a financial analyst expert."</span><span class="p">,</span>
|
|
</span><span id="__span-11-10"><a id="__codelineno-11-10" name="__codelineno-11-10"></a> <span class="s2">"model_name"</span><span class="p">:</span> <span class="s2">"gpt-4o"</span><span class="p">,</span>
|
|
</span><span id="__span-11-11"><a id="__codelineno-11-11" name="__codelineno-11-11"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-11-12"><a id="__codelineno-11-12" name="__codelineno-11-12"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-11-13"><a id="__codelineno-11-13" name="__codelineno-11-13"></a> <span class="s2">"max_tokens"</span><span class="p">:</span> <span class="mi">8192</span><span class="p">,</span>
|
|
</span><span id="__span-11-14"><a id="__codelineno-11-14" name="__codelineno-11-14"></a> <span class="s2">"temperature"</span><span class="p">:</span> <span class="mf">0.5</span><span class="p">,</span>
|
|
</span><span id="__span-11-15"><a id="__codelineno-11-15" name="__codelineno-11-15"></a> <span class="s2">"auto_generate_prompt"</span><span class="p">:</span> <span class="kc">False</span>
|
|
</span><span id="__span-11-16"><a id="__codelineno-11-16" name="__codelineno-11-16"></a> <span class="p">},</span>
|
|
</span><span id="__span-11-17"><a id="__codelineno-11-17" name="__codelineno-11-17"></a> <span class="p">{</span>
|
|
</span><span id="__span-11-18"><a id="__codelineno-11-18" name="__codelineno-11-18"></a> <span class="s2">"agent_name"</span><span class="p">:</span> <span class="s2">"Economic Forecaster"</span><span class="p">,</span> <span class="c1"># (2)</span>
|
|
</span><span id="__span-11-19"><a id="__codelineno-11-19" name="__codelineno-11-19"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Predicts economic trends"</span><span class="p">,</span>
|
|
</span><span id="__span-11-20"><a id="__codelineno-11-20" name="__codelineno-11-20"></a> <span class="s2">"system_prompt"</span><span class="p">:</span> <span class="s2">"You are an expert in economic forecasting."</span><span class="p">,</span>
|
|
</span><span id="__span-11-21"><a id="__codelineno-11-21" name="__codelineno-11-21"></a> <span class="s2">"model_name"</span><span class="p">:</span> <span class="s2">"gpt-4o"</span><span class="p">,</span>
|
|
</span><span id="__span-11-22"><a id="__codelineno-11-22" name="__codelineno-11-22"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-11-23"><a id="__codelineno-11-23" name="__codelineno-11-23"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-11-24"><a id="__codelineno-11-24" name="__codelineno-11-24"></a> <span class="s2">"max_tokens"</span><span class="p">:</span> <span class="mi">8192</span><span class="p">,</span>
|
|
</span><span id="__span-11-25"><a id="__codelineno-11-25" name="__codelineno-11-25"></a> <span class="s2">"temperature"</span><span class="p">:</span> <span class="mf">0.5</span><span class="p">,</span>
|
|
</span><span id="__span-11-26"><a id="__codelineno-11-26" name="__codelineno-11-26"></a> <span class="s2">"auto_generate_prompt"</span><span class="p">:</span> <span class="kc">False</span>
|
|
</span><span id="__span-11-27"><a id="__codelineno-11-27" name="__codelineno-11-27"></a> <span class="p">}</span>
|
|
</span><span id="__span-11-28"><a id="__codelineno-11-28" name="__codelineno-11-28"></a> <span class="p">],</span>
|
|
</span><span id="__span-11-29"><a id="__codelineno-11-29" name="__codelineno-11-29"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-11-30"><a id="__codelineno-11-30" name="__codelineno-11-30"></a> <span class="s2">"swarm_type"</span><span class="p">:</span> <span class="s2">"SequentialWorkflow"</span><span class="p">,</span> <span class="c1"># (3)</span>
|
|
</span><span id="__span-11-31"><a id="__codelineno-11-31" name="__codelineno-11-31"></a> <span class="s2">"task"</span><span class="p">:</span> <span class="s2">"Analyze the current market conditions and provide economic forecasts."</span>
|
|
</span><span id="__span-11-32"><a id="__codelineno-11-32" name="__codelineno-11-32"></a> <span class="p">}</span>
|
|
</span><span id="__span-11-33"><a id="__codelineno-11-33" name="__codelineno-11-33"></a>
|
|
</span><span id="__span-11-34"><a id="__codelineno-11-34" name="__codelineno-11-34"></a> <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><span id="__span-11-35"><a id="__codelineno-11-35" name="__codelineno-11-35"></a> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">BASE_URL</span><span class="si">}</span><span class="s2">/v1/swarm/completions"</span><span class="p">,</span>
|
|
</span><span id="__span-11-36"><a id="__codelineno-11-36" name="__codelineno-11-36"></a> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">,</span>
|
|
</span><span id="__span-11-37"><a id="__codelineno-11-37" name="__codelineno-11-37"></a> <span class="n">json</span><span class="o">=</span><span class="n">payload</span>
|
|
</span><span id="__span-11-38"><a id="__codelineno-11-38" name="__codelineno-11-38"></a> <span class="p">)</span>
|
|
</span><span id="__span-11-39"><a id="__codelineno-11-39" name="__codelineno-11-39"></a> <span class="k">return</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
<ol>
|
|
<li>First agent analyzes market trends</li>
|
|
<li>Second agent builds on first agent's analysis</li>
|
|
<li>Sequential workflow ensures ordered execution</li>
|
|
</ol>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-bash highlight"><span class="filename">sequential_swarm.sh</span><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s2">"https://api.swarms.world/v1/swarm/completions"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-12-2"><a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"x-api-key: </span><span class="nv">$SWARMS_API_KEY</span><span class="s2">"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-12-3"><a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-12-4"><a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a><span class="w"> </span>-d<span class="w"> </span><span class="s1">'{</span>
|
|
</span><span id="__span-12-5"><a id="__codelineno-12-5" name="__codelineno-12-5" href="#__codelineno-12-5"></a><span class="s1"> "name": "Financial Analysis Swarm",</span>
|
|
</span><span id="__span-12-6"><a id="__codelineno-12-6" name="__codelineno-12-6" href="#__codelineno-12-6"></a><span class="s1"> "description": "Market analysis swarm",</span>
|
|
</span><span id="__span-12-7"><a id="__codelineno-12-7" name="__codelineno-12-7" href="#__codelineno-12-7"></a><span class="s1"> "agents": [</span>
|
|
</span><span id="__span-12-8"><a id="__codelineno-12-8" name="__codelineno-12-8" href="#__codelineno-12-8"></a><span class="s1"> {</span>
|
|
</span><span id="__span-12-9"><a id="__codelineno-12-9" name="__codelineno-12-9" href="#__codelineno-12-9"></a><span class="s1"> "agent_name": "Market Analyst",</span>
|
|
</span><span id="__span-12-10"><a id="__codelineno-12-10" name="__codelineno-12-10" href="#__codelineno-12-10"></a><span class="s1"> "description": "Analyzes market trends",</span>
|
|
</span><span id="__span-12-11"><a id="__codelineno-12-11" name="__codelineno-12-11" href="#__codelineno-12-11"></a><span class="s1"> "system_prompt": "You are a financial analyst expert.",</span>
|
|
</span><span id="__span-12-12"><a id="__codelineno-12-12" name="__codelineno-12-12" href="#__codelineno-12-12"></a><span class="s1"> "model_name": "gpt-4o",</span>
|
|
</span><span id="__span-12-13"><a id="__codelineno-12-13" name="__codelineno-12-13" href="#__codelineno-12-13"></a><span class="s1"> "role": "worker",</span>
|
|
</span><span id="__span-12-14"><a id="__codelineno-12-14" name="__codelineno-12-14" href="#__codelineno-12-14"></a><span class="s1"> "max_loops": 1,</span>
|
|
</span><span id="__span-12-15"><a id="__codelineno-12-15" name="__codelineno-12-15" href="#__codelineno-12-15"></a><span class="s1"> "max_tokens": 8192,</span>
|
|
</span><span id="__span-12-16"><a id="__codelineno-12-16" name="__codelineno-12-16" href="#__codelineno-12-16"></a><span class="s1"> "temperature": 0.5,</span>
|
|
</span><span id="__span-12-17"><a id="__codelineno-12-17" name="__codelineno-12-17" href="#__codelineno-12-17"></a><span class="s1"> "auto_generate_prompt": false</span>
|
|
</span><span id="__span-12-18"><a id="__codelineno-12-18" name="__codelineno-12-18" href="#__codelineno-12-18"></a><span class="s1"> },</span>
|
|
</span><span id="__span-12-19"><a id="__codelineno-12-19" name="__codelineno-12-19" href="#__codelineno-12-19"></a><span class="s1"> {</span>
|
|
</span><span id="__span-12-20"><a id="__codelineno-12-20" name="__codelineno-12-20" href="#__codelineno-12-20"></a><span class="s1"> "agent_name": "Economic Forecaster",</span>
|
|
</span><span id="__span-12-21"><a id="__codelineno-12-21" name="__codelineno-12-21" href="#__codelineno-12-21"></a><span class="s1"> "description": "Predicts economic trends",</span>
|
|
</span><span id="__span-12-22"><a id="__codelineno-12-22" name="__codelineno-12-22" href="#__codelineno-12-22"></a><span class="s1"> "system_prompt": "You are an expert in economic forecasting.",</span>
|
|
</span><span id="__span-12-23"><a id="__codelineno-12-23" name="__codelineno-12-23" href="#__codelineno-12-23"></a><span class="s1"> "model_name": "gpt-4o",</span>
|
|
</span><span id="__span-12-24"><a id="__codelineno-12-24" name="__codelineno-12-24" href="#__codelineno-12-24"></a><span class="s1"> "role": "worker",</span>
|
|
</span><span id="__span-12-25"><a id="__codelineno-12-25" name="__codelineno-12-25" href="#__codelineno-12-25"></a><span class="s1"> "max_loops": 1,</span>
|
|
</span><span id="__span-12-26"><a id="__codelineno-12-26" name="__codelineno-12-26" href="#__codelineno-12-26"></a><span class="s1"> "max_tokens": 8192,</span>
|
|
</span><span id="__span-12-27"><a id="__codelineno-12-27" name="__codelineno-12-27" href="#__codelineno-12-27"></a><span class="s1"> "temperature": 0.5,</span>
|
|
</span><span id="__span-12-28"><a id="__codelineno-12-28" name="__codelineno-12-28" href="#__codelineno-12-28"></a><span class="s1"> "auto_generate_prompt": false</span>
|
|
</span><span id="__span-12-29"><a id="__codelineno-12-29" name="__codelineno-12-29" href="#__codelineno-12-29"></a><span class="s1"> }</span>
|
|
</span><span id="__span-12-30"><a id="__codelineno-12-30" name="__codelineno-12-30" href="#__codelineno-12-30"></a><span class="s1"> ],</span>
|
|
</span><span id="__span-12-31"><a id="__codelineno-12-31" name="__codelineno-12-31" href="#__codelineno-12-31"></a><span class="s1"> "max_loops": 1,</span>
|
|
</span><span id="__span-12-32"><a id="__codelineno-12-32" name="__codelineno-12-32" href="#__codelineno-12-32"></a><span class="s1"> "swarm_type": "SequentialWorkflow",</span>
|
|
</span><span id="__span-12-33"><a id="__codelineno-12-33" name="__codelineno-12-33" href="#__codelineno-12-33"></a><span class="s1"> "task": "Analyze the current market conditions and provide economic forecasts."</span>
|
|
</span><span id="__span-12-34"><a id="__codelineno-12-34" name="__codelineno-12-34" href="#__codelineno-12-34"></a><span class="s1"> }'</span>
|
|
</span></code></pre></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-typescript highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">sequential_swarm.ts</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-13-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-50">50</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-51">51</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-52">52</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-53">53</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-54">54</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-55">55</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-56">56</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-57">57</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-58">58</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-59">59</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-60">60</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-61">61</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-62">62</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-63">63</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-64">64</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-65">65</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-66">66</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-67">67</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-68">68</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-69">69</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-70">70</a></span>
|
|
<span class="normal"><a href="#__codelineno-13-71">71</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1"></a><span class="kd">interface</span><span class="w"> </span><span class="nx">SwarmAgent</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2"></a><span class="w"> </span><span class="nx">agent_name</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-13-3"><a id="__codelineno-13-3" name="__codelineno-13-3"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-13-4"><a id="__codelineno-13-4" name="__codelineno-13-4"></a><span class="w"> </span><span class="nx">system_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-13-5"><a id="__codelineno-13-5" name="__codelineno-13-5"></a><span class="w"> </span><span class="nx">model_name</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-13-6"><a id="__codelineno-13-6" name="__codelineno-13-6"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-13-7"><a id="__codelineno-13-7" name="__codelineno-13-7"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">number</span><span class="p">;</span>
|
|
</span><span id="__span-13-8"><a id="__codelineno-13-8" name="__codelineno-13-8"></a><span class="w"> </span><span class="nx">max_tokens</span><span class="o">:</span><span class="w"> </span><span class="kt">number</span><span class="p">;</span>
|
|
</span><span id="__span-13-9"><a id="__codelineno-13-9" name="__codelineno-13-9"></a><span class="w"> </span><span class="nx">temperature</span><span class="o">:</span><span class="w"> </span><span class="kt">number</span><span class="p">;</span>
|
|
</span><span id="__span-13-10"><a id="__codelineno-13-10" name="__codelineno-13-10"></a><span class="w"> </span><span class="nx">auto_generate_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">boolean</span><span class="p">;</span>
|
|
</span><span id="__span-13-11"><a id="__codelineno-13-11" name="__codelineno-13-11"></a><span class="p">}</span>
|
|
</span><span id="__span-13-12"><a id="__codelineno-13-12" name="__codelineno-13-12"></a>
|
|
</span><span id="__span-13-13"><a id="__codelineno-13-13" name="__codelineno-13-13"></a><span class="kd">interface</span><span class="w"> </span><span class="nx">SwarmPayload</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-13-14"><a id="__codelineno-13-14" name="__codelineno-13-14"></a><span class="w"> </span><span class="nx">name</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-13-15"><a id="__codelineno-13-15" name="__codelineno-13-15"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-13-16"><a id="__codelineno-13-16" name="__codelineno-13-16"></a><span class="w"> </span><span class="nx">agents</span><span class="o">:</span><span class="w"> </span><span class="kt">SwarmAgent</span><span class="p">[];</span>
|
|
</span><span id="__span-13-17"><a id="__codelineno-13-17" name="__codelineno-13-17"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">number</span><span class="p">;</span>
|
|
</span><span id="__span-13-18"><a id="__codelineno-13-18" name="__codelineno-13-18"></a><span class="w"> </span><span class="nx">swarm_type</span><span class="o">:</span><span class="w"> </span><span class="s1">'SequentialWorkflow'</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="s1">'ConcurrentWorkflow'</span><span class="p">;</span>
|
|
</span><span id="__span-13-19"><a id="__codelineno-13-19" name="__codelineno-13-19"></a><span class="w"> </span><span class="nx">task</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-13-20"><a id="__codelineno-13-20" name="__codelineno-13-20"></a><span class="p">}</span>
|
|
</span><span id="__span-13-21"><a id="__codelineno-13-21" name="__codelineno-13-21"></a>
|
|
</span><span id="__span-13-22"><a id="__codelineno-13-22" name="__codelineno-13-22"></a><span class="k">async</span><span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">runSequentialSwarm</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-13-23"><a id="__codelineno-13-23" name="__codelineno-13-23"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">payload</span><span class="o">:</span><span class="w"> </span><span class="kt">SwarmPayload</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-13-24"><a id="__codelineno-13-24" name="__codelineno-13-24"></a><span class="w"> </span><span class="nx">name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Financial Analysis Swarm"</span><span class="p">,</span>
|
|
</span><span id="__span-13-25"><a id="__codelineno-13-25" name="__codelineno-13-25"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Market analysis swarm"</span><span class="p">,</span>
|
|
</span><span id="__span-13-26"><a id="__codelineno-13-26" name="__codelineno-13-26"></a><span class="w"> </span><span class="nx">agents</span><span class="o">:</span><span class="w"> </span><span class="p">[</span>
|
|
</span><span id="__span-13-27"><a id="__codelineno-13-27" name="__codelineno-13-27"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-13-28"><a id="__codelineno-13-28" name="__codelineno-13-28"></a><span class="w"> </span><span class="nx">agent_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Market Analyst"</span><span class="p">,</span>
|
|
</span><span id="__span-13-29"><a id="__codelineno-13-29" name="__codelineno-13-29"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Analyzes market trends"</span><span class="p">,</span>
|
|
</span><span id="__span-13-30"><a id="__codelineno-13-30" name="__codelineno-13-30"></a><span class="w"> </span><span class="nx">system_prompt</span><span class="o">:</span><span class="w"> </span><span class="s2">"You are a financial analyst expert."</span><span class="p">,</span>
|
|
</span><span id="__span-13-31"><a id="__codelineno-13-31" name="__codelineno-13-31"></a><span class="w"> </span><span class="nx">model_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"gpt-4o"</span><span class="p">,</span>
|
|
</span><span id="__span-13-32"><a id="__codelineno-13-32" name="__codelineno-13-32"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-13-33"><a id="__codelineno-13-33" name="__codelineno-13-33"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-13-34"><a id="__codelineno-13-34" name="__codelineno-13-34"></a><span class="w"> </span><span class="nx">max_tokens</span><span class="o">:</span><span class="w"> </span><span class="kt">8192</span><span class="p">,</span>
|
|
</span><span id="__span-13-35"><a id="__codelineno-13-35" name="__codelineno-13-35"></a><span class="w"> </span><span class="nx">temperature</span><span class="o">:</span><span class="w"> </span><span class="kt">0.5</span><span class="p">,</span>
|
|
</span><span id="__span-13-36"><a id="__codelineno-13-36" name="__codelineno-13-36"></a><span class="w"> </span><span class="nx">auto_generate_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span>
|
|
</span><span id="__span-13-37"><a id="__codelineno-13-37" name="__codelineno-13-37"></a><span class="w"> </span><span class="p">},</span>
|
|
</span><span id="__span-13-38"><a id="__codelineno-13-38" name="__codelineno-13-38"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-13-39"><a id="__codelineno-13-39" name="__codelineno-13-39"></a><span class="w"> </span><span class="nx">agent_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Economic Forecaster"</span><span class="p">,</span>
|
|
</span><span id="__span-13-40"><a id="__codelineno-13-40" name="__codelineno-13-40"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Predicts economic trends"</span><span class="p">,</span>
|
|
</span><span id="__span-13-41"><a id="__codelineno-13-41" name="__codelineno-13-41"></a><span class="w"> </span><span class="nx">system_prompt</span><span class="o">:</span><span class="w"> </span><span class="s2">"You are an expert in economic forecasting."</span><span class="p">,</span>
|
|
</span><span id="__span-13-42"><a id="__codelineno-13-42" name="__codelineno-13-42"></a><span class="w"> </span><span class="nx">model_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"gpt-4o"</span><span class="p">,</span>
|
|
</span><span id="__span-13-43"><a id="__codelineno-13-43" name="__codelineno-13-43"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-13-44"><a id="__codelineno-13-44" name="__codelineno-13-44"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-13-45"><a id="__codelineno-13-45" name="__codelineno-13-45"></a><span class="w"> </span><span class="nx">max_tokens</span><span class="o">:</span><span class="w"> </span><span class="kt">8192</span><span class="p">,</span>
|
|
</span><span id="__span-13-46"><a id="__codelineno-13-46" name="__codelineno-13-46"></a><span class="w"> </span><span class="nx">temperature</span><span class="o">:</span><span class="w"> </span><span class="kt">0.5</span><span class="p">,</span>
|
|
</span><span id="__span-13-47"><a id="__codelineno-13-47" name="__codelineno-13-47"></a><span class="w"> </span><span class="nx">auto_generate_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span>
|
|
</span><span id="__span-13-48"><a id="__codelineno-13-48" name="__codelineno-13-48"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-13-49"><a id="__codelineno-13-49" name="__codelineno-13-49"></a><span class="w"> </span><span class="p">],</span>
|
|
</span><span id="__span-13-50"><a id="__codelineno-13-50" name="__codelineno-13-50"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-13-51"><a id="__codelineno-13-51" name="__codelineno-13-51"></a><span class="w"> </span><span class="nx">swarm_type</span><span class="o">:</span><span class="w"> </span><span class="s2">"SequentialWorkflow"</span><span class="p">,</span>
|
|
</span><span id="__span-13-52"><a id="__codelineno-13-52" name="__codelineno-13-52"></a><span class="w"> </span><span class="nx">task</span><span class="o">:</span><span class="w"> </span><span class="s2">"Analyze the current market conditions and provide economic forecasts."</span>
|
|
</span><span id="__span-13-53"><a id="__codelineno-13-53" name="__codelineno-13-53"></a><span class="w"> </span><span class="p">};</span>
|
|
</span><span id="__span-13-54"><a id="__codelineno-13-54" name="__codelineno-13-54"></a>
|
|
</span><span id="__span-13-55"><a id="__codelineno-13-55" name="__codelineno-13-55"></a><span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-13-56"><a id="__codelineno-13-56" name="__codelineno-13-56"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">axios</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span>
|
|
</span><span id="__span-13-57"><a id="__codelineno-13-57" name="__codelineno-13-57"></a><span class="w"> </span><span class="sb">`</span><span class="si">${</span><span class="nx">BASE_URL</span><span class="si">}</span><span class="sb">/v1/swarm/completions`</span><span class="p">,</span>
|
|
</span><span id="__span-13-58"><a id="__codelineno-13-58" name="__codelineno-13-58"></a><span class="w"> </span><span class="nx">payload</span><span class="p">,</span>
|
|
</span><span id="__span-13-59"><a id="__codelineno-13-59" name="__codelineno-13-59"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-13-60"><a id="__codelineno-13-60" name="__codelineno-13-60"></a><span class="w"> </span><span class="nx">headers</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-13-61"><a id="__codelineno-13-61" name="__codelineno-13-61"></a><span class="w"> </span><span class="s1">'x-api-key'</span><span class="o">:</span><span class="w"> </span><span class="nx">API_KEY</span><span class="p">,</span>
|
|
</span><span id="__span-13-62"><a id="__codelineno-13-62" name="__codelineno-13-62"></a><span class="w"> </span><span class="s1">'Content-Type'</span><span class="o">:</span><span class="w"> </span><span class="s1">'application/json'</span>
|
|
</span><span id="__span-13-63"><a id="__codelineno-13-63" name="__codelineno-13-63"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-13-64"><a id="__codelineno-13-64" name="__codelineno-13-64"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-13-65"><a id="__codelineno-13-65" name="__codelineno-13-65"></a><span class="w"> </span><span class="p">);</span>
|
|
</span><span id="__span-13-66"><a id="__codelineno-13-66" name="__codelineno-13-66"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">;</span>
|
|
</span><span id="__span-13-67"><a id="__codelineno-13-67" name="__codelineno-13-67"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="nx">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-13-68"><a id="__codelineno-13-68" name="__codelineno-13-68"></a><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s1">'Error:'</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="p">);</span>
|
|
</span><span id="__span-13-69"><a id="__codelineno-13-69" name="__codelineno-13-69"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="nx">error</span><span class="p">;</span>
|
|
</span><span id="__span-13-70"><a id="__codelineno-13-70" name="__codelineno-13-70"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-13-71"><a id="__codelineno-13-71" name="__codelineno-13-71"></a><span class="p">}</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="concurrent-workflow">Concurrent Workflow<a class="headerlink" href="#concurrent-workflow" title="Permanent link">¶</a></h3>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="6:3"><input checked="checked" id="concurrent-workflow-python" name="__tabbed_6" type="radio" /><input id="concurrent-workflow-curl" name="__tabbed_6" type="radio" /><input id="concurrent-workflow-typescript" name="__tabbed_6" type="radio" /><div class="tabbed-labels"><label for="concurrent-workflow-python">Python</label><label for="concurrent-workflow-curl">cURL</label><label for="concurrent-workflow-typescript">TypeScript</label></div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block">
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">concurrent_swarm.py</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-14-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-14-39">39</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">run_concurrent_swarm</span><span class="p">():</span>
|
|
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2"></a> <span class="n">payload</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-14-3"><a id="__codelineno-14-3" name="__codelineno-14-3"></a> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Medical Analysis Swarm"</span><span class="p">,</span>
|
|
</span><span id="__span-14-4"><a id="__codelineno-14-4" name="__codelineno-14-4"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Analyzes medical data concurrently"</span><span class="p">,</span>
|
|
</span><span id="__span-14-5"><a id="__codelineno-14-5" name="__codelineno-14-5"></a> <span class="s2">"agents"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span><span id="__span-14-6"><a id="__codelineno-14-6" name="__codelineno-14-6"></a> <span class="p">{</span>
|
|
</span><span id="__span-14-7"><a id="__codelineno-14-7" name="__codelineno-14-7"></a> <span class="s2">"agent_name"</span><span class="p">:</span> <span class="s2">"Lab Data Analyzer"</span><span class="p">,</span> <span class="c1"># (1)</span>
|
|
</span><span id="__span-14-8"><a id="__codelineno-14-8" name="__codelineno-14-8"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Analyzes lab report data"</span><span class="p">,</span>
|
|
</span><span id="__span-14-9"><a id="__codelineno-14-9" name="__codelineno-14-9"></a> <span class="s2">"system_prompt"</span><span class="p">:</span> <span class="s2">"You are a medical data analyst specializing in lab results."</span><span class="p">,</span>
|
|
</span><span id="__span-14-10"><a id="__codelineno-14-10" name="__codelineno-14-10"></a> <span class="s2">"model_name"</span><span class="p">:</span> <span class="s2">"claude-3-5-sonnet-20240620"</span><span class="p">,</span>
|
|
</span><span id="__span-14-11"><a id="__codelineno-14-11" name="__codelineno-14-11"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-14-12"><a id="__codelineno-14-12" name="__codelineno-14-12"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-14-13"><a id="__codelineno-14-13" name="__codelineno-14-13"></a> <span class="s2">"max_tokens"</span><span class="p">:</span> <span class="mi">8192</span><span class="p">,</span>
|
|
</span><span id="__span-14-14"><a id="__codelineno-14-14" name="__codelineno-14-14"></a> <span class="s2">"temperature"</span><span class="p">:</span> <span class="mf">0.5</span><span class="p">,</span>
|
|
</span><span id="__span-14-15"><a id="__codelineno-14-15" name="__codelineno-14-15"></a> <span class="s2">"auto_generate_prompt"</span><span class="p">:</span> <span class="kc">False</span>
|
|
</span><span id="__span-14-16"><a id="__codelineno-14-16" name="__codelineno-14-16"></a> <span class="p">},</span>
|
|
</span><span id="__span-14-17"><a id="__codelineno-14-17" name="__codelineno-14-17"></a> <span class="p">{</span>
|
|
</span><span id="__span-14-18"><a id="__codelineno-14-18" name="__codelineno-14-18"></a> <span class="s2">"agent_name"</span><span class="p">:</span> <span class="s2">"Clinical Specialist"</span><span class="p">,</span> <span class="c1"># (2)</span>
|
|
</span><span id="__span-14-19"><a id="__codelineno-14-19" name="__codelineno-14-19"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Provides clinical interpretations"</span><span class="p">,</span>
|
|
</span><span id="__span-14-20"><a id="__codelineno-14-20" name="__codelineno-14-20"></a> <span class="s2">"system_prompt"</span><span class="p">:</span> <span class="s2">"You are an expert in clinical diagnosis."</span><span class="p">,</span>
|
|
</span><span id="__span-14-21"><a id="__codelineno-14-21" name="__codelineno-14-21"></a> <span class="s2">"model_name"</span><span class="p">:</span> <span class="s2">"claude-3-5-sonnet-20240620"</span><span class="p">,</span>
|
|
</span><span id="__span-14-22"><a id="__codelineno-14-22" name="__codelineno-14-22"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-14-23"><a id="__codelineno-14-23" name="__codelineno-14-23"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-14-24"><a id="__codelineno-14-24" name="__codelineno-14-24"></a> <span class="s2">"max_tokens"</span><span class="p">:</span> <span class="mi">8192</span><span class="p">,</span>
|
|
</span><span id="__span-14-25"><a id="__codelineno-14-25" name="__codelineno-14-25"></a> <span class="s2">"temperature"</span><span class="p">:</span> <span class="mf">0.5</span><span class="p">,</span>
|
|
</span><span id="__span-14-26"><a id="__codelineno-14-26" name="__codelineno-14-26"></a> <span class="s2">"auto_generate_prompt"</span><span class="p">:</span> <span class="kc">False</span>
|
|
</span><span id="__span-14-27"><a id="__codelineno-14-27" name="__codelineno-14-27"></a> <span class="p">}</span>
|
|
</span><span id="__span-14-28"><a id="__codelineno-14-28" name="__codelineno-14-28"></a> <span class="p">],</span>
|
|
</span><span id="__span-14-29"><a id="__codelineno-14-29" name="__codelineno-14-29"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-14-30"><a id="__codelineno-14-30" name="__codelineno-14-30"></a> <span class="s2">"swarm_type"</span><span class="p">:</span> <span class="s2">"ConcurrentWorkflow"</span><span class="p">,</span> <span class="c1"># (3)</span>
|
|
</span><span id="__span-14-31"><a id="__codelineno-14-31" name="__codelineno-14-31"></a> <span class="s2">"task"</span><span class="p">:</span> <span class="s2">"Analyze these lab results and provide clinical interpretations."</span>
|
|
</span><span id="__span-14-32"><a id="__codelineno-14-32" name="__codelineno-14-32"></a> <span class="p">}</span>
|
|
</span><span id="__span-14-33"><a id="__codelineno-14-33" name="__codelineno-14-33"></a>
|
|
</span><span id="__span-14-34"><a id="__codelineno-14-34" name="__codelineno-14-34"></a> <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><span id="__span-14-35"><a id="__codelineno-14-35" name="__codelineno-14-35"></a> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">BASE_URL</span><span class="si">}</span><span class="s2">/v1/swarm/completions"</span><span class="p">,</span>
|
|
</span><span id="__span-14-36"><a id="__codelineno-14-36" name="__codelineno-14-36"></a> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">,</span>
|
|
</span><span id="__span-14-37"><a id="__codelineno-14-37" name="__codelineno-14-37"></a> <span class="n">json</span><span class="o">=</span><span class="n">payload</span>
|
|
</span><span id="__span-14-38"><a id="__codelineno-14-38" name="__codelineno-14-38"></a> <span class="p">)</span>
|
|
</span><span id="__span-14-39"><a id="__codelineno-14-39" name="__codelineno-14-39"></a> <span class="k">return</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
<ol>
|
|
<li>First agent processes lab data</li>
|
|
<li>Second agent works simultaneously</li>
|
|
<li>Concurrent workflow for parallel processing</li>
|
|
</ol>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-bash highlight"><span class="filename">concurrent_swarm.sh</span><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s2">"https://api.swarms.world/v1/swarm/completions"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"x-api-key: </span><span class="nv">$SWARMS_API_KEY</span><span class="s2">"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="w"> </span>-d<span class="w"> </span><span class="s1">'{</span>
|
|
</span><span id="__span-15-5"><a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a><span class="s1"> "name": "Medical Analysis Swarm",</span>
|
|
</span><span id="__span-15-6"><a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a><span class="s1"> "description": "Analyzes medical data concurrently",</span>
|
|
</span><span id="__span-15-7"><a id="__codelineno-15-7" name="__codelineno-15-7" href="#__codelineno-15-7"></a><span class="s1"> "agents": [</span>
|
|
</span><span id="__span-15-8"><a id="__codelineno-15-8" name="__codelineno-15-8" href="#__codelineno-15-8"></a><span class="s1"> {</span>
|
|
</span><span id="__span-15-9"><a id="__codelineno-15-9" name="__codelineno-15-9" href="#__codelineno-15-9"></a><span class="s1"> "agent_name": "Lab Data Analyzer",</span>
|
|
</span><span id="__span-15-10"><a id="__codelineno-15-10" name="__codelineno-15-10" href="#__codelineno-15-10"></a><span class="s1"> "description": "Analyzes lab report data",</span>
|
|
</span><span id="__span-15-11"><a id="__codelineno-15-11" name="__codelineno-15-11" href="#__codelineno-15-11"></a><span class="s1"> "system_prompt": "You are a medical data analyst specializing in lab results.",</span>
|
|
</span><span id="__span-15-12"><a id="__codelineno-15-12" name="__codelineno-15-12" href="#__codelineno-15-12"></a><span class="s1"> "model_name": "claude-3-5-sonnet-20240620",</span>
|
|
</span><span id="__span-15-13"><a id="__codelineno-15-13" name="__codelineno-15-13" href="#__codelineno-15-13"></a><span class="s1"> "role": "worker",</span>
|
|
</span><span id="__span-15-14"><a id="__codelineno-15-14" name="__codelineno-15-14" href="#__codelineno-15-14"></a><span class="s1"> "max_loops": 1,</span>
|
|
</span><span id="__span-15-15"><a id="__codelineno-15-15" name="__codelineno-15-15" href="#__codelineno-15-15"></a><span class="s1"> "max_tokens": 8192,</span>
|
|
</span><span id="__span-15-16"><a id="__codelineno-15-16" name="__codelineno-15-16" href="#__codelineno-15-16"></a><span class="s1"> "temperature": 0.5,</span>
|
|
</span><span id="__span-15-17"><a id="__codelineno-15-17" name="__codelineno-15-17" href="#__codelineno-15-17"></a><span class="s1"> "auto_generate_prompt": false</span>
|
|
</span><span id="__span-15-18"><a id="__codelineno-15-18" name="__codelineno-15-18" href="#__codelineno-15-18"></a><span class="s1"> },</span>
|
|
</span><span id="__span-15-19"><a id="__codelineno-15-19" name="__codelineno-15-19" href="#__codelineno-15-19"></a><span class="s1"> {</span>
|
|
</span><span id="__span-15-20"><a id="__codelineno-15-20" name="__codelineno-15-20" href="#__codelineno-15-20"></a><span class="s1"> "agent_name": "Clinical Specialist",</span>
|
|
</span><span id="__span-15-21"><a id="__codelineno-15-21" name="__codelineno-15-21" href="#__codelineno-15-21"></a><span class="s1"> "description": "Provides clinical interpretations",</span>
|
|
</span><span id="__span-15-22"><a id="__codelineno-15-22" name="__codelineno-15-22" href="#__codelineno-15-22"></a><span class="s1"> "system_prompt": "You are an expert in clinical diagnosis.",</span>
|
|
</span><span id="__span-15-23"><a id="__codelineno-15-23" name="__codelineno-15-23" href="#__codelineno-15-23"></a><span class="s1"> "model_name": "claude-3-5-sonnet-20240620",</span>
|
|
</span><span id="__span-15-24"><a id="__codelineno-15-24" name="__codelineno-15-24" href="#__codelineno-15-24"></a><span class="s1"> "role": "worker",</span>
|
|
</span><span id="__span-15-25"><a id="__codelineno-15-25" name="__codelineno-15-25" href="#__codelineno-15-25"></a><span class="s1"> "max_loops": 1,</span>
|
|
</span><span id="__span-15-26"><a id="__codelineno-15-26" name="__codelineno-15-26" href="#__codelineno-15-26"></a><span class="s1"> "max_tokens": 8192,</span>
|
|
</span><span id="__span-15-27"><a id="__codelineno-15-27" name="__codelineno-15-27" href="#__codelineno-15-27"></a><span class="s1"> "temperature": 0.5,</span>
|
|
</span><span id="__span-15-28"><a id="__codelineno-15-28" name="__codelineno-15-28" href="#__codelineno-15-28"></a><span class="s1"> "auto_generate_prompt": false</span>
|
|
</span><span id="__span-15-29"><a id="__codelineno-15-29" name="__codelineno-15-29" href="#__codelineno-15-29"></a><span class="s1"> }</span>
|
|
</span><span id="__span-15-30"><a id="__codelineno-15-30" name="__codelineno-15-30" href="#__codelineno-15-30"></a><span class="s1"> ],</span>
|
|
</span><span id="__span-15-31"><a id="__codelineno-15-31" name="__codelineno-15-31" href="#__codelineno-15-31"></a><span class="s1"> "max_loops": 1,</span>
|
|
</span><span id="__span-15-32"><a id="__codelineno-15-32" name="__codelineno-15-32" href="#__codelineno-15-32"></a><span class="s1"> "swarm_type": "ConcurrentWorkflow",</span>
|
|
</span><span id="__span-15-33"><a id="__codelineno-15-33" name="__codelineno-15-33" href="#__codelineno-15-33"></a><span class="s1"> "task": "Analyze these lab results and provide clinical interpretations."</span>
|
|
</span><span id="__span-15-34"><a id="__codelineno-15-34" name="__codelineno-15-34" href="#__codelineno-15-34"></a><span class="s1"> }'</span>
|
|
</span></code></pre></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-typescript highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">concurrent_swarm.ts</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-16-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-16-50">50</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-16-1"><a id="__codelineno-16-1" name="__codelineno-16-1"></a><span class="k">async</span><span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">runConcurrentSwarm</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-16-2"><a id="__codelineno-16-2" name="__codelineno-16-2"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">payload</span><span class="o">:</span><span class="w"> </span><span class="kt">SwarmPayload</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-16-3"><a id="__codelineno-16-3" name="__codelineno-16-3"></a><span class="w"> </span><span class="nx">name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Medical Analysis Swarm"</span><span class="p">,</span>
|
|
</span><span id="__span-16-4"><a id="__codelineno-16-4" name="__codelineno-16-4"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Analyzes medical data concurrently"</span><span class="p">,</span>
|
|
</span><span id="__span-16-5"><a id="__codelineno-16-5" name="__codelineno-16-5"></a><span class="w"> </span><span class="nx">agents</span><span class="o">:</span><span class="w"> </span><span class="p">[</span>
|
|
</span><span id="__span-16-6"><a id="__codelineno-16-6" name="__codelineno-16-6"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-16-7"><a id="__codelineno-16-7" name="__codelineno-16-7"></a><span class="w"> </span><span class="nx">agent_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Lab Data Analyzer"</span><span class="p">,</span>
|
|
</span><span id="__span-16-8"><a id="__codelineno-16-8" name="__codelineno-16-8"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Analyzes lab report data"</span><span class="p">,</span>
|
|
</span><span id="__span-16-9"><a id="__codelineno-16-9" name="__codelineno-16-9"></a><span class="w"> </span><span class="nx">system_prompt</span><span class="o">:</span><span class="w"> </span><span class="s2">"You are a medical data analyst specializing in lab results."</span><span class="p">,</span>
|
|
</span><span id="__span-16-10"><a id="__codelineno-16-10" name="__codelineno-16-10"></a><span class="w"> </span><span class="nx">model_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"claude-3-5-sonnet-20240620"</span><span class="p">,</span>
|
|
</span><span id="__span-16-11"><a id="__codelineno-16-11" name="__codelineno-16-11"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-16-12"><a id="__codelineno-16-12" name="__codelineno-16-12"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-16-13"><a id="__codelineno-16-13" name="__codelineno-16-13"></a><span class="w"> </span><span class="nx">max_tokens</span><span class="o">:</span><span class="w"> </span><span class="kt">8192</span><span class="p">,</span>
|
|
</span><span id="__span-16-14"><a id="__codelineno-16-14" name="__codelineno-16-14"></a><span class="w"> </span><span class="nx">temperature</span><span class="o">:</span><span class="w"> </span><span class="kt">0.5</span><span class="p">,</span>
|
|
</span><span id="__span-16-15"><a id="__codelineno-16-15" name="__codelineno-16-15"></a><span class="w"> </span><span class="nx">auto_generate_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span>
|
|
</span><span id="__span-16-16"><a id="__codelineno-16-16" name="__codelineno-16-16"></a><span class="w"> </span><span class="p">},</span>
|
|
</span><span id="__span-16-17"><a id="__codelineno-16-17" name="__codelineno-16-17"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-16-18"><a id="__codelineno-16-18" name="__codelineno-16-18"></a><span class="w"> </span><span class="nx">agent_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Clinical Specialist"</span><span class="p">,</span>
|
|
</span><span id="__span-16-19"><a id="__codelineno-16-19" name="__codelineno-16-19"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Provides clinical interpretations"</span><span class="p">,</span>
|
|
</span><span id="__span-16-20"><a id="__codelineno-16-20" name="__codelineno-16-20"></a><span class="w"> </span><span class="nx">system_prompt</span><span class="o">:</span><span class="w"> </span><span class="s2">"You are an expert in clinical diagnosis."</span><span class="p">,</span>
|
|
</span><span id="__span-16-21"><a id="__codelineno-16-21" name="__codelineno-16-21"></a><span class="w"> </span><span class="nx">model_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"claude-3-5-sonnet-20240620"</span><span class="p">,</span>
|
|
</span><span id="__span-16-22"><a id="__codelineno-16-22" name="__codelineno-16-22"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-16-23"><a id="__codelineno-16-23" name="__codelineno-16-23"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-16-24"><a id="__codelineno-16-24" name="__codelineno-16-24"></a><span class="w"> </span><span class="nx">max_tokens</span><span class="o">:</span><span class="w"> </span><span class="kt">8192</span><span class="p">,</span>
|
|
</span><span id="__span-16-25"><a id="__codelineno-16-25" name="__codelineno-16-25"></a><span class="w"> </span><span class="nx">temperature</span><span class="o">:</span><span class="w"> </span><span class="kt">0.5</span><span class="p">,</span>
|
|
</span><span id="__span-16-26"><a id="__codelineno-16-26" name="__codelineno-16-26"></a><span class="w"> </span><span class="nx">auto_generate_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span>
|
|
</span><span id="__span-16-27"><a id="__codelineno-16-27" name="__codelineno-16-27"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-16-28"><a id="__codelineno-16-28" name="__codelineno-16-28"></a><span class="w"> </span><span class="p">],</span>
|
|
</span><span id="__span-16-29"><a id="__codelineno-16-29" name="__codelineno-16-29"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-16-30"><a id="__codelineno-16-30" name="__codelineno-16-30"></a><span class="w"> </span><span class="nx">swarm_type</span><span class="o">:</span><span class="w"> </span><span class="s2">"ConcurrentWorkflow"</span><span class="p">,</span>
|
|
</span><span id="__span-16-31"><a id="__codelineno-16-31" name="__codelineno-16-31"></a><span class="w"> </span><span class="nx">task</span><span class="o">:</span><span class="w"> </span><span class="s2">"Analyze these lab results and provide clinical interpretations."</span>
|
|
</span><span id="__span-16-32"><a id="__codelineno-16-32" name="__codelineno-16-32"></a><span class="w"> </span><span class="p">};</span>
|
|
</span><span id="__span-16-33"><a id="__codelineno-16-33" name="__codelineno-16-33"></a>
|
|
</span><span id="__span-16-34"><a id="__codelineno-16-34" name="__codelineno-16-34"></a><span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-16-35"><a id="__codelineno-16-35" name="__codelineno-16-35"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">axios</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span>
|
|
</span><span id="__span-16-36"><a id="__codelineno-16-36" name="__codelineno-16-36"></a><span class="w"> </span><span class="sb">`</span><span class="si">${</span><span class="nx">BASE_URL</span><span class="si">}</span><span class="sb">/v1/swarm/completions`</span><span class="p">,</span>
|
|
</span><span id="__span-16-37"><a id="__codelineno-16-37" name="__codelineno-16-37"></a><span class="w"> </span><span class="nx">payload</span><span class="p">,</span>
|
|
</span><span id="__span-16-38"><a id="__codelineno-16-38" name="__codelineno-16-38"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-16-39"><a id="__codelineno-16-39" name="__codelineno-16-39"></a><span class="w"> </span><span class="nx">headers</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-16-40"><a id="__codelineno-16-40" name="__codelineno-16-40"></a><span class="w"> </span><span class="s1">'x-api-key'</span><span class="o">:</span><span class="w"> </span><span class="nx">API_KEY</span><span class="p">,</span>
|
|
</span><span id="__span-16-41"><a id="__codelineno-16-41" name="__codelineno-16-41"></a><span class="w"> </span><span class="s1">'Content-Type'</span><span class="o">:</span><span class="w"> </span><span class="s1">'application/json'</span>
|
|
</span><span id="__span-16-42"><a id="__codelineno-16-42" name="__codelineno-16-42"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-16-43"><a id="__codelineno-16-43" name="__codelineno-16-43"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-16-44"><a id="__codelineno-16-44" name="__codelineno-16-44"></a><span class="w"> </span><span class="p">);</span>
|
|
</span><span id="__span-16-45"><a id="__codelineno-16-45" name="__codelineno-16-45"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">;</span>
|
|
</span><span id="__span-16-46"><a id="__codelineno-16-46" name="__codelineno-16-46"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="nx">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-16-47"><a id="__codelineno-16-47" name="__codelineno-16-47"></a><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s1">'Error:'</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="p">);</span>
|
|
</span><span id="__span-16-48"><a id="__codelineno-16-48" name="__codelineno-16-48"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="nx">error</span><span class="p">;</span>
|
|
</span><span id="__span-16-49"><a id="__codelineno-16-49" name="__codelineno-16-49"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-16-50"><a id="__codelineno-16-50" name="__codelineno-16-50"></a><span class="p">}</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="batch-processing">Batch Processing<a class="headerlink" href="#batch-processing" title="Permanent link">¶</a></h3>
|
|
<div class="admonition example">
|
|
<p class="admonition-title">Batch Processing</p>
|
|
<p>Process multiple swarms in a single request for improved efficiency.</p>
|
|
</div>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="7:3"><input checked="checked" id="batch-processing-python" name="__tabbed_7" type="radio" /><input id="batch-processing-curl" name="__tabbed_7" type="radio" /><input id="batch-processing-typescript" name="__tabbed_7" type="radio" /><div class="tabbed-labels"><label for="batch-processing-python">Python</label><label for="batch-processing-curl">cURL</label><label for="batch-processing-typescript">TypeScript</label></div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block">
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">batch_swarms.py</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-17-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-17-35">35</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">run_batch_swarms</span><span class="p">():</span>
|
|
</span><span id="__span-17-2"><a id="__codelineno-17-2" name="__codelineno-17-2"></a> <span class="n">payload</span> <span class="o">=</span> <span class="p">[</span>
|
|
</span><span id="__span-17-3"><a id="__codelineno-17-3" name="__codelineno-17-3"></a> <span class="p">{</span>
|
|
</span><span id="__span-17-4"><a id="__codelineno-17-4" name="__codelineno-17-4"></a> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Batch Swarm 1"</span><span class="p">,</span>
|
|
</span><span id="__span-17-5"><a id="__codelineno-17-5" name="__codelineno-17-5"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"First swarm in batch"</span><span class="p">,</span>
|
|
</span><span id="__span-17-6"><a id="__codelineno-17-6" name="__codelineno-17-6"></a> <span class="s2">"agents"</span><span class="p">:</span> <span class="p">[</span>
|
|
</span><span id="__span-17-7"><a id="__codelineno-17-7" name="__codelineno-17-7"></a> <span class="p">{</span>
|
|
</span><span id="__span-17-8"><a id="__codelineno-17-8" name="__codelineno-17-8"></a> <span class="s2">"agent_name"</span><span class="p">:</span> <span class="s2">"Research Agent"</span><span class="p">,</span>
|
|
</span><span id="__span-17-9"><a id="__codelineno-17-9" name="__codelineno-17-9"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Conducts research"</span><span class="p">,</span>
|
|
</span><span id="__span-17-10"><a id="__codelineno-17-10" name="__codelineno-17-10"></a> <span class="s2">"system_prompt"</span><span class="p">:</span> <span class="s2">"You are a research assistant."</span><span class="p">,</span>
|
|
</span><span id="__span-17-11"><a id="__codelineno-17-11" name="__codelineno-17-11"></a> <span class="s2">"model_name"</span><span class="p">:</span> <span class="s2">"gpt-4"</span><span class="p">,</span>
|
|
</span><span id="__span-17-12"><a id="__codelineno-17-12" name="__codelineno-17-12"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-17-13"><a id="__codelineno-17-13" name="__codelineno-17-13"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span>
|
|
</span><span id="__span-17-14"><a id="__codelineno-17-14" name="__codelineno-17-14"></a> <span class="p">},</span>
|
|
</span><span id="__span-17-15"><a id="__codelineno-17-15" name="__codelineno-17-15"></a> <span class="p">{</span>
|
|
</span><span id="__span-17-16"><a id="__codelineno-17-16" name="__codelineno-17-16"></a> <span class="s2">"agent_name"</span><span class="p">:</span> <span class="s2">"Analysis Agent"</span><span class="p">,</span>
|
|
</span><span id="__span-17-17"><a id="__codelineno-17-17" name="__codelineno-17-17"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Analyzes data"</span><span class="p">,</span>
|
|
</span><span id="__span-17-18"><a id="__codelineno-17-18" name="__codelineno-17-18"></a> <span class="s2">"system_prompt"</span><span class="p">:</span> <span class="s2">"You are a data analyst."</span><span class="p">,</span>
|
|
</span><span id="__span-17-19"><a id="__codelineno-17-19" name="__codelineno-17-19"></a> <span class="s2">"model_name"</span><span class="p">:</span> <span class="s2">"gpt-4"</span><span class="p">,</span>
|
|
</span><span id="__span-17-20"><a id="__codelineno-17-20" name="__codelineno-17-20"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-17-21"><a id="__codelineno-17-21" name="__codelineno-17-21"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span>
|
|
</span><span id="__span-17-22"><a id="__codelineno-17-22" name="__codelineno-17-22"></a> <span class="p">}</span>
|
|
</span><span id="__span-17-23"><a id="__codelineno-17-23" name="__codelineno-17-23"></a> <span class="p">],</span>
|
|
</span><span id="__span-17-24"><a id="__codelineno-17-24" name="__codelineno-17-24"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-17-25"><a id="__codelineno-17-25" name="__codelineno-17-25"></a> <span class="s2">"swarm_type"</span><span class="p">:</span> <span class="s2">"SequentialWorkflow"</span><span class="p">,</span>
|
|
</span><span id="__span-17-26"><a id="__codelineno-17-26" name="__codelineno-17-26"></a> <span class="s2">"task"</span><span class="p">:</span> <span class="s2">"Research AI advancements."</span>
|
|
</span><span id="__span-17-27"><a id="__codelineno-17-27" name="__codelineno-17-27"></a> <span class="p">}</span>
|
|
</span><span id="__span-17-28"><a id="__codelineno-17-28" name="__codelineno-17-28"></a> <span class="p">]</span>
|
|
</span><span id="__span-17-29"><a id="__codelineno-17-29" name="__codelineno-17-29"></a>
|
|
</span><span id="__span-17-30"><a id="__codelineno-17-30" name="__codelineno-17-30"></a> <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><span id="__span-17-31"><a id="__codelineno-17-31" name="__codelineno-17-31"></a> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">BASE_URL</span><span class="si">}</span><span class="s2">/v1/swarm/batch/completions"</span><span class="p">,</span>
|
|
</span><span id="__span-17-32"><a id="__codelineno-17-32" name="__codelineno-17-32"></a> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">,</span>
|
|
</span><span id="__span-17-33"><a id="__codelineno-17-33" name="__codelineno-17-33"></a> <span class="n">json</span><span class="o">=</span><span class="n">payload</span>
|
|
</span><span id="__span-17-34"><a id="__codelineno-17-34" name="__codelineno-17-34"></a> <span class="p">)</span>
|
|
</span><span id="__span-17-35"><a id="__codelineno-17-35" name="__codelineno-17-35"></a> <span class="k">return</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-bash highlight"><span class="filename">batch_swarms.sh</span><pre><span></span><code><span id="__span-18-1"><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s2">"https://api.swarms.world/v1/swarm/batch/completions"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-18-2"><a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"x-api-key: </span><span class="nv">$SWARMS_API_KEY</span><span class="s2">"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-18-3"><a id="__codelineno-18-3" name="__codelineno-18-3" href="#__codelineno-18-3"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-18-4"><a id="__codelineno-18-4" name="__codelineno-18-4" href="#__codelineno-18-4"></a><span class="w"> </span>-d<span class="w"> </span><span class="s1">'[</span>
|
|
</span><span id="__span-18-5"><a id="__codelineno-18-5" name="__codelineno-18-5" href="#__codelineno-18-5"></a><span class="s1"> {</span>
|
|
</span><span id="__span-18-6"><a id="__codelineno-18-6" name="__codelineno-18-6" href="#__codelineno-18-6"></a><span class="s1"> "name": "Batch Swarm 1",</span>
|
|
</span><span id="__span-18-7"><a id="__codelineno-18-7" name="__codelineno-18-7" href="#__codelineno-18-7"></a><span class="s1"> "description": "First swarm in batch",</span>
|
|
</span><span id="__span-18-8"><a id="__codelineno-18-8" name="__codelineno-18-8" href="#__codelineno-18-8"></a><span class="s1"> "agents": [</span>
|
|
</span><span id="__span-18-9"><a id="__codelineno-18-9" name="__codelineno-18-9" href="#__codelineno-18-9"></a><span class="s1"> {</span>
|
|
</span><span id="__span-18-10"><a id="__codelineno-18-10" name="__codelineno-18-10" href="#__codelineno-18-10"></a><span class="s1"> "agent_name": "Research Agent",</span>
|
|
</span><span id="__span-18-11"><a id="__codelineno-18-11" name="__codelineno-18-11" href="#__codelineno-18-11"></a><span class="s1"> "description": "Conducts research",</span>
|
|
</span><span id="__span-18-12"><a id="__codelineno-18-12" name="__codelineno-18-12" href="#__codelineno-18-12"></a><span class="s1"> "system_prompt": "You are a research assistant.",</span>
|
|
</span><span id="__span-18-13"><a id="__codelineno-18-13" name="__codelineno-18-13" href="#__codelineno-18-13"></a><span class="s1"> "model_name": "gpt-4",</span>
|
|
</span><span id="__span-18-14"><a id="__codelineno-18-14" name="__codelineno-18-14" href="#__codelineno-18-14"></a><span class="s1"> "role": "worker",</span>
|
|
</span><span id="__span-18-15"><a id="__codelineno-18-15" name="__codelineno-18-15" href="#__codelineno-18-15"></a><span class="s1"> "max_loops": 1</span>
|
|
</span><span id="__span-18-16"><a id="__codelineno-18-16" name="__codelineno-18-16" href="#__codelineno-18-16"></a><span class="s1"> },</span>
|
|
</span><span id="__span-18-17"><a id="__codelineno-18-17" name="__codelineno-18-17" href="#__codelineno-18-17"></a><span class="s1"> {</span>
|
|
</span><span id="__span-18-18"><a id="__codelineno-18-18" name="__codelineno-18-18" href="#__codelineno-18-18"></a><span class="s1"> "agent_name": "Analysis Agent",</span>
|
|
</span><span id="__span-18-19"><a id="__codelineno-18-19" name="__codelineno-18-19" href="#__codelineno-18-19"></a><span class="s1"> "description": "Analyzes data",</span>
|
|
</span><span id="__span-18-20"><a id="__codelineno-18-20" name="__codelineno-18-20" href="#__codelineno-18-20"></a><span class="s1"> "system_prompt": "You are a data analyst.",</span>
|
|
</span><span id="__span-18-21"><a id="__codelineno-18-21" name="__codelineno-18-21" href="#__codelineno-18-21"></a><span class="s1"> "model_name": "gpt-4",</span>
|
|
</span><span id="__span-18-22"><a id="__codelineno-18-22" name="__codelineno-18-22" href="#__codelineno-18-22"></a><span class="s1"> "role": "worker",</span>
|
|
</span><span id="__span-18-23"><a id="__codelineno-18-23" name="__codelineno-18-23" href="#__codelineno-18-23"></a><span class="s1"> "max_loops": 1</span>
|
|
</span><span id="__span-18-24"><a id="__codelineno-18-24" name="__codelineno-18-24" href="#__codelineno-18-24"></a><span class="s1"> }</span>
|
|
</span><span id="__span-18-25"><a id="__codelineno-18-25" name="__codelineno-18-25" href="#__codelineno-18-25"></a><span class="s1"> ],</span>
|
|
</span><span id="__span-18-26"><a id="__codelineno-18-26" name="__codelineno-18-26" href="#__codelineno-18-26"></a><span class="s1"> "max_loops": 1,</span>
|
|
</span><span id="__span-18-27"><a id="__codelineno-18-27" name="__codelineno-18-27" href="#__codelineno-18-27"></a><span class="s1"> "swarm_type": "SequentialWorkflow",</span>
|
|
</span><span id="__span-18-28"><a id="__codelineno-18-28" name="__codelineno-18-28" href="#__codelineno-18-28"></a><span class="s1"> "task": "Research AI advancements."</span>
|
|
</span><span id="__span-18-29"><a id="__codelineno-18-29" name="__codelineno-18-29" href="#__codelineno-18-29"></a><span class="s1"> }</span>
|
|
</span><span id="__span-18-30"><a id="__codelineno-18-30" name="__codelineno-18-30" href="#__codelineno-18-30"></a><span class="s1"> ]'</span>
|
|
</span></code></pre></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-typescript highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">batch_swarms.ts</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-19-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-50">50</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-51">51</a></span>
|
|
<span class="normal"><a href="#__codelineno-19-52">52</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1"></a><span class="k">async</span><span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">runBatchSwarms</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-19-2"><a id="__codelineno-19-2" name="__codelineno-19-2"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">payload</span><span class="o">:</span><span class="w"> </span><span class="kt">SwarmPayload</span><span class="p">[]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span>
|
|
</span><span id="__span-19-3"><a id="__codelineno-19-3" name="__codelineno-19-3"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-19-4"><a id="__codelineno-19-4" name="__codelineno-19-4"></a><span class="w"> </span><span class="nx">name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Batch Swarm 1"</span><span class="p">,</span>
|
|
</span><span id="__span-19-5"><a id="__codelineno-19-5" name="__codelineno-19-5"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"First swarm in batch"</span><span class="p">,</span>
|
|
</span><span id="__span-19-6"><a id="__codelineno-19-6" name="__codelineno-19-6"></a><span class="w"> </span><span class="nx">agents</span><span class="o">:</span><span class="w"> </span><span class="p">[</span>
|
|
</span><span id="__span-19-7"><a id="__codelineno-19-7" name="__codelineno-19-7"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-19-8"><a id="__codelineno-19-8" name="__codelineno-19-8"></a><span class="w"> </span><span class="nx">agent_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Research Agent"</span><span class="p">,</span>
|
|
</span><span id="__span-19-9"><a id="__codelineno-19-9" name="__codelineno-19-9"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Conducts research"</span><span class="p">,</span>
|
|
</span><span id="__span-19-10"><a id="__codelineno-19-10" name="__codelineno-19-10"></a><span class="w"> </span><span class="nx">system_prompt</span><span class="o">:</span><span class="w"> </span><span class="s2">"You are a research assistant."</span><span class="p">,</span>
|
|
</span><span id="__span-19-11"><a id="__codelineno-19-11" name="__codelineno-19-11"></a><span class="w"> </span><span class="nx">model_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"gpt-4"</span><span class="p">,</span>
|
|
</span><span id="__span-19-12"><a id="__codelineno-19-12" name="__codelineno-19-12"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-19-13"><a id="__codelineno-19-13" name="__codelineno-19-13"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-19-14"><a id="__codelineno-19-14" name="__codelineno-19-14"></a><span class="w"> </span><span class="nx">max_tokens</span><span class="o">:</span><span class="w"> </span><span class="kt">8192</span><span class="p">,</span>
|
|
</span><span id="__span-19-15"><a id="__codelineno-19-15" name="__codelineno-19-15"></a><span class="w"> </span><span class="nx">temperature</span><span class="o">:</span><span class="w"> </span><span class="kt">0.7</span><span class="p">,</span>
|
|
</span><span id="__span-19-16"><a id="__codelineno-19-16" name="__codelineno-19-16"></a><span class="w"> </span><span class="nx">auto_generate_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span>
|
|
</span><span id="__span-19-17"><a id="__codelineno-19-17" name="__codelineno-19-17"></a><span class="w"> </span><span class="p">},</span>
|
|
</span><span id="__span-19-18"><a id="__codelineno-19-18" name="__codelineno-19-18"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-19-19"><a id="__codelineno-19-19" name="__codelineno-19-19"></a><span class="w"> </span><span class="nx">agent_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Analysis Agent"</span><span class="p">,</span>
|
|
</span><span id="__span-19-20"><a id="__codelineno-19-20" name="__codelineno-19-20"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Analyzes data"</span><span class="p">,</span>
|
|
</span><span id="__span-19-21"><a id="__codelineno-19-21" name="__codelineno-19-21"></a><span class="w"> </span><span class="nx">system_prompt</span><span class="o">:</span><span class="w"> </span><span class="s2">"You are a data analyst."</span><span class="p">,</span>
|
|
</span><span id="__span-19-22"><a id="__codelineno-19-22" name="__codelineno-19-22"></a><span class="w"> </span><span class="nx">model_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"gpt-4"</span><span class="p">,</span>
|
|
</span><span id="__span-19-23"><a id="__codelineno-19-23" name="__codelineno-19-23"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-19-24"><a id="__codelineno-19-24" name="__codelineno-19-24"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-19-25"><a id="__codelineno-19-25" name="__codelineno-19-25"></a><span class="w"> </span><span class="nx">max_tokens</span><span class="o">:</span><span class="w"> </span><span class="kt">8192</span><span class="p">,</span>
|
|
</span><span id="__span-19-26"><a id="__codelineno-19-26" name="__codelineno-19-26"></a><span class="w"> </span><span class="nx">temperature</span><span class="o">:</span><span class="w"> </span><span class="kt">0.7</span><span class="p">,</span>
|
|
</span><span id="__span-19-27"><a id="__codelineno-19-27" name="__codelineno-19-27"></a><span class="w"> </span><span class="nx">auto_generate_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span>
|
|
</span><span id="__span-19-28"><a id="__codelineno-19-28" name="__codelineno-19-28"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-19-29"><a id="__codelineno-19-29" name="__codelineno-19-29"></a><span class="w"> </span><span class="p">],</span>
|
|
</span><span id="__span-19-30"><a id="__codelineno-19-30" name="__codelineno-19-30"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-19-31"><a id="__codelineno-19-31" name="__codelineno-19-31"></a><span class="w"> </span><span class="nx">swarm_type</span><span class="o">:</span><span class="w"> </span><span class="s2">"SequentialWorkflow"</span><span class="p">,</span>
|
|
</span><span id="__span-19-32"><a id="__codelineno-19-32" name="__codelineno-19-32"></a><span class="w"> </span><span class="nx">task</span><span class="o">:</span><span class="w"> </span><span class="s2">"Research AI advancements."</span>
|
|
</span><span id="__span-19-33"><a id="__codelineno-19-33" name="__codelineno-19-33"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-19-34"><a id="__codelineno-19-34" name="__codelineno-19-34"></a><span class="w"> </span><span class="p">];</span>
|
|
</span><span id="__span-19-35"><a id="__codelineno-19-35" name="__codelineno-19-35"></a>
|
|
</span><span id="__span-19-36"><a id="__codelineno-19-36" name="__codelineno-19-36"></a><span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-19-37"><a id="__codelineno-19-37" name="__codelineno-19-37"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">axios</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span>
|
|
</span><span id="__span-19-38"><a id="__codelineno-19-38" name="__codelineno-19-38"></a><span class="w"> </span><span class="sb">`</span><span class="si">${</span><span class="nx">BASE_URL</span><span class="si">}</span><span class="sb">/v1/swarm/batch/completions`</span><span class="p">,</span>
|
|
</span><span id="__span-19-39"><a id="__codelineno-19-39" name="__codelineno-19-39"></a><span class="w"> </span><span class="nx">payload</span><span class="p">,</span>
|
|
</span><span id="__span-19-40"><a id="__codelineno-19-40" name="__codelineno-19-40"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-19-41"><a id="__codelineno-19-41" name="__codelineno-19-41"></a><span class="w"> </span><span class="nx">headers</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-19-42"><a id="__codelineno-19-42" name="__codelineno-19-42"></a><span class="w"> </span><span class="s1">'x-api-key'</span><span class="o">:</span><span class="w"> </span><span class="nx">API_KEY</span><span class="p">,</span>
|
|
</span><span id="__span-19-43"><a id="__codelineno-19-43" name="__codelineno-19-43"></a><span class="w"> </span><span class="s1">'Content-Type'</span><span class="o">:</span><span class="w"> </span><span class="s1">'application/json'</span>
|
|
</span><span id="__span-19-44"><a id="__codelineno-19-44" name="__codelineno-19-44"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-19-45"><a id="__codelineno-19-45" name="__codelineno-19-45"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-19-46"><a id="__codelineno-19-46" name="__codelineno-19-46"></a><span class="w"> </span><span class="p">);</span>
|
|
</span><span id="__span-19-47"><a id="__codelineno-19-47" name="__codelineno-19-47"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">;</span>
|
|
</span><span id="__span-19-48"><a id="__codelineno-19-48" name="__codelineno-19-48"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="nx">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-19-49"><a id="__codelineno-19-49" name="__codelineno-19-49"></a><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s1">'Error:'</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="p">);</span>
|
|
</span><span id="__span-19-50"><a id="__codelineno-19-50" name="__codelineno-19-50"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="nx">error</span><span class="p">;</span>
|
|
</span><span id="__span-19-51"><a id="__codelineno-19-51" name="__codelineno-19-51"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-19-52"><a id="__codelineno-19-52" name="__codelineno-19-52"></a><span class="p">}</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="advanced-features">Advanced Features<a class="headerlink" href="#advanced-features" title="Permanent link">¶</a></h2>
|
|
<h3 id="tools-integration">Tools Integration<a class="headerlink" href="#tools-integration" title="Permanent link">¶</a></h3>
|
|
<div class="admonition note">
|
|
<p class="admonition-title">Tools</p>
|
|
<p>Enhance agent capabilities by providing them with specialized tools.</p>
|
|
</div>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="8:3"><input checked="checked" id="tools-integration-python" name="__tabbed_8" type="radio" /><input id="tools-integration-curl" name="__tabbed_8" type="radio" /><input id="tools-integration-typescript" name="__tabbed_8" type="radio" /><div class="tabbed-labels"><label for="tools-integration-python">Python</label><label for="tools-integration-curl">cURL</label><label for="tools-integration-typescript">TypeScript</label></div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block">
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">tools_example.py</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-20-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-20-50">50</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-20-1"><a id="__codelineno-20-1" name="__codelineno-20-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">run_agent_with_tools</span><span class="p">():</span>
|
|
</span><span id="__span-20-2"><a id="__codelineno-20-2" name="__codelineno-20-2"></a> <span class="n">tools_dictionary</span> <span class="o">=</span> <span class="p">[</span>
|
|
</span><span id="__span-20-3"><a id="__codelineno-20-3" name="__codelineno-20-3"></a> <span class="p">{</span>
|
|
</span><span id="__span-20-4"><a id="__codelineno-20-4" name="__codelineno-20-4"></a> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"function"</span><span class="p">,</span>
|
|
</span><span id="__span-20-5"><a id="__codelineno-20-5" name="__codelineno-20-5"></a> <span class="s2">"function"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span id="__span-20-6"><a id="__codelineno-20-6" name="__codelineno-20-6"></a> <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"search_topic"</span><span class="p">,</span>
|
|
</span><span id="__span-20-7"><a id="__codelineno-20-7" name="__codelineno-20-7"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Conduct an in-depth search on a topic"</span><span class="p">,</span>
|
|
</span><span id="__span-20-8"><a id="__codelineno-20-8" name="__codelineno-20-8"></a> <span class="s2">"parameters"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span id="__span-20-9"><a id="__codelineno-20-9" name="__codelineno-20-9"></a> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"object"</span><span class="p">,</span>
|
|
</span><span id="__span-20-10"><a id="__codelineno-20-10" name="__codelineno-20-10"></a> <span class="s2">"properties"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span id="__span-20-11"><a id="__codelineno-20-11" name="__codelineno-20-11"></a> <span class="s2">"depth"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span id="__span-20-12"><a id="__codelineno-20-12" name="__codelineno-20-12"></a> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"integer"</span><span class="p">,</span>
|
|
</span><span id="__span-20-13"><a id="__codelineno-20-13" name="__codelineno-20-13"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Search depth (1-3)"</span>
|
|
</span><span id="__span-20-14"><a id="__codelineno-20-14" name="__codelineno-20-14"></a> <span class="p">},</span>
|
|
</span><span id="__span-20-15"><a id="__codelineno-20-15" name="__codelineno-20-15"></a> <span class="s2">"detailed_queries"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span id="__span-20-16"><a id="__codelineno-20-16" name="__codelineno-20-16"></a> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"array"</span><span class="p">,</span>
|
|
</span><span id="__span-20-17"><a id="__codelineno-20-17" name="__codelineno-20-17"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Specific search queries"</span><span class="p">,</span>
|
|
</span><span id="__span-20-18"><a id="__codelineno-20-18" name="__codelineno-20-18"></a> <span class="s2">"items"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span id="__span-20-19"><a id="__codelineno-20-19" name="__codelineno-20-19"></a> <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"string"</span>
|
|
</span><span id="__span-20-20"><a id="__codelineno-20-20" name="__codelineno-20-20"></a> <span class="p">}</span>
|
|
</span><span id="__span-20-21"><a id="__codelineno-20-21" name="__codelineno-20-21"></a> <span class="p">}</span>
|
|
</span><span id="__span-20-22"><a id="__codelineno-20-22" name="__codelineno-20-22"></a> <span class="p">},</span>
|
|
</span><span id="__span-20-23"><a id="__codelineno-20-23" name="__codelineno-20-23"></a> <span class="s2">"required"</span><span class="p">:</span> <span class="p">[</span><span class="s2">"depth"</span><span class="p">,</span> <span class="s2">"detailed_queries"</span><span class="p">]</span>
|
|
</span><span id="__span-20-24"><a id="__codelineno-20-24" name="__codelineno-20-24"></a> <span class="p">}</span>
|
|
</span><span id="__span-20-25"><a id="__codelineno-20-25" name="__codelineno-20-25"></a> <span class="p">}</span>
|
|
</span><span id="__span-20-26"><a id="__codelineno-20-26" name="__codelineno-20-26"></a> <span class="p">}</span>
|
|
</span><span id="__span-20-27"><a id="__codelineno-20-27" name="__codelineno-20-27"></a> <span class="p">]</span>
|
|
</span><span id="__span-20-28"><a id="__codelineno-20-28" name="__codelineno-20-28"></a>
|
|
</span><span id="__span-20-29"><a id="__codelineno-20-29" name="__codelineno-20-29"></a> <span class="n">payload</span> <span class="o">=</span> <span class="p">{</span>
|
|
</span><span id="__span-20-30"><a id="__codelineno-20-30" name="__codelineno-20-30"></a> <span class="s2">"agent_config"</span><span class="p">:</span> <span class="p">{</span>
|
|
</span><span id="__span-20-31"><a id="__codelineno-20-31" name="__codelineno-20-31"></a> <span class="s2">"agent_name"</span><span class="p">:</span> <span class="s2">"Research Assistant"</span><span class="p">,</span>
|
|
</span><span id="__span-20-32"><a id="__codelineno-20-32" name="__codelineno-20-32"></a> <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Expert in research with search capabilities"</span><span class="p">,</span>
|
|
</span><span id="__span-20-33"><a id="__codelineno-20-33" name="__codelineno-20-33"></a> <span class="s2">"system_prompt"</span><span class="p">:</span> <span class="s2">"You are a research assistant with search capabilities."</span><span class="p">,</span>
|
|
</span><span id="__span-20-34"><a id="__codelineno-20-34" name="__codelineno-20-34"></a> <span class="s2">"model_name"</span><span class="p">:</span> <span class="s2">"gpt-4"</span><span class="p">,</span>
|
|
</span><span id="__span-20-35"><a id="__codelineno-20-35" name="__codelineno-20-35"></a> <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-20-36"><a id="__codelineno-20-36" name="__codelineno-20-36"></a> <span class="s2">"max_loops"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
|
|
</span><span id="__span-20-37"><a id="__codelineno-20-37" name="__codelineno-20-37"></a> <span class="s2">"max_tokens"</span><span class="p">:</span> <span class="mi">8192</span><span class="p">,</span>
|
|
</span><span id="__span-20-38"><a id="__codelineno-20-38" name="__codelineno-20-38"></a> <span class="s2">"temperature"</span><span class="p">:</span> <span class="mf">0.7</span><span class="p">,</span>
|
|
</span><span id="__span-20-39"><a id="__codelineno-20-39" name="__codelineno-20-39"></a> <span class="s2">"auto_generate_prompt"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span>
|
|
</span><span id="__span-20-40"><a id="__codelineno-20-40" name="__codelineno-20-40"></a> <span class="s2">"tools_dictionary"</span><span class="p">:</span> <span class="n">tools_dictionary</span>
|
|
</span><span id="__span-20-41"><a id="__codelineno-20-41" name="__codelineno-20-41"></a> <span class="p">},</span>
|
|
</span><span id="__span-20-42"><a id="__codelineno-20-42" name="__codelineno-20-42"></a> <span class="s2">"task"</span><span class="p">:</span> <span class="s2">"Research the latest developments in quantum computing."</span>
|
|
</span><span id="__span-20-43"><a id="__codelineno-20-43" name="__codelineno-20-43"></a> <span class="p">}</span>
|
|
</span><span id="__span-20-44"><a id="__codelineno-20-44" name="__codelineno-20-44"></a>
|
|
</span><span id="__span-20-45"><a id="__codelineno-20-45" name="__codelineno-20-45"></a> <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><span id="__span-20-46"><a id="__codelineno-20-46" name="__codelineno-20-46"></a> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">BASE_URL</span><span class="si">}</span><span class="s2">/v1/agent/completions"</span><span class="p">,</span>
|
|
</span><span id="__span-20-47"><a id="__codelineno-20-47" name="__codelineno-20-47"></a> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">,</span>
|
|
</span><span id="__span-20-48"><a id="__codelineno-20-48" name="__codelineno-20-48"></a> <span class="n">json</span><span class="o">=</span><span class="n">payload</span>
|
|
</span><span id="__span-20-49"><a id="__codelineno-20-49" name="__codelineno-20-49"></a> <span class="p">)</span>
|
|
</span><span id="__span-20-50"><a id="__codelineno-20-50" name="__codelineno-20-50"></a> <span class="k">return</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-bash highlight"><span class="filename">tools_example.sh</span><pre><span></span><code><span id="__span-21-1"><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a>curl<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span><span class="s2">"https://api.swarms.world/v1/agent/completions"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-21-2"><a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"x-api-key: </span><span class="nv">$SWARMS_API_KEY</span><span class="s2">"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-21-3"><a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a><span class="w"> </span>-H<span class="w"> </span><span class="s2">"Content-Type: application/json"</span><span class="w"> </span><span class="se">\</span>
|
|
</span><span id="__span-21-4"><a id="__codelineno-21-4" name="__codelineno-21-4" href="#__codelineno-21-4"></a><span class="w"> </span>-d<span class="w"> </span><span class="s1">'{</span>
|
|
</span><span id="__span-21-5"><a id="__codelineno-21-5" name="__codelineno-21-5" href="#__codelineno-21-5"></a><span class="s1"> "agent_config": {</span>
|
|
</span><span id="__span-21-6"><a id="__codelineno-21-6" name="__codelineno-21-6" href="#__codelineno-21-6"></a><span class="s1"> "agent_name": "Research Assistant",</span>
|
|
</span><span id="__span-21-7"><a id="__codelineno-21-7" name="__codelineno-21-7" href="#__codelineno-21-7"></a><span class="s1"> "description": "Expert in research with search capabilities",</span>
|
|
</span><span id="__span-21-8"><a id="__codelineno-21-8" name="__codelineno-21-8" href="#__codelineno-21-8"></a><span class="s1"> "system_prompt": "You are a research assistant with search capabilities.",</span>
|
|
</span><span id="__span-21-9"><a id="__codelineno-21-9" name="__codelineno-21-9" href="#__codelineno-21-9"></a><span class="s1"> "model_name": "gpt-4",</span>
|
|
</span><span id="__span-21-10"><a id="__codelineno-21-10" name="__codelineno-21-10" href="#__codelineno-21-10"></a><span class="s1"> "role": "worker",</span>
|
|
</span><span id="__span-21-11"><a id="__codelineno-21-11" name="__codelineno-21-11" href="#__codelineno-21-11"></a><span class="s1"> "max_loops": 1,</span>
|
|
</span><span id="__span-21-12"><a id="__codelineno-21-12" name="__codelineno-21-12" href="#__codelineno-21-12"></a><span class="s1"> "max_tokens": 8192,</span>
|
|
</span><span id="__span-21-13"><a id="__codelineno-21-13" name="__codelineno-21-13" href="#__codelineno-21-13"></a><span class="s1"> "temperature": 0.7,</span>
|
|
</span><span id="__span-21-14"><a id="__codelineno-21-14" name="__codelineno-21-14" href="#__codelineno-21-14"></a><span class="s1"> "auto_generate_prompt": false,</span>
|
|
</span><span id="__span-21-15"><a id="__codelineno-21-15" name="__codelineno-21-15" href="#__codelineno-21-15"></a><span class="s1"> "tools_dictionary": [</span>
|
|
</span><span id="__span-21-16"><a id="__codelineno-21-16" name="__codelineno-21-16" href="#__codelineno-21-16"></a><span class="s1"> {</span>
|
|
</span><span id="__span-21-17"><a id="__codelineno-21-17" name="__codelineno-21-17" href="#__codelineno-21-17"></a><span class="s1"> "type": "function",</span>
|
|
</span><span id="__span-21-18"><a id="__codelineno-21-18" name="__codelineno-21-18" href="#__codelineno-21-18"></a><span class="s1"> "function": {</span>
|
|
</span><span id="__span-21-19"><a id="__codelineno-21-19" name="__codelineno-21-19" href="#__codelineno-21-19"></a><span class="s1"> "name": "search_topic",</span>
|
|
</span><span id="__span-21-20"><a id="__codelineno-21-20" name="__codelineno-21-20" href="#__codelineno-21-20"></a><span class="s1"> "description": "Conduct an in-depth search on a topic",</span>
|
|
</span><span id="__span-21-21"><a id="__codelineno-21-21" name="__codelineno-21-21" href="#__codelineno-21-21"></a><span class="s1"> "parameters": {</span>
|
|
</span><span id="__span-21-22"><a id="__codelineno-21-22" name="__codelineno-21-22" href="#__codelineno-21-22"></a><span class="s1"> "type": "object",</span>
|
|
</span><span id="__span-21-23"><a id="__codelineno-21-23" name="__codelineno-21-23" href="#__codelineno-21-23"></a><span class="s1"> "properties": {</span>
|
|
</span><span id="__span-21-24"><a id="__codelineno-21-24" name="__codelineno-21-24" href="#__codelineno-21-24"></a><span class="s1"> "depth": {</span>
|
|
</span><span id="__span-21-25"><a id="__codelineno-21-25" name="__codelineno-21-25" href="#__codelineno-21-25"></a><span class="s1"> "type": "integer",</span>
|
|
</span><span id="__span-21-26"><a id="__codelineno-21-26" name="__codelineno-21-26" href="#__codelineno-21-26"></a><span class="s1"> "description": "Search depth (1-3)"</span>
|
|
</span><span id="__span-21-27"><a id="__codelineno-21-27" name="__codelineno-21-27" href="#__codelineno-21-27"></a><span class="s1"> },</span>
|
|
</span><span id="__span-21-28"><a id="__codelineno-21-28" name="__codelineno-21-28" href="#__codelineno-21-28"></a><span class="s1"> "detailed_queries": {</span>
|
|
</span><span id="__span-21-29"><a id="__codelineno-21-29" name="__codelineno-21-29" href="#__codelineno-21-29"></a><span class="s1"> "type": "array",</span>
|
|
</span><span id="__span-21-30"><a id="__codelineno-21-30" name="__codelineno-21-30" href="#__codelineno-21-30"></a><span class="s1"> "description": "Specific search queries",</span>
|
|
</span><span id="__span-21-31"><a id="__codelineno-21-31" name="__codelineno-21-31" href="#__codelineno-21-31"></a><span class="s1"> "items": {</span>
|
|
</span><span id="__span-21-32"><a id="__codelineno-21-32" name="__codelineno-21-32" href="#__codelineno-21-32"></a><span class="s1"> "type": "string"</span>
|
|
</span><span id="__span-21-33"><a id="__codelineno-21-33" name="__codelineno-21-33" href="#__codelineno-21-33"></a><span class="s1"> }</span>
|
|
</span><span id="__span-21-34"><a id="__codelineno-21-34" name="__codelineno-21-34" href="#__codelineno-21-34"></a><span class="s1"> }</span>
|
|
</span><span id="__span-21-35"><a id="__codelineno-21-35" name="__codelineno-21-35" href="#__codelineno-21-35"></a><span class="s1"> },</span>
|
|
</span><span id="__span-21-36"><a id="__codelineno-21-36" name="__codelineno-21-36" href="#__codelineno-21-36"></a><span class="s1"> "required": ["depth", "detailed_queries"]</span>
|
|
</span><span id="__span-21-37"><a id="__codelineno-21-37" name="__codelineno-21-37" href="#__codelineno-21-37"></a><span class="s1"> }</span>
|
|
</span><span id="__span-21-38"><a id="__codelineno-21-38" name="__codelineno-21-38" href="#__codelineno-21-38"></a><span class="s1"> }</span>
|
|
</span><span id="__span-21-39"><a id="__codelineno-21-39" name="__codelineno-21-39" href="#__codelineno-21-39"></a><span class="s1"> }</span>
|
|
</span><span id="__span-21-40"><a id="__codelineno-21-40" name="__codelineno-21-40" href="#__codelineno-21-40"></a><span class="s1"> ]</span>
|
|
</span><span id="__span-21-41"><a id="__codelineno-21-41" name="__codelineno-21-41" href="#__codelineno-21-41"></a><span class="s1"> },</span>
|
|
</span><span id="__span-21-42"><a id="__codelineno-21-42" name="__codelineno-21-42" href="#__codelineno-21-42"></a><span class="s1"> "task": "Research the latest developments in quantum computing."</span>
|
|
</span><span id="__span-21-43"><a id="__codelineno-21-43" name="__codelineno-21-43" href="#__codelineno-21-43"></a><span class="s1"> }'</span>
|
|
</span></code></pre></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-typescript highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">tools_example.ts</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-22-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-50">50</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-51">51</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-52">52</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-53">53</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-54">54</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-55">55</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-56">56</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-57">57</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-58">58</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-59">59</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-60">60</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-61">61</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-62">62</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-63">63</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-64">64</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-65">65</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-66">66</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-67">67</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-68">68</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-69">69</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-70">70</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-71">71</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-72">72</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-73">73</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-74">74</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-75">75</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-76">76</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-77">77</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-78">78</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-79">79</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-80">80</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-81">81</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-82">82</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-83">83</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-84">84</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-85">85</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-86">86</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-87">87</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-88">88</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-89">89</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-90">90</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-91">91</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-92">92</a></span>
|
|
<span class="normal"><a href="#__codelineno-22-93">93</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-22-1"><a id="__codelineno-22-1" name="__codelineno-22-1"></a><span class="kd">interface</span><span class="w"> </span><span class="nx">ToolFunction</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-2"><a id="__codelineno-22-2" name="__codelineno-22-2"></a><span class="w"> </span><span class="nx">name</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-22-3"><a id="__codelineno-22-3" name="__codelineno-22-3"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-22-4"><a id="__codelineno-22-4" name="__codelineno-22-4"></a><span class="w"> </span><span class="nx">parameters</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-5"><a id="__codelineno-22-5" name="__codelineno-22-5"></a><span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-22-6"><a id="__codelineno-22-6" name="__codelineno-22-6"></a><span class="w"> </span><span class="nx">properties</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-7"><a id="__codelineno-22-7" name="__codelineno-22-7"></a><span class="w"> </span><span class="p">[</span><span class="nx">key</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">]</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-8"><a id="__codelineno-22-8" name="__codelineno-22-8"></a><span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-22-9"><a id="__codelineno-22-9" name="__codelineno-22-9"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-22-10"><a id="__codelineno-22-10" name="__codelineno-22-10"></a><span class="w"> </span><span class="nx">items</span><span class="o">?:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-11"><a id="__codelineno-22-11" name="__codelineno-22-11"></a><span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-22-12"><a id="__codelineno-22-12" name="__codelineno-22-12"></a><span class="w"> </span><span class="p">};</span>
|
|
</span><span id="__span-22-13"><a id="__codelineno-22-13" name="__codelineno-22-13"></a><span class="w"> </span><span class="p">};</span>
|
|
</span><span id="__span-22-14"><a id="__codelineno-22-14" name="__codelineno-22-14"></a><span class="w"> </span><span class="p">};</span>
|
|
</span><span id="__span-22-15"><a id="__codelineno-22-15" name="__codelineno-22-15"></a><span class="w"> </span><span class="nx">required</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">[];</span>
|
|
</span><span id="__span-22-16"><a id="__codelineno-22-16" name="__codelineno-22-16"></a><span class="w"> </span><span class="p">};</span>
|
|
</span><span id="__span-22-17"><a id="__codelineno-22-17" name="__codelineno-22-17"></a><span class="p">}</span>
|
|
</span><span id="__span-22-18"><a id="__codelineno-22-18" name="__codelineno-22-18"></a>
|
|
</span><span id="__span-22-19"><a id="__codelineno-22-19" name="__codelineno-22-19"></a><span class="kd">interface</span><span class="w"> </span><span class="nx">Tool</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-20"><a id="__codelineno-22-20" name="__codelineno-22-20"></a><span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-22-21"><a id="__codelineno-22-21" name="__codelineno-22-21"></a><span class="w"> </span><span class="nx">function</span><span class="o">:</span><span class="w"> </span><span class="kt">ToolFunction</span><span class="p">;</span>
|
|
</span><span id="__span-22-22"><a id="__codelineno-22-22" name="__codelineno-22-22"></a><span class="p">}</span>
|
|
</span><span id="__span-22-23"><a id="__codelineno-22-23" name="__codelineno-22-23"></a>
|
|
</span><span id="__span-22-24"><a id="__codelineno-22-24" name="__codelineno-22-24"></a><span class="kd">interface</span><span class="w"> </span><span class="nx">AgentWithToolsConfig</span><span class="w"> </span><span class="k">extends</span><span class="w"> </span><span class="nx">AgentConfig</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-25"><a id="__codelineno-22-25" name="__codelineno-22-25"></a><span class="w"> </span><span class="nx">tools_dictionary</span><span class="o">:</span><span class="w"> </span><span class="kt">Tool</span><span class="p">[];</span>
|
|
</span><span id="__span-22-26"><a id="__codelineno-22-26" name="__codelineno-22-26"></a><span class="p">}</span>
|
|
</span><span id="__span-22-27"><a id="__codelineno-22-27" name="__codelineno-22-27"></a>
|
|
</span><span id="__span-22-28"><a id="__codelineno-22-28" name="__codelineno-22-28"></a><span class="kd">interface</span><span class="w"> </span><span class="nx">AgentWithToolsPayload</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-29"><a id="__codelineno-22-29" name="__codelineno-22-29"></a><span class="w"> </span><span class="nx">agent_config</span><span class="o">:</span><span class="w"> </span><span class="kt">AgentWithToolsConfig</span><span class="p">;</span>
|
|
</span><span id="__span-22-30"><a id="__codelineno-22-30" name="__codelineno-22-30"></a><span class="w"> </span><span class="nx">task</span><span class="o">:</span><span class="w"> </span><span class="kt">string</span><span class="p">;</span>
|
|
</span><span id="__span-22-31"><a id="__codelineno-22-31" name="__codelineno-22-31"></a><span class="p">}</span>
|
|
</span><span id="__span-22-32"><a id="__codelineno-22-32" name="__codelineno-22-32"></a>
|
|
</span><span id="__span-22-33"><a id="__codelineno-22-33" name="__codelineno-22-33"></a><span class="k">async</span><span class="w"> </span><span class="kd">function</span><span class="w"> </span><span class="nx">runAgentWithTools</span><span class="p">()</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-34"><a id="__codelineno-22-34" name="__codelineno-22-34"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">toolsDictionary</span><span class="o">:</span><span class="w"> </span><span class="kt">Tool</span><span class="p">[]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span>
|
|
</span><span id="__span-22-35"><a id="__codelineno-22-35" name="__codelineno-22-35"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-36"><a id="__codelineno-22-36" name="__codelineno-22-36"></a><span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="s2">"function"</span><span class="p">,</span>
|
|
</span><span id="__span-22-37"><a id="__codelineno-22-37" name="__codelineno-22-37"></a><span class="w"> </span><span class="kd">function</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-38"><a id="__codelineno-22-38" name="__codelineno-22-38"></a><span class="w"> </span><span class="nx">name</span><span class="o">:</span><span class="w"> </span><span class="s2">"search_topic"</span><span class="p">,</span>
|
|
</span><span id="__span-22-39"><a id="__codelineno-22-39" name="__codelineno-22-39"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Conduct an in-depth search on a topic"</span><span class="p">,</span>
|
|
</span><span id="__span-22-40"><a id="__codelineno-22-40" name="__codelineno-22-40"></a><span class="w"> </span><span class="nx">parameters</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-41"><a id="__codelineno-22-41" name="__codelineno-22-41"></a><span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="s2">"object"</span><span class="p">,</span>
|
|
</span><span id="__span-22-42"><a id="__codelineno-22-42" name="__codelineno-22-42"></a><span class="w"> </span><span class="nx">properties</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-43"><a id="__codelineno-22-43" name="__codelineno-22-43"></a><span class="w"> </span><span class="nx">depth</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-44"><a id="__codelineno-22-44" name="__codelineno-22-44"></a><span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="s2">"integer"</span><span class="p">,</span>
|
|
</span><span id="__span-22-45"><a id="__codelineno-22-45" name="__codelineno-22-45"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Search depth (1-3)"</span>
|
|
</span><span id="__span-22-46"><a id="__codelineno-22-46" name="__codelineno-22-46"></a><span class="w"> </span><span class="p">},</span>
|
|
</span><span id="__span-22-47"><a id="__codelineno-22-47" name="__codelineno-22-47"></a><span class="w"> </span><span class="nx">detailed_queries</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-48"><a id="__codelineno-22-48" name="__codelineno-22-48"></a><span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="s2">"array"</span><span class="p">,</span>
|
|
</span><span id="__span-22-49"><a id="__codelineno-22-49" name="__codelineno-22-49"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Specific search queries"</span><span class="p">,</span>
|
|
</span><span id="__span-22-50"><a id="__codelineno-22-50" name="__codelineno-22-50"></a><span class="w"> </span><span class="nx">items</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-51"><a id="__codelineno-22-51" name="__codelineno-22-51"></a><span class="w"> </span><span class="kr">type</span><span class="o">:</span><span class="w"> </span><span class="s2">"string"</span>
|
|
</span><span id="__span-22-52"><a id="__codelineno-22-52" name="__codelineno-22-52"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-22-53"><a id="__codelineno-22-53" name="__codelineno-22-53"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-22-54"><a id="__codelineno-22-54" name="__codelineno-22-54"></a><span class="w"> </span><span class="p">},</span>
|
|
</span><span id="__span-22-55"><a id="__codelineno-22-55" name="__codelineno-22-55"></a><span class="w"> </span><span class="nx">required</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"depth"</span><span class="p">,</span><span class="w"> </span><span class="s2">"detailed_queries"</span><span class="p">]</span>
|
|
</span><span id="__span-22-56"><a id="__codelineno-22-56" name="__codelineno-22-56"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-22-57"><a id="__codelineno-22-57" name="__codelineno-22-57"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-22-58"><a id="__codelineno-22-58" name="__codelineno-22-58"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-22-59"><a id="__codelineno-22-59" name="__codelineno-22-59"></a><span class="w"> </span><span class="p">];</span>
|
|
</span><span id="__span-22-60"><a id="__codelineno-22-60" name="__codelineno-22-60"></a>
|
|
</span><span id="__span-22-61"><a id="__codelineno-22-61" name="__codelineno-22-61"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">payload</span><span class="o">:</span><span class="w"> </span><span class="kt">AgentWithToolsPayload</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-62"><a id="__codelineno-22-62" name="__codelineno-22-62"></a><span class="w"> </span><span class="nx">agent_config</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-63"><a id="__codelineno-22-63" name="__codelineno-22-63"></a><span class="w"> </span><span class="nx">agent_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"Research Assistant"</span><span class="p">,</span>
|
|
</span><span id="__span-22-64"><a id="__codelineno-22-64" name="__codelineno-22-64"></a><span class="w"> </span><span class="nx">description</span><span class="o">:</span><span class="w"> </span><span class="s2">"Expert in research with search capabilities"</span><span class="p">,</span>
|
|
</span><span id="__span-22-65"><a id="__codelineno-22-65" name="__codelineno-22-65"></a><span class="w"> </span><span class="nx">system_prompt</span><span class="o">:</span><span class="w"> </span><span class="s2">"You are a research assistant with search capabilities."</span><span class="p">,</span>
|
|
</span><span id="__span-22-66"><a id="__codelineno-22-66" name="__codelineno-22-66"></a><span class="w"> </span><span class="nx">model_name</span><span class="o">:</span><span class="w"> </span><span class="s2">"gpt-4"</span><span class="p">,</span>
|
|
</span><span id="__span-22-67"><a id="__codelineno-22-67" name="__codelineno-22-67"></a><span class="w"> </span><span class="nx">role</span><span class="o">:</span><span class="w"> </span><span class="s2">"worker"</span><span class="p">,</span>
|
|
</span><span id="__span-22-68"><a id="__codelineno-22-68" name="__codelineno-22-68"></a><span class="w"> </span><span class="nx">max_loops</span><span class="o">:</span><span class="w"> </span><span class="kt">1</span><span class="p">,</span>
|
|
</span><span id="__span-22-69"><a id="__codelineno-22-69" name="__codelineno-22-69"></a><span class="w"> </span><span class="nx">max_tokens</span><span class="o">:</span><span class="w"> </span><span class="kt">8192</span><span class="p">,</span>
|
|
</span><span id="__span-22-70"><a id="__codelineno-22-70" name="__codelineno-22-70"></a><span class="w"> </span><span class="nx">temperature</span><span class="o">:</span><span class="w"> </span><span class="kt">0.7</span><span class="p">,</span>
|
|
</span><span id="__span-22-71"><a id="__codelineno-22-71" name="__codelineno-22-71"></a><span class="w"> </span><span class="nx">auto_generate_prompt</span><span class="o">:</span><span class="w"> </span><span class="kt">false</span><span class="p">,</span>
|
|
</span><span id="__span-22-72"><a id="__codelineno-22-72" name="__codelineno-22-72"></a><span class="w"> </span><span class="nx">tools_dictionary</span><span class="o">:</span><span class="w"> </span><span class="kt">toolsDictionary</span>
|
|
</span><span id="__span-22-73"><a id="__codelineno-22-73" name="__codelineno-22-73"></a><span class="w"> </span><span class="p">},</span>
|
|
</span><span id="__span-22-74"><a id="__codelineno-22-74" name="__codelineno-22-74"></a><span class="w"> </span><span class="nx">task</span><span class="o">:</span><span class="w"> </span><span class="s2">"Research the latest developments in quantum computing."</span>
|
|
</span><span id="__span-22-75"><a id="__codelineno-22-75" name="__codelineno-22-75"></a><span class="w"> </span><span class="p">};</span>
|
|
</span><span id="__span-22-76"><a id="__codelineno-22-76" name="__codelineno-22-76"></a>
|
|
</span><span id="__span-22-77"><a id="__codelineno-22-77" name="__codelineno-22-77"></a><span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-78"><a id="__codelineno-22-78" name="__codelineno-22-78"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">axios</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span>
|
|
</span><span id="__span-22-79"><a id="__codelineno-22-79" name="__codelineno-22-79"></a><span class="w"> </span><span class="sb">`</span><span class="si">${</span><span class="nx">BASE_URL</span><span class="si">}</span><span class="sb">/v1/agent/completions`</span><span class="p">,</span>
|
|
</span><span id="__span-22-80"><a id="__codelineno-22-80" name="__codelineno-22-80"></a><span class="w"> </span><span class="nx">payload</span><span class="p">,</span>
|
|
</span><span id="__span-22-81"><a id="__codelineno-22-81" name="__codelineno-22-81"></a><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-82"><a id="__codelineno-22-82" name="__codelineno-22-82"></a><span class="w"> </span><span class="nx">headers</span><span class="o">:</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-83"><a id="__codelineno-22-83" name="__codelineno-22-83"></a><span class="w"> </span><span class="s1">'x-api-key'</span><span class="o">:</span><span class="w"> </span><span class="nx">API_KEY</span><span class="p">,</span>
|
|
</span><span id="__span-22-84"><a id="__codelineno-22-84" name="__codelineno-22-84"></a><span class="w"> </span><span class="s1">'Content-Type'</span><span class="o">:</span><span class="w"> </span><span class="s1">'application/json'</span>
|
|
</span><span id="__span-22-85"><a id="__codelineno-22-85" name="__codelineno-22-85"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-22-86"><a id="__codelineno-22-86" name="__codelineno-22-86"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-22-87"><a id="__codelineno-22-87" name="__codelineno-22-87"></a><span class="w"> </span><span class="p">);</span>
|
|
</span><span id="__span-22-88"><a id="__codelineno-22-88" name="__codelineno-22-88"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">response</span><span class="p">.</span><span class="nx">data</span><span class="p">;</span>
|
|
</span><span id="__span-22-89"><a id="__codelineno-22-89" name="__codelineno-22-89"></a><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="nx">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-22-90"><a id="__codelineno-22-90" name="__codelineno-22-90"></a><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s1">'Error:'</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="p">);</span>
|
|
</span><span id="__span-22-91"><a id="__codelineno-22-91" name="__codelineno-22-91"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="nx">error</span><span class="p">;</span>
|
|
</span><span id="__span-22-92"><a id="__codelineno-22-92" name="__codelineno-22-92"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-22-93"><a id="__codelineno-22-93" name="__codelineno-22-93"></a><span class="p">}</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h3 id="available-models">Available Models<a class="headerlink" href="#available-models" title="Permanent link">¶</a></h3>
|
|
<div class="admonition info">
|
|
<p class="admonition-title">Supported Models</p>
|
|
<p>Choose the right model for your use case:</p>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="9:3"><input checked="checked" id="available-models-openai" name="__tabbed_9" type="radio" /><input id="available-models-anthropic" name="__tabbed_9" type="radio" /><input id="available-models-groq" name="__tabbed_9" type="radio" /><div class="tabbed-labels"><label for="available-models-openai">OpenAI</label><label for="available-models-anthropic">Anthropic</label><label for="available-models-groq">Groq</label></div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block">
|
|
<ul>
|
|
<li><code>gpt-4</code></li>
|
|
<li><code>gpt-4o</code></li>
|
|
<li><code>gpt-4o-mini</code></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<ul>
|
|
<li><code>claude-3-5-sonnet-20240620</code></li>
|
|
<li><code>claude-3-7-sonnet-latest</code></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<ul>
|
|
<li><code>groq/llama3-70b-8192</code></li>
|
|
<li><code>groq/deepseek-r1-distill-llama-70b</code></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="best-practices">Best Practices<a class="headerlink" href="#best-practices" title="Permanent link">¶</a></h2>
|
|
<div class="admonition danger">
|
|
<p class="admonition-title">Security</p>
|
|
<p>Never commit API keys or sensitive credentials to version control.</p>
|
|
</div>
|
|
<div class="admonition warning">
|
|
<p class="admonition-title">Rate Limits</p>
|
|
<p>Implement proper rate limiting and error handling in production.</p>
|
|
</div>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Testing</p>
|
|
<p>Start with simple tasks and gradually increase complexity.</p>
|
|
</div>
|
|
<div class="tabbed-set tabbed-alternate" data-tabs="10:2"><input checked="checked" id="best-practices-python" name="__tabbed_10" type="radio" /><input id="best-practices-typescript" name="__tabbed_10" type="radio" /><div class="tabbed-labels"><label for="best-practices-python">Python</label><label for="best-practices-typescript">TypeScript</label></div>
|
|
<div class="tabbed-content">
|
|
<div class="tabbed-block">
|
|
<div class="language-python highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">best_practices.py</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-23-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-23-22">22</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-23-1"><a id="__codelineno-23-1" name="__codelineno-23-1"></a><span class="c1"># Error Handling</span>
|
|
</span><span id="__span-23-2"><a id="__codelineno-23-2" name="__codelineno-23-2"></a><span class="k">try</span><span class="p">:</span>
|
|
</span><span id="__span-23-3"><a id="__codelineno-23-3" name="__codelineno-23-3"></a> <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="n">url</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">,</span> <span class="n">json</span><span class="o">=</span><span class="n">payload</span><span class="p">)</span>
|
|
</span><span id="__span-23-4"><a id="__codelineno-23-4" name="__codelineno-23-4"></a> <span class="n">response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
|
|
</span><span id="__span-23-5"><a id="__codelineno-23-5" name="__codelineno-23-5"></a><span class="k">except</span> <span class="n">requests</span><span class="o">.</span><span class="n">exceptions</span><span class="o">.</span><span class="n">RequestException</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
</span><span id="__span-23-6"><a id="__codelineno-23-6" name="__codelineno-23-6"></a> <span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Error: </span><span class="si">{</span><span class="n">e</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
</span><span id="__span-23-7"><a id="__codelineno-23-7" name="__codelineno-23-7"></a>
|
|
</span><span id="__span-23-8"><a id="__codelineno-23-8" name="__codelineno-23-8"></a><span class="c1"># Rate Limiting</span>
|
|
</span><span id="__span-23-9"><a id="__codelineno-23-9" name="__codelineno-23-9"></a><span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
|
|
</span><span id="__span-23-10"><a id="__codelineno-23-10" name="__codelineno-23-10"></a><span class="kn">from</span><span class="w"> </span><span class="nn">tenacity</span><span class="w"> </span><span class="kn">import</span> <span class="n">retry</span><span class="p">,</span> <span class="n">wait_exponential</span>
|
|
</span><span id="__span-23-11"><a id="__codelineno-23-11" name="__codelineno-23-11"></a>
|
|
</span><span id="__span-23-12"><a id="__codelineno-23-12" name="__codelineno-23-12"></a><span class="nd">@retry</span><span class="p">(</span><span class="n">wait</span><span class="o">=</span><span class="n">wait_exponential</span><span class="p">(</span><span class="n">multiplier</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="nb">min</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="nb">max</span><span class="o">=</span><span class="mi">10</span><span class="p">))</span>
|
|
</span><span id="__span-23-13"><a id="__codelineno-23-13" name="__codelineno-23-13"></a><span class="k">def</span><span class="w"> </span><span class="nf">make_api_call</span><span class="p">():</span>
|
|
</span><span id="__span-23-14"><a id="__codelineno-23-14" name="__codelineno-23-14"></a> <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="n">url</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">,</span> <span class="n">json</span><span class="o">=</span><span class="n">payload</span><span class="p">)</span>
|
|
</span><span id="__span-23-15"><a id="__codelineno-23-15" name="__codelineno-23-15"></a> <span class="n">response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
|
|
</span><span id="__span-23-16"><a id="__codelineno-23-16" name="__codelineno-23-16"></a> <span class="k">return</span> <span class="n">response</span>
|
|
</span><span id="__span-23-17"><a id="__codelineno-23-17" name="__codelineno-23-17"></a>
|
|
</span><span id="__span-23-18"><a id="__codelineno-23-18" name="__codelineno-23-18"></a><span class="c1"># Input Validation</span>
|
|
</span><span id="__span-23-19"><a id="__codelineno-23-19" name="__codelineno-23-19"></a><span class="k">def</span><span class="w"> </span><span class="nf">validate_payload</span><span class="p">(</span><span class="n">payload</span><span class="p">):</span>
|
|
</span><span id="__span-23-20"><a id="__codelineno-23-20" name="__codelineno-23-20"></a> <span class="n">required_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"agent_config"</span><span class="p">,</span> <span class="s2">"task"</span><span class="p">]</span>
|
|
</span><span id="__span-23-21"><a id="__codelineno-23-21" name="__codelineno-23-21"></a> <span class="k">if</span> <span class="ow">not</span> <span class="nb">all</span><span class="p">(</span><span class="n">field</span> <span class="ow">in</span> <span class="n">payload</span> <span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">required_fields</span><span class="p">):</span>
|
|
</span><span id="__span-23-22"><a id="__codelineno-23-22" name="__codelineno-23-22"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">"Missing required fields"</span><span class="p">)</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
<div class="tabbed-block">
|
|
<div class="language-typescript highlight"><table class="highlighttable"><tr><th colspan="2" class="filename"><span class="filename">best_practices.ts</span></th></tr><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-24-1"> 1</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-2"> 2</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-3"> 3</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-4"> 4</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-5"> 5</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-6"> 6</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-24-30">30</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-24-1"><a id="__codelineno-24-1" name="__codelineno-24-1"></a><span class="c1">// Error Handling</span>
|
|
</span><span id="__span-24-2"><a id="__codelineno-24-2" name="__codelineno-24-2"></a><span class="k">try</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-24-3"><a id="__codelineno-24-3" name="__codelineno-24-3"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="nx">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">await</span><span class="w"> </span><span class="nx">axios</span><span class="p">.</span><span class="nx">post</span><span class="p">(</span><span class="nx">url</span><span class="p">,</span><span class="w"> </span><span class="nx">payload</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">headers</span><span class="w"> </span><span class="p">});</span>
|
|
</span><span id="__span-24-4"><a id="__codelineno-24-4" name="__codelineno-24-4"></a><span class="p">}</span><span class="w"> </span><span class="k">catch</span><span class="w"> </span><span class="p">(</span><span class="nx">error</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-24-5"><a id="__codelineno-24-5" name="__codelineno-24-5"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">axios</span><span class="p">.</span><span class="nx">isAxiosError</span><span class="p">(</span><span class="nx">error</span><span class="p">))</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-24-6"><a id="__codelineno-24-6" name="__codelineno-24-6"></a><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">error</span><span class="p">(</span><span class="s1">'API Error:'</span><span class="p">,</span><span class="w"> </span><span class="nx">error</span><span class="p">.</span><span class="nx">response</span><span class="o">?</span><span class="p">.</span><span class="nx">data</span><span class="p">);</span>
|
|
</span><span id="__span-24-7"><a id="__codelineno-24-7" name="__codelineno-24-7"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-24-8"><a id="__codelineno-24-8" name="__codelineno-24-8"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="nx">error</span><span class="p">;</span>
|
|
</span><span id="__span-24-9"><a id="__codelineno-24-9" name="__codelineno-24-9"></a><span class="p">}</span>
|
|
</span><span id="__span-24-10"><a id="__codelineno-24-10" name="__codelineno-24-10"></a>
|
|
</span><span id="__span-24-11"><a id="__codelineno-24-11" name="__codelineno-24-11"></a><span class="c1">// Rate Limiting</span>
|
|
</span><span id="__span-24-12"><a id="__codelineno-24-12" name="__codelineno-24-12"></a><span class="k">import</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">rateLimit</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="kr">from</span><span class="w"> </span><span class="s1">'axios-rate-limit'</span><span class="p">;</span>
|
|
</span><span id="__span-24-13"><a id="__codelineno-24-13" name="__codelineno-24-13"></a>
|
|
</span><span id="__span-24-14"><a id="__codelineno-24-14" name="__codelineno-24-14"></a><span class="kd">const</span><span class="w"> </span><span class="nx">http</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">rateLimit</span><span class="p">(</span><span class="nx">axios</span><span class="p">.</span><span class="nx">create</span><span class="p">(),</span><span class="w"> </span><span class="p">{</span><span class="w"> </span>
|
|
</span><span id="__span-24-15"><a id="__codelineno-24-15" name="__codelineno-24-15"></a><span class="w"> </span><span class="nx">maxRequests</span><span class="o">:</span><span class="w"> </span><span class="kt">2</span><span class="p">,</span>
|
|
</span><span id="__span-24-16"><a id="__codelineno-24-16" name="__codelineno-24-16"></a><span class="w"> </span><span class="nx">perMilliseconds</span><span class="o">:</span><span class="w"> </span><span class="kt">1000</span>
|
|
</span><span id="__span-24-17"><a id="__codelineno-24-17" name="__codelineno-24-17"></a><span class="p">});</span>
|
|
</span><span id="__span-24-18"><a id="__codelineno-24-18" name="__codelineno-24-18"></a>
|
|
</span><span id="__span-24-19"><a id="__codelineno-24-19" name="__codelineno-24-19"></a><span class="c1">// Input Validation</span>
|
|
</span><span id="__span-24-20"><a id="__codelineno-24-20" name="__codelineno-24-20"></a><span class="kd">function</span><span class="w"> </span><span class="nx">validatePayload</span><span class="p">(</span><span class="nx">payload</span><span class="o">:</span><span class="w"> </span><span class="kt">unknown</span><span class="p">)</span><span class="o">:</span><span class="w"> </span><span class="nx">asserts</span><span class="w"> </span><span class="nx">payload</span><span class="w"> </span><span class="nx">is</span><span class="w"> </span><span class="nx">AgentPayload</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-24-21"><a id="__codelineno-24-21" name="__codelineno-24-21"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">payload</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="ow">typeof</span><span class="w"> </span><span class="nx">payload</span><span class="w"> </span><span class="o">!==</span><span class="w"> </span><span class="s1">'object'</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-24-22"><a id="__codelineno-24-22" name="__codelineno-24-22"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">'Invalid payload'</span><span class="p">);</span>
|
|
</span><span id="__span-24-23"><a id="__codelineno-24-23" name="__codelineno-24-23"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-24-24"><a id="__codelineno-24-24" name="__codelineno-24-24"></a>
|
|
</span><span id="__span-24-25"><a id="__codelineno-24-25" name="__codelineno-24-25"></a><span class="w"> </span><span class="kd">const</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">agent_config</span><span class="p">,</span><span class="w"> </span><span class="nx">task</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">payload</span><span class="w"> </span><span class="kr">as</span><span class="w"> </span><span class="nx">Partial</span><span class="o"><</span><span class="nx">AgentPayload</span><span class="o">></span><span class="p">;</span>
|
|
</span><span id="__span-24-26"><a id="__codelineno-24-26" name="__codelineno-24-26"></a>
|
|
</span><span id="__span-24-27"><a id="__codelineno-24-27" name="__codelineno-24-27"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">agent_config</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="o">!</span><span class="nx">task</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
|
|
</span><span id="__span-24-28"><a id="__codelineno-24-28" name="__codelineno-24-28"></a><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">'Missing required fields'</span><span class="p">);</span>
|
|
</span><span id="__span-24-29"><a id="__codelineno-24-29" name="__codelineno-24-29"></a><span class="w"> </span><span class="p">}</span>
|
|
</span><span id="__span-24-30"><a id="__codelineno-24-30" name="__codelineno-24-30"></a><span class="p">}</span>
|
|
</span></code></pre></div></td></tr></table></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 id="connect-with-us">Connect With Us<a class="headerlink" href="#connect-with-us" title="Permanent link">¶</a></h2>
|
|
<p>Join our community of agent engineers and researchers for technical support, cutting-edge updates, and exclusive access to world-class agent engineering insights!</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Platform</th>
|
|
<th>Description</th>
|
|
<th>Link</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>📚 Documentation</td>
|
|
<td>Official documentation and guides</td>
|
|
<td><a href="https://docs.swarms.world">docs.swarms.world</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>📝 Blog</td>
|
|
<td>Latest updates and technical articles</td>
|
|
<td><a href="https://medium.com/@kyeg">Medium</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>💬 Discord</td>
|
|
<td>Live chat and community support</td>
|
|
<td><a href="https://discord.gg/jM3Z6M9uMq">Join Discord</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🐦 Twitter</td>
|
|
<td>Latest news and announcements</td>
|
|
<td><a href="https://twitter.com/kyegomez">@kyegomez</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>👥 LinkedIn</td>
|
|
<td>Professional network and updates</td>
|
|
<td><a href="https://www.linkedin.com/company/the-swarm-corporation">The Swarm Corporation</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>📺 YouTube</td>
|
|
<td>Tutorials and demos</td>
|
|
<td><a href="https://www.youtube.com/channel/UC9yXyitkbU_WSy7bd_41SqQ">Swarms Channel</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🎫 Events</td>
|
|
<td>Join our community events</td>
|
|
<td><a href="https://lu.ma/5p2jnc2v">Sign up here</a></td>
|
|
</tr>
|
|
<tr>
|
|
<td>🚀 Onboarding Session</td>
|
|
<td>Get onboarded with Kye Gomez, creator and lead maintainer of Swarms</td>
|
|
<td><a href="https://cal.com/swarms/swarms-onboarding-session">Book Session</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<aside class="md-source-file">
|
|
|
|
|
|
<span class="md-source-file__fact">
|
|
<span class="md-icon" title="Last update">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
|
|
</span>
|
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="July 26, 2025 08:54:38 UTC">July 26, 2025</span>
|
|
</span>
|
|
|
|
|
|
|
|
|
|
<span class="md-source-file__fact">
|
|
<span class="md-icon" title="Created">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3z"/></svg>
|
|
</span>
|
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date" title="July 26, 2025 08:54:38 UTC">July 26, 2025</span>
|
|
</span>
|
|
|
|
|
|
|
|
|
|
|
|
<span class="md-source-file__fact">
|
|
<span class="md-icon" title="Contributors">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 5.5A3.5 3.5 0 0 1 15.5 9a3.5 3.5 0 0 1-3.5 3.5A3.5 3.5 0 0 1 8.5 9 3.5 3.5 0 0 1 12 5.5M5 8c.56 0 1.08.15 1.53.42-.15 1.43.27 2.85 1.13 3.96C7.16 13.34 6.16 14 5 14a3 3 0 0 1-3-3 3 3 0 0 1 3-3m14 0a3 3 0 0 1 3 3 3 3 0 0 1-3 3c-1.16 0-2.16-.66-2.66-1.62a5.54 5.54 0 0 0 1.13-3.96c.45-.27.97-.42 1.53-.42M5.5 18.25c0-2.07 2.91-3.75 6.5-3.75s6.5 1.68 6.5 3.75V20h-13zM0 20v-1.5c0-1.39 1.89-2.56 4.45-2.9-.59.68-.95 1.62-.95 2.65V20zm24 0h-3.5v-1.75c0-1.03-.36-1.97-.95-2.65 2.56.34 4.45 1.51 4.45 2.9z"/></svg>
|
|
|
|
</span>
|
|
<nav>
|
|
|
|
</nav>
|
|
</span>
|
|
|
|
|
|
|
|
</aside>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</article>
|
|
</div>
|
|
|
|
|
|
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
</div>
|
|
|
|
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
|
Back to top
|
|
</button>
|
|
|
|
</main>
|
|
|
|
<footer class="md-footer">
|
|
<!-- Custom Footer Links Section -->
|
|
<div class="md-footer-custom">
|
|
<div class="md-footer-custom__inner md-grid">
|
|
<div class="md-footer-links">
|
|
|
|
<div class="md-footer-links__section">
|
|
<h4 class="md-footer-links__title">Getting Started</h4>
|
|
<ul class="md-footer-links__list">
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/install/install/" class="md-footer-links__link">
|
|
Installation
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/quickstart/" class="md-footer-links__link">
|
|
Quickstart
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/install/env/" class="md-footer-links__link">
|
|
Environment Setup
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/examples/basic_agent/" class="md-footer-links__link">
|
|
Basic Agent Example
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="md-footer-links__section">
|
|
<h4 class="md-footer-links__title">Core Capabilities</h4>
|
|
<ul class="md-footer-links__list">
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/structs/agent/" class="md-footer-links__link">
|
|
Agents
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/tools/tools_examples/" class="md-footer-links__link">
|
|
Tools and MCP
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/concept/swarm_architectures/" class="md-footer-links__link">
|
|
Multi-Agent Architectures
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/structs/sequential_workflow/" class="md-footer-links__link">
|
|
Sequential Workflow
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/structs/concurrentworkflow/" class="md-footer-links__link">
|
|
Concurrent Workflow
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/structs/hierarchical_swarm/" class="md-footer-links__link">
|
|
Hierarchical Swarm
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/structs/swarm_router/" class="md-footer-links__link">
|
|
Swarm Router
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="md-footer-links__section">
|
|
<h4 class="md-footer-links__title">Templates & Applications</h4>
|
|
<ul class="md-footer-links__list">
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/examples/index/" class="md-footer-links__link">
|
|
Examples Overview
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/examples/cookbook_index/" class="md-footer-links__link">
|
|
Cookbook
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/examples/templates/" class="md-footer-links__link">
|
|
Templates
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/examples/paper_implementations/" class="md-footer-links__link">
|
|
Paper Implementations
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="md-footer-links__section">
|
|
<h4 class="md-footer-links__title">Contributors</h4>
|
|
<ul class="md-footer-links__list">
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/contributors/main/" class="md-footer-links__link">
|
|
Contributing
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/framework/code_cleanliness/" class="md-footer-links__link">
|
|
Code Style Guide
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/contributors/docs/" class="md-footer-links__link">
|
|
Adding Documentation
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/corporate/bounty_program/" class="md-footer-links__link">
|
|
Bounty Program
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://docs.swarms.world/en/latest/swarms/support/" class="md-footer-links__link">
|
|
Support
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="md-footer-links__section">
|
|
<h4 class="md-footer-links__title">Community</h4>
|
|
<ul class="md-footer-links__list">
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://twitter.com/swarms_corp" class="md-footer-links__link">
|
|
Twitter
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://discord.gg/jM3Z6M9uMq" class="md-footer-links__link">
|
|
Discord
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://www.youtube.com/channel/UC9yXyitkbU_WSy7bd_41SqQ" class="md-footer-links__link">
|
|
YouTube
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://www.linkedin.com/company/the-swarm-corporation" class="md-footer-links__link">
|
|
LinkedIn
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://medium.com/@kyeg" class="md-footer-links__link">
|
|
Blog
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://lu.ma/5p2jnc2v" class="md-footer-links__link">
|
|
Events
|
|
</a>
|
|
</li>
|
|
|
|
<li class="md-footer-links__item">
|
|
<a href="https://cal.com/swarms/swarms-onboarding-session" class="md-footer-links__link">
|
|
Onboarding Session
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Company Information Section -->
|
|
<div class="md-footer-company">
|
|
<div class="md-footer-company__inner md-grid">
|
|
<div class="md-footer-company__content">
|
|
<div class="md-footer-company__brand">
|
|
<h3 class="md-footer-company__name">Swarms</h3>
|
|
<p class="md-footer-company__description">
|
|
Automating the world economy with multi-agent collaboration
|
|
</p>
|
|
</div>
|
|
<div class="md-footer-company__copyright">
|
|
<p>© 2024 Swarms. All rights reserved.</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Original Material Footer -->
|
|
|
|
<footer class="md-footer">
|
|
|
|
|
|
|
|
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
|
|
|
|
|
<a href="../swarms_api/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Overview">
|
|
<div class="md-footer__button md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
|
</div>
|
|
<div class="md-footer__title">
|
|
<span class="md-footer__direction">
|
|
Previous
|
|
</span>
|
|
<div class="md-ellipsis">
|
|
Overview
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="../mcp/" class="md-footer__link md-footer__link--next" aria-label="Next: MCP Server">
|
|
<div class="md-footer__title">
|
|
<span class="md-footer__direction">
|
|
Next
|
|
</span>
|
|
<div class="md-ellipsis">
|
|
MCP Server
|
|
</div>
|
|
</div>
|
|
<div class="md-footer__button md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-copyright">
|
|
|
|
<div class="md-copyright__highlight">
|
|
TGSC Corp 2024. All rights reserved.
|
|
</div>
|
|
|
|
|
|
Made with
|
|
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
Material for MkDocs
|
|
</a>
|
|
|
|
</div>
|
|
|
|
<div class="md-social">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://x.com/swarms_corp" target="_blank" rel="noopener" title="x.com" class="md-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/kyegomez/swarms" target="_blank" rel="noopener" title="github.com" class="md-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://discord.gg/jM3Z6M9uMq" target="_blank" rel="noopener" title="discord.gg" class="md-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M524.531 69.836a1.5 1.5 0 0 0-.764-.7A485 485 0 0 0 404.081 32.03a1.82 1.82 0 0 0-1.923.91 338 338 0 0 0-14.9 30.6 447.9 447.9 0 0 0-134.426 0 310 310 0 0 0-15.135-30.6 1.89 1.89 0 0 0-1.924-.91 483.7 483.7 0 0 0-119.688 37.107 1.7 1.7 0 0 0-.788.676C39.068 183.651 18.186 294.69 28.43 404.354a2.02 2.02 0 0 0 .765 1.375 487.7 487.7 0 0 0 146.825 74.189 1.9 1.9 0 0 0 2.063-.676A348 348 0 0 0 208.12 430.4a1.86 1.86 0 0 0-1.019-2.588 321 321 0 0 1-45.868-21.853 1.885 1.885 0 0 1-.185-3.126 251 251 0 0 0 9.109-7.137 1.82 1.82 0 0 1 1.9-.256c96.229 43.917 200.41 43.917 295.5 0a1.81 1.81 0 0 1 1.924.233 235 235 0 0 0 9.132 7.16 1.884 1.884 0 0 1-.162 3.126 301.4 301.4 0 0 1-45.89 21.83 1.875 1.875 0 0 0-1 2.611 391 391 0 0 0 30.014 48.815 1.86 1.86 0 0 0 2.063.7A486 486 0 0 0 610.7 405.729a1.88 1.88 0 0 0 .765-1.352c12.264-126.783-20.532-236.912-86.934-334.541M222.491 337.58c-28.972 0-52.844-26.587-52.844-59.239s23.409-59.241 52.844-59.241c29.665 0 53.306 26.82 52.843 59.239 0 32.654-23.41 59.241-52.843 59.241m195.38 0c-28.971 0-52.843-26.587-52.843-59.239s23.409-59.241 52.843-59.241c29.667 0 53.307 26.82 52.844 59.239 0 32.654-23.177 59.241-52.844 59.241"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://www.youtube.com/@kyegomez3242" target="_blank" rel="noopener" title="www.youtube.com" class="md-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M549.655 124.083c-6.281-23.65-24.787-42.276-48.284-48.597C458.781 64 288 64 288 64S117.22 64 74.629 75.486c-23.497 6.322-42.003 24.947-48.284 48.597-11.412 42.867-11.412 132.305-11.412 132.305s0 89.438 11.412 132.305c6.281 23.65 24.787 41.5 48.284 47.821C117.22 448 288 448 288 448s170.78 0 213.371-11.486c23.497-6.321 42.003-24.171 48.284-47.821 11.412-42.867 11.412-132.305 11.412-132.305s0-89.438-11.412-132.305m-317.51 213.508V175.185l142.739 81.205z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://www.linkedin.com/company/swarms-corp/" target="_blank" rel="noopener" title="www.linkedin.com" class="md-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3M135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5m282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9z"/></svg>
|
|
</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "content.code.annotate", "navigation.tabs", "navigation.sections", "navigation.top", "navigation.footer", "announce.dismiss"], "search": "../../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
|
|
|
|
|
<script src="../../assets/javascripts/bundle.56ea9cef.min.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |