Skip to content

Commit

Permalink
Minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
bonk1t committed Nov 20, 2024
1 parent 3fbc701 commit 1160ca0
Show file tree
Hide file tree
Showing 9 changed files with 138 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs_new/advanced-topics/advanced-communication-flows.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Advanced Communication Flows"
description: "Learn how to customize communication flows for your agency."
icon: "message"
icon: "comments"
---

Multi-agent communication is the core functionality of any Multi-Agent System. Unlike in all other frameworks, Agency Swarm not only allows you to define communication flows in any way you want (uniform communication flows), but to also configure the underlying logic for this feature. This means that you can create entirely new types of communication, or adjust it to your own needs. Below you will find a guide on how to do all this, along with some common examples.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Customizing Prompts and Few-Shot Learning"
description: "Fine-tune agent behavior by customizing prompts and providing few-shot examples."
icon: "magic"
icon: "gear"
---

Fine-tune agent behavior by customizing prompts and providing few-shot examples.
Expand Down
18 changes: 7 additions & 11 deletions docs_new/advanced-topics/production-readiness.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Production Readiness"
description: "Prepare your agency for production by enhancing reliability, scalability, and security."
icon: "check-circle-o"
icon: "check"
---

<Info>
Expand All @@ -10,30 +10,30 @@ Ensuring your agency is production-ready involves careful planning and implement

## Key Considerations

<AccordionGroup>
<AccordionGroup defaultOpen={true}>

<Accordion title="Robust Error Handling" icon="bug" iconType="solid">
<Accordion title="Robust Error Handling" icon="bug" iconType="solid" defaultOpen={true}>
Implement comprehensive error handling within agents and tools to gracefully handle unexpected issues.

<Tip>
Use try-except blocks and logging to capture and manage exceptions.
</Tip>
</Accordion>

<Accordion title="Security Measures" icon="shield-alt" iconType="solid">
<Accordion title="Security Measures" icon="shield" iconType="solid" defaultOpen={true}>
Secure API keys, enforce access controls, and sanitize inputs to protect against vulnerabilities.

<Warning>
Never hard-code API keys or sensitive information in your code.
</Warning>
</Accordion>

<Accordion title="Monitoring and Logging" icon="eye" iconType="solid">
<Accordion title="Monitoring and Logging" icon="eye" iconType="solid" defaultOpen={true}>
Use monitoring tools to track performance and detect anomalies. Maintain logs for auditing and debugging.

</Accordion>

<Accordion title="Scalability" icon="arrows-alt" iconType="solid">
<Accordion title="Scalability" icon="arrows" iconType="solid" defaultOpen={true}>
Design for horizontal scaling to handle increased loads efficiently.

<Tip>
Expand All @@ -46,11 +46,7 @@ Consider using cloud services that support auto-scaling features.
## Best Practices

<Check>

- **Testing**: Thoroughly test agents and tools under various conditions, including edge cases.

- **Documentation**: Maintain clear documentation for maintenance and onboarding of new team members.

- **Continuous Integration/Continuous Deployment (CI/CD)**: Set up pipelines for automated testing and deployment to streamline updates.

</Check>
</Check>
39 changes: 39 additions & 0 deletions docs_new/extras/extras.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Agency Swarm Extras
description: Additional resources and repositories for Agency Swarm.
icon: plus-circle
---

Explore additional repositories to enhance your Agency Swarm experience.

<CardGroup cols={3}>
<Card
title="Agency Swarm Lab"
color="#F3A78B"
href="https://github.com/VRSEN/agency-swarm-lab"
icon="flask"
iconType="duotone"
>
Experiment with the latest features in Agency Swarm Lab.
</Card>

<Card
title="API Railway Template"
color="#F3A78B"
href="https://github.com/VRSEN/agency-swarm-api-railway-template"
icon="train"
iconType="duotone"
>
Deploy your agency using the API Railway Template.
</Card>

<Card
title="Voice Interface"
color="#F3A78B"
href="https://github.com/VRSEN/agency-voice-interface"
icon="microphone"
iconType="duotone"
>
Integrate voice commands with the Agency Voice Interface.
</Card>
</CardGroup>
6 changes: 3 additions & 3 deletions docs_new/faq/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ icon: "question"

Find answers to common questions about Agency Swarm.

