+
Solution overview
The solution leverages Azure OpenAI Service, Azure Container Apps, Azure Cosmos DB, and Azure Container Registry to create an intelligent automation pipeline. It uses a multi-agent approach where specialized AI agents work together to plan, execute, and validate tasks based on user input.
### Solution architecture
-||
+||
|---|
@@ -30,7 +30,7 @@ The solution leverages Azure OpenAI Service, Azure Container Apps, Azure Cosmos
### How to customize
If you'd like to customize the solution accelerator, here are some common areas to start:
-[Custom scenario](./documentation/CustomizeSolution.md)
+[Custom scenario](./docs/CustomizeSolution.md)
@@ -63,14 +63,14 @@ If you'd like to customize the solution accelerator, here are some common areas
-
+
Quick deploy
### How to install or deploy
Follow the quick deploy steps on the deployment guide to deploy this solution to your own Azure subscription.
-[Click here to launch the deployment guide](./documentation/DeploymentGuide.md)
+[Click here to launch the deployment guide](./docs/DeploymentGuide.md)
| [](https://codespaces.new/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator) | [](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator) |
@@ -79,13 +79,13 @@ Follow the quick deploy steps on the deployment guide to deploy this solution to
> ⚠️ **Important: Check Azure OpenAI Quota Availability**
-
To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./documentation/quota_check.md) before you deploy the solution.
+
To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./docs/quota_check.md) before you deploy the solution.
### Prerequisites and Costs
-To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups and resources**. Follow the steps in [Azure Account Set Up](./documentation/AzureAccountSetUp.md).
+To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups and resources**. Follow the steps in [Azure Account Set Up](./docs/AzureAccountSetUp.md).
Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/table) page and select a **region** where the following services are available: Azure OpenAI Service, Azure AI Search, and Azure Semantic Search.
@@ -107,11 +107,11 @@ Use the [Azure pricing calculator](https://azure.microsoft.com/en-us/pricing/cal
either by deleting the resource group in the Portal or running `azd down`.
-
+
Business Scenario
-||
+||
|---|
@@ -148,7 +148,7 @@ By using the *Multi-Agent Custom Automation Engine* solution accelerator, users
-
+
Supporting documentation
@@ -185,7 +185,7 @@ Have questions, find a bug, or want to request a feature? [Submit a new issue](h
## Responsible AI Transparency FAQ
-Please refer to [Transparency FAQ](./documentation/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
+Please refer to [Transparency FAQ](./docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
diff --git a/documentation/AzureAccountSetUp.md b/docs/AzureAccountSetUp.md
similarity index 100%
rename from documentation/AzureAccountSetUp.md
rename to docs/AzureAccountSetUp.md
diff --git a/documentation/AzureGPTQuotaSettings.md b/docs/AzureGPTQuotaSettings.md
similarity index 100%
rename from documentation/AzureGPTQuotaSettings.md
rename to docs/AzureGPTQuotaSettings.md
diff --git a/docs/CustomizeSolution.md b/docs/CustomizeSolution.md
index d07e02d86..160550a0f 100644
--- a/docs/CustomizeSolution.md
+++ b/docs/CustomizeSolution.md
@@ -1,3 +1,18 @@
+# Table of Contents
+
+- [Table of Contents](#table-of-contents)
+ - [Accelerating your own Multi-Agent - Custom Automation Engine MVP](#accelerating-your-own-multi-agent---custom-automation-engine-mvp)
+ - [Technical Overview](#technical-overview)
+ - [Adding a New Agent to the Multi-Agent System](#adding-a-new-agent-to-the-multi-agent-system)
+ - [API Reference](#api-reference)
+ - [Models and Datatypes](#models-and-datatypes)
+ - [Application Flow](#application-flow)
+ - [Agents Overview](#agents-overview)
+ - [Persistent Storage with Cosmos DB](#persistent-storage-with-cosmos-db)
+ - [Utilities](#utilities)
+ - [Summary](#summary)
+
+
# Accelerating your own Multi-Agent - Custom Automation Engine MVP
As the name suggests, this project is designed to accelerate development of Multi-Agent solutions in your environment. The example solution presented shows how such a solution would be implemented and provides example agent definitions along with stubs for possible tools those agents could use to accomplish tasks. You will want to implement real functions in your own environment, to be used by agents customized around your own use cases. Users can choose the LLM that is optimized for responsible use. The default LLM is GPT-4o which inherits the existing responsible AI mechanisms and filters from the LLM provider. We encourage developers to review [OpenAI’s Usage policies](https://openai.com/policies/usage-policies/) and [Azure OpenAI’s Code of Conduct](https://learn.microsoft.com/en-us/legal/cognitive-services/openai/code-of-conduct) when using GPT-4o. This document is designed to provide the in-depth technical information to allow you to add these customizations. Once the agents and tools have been developed, you will likely want to implement your own real world front end solution to replace the example in this accelerator.
@@ -15,21 +30,6 @@ This application is an AI-driven orchestration system that manages a group of AI
This code has not been tested as an end-to-end, reliable production application- it is a foundation to help accelerate building out multi-agent systems. You are encouraged to add your own data and functions to the agents, and then you must apply your own performance and safety evaluation testing frameworks to this system before deploying it.
Below, we'll dive into the details of each component, focusing on the endpoints, data types, and the flow of information through the system.
-# Table of Contents
-
-- [Table of Contents](#table-of-contents)
- - [Accelerating your own Multi-Agent - Custom Automation Engine MVP](#accelerating-your-own-multi-agent---custom-automation-engine-mvp)
- - [Technical Overview](#technical-overview)
- - [Adding a New Agent to the Multi-Agent System](#adding-a-new-agent-to-the-multi-agent-system)
- - [API Reference](#api-reference)
- - [Models and Datatypes](#models-and-datatypes)
- - [Application Flow](#application-flow)
- - [Agents Overview](#agents-overview)
- - [Persistent Storage with Cosmos DB](#persistent-storage-with-cosmos-db)
- - [Utilities](#utilities)
- - [Summary](#summary)
-
-
## Adding a New Agent to the Multi-Agent System
This guide details the steps required to add a new agent to the Multi-Agent Custom Automation Engine. The process includes registering the agent, defining its capabilities through tools, and ensuring the PlannerAgent includes the new agent when generating activity plans.
@@ -41,7 +41,6 @@ Every agent is equipped with a set of tools (functions) that it can call to perf
Example (for a `BakerAgent`):
```python
- from autogen_core.components.tools import FunctionTool, Tool
from typing import List
async def bake_cookies(cookie_type: str, quantity: int) -> str:
@@ -615,4 +614,4 @@ This application orchestrates a group of AI agents to accomplish user-defined ta
Understanding the flow of data through the endpoints, agents, and persistent storage is key to grasping the logic of the application. Each component plays a specific role in ensuring tasks are planned, executed, and adjusted based on feedback, providing a robust and interactive system.
-For instructions to setup a local development environment for the solution, please see [local deployment guide](./LocalDeployment.md).
+For instructions to setup a local development environment for the solution, please see [deployment guide](./DeploymentGuide.md).
diff --git a/documentation/DeleteResourceGroup.md b/docs/DeleteResourceGroup.md
similarity index 100%
rename from documentation/DeleteResourceGroup.md
rename to docs/DeleteResourceGroup.md
diff --git a/documentation/DeploymentGuide.md b/docs/DeploymentGuide.md
similarity index 99%
rename from documentation/DeploymentGuide.md
rename to docs/DeploymentGuide.md
index 420bfe90d..2b5cc5105 100644
--- a/documentation/DeploymentGuide.md
+++ b/docs/DeploymentGuide.md
@@ -2,7 +2,7 @@
## **Pre-requisites**
-To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups, resources, app registrations, and assign roles at the resource group level**. This should include Contributor role at the subscription level and Role Based Access Control role on the subscription and/or resource group level. Follow the steps in [Azure Account Set Up](../documentation/AzureAccountSetUp.md).
+To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups, resources, app registrations, and assign roles at the resource group level**. This should include Contributor role at the subscription level and Role Based Access Control role on the subscription and/or resource group level. Follow the steps in [Azure Account Set Up](../docs/AzureAccountSetUp.md).
Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all®ions=all) page and select a **region** where the following services are available:
@@ -223,7 +223,7 @@ This guide provides step-by-step instructions for deploying your application usi
There are several ways to deploy the solution. You can deploy to run in Azure in one click, or manually, or you can deploy locally.
-When Deployment is complete, follow steps in [Set Up Authentication in Azure App Service](../documentation/azure_app_service_auth_setup.md) to add app authentication to your web app running on Azure App Service
+When Deployment is complete, follow steps in [Set Up Authentication in Azure App Service](../docs/azure_app_service_auth_setup.md) to add app authentication to your web app running on Azure App Service
# Local setup
diff --git a/documentation/ManualAzureDeployment.md b/docs/ManualAzureDeployment.md
similarity index 100%
rename from documentation/ManualAzureDeployment.md
rename to docs/ManualAzureDeployment.md
diff --git a/documentation/SampleQuestions.md b/docs/SampleQuestions.md
similarity index 100%
rename from documentation/SampleQuestions.md
rename to docs/SampleQuestions.md
diff --git a/documentation/TRANSPARENCY_FAQ.md b/docs/TRANSPARENCY_FAQ.md
similarity index 100%
rename from documentation/TRANSPARENCY_FAQ.md
rename to docs/TRANSPARENCY_FAQ.md
diff --git a/docs/azure_app_service_auth_setup.md b/docs/azure_app_service_auth_setup.md
index 6026b69ef..f73ff8e58 100644
--- a/docs/azure_app_service_auth_setup.md
+++ b/docs/azure_app_service_auth_setup.md
@@ -1,20 +1,28 @@
# Set Up Authentication in Azure App Service
+This document provides step-by-step instructions to configure Azure App Registrations for a front-end application.
+
+## Prerequisites
+
+- Access to **Microsoft Entra ID**
+- Necessary permissions to create and manage **App Registrations**
+
## Step 1: Add Authentication in Azure App Service configuration
1. Click on `Authentication` from left menu.
-2. Click on `+ Add Provider` to see a list of identity providers.
+2. Click on `+ Add identity provider` to see a list of identity providers.
-3. Click on `+ Add Provider` to see a list of identity providers.
+3. Click on `Identity Provider` dropdown to see a list of identity providers.
-4. Select the first option `Microsoft Entra Id` from the drop-down list. If `Create new app registration` is disabled, go to [Step 1a](#step-1a-creating-a-new-app-registration).
+4. Select the first option `Microsoft Entra Id` from the drop-down list and select `client secret expiration` under App registration.
+> NOTE: If `Create new app registration` is disabled, then go to [Create new app registration](/docs/create_new_app_registration.md) and come back to this step to complete the app authentication.
@@ -22,37 +30,4 @@
-### Step 1a: Creating a new App Registration
-
-1. Click on `Home` and select `Microsoft Entra ID`.
-
-
-
-2. Click on `App registrations`.
-
-
-
-3. Click on `+ New registration`.
-
-
-
-4. Provide the `Name`, select supported account types as `Accounts in this organizational directory only(Contoso only - Single tenant)`, select platform as `Web`, enter/select the `URL` and register.
-
-
-
-5. After application is created sucessfully, then click on `Add a Redirect URL`.
-
-
-
-6. Click on `+ Add a platform`.
-
-
-
-7. Click on `Web`.
-
-
-
-8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Step 1](#step-1-add-authentication-in-azure-app-service-configuration) and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name.
-E.g. <>.azurewebsites.net/.auth/login/aad/callback>>
-
-
+6. You have successfully added app authentication, and now required to log in to access the application.
diff --git a/docs/create_new_app_registration.md b/docs/create_new_app_registration.md
new file mode 100644
index 000000000..28edbf452
--- /dev/null
+++ b/docs/create_new_app_registration.md
@@ -0,0 +1,35 @@
+# Creating a new App Registration
+
+1. Click on `Home` and select `Microsoft Entra ID`.
+
+
+
+2. Click on `App registrations`.
+
+
+
+3. Click on `+ New registration`.
+
+
+
+4. Provide the `Name`, select supported account types as `Accounts in this organizational directory only(Contoso only - Single tenant)`, select platform as `Web`, enter/select the `URL` and register.
+
+
+
+5. After application is created successfully, then click on `Add a Redirect URL`.
+
+
+
+6. Click on `+ Add a platform`.
+
+
+
+7. Click on `Web`.
+
+
+
+8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Set Up Authentication in Azure App Service](azure_app_service_auth_setup.md) Step 1 page and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name.
+
+E.g. <>.azurewebsites.net/.auth/login/aad/callback>>
+
+
diff --git a/documentation/images/DeleteRG.png b/docs/images/DeleteRG.png
similarity index 100%
rename from documentation/images/DeleteRG.png
rename to docs/images/DeleteRG.png
diff --git a/documentation/images/MACAE-GP1.png b/docs/images/MACAE-GP1.png
similarity index 100%
rename from documentation/images/MACAE-GP1.png
rename to docs/images/MACAE-GP1.png
diff --git a/documentation/images/MACAE-GP2.png b/docs/images/MACAE-GP2.png
similarity index 100%
rename from documentation/images/MACAE-GP2.png
rename to docs/images/MACAE-GP2.png
diff --git a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png
index 4cf476ad5..ca9ea30fb 100644
Binary files a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png and b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png differ
diff --git a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png
index a57f0769e..17ccf135c 100644
Binary files a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png and b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png differ
diff --git a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png
index d839d27eb..ea94ce814 100644
Binary files a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png and b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png differ
diff --git a/docs/images/azure-app-service-auth-setup/AppAuthentication.png b/docs/images/azure-app-service-auth-setup/AppAuthentication.png
index 286e10207..e2a8ca000 100644
Binary files a/docs/images/azure-app-service-auth-setup/AppAuthentication.png and b/docs/images/azure-app-service-auth-setup/AppAuthentication.png differ
diff --git a/docs/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png b/docs/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png
index d839d27eb..79f458125 100644
Binary files a/docs/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png and b/docs/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png differ
diff --git a/documentation/images/deleteservices.png b/docs/images/deleteservices.png
similarity index 100%
rename from documentation/images/deleteservices.png
rename to docs/images/deleteservices.png
diff --git a/documentation/images/git_bash.png b/docs/images/git_bash.png
similarity index 100%
rename from documentation/images/git_bash.png
rename to docs/images/git_bash.png
diff --git a/documentation/images/quota-check-output.png b/docs/images/quota-check-output.png
similarity index 100%
rename from documentation/images/quota-check-output.png
rename to docs/images/quota-check-output.png
diff --git a/documentation/images/readme/business-scenario.png b/docs/images/readme/business-scenario.png
similarity index 100%
rename from documentation/images/readme/business-scenario.png
rename to docs/images/readme/business-scenario.png
diff --git a/docs/images/readme/macae-architecture.png b/docs/images/readme/macae-architecture.png
index 36ccb432b..95826744e 100644
Binary files a/docs/images/readme/macae-architecture.png and b/docs/images/readme/macae-architecture.png differ
diff --git a/documentation/images/readme/quick-deploy.png b/docs/images/readme/quick-deploy.png
similarity index 100%
rename from documentation/images/readme/quick-deploy.png
rename to docs/images/readme/quick-deploy.png
diff --git a/documentation/images/readme/solution-overview.png b/docs/images/readme/solution-overview.png
similarity index 100%
rename from documentation/images/readme/solution-overview.png
rename to docs/images/readme/solution-overview.png
diff --git a/documentation/images/readme/supporting-documentation.png b/docs/images/readme/supporting-documentation.png
similarity index 100%
rename from documentation/images/readme/supporting-documentation.png
rename to docs/images/readme/supporting-documentation.png
diff --git a/documentation/images/resource-groups.png b/docs/images/resource-groups.png
similarity index 100%
rename from documentation/images/resource-groups.png
rename to docs/images/resource-groups.png
diff --git a/documentation/images/resourcegroup.png b/docs/images/resourcegroup.png
similarity index 100%
rename from documentation/images/resourcegroup.png
rename to docs/images/resourcegroup.png
diff --git a/documentation/quota_check.md b/docs/quota_check.md
similarity index 100%
rename from documentation/quota_check.md
rename to docs/quota_check.md
diff --git a/documentation/CustomizeSolution.md b/documentation/CustomizeSolution.md
deleted file mode 100644
index 160550a0f..000000000
--- a/documentation/CustomizeSolution.md
+++ /dev/null
@@ -1,617 +0,0 @@
-# Table of Contents
-
-- [Table of Contents](#table-of-contents)
- - [Accelerating your own Multi-Agent - Custom Automation Engine MVP](#accelerating-your-own-multi-agent---custom-automation-engine-mvp)
- - [Technical Overview](#technical-overview)
- - [Adding a New Agent to the Multi-Agent System](#adding-a-new-agent-to-the-multi-agent-system)
- - [API Reference](#api-reference)
- - [Models and Datatypes](#models-and-datatypes)
- - [Application Flow](#application-flow)
- - [Agents Overview](#agents-overview)
- - [Persistent Storage with Cosmos DB](#persistent-storage-with-cosmos-db)
- - [Utilities](#utilities)
- - [Summary](#summary)
-
-
-# Accelerating your own Multi-Agent - Custom Automation Engine MVP
-
-As the name suggests, this project is designed to accelerate development of Multi-Agent solutions in your environment. The example solution presented shows how such a solution would be implemented and provides example agent definitions along with stubs for possible tools those agents could use to accomplish tasks. You will want to implement real functions in your own environment, to be used by agents customized around your own use cases. Users can choose the LLM that is optimized for responsible use. The default LLM is GPT-4o which inherits the existing responsible AI mechanisms and filters from the LLM provider. We encourage developers to review [OpenAI’s Usage policies](https://openai.com/policies/usage-policies/) and [Azure OpenAI’s Code of Conduct](https://learn.microsoft.com/en-us/legal/cognitive-services/openai/code-of-conduct) when using GPT-4o. This document is designed to provide the in-depth technical information to allow you to add these customizations. Once the agents and tools have been developed, you will likely want to implement your own real world front end solution to replace the example in this accelerator.
-
-## Technical Overview
-
-This application is an AI-driven orchestration system that manages a group of AI agents to accomplish tasks based on user input. It uses a FastAPI backend to handle HTTP requests, processes them through various specialized agents, and stores stateful information using Azure Cosmos DB. The system is designed to:
-
-- Receive input tasks from users.
-- Generate a detailed plan to accomplish the task using a Planner agent.
-- Execute the plan by delegating steps to specialized agents (e.g., HR, Procurement, Marketing).
-- Incorporate human feedback into the workflow.
-- Maintain state across sessions with persistent storage.
-
-This code has not been tested as an end-to-end, reliable production application- it is a foundation to help accelerate building out multi-agent systems. You are encouraged to add your own data and functions to the agents, and then you must apply your own performance and safety evaluation testing frameworks to this system before deploying it.
-
-Below, we'll dive into the details of each component, focusing on the endpoints, data types, and the flow of information through the system.
-## Adding a New Agent to the Multi-Agent System
-
-This guide details the steps required to add a new agent to the Multi-Agent Custom Automation Engine. The process includes registering the agent, defining its capabilities through tools, and ensuring the PlannerAgent includes the new agent when generating activity plans.
-
-### **Step 1: Define the New Agent's Tools**
-Every agent is equipped with a set of tools (functions) that it can call to perform specific tasks. These tools need to be defined first.
-
-1. **Create New Tools**: In a new or existing file, define the tools your agent will use.
-
- Example (for a `BakerAgent`):
- ```python
- from typing import List
-
- async def bake_cookies(cookie_type: str, quantity: int) -> str:
- return f"Baked {quantity} {cookie_type} cookies."
-
- async def prepare_dough(dough_type: str) -> str:
- return f"Prepared {dough_type} dough."
-
- def get_baker_tools() -> List[Tool]:
- return [
- FunctionTool(bake_cookies, description="Bake cookies of a specific type.", name="bake_cookies"),
- FunctionTool(prepare_dough, description="Prepare dough of a specific type.", name="prepare_dough"),
- ]
- ```
-
-
-2. **Implement the Agent Class**
-Create a new agent class that inherits from `BaseAgent`.
-
-Example (for `BakerAgent`):
-```python
-from agents.base_agent import BaseAgent
-
-class BakerAgent(BaseAgent):
- def __init__(self, model_client, session_id, user_id, memory, tools, agent_id):
- super().__init__(
- "BakerAgent",
- model_client,
- session_id,
- user_id,
- memory,
- tools,
- agent_id,
- system_message="You are an AI Agent specialized in baking tasks.",
- )
-```
-### **Step 2: Register the new Agent in the messages**
-Update `messages.py` to include the new agent.
-
- ```python
- class BAgentType(str, Enum):
- baker_agent = "BakerAgent"
-```
-
-### **Step 3: Register the Agent in the Initialization Process**
-Update the `initialize_runtime_and_context` function in `utils.py` to include the new agent.
-
-1. **Import new agent**:
- ```python
- from agents.baker_agent import BakerAgent, get_baker_tools
- ```
-
-2. **Add the bakers tools**:
- ```python
- baker_tools = get_baker_tools()
- ```
-
-3. **Generate Agent IDs**:
- ```python
- baker_agent_id = AgentId("baker_agent", session_id)
- baker_tool_agent_id = AgentId("baker_tool_agent", session_id)
- ```
-
-4. **Register to ToolAgent**:
- ```python
- await ToolAgent.register(
- runtime,
- "baker_tool_agent",
- lambda: ToolAgent("Baker tool execution agent", baker_tools),
- )
- ```
-
-5. **Register the Agent and ToolAgent**:
- ```python
- await BakerAgent.register(
- runtime,
- baker_agent_id.type,
- lambda: BakerAgent(
- aoai_model_client,
- session_id,
- user_id,
- cosmos_memory,
- get_baker_tools(),
- baker_tool_agent_id,
- ),
- )
- ```
-6. **Add to agent_ids**:
- ```python
- agent_ids = {
- BAgentType.baker_agent: baker_agent_id,
- ```
-7. **Add to retrieve_all_agent_tools**:
- ```python
- def retrieve_all_agent_tools() -> List[Dict[str, Any]]:
- baker_tools: List[Tool] = get_baker_tools()
- ```
-8. **Append baker_tools to functions**:
- ```python
- for tool in baker_tools:
- functions.append(
- {
- "agent": "BakerAgent",
- "function": tool.name,
- "description": tool.description,
- "arguments": str(tool.schema["parameters"]["properties"]),
- }
- )
- ```
-### **Step 4: Update home page**
-Update `src/frontend/wwwroot/home/home.html` adding new html block
-
-1. **Add a new UI element was added to allow users to request baking tasks from the BakerAgent**
-```html
-
-
-
-
- Bake Cookies
- Please bake 12 chocolate chip cookies for tomorrow's event.
-
-
-
-```
-### **Step 5: Update tasks**
-Update `src/frontend/wwwroot/task/task.js`
-
-1. **Add `BakerAgent` as a recognized agent type in the frontend JavaScript file**
-```js
- case "BakerAgent":
- agentIcon = "manager";
- break;
-```
-### **Step 6: Validate the Integration**
-Deploy the updated system and ensure the new agent is properly included in the planning process. For example, if the user requests to bake cookies, the `PlannerAgent` should:
-
-- Identify the `BakerAgent` as the responsible agent.
-- Call `bake_cookies` or `prepare_dough` from the agent's toolset.
-
-### **Step 7: Update Documentation**
-Ensure that the system documentation reflects the addition of the new agent and its capabilities. Update the `README.md` and any related technical documentation to include information about the `BakerAgent`.
-
-### **Step 8: Testing**
-Thoroughly test the agent in both automated and manual scenarios. Verify that:
-
-- The agent responds correctly to tasks.
-- The PlannerAgent includes the new agent in relevant plans.
-- The agent's tools are executed as expected.
-
-Following these steps will successfully integrate a new agent into the Multi-Agent Custom Automation Engine.
-
-### API Reference
-To view the API reference, go to the API endpoint in a browser and add "/docs". This will bring up a full Swagger environment and reference documentation for the REST API included with this accelerator. For example, ```https://macae-backend.eastus2.azurecontainerapps.io/docs```.
-If you prefer ReDoc, this is available by appending "/redoc".
-
-
-
-### Models and Datatypes
-#### Models
-##### **`BaseDataModel`**
-The `BaseDataModel` is a foundational class for creating structured data models using Pydantic. It provides the following attributes:
-
-- **`id`**: A unique identifier for the data, generated using `uuid`.
-- **`ts`**: An optional timestamp indicating when the model instance was created or modified.
-
-#### **`AgentMessage`**
-The `AgentMessage` model represents communication between agents and includes the following fields:
-
-- **`id`**: A unique identifier for the message, generated using `uuid`.
-- **`data_type`**: A literal value of `"agent_message"` to identify the message type.
-- **`session_id`**: The session associated with this message.
-- **`user_id`**: The ID of the user associated with this message.
-- **`plan_id`**: The ID of the related plan.
-- **`content`**: The content of the message.
-- **`source`**: The origin or sender of the message (e.g., an agent).
-- **`ts`**: An optional timestamp for when the message was created.
-- **`step_id`**: An optional ID of the step associated with this message.
-
-#### **`Session`**
-The `Session` model represents a user session and extends the `BaseDataModel`. It has the following attributes:
-
-- **`data_type`**: A literal value of `"session"` to identify the type of data.
-- **`current_status`**: The current status of the session (e.g., `active`, `completed`).
-- **`message_to_user`**: An optional field to store any messages sent to the user.
-- **`ts`**: An optional timestamp for the session's creation or last update.
-
-
-#### **`Plan`**
-The `Plan` model represents a high-level structure for organizing actions or tasks. It extends the `BaseDataModel` and includes the following attributes:
-
-- **`data_type`**: A literal value of `"plan"` to identify the data type.
-- **`session_id`**: The ID of the session associated with this plan.
-- **`initial_goal`**: A description of the initial goal derived from the user’s input.
-- **`overall_status`**: The overall status of the plan (e.g., `in_progress`, `completed`, `failed`).
-
-#### **`Step`**
-The `Step` model represents a discrete action or task within a plan. It extends the `BaseDataModel` and includes the following attributes:
-
-- **`data_type`**: A literal value of `"step"` to identify the data type.
-- **`plan_id`**: The ID of the plan the step belongs to.
-- **`action`**: The specific action or task to be performed.
-- **`agent`**: The name of the agent responsible for executing the step.
-- **`status`**: The status of the step (e.g., `planned`, `approved`, `completed`).
-- **`agent_reply`**: An optional response from the agent after executing the step.
-- **`human_feedback`**: Optional feedback provided by a user about the step.
-- **`updated_action`**: Optional modified action based on human feedback.
-- **`session_id`**: The session ID associated with the step.
-- **`user_id`**: The ID of the user providing feedback or interacting with the step.
-
-#### **`PlanWithSteps`**
-The `PlanWithSteps` model extends the `Plan` model and includes additional information about the steps in the plan. It has the following attributes:
-
-- **`steps`**: A list of `Step` objects associated with the plan.
-- **`total_steps`**: The total number of steps in the plan.
-- **`completed_steps`**: The number of steps that have been completed.
-- **`pending_steps`**: The number of steps that are pending approval or completion.
-
-**Additional Features**:
-The `PlanWithSteps` model provides methods to update step counts:
-- `update_step_counts()`: Calculates and updates the `total_steps`, `completed_steps`, and `pending_steps` fields based on the associated steps.
-
-#### **`InputTask`**
-The `InputTask` model represents the user’s initial input for creating a plan. It includes the following attributes:
-
-- **`session_id`**: An optional string for the session ID. If not provided, a new UUID will be generated.
-- **`description`**: A string describing the task or goal the user wants to accomplish.
-- **`user_id`**: The ID of the user providing the input.
-
-#### **`ApprovalRequest`**
-The `ApprovalRequest` model represents a request to approve a step or multiple steps. It includes the following attributes:
-
-- **`step_id`**: An optional string representing the specific step to approve. If not provided, the request applies to all steps.
-- **`plan_id`**: The ID of the plan containing the step(s) to approve.
-- **`session_id`**: The ID of the session associated with the approval request.
-- **`approved`**: A boolean indicating whether the step(s) are approved.
-- **`human_feedback`**: An optional string containing comments or feedback from the user.
-- **`updated_action`**: An optional string representing a modified action based on feedback.
-- **`user_id`**: The ID of the user making the approval request.
-
-
-#### **`HumanFeedback`**
-The `HumanFeedback` model captures user feedback on a specific step or plan. It includes the following attributes:
-
-- **`step_id`**: The ID of the step the feedback is related to.
-- **`plan_id`**: The ID of the plan containing the step.
-- **`session_id`**: The session ID associated with the feedback.
-- **`approved`**: A boolean indicating if the step is approved.
-- **`human_feedback`**: Optional comments or feedback provided by the user.
-- **`updated_action`**: Optional modified action based on the feedback.
-- **`user_id`**: The ID of the user providing the feedback.
-
-#### **`HumanClarification`**
-The `HumanClarification` model represents clarifications provided by the user about a plan. It includes the following attributes:
-
-- **`plan_id`**: The ID of the plan requiring clarification.
-- **`session_id`**: The session ID associated with the plan.
-- **`human_clarification`**: The clarification details provided by the user.
-- **`user_id`**: The ID of the user providing the clarification.
-
-#### **`ActionRequest`**
-The `ActionRequest` model captures a request to perform an action within the system. It includes the following attributes:
-
-- **`session_id`**: The session ID associated with the action request.
-- **`plan_id`**: The ID of the plan associated with the action.
-- **`step_id`**: Optional ID of the step associated with the action.
-- **`action`**: A string describing the action to be performed.
-- **`user_id`**: The ID of the user requesting the action.
-
-#### **`ActionResponse`**
-The `ActionResponse` model represents the response to an action request. It includes the following attributes:
-
-- **`status`**: A string indicating the status of the action (e.g., `success`, `failure`).
-- **`message`**: An optional string providing additional details or context about the action's result.
-- **`data`**: Optional data payload containing any relevant information from the action.
-- **`user_id`**: The ID of the user associated with the action response.
-
-#### **`PlanStateUpdate`**
-The `PlanStateUpdate` model represents an update to the state of a plan. It includes the following attributes:
-
-- **`plan_id`**: The ID of the plan being updated.
-- **`session_id`**: The session ID associated with the plan.
-- **`new_state`**: A string representing the new state of the plan (e.g., `in_progress`, `completed`, `failed`).
-- **`user_id`**: The ID of the user making the state update.
-- **`timestamp`**: An optional timestamp indicating when the update was made.
-
----
-
-#### **`GroupChatMessage`**
-The `GroupChatMessage` model represents a message sent in a group chat context. It includes the following attributes:
-
-- **`message_id`**: A unique ID for the message.
-- **`session_id`**: The session ID associated with the group chat.
-- **`user_id`**: The ID of the user sending the message.
-- **`content`**: The text content of the message.
-- **`timestamp`**: A timestamp indicating when the message was sent.
-
----
-
-#### **`RequestToSpeak`**
-The `RequestToSpeak` model represents a user's request to speak or take action in a group chat or collaboration session. It includes the following attributes:
-
-- **`request_id`**: A unique ID for the request.
-- **`session_id`**: The session ID associated with the request.
-- **`user_id`**: The ID of the user making the request.
-- **`reason`**: A string describing the reason or purpose of the request.
-- **`timestamp`**: A timestamp indicating when the request was made.
-
-
-### Data Types
-
-#### **`DataType`**
-The `DataType` enumeration defines the types of data used in the system. Possible values include:
-- **`plan`**: Represents a plan data type.
-- **`session`**: Represents a session data type.
-- **`step`**: Represents a step data type.
-- **`agent_message`**: Represents an agent message data type.
-
----
-
-#### **`BAgentType`**
-The `BAgentType` enumeration defines the types of agents in the system. Possible values include:
-- **`human`**: Represents a human agent.
-- **`ai_assistant`**: Represents an AI assistant agent.
-- **`external_service`**: Represents an external service agent.
-
-#### **`StepStatus`**
-The `StepStatus` enumeration defines the possible statuses for a step. Possible values include:
-- **`planned`**: Indicates the step is planned but not yet approved or completed.
-- **`approved`**: Indicates the step has been approved.
-- **`completed`**: Indicates the step has been completed.
-- **`failed`**: Indicates the step has failed.
-
-
-#### **`PlanStatus`**
-The `PlanStatus` enumeration defines the possible statuses for a plan. Possible values include:
-- **`in_progress`**: Indicates the plan is currently in progress.
-- **`completed`**: Indicates the plan has been successfully completed.
-- **`failed`**: Indicates the plan has failed.
-
-
-#### **`HumanFeedbackStatus`**
-The `HumanFeedbackStatus` enumeration defines the possible statuses for human feedback. Possible values include:
-- **`pending`**: Indicates the feedback is awaiting review or action.
-- **`addressed`**: Indicates the feedback has been addressed.
-- **`rejected`**: Indicates the feedback has been rejected.
-
-
-### Application Flow
-
-#### **Initialization**
-
-The initialization process sets up the necessary agents and context for a session. This involves:
-
-- **Generating Unique AgentIds**: Each agent is assigned a unique `AgentId` based on the `session_id`, ensuring that multiple sessions can operate independently.
-- **Instantiating Agents**: Various agents, such as `PlannerAgent`, `HrAgent`, and `GroupChatManager`, are initialized and registered with unique `AgentIds`.
-- **Setting Up Azure OpenAI Client**: The Azure OpenAI Chat Completion Client is initialized to handle LLM interactions with support for function calling, JSON output, and vision handling.
-- **Creating Cosmos DB Context**: A `CosmosBufferedChatCompletionContext` is established for stateful interaction storage.
-
-**Code Reference: `utils.py`**
-
-**Steps:**
-1. **Session ID Generation**: If `session_id` is not provided, a new UUID is generated.
-2. **Agent Registration**: Each agent is assigned a unique `AgentId` and registered with the runtime.
-3. **Azure OpenAI Initialization**: The LLM client is configured for advanced interactions.
-4. **Cosmos DB Context Creation**: A buffered context is created for storing stateful interactions.
-5. **Runtime Start**: The runtime is started, enabling communication and agent operation.
-
-
-
-### Input Task Handling
-
-When the `/input_task` endpoint receives an `InputTask`, it performs the following steps:
-
-1. Ensures a `session_id` is available.
-2. Calls `initialize` to set up agents and context for the session.
-3. Creates a `GroupChatManager` agent ID using the `session_id`.
-4. Sends the `InputTask` message to the `GroupChatManager`.
-5. Returns the `session_id` and `plan_id`.
-
-**Code Reference: `app.py`**
-
- @app.post("/input_task")
- async def input_task(input_task: InputTask):
- # Initialize session and agents
- # Send InputTask to GroupChatManager
- # Return status, session_id, and plan_id
-
-### Planning
-
-The `GroupChatManager` handles the `InputTask` by:
-
-1. Passing the `InputTask` to the `PlannerAgent`.
-2. The `PlannerAgent` generates a `Plan` with detailed `Steps`.
-3. The `PlannerAgent` uses LLM capabilities to create a structured plan based on the task description.
-4. The plan and steps are stored in the Cosmos DB context.
-5. The `GroupChatManager` starts processing the first step.
-
-**Code Reference: `group_chat_manager.py` and `planner.py`**
-
- # GroupChatManager.handle_input_task
- plan: Plan = await self.send_message(message, self.planner_agent_id)
- await self.memory.add_plan(plan)
- # Start processing steps
- await self.process_next_step(message.session_id)
-
- # PlannerAgent.handle_input_task
- plan, steps = await self.create_structured_message(...)
- await self.memory.add_plan(plan)
- for step in steps:
- await self.memory.add_step(step)
-
-### Step Execution and Approval
-
-For each step in the plan:
-
-1. The `GroupChatManager` retrieves the next planned step.
-2. It sends an `ApprovalRequest` to the `HumanAgent` to get human approval.
-3. The `HumanAgent` waits for human feedback (provided via the `/human_feedback` endpoint).
-4. The step status is updated to `awaiting_feedback`.
-
-**Code Reference: `group_chat_manager.py`**
-
- async def process_next_step(self, session_id: str):
- # Get plan and steps
- # Find next planned step
- # Update step status to 'awaiting_feedback'
- # Send ApprovalRequest to HumanAgent
-
-### Human Feedback
-
-The human can provide feedback on a step via the `/human_feedback` endpoint:
-
-1. The `HumanFeedback` message is received by the FastAPI app.
-2. The message is sent to the `HumanAgent`.
-3. The `HumanAgent` updates the step with the feedback.
-4. The `HumanAgent` sends the feedback to the `GroupChatManager`.
-5. The `GroupChatManager` either proceeds to execute the step or handles rejections.
-
-**Code Reference: `app.py` and `human.py`**
-
- # app.py
- @app.post("/human_feedback")
- async def human_feedback(human_feedback: HumanFeedback):
- # Send HumanFeedback to HumanAgent
-
- # human.py
- @message_handler
- async def handle_human_feedback(self, message: HumanFeedback, ctx: MessageContext):
- # Update step with feedback
- # Send feedback back to GroupChatManager
-
-### Action Execution by Specialized Agents
-
-If a step is approved:
-
-1. The `GroupChatManager` sends an `ActionRequest` to the appropriate specialized agent (e.g., `HrAgent`, `ProcurementAgent`).
-2. The specialized agent executes the action using tools and LLMs.
-3. The agent sends an `ActionResponse` back to the `GroupChatManager`.
-4. The `GroupChatManager` updates the step status and proceeds to the next step.
-
-**Code Reference: `group_chat_manager.py` and `base_agent.py`**
-
- # GroupChatManager.execute_step
- action_request = ActionRequest(...)
- await self.send_message(action_request, agent_id)
-
- # BaseAgent.handle_action_request
- # Execute action using tools and LLM
- # Update step status
- # Send ActionResponse back to GroupChatManager
-
-## Agents Overview
-
-### GroupChatManager
-
-**Role:** Orchestrates the entire workflow.
-**Responsibilities:**
-
-- Receives `InputTask` from the user.
-- Interacts with `PlannerAgent` to generate a plan.
-- Manages the execution and approval process of each step.
-- Handles human feedback and directs approved steps to the appropriate agents.
-
-**Code Reference: `group_chat_manager.py`**
-
-### PlannerAgent
-
-**Role:** Generates a detailed plan based on the input task.
-**Responsibilities:**
-
-- Parses the task description.
-- Creates a structured plan with specific actions and agents assigned to each step.
-- Stores the plan in the context.
-- Handles re-planning if steps fail.
-
-**Code Reference: `planner.py`**
-
-### HumanAgent
-
-**Role:** Interfaces with the human user for approvals and feedback.
-**Responsibilities:**
-
-- Receives `ApprovalRequest` messages.
-- Waits for human feedback (provided via the API).
-- Updates steps in the context based on feedback.
-- Communicates feedback back to the `GroupChatManager`.
-
-**Code Reference: `human.py`**
-
-### Specialized Agents
-
-**Types:** `HrAgent`, `LegalAgent`, `MarketingAgent`, etc.
-**Role:** Execute specific actions related to their domain.
-**Responsibilities:**
-
-- Receive `ActionRequest` messages.
-- Perform actions using tools and LLM capabilities.
-- Provide results and update steps in the context.
-- Communicate `ActionResponse` back to the `GroupChatManager`.
-
-**Common Implementation:**
-All specialized agents inherit from `BaseAgent`, which handles common functionality.
-**Code Reference:** `base_agent.py`, `hr.py`, etc.
-
-
-
-## Persistent Storage with Cosmos DB
-
-The application uses Azure Cosmos DB to store and retrieve session data, plans, steps, and messages. This ensures that the state is maintained across different components and can handle multiple sessions concurrently.
-
-**Key Points:**
-
-- **Session Management:** Stores session information and current status.
-- **Plan Storage:** Plans are saved and can be retrieved or updated.
-- **Step Tracking:** Each step's status, actions, and feedback are stored.
-- **Message History:** Chat messages between agents are stored for context.
-
-**Cosmos DB Client Initialization:**
-
-- Uses `ClientSecretCredential` for authentication.
-- Asynchronous operations are used throughout to prevent blocking.
-
-**Code Reference: `cosmos_memory.py`**
-
-## Utilities
-
-### `initialize` Function
-
-**Location:** `utils.py`
-**Purpose:** Initializes agents and context for a session, ensuring that each session has its own unique agents and runtime.
-**Key Actions:**
-
-- Generates unique AgentIds with the `session_id`.
-- Creates instances of agents and registers them with the runtime.
-- Initializes `CosmosBufferedChatCompletionContext` for session-specific storage.
-- Starts the runtime.
-
-**Example Usage:**
-
- runtime, cosmos_memory = await initialize(input_task.session_id)
-
-## Summary
-
-This application orchestrates a group of AI agents to accomplish user-defined tasks by:
-
-- Accepting tasks via HTTP endpoints.
-- Generating detailed plans using LLMs.
-- Delegating actions to specialized agents.
-- Incorporating human feedback.
-- Maintaining state using Azure Cosmos DB.
-
-Understanding the flow of data through the endpoints, agents, and persistent storage is key to grasping the logic of the application. Each component plays a specific role in ensuring tasks are planned, executed, and adjusted based on feedback, providing a robust and interactive system.
-
-For instructions to setup a local development environment for the solution, please see [deployment guide](./DeploymentGuide.md).
diff --git a/documentation/azure_app_service_auth_setup.md b/documentation/azure_app_service_auth_setup.md
deleted file mode 100644
index 8829e8a9f..000000000
--- a/documentation/azure_app_service_auth_setup.md
+++ /dev/null
@@ -1,58 +0,0 @@
-# Set Up Authentication in Azure App Service
-
-## Step 1: Add Authentication in Azure App Service configuration
-
-1. Click on `Authentication` from left menu.
-
-
-
-2. Click on `+ Add Provider` to see a list of identity providers.
-
-
-
-3. Click on `+ Add Provider` to see a list of identity providers.
-
-
-
-4. Select the first option `Microsoft Entra Id` from the drop-down list. If `Create new app registration` is disabled, go to [Step 1a](#step-1a-creating-a-new-app-registration).
-
-
-
-5. Accept the default values and click on `Add` button to go back to the previous page with the identity provider added.
-
-
-
-### Step 1a: Creating a new App Registration
-
-1. Click on `Home` and select `Microsoft Entra ID`.
-
-
-
-2. Click on `App registrations`.
-
-
-
-3. Click on `+ New registration`.
-
-
-
-4. Provide the `Name`, select supported account types as `Accounts in this organizational directory only(Contoso only - Single tenant)`, select platform as `Web`, enter/select the `URL` and register.
-
-
-
-5. After application is created successfully, then click on `Add a Redirect URL`.
-
-
-
-6. Click on `+ Add a platform`.
-
-
-
-7. Click on `Web`.
-
-
-
-8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Step 1](#step-1-add-authentication-in-azure-app-service-configuration) and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name.
-E.g. <>.azurewebsites.net/.auth/login/aad/callback>>
-
-
diff --git a/documentation/images/azure-app-service-auth-setup/AddDetails.png b/documentation/images/azure-app-service-auth-setup/AddDetails.png
deleted file mode 100644
index f36b596f2..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AddDetails.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AddPlatform.png b/documentation/images/azure-app-service-auth-setup/AddPlatform.png
deleted file mode 100644
index 6c74919b4..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AddPlatform.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AddRedirectURL.png b/documentation/images/azure-app-service-auth-setup/AddRedirectURL.png
deleted file mode 100644
index d5cbcfac4..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AddRedirectURL.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png b/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png
deleted file mode 100644
index 4cf476ad5..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png b/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png
deleted file mode 100644
index a57f0769e..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png b/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png
deleted file mode 100644
index d839d27eb..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AppAuthentication.png b/documentation/images/azure-app-service-auth-setup/AppAuthentication.png
deleted file mode 100644
index 286e10207..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AppAuthentication.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png b/documentation/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png
deleted file mode 100644
index d839d27eb..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/Appregistrations.png b/documentation/images/azure-app-service-auth-setup/Appregistrations.png
deleted file mode 100644
index af2d3ae44..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/Appregistrations.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/MicrosoftEntraID.png b/documentation/images/azure-app-service-auth-setup/MicrosoftEntraID.png
deleted file mode 100644
index 1f24b89d0..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/MicrosoftEntraID.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/NewRegistration.png b/documentation/images/azure-app-service-auth-setup/NewRegistration.png
deleted file mode 100644
index 288f9af5a..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/NewRegistration.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/Web.png b/documentation/images/azure-app-service-auth-setup/Web.png
deleted file mode 100644
index 35f846453..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/Web.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/WebAppURL.png b/documentation/images/azure-app-service-auth-setup/WebAppURL.png
deleted file mode 100644
index 40c6740e9..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/WebAppURL.png and /dev/null differ
diff --git a/documentation/images/customize_solution/logic_flow.svg b/documentation/images/customize_solution/logic_flow.svg
deleted file mode 100644
index 9914ae8a6..000000000
--- a/documentation/images/customize_solution/logic_flow.svg
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-
-
\ No newline at end of file
diff --git a/documentation/images/customize_solution/redoc_ui.png b/documentation/images/customize_solution/redoc_ui.png
deleted file mode 100644
index cd7e445b4..000000000
Binary files a/documentation/images/customize_solution/redoc_ui.png and /dev/null differ
diff --git a/documentation/images/readme/customerTruth.png b/documentation/images/readme/customerTruth.png
deleted file mode 100644
index 20cc799b1..000000000
Binary files a/documentation/images/readme/customerTruth.png and /dev/null differ
diff --git a/documentation/images/readme/macae-application.png b/documentation/images/readme/macae-application.png
deleted file mode 100644
index 923c3ad23..000000000
Binary files a/documentation/images/readme/macae-application.png and /dev/null differ
diff --git a/documentation/images/readme/macae-architecture.png b/documentation/images/readme/macae-architecture.png
deleted file mode 100644
index 95826744e..000000000
Binary files a/documentation/images/readme/macae-architecture.png and /dev/null differ
diff --git a/documentation/images/readme/oneClickDeploy.png b/documentation/images/readme/oneClickDeploy.png
deleted file mode 100644
index 846e0e1fb..000000000
Binary files a/documentation/images/readme/oneClickDeploy.png and /dev/null differ
diff --git a/documentation/images/readme/userStory.png b/documentation/images/readme/userStory.png
deleted file mode 100644
index ba485f545..000000000
Binary files a/documentation/images/readme/userStory.png and /dev/null differ
Quick deploy
+
Business Scenario
-||
+||
|---|
@@ -148,7 +148,7 @@ By using the *Multi-Agent Custom Automation Engine* solution accelerator, users
-
+
Supporting documentation
@@ -185,7 +185,7 @@ Have questions, find a bug, or want to request a feature? [Submit a new issue](h
## Responsible AI Transparency FAQ
-Please refer to [Transparency FAQ](./documentation/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
+Please refer to [Transparency FAQ](./docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
diff --git a/documentation/AzureAccountSetUp.md b/docs/AzureAccountSetUp.md
similarity index 100%
rename from documentation/AzureAccountSetUp.md
rename to docs/AzureAccountSetUp.md
diff --git a/documentation/AzureGPTQuotaSettings.md b/docs/AzureGPTQuotaSettings.md
similarity index 100%
rename from documentation/AzureGPTQuotaSettings.md
rename to docs/AzureGPTQuotaSettings.md
diff --git a/docs/CustomizeSolution.md b/docs/CustomizeSolution.md
index d07e02d86..160550a0f 100644
--- a/docs/CustomizeSolution.md
+++ b/docs/CustomizeSolution.md
@@ -1,3 +1,18 @@
+# Table of Contents
+
+- [Table of Contents](#table-of-contents)
+ - [Accelerating your own Multi-Agent - Custom Automation Engine MVP](#accelerating-your-own-multi-agent---custom-automation-engine-mvp)
+ - [Technical Overview](#technical-overview)
+ - [Adding a New Agent to the Multi-Agent System](#adding-a-new-agent-to-the-multi-agent-system)
+ - [API Reference](#api-reference)
+ - [Models and Datatypes](#models-and-datatypes)
+ - [Application Flow](#application-flow)
+ - [Agents Overview](#agents-overview)
+ - [Persistent Storage with Cosmos DB](#persistent-storage-with-cosmos-db)
+ - [Utilities](#utilities)
+ - [Summary](#summary)
+
+
# Accelerating your own Multi-Agent - Custom Automation Engine MVP
As the name suggests, this project is designed to accelerate development of Multi-Agent solutions in your environment. The example solution presented shows how such a solution would be implemented and provides example agent definitions along with stubs for possible tools those agents could use to accomplish tasks. You will want to implement real functions in your own environment, to be used by agents customized around your own use cases. Users can choose the LLM that is optimized for responsible use. The default LLM is GPT-4o which inherits the existing responsible AI mechanisms and filters from the LLM provider. We encourage developers to review [OpenAI’s Usage policies](https://openai.com/policies/usage-policies/) and [Azure OpenAI’s Code of Conduct](https://learn.microsoft.com/en-us/legal/cognitive-services/openai/code-of-conduct) when using GPT-4o. This document is designed to provide the in-depth technical information to allow you to add these customizations. Once the agents and tools have been developed, you will likely want to implement your own real world front end solution to replace the example in this accelerator.
@@ -15,21 +30,6 @@ This application is an AI-driven orchestration system that manages a group of AI
This code has not been tested as an end-to-end, reliable production application- it is a foundation to help accelerate building out multi-agent systems. You are encouraged to add your own data and functions to the agents, and then you must apply your own performance and safety evaluation testing frameworks to this system before deploying it.
Below, we'll dive into the details of each component, focusing on the endpoints, data types, and the flow of information through the system.
-# Table of Contents
-
-- [Table of Contents](#table-of-contents)
- - [Accelerating your own Multi-Agent - Custom Automation Engine MVP](#accelerating-your-own-multi-agent---custom-automation-engine-mvp)
- - [Technical Overview](#technical-overview)
- - [Adding a New Agent to the Multi-Agent System](#adding-a-new-agent-to-the-multi-agent-system)
- - [API Reference](#api-reference)
- - [Models and Datatypes](#models-and-datatypes)
- - [Application Flow](#application-flow)
- - [Agents Overview](#agents-overview)
- - [Persistent Storage with Cosmos DB](#persistent-storage-with-cosmos-db)
- - [Utilities](#utilities)
- - [Summary](#summary)
-
-
## Adding a New Agent to the Multi-Agent System
This guide details the steps required to add a new agent to the Multi-Agent Custom Automation Engine. The process includes registering the agent, defining its capabilities through tools, and ensuring the PlannerAgent includes the new agent when generating activity plans.
@@ -41,7 +41,6 @@ Every agent is equipped with a set of tools (functions) that it can call to perf
Example (for a `BakerAgent`):
```python
- from autogen_core.components.tools import FunctionTool, Tool
from typing import List
async def bake_cookies(cookie_type: str, quantity: int) -> str:
@@ -615,4 +614,4 @@ This application orchestrates a group of AI agents to accomplish user-defined ta
Understanding the flow of data through the endpoints, agents, and persistent storage is key to grasping the logic of the application. Each component plays a specific role in ensuring tasks are planned, executed, and adjusted based on feedback, providing a robust and interactive system.
-For instructions to setup a local development environment for the solution, please see [local deployment guide](./LocalDeployment.md).
+For instructions to setup a local development environment for the solution, please see [deployment guide](./DeploymentGuide.md).
diff --git a/documentation/DeleteResourceGroup.md b/docs/DeleteResourceGroup.md
similarity index 100%
rename from documentation/DeleteResourceGroup.md
rename to docs/DeleteResourceGroup.md
diff --git a/documentation/DeploymentGuide.md b/docs/DeploymentGuide.md
similarity index 99%
rename from documentation/DeploymentGuide.md
rename to docs/DeploymentGuide.md
index 420bfe90d..2b5cc5105 100644
--- a/documentation/DeploymentGuide.md
+++ b/docs/DeploymentGuide.md
@@ -2,7 +2,7 @@
## **Pre-requisites**
-To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups, resources, app registrations, and assign roles at the resource group level**. This should include Contributor role at the subscription level and Role Based Access Control role on the subscription and/or resource group level. Follow the steps in [Azure Account Set Up](../documentation/AzureAccountSetUp.md).
+To deploy this solution accelerator, ensure you have access to an [Azure subscription](https://azure.microsoft.com/free/) with the necessary permissions to create **resource groups, resources, app registrations, and assign roles at the resource group level**. This should include Contributor role at the subscription level and Role Based Access Control role on the subscription and/or resource group level. Follow the steps in [Azure Account Set Up](../docs/AzureAccountSetUp.md).
Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all®ions=all) page and select a **region** where the following services are available:
@@ -223,7 +223,7 @@ This guide provides step-by-step instructions for deploying your application usi
There are several ways to deploy the solution. You can deploy to run in Azure in one click, or manually, or you can deploy locally.
-When Deployment is complete, follow steps in [Set Up Authentication in Azure App Service](../documentation/azure_app_service_auth_setup.md) to add app authentication to your web app running on Azure App Service
+When Deployment is complete, follow steps in [Set Up Authentication in Azure App Service](../docs/azure_app_service_auth_setup.md) to add app authentication to your web app running on Azure App Service
# Local setup
diff --git a/documentation/ManualAzureDeployment.md b/docs/ManualAzureDeployment.md
similarity index 100%
rename from documentation/ManualAzureDeployment.md
rename to docs/ManualAzureDeployment.md
diff --git a/documentation/SampleQuestions.md b/docs/SampleQuestions.md
similarity index 100%
rename from documentation/SampleQuestions.md
rename to docs/SampleQuestions.md
diff --git a/documentation/TRANSPARENCY_FAQ.md b/docs/TRANSPARENCY_FAQ.md
similarity index 100%
rename from documentation/TRANSPARENCY_FAQ.md
rename to docs/TRANSPARENCY_FAQ.md
diff --git a/docs/azure_app_service_auth_setup.md b/docs/azure_app_service_auth_setup.md
index 6026b69ef..f73ff8e58 100644
--- a/docs/azure_app_service_auth_setup.md
+++ b/docs/azure_app_service_auth_setup.md
@@ -1,20 +1,28 @@
# Set Up Authentication in Azure App Service
+This document provides step-by-step instructions to configure Azure App Registrations for a front-end application.
+
+## Prerequisites
+
+- Access to **Microsoft Entra ID**
+- Necessary permissions to create and manage **App Registrations**
+
## Step 1: Add Authentication in Azure App Service configuration
1. Click on `Authentication` from left menu.
-2. Click on `+ Add Provider` to see a list of identity providers.
+2. Click on `+ Add identity provider` to see a list of identity providers.
-3. Click on `+ Add Provider` to see a list of identity providers.
+3. Click on `Identity Provider` dropdown to see a list of identity providers.
-4. Select the first option `Microsoft Entra Id` from the drop-down list. If `Create new app registration` is disabled, go to [Step 1a](#step-1a-creating-a-new-app-registration).
+4. Select the first option `Microsoft Entra Id` from the drop-down list and select `client secret expiration` under App registration.
+> NOTE: If `Create new app registration` is disabled, then go to [Create new app registration](/docs/create_new_app_registration.md) and come back to this step to complete the app authentication.
@@ -22,37 +30,4 @@
-### Step 1a: Creating a new App Registration
-
-1. Click on `Home` and select `Microsoft Entra ID`.
-
-
-
-2. Click on `App registrations`.
-
-
-
-3. Click on `+ New registration`.
-
-
-
-4. Provide the `Name`, select supported account types as `Accounts in this organizational directory only(Contoso only - Single tenant)`, select platform as `Web`, enter/select the `URL` and register.
-
-
-
-5. After application is created sucessfully, then click on `Add a Redirect URL`.
-
-
-
-6. Click on `+ Add a platform`.
-
-
-
-7. Click on `Web`.
-
-
-
-8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Step 1](#step-1-add-authentication-in-azure-app-service-configuration) and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name.
-E.g. <>.azurewebsites.net/.auth/login/aad/callback>>
-
-
+6. You have successfully added app authentication, and now required to log in to access the application.
diff --git a/docs/create_new_app_registration.md b/docs/create_new_app_registration.md
new file mode 100644
index 000000000..28edbf452
--- /dev/null
+++ b/docs/create_new_app_registration.md
@@ -0,0 +1,35 @@
+# Creating a new App Registration
+
+1. Click on `Home` and select `Microsoft Entra ID`.
+
+
+
+2. Click on `App registrations`.
+
+
+
+3. Click on `+ New registration`.
+
+
+
+4. Provide the `Name`, select supported account types as `Accounts in this organizational directory only(Contoso only - Single tenant)`, select platform as `Web`, enter/select the `URL` and register.
+
+
+
+5. After application is created successfully, then click on `Add a Redirect URL`.
+
+
+
+6. Click on `+ Add a platform`.
+
+
+
+7. Click on `Web`.
+
+
+
+8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Set Up Authentication in Azure App Service](azure_app_service_auth_setup.md) Step 1 page and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name.
+
+E.g. <>.azurewebsites.net/.auth/login/aad/callback>>
+
+
diff --git a/documentation/images/DeleteRG.png b/docs/images/DeleteRG.png
similarity index 100%
rename from documentation/images/DeleteRG.png
rename to docs/images/DeleteRG.png
diff --git a/documentation/images/MACAE-GP1.png b/docs/images/MACAE-GP1.png
similarity index 100%
rename from documentation/images/MACAE-GP1.png
rename to docs/images/MACAE-GP1.png
diff --git a/documentation/images/MACAE-GP2.png b/docs/images/MACAE-GP2.png
similarity index 100%
rename from documentation/images/MACAE-GP2.png
rename to docs/images/MACAE-GP2.png
diff --git a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png
index 4cf476ad5..ca9ea30fb 100644
Binary files a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png and b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png differ
diff --git a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png
index a57f0769e..17ccf135c 100644
Binary files a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png and b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png differ
diff --git a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png
index d839d27eb..ea94ce814 100644
Binary files a/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png and b/docs/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png differ
diff --git a/docs/images/azure-app-service-auth-setup/AppAuthentication.png b/docs/images/azure-app-service-auth-setup/AppAuthentication.png
index 286e10207..e2a8ca000 100644
Binary files a/docs/images/azure-app-service-auth-setup/AppAuthentication.png and b/docs/images/azure-app-service-auth-setup/AppAuthentication.png differ
diff --git a/docs/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png b/docs/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png
index d839d27eb..79f458125 100644
Binary files a/docs/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png and b/docs/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png differ
diff --git a/documentation/images/deleteservices.png b/docs/images/deleteservices.png
similarity index 100%
rename from documentation/images/deleteservices.png
rename to docs/images/deleteservices.png
diff --git a/documentation/images/git_bash.png b/docs/images/git_bash.png
similarity index 100%
rename from documentation/images/git_bash.png
rename to docs/images/git_bash.png
diff --git a/documentation/images/quota-check-output.png b/docs/images/quota-check-output.png
similarity index 100%
rename from documentation/images/quota-check-output.png
rename to docs/images/quota-check-output.png
diff --git a/documentation/images/readme/business-scenario.png b/docs/images/readme/business-scenario.png
similarity index 100%
rename from documentation/images/readme/business-scenario.png
rename to docs/images/readme/business-scenario.png
diff --git a/docs/images/readme/macae-architecture.png b/docs/images/readme/macae-architecture.png
index 36ccb432b..95826744e 100644
Binary files a/docs/images/readme/macae-architecture.png and b/docs/images/readme/macae-architecture.png differ
diff --git a/documentation/images/readme/quick-deploy.png b/docs/images/readme/quick-deploy.png
similarity index 100%
rename from documentation/images/readme/quick-deploy.png
rename to docs/images/readme/quick-deploy.png
diff --git a/documentation/images/readme/solution-overview.png b/docs/images/readme/solution-overview.png
similarity index 100%
rename from documentation/images/readme/solution-overview.png
rename to docs/images/readme/solution-overview.png
diff --git a/documentation/images/readme/supporting-documentation.png b/docs/images/readme/supporting-documentation.png
similarity index 100%
rename from documentation/images/readme/supporting-documentation.png
rename to docs/images/readme/supporting-documentation.png
diff --git a/documentation/images/resource-groups.png b/docs/images/resource-groups.png
similarity index 100%
rename from documentation/images/resource-groups.png
rename to docs/images/resource-groups.png
diff --git a/documentation/images/resourcegroup.png b/docs/images/resourcegroup.png
similarity index 100%
rename from documentation/images/resourcegroup.png
rename to docs/images/resourcegroup.png
diff --git a/documentation/quota_check.md b/docs/quota_check.md
similarity index 100%
rename from documentation/quota_check.md
rename to docs/quota_check.md
diff --git a/documentation/CustomizeSolution.md b/documentation/CustomizeSolution.md
deleted file mode 100644
index 160550a0f..000000000
--- a/documentation/CustomizeSolution.md
+++ /dev/null
@@ -1,617 +0,0 @@
-# Table of Contents
-
-- [Table of Contents](#table-of-contents)
- - [Accelerating your own Multi-Agent - Custom Automation Engine MVP](#accelerating-your-own-multi-agent---custom-automation-engine-mvp)
- - [Technical Overview](#technical-overview)
- - [Adding a New Agent to the Multi-Agent System](#adding-a-new-agent-to-the-multi-agent-system)
- - [API Reference](#api-reference)
- - [Models and Datatypes](#models-and-datatypes)
- - [Application Flow](#application-flow)
- - [Agents Overview](#agents-overview)
- - [Persistent Storage with Cosmos DB](#persistent-storage-with-cosmos-db)
- - [Utilities](#utilities)
- - [Summary](#summary)
-
-
-# Accelerating your own Multi-Agent - Custom Automation Engine MVP
-
-As the name suggests, this project is designed to accelerate development of Multi-Agent solutions in your environment. The example solution presented shows how such a solution would be implemented and provides example agent definitions along with stubs for possible tools those agents could use to accomplish tasks. You will want to implement real functions in your own environment, to be used by agents customized around your own use cases. Users can choose the LLM that is optimized for responsible use. The default LLM is GPT-4o which inherits the existing responsible AI mechanisms and filters from the LLM provider. We encourage developers to review [OpenAI’s Usage policies](https://openai.com/policies/usage-policies/) and [Azure OpenAI’s Code of Conduct](https://learn.microsoft.com/en-us/legal/cognitive-services/openai/code-of-conduct) when using GPT-4o. This document is designed to provide the in-depth technical information to allow you to add these customizations. Once the agents and tools have been developed, you will likely want to implement your own real world front end solution to replace the example in this accelerator.
-
-## Technical Overview
-
-This application is an AI-driven orchestration system that manages a group of AI agents to accomplish tasks based on user input. It uses a FastAPI backend to handle HTTP requests, processes them through various specialized agents, and stores stateful information using Azure Cosmos DB. The system is designed to:
-
-- Receive input tasks from users.
-- Generate a detailed plan to accomplish the task using a Planner agent.
-- Execute the plan by delegating steps to specialized agents (e.g., HR, Procurement, Marketing).
-- Incorporate human feedback into the workflow.
-- Maintain state across sessions with persistent storage.
-
-This code has not been tested as an end-to-end, reliable production application- it is a foundation to help accelerate building out multi-agent systems. You are encouraged to add your own data and functions to the agents, and then you must apply your own performance and safety evaluation testing frameworks to this system before deploying it.
-
-Below, we'll dive into the details of each component, focusing on the endpoints, data types, and the flow of information through the system.
-## Adding a New Agent to the Multi-Agent System
-
-This guide details the steps required to add a new agent to the Multi-Agent Custom Automation Engine. The process includes registering the agent, defining its capabilities through tools, and ensuring the PlannerAgent includes the new agent when generating activity plans.
-
-### **Step 1: Define the New Agent's Tools**
-Every agent is equipped with a set of tools (functions) that it can call to perform specific tasks. These tools need to be defined first.
-
-1. **Create New Tools**: In a new or existing file, define the tools your agent will use.
-
- Example (for a `BakerAgent`):
- ```python
- from typing import List
-
- async def bake_cookies(cookie_type: str, quantity: int) -> str:
- return f"Baked {quantity} {cookie_type} cookies."
-
- async def prepare_dough(dough_type: str) -> str:
- return f"Prepared {dough_type} dough."
-
- def get_baker_tools() -> List[Tool]:
- return [
- FunctionTool(bake_cookies, description="Bake cookies of a specific type.", name="bake_cookies"),
- FunctionTool(prepare_dough, description="Prepare dough of a specific type.", name="prepare_dough"),
- ]
- ```
-
-
-2. **Implement the Agent Class**
-Create a new agent class that inherits from `BaseAgent`.
-
-Example (for `BakerAgent`):
-```python
-from agents.base_agent import BaseAgent
-
-class BakerAgent(BaseAgent):
- def __init__(self, model_client, session_id, user_id, memory, tools, agent_id):
- super().__init__(
- "BakerAgent",
- model_client,
- session_id,
- user_id,
- memory,
- tools,
- agent_id,
- system_message="You are an AI Agent specialized in baking tasks.",
- )
-```
-### **Step 2: Register the new Agent in the messages**
-Update `messages.py` to include the new agent.
-
- ```python
- class BAgentType(str, Enum):
- baker_agent = "BakerAgent"
-```
-
-### **Step 3: Register the Agent in the Initialization Process**
-Update the `initialize_runtime_and_context` function in `utils.py` to include the new agent.
-
-1. **Import new agent**:
- ```python
- from agents.baker_agent import BakerAgent, get_baker_tools
- ```
-
-2. **Add the bakers tools**:
- ```python
- baker_tools = get_baker_tools()
- ```
-
-3. **Generate Agent IDs**:
- ```python
- baker_agent_id = AgentId("baker_agent", session_id)
- baker_tool_agent_id = AgentId("baker_tool_agent", session_id)
- ```
-
-4. **Register to ToolAgent**:
- ```python
- await ToolAgent.register(
- runtime,
- "baker_tool_agent",
- lambda: ToolAgent("Baker tool execution agent", baker_tools),
- )
- ```
-
-5. **Register the Agent and ToolAgent**:
- ```python
- await BakerAgent.register(
- runtime,
- baker_agent_id.type,
- lambda: BakerAgent(
- aoai_model_client,
- session_id,
- user_id,
- cosmos_memory,
- get_baker_tools(),
- baker_tool_agent_id,
- ),
- )
- ```
-6. **Add to agent_ids**:
- ```python
- agent_ids = {
- BAgentType.baker_agent: baker_agent_id,
- ```
-7. **Add to retrieve_all_agent_tools**:
- ```python
- def retrieve_all_agent_tools() -> List[Dict[str, Any]]:
- baker_tools: List[Tool] = get_baker_tools()
- ```
-8. **Append baker_tools to functions**:
- ```python
- for tool in baker_tools:
- functions.append(
- {
- "agent": "BakerAgent",
- "function": tool.name,
- "description": tool.description,
- "arguments": str(tool.schema["parameters"]["properties"]),
- }
- )
- ```
-### **Step 4: Update home page**
-Update `src/frontend/wwwroot/home/home.html` adding new html block
-
-1. **Add a new UI element was added to allow users to request baking tasks from the BakerAgent**
-```html
-
-
-
-
- Bake Cookies
- Please bake 12 chocolate chip cookies for tomorrow's event.
-
-
-
-```
-### **Step 5: Update tasks**
-Update `src/frontend/wwwroot/task/task.js`
-
-1. **Add `BakerAgent` as a recognized agent type in the frontend JavaScript file**
-```js
- case "BakerAgent":
- agentIcon = "manager";
- break;
-```
-### **Step 6: Validate the Integration**
-Deploy the updated system and ensure the new agent is properly included in the planning process. For example, if the user requests to bake cookies, the `PlannerAgent` should:
-
-- Identify the `BakerAgent` as the responsible agent.
-- Call `bake_cookies` or `prepare_dough` from the agent's toolset.
-
-### **Step 7: Update Documentation**
-Ensure that the system documentation reflects the addition of the new agent and its capabilities. Update the `README.md` and any related technical documentation to include information about the `BakerAgent`.
-
-### **Step 8: Testing**
-Thoroughly test the agent in both automated and manual scenarios. Verify that:
-
-- The agent responds correctly to tasks.
-- The PlannerAgent includes the new agent in relevant plans.
-- The agent's tools are executed as expected.
-
-Following these steps will successfully integrate a new agent into the Multi-Agent Custom Automation Engine.
-
-### API Reference
-To view the API reference, go to the API endpoint in a browser and add "/docs". This will bring up a full Swagger environment and reference documentation for the REST API included with this accelerator. For example, ```https://macae-backend.eastus2.azurecontainerapps.io/docs```.
-If you prefer ReDoc, this is available by appending "/redoc".
-
-
-
-### Models and Datatypes
-#### Models
-##### **`BaseDataModel`**
-The `BaseDataModel` is a foundational class for creating structured data models using Pydantic. It provides the following attributes:
-
-- **`id`**: A unique identifier for the data, generated using `uuid`.
-- **`ts`**: An optional timestamp indicating when the model instance was created or modified.
-
-#### **`AgentMessage`**
-The `AgentMessage` model represents communication between agents and includes the following fields:
-
-- **`id`**: A unique identifier for the message, generated using `uuid`.
-- **`data_type`**: A literal value of `"agent_message"` to identify the message type.
-- **`session_id`**: The session associated with this message.
-- **`user_id`**: The ID of the user associated with this message.
-- **`plan_id`**: The ID of the related plan.
-- **`content`**: The content of the message.
-- **`source`**: The origin or sender of the message (e.g., an agent).
-- **`ts`**: An optional timestamp for when the message was created.
-- **`step_id`**: An optional ID of the step associated with this message.
-
-#### **`Session`**
-The `Session` model represents a user session and extends the `BaseDataModel`. It has the following attributes:
-
-- **`data_type`**: A literal value of `"session"` to identify the type of data.
-- **`current_status`**: The current status of the session (e.g., `active`, `completed`).
-- **`message_to_user`**: An optional field to store any messages sent to the user.
-- **`ts`**: An optional timestamp for the session's creation or last update.
-
-
-#### **`Plan`**
-The `Plan` model represents a high-level structure for organizing actions or tasks. It extends the `BaseDataModel` and includes the following attributes:
-
-- **`data_type`**: A literal value of `"plan"` to identify the data type.
-- **`session_id`**: The ID of the session associated with this plan.
-- **`initial_goal`**: A description of the initial goal derived from the user’s input.
-- **`overall_status`**: The overall status of the plan (e.g., `in_progress`, `completed`, `failed`).
-
-#### **`Step`**
-The `Step` model represents a discrete action or task within a plan. It extends the `BaseDataModel` and includes the following attributes:
-
-- **`data_type`**: A literal value of `"step"` to identify the data type.
-- **`plan_id`**: The ID of the plan the step belongs to.
-- **`action`**: The specific action or task to be performed.
-- **`agent`**: The name of the agent responsible for executing the step.
-- **`status`**: The status of the step (e.g., `planned`, `approved`, `completed`).
-- **`agent_reply`**: An optional response from the agent after executing the step.
-- **`human_feedback`**: Optional feedback provided by a user about the step.
-- **`updated_action`**: Optional modified action based on human feedback.
-- **`session_id`**: The session ID associated with the step.
-- **`user_id`**: The ID of the user providing feedback or interacting with the step.
-
-#### **`PlanWithSteps`**
-The `PlanWithSteps` model extends the `Plan` model and includes additional information about the steps in the plan. It has the following attributes:
-
-- **`steps`**: A list of `Step` objects associated with the plan.
-- **`total_steps`**: The total number of steps in the plan.
-- **`completed_steps`**: The number of steps that have been completed.
-- **`pending_steps`**: The number of steps that are pending approval or completion.
-
-**Additional Features**:
-The `PlanWithSteps` model provides methods to update step counts:
-- `update_step_counts()`: Calculates and updates the `total_steps`, `completed_steps`, and `pending_steps` fields based on the associated steps.
-
-#### **`InputTask`**
-The `InputTask` model represents the user’s initial input for creating a plan. It includes the following attributes:
-
-- **`session_id`**: An optional string for the session ID. If not provided, a new UUID will be generated.
-- **`description`**: A string describing the task or goal the user wants to accomplish.
-- **`user_id`**: The ID of the user providing the input.
-
-#### **`ApprovalRequest`**
-The `ApprovalRequest` model represents a request to approve a step or multiple steps. It includes the following attributes:
-
-- **`step_id`**: An optional string representing the specific step to approve. If not provided, the request applies to all steps.
-- **`plan_id`**: The ID of the plan containing the step(s) to approve.
-- **`session_id`**: The ID of the session associated with the approval request.
-- **`approved`**: A boolean indicating whether the step(s) are approved.
-- **`human_feedback`**: An optional string containing comments or feedback from the user.
-- **`updated_action`**: An optional string representing a modified action based on feedback.
-- **`user_id`**: The ID of the user making the approval request.
-
-
-#### **`HumanFeedback`**
-The `HumanFeedback` model captures user feedback on a specific step or plan. It includes the following attributes:
-
-- **`step_id`**: The ID of the step the feedback is related to.
-- **`plan_id`**: The ID of the plan containing the step.
-- **`session_id`**: The session ID associated with the feedback.
-- **`approved`**: A boolean indicating if the step is approved.
-- **`human_feedback`**: Optional comments or feedback provided by the user.
-- **`updated_action`**: Optional modified action based on the feedback.
-- **`user_id`**: The ID of the user providing the feedback.
-
-#### **`HumanClarification`**
-The `HumanClarification` model represents clarifications provided by the user about a plan. It includes the following attributes:
-
-- **`plan_id`**: The ID of the plan requiring clarification.
-- **`session_id`**: The session ID associated with the plan.
-- **`human_clarification`**: The clarification details provided by the user.
-- **`user_id`**: The ID of the user providing the clarification.
-
-#### **`ActionRequest`**
-The `ActionRequest` model captures a request to perform an action within the system. It includes the following attributes:
-
-- **`session_id`**: The session ID associated with the action request.
-- **`plan_id`**: The ID of the plan associated with the action.
-- **`step_id`**: Optional ID of the step associated with the action.
-- **`action`**: A string describing the action to be performed.
-- **`user_id`**: The ID of the user requesting the action.
-
-#### **`ActionResponse`**
-The `ActionResponse` model represents the response to an action request. It includes the following attributes:
-
-- **`status`**: A string indicating the status of the action (e.g., `success`, `failure`).
-- **`message`**: An optional string providing additional details or context about the action's result.
-- **`data`**: Optional data payload containing any relevant information from the action.
-- **`user_id`**: The ID of the user associated with the action response.
-
-#### **`PlanStateUpdate`**
-The `PlanStateUpdate` model represents an update to the state of a plan. It includes the following attributes:
-
-- **`plan_id`**: The ID of the plan being updated.
-- **`session_id`**: The session ID associated with the plan.
-- **`new_state`**: A string representing the new state of the plan (e.g., `in_progress`, `completed`, `failed`).
-- **`user_id`**: The ID of the user making the state update.
-- **`timestamp`**: An optional timestamp indicating when the update was made.
-
----
-
-#### **`GroupChatMessage`**
-The `GroupChatMessage` model represents a message sent in a group chat context. It includes the following attributes:
-
-- **`message_id`**: A unique ID for the message.
-- **`session_id`**: The session ID associated with the group chat.
-- **`user_id`**: The ID of the user sending the message.
-- **`content`**: The text content of the message.
-- **`timestamp`**: A timestamp indicating when the message was sent.
-
----
-
-#### **`RequestToSpeak`**
-The `RequestToSpeak` model represents a user's request to speak or take action in a group chat or collaboration session. It includes the following attributes:
-
-- **`request_id`**: A unique ID for the request.
-- **`session_id`**: The session ID associated with the request.
-- **`user_id`**: The ID of the user making the request.
-- **`reason`**: A string describing the reason or purpose of the request.
-- **`timestamp`**: A timestamp indicating when the request was made.
-
-
-### Data Types
-
-#### **`DataType`**
-The `DataType` enumeration defines the types of data used in the system. Possible values include:
-- **`plan`**: Represents a plan data type.
-- **`session`**: Represents a session data type.
-- **`step`**: Represents a step data type.
-- **`agent_message`**: Represents an agent message data type.
-
----
-
-#### **`BAgentType`**
-The `BAgentType` enumeration defines the types of agents in the system. Possible values include:
-- **`human`**: Represents a human agent.
-- **`ai_assistant`**: Represents an AI assistant agent.
-- **`external_service`**: Represents an external service agent.
-
-#### **`StepStatus`**
-The `StepStatus` enumeration defines the possible statuses for a step. Possible values include:
-- **`planned`**: Indicates the step is planned but not yet approved or completed.
-- **`approved`**: Indicates the step has been approved.
-- **`completed`**: Indicates the step has been completed.
-- **`failed`**: Indicates the step has failed.
-
-
-#### **`PlanStatus`**
-The `PlanStatus` enumeration defines the possible statuses for a plan. Possible values include:
-- **`in_progress`**: Indicates the plan is currently in progress.
-- **`completed`**: Indicates the plan has been successfully completed.
-- **`failed`**: Indicates the plan has failed.
-
-
-#### **`HumanFeedbackStatus`**
-The `HumanFeedbackStatus` enumeration defines the possible statuses for human feedback. Possible values include:
-- **`pending`**: Indicates the feedback is awaiting review or action.
-- **`addressed`**: Indicates the feedback has been addressed.
-- **`rejected`**: Indicates the feedback has been rejected.
-
-
-### Application Flow
-
-#### **Initialization**
-
-The initialization process sets up the necessary agents and context for a session. This involves:
-
-- **Generating Unique AgentIds**: Each agent is assigned a unique `AgentId` based on the `session_id`, ensuring that multiple sessions can operate independently.
-- **Instantiating Agents**: Various agents, such as `PlannerAgent`, `HrAgent`, and `GroupChatManager`, are initialized and registered with unique `AgentIds`.
-- **Setting Up Azure OpenAI Client**: The Azure OpenAI Chat Completion Client is initialized to handle LLM interactions with support for function calling, JSON output, and vision handling.
-- **Creating Cosmos DB Context**: A `CosmosBufferedChatCompletionContext` is established for stateful interaction storage.
-
-**Code Reference: `utils.py`**
-
-**Steps:**
-1. **Session ID Generation**: If `session_id` is not provided, a new UUID is generated.
-2. **Agent Registration**: Each agent is assigned a unique `AgentId` and registered with the runtime.
-3. **Azure OpenAI Initialization**: The LLM client is configured for advanced interactions.
-4. **Cosmos DB Context Creation**: A buffered context is created for storing stateful interactions.
-5. **Runtime Start**: The runtime is started, enabling communication and agent operation.
-
-
-
-### Input Task Handling
-
-When the `/input_task` endpoint receives an `InputTask`, it performs the following steps:
-
-1. Ensures a `session_id` is available.
-2. Calls `initialize` to set up agents and context for the session.
-3. Creates a `GroupChatManager` agent ID using the `session_id`.
-4. Sends the `InputTask` message to the `GroupChatManager`.
-5. Returns the `session_id` and `plan_id`.
-
-**Code Reference: `app.py`**
-
- @app.post("/input_task")
- async def input_task(input_task: InputTask):
- # Initialize session and agents
- # Send InputTask to GroupChatManager
- # Return status, session_id, and plan_id
-
-### Planning
-
-The `GroupChatManager` handles the `InputTask` by:
-
-1. Passing the `InputTask` to the `PlannerAgent`.
-2. The `PlannerAgent` generates a `Plan` with detailed `Steps`.
-3. The `PlannerAgent` uses LLM capabilities to create a structured plan based on the task description.
-4. The plan and steps are stored in the Cosmos DB context.
-5. The `GroupChatManager` starts processing the first step.
-
-**Code Reference: `group_chat_manager.py` and `planner.py`**
-
- # GroupChatManager.handle_input_task
- plan: Plan = await self.send_message(message, self.planner_agent_id)
- await self.memory.add_plan(plan)
- # Start processing steps
- await self.process_next_step(message.session_id)
-
- # PlannerAgent.handle_input_task
- plan, steps = await self.create_structured_message(...)
- await self.memory.add_plan(plan)
- for step in steps:
- await self.memory.add_step(step)
-
-### Step Execution and Approval
-
-For each step in the plan:
-
-1. The `GroupChatManager` retrieves the next planned step.
-2. It sends an `ApprovalRequest` to the `HumanAgent` to get human approval.
-3. The `HumanAgent` waits for human feedback (provided via the `/human_feedback` endpoint).
-4. The step status is updated to `awaiting_feedback`.
-
-**Code Reference: `group_chat_manager.py`**
-
- async def process_next_step(self, session_id: str):
- # Get plan and steps
- # Find next planned step
- # Update step status to 'awaiting_feedback'
- # Send ApprovalRequest to HumanAgent
-
-### Human Feedback
-
-The human can provide feedback on a step via the `/human_feedback` endpoint:
-
-1. The `HumanFeedback` message is received by the FastAPI app.
-2. The message is sent to the `HumanAgent`.
-3. The `HumanAgent` updates the step with the feedback.
-4. The `HumanAgent` sends the feedback to the `GroupChatManager`.
-5. The `GroupChatManager` either proceeds to execute the step or handles rejections.
-
-**Code Reference: `app.py` and `human.py`**
-
- # app.py
- @app.post("/human_feedback")
- async def human_feedback(human_feedback: HumanFeedback):
- # Send HumanFeedback to HumanAgent
-
- # human.py
- @message_handler
- async def handle_human_feedback(self, message: HumanFeedback, ctx: MessageContext):
- # Update step with feedback
- # Send feedback back to GroupChatManager
-
-### Action Execution by Specialized Agents
-
-If a step is approved:
-
-1. The `GroupChatManager` sends an `ActionRequest` to the appropriate specialized agent (e.g., `HrAgent`, `ProcurementAgent`).
-2. The specialized agent executes the action using tools and LLMs.
-3. The agent sends an `ActionResponse` back to the `GroupChatManager`.
-4. The `GroupChatManager` updates the step status and proceeds to the next step.
-
-**Code Reference: `group_chat_manager.py` and `base_agent.py`**
-
- # GroupChatManager.execute_step
- action_request = ActionRequest(...)
- await self.send_message(action_request, agent_id)
-
- # BaseAgent.handle_action_request
- # Execute action using tools and LLM
- # Update step status
- # Send ActionResponse back to GroupChatManager
-
-## Agents Overview
-
-### GroupChatManager
-
-**Role:** Orchestrates the entire workflow.
-**Responsibilities:**
-
-- Receives `InputTask` from the user.
-- Interacts with `PlannerAgent` to generate a plan.
-- Manages the execution and approval process of each step.
-- Handles human feedback and directs approved steps to the appropriate agents.
-
-**Code Reference: `group_chat_manager.py`**
-
-### PlannerAgent
-
-**Role:** Generates a detailed plan based on the input task.
-**Responsibilities:**
-
-- Parses the task description.
-- Creates a structured plan with specific actions and agents assigned to each step.
-- Stores the plan in the context.
-- Handles re-planning if steps fail.
-
-**Code Reference: `planner.py`**
-
-### HumanAgent
-
-**Role:** Interfaces with the human user for approvals and feedback.
-**Responsibilities:**
-
-- Receives `ApprovalRequest` messages.
-- Waits for human feedback (provided via the API).
-- Updates steps in the context based on feedback.
-- Communicates feedback back to the `GroupChatManager`.
-
-**Code Reference: `human.py`**
-
-### Specialized Agents
-
-**Types:** `HrAgent`, `LegalAgent`, `MarketingAgent`, etc.
-**Role:** Execute specific actions related to their domain.
-**Responsibilities:**
-
-- Receive `ActionRequest` messages.
-- Perform actions using tools and LLM capabilities.
-- Provide results and update steps in the context.
-- Communicate `ActionResponse` back to the `GroupChatManager`.
-
-**Common Implementation:**
-All specialized agents inherit from `BaseAgent`, which handles common functionality.
-**Code Reference:** `base_agent.py`, `hr.py`, etc.
-
-
-
-## Persistent Storage with Cosmos DB
-
-The application uses Azure Cosmos DB to store and retrieve session data, plans, steps, and messages. This ensures that the state is maintained across different components and can handle multiple sessions concurrently.
-
-**Key Points:**
-
-- **Session Management:** Stores session information and current status.
-- **Plan Storage:** Plans are saved and can be retrieved or updated.
-- **Step Tracking:** Each step's status, actions, and feedback are stored.
-- **Message History:** Chat messages between agents are stored for context.
-
-**Cosmos DB Client Initialization:**
-
-- Uses `ClientSecretCredential` for authentication.
-- Asynchronous operations are used throughout to prevent blocking.
-
-**Code Reference: `cosmos_memory.py`**
-
-## Utilities
-
-### `initialize` Function
-
-**Location:** `utils.py`
-**Purpose:** Initializes agents and context for a session, ensuring that each session has its own unique agents and runtime.
-**Key Actions:**
-
-- Generates unique AgentIds with the `session_id`.
-- Creates instances of agents and registers them with the runtime.
-- Initializes `CosmosBufferedChatCompletionContext` for session-specific storage.
-- Starts the runtime.
-
-**Example Usage:**
-
- runtime, cosmos_memory = await initialize(input_task.session_id)
-
-## Summary
-
-This application orchestrates a group of AI agents to accomplish user-defined tasks by:
-
-- Accepting tasks via HTTP endpoints.
-- Generating detailed plans using LLMs.
-- Delegating actions to specialized agents.
-- Incorporating human feedback.
-- Maintaining state using Azure Cosmos DB.
-
-Understanding the flow of data through the endpoints, agents, and persistent storage is key to grasping the logic of the application. Each component plays a specific role in ensuring tasks are planned, executed, and adjusted based on feedback, providing a robust and interactive system.
-
-For instructions to setup a local development environment for the solution, please see [deployment guide](./DeploymentGuide.md).
diff --git a/documentation/azure_app_service_auth_setup.md b/documentation/azure_app_service_auth_setup.md
deleted file mode 100644
index 8829e8a9f..000000000
--- a/documentation/azure_app_service_auth_setup.md
+++ /dev/null
@@ -1,58 +0,0 @@
-# Set Up Authentication in Azure App Service
-
-## Step 1: Add Authentication in Azure App Service configuration
-
-1. Click on `Authentication` from left menu.
-
-
-
-2. Click on `+ Add Provider` to see a list of identity providers.
-
-
-
-3. Click on `+ Add Provider` to see a list of identity providers.
-
-
-
-4. Select the first option `Microsoft Entra Id` from the drop-down list. If `Create new app registration` is disabled, go to [Step 1a](#step-1a-creating-a-new-app-registration).
-
-
-
-5. Accept the default values and click on `Add` button to go back to the previous page with the identity provider added.
-
-
-
-### Step 1a: Creating a new App Registration
-
-1. Click on `Home` and select `Microsoft Entra ID`.
-
-
-
-2. Click on `App registrations`.
-
-
-
-3. Click on `+ New registration`.
-
-
-
-4. Provide the `Name`, select supported account types as `Accounts in this organizational directory only(Contoso only - Single tenant)`, select platform as `Web`, enter/select the `URL` and register.
-
-
-
-5. After application is created successfully, then click on `Add a Redirect URL`.
-
-
-
-6. Click on `+ Add a platform`.
-
-
-
-7. Click on `Web`.
-
-
-
-8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Step 1](#step-1-add-authentication-in-azure-app-service-configuration) and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name.
-E.g. <>.azurewebsites.net/.auth/login/aad/callback>>
-
-
diff --git a/documentation/images/azure-app-service-auth-setup/AddDetails.png b/documentation/images/azure-app-service-auth-setup/AddDetails.png
deleted file mode 100644
index f36b596f2..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AddDetails.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AddPlatform.png b/documentation/images/azure-app-service-auth-setup/AddPlatform.png
deleted file mode 100644
index 6c74919b4..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AddPlatform.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AddRedirectURL.png b/documentation/images/azure-app-service-auth-setup/AddRedirectURL.png
deleted file mode 100644
index d5cbcfac4..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AddRedirectURL.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png b/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png
deleted file mode 100644
index 4cf476ad5..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProvider.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png b/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png
deleted file mode 100644
index a57f0769e..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png b/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png
deleted file mode 100644
index d839d27eb..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AppAuthentication.png b/documentation/images/azure-app-service-auth-setup/AppAuthentication.png
deleted file mode 100644
index 286e10207..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AppAuthentication.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png b/documentation/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png
deleted file mode 100644
index d839d27eb..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/AppAuthenticationIdentity.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/Appregistrations.png b/documentation/images/azure-app-service-auth-setup/Appregistrations.png
deleted file mode 100644
index af2d3ae44..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/Appregistrations.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/MicrosoftEntraID.png b/documentation/images/azure-app-service-auth-setup/MicrosoftEntraID.png
deleted file mode 100644
index 1f24b89d0..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/MicrosoftEntraID.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/NewRegistration.png b/documentation/images/azure-app-service-auth-setup/NewRegistration.png
deleted file mode 100644
index 288f9af5a..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/NewRegistration.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/Web.png b/documentation/images/azure-app-service-auth-setup/Web.png
deleted file mode 100644
index 35f846453..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/Web.png and /dev/null differ
diff --git a/documentation/images/azure-app-service-auth-setup/WebAppURL.png b/documentation/images/azure-app-service-auth-setup/WebAppURL.png
deleted file mode 100644
index 40c6740e9..000000000
Binary files a/documentation/images/azure-app-service-auth-setup/WebAppURL.png and /dev/null differ
diff --git a/documentation/images/customize_solution/logic_flow.svg b/documentation/images/customize_solution/logic_flow.svg
deleted file mode 100644
index 9914ae8a6..000000000
--- a/documentation/images/customize_solution/logic_flow.svg
+++ /dev/null
@@ -1,4 +0,0 @@
-
-
-
-
\ No newline at end of file
diff --git a/documentation/images/customize_solution/redoc_ui.png b/documentation/images/customize_solution/redoc_ui.png
deleted file mode 100644
index cd7e445b4..000000000
Binary files a/documentation/images/customize_solution/redoc_ui.png and /dev/null differ
diff --git a/documentation/images/readme/customerTruth.png b/documentation/images/readme/customerTruth.png
deleted file mode 100644
index 20cc799b1..000000000
Binary files a/documentation/images/readme/customerTruth.png and /dev/null differ
diff --git a/documentation/images/readme/macae-application.png b/documentation/images/readme/macae-application.png
deleted file mode 100644
index 923c3ad23..000000000
Binary files a/documentation/images/readme/macae-application.png and /dev/null differ
diff --git a/documentation/images/readme/macae-architecture.png b/documentation/images/readme/macae-architecture.png
deleted file mode 100644
index 95826744e..000000000
Binary files a/documentation/images/readme/macae-architecture.png and /dev/null differ
diff --git a/documentation/images/readme/oneClickDeploy.png b/documentation/images/readme/oneClickDeploy.png
deleted file mode 100644
index 846e0e1fb..000000000
Binary files a/documentation/images/readme/oneClickDeploy.png and /dev/null differ
diff --git a/documentation/images/readme/userStory.png b/documentation/images/readme/userStory.png
deleted file mode 100644
index ba485f545..000000000
Binary files a/documentation/images/readme/userStory.png and /dev/null differ
Supporting documentation
-
-```
-### **Step 5: Update tasks**
-Update `src/frontend/wwwroot/task/task.js`
-
-1. **Add `BakerAgent` as a recognized agent type in the frontend JavaScript file**
-```js
- case "BakerAgent":
- agentIcon = "manager";
- break;
-```
-### **Step 6: Validate the Integration**
-Deploy the updated system and ensure the new agent is properly included in the planning process. For example, if the user requests to bake cookies, the `PlannerAgent` should:
-
-- Identify the `BakerAgent` as the responsible agent.
-- Call `bake_cookies` or `prepare_dough` from the agent's toolset.
-
-### **Step 7: Update Documentation**
-Ensure that the system documentation reflects the addition of the new agent and its capabilities. Update the `README.md` and any related technical documentation to include information about the `BakerAgent`.
-
-### **Step 8: Testing**
-Thoroughly test the agent in both automated and manual scenarios. Verify that:
-
-- The agent responds correctly to tasks.
-- The PlannerAgent includes the new agent in relevant plans.
-- The agent's tools are executed as expected.
-
-Following these steps will successfully integrate a new agent into the Multi-Agent Custom Automation Engine.
-
-### API Reference
-To view the API reference, go to the API endpoint in a browser and add "/docs". This will bring up a full Swagger environment and reference documentation for the REST API included with this accelerator. For example, ```https://macae-backend.eastus2.azurecontainerapps.io/docs```.
-If you prefer ReDoc, this is available by appending "/redoc".
-
-
-
-### Models and Datatypes
-#### Models
-##### **`BaseDataModel`**
-The `BaseDataModel` is a foundational class for creating structured data models using Pydantic. It provides the following attributes:
-
-- **`id`**: A unique identifier for the data, generated using `uuid`.
-- **`ts`**: An optional timestamp indicating when the model instance was created or modified.
-
-#### **`AgentMessage`**
-The `AgentMessage` model represents communication between agents and includes the following fields:
-
-- **`id`**: A unique identifier for the message, generated using `uuid`.
-- **`data_type`**: A literal value of `"agent_message"` to identify the message type.
-- **`session_id`**: The session associated with this message.
-- **`user_id`**: The ID of the user associated with this message.
-- **`plan_id`**: The ID of the related plan.
-- **`content`**: The content of the message.
-- **`source`**: The origin or sender of the message (e.g., an agent).
-- **`ts`**: An optional timestamp for when the message was created.
-- **`step_id`**: An optional ID of the step associated with this message.
-
-#### **`Session`**
-The `Session` model represents a user session and extends the `BaseDataModel`. It has the following attributes:
-
-- **`data_type`**: A literal value of `"session"` to identify the type of data.
-- **`current_status`**: The current status of the session (e.g., `active`, `completed`).
-- **`message_to_user`**: An optional field to store any messages sent to the user.
-- **`ts`**: An optional timestamp for the session's creation or last update.
-
-
-#### **`Plan`**
-The `Plan` model represents a high-level structure for organizing actions or tasks. It extends the `BaseDataModel` and includes the following attributes:
-
-- **`data_type`**: A literal value of `"plan"` to identify the data type.
-- **`session_id`**: The ID of the session associated with this plan.
-- **`initial_goal`**: A description of the initial goal derived from the user’s input.
-- **`overall_status`**: The overall status of the plan (e.g., `in_progress`, `completed`, `failed`).
-
-#### **`Step`**
-The `Step` model represents a discrete action or task within a plan. It extends the `BaseDataModel` and includes the following attributes:
-
-- **`data_type`**: A literal value of `"step"` to identify the data type.
-- **`plan_id`**: The ID of the plan the step belongs to.
-- **`action`**: The specific action or task to be performed.
-- **`agent`**: The name of the agent responsible for executing the step.
-- **`status`**: The status of the step (e.g., `planned`, `approved`, `completed`).
-- **`agent_reply`**: An optional response from the agent after executing the step.
-- **`human_feedback`**: Optional feedback provided by a user about the step.
-- **`updated_action`**: Optional modified action based on human feedback.
-- **`session_id`**: The session ID associated with the step.
-- **`user_id`**: The ID of the user providing feedback or interacting with the step.
-
-#### **`PlanWithSteps`**
-The `PlanWithSteps` model extends the `Plan` model and includes additional information about the steps in the plan. It has the following attributes:
-
-- **`steps`**: A list of `Step` objects associated with the plan.
-- **`total_steps`**: The total number of steps in the plan.
-- **`completed_steps`**: The number of steps that have been completed.
-- **`pending_steps`**: The number of steps that are pending approval or completion.
-
-**Additional Features**:
-The `PlanWithSteps` model provides methods to update step counts:
-- `update_step_counts()`: Calculates and updates the `total_steps`, `completed_steps`, and `pending_steps` fields based on the associated steps.
-
-#### **`InputTask`**
-The `InputTask` model represents the user’s initial input for creating a plan. It includes the following attributes:
-
-- **`session_id`**: An optional string for the session ID. If not provided, a new UUID will be generated.
-- **`description`**: A string describing the task or goal the user wants to accomplish.
-- **`user_id`**: The ID of the user providing the input.
-
-#### **`ApprovalRequest`**
-The `ApprovalRequest` model represents a request to approve a step or multiple steps. It includes the following attributes:
-
-- **`step_id`**: An optional string representing the specific step to approve. If not provided, the request applies to all steps.
-- **`plan_id`**: The ID of the plan containing the step(s) to approve.
-- **`session_id`**: The ID of the session associated with the approval request.
-- **`approved`**: A boolean indicating whether the step(s) are approved.
-- **`human_feedback`**: An optional string containing comments or feedback from the user.
-- **`updated_action`**: An optional string representing a modified action based on feedback.
-- **`user_id`**: The ID of the user making the approval request.
-
-
-#### **`HumanFeedback`**
-The `HumanFeedback` model captures user feedback on a specific step or plan. It includes the following attributes:
-
-- **`step_id`**: The ID of the step the feedback is related to.
-- **`plan_id`**: The ID of the plan containing the step.
-- **`session_id`**: The session ID associated with the feedback.
-- **`approved`**: A boolean indicating if the step is approved.
-- **`human_feedback`**: Optional comments or feedback provided by the user.
-- **`updated_action`**: Optional modified action based on the feedback.
-- **`user_id`**: The ID of the user providing the feedback.
-
-#### **`HumanClarification`**
-The `HumanClarification` model represents clarifications provided by the user about a plan. It includes the following attributes:
-
-- **`plan_id`**: The ID of the plan requiring clarification.
-- **`session_id`**: The session ID associated with the plan.
-- **`human_clarification`**: The clarification details provided by the user.
-- **`user_id`**: The ID of the user providing the clarification.
-
-#### **`ActionRequest`**
-The `ActionRequest` model captures a request to perform an action within the system. It includes the following attributes:
-
-- **`session_id`**: The session ID associated with the action request.
-- **`plan_id`**: The ID of the plan associated with the action.
-- **`step_id`**: Optional ID of the step associated with the action.
-- **`action`**: A string describing the action to be performed.
-- **`user_id`**: The ID of the user requesting the action.
-
-#### **`ActionResponse`**
-The `ActionResponse` model represents the response to an action request. It includes the following attributes:
-
-- **`status`**: A string indicating the status of the action (e.g., `success`, `failure`).
-- **`message`**: An optional string providing additional details or context about the action's result.
-- **`data`**: Optional data payload containing any relevant information from the action.
-- **`user_id`**: The ID of the user associated with the action response.
-
-#### **`PlanStateUpdate`**
-The `PlanStateUpdate` model represents an update to the state of a plan. It includes the following attributes:
-
-- **`plan_id`**: The ID of the plan being updated.
-- **`session_id`**: The session ID associated with the plan.
-- **`new_state`**: A string representing the new state of the plan (e.g., `in_progress`, `completed`, `failed`).
-- **`user_id`**: The ID of the user making the state update.
-- **`timestamp`**: An optional timestamp indicating when the update was made.
-
----
-
-#### **`GroupChatMessage`**
-The `GroupChatMessage` model represents a message sent in a group chat context. It includes the following attributes:
-
-- **`message_id`**: A unique ID for the message.
-- **`session_id`**: The session ID associated with the group chat.
-- **`user_id`**: The ID of the user sending the message.
-- **`content`**: The text content of the message.
-- **`timestamp`**: A timestamp indicating when the message was sent.
-
----
-
-#### **`RequestToSpeak`**
-The `RequestToSpeak` model represents a user's request to speak or take action in a group chat or collaboration session. It includes the following attributes:
-
-- **`request_id`**: A unique ID for the request.
-- **`session_id`**: The session ID associated with the request.
-- **`user_id`**: The ID of the user making the request.
-- **`reason`**: A string describing the reason or purpose of the request.
-- **`timestamp`**: A timestamp indicating when the request was made.
-
-
-### Data Types
-
-#### **`DataType`**
-The `DataType` enumeration defines the types of data used in the system. Possible values include:
-- **`plan`**: Represents a plan data type.
-- **`session`**: Represents a session data type.
-- **`step`**: Represents a step data type.
-- **`agent_message`**: Represents an agent message data type.
-
----
-
-#### **`BAgentType`**
-The `BAgentType` enumeration defines the types of agents in the system. Possible values include:
-- **`human`**: Represents a human agent.
-- **`ai_assistant`**: Represents an AI assistant agent.
-- **`external_service`**: Represents an external service agent.
-
-#### **`StepStatus`**
-The `StepStatus` enumeration defines the possible statuses for a step. Possible values include:
-- **`planned`**: Indicates the step is planned but not yet approved or completed.
-- **`approved`**: Indicates the step has been approved.
-- **`completed`**: Indicates the step has been completed.
-- **`failed`**: Indicates the step has failed.
-
-
-#### **`PlanStatus`**
-The `PlanStatus` enumeration defines the possible statuses for a plan. Possible values include:
-- **`in_progress`**: Indicates the plan is currently in progress.
-- **`completed`**: Indicates the plan has been successfully completed.
-- **`failed`**: Indicates the plan has failed.
-
-
-#### **`HumanFeedbackStatus`**
-The `HumanFeedbackStatus` enumeration defines the possible statuses for human feedback. Possible values include:
-- **`pending`**: Indicates the feedback is awaiting review or action.
-- **`addressed`**: Indicates the feedback has been addressed.
-- **`rejected`**: Indicates the feedback has been rejected.
-
-
-### Application Flow
-
-#### **Initialization**
-
-The initialization process sets up the necessary agents and context for a session. This involves:
-
-- **Generating Unique AgentIds**: Each agent is assigned a unique `AgentId` based on the `session_id`, ensuring that multiple sessions can operate independently.
-- **Instantiating Agents**: Various agents, such as `PlannerAgent`, `HrAgent`, and `GroupChatManager`, are initialized and registered with unique `AgentIds`.
-- **Setting Up Azure OpenAI Client**: The Azure OpenAI Chat Completion Client is initialized to handle LLM interactions with support for function calling, JSON output, and vision handling.
-- **Creating Cosmos DB Context**: A `CosmosBufferedChatCompletionContext` is established for stateful interaction storage.
-
-**Code Reference: `utils.py`**
-
-**Steps:**
-1. **Session ID Generation**: If `session_id` is not provided, a new UUID is generated.
-2. **Agent Registration**: Each agent is assigned a unique `AgentId` and registered with the runtime.
-3. **Azure OpenAI Initialization**: The LLM client is configured for advanced interactions.
-4. **Cosmos DB Context Creation**: A buffered context is created for storing stateful interactions.
-5. **Runtime Start**: The runtime is started, enabling communication and agent operation.
-
-
-
-### Input Task Handling
-
-When the `/input_task` endpoint receives an `InputTask`, it performs the following steps:
-
-1. Ensures a `session_id` is available.
-2. Calls `initialize` to set up agents and context for the session.
-3. Creates a `GroupChatManager` agent ID using the `session_id`.
-4. Sends the `InputTask` message to the `GroupChatManager`.
-5. Returns the `session_id` and `plan_id`.
-
-**Code Reference: `app.py`**
-
- @app.post("/input_task")
- async def input_task(input_task: InputTask):
- # Initialize session and agents
- # Send InputTask to GroupChatManager
- # Return status, session_id, and plan_id
-
-### Planning
-
-The `GroupChatManager` handles the `InputTask` by:
-
-1. Passing the `InputTask` to the `PlannerAgent`.
-2. The `PlannerAgent` generates a `Plan` with detailed `Steps`.
-3. The `PlannerAgent` uses LLM capabilities to create a structured plan based on the task description.
-4. The plan and steps are stored in the Cosmos DB context.
-5. The `GroupChatManager` starts processing the first step.
-
-**Code Reference: `group_chat_manager.py` and `planner.py`**
-
- # GroupChatManager.handle_input_task
- plan: Plan = await self.send_message(message, self.planner_agent_id)
- await self.memory.add_plan(plan)
- # Start processing steps
- await self.process_next_step(message.session_id)
-
- # PlannerAgent.handle_input_task
- plan, steps = await self.create_structured_message(...)
- await self.memory.add_plan(plan)
- for step in steps:
- await self.memory.add_step(step)
-
-### Step Execution and Approval
-
-For each step in the plan:
-
-1. The `GroupChatManager` retrieves the next planned step.
-2. It sends an `ApprovalRequest` to the `HumanAgent` to get human approval.
-3. The `HumanAgent` waits for human feedback (provided via the `/human_feedback` endpoint).
-4. The step status is updated to `awaiting_feedback`.
-
-**Code Reference: `group_chat_manager.py`**
-
- async def process_next_step(self, session_id: str):
- # Get plan and steps
- # Find next planned step
- # Update step status to 'awaiting_feedback'
- # Send ApprovalRequest to HumanAgent
-
-### Human Feedback
-
-The human can provide feedback on a step via the `/human_feedback` endpoint:
-
-1. The `HumanFeedback` message is received by the FastAPI app.
-2. The message is sent to the `HumanAgent`.
-3. The `HumanAgent` updates the step with the feedback.
-4. The `HumanAgent` sends the feedback to the `GroupChatManager`.
-5. The `GroupChatManager` either proceeds to execute the step or handles rejections.
-
-**Code Reference: `app.py` and `human.py`**
-
- # app.py
- @app.post("/human_feedback")
- async def human_feedback(human_feedback: HumanFeedback):
- # Send HumanFeedback to HumanAgent
-
- # human.py
- @message_handler
- async def handle_human_feedback(self, message: HumanFeedback, ctx: MessageContext):
- # Update step with feedback
- # Send feedback back to GroupChatManager
-
-### Action Execution by Specialized Agents
-
-If a step is approved:
-
-1. The `GroupChatManager` sends an `ActionRequest` to the appropriate specialized agent (e.g., `HrAgent`, `ProcurementAgent`).
-2. The specialized agent executes the action using tools and LLMs.
-3. The agent sends an `ActionResponse` back to the `GroupChatManager`.
-4. The `GroupChatManager` updates the step status and proceeds to the next step.
-
-**Code Reference: `group_chat_manager.py` and `base_agent.py`**
-
- # GroupChatManager.execute_step
- action_request = ActionRequest(...)
- await self.send_message(action_request, agent_id)
-
- # BaseAgent.handle_action_request
- # Execute action using tools and LLM
- # Update step status
- # Send ActionResponse back to GroupChatManager
-
-## Agents Overview
-
-### GroupChatManager
-
-**Role:** Orchestrates the entire workflow.
-**Responsibilities:**
-
-- Receives `InputTask` from the user.
-- Interacts with `PlannerAgent` to generate a plan.
-- Manages the execution and approval process of each step.
-- Handles human feedback and directs approved steps to the appropriate agents.
-
-**Code Reference: `group_chat_manager.py`**
-
-### PlannerAgent
-
-**Role:** Generates a detailed plan based on the input task.
-**Responsibilities:**
-
-- Parses the task description.
-- Creates a structured plan with specific actions and agents assigned to each step.
-- Stores the plan in the context.
-- Handles re-planning if steps fail.
-
-**Code Reference: `planner.py`**
-
-### HumanAgent
-
-**Role:** Interfaces with the human user for approvals and feedback.
-**Responsibilities:**
-
-- Receives `ApprovalRequest` messages.
-- Waits for human feedback (provided via the API).
-- Updates steps in the context based on feedback.
-- Communicates feedback back to the `GroupChatManager`.
-
-**Code Reference: `human.py`**
-
-### Specialized Agents
-
-**Types:** `HrAgent`, `LegalAgent`, `MarketingAgent`, etc.
-**Role:** Execute specific actions related to their domain.
-**Responsibilities:**
-
-- Receive `ActionRequest` messages.
-- Perform actions using tools and LLM capabilities.
-- Provide results and update steps in the context.
-- Communicate `ActionResponse` back to the `GroupChatManager`.
-
-**Common Implementation:**
-All specialized agents inherit from `BaseAgent`, which handles common functionality.
-**Code Reference:** `base_agent.py`, `hr.py`, etc.
-
-
-
-## Persistent Storage with Cosmos DB
-
-The application uses Azure Cosmos DB to store and retrieve session data, plans, steps, and messages. This ensures that the state is maintained across different components and can handle multiple sessions concurrently.
-
-**Key Points:**
-
-- **Session Management:** Stores session information and current status.
-- **Plan Storage:** Plans are saved and can be retrieved or updated.
-- **Step Tracking:** Each step's status, actions, and feedback are stored.
-- **Message History:** Chat messages between agents are stored for context.
-
-**Cosmos DB Client Initialization:**
-
-- Uses `ClientSecretCredential` for authentication.
-- Asynchronous operations are used throughout to prevent blocking.
-
-**Code Reference: `cosmos_memory.py`**
-
-## Utilities
-
-### `initialize` Function
-
-**Location:** `utils.py`
-**Purpose:** Initializes agents and context for a session, ensuring that each session has its own unique agents and runtime.
-**Key Actions:**
-
-- Generates unique AgentIds with the `session_id`.
-- Creates instances of agents and registers them with the runtime.
-- Initializes `CosmosBufferedChatCompletionContext` for session-specific storage.
-- Starts the runtime.
-
-**Example Usage:**
-
- runtime, cosmos_memory = await initialize(input_task.session_id)
-
-## Summary
-
-This application orchestrates a group of AI agents to accomplish user-defined tasks by:
-
-- Accepting tasks via HTTP endpoints.
-- Generating detailed plans using LLMs.
-- Delegating actions to specialized agents.
-- Incorporating human feedback.
-- Maintaining state using Azure Cosmos DB.
-
-Understanding the flow of data through the endpoints, agents, and persistent storage is key to grasping the logic of the application. Each component plays a specific role in ensuring tasks are planned, executed, and adjusted based on feedback, providing a robust and interactive system.
-
-For instructions to setup a local development environment for the solution, please see [deployment guide](./DeploymentGuide.md).
diff --git a/documentation/azure_app_service_auth_setup.md b/documentation/azure_app_service_auth_setup.md
deleted file mode 100644
index 8829e8a9f..000000000
--- a/documentation/azure_app_service_auth_setup.md
+++ /dev/null
@@ -1,58 +0,0 @@
-# Set Up Authentication in Azure App Service
-
-## Step 1: Add Authentication in Azure App Service configuration
-
-1. Click on `Authentication` from left menu.
-
-
-
-2. Click on `+ Add Provider` to see a list of identity providers.
-
-
-
-3. Click on `+ Add Provider` to see a list of identity providers.
-
-
-
-4. Select the first option `Microsoft Entra Id` from the drop-down list. If `Create new app registration` is disabled, go to [Step 1a](#step-1a-creating-a-new-app-registration).
-
-
-
-5. Accept the default values and click on `Add` button to go back to the previous page with the identity provider added.
-
-
-
-### Step 1a: Creating a new App Registration
-
-1. Click on `Home` and select `Microsoft Entra ID`.
-
-
-
-2. Click on `App registrations`.
-
-
-
-3. Click on `+ New registration`.
-
-
-
-4. Provide the `Name`, select supported account types as `Accounts in this organizational directory only(Contoso only - Single tenant)`, select platform as `Web`, enter/select the `URL` and register.
-
-
-
-5. After application is created successfully, then click on `Add a Redirect URL`.
-
-
-
-6. Click on `+ Add a platform`.
-
-
-
-7. Click on `Web`.
-
-
-
-8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Step 1](#step-1-add-authentication-in-azure-app-service-configuration) and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name.
-E.g. <
-
-
-
- Bake Cookies -
- - Bake Cookies -
Please bake 12 chocolate chip cookies for tomorrow's event.
-