|
| 1 | +--- |
| 2 | +title: "Share custom model projects using Form Recognizer Studio" |
| 3 | +titleSuffix: Azure Applied AI Services |
| 4 | +description: Learn how to share custom model projects using Form Recognizer Studio. |
| 5 | +author: laujan |
| 6 | +manager: nitinme |
| 7 | +ms.service: applied-ai-services |
| 8 | +ms.subservice: forms-recognizer |
| 9 | +ms.topic: how-to |
| 10 | +ms.date: 04/17/2023 |
| 11 | +ms.author: jppark |
| 12 | +monikerRange: 'form-recog-3.0.0' |
| 13 | +recommendations: false |
| 14 | +--- |
| 15 | + |
| 16 | +# Share custom model projects using Form Recognizer Studio |
| 17 | + |
| 18 | +Form Recognizer Studio is an online tool to visually explore, understand, train, and integrate features from the Form Recognizer service into your applications. Form Recognizer Studio enables project sharing feature within the custom extraction model. Projects can be shared easily via a project token. The same project token can also be used to import a project. |
| 19 | + |
| 20 | +## Prerequisite |
| 21 | + |
| 22 | +In order to share and import your custom extraction projects seamlessly, both users (user who shares and user who imports) need an An active [**Azure account**](https://azure.microsoft.com/free/cognitive-services/). If you don't have one, you can [**create a free account**](https://azure.microsoft.com/free/). Also, both users need to configure permissions to grant access to the Form Recognizer and storage resources. |
| 23 | + |
| 24 | +## Granted access and permissions |
| 25 | + |
| 26 | + > [!IMPORTANT] |
| 27 | + > Custom model projects can be imported only if you have the access to the storage account that is associated with the project you are trying to import. Check your storage account permission before starting to share or import projects with others. |
| 28 | +
|
| 29 | +### Managed identity |
| 30 | + |
| 31 | +Enable a system-assigned managed identity for your Form Recognizer resource. A system-assigned managed identity is enabled directly on a service instance. It isn't enabled by default; you must go to your resource and update the identity setting. |
| 32 | + |
| 33 | +For more information, *see*, [Enable a system-assigned managed identity](../managed-identities.md#enable-a-system-assigned-managed-identity) |
| 34 | + |
| 35 | +### Role-based access control (RBAC) |
| 36 | + |
| 37 | +Grant your Form Recognizer managed identity access to your storage account using Azure role-based access control (Azure RBAC). The [Storage Blob Data Contributor](../../..//role-based-access-control/built-in-roles.md#storage-blob-data-reader) role grants read, write, and delete permissions for Azure Storage containers and blobs. |
| 38 | + |
| 39 | +For more information, *see*, [Grant access to your storage account](../managed-identities.md#grant-access-to-your-storage-account) |
| 40 | + |
| 41 | +### Configure cross origin resource sharing (CORS) |
| 42 | + |
| 43 | +CORS needs to be configured in your Azure storage account for it to be accessible to the Form Recognizer Studio. You can update the CORS setting in the Azure portal. |
| 44 | + |
| 45 | +Form more information, *see* [Configure CORS](../quickstarts/try-form-recognizer-studio.md#configure-cors) |
| 46 | + |
| 47 | +### Virtual networks and firewalls |
| 48 | + |
| 49 | +If your storage account VNet is enabled or if there are any firewall constraints, the project can't be shared. If you want to bypass those restrictions, ensure that those settings are turned off. |
| 50 | + |
| 51 | +A workaround is to manually create a project using the same settings as the project being shared. |
| 52 | + |
| 53 | +### User sharing requirements |
| 54 | + |
| 55 | +Users sharing the project need to create a project [**`ListAccountSAS`**](/rest/api/storagerp/storage-accounts/list-account-sas) to configure the storage account CORS and a [**`ListServiceSAS`**](/rest/api/storagerp/storage-accounts/list-service-sas) to generate a SAS token for *read*, *write* and *list* container's file in addition to blob storage data *update* permissions. |
| 56 | + |
| 57 | +### User importing requirements |
| 58 | + |
| 59 | +Users who want to import the project need a [**`ListServiceSAS`**](/rest/api/storagerp/storage-accounts/list-service-sas) to generate a SAS token for *read*, *write* and *list* container's file in addition to blob storage data *update* permissions. |
| 60 | + |
| 61 | +## Share a custom extraction model with Form Recognizer studio |
| 62 | + |
| 63 | +Follow these steps to share your project using Form Recognizer studio: |
| 64 | + |
| 65 | +1. Start by navigating to the [Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/studio). |
| 66 | + |
| 67 | +1. In the Studio, select the **Custom extraction models** tile, under the custom models section. |
| 68 | + |
| 69 | + :::image type="content" source="../media/how-to/studio-custom-extraction.png" alt-text="Screenshot showing how to select a custom extraction model in the Studio."::: |
| 70 | + |
| 71 | +1. On the custom extraction models page, select the desired model to share and then select the **Share** button. |
| 72 | + |
| 73 | + :::image type="content" source="../media/how-to/studio-project-share.png" alt-text="Screenshot showing how to select the desired model and select the share option."::: |
| 74 | + |
| 75 | +1. On the share project dialog, copy the project token for the selected project. |
| 76 | + |
| 77 | +:::image type="content" source="../media/how-to/studio-project-token.png" alt-text="Screenshot showing how to copy the project token."::: |
| 78 | + |
| 79 | +## Import custom extraction model with Form Recognizer studio |
| 80 | + |
| 81 | +Follow these steps to import a project using Form Recognizer studio. |
| 82 | + |
| 83 | +1. Start by navigating to the [Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/studio). |
| 84 | + |
| 85 | +1. In the Studio, select the **Custom extraction models** tile, under the custom models section. |
| 86 | + |
| 87 | + :::image type="content" source="../media/how-to/studio-custom-extraction.png" alt-text="Screenshot: Select custom extraction model in the Studio."::: |
| 88 | + |
| 89 | +1. On the custom extraction models page, select the **Import** button. |
| 90 | + |
| 91 | + :::image type="content" source="../media/how-to/studio-project-import.png" alt-text="Screenshot: Select import within custom extraction model page."::: |
| 92 | + |
| 93 | +1. On the import project dialog, paste the project token shared with you and select import. |
| 94 | + |
| 95 | +:::image type="content" source="../media/how-to/studio-import-token.png" alt-text="Screenshot: Paste the project token in the dialogue."::: |
| 96 | + |
| 97 | +## Next steps |
| 98 | + |
| 99 | +> [!div class="nextstepaction"] |
| 100 | +> [Back up and recover models](../disaster-recovery.md) |
0 commit comments