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.

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

Layout API update in FormRecognzier 2.0-preview #7581

Merged
merged 39 commits into from
Oct 25, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
ea176ae
Adding FR v2.0 API updates
Sep 24, 2019
2194edb
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Sep 25, 2019
50814ee
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Sep 25, 2019
f765772
PR Validation: Fix typo, missing file ref.
Sep 25, 2019
c631a7b
PR Validation: Fix missed typo
Sep 25, 2019
9e7b71b
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Sep 27, 2019
4ac2e0c
PR Validation: fixing model verification errors, doc string fixes.
Sep 27, 2019
21be0f4
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Sep 27, 2019
4322814
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Oct 2, 2019
18f68c4
Fixing model verification, added Receipts endpoints, related examples.
Oct 2, 2019
45481b0
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Oct 2, 2019
150d849
Fixing semantic validation error
Oct 2, 2019
e9c26dc
Update labelFile param
Oct 2, 2019
c7a5874
fixing types
Oct 2, 2019
4fe4cbd
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Oct 2, 2019
f704ed1
Fixing model validation errors
Oct 2, 2019
3a6f6d9
Fixing model verification errors, other fixes.
Oct 3, 2019
d16f31e
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Oct 3, 2019
ed7627d
Fixing mode verification error.
Oct 3, 2019
f457a44
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Oct 3, 2019
ebdccea
Fixing typo.
Oct 3, 2019
931f3dd
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Oct 10, 2019
9759116
Fixing doc strings, Location header update, Change response code for …
Oct 10, 2019
cb09c84
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Oct 11, 2019
97be67d
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Oct 15, 2019
52d90da
Incorporating feedback from Paul.
Oct 15, 2019
de59610
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Oct 15, 2019
7995446
Feedback from Florian, verification fix.
Oct 15, 2019
743b911
Fixing for merge verification.
Oct 16, 2019
008ce0d
Merge branch 'master' of https://github.com/azure/azure-rest-api-spec…
Oct 16, 2019
6a7233b
fixing for model verification tests
Oct 16, 2019
d029c55
fixing model verification errors.
Oct 16, 2019
1d58d04
fixing example file to correct useLabelFile option.
Oct 16, 2019
93db53b
Update for Layout Analysis
yungshinlintw Oct 17, 2019
1efbec9
Update result for layout
yungshinlintw Oct 17, 2019
5c127af
Update for OCRLanguage parameter
yungshinlintw Oct 17, 2019
6eca888
Update from PR comment
yungshinlintw Oct 17, 2019
b9f5e71
Remove language as a parameter
yungshinlintw Oct 22, 2019
d88a686
Merge branch 'master' of https://github.com/Azure/azure-rest-api-spec…
yungshinlintw Oct 22, 2019
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
Original file line number Diff line number Diff line change
Expand Up @@ -395,6 +395,90 @@
}
}
}
},
"/layout/analyze": {
"post": {
"summary": "Analyze Layout",
"description": "Extract text and layout information from a given document. The input document must be of one of the supported content types - 'application/pdf', 'image/jpeg', 'image/png' or 'image/tiff'. Alternatively, use 'application/json' type to specify the location (Uri or local path) of the document to be analyzed.",
"operationId": "AnalyzeLayoutAsync",
"consumes": [
"application/pdf",
"application/json",
"image/jpeg",
"image/png",
"image/tiff"
],
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "#/parameters/FileStream"
}
],
"responses": {
"202": {
"description": "Request is queued successfully.",
"headers": {
"Operation-Location": {
"type": "string",
"description": "URL containing the resultId used to track the progress and obtain the result of the analyze operation."
}
}
},
"default": {
"description": "Response entity accompanying non-successful responses containing additional details about the error.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Analyze layout": {
"$ref": "./examples/LayoutBatch.json"
}
}
}
},
"/layout/analyzeResults/{resultId}": {
"get": {
"summary": "Get Analyze Layout Result",
"description": "Track the progress and obtain the result of the analyze layout operation",
"operationId": "GetAnalyzeLayoutResult",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
"name": "resultId",
"in": "path",
"description": "Analyze operation result identifier.",
"required": true,
"type": "string",
"format": "uuid"
}
],
"responses": {
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/AnalyzeOperationResult"
}
},
"default": {
"description": "Response entity accompanying non-successful responses containing additional details about the error.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get analyze layout result": {
"$ref": "./examples/LayoutBatchResult.json"
}
}
}
}
},
"definitions": {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"parameters": {
"endpoint": "{endpoint}",
"Content-Type": "application/json",
"Ocp-Apim-Subscription-Key": "{API key}",
"language": "en",
"body": {
}
},
"responses": {
"202": {
"headers": {
"Operation-Location": "{endpoint}/formrecognizer/v2.0-preview/layout/analyzeResults/{resultId}"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{
"parameters": {
"endpoint": "{endpoint}",
"Content-Type": "application/json",
"Ocp-Apim-Subscription-Key": "{API key}",
"modelId": "{model Id}",
"resultId": "{result Id}",
"body": {}
},
"responses": {
"200": {
"body":{
"status": "succeeded",
"createdDateTime": "2019-05-01T10:53:21Z",
"lastUpdatedDateTime": "2019-05-01T10:53:23Z",
"analyzeResult": {
"version":"v2.0",
"readResults":[],
"pageResults":[]
}
}
}
}
}