Skip to content

Commit 788507c

Browse files
ramparabSandeep Parabkristapratico
authored
FRv2.1-preview.2 update (#10805)
* Initial update for .preview.2 release. * Standardized Errors, sample list. * removing from master from now as this is just a proposal * Add support for preview.3 * Adding appearance property to ReadResult. * Incorporate review feedback. * Update swagger * Updating page range parameter for layout API. * Adding .bmp, language support, table bounding box. * Refactoring Locale parameter. * Refactor language parameter. * Ran prettier. * Spell check fix. * Update to add preview.2 swagger. * Update specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/FormRecognizer.json Co-authored-by: Krista Pratico <[email protected]> * Update specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/FormRecognizer.json Co-authored-by: Krista Pratico <[email protected]> * Incorporate review feedback. * Incorporating review feedback. * Adding language to ReadResult - Japan Co-authored-by: Sandeep Parab <[email protected]> Co-authored-by: Krista Pratico <[email protected]>
1 parent 731b282 commit 788507c

23 files changed

+2675
-3
lines changed

‎specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/FormRecognizer.json‎

Lines changed: 2176 additions & 0 deletions
Large diffs are not rendered by default.

‎specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/examples/AnalyzeBatch.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"parameters": {
3+
"endpoint": "{endpoint}",
4+
"Content-Type": "application/json",
5+
"Ocp-Apim-Subscription-Key": "{API key}",
6+
"modelId": "{modelId}",
7+
"body": {}
8+
},
9+
"responses": {
10+
"202": {
11+
"headers": {
12+
"Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.2/custom/models/{modelId}/analyzeResults/{resultId}"
13+
}
14+
}
15+
}
16+
}

‎specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/examples/AnalyzeOperationResult.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"parameters": {
3+
"endpoint": "{endpoint}",
4+
"Ocp-Apim-Subscription-Key": "{API key}",
5+
"modelId": "{modelId}",
6+
"resultId": "{result Id}",
7+
"body": {}
8+
},
9+
"responses": {
10+
"200": {
11+
"body": {
12+
"status": "running",
13+
"createdDateTime": "2019-05-01T10:53:21Z",
14+
"lastUpdatedDateTime": "2019-05-01T10:53:23Z",
15+
"analyzeResult": {
16+
"version": "v2.1",
17+
"readResults": [],
18+
"pageResults": [],
19+
"documentResults": [],
20+
"errors": []
21+
}
22+
}
23+
}
24+
}
25+
}

‎specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/examples/BusinessCardBatch.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"parameters": {
3+
"endpoint": "{endpoint}",
4+
"Content-Type": "application/json",
5+
"Ocp-Apim-Subscription-Key": "{API key}",
6+
"body": {
7+
"source": "http://www.example.com/image.jpg"
8+
}
9+
},
10+
"responses": {
11+
"202": {
12+
"headers": {
13+
"Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.2/prebuilt/businessCard/analyzeResults/{resultId}"
14+
}
15+
}
16+
}
17+
}

‎specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/examples/BusinessCardBatchResult.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"parameters": {
3+
"endpoint": "{endpoint}",
4+
"Ocp-Apim-Subscription-Key": "{API key}",
5+
"resultId": "{result Id}",
6+
"body": {}
7+
},
8+
"responses": {
9+
"200": {
10+
"body": {
11+
"status": "running",
12+
"createdDateTime": "2019-05-01T10:53:21Z",
13+
"lastUpdatedDateTime": "2019-05-01T10:53:23Z",
14+
"analyzeResult": {
15+
"version": "v2.1",
16+
"readResults": [],
17+
"pageResults": [],
18+
"documentResults": [],
19+
"errors": []
20+
}
21+
}
22+
}
23+
}
24+
}

‎specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/examples/ComposeModels.json‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{
2+
"parameters": {
3+
"endpoint": "{endpoint}",
4+
"Content-Type": "application/json",
5+
"Ocp-Apim-Subscription-Key": "{API key}",
6+
"body": {},
7+
"composeRequest": {
8+
"modelIds": [
9+
"4afb20d6-3ed0-4cde-ba40-dbd6207268dd",
10+
"6f841356-aa32-42c9-a739-2182c47b79c9"
11+
]
12+
}
13+
},
14+
"responses": {
15+
"201": {
16+
"headers": {
17+
"Location": "{endpoint}/formrecognizer/v2.1-preview.2/custom/models/{modelId}"
18+
}
19+
}
20+
}
21+
}

‎specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/examples/CopyModel.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"parameters": {
3+
"endpoint": "{endpoint}",
4+
"Content-Type": "application/json",
5+
"Ocp-Apim-Subscription-Key": "{API key}",
6+
"modelId": "{modelId}",
7+
"body": {},
8+
"copyRequest": {
9+
"targetResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{resourceName}",
10+
"targetResourceRegion": "westus2",
11+
"copyAuthorization": {
12+
"modelId": "{modelId}",
13+
"accessToken": "{accessToken}",
14+
"expirationDateTimeTicks": 637190189980000000
15+
}
16+
}
17+
},
18+
"responses": {
19+
"202": {
20+
"headers": {
21+
"Operation-Location": "{endpoint}/formrecognizer/v2.1-preview.2/custom/models/{modelId}/copyResults/{resultId}"
22+
}
23+
}
24+
}
25+
}

‎specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/examples/CopyModelAuthorization.json‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"parameters": {
3+
"endpoint": "{endpoint}",
4+
"Content-Type": "application/json",
5+
"Ocp-Apim-Subscription-Key": "{API key}",
6+
"body": {}
7+
},
8+
"responses": {
9+
"201": {
10+
"headers": {
11+
"Location": "{endpoint}/formrecognizer/v2.1-preview.2/custom/models/{modelId}"
12+
},
13+
"body": {
14+
"modelId": "{modelId}",
15+
"accessToken": "{accessToken}",
16+
"expirationDateTimeTicks": 637190189980000000
17+
}
18+
}
19+
}
20+
}

‎specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/examples/CopyOperationResult.json‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"parameters": {
3+
"endpoint": "{endpoint}",
4+
"Content-Type": "application/json",
5+
"Ocp-Apim-Subscription-Key": "{API key}",
6+
"modelId": "{modelId}",
7+
"resultId": "{resultId}",
8+
"body": {}
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"status": "succeeded",
14+
"createdDateTime": "2020-01-01T00:00:00Z",
15+
"lastUpdatedDateTime": "2020-01-01T00:01:00Z",
16+
"copyResult": {
17+
"modelId": "{modelId}",
18+
"errors": []
19+
}
20+
}
21+
}
22+
}
23+
}

‎specification/cognitiveservices/data-plane/FormRecognizer/preview/v2.1-preview.2/examples/CopyOperationResultWithErrors.json‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
{
2+
"parameters": {
3+
"endpoint": "{endpoint}",
4+
"Content-Type": "application/json",
5+
"Ocp-Apim-Subscription-Key": "{API key}",
6+
"modelId": "{modelId}",
7+
"resultId": "{resultId}",
8+
"body": {}
9+
},
10+
"responses": {
11+
"200": {
12+
"body": {
13+
"status": "failed",
14+
"createdDateTime": "2020-01-01T00:00:00Z",
15+
"lastUpdatedDateTime": "2020-01-01T00:01:00Z",
16+
"copyResult": {
17+
"modelId": "{modelId}",
18+
"errors": [
19+
{
20+
"code": "ResourceResolverError",
21+
"message": "{ErrorMessage}"
22+
}
23+
]
24+
}
25+
}
26+
}
27+
}
28+
}

0 commit comments

Comments
 (0)