Quickstart

Quickstart Guide for Multi-Agent Orchestrator

To help you kickstart with the Multi-Agent Orchestrator framework, we’ll walk you through the step-by-step process of setting up and running your first multi-agent conversation.

💁 Ensure you have Node.js and npm installed (for TypeScript) or Python installed (for Python) on your development environment before proceeding.

Prerequisites

1. Create a new project:

TypeScript

mkdir test_multi_agent_orchestrator
cd test_multi_agent_orchestrator
npm init

Follow the steps to generate a package.json file.

Python

mkdir test_multi_agent_orchestrator
cd test_multi_agent_orchestrator
# Optional: Set up a virtual environment
python -m venv venv
source venv/bin/activate  # On Windows use `venv\Scripts\activate`

2. Authenticate with your AWS account

This quickstart demonstrates the use of Amazon Bedrock for both classification and agent responses.

To authenticate with your AWS account, follow these steps:

a. Install the AWS CLI if you haven’t already. You can download it from the official AWS CLI page.

b. Configure your AWS CLI with your credentials. For detailed instructions on how to set up your AWS CLI, please refer to the AWS CLI Configuration Quickstart Guide.

c. After configuring your AWS CLI, verify your authentication by running:

aws sts get-caller-identity

If successful, this command will return your AWS account ID, user ID, and ARN.

By default, the framework is configured as follows:

• Classifier: Uses the Bedrock Classifier implementation with anthropic.claude-3-5-sonnet-20240620-v1:0
• Agent: Utilizes the Bedrock LLM Agent with anthropic.claude-3-haiku-20240307-v1:0

Important

These are merely default settings and can be easily changed to suit your needs or preferences.

You have the flexibility to:

• Change the classifier model or implementation
• Change the agent model or implementation
• Use any other compatible models available through Amazon Bedrock

Ensure you have requested access to the models you intend to use through the AWS console.

To customize the model selection:

• For the classifier, refer to our guide on configuring the classifier.
• For the agent, refer to our guide on configuring agents.

🚀 Get Started!

1. Install the Multi-Agent Orchestrator framework in your project:

TypeScript

npm install multi-agent-orchestrator

Python

pip install multi-agent-orchestrator

2. Create a new file for your quickstart code:

TypeScript

Create a file named quickstart.ts.

Python

Create a file named quickstart.py.

3. Create an Orchestrator:

TypeScript

import { MultiAgentOrchestrator } from "multi-agent-orchestrator";
const orchestrator = new MultiAgentOrchestrator({
  config: {
    LOG_AGENT_CHAT: true,
    LOG_CLASSIFIER_CHAT: true,
    LOG_CLASSIFIER_RAW_OUTPUT: false,
    LOG_CLASSIFIER_OUTPUT: true,
    LOG_EXECUTION_TIMES: true,
  }
});

Python

import uuid
import asyncio
from typing import Optional, List, Dict, Any
import json
import sys
from multi_agent_orchestrator.orchestrator import MultiAgentOrchestrator, OrchestratorConfig
from multi_agent_orchestrator.agents import (BedrockLLMAgent,
 BedrockLLMAgentOptions,
 AgentResponse,
 AgentCallbacks)
from multi_agent_orchestrator.types import ConversationMessage, ParticipantRole

orchestrator = MultiAgentOrchestrator(options=OrchestratorConfig(
  LOG_AGENT_CHAT=True,
  LOG_CLASSIFIER_CHAT=True,
  LOG_CLASSIFIER_RAW_OUTPUT=True,
  LOG_CLASSIFIER_OUTPUT=True,
  LOG_EXECUTION_TIMES=True,
  MAX_RETRIES=3,
  USE_DEFAULT_AGENT_IF_NONE_IDENTIFIED=True,
  MAX_MESSAGE_PAIRS_PER_AGENT=10
))

4. Add Agents:

TypeScript

