docs: 📝 New documentation added

Author: Eashan Kaushik

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -30,7 +30,7 @@
 
 * [ ] Have you included your Agent Example name in [README.md](https://github.com/aws-samples/bedrock-multi-agents-collaboration-workshop)?
 * [ ] Have you included your Agent Example introduction in [README.md](https://github.com/aws-samples/bedrock-multi-agents-collaboration-workshop/tree/main/src/examples)
-* [ ] Have you included Introduction, Architecture Diagram, Sample Prompts, and Clean Up steps?
+* [ ] Have you included Introduction, Architecture Diagram, Prerequisites, Usage, Sample Prompts, and Clean Up steps?
 * [ ] Have you appened `_agent` to the new folder name in `src/examples`?
 * [ ] I agree to resolve any [issues](https://github.com/aws-samples/bedrock-multi-agents-collaboration-workshop/issues) created for this example. 
 

.gitignore

@@ -14,3 +14,4 @@ aws-lambda-developer-guide/
 # local copies
 agent-old.py
 knowledge_bases-old.py
+*.pptx

src/examples/00_hello_world_agent/README.md

@@ -0,0 +1,15 @@
+# Hello World Agent
+
+## Introduction
+
+## Architecture Diagram
+
+## Prerequisites
+
+## Usage & Sample Prompts
+
+## Clean Up
+
+## License
+
+This library is licensed under the MIT-0 License. See the LICENSE file.

src/examples/devops_agent/README.md

@@ -0,0 +1,11 @@
+# Devops Agent
+
+## Introduction
+
+## Architecture Diagram
+
+## Usage & Sample Prompts
+
+## License
+
+This library is licensed under the MIT-0 License. See the LICENSE file.

src/examples/portfolio_assistant_agent/README.md

@@ -0,0 +1,15 @@
+# Portfolio Assistant Agent
+
+## Introduction
+
+## Architecture Diagram
+
+## Prerequisites
+
+## Usage & Sample Prompts
+
+## Clean Up
+
+## License
+
+This library is licensed under the MIT-0 License. See the LICENSE file.

src/examples/startup_advisor_agent/README.md

@@ -0,0 +1,15 @@
+# Startup Advisor Agent
+
+## Introduction
+
+## Architecture Diagram
+
+## Prerequisites
+
+## Usage & Sample Prompts
+
+## Clean Up
+
+## License
+
+This library is licensed under the MIT-0 License. See the LICENSE file.

src/examples/team_poems_agent/README.md

@@ -0,0 +1,15 @@
+# Sports Team Poet Agent
+
+## Introduction
+
+## Architecture Diagram
+
+## Prerequisites
+
+## Usage & Sample Prompts
+
+## Clean Up
+
+## License
+
+This library is licensed under the MIT-0 License. See the LICENSE file.

src/examples/trip_planner_agent/README.md

@@ -0,0 +1,15 @@
+# Trip Planner Agent
+
+## Introduction
+
+## Architecture Diagram
+
+## Prerequisites
+
+## Usage & Sample Prompts
+
+## Clean Up
+
+## License
+
+This library is licensed under the MIT-0 License. See the LICENSE file.

src/examples/voyage_virtuoso_agent/README.md

@@ -0,0 +1,15 @@
+# Voyage Vituoso Agent
+
+## Introduction
+
+## Architecture Diagram
+
+## Prerequisites
+
+## Usage & Sample Prompts
+
+## Clean Up
+
+## License
+
+This library is licensed under the MIT-0 License. See the LICENSE file.

src/shared/web_search/cfn_stacks/web_search_stack.yaml

@@ -13,12 +13,16 @@ Parameters:
   SerperApiKey:
     Type: String
     NoEcho: true
-    Description: API Key for Serper service
+    Description: Provide SerperApiKey API Key to utilize /google_search path
 
   TavilyApiKey:
     Type: String
     NoEcho: true
-    Description: API Key for Tavily service
+    Description: Provide TavilyApiKey API Key to utilize /web_search or /travily_ai_search path
+
+Conditions:
+  HasSerperApiKey: !Not [!Equals [!Ref SerperApiKey, '']]
+  HasTavilyApiKey: !Not [!Equals [!Ref TavilyApiKey, '']]
 
 Resources:
   #####################
@@ -27,13 +31,15 @@ Resources:
 
   SerperApiKeySecret:
     Type: 'AWS::SecretsManager::Secret'
+    Condition: HasSerperApiKey
     Properties:
       Name: 'SERPER_API_KEY'
       Description: 'API Key for Serper service'
       SecretString: !Ref SerperApiKey
 
   TavilyApiKeySecret:
     Type: 'AWS::SecretsManager::Secret'
+    Condition: HasTavilyApiKey
     Properties:
       Name: 'TAVILY_API_KEY'
       Description: 'API Key for Tavily service'
@@ -73,11 +79,6 @@ Resources:
           logger = logging.getLogger(__name__)
           logger.setLevel(log_level)
 
-          # AWS_REGION = os.environ.get("AWS_REGION", "us-east-1")
-          # ACTION_GROUP_NAME = os.environ.get("ACTION_GROUP", "action-group-web-search-d213q")
-          FUNCTION_NAMES = ["tavily-ai-search", "google-search", "web_search"]
-
-
           def is_env_var_set(env_var: str) -> bool:
               return env_var in os.environ and os.environ[env_var] not in ("", "0", "false", "False")
 
@@ -99,20 +100,22 @@ Resources:
 
               return secret
 
+          FUNCTION_NAMES = ["tavily_ai_search", "google_search", "web_search"]
 
-          SERPER_API_KEY = get_from_secretstore_or_env("SERPER_API_KEY")
-          TAVILY_API_KEY = get_from_secretstore_or_env("TAVILY_API_KEY")
+          try:
+            SERPER_API_KEY = get_from_secretstore_or_env("SERPER_API_KEY")
+            FUNCTION_NAMES.append("google_search")
+          except Exception as e:
+            SERPER_API_KEY = None
 
+          try:
+            TAVILY_API_KEY = get_from_secretstore_or_env("TAVILY_API_KEY")
+            FUNCTION_NAMES.append("tavily_ai_search", "web_search")
+          except Exception as e:
+            TAVILY_API_KEY = None
 
           def extract_search_params(action_group, function, parameters):
-              # if action_group != ACTION_GROUP_NAME:
-              #     logger.error(f"unexpected name '{action_group}'; expected valid action group name '{ACTION_GROUP_NAME}'")
-              #     return None, None
-
-              if function not in FUNCTION_NAMES:
-                  logger.error(f"unexpected function name '{function}'; valid function names are'{FUNCTION_NAMES}'")
-                  return None, None
-
+          
               search_query = next(
                   (param["value"] for param in parameters if param["name"] == "search_query"),
                   None,
@@ -133,7 +136,7 @@ Resources:
                   None,
               )
 
-              logger.debug(f"extract_search_params: {search_query=} {target_website=}")
+              logger.debug(f"extract_search_params: {search_query=} {target_website=} {topic=} {days=}")
 
               return search_query, target_website, topic, days
 
@@ -199,6 +202,9 @@ Resources:
 
               logger.info(f"lambda_handler: {action_group=} {function=}")
 
+              if function not in FUNCTION_NAMES:
+                  raise
+
               search_query, target_website, topic, days = extract_search_params(action_group, function, parameters)
 
               search_results: str = ""

src/utils/README.md

@@ -10,7 +10,7 @@ This module contains utilities for building and using various Amazon Bedrock fea
 - [Utilize yaml files to define Agents and Tasks](#utilize-yaml-files-to-define-agents-and-tasks)
 - [Associate shared tools with Amazon Bedrock Agents](#associate-shared-tools-with-amazon-bedrock-agents)
 
-### Create and Manage Amazon Bedrock Agents
+## Create and Manage Amazon Bedrock Agents
 
 This module contains a helper class for building and using Agents for Amazon Bedrock. The AgentsForAmazonBedrock class provides a convenient interface for working with Agents.It includes methods for creating, updating, and invoking Agents, as well as managing IAM roles and Lambda functions for action groups. Here is a quick example of using
 the classs:
@@ -50,7 +50,7 @@ Here is a summary of the most important methods:
 - add_action_group_with_lambda: Creates a new Action Group for an Agent, backed by Lambda.
 - simple_invoke_agent: Invokes an Agent with a given input.
 
-### Create and Manage Amazon Bedrock KnowledgeBase
+## Create and Manage Amazon Bedrock KnowledgeBase
 
 This module contains a helper class for building and using Knowledge Bases for Amazon Bedrock. The KnowledgeBasesForAmazonBedrock class provides a convenient interface for working with Knowledge Bases. It includes methods for creating, updating, and invoking Knowledge Bases, as well as managing IAM roles and OpenSearch Serverless. Here is a quick example of using the class:
 
@@ -75,7 +75,7 @@ Here is a summary of the most important methods:
 - create_or_retrieve_knowledge_base: Creates a new Knowledge Base or retrieves an existent one.
 - synchronize_data: Syncronize the Knowledge Base with the
 
-### Create and Manage Amazon Bedrock Multi-Agent Collaboration
+## Create and Manage Amazon Bedrock Multi-Agent Collaboration
 
 Check out `Hello World` example [here](/src/examples/00_hello_world_agent/).
 
@@ -104,13 +104,13 @@ hello_world_supervisor = SupervisorAgent.direct_create(
 )
 ```
 
-### Utilize yaml files to define Agents and Tasks
+## Utilize yaml files to define Agents and Tasks
 
 Few examples to utilize yaml files to define Agents and Tasks can be found here:
 
 - **[Sports Team Poet Agent](/src/examples/team_poems_agent/)** This is a fun example for sports fans. The Sports Team Poet is a supervisor with a Research Agent and a Sports Poetry Writer. Pick your favorite team (go Celtics!) and see multi-agents collaborate to conduct web research about your team and make a fun poem with those insights. Have fun!
 - **[Trip Planner Agent](/src/examples/trip_planner_agent/)** The Trip Planner uses a few sub-agents to help you build a robust itinerary given a destination and number of days. It leverages a Restaurant Scout and an Activity Finder to get great ideas, and an Intinerary Compiler to finish the job. Try it out for your next trip.
 
-### Associate shared tools with Amazon Bedrock Agents
+## Associate shared tools with Amazon Bedrock Agents
 
 For guidance follow instruction for individual tools [here](/src/shared/).