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

Analyze Layout update #8

Open
wants to merge 55 commits into
base: FRv20Updates
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
55 commits
Select commit Hold shift + click to select a range
14464cf
Swagger changes to support automatic repairs on Virtual Machine Scale…
hapandar Oct 16, 2019
b2684c3
Added IMDS version 2019-11-01 (#7438)
rifrankl Oct 16, 2019
b988ead
[DataFactory]Add CompressionCodec property for ORC Dataset (#7452)
TinaHu1 Oct 17, 2019
93db53b
Update for Layout Analysis
yungshinlintw Oct 17, 2019
1efbec9
Update result for layout
yungshinlintw Oct 17, 2019
8634e08
Adding readme.cli.md file for peering (#7419)
Oct 17, 2019
9baf9b6
Adding PolicyInsights policyStates api version 2019-10-01. (#7505)
sandipsh Oct 17, 2019
9aad4c8
Advisor: add readme.java.md file (#7533)
xseeseesee Oct 17, 2019
a71b00b
regenerated all-api-versions
Oct 17, 2019
d6dc3f5
[DataFactory]Add Dynamics Server-toServer authentication type. (#7437)
sjtuxzq Oct 17, 2019
c2f6e5b
chore: jsonfmt policyinsights (#7536)
nschonni Oct 17, 2019
3b87973
chore: jsonfmt compute (#7535)
nschonni Oct 17, 2019
59998f7
Add "Allocating","Upgrading" and "Compiling" enum into DeploymentReso…
bowen5 Oct 17, 2019
5c127af
Update for OCRLanguage parameter
yungshinlintw Oct 17, 2019
e092f42
Adding FR v2.0 API updates (#7303)
ramparab Oct 17, 2019
4de63a0
regenerated all-api-versions
Oct 17, 2019
6eca888
Update from PR comment
yungshinlintw Oct 17, 2019
732f08f
[Storage] Support private endpoint connection apis on new api version…
prpandey3004 Oct 18, 2019
bc811bd
regenerated all-api-versions
Oct 18, 2019
3fcde8b
Updating Functions ARM API specs (#7174)
mathewc Oct 18, 2019
1efb1b6
CostManagement RP- Introducing API Version 2019-10-01 plus adding Mod…
parisa-naeimi Oct 18, 2019
ad92120
regenerated all-api-versions
Oct 18, 2019
7717107
Consumption RP - Introducing API Version 2019-10-01 with support of n…
parisa-naeimi Oct 18, 2019
b51344b
regenerated all-api-versions
Oct 18, 2019
d88d106
Fix typo in readme.go for web (#7547)
Oct 19, 2019
4a26ffa
Compute 2019-07-01 version (#7094)
hyonholee Oct 20, 2019
0bea032
regenerated all-api-versions
Oct 20, 2019
4d8c0af
Correcting the verbs from Create BillingProfile and InvoiceSection as…
asarkar84 Oct 21, 2019
b2d6bdb
Updating swagger spec to fix billing plans schema in catalogs respons…
sornaks Oct 21, 2019
796f8ca
Microsoft Azure StorageCache new API version (#7520)
romahamu Oct 21, 2019
3e8d178
update ARM email template and fix repoWhiltelist location (#7556)
ruowan Oct 21, 2019
6004a8b
add AKS rotateClusterCertificates API (#7436)
andyzhangx Oct 21, 2019
0c3c17c
[Storage] Sync swagger changes from 2019-04-01 to 2019-06-01 apiversi…
prpandey3004 Oct 21, 2019
9fcf995
Omelhari/feature assigning ap is (#7503)
omar-el-hariry Oct 21, 2019
5e3c3a7
Refactory CognitiveServicesAccount model specification. (#7415)
yangyuan Oct 21, 2019
6a15a80
[SRP] Add CORS to common types (#7562)
zfchen95 Oct 21, 2019
71db546
Updating the docs to include rankerType field in QueryDTO (#7538)
rokulka Oct 21, 2019
4032496
[Azure Search] Apply branding changes to stable/2019-05-06 and track1…
bleroy Oct 21, 2019
f243746
Add Hybrid RP rest api spec (#7487)
farehar Oct 22, 2019
931cb1a
regenerated all-api-versions
Oct 22, 2019
144e1e7
Merge Network's October release branch into master (#7564)
anton-evseev Oct 22, 2019
fce4dc4
regenerated all-api-versions
Oct 22, 2019
6405fdd
update-event-schema-for-azure-storage-event-grid-notification-for-cr…
wanha-ms Oct 22, 2019
08ec526
[Resources] Add Deployment scripts as a new resource type - preview -…
filizt Oct 22, 2019
57bd130
regenerated all-api-versions
Oct 22, 2019
5265b92
Fixing issues in Azurestack admin api specs while running the powersh…
bganapa Oct 22, 2019
ffc9aba
fixing tag package-2019-07-01-only (#7574)
Oct 22, 2019
cf9e1b3
Publish container service 2019-10-01 api version (#7567)
Oct 22, 2019
2fefd59
updates for network experiment (#7573)
Oct 22, 2019
a3a1a3b
scope assignmens override + flatten all (#7571)
Oct 22, 2019
eb7b04c
regenerated all-api-versions
Oct 22, 2019
bb46c8b
remove 5days email notification (#7576)
ruowan Oct 22, 2019
282efa7
updating peering cli structure (#7572)
Oct 22, 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,93 @@
}
}
}
},
"/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/OcrLanguage"
},
{
"$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",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"description": "Track the progress and obtain the result of the analyze layout operation.",

"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 Expand Up @@ -1291,6 +1378,22 @@
"in": "path",
"x-ms-skip-url-encoding": true
},
"OcrLanguage": {
"name": "language",
"in": "query",
"description": "The BCP-47 language code of the text to be detected in the image.",
"required": true,
"x-ms-parameter-location": "method",
"type": "string",
"x-ms-enum": {
"name": "Language",
"modelAsString": true
},
"enum": [
"en",
"es"
]
},
"FileStream": {
"name": "fileStream",
"description": ".json, .pdf, .jpg, .png or .tiff type file stream.",
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":[]
}
}
}
}
}