Skip to content

[formrecognizer] docs edits #21030

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

Merged
kristapratico merged 6 commits into from
Oct 4, 2021
Merged

[formrecognizer] docs edits #21030

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cf03cc0
readme edits
kristapratico Oct 4, 2021
a184520
fix some docstrings
kristapratico Oct 4, 2021
9fb43b2
fix asyncitempaged docstring type
kristapratico Oct 4, 2021
a952c0c
samples edits
kristapratico Oct 4, 2021
e190d23
remove unimported helper method from migration guide
kristapratico Oct 4, 2021
cb372f6
update link on build model
kristapratico Oct 4, 2021
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
Prev Previous commit
Next Next commit
samples edits
  • Loading branch information
@kristapratico
kristapratico committed Oct 4, 2021
commit a952c0cee5c49e857a6d23ff8481923e2e7afea2
6 changes: 3 additions & 3 deletions ...er/azure-ai-formrecognizer/samples/v3.2-beta/async_samples/sample_analyze_layout_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
This sample demonstrates how to extract text, selection marks, and layout information from a document
given through a file.

Note that selection marks returned from begin_analyze_document() do not return the text associated with
the checkbox. For the API to return this information, build a custom model to analyze the checkbox and its text.
See sample_build_model_async.py for more information.
Note that selection marks returned from begin_analyze_document(model="prebuilt-layout") do not return the text
associated with the checkbox. For the API to return this information, build a custom model to analyze the
checkbox and its text. See sample_build_model.py for more information.

USAGE:
python sample_analyze_layout_async.py
Expand Down
2 changes: 1 addition & 1 deletion ...nizer/azure-ai-formrecognizer/samples/v3.2-beta/async_samples/sample_build_model_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
documents found in https://aka.ms/azsdk/formrecognizer/sampletrainingfiles

More details on setting up a container and required file structure can be found here:
https://docs.microsoft.com/azure/cognitive-services/form-recognizer/build-training-data-set
https://aka.ms/azsdk/formrecognizer/buildtrainingset

USAGE:
python sample_build_model_async.py
Expand Down
6 changes: 3 additions & 3 deletions sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_analyze_layout.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@
This sample demonstrates how to extract text, selection marks, and layout information from a document
given through a file.

Note that selection marks returned from begin_analyze_document() do not return the text associated with
the checkbox. For the API to return this information, build a custom model to analyze the checkbox and its text.
See sample_build_model.py for more information.
Note that selection marks returned from begin_analyze_document(model="prebuilt-layout") do not return the text
associated with the checkbox. For the API to return this information, build a custom model to analyze the
checkbox and its text. See sample_build_model.py for more information.

USAGE:
python sample_analyze_layout.py
Expand Down
2 changes: 1 addition & 1 deletion sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_build_model.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
documents found in https://aka.ms/azsdk/formrecognizer/sampletrainingfiles

More details on setting up a container and required file structure can be found here:
https://docs.microsoft.com/azure/cognitive-services/form-recognizer/build-training-data-set
https://aka.ms/azsdk/formrecognizer/buildtrainingset

USAGE:
python sample_build_model.py
Expand Down