Skip to content

Commit 72029bd

Browse files
DocGailZhouCopilot
andauthored
docs: Docs update only (#17)
* updated image * Added data source description * Added additional instructoin on how to create data agent * simplified overviews * simplified solution overview text and moved some text into architecture section * made spikes more visbile for 1 * updated ui * Added agent UI * consistency check * resolved broken links * sample questions * Update docs/FabricDataAgentGuide.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/FabricDataAgentGuide.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/FabricDataAgentGuide.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent a910387 commit 72029bd

7 files changed

Lines changed: 35 additions & 12 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Real-Time Intelligence for Operations Solution Accelerator
22

3-
This solution accelerator provides the architecture and working solution for real-time intelligence for operations. We used simulated manufacturing facility asset data for the process flow. As real-time events are streamed in, anomalies are detected with notifications sent to a specified Outlook email account. The solution includes a customized Fabric Data Agent that provides a chat experience to answer users' questions with intelligence derived from the data.
3+
This solution accelerator provides a complete real-time intelligence platform for manufacturing operations. It analyzes live and historical telemetry data through interactive dashboards, automatically detects anomalies with email alerts, and includes an AI-powered data agent for conversational insights. The architecture and approach can be easily extended to other industries for broad adoption.
44

55
**Key use cases include:**
66

@@ -21,11 +21,11 @@ This solution accelerator provides the architecture and working solution for rea
2121
Solution overview
2222
</h2>
2323

24-
This solution accelerator provides a working solution for manufacturing asset performance monitoring, real-time anomaly detection, and anomaly notification. The manufacturing facility telemetry data is synthetically generated with the `Telemetry Data Simulator`. This architecture can be extended to other industries as long as the appropriate data is generated or actual operations data is ingested into the `Azure Event Hub`, and related component configurations and Kusto Query Language (KQL) code are updated accordingly. For a brief description of the architecture, please refer to [Solution Architecture Overview](./docs/TechnicalArchitecture.md).
24+
This solution accelerator delivers comprehensive asset monitoring, real-time anomaly detection, and automated notifications for manufacturing operations.
2525

2626
### Solution architecture
2727

28-
Below diagram illustrates the solution architecture.
28+
Below diagram illustrates the solution architecture. Synthetic telemetry data is generated by the `Telemetry Data Simulator`. The architecture easily adapts to other industries by connecting your own data sources to `Azure Event Hub` and customizing the dashboards and queries. For technical details, see the [Solution Architecture Overview](./docs/TechnicalArchitecture.md).
2929

3030
| ![image](./docs/images/readme/solution-architecture.png) |
3131
| -------------------------------------------------------- |
@@ -180,7 +180,7 @@ Use cases can be summarized as below:
180180
- **The solution provides multiple business functions with a simple architecture** <br/>
181181
The deployed solution provides real-time telemetry data monitoring, analysis, summarization, graphical reports, anomaly detection and notifications with a quick to deploy, secure, and simple architecture.
182182

183-
- **A Fabric Data Agent getting quick business intelligence without programming effort.** <br/>
183+
- **A Fabric Data Agent getting quick business intelligence without programming effort** <br/>
184184
The Fabric Data Agent can be quickly configured with instructions delivered in this solution accelerator, providing quick and accurate insights from data effortlessly. No programming skills are necessary.
185185

186186
- **Real-Time Intelligence for Operations Dashboard**<br/>

docs/AzureAccountSetUp.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
## Azure account setup
2+
3+
1. Sign up for a [free Azure account](https://azure.microsoft.com/free/) and create an Azure Subscription.
4+
2. Check that you have the necessary permissions:
5+
* Your Azure account must have `Microsoft.Authorization/roleAssignments/write` permissions, such as [Role Based Access Control Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#role-based-access-control-administrator-preview), [User Access Administrator](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#user-access-administrator), or [Owner](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#owner).
6+
* Your Azure account also needs `Microsoft.Resources/deployments/write` permissions on the subscription level.
7+
8+
You can view the permissions for your account and subscription by following the steps below:
9+
- Navigate to the [Azure Portal](https://portal.azure.com/) and click on `Subscriptions` under 'Navigation'
10+
- Select the subscription you are using for this accelerator from the list.
11+
- If you try to search for your subscription and it does not come up, make sure no filters are selected.
12+
- Select `Access control (IAM)` and you can see the roles that are assigned to your account for this subscription.
13+
- If you want to see more information about the roles, you can go to the `Role assignments`
14+
tab and search by your account name and then click the role you want to view more information about.

docs/DemonstratorGuide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ When you open one of the emails, you will see something similar to below:
4545

4646
## Step 5. Demonstrate the Fabric Data Agent
4747

48-
Please follow the [Fabric Data Agent Guide](./FabricDataAgentGuide.md) to understand how the Fabric Data Agent is created and set up. If it is not already set up, you can follow the instructions to create and configure a new Fabric Data Agent in minutes. After that, you can ask any questions you'd like the agent to answer. For starters, you can use the [sample questions and answers](./fabric_data_agent/sample_test_questions.md).
48+
Please follow the [Fabric Data Agent Guide](./FabricDataAgentGuide.md) to understand how the Fabric Data Agent is created and set up. If it is not already set up, you can follow the instructions to create and configure a new Fabric Data Agent in minutes. After that, you can ask any questions you'd like the agent to answer. For starters, you can use the [sample test questions](./fabric_data_agent/user_sample_test_questions.md).
4949

5050
In the Fabric workspace, find the Fabric Data Agent that is already set up. You will be able to chat with the agent right away. Below is the user interface you can expect:
5151

docs/FabricDataAgentGuide.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Fabric Data Agent Guide
22

3-
After you have deployed your solution, you can add Azure Data Agent to get data analysis features from Fabric built-in AI capabilities. You can follow [Microsoft's Fabric Data Agent Guide](https://learn.microsoft.com/en-us/fabric/data-science/how-to-create-data-agent) to create and set up your Fabric Data Agent, and use the materials provided here to set up your agent quickly. For example, you can
3+
After you have deployed your solution, you can add Azure Data Agent to get data analysis features from Fabric built-in AI capabilities. You can follow [Microsoft's Fabric Data Agent Guide](https://learn.microsoft.com/en-us/fabric/data-science/how-to-create-data-agent) to create and set up your Fabric Data Agent, and use the materials provided here to set up your agent quickly. For example, you can create a new item, search for 'data agent', you will be presented the clickable resource to create a Fabric Data Agent.
44

55
- Create a Fabric Data Agent with a name, for example, `RTI_Data_Agent`,
6-
- Add the EventHouse created in the Fabric workspace as your data source,
6+
- Add the KQL Database created in the Fabric workspace as your data source,
77
- Use the Agent configuration files provided below to set up your Fabric Data Agent.
88

99
## 📁 Agent Configuration Files
@@ -15,16 +15,25 @@ This folder contains essential configuration files for setting up your Fabric Da
1515
**[Agent Instructions - Master Prompt](./fabric_data_agent/agent_instructions.md)**
1616
Contains the primary instructions and behavior guidelines for your Fabric Data Agent. This file establishes the agent's role, scope, and response patterns.
1717

18+
**[Data Source Description](./fabric_data_agent/data_source_descriptions.md)**
19+
Provides a description of the data source.
20+
1821
**[Data Source Instructions](./fabric_data_agent/data_source_instructions.md)**
1922
Provides detailed information about your data structure, table relationships, and query patterns. This helps the agent understand your data and deliver more accurate, efficient responses.
2023

21-
**[Example Queries](./fabric_data_agent/example_queries.md)**
22-
Training pairs that map business questions to proven KQL queries. These examples help your data agent learn optimal response patterns for common manufacturing scenarios.
24+
**Example Question and KQL Query Set**
25+
26+
You can provide example questions and corresponding KQL query code as well. In the `docs/fabric_data_agent` folder, you will find the below files as starters:
27+
28+
1. example_question_1.md and example_kql_code_1.md
29+
2. example_question_2.md and example_kql_code_2.md
30+
3. example_question_3.md and example_kql_code_3.md
31+
32+
### Testing the Data Agent
2333

24-
### Testing Files
34+
Once the Data Agent is set up with the above agent configuration files, you will be able to chat with the agent right away. You can also publish your data agent for others to use. Below is the user interface you can expect ([link to more sample test questions](./fabric_data_agent/user_sample_test_questions.md)):
2535

26-
**[Test Sample Questions](./fabric_data_agent/sample_test_questions.md)**
27-
A collection of sample questions you can use to test your agent's performance and evaluate response quality. Ideal for sharing with your testing team to jumpstart validation efforts.
36+
![Fabric Data Agent UI](../docs/images/deployment/fabric_data_agent_ui.png)
2837

2938
## 💡 Customization Tips
3039

-27.3 KB
Loading
187 KB
Loading
448 KB
Loading

0 commit comments

Comments
 (0)