Skip to content

Commit e1bdebe

Browse files
Update documentation and code comments for clarity and accuracy
1 parent 571bc88 commit e1bdebe

14 files changed

Lines changed: 50 additions & 28 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ This template uses Azure Key Vault to store all connections to communicate betwe
180180

181181
This template also uses [Managed Identity](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) for local development and deployment.
182182

183-
To ensure continued best practices in your own repository, we recommend that anyone creating solutions based on our templates ensure that the [Github secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning) setting is enabled.
183+
To ensure continued best practices in your own repository, we recommend that anyone creating solutions based on our templates ensure that the [GitHub secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning) setting is enabled.
184184

185185
You may want to consider additional security measures, such as:
186186

TRANSPARENCY_FAQS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ The system allows users to review, reorder and approve steps generated in a plan
2626

2727
## What operational factors and settings allow for effective and responsible use of Multi Agent: Custom Automation Engine – Solution Accelerator?
2828
Effective and responsible use of the Multi Agent: Custom Automation Engine – Solution Accelerator depends on several operational factors and settings. The system is designed to perform reliably and safely across a range of business tasks that it was evaluated for. Users can customize certain settings, such as the planning language model used by the system, the types of tasks that agents are assigned, and the specific actions that agents can take (e.g., sending emails or scheduling orientation sessions for new employees). However, it's important to note that these choices may impact the system's behavior in real-world scenarios.
29-
For example, selecting a planning language model that is not well-suited to the complexity of the tasks may result in lower accuracy and performance. Similarly, assigning tasks that are outside the system's intended scope may lead to errors or incomplete results. Users can choose the LLM that is optimized for responsible use. The default LLM is GPT-4o which inherits the existing RAI mechanisms and filters from the LLM provider. Caching is enabled by default to increase reliability and control cost. 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-40. To ensure effective and responsible use of the accelerator, users should carefully consider their choices and use the system within its intended scope.
29+
For example, selecting a planning language model that is not well-suited to the complexity of the tasks may result in lower accuracy and performance. Similarly, assigning tasks that are outside the system's intended scope may lead to errors or incomplete results. Users can choose the LLM that is optimized for responsible use. The default LLM is GPT-4.1 which inherits the existing RAI mechanisms and filters from the LLM provider. Caching is enabled by default to increase reliability and control cost. 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-4.1. To ensure effective and responsible use of the accelerator, users should carefully consider their choices and use the system within its intended scope.

docs/AVMPostDeploymentGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Before starting the post-deployment process, ensure you have the following:
2626

2727
2. **[Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli)** <small>(v2.50+)</small> - Command-line tool for managing Azure resources
2828

