Skip to content

Commit 964f5c8

Browse files
Merge pull request #88 from microsoft/docs-gh-redesign
docs: updating deployment docs
2 parents cfe7180 + 0b95271 commit 964f5c8

File tree

3 files changed

+27
-6
lines changed

3 files changed

+27
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ User story
1111

1212
This solution accelerator enables customers to programmatically extract data and apply schemas to unstructured documents across text-based and multi-modal content. During processing, extraction and data schema transformation - these steps are scored for accuracy to automate processing and identify as-needed human validation. This allows for improved accuracy and greater speed for data integration into downstream systems.
1313

14-
It leverages Azure AI Foundry, Azure AI Content Understanding, Azure OpenAI Service, Azure blob storage, and Cosmos DB to transform large volumes of unstructured content through event-driven processing pipelines for integration into downstream applications and post-processing activities.
14+
It leverages Azure AI Foundry, Azure AI Content Understanding, Azure OpenAI Service, Azure blob storage, and Azure Cosmos DB to transform large volumes of unstructured content through event-driven processing pipelines for integration into downstream applications and post-processing activities.
1515

1616

1717
### Technical key features

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/DeploymentGuide.md

Lines changed: 12 additions & 5 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](./docs/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](./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

@@ -38,7 +38,7 @@ This will allow the scripts to run for the current session without permanently c
3838

3939
## Deployment Options & Steps
4040

41-
Pick from the options below to see step-by-step instructions for GitHub Codespaces, VS Code Dev Containers, Local Environments, and Bicep deployments.
41+
Pick from the options below to see step-by-step instructions for GitHub Codespaces, VS Code Dev Containers, and Local Environments.
4242

4343
| [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/microsoft/content-processing-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/content-processing-solution-accelerator) |
4444
|---|---|
@@ -117,16 +117,16 @@ When you start the deployment, most parameters will have **default values**, but
117117
| **Azure AI Content Understanding Location** | Select from a drop-down list of values. | Sweden Central |
118118
| **Secondary Location** | A **less busy** region for **Azure Cosmos DB**, useful in case of availability constraints. | eastus2 |
119119
| **Deployment Type** | Select from a drop-down list. | GlobalStandard |
120-
| **GPT Model** | Choose from **gpt-4, gpt-4o, gpt-4o-mini**. | gpt-4o |
121-
| **GPT Model Deployment Capacity** | Configure capacity for **GPT models**. | 100k |
120+
| **GPT Model** | Choose from **gpt-4o**. | gpt-4o |
121+
| **GPT Model Deployment Capacity** | Configure capacity for **GPT models**. | 300k |
122122

123123
</details>
124124

125125
<details>
126126
<summary><b>[Optional] Quota Recommendations</b></summary>
127127

128128
By default, the **GPT model capacity** in deployment is set to **30k tokens**.
129-
> **We recommend increasing the capacity to 100k tokens for optimal performance.**
129+
> **We recommend increasing the capacity to 100k tokens, if available, for optimal performance.**
130130

131131
To adjust quota settings, follow these [steps](./AzureGPTQuotaSettings.md).
132132

@@ -261,3 +261,10 @@ This will rebuild the source code, package it into a container, and push it to t
261261
4. **Deleting Resources After a Failed Deployment**
262262
263263
- Follow steps in [Delete Resource Group](./DeleteResourceGroup.md) if your deployment fails and/or you need to clean up the resources.
264+
265+
## Next Steps
266+
267+
Now that you've completed your deployment, you can start using the solution. Try out these things to start getting familiar with the capabilities:
268+
* Open the web container app URL in your browser and explore the web user interface and upload your own invoices.
269+
* [Create your own schema definition](./CustomizeSchemaData.md), so you can upload and process your own types of documents.
270+
* [Ingest the API](API.md) for processing documents programmatically.

0 commit comments

Comments
 (0)