<AccordionGroup>
<AccordionGroup defaultOpen={true}>

<Accordion title="What is Agency Swarm?" icon="question-circle" iconType="solid">
<Accordion title="What is Agency Swarm?" icon="bee" iconType="solid">
**A**: Agency Swarm is an open-source framework designed to facilitate the creation and orchestration of multi-agent AI systems.
</Accordion>

Expand All @@ -22,7 +22,7 @@ pip install agency-swarm
</CodeBlock>
</Accordion>

<Accordion title="Can I use custom models with Agency Swarm?" icon="cogs" iconType="solid">
<Accordion title="Can I use custom models with Agency Swarm?" icon="gear" iconType="solid">
**A**: Yes, you can integrate open-source models or custom language models that mimic the OpenAI Assistants API.
</Accordion>

Expand Down
2 changes: 1 addition & 1 deletion docs_new/framework-overview/communication-flows.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Communication Flows"
description: "Learn how to define communication flows for your agency."
icon: "message"
icon: "comments"
---

Communication flows in Agency Swarm are flexible and user-defined. Unlike other frameworks, they are **not strictly hierarchical** or **sequential**. Communication permissions are established from left to right inside the `agency_chart`.
Expand Down
2 changes: 1 addition & 1 deletion docs_new/how-to-guides/managing-communication-flows.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Managing Communication Flows"
description: "Learn how to define custom communication flows for your agency."
icon: "message"
icon: "comments"
---

Effective communication between agents is essential for collaboration. Agency Swarm allows you to define custom communication flows.
Expand Down
20 changes: 18 additions & 2 deletions docs_new/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,12 @@
},
"tabs": [
{
"name": "Examples",
"url": "examples"
"name": "Tutorials",
"url": "tutorials"
},
{
"name": "Extras",
"url": "extras"
}
],
"anchors": [
Expand Down Expand Up @@ -123,6 +127,18 @@
"pages": [
"faq/faq"
]
},
{
"group": "Tutorials",
"pages": [
"tutorials/tutorials"
]
},
{
"group": "Extras",
"pages": [
"extras/extras"
]
}
],
"search": {
Expand Down
67 changes: 67 additions & 0 deletions docs_new/tutorials/tutorials.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: "Agency Swarm Tutorials"
description: "A collection of tutorials showing how to use the Agency Swarm framework to automate workflows."
icon: "rocket-launch"
---

<CardGroup cols={3}>
<Card
title="Getting Started with Agency Swarm"
color="#F3A78B"
href="https://www.youtube.com/watch?v=53_e3lmk6Mo"
icon="play-circle"
iconType="solid"
>
This video provides a practical guide to deploying AI agents in production using a free deployment template. It covers cloud, serverless, and hybrid options.
</Card>

<Card
title="How to Build AI Agents in Plain English (Cursor Template)"
color="#F3A78B"
href="https://www.youtube.com/watch?v=Og73plUTabs"
icon="arrows-left-right"
iconType="duotone"
>
Learn to create AI agent teams using a Cursor template. This tutorial walks you through building a content creation agency with step-by-step instructions.
</Card>

<Card
title="Customizing Agent Prompts"
color="#F3A78B"
href="https://www.youtube.com/watch?v=AZlPelcATHo"
icon="edit"
iconType="duotone"
>
Explore advanced techniques in the Agency Swarm framework, including asynchronous modes, parallel tool calling, and open API schema conversion.
</Card>

<Card
title="Deploying to Production"
color="#F3A78B"
href="https://www.youtube.com/watch?v=hb0j9Qn-KjM"
icon="server"
iconType="duotone"
>
Guide on deploying your agency to a production environment.
</Card>

<Card
title="Managing Communication Flows"
color="#F3A78B"
href="https://www.youtube.com/watch?v=Vd-Gtfm_zjw"
icon="comments"
iconType="duotone"
>
Strategies for managing agent communication flows.
</Card>

<Card
title="Advanced Topics in Agency Swarm"
color="#F3A78B"
href="https://www.youtube.com/watch?v=MOyl58VF2ak"
icon="lightbulb"
iconType="duotone"
>
Explore advanced features and best practices.
</Card>
</CardGroup>

0 comments on commit 1160ca0

Please sign in to comment.