You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/applied-ai-services/form-recognizer/api-v2-0/includes/csharp-v3-0-0.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ ms.custom: " devx-track-csharp"
21
21
* The [Visual Studio IDE](https://visualstudio.microsoft.com/vs/) or current version of [.NET Core](https://dotnet.microsoft.com/download/dotnet-core).
22
22
* An Azure Storage blob that contains a set of training data. See [Build a training data set for a custom model](../../build-training-data-set.md) for tips and options for putting together your training data set. For this quickstart, you can use the files under the **Train** folder of the [sample data set](https://go.microsoft.com/fwlink/?linkid=2090451) (download and extract *sample_data.zip*).
23
23
* Once you have your Azure subscription, <ahref="https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer"title="Create a Form Recognizer resource"target="_blank">create a Form Recognizer resource </a> in the Azure portal to get your key and endpoint. After it deploys, select **Go to resource**.
24
-
* You will need the key and endpoint from the resource you create to connect your application to the Form Recognizer API. You'll paste your key and endpoint into the code below later in the quickstart.
24
+
* You will need the key and endpoint from the resource you create to connect your application to the Form Recognizer API. Paste your key and endpoint into the code below later in the quickstart.
25
25
* You can use the free pricing tier (`F0`) to try the service, and upgrade later to a paid tier for production.
26
26
27
27
## Setting up
@@ -68,7 +68,7 @@ In the application's **Program** class, create variables for your resource's key
68
68
> [!IMPORTANT]
69
69
> Go to the Azure portal. If the Form Recognizer resource you created in the **Prerequisites** section deployed successfully, click the **Go to Resource** button under **Next Steps**. You can find your key and endpoint in the resource's **key and endpoint** page, under **resource management**.
70
70
>
71
-
> Remember to remove the key from your code when you're done, and never post it publicly. For production, use secure methods to store and access your credentials. See the Cognitive Services [security](../../../../cognitive-services/cognitive-services-security.md) article for more information.
71
+
> Remember to remove the key from your code when you're done, and never post it publicly. For production, use secure methods to store and access your credentials. For more information, _see_Cognitive Services [security](../../../../cognitive-services/cognitive-services-security.md).
@@ -93,7 +93,7 @@ With Form Recognizer, you can create two different client types. The first, `For
93
93
`FormTrainingClient` provides operations for:
94
94
95
95
* Training custom models to analyze all fields and values found in your custom forms. A `CustomFormModel` is returned indicating the form types the model will analyze, and the fields it will extract for each form type.
96
-
* Training custom models to analyze specific fields and values you specify by labeling your custom forms. A `CustomFormModel` is returned indicating the fields the model will extract, as well as the estimated accuracy for each field.
96
+
* Training custom models to analyze specific fields and values you specify by labeling your custom forms. A `CustomFormModel` is returned indicating the fields the model will extract and the estimated accuracy for each field.
97
97
* Managing models created in your account.
98
98
* Copying a custom model from one Form Recognizer resource to another.
99
99
@@ -116,7 +116,7 @@ These code snippets show you how to do the following tasks with the Form Recogni
116
116
117
117
## Authenticate the client
118
118
119
-
Below **Main**, create a new method named `AuthenticateClient`. You'll use this in other tasks to authenticate your requests to the Form Recognizer service. This method uses the `AzureKeyCredential` object, so that if needed, you can update the API key without creating new client objects.
119
+
Below **Main**, create a new method named `AuthenticateClient`. You'll use this method in other tasks to authenticate your requests to the Form Recognizer service. This method uses the `AzureKeyCredential` object, so that if needed, you can update the API key without creating new client objects.
120
120
121
121
> [!IMPORTANT]
122
122
> Get your key and endpoint from the Azure portal. If the Form Recognizer resource you created in the **Prerequisites** section deployed successfully, click the **Go to Resource** button under **Next Steps**. You can find your key and endpoint in the resource's **key and endpoint** page, under **resource management**.
@@ -131,7 +131,7 @@ Repeat the steps above for a new method that authenticates a training client.
131
131
132
132
## Get assets for testing
133
133
134
-
You'll also need to add references to the URLs for your training and testing data. Add these to the root of your **Program** class.
134
+
You'll also need to add references to the URLs for your training and testing data. Add these references to the root of your **Program** class.
135
135
136
136
* To retrieve the SAS URL for your custom model training data, go to your storage resource in the Azure portal and select the **Storage Explorer** tab. Navigate to your container, right-click, and select **Get shared access signature**. It's important to get the SAS for your container, not for the storage account itself. Make sure the **Read**, **Write**, **Delete** and **List** permissions are checked, and select **Create**. Then copy the value in the **URL** section to a temporary location. It should have the form: `https://<storage account>.blob.core.windows.net/<container name>?<SAS value>`.
137
137
@@ -144,7 +144,7 @@ You'll also need to add references to the URLs for your training and testing dat
144
144
145
145
## Analyze layout
146
146
147
-
You can use Form Recognizer to analyze tables, lines, and words in documents, without needing to train a model. The returned value is a collection of **FormPage** objects: one for each page in the submitted document. For more information about layout extraction see the [Layout conceptual guide](../../concept-layout.md).
147
+
You can use Form Recognizer to analyze tables, lines, and words in documents, without needing to train a model. The returned value is a collection of **FormPage** objects: one for each page in the submitted document. For more information about layout extraction, see the [Layout conceptual guide](../../concept-layout.md).
148
148
149
149
To analyze the content of a file at a given URL, use the `StartRecognizeContentFromUri` method.
Copy file name to clipboardExpand all lines: articles/applied-ai-services/form-recognizer/api-v2-0/includes/java-v3-0-0.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ ms.author: lajanuar
23
23
* The current version of the [Java Development Kit (JDK)](https://www.oracle.com/technetwork/java/javase/downloads/index.html)
24
24
* The [Gradle build tool](https://gradle.org/install/), or another dependency manager.
25
25
* Once you have your Azure subscription, <ahref="https://ms.portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer"title="Create a Form Recognizer resource"target="_blank">create a Form Recognizer resource </a> in the Azure portal to get your key and endpoint. After it deploys, select **Go to resource**.
26
-
* You will need the key and endpoint from the resource you create to connect your application to the Form Recognizer API. You'll paste your key and endpoint into the code below later in the quickstart.
26
+
* You will need the key and endpoint from the resource you create to connect your application to the Form Recognizer API. Paste your key and endpoint into the code below later in the quickstart.
27
27
* You can use the free pricing tier (`F0`) to try the service, and upgrade later to a paid tier for production.
28
28
* An Azure Storage blob that contains a set of training data. See [Build a training data set for a custom model](../../build-training-data-set.md) for tips and options for putting together your training data set. For this quickstart, you can use the files under the **Train** folder of the [sample data set](https://go.microsoft.com/fwlink/?linkid=2090451) (download and extract *sample_data.zip*).
29
29
@@ -37,7 +37,7 @@ In a console window (such as cmd, PowerShell, or Bash), create a new directory f
37
37
mkdir myapp && cd myapp
38
38
```
39
39
40
-
Run the `gradle init` command from your working directory. This command will create essential build files for Gradle, including *build.gradle.kts* which is used at runtime to create and configure your application.
40
+
Run the `gradle init` command from your working directory. This command will create essential build files for Gradle, including *build.gradle.kts*, which is used at runtime to create and configure your application.
41
41
42
42
```console
43
43
gradle init --type basic
@@ -92,9 +92,9 @@ In the application's **FormRecognizer** class, create variables for your resourc
92
92
> [!IMPORTANT]
93
93
> Go to the Azure portal. If the Form Recognizer resource you created in the **Prerequisites** section deployed successfully, click the **Go to Resource** button under **Next Steps**. You can find your key and endpoint in the resource's **key and endpoint** page, under **resource management**.
94
94
>
95
-
> Remember to remove the key from your code when you're done, and never post it publicly. For production, use secure methods to store and access your credentials. See the Cognitive Services [security](../../../../cognitive-services/cognitive-services-security.md) article for more information.
95
+
> Remember to remove the key from your code when you're done, and never post it publicly. For production, use secure methods to store and access your credentials. For more information, _see_Cognitive Services [security](../../../../cognitive-services/cognitive-services-security.md).
96
96
97
-
In the application's **main** method, add calls for the methods used in this quickstart. You'll define these later. You'll also need to add references to the URLs for your training and testing data.
97
+
In the application's **main** method, add calls for the methods used in this quickstart. You'll define these methods later. You'll also need to add references to the URLs for your training and testing data.
98
98
99
99
*[!INCLUDE [get SAS URL](../../includes/sas-instructions.md)]
100
100
@@ -124,7 +124,7 @@ With Form Recognizer, you can create two different client types. The first, `For
124
124
`FormTrainingClient` provides operations for:
125
125
126
126
* Training custom models to analyze all fields and values found in your custom forms. A `CustomFormModel` is returned indicating the form types the model will analyze, and the fields it will extract for each form type.
127
-
* Training custom models to analyze specific fields and values you specify by labeling your custom forms. A `CustomFormModel` is returned indicating the fields the model will extract, as well as the estimated accuracy for each field.
127
+
* Training custom models to analyze specific fields and values you specify by labeling your custom forms. A `CustomFormModel` is returned indicating the fields the model will extract and the estimated accuracy for each field.
128
128
* Managing models created in your account.
129
129
* Copying a custom model from one Form Recognizer resource to another.
130
130
@@ -151,7 +151,7 @@ At the top of your **main** method, add the following code. Here, you'll authent
151
151
152
152
## Analyze layout
153
153
154
-
You can use Form Recognizer to analyze tables, lines, and words in documents, without needing to train a model. For more information about layout extraction see the [Layout conceptual guide](../../concept-layout.md).
154
+
You can use Form Recognizer to analyze tables, lines, and words in documents, without needing to train a model. For more information about layout extraction, see the [Layout conceptual guide](../../concept-layout.md).
155
155
156
156
To analyze the content of a file at a given URL, use the **beginRecognizeContentFromUrl** method.
157
157
@@ -306,7 +306,7 @@ You'll use the **beginRecognizeCustomFormsFromUrl** method.
306
306
> [!TIP]
307
307
> You can also analyze a local file. See the [FormRecognizerClient](/java/api/com.azure.ai.formrecognizer.formrecognizerclient) methods, such as **beginRecognizeCustomForms**. Or, see the sample code on [GitHub](https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/formrecognizer/azure-ai-formrecognizer/src/samples/README.md) for scenarios involving local images.
308
308
309
-
The returned value is a collection of **RecognizedForm** objects: one for each page in the submitted document.The following code prints the analysis results to the console. It prints each recognized field and corresponding value, along with a confidence score.
309
+
The returned value is a collection of **RecognizedForm** objects: one for each page in the submitted document.The following code prints the analysis results to the console. It prints each recognized field and corresponding value, along with a confidence score.
@@ -398,7 +398,7 @@ If you want to clean up and remove a Cognitive Services subscription, you can de
398
398
399
399
## Troubleshooting
400
400
401
-
From Recognizer clients raise `ErrorResponseException` exceptions. For example, if you try to provide an invalid file source URL an `ErrorResponseException` would be raised with an error indicating the failure cause. In the following code snippet, the error is handled gracefully by catching the exception and display the additional information about the error.
401
+
Form Recognizer clients raise `ErrorResponseException` exceptions. For example, if you try to provide an invalid file source URL an `ErrorResponseException` would be raised with an error indicating the failure cause. In the following code snippet, the error is handled gracefully by catching the exception and display the additional information about the error.
Copy file name to clipboardExpand all lines: articles/applied-ai-services/form-recognizer/concept-form-recognizer-studio.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ ms.author: sajagtap
16
16
>[!NOTE]
17
17
> Form Recognizer Studio is currently in public preview. Some features may not be supported or have limited capabilities.
18
18
19
-
[Form Recognizer Studio preview](https://formrecognizer.appliedai.azure.com/) is an online tool for visually exploring, understanding, and integrating features from the Form Recognizer service into your applications. Use the [Form Recognizer Studio quickstart](quickstarts/try-v3-form-recognizer-studio.md) to get started with exploring the pre-trained models with sample documents or your own. Create projects to build custom form models and reference the models in your applications using the [Python SDK preview](quickstarts/try-v3-python-sdk.md) and other quickstarts.
19
+
[Form Recognizer Studio preview](https://formrecognizer.appliedai.azure.com/) is an online tool for visually exploring, understanding, and integrating features from the Form Recognizer service into your applications. Use the [Form Recognizer Studio quickstart](quickstarts/try-v3-form-recognizer-studio.md) to get started analyzing documents with pre-trained models. Build custom form models and reference the models in your applications using the [Python SDK preview](quickstarts/try-v3-python-sdk.md) and other quickstarts.
20
20
21
21
The following image shows the Invoice prebuilt model feature at work.
22
22
@@ -32,7 +32,7 @@ The following Form Recognizer service features are available in the Studio.
32
32
33
33
***Custom models**: Form Recognizer's custom models enable you to extract fields and values from models trained with your data, tailored to your forms and documents. Create standalone custom models or combine two or more custom models to create a composed model to extract data from multiple form types. Start with the [Studio Custom models quickstart](quickstarts/try-v3-form-recognizer-studio.md#custom-model-basics). Use the online wizard, labeling interface, training step, and visualizations to understand how the feature works. Test the custom model with your sample documents and iterate to improve the model. See the [Custom models overview](concept-custom.md) to learn more and use the [Form Recognizer v3.0 preview migration guide](v3-migration-guide.md) to start integrating the new models with your applications.
34
34
35
-
***Custom models: Labeling features**: Form Recognizer Custom model creation requires identifying the fields to be extracted and labeling the content in your documents with those fields before training the custom models. Labeling text, selection marks, tabular data, and other content types are typically assisted with a user interface to ease the training workflow. For example, use the [Label as tables](quickstarts/try-v3-form-recognizer-studio.md#labeling-as-tables) and [Labeling for signature detection](quickstarts/try-v3-form-recognizer-studio.md#labeling-for-signature-detection) quickstarts to understand the labeling experience in Form Recognizer Studio.
35
+
***Custom models: Labeling features**: Form Recognizer Custom model creation requires identifying the fields to be extracted and labeling those fields before training the custom models. Labeling text, selection marks, tabular data, and other content types are typically assisted with a user interface to ease the training workflow. For example, use the [Label as tables](quickstarts/try-v3-form-recognizer-studio.md#labeling-as-tables) and [Labeling for signature detection](quickstarts/try-v3-form-recognizer-studio.md#labeling-for-signature-detection) quickstarts to understand the labeling experience in Form Recognizer Studio.
0 commit comments