Skip to content

Commit 4c91fdd

Browse files
Merge pull request #236 from microsoft/psl-doc-update
docs: Updates in docs folder
2 parents 465a96c + 4b35974 commit 4c91fdd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+76
-746
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,22 @@ The Multi-Agent Custom Automation Engine solution accelerator allows users to sp
1515
</div>
1616
<br/>
1717

18-
<h2><img src="./documentation/images/readme/solution-overview.png" width="48" />
18+
<h2><img src="./docs/images/readme/solution-overview.png" width="48" />
1919
Solution overview
2020
</h2>
2121

2222
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.
2323

2424
### Solution architecture
25-
|![image](./documentation/images/readme/macae-architecture.png)|
25+
|![image](./docs/images/readme/macae-architecture.png)|
2626
|---|
2727

2828

2929

3030
### How to customize
3131
If you'd like to customize the solution accelerator, here are some common areas to start:
3232

33-
[Custom scenario](./documentation/CustomizeSolution.md)
33+
[Custom scenario](./docs/CustomizeSolution.md)
3434

3535
<br/>
3636

@@ -63,14 +63,14 @@ If you'd like to customize the solution accelerator, here are some common areas
6363
</details>
6464

6565
<br /><br />
66-
<h2><img src="./documentation/images/readme/quick-deploy.png" width="48" />
66+
<h2><img src="./docs/images/readme/quick-deploy.png" width="48" />
6767
Quick deploy
6868
</h2>
6969

7070
### How to install or deploy
7171
Follow the quick deploy steps on the deployment guide to deploy this solution to your own Azure subscription.
7272

73-
[Click here to launch the deployment guide](./documentation/DeploymentGuide.md)
73+
[Click here to launch the deployment guide](./docs/DeploymentGuide.md)
7474
<br/><br/>
7575

7676
| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator) | [![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](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
7979
<br/>
8080

8181
> ⚠️ **Important: Check Azure OpenAI Quota Availability**
82-
<br/>To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./documentation/quota_check.md) before you deploy the solution.
82+
<br/>To ensure sufficient quota is available in your subscription, please follow [quota check instructions guide](./docs/quota_check.md) before you deploy the solution.
8383
8484
<br/>
8585

8686
### Prerequisites and Costs
8787

88-
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).
88+
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).
8989

9090
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.
9191