29-
3. **[Python](https://www.python.org/downloads/)** <small>(v4.9+ recommended)</small> - Required for data processing scripts
29+
3. **[Python](https://www.python.org/downloads/)** <small>(v3.9+ recommended)</small> - Required for data processing scripts
3030

3131
4. **[Git](https://git-scm.com/downloads/)** - Version control system for cloning the repository
3232
5. **[Bicep CLI](https://learn.microsoft.com/azure/azure-resource-manager/bicep/install)** <small>(v0.33.0+)</small> - Required for compiling infrastructure templates

docs/AzureGPTQuotaSettings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
3. **Go to** the `Management Center` from the bottom-left navigation menu.
66
4. Select `Quota`
77
- Click on the `GlobalStandard` dropdown.
8-
- Select the required **GPT model** (`GPT-4o`)
8+
- Select the required **GPT model** (`GPT-4.1`)
99
- Choose the **region** where the deployment is hosted.
1010
5. Request More Quota or delete any unused model deployments as needed.

docs/SampleQuestions.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@ To help you get started, here are some **Sample Prompts** you can ask in the app
66
## **Teams**
77
Select the Team option from the top-left section, then click Continue after choosing the desired team.
88

9-
> _Note: Five teams are available only if all teams are selected during post-deployment; otherwise, only selected teams are visible._
9+
> _Note: Six teams are available only if all teams are selected during post-deployment; otherwise, only selected teams are visible._
1010
- Retail
1111
- HR
1212
- Marketing
1313
- RFP
1414
- Contract Compliance
15+
- Retail Marketing Content Generation
1516

1617
![Application](images/samplequestion_1.png)
1718

@@ -117,5 +118,26 @@ _Sample operation:_
117118
> _Observe: It goes into "Thinking Process", "Processing your plan" and "coordinating with AI Agents"._ <br>
118119
> _Review the output._
119120
121+
### **Retail Marketing Content Generation Scenario**
122+
If you select the Retail Marketing Content Generation team, follow the prompts below.
123+
124+
>**Agents Used:** Triage, Planning, Research, Text Content, Image Content, Compliance
125+
126+
The Retail Marketing Content Generation Scenario allows users to generate end-to-end marketing assets (copy + image) for retail campaigns, grounded in the Contoso Paint product catalog. Key tasks include:
127+
128+
_Sample operation:_
129+
130+
- Task: Switch to the **"Retail Marketing Content Generation Team"** from the top left section and click **"Continue"** button.
131+
- Task: From the Quick Tasks, select **"Generate a social media post"** and submit it.
132+
133+
> _Note: Average response time is 30–60 seconds for plan generation._ <br>
134+
> _Observe: It will trigger the "Generating Plan Action" and give the Proposed Plan with 5 or more Steps (Planning → Research → Text Content → Image Content → Compliance)._
135+
</br>
136+
137+
- Task: Click on **"Approve Task Plan"** Button.
138+
> _Note: Average response time is around 2–3 minutes (image generation included)._ <br>
139+
> _Observe: It goes into "Thinking Process", "Processing your plan" and "coordinating with AI Agents". The final output includes marketing copy (headline, body, CTA, hashtags), a rendered campaign image, and a compliance review._ <br>
140+
> _Review the output._
141+
120142

121143
This structured approach ensures that users receive automated, AI-coordinated task execution and intelligent responses from specialized agents.

docs/TroubleShootingSteps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,4 +166,4 @@ Use these as quick reference guides to unblock your deployments.
166166
---------------------------------
167167

168168
💡 Note: If you encounter any other issues, you can refer to the [Common Deployment Errors](https://learn.microsoft.com/en-us/azure/azure-resource-manager/troubleshooting/common-deployment-errors) documentation.
169-
If the problem persists, you can also raise an bug in our [MACAE Github Issues](https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator/issues) for further support.
169+
If the problem persists, you can also raise a bug in our [MACAE GitHub Issues](https://github.com/microsoft/Multi-Agent-Custom-Automation-Engine-Solution-Accelerator/issues) for further support.

docs/mcp_server.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
Capturing the notes from auth install before deleting for docs...
22

33
### Auth section:
4-
Requires and app registration as in azure_app_service_auth_setup.md so not deployed by default.
4+
Requires an app registration as in azure_app_service_auth_setup.md so not deployed by default.
55

66
To setup basic auth with FastMCP - bearer token - you can integrate with Azure by using it as your token provider.
77

88
``` from fastmcp.server.auth import JWTVerifier```
99

1010
```
1111
auth = JWTVerifier(
12-
jwks_uri="https://login.microsoftonline.com/52b39610-0746-4c25-a83d-d4f89fadedfe/discovery/v2.0/keys",
13-
#issuer="https://login.microsoftonline.com/52b39610-0746-4c25-a83d-d4f89fadedfe/v2.0",
12+
jwks_uri="https://login.microsoftonline.com/<your-tenant-id>/discovery/v2.0/keys",
13+
#issuer="https://login.microsoftonline.com/<your-tenant-id>/v2.0",
1414
# This issuer is not correct in the docs. Found by decoding the token.
15-
issuer="https://sts.windows.net/52b39610-0746-4c25-a83d-d4f89fadedfe/",
15+
issuer="https://sts.windows.net/<your-tenant-id>/",
1616
algorithm="RS256",
17-
audience="api://7a95e70b-062e-4cd3-a88c-603fc70e1c73"
17+
audience="api://<your-app-client-id>"
1818
)
1919
```
2020

docs/quota_check.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Check Quota Availability Before Deployment
22

33
Before deploying the accelerator, **ensure sufficient quota availability** for the required model.
4-
> **For Global Standard | GPT-4o - the capacity to at least 150k tokens for optimal performance.**
4+
> **For Global Standard | GPT-4.1 - the capacity to at least 150k tokens for optimal performance.**
55
66
### Login if you have not done so already
77
```

src/App/src/commonComponents/modules/ChatExample.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ const ChatExample: React.FC = () => {
4545
<div className="bot-tag">BOT</div>
4646
</div>
4747
<div className="message-content">
48-
You got it! I've initiated a background check and everything looks good to go— You're ready to move onto helping Jessica set up and Office 365 account. Want me to hand that over to your Manager Agent?
48+
You got it! I've initiated a background check and everything looks good to go— You're ready to move onto helping Jessica set up an Office 365 account. Want me to hand that over to your Manager Agent?
4949
</div>
5050
<div className="message-actions">
5151
<button className="action-button">👍</button>

src/App/src/components/common/TeamSelector.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -721,7 +721,7 @@ const TeamSelector: React.FC<TeamSelectorProps> = ({
721721
Are you sure you want to delete "{teamToDelete?.name}"?
722722
</DialogTitle>
723723
<Text className={styles.deleteConfirmText}>
724-
This team configurations and its agents are shared across all users in the system. Deleting this team will permanently remove it for everyone, and this action cannot be undone.
724+
This team configuration and its agents are shared across all users in the system. Deleting this team will permanently remove it for everyone, and this action cannot be undone.
725725
</Text>
726726
</DialogBody>
727727
<div className={styles.deleteDialogActions}>

0 commit comments

Comments
 (0)