Skip to content

Commit f8688e5

Browse files
authored
Merge pull request #380 from microsoft/docs-gh-updates
docs: readme template and content updates
2 parents a469623 + 85c5742 commit f8688e5

21 files changed

+180
-94
lines changed

Images/readme/customerTruth.png

-182 KB
Binary file not shown.

Images/readme/quickDeploy.png

-89.8 KB
Binary file not shown.
-186 KB
Binary file not shown.

Images/readme/userStory.png

-126 KB
Binary file not shown.

README.md

Lines changed: 152 additions & 82 deletions
Large diffs are not rendered by default.

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.
Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
## Content Processing
1+
## Content and Data Processing Workflow
22
Additional details about how content processing is handled in the solution. This includes the workflow steps and how to use your own data in the solution.
33

44
### Workflow
5-
![image](../Images/readme_deployment/DocumentProcess.png)
5+
![image](./images/deployment/DocumentProcess.png)
66
1. <u>Document upload</u><br/>
77
Documents added to blob storage. Processing is triggered based on file check-in.
88

@@ -34,6 +34,10 @@ You can upload through the user interface files that you would like processed. T
3434
2. <u>Bulk File Processing</u><br/>
3535
You can take buik file processing since the web app saves uploaded files here also. This would be the ideal to upload a large number of document or files that are large in size.
3636

37+
> **Document Upload Limit:** <br/>
38+
Please ensure that the document you upload does not exceed a maximum size of 250 MB.
39+
40+
3741
### Modifying Processing Prompts
3842

3943
Prompt based processing is used for context extraction, summarization, and keyword/entity extraction. Modifications to the prompts will change what is extracted for the related workflow step.
Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Deployment Guide for Services
1+
# Deployment Guide
22

33
> This repository presents a solution and reference architecture for the Knowledge Mining solution accelerator. Please note that the **provided code serves as a demonstration and is not an officially supported Microsoft offering**.
44
>
@@ -10,8 +10,6 @@
1010
* [Deploy to Azure](#deploy-to-azure)
1111
* [Post-Deploy Configuration](#post-deploy-configuration)
1212
* [Next Steps](#next-steps)
13-
* [Test APIs](./docs/TestApis.md)
14-
* [Deploy Power Platform Client](./DeployPowerPlatformClient.md)
1513

1614
## Prerequisites
1715

@@ -43,7 +41,7 @@
4341
3. Go to **Settings** and select **Resource Providers**.
4442
4. Check for Microsoft.Compute and click Register if it is not already registered.
4543
<br>
46-
<img src="./Images/readme_deployment/Subscription_ResourceProvider.png" alt="ResourceProvider" width="900">
44+
<img src="./images/deployment/Subscription_ResourceProvider.png" alt="ResourceProvider" width="900">
4745

4846

4947
## Regional Availability
@@ -62,7 +60,7 @@ The deployment region for this model is fixed in 'East US'
6260

6361
## Deployment
6462

65-
The automated deployment process is very straightforward and simplified via a single [deployment script](./Deployment/resourcedeployment.ps1) that completes in approximately 10-15 minutes:
63+
The automated deployment process is very straightforward and simplified via a single [deployment script](../Deployment/resourcedeployment.ps1) that completes in approximately 10-15 minutes:
6664

6765
### Automated Deployment Steps:
6866
1. Deploy Azure resources.
@@ -92,7 +90,7 @@ powershell.exe -ExecutionPolicy Bypass -File ".\resourcedeployment.ps1"
9290
```
9391

9492
You will be prompted for the following parameters with this Screen :
95-
<img src="./Images/readme_deployment/Deployment_Screen01.png" width="900" alt-text="Input Parameters">
93+
<img src="./images/deployment/Deployment_Screen01.png" width="900" alt-text="Input Parameters">
9694

9795
1. **Subscription ID** - copy/paste from Azure portal
9896
1. **Location** - Azure data center where resources will be deployed.
@@ -130,7 +128,7 @@ Let's check the message and configure your model's TPM rate higher to get better
130128
You can check the Application URL from the final console message.
131129
Don't miss this Url information. This is the application's endpoint URL and it should be used for your data importing process.
132130
133-
<img src="./Images/readme_deployment/Deployment_Screen02.png" alt="Success Deployment" width="900">
131+
<img src="./images/deployment/Deployment_Screen02.png" alt="Success Deployment" width="900">
134132
135133
## Next Steps
136134
@@ -152,10 +150,10 @@ Don't miss this Url information. This is the application's endpoint URL and it s
152150
153151
154152
1. Browse to the project in Azure AI Foundry, and select **each of the 2 models** within the `Deployments` menu:
155-
<img src="./Images/readme_deployment/Control_Model_TPM000.png" alt="Select Model" width="700">
153+
<img src="./images/deployment/Control_Model_TPM000.png" alt="Select Model" width="700">
156154
157155
2. Increase the TPM value for **each model** for faster report generation:
158-
<img src="./Images/readme_deployment/Control_Model_TPM001.png" alt="Set Token per minute" width="700">
156+
<img src="./images/deployment/Control_Model_TPM001.png" alt="Set Token per minute" width="700">
159157
160158
### 2. Data Uploading and Processing
161159
After increasing the TPM limit for each model, let's upload and process the sample documents.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Additional details about the technical architecture of the Document Knowledge Mining solution accelerator. This describes the purpose and additional context of each component in the solution.
44

5-
![image](../Images/readme/architecture.png)
5+
![image](./images/readme/solution-architecture.png)
66

77

88
### Ingress Controller
File renamed without changes.

0 commit comments

Comments
 (0)