-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document Intelligence 2024-07-31-preview (#30088)
* Add DocumentIntelligence 2024-07-31-preview. * Fix validation.
- Loading branch information
Showing
73 changed files
with
21,953 additions
and
77 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 28 additions & 0 deletions
28
specification/ai/DocumentIntelligence/examples/2024-07-31-preview/AnalyzeBatchDocuments.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| { | ||
| "operationId": "DocumentModels_AnalyzeBatchDocuments", | ||
| "title": "Analyze Batch Documents", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "modelId": "customModel", | ||
| "pages": "1-5", | ||
| "locale": "en-US", | ||
| "stringIndexType": "textElements", | ||
| "analyzeBatchRequest": { | ||
| "azureBlobSource": { | ||
| "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", | ||
| "prefix": "trainingDocs/" | ||
| }, | ||
| "resultContainerUrl": "https://myStorageAccount.blob.core.windows.net/myOutputContainer?mySasToken", | ||
| "resultPrefix": "trainingDocsResult/", | ||
| "overwriteExisting": true | ||
| } | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeBatchResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview" | ||
| } | ||
| } | ||
| } | ||
| } |
22 changes: 22 additions & 0 deletions
22
...ification/ai/DocumentIntelligence/examples/2024-07-31-preview/AnalyzeDocument_Base64.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| { | ||
| "operationId": "DocumentModels_AnalyzeDocument", | ||
| "title": "Analyze Document from Base64", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "modelId": "prebuilt-layout", | ||
| "pages": "1-2,4", | ||
| "locale": "en-US", | ||
| "stringIndexType": "textElements", | ||
| "analyzeRequest": { | ||
| "base64Source": "e2Jhc2U2NEVuY29kZWRQZGZ9" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-layout/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview" | ||
| } | ||
| } | ||
| } | ||
| } |
20 changes: 20 additions & 0 deletions
20
...ification/ai/DocumentIntelligence/examples/2024-07-31-preview/AnalyzeDocument_Stream.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| { | ||
| "operationId": "DocumentModels_AnalyzeDocumentFromStream", | ||
| "title": "Analyze Document from Url", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "modelId": "customModel", | ||
| "pages": "1-2,4", | ||
| "locale": "en-US", | ||
| "stringIndexType": "textElements", | ||
| "input": "{binaryFile}" | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview" | ||
| } | ||
| } | ||
| } | ||
| } |
22 changes: 22 additions & 0 deletions
22
specification/ai/DocumentIntelligence/examples/2024-07-31-preview/AnalyzeDocument_Url.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| { | ||
| "operationId": "DocumentModels_AnalyzeDocument", | ||
| "title": "Analyze Document from Url", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "modelId": "customModel", | ||
| "pages": "1-2,4", | ||
| "locale": "en-US", | ||
| "stringIndexType": "textElements", | ||
| "analyzeRequest": { | ||
| "urlSource": "http://host.com/doc.pdf" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/customModel/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview" | ||
| } | ||
| } | ||
| } | ||
| } |
24 changes: 24 additions & 0 deletions
24
.../ai/DocumentIntelligence/examples/2024-07-31-preview/AuthorizeCopyDocumentClassifier.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "operationId": "DocumentClassifiers_AuthorizeClassifierCopy", | ||
| "title": "Authorize Copy of Document Classifier", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "authorizeCopyRequest": { | ||
| "classifierId": "targetClassifier", | ||
| "description": "Target classifier description" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", | ||
| "targetResourceRegion": "targetResourceRegion", | ||
| "targetClassifierId": "targetClassifier", | ||
| "targetClassifierLocation": "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/targetClassifier", | ||
| "accessToken": "accessToken", | ||
| "expirationDateTime": "2021-09-23T09:12:54.552Z" | ||
| } | ||
| } | ||
| } | ||
| } |
24 changes: 24 additions & 0 deletions
24
...ation/ai/DocumentIntelligence/examples/2024-07-31-preview/AuthorizeCopyDocumentModel.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "operationId": "DocumentModels_AuthorizeModelCopy", | ||
| "title": "Authorize Copy of Document Model", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "authorizeCopyRequest": { | ||
| "modelId": "targetModel", | ||
| "description": "Target model description" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "200": { | ||
| "body": { | ||
| "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", | ||
| "targetResourceRegion": "targetResourceRegion", | ||
| "targetModelId": "targetModel", | ||
| "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentModels/targetModel", | ||
| "accessToken": "accessToken", | ||
| "expirationDateTime": "2021-09-23T09:12:54.552Z" | ||
| } | ||
| } | ||
| } | ||
| } |
33 changes: 33 additions & 0 deletions
33
...fication/ai/DocumentIntelligence/examples/2024-07-31-preview/BuildDocumentClassifier.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| { | ||
| "operationId": "DocumentClassifiers_BuildClassifier", | ||
| "title": "Build Document Classifier", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "buildRequest": { | ||
| "classifierId": "myClassifier", | ||
| "description": "Classifier description", | ||
| "docTypes": { | ||
| "formA": { | ||
| "azureBlobSource": { | ||
| "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", | ||
| "prefix": "formADocs/" | ||
| } | ||
| }, | ||
| "formB": { | ||
| "azureBlobFileListSource": { | ||
| "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", | ||
| "fileList": "formB.jsonl" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview" | ||
| } | ||
| } | ||
| } | ||
| } |
27 changes: 27 additions & 0 deletions
27
specification/ai/DocumentIntelligence/examples/2024-07-31-preview/BuildDocumentModel.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| { | ||
| "operationId": "DocumentModels_BuildModel", | ||
| "title": "Build Document Model", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "buildRequest": { | ||
| "modelId": "myCustomModel", | ||
| "description": "Custom model description", | ||
| "buildMode": "template", | ||
| "azureBlobSource": { | ||
| "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer?mySasToken", | ||
| "prefix": "trainingDocs/" | ||
| }, | ||
| "tags": { | ||
| "createdBy": "myUserId" | ||
| } | ||
| } | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview" | ||
| } | ||
| } | ||
| } | ||
| } |
18 changes: 18 additions & 0 deletions
18
...fication/ai/DocumentIntelligence/examples/2024-07-31-preview/ClassifyDocument_Stream.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| { | ||
| "operationId": "DocumentClassifiers_ClassifyDocumentFromStream", | ||
| "title": "Classify Document from Url", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "classifierId": "classifierId", | ||
| "stringIndexType": "textElements", | ||
| "input": "{binaryFile}" | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview" | ||
| } | ||
| } | ||
| } | ||
| } |
20 changes: 20 additions & 0 deletions
20
specification/ai/DocumentIntelligence/examples/2024-07-31-preview/ClassifyDocument_Url.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| { | ||
| "operationId": "DocumentClassifiers_ClassifyDocument", | ||
| "title": "Classify Document from Url", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "classifierId": "classifierId", | ||
| "stringIndexType": "textElements", | ||
| "classifyRequest": { | ||
| "urlSource": "http://host.com/doc.pdf" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/customClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-07-31-preview" | ||
| } | ||
| } | ||
| } | ||
| } |
28 changes: 28 additions & 0 deletions
28
specification/ai/DocumentIntelligence/examples/2024-07-31-preview/ComposeDocumentModel.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| { | ||
| "operationId": "DocumentModels_ComposeModel", | ||
| "title": "Compose Document Model", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "composeRequest": { | ||
| "modelId": "composedModel", | ||
| "description": "Composed model description", | ||
| "classifierId": "customClassifier", | ||
| "docTypes": { | ||
| "formA": { | ||
| "modelId": "model1" | ||
| }, | ||
| "formB": { | ||
| "modelId": "model2" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview" | ||
| } | ||
| } | ||
| } | ||
| } |
24 changes: 24 additions & 0 deletions
24
...ication/ai/DocumentIntelligence/examples/2024-07-31-preview/CopyDocumentClassifierTo.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "operationId": "DocumentClassifiers_CopyClassifierTo", | ||
| "title": "Copy Document Classifier To", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "classifierId": "sourceClassifier", | ||
| "copyToRequest": { | ||
| "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", | ||
| "targetResourceRegion": "targetResourceRegion", | ||
| "targetClassifierId": "targetClassifier", | ||
| "targetClassifierLocation": "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/targetClassifier", | ||
| "accessToken": "accessToken", | ||
| "expirationDateTime": "2021-09-23T09:12:54.552Z" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview" | ||
| } | ||
| } | ||
| } | ||
| } |
24 changes: 24 additions & 0 deletions
24
specification/ai/DocumentIntelligence/examples/2024-07-31-preview/CopyDocumentModelTo.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| { | ||
| "operationId": "DocumentModels_CopyModelTo", | ||
| "title": "Copy Document Model To", | ||
| "parameters": { | ||
| "endpoint": "https://myendpoint.cognitiveservices.azure.com", | ||
| "api-version": "2024-07-31-preview", | ||
| "modelId": "sourceModel", | ||
| "copyToRequest": { | ||
| "targetResourceId": "/subscriptions/targetSub/resourceGroups/targetRG/providers/Microsoft.CognitiveServices/accounts/targetService", | ||
| "targetResourceRegion": "targetResourceRegion", | ||
| "targetModelId": "targetModel", | ||
| "targetModelLocation": "https://targetEndpoint.cognitiveservices.azure.com/documentintelligence/documentModels/targetModel", | ||
| "accessToken": "accessToken", | ||
| "expirationDateTime": "2021-09-23T09:12:54.552Z" | ||
| } | ||
| }, | ||
| "responses": { | ||
| "202": { | ||
| "headers": { | ||
| "Operation-Location": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?api-version=2024-07-31-preview" | ||
| } | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.