import { BedrockLLMAgent } from "multi-agent-orchestrator";
orchestrator.addAgent(
  new BedrockLLMAgent({
    name: "Tech Agent",
    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.",
    streaming: true
  })
);

orchestrator.addAgent(
  new BedrockLLMAgent({
    name: "Health Agent",
    description: "Focuses on health and medical topics such as general wellness, nutrition, diseases, treatments, mental health, fitness, healthcare systems, and medical terminology or concepts.",
  })
);

Python

class BedrockLLMAgentCallbacks(AgentCallbacks):
    def on_llm_new_token(self, token: str) -> None:
        # handle response streaming here
        print(token, end='', flush=True)

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",
  callbacks=BedrockLLMAgentCallbacks()
))
orchestrator.add_agent(tech_agent)

5. Send a Query:

TypeScript

const userId = "quickstart-user";
const sessionId = "quickstart-session";
const query = "What are the latest trends in AI?";
console.log(`\nUser Query: ${query}`);

async function main() {
  try {
    const response = await orchestrator.routeRequest(query, userId, sessionId);
    console.log("\n** RESPONSE ** \n");
    console.log(`> Agent ID: ${response.metadata.agentId}`);
    console.log(`> Agent Name: ${response.metadata.agentName}`);
    console.log(`> User Input: ${response.metadata.userInput}`);
    console.log(`> User ID: ${response.metadata.userId}`);
    console.log(`> Session ID: ${response.metadata.sessionId}`);
    console.log(
      `> Additional Parameters:`,
      response.metadata.additionalParams
    );
    console.log(`\n> Response: `);
    // Stream the content
    for await (const chunk of response.output) {
      if (typeof chunk === "string") {
        process.stdout.write(chunk);
      } else {
        console.error("Received unexpected chunk type:", typeof chunk);
      }
    }
    console.log();
  } catch (error) {
    console.error("An error occurred:", error);
    // Here you could also add more specific error handling if needed
  }
}

main();

Python

async def handle_request(_orchestrator: MultiAgentOrchestrator, _user_input: str, _user_id: str, _session_id: str):
    response: AgentResponse = await _orchestrator.route_request(_user_input, _user_id, _session_id)
    # Print metadata
    print("\nMetadata:")
    print(f"Selected Agent: {response.metadata.agent_name}")
    if response.streaming:
        print('Response:', response.output.content[0]['text'])
    else:
        print('Response:', response.output.content[0]['text'])

if __name__ == "__main__":
    USER_ID = "user123"
    SESSION_ID = str(uuid.uuid4())
    print("Welcome to the interactive Multi-Agent system. Type 'quit' to exit.")
    while True:
        # Get user input
        user_input = input("\nYou: ").strip()
        if user_input.lower() == 'quit':
            print("Exiting the program. Goodbye!")
            sys.exit()
        # Run the async function
        asyncio.run(handle_request(orchestrator, user_input, USER_ID, SESSION_ID))

Now, let’s run the quickstart script:

TypeScript

npx ts-node quickstart.ts

Python

python quickstart.py

Congratulations! 🎉 You’ve successfully set up and run your first multi-agent conversation using the Multi-Agent Orchestrator System.

👨‍💻 Next Steps

Now that you’ve seen the basic functionality, here are some next steps to explore:

1. Try adding other agents from those built-in in the framework (Bedrock LLM Agent, Amazon Lex Bot, Amazon Bedrock Agent, Lambda Agent, OpenAI Agent).
2. Experiment with different storage options, such as Amazon DynamoDB for persistent storage.
3. Explore the Agent Overlap Analysis feature to optimize your agent configurations.
4. Integrate the system into a web application or deploy it as an AWS Lambda function.
5. Try adding your own custom agents by extending the Agent class.

For more detailed information on these advanced features, check out our full documentation.

🧹 Cleanup

As this quickstart uses in-memory storage and local resources, there’s no cleanup required. Simply stop the script when you’re done experimenting.