@@ -107,11 +107,11 @@ Use the [Azure pricing calculator](https://azure.microsoft.com/en-us/pricing/cal
107107
either by deleting the resource group in the Portal or running `azd down`.
108108

109109
<br /><br />
110-
<h2><img src="./documentation/images/readme/business-scenario.png" width="48" />
110+
<h2><img src="./docs/images/readme/business-scenario.png" width="48" />
111111
Business Scenario
112112
</h2>
113113

114-
|![image](./documentation/images/readme/macae-application.png)|
114+
|![image](./docs/images/readme/macae-application.png)|
115115
|---|
116116

117117
<br/>
@@ -148,7 +148,7 @@ By using the *Multi-Agent Custom Automation Engine* solution accelerator, users
148148

149149
<br /><br />
150150

151-
<h2><img src="./documentation/images/readme/supporting-documentation.png" width="48" />
151+
<h2><img src="./docs/images/readme/supporting-documentation.png" width="48" />
152152
Supporting documentation
153153
</h2>
154154

@@ -185,7 +185,7 @@ Have questions, find a bug, or want to request a feature? [Submit a new issue](h
185185
<br/>
186186

187187
## Responsible AI Transparency FAQ
188-
Please refer to [Transparency FAQ](./documentation/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
188+
Please refer to [Transparency FAQ](./docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
189189

190190
<br/>
191191

File renamed without changes.
File renamed without changes.

docs/CustomizeSolution.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,18 @@
1+
# Table of Contents
2+
3+
- [Table of Contents](#table-of-contents)
4+
- [Accelerating your own Multi-Agent - Custom Automation Engine MVP](#accelerating-your-own-multi-agent---custom-automation-engine-mvp)
5+
- [Technical Overview](#technical-overview)
6+
- [Adding a New Agent to the Multi-Agent System](#adding-a-new-agent-to-the-multi-agent-system)
7+
- [API Reference](#api-reference)
8+
- [Models and Datatypes](#models-and-datatypes)
9+
- [Application Flow](#application-flow)
10+
- [Agents Overview](#agents-overview)
11+
- [Persistent Storage with Cosmos DB](#persistent-storage-with-cosmos-db)
12+
- [Utilities](#utilities)
13+
- [Summary](#summary)
14+
15+
116
# Accelerating your own Multi-Agent - Custom Automation Engine MVP
217

318
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
1530
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.
1631

1732
Below, we'll dive into the details of each component, focusing on the endpoints, data types, and the flow of information through the system.
18-
# Table of Contents
19-
20-
- [Table of Contents](#table-of-contents)
21-
- [Accelerating your own Multi-Agent - Custom Automation Engine MVP](#accelerating-your-own-multi-agent---custom-automation-engine-mvp)
22-
- [Technical Overview](#technical-overview)
23-
- [Adding a New Agent to the Multi-Agent System](#adding-a-new-agent-to-the-multi-agent-system)
24-
- [API Reference](#api-reference)
25-
- [Models and Datatypes](#models-and-datatypes)
26-
- [Application Flow](#application-flow)
27-
- [Agents Overview](#agents-overview)
28-
- [Persistent Storage with Cosmos DB](#persistent-storage-with-cosmos-db)
29-
- [Utilities](#utilities)
30-
- [Summary](#summary)
31-
32-
3333
## Adding a New Agent to the Multi-Agent System
3434

3535
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
4141

4242
Example (for a `BakerAgent`):
4343
```python
44-
from autogen_core.components.tools import FunctionTool, Tool
4544
from typing import List
4645

4746
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
615614

616615
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.
617616

618-
For instructions to setup a local development environment for the solution, please see [local deployment guide](./LocalDeployment.md).
617+
For instructions to setup a local development environment for the solution, please see [deployment guide](./DeploymentGuide.md).
File renamed without changes.

documentation/DeploymentGuide.md renamed to docs/DeploymentGuide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## **Pre-requisites**
44

5-
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).
5+
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).
66

77
Check the [Azure Products by Region](https://azure.microsoft.com/en-us/explore/global-infrastructure/products-by-region/?products=all&regions=all) page and select a **region** where the following services are available:
88

@@ -223,7 +223,7 @@ This guide provides step-by-step instructions for deploying your application usi
223223

224224
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.
225225

226-
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
226+
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
227227

228228
# Local setup
229229

File renamed without changes.
File renamed without changes.
File renamed without changes.
Lines changed: 12 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,33 @@
11
# Set Up Authentication in Azure App Service
22

3+
This document provides step-by-step instructions to configure Azure App Registrations for a front-end application.
4+
5+
## Prerequisites
6+
7+
- Access to **Microsoft Entra ID**
8+
- Necessary permissions to create and manage **App Registrations**
9+
310
## Step 1: Add Authentication in Azure App Service configuration
411

512
1. Click on `Authentication` from left menu.
613

714
![Authentication](./images/azure-app-service-auth-setup/AppAuthentication.png)
815

9-
2. Click on `+ Add Provider` to see a list of identity providers.
16+
2. Click on `+ Add identity provider` to see a list of identity providers.
1017

1118
![Authentication Identity](./images/azure-app-service-auth-setup/AppAuthenticationIdentity.png)
1219

13-
3. Click on `+ Add Provider` to see a list of identity providers.
20+
3. Click on `Identity Provider` dropdown to see a list of identity providers.
1421

1522
![Add Provider](./images/azure-app-service-auth-setup/AppAuthIdentityProvider.png)
1623

17-
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).
24+
4. Select the first option `Microsoft Entra Id` from the drop-down list and select `client secret expiration` under App registration.
25+
> 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.
1826
1927
![Add Provider](./images/azure-app-service-auth-setup/AppAuthIdentityProviderAdd.png)
2028

2129
5. Accept the default values and click on `Add` button to go back to the previous page with the idenity provider added.
2230

2331
![Add Provider](./images/azure-app-service-auth-setup/AppAuthIdentityProviderAdded.png)
2432

25-
### Step 1a: Creating a new App Registration
26-
27-
1. Click on `Home` and select `Microsoft Entra ID`.
28-
29-
![Microsoft Entra ID](./images/azure-app-service-auth-setup/MicrosoftEntraID.png)
30-
31-
2. Click on `App registrations`.
32-
33-
![App registrations](./images/azure-app-service-auth-setup/Appregistrations.png)
34-
35-
3. Click on `+ New registration`.
36-
37-
![New Registrations](./images/azure-app-service-auth-setup/NewRegistration.png)
38-
39-
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.
40-
41-
![Add Details](./images/azure-app-service-auth-setup/AddDetails.png)
42-
43-
5. After application is created sucessfully, then click on `Add a Redirect URL`.
44-
45-
![Redirect URL](./images/azure-app-service-auth-setup/AddRedirectURL.png)
46-
47-
6. Click on `+ Add a platform`.
48-
49-
![+ Add platform](./images/azure-app-service-auth-setup/AddPlatform.png)
50-
51-
7. Click on `Web`.
52-
53-
![Web](./images/azure-app-service-auth-setup/Web.png)
54-
55-
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.
56-
E.g. <<https://<< appservicename >>.azurewebsites.net/.auth/login/aad/callback>>
57-
58-
![Add Details](./images/azure-app-service-auth-setup/WebAppURL.png)
33+
6. You have successfully added app authentication, and now required to log in to access the application.

0 commit comments

Comments
 (0)