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/ai-services/document-intelligence/how-to-guides/compose-custom-models.md
+22-22Lines changed: 22 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,7 +36,7 @@ ms.author: lajanuar
36
36
37
37
::: moniker range=">=doc-intel-3.0.0"
38
38
39
-
A composed model is created by taking a collection of custom models and assigning them to a single model ID. You can assign up to 200 trained custom models to a single composed model ID. When a document is submitted to a composed model, the service performs a classification step to decide which custom model accurately represents the form presented for analysis. Composed models are useful when you've trained several models and want to group them to analyze similar form types. For example, your composed model might include custom models trained to analyze your supply, equipment, and furniture purchase orders. Instead of manually trying to select the appropriate model, you can use a composed model to determine the appropriate custom model for each analysis and extraction.
39
+
A composed model is created by taking a collection of custom models and assigning them to a single model ID. You can assign up to 200 trained custom models to a single composed model ID. When a document is submitted to a composed model, the service performs a classification step to decide which custom model accurately represents the form presented for analysis. Composed models are useful when you train several models and want to group them to analyze similar form types. For example, your composed model might include custom models trained to analyze your supply, equipment, and furniture purchase orders. Instead of manually trying to select the appropriate model, you can use a composed model to determine the appropriate custom model for each analysis and extraction.
40
40
41
41
To learn more, see [Composed custom models](../concept-composed-models.md).
42
42
@@ -48,7 +48,7 @@ To get started, you need the following resources:
48
48
49
49
***An Azure subscription**. You can [create a free Azure subscription](https://azure.microsoft.com/free/cognitive-services/).
50
50
51
-
***A Document Intelligence instance**. Once you have your Azure subscription, [create a Document Intelligence resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) in the Azure portal to get your key and endpoint. If you have an existing Document Intelligence resource, navigate directly to your resource page. You can use the free pricing tier (F0) to try the service, and upgrade later to a paid tier for production.
51
+
***A Document Intelligence instance**. Once you have your Azure subscription, [create a Document Intelligence resource](https://portal.azure.com/#create/Microsoft.CognitiveServicesFormRecognizer) in the Azure portal to get your key and endpoint. If you have an existing Document Intelligence resource, navigate directly to your resource page. You can use the free pricing tier (F0) to try the service, and upgrade later to a paid tier for production.
52
52
53
53
1. After the resource deploys, select **Go to resource**.
54
54
@@ -63,7 +63,7 @@ To get started, you need the following resources:
63
63
64
64
## Create your custom models
65
65
66
-
First, you need a set of custom models to compose. You can use the Document Intelligence Studio, REST API, or client-library SDKs. The steps are as follows:
66
+
First, you need a set of custom models to compose. You can use the Document Intelligence Studio, REST API, or client libraries. The steps are as follows:
67
67
68
68
*[**Assemble your training dataset**](#assemble-your-training-dataset)
69
69
*[**Upload your training set to Azure blob storage**](#upload-your-training-dataset)
@@ -85,7 +85,7 @@ See [Build a training data set](../how-to-guides/build-a-custom-model.md?view=do
85
85
86
86
## Upload your training dataset
87
87
88
-
When you've gathered a set of training documents, you need to [upload your training data](../how-to-guides/build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=true#upload-your-training-data) to an Azure blob storage container.
88
+
Once you gather a set of training documents, you need to [upload your training data](../how-to-guides/build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=true#upload-your-training-data) to an Azure blob storage container.
89
89
90
90
If you want to use manually labeled data, you have to upload the *.labels.json* and *.ocr.json* files that correspond to your training documents.
91
91
@@ -105,7 +105,7 @@ To create custom models, start with configuring your project:
105
105
106
106
1. Enter project details, select the Azure subscription and resource, and the Azure Blob storage container that contains your data.
107
107
108
-
1. Review and submit your settings to create the project.
108
+
1. Review and submit your settings and create the project.
109
109
110
110
:::image type="content" source="../media/studio/create-project.gif" alt-text="Animation showing create a custom project in Document Intelligence Studio.":::
111
111
@@ -121,7 +121,7 @@ See [Document Intelligence Studio: labeling as tables](../concept-custom-label.m
121
121
122
122
Training with labels leads to better performance in some scenarios. To train with labels, you need to have special label information files (*\<filename\>.pdf.labels.json*) in your blob storage container alongside the training documents.
123
123
124
-
Label files contain key-value associations that a user has entered manually. They're needed for labeled data training, but not every source file needs to have a corresponding label file. Source files without labels are treated as ordinary training documents. We recommend five or more labeled files for reliable training. You can use a UI tool like [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/customform/projects) to generate these files.
124
+
Label files contain key-value associations that a user entered manually. The files are needed for labeled data training, but not every source file needs to have a corresponding label file. Source files without labels are treated as ordinary training documents. We recommend five or more labeled files for reliable training. You can use a UI tool like [Document Intelligence Studio](https://formrecognizer.appliedai.azure.com/studio/customform/projects) to generate these files.
125
125
126
126
Once you have your label files, you can include them with by calling the training method with the *useLabelFile* parameter set to `true`.
127
127
@@ -150,7 +150,7 @@ With the [**create compose model**](/rest/api/aiservices/document-models/compose
150
150
151
151
### [Document Intelligence Studio](#tab/studio)
152
152
153
-
Once the training process has successfully completed, you can begin to build your composed model. Here are the steps for creating and using composed models:
153
+
Once the training process is successfully completed, you can begin to build your composed model. Here are the steps for creating and using composed models:
154
154
155
155
*[**Gather your custom model IDs**](#gather-your-model-ids)
156
156
*[**Compose your custom models**](#compose-your-custom-models)
@@ -197,15 +197,15 @@ You can manage your custom models throughout life cycles:
197
197
198
198
### [REST API](#tab/rest)
199
199
200
-
Once the training process has successfully completed, you can begin to build your composed model. Here are the steps for creating and using composed models:
200
+
Once the training process is successfully completed, you can begin to build your composed model. Here are the steps for creating and using composed models:
201
201
202
202
*[**Compose your custom models**](#compose-your-custom-models)
203
203
*[**Analyze documents**](#analyze-documents)
204
204
*[**Manage your composed models**](#manage-your-composed-models)
205
205
206
206
#### Compose your custom models
207
207
208
-
The [compose model API](/rest/api/aiservices/document-models/compose-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP) accepts a list of model IDs to be composed.
208
+
The [composed models API](/rest/api/aiservices/document-models/compose-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP) accepts a list of model IDs to be composed.
209
209
210
210
:::image type="content" source="../media/compose-model-request-body.png" alt-text="Screenshot of compose model request.":::
211
211
@@ -221,7 +221,7 @@ You can manage custom models throughout your development needs including [**copy
221
221
222
222
### [Client libraries](#tab/sdks)
223
223
224
-
Once the training process has successfully completed, you can begin to build your composed model. Here are the steps for creating and using composed models:
224
+
Once the training process successfully completes, you can begin to build your composed model. Here are the steps for creating and using composed models:
225
225
226
226
*[**Create a composed model**](#create-a-composed-model)
227
227
*[**Analyze documents**](#analyze-documents)
@@ -240,7 +240,7 @@ You can use the programming language of your choice to create a composed model:
240
240
241
241
#### Analyze documents
242
242
243
-
Once you've built your composed model, you can use it to analyze forms and documents. Use your composed `model ID` and let the service decide which of your aggregated custom models fits best according to the document provided.
243
+
Once you build your composed model, you can use it to analyze forms and documents. Use your composed `model ID` and let the service decide which of your aggregated custom models fits best according to the document provided.
244
244
245
245
|Programming language| Code sample |
246
246
|--|--|
@@ -262,7 +262,7 @@ You can manage a custom model at each stage in its life cycles. You can copy a c
262
262
263
263
---
264
264
265
-
Great! You've learned the steps to create custom and composed models and use them in your Document Intelligence projects and applications.
265
+
Great! You learned the steps to create custom and composed models and use them in your Document Intelligence projects and applications.
266
266
267
267
## Next steps
268
268
@@ -296,7 +296,7 @@ Document Intelligence uses advanced machine-learning technology to detect and ex
296
296
297
297
***Composed models**. A composed model is created by taking a collection of custom models and assigning them to a single model that encompasses your form types. When a document is submitted to a composed model, the service performs a classification step to decide which custom model accurately represents the form presented for analysis.
298
298
299
-
In this article, you learn how to create Document Intelligence custom and composed models using our [Document Intelligence Sample Labeling tool](../label-tool.md), [REST APIs](../how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true), or [client-library SDKs](../how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true).
299
+
In this article, you learn how to create Document Intelligence custom and composed models using our [Document Intelligence Sample Labeling tool](../label-tool.md), [REST APIs](../how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true), or [client libraries](../how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true).
300
300
301
301
## Sample Labeling tool
302
302
@@ -315,11 +315,11 @@ In the Document Intelligence UI:
315
315
316
316
1. Select **Use Custom to train a model with labels and get key value pairs**.
317
317
318
-
:::image type="content" source="../media/label-tool/fott-use-custom.png" alt-text="Screenshot of the FOTT tool select custom model option.":::
318
+
:::image type="content" source="../media/label-tool/fott-use-custom.png" alt-text="Screenshot of the `FOTT` tool select custom model option.":::
319
319
320
320
1. In the next window, select **New project**:
321
321
322
-
:::image type="content" source="../media/label-tool/fott-new-project.png" alt-text="Screenshot of the FOTT tool select new project option.":::
322
+
:::image type="content" source="../media/label-tool/fott-new-project.png" alt-text="Screenshot of the `FOTT` tool select new project option.":::
323
323
324
324
## Create your models
325
325
@@ -360,14 +360,14 @@ Document Intelligence uses the [Layout](../concept-layout.md) API to learn the e
360
360
361
361
With the Model Compose operation, you can assign up to 200 trained custom models to a single model ID. When you call Analyze with the composed model ID, Document Intelligence classifies the form you submitted first, chooses the best matching assigned model, and then returns results for that model. This operation is useful when incoming forms may belong to one of several templates.
362
362
363
-
Using the Document Intelligence Sample Labeling tool, the REST API, or the Client-library SDKs, follow the steps to set up a composed model:
363
+
Using the Document Intelligence Sample Labeling tool, the REST API, or the client libraries, follow the steps to set up a composed model:
364
364
365
365
1.[**Gather your custom model IDs**](#gather-your-custom-model-ids)
366
366
1.[**Compose your custom models**](#compose-your-custom-models)
367
367
368
368
### Gather your custom model IDs
369
369
370
-
Once the training process has successfully completed, your custom model is assigned a model ID. You can retrieve a model ID as follows:
370
+
Once the training process is successfully completed, your custom model is assigned a model ID. You can retrieve a model ID as follows:
371
371
372
372
<!-- Applies to FOTT but labeled studio to eliminate tab grouping warning -->
@@ -384,7 +384,7 @@ The [**REST API**](build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=tr
384
384
385
385
### [**Client-library SDKs**](#tab/sdks)
386
386
387
-
The [**client-library SDKs**](build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=true#train-your-model) return a model object that can be queried to return the trained model ID:
387
+
The [**clientlibrary SDKs**](build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=true#train-your-model) return a model object that can be queried to return the trained model ID:
388
388
389
389
* C\# | [CustomFormModel Class](/dotnet/api/azure.ai.formrecognizer.training.customformmodel?view=azure-dotnet&preserve-view=true#properties"Azure SDK for .NET")
390
390
@@ -398,14 +398,14 @@ The [**REST API**](build-a-custom-model.md?view=doc-intel-2.1.0&preserve-view=tr
398
398
399
399
#### Compose your custom models
400
400
401
-
After you've gathered your custom models corresponding to a single form type, you can compose them into a single model.
401
+
After you gather your custom models corresponding to a single form type, you can compose them into a single model.
402
402
403
403
<!-- Applies to FOTT but labeled studio to eliminate tab grouping warning -->
1. On the tool's left-pane menu, select the **Analyze icon** (light bulb).
448
+
1. On the tool's left-pane menu, select the **`Analyze` icon** (light bulb).
449
449
450
450
1. Choose a local file or image URL to analyze.
451
451
@@ -480,7 +480,7 @@ Test your newly trained models by [analyzing forms](build-a-custom-model.md?view
480
480
481
481
You can [manage your custom models](../how-to-guides/use-sdk-rest-api.md?view=doc-intel-2.1.0&preserve-view=true) throughout their lifecycle by viewing a [list of all custom models](/rest/api/aiservices/document-models/get-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTPs) under your subscription, retrieving information about [a specific custom model](/rest/api/aiservices/document-models/get-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP), and [deleting custom models](/rest/api/aiservices/document-models/delete-model?view=rest-aiservices-2023-07-31&preserve-view=true&tabs=HTTP) from your account.
482
482
483
-
Great! You've learned the steps to create custom and composed models and use them in your Document Intelligence projects and applications.
483
+
Great! You learned the steps to create custom and composed models and use them in your Document Intelligence projects and applications.
0 commit comments