Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[formrecognizer] Adding terminology section #21031

Merged
merged 1 commit into from
Oct 4, 2021
Merged

[formrecognizer] Adding terminology section #21031

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions sdk/formrecognizer/azure-ai-formrecognizer/MIGRATION_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ Familiarity with `azure-ai-formrecognizer (3.1.x and below)` package is assumed.
## Table of Contents
- [Migration benefits](#migration-benefits)
- [Important changes](#important-changes)
- [Terminology](#terminology)
- [Client usage](#client-usage)
- [Analyzing document](#analyzing-documents)
- [Analyzing documents](#analyzing-documents)
- [Analyzing a document with a custom model](#analyzing-a-document-with-a-custom-model)
- [Training a custom model](#training-a-custom-model)
- [Manage models](#manage-models)
- [Managing models](#managing-models)
- [Additional samples](#additional-samples)

## Migration benefits
Expand All @@ -36,6 +37,15 @@ Please refer to the [README][readme] for more information on these new clients.

## Important changes

### Terminology

Some terminology has changed to reflect the enhanced capabilities of the newest Form Recognizer service APIs. While the service is still called "Form Recognizer", it is capable of much more than simple recognition and is not limited to documents that are "forms". As a result, we've made the following broad changes to the terminology used throughout the SDK:

- The word "Document" has broadly replaced the word "Form." The service supports a wide variety of documents and data-extraction scenarios, not merely limited to "forms."
- The word "Analyze" has broadly replaced the word "Recognize." The document analysis operations execute a data extraction pipeline that supports more than just recognition.
- Distinctions between "custom" and "prebuilt" models have broadly been eliminated. Prebuilt models are simply models that were created by the Form Recognizer service team and that exist within every Form Recognizer resource.
- The concept of "model training" has broadly been replaced with "model creation", "building a model", or "model administration" (whatever is most appropriate in context), as not all model creation operations involve "training" a model from a data set. When referring to a model schema trained from a data set, we will use the term "document type" instead.

### Client usage

We continue to support API key and AAD authentication methods when creating the clients. Below are the differences between the two versions:
Expand Down Expand Up @@ -635,7 +645,7 @@ for name, doc_type in model.doc_types.items():
print("Field: '{}' has confidence score {}".format(field_name, confidence))
```

### Manage models
### Managing models

Differences between the versions:
- When using API version `2021-09-30-preview` and later models no longer include submodels, instead a model can analyze different document types.
Expand Down