agent-squad 1.0.0__tar.gz

agent_squad-1.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

agent_squad-1.0.0/PKG-INFO

@@ -0,0 +1,302 @@
+Metadata-Version: 2.4
+Name: agent_squad
+Version: 1.0.0
+Summary: Agent Squad framework
+Home-page: https://github.com/awslabs/agent-squad
+Author: Anthony Bernabeu, Corneliu Croitoru
+Author-email: brnaba@amazon.com, ccroito@amazon.com
+License: Apache License 2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: aws
+Requires-Dist: boto3>=1.36.18; extra == "aws"
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.40.0; extra == "anthropic"
+Provides-Extra: openai
+Requires-Dist: openai>=1.55.3; extra == "openai"
+Provides-Extra: sql
+Requires-Dist: libsql-client>=0.3.1; extra == "sql"
+Provides-Extra: all
+Requires-Dist: anthropic>=0.40.0; extra == "all"
+Requires-Dist: openai>=1.55.3; extra == "all"
+Requires-Dist: boto3>=1.36.18; extra == "all"
+Requires-Dist: libsql-client>=0.3.1; extra == "all"
+Dynamic: license-file
+
+<h2 align="center">Agent Squad&nbsp;</h2>
+
+<p align="center">Flexible and powerful framework for managing multiple AI agents and handling complex conversations.</p>
+
+
+<p align="center">
+  <a href="https://github.com/awslabs/agent-squad"><img alt="GitHub Repo" src="https://img.shields.io/badge/GitHub-Repo-green.svg" /></a>
+  <a href="https://pypi.org/project/agent-squad/"><img alt="PyPI" src="https://img.shields.io/pypi/v/agent-squad.svg?style=flat-square"></a>
+  <a href="https://awslabs.github.io/agent-squad/"><img alt="Documentation" src="https://img.shields.io/badge/docs-book-blue.svg?style=flat-square"></a>
+</p>
+
+<p align="center">
+  <!-- GitHub Stats -->
+  <img src="https://img.shields.io/github/stars/awslabs/agent-squad?style=social" alt="GitHub stars">
+  <img src="https://img.shields.io/github/forks/awslabs/agent-squad?style=social" alt="GitHub forks">
+  <img src="https://img.shields.io/github/watchers/awslabs/agent-squad?style=social" alt="GitHub watchers">
+</p>
+
+<p align="center">
+  <!-- Repository Info -->
+  <img src="https://img.shields.io/github/last-commit/awslabs/agent-squad" alt="Last Commit">
+  <img src="https://img.shields.io/github/issues/awslabs/agent-squad" alt="Issues">
+  <img src="https://img.shields.io/github/issues-pr/awslabs/agent-squad" alt="Pull Requests">
+</p>
+
+<p align="center">
+  <!-- Package Stats -->
+  <a href="https://pypi.org/project/agent-squad/"><img src="https://img.shields.io/pypi/dm/agent-squad?label=pypi%20downloads" alt="PyPI Monthly Downloads"></a>
+  <img src="https://img.shields.io/static/v1?label=python&message=%203.11|%203.12|%203.13&color=blue?style=flat-square&logo=python" alt="Python versions">
+
+</p>
+
+## 🔖 Features
+
+- 🧠 **Intelligent intent classification** — Dynamically route queries to the most suitable agent based on context and content.
+- 🌊 **Flexible agent responses** — Support for both streaming and non-streaming responses from different agents.
+- 📚 **Context management** — Maintain and utilize conversation context across multiple agents for coherent interactions.
+- 🔧 **Extensible architecture** — Easily integrate new agents or customize existing ones to fit your specific needs.
+- 🌐 **Universal deployment** — Run anywhere - from AWS Lambda to your local environment or any cloud platform.
+- 📦 **Pre-built agents and classifiers** — A variety of ready-to-use agents and multiple classifier implementations available.
+- 🔤 **TypeScript support** — Native TypeScript implementation available.
+
+## What's the Agent Squad ❓
+
+The Agent Squad is a flexible framework for managing multiple AI agents and handling complex conversations. It intelligently routes queries and maintains context across interactions.
+
+The system offers pre-built components for quick deployment, while also allowing easy integration of custom agents and conversation messages storage solutions.
+
+This adaptability makes it suitable for a wide range of applications, from simple chatbots to sophisticated AI systems, accommodating diverse requirements and scaling efficiently.
+
+
+## 🏗️ High-level architecture flow diagram
+
+<br /><br />
+
+![High-level architecture flow diagram](https://raw.githubusercontent.com/awslabs/agent-squad/main/img/flow.jpg)
+
+<br /><br />
+
+
+1. The process begins with user input, which is analyzed by a Classifier.
+2. The Classifier leverages both Agents' Characteristics and Agents' Conversation history to select the most appropriate agent for the task.
+3. Once an agent is selected, it processes the user input.
+4. The orchestrator then saves the conversation, updating the Agents' Conversation history, before delivering the response back to the user.
+
+
+## 💬 Demo App
+
+To quickly get a feel for the Agent Squad, we've provided a Demo App with a few basic agents. This interactive demo showcases the orchestrator's capabilities in a user-friendly interface. To learn more about setting up and running the demo app, please refer to our [Demo App](https://awslabs.github.io/agent-squad/cookbook/examples/chat-demo-app/) section.
+
+<br>
+
+In the screen recording below, we demonstrate an extended version of the demo app that uses 6 specialized agents:
+- **Travel Agent**: Powered by an Amazon Lex Bot
+- **Weather Agent**: Utilizes a Bedrock LLM Agent with a tool to query the open-meteo API
+- **Restaurant Agent**: Implemented as an Amazon Bedrock Agent
+- **Math Agent**: Utilizes a Bedrock LLM Agent with two tools for executing mathematical operations
+- **Tech Agent**: A Bedrock LLM Agent designed to answer questions on technical topics
+- **Health Agent**: A Bedrock LLM Agent focused on addressing health-related queries
+
+Watch as the system seamlessly switches context between diverse topics, from booking flights to checking weather, solving math problems, and providing health information.
+Notice how the appropriate agent is selected for each query, maintaining coherence even with brief follow-up inputs.
+
+The demo highlights the system's ability to handle complex, multi-turn conversations while preserving context and leveraging specialized agents across various domains.
+
+Click on the image below to see a screen recording of the demo app on the GitHub repository of the project:
+<a href="https://github.com/awslabs/agent-squad" target="_blank">
+  <img src="https://raw.githubusercontent.com/awslabs/agent-squad/main/img/demo-app.jpg" alt="Demo App Screen Recording" style="max-width: 100%; height: auto;">
+</a>
+
+
+
+## 🚀 Getting Started
+
+Check out our [documentation](https://awslabs.github.io/agent-squad/) for comprehensive guides on setting up and using the Agent Squad!
+
+
+
+### Core Installation
+
+```bash
+# Optional: Set up a virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows use `venv\Scripts\activate`
+pip install agent-squad[aws]
+```
+
+#### Default Usage
+
+Here's an equivalent Python example demonstrating the use of the Agent Squad with a Bedrock LLM Agent and a Lex Bot Agent:
+
+```python
+import sys
+import asyncio
+from agent_squad.orchestrator import AgentSquad
+from agent_squad.agents import BedrockLLMAgent, LexBotAgent, BedrockLLMAgentOptions, LexBotAgentOptions, AgentStreamResponse
+
+orchestrator = AgentSquad()
+
+tech_agent = BedrockLLMAgent(BedrockLLMAgentOptions(
+  name="Tech Agent",
+  streaming=True,
+  description="Specializes in technology areas including software development, hardware, AI, \
+  cybersecurity, blockchain, cloud computing, emerging tech innovations, and pricing/costs \
+  related to technology products and services.",
+  model_id="anthropic.claude-3-sonnet-20240229-v1:0",
+))
+orchestrator.add_agent(tech_agent)
+
+
+health_agent = BedrockLLMAgent(BedrockLLMAgentOptions(
+  name="Health Agent",
+  streaming=True,
+  description="Specializes in health and well being",
+))
+orchestrator.add_agent(health_agent)
+
+async def main():
+    # Example usage
+    response = await orchestrator.route_request(
+        "What is AWS Lambda?",
+        'user123',
+        'session456',
+        {},
+        True
+    )
+
+    # Handle the response (streaming or non-streaming)
+    if response.streaming:
+        print("\n** RESPONSE STREAMING ** \n")
+        # Send metadata immediately
+        print(f"> Agent ID: {response.metadata.agent_id}")
+        print(f"> Agent Name: {response.metadata.agent_name}")
+        print(f"> User Input: {response.metadata.user_input}")
+        print(f"> User ID: {response.metadata.user_id}")
+        print(f"> Session ID: {response.metadata.session_id}")
+        print(f"> Additional Parameters: {response.metadata.additional_params}")
+        print("\n> Response: ")
+
+        # Stream the content
+        async for chunk in response.output:
+            async for chunk in response.output:
+              if isinstance(chunk, AgentStreamResponse):
+                  print(chunk.text, end='', flush=True)
+              else:
+                  print(f"Received unexpected chunk type: {type(chunk)}", file=sys.stderr)
+
+    else:
+        # Handle non-streaming response (AgentProcessingResult)
+        print("\n** RESPONSE ** \n")
+        print(f"> Agent ID: {response.metadata.agent_id}")
+        print(f"> Agent Name: {response.metadata.agent_name}")
+        print(f"> User Input: {response.metadata.user_input}")
+        print(f"> User ID: {response.metadata.user_id}")
+        print(f"> Session ID: {response.metadata.session_id}")
+        print(f"> Additional Parameters: {response.metadata.additional_params}")
+        print(f"\n> Response: {response.output.content}")
+
+if __name__ == "__main__":
+  asyncio.run(main())
+```
+
+The following example demonstrates how to use the Agent Squad with two different types of agents: a Bedrock LLM Agent with Converse API support and a Lex Bot Agent. This showcases the flexibility of the system in integrating various AI services.
+
+```python
+
+```
+
+This example showcases:
+1. The use of a Bedrock LLM Agent with Converse API support, allowing for multi-turn conversations.
+2. Integration of a Lex Bot Agent for specialized tasks (in this case, travel-related queries).
+3. The orchestrator's ability to route requests to the most appropriate agent based on the input.
+4. Handling of both streaming and non-streaming responses from different types of agents.
+
+
+### Working with Anthropic or OpenAI
+If you want to use Anthropic or OpenAI for classifier and/or agents, make sure to install the agent-squad with the relevant extra feature.
+```bash
+pip install "agent-squad[anthropic]"
+pip install "agent-squad[openai]"
+```
+
+### Full package installation
+For a complete installation (including Anthropic and OpenAi):
+```bash
+pip install agent-squad[all]
+```
+
+## Building Locally
+
+This guide explains how to build and install the agent-squad package from source code.
+
+### Prerequisites
+
+- Python 3.11
+- pip package manager
+- Git (to clone the repository)
+
+### Building the Package
+
+1. Navigate to the Python package directory:
+   ```bash
+   cd python
+   ```
+
+2. Install the build dependencies:
+   ```bash
+   python -m pip install build
+   ```
+
+3. Build the package:
+   ```bash
+   python -m build
+   ```
+
+This process will create distribution files in the `python/dist` directory, including a wheel (`.whl`) file.
+
+### Installation
+
+1. Locate the current version number in `setup.cfg`.
+
+2. Install the built package using pip:
+   ```bash
+   pip install ./dist/agent_squad-<VERSION>-py3-none-any.whl
+   ```
+   Replace `<VERSION>` with the version number from `setup.cfg`.
+
+### Example
+
+If the version in `setup.cfg` is `1.2.3`, the installation command would be:
+```bash
+pip install ./dist/agent_squad-1.2.3-py3-none-any.whl
+```
+
+### Troubleshooting
+
+- If you encounter permission errors during installation, you may need to use `sudo` or activate a virtual environment.
+- Make sure you're in the correct directory when running the build and install commands.
+- Clean the `dist` directory before rebuilding if you encounter issues: `rm -rf python/dist/*`
+
+
+
+## 🤝 Contributing
+
+We welcome contributions! Please see our [Contributing Guide](https://raw.githubusercontent.com/awslabs/agent-squad/main/CONTRIBUTING.md) for more details.
+
+## 📄 LICENSE
+
+This project is licensed under the Apache 2.0 licence - see the [LICENSE](https://raw.githubusercontent.com/awslabs/agent-squad/main/LICENSE) file for details.
+
+## 📄 Font License
+This project uses the JetBrainsMono NF font, licensed under the SIL Open Font License 1.1.
+For full license details, see [FONT-LICENSE.md](https://github.com/JetBrains/JetBrainsMono/blob/master/OFL.txt).