Skip to content

Commit 6503527

Browse files
authored
Merge pull request #205079 from laujan/1964238-update-quickstarts-next-steps-with-studio
add new studio overview article
2 parents 0843cad + 135fc86 commit 6503527

11 files changed

+106
-19
lines changed
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
title: What is Form Recognizer Studio?
3+
titleSuffix: Azure Applied AI Services
4+
description: Learn how to set up and use Form Recognizer Studio to test features of Azure Form Recognizer on the web.
5+
author: laujan
6+
manager: nitinme
7+
ms.service: applied-ai-services
8+
ms.subservice: forms-recognizer
9+
ms.topic: overview
10+
ms.date: 07/18/2022
11+
ms.author: lajanuar
12+
recommendations: false
13+
---
14+
15+
<!-- markdownlint-disable MD033 -->
16+
# What is Form Recognizer Studio?
17+
18+
>[!NOTE]
19+
> Form Recognizer Studio is currently in public preview. Some features may not be supported or have limited capabilities.
20+
21+
Form Recognizer Studio is an online tool to visually explore, understand, and integrate features from the Form Recognizer service into your applications. The studio provides a platform for you to experiment with the different Form Recognizer models and sample their returned data in an interactive manner without the need to write code.
22+
23+
The studio supports all Form Recognizer v3.0 models and v2.1 models with labeled data. Refer to the [REST API migration guide](v3-migration-guide.md) for detailed information about migrating from v2.1 to v3.0.
24+
25+
## Get started using Form Recognizer Studio
26+
27+
1. To use Form Recognizer Studio, you'll need the following assets:
28+
29+
* **Azure subscription** - [Create one for free](https://azure.microsoft.com/free/cognitive-services/).
30+
31+
* **Cognitive Services or Form Recognizer resource**. Once you have your Azure subscription, create a [single-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) or [multi-service](https://portal.azure.com/#create/Microsoft.CognitiveServicesAllInOne) resource, in the Azure portal to get your key and endpoint. Use the free pricing tier (`F0`) to try the service, and upgrade later to a paid tier for production.
32+
33+
> [!TIP]
34+
>
35+
> * Create a Cognitive Services (multi-service) resource if you plan to access multiple cognitive services under a single endpoint and key.
36+
> * Create a single-service resource for Form Recognizer access only. Please note that you'll need a single-service resource if you intend to use [Azure Active Directory authentication](../../active-directory/authentication/overview-authentication.md).
37+
38+
1. Navigate to the [Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/). If it's your first time logging in, a popup window will appear prompting you to configure your service resource. You have two options:
39+
40+
**a. Access by Resource**.
41+
42+
* Choose your existing subscription.
43+
* Select an existing resource group within your subscription or create a new one.
44+
* Select your existing Form Recognizer or Cognitive services resource.
45+
46+
:::image type="content" source="media/studio/welcome-to-studio.png" alt-text="Screenshot of the configure service resource window.":::
47+
48+
**b. Access by API endpoint and key**.
49+
50+
* Retrieve your endpoint and key from the Azure portal.
51+
* Go to the overview page for your resource and select **Keys and Endpoint** from the left navigation bar.
52+
* Enter the values in the appropriate fields.
53+
54+
:::image type="content" source="media/containers/keys-and-endpoint.png" alt-text="Screenshot: keys and endpoint location in the Azure portal.":::
55+
56+
1. Once you've completed configuring your resource, you'll be able to try the different models offered by Form Recognizer Studio. From the front page, select any Form Recognizer model to try using a no-code approach.
57+
58+
:::image type="content" source="media/studio/form-recognizer-studio-front.png" alt-text="Screenshot of Form Recognizer Studio front page.":::
59+
60+
1. After you've tried Form Recognizer Studio, use the [**C#**](quickstarts/try-v3-csharp-sdk.md), [**Java**](quickstarts/try-v3-java-sdk.md), [**JavaScript**](quickstarts/try-v3-javascript-sdk.md) or [**Python**](quickstarts/try-v3-python-sdk.md) client libraries or the [**REST API**](quickstarts/try-v3-rest-api.md) to get started incorporating Form Recognizer models into your own applications.
61+
62+
To learn more about each model, *see* the concepts pages.
63+
64+
| Model type| Models |
65+
|-----|-----|
66+
|Document analysis models| <ul><li>[**Read model**](concept-read.md)</li><li>[**Layout model**](concept-layout.md)</li><li>[**General document model**](concept-general-document.md)</li></ul>.</br></br>
67+
|**Prebuilt models**|<ul><li>[**W-2 form model**](concept-w2.md)</li><li>[**Invoice model**](concept-invoice.md)</li><li>[**Receipt model**](concept-receipt.md)</li><li>[**ID document model**](concept-id-document.md)</li><li>[**Business card model**](concept-business-card.md)</li></ul>
68+
|Custom models|<ul><li>[**Custom model**](concept-custom.md)</li><ul><li>[**Template model**](concept-custom-template.md)</li><li>[**Neural model**](concept-custom-template.md)</li></ul><li>[**Composed model**](concept-model-overview.md)</li></ul>
69+
70+
### Manage your resource
71+
72+
To view resource details such as name and pricing tier, select the **Settings** icon in the top-right corner of the Form Recognizer Studio home page and select the **Resource** tab. If you have access to other resources, you can switch resources as well.
73+
74+
:::image type="content" source="media/studio/form-recognizer-studio-resource-page.png" alt-text="Screenshot of the studio settings page resource tab.":::
75+
76+
With Form Recognizer, you can quickly automate your data processing in applications and workflows, easily enhance data-driven strategies, and skillfully enrich document search capabilities.
77+
78+
## Next steps
79+
80+
* Visit [Form Recognizer Studio](https://formrecognizer.appliedai.azure.com/studio) to begin using the models presented by the service.
81+
82+
* For more information on Form Recognizer capabilities, see [Azure Form Recognizer overview](overview.md).
203 KB
Loading
11.6 KB
Loading
51.1 KB
Loading

articles/applied-ai-services/form-recognizer/quickstarts/try-sample-label-tool.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -283,9 +283,9 @@ Choose the Train icon on the left pane to open the Training page. Then select th
283283

284284
:::image type="content" source="../media/analyze.png" alt-text="Training view.":::
285285

286-
That's it! You've learned how to use the Form Recognizer sample tool for Form Recognizer prebuilt, layout and custom models. You've also learned to analyze a custom form with manually labeled data. Now you can try a Form Recognizer client library SDK or REST API.
286+
That's it! You've learned how to use the Form Recognizer sample tool for Form Recognizer prebuilt, layout and custom models. You've also learned to analyze a custom form with manually labeled data.
287287

288288
## Next steps
289289

290-
> [!div class="nextstepaction"]
291-
> [Explore Form Recognizer client library SDK and REST API quickstart](../quickstarts/get-started-sdk-rest-api.md)
290+
>[!div class="nextstepaction"]
291+
> [**Form Recognizer Studio**](https://formrecognizer.appliedai.azure.com/studio)

articles/applied-ai-services/form-recognizer/quickstarts/try-v3-csharp-sdk.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -567,12 +567,12 @@ To view the entire output, visit the Azure samples repository on GitHub to view
567567

568568
That's it, congratulations!
569569

570-
In this quickstart, you used the Form Recognizer C# SDK to analyze various forms and documents in different ways. Next, explore the reference documentation to learn about Form Recognizer API in more depth.
570+
In this quickstart, you used the Form Recognizer C# SDK to analyze various forms and documents in different ways. Next, explore the Form Recognizer Studio and reference documentation to learn about Form Recognizer API in more depth.
571571

572572
## Next steps
573573

574-
> [!div class="nextstepaction"]
575-
> [Form Recognizer REST API v3.0 (preview)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument)
574+
>[!div class="nextstepaction"]
575+
> [**Form Recognizer Studio**](https://formrecognizer.appliedai.azure.com/studio)
576576
577577
> [!div class="nextstepaction"]
578-
> [Form Recognizer .NET/C# reference library](https://azuresdkdocs.blob.core.windows.net/$web/dotnet/Azure.AI.FormRecognizer/4.0.0-beta.4/index.html)
578+
> [Form Recognizer REST API v3.0 (preview)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument)

articles/applied-ai-services/form-recognizer/quickstarts/try-v3-java-sdk.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -624,8 +624,8 @@ In this quickstart, you used the Form Recognizer Java SDK to analyze various for
624624

625625
## Next steps
626626

627-
> [!div class="nextstepaction"]
628-
> [Form Recognizer REST API v3.0 (preview)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument)
627+
>[!div class="nextstepaction"]
628+
> [**Form Recognizer Studio**](https://formrecognizer.appliedai.azure.com/studio)
629629
630630
> [!div class="nextstepaction"]
631-
> [Form Recognizer Java reference library](https://azuresdkdocs.blob.core.windows.net/$web/java/azure-ai-formrecognizer/4.0.0-beta.5/index.html)
631+
> [Form Recognizer REST API v3.0 (preview)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument)

articles/applied-ai-services/form-recognizer/quickstarts/try-v3-javascript-sdk.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -401,12 +401,12 @@ To view the entire output, visit the Azure samples repository on GitHub to view
401401
402402
That's it, congratulations!
403403
404-
In this quickstart, you used the Form Recognizer JavaScript SDK to analyze various forms in different ways. Next, explore the reference documentation to learn moe about Form Recognizer v3.0 API.
404+
In this quickstart, you used the Form Recognizer JavaScript SDK to analyze various forms in different ways. Next, explore the Form Recognizer Studio and reference documentation to learn moe about Form Recognizer v3.0 API.
405405
406406
## Next steps
407407
408-
> [!div class="nextstepaction"]
409-
> [Form Recognizer REST API v3.0 (preview)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument)
408+
>[!div class="nextstepaction"]
409+
> [**Form Recognizer Studio**](https://formrecognizer.appliedai.azure.com/studio)
410410
411411
> [!div class="nextstepaction"]
412-
> [Form Recognizer JavaScript reference library](https://azuresdkdocs.blob.core.windows.net/$web/javascript/azure-ai-form-recognizer/4.0.0-beta.4/index.html)
412+
> [Form Recognizer REST API v3.0 (preview)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument)

articles/applied-ai-services/form-recognizer/quickstarts/try-v3-python-sdk.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -735,12 +735,12 @@ To view the entire output, visit the Azure samples repository on GitHub to view
735735

736736
That's it, congratulations!
737737

738-
In this quickstart, you used the Form Recognizer Python SDK to analyze various forms in different ways. Next, explore the reference documentation to learn more about Form Recognizer v3.0 API.
738+
In this quickstart, you used the Form Recognizer Python SDK to analyze various forms in different ways. Next, explore the Form Recognizer Studio and reference documentation to learn more about Form Recognizer v3.0 API.
739739

740740
## Next steps
741741

742-
> [!div class="nextstepaction"]
743-
> [Form Recognizer REST API v3.0 (preview)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument)
742+
>[!div class="nextstepaction"]
743+
> [**Form Recognizer Studio**](https://formrecognizer.appliedai.azure.com/studio)
744744
745745
> [!div class="nextstepaction"]
746-
> [Form Recognizer Python reference library](https://azuresdkdocs.blob.core.windows.net/$web/python/azure-ai-formrecognizer/3.2.0b5/index.html)
746+
> [Form Recognizer REST API v3.0 (preview)](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-2022-06-30-preview/operations/AnalyzeDocument)

articles/applied-ai-services/form-recognizer/quickstarts/try-v3-rest-api.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,10 @@ The prebuilt models extract pre-defined sets of document fields. See [Model data
175175

176176
## Next steps
177177

178-
In this quickstart, you used the Form Recognizer REST API preview (v3.0) to analyze forms in different ways. Next, further explore the latest reference documentation to learn more about the Form Recognizer API.
178+
In this quickstart, you used the Form Recognizer REST API preview (v3.0) to analyze forms in different ways. Next, further explore the Form Recognizer Studio and latest reference documentation to learn more about the Form Recognizer API.
179+
180+
>[!div class="nextstepaction"]
181+
> [**Form Recognizer Studio**](https://formrecognizer.appliedai.azure.com/studio)
179182

180183
> [!div class="nextstepaction"]
181184
> [REST API preview (v3.0) reference documentation](https://westus.dev.cognitive.microsoft.com/docs/services/form-recognizer-api-v3-0-preview-2/operations/AnalyzeDocument)

0 commit comments

Comments
 